grape-swagger 0.20.2 → 0.20.3

data/spec/swagger_v2/param_type_spec.rb

@@ -19,16 +19,15 @@ describe 'Params Types' do
     get '/swagger_doc/action'
     expect(last_response.status).to eq 200
     body = JSON.parse last_response.body
-    body['paths']["/action"]['post']['parameters']
+    body['paths']['/action']['post']['parameters']
   end
 
   it 'reads param type correctly' do
     expect(subject).to eq [{
-      "in"=>"formData",
-      "name"=>"input",
-      "description"=>nil,
-      "type"=>"string",
-      "required"=>true
+      'in' => 'formData',
+      'name' => 'input',
+      'type' => 'string',
+      'required' => true
     }]
   end
 

data/spec/swagger_v2/param_values_spec.rb

@@ -45,12 +45,11 @@ describe 'Convert values to enum or Range' do
     subject(:plain_array) { first_parameter_info('plain_array') }
     it 'has values as array in enum' do
       expect(plain_array).to eq [{
-        "in"=>"formData",
-        "name"=>"letter",
-        "description"=>nil,
-        "type"=>"string",
-        "required"=>true,
-        "enum"=>["a", "b", "c"]
+        'in' => 'formData',
+        'name' => 'letter',
+        'type' => 'string',
+        'required' => true,
+        'enum' => %w(a b c)
       }]
     end
   end
@@ -60,12 +59,11 @@ describe 'Convert values to enum or Range' do
 
     it 'has proc returned values as array in enum' do
       expect(array_in_proc).to eq [{
-        "in"=>"formData",
-        "name"=>"letter",
-        "description"=>nil,
-        "type"=>"string",
-        "required"=>true,
-        "enum"=>["d", "e", "f"]
+        'in' => 'formData',
+        'name' => 'letter',
+        'type' => 'string',
+        'required' => true,
+        'enum' => %w(d e f)
       }]
     end
   end
@@ -75,11 +73,10 @@ describe 'Convert values to enum or Range' do
 
     it 'has letter range values' do
       expect(range_letter).to eq [{
-        "in"=>"formData",
-        "name"=>"letter",
-        "description"=>nil,
-        "type"=>"string",
-        "required"=>true
+        'in' => 'formData',
+        'name' => 'letter',
+        'type' => 'string',
+        'required' => true
       }]
     end
 
@@ -87,14 +84,13 @@ describe 'Convert values to enum or Range' do
 
     it 'has integer range values' do
       expect(range_integer).to eq [{
-        "in"=>"formData",
-        "name"=>"integer",
-        "description"=>nil,
-        "type"=>"integer",
-        "required"=>true,
-        "format"=>"int32",
-        "minimum"=>-5,
-        "maximum"=>5
+        'in' => 'formData',
+        'name' => 'integer',
+        'type' => 'integer',
+        'required' => true,
+        'format' => 'int32',
+        'minimum' => -5,
+        'maximum' => 5
       }]
     end
   end
@@ -133,12 +129,11 @@ describe 'Convert values to enum for float range and not arrays inside a proc',
 
     it 'has proc returned value as string in enum' do
       expect(non_array_in_proc).to eq [{
-        "in"=>"formData",
-        "name"=>"letter",
-        "description"=>nil,
-        "type"=>"string",
-        "required"=>true,
-        "enum"=>"string"
+        'in' => 'formData',
+        'name' => 'letter',
+        'type' => 'string',
+        'required' => true,
+        'enum' => 'string'
       }]
     end
   end
@@ -148,12 +143,11 @@ describe 'Convert values to enum for float range and not arrays inside a proc',
 
     it 'has float range values as string' do
       expect(range_float).to eq [{
-        "in"=>"formData",
-        "name"=>"float",
-        "description"=>nil,
-        "type"=>"number",
-        "required"=>true,
-        "format"=>"float"
+        'in' => 'formData',
+        'name' => 'float',
+        'type' => 'number',
+        'required' => true,
+        'format' => 'float'
       }]
     end
   end

data/spec/swagger_v2/params_array_spec.rb

