grape-swagger 0.20.2 → 0.20.3

data/spec/swagger_v2/boolean_params_spec.rb

@@ -24,7 +24,7 @@ describe 'Boolean Params' do
 
   it 'converts boolean types' do
     expect(subject).to eq [
-      {"in"=>"formData", "name"=>"a_boolean", "description"=>nil, "type"=>"boolean", "required"=>true}
+      { 'in' => 'formData', 'name' => 'a_boolean', 'type' => 'boolean', 'required' => true }
     ]
   end
 end

data/spec/swagger_v2/default_api_spec.rb

@@ -21,20 +21,19 @@ describe 'Default API' do
 
     it 'documents api' do
       expect(subject).to eq(
-        {
-          "info"=>{"title"=>"API title", "version"=>"v1"},
-          "swagger"=>"2.0",
-          "produces"=>["application/json"],
-          "host"=>"example.org",
-          "tags" => [{"name"=>"something", "description"=>"Operations about somethings"}],
-          "paths"=>{
-            "/something"=>{
-              "get"=>{
-                "description"=>"This gets something.",
-                "produces"=>["application/json"],
-                "tags"=>["something"],
-                "operationId"=>"getSomething",
-                "responses"=>{"200"=>{"description"=>"This gets something."}}}}}}
+        'info' => { 'title' => 'API title', 'version' => '0.0.1' },
+        'swagger' => '2.0',
+        'produces' => ['application/json'],
+        'host' => 'example.org',
+        'tags' => [{ 'name' => 'something', 'description' => 'Operations about somethings' }],
+        'paths' => {
+          '/something' => {
+            'get' => {
+              'description' => 'This gets something.',
+              'produces' => ['application/json'],
+              'tags' => ['something'],
+              'operationId' => 'getSomething',
+              'responses' => { '200' => { 'description' => 'This gets something.' } } } } }
       )
     end
 
@@ -65,21 +64,19 @@ describe 'Default API' do
     end
 
     it 'documents endpoint' do
-      expect(subject).to eq({
-        "info"=>{"title"=>"API title", "version"=>"v1"},
-        "swagger"=>"2.0",
-        "produces"=>["application/json"],
-        "host"=>"example.org",
-        "tags" => [{"name"=>"something", "description"=>"Operations about somethings"}],
-        "paths"=>{
-          "/something"=>{
-            "get"=>{
-              "description"=>"This gets something.",
-              "produces"=>["application/json"],
-              "tags"=>["something"],
-              "operationId"=>"getSomething",
-              "responses"=>{"200"=>{"description"=>"This gets something."}}}}}
-      })
+      expect(subject).to eq('info' => { 'title' => 'API title', 'version' => '0.0.1' },
+                            'swagger' => '2.0',
+                            'produces' => ['application/json'],
+                            'host' => 'example.org',
+                            'tags' => [{ 'name' => 'something', 'description' => 'Operations about somethings' }],
+                            'paths' => {
+                              '/something' => {
+                                'get' => {
+                                  'description' => 'This gets something.',
+                                  'produces' => ['application/json'],
+                                  'tags' => ['something'],
+                                  'operationId' => 'getSomething',
+                                  'responses' => { '200' => { 'description' => 'This gets something.' } } } } })
     end
   end
 

data/spec/swagger_v2/description_not_initialized.rb

@@ -2,7 +2,7 @@ require 'spec_helper'
 
 describe 'details' do
   describe 'details, pass markdown with redcarpet even with nil description and detail', unless: RUBY_PLATFORM.eql?('java') do
-    include_context "the api entities"
+    include_context 'the api entities'
 
     before :all do
       module TheApi
@@ -12,9 +12,9 @@ describe 'details' do
           desc nil,
                detail: nil,
                entity: Entities::UseResponse,
-               failure: [{code: 400, model: Entities::ApiError}]
+               failure: [{ code: 400, model: Entities::ApiError }]
           get '/use_gfm_rc_detail' do
-            { "declared_params" => declared(params) }
+            { 'declared_params' => declared(params) }
           end
 
           add_swagger_documentation markdown: GrapeSwagger::Markdown::RedcarpetAdapter.new

data/spec/swagger_v2/float_api_spec.rb

