grape-swagger 0.25.3 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7ff792817a48d392666a4e84933495fa6e68b66e
-  data.tar.gz: 9368606ffd2008f4491145cf3e3803579abde016
+  metadata.gz: 87b55239e7b98e9c8c7e5594eaf6c0aa972c435a
+  data.tar.gz: 16d060450d230d97ac721f12229d54c2bd5b45f5
 SHA512:
-  metadata.gz: 84b8254773002e828481160615dc3176121d3f440de4937949ca086d53129aae064d72ad4ef5810c23789e3918228ccc083f6794eddb918ccebdc576224a8a30
-  data.tar.gz: 5960d2a66afffdb1f37a625d553e974aa782be32b7166b3199ac89e7b6dd347d8c6f97e431d81faf328482763a47ce39da5528f503b9f1c1de090eac9b96a246
+  metadata.gz: beb4fe2a550eec626c36da9f142725cd68b2ff699ee4ded6809353e516d63425d8b2ec3f6c846097345cc3874949e627675eb6c39d206bb63ed56a2cd14c9d4d
+  data.tar.gz: 5b6d3e6149bc6c2c86a3dce2a1bfc134d5c0c535b9ffee96fe2d367eedec3d355f53c381e211ab8d82de7152bdcfcf6e6851bb4492d24c5362477ed81727a98d

data/.rubocop.yml

@@ -9,5 +9,9 @@ Metrics/LineLength:
   Exclude:
     - spec/**/*
 
+Metrics/MethodLength:
+  Exclude:
+    - spec/**/*
+
 Style/IndentHash:
   EnforcedStyle: consistent

data/.rubocop_todo.yml

@@ -1,43 +1,43 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-10-31 11:51:42 +0100 using RuboCop version 0.45.0.
+# on 2016-11-24 18:42:08 +0800 using RuboCop version 0.45.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 27
+# Offense count: 29
 Metrics/AbcSize:
   Max: 56
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/BlockLength:
-  Max: 30
+  Max: 29
 
 # Offense count: 3
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
   Max: 265
 
-# Offense count: 10
+# Offense count: 12
 Metrics/CyclomaticComplexity:
-  Max: 15
+  Max: 14
 
-# Offense count: 803
+# Offense count: 129
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives.
 # URISchemes: http, https
 Metrics/LineLength:
   Max: 120
 
-# Offense count: 34
+# Offense count: 35
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 101
+  Max: 40
 
-# Offense count: 5
+# Offense count: 7
 Metrics/PerceivedComplexity:
-  Max: 16
+  Max: 15
 
 # Offense count: 3
 Style/ClassVars:
@@ -58,20 +58,13 @@ Style/FileName:
     - 'spec/swagger_v2/api_swagger_v2_type-format_spec.rb'
     - 'spec/swagger_v2/grape-swagger_spec.rb'
 
-# Offense count: 94
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: when_needed, always
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
 # Offense count: 1
 # Cop supports --auto-correct.
 Style/MultilineIfModifier:
   Exclude:
     - 'lib/grape-swagger/grape/route.rb'
 
-# Offense count: 4
+# Offense count: 5
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, AllowInnerSlashes.
 # SupportedStyles: slashes, percent_r, mixed

data/.travis.yml

@@ -6,26 +6,29 @@ before_install:
 
 matrix:
   include:
-    - rvm: 2.3.3
+    - rvm: 2.4.0
       script:
         - bundle exec danger
-    - rvm: 2.3.3
+    - rvm: 2.4.0
       env: MODEL_PARSER=grape-swagger-entity
-    - rvm: 2.3.3
+    - rvm: 2.4.0
       env: MODEL_PARSER=grape-swagger-representable
-    - rvm: 2.3.3
-      env: GRAPE_VERSION=0.14.0
-    - rvm: 2.3.3
-      env: GRAPE_VERSION=0.15.0
-    - rvm: 2.3.3
+    - rvm: 2.4.0
       env: GRAPE_VERSION=0.16.2
-    - rvm: 2.3.3
+    - rvm: 2.4.0
       env: GRAPE_VERSION=0.17.0
-    - rvm: 2.3.3
+    - rvm: 2.4.0
       env: GRAPE_VERSION=0.18.0
