grape-swagger 0.20.2 → 0.20.3

data/spec/swagger_v2/simple_mounted_api_spec.rb

@@ -10,46 +10,54 @@ describe 'a simple mounted api' do
       end
 
       desc 'This gets something.',
-        notes: '_test_'
+           notes: '_test_'
 
       get '/simple' do
         { bla: 'something' }
       end
 
       desc 'This gets something for URL using - separator.',
-        notes: '_test_'
+           notes: '_test_'
 
       get '/simple-test' do
         { bla: 'something' }
       end
 
+      head '/simple-head-test' do
+        status 200
+      end
+
+      options '/simple-options-test' do
+        status 200
+      end
+
       desc 'this gets something else',
-        headers: {
-          'XAuthToken' => { description: 'A required header.', required: true },
-          'XOtherHeader' => { description: 'An optional header.', required: false }
-        },
-        http_codes: [
-          { code: 403, message: 'invalid pony' },
-          { code: 405, message: 'no ponies left!' }
-        ]
+           headers: {
+             'XAuthToken' => { description: 'A required header.', required: true },
+             'XOtherHeader' => { description: 'An optional header.', required: false }
+           },
+           http_codes: [
+             { code: 403, message: 'invalid pony' },
+             { code: 405, message: 'no ponies left!' }
+           ]
 
       get '/simple_with_headers' do
         { bla: 'something_else' }
       end
 
       desc 'this takes an array of parameters',
-        params: {
-          'items[]' => { description: 'array of items', is_array: true }
-        }
+           params: {
+             'items[]' => { description: 'array of items', is_array: true }
+           }
 
       post '/items' do
         {}
       end
 
       desc 'this uses a custom parameter',
-        params: {
-          'custom' => { type: CustomType, description: 'array of items', is_array: true }
-        }
+           params: {
+             'custom' => { type: CustomType, description: 'array of items', is_array: true }
+           }
 
       get '/custom' do
         {}
@@ -66,78 +74,88 @@ describe 'a simple mounted api' do
     SimpleApi
   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).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"=>"simple-test", "description"=>"Operations about simple-tests"}, {"name"=>"simple_with_headers", "description"=>"Operations about simple_with_headers"}, {"name"=>"items", "description"=>"Operations about items"}, {"name"=>"custom", "description"=>"Operations about customs"}],