@@ -24,7 +24,7 @@ describe 'Float Params' do
 
   it 'converts float types' do
     expect(subject).to eq [
-      {"in"=>"formData", "name"=>"a_float", "description"=>nil, "type"=>"number", "required"=>true, "format"=>"float"}
+      { 'in' => 'formData', 'name' => 'a_float', 'type' => 'number', 'required' => true, 'format' => 'float' }
     ]
   end
 end

data/spec/swagger_v2/form_params_spec.rb

@@ -50,16 +50,16 @@ describe 'Form Params' do
 
   it 'retrieves the documentation form params' do
     expect(subject['paths'].length).to eq 2
-    expect(subject['paths'].keys).to include('/items','/items/{id}')
+    expect(subject['paths'].keys).to include('/items', '/items/{id}')
     expect(subject['paths']['/items'].keys).to include 'post'
     expect(subject['paths']['/items/{id}'].keys).to include('post', 'patch', 'put')
   end
 
   it 'treats Symbol parameter as form param' do
     expect(subject['paths']['/items/{id}']['post']['parameters']).to eq [
-      {"in"=>"path", "name"=>"id", "description"=>"id of item", "type"=>"integer", "required"=>true, "format"=>"int32"},
-      {"in"=>"formData", "name"=>"name", "description"=>"name of item", "type"=>"string", "required"=>true},
-      {"in"=>"formData", "name"=>"conditions", "description"=>"conditions of item", "type"=>"string", "required"=>false, "enum"=>["one", "two"]}
+      { 'in' => 'path', 'name' => 'id', 'description' => 'id of item', 'type' => 'integer', 'required' => true, 'format' => 'int32' },
+      { 'in' => 'formData', 'name' => 'name', 'description' => 'name of item', 'type' => 'string', 'required' => true },
+      { 'in' => 'formData', 'name' => 'conditions', 'description' => 'conditions of item', 'type' => 'string', 'required' => false, 'enum' => %w(one two) }
     ]
   end
 end

data/spec/swagger_v2/hide_api_spec.rb

@@ -35,28 +35,27 @@ describe 'a hide mounted api' do
   end
 
   it "retrieves swagger-documentation that doesn't include hidden endpoints" do
-    expect(subject).to eq({
-      "info"=>{"title"=>"API title", "version"=>"v1"},
-      "swagger"=>"2.0",
-      "produces"=>["application/xml", "application/json", "application/octet-stream", "text/plain"],
-      "host"=>"example.org",
-      "tags" => [{"name"=>"simple", "description"=>"Operations about simples"}, {"name"=>"lazy", "description"=>"Operations about lazies"}],
-      "paths"=>{
-        "/simple"=>{
-          "get"=>{
-            "description"=>"Show this endpoint",
-            "produces"=>["application/json"],
-            "tags"=>["simple"],
-            "operationId"=>"getSimple",
-            "responses"=>{"200"=>{"description"=>"Show this endpoint"}}}},
-        "/lazy"=>{
-          "get"=>{
-            "description"=>"Lazily show endpoint",
-            "produces"=>["application/json"],
-            "tags"=>["lazy"],
-            "operationId"=>"getLazy",
-            "responses"=>{"200"=>{"description"=>"Lazily show endpoint"}}}}}
-    })
+    expect(subject).to eq(
+      'info' => { 'title' => 'API title', 'version' => '0.0.1' },
+      'swagger' => '2.0',
+      'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
+      'host' => 'example.org',
+      'tags' => [{ 'name' => 'simple', 'description' => 'Operations about simples' }, { 'name' => 'lazy', 'description' => 'Operations about lazies' }],
+      'paths' => {
+        '/simple' => {
+          'get' => {
+            'description' => 'Show this endpoint',
+            'produces' => ['application/json'],
+            'tags' => ['simple'],
+            'operationId' => 'getSimple',
+            'responses' => { '200' => { 'description' => 'Show this endpoint' } } } },
+        '/lazy' => {
+          'get' => {
+            'description' => 'Lazily show endpoint',
+            'produces' => ['application/json'],
+            'tags' => ['lazy'],
+            'operationId' => 'getLazy',
+            'responses' => { '200' => { 'description' => 'Lazily show endpoint' } } } } })
   end
 end
 
@@ -91,38 +90,36 @@ describe 'a hide mounted api with same namespace' do
 
   it 'retrieves swagger-documentation on /swagger_doc' do
     get '/swagger_doc.json'
