grape-swagger 0.27.0 → 0.27.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b76f67355052da445cdb76c9405479606c5fd4e8
-  data.tar.gz: 64ab481f4a7eb9479c66f03ee1c3a8489d85db48
+  metadata.gz: 3d4da1b29c0c251744171e78d2d8e7f9911c8b0d
+  data.tar.gz: 24c02ffce502d8e7379fbde275c9f747f3bc07d3
 SHA512:
-  metadata.gz: 8132feb353b8a6c9ae6359d86507e5f7e785e414880bf3bbcd3452e73acdb2806281405048397a231d881912676ff1ccda13e9c950ee9031a52fb667bcd6a528
-  data.tar.gz: 66a8603fd1ca61891c64b8caf5259b12f3c2ca2c357fff8a0017db6aa53d2399e7478b3b236c48b414819a178cf347bd1bb58c7849fc752c82c9bdb3d3bcc0f2
+  metadata.gz: cf0dadce63c9f23539eab02f871cbaeeccc6a39af8ca7b2e588fe3082301eed7e913ab2e77d1cbcfb7b90f56f645bad348fa5248b609677ab5a436df4026f633
+  data.tar.gz: 6b094b917156606be769a220c74a06198b0721e54e2a456b8104baad7c1605ec1e2642d01f308778cb260e4ab7dd7313be8d913b0eef7225d32c7b2fd0f62d09

data/.travis.yml

@@ -11,7 +11,7 @@ after_success:
 
 rvm:
   - 2.4.1
-  - 2.3.3
+  - 2.3.4
 
 env:
   - MODEL_PARSER=grape-swagger-entity
@@ -19,14 +19,14 @@ env:
   - GRAPE_VERSION=0.16.2
   - GRAPE_VERSION=0.17.0
   - GRAPE_VERSION=0.18.0
-  - GRAPE_VERSION=0.19.1
+  - GRAPE_VERSION=0.19.2
   - GRAPE_VERSION=HEAD
 
 matrix:
   fast_finish: true
 
   include:
-    - rvm: 2.2.6
+    - rvm: 2.2.7
       env:
     - rvm: ruby-head
       env:

data/CHANGELOG.md

@@ -8,7 +8,13 @@
 
 * Your contribution here.
 
