grape-swagger 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a3f65f49a31d6affe69a657daff3867582070436163992acb47f1166dde1cc6
-  data.tar.gz: da9f13e2efd7e2b23dc92eea5b9deeaf4d9b8a860b13bae2b7f928b31d996be3
+  metadata.gz: 1d9d2fa1309701cf2c24f0993db15660df9be1c437861529a321e6344390fc90
+  data.tar.gz: 8e74a44fddb127a89ec914da70de6118a86fe17318fb16e4f68d2761cd69dc1c
 SHA512:
-  metadata.gz: 0d51d5cde5ff558fefcbf8b4503d290bc535c48f22d1ee3c2662ad406c548b7ef72d196b36598b2d3ea68d6ebef8e6ce43e3dec8dab6f371df9d12aaadd34567
-  data.tar.gz: b22301456da8cd150767fd614434bfad161959eb0836b028b4ff8d15893fd128c53513e87ab8180a6442b8fda9ec41a6e6648b67cb32a46b692d2b117e229ec1
+  metadata.gz: 79db26518f7697a7347ad92749eaa14722310e41e395177e839d04bfc5e490026989a687158f89f34ea52a62a390482430d79067aa887f4ef90e95bf991315d7
+  data.tar.gz: 95e85e0b5d337b53bd4ed260aed3fcaae2acae613fcf337552afe0b4be280da89587351008f1f2054440b61e868804c1710340214d2ad80ca4950439af3f5fbe

data/.rubocop.yml

@@ -28,6 +28,10 @@ Layout/SpaceAroundMethodCallOperator:
 
 # Lint stuff
 #
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - spec/**/*
+
 Lint/DeprecatedOpenSSLConstant:
   Enabled: true
 
@@ -50,7 +54,7 @@ Metrics/BlockLength:
     - spec/**/*
 
 Metrics/ClassLength:
-  Max: 300
+  Max: 350
 
 Metrics/CyclomaticComplexity:
   Max: 17
@@ -69,6 +73,9 @@ Naming:
 Style/AccessorGrouping:
   Enabled: true
 
+Style/AsciiComments:
+  Enabled: false
+
 Style/ArrayCoercion:
   Enabled: true
 

data/.rubocop_todo.yml

@@ -28,7 +28,7 @@ Metrics/MethodLength:
 
 # Offense count: 7
 Metrics/PerceivedComplexity:
-  Max: 14
+  Max: 16
 
 # Offense count: 3
 Style/ClassVars:

data/.travis.yml

@@ -11,12 +11,13 @@ after_success:
 rvm:
   - 2.5.8
   - 2.6.6
-  - 2.7.1
+  - 2.7.2
 env:
   - GRAPE_VERSION=1.3.3
-  - GRAPE_VERSION=1.4.0 MODEL_PARSER=grape-swagger-entity
-  - GRAPE_VERSION=1.4.0 MODEL_PARSER=grape-swagger-representable
   - 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:

data/CHANGELOG.md

@@ -9,6 +9,17 @@
 * Your contribution here.
 
 