-        "paths"=>{
-          "/simple"=>{
-            "get"=>{
-              "description"=>"This gets something.",
-              "produces"=>["application/json"],
-              "tags"=>["simple"],
-              "operationId"=>"getSimple",
-              "responses"=>{"200"=>{"description"=>"This gets something."}}}},
-          "/simple-test"=>{
-            "get"=>{
-              "description"=>"This gets something for URL using - separator.",
-              "produces"=>["application/json"],
-              "tags"=>["simple-test"],
-              "operationId"=>"getSimpleTest",
-              "responses"=>{"200"=>{"description"=>"This gets something for URL using - separator."}}}},
-          "/simple_with_headers"=>{
-            "get"=>{
-              "description"=>"this gets something else",
-              "produces"=>["application/json"],
-              "parameters"=>[
-                {"in"=>"header", "name"=>"XAuthToken", "description"=>"A required header.", "type"=>"string", "required"=>true},
-                {"in"=>"header", "name"=>"XOtherHeader", "description"=>"An optional header.", "type"=>"string", "required"=>false}],
-              "tags"=>["simple_with_headers"],
-              "operationId"=>"getSimpleWithHeaders",
-              "responses"=>{
-                "200"=>{"description"=>"this gets something else"},
-                "403"=>{"description"=>"invalid pony"},
-                "405"=>{"description"=>"no ponies left!"}}
-          }},
-          "/items"=>{
-            "post"=>{
-              "description"=>"this takes an array of parameters",
-              "produces"=>["application/json"],
-              "consumes"=>["application/json"],
-              "parameters"=>[{"in"=>"formData", "name"=>"items[]", "description"=>"array of items", "required"=>false, "type"=>"array", "items"=>{"type"=>"string"}}],
-              "tags"=>["items"],
-              "operationId"=>"postItems",
-              "responses"=>{"201"=>{"description"=>"this takes an array of parameters", "schema"=>{"$ref"=>"#/definitions/Item"}}}
-          }},
-          "/custom"=>{
-            "get"=>{
-              "description"=>"this uses a custom parameter",
-              "produces"=>["application/json"],
-              "parameters"=>[{"in"=>"formData", "name"=>"custom", "description"=>"array of items", "required"=>false, "type"=>"array", "items"=>{"type"=>"CustomType"}}],
-              "tags"=>["custom"],
-              "operationId"=>"getCustom",
-              "responses"=>{"200"=>{"description"=>"this uses a custom parameter", "schema"=>{"$ref"=>"#/definitions/Custom"}}}}
-      }},
-      "definitions"=>{
-        "Item"=>{
-          "type"=>"object",
-          "properties"=>{"items[]"=>{"type"=>"string"}},
-          "description"=>"this takes an array of parameters"
+      expect(subject).to eq(
+        'info' => {
+          'title' => 'API title', 'version' => '0.0.1'
         },
-        "Custom"=>{
-          "type"=>"object",
-          "properties"=>{"custom"=>{"type"=>"CustomType"}},
-          "description"=>"this uses a custom parameter"
-        }}})
+        'swagger' => '2.0',
+        'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
+        'host' => 'example.org',
+        'tags' => [
+          { 'name' => 'simple', 'description' => 'Operations about simples' },
+          { 'name' => 'simple-test', 'description' => 'Operations about simple-tests' },
+          { 'name' => 'simple-head-test', 'description' => 'Operations about simple-head-tests' },
+          { 'name' => 'simple-options-test', 'description' => 'Operations about simple-options-tests' },
+          { 'name' => 'simple_with_headers', 'description' => 'Operations about simple_with_headers' },
+          { 'name' => 'items', 'description' => 'Operations about items' },
+          { 'name' => 'custom', 'description' => 'Operations about customs' }],
+        'paths' => {
+          '/simple' => {
+            'get' => {
+              'description' => 'This gets something.',
+              'produces' => ['application/json'],
+              'tags' => ['simple'],
+              'operationId' => 'getSimple',
+              'responses' => { '200' => { 'description' => 'This gets something.' } } } },
+          '/simple-test' => {
+            'get' => {
+              'description' => 'This gets something for URL using - separator.',
+              'produces' => ['application/json'],
+              'tags' => ['simple-test'],
+              'operationId' => 'getSimpleTest',
+              'responses' => { '200' => { 'description' => 'This gets something for URL using - separator.' } } } },
+          '/simple-head-test' => {
+            'head' => {
+              'produces' => ['application/json'],
+              'responses' => { '200' => { 'description' => 'head SimpleHeadTest' } },
+              'tags' => ['simple-head-test'],
+              'operationId' => 'headSimpleHeadTest' } },
+          '/simple-options-test' => {
+            'options' => {
+              'produces' => ['application/json'],
+              'responses' => { '200' => { 'description' => 'option SimpleOptionsTest' } },
+              'tags' => ['simple-options-test'],
+              'operationId' => 'optionsSimpleOptionsTest' } },
+          '/simple_with_headers' => {
+            'get' => {
+              'description' => 'this gets something else',
+              'produces' => ['application/json'],
+              'parameters' => [
+                { 'in' => 'header', 'name' => 'XAuthToken', 'description' => 'A required header.', 'type' => 'string', 'required' => true },
+                { 'in' => 'header', 'name' => 'XOtherHeader', 'description' => 'An optional header.', 'type' => 'string', 'required' => false }],
+              'tags' => ['simple_with_headers'],
+              'operationId' => 'getSimpleWithHeaders',
+              'responses' => {
+                '200' => { 'description' => 'this gets something else' },
+                '403' => { 'description' => 'invalid pony' },
+                '405' => { 'description' => 'no ponies left!' } }
+            } },
+          '/items' => {
+            'post' => {
+              'description' => 'this takes an array of parameters',
+              'produces' => ['application/json'],
+              'consumes' => ['application/json'],
+              'parameters' => [{ 'in' => 'formData', 'name' => 'items[]', 'description' => 'array of items', 'required' => false, 'type' => 'array', 'items' => { 'type' => 'string' } }],
+              'tags' => ['items'],
+              'operationId' => 'postItems',
+              'responses' => { '201' => { 'description' => 'this takes an array of parameters' } }
+            } },
+          '/custom' => {
+            'get' => {
+              'description' => 'this uses a custom parameter',
+              'produces' => ['application/json'],
+              'parameters' => [{ 'in' => 'formData', 'name' => 'custom', 'description' => 'array of items', 'required' => false, 'type' => 'array', 'items' => { 'type' => 'CustomType' } }],
+              'tags' => ['custom'],
+              'operationId' => 'getCustom',
+              'responses' => { '200' => { 'description' => 'this uses a custom parameter' } } }
+          } })
     end
   end
 
@@ -148,21 +166,28 @@ describe 'a simple mounted api' do
     end
 
     specify 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"=>"simple-test", "description"=>"Operations about simple-tests"}, {"name"=>"simple_with_headers", "description"=>"Operations about simple_with_headers"}, {"name"=>"items", "description"=>"Operations about items"}, {"name"=>"custom", "description"=>"Operations about customs"}],
