grape-swagger 1.3.1 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d9d2fa1309701cf2c24f0993db15660df9be1c437861529a321e6344390fc90
-  data.tar.gz: 8e74a44fddb127a89ec914da70de6118a86fe17318fb16e4f68d2761cd69dc1c
+  metadata.gz: 2fa0c33214a157ed16d147edc9813bbb6d745498947d211c2eff21ce86b023a6
+  data.tar.gz: 27c475b099a28f9b8610ded30906edf1a974825153348d8d590abba13688f29d
 SHA512:
-  metadata.gz: 79db26518f7697a7347ad92749eaa14722310e41e395177e839d04bfc5e490026989a687158f89f34ea52a62a390482430d79067aa887f4ef90e95bf991315d7
-  data.tar.gz: 95e85e0b5d337b53bd4ed260aed3fcaae2acae613fcf337552afe0b4be280da89587351008f1f2054440b61e868804c1710340214d2ad80ca4950439af3f5fbe
+  metadata.gz: d01c3d660f905522d943bebf2e5a609231bba1938b0cc02c49908048a691a0f0f1baa184ec2fed63d8a72280a92f3aa208273ce64b2bada90b09725cff71b080
+  data.tar.gz: 1316664cfc4ec624311e891cd5c4bc106739bc3be9cb363bac02acccaa5e282a9fc1f9012ca590313fef8b74a5d6930a0afda371c05657b271e5ddfaf9e502d4

data/.github/dependabot.yml

@@ -0,0 +1,14 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+      day: "friday"
+    assignees:
+      - "LeFnord"

data/.github/workflows/rubocop.yml

@@ -0,0 +1,26 @@
+name: Rubocop
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  rubocop:
+    name: Rubocop
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-ruby@v1
+        with:
+          ruby-version: '3.0'
+      - run: gem install rubocop --no-doc
+      - run: rubocop --format progress --format json --out rubocop.json
+        id: rubocop
+      - uses: duderman/rubocop-annotate-action@v0.1.0
+        with:
+          path: rubocop.json
+        if: ${{ failure() }}

data/.github/workflows/ruby.yml

@@ -0,0 +1,32 @@
+name: Ruby
+
+on:
+  push:
+    branches:
+      - '*'
+  pull_request:
+    branches:
+      - '*'
+
+jobs:
+  rspec:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+        grape-version: [1.5.3, 1.4.0, 1.3.3]
+        model-parser: [grape-swagger-entity, grape-swagger-representable, '']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        GRAPE_VERSION: ${{ matrix.grape-version }}
+        MODEL_PARSER: ${{ matrix.model-parser }}
+        bundler-cache: true
+    - name: Run rspec
+      run: bundle exec rspec
+    - name: Run rubocop
+      run: bundle exec rubocop

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -9,6 +9,18 @@
 * Your contribution here.
 
 
