grape-swagger 0.20.2 → 0.20.3

data/spec/support/namespace_tags.rb

@@ -1,11 +1,9 @@
-RSpec.shared_context "namespace example" do
+RSpec.shared_context 'namespace example' do
   before :all do
     module TheApi
-
       class CustomType; end
 
       class NamespaceApi < Grape::API
-
         namespace :hudson do
           desc 'Document root'
           get '/' do
@@ -14,7 +12,7 @@ RSpec.shared_context "namespace example" do
 
         namespace :colorado do
           desc 'This gets something.',
-            notes: '_test_'
+               notes: '_test_'
 
           get '/simple' do
             { bla: 'something' }
@@ -23,7 +21,7 @@ RSpec.shared_context "namespace example" do
 
         namespace :colorado do
           desc 'This gets something for URL using - separator.',
-            notes: '_test_'
+               notes: '_test_'
 
           get '/simple-test' do
             { bla: 'something' }
@@ -32,14 +30,14 @@ RSpec.shared_context "namespace example" do
 
         namespace :thames do
           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' }
@@ -48,9 +46,9 @@ RSpec.shared_context "namespace example" do
 
         namespace :niles do
           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
             {}
@@ -59,9 +57,9 @@ RSpec.shared_context "namespace example" do
 
         namespace :niles do
           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
             {}

data/spec/support/the_api_entities.rb

@@ -1,4 +1,4 @@
-RSpec.shared_context "the api entities" do
+RSpec.shared_context 'the api entities' do
   before :all do
     module TheApi
       module Entities
@@ -47,6 +47,4 @@ RSpec.shared_context "the api entities" do
       end
     end
   end
-
-
 end

data/spec/support/the_paths_definitions.rb

