grape-swagger 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c2826417c60f2f12c57698a03f03a15b9c1603c9c19a5cfc5c6594aec5512f13
-  data.tar.gz: ed6a07977e30c0ec647f41e60acf2d0184ba8f8531c626da87213aa1136fec1b
+  metadata.gz: 9cff361f819d42d8c3f847c605a31190f82764da573728d043debfe312d30069
+  data.tar.gz: faada4385a0db1fec73606585085deec766991007a9f050df1f2c0bbd9e9e018
 SHA512:
-  metadata.gz: e032c09183d38e9ce114cb0c02f6c083a8d79339975678265ef2b6dc49945c8e977c4c2785a62f6aea0d0cc42ae72c8a6ece4cdd8d2fdb9db938eb27a819e25f
-  data.tar.gz: 42779db4d2991ddc177027f9ae4526dd6ff999faaf7abdd6a8f9cf44978878a19ce300b1440f32eaf562ca1575d1cc7f0c1a9215366eb66683d53a299767c5b0
+  metadata.gz: 7a86553f29d5b5a338a0ac21d049845ab609ee4adc2864940813f61384a8bcc19c8b0a644bb484f2b79533a111ab16a51c192236b23f540ed672e5e7a161fb23
+  data.tar.gz: 9b5bc29e3ead5f683781cbc0418e3d18f4b056368885e470224bb57ebe03f4232725a971e8589e109240c949aad565e80d5b4ecd31e31f6e5721f0c86c8aaf2f

data/.github/workflows/ci.yml

@@ -18,7 +18,7 @@ jobs:
       - uses: actions/checkout@v3
       - uses: ruby/setup-ruby@v1
         with:
-          ruby-version: '3.1'
+          ruby-version: '3.2'
           bundler-cache: true
       - name: Run rubocop
         run: bundle exec rubocop --parallel --format progress
@@ -28,8 +28,8 @@ jobs:
     needs: ['rubocop']
     strategy:
       matrix:
-        ruby-version: ['2.7', '3.0', '3.1', 'head']
-        grape-version: [1.6.2, 1.5.3]
+        ruby-version: ['3.0', '3.1', '3.2', 'head']
+        grape-version: [1.6.2, 1.7.0]
         model-parser: [grape-swagger-entity, grape-swagger-representable, '']
     steps:
     - name: Check out branch

data/.rubocop.yml

@@ -5,7 +5,7 @@ AllCops:
     - vendor/**/*
     - example/**/*
   NewCops: enable
-  TargetRubyVersion: 3.1
+  TargetRubyVersion: 3.2
   SuggestExtensions: false
 
 #  Layout stuff

data/CHANGELOG.md

@@ -9,6 +9,14 @@
 * Your contribution here.
 
 
