grape-swagger 0.26.1 → 0.27.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5d302ec60b3bef72593d98458853f1b55cfa9be
-  data.tar.gz: a58b6ce813533e111d2292959821bb932e581358
+  metadata.gz: b76f67355052da445cdb76c9405479606c5fd4e8
+  data.tar.gz: 64ab481f4a7eb9479c66f03ee1c3a8489d85db48
 SHA512:
-  metadata.gz: d3e31c1740c6605ca8f59a07aeb0b1105ef9d1b789c526f3c212b582bcf36527362ea3f0843b2f5c8cb457659e37177cd9e3a04afbb09a39be5c55c07b41069d
-  data.tar.gz: 6fc0e0f55ad293e48696ce9721fccba8febb38ceebb85ee9990ef91d03b2c94beb5891875f1c84ef22ac7aaff42bc532a649ebf77e5617583f8053b8528e5713
+  metadata.gz: 8132feb353b8a6c9ae6359d86507e5f7e785e414880bf3bbcd3452e73acdb2806281405048397a231d881912676ff1ccda13e9c950ee9031a52fb667bcd6a528
+  data.tar.gz: 66a8603fd1ca61891c64b8caf5259b12f3c2ca2c357fff8a0017db6aa53d2399e7478b3b236c48b414819a178cf347bd1bb58c7849fc752c82c9bdb3d3bcc0f2

data/.rubocop.yml

@@ -2,6 +2,7 @@ AllCops:
   Exclude:
     - vendor/**/*
     - example/**/*
+  TargetRubyVersion: 2.4
 
 inherit_from: .rubocop_todo.yml
 
@@ -19,3 +20,6 @@ Metrics/MethodLength:
 
 Style/IndentHash:
   EnforcedStyle: consistent
+
+Style/FileName:
+  Enabled: false

data/.rubocop_todo.yml

@@ -18,11 +18,11 @@ Metrics/BlockLength:
 # Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 265
+  Max: 275
 
 # Offense count: 12
 Metrics/CyclomaticComplexity:
-  Max: 14
+  Max: 15
 
 # Offense count: 129
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives.
@@ -37,7 +37,7 @@ Metrics/MethodLength:
 
 # Offense count: 7
 Metrics/PerceivedComplexity:
-  Max: 15
+  Max: 16
 
 # Offense count: 3
 Style/ClassVars:
@@ -48,15 +48,9 @@ Style/ClassVars:
 Style/Documentation:
   Enabled: false
 
-# Offense count: 5
-# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts.
-Style/FileName:
+Style/MixinGrouping:
   Exclude:
-    - 'lib/grape-swagger.rb'
-    - 'spec/swagger_v2/api_swagger_v2_definitions-models_spec.rb'
-    - 'spec/swagger_v2/api_swagger_v2_format-content_type_spec.rb'
-    - 'spec/swagger_v2/api_swagger_v2_type-format_spec.rb'
-    - 'spec/swagger_v2/grape-swagger_spec.rb'
+    - spec/**/*
 
 # Offense count: 1
 # Cop supports --auto-correct.

data/.travis.yml

@@ -8,10 +8,9 @@ before_install:
 
 after_success:
   - bundle exec danger
-  - coveralls
 
 rvm:
-  - 2.4.0
+  - 2.4.1
   - 2.3.3
 
 env:

data/CHANGELOG.md

@@ -8,7 +8,26 @@
 
 * Your contribution here.
 