+### 1.4.0 (March 20, 2021)
+
+#### Features
+
+* [#818](https://github.com/ruby-grape/grape-swagger/pull/818): Adds ruby 3.0 support - [@LeFnord](https://github.com/LeFnord).
+* [#815](https://github.com/ruby-grape/grape-swagger/pull/815): Add required for multiple presents - [@MaximeRDY](https://github.com/MaximeRDY).
+
+#### Fixes
+
+* [#822](https://github.com/ruby-grape/grape-swagger/pull/822): Corrected the related parameter lookup on request params - [@Jack12816](https://github.com/Jack12816).
+
+
 ### 1.3.1 (November 1, 2020)
 
 #### Features

data/README.md

@@ -451,6 +451,7 @@ add_swagger_documentation \
 * [Collection Format](#collection-format)
 * [Hiding parameters](#hiding-parameters)
 * [Setting a Swagger default value](#default-value)
+* [Example parameter value](#param-example)
 * [Response documentation](#response)
 * [Changing default status codes](#change-status)
 * [File response](#file-response)
@@ -769,8 +770,6 @@ params do
 end
 ```
 
-The example parameter will populate the Swagger UI with the example value, and can be used for optional or required parameters.
-
 Grape uses the option `default` to set a default value for optional parameters. This is different in that Grape will set your parameter to the provided default if the parameter is omitted, whereas the example value above will only set the value in the UI itself. This will set the Swagger `defaultValue` to the provided value. Note that the example value will override the Grape default value.
 
 ```ruby
@@ -780,6 +779,16 @@ params do
 end
 ```
 
+#### Example parameter value <a name="param-example"></a>
+
+The example parameter will populate the Swagger UI with the example value, and can be used for optional or required parameters.
+
+```ruby
+params do
+  requires :id, type: Integer, documentation: { example: 123 }
+  optional :name, type String, documentation: { example: 'Buddy Guy' }
+end
+```
 
 #### Expose nested namespace as standalone route
 
@@ -1302,7 +1311,7 @@ You can also specify if the response is an array, with the `is_array` key:
 desc 'Multiple response with array',
   success: [
     { model: Entities::EnumValues, as: :gender },
-    { model: Entities::Something, as: :somethings, is_array: true }
+    { model: Entities::Something, as: :somethings, is_array: true, required: true }
   ]
 end
 
@@ -1327,7 +1336,8 @@ The result will look like following:
                 "$ref":"#/definitions/Something"
             }
           }
-        }
+        },
+        "required": ["somethings"]
       }
     }
   }

data/UPGRADING.md

@@ -1,5 +1,9 @@
 ## Upgrading Grape-swagger
 
+### Upgrading to >= 1.4.0
+
+- Official support for ruby < 2.5 removed, ruby 2.5 only in testing mode, but no support.
+
 ### Upgrading to >= 1.3.0
 
 - The model (entity) description no longer comes from the route description. It will have a default value: `<<EntityName>> model`.

data/grape-swagger.gemspec

@@ -7,13 +7,13 @@ Gem::Specification.new do |s|
   s.name        = 'grape-swagger'
   s.version     = GrapeSwagger::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ['Tim Vandecasteele']
-  s.email       = ['tim.vandecasteele@gmail.com']
+  s.authors     = ['LeFnord', 'Tim Vandecasteele']
+  s.email       = ['pscholz.le@gmail.com', 'tim.vandecasteele@gmail.com']
   s.homepage    = 'https://github.com/ruby-grape/grape-swagger'
   s.summary     = 'Add auto generated documentation to your Grape API that can be displayed with Swagger.'
   s.license     = 'MIT'
 
-  s.required_ruby_version = '>= 2.4'
+  s.required_ruby_version = '>= 2.5'
   s.add_runtime_dependency 'grape', '~> 1.3'
 
   s.files         = `git ls-files`.split("\n")

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

@@ -7,7 +7,7 @@ module GrapeSwagger
         def to_format(parameters)
           parameters.reject { |parameter| parameter[:in] == 'body' }.each do |b|
             related_parameters = parameters.select do |p|
-              p[:name] != b[:name] && p[:name].to_s.include?("#{b[:name].to_s.gsub(/\[\]\z/, '')}[")
+              p[:name] != b[:name] && p[:name].to_s.start_with?("#{b[:name].to_s.gsub(/\[\]\z/, '')}[")
             end
             parameters.reject! { |p| p[:name] == b[:name] } if move_down(b, related_parameters)
           end

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

@@ -27,6 +27,7 @@ module GrapeSwagger
           document_required(settings)
           document_additional_properties(settings)
           document_add_extensions(settings)
+          document_example(settings)
 
           @parsed_param
         end
@@ -112,6 +113,11 @@ module GrapeSwagger
           @parsed_param[:additionalProperties] = additional_properties if additional_properties
         end
 
+        def document_example(settings)
+          example = settings[:example]
+          @parsed_param[:example] = example if example
+        end
+
         def param_type(value_type)
           param_type = value_type[:param_type] || value_type[:in]
           if value_type[:path].include?("{#{value_type[:param_name]}}")

data/lib/grape-swagger/endpoint.rb

@@ -270,11 +270,18 @@ module Grape
     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))
+
+        if value[:required]
+          memo[value[:code]][:schema][:required] ||= []
+          memo[value[:code]][:schema][:required] << value[:as].to_s
+        end
+
       elsif value[:as]
         memo[value[:code]][:schema] = {
           type: :object,
           properties: build_reference(route, value, response_model, options)
         }
+        memo[value[:code]][:schema][:required] = [value[:as].to_s] if value[:required]
       else
         memo[value[:code]][:schema] = build_reference(route, value, response_model, options)
       end
@@ -322,7 +329,7 @@ module Grape
     end
 
     def file_response?(value)
-      value.to_s.casecmp('file').zero? ? true : false
+      value.to_s.casecmp('file').zero?
     end
 
     def build_file_response(memo)
@@ -413,6 +420,7 @@ module Grape
         default_code[:headers] = entity[:headers] if entity[:headers]
         default_code[:as] = entity[:as] if entity[:as]
         default_code[:is_array] = entity[:is_array] if entity[:is_array]
+        default_code[:required] = entity[:required] if entity[:required]
       else
         default_code = GrapeSwagger::DocMethods::StatusCodes.get[route.request_method.downcase.to_sym]
         default_code[:model] = entity if entity

data/lib/grape-swagger/errors.rb

@@ -3,7 +3,9 @@
 module GrapeSwagger
   module Errors
     class UnregisteredParser < StandardError; end
+
     class SwaggerSpec < StandardError; end
+
     class SwaggerSpecDeprecated < SwaggerSpec
       class << self
         def tell!(what)

data/lib/grape-swagger/model_parsers.rb

@@ -16,14 +16,14 @@ module GrapeSwagger
       subhash = @parsers.except(klass).to_a
       insert_at = subhash.index(subhash.assoc(before_klass))
       insert_at = subhash.length - 1 if insert_at.nil?
-      @parsers = Hash[subhash.insert(insert_at, [klass, ancestor])]
+      @parsers = subhash.insert(insert_at, [klass, ancestor]).to_h
     end
 
     def insert_after(after_klass, klass, ancestor)
       subhash = @parsers.except(klass).to_a
       insert_at = subhash.index(subhash.assoc(after_klass))
       insert_at = subhash.length - 1 if insert_at.nil?
-      @parsers = Hash[subhash.insert(insert_at + 1, [klass, ancestor])]
+      @parsers = subhash.insert(insert_at + 1, [klass, ancestor]).to_h
     end
 
     def each

data/lib/grape-swagger/version.rb

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

data/spec/issues/776_multiple_presents_spec.rb

@@ -11,7 +11,7 @@ describe '#776 multiple presents spec' do
         desc 'Get multiple presents',
              success: [
                { model: Entities::EnumValues, as: :gender },
-               { model: Entities::Something, as: :somethings, is_array: true }
+               { model: Entities::Something, as: :somethings, is_array: true, required: true }
              ]
 
         get do
@@ -50,7 +50,10 @@ describe '#776 multiple presents spec' do
           '$ref' => '#/definitions/EnumValues'
         }
       },
-      'type' => 'object'
+      'type' => 'object',
+      'required' => [
+        'somethings'
+      ]
     })
   end
 end

data/spec/lib/format_data_spec.rb

@@ -87,5 +87,29 @@ describe GrapeSwagger::DocMethods::FormatData do
         expect(subject.to_format(params)).to eq expected_params
       end
     end
+
+    context 'when array params are not related' do
+      let(:params) do
+        [
+          { name: 'id', required: true, type: 'string' },
+          { name: 'description', required: false, type: 'string' },
+          { name: 'ids[]', required: true, type: 'array', items: { type: 'string' } },
+          { name: 'user_ids[]', required: true, type: 'array', items: { type: 'string' } }
+        ]
+      end
+
+      let(:expected_params) do
+        [
+          { name: 'id', required: true, type: 'string' },
+          { name: 'description', required: false, type: 'string' },
+          { name: 'ids[]', required: true, type: 'array', items: { type: 'string' } },
+          { name: 'user_ids[]', required: true, type: 'array', items: { type: 'string' } }
+        ]
+      end
+
+      it 'parses params correctly and adds array type all concerned elements' do
+        expect(subject.to_format(params)).to eq expected_params
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -19,7 +19,7 @@ MODEL_PARSER = ENV.key?('MODEL_PARSER') ? ENV['MODEL_PARSER'].to_s.downcase.sub(
 require 'grape'
 require 'grape-swagger'
 
-Dir[File.join(Dir.getwd, 'spec/support/*.rb')].sort.each { |f| require f }
+Dir[File.join(Dir.getwd, 'spec/support/*.rb')].each { |f| require f }
 require "grape-swagger/#{MODEL_PARSER}" if MODEL_PARSER != 'mock'
 require File.join(Dir.getwd, "spec/support/model_parsers/#{MODEL_PARSER}_parser.rb")
 

data/spec/support/empty_model_parser.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+# rubocop:disable Lint/EmptyClass
 class EmptyClass
 end
+# rubocop:enable Lint/EmptyClass
 
 module GrapeSwagger
   class EmptyModelParser

data/spec/support/model_parsers/mock_parser.rb

@@ -40,21 +40,37 @@ RSpec.shared_context 'mock swagger example' do
       end
 
       class UseNestedWithAddress < OpenStruct; end
+
       class TypedDefinition < OpenStruct; end
+
       class UseItemResponseAsType < OpenStruct; end
+
       class OtherItem < OpenStruct; end
+
       class EnumValues < OpenStruct; end
+
       class AliasedThing < OpenStruct; end
+
       class FourthLevel < OpenStruct; end
+
       class ThirdLevel < OpenStruct; end
+
       class SecondLevel < OpenStruct; end
+
       class FirstLevel < OpenStruct; end
+
       class QueryInputElement < OpenStruct; end
+
       class QueryInput < OpenStruct; end
+
       class ApiError < OpenStruct; end
+
       class SecondApiError < OpenStruct; end
+
       class RecursiveModel < OpenStruct; end
+
       class DocumentedHashAndArrayModel < OpenStruct; end
+
       module NestedModule
         class ApiResponse < OpenStruct; end
       end

data/spec/support/namespace_tags.rb

@@ -3,7 +3,9 @@
 RSpec.shared_context 'namespace example' do
   before :all do
     module TheApi
+      # rubocop:disable Lint/EmptyClass
       class CustomType; end
+      # rubocop:enable Lint/EmptyClass
 
       class NamespaceApi < Grape::API
         namespace :hudson do

data/spec/swagger_v2/api_swagger_v2_response_with_headers_spec.rb

@@ -19,7 +19,8 @@ describe 'response with headers' do
         end
 
         desc 'A 204 can have headers too' do
-          success Hash[status: 204, message: 'No content', headers: { 'Location' => { description: 'Location of resource', type: 'string' } }]
+          foo = { status: 204, message: 'No content', headers: { 'Location' => { description: 'Location of resource', type: 'string' } } }
+          success foo
           failure [[400, 'Bad Request', Entities::ApiError, { 'application/json' => { code: 400, message: 'Bad request' } }, { 'Date' => { description: 'Date of failure', type: 'string' } }]]
         end
         delete '/no_content_response_headers' do
@@ -27,7 +28,8 @@ describe 'response with headers' do
         end
 
         desc 'A file can have headers too' do
-          success Hash[status: 200, model: 'File', headers: { 'Cache-Control' => { description: 'Directive for caching', type: 'string' } }]
+          foo = { status: 200, model: 'File', headers: { 'Cache-Control': { description: 'Directive for caching', type: 'string' } } }
+          success foo
           failure [[404, 'NotFound', Entities::ApiError, { 'application/json' => { code: 404, message: 'Not found' } }, { 'Date' => { description: 'Date of failure', type: 'string' } }]]
         end
         get '/file_response_headers' do

data/spec/swagger_v2/inheritance_and_discriminator_spec.rb

@@ -33,6 +33,7 @@ describe 'Inheritance and Discriminator' do
           }
         end
       end
+
       class NameApi < Grape::API
         add_swagger_documentation models: [Entities::Pet, Entities::Cat]
       end

data/spec/swagger_v2/params_example_spec.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'Param example' do
+  def app
+    Class.new(Grape::API) do
+      format :json
+
+      params do
+        requires :id, type: Integer, documentation: { example: 123 }
+        optional :name, type: String, documentation: { example: 'Person' }
+        optional :obj, type: 'Object', documentation: { example: { 'foo' => 'bar' } }
+      end
+
+      get '/endpoint_with_examples' do
+        { 'declared_params' => declared(params) }
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  describe 'documentation with parameter examples' do
+    subject do
+      get '/swagger_doc/endpoint_with_examples'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/endpoint_with_examples']['get']['parameters']).to eql(
+        [
+          { 'in' => 'query', 'name' => 'id', 'type' => 'integer', 'example' => 123, 'format' => 'int32', 'required' => true },
+          { 'in' => 'query', 'name' => 'name', 'type' => 'string', 'example' => 'Person', 'required' => false },
+          { 'in' => 'query', 'name' => 'obj', 'type' => 'Object', 'example' => { 'foo' => 'bar' }, 'required' => false }
+        ]
+      )
+    end
+  end
+end

data/spec/swagger_v2/simple_mounted_api_spec.rb

@@ -4,7 +4,9 @@ require 'spec_helper'
 
 describe 'a simple mounted api' do
   before :all do
+    # rubocop:disable Lint/EmptyClass
     class CustomType; end
+    # rubocop:enable Lint/EmptyClass
 
     class SimpleMountedApi < Grape::API
       desc 'Document root'

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.4.0
 platform: ruby
 authors:
+- LeFnord
 - Tim Vandecasteele
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-01 00:00:00.000000000 Z
+date: 2021-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -26,18 +27,21 @@ dependencies:
         version: '1.3'
 description:
 email:
+- pscholz.le@gmail.com
 - tim.vandecasteele@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".coveralls.yml"
+- ".github/dependabot.yml"
+- ".github/workflows/rubocop.yml"
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".ruby-gemset"
-- ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Dangerfile
@@ -170,8 +174,9 @@ files:
 - spec/swagger_v2/param_multi_type_spec.rb
 - spec/swagger_v2/param_type_spec.rb
 - spec/swagger_v2/param_values_spec.rb
-- spec/swagger_v2/params_array_collection_fromat_spec.rb
+- spec/swagger_v2/params_array_collection_format_spec.rb
 - spec/swagger_v2/params_array_spec.rb
+- spec/swagger_v2/params_example_spec.rb
 - spec/swagger_v2/params_hash_spec.rb
 - spec/swagger_v2/params_nested_spec.rb
 - spec/swagger_v2/parent_less_namespace_spec.rb
@@ -191,14 +196,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Add auto generated documentation to your Grape API that can be displayed
@@ -297,8 +302,9 @@ test_files:
 - spec/swagger_v2/param_multi_type_spec.rb
 - spec/swagger_v2/param_type_spec.rb
 - spec/swagger_v2/param_values_spec.rb
-- spec/swagger_v2/params_array_collection_fromat_spec.rb
+- spec/swagger_v2/params_array_collection_format_spec.rb
 - spec/swagger_v2/params_array_spec.rb
+- spec/swagger_v2/params_example_spec.rb
 - spec/swagger_v2/params_hash_spec.rb
 - spec/swagger_v2/params_nested_spec.rb
 - spec/swagger_v2/parent_less_namespace_spec.rb

data/.travis.yml

@@ -1,41 +0,0 @@
-language: ruby
-
-os: linux
-
-before_install:
-  - gem install bundler
-
-after_success:
-  - bundle exec danger
-
-rvm:
-  - 2.5.8
-  - 2.6.6
-  - 2.7.2
-env:
-  - GRAPE_VERSION=1.3.3
-  - GRAPE_VERSION=1.4.0
-  - GRAPE_VERSION=1.5.0 MODEL_PARSER=grape-swagger-entity
-  - GRAPE_VERSION=1.5.0 MODEL_PARSER=grape-swagger-representable
-  - GRAPE_VERSION=1.5.0
-  - GRAPE_VERSION=HEAD
-
-jobs:
-  fast_finish: true
-
-  include:
-    - rvm: 2.4.10
-      env:
-    - rvm: ruby-head
-      env:
-    - rvm: jruby-head
-      env:
-    - rvm: truffleruby-head
-      env:
-      script: bundle exec rake spec
-
-  allow_failures:
-    - rvm: 2.4.10
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: truffleruby-head