+### 1.6.0 (March 19, 2023)
+
+#### Features
+
+* [#872](https://github.com/ruby-grape/grape-swagger/pull/872): Add `consumes` and `produces` options to `add_swagger_documentation` - [@spaceraccoon](https://github.com/spaceraccoon)
+* [#868](https://github.com/ruby-grape/grape-swagger/pull/868): Add `default` endpoint option to specify default response - [@dhruvCW](https://github.com/dhruvCW)
+
+
 ### 1.5.0 (July 28, 2022)
 
 #### Features

data/Gemfile

@@ -2,11 +2,9 @@
 
 source 'http://rubygems.org'
 
-ruby RUBY_VERSION
-
 gemspec
 
-gem 'grape', case version = ENV.fetch('GRAPE_VERSION', '~> 1.6')
+gem 'grape', case version = ENV.fetch('GRAPE_VERSION', '~> 1.7')
              when 'HEAD'
                { git: 'https://github.com/ruby-grape/grape' }
              else
@@ -21,7 +19,7 @@ group :development, :test do
   gem 'pry', platforms: [:mri]
   gem 'pry-byebug', platforms: [:mri]
 
-  gem 'rack', '~> 2.2'
+  gem 'rack', '~> 3.0'
   gem 'rack-cors'
   gem 'rack-test'
   gem 'rake'

data/README.md

@@ -206,6 +206,8 @@ end
 * [array_use_braces](#array_use_braces)
 * [api_documentation](#api_documentation)
 * [specific_api_documentation](#specific_api_documentation)
+* [consumes](#consumes)
+* [produces](#produces)
 
 You can pass a hash with optional configuration settings to ```add_swagger_documentation```.
 The examples show the default value.
@@ -432,6 +434,24 @@ add_swagger_documentation \
    specific_api_documentation: { desc: 'Reticulated splines API swagger-compatible endpoint documentation.' }
 ```
 
+#### consumes
+
+Customize the Swagger API default global `consumes` field value.
+
+```ruby
+add_swagger_documentation \
+   consumes: ['application/json', 'application/x-www-form-urlencoded']
+```
+
+#### produces
+
+Customize the Swagger API default global `produces` field value.
+
+```ruby
+add_swagger_documentation \
+   produces: ['text/plain']
+```
+
 ## Routes Configuration <a name="routes"></a>
 
 * [Swagger Header Parameters](#headers)
@@ -1022,6 +1042,50 @@ end
 }
 ```
 
+#### Default response <a name="default-response"></a>
+
+By setting the `default` option you can also define a default response that is the result returned for all unspecified status codes.
+The definition supports the same syntax as `success` or `failure`.
+
+In the following cases, the schema ref would be taken from route.
+
+```ruby
+desc 'thing', default: { message: 'the default response' }
+get '/thing' do
+  # ...
+end
+```
+The generated swagger section will be something like
+
+```json
+"responses": {
+  "default": {
+    "description": "the default response"
+  }
+},
+```
+Just like with `success` or `failure` you can also provide a `model` parameter.
+
+```ruby
+desc 'Get a list of stuff',
+    default: { model: Entities::UseResponse, message: 'the default response' }
+get do
+  # your code comes here
+end
+```
+The generated swagger document will then correctly reference the model schema.
+
+```json
+"responses": {
+  "default": {
+    "description": "the default response",
+    "schema": {
+      "$ref": "#/definitions/UseResponse"
+    }
+  }
+},
+```
+
 
 #### Extensions <a name="extensions"></a>
 

data/lib/grape-swagger/endpoint.rb

@@ -5,7 +5,7 @@ require 'active_support/core_ext/string/inflections'
 require 'grape-swagger/endpoint/params_parser'
 
 module Grape
-  class Endpoint
+  class Endpoint # rubocop:disable Metrics/ClassLength
     def content_types_for(target_class)
       content_types = (target_class.content_types || {}).values
 
@@ -27,7 +27,8 @@ module Grape
       object = {
         info: info_object(options[:info].merge(version: options[:doc_version])),
         swagger: '2.0',
-        produces: content_types_for(target_class),
+        produces: options[:produces] || content_types_for(target_class),
+        consumes: options[:consumes],
         authorizations: options[:authorizations],
         securityDefinitions: options[:security_definitions],
         security: options[:security],
@@ -117,7 +118,7 @@ module Grape
       method[:summary]     = summary_object(route)
       method[:description] = description_object(route)
       method[:produces]    = produces_object(route, options[:produces] || options[:format])
-      method[:consumes]    = consumes_object(route, options[:format])
+      method[:consumes]    = consumes_object(route, options[:consumes] || options[:format])
       method[:parameters]  = params_object(route, options, path)
       method[:security]    = security_object(route)
       method[:responses]   = response_object(route, options)
@@ -240,7 +241,8 @@ module Grape
       if route.http_codes.is_a?(Array) && route.http_codes.any? { |code| success_code?(code) }
         route.http_codes.clone
       else
-        success_codes_from_route(route) + (route.http_codes || route.options[:failure] || [])
+        success_codes_from_route(route) + default_code_from_route(route) +
+          (route.http_codes || route.options[:failure] || [])
       end
     end
 
@@ -267,6 +269,21 @@ module Grape
 
     private
 
+    def default_code_from_route(route)
+      entity = route.options[:default_response]
+      return [] if entity.nil?
+
+      default_code = { code: 'default', message: 'Default Response' }
+      if entity.is_a?(Hash)
+        default_code[:message] = entity[:message] || default_code[:message]
+        default_code[:model] = entity[:model] if entity[:model].present?
+      else
+        default_code[:model] = entity
+      end
+
+      [default_code]
+    end
+
     def build_memo_schema(memo, route, value, response_model, options)
       if memo[value[:code]][:schema] && value[:as]
         memo[value[:code]][:schema][:properties].merge!(build_reference(route, value, response_model, options))
@@ -294,7 +311,7 @@ module Grape
                   else
                     build_reference_hash(response_model)
                   end
-      return reference unless value[:code] < 300
+      return reference unless value[:code] == 'default' || value[:code] < 300
 
       if value.key?(:as) && value.key?(:is_array)
         reference[value[:as]] = build_reference_array(reference[value[:as]])

data/lib/grape-swagger/version.rb

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

data/spec/issues/677_consumes_produces_add_swagger_documentation_options_spec.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#677 consumes and produces options are included in add_swagger_documentation options' do
+  describe 'no override' do
+    let(:app) do
+      Class.new(Grape::API) do
+        resource :accounts do
+          route_param :account_number, type: String do
+            resource :records do
+              route_param :id do
+                post do
+                  { message: 'hello world' }
+                end
+              end
+            end
+          end
+        end
+
+        add_swagger_documentation \
+          format: :json
+      end
+    end
+
+    subject do
+      get '/swagger_doc'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/accounts/{account_number}/records/{id}']['post']['produces']).to eq ['application/json']
+      expect(subject['paths']['/accounts/{account_number}/records/{id}']['post']['consumes']).to eq ['application/json']
+    end
+  end
+
+  describe 'override produces' do
+    let(:app) do
+      Class.new(Grape::API) do
+        resource :accounts do
+          route_param :account_number, type: String do
+            resource :records do
+              route_param :id do
+                post do
+                  { message: 'hello world' }
+                end
+              end
+            end
+          end
+        end
+
+        add_swagger_documentation \
+          format: :json,
+          produces: ['text/plain']
+      end
+    end
+
+    subject do
+      get '/swagger_doc'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/accounts/{account_number}/records/{id}']['post']['produces']).to eq ['text/plain']
+      expect(subject['paths']['/accounts/{account_number}/records/{id}']['post']['consumes']).to eq ['application/json']
+    end
+  end
+
+  describe 'override consumes' do
+    let(:app) do
+      Class.new(Grape::API) do
+        resource :accounts do
+          route_param :account_number, type: String do
+            resource :records do
+              route_param :id do
+                post do
+                  { message: 'hello world' }
+                end
+              end
+            end
+          end
+        end
+
+        add_swagger_documentation \
+          format: :json, \
+          consumes: ['application/json', 'application/x-www-form-urlencoded']
+      end
+    end
+
+    subject do
+      get '/swagger_doc'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/accounts/{account_number}/records/{id}']['post']['produces']).to eq ['application/json']
+      expect(subject['paths']['/accounts/{account_number}/records/{id}']['post']['consumes']).to eq ['application/json', 'application/x-www-form-urlencoded']
+    end
+  end
+end

data/spec/lib/oapi_tasks_spec.rb

@@ -30,7 +30,7 @@ RSpec.describe GrapeSwagger::Rake::OapiTasks do
 
   describe '.new' do
     it 'accepts class name as a constant' do
-      expect(described_class.new(::Api::Base).send(:api_class)).to eq(Api::Base)
+      expect(described_class.new(Api::Base).send(:api_class)).to eq(Api::Base)
     end
 
     it 'accepts class name as a string' do

data/spec/swagger_v2/api_documentation_spec.rb

@@ -21,21 +21,7 @@ describe 'API with additional options' do
     expect(subject).to eq(
       [
         { description: 'Swagger compatible API description' },
-        {
-          description: 'Swagger compatible API description for specific API',
-          params: {
-            'locale' => {
-              desc: 'Locale of API documentation',
-              required: false,
-              type: 'Symbol'
-            },
-            'name' => {
-              desc: 'Resource name of mounted API',
-              required: true,
-              type: 'String'
-            }
-          }
-        }
+        { description: 'Swagger compatible API description for specific API', params: {} }
       ]
     )
   end

data/spec/swagger_v2/api_swagger_v2_response_with_models_spec.rb

@@ -15,7 +15,8 @@ describe 'response' do
              failure: [
                { code: 400, message: 'NotFound', model: '' },
                { code: 404, message: 'BadRequest', model: Entities::ApiError }
-             ]
+             ],
+             default_response: { message: 'Error', model: Entities::ApiError }
         get '/use-response' do
           { 'declared_params' => declared(params) }
         end
@@ -42,7 +43,8 @@ describe 'response' do
         'responses' => {
           '200' => { 'description' => 'This returns something', 'schema' => { '$ref' => '#/definitions/UseResponse' } },
           '400' => { 'description' => 'NotFound' },
-          '404' => { 'description' => 'BadRequest', 'schema' => { '$ref' => '#/definitions/ApiError' } }
+          '404' => { 'description' => 'BadRequest', 'schema' => { '$ref' => '#/definitions/ApiError' } },
+          'default' => { 'description' => 'Error', 'schema' => { '$ref' => '#/definitions/ApiError' } }
         },
         'tags' => ['use-response'],
         'operationId' => 'getUseResponse'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - LeFnord
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-28 00:00:00.000000000 Z
+date: 2023-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -40,7 +40,6 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".ruby-gemset"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Dangerfile
@@ -96,6 +95,7 @@ files:
 - spec/issues/587_range_parameter_delimited_by_dash_spec.rb
 - spec/issues/605_root_route_documentation_spec.rb
 - spec/issues/650_params_array_spec.rb
+- spec/issues/677_consumes_produces_add_swagger_documentation_options_spec.rb
 - spec/issues/680_keep_204_error_schemas_spec.rb
 - spec/issues/751_deeply_nested_objects_spec.rb
 - spec/issues/776_multiple_presents_spec.rb
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: Add auto generated documentation to your Grape API that can be displayed

data/.ruby-gemset

@@ -1 +0,0 @@
-grape-swagger