@@ -17,9 +17,9 @@ describe 'Group Params as Array' do
 
       params do
         requires :typed_group, type: Array do
-          requires :id, type: Integer, desc: "integer given"
-          requires :name, type: String, desc: "string given"
-          optional :email, type: String, desc: "email given"
+          requires :id, type: Integer, desc: 'integer given'
+          requires :name, type: String, desc: 'string given'
+          optional :email, type: String, desc: 'email given'
           optional :others, type: Integer, values: [1, 2, 3]
         end
       end
@@ -31,33 +31,35 @@ describe 'Group Params as Array' do
     end
   end
 
-  describe "retrieves the documentation for grouped parameters" do
+  describe 'retrieves the documentation for grouped parameters' do
     subject do
       get '/swagger_doc/groups'
       JSON.parse(last_response.body)
     end
 
     specify do
-      expect(subject['paths']['/groups']['post']['parameters']).to eql([
-        {"in"=>"formData", "name"=>"required_group[][required_param_1]", "description"=>nil, "required"=>true, "type"=>"array", "items"=>{"type"=>"string"}},
-        {"in"=>"formData", "name"=>"required_group[][required_param_2]", "description"=>nil, "required"=>true, "type"=>"array", "items"=>{"type"=>"string"}}
-      ])
+      expect(subject['paths']['/groups']['post']['parameters']).to eql(
+        [
+          { 'in' => 'formData', 'name' => 'required_group[][required_param_1]', 'required' => true, 'type' => 'array', 'items' => { 'type' => 'string' } },
+          { 'in' => 'formData', 'name' => 'required_group[][required_param_2]', 'required' => true, 'type' => 'array', 'items' => { 'type' => 'string' } }
+        ])
     end
   end
 
-  describe "retrieves the documentation for typed group parameters" do
+  describe 'retrieves the documentation for typed group parameters' do
     subject do
       get '/swagger_doc/type_given'
       JSON.parse(last_response.body)
     end
 
     specify do
-      expect(subject['paths']['/type_given']['post']['parameters']).to eql([
-        {"in"=>"formData", "name"=>"typed_group[][id]", "description"=>"integer given", "required"=>true, "type"=>"array", "items"=>{"type"=>"integer"}},
-        {"in"=>"formData", "name"=>"typed_group[][name]", "description"=>"string given", "required"=>true, "type"=>"array", "items"=>{"type"=>"string"}},
-        {"in"=>"formData", "name"=>"typed_group[][email]", "description"=>"email given", "required"=>false, "type"=>"array", "items"=>{"type"=>"string"}},
-        {"in"=>"formData", "name"=>"typed_group[][others]", "description"=>nil, "required"=>false, "type"=>"array", "items"=>{"type"=>"integer"}, "enum"=>[1, 2, 3]}
-      ])
+      expect(subject['paths']['/type_given']['post']['parameters']).to eql(
+        [
+          { 'in' => 'formData', 'name' => 'typed_group[][id]', 'description' => 'integer given', 'required' => true, 'type' => 'array', 'items' => { 'type' => 'integer' } },
+          { 'in' => 'formData', 'name' => 'typed_group[][name]', 'description' => 'string given', 'required' => true, 'type' => 'array', 'items' => { 'type' => 'string' } },
+          { 'in' => 'formData', 'name' => 'typed_group[][email]', 'description' => 'email given', 'required' => false, 'type' => 'array', 'items' => { 'type' => 'string' } },
+          { 'in' => 'formData', 'name' => 'typed_group[][others]', 'required' => false, 'type' => 'array', 'items' => { 'type' => 'integer' }, 'enum' => [1, 2, 3] }
+        ])
     end
   end
 end

data/spec/swagger_v2/params_hash_spec.rb

@@ -17,9 +17,9 @@ describe 'Group Params as Hash' do
 
       params do
         requires :typed_group, type: Hash do
