grape-swagger 0.32.1 → 0.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c5f4e8337c6872fe55038b194145b68b2f590d5b0c1a69e21968ce3c2cd15ab
-  data.tar.gz: 37af5bafa392cd66f53636e5e586b6763ecab6596d31250977644482183b5506
+  metadata.gz: fd05d00a2d4f16e3ecfa826aa0053928231d9e3f2e3316ea1f612c804284d858
+  data.tar.gz: 7b6637a45c95035939be0a52312f6f16f62bf1f67d788c1d1e6884b1611f6322
 SHA512:
-  metadata.gz: f994d0712a3cdb78c37536ca4a636b986ed48178daeed7b0dcb86fe02b75ffb0b2844cacddac3f767213d461efc6f1ba15adea681622ee5add22c0a5ec31c74e
-  data.tar.gz: 3ccae0f447dfd4e4517e3d5f02e33678b3733a999d2bd1c81a9a9f54d29d201cd0c378b64f20932dcbbe41b660ffad742d1940bab0094b64586802655cb44b49
+  metadata.gz: 05541a6f1670c730a7fb3c7c4acc422aeecdf562fc3f77477e0721628dac3aeec147ce0653d74a1a7560ddd36fc90075fae23ae58d1ed424445290e801d2856e
+  data.tar.gz: ac5ce4eadc5bc9dd4ecdac8bd514a339c9157b77f661c8e696c6a527dfc0a2d6d09acc8527351ac1ba0cbbf0e8894959baa5daa7eb0cd41997ca1b9dd9ddb065

data/.rubocop.yml

@@ -4,12 +4,12 @@ AllCops:
   Exclude:
     - vendor/**/*
     - example/**/*
-  TargetRubyVersion: 2.4
+  TargetRubyVersion: 2.6
 
 Layout/EmptyLinesAroundArguments:
   Enabled: false
 
-Layout/IndentHash:
+Layout/IndentFirstHashElement:
   EnforcedStyle: consistent
 
 Metrics/BlockLength:

data/.rubocop_todo.yml

@@ -1,18 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-11-04 01:12:26 +0100 using RuboCop version 0.60.0.
+# on 2019-06-05 12:13:59 +0000 using RuboCop version 0.71.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: 1
-# Configuration parameters: Include.
-# Include: **/*.gemfile, **/Gemfile, **/gems.rb
-Bundler/DuplicatedGem:
-  Exclude:
-    - 'Gemfile'
-
 # Offense count: 1
 # Configuration parameters: Include.
 # Include: **/*.gemspec
@@ -20,9 +13,15 @@ Gemspec/RequiredRubyVersion:
   Exclude:
     - 'grape-swagger.gemspec'
 
+# Offense count: 1
+# Cop supports --auto-correct.
+Lint/UnneededCopEnableDirective:
+  Exclude:
+    - 'spec/lib/optional_object_spec.rb'
+
 # Offense count: 30
 Metrics/AbcSize:
-  Max: 57
+  Max: 59
 
 # Offense count: 10
 Metrics/CyclomaticComplexity:
@@ -31,7 +30,7 @@ Metrics/CyclomaticComplexity:
 # Offense count: 22
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/MethodLength:
-  Max: 44
+  Max: 45
 
 # Offense count: 7
 Metrics/PerceivedComplexity:

data/.travis.yml

@@ -1,25 +1,20 @@
 language: ruby
 
-sudo: false
-
 before_install:
-  - gem update --system
   - gem install bundler
 
 after_success:
-  # - coveralls
   - bundle exec danger
 
 rvm:
-  - 2.4.5
-  - 2.5.3
-  - 2.6.0-rc1
+  - 2.4.6
+  - 2.5.5
+  - 2.6.3
 env:
   - MODEL_PARSER=grape-swagger-entity
   - MODEL_PARSER=grape-swagger-representable
-  - GRAPE_VERSION=0.19.2
   - GRAPE_VERSION=1.0.3
-  - GRAPE_VERSION=1.2.2
+  - GRAPE_VERSION=1.2.4
   - GRAPE_VERSION=HEAD
 
 matrix:

data/CHANGELOG.md

@@ -8,6 +8,15 @@
 
 * Your contribution here.
 
