Skip to content

Commit

Permalink
Added value support for grape enties.
Browse files Browse the repository at this point in the history
  • Loading branch information
Antek Drzewiecki committed Jul 30, 2014
1 parent fd5dfb2 commit f1e91ce
Show file tree
Hide file tree
Showing 5 changed files with 64 additions and 13 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
* [#126](https://github.com/tim-vandecasteele/grape-swagger/pull/126): Rewritten demo in the `test` folder with CORS enabled - [@dblock](https://github.com/dblock).
* [#127](https://github.com/tim-vandecasteele/grape-swagger/pull/127): Fixed `undefined method 'reject' for nil:NilClass` error for an invalid route, now returning 404 Not Found - [@dblock](https://github.com/dblock).
* [#128](https://github.com/tim-vandecasteele/grape-swagger/pull/128): Combine global models and endpoint entities - [@dspaeth-faber](https://github.com/dspaeth-faber).
* Added support for values in form parameters - [@Antek-drzewiecki](https://github.com/Antek-drzewiecki)
* [#132](https://github.com/tim-vandecasteele/grape-swagger/pull/132): Addes support for enum values in entity documentation and form parameters - [@Antek-drzewiecki](https://github.com/Antek-drzewiecki).
* Your Contribution Here

### 0.7.2 (February 6, 2014)
Expand Down
6 changes: 6 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ module API
class Status < Grape::Entity
expose :text, documentation: { type: 'string', desc: 'Status update text.' }
expose :links, using: Link, documentation: { type: 'link', is_array: true }
expose :numbers, documentation: { type: 'integer', desc: 'favourite number', values: [1,2,3,4] }
end
class Link < Grape::Entity
Expand All @@ -215,6 +216,11 @@ module API
type = current_user.admin? ? :full : :default
present statuses, with: API::Entities::Status, type: type
end
desc 'Creates a new status', entity: API::Entities::Status, params: API::Entities::Status.documentation
post '/statuses' do
...
end
end
end
```
Expand Down
15 changes: 11 additions & 4 deletions lib/grape-swagger.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -240,10 +240,9 @@ def parse_params(params, path, method)
required = value.is_a?(Hash) ? !!value[:required] : false
default_value = value.is_a?(Hash) ? value[:default] : nil
is_array = value.is_a?(Hash) ? (value[:is_array] || false) : false
enum_values = value.is_a?(Hash) ? value[:values] : nil
if enum_values && enum_values.is_a?(Proc)
enum_values = enum_values.call
end
enum_values = value.is_a?(Hash) ? value[:values] : nil
enum_values = enum_values.call if enum_values && enum_values.is_a?(Proc)

if value.is_a?(Hash) && value.key?(:param_type)
param_type = value[:param_type]
if is_array
Expand Down Expand Up @@ -377,7 +376,15 @@ def parse_entity_models(models)
property_description = p.delete(:desc)
p[:description] = property_description if property_description

# rename Grape's 'values' to 'enum'
select_values = p.delete(:values)
if select_values
select_values = select_values.call if select_values.is_a?(Proc)
p[:enum] = select_values
end

properties[property_name] = p

end

result[name] = {
Expand Down
38 changes: 38 additions & 0 deletions spec/api_models_spec.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ class Something < Grape::Entity
end
end

module Entities
class EnumValues < Grape::Entity
expose :gender, documentation: { type: 'string', desc: 'Content of something.', values: %w(Male Female) }
expose :number, documentation: { type: 'integer', desc: 'Content of something.', values: proc { [1, 2] } }
end
end

module Entities
module Some
class Thing < Grape::Entity
Expand Down Expand Up @@ -64,6 +71,14 @@ def app
present thing, with: Entities::SomeThingElse
end

desc 'This tests the enum values in params and documentation.', entity: Entities::EnumValues, params: Entities::EnumValues.documentation
get '/enum_description_in_entity' do

enum_value = OpenStruct.new gender: 'Male', number: 1

present enum_value, with: Entities::EnumValues
end

add_swagger_documentation
end
end
Expand All @@ -88,6 +103,7 @@ def app
{ 'path' => '/something.{format}', 'description' => 'Operations about somethings' },
{ 'path' => '/thing.{format}', 'description' => 'Operations about things' },
{ 'path' => '/somethingelse.{format}', 'description' => 'Operations about somethingelses' },
{ 'path' => '/enum_description_in_entity.{format}', 'description' => 'Operations about enum_description_in_entities' },
{ 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }
]
end
Expand Down Expand Up @@ -157,4 +173,26 @@ def app
}
)
end

it 'includes enum values in params and documentation.' do
get '/swagger_doc/enum_description_in_entity.json'
result = JSON.parse(last_response.body)
expect(result['models']['EnumValues']).to eq(
'id' => 'EnumValues',
'properties' => {
'gender' => { 'type' => 'string', 'description' => 'Content of something.', 'enum' => %w(Male Female) },
'number' => { 'type' => 'integer', 'description' => 'Content of something.', 'enum' => [1, 2] }
}
)

expect(result['apis'][0]['operations'][0]).to include(
'parameters' =>
[
{ 'paramType' => 'query', 'name' => 'gender', 'description' => 'Content of something.', 'type' => 'string', 'required' => false, 'allowMultiple' => false, 'enum' => %w(Male Female) },
{ 'paramType' => 'query', 'name' => 'number', 'description' => 'Content of something.', 'type' => 'integer', 'required' => false, 'allowMultiple' => false, 'format' => 'int32', 'enum' => [1, 2] }
],
'type' => 'EnumValues'
)

end
end
16 changes: 8 additions & 8 deletions spec/form_params_spec.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ def app
params do
requires :id, type: Integer, desc: 'id of item'
requires :name, type: String, desc: 'name of item'
requires :conditions, type: Integer, desc: 'conditions of item', values: [1,2,3]
requires :conditions, type: Integer, desc: 'conditions of item', values: [1, 2, 3]
end
put '/items/:id' do
{}
Expand All @@ -24,7 +24,7 @@ def app
params do
requires :id, type: Integer, desc: 'id of item'
requires :name, type: String, desc: 'name of item'
optional :conditions, type: String, desc: 'conditions of item', values: Proc.new {['1','2']}
optional :conditions, type: String, desc: 'conditions of item', values: proc { %w(1 2) }
end
patch '/items/:id' do
{}
Expand Down Expand Up @@ -63,9 +63,9 @@ def app
'nickname' => 'PUT-items--id---format-',
'method' => 'PUT',
'parameters' => [
{ 'paramType' => 'path', 'name' => 'id', 'description' => 'id of item', 'type' => 'integer', 'required' => true, 'allowMultiple' => false, 'format' => 'int32' },
{ 'paramType' => 'form', 'name' => 'name', 'description' => 'name of item', 'type' => 'string', 'required' => true, 'allowMultiple' => false },
{ 'paramType' => 'form', 'name' => 'conditions', 'description' => 'conditions of item', 'type' => 'integer', 'required' => true, 'allowMultiple' => false, 'format' => 'int32', 'enum' => [1,2,3] }
{ 'paramType' => 'path', 'name' => 'id', 'description' => 'id of item', 'type' => 'integer', 'required' => true, 'allowMultiple' => false, 'format' => 'int32' },
{ 'paramType' => 'form', 'name' => 'name', 'description' => 'name of item', 'type' => 'string', 'required' => true, 'allowMultiple' => false },
{ 'paramType' => 'form', 'name' => 'conditions', 'description' => 'conditions of item', 'type' => 'integer', 'required' => true, 'allowMultiple' => false, 'format' => 'int32', 'enum' => [1, 2, 3] }
],
'type' => 'void'
},
Expand All @@ -75,9 +75,9 @@ def app
'nickname' => 'PATCH-items--id---format-',
'method' => 'PATCH',
'parameters' => [
{ 'paramType' => 'path', 'name' => 'id', 'description' => 'id of item', 'type' => 'integer', 'required' => true, 'allowMultiple' => false, 'format' => 'int32' },
{ 'paramType' => 'form', 'name' => 'name', 'description' => 'name of item', 'type' => 'string', 'required' => true, 'allowMultiple' => false },
{ 'paramType' => 'form', 'name' => 'conditions', 'description' => 'conditions of item', 'type' => 'string', 'required' => false, 'allowMultiple' => false, 'enum' => ['1','2'] }
{ 'paramType' => 'path', 'name' => 'id', 'description' => 'id of item', 'type' => 'integer', 'required' => true, 'allowMultiple' => false, 'format' => 'int32' },
{ 'paramType' => 'form', 'name' => 'name', 'description' => 'name of item', 'type' => 'string', 'required' => true, 'allowMultiple' => false },
{ 'paramType' => 'form', 'name' => 'conditions', 'description' => 'conditions of item', 'type' => 'string', 'required' => false, 'allowMultiple' => false, 'enum' => %w(1 2) }
],
'type' => 'void'
}
Expand Down

0 comments on commit f1e91ce

Please sign in to comment.