-          requires :id, type: Integer, desc: "integer given"
-          requires :name, type: String, desc: "string given"
-          optional :email, type: String, desc: "email given"
+          requires :id, type: Integer, desc: 'integer given'
+          requires :name, type: String, desc: 'string given'
+          optional :email, type: String, desc: 'email given'
           optional :others, type: Integer, values: [1, 2, 3]
         end
       end
@@ -31,7 +31,7 @@ describe 'Group Params as Hash' do
     end
   end
 
-  describe "grouped parameters" do
+  describe 'grouped parameters' do
     subject do
       get '/swagger_doc/use_groups'
       JSON.parse(last_response.body)
@@ -39,14 +39,15 @@ describe 'Group Params as Hash' do
 
     specify do
       expect(subject['paths']['/use_groups']['post']).to include('parameters')
-      expect(subject['paths']['/use_groups']['post']['parameters']).to eql([
-        {"in"=>"formData", "name"=>"required_group[required_param_1]", "description"=>nil, "type"=>"string", "required"=>true},
-        {"in"=>"formData", "name"=>"required_group[required_param_2]", "description"=>nil, "type"=>"string", "required"=>true}
-      ])
+      expect(subject['paths']['/use_groups']['post']['parameters']).to eql(
+        [
+          { 'in' => 'formData', 'name' => 'required_group[required_param_1]', 'type' => 'string', 'required' => true },
+          { 'in' => 'formData', 'name' => 'required_group[required_param_2]', 'type' => 'string', 'required' => true }
+        ])
     end
   end
 
-  describe "grouped parameters with given type" do
+  describe 'grouped parameters with given type' do
     subject do
       get '/swagger_doc/use_given_type'
       JSON.parse(last_response.body)
@@ -54,12 +55,13 @@ describe 'Group Params as Hash' do
 
     specify do
       expect(subject['paths']['/use_given_type']['post']).to include('parameters')
-      expect(subject['paths']['/use_given_type']['post']['parameters']).to eql([
-        {"in"=>"formData", "name"=>"typed_group[id]", "description"=>"integer given", "type"=>"integer", "required"=>true, "format"=>"int32"},
-        {"in"=>"formData", "name"=>"typed_group[name]", "description"=>"string given", "type"=>"string", "required"=>true},
-        {"in"=>"formData", "name"=>"typed_group[email]", "description"=>"email given", "type"=>"string", "required"=>false},
-        {"in"=>"formData", "name"=>"typed_group[others]", "description"=>nil, "type"=>"integer", "required"=>false, "format"=>"int32", "enum"=>[1, 2, 3]}
-      ])
+      expect(subject['paths']['/use_given_type']['post']['parameters']).to eql(
+        [
+          { 'in' => 'formData', 'name' => 'typed_group[id]', 'description' => 'integer given', 'type' => 'integer', 'required' => true, 'format' => 'int32' },
+          { 'in' => 'formData', 'name' => 'typed_group[name]', 'description' => 'string given', 'type' => 'string', 'required' => true },
+          { 'in' => 'formData', 'name' => 'typed_group[email]', 'description' => 'email given', 'type' => 'string', 'required' => false },
+          { 'in' => 'formData', 'name' => 'typed_group[others]', 'type' => 'integer', 'required' => false, 'format' => 'int32', 'enum' => [1, 2, 3] }
+        ])
     end
   end
 end

data/spec/swagger_v2/params_nested_spec.rb

@@ -33,31 +33,33 @@ describe 'nested group params' do
     end
   end
 
-  describe "retrieves the documentation for nested array parameters" do
+  describe 'retrieves the documentation for nested array parameters' do
     subject do
       get '/swagger_doc/nested_array'
       JSON.parse(last_response.body)
     end
 
     specify do
-      expect(subject['paths']['/nested_array']['post']['parameters']).to eql([
-        {"in"=>"formData", "name"=>"a_array[][param_1]", "description"=>nil, "required"=>true, "type"=>"array", "items"=>{"type"=>"integer"}},
-        {"in"=>"formData", "name"=>"a_array[][b_array][][param_2]", "description"=>nil, "required"=>true, "type"=>"array", "items"=>{"type"=>"string"}}
-      ])
+      expect(subject['paths']['/nested_array']['post']['parameters']).to eql(
+        [
+          { 'in' => 'formData', 'name' => 'a_array[][param_1]', 'required' => true, 'type' => 'array', 'items' => { 'type' => 'integer' } },
+          { 'in' => 'formData', 'name' => 'a_array[][b_array][][param_2]', 'required' => true, 'type' => 'array', 'items' => { 'type' => 'string' } }
+        ])
     end
   end
 