-    - rvm: 2.3.3
+    - rvm: 2.4.0
+      env: GRAPE_VERSION=0.19.0
+    - rvm: 2.4.0
       env: GRAPE_VERSION=HEAD
-    - rvm: 2.2
+    - rvm: 2.3.3
+      env: MODEL_PARSER=grape-swagger-entity
+    - rvm: 2.3.3
+      env: MODEL_PARSER=grape-swagger-representable
+    - rvm: 2.3.3
+    - rvm: 2.2.6
     - rvm: ruby-head
     - rvm: jruby-9.1.6.0
     - rvm: jruby-head

data/CHANGELOG.md

@@ -8,6 +8,18 @@
 
 * Your contribution here.
 
+### 0.26.0 (January 9, 2017)
+
+#### Features
+
+* [#558](https://github.com/ruby-grape/grape-swagger/pull/558): Version cascading including dependency updates (includes: [LeFnord#27](https://github.com/LeFnord/grape-swagger/pull/27)) - [@LeFnord](https://github.com/LeFnord).
+* [#535](https://github.com/ruby-grape/grape-swagger/pull/535): Add support for grape version cascading  - [@qinix](https://github.com/qinix).
+* [#560](https://github.com/ruby-grape/grape-swagger/pull/560): Map clearly Grape desc/detail to Swagger summary/description - [@frodrigo](https://github.com/frodrigo).
+
+#### Fixes
+
+* [#561](https://github.com/ruby-grape/grape-swagger/pull/561): Rename failures to failure in readme - [@justincampbell](https://github.com/justincampbell).
+
 ### 0.25.3 (December 18, 2016)
 
 #### Features

data/Gemfile

@@ -4,7 +4,7 @@ ruby RUBY_VERSION
 
 gemspec
 
-gem 'grape', case version = ENV['GRAPE_VERSION'] || '~> 0.18'
+gem 'grape', case version = ENV['GRAPE_VERSION'] || '~> 0.19'
              when 'HEAD'
                { github: 'ruby-grape/grape' }
              else
@@ -23,7 +23,7 @@ group :development, :test do
   gem 'rack-test'
   gem 'rake'
   gem 'rdoc'
-  gem 'redcarpet', platforms: [:mri]
+  gem 'redcarpet', '< 3.4', platforms: [:mri]
   gem 'rouge', platforms: [:mri]
   gem 'rspec', '~> 3.0'
   gem 'rubocop', '~> 0.40'
@@ -32,5 +32,5 @@ end
 group :test do
   gem 'grape-entity'
   gem 'grape-swagger-entity'
-  gem 'ruby-grape-danger', '~> 0.1.0', require: false
+  gem 'ruby-grape-danger', '~> 0.1.1', require: false
 end

data/README.md

@@ -54,6 +54,8 @@ grape-swagger | swagger spec | grape                   | grape-entity | represen
 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      |
 
 <a name="swagger-spec" />
 ## Swagger-Spec
@@ -523,7 +525,7 @@ desc 'Get all kittens!', {
   is_array: true,
   nickname: 'getKittens',
   success: Entities::Kitten, # or success
-  failures: [[401, 'KittenBitesError', Entities::BadKitten]] # or failure
+  failure: [[401, 'KittenBitesError', Entities::BadKitten]] # or failure
   # also explicit as hash: [{ code: 401, mssage: 'KittenBitesError', model: Entities::BadKitten }]
   produces: [ "array", "of", "mime_types" ],
   consumes: [ "array", "of", "mime_types" ]
@@ -753,7 +755,7 @@ You can also document the HTTP status codes with a description and a specified m
 In the following cases, the schema ref would be taken from route.
 
 ```ruby
-desc 'thing', failures: [ { code: 400, message: 'Invalid parameter entry' } ]
+desc 'thing', failure: [ { code: 400, message: 'Invalid parameter entry' } ]
 get '/thing' do
   ...
 end
@@ -762,7 +764,7 @@ end
 ```ruby
 desc 'thing' do
   params Entities::Something.documentation
-  failures [ { code: 400, message: 'Invalid parameter entry' } ]
+  failure [ { code: 400, message: 'Invalid parameter entry' } ]
 end
 get '/thing' do
   ...
@@ -770,7 +772,7 @@ end
 ```
 
 ```ruby
-get '/thing', failures: [
+get '/thing', failure: [
   { code: 400, message: 'Invalid parameter entry' },
   { code: 404, message: 'Not authorized' },
 ] do
@@ -780,7 +782,7 @@ end
 
 By adding a `model` key, e.g. this would be taken.
 ```ruby
-get '/thing', failures: [
+get '/thing', failure: [
   { code: 400, message: 'General error' },
   { code: 422, message: 'Invalid parameter entry', model: Entities::ApiError }
 ] do

data/Rakefile

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

data/grape-swagger.gemspec

@@ -11,7 +11,8 @@ Gem::Specification.new do |s|
   s.summary     = 'Add auto generated documentation to your Grape API that can be displayed with Swagger.'
   s.license     = 'MIT'
 
-  s.add_runtime_dependency 'grape', '>= 0.12.0'
+  s.required_ruby_version = '>= 2.2.6'
+  s.add_runtime_dependency 'grape', '>= 0.16.2'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec}/*`.split("\n")

data/lib/grape-swagger.rb

@@ -1,7 +1,5 @@
 require 'grape'
 
-require 'grape-swagger/grape/route'
-
 require 'grape-swagger/version'
 require 'grape-swagger/endpoint'
 require 'grape-swagger/errors'

data/lib/grape-swagger/doc_methods.rb

@@ -10,6 +10,7 @@ require 'grape-swagger/doc_methods/parse_params'
 require 'grape-swagger/doc_methods/move_params'
 require 'grape-swagger/doc_methods/headers'
 require 'grape-swagger/doc_methods/build_model_definition'
+require 'grape-swagger/doc_methods/version'
 
 module GrapeSwagger
   module DocMethods

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

@@ -15,7 +15,9 @@ module GrapeSwagger
           item = path.gsub(%r{/{(.+?)}}, '').split('/').last.singularize.underscore.camelize || 'Item'
 
           if route.version && options[:add_version]
-            path.sub!('{version}', route.version.to_s)
+            version = GrapeSwagger::DocMethods::Version.get(route)
+            version = version.first while version.is_a?(Array)
+            path.sub!('{version}', version.to_s)
           else
             path.sub!('/{version}', '')
           end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module GrapeSwagger
+  module DocMethods
+    class Version
+      class << self
+        def get(route)
+          version = route.version
+          # for grape version 0.16.2, the version can be a string like '[:v1, :v2]'
+          # for grape version bigger than 0.16.2, the version can be a array like [:v1, :v2]
+          if version.is_a?(String) && version.start_with?('[') && version.end_with?(']')
+            instance_eval(version)
+          else
+            version
+          end
+        end
+      end
+    end
+  end
+end

data/lib/grape-swagger/endpoint.rb

@@ -131,10 +131,8 @@ module Grape
     end
 
     def description_object(route, markdown)
-      description = route.options[:desc] if route.options.key?(:desc)
       description = route.description if route.description.present?
-      description = "# #{description} " if markdown
-      description += "\n #{route.options[:detail]}" if route.options.key?(:detail)
+      description = route.options[:detail] if route.options.key?(:detail)
       description = markdown.markdown(description.to_s).chomp if markdown
 
       description
@@ -228,9 +226,11 @@ module Grape
     end
 
     def tag_object(route)
+      version = GrapeSwagger::DocMethods::Version.get(route)
+      version = [version] unless version.is_a?(Array)
       Array(
         route.path.split('{')[0].split('/').reject(&:empty?).delete_if do |i|
-          i == route.prefix.to_s || i == route.version
+          i == route.prefix.to_s || version.map(&:to_s).include?(i)
         end.first
       )
     end

data/lib/grape-swagger/version.rb

@@ -1,3 +1,3 @@
 module GrapeSwagger
-  VERSION = '0.25.3'.freeze
+  VERSION = '0.26.0'.freeze
 end

data/spec/swagger_v2/api_swagger_v2_detail_spec.rb

@@ -61,13 +61,17 @@ describe 'details' do
     end
 
     specify do
+      expect(subject['paths']['/use_detail']['get']).to include('summary')
+      expect(subject['paths']['/use_detail']['get']['summary']).to eql 'This returns something'
       expect(subject['paths']['/use_detail']['get']).to include('description')
-      expect(subject['paths']['/use_detail']['get']['description']).to eql "This returns something\n detailed description of the route"
+      expect(subject['paths']['/use_detail']['get']['description']).to eql 'detailed description of the route'
     end
 
     specify do
+      expect(subject['paths']['/use_detail_block']['get']).to include('summary')
+      expect(subject['paths']['/use_detail_block']['get']['summary']).to eql 'This returns something'
       expect(subject['paths']['/use_detail_block']['get']).to include('description')
-      expect(subject['paths']['/use_detail_block']['get']['description']).to eql "This returns something\n detailed description of the route inside the `desc` block"
+      expect(subject['paths']['/use_detail_block']['get']['description']).to eql 'detailed description of the route inside the `desc` block'
     end
   end
 
@@ -104,7 +108,7 @@ describe 'details' do
     specify do
       expect(subject['paths']['/use_gfm_detail']['get']).to include('description')
       expect(subject['paths']['/use_gfm_detail']['get']['description']).to eql(
-        "<h1 id=\"this-returns-something\">This returns something</h1>\n<p># Burgers in Heaven</p>\n\n<blockquote>\n  <p>A burger doesn’t come for free</p>\n</blockquote>\n\n<p>If you want to reserve a burger in heaven, you have to do<br />\nsome crazy stuff on earth.</p>\n\n<pre><code>def do_good\nputs 'help people'\nend\n</code></pre>\n\n<ul>\n  <li><em>Will go to Heaven:</em> Probably</li>\n  <li><em>Will go to Hell:</em> Probably not</li>\n</ul>"
+        "<h1 id=\"burgers-in-heaven\">Burgers in Heaven</h1>\n\n<blockquote>\n  <p>A burger doesn’t come for free</p>\n</blockquote>\n\n<p>If you want to reserve a burger in heaven, you have to do<br />\nsome crazy stuff on earth.</p>\n\n<pre><code>def do_good\nputs 'help people'\nend\n</code></pre>\n\n<ul>\n  <li><em>Will go to Heaven:</em> Probably</li>\n  <li><em>Will go to Hell:</em> Probably not</li>\n</ul>"
       )
     end
   end
@@ -142,7 +146,7 @@ describe 'details' do
     specify do
       expect(subject['paths']['/use_gfm_rc_detail']['get']).to include('description')
       expect(subject['paths']['/use_gfm_rc_detail']['get']['description']).to eql(
-        "<h1>This returns something</h1>\n\n<p># Burgers in Heaven</p>\n\n<blockquote>\n<p>A burger doesn&#39;t come for free</p>\n</blockquote>\n\n<p>If you want to reserve a burger in heaven, you have to do\nsome crazy stuff on earth.</p>\n<pre class=\"highlight plaintext\"><code>def do_good\nputs 'help people'\nend\n</code></pre>\n<ul>\n<li><em>Will go to Heaven:</em> Probably</li>\n<li><em>Will go to Hell:</em> Probably not</li>\n</ul>"
+        "<h1>Burgers in Heaven</h1>\n\n<blockquote>\n<p>A burger doesn&#39;t come for free</p>\n</blockquote>\n\n<p>If you want to reserve a burger in heaven, you have to do\nsome crazy stuff on earth.</p>\n<pre class=\"highlight plaintext\"><code>def do_good\nputs 'help people'\nend\n</code></pre>\n<ul>\n<li><em>Will go to Heaven:</em> Probably</li>\n<li><em>Will go to Hell:</em> Probably not</li>\n</ul>"
       )
     end
   end

data/spec/swagger_v2/namespace_tags_prefix_spec.rb

@@ -6,14 +6,34 @@ describe 'namespace tags check while using prefix and version' do
   before :all do
     module TheApi
       class NamespaceApi < Grape::API
-        version :v1
+        version [:v1, :v2]
+      end
+
+      class CascadingVersionApi < Grape::API
+        version :v2
+
+        namespace :hudson do
+          desc 'Document root'
+          get '/' do
+          end
+        end
+
+        namespace :colorado do
+          desc 'This gets something.',
+               notes: '_test_'
+
+          get '/simple' do
+            { bla: 'something' }
+          end
+        end
       end
     end
 
     class TagApi < Grape::API
       prefix :api
+      mount TheApi::CascadingVersionApi
       mount TheApi::NamespaceApi
-      add_swagger_documentation version: 'v1'
+      add_swagger_documentation
     end
   end
 
@@ -43,6 +63,8 @@ describe 'namespace tags check while using prefix and version' do
       expect(subject['paths']['/api/v1/thames/simple_with_headers']['get']['tags']).to eql(['thames'])
       expect(subject['paths']['/api/v1/niles/items']['post']['tags']).to eql(['niles'])
       expect(subject['paths']['/api/v1/niles/custom']['get']['tags']).to eql(['niles'])
+      expect(subject['paths']['/api/v2/hudson']['get']['tags']).to eql(['hudson'])
+      expect(subject['paths']['/api/v2/colorado/simple']['get']['tags']).to eql(['colorado'])
     end
   end
 

data/spec/swagger_v2/namespaced_api_spec.rb

@@ -16,8 +16,8 @@ describe 'namespace' do
       JSON.parse(last_response.body)['paths']['/aspace']['get']
     end
 
-    it 'shows the namespace description in the json spec' do
-      expect(subject['description']).to eql('Description for aspace')
+    it 'shows the namespace summary in the json spec' do
+      expect(subject['summary']).to eql('Description for aspace')
     end
   end
 
@@ -36,8 +36,8 @@ describe 'namespace' do
       JSON.parse(last_response.body)['paths']['/camelCases']['get']
     end
 
-    it 'shows the namespace description in the json spec' do
-      expect(subject['description']).to eql('Look! An endpoint.')
+    it 'shows the namespace summary in the json spec' do
+      expect(subject['summary']).to eql('Look! An endpoint.')
     end
   end
 
@@ -60,8 +60,8 @@ describe 'namespace' do
       JSON.parse(last_response.body)['paths']['/bspace']['get']
     end
 
-    it 'shows the namespace description in the json spec' do
-      expect(subject['description']).to eql('Description for aspace')
+    it 'shows the namespace summary in the json spec' do
+      expect(subject['summary']).to eql('Description for aspace')
     end
   end
 
@@ -84,8 +84,8 @@ describe 'namespace' do
       JSON.parse(last_response.body)['paths']['/mounted/bspace']['get']
     end
 
-    it 'shows the namespace description in the json spec' do
-      expect(subject['description']).to eql('Description for aspace')
+    it 'shows the namespace summary in the json spec' do
+      expect(subject['summary']).to eql('Description for aspace')
     end
   end
 
@@ -112,8 +112,8 @@ describe 'namespace' do
       JSON.parse(last_response.body)['paths']['/mounted/bspace']['get']
     end
 
-    it 'shows the namespace description in the json spec' do
-      expect(subject['description']).to eql('Description for aspace')
+    it 'shows the namespace summary in the json spec' do
+      expect(subject['summary']).to eql('Description for aspace')
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.25.3
+  version: 0.26.0
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-18 00:00:00.000000000 Z
+date: 2017-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.16.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: 0.16.2
 description: 
 email:
 - tim.vandecasteele@gmail.com
@@ -68,9 +68,9 @@ files:
 - lib/grape-swagger/doc_methods/produces_consumes.rb
 - lib/grape-swagger/doc_methods/status_codes.rb
 - lib/grape-swagger/doc_methods/tag_name_description.rb
+- lib/grape-swagger/doc_methods/version.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/model_parsers.rb
@@ -164,7 +164,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.2.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/grape-swagger/grape/route.rb

@@ -1,17 +0,0 @@
-# backwards compatibility for Grape < 0.16.0
-module Grape
-  class Route
-    [:path, :prefix, :entity, :description, :settings, :params, :headers, :http_codes, :version]
-      .each do |m|
-      define_method m do
-        send "route_#{m}"
-      end
-    end
-
-    def request_method
-      route_method
-    end
-
-    attr_reader :options
-  end
-end if defined?(Grape::VERSION) && Gem::Version.new(::Grape::VERSION) < Gem::Version.new('0.16.0')