@@ -1,94 +1,104 @@
-RSpec.shared_context "the api paths/defs" do
-  let(:paths) {{
-    "/in_body" => {
-      post: {
-        produces: ["application/json"],
-        consumes: ["application/json"],
-        parameters: [
-          {in: "body", name: "in_body_1", description: "in_body_1", type: "integer", format: "int32", required: true},
-          {in: "body", name: "in_body_2", description: "in_body_2", type: "string", required: false},
-          {in: "body", name: "in_body_3", description: "in_body_3", type: "string", required: false}
-        ],
-        responses: {201 => {description: "post in body /wo entity", schema: {"$ref" => "#/definitions/InBody"}}},
-        tags: ["in_body"],
-        operationId: "postInBody"
-      },
-      get: {
-        produces: ["application/json"],
-        responses: {200 => {description: "get in path /wo entity", schema: {"$ref" => "#/definitions/InBody"}}},
-        tags: ["in_body"],
-        operationId: "getInBody"
-      }
-    },
-    "/in_body/{key}" => {
-      put: {
-        produces: ["application/json"],
-        consumes: ["application/json"],
-        parameters: [
-          {in: "path", name: "key", description: nil, type: "integer", format: "int32", required: true},
-          {in: "body", name: "in_body_1", description: "in_body_1", type: "integer", format: "int32", required: true},
-          {in: "body", name: "in_body_2", description: "in_body_2", type: "string", required: false},
-          {in: "body", name: "in_body_3", description: "in_body_3", type: "string", required: false}
-        ],
-        responses: {200 => {description: "put in body /wo entity", schema: {"$ref" => "#/definitions/InBody"}}},
-        tags: ["in_body"],
-        operationId: "putInBodyKey"
+RSpec.shared_context 'the api paths/defs' do
+  let(:paths) do
+    {
+      '/in_body' => {
+        post: {
+          produces: ['application/json'],
+          consumes: ['application/json'],
+          parameters: [
+            { in: 'body', name: 'in_body_1', description: 'in_body_1', type: 'integer', format: 'int32', required: true },
+            { in: 'body', name: 'in_body_2', description: 'in_body_2', type: 'string', required: false },
+            { in: 'body', name: 'in_body_3', description: 'in_body_3', type: 'string', required: false }
+          ],
+          responses: { 201 => { description: 'post in body /wo entity', schema: { '$ref' => '#/definitions/InBody' } } },
+          tags: ['in_body'],
+          operationId: 'postInBody'
+        },
+        get: {
+          produces: ['application/json'],
+          responses: { 200 => { description: 'get in path /wo entity', schema: { '$ref' => '#/definitions/InBody' } } },
+          tags: ['in_body'],
+          operationId: 'getInBody'
+        }
       },
-      get: {
-        produces: ["application/json"],
+      '/in_body/{key}' => {
+        put: {
+          produces: ['application/json'],
+          consumes: ['application/json'],
+          parameters: [
+            { in: 'path', name: 'key', description: nil, type: 'integer', format: 'int32', required: true },
+            { in: 'body', name: 'in_body_1', description: 'in_body_1', type: 'integer', format: 'int32', required: true },
+            { in: 'body', name: 'in_body_2', description: 'in_body_2', type: 'string', required: false },
+            { in: 'body', name: 'in_body_3', description: 'in_body_3', type: 'string', required: false }
+          ],
+          responses: { 200 => { description: 'put in body /wo entity', schema: { '$ref' => '#/definitions/InBody' } } },
+          tags: ['in_body'],
+          operationId: 'putInBodyKey'
+        },
+        get: {
+          produces: ['application/json'],
+          parameters: [
+            { in: 'path', name: 'key', description: nil, type: 'integer', format: 'int32', required: true }
+          ],
+          responses: { 200 => { description: 'get in path /wo entity', schema: { '$ref' => '#/definitions/InBody' } } },
+          tags: ['in_body'],
+          operationId: 'getInBodyKey'
+        } }
+    }
+  end
+
+  let(:found_path) do
+    {
+      post: {
+        produces: ['application/json'],
+        consumes: ['application/json'],
         parameters: [
-          {in: "path", name: "key", description: nil, type: "integer", format: "int32", required: true}
+          { in: 'body', name: 'in_body_1', description: 'in_body_1', type: 'integer', format: 'int32', required: true },
+          { in: 'body', name: 'in_body_2', description: 'in_body_2', type: 'string', required: false },
+          { in: 'body', name: 'in_body_3', description: 'in_body_3', type: 'string', required: false }
         ],
-        responses: {200 => {description: "get in path /wo entity", schema: {"$ref" => "#/definitions/InBody"}}},
-        tags: ["in_body"],
-        operationId: "getInBodyKey"
-    }}
-  }}
+        responses: { 201 => { description: 'post in body /wo entity', schema: { '$ref' => '#/definitions/InBody' } } },
+        tags: ['in_body'],
+        operationId: 'postInBody'
+      } }
+  end
 
-  let(:found_path) {{
-    post: {
-      produces: ["application/json"],
-      consumes: ["application/json"],
-      parameters: [
-        {in: "body", name: "in_body_1", description: "in_body_1", type: "integer", format: "int32", required: true},
-        {in: "body", name: "in_body_2", description: "in_body_2", type: "string", required: false},
-        {in: "body", name: "in_body_3", description: "in_body_3", type: "string", required: false}
-      ],
-      responses: {201 =>  {description: "post in body /wo entity", schema: {"$ref"=>"#/definitions/InBody"}}},
-      tags: ["in_body"],
-      operationId: "postInBody"
-  }}}
+  let(:definitions) do
+    {
+      'InBody' => {
+        type: 'object',
+        properties: {
+          in_body_1: { type: 'integer', format: 'int32' },
+          in_body_2: { type: 'string' },
+          in_body_3: { type: 'string' },
+          key: { type: 'integer', format: 'int32' }
+        } } }
+  end
 
-  let(:definitions) {{
-    "InBody" => {
-      type: "object",
+  let(:expected_post_defs) do
+    {
+      type: 'object',
       properties: {
-        in_body_1: {type: "integer", format: "int32"},
-        in_body_2: {type: "string"},
-        in_body_3: {type: "string"},
-        key: {type: "integer", format: "int32"}
-  }}}}
-
-  let(:expected_post_defs) {{
-    type: "object",
-    properties: {
-      in_body_1: {type: "integer", format: "int32", description: "in_body_1"},
-      in_body_2: {type: "string", description: "in_body_2"},
-      in_body_3: {type: "string", description: "in_body_3"}
-    },
-    :required=>[:in_body_1]
-  }}
+        in_body_1: { type: 'integer', format: 'int32', description: 'in_body_1' },
+        in_body_2: { type: 'string', description: 'in_body_2' },
+        in_body_3: { type: 'string', description: 'in_body_3' }
+      },
+      required: [:in_body_1]
+    }
+  end
 