-    expect(JSON.parse(last_response.body)).to eq({
-      "info"=>{"title"=>"API title", "version"=>"v1"},
-      "swagger"=>"2.0",
-      "produces"=>["application/xml", "application/json", "application/octet-stream", "text/plain"],
-      "host"=>"example.org",
-      "tags" => [{"name"=>"simple", "description"=>"Operations about simples"}],
-      "paths"=>{
-        "/simple/show"=>{
-          "get"=>{
-            "description"=>"Show this endpoint",
-            "produces"=>["application/json"],
-            "operationId"=>"getSimpleShow",
-            "tags"=>["simple"], "responses"=>{"200"=>{"description"=>"Show this endpoint"}}}}}
-      })
+    expect(JSON.parse(last_response.body)).to eq(
+      'info' => { 'title' => 'API title', 'version' => '0.0.1' },
+      'swagger' => '2.0',
+      'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
+      'host' => 'example.org',
+      'tags' => [{ 'name' => 'simple', 'description' => 'Operations about simples' }],
+      'paths' => {
+        '/simple/show' => {
+          'get' => {
+            'description' => 'Show this endpoint',
+            'produces' => ['application/json'],
+            'operationId' => 'getSimpleShow',
+            'tags' => ['simple'], 'responses' => { '200' => { 'description' => 'Show this endpoint' } } } } })
   end
 
   it "retrieves the documentation for mounted-api that doesn't include hidden endpoints" do
     get '/swagger_doc/simple.json'
-    expect(JSON.parse(last_response.body)).to eq({
-      "info"=>{"title"=>"API title", "version"=>"v1"},
-      "swagger"=>"2.0",
-      "produces"=>["application/xml", "application/json", "application/octet-stream", "text/plain"],
-      "host"=>"example.org",
-      "tags" => [{"name"=>"simple", "description"=>"Operations about simples"}],
-      "paths"=>{
-        "/simple/show"=>{
-          "get"=>{
-            "description"=>"Show this endpoint",
-            "produces"=>["application/json"],
-            "tags"=>["simple"],
-            "operationId"=>"getSimpleShow",
-            "responses"=>{"200"=>{"description"=>"Show this endpoint"}}}}}
-      })
+    expect(JSON.parse(last_response.body)).to eq(
+      'info' => { 'title' => 'API title', 'version' => '0.0.1' },
+      'swagger' => '2.0',
+      'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
+      'host' => 'example.org',
+      'tags' => [{ 'name' => 'simple', 'description' => 'Operations about simples' }],
+      'paths' => {
+        '/simple/show' => {
+          'get' => {
+            'description' => 'Show this endpoint',
+            'produces' => ['application/json'],
+            'tags' => ['simple'],
+            'operationId' => 'getSimpleShow',
+            'responses' => { '200' => { 'description' => 'Show this endpoint' } } } } })
   end
 end

data/spec/swagger_v2/host.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'host in the swagger_doc' do
-  include_context "the api entities"
+  include_context 'the api entities'
 
   before :all do
     module TheApi

data/spec/swagger_v2/mounted_target_class_spec.rb

@@ -28,47 +28,45 @@ describe 'docs mounted separately from api' do
 
   it 'retrieves docs for actual api class' do
     get '/swagger_doc.json'
