grape-swagger 0.27.2 → 0.27.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd96ed3b622fb9377315f85c54a8bc7a48bca789
-  data.tar.gz: f422e01c1efc38591c61e0b9e547e2935b543d92
+  metadata.gz: 4f8965c701e729810dda5456398ca1be10ede83f
+  data.tar.gz: ea1d30739c20e4317301e8f4117c62ae9b48a3aa
 SHA512:
-  metadata.gz: 6ad5d364859f7eaef34fb16805b5ba7dbbb8c1c79c84d4b76f18d5635b17237cd11cb7a849107d24ffe6eea98c99babd8ff287dcf5c233a877d6f573f35633fc
-  data.tar.gz: 135704aca1becf4c1f25cfcf4c0d1ebe71357fb7d637f151d589ba26cca9c7dad00f945e6948108e632a985abfdb727a322dcb02672ed972b447ca9e5f842f27
+  metadata.gz: e3ddeb7ee947dbc7bcfbc5aa6c102e71c68bf9f366f2a9fdb0db56c7ea8beba030d5eea0353821c32ba4c0596e82e48f37f9e99f5d215e1ddcb0ea1cd954f782
+  data.tar.gz: 96e40804304834a0c1615cc0a1915b370a1b84c9df308311972fedbc92ccf7e771f87120b9963d216532c825aed47538b6e9c335ddb5b8f8378edb2ea99899b1

data/.rubocop.yml

@@ -1,10 +1,13 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
   Exclude:
     - vendor/**/*
     - example/**/*
   TargetRubyVersion: 2.4
 
-inherit_from: .rubocop_todo.yml
+Layout/IndentHash:
+  EnforcedStyle: consistent
 
 Metrics/BlockLength:
   Exclude:
@@ -18,8 +21,6 @@ Metrics/MethodLength:
   Exclude:
     - spec/**/*
 
-Style/IndentHash:
-  EnforcedStyle: consistent
 
 Style/FileName:
   Enabled: false

data/.travis.yml

@@ -20,6 +20,7 @@ env:
   - GRAPE_VERSION=0.17.0
   - GRAPE_VERSION=0.18.0
   - GRAPE_VERSION=0.19.2
+  - GRAPE_VERSION=1.0.0
   - GRAPE_VERSION=HEAD
 
 matrix:

data/CHANGELOG.md

@@ -8,6 +8,16 @@
 
 * Your contribution here.
 