-  let(:expected_put_defs) {{
-    type: "object",
-    properties: {
-      in_body_1: {type: "integer", format: "int32", description: "in_body_1"},
-      in_body_2: {type: "string", description: "in_body_2"},
-      in_body_3: {type: "string", description: "in_body_3"},
-      key: {type: "integer", format: "int32", readOnly: true}
-    },
-    :required=>[:in_body_1]
-  }}
+  let(:expected_put_defs) do
+    {
+      type: 'object',
+      properties: {
+        in_body_1: { type: 'integer', format: 'int32', description: 'in_body_1' },
+        in_body_2: { type: 'string', description: 'in_body_2' },
+        in_body_3: { type: 'string', description: 'in_body_3' },
+        key: { type: 'integer', format: 'int32', readOnly: true }
+      },
+      required: [:in_body_1]
+    }
+  end
 
-  let(:expected_path) {[]}
+  let(:expected_path) { [] }
 end

data/spec/swagger_v2/api_swagger_v2_definitions-models_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe 'definitions/models' do
-  include_context "the api entities"
+  include_context 'the api entities'
 
   before :all do
     module TheApi

data/spec/swagger_v2/api_swagger_v2_detail_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 def details
-<<-DETAILS
+  <<-DETAILS
 # Burgers in Heaven
 
 > A burger doesn't come for free
@@ -23,8 +23,8 @@ DETAILS
 end
 
 describe 'details' do
-  describe "take deatils as it is" do
-    include_context "the api entities"
+  describe 'take deatils as it is' do
+    include_context 'the api entities'
 
     before :all do
       module TheApi
@@ -32,20 +32,20 @@ describe 'details' do
           format :json
 
           desc 'This returns something',
-            detail: 'detailed description of the route',
-            entity: Entities::UseResponse,
-            failure: [{code: 400, model: Entities::ApiError}]
+               detail: 'detailed description of the route',
+               entity: Entities::UseResponse,
+               failure: [{ code: 400, model: Entities::ApiError }]
           get '/use_detail' do
-            { "declared_params" => declared(params) }
+            { 'declared_params' => declared(params) }
           end
 
           desc 'This returns something' do
             detail 'detailed description of the route inside the `desc` block'
             entity Entities::UseResponse
-            failure [{code: 400, model: Entities::ApiError}]
+            failure [{ code: 400, model: Entities::ApiError }]
           end
           get '/use_detail_block' do
-            { "declared_params" => declared(params) }
+            { 'declared_params' => declared(params) }
           end
 
           add_swagger_documentation
@@ -74,7 +74,7 @@ describe 'details' do
   end
 
   describe 'details, convert markdown with kramdown' do
-    include_context "the api entities"
+    include_context 'the api entities'
 
     before :all do
       module TheApi
@@ -82,11 +82,11 @@ describe 'details' do
           format :json
 
           desc 'This returns something',
-            detail: details,
-            entity: Entities::UseResponse,
-            failure: [{code: 400, model: Entities::ApiError}]
+               detail: details,
+               entity: Entities::UseResponse,
+               failure: [{ code: 400, model: Entities::ApiError }]
           get '/use_gfm_detail' do
-            { "declared_params" => declared(params) }
+            { 'declared_params' => declared(params) }
           end
 
           add_swagger_documentation markdown: GrapeSwagger::Markdown::KramdownAdapter.new
@@ -112,7 +112,7 @@ describe 'details' do
   end
 
   describe 'details, convert markdown with redcarpet', unless: RUBY_PLATFORM.eql?('java') do