-    expect(JSON.parse(last_response.body)).to eq({
-      "info"=>{"title"=>"API title", "version"=>"v1"},
-      "swagger"=>"2.0",
-      "produces"=>["application/xml", "application/json", "application/octet-stream", "text/plain"],
-      "host"=>"example.org",
-      "tags"=>[{"name"=>"simple", "description"=>"Operations about simples"}],
-      "paths"=>{
-        "/simple"=>{
-          "get"=>{
-            "description"=>"This gets something.",
-            "produces"=>["application/json"],
-            "responses"=>{"200"=>{"description"=>"This gets something."}},
-            "tags"=>["simple"],
-            "operationId"=>"getSimple"
+    expect(JSON.parse(last_response.body)).to eq(
+      'info' => { 'title' => 'API title', 'version' => '0.0.1' },
+      'swagger' => '2.0',
+      'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
+      'host' => 'example.org',
+      'tags' => [{ 'name' => 'simple', 'description' => 'Operations about simples' }],
+      'paths' => {
+        '/simple' => {
+          'get' => {
+            'description' => 'This gets something.',
+            'produces' => ['application/json'],
+            'responses' => { '200' => { 'description' => 'This gets something.' } },
+            'tags' => ['simple'],
+            'operationId' => 'getSimple'
           }
         }
-      }
-    })
+      })
   end
 
   it 'retrieves docs for endpoint in actual api class' do
     get '/swagger_doc/simple.json'
-    expect(JSON.parse(last_response.body)).to eq({
-      "info"=>{"title"=>"API title", "version"=>"v1"},
-      "swagger"=>"2.0",
-      "tags" => [{"name"=>"simple", "description"=>"Operations about simples"}],
-      "produces"=>["application/xml", "application/json", "application/octet-stream", "text/plain"],
-      "host"=>"example.org",
-      "paths" => {
-        "/simple"=>{
-          "get"=>{
-            "description"=>"This gets something.",
-            "produces"=>["application/json"],
-            "responses"=>{
-              "200"=>{"description"=>"This gets something."}
+    expect(JSON.parse(last_response.body)).to eq(
+      'info' => { 'title' => 'API title', 'version' => '0.0.1' },
+      'swagger' => '2.0',
+      'tags' => [{ 'name' => 'simple', 'description' => 'Operations about simples' }],
+      'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
+      'host' => 'example.org',
+      'paths' => {
+        '/simple' => {
+          'get' => {
+            'description' => 'This gets something.',
+            'produces' => ['application/json'],
+            'responses' => {
+              '200' => { 'description' => 'This gets something.' }
             },
-            "tags"=>["simple"],
-            "operationId"=>"getSimple"
+            'tags' => ['simple'],
+            'operationId' => 'getSimple'
           }
         }
-      }
-    })
+      })
   end
 end

data/spec/swagger_v2/namespace_tags_prefix_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'namespace tags check while using prefix and version' do
-  include_context "namespace example"
+  include_context 'namespace example'
 
   before :all do
     module TheApi
@@ -21,19 +21,20 @@ describe 'namespace tags check while using prefix and version' do
     TagApi
   end
 
-  describe "retrieves swagger-documentation on /swagger_doc" do
+  describe 'retrieves swagger-documentation on /swagger_doc' do
     subject do
       get '/api/swagger_doc.json'
       JSON.parse(last_response.body)
     end
 
     specify do
-      expect(subject['tags']).to eql([
-        {"name"=>"hudson", "description"=>"Operations about hudsons"},
-        {"name"=>"colorado", "description"=>"Operations about colorados"},
-        {"name"=>"thames", "description"=>"Operations about thames"},
-        {"name"=>"niles", "description"=>"Operations about niles"}
-      ])
+      expect(subject['tags']).to eql(
+        [
+          { 'name' => 'hudson', 'description' => 'Operations about hudsons' },
+          { 'name' => 'colorado', 'description' => 'Operations about colorados' },
+          { 'name' => 'thames', 'description' => 'Operations about thames' },
+          { 'name' => 'niles', 'description' => 'Operations about niles' }
+        ])
 
       expect(subject['paths']['/api/v1/hudson']['get']['tags']).to eql(['hudson'])
       expect(subject['paths']['/api/v1/colorado/simple']['get']['tags']).to eql(['colorado'])
@@ -44,7 +45,6 @@ describe 'namespace tags check while using prefix and version' do
     end
   end
 
-
   describe 'retrieves the documentation for mounted-api' do
     subject do
       get '/api/swagger_doc/colorado.json'
@@ -52,12 +52,13 @@ describe 'namespace tags check while using prefix and version' do
     end
 
     specify do
-      expect(subject['tags']).to eql([
-        {"name"=>"hudson", "description"=>"Operations about hudsons"},
-        {"name"=>"colorado", "description"=>"Operations about colorados"},
-        {"name"=>"thames", "description"=>"Operations about thames"},
-        {"name"=>"niles", "description"=>"Operations about niles"}
-      ])
+      expect(subject['tags']).to eql(
+        [
+          { 'name' => 'hudson', 'description' => 'Operations about hudsons' },
+          { 'name' => 'colorado', 'description' => 'Operations about colorados' },
+          { 'name' => 'thames', 'description' => 'Operations about thames' },
+          { 'name' => 'niles', 'description' => 'Operations about niles' }
+        ])
 
       expect(subject['paths']['/api/v1/colorado/simple']['get']['tags']).to eql(['colorado'])
       expect(subject['paths']['/api/v1/colorado/simple-test']['get']['tags']).to eql(['colorado'])
@@ -70,12 +71,13 @@ describe 'namespace tags check while using prefix and version' do
       end
 
       specify do
-        expect(subject['tags']).to eql([
-          {"name"=>"hudson", "description"=>"Operations about hudsons"},
-          {"name"=>"colorado", "description"=>"Operations about colorados"},
-          {"name"=>"thames", "description"=>"Operations about thames"},
-          {"name"=>"niles", "description"=>"Operations about niles"}
-        ])
+        expect(subject['tags']).to eql(
+          [
+            { 'name' => 'hudson', 'description' => 'Operations about hudsons' },
+            { 'name' => 'colorado', 'description' => 'Operations about colorados' },
+            { 'name' => 'thames', 'description' => 'Operations about thames' },
+            { 'name' => 'niles', 'description' => 'Operations about niles' }
+          ])
 
         expect(subject['paths']['/api/v1/thames/simple_with_headers']['get']['tags']).to eql(['thames'])
       end

data/spec/swagger_v2/namespace_tags_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'namespace tags check' do
-  include_context "namespace example"
+  include_context 'namespace example'
 
   before :all do
     class TestApi < Grape::API
@@ -14,19 +14,20 @@ describe 'namespace tags check' do
     TestApi
   end
 
-  describe "retrieves swagger-documentation on /swagger_doc" do
+  describe 'retrieves swagger-documentation on /swagger_doc' do
     subject do
       get '/swagger_doc.json'
       JSON.parse(last_response.body)
     end
 
     specify do
-      expect(subject['tags']).to eql([
-        {"name"=>"hudson", "description"=>"Operations about hudsons"},
-        {"name"=>"colorado", "description"=>"Operations about colorados"},
-        {"name"=>"thames", "description"=>"Operations about thames"},
-        {"name"=>"niles", "description"=>"Operations about niles"}
-      ])
+      expect(subject['tags']).to eql(
+        [
+          { 'name' => 'hudson', 'description' => 'Operations about hudsons' },
+          { 'name' => 'colorado', 'description' => 'Operations about colorados' },
+          { 'name' => 'thames', 'description' => 'Operations about thames' },
+          { 'name' => 'niles', 'description' => 'Operations about niles' }
+        ])
 
       expect(subject['paths']['/hudson']['get']['tags']).to eql(['hudson'])
       expect(subject['paths']['/colorado/simple']['get']['tags']).to eql(['colorado'])
@@ -44,12 +45,13 @@ describe 'namespace tags check' do
     end
 
     specify do
-      expect(subject['tags']).to eql([
-        {"name"=>"hudson", "description"=>"Operations about hudsons"},
-        {"name"=>"colorado", "description"=>"Operations about colorados"},
-        {"name"=>"thames", "description"=>"Operations about thames"},
-        {"name"=>"niles", "description"=>"Operations about niles"}
-      ])
+      expect(subject['tags']).to eql(
+        [
+          { 'name' => 'hudson', 'description' => 'Operations about hudsons' },
+          { 'name' => 'colorado', 'description' => 'Operations about colorados' },
+          { 'name' => 'thames', 'description' => 'Operations about thames' },
+          { 'name' => 'niles', 'description' => 'Operations about niles' }
+        ])
 
       expect(subject['paths']['/colorado/simple']['get']['tags']).to eql(['colorado'])
       expect(subject['paths']['/colorado/simple-test']['get']['tags']).to eql(['colorado'])
@@ -62,12 +64,13 @@ describe 'namespace tags check' do
       end
 
       specify do
-        expect(subject['tags']).to eql([
-          {"name"=>"hudson", "description"=>"Operations about hudsons"},
-          {"name"=>"colorado", "description"=>"Operations about colorados"},
-          {"name"=>"thames", "description"=>"Operations about thames"},
-          {"name"=>"niles", "description"=>"Operations about niles"}
-        ])
+        expect(subject['tags']).to eql(
+          [
+            { 'name' => 'hudson', 'description' => 'Operations about hudsons' },
+            { 'name' => 'colorado', 'description' => 'Operations about colorados' },
+            { 'name' => 'thames', 'description' => 'Operations about thames' },
+            { 'name' => 'niles', 'description' => 'Operations about niles' }
+          ])
 
         expect(subject['paths']['/thames/simple_with_headers']['get']['tags']).to eql(['thames'])
       end