+### 1.3.1 (November 1, 2020)
+
+#### Features
+
+* [#813](https://github.com/ruby-grape/grape-swagger/pull/813): Handle multiple presents - [@AntoineGuestin](https://github.com/AntoineGuestin).
+
+#### Fixes
+
+* [#811](https://github.com/ruby-grape/grape-swagger/pull/811): Fixes #809: supports utf8 route names - [@LeFnord](https://github.com/LeFnord).
+
+
 ### 1.3.0 (September 3, 2020)
 
 #### Features

data/Gemfile

@@ -6,7 +6,7 @@ ruby RUBY_VERSION
 
 gemspec
 
-gem 'grape', case version = ENV['GRAPE_VERSION'] || '>= 1.4.0'
+gem 'grape', case version = ENV['GRAPE_VERSION'] || '>= 1.5.0'
              when 'HEAD'
                { git: 'https://github.com/ruby-grape/grape' }
              else
@@ -27,7 +27,7 @@ group :development, :test do
   gem 'rake'
   gem 'rdoc'
   gem 'rspec', '~> 3.9'
-  gem 'rubocop', '~> 0.90', require: false
+  gem 'rubocop', '~> 1.0', require: false
 end
 
 group :test do

data/README.md

@@ -458,6 +458,7 @@ add_swagger_documentation \
 * [Response examples documentation](#response-examples)
 * [Response headers documentation](#response-headers)
 * [Adding root element to responses](#response-root)
+* [Multiple present Response](#multiple-response)
 
 #### Swagger Header Parameters  <a name="headers"></a>
 
@@ -1262,6 +1263,75 @@ The result will look like following:
     }
   }
 ```
+#### Multiple present Response <a name="multiple-response"></a>
+
+You can specify a custom multiple response by using the `as` key:
+```ruby
+desc 'Multiple response',
+  success: [
+    { model: Entities::EnumValues, as: :gender },
+    { model: Entities::Something, as: :somethings }
+  ]
+end
+
+get '/things' do
+  ...
+end
+```
+The result will look like following:
+```
+  "responses": {
+    "200": {
+      "description": "Multiple response",
+      "schema":{
+        "type":"object",
+        "properties":{
+          "gender":{
+            "$ref":"#/definitions/EnumValues"
+          },
+          "somethings":{
+            "$ref":"#/definitions/Something"
+          }
+        }
+      }
+    }
+  }
+```
+You can also specify if the response is an array, with the `is_array` key:
+```ruby
+desc 'Multiple response with array',
+  success: [
+    { model: Entities::EnumValues, as: :gender },
+    { model: Entities::Something, as: :somethings, is_array: true }
+  ]
+end
+
+get '/things' do
+  ...
+end
+```
+The result will look like following:
+```
+  "responses": {
+    "200": {
+      "description": "Multiple response with array",
+      "schema":{
+        "type":"object",
+        "properties":{
+          "gender":{
+            "$ref":"#/definitions/EnumValues"
+          },
+          "somethings":{
+            "type":"array",
+            "items":{
+                "$ref":"#/definitions/Something"
+            }
+          }
+        }
+      }
+    }
+  }
+```
 
 ## Using Grape Entities <a name="grape-entity"></a>
 

data/lib/grape-swagger.rb

@@ -29,7 +29,10 @@ module SwaggerRouting
       route_match = route_path.split(/^.*?#{route.prefix}/).last
       next unless route_match
 
-      route_match = route_match.match('\/([\w|-]*?)[\.\/\(]') || route_match.match('\/([\w|-]*)$')
+      # want to match emojis … ;)
+      # route_match = route_match
+      #   .match('\/([\p{Alnum}|\p{Emoji}|\-|\_]*?)[\.\/\(]') || route_match.match('\/([\p{Alpha}|\p{Emoji}|\-|\_]*)$')
+      route_match = route_match.match('\/([\p{Alnum}|\-|\_]*?)[\.\/\(]') || route_match.match('\/([\p{Alpha}|\-|\_]*)$')
       next unless route_match
 
       resource = route_match.captures.first
@@ -85,7 +88,7 @@ module SwaggerRouting
     route_name = name.match(%r{^/?([^/]*).*$})[1]
     return route_name unless route_name.include? ':'
 
-    matches = name.match(/\/[a-z]+/)
+    matches = name.match(/\/\p{Alpha}+/)
     matches.nil? ? route_name : matches[0].delete('/')
   end
 

data/lib/grape-swagger/endpoint.rb

@@ -201,8 +201,7 @@ module Grape
     def response_object(route, options)
       codes(route).each_with_object({}) do |value, memo|
         value[:message] ||= ''
-        memo[value[:code]] = { description: value[:message] }
-
+        memo[value[:code]] = { description: value[:message] ||= '' } unless memo[value[:code]].present?
         memo[value[:code]][:headers] = value[:headers] if value[:headers]
 
         next build_file_response(memo[value[:code]]) if file_response?(value[:model])
@@ -221,7 +220,7 @@ module Grape
         next if response_model.start_with?('Swagger_doc')
 
         @definitions[response_model][:description] ||= "#{response_model} model"
-        memo[value[:code]][:schema] = build_reference(route, value, response_model, options)
+        build_memo_schema(memo, route, value, response_model, options)
         memo[value[:code]][:examples] = value[:examples] if value[:examples]
       end
     end
@@ -268,15 +267,45 @@ module Grape
 
     private
 
+    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))
+      elsif value[:as]
+        memo[value[:code]][:schema] = {
+          type: :object,
+          properties: build_reference(route, value, response_model, options)
+        }
+      else
+        memo[value[:code]][:schema] = build_reference(route, value, response_model, options)
+      end
+    end
+
     def build_reference(route, value, response_model, settings)
       # TODO: proof that the definition exist, if model isn't specified
-      reference = { '$ref' => "#/definitions/#{response_model}" }
+      reference = if value.key?(:as)
+                    { value[:as] => build_reference_hash(response_model) }
+                  else
+                    build_reference_hash(response_model)
+                  end
       return reference unless value[:code] < 300
 
-      reference = { type: 'array', items: reference } if route.options[:is_array]
+      if value.key?(:as) && value.key?(:is_array)
+        reference[value[:as]] = build_reference_array(reference[value[:as]])
+      elsif route.options[:is_array]
+        reference = build_reference_array(reference)
+      end
+
       build_root(route, reference, response_model, settings)
     end
 
+    def build_reference_hash(response_model)
+      { '$ref' => "#/definitions/#{response_model}" }
+    end
+
+    def build_reference_array(reference)
+      { type: 'array', items: reference }
+    end
+
     def build_root(route, reference, response_model, settings)
       default_root = response_model.underscore
       default_root = default_root.pluralize if route.options[:is_array]
@@ -382,6 +411,8 @@ module Grape
         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]
+        default_code[:as] = entity[:as] if entity[:as]
+        default_code[:is_array] = entity[:is_array] if entity[:is_array]
       else
         default_code = GrapeSwagger::DocMethods::StatusCodes.get[route.request_method.downcase.to_sym]
         default_code[:model] = entity if entity

data/lib/grape-swagger/version.rb

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

data/spec/issues/537_enum_values_spec.rb

@@ -15,6 +15,7 @@ describe '#537 enum values spec' do
         desc 'create account',
              success: Spec
         get do
+          { message: 'hi' }
         end
       end
 

data/spec/issues/776_multiple_presents_spec.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#776 multiple presents spec' do
+  include_context "#{MODEL_PARSER} swagger example"
+
+  let(:app) do
+    Class.new(Grape::API) do
+      namespace :issue_776 do
+        desc 'Get multiple presents',
+             success: [
+               { model: Entities::EnumValues, as: :gender },
+               { model: Entities::Something, as: :somethings, is_array: true }
+             ]
+
+        get do
+          present :gender, { number: 1, gender: 'Male' }, with: Entities::EnumValues
+          present :somethings, [
+            { id: 1, text: 'element_1', links: %w[link1 link2] },
+            { id: 2, text: 'element_2', links: %w[link1 link2] }
+          ], with: Entities::Something, is_array: true
+        end
+      end
+
+      add_swagger_documentation format: :json
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  let(:definitions) { subject['definitions'] }
+  let(:schema) { subject['paths']['/issue_776']['get']['responses']['200']['schema'] }
+
+  specify { expect(definitions.keys).to include 'EnumValues', 'Something' }
+
+  specify do
+    expect(schema).to eql({
+      'properties' => {
+        'somethings' => {
+          'items' => {
+            '$ref' => '#/definitions/Something'
+          },
+          'type' => 'array'
+        },
+        'gender' => {
+          '$ref' => '#/definitions/EnumValues'
+        }
+      },
+      'type' => 'object'
+    })
+  end
+end

data/spec/issues/809_utf8_routes_spec.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe '#605 root route documentation' do
+  let(:app) do
+    Class.new(Grape::API) do
+      resource :grunnbeløp do
+        desc 'returnerer grunnbeløp'
+        get do
+          { message: 'hello world' }
+        end
+      end
+
+      resource :εσόδων do
+        desc 'εσόδων'
+        get do
+          { message: 'hello world' }
+        end
+      end
+
+      resource :数 do
+        desc '数'
+        get do
+          { message: 'hello world' }
+        end
+      end
+
+      resource :amount do
+        desc 'returns amount'
+        get do
+          { message: 'hello world' }
+        end
+      end
+
+      resource :👍 do
+        desc 'returns 👍'
+        get do
+          { message: 'hello world' }
+        end
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)['paths']
+  end
+
+  specify do
+    expect(subject.keys).to match_array ['/grunnbeløp', '/amount', '/εσόδων', '/数']
+  end
+end

data/spec/support/namespace_tags.rb

@@ -9,6 +9,7 @@ RSpec.shared_context 'namespace example' do
         namespace :hudson do
           desc 'Document root'
           get '/' do
+            { message: 'hi' }
           end
         end
 

data/spec/swagger_v2/api_swagger_v2_mounted_spec.rb

@@ -81,6 +81,7 @@ describe 'swagger spec v2.0' do
           requires :id, type: Integer
         end
         delete '/dummy/:id' do
+          {}
         end
 
         namespace :other_thing do

data/spec/swagger_v2/api_swagger_v2_spec.rb

@@ -80,6 +80,7 @@ describe 'swagger spec v2.0' do
         requires :id, type: Integer
       end
       delete '/dummy/:id' do
+        {}
       end
 
       namespace :other_thing do

data/spec/swagger_v2/boolean_params_spec.rb

@@ -11,6 +11,7 @@ describe 'Boolean Params' do
         requires :a_boolean, type: Grape::API::Boolean
       end
       post :splines do
+        { message: 'hi' }
       end
 
       add_swagger_documentation

data/spec/swagger_v2/float_api_spec.rb

@@ -11,6 +11,7 @@ describe 'Float Params' do
         requires :a_float, type: Float
       end
       post :splines do
+        { message: 'hi' }
       end
 
       add_swagger_documentation

data/spec/swagger_v2/namespace_tags_prefix_spec.rb

@@ -17,6 +17,7 @@ describe 'namespace tags check while using prefix and version' do
         namespace :hudson do
           desc 'Document root'
           get '/' do
+            { message: 'hi' }
           end
         end
 

data/spec/swagger_v2/param_multi_type_spec.rb

@@ -16,6 +16,7 @@ describe 'Params Multi Types' do
         requires :another_input, type: [String, Integer]
       end
       post :action do
+        { message: 'hi' }
       end
 
       add_swagger_documentation
@@ -61,6 +62,7 @@ describe 'Params Multi Types' do
           requires :another_input, type: [String, Integer]
         end
         post :action do
+          { message: 'hi' }
         end
 
         add_swagger_documentation

data/spec/swagger_v2/param_type_spec.rb

@@ -11,12 +11,14 @@ describe 'Params Types' do
         requires :input, type: String
       end
       post :action do
+        { message: 'hi' }
       end
 
       params do
         requires :input, type: String, default: '14', documentation: { type: 'email', default: '42' }
       end
       post :action_with_doc do
+        { message: 'hi' }
       end
 
       add_swagger_documentation
@@ -49,6 +51,7 @@ describe 'Params Types' do
             requires :input, type: String
           end
           post :action do
+            { message: 'hi' }
           end
 
           add_swagger_documentation

data/spec/swagger_v2/param_values_spec.rb

@@ -12,24 +12,28 @@ describe 'Convert values to enum or Range' do
         requires :letter, type: String, values: %w[a b c]
       end
       post :plain_array do
+        { message: 'hi' }
       end
 
       params do
         requires :letter, type: String, values: proc { %w[d e f] }
       end
       post :array_in_proc do
+        { message: 'hi' }
       end
 
       params do
         requires :letter, type: String, values: 'a'..'z'
       end
       post :range_letter do
+        { message: 'hi' }
       end
 
       params do
         requires :integer, type: Integer, values: -5..5
       end
       post :range_integer do
+        { message: 'hi' }
       end
 
       add_swagger_documentation
@@ -107,12 +111,14 @@ describe 'Convert values to enum for float range and not arrays inside a proc',
         requires :letter, type: String, values: proc { 'string' }
       end
       post :non_array_in_proc do
+        { message: 'hi' }
       end
 
       params do
         requires :float, type: Float, values: -5.0..5.0
       end
       post :range_float do
+        { message: 'hi' }
       end
 
       add_swagger_documentation

data/spec/swagger_v2/simple_mounted_api_spec.rb

@@ -9,6 +9,7 @@ describe 'a simple mounted api' do
     class SimpleMountedApi < Grape::API
       desc 'Document root'
       get do
+        { message: 'hi' }
       end
 
       desc 'This gets something.',

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-04 00:00:00.000000000 Z
+date: 2020-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -95,7 +95,9 @@ files:
 - spec/issues/650_params_array_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
 - spec/issues/784_extensions_on_params_spec.rb
+- spec/issues/809_utf8_routes_spec.rb
 - spec/lib/data_type_spec.rb
 - spec/lib/endpoint/params_parser_spec.rb
 - spec/lib/endpoint_spec.rb
@@ -220,7 +222,9 @@ test_files:
 - spec/issues/650_params_array_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
 - spec/issues/784_extensions_on_params_spec.rb
+- spec/issues/809_utf8_routes_spec.rb
 - spec/lib/data_type_spec.rb
 - spec/lib/endpoint/params_parser_spec.rb
 - spec/lib/endpoint_spec.rb