+### 0.27.3 (July 11, 2017)
+
+#### Features
+
+* [#613](https://github.com/ruby-grape/grape-swagger/pull/613): Fix Proc with arity one in param values - [@timothysu](https://github.com/timothysu).
+
+#### Fixes
+
+* [#616](https://github.com/ruby-grape/grape-swagger/pull/616): Fix swagger to show root path ([#605](https://github.com/ruby-grape/grape-swagger/issue/605)) - [@NightWolf007](https://github.com/NightWolf007).
+
 ### 0.27.2 (May 11, 2017)
 
 #### Features

data/Gemfile

@@ -6,9 +6,9 @@ ruby RUBY_VERSION
 
 gemspec
 
-gem 'grape', case version = ENV['GRAPE_VERSION'] || '~> 0.19'
+gem 'grape', case version = ENV['GRAPE_VERSION'] || '~> 1.0'
              when 'HEAD'
-               { github: 'ruby-grape/grape' }
+               { git: 'https://github.com/ruby-grape/grape' }
              else
                version
              end
@@ -25,7 +25,7 @@ group :development, :test do
   gem 'rake'
   gem 'rdoc'
   gem 'rspec', '~> 3.0'
-  gem 'rubocop', '~> 0.48'
+  gem 'rubocop', '~> 0.49'
 end
 
 group :test do

data/grape-swagger.gemspec

@@ -13,7 +13,7 @@ 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.required_ruby_version = '>= 2.2.6'
+  s.required_ruby_version = '>= 2.2'
   s.add_runtime_dependency 'grape', '>= 0.16.2'
 
   s.files         = `git ls-files`.split("\n")

data/lib/grape-swagger.rb

@@ -69,7 +69,7 @@ module Grape
           route_match = route_match.match('\/([\w|-]*?)[\.\/\(]') || route_match.match('\/([\w|-]*)$')
           next unless route_match
           resource = route_match.captures.first
-          next if resource.empty?
+          resource = '/' if resource.empty?
           @target_class.combined_routes[resource] ||= []
           next if doc_klass.hide_documentation_path && route.path.match(/#{doc_klass.mount_path}($|\/|\(\.)/)
           @target_class.combined_routes[resource] << route

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

@@ -101,7 +101,7 @@ module GrapeSwagger
         def parse_enum_or_range_values(values)
           case values
           when Proc
-            parse_enum_or_range_values(values.call)
+            parse_enum_or_range_values(values.call) if values.parameters.empty?
           when Range
             parse_range_values(values) if values.first.is_a?(Integer)
           else

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

@@ -14,7 +14,8 @@ module GrapeSwagger
           path.gsub!(/:(\w+)/, '{\1}')
 
           # set item from path, this could be used for the definitions object
-          item = path.gsub(%r{/{(.+?)}}, '').split('/').last.singularize.underscore.camelize || 'Item'
+          path_name = path.gsub(%r{/{(.+?)}}, '').split('/').last
+          item = path_name.present? ? path_name.singularize.underscore.camelize : 'Item'
 
           if route.version && options[:add_version]
             version = GrapeSwagger::DocMethods::Version.get(route)

data/lib/grape-swagger/version.rb

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

data/spec/issues/605_root_route_documentation_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#605 root route documentation' do
+  let(:app) do
+    Class.new(Grape::API) do
+      get do
+        { message: 'hello world' }
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)['paths']
+  end
+
+  specify { expect(app.combined_routes.keys).to include '/' }
+  specify { expect(subject.keys).to include '/' }
+end

data/spec/lib/parse_params_spec.rb

@@ -47,6 +47,14 @@ describe GrapeSwagger::DocMethods::ParseParams do
           expect(parsed_range).to eql(enum: %w[a b c])
         end
       end
+
+      describe 'with arity one' do
+        let(:values) { proc { |v| v < 25 } }
+        specify do
+          parsed_range = subject.send(:parse_enum_or_range_values, values)
+          expect(parsed_range).to be_nil
+        end
+      end
     end
 
     describe 'values as Array -> enums' do

data/spec/swagger_v2/simple_mounted_api_spec.rb

@@ -100,6 +100,15 @@ describe 'a simple mounted api' do
           { 'name' => 'custom', 'description' => 'Operations about customs' }
         ],
         'paths' => {
+          '/' => {
+            'get' => {
+              'summary' => 'Document root',
+              'description' => 'Document root',
+              'produces' => ['application/json'],
+              'responses' => { '200' => { 'description' => 'Document root' } },
+              'operationId' => 'get'
+            }
+          },
           '/simple' => {
             'get' => {
               'summary' => 'This gets something.',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.27.2
+  version: 0.27.3
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2017-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -88,6 +88,7 @@ files:
 - spec/issues/579_align_put_post_parameters_spec.rb
 - spec/issues/582_file_response_spec.rb
 - spec/issues/587_range_parameter_delimited_by_dash_spec.rb
+- spec/issues/605_root_route_documentation_spec.rb
 - spec/lib/data_type_spec.rb
 - spec/lib/endpoint_spec.rb
 - spec/lib/extensions_spec.rb
@@ -170,7 +171,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.2.6
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -197,6 +198,7 @@ test_files:
 - spec/issues/579_align_put_post_parameters_spec.rb
 - spec/issues/582_file_response_spec.rb
 - spec/issues/587_range_parameter_delimited_by_dash_spec.rb
+- spec/issues/605_root_route_documentation_spec.rb
 - spec/lib/data_type_spec.rb
 - spec/lib/endpoint_spec.rb
 - spec/lib/extensions_spec.rb