+### 0.33.0 (June 21, 2019)
+
+#### Fixes
+
+* [#747](https://github.com/ruby-grape/grape-swagger/pull/747): Allow multiple different success responses - [@charanftp3](https://github.com/charanpanchagnula).
+* [#746](https://github.com/ruby-grape/grape-swagger/pull/746): Fix path with optional format - [@fnordfish](https://github.com/fnordfish).
+* [#743](https://github.com/ruby-grape/grape-swagger/pull/743): CI: use 2.4.6, 2.5.5 - [@olleolleolle](https://github.com/olleolleolle).
+* [#737](https://github.com/ruby-grape/grape-swagger/pull/737): Add swagger endpoint guard to both doc endpoints - [@urkle](https://github.com/urkle).
+
 ### 0.32.1 (December 7, 2018)
 
 #### Fixes

data/Gemfile

@@ -25,17 +25,12 @@ group :development, :test do
   gem 'rack-test'
   gem 'rake'
   gem 'rdoc'
-  gem 'rspec', '~> 3.0'
-  # TODO: change back after 2.6.0 release and updated rubocop version
-  if RUBY_VERSION == '2.6.0'
-    gem 'rubocop', git: 'https://github.com/rubocop-hq/rubocop.git', require: false
-  else
-    gem 'rubocop', '~> 0.61', require: false
-  end
+  gem 'rspec', '~> 3.8'
+  gem 'rubocop', '~> 0.71', require: false
 end
 
 group :test do
-  gem 'coveralls', '~> 0.8', require: false
+  gem 'coveralls_reborn', require: false
   gem 'grape-swagger-entity'
   gem 'ruby-grape-danger', '~> 0.1.1', require: false
   gem 'simplecov', require: false

data/README.md

@@ -900,6 +900,45 @@ end
 },
 ```
 
+#### Multiple status codes for response <a name="multiple-status-response"></a>
+
+Multiple values can be provided for `success` and `failure` attributes in the response.
+
+```ruby
+desc 'Attach a field to an entity through a PUT',
+    success: [
+      { code: 201, model: Entities::UseResponse, message: 'Successfully created' },
+      { code: 204, message: 'Already exists' }
+    ],
+    failure: [
+      { code: 400, message: 'Bad request' },
+      { code: 404, message: 'Not found' }
+    ]  
+put do
+  # your code comes here
+end
+```
+
+```json
+"responses": {
+  "201": {
+    "description": "Successfully created",
+    "schema": {
+      "$ref": "#/definitions/UseResponse"
+    }
+  },
+  "204": {
+    "description": "Already exists"
+  },
+  "400": {
+    "description": "Bad request"
+  },
+  "404": {
+    "description": "Not found"
+  }
+},
+```
+
 
 #### File response <a name="file-response"></a>
 

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

data/lib/grape-swagger/doc_methods.rb

@@ -45,8 +45,6 @@ module GrapeSwagger
 
       desc api_doc.delete(:desc), api_doc
 
-      instance_eval(guard) unless guard.nil?
-
       output_path_definitions = proc do |combi_routes, endpoint|
         output = endpoint.swagger_object(
           target_class,
@@ -64,6 +62,8 @@ module GrapeSwagger
         output
       end
 
+      instance_eval(guard) unless guard.nil?
+
       get mount_path do
         header['Access-Control-Allow-Origin']   = '*'
         header['Access-Control-Request-Method'] = '*'
@@ -79,6 +79,8 @@ module GrapeSwagger
         optional :locale, type: Symbol, desc: 'Locale of API documentation'
       end
 
+      instance_eval(guard) unless guard.nil?
+
       get "#{mount_path}/:name" do
         I18n.locale = params[:locale] || I18n.default_locale
 

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

@@ -18,7 +18,7 @@ module GrapeSwagger
           operation = path.split('/').map(&:capitalize).join
           operation.gsub!(/\-(\w)/, &:upcase).delete!('-') if operation[/\-(\w)/]
           operation.gsub!(/\_(\w)/, &:upcase).delete!('_') if operation.include?('_')
-          operation.gsub!(/\.(\w)/, &:upcase).delete!('.') if operation.include?('.')
+          operation.gsub!(/\.(\w)/, &:upcase).delete!('.') if operation[/\.(\w)/]
           if path.include?('{')
             operation.gsub!(/\{(\w)/, &:upcase)
             operation.delete!('{').delete!('}')

data/lib/grape-swagger/endpoint.rb

@@ -238,20 +238,13 @@ module Grape
     end
 
     def success_codes_from_route(route)
-      default_code = GrapeSwagger::DocMethods::StatusCodes.get[route.request_method.downcase.to_sym]
-      if @entity.is_a?(Hash)
-        default_code[:code] = @entity[:code] if @entity[:code].present?
-        default_code[:model] = @entity[:model] if @entity[:model].present?
-        default_code[:message] = @entity[:message] || route.description || default_code[:message].sub('{item}', @item)
-        default_code[:examples] = @entity[:examples] if @entity[:examples]
-        default_code[:headers] = @entity[:headers] if @entity[:headers]
-      else
-        default_code = GrapeSwagger::DocMethods::StatusCodes.get[route.request_method.downcase.to_sym]
-        default_code[:model] = @entity if @entity
-        default_code[:message] = route.description || default_code[:message].sub('{item}', @item)
+      if @entity.is_a?(Array)
+        return @entity.map do |entity|
+          success_code_from_entity(route, entity)
+        end
       end
 
-      [default_code]
+      [success_code_from_entity(route, @entity)]
     end
 
     def tag_object(route, path)
@@ -350,5 +343,22 @@ module Grape
 
       options[:token_owner] ? route_hidden.call(send(options[:token_owner].to_sym)) : route_hidden.call
     end
+
+    def success_code_from_entity(route, entity)
+      default_code = GrapeSwagger::DocMethods::StatusCodes.get[route.request_method.downcase.to_sym]
+      if entity.is_a?(Hash)
+        default_code[:code] = entity[:code] if entity[:code].present?
+        default_code[:model] = entity[:model] if entity[:model].present?
+        default_code[:message] = entity[:message] || route.description || default_code[:message].sub('{item}', @item)
+        default_code[:examples] = entity[:examples] if entity[:examples]
+        default_code[:headers] = entity[:headers] if entity[:headers]
+      else
+        default_code = GrapeSwagger::DocMethods::StatusCodes.get[route.request_method.downcase.to_sym]
+        default_code[:model] = entity if entity
+        default_code[:message] = route.description || default_code[:message].sub('{item}', @item)
+      end
+
+      default_code
+    end
   end
 end

data/lib/grape-swagger/version.rb

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

data/spec/lib/operation_id_spec.rb

@@ -47,6 +47,9 @@ describe GrapeSwagger::DocMethods::OperationId do
       it 'GET with path /simple_test/bar-foo{id}' do
         expect(subject.build(route, '/simple_test/bar-foo{id}')).to eql 'getSimpleTestBarFooId'
       end
+      it 'GET path with optional format' do
+        expect(subject.build(route, 'foo(.{format})')).to eql 'getFoo(.Format)'
+      end
     end
   end
 end

data/spec/lib/optional_object_spec.rb

@@ -36,7 +36,6 @@ describe GrapeSwagger::DocMethods::OptionalObject do
     end
 
     describe 'option is a proc' do
-      # rubocop:disable RegexpMatch
       let(:options) do
         { host: proc { |request| request.host =~ /^example/ ? '/api-example' : '/api' } }
       end

data/spec/spec_helper.rb

@@ -2,14 +2,14 @@
 
 if RUBY_ENGINE == 'ruby'
   require 'simplecov'
-  # require 'coveralls'
+  require 'coveralls'
 
-  # SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
   SimpleCov.start do
     add_filter 'spec/'
-    # add_filter 'example/'
+    add_filter 'example/'
   end
-  # Coveralls.wear!
+  Coveralls.wear!
 end
 
 $LOAD_PATH.unshift File.expand_path('../lib', __dir__)

data/spec/swagger_v2/api_swagger_v2_response_spec.rb

@@ -31,6 +31,17 @@ describe 'response' do
           { 'declared_params' => declared(params) }
         end
 
+        desc 'This returns something',
+             success: [
+               { code: 200, message: 'Request has succeeded' },
+               { code: 201, message: 'Successful Operation' },
+               { code: 204, message: 'Request was fulfilled' }
+             ],
+             failure: [{ code: 400, message: 'NotFound', model: Entities::ApiError }]
+        get '/multiple-success-responses' do
+          { 'declared_params' => declared(params) }
+        end
+
         add_swagger_documentation
       end
     end
@@ -106,4 +117,27 @@ describe 'response' do
       expect(subject['definitions']).to eql(swagger_params_as_response_object)
     end
   end
+
+  describe 'uses params as response object when response contains multiple values for success' do
+    subject do
+      get '/swagger_doc/multiple-success-responses'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/multiple-success-responses']['get']).to eql(
+        'description' => 'This returns something',
+        'produces' => ['application/json'],
+        'responses' => {
+          '200' => { 'description' => 'Request has succeeded' },
+          '201' => { 'description' => 'Successful Operation' },
+          '204' => { 'description' => 'Request was fulfilled' },
+          '400' => { 'description' => 'NotFound', 'schema' => { '$ref' => '#/definitions/ApiError' } }
+        },
+        'tags' => ['multiple-success-responses'],
+        'operationId' => 'getMultipleSuccessResponses'
+      )
+      expect(subject['definitions']).to eql(swagger_params_as_response_object)
+    end
+  end
 end

data/spec/swagger_v2/guarded_endpoint_spec.rb

@@ -68,47 +68,95 @@ describe 'a guarded api endpoint' do
     GuardedApi
   end
 
-  context 'when a correct token is passed with the request' do
-    subject do
-      get '/swagger_doc.json', {}, 'HTTP_AUTHORIZATION' => '12345'
-      JSON.parse(last_response.body)
-    end
+  let(:endpoint) { '/swagger_doc.json' }
+  let(:auth_token) { nil }
+
+  subject do
+    get endpoint, {}, 'HTTP_AUTHORIZATION' => auth_token
+    JSON.parse(last_response.body)
+  end
 
-    it 'retrieves swagger-documentation for the endpoint' do
-      expect(subject).to eq(
-        'info' => { 'title' => 'API title', 'version' => '0.0.1' },
-        'swagger' => '2.0',
-        'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
-        'host' => 'example.org',
-        'tags' => [{ 'name' => 'auth', 'description' => 'Operations about auths' }],
-        'paths' => {
-          '/auth' => {
-            'get' => {
-              'description' => 'Show endpoint if authenticated',
-              'produces' => ['application/json'],
-              'tags' => ['auth'],
-              'operationId' => 'getAuth',
-              'responses' => { '200' => { 'description' => 'Show endpoint if authenticated' } }
+  context 'accessing the main doc endpoint' do
+    let(:endpoint) { '/swagger_doc.json' }
+
+    context 'when a correct token is passed with the request' do
+      let(:auth_token) { '12345' }
+
+      it 'retrieves swagger-documentation for the endpoint' do
+        expect(subject).to eq(
+          'info' => { 'title' => 'API title', 'version' => '0.0.1' },
+          'swagger' => '2.0',
+          'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
+          'host' => 'example.org',
+          'tags' => [{ 'name' => 'auth', 'description' => 'Operations about auths' }],
+          'paths' => {
+            '/auth' => {
+              'get' => {
+                'description' => 'Show endpoint if authenticated',
+                'produces' => ['application/json'],
+                'tags' => ['auth'],
+                'operationId' => 'getAuth',
+                'responses' => { '200' => { 'description' => 'Show endpoint if authenticated' } }
+              }
             }
           }
-        }
-      )
+        )
+      end
+    end
+
+    context 'when a bad token is passed with the request' do
+      let(:auth_token) { '123456' }
+
+      it 'does not retrieve swagger-documentation for the endpoint - only the info_object' do
+        expect(subject).to eq(
+          'info' => { 'title' => 'API title', 'version' => '0.0.1' },
+          'swagger' => '2.0',
+          'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
+          'host' => 'example.org'
+        )
+      end
     end
   end
 
-  context 'when a bad token is passed with the request' do
-    subject do
-      get '/swagger_doc.json', {}, 'HTTP_AUTHORIZATION' => '123456'
-      JSON.parse(last_response.body)
+  context 'accessing the tag specific endpoint' do
+    let(:endpoint) { '/swagger_doc/auth.json' }
+
+    context 'when a correct token is passed with the request' do
+      let(:auth_token) { '12345' }
+
+      it 'retrieves swagger-documentation for the endpoint' do
+        expect(subject).to eq(
+          'info' => { 'title' => 'API title', 'version' => '0.0.1' },
+          'swagger' => '2.0',
+          'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
+          'host' => 'example.org',
+          'tags' => [{ 'name' => 'auth', 'description' => 'Operations about auths' }],
+          'paths' => {
+            '/auth' => {
+              'get' => {
+                'description' => 'Show endpoint if authenticated',
+                'produces' => ['application/json'],
+                'tags' => ['auth'],
+                'operationId' => 'getAuth',
+                'responses' => { '200' => { 'description' => 'Show endpoint if authenticated' } }
+              }
+            }
+          }
+        )
+      end
     end
 
-    it 'does not retrieve swagger-documentation for the endpoint - only the info_object' do
-      expect(subject).to eq(
-        'info' => { 'title' => 'API title', 'version' => '0.0.1' },
-        'swagger' => '2.0',
-        'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
-        'host' => 'example.org'
-      )
+    context 'when a bad token is passed with the request' do
+      let(:auth_token) { '123456' }
+
+      it 'does not retrieve swagger-documentation for the endpoint - only the info_object' do
+        expect(subject).to eq(
+          'info' => { 'title' => 'API title', 'version' => '0.0.1' },
+          'swagger' => '2.0',
+          'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
+          'host' => 'example.org'
+        )
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.32.1
+  version: 0.33.0
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-07 00:00:00.000000000 Z
+date: 2019-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -182,15 +182,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Add auto generated documentation to your Grape API that can be displayed