-        "paths"=>{
-          "/simple"=>{
-            "get"=>{
-              "description"=>"This gets something.",
-              "produces"=>["application/json"],
-              "tags"=>["simple"],
-              "operationId"=>"getSimple",
-              "responses"=>{"200"=>{"description"=>"This gets something."}}}}
-        }})
+      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' => 'simple-test', 'description' => 'Operations about simple-tests' },
+          { 'name' => 'simple-head-test', 'description' => 'Operations about simple-head-tests' },
+          { 'name' => 'simple-options-test', 'description' => 'Operations about simple-options-tests' },
+          { 'name' => 'simple_with_headers', 'description' => 'Operations about simple_with_headers' },
+          { 'name' => 'items', 'description' => 'Operations about items' },
+          { 'name' => 'custom', 'description' => 'Operations about customs' }],
+        'paths' => {
+          '/simple' => {
+            'get' => {
+              'description' => 'This gets something.',
+              'produces' => ['application/json'],
+              'tags' => ['simple'],
+              'operationId' => 'getSimple',
+              'responses' => { '200' => { 'description' => 'This gets something.' } } } }
+        })
     end
   end
 
@@ -174,21 +199,28 @@ describe 'a simple mounted api' do
       end
 
       specify 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"=>"simple-test", "description"=>"Operations about simple-tests"}, {"name"=>"simple_with_headers", "description"=>"Operations about simple_with_headers"}, {"name"=>"items", "description"=>"Operations about items"}, {"name"=>"custom", "description"=>"Operations about customs"}],
-          "paths"=>{
-            "/simple-test"=>{
-              "get"=>{
-                "description"=>"This gets something for URL using - separator.",
-                "produces"=>["application/json"],
-                "tags"=>["simple-test"],
-                "operationId"=>"getSimpleTest",
-                "responses"=>{"200"=>{"description"=>"This gets something for URL using - separator."}}}}
-          }})
+        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' => 'simple-test', 'description' => 'Operations about simple-tests' },
+            { 'name' => 'simple-head-test', 'description' => 'Operations about simple-head-tests' },
+            { 'name' => 'simple-options-test', 'description' => 'Operations about simple-options-tests' },
+            { 'name' => 'simple_with_headers', 'description' => 'Operations about simple_with_headers' },
+            { 'name' => 'items', 'description' => 'Operations about items' },
+            { 'name' => 'custom', 'description' => 'Operations about customs' }],
+          'paths' => {
+            '/simple-test' => {
+              'get' => {
+                'description' => 'This gets something for URL using - separator.',
+                'produces' => ['application/json'],
+                'tags' => ['simple-test'],
+                'operationId' => 'getSimpleTest',
+                'responses' => { '200' => { 'description' => 'This gets something for URL using - separator.' } } } }
+          })
       end
     end
 
@@ -199,21 +231,21 @@ describe 'a simple mounted api' do
       end
 
       specify do
-        expect(subject['paths']).to eq({
-          "/simple_with_headers"=>{
-            "get"=>{
-              "description"=>"this gets something else",
-              "produces"=>["application/json"],
-              "parameters"=>[
-                {"in"=>"header", "name"=>"XAuthToken", "description"=>"A required header.", "type"=>"string", "required"=>true},
-                {"in"=>"header", "name"=>"XOtherHeader", "description"=>"An optional header.", "type"=>"string", "required"=>false}],
-              "tags"=>["simple_with_headers"],
-              "operationId"=>"getSimpleWithHeaders",
-              "responses"=>{
-                "200"=>{"description"=>"this gets something else"},
-                "403"=>{"description"=>"invalid pony"},
-                "405"=>{"description"=>"no ponies left!"}}}
-          }})
+        expect(subject['paths']).to eq(
+          '/simple_with_headers' => {
+            'get' => {
+              'description' => 'this gets something else',
+              'produces' => ['application/json'],
+              'parameters' => [
+                { 'in' => 'header', 'name' => 'XAuthToken', 'description' => 'A required header.', 'type' => 'string', 'required' => true },
+                { 'in' => 'header', 'name' => 'XOtherHeader', 'description' => 'An optional header.', 'type' => 'string', 'required' => false }],
+              'tags' => ['simple_with_headers'],
+              'operationId' => 'getSimpleWithHeaders',
+              'responses' => {
+                '200' => { 'description' => 'this gets something else' },
+                '403' => { 'description' => 'invalid pony' },
+                '405' => { 'description' => 'no ponies left!' } } }
+          })
       end
     end
 