-###  0.27.0 (March 27, 2014)
+### ###  0.27.1 (April 28, 2017)
+
+#### Features
+
+* [#602](https://github.com/ruby-grape/grape-swagger/pull/602): Allow security object to be defined - [@markevich](https://github.com/markevich).
+
+###  0.27.0 (March 27, 2017)
 
 #### Features
 
@@ -16,8 +22,6 @@
 * [#588](https://github.com/ruby-grape/grape-swagger/pull/588): Allow extension keys in Info object - [@mattyr](https://github.com/mattyr).
 * [#589](https://github.com/ruby-grape/grape-swagger/pull/589): Allow overriding tag definitions in Info object - [@mattyr](https://github.com/mattyr).
 
-* Your contribution here.
-
 #### Fixes
 
 * [#580](https://github.com/ruby-grape/grape-swagger/pull/580): Issue #578: fixes duplicated path params - [@LeFnord](https://github.com/LeFnord).
@@ -25,8 +29,6 @@
 * [#586](https://github.com/ruby-grape/grape-swagger/pull/586): Issue #587: Parameters delimited by dash cause exception - [@risa](https://github.com/risa).
 * [#593](https://github.com/ruby-grape/grape-swagger/pull/593): Clarify hidden option in readme - [@thogg4](https://github.com/thogg4).
 
-* Your contribution here.
-
 ### 0.26.1 (February 3, 2017)
 
 #### Features

data/Gemfile

@@ -25,7 +25,7 @@ group :development, :test do
   gem 'rake'
   gem 'rdoc'
   gem 'rspec', '~> 3.0'
-  gem 'rubocop', '~> 0.47'
+  gem 'rubocop', '~> 0.48'
 end
 
 group :test do

data/README.md

@@ -21,8 +21,8 @@
 * [Example](#example)
 * [Rake Tasks](#rake)
 
-<a name="what" />
-## What is grape-swagger?
+
+## What is grape-swagger? <a name="what" />
 
 The grape-swagger gem provides an autogenerated documentation for your [Grape](https://github.com/ruby-grape/grape) API. The generated documentation is Swagger-compliant, meaning it can easily be discovered in [Swagger UI](https://github.com/wordnik/swagger-ui). You should be able to point [the petstore demo](http://petstore.swagger.io/) to your API.
 
@@ -30,8 +30,8 @@ The grape-swagger gem provides an autogenerated documentation for your [Grape](h
 
 This screenshot is based on the [Hussars](https://github.com/LeFnord/hussars) sample app.
 
-<a name="related" />
-## Related Projects
+
+## Related Projects <a name="related" />
 
 * [Grape](https://github.com/ruby-grape/grape)
 * [Grape Swagger Entity](https://github.com/ruby-grape/grape-swagger-entity)
@@ -40,8 +40,8 @@ This screenshot is based on the [Hussars](https://github.com/LeFnord/hussars) sa
 * [Swagger UI](https://github.com/wordnik/swagger-ui)
 
 
-<a name="version" />
-## Compatibility
+
+## Compatibility <a name="version" />
 
 The following versions of grape, grape-entity and grape-swagger can currently be used together.
 
@@ -53,15 +53,15 @@ grape-swagger | swagger spec | grape                   | grape-entity | represen
 0.26.0        |     2.0      | >= 0.16.2               | <= 0.6.1     | >= 2.4.1      |
 0.27.0        |     2.0      | >= 0.16.2               | => 0.5.0     | >= 2.4.1      |
 
-<a name="swagger-spec" />
-## Swagger-Spec
+
+## Swagger-Spec <a name="swagger-spec" />
 
 Grape-swagger generates documentation per [Swagger / OpenAPI Spec 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md).
 
 <!-- validating it with: http://bigstickcarpet.com/swagger-parser/www/index.html -->
 
-<a name="install" />
-## Installation
+
+## Installation <a name="install" />
 
 Add to your Gemfile:
 
@@ -74,8 +74,8 @@ gem 'grape-swagger'
 Please see [UPGRADING](UPGRADING.md) when upgrading from a previous version.
 
 
-<a name="usage" />
-## Usage
+
+## Usage <a name="usage" />
 
 Mount all your different APIs (with ```Grape::API``` superclass) on a root node. In the root class definition, include ```add_swagger_documentation```, this sets up the system and registers the documentation on '/swagger_doc'. See [example/config.ru](example/config.ru) for a simple demo.
 
@@ -97,8 +97,8 @@ end
 To explore your API, either download [Swagger UI](https://github.com/wordnik/swagger-ui) and set it up yourself or go to the [online swagger demo](http://petstore.swagger.wordnik.com/) and enter your localhost url documentation root in the url field (probably something in the line of http://localhost:3000/swagger_doc).
 
 
-<a name="model_parsers" />
-## Model Parsers
+
+## Model Parsers <a name="model_parsers" />
 
 Since 0.21.0, `Grape::Entity` is not a part of grape-swagger, you need to add `grape-swagger-entity` manually to your Gemfile.
 Also added support for [representable](https://github.com/apotonick/representable) via `grape-swagger-representable`.
@@ -116,7 +116,7 @@ If you are not using Rails, make sure to load the parser inside your application
 
 You can create your own model parser, for example for [roar](https://github.com/apotonick/roar).
 
-```rb
+```ruby
 module GrapeSwagger
   module Roar
     class Parser
@@ -138,7 +138,7 @@ end
 
 Then you should register your custom parser.
 
-```rb
+```ruby
 GrapeSwagger.model_parsers.register(GrapeSwagger::Roar::Parser, Roar::Decorator)
 ```
 
@@ -146,13 +146,13 @@ To control model parsers sequence, you can insert your parser before or after an
 
 #### insert_before
 
-```rb
+```ruby
 GrapeSwagger.model_parsers.insert_before(GrapeSwagger::Representable::Parser, GrapeSwagger::Roar::Parser, Roar::Decorator)
 ```
 
 #### insert_after
 
-```rb
+```ruby
 GrapeSwagger.model_parsers.insert_after(GrapeSwagger::Roar::Parser, GrapeSwagger::Representable::Parser, Representable::Decorator)
 ```
 
@@ -163,7 +163,7 @@ As we know, `Roar::Decorator` uses `Representable::Decorator` as a superclass, t
 
 If you use the online demo, make sure your API supports foreign requests by enabling CORS in Grape, otherwise you'll see the API description, but requests on the API won't return. Use [rack-cors](https://github.com/cyu/rack-cors) to enable CORS.
 
-````ruby
+```ruby
 require 'rack/cors'
 use Rack::Cors do
   allow do
@@ -183,8 +183,8 @@ end
 ```
 
 
-<a name="configure" />
-## Configure
+
+## Configure <a name="configure" />
 
 * [host](#host)
 * [base_path](#base_path)
@@ -196,6 +196,7 @@ end
 * [swagger_endpoint_guard](#swagger_endpoint_guard)
 * [token_owner](#token_owner)
 * [security_definitions](#security_definitions)
+* [security](#security)
 * [models](#models)
 * [tags](#tags)
 * [hide_documentation_path](#hide_documentation_path)
@@ -213,16 +214,16 @@ add_swagger_documentation \
   base_path: proc { |request| request.host =~ /^example/ ? '/api-example' : '/api' }
 ```
 
-<a name="host" />
-#### host:
+
+#### host: <a name="host" />
 Sets explicit the `host`, default would be taken from `request`.
 ```ruby
 add_swagger_documentation \
    host: 'www.example.com'
 ```
 
-<a name="base_path" />
-#### base_path:
+
+#### base_path: <a name="base_path" />
 Base path of the API that's being exposed, default would be taken from `request`.
 ```ruby
 add_swagger_documentation \
@@ -231,8 +232,8 @@ add_swagger_documentation \
 
 `host` and `base_path` are also accepting a `proc` or `lambda`
 
-<a name="mount_path" />
-#### mount_path:
+
+#### mount_path: <a name="mount_path" />
 The path where the API documentation is loaded, default is: `/swagger_doc`.
 ```ruby
 add_swagger_documentation \
@@ -255,20 +256,20 @@ add_swagger_documentation \
    add_version: true
 ```
 
-<a name="doc_version" />
-#### doc_version:
+
+#### doc_version: <a name="doc_version" />
 Specify the version of the documentation at [info section](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#info-object), default is: `'0.0.1'`
 ```ruby
 add_swagger_documentation \
    doc_version: '0.0.1'
 ```
 
-<a name="markdown" />
-#### markdown: (deprecated)
+
+#### markdown: (deprecated) <a name="markdown" />
 OAPI accepts GFM for descriptions
 
-<a name="endpoint_auth_wrapper" />
-#### endpoint_auth_wrapper:
+
+#### endpoint_auth_wrapper: <a name="endpoint_auth_wrapper" />
 Specify the middleware to use for securing endpoints.
 
 ```ruby
@@ -276,8 +277,8 @@ add_swagger_documentation \
    endpoint_auth_wrapper: WineBouncer::OAuth2
 ```
 
-<a name="swagger_endpoint_guard" />
-#### swagger_endpoint_guard:
+
+#### swagger_endpoint_guard: <a name="swagger_endpoint_guard" />
 Specify the method and auth scopes, used by the middleware for securing endpoints.
 
 ```ruby
@@ -285,8 +286,8 @@ add_swagger_documentation \
    swagger_endpoint_guard: 'oauth2 false'
 ```
 
-<a name="token_owner" />
-#### token_owner:
+
+#### token_owner: <a name="token_owner" />
 Specify the token_owner method, provided by the middleware, which is typically named 'resource_owner'.
 
 ```ruby
@@ -294,8 +295,8 @@ add_swagger_documentation \
    token_owner: 'resource_owner'
 ```
 
-<a name="security_definitions" />
-#### security_definitions:
+
+#### security_definitions: <a name="security_definitions" />
 Specify the [Security Definitions Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#security-definitions-object)
 
 _NOTE: [Swagger-UI is supporting only implicit flow yet](https://github.com/swagger-api/swagger-ui/issues/2406#issuecomment-248651879)_
@@ -311,8 +312,20 @@ add_swagger_documentation \
   }
 ```
 
-<a name="models" />
-#### models:
+#### security: <a name="security" />
+Specify the [Security Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#securityRequirementObject)
+
+```ruby
+add_swagger_documentation \
+  security: [
+    {
+      api_key: []
+    }
+  ]
+```
+
+
+#### models: <a name="models" />
 A list of entities to document. Combine with the [grape-entity](https://github.com/ruby-grape/grape-entity) gem.
 
 These would be added to the definitions section of the swagger file.
@@ -325,8 +338,8 @@ add_swagger_documentation \
    ]
 ```
 
-<a name="tags" />
-### tags:
+
+### tags: <a name="tags" />
 A list of tags to document.  By default tags are automatically generated
 for endpoints based on route names.
 
@@ -337,8 +350,8 @@ add_swagger_documentation \
   ]
 ```
 
-<a name="hide_documentation_path" />
-#### hide_documentation_path: (default: `true`)
+
+#### hide_documentation_path: (default: `true`) <a name="hide_documentation_path" />
 ```ruby
 add_swagger_documentation \
    hide_documentation_path: true
@@ -346,8 +359,8 @@ add_swagger_documentation \
 
 Don't show the `/swagger_doc` path in the generated swagger documentation.
 
-<a name="info" />
-#### info:
+
+#### info: <a name="info" />
 ```ruby
 add_swagger_documentation \
   info: {
@@ -385,8 +398,8 @@ add_swagger_documentation \
 ``` -->
 
 
-<a name="routes" />
-## Routes Configuration
+
+## Routes Configuration <a name="routes" />
 
 * [Swagger Header Parameters](#headers)
 * [Hiding an Endpoint](#hiding)
@@ -409,9 +422,9 @@ add_swagger_documentation \
 * [Extensions](#extensions)
 
 
-<a name="headers" />
-#### Swagger Header Parameters <a name="headers" />
 
+#### Swagger Header Parameters  <a name="headers" />
+ <a name="headers" />
 Swagger also supports the documentation of parameters passed in the header. Since grape's ```params[]``` doesn't return header parameters we can specify header parameters seperately in a block after the description.
 
 ```ruby
@@ -430,8 +443,8 @@ desc "Return super-secret information", {
 ```
 
 
-<a name="hiding" />
-#### Hiding an Endpoint
+
+#### Hiding an Endpoint <a name="hiding" />
 
 You can hide an endpoint by adding ```hidden: true``` in the description of the endpoint:
 
@@ -453,8 +466,8 @@ desc 'Conditionally hide this endpoint', hidden: lambda { ENV['EXPERIMENTAL'] !=
 ```
 
 
-<a name="overriding-auto-generated-nicknames" />
-#### Overriding Auto-Generated Nicknames
+
+#### Overriding Auto-Generated Nicknames <a name="overriding-auto-generated-nicknames" />
 
 You can specify a swagger nickname to use instead of the auto generated name by adding `:nickname 'string'``` in the description of the endpoint.
 
@@ -463,8 +476,8 @@ desc 'Get a full list of pets', nickname: 'getAllPets'
 ```
 
 
-<a name="details" />
-#### Specify endpoint details
+
+#### Specify endpoint details <a name="details" />
 
 To specify further details for an endpoint, use the `detail` option within a block passed to `desc`:
 
@@ -476,8 +489,8 @@ get '/kittens' do
 ```
 
 
-<a name="summary" />
-#### Overriding the route summary
+
+#### Overriding the route summary <a name="summary" />
 
 To override the summary, add `summary: '[string]'` after the description.
 
@@ -492,8 +505,8 @@ end
 ```
 
 
-<a name="tags" />
-#### Overriding the tags
+
+#### Overriding the tags <a name="tags" />
 
 Tags are used for logical grouping of operations by resources or any other qualifier. To override the
 tags array, add `tags: ['tag1', 'tag2']` after the description.
@@ -508,8 +521,8 @@ end
 ```
 
 
-<a name="array" />
-#### Defining an endpoint as an array
+
+#### Defining an endpoint as an array <a name="array" />
 
 You can define an endpoint as an array by adding `is_array` in the description:
 
@@ -518,8 +531,8 @@ desc 'Get a full list of pets', is_array: true
 ```
 
 
-<a name="options" />
-#### Using an options hash
+
+#### Using an options hash <a name="options" />
 
 The Grape DSL supports either an options hash or a restricted block to pass settings. Passing the `nickname`, `hidden` and `is_array` options together with response codes is only possible when passing an options hash.
 Since the syntax differs you'll need to adjust it accordingly:
@@ -539,8 +552,8 @@ get '/kittens' do
 ```
 
 
-<a name="overriding-param-type" />
-#### Overriding parameter type
+
+#### Overriding parameter type <a name="overriding-param-type" />
 
 You can override paramType, using the documentation hash. See [parameter object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameter-object) for available types.
 
@@ -554,8 +567,8 @@ end
 ```
 
 
-<a name="overriding-type-of-param" />
-#### Overriding data type of the parameter
+
+#### Overriding data type of the parameter <a name="overriding-type-of-param" />
 
 You can override type, using the documentation hash.
 
@@ -579,8 +592,8 @@ end
 ```
 
 
-<a name="multiple-types" />
-#### Multiple types
+
+#### Multiple types <a name="multiple-types" />
 
 By default when you set multiple types, the first type is selected as swagger type
 
@@ -603,8 +616,8 @@ end
 ```
 
 
-<a name="array-type" />
-#### Array of data type
+
+#### Array of data type <a name="array-type" />
 
 Array types are also supported.
 
@@ -630,8 +643,8 @@ end
 ```
 
 
-<a name="collection-format" />
-#### Collection format of arrays
+
+#### Collection format of arrays <a name="collection-format" />
 
 You can set the collection format of an array, using the documentation hash.
 
@@ -665,8 +678,8 @@ end
 ```
 
 
-<a name="hiding-parameters" />
-#### Hiding parameters
+
+#### Hiding parameters <a name="hiding-parameters" />
 
 Exclude single optional parameter from the documentation
 
@@ -681,8 +694,8 @@ end
 ```
 
 
-<a name="default-value" />
-#### Setting a Swagger default value
+
+#### Setting a Swagger default value <a name="default-value" />
 
 Grape allows for an additional documentation hash to be passed to a parameter.
 
@@ -752,8 +765,8 @@ end
 ```
 
 
-<a name="response" />
-#### Response documentation
+
+#### Response documentation <a name="response" />
 
 You can also document the HTTP status codes with a description and a specified model, as ref in the schema to the definitions, that your API returns with one of the following syntax.
 
@@ -815,8 +828,8 @@ The result is then something like following:
 },
 ```
 
-<a name="change-status" />
-#### Changing default status codes
+
+#### Changing default status codes <a name="change-status" />
 
 The default status codes, one could be found (-> [status codes](lib/grape-swagger/doc_methods/status_codes.rb)) can be changed to your specific needs, to achive it, you have to change it for grape itself and for the documentation.
 
@@ -841,8 +854,8 @@ end
 },
 ```
 
-<a name="file-response" />
-#### File response
+
+#### File response <a name="file-response" />
 
 Set `success` to `File` and sets also produces. If produces wasn't set, it defaults to `application/octet-stream`.
 ```ruby
@@ -868,8 +881,8 @@ end
 }
 ```
 
-<a name="extensions" />
-#### Extensions
+
+#### Extensions <a name="extensions" />
 
 Swagger spec2.0 supports extensions on different levels, for the moment,
 the documentation on `info`, `verb`, `path` and `definition` level would be supported.
@@ -940,8 +953,8 @@ route_setting :x_def, [{ for: 422, other: 'stuff' }, { for: 200, some: 'stuff' }
 ```
 
 
-<a name="grape-entity" />
-## Using Grape Entities
+
+## Using Grape Entities <a name="grape-entity" />
 
 Add the [grape-entity](https://github.com/ruby-grape/grape-entity) and [grape-swagger-entity](https://github.com/ruby-grape/grape-swagger-entity) gem to your Gemfile.
 
@@ -1060,8 +1073,8 @@ module API
 end
 ```
 
-<a name="oauth" />
-## Securing the Swagger UI
+
+## Securing the Swagger UI <a name="oauth" />
 
 
 The Swagger UI on Grape could be secured from unauthorized access using any middleware, which provides certain methods:
@@ -1131,8 +1144,8 @@ users, you could pass a lambda to the :hidden key of a endpoint's description:
 The lambda is checking whether the user is authenticated (if not, the token_owner is nil by default), and has the admin
 role - only admins can see this endpoint.
 
-<a name="md_usage" />
-## Markdown in Detail (deprecated)
+
+## Markdown in Detail (deprecated) <a name="md_usage" />
 
 Usage of option `markdown` will no longer be supported,
 cause OAPI accepts [GFM](https://help.github.com/articles/github-flavored-markdown) and plain text.
@@ -1184,8 +1197,8 @@ end
 ```
 
 
-<a name="rake" />
-## Rake Tasks
+
+## Rake Tasks <a name="rake" />
 
 Add these lines to your Rakefile, and initialize the Task class with your Api class – be sure your Api class is available.
 

data/Rakefile

@@ -18,4 +18,4 @@ RSpec::Core::RakeTask.new(:spec)
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-task default: %i(spec rubocop)
+task default: %i[spec rubocop]

data/lib/grape-swagger/doc_methods.rb

@@ -39,7 +39,7 @@ module GrapeSwagger
       class_variables_from(options)
 
       if formatter
-        %i(format default_format default_error_formatter).each do |method|
+        %i[format default_format default_error_formatter].each do |method|
           send(method, formatter)
         end
       end
@@ -99,6 +99,7 @@ module GrapeSwagger
         format: :json,
         authorizations: nil,
         security_definitions: nil,
+        security: nil,
         api_documentation: { desc: 'Swagger compatible API description' },
         specific_api_documentation: { desc: 'Swagger compatible API description for specific API' },
         endpoint_auth_wrapper: nil,

data/lib/grape-swagger/doc_methods/data_type.rb

@@ -68,7 +68,7 @@ module GrapeSwagger
         end
 
         def request_primitives
-          primitives + %w(object string boolean file json array)
+          primitives + %w[object string boolean file json array]
         end
 
         def primitives
@@ -80,22 +80,22 @@ module GrapeSwagger
         end
 
         def collections
-          %w(csv ssv tsv pipes multi)
+          %w[csv ssv tsv pipes multi]
         end
       end
 
       PRIMITIVE_MAPPINGS = {
-        'integer' => %w(integer int32),
-        'long' => %w(integer int64),
-        'float' => %w(number float),
-        'double' => %w(number double),
-        'byte' => %w(string byte),
-        'date' => %w(string date),
-        'dateTime' => %w(string date-time),
-        'binary' => %w(string binary),
-        'password' => %w(string password),
-        'email' => %w(string email),
-        'uuid' => %w(string uuid)
+        'integer' => %w[integer int32],
+        'long' => %w[integer int64],
+        'float' => %w[number float],
+        'double' => %w[number double],
+        'byte' => %w[string byte],
+        'date' => %w[string date],
+        'dateTime' => %w[string date-time],
+        'binary' => %w[string binary],
+        'password' => %w[string password],
+        'email' => %w[string email],
+        'uuid' => %w[string uuid]
       }.freeze
     end
   end

data/lib/grape-swagger/doc_methods/move_params.rb

@@ -198,7 +198,7 @@ module GrapeSwagger
         end
 
         def property_keys
-          %i(type format description minimum maximum items)
+          %i[type format description minimum maximum items]
         end
 
         def deletable?(param)

data/lib/grape-swagger/doc_methods/parse_params.rb

@@ -91,7 +91,7 @@ module GrapeSwagger
             'path'
           elsif param_type
             param_type
-          elsif %w(POST PUT PATCH).include?(value_type[:method])
+          elsif %w[POST PUT PATCH].include?(value_type[:method])
             DataType.request_primitive?(value_type[:data_type]) ? 'formData' : 'body'
           else
             'query'

data/lib/grape-swagger/endpoint.rb

@@ -29,6 +29,7 @@ module Grape
         produces:       content_types_for(target_class),
         authorizations: options[:authorizations],
         securityDefinitions: options[:security_definitions],
+        security: options[:security],
         host:           GrapeSwagger::DocMethods::OptionalObject.build(:host, options, request),
         basePath:       GrapeSwagger::DocMethods::OptionalObject.build(:base_path, options, request),
         schemes:        options[:schemes].is_a?(String) ? [options[:schemes]] : options[:schemes]
@@ -149,7 +150,7 @@ module Grape
 
       mime_types = GrapeSwagger::DocMethods::ProducesConsumes.call(format)
 
-      route_mime_types = %i(formats content_types produces).map do |producer|
+      route_mime_types = %i[formats content_types produces].map do |producer|
         possible = route.options[producer]
         GrapeSwagger::DocMethods::ProducesConsumes.call(possible) if possible.present?
       end.flatten.compact.uniq
@@ -162,7 +163,7 @@ module Grape
       if route.settings[:description] && route.settings[:description][:consumes]
         format = route.settings[:description][:consumes]
       end
-      mime_types = GrapeSwagger::DocMethods::ProducesConsumes.call(format) if %i(post put).include?(method)
+      mime_types = GrapeSwagger::DocMethods::ProducesConsumes.call(format) if %i[post put].include?(method)
 
       mime_types
     end
@@ -286,7 +287,7 @@ module Grape
         param_type = param_type.to_s unless param_type.nil?
         array_key = name.to_s if param_type_is_array?(param_type)
         options[:is_array] = true if array_key && name.start_with?(array_key)
-        memo[name] = options unless %w(Hash Array).include?(param_type) && !options.key?(:documentation)
+        memo[name] = options unless %w[Hash Array].include?(param_type) && !options.key?(:documentation)
       end
     end
 

data/lib/grape-swagger/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GrapeSwagger
-  VERSION = '0.27.0'
+  VERSION = '0.27.1'
 end

data/spec/issues/537_enum_values_spec.rb

@@ -7,8 +7,8 @@ describe '#537 enum values spec' do
     Class.new(Grape::API) do
       namespace :issue_537 do
         class Spec < Grape::Entity
-          expose :enum_property, documentation: { values: %i(foo bar) }
-          expose :enum_property_default, documentation: { values: %w(a b c), default: 'c' }
+          expose :enum_property, documentation: { values: %i[foo bar] }
+          expose :enum_property_default, documentation: { values: %w[a b c], default: 'c' }
           expose :own_format, documentation: { format: 'log' }
         end
 
@@ -30,13 +30,13 @@ describe '#537 enum values spec' do
   let(:property) { subject['definitions']['Spec']['properties']['enum_property'] }
   specify do
     expect(property).to include 'enum'
-    expect(property['enum']).to eql %w(foo bar)
+    expect(property['enum']).to eql %w[foo bar]
   end
 
   let(:property_default) { subject['definitions']['Spec']['properties']['enum_property_default'] }
   specify do
     expect(property_default).to include 'enum'
-    expect(property_default['enum']).to eql %w(a b c)
+    expect(property_default['enum']).to eql %w[a b c]
     expect(property_default).to include 'default'
     expect(property_default['default']).to eql 'c'
   end

data/spec/issues/572_array_post_body_spec.rb

@@ -29,7 +29,7 @@ describe '#572 is_array is applied to all possible responses' do
     JSON.parse(last_response.body)
   end
 
-  let(:codes) { %w(200 401 404 429) }
+  let(:codes) { %w[200 401 404 429] }
 
   let(:responses) { subject['paths']['/issue_572']['get']['responses'] }
 

data/spec/lib/endpoint_spec.rb

@@ -52,7 +52,7 @@ describe Grape::Endpoint do
           let(:object) { subject.content_types_for(target_class) }
 
           specify do
-            expect(object).to eql %w(application/xml application/json text/plain)
+            expect(object).to eql %w[application/xml application/json text/plain]
           end
         end
       end

data/spec/lib/parse_params_spec.rb

@@ -41,19 +41,19 @@ describe GrapeSwagger::DocMethods::ParseParams do
       end
 
       describe 'as Array' do
-        let(:values) { proc { %w(a b c) } }
+        let(:values) { proc { %w[a b c] } }
         specify do
           parsed_range = subject.send(:parse_enum_or_range_values, values)
-          expect(parsed_range).to eql(enum: %w(a b c))
+          expect(parsed_range).to eql(enum: %w[a b c])
         end
       end
     end
 
     describe 'values as Array -> enums' do
-      let(:values) { %w(a b c) }
+      let(:values) { %w[a b c] }
       specify do
         parsed_range = subject.send(:parse_enum_or_range_values, values)
-        expect(parsed_range).to eql(enum: %w(a b c))
+        expect(parsed_range).to eql(enum: %w[a b c])
       end
     end
   end

data/spec/lib/tag_name_description_spec.rb

@@ -8,7 +8,7 @@ describe GrapeSwagger::DocMethods::TagNameDescription do
     subject { described_class.send(:build_memo, tag) }
 
     specify do
-      expect(subject.keys).to eql %i(name description)
+      expect(subject.keys).to eql %i[name description]
       expect(subject).to eql(
         name: tag,
         description: "Operations about #{tag.pluralize}"
@@ -51,7 +51,7 @@ describe GrapeSwagger::DocMethods::TagNameDescription do
         describe 'uniq key' do
           let(:paths) do
             {
-              key_1: { post: { tags: %w(tags_given another_tag_given) } }
+              key_1: { post: { tags: %w[tags_given another_tag_given] } }
             }
           end
 

data/spec/lib/version_spec.rb

@@ -9,7 +9,7 @@ describe GrapeSwagger::DocMethods::Version do
   describe 'grape 0.16.2 version' do
     let(:version) { '[:v1, :v2]' }
     it { is_expected.to be_a Array }
-    it { is_expected.to eql %i(v1 v2) }
+    it { is_expected.to eql %i[v1 v2] }
   end
 
   describe 'newer grape versions' do
@@ -20,9 +20,9 @@ describe GrapeSwagger::DocMethods::Version do
     end
 
     describe 'as Array' do
-      let(:version) { %i(v1 v2) }
+      let(:version) { %i[v1 v2] }
       it { is_expected.to be_a Array }
-      it { is_expected.to eql %i(v1 v2) }
+      it { is_expected.to eql %i[v1 v2] }
     end
   end
 end

data/spec/support/model_parsers/entity_parser.rb

@@ -11,7 +11,7 @@ RSpec.shared_context 'entity swagger example' do
       end
 
       class EnumValues < Grape::Entity
-        expose :gender, documentation: { type: 'string', desc: 'Content of something.', values: %w(Male Female) }
+        expose :gender, documentation: { type: 'string', desc: 'Content of something.', values: %w[Male Female] }
         expose :number, documentation: { type: 'integer', desc: 'Content of something.', values: [1, 2] }
       end
 
@@ -312,7 +312,7 @@ RSpec.shared_context 'entity swagger example' do
         },
         'QueryInputElement' => {
           'type' => 'object',
-          'required' => %w(key value),
+          'required' => %w[key value],
           'properties' => { 'key' => { 'type' => 'string', 'description' => 'Name of parameter' }, 'value' => { 'type' => 'string', 'description' => 'Value of parameter' } }
         },
         'ApiError' => {
@@ -334,9 +334,9 @@ RSpec.shared_context 'entity swagger example' do
     }
   end
 
-  let(:http_verbs) { %w(get post put delete) }
+  let(:http_verbs) { %w[get post put delete] }
 end
 
 def mounted_paths
-  %w(/thing /other_thing /dummy)
+  %w[/thing /other_thing /dummy]
 end

data/spec/support/model_parsers/mock_parser.rb

@@ -330,9 +330,9 @@ RSpec.shared_context 'mock swagger example' do
     }
   end
 
-  let(:http_verbs) { %w(get post put delete) }
+  let(:http_verbs) { %w[get post put delete] }
 end
 
 def mounted_paths
-  %w(/thing /other_thing /dummy)
+  %w[/thing /other_thing /dummy]
 end

data/spec/support/model_parsers/representable_parser.rb

@@ -29,7 +29,7 @@ RSpec.shared_context 'representable swagger example' do
       class EnumValues < Representable::Decorator
         include Representable::JSON
 
-        property :gender, documentation: { type: 'string', desc: 'Content of something.', values: %w(Male Female) }
+        property :gender, documentation: { type: 'string', desc: 'Content of something.', values: %w[Male Female] }
         property :number, documentation: { type: 'integer', desc: 'Content of something.', values: [1, 2] }
       end
 
@@ -384,7 +384,7 @@ RSpec.shared_context 'representable swagger example' do
         },
         'QueryInputElement' => {
           'type' => 'object',
-          'required' => %w(key value),
+          'required' => %w[key value],
           'properties' => { 'key' => { 'type' => 'string', 'description' => 'Name of parameter' }, 'value' => { 'type' => 'string', 'description' => 'Value of parameter' } }
         },
         'ApiError' => {
@@ -406,9 +406,9 @@ RSpec.shared_context 'representable swagger example' do
     }
   end
 
-  let(:http_verbs) { %w(get post put delete) }
+  let(:http_verbs) { %w[get post put delete] }
 end
 
 def mounted_paths
-  %w(/thing /other_thing /dummy)
+  %w[/thing /other_thing /dummy]
 end

data/spec/swagger_v2/api_swagger_v2_global_configuration_spec.rb

@@ -26,7 +26,8 @@ describe 'global configuration stuff' do
                                   mount_path: 'documentation',
                                   add_base_path: true,
                                   add_version: true,
-                                  security_definitions: { api_key: { foo: 'bar' } }
+                                  security_definitions: { api_key: { foo: 'bar' } },
+                                  security: [{ api_key: [] }]
       end
     end
   end
@@ -49,6 +50,7 @@ describe 'global configuration stuff' do
       expect(subject['schemes']).to eql ['https']
       expect(subject['securityDefinitions'].keys).to include('api_key')
       expect(subject['securityDefinitions']['api_key']).to include('foo' => 'bar')
+      expect(subject['security']).to include('api_key' => [])
     end
   end
 end

data/spec/swagger_v2/api_swagger_v2_param_type_body_nested_spec.rb

@@ -138,11 +138,11 @@ describe 'moving body/formData Params to definitions' do
                       'city' => { 'type' => 'string', 'description' => 'city' },
                       'country' => { 'type' => 'string', 'description' => 'country' }
                     },
-                    'required' => %w(street postcode city)
+                    'required' => %w[street postcode city]
                   }
                 }
               },
-              'required' => %w(name)
+              'required' => %w[name]
             }
           },
           'description' => 'post in body with nested parameters'
@@ -232,7 +232,7 @@ describe 'moving body/formData Params to definitions' do
                   }
                 }
               },
-              'required' => %w(name)
+              'required' => %w[name]
             }
           },
           'description' => 'put in body with multiple nested parameters'

data/spec/swagger_v2/form_params_spec.rb

@@ -26,7 +26,7 @@ describe 'Form Params' do
       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 { %w(1 2) }
+        optional :conditions, type: String, desc: 'conditions of item', values: proc { %w[1 2] }
       end
       patch '/items/:id' do
         {}
@@ -35,7 +35,7 @@ describe 'Form Params' do
       params do
         requires :id, type: Integer, desc: 'id of item'
         requires :name, type: String, desc: 'name of item'
-        optional :conditions, type: Symbol, desc: 'conditions of item', values: %i(one two)
+        optional :conditions, type: Symbol, desc: 'conditions of item', values: %i[one two]
       end
       post '/items/:id' do
         {}
@@ -61,7 +61,7 @@ describe 'Form Params' 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' => %w(one two) }
+      { 'in' => 'formData', 'name' => 'conditions', 'description' => 'conditions of item', 'type' => 'string', 'required' => false, 'enum' => %w[one two] }
     ]
   end
 end

data/spec/swagger_v2/namespace_tags_prefix_spec.rb

@@ -8,7 +8,7 @@ describe 'namespace tags check while using prefix and version' do
   before :all do
     module TheApi
       class NamespaceApi < Grape::API
-        version %i(v1 v2)
+        version %i[v1 v2]
       end
 
       class CascadingVersionApi < Grape::API

data/spec/swagger_v2/param_multi_type_spec.rb

@@ -69,7 +69,7 @@ describe 'Params Multi Types' do
 
     it 'has consistent types' do
       types = subject.map { |param| param['type'] }
-      expect(types).to eq(%w(string string string))
+      expect(types).to eq(%w[string string string])
     end
   end
 end

data/spec/swagger_v2/param_type_spec.rb

@@ -57,7 +57,7 @@ describe 'Params Types' do
 
       it 'has consistent types' do
         types = subject.map { |param| param['type'] }
-        expect(types).to eq(%w(string string))
+        expect(types).to eq(%w[string string])
       end
     end
   end

data/spec/swagger_v2/param_values_spec.rb

@@ -9,13 +9,13 @@ describe 'Convert values to enum or Range' do
       format :json
 
       params do
-        requires :letter, type: String, values: %w(a b c)
+        requires :letter, type: String, values: %w[a b c]
       end
       post :plain_array do
       end
 
       params do
-        requires :letter, type: String, values: proc { %w(d e f) }
+        requires :letter, type: String, values: proc { %w[d e f] }
       end
       post :array_in_proc do
       end
@@ -51,7 +51,7 @@ describe 'Convert values to enum or Range' do
         'name' => 'letter',
         'type' => 'string',
         'required' => true,
-        'enum' => %w(a b c)
+        'enum' => %w[a b c]
       }]
     end
   end
@@ -65,7 +65,7 @@ describe 'Convert values to enum or Range' do
         'name' => 'letter',
         'type' => 'string',
         'required' => true,
-        'enum' => %w(d e f)
+        'enum' => %w[d e f]
       }]
     end
   end

data/spec/swagger_v2/params_array_spec.rb

@@ -125,7 +125,7 @@ describe 'Group Params as Array' do
             'type' => 'integer', 'format' => 'int32', 'description' => 'nested array of integers'
           }
         },
-        'required' => %w(array_of_string array_of_integer)
+        'required' => %w[array_of_string array_of_integer]
       )
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.27.0
+  version: 0.27.1
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-28 00:00:00.000000000 Z
+date: 2017-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -178,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Add auto generated documentation to your Grape API that can be displayed