-  describe "retrieves the documentation for nested hash parameters" do
+  describe 'retrieves the documentation for nested hash parameters' do
     subject do
       get '/swagger_doc/nested_hash'
       JSON.parse(last_response.body)
     end
 
     specify do
-      expect(subject['paths']['/nested_hash']['post']['parameters']).to eql([
-        {"in"=>"formData", "name"=>"a_hash[param_1]", "description"=>nil, "required"=>true, "type"=>"integer", "format"=>"int32"},
-        {"in"=>"formData", "name"=>"a_hash[b_hash][param_2]", "description"=>nil, "required"=>true, "type"=>"string"}
-      ])
+      expect(subject['paths']['/nested_hash']['post']['parameters']).to eql(
+        [
+          { 'in' => 'formData', 'name' => 'a_hash[param_1]', 'required' => true, 'type' => 'integer', 'format' => 'int32' },
+          { 'in' => 'formData', 'name' => 'a_hash[b_hash][param_2]', 'required' => true, 'type' => 'string' }
+        ])
     end
   end
 end

data/spec/swagger_v2/reference_entity.rb

@@ -38,7 +38,7 @@ describe 'referenceEntity' do
           present kind, with: Entities::Kind
         end
 
-        add_swagger_documentation #models: [MyAPI::Entities::Something, MyAPI::Entities::Kind]
+        add_swagger_documentation # models: [MyAPI::Entities::Something, MyAPI::Entities::Kind]
       end
     end
   end
@@ -54,22 +54,22 @@ describe 'referenceEntity' do
 
   it 'should document specified models' do
     expect(subject['paths']['/kind']['get']['parameters']).to eq [{
-      "in"=>"query",
-      "name"=>"something",
-      "description"=>"something as parameter",
-      "type"=>"string",
-      "required"=>false,
-      "allowMultiple"=>false
+      'in' => 'query',
+      'name' => 'something',
+      'description' => 'something as parameter',
+      'type' => 'string',
+      'required' => false,
+      'allowMultiple' => false
     }]
 
     expect(subject['definitions'].keys).to include 'Something'
     expect(subject['definitions']['Something']).to eq(
-      "type"=>"object", "properties"=>{"text"=>{"type"=>"string"}}
+      'type' => 'object', 'properties' => { 'text' => { 'type' => 'string' } }
     )
 
     expect(subject['definitions'].keys).to include 'Kind'
     expect(subject['definitions']['Kind']).to eq(
-      "properties" => {"something"=>{"$ref"=>"#/definitions/Something"}}
+      'properties' => { 'something' => { '$ref' => '#/definitions/Something' } }
     )
   end
 end

data/spec/swagger_v2/response_model_spec.rb

@@ -10,11 +10,9 @@ describe 'responseModel' do
 
         class Relation < Grape::Entity
           expose :name, documentation: { type: 'string', desc: 'Name' }
-
         end
         class Tag < Grape::Entity
           expose :name, documentation: { type: 'string', desc: 'Name' }
-
         end
         class Error < Grape::Entity
           expose :code, documentation: { type: 'string', desc: 'Error code' }
@@ -34,8 +32,8 @@ describe 'responseModel' do
       class ResponseModelApi < Grape::API
         format :json
         desc 'This returns something',
-          is_array: true,
-          http_codes: [ { code: 200, message: 'OK', model: Entities::Something } ]
+             is_array: true,
+             http_codes: [{ code: 200, message: 'OK', model: Entities::Something }]
         get '/something' do
           something = OpenStruct.new text: 'something'
           present something, with: Entities::Something