@@ -224,17 +256,17 @@ describe 'a simple mounted api' do
       end
 
       specify do
-        expect(subject['paths']).to eq({
-          "/items"=>{
-            "post"=>{
-              "description"=>"this takes an array of parameters",
-              "produces"=>["application/json"],
-              "consumes"=>["application/json"],
-              "parameters"=>[{"in"=>"formData", "name"=>"items[]", "description"=>"array of items", "required"=>false, "type"=>"array", "items"=>{"type"=>"string"}}],
-              "tags"=>["items"],
-              "operationId"=>"postItems",
-              "responses"=>{"201"=>{"description"=>"this takes an array of parameters", "schema"=>{"$ref"=>"#/definitions/Item"}}}}
-          }})
+        expect(subject['paths']).to eq(
+          '/items' => {
+            'post' => {
+              'description' => 'this takes an array of parameters',
+              'produces' => ['application/json'],
+              'consumes' => ['application/json'],
+              'parameters' => [{ 'in' => 'formData', 'name' => 'items[]', 'description' => 'array of items', 'required' => false, 'type' => 'array', 'items' => { 'type' => 'string' } }],
+              'tags' => ['items'],
+              'operationId' => 'postItems',
+              'responses' => { '201' => { 'description' => 'this takes an array of parameters' } } }
+          })
       end
     end
 
@@ -245,16 +277,16 @@ describe 'a simple mounted api' do
       end
 
       specify do
-        expect(subject['paths']).to eq({
-          "/custom"=>{
-            "get"=>{
-              "description"=>"this uses a custom parameter",
-              "produces"=>["application/json"],
-              "parameters"=>[{"in"=>"formData", "name"=>"custom", "description"=>"array of items", "required"=>false, "type"=>"array", "items"=>{"type"=>"CustomType"}}],
-              "tags"=>["custom"],
-              "operationId"=>"getCustom",
-              "responses"=>{"200"=>{"description"=>"this uses a custom parameter", "schema"=>{"$ref"=>"#/definitions/Custom"}}}}
-          }})
+        expect(subject['paths']).to eq(
+          '/custom' => {
+            'get' => {
+              'description' => 'this uses a custom parameter',
+              'produces' => ['application/json'],
+              'parameters' => [{ 'in' => 'formData', 'name' => 'custom', 'description' => 'array of items', 'required' => false, 'type' => 'array', 'items' => { 'type' => 'CustomType' } }],
+              'tags' => ['custom'],
+              'operationId' => 'getCustom',
+              'responses' => { '200' => { 'description' => 'this uses a custom parameter' } } }
+          })
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.20.2
+  version: 0.20.3
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-22 00:00:00.000000000 Z
+date: 2016-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -17,9 +17,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.0
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 0.14.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,9 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.0
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: 0.14.0
 - !ruby/object:Gem::Dependency
   name: grape-entity
   requirement: !ruby/object:Gem::Requirement
@@ -284,9 +278,11 @@ files:
 - lib/grape-swagger/doc_methods/tag_name_description.rb
 - lib/grape-swagger/endpoint.rb
 - lib/grape-swagger/errors.rb
+- lib/grape-swagger/grape/route.rb
 - lib/grape-swagger/markdown/kramdown_adapter.rb
 - lib/grape-swagger/markdown/redcarpet_adapter.rb
 - lib/grape-swagger/version.rb
+- spec/issues/403_versions_spec.rb
 - spec/lib/data_type_spec.rb
 - spec/lib/endpoint_spec.rb
 - spec/lib/extensions_spec.rb
@@ -297,7 +293,6 @@ files:
 - spec/lib/produces_consumes_spec.rb
 - spec/markdown/kramdown_adapter_spec.rb
 - spec/markdown/redcarpet_adapter_spec.rb
-- spec/params_entity_spec.rb
 - spec/spec_helper.rb
 - spec/support/api_swagger_v2_result.rb
 - spec/support/grape_version.rb
@@ -366,6 +361,7 @@ specification_version: 4
 summary: A simple way to add auto generated documentation to your Grape API that can
   be displayed with Swagger.
 test_files:
+- spec/issues/403_versions_spec.rb
 - spec/lib/data_type_spec.rb
 - spec/lib/endpoint_spec.rb
 - spec/lib/extensions_spec.rb
@@ -376,7 +372,6 @@ test_files:
 - spec/lib/produces_consumes_spec.rb
 - spec/markdown/kramdown_adapter_spec.rb
 - spec/markdown/redcarpet_adapter_spec.rb
-- spec/params_entity_spec.rb
 - spec/spec_helper.rb
 - spec/support/api_swagger_v2_result.rb
 - spec/support/grape_version.rb