-### 0.26.1 (February 3, 2014)
+###  0.27.0 (March 27, 2014)
+
+#### Features
+
+* [#583](https://github.com/ruby-grape/grape-swagger/pull/583): Issue #582: document file response - [@LeFnord](https://github.com/LeFnord).
+* [#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).
+* [#585](https://github.com/ruby-grape/grape-swagger/pull/585): Issue #584: do not mutate route.path - [@LeFnord](https://github.com/LeFnord).
+* [#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/Dangerfile

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 danger.import_dangerfile(gem: 'ruby-grape-danger')

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'http://rubygems.org'
 
 ruby RUBY_VERSION
@@ -23,11 +25,12 @@ group :development, :test do
   gem 'rake'
   gem 'rdoc'
   gem 'rspec', '~> 3.0'
-  gem 'rubocop', '~> 0.46'
+  gem 'rubocop', '~> 0.47'
 end
+
 group :test do
   gem 'coveralls', require: false
-  gem 'grape-entity'
+  gem 'grape-entity', '~>0.5'
   gem 'grape-swagger-entity'
   gem 'ruby-grape-danger', '~> 0.1.1', require: false
   gem 'simplecov', require: false

data/README.md

@@ -49,14 +49,9 @@ grape-swagger | swagger spec | grape                   | grape-entity | represen
 --------------|--------------|-------------------------|--------------|---------------|
 0.10.5        |     1.2      | >= 0.10.0 ... <= 0.14.0 |  < 0.5.0     | n/a           |
 0.11.0        |     1.2      |               >= 0.16.2 |  < 0.5.0     | n/a           |
-0.20.1        |     2.0      | >= 0.12.0 ... <= 0.14.0 | <= 0.5.1     | n/a           |
-0.20.3        |     2.0      | >= 0.12.0 ... ~> 0.16.2 | ~> 0.5.1     | n/a           |
-0.21.0        |     2.0      | >= 0.12.0 ... <= 0.16.2 | <= 0.5.1     | >= 2.4.1      |
-0.23.0        |     2.0      | >= 0.12.0 ... <= 0.17.0 | <= 0.5.1     | >= 2.4.1      |
-0.24.0        |     2.0      | >= 0.12.0 ... <= 0.18.0 | <= 0.5.1     | >= 2.4.1      |
-0.25.0        |     2.0      | >= 0.14.0 ... <= 0.18.0 | <= 0.5.2     | >= 2.4.1      |
 0.25.2        |     2.0      | >= 0.14.0 ... <= 0.18.0 | <= 0.6.0     | >= 2.4.1      |
 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
@@ -202,6 +197,7 @@ end
 * [token_owner](#token_owner)
 * [security_definitions](#security_definitions)
 * [models](#models)
+* [tags](#tags)
 * [hide_documentation_path](#hide_documentation_path)
 * [info](#info)
 
@@ -329,6 +325,18 @@ add_swagger_documentation \
    ]
 ```
 
+<a name="tags" />
+### tags:
+A list of tags to document.  By default tags are automatically generated
+for endpoints based on route names.
+
+```ruby
+add_swagger_documentation \
+  tags: [
+    { name: 'widgets', description: 'A description of widgets' }
+  ]
+```
+
 <a name="hide_documentation_path" />
 #### hide_documentation_path: (default: `true`)
 ```ruby
@@ -397,6 +405,7 @@ add_swagger_documentation \
 * [Setting a Swagger default value](#default-value)
 * [Response documentation](#response)
 * [Changing default status codes](#change-status)
+* [File response](#file-response)
 * [Extensions](#extensions)
 
 
@@ -430,6 +439,12 @@ You can hide an endpoint by adding ```hidden: true``` in the description of the
 desc 'Hide this endpoint', hidden: true
 ```
 
+Or by adding ```hidden: true``` on the verb method of the endpoint, such as `get`, `post` and `put`:
+
+```ruby
+get '/kittens', hidden: true do
+```
+
 Endpoints can be conditionally hidden by providing a callable object such as a lambda which evaluates to the desired
 state:
 
@@ -826,16 +841,56 @@ end
 },
 ```
 
+<a name="file-response" />
+#### File response
+
+Set `success` to `File` and sets also produces. If produces wasn't set, it defaults to `application/octet-stream`.
+```ruby
+desc 'Get a file',
+    success: File
+get do
+  # your file reponse
+end
+…
+```
+
+```json
+"produces": [
+  "application/octet-stream"
+],
+"responses": {
+  "200": {
+    "description": "Get a file",
+    "schema": {
+      "type": "file"
+    }
+  }
+}
+```
 
 <a name="extensions" />
 #### Extensions
 
 Swagger spec2.0 supports extensions on different levels, for the moment,
-the documentation on `verb`, `path` and `definition` level would be supported.
+the documentation on `info`, `verb`, `path` and `definition` level would be supported.
 The documented key would be generated from the `x` + `-` + key of the submitted hash,
 for possibilities refer to the [extensions spec](spec/lib/extensions_spec.rb).
 To get an overview *how* the extensions would be defined on grape level, see the following examples:
 
+- `info` extension, add a `x` key to the `info` hash when calling ```add_swagger_documentation```:
+```ruby
+  add_swagger_documentation \
+    info: {
+      x: { some: 'stuff' }
+    }
+```
+this would generate:
+```json
+"info":{
+  "x-some":"stuff"
+}
+```
+
 - `verb` extension, add a `x` key to the `desc` hash:
 ```ruby
 desc 'This returns something with extension on verb level',
@@ -1079,13 +1134,13 @@ role - only admins can see this endpoint.
 <a name="md_usage" />
 ## Markdown in Detail (deprecated)
 
-Usage of option `markdown` won't no longer be supported,
+Usage of option `markdown` will no longer be supported,
 cause OAPI accepts [GFM](https://help.github.com/articles/github-flavored-markdown) and plain text.
 (see: [description of `Info`](https://github.com/OAI/OpenAPI-Specification/blob/OpenAPI.next/versions/2.0.md#info-object))
 
 
 <a="example" />
-## Example
+## Examples
 
 Go into example directory and run it: `$ bundle exec rackup`
 go to: `http://localhost:9292/swagger_doc` to get it
@@ -1106,9 +1161,7 @@ class NamespaceApi < Grape::API
     desc 'Document root'
     get '/' do
     end
-  end
 
-  namespace :hudson do
     desc 'This gets something.',
       notes: '_test_'
 
@@ -1117,12 +1170,12 @@ class NamespaceApi < Grape::API
     end
   end
 
-  namespace :colorado do
-    desc 'This gets something for URL using - separator.',
-      notes: '_test_'
-
-    get '/simple-test' do
-      { bla: 'something' }
+  namespace :download do
+    desc 'download files',
+         success: File,
+         produces: ['text/csv']
+    get ':id' do
+      # file response
     end
   end
 end

data/RELEASING.md

@@ -1,6 +1,6 @@
 # Releasing Grape-Swagger
 
-There're no particular rules about when to release grape-swagger. Release bug fixes frequenty, features not so frequently and breaking API changes rarely.
+There're no particular rules about when to release grape-swagger. Release bug fixes frequently, features not so frequently and breaking API changes rarely.
 
 ### Release
 
@@ -56,7 +56,7 @@ Next Release
 * Your contribution here.
 ```
 
-Comit your changes.
+Commit your changes.
 
 ```
 git add CHANGELOG.md

data/Rakefile

@@ -1,4 +1,5 @@
 # encoding: utf-8
+# frozen_string_literal: true
 
 require 'rubygems'
 require 'bundler'
@@ -17,4 +18,4 @@ RSpec::Core::RakeTask.new(:spec)
 require 'rubocop/rake_task'
 RuboCop::RakeTask.new(:rubocop)
 
-task default: [:spec, :rubocop]
+task default: %i(spec rubocop)

data/grape-swagger.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 $LOAD_PATH.push File.expand_path('../lib', __FILE__)
 require 'grape-swagger/version'
 

data/lib/grape-swagger.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape'
 
 require 'grape-swagger/version'
@@ -106,7 +108,7 @@ module Grape
               ns.options[:swagger][:nested] != false
           end
 
-          parent_standalone_namespaces = standalone_namespaces.reject { |ns_name, _| !name.start_with?(ns_name) }
+          parent_standalone_namespaces = standalone_namespaces.select { |ns_name, _| name.start_with?(ns_name) }
           # add only to the main route
           # if the namespace is not within any other namespace appearing as standalone resource
           # rubocop:disable Style/Next

data/lib/grape-swagger/doc_methods.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'grape-swagger/doc_methods/status_codes'
 require 'grape-swagger/doc_methods/produces_consumes'
 require 'grape-swagger/doc_methods/data_type'
@@ -37,7 +39,7 @@ module GrapeSwagger
       class_variables_from(options)
 
       if formatter
-        [:format, :default_format, :default_error_formatter].each do |method|
+        %i(format default_format default_error_formatter).each do |method|
           send(method, formatter)
         end
       end
@@ -52,7 +54,8 @@ module GrapeSwagger
         )
 
         paths, definitions   = endpoint.path_and_definition_objects(combi_routes, options)
-        tags                 = GrapeSwagger::DocMethods::TagNameDescription.build(paths)
+        tags                 = tags_from(paths, options)
+
         output[:tags]        = tags unless tags.empty? || paths.blank?
         output[:paths]       = paths unless paths.blank?
         output[:definitions] = definitions unless definitions.blank?
@@ -109,5 +112,17 @@ module GrapeSwagger
       @@class_name              = options[:class_name] || options[:mount_path].delete('/')
       @@hide_documentation_path = options[:hide_documentation_path]
     end
+
+    def tags_from(paths, options)
+      tags = GrapeSwagger::DocMethods::TagNameDescription.build(paths)
+
+      if options[:tags]
+        names = options[:tags].map { |t| t[:name] }
+        tags.reject! { |t| names.include?(t[:name]) }
+        tags += options[:tags]
+      end
+
+      tags
+    end
   end
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   module DocMethods
     class BuildModelDefinition

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   module DocMethods
     class DataType

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   module DocMethods
     class Extensions
@@ -13,6 +15,10 @@ module GrapeSwagger
           add_extensions_to_definition(settings, path, definitions) if settings && extended?(settings, :x_def)
         end
 
+        def add_extensions_to_info(settings, info)
+          add_extension_to(info, extension(settings)) if extended?(settings, :x)
+        end
+
         def add_extensions_to_path(settings, path)
           add_extension_to(path, extension(settings, :x_path))
         end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   module DocMethods
     class Headers

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module GrapeSwagger
   module DocMethods
     class MoveParams
@@ -8,7 +10,7 @@ module GrapeSwagger
           move_methods.include?(http_verb) && includes_body_param?(params)
         end
 
-        def to_definition(params, route, definitions)
+        def to_definition(path, params, route, definitions)
           @definitions = definitions
           unify!(params)
 
@@ -16,7 +18,7 @@ module GrapeSwagger
 
           return (params + correct_array_param(params_to_move)) if should_correct_array?(params_to_move)
 
-          params << parent_definition_of_params(params_to_move, route)
+          params << parent_definition_of_params(params_to_move, path, route)
 
           params
         end
@@ -33,8 +35,8 @@ module GrapeSwagger
           param
         end
 
-        def parent_definition_of_params(params, route)
-          definition_name = OperationId.manipulate(parse_model(route.path))
+        def parent_definition_of_params(params, path, route)
+          definition_name = OperationId.manipulate(parse_model(path))
           referenced_definition = build_definition(definition_name, params, route.request_method.downcase)
           definition = @definitions[referenced_definition]
 
@@ -196,7 +198,7 @@ module GrapeSwagger
         end
 
         def property_keys
-          [:type, :format, :description, :minimum, :maximum, :items]
+          %i(type format description minimum maximum items)
         end
 
         def deletable?(param)