@@ -75,67 +73,64 @@ describe 'responseModel' do
     JSON.parse(last_response.body)
   end
 
-  it "documents index action" do
-    expect(subject['paths']["/something"]["get"]["responses"]).to eq(
-      {
-        "200"=>{
-          "description"=>"OK",
-          "schema"=>{
-            "type"=>"array",
-            "items"=>{"$ref"=>"#/definitions/Something"}}
-        }}
+  it 'documents index action' do
+    expect(subject['paths']['/something']['get']['responses']).to eq(
+      '200' => {
+        'description' => 'OK',
+        'schema' => {
+          'type' => 'array',
+          'items' => { '$ref' => '#/definitions/Something' } }
+      }
     )
   end
 
   it 'should document specified models as show action' do
-    expect(subject['paths']["/something/{id}"]["get"]["responses"]).to eq(
-      {
-        "200"=>{
-          "description"=>"OK",
-          "schema"=>{"$ref"=>"#/definitions/Something"}
-        },
-        "403"=>{
-          "description"=>"Refused to return something",
-          "schema"=>{"$ref"=>"#/definitions/Error"}
-      }}
+    expect(subject['paths']['/something/{id}']['get']['responses']).to eq(
+      '200' => {
+        'description' => 'OK',
+        'schema' => { '$ref' => '#/definitions/Something' }
+      },
+      '403' => {
+        'description' => 'Refused to return something',
+        'schema' => { '$ref' => '#/definitions/Error' }
+      }
     )
     expect(subject['definitions'].keys).to include 'Error'
     expect(subject['definitions']['Error']).to eq(
-      {
-        "type"=>"object",
-        "description" => "This returns something or an error",
-        "properties"=>{
-          "code"=>{"type"=>"string","description"=>"Error code"},
-          "message"=>{"type"=>"string","description"=>"Error message"}
-      }}
+      'type' => 'object',
+      'description' => 'This returns something or an error',
+      'properties' => {
+        'code' => { 'type' => 'string', 'description' => 'Error code' },
+        'message' => { 'type' => 'string', 'description' => 'Error message' }
+      }
     )
 
     expect(subject['definitions'].keys).to include 'Something'
     expect(subject['definitions']['Something']).to eq(
-    { "type"=>"object",
-      "description" => "This returns something or an error",
-      "properties"=>
-        { "text"=>{"type"=>"string","description"=>"Content of something."},
-          "kind"=>{"$ref"=>"#/definitions/Kind","description"=>"The kind of this something."},
-          "kind2"=>{"$ref"=>"#/definitions/Kind","description"=>"Secondary kind."},
-          "kind3"=>{"$ref"=>"#/definitions/Kind","description"=>"Tertiary kind."},
-          "tags"=>{"type"=>"array", "items"=>{"$ref"=>"#/definitions/Tag"},"description"=>"Tags."},
-          "relation"=>{"$ref"=>"#/definitions/Relation","description"=>"A related model."}}}
+      'type' => 'object',
+      'description' => 'This returns something or an error',
+      'properties' =>
+          { 'text' => { 'type' => 'string', 'description' => 'Content of something.' },
+            'kind' => { '$ref' => '#/definitions/Kind', 'description' => 'The kind of this something.' },
+            'kind2' => { '$ref' => '#/definitions/Kind', 'description' => 'Secondary kind.' },
+            'kind3' => { '$ref' => '#/definitions/Kind', 'description' => 'Tertiary kind.' },
+            'tags' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/Tag' }, 'description' => 'Tags.' },
+            'relation' => { '$ref' => '#/definitions/Relation', 'description' => 'A related model.' } }
     )
 
     expect(subject['definitions'].keys).to include 'Kind'
     expect(subject['definitions']['Kind']).to eq(
-      "type"=>"object", "properties"=>{"title"=>{"type"=>"string","description"=>"Title of the kind."}}
+      'type' => 'object', 'properties' => { 'title' => { 'type' => 'string', 'description' => 'Title of the kind.' } }
     )
 
     expect(subject['definitions'].keys).to include 'Relation'
     expect(subject['definitions']['Relation']).to eq(
-      "type"=>"object", "properties"=>{"name"=>{"type"=>"string","description"=>"Name"}}
+      'type' => 'object', 'properties' => { 'name' => { 'type' => 'string', 'description' => 'Name' } }
     )
 
     expect(subject['definitions'].keys).to include 'Tag'
     expect(subject['definitions']['Tag']).to eq(
-      "type"=>"object", "properties"=>{"name"=>{"type"=>"string","description"=>"Name"}}
+      'type' => 'object', 'properties' => { 'name' => { 'type' => 'string', 'description' => 'Name' } }
     )
   end
 end
@@ -150,11 +145,9 @@ describe 'should build definition from given entity' do
 
         class Relation < Grape::Entity
           expose :name, documentation: { type: String, desc: 'Name' }
-
         end
         class Tag < Grape::Entity
           expose :name, documentation: { type: 'string', desc: 'Name' }
-
         end
 
         class SomeEntity < Grape::Entity
@@ -170,8 +163,8 @@ describe 'should build definition from given entity' do
       class ResponseEntityApi < Grape::API
         format :json
         desc 'This returns something',
-          is_array: true,
-          entity: Entities::SomeEntity
+             is_array: true,
+             entity: Entities::SomeEntity
         get '/some_entity' do
           something = OpenStruct.new text: 'something'
           present something, with: Entities::SomeEntity
@@ -191,22 +184,25 @@ describe 'should build definition from given entity' do
     JSON.parse(last_response.body)
   end
 
-  it "it prefer entity over others" do
-    expect(subject['definitions']).to eql({
-      "Kind"=>{"type"=>"object", "properties"=>{"id"=>{"type"=>"integer", "format"=>"int32", "description"=>"Title of the kind."}}},
-      "Tag"=>{"type"=>"object", "properties"=>{"name"=>{"type"=>"string", "description"=>"Name"}}},
-      "Relation"=>{"type"=>"object", "properties"=>{"name"=>{"type"=>"string", "description"=>"Name"}}},
-      "SomeEntity"=>{
-        "type"=>"object",
-        "properties"=>{
-          "text"=>{"type"=>"string", "description"=>"Content of something."},
-          "kind"=>{"$ref"=>"#/definitions/Kind", "description"=>"The kind of this something."},
-          "kind2"=>{"$ref"=>"#/definitions/Kind", "description"=>"Secondary kind."},
-          "kind3"=>{"$ref"=>"#/definitions/Kind", "description"=>"Tertiary kind."},
-          "tags"=>{"type"=>"array", "items"=>{"$ref"=>"#/definitions/Tag"}, "description"=>"Tags."},
-          "relation"=>{"$ref"=>"#/definitions/Relation", "description"=>"A related model."}
+  it 'it prefer entity over others' do
+    expect(subject['definitions']).to eql(
+      'Kind' => {
+        'type' => 'object',
+        'properties' => {
+          'id' => { 'type' => 'integer', 'format' => 'int32', 'description' => 'Title of the kind.' } } },
+      'Tag' => { 'type' => 'object', 'properties' => { 'name' => { 'type' => 'string', 'description' => 'Name' } } },
+      'Relation' => { 'type' => 'object', 'properties' => { 'name' => { 'type' => 'string', 'description' => 'Name' } } },
+      'SomeEntity' => {
+        'type' => 'object',
+        'properties' => {
+          'text' => { 'type' => 'string', 'description' => 'Content of something.' },
+          'kind' => { '$ref' => '#/definitions/Kind', 'description' => 'The kind of this something.' },
+          'kind2' => { '$ref' => '#/definitions/Kind', 'description' => 'Secondary kind.' },
+          'kind3' => { '$ref' => '#/definitions/Kind', 'description' => 'Tertiary kind.' },
+          'tags' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/Tag' }, 'description' => 'Tags.' },
+          'relation' => { '$ref' => '#/definitions/Relation', 'description' => 'A related model.' }
         },
-        "description"=>"This returns something"
-      }})
+        'description' => 'This returns something'
+      })
   end
 end