-    include_context "the api entities"
+    include_context 'the api entities'
 
     before :all do
       module TheApi
@@ -120,11 +120,11 @@ describe 'details' do
           format :json
 
           desc 'This returns something',
-            detail: details,
-            entity: Entities::UseResponse,
-            failure: [{code: 400, model: Entities::ApiError}]
+               detail: details,
+               entity: Entities::UseResponse,
+               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/api_swagger_v2_extensions_spec.rb

@@ -1,50 +1,50 @@
 require 'spec_helper'
 
 describe 'extension' do
-  include_context "the api entities"
+  include_context 'the api entities'
 
   before :all do
     module TheApi
       class ExtensionsApi < Grape::API
         format :json
 
-        route_setting :x_path, { some: 'stuff' }
+        route_setting :x_path, some: 'stuff'
 
         desc 'This returns something with extension on path level',
-          params: Entities::UseResponse.documentation,
-          failure: [{code: 400, message: 'NotFound', model: Entities::ApiError}]
+             params: Entities::UseResponse.documentation,
+             failure: [{ code: 400, message: 'NotFound', model: Entities::ApiError }]
         get '/path_extension' do
-          { "declared_params" => declared(params) }
+          { 'declared_params' => declared(params) }
         end
 
         desc 'This returns something with extension on verb level',
-          params: Entities::UseResponse.documentation,
-          failure: [{code: 400, message: 'NotFound', model: Entities::ApiError}],
-          x: { some: 'stuff' }
+             params: Entities::UseResponse.documentation,
+             failure: [{ code: 400, message: 'NotFound', model: Entities::ApiError }],
+             x: { some: 'stuff' }
         params do
           requires :id, type: Integer
         end
         get '/verb_extension' do
-          { "declared_params" => declared(params) }
+          { 'declared_params' => declared(params) }
         end
 
-        route_setting :x_def, { for: 200, some: 'stuff' }
+        route_setting :x_def, for: 200, some: 'stuff'
 
         desc 'This returns something with extension on definition level',
-          params: Entities::ResponseItem.documentation,
-          success: Entities::ResponseItem,
-          failure: [{code: 400, message: 'NotFound', model: Entities::ApiError}]
+             params: Entities::ResponseItem.documentation,
+             success: Entities::ResponseItem,
+             failure: [{ code: 400, message: 'NotFound', model: Entities::ApiError }]
         get '/definitions_extension' do
-          { "declared_params" => declared(params) }
+          { 'declared_params' => declared(params) }
         end
 
         route_setting :x_def, [{ for: 422, other: 'stuff' }, { for: 200, some: 'stuff' }]
 
         desc 'This returns something with extension on definition level',
-          success: Entities::OtherItem,
-          failure: [{code: 422, message: 'NotFound', model: Entities::SecondApiError}]
+             success: Entities::OtherItem,
+             failure: [{ code: 422, message: 'NotFound', model: Entities::SecondApiError }]
         get '/multiple_definitions_extension' do
-          { "declared_params" => declared(params) }
+          { 'declared_params' => declared(params) }
         end
 
         add_swagger_documentation
@@ -56,7 +56,7 @@ describe 'extension' do
     TheApi::ExtensionsApi
   end
 
-  describe "extension on path level" do
+  describe 'extension on path level' do
     subject do
       get '/swagger_doc/path_extension'
       JSON.parse(last_response.body)
@@ -68,7 +68,7 @@ describe 'extension' do
     end
   end
 
-  describe "extension on verb level" do
+  describe 'extension on verb level' do
     subject do
       get '/swagger_doc/verb_extension'
       JSON.parse(last_response.body)
@@ -80,7 +80,7 @@ describe 'extension' do
     end
   end
 
-  describe "extension on definition level" do
+  describe 'extension on definition level' do
     subject do
       get '/swagger_doc/definitions_extension'
       JSON.parse(last_response.body)
@@ -93,7 +93,7 @@ describe 'extension' do
     end
   end
 
-  describe "extension on definition level" do
+  describe 'extension on definition level' do
     subject do
       get '/swagger_doc/multiple_definitions_extension'
       JSON.parse(last_response.body)