grape-swagger 0.34.2 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1adc600f72fbf0b270ca597d538fc692ab1b06d96aec051dd5aac93b0d9541e4
-  data.tar.gz: 90b38eef4b8736e686c57b9ae3a0a047c3be752076a3c51fe81a2b2ace4534d7
+  metadata.gz: 7a3f65f49a31d6affe69a657daff3867582070436163992acb47f1166dde1cc6
+  data.tar.gz: da9f13e2efd7e2b23dc92eea5b9deeaf4d9b8a860b13bae2b7f928b31d996be3
 SHA512:
-  metadata.gz: becc52b89b55eaf20b8e17c39b2a2d53592fbe6a92feb1c50d6f1b80d4ee0b14edb16dbcb5e6168a5d7830b80f8d412af19c78fc0a645aabd1ca3570ed3e34fb
-  data.tar.gz: c6da9f8e4818368d67f525898d69b9d15fe46d429cb4223fb44ff1f4d2c52aefff99f8487cf8ecdf702153d1a3d7dbaed93756a0967bbdadd871fdc26f8af229
+  metadata.gz: 0d51d5cde5ff558fefcbf8b4503d290bc535c48f22d1ee3c2662ad406c548b7ef72d196b36598b2d3ea68d6ebef8e6ce43e3dec8dab6f371df9d12aaadd34567
+  data.tar.gz: b22301456da8cd150767fd614434bfad161959eb0836b028b4ff8d15893fd128c53513e87ab8180a6442b8fda9ec41a6e6648b67cb32a46b692d2b117e229ec1

data/.rubocop.yml

@@ -4,11 +4,17 @@ AllCops:
   Exclude:
     - vendor/**/*
     - example/**/*
+  NewCops: enable
   TargetRubyVersion: 2.7
 
+#  Layout stuff
+#
 Layout/EmptyLinesAroundArguments:
   Enabled: false
 
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
 Layout/FirstHashElementIndentation:
   EnforcedStyle: consistent
 
@@ -17,6 +23,28 @@ Layout/LineLength:
   Exclude:
     - spec/**/*
 
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+# Lint stuff
+#
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+# Metrics stuff
+#
 Metrics/BlockLength:
   Exclude:
     - spec/**/*
@@ -24,12 +52,70 @@ Metrics/BlockLength:
 Metrics/ClassLength:
   Max: 300
 
+Metrics/CyclomaticComplexity:
+  Max: 17
+
 Metrics/MethodLength:
   Exclude:
     - spec/**/*
 
+# Naming stuff
+#
 Naming:
   Enabled: false
 
+# Style stuff
+#
+Style/AccessorGrouping:
+  Enabled: true
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/ExplicitBlockArgument:
+  Enabled: false
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
 Style/RegexpLiteral:
   Enabled: false
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: false

data/.travis.yml

@@ -1,5 +1,7 @@
 language: ruby
 
+os: linux
+
 before_install:
   - gem install bundler
 
@@ -7,27 +9,32 @@ after_success:
   - bundle exec danger
 
 rvm:
-  - 2.5.7
-  - 2.6.5
-  - 2.7.0
+  - 2.5.8
+  - 2.6.6
+  - 2.7.1
 env:
-  - GRAPE_VERSION=1.2.5 MODEL_PARSER=grape-swagger-entity
-  - GRAPE_VERSION=1.2.5 MODEL_PARSER=grape-swagger-representable
-  - GRAPE_VERSION=1.0.3
-  - GRAPE_VERSION=1.2.5
+  - 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=HEAD
 
-matrix:
+jobs:
   fast_finish: true
 
   include:
-    - rvm: 2.4.9
-      env: GRAPE_VERSION=1.2.5
+    - rvm: 2.4.10
+      env:
     - rvm: ruby-head
-      env: GRAPE_VERSION=HEAD
+      env:
     - rvm: jruby-head
       env:
+    - rvm: truffleruby-head
+      env:
+      script: bundle exec rake spec
 
   allow_failures:
-    - rvm: 2.4.9
+    - rvm: 2.4.10
     - rvm: ruby-head
     - rvm: jruby-head
+    - rvm: truffleruby-head

data/CHANGELOG.md

@@ -6,6 +6,53 @@
 
 #### Fixes
 
+* Your contribution here.
+
+
+### 1.3.0 (September 3, 2020)
+
+#### Features
+
+* [#804](https://github.com/ruby-grape/grape-swagger/pull/804): Don't overwrite model description with the route description - [@Bhacaz](https://github.com/Bhacaz).
+
+
+### 1.2.1 (July 15, 2020)
+
+#### Fixes
+
+* [#801](https://github.com/ruby-grape/grape-swagger/pull/801): Fixes behaviour after grape upgrade to 1.4.0 - [@LeFnord](https://github.com/LeFnord).
+
+
+### 1.2.0 (July 1, 2020)
+
+#### Features
+
+* [#794](https://github.com/ruby-grape/grape-swagger/pull/794): Allow `entity_name` to be inherited, fixes issue #659 - [@urkle](https://github.com/urkle).
+* [#793](https://github.com/ruby-grape/grape-swagger/pull/793): Features/inheritance and discriminator - [@MaximeRDY](https://github.com/MaximeRDY).
+
+#### Fixes
+
+* [#798](https://github.com/ruby-grape/grape-swagger/pull/798): Modify full entity name separator - [@GarrettB71](https://github.com/GarrettB71).
+* [#796](https://github.com/ruby-grape/grape-swagger/pull/796): Support grape 1.4.0 - [@thedanielhanke](https://github.com/thedanielhanke).
+
+
+### 1.1.0 (April 20, 2020)
+
+#### Features
+
+* [#785](https://github.com/ruby-grape/grape-swagger/pull/785): Add extensions for params - [@MaximeRDY](https://github.com/MaximeRDY).
+* [#782](https://github.com/ruby-grape/grape-swagger/pull/782): Allow passing class name as string for rake task initializer - [@misdoro](https://github.com/misdoro).
+* [#786](https://github.com/ruby-grape/grape-swagger/pull/786): Use full entity name as a default - [@mrexox](https://github.com/mrexox).
+
+
+### 1.0.0 (February 10, 2020)
+
+#### Features
+
+* [#777](https://github.com/ruby-grape/grape-swagger/pull/777): Make usage of grape >= 1.3, rack >= 2.1 - [@LeFnord](https://github.com/LeFnord).
+* [#775](https://github.com/ruby-grape/grape-swagger/pull/775): Add in token_owner support to param hidden procs - [@urkle](https://github.com/urkle).
+
+
 ### 0.34.2 (January 20, 2020)
 
 #### Fixes
@@ -38,10 +85,6 @@
 * [#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).
 
-#### Changes
-
-* [#749](https://github.com/ruby-grape/grape-swagger/pull/749) Drop support for Ruby 2.3 and below - [@LeFnord](https://github.com/LeFnord).
-
 
 ### 0.32.1 (December 7, 2018)
 

data/Gemfile

@@ -6,7 +6,7 @@ ruby RUBY_VERSION
 
 gemspec
 
-gem 'grape', case version = ENV['GRAPE_VERSION'] || '< 1.3.0'
+gem 'grape', case version = ENV['GRAPE_VERSION'] || '>= 1.4.0'
              when 'HEAD'
                { git: 'https://github.com/ruby-grape/grape' }
              else
@@ -14,23 +14,29 @@ gem 'grape', case version = ENV['GRAPE_VERSION'] || '< 1.3.0'
              end
 
 gem ENV['MODEL_PARSER'] if ENV.key?('MODEL_PARSER')
+
 group :development, :test do
   gem 'bundler'
   gem 'grape-entity'
   gem 'pry', platforms: [:mri]
   gem 'pry-byebug', platforms: [:mri]
 
+  gem 'rack', '~> 2.2'
   gem 'rack-cors'
   gem 'rack-test'
   gem 'rake'
   gem 'rdoc'
   gem 'rspec', '~> 3.9'
-  gem 'rubocop', '~> 0.75', require: false
+  gem 'rubocop', '~> 0.90', require: false
 end
 
 group :test do
   gem 'coveralls_reborn', require: false
-  gem 'grape-swagger-entity'
+
   gem 'ruby-grape-danger', '~> 0.1.1', require: false
   gem 'simplecov', require: false
+
+  unless ENV['MODEL_PARSER'] == 'grape-swagger-entity'
+    gem 'grape-swagger-entity', git: 'https://github.com/ruby-grape/grape-swagger-entity'
+  end
 end

data/README.md

@@ -43,15 +43,16 @@ This screenshot is based on the [Hussars](https://github.com/LeFnord/hussars) sa
 
 The following versions of grape, grape-entity and grape-swagger can currently be used together.
 
-grape-swagger | swagger spec | grape                   | grape-entity | representable |
---------------|--------------|-------------------------|--------------|---------------|
-0.10.5        |     1.2      | >= 0.10.0 ... <= 0.14.0 |  < 0.5.0     | n/a           |
-0.11.0        |     1.2      |               >= 0.16.2 |  < 0.5.0     | n/a           |
-0.25.2        |     2.0      | >= 0.14.0 ... <= 0.18.0 | <= 0.6.0     | >= 2.4.1      |
-0.26.0        |     2.0      | >= 0.16.2 ... <= 1.1.0  | <= 0.6.1     | >= 2.4.1      |
-0.27.0        |     2.0      | >= 0.16.2 ... <= 1.1.0  | >= 0.5.0     | >= 2.4.1      |
-0.32.0        |     2.0      | >= 0.16.2               | >= 0.5.0     | >= 2.4.1      |
-0.34.0        |     2.0      | >= 0.16.2 ... < 1.3.0   | >= 0.5.0     | >= 2.4.1      |
+| grape-swagger | swagger spec | grape                   | grape-entity | representable |
+| ------------- | ------------ | ----------------------- | ------------ | ------------- |
+| 0.10.5        | 1.2          | >= 0.10.0 ... <= 0.14.0 | < 0.5.0      | n/a           |
+| 0.11.0        | 1.2          | >= 0.16.2               | < 0.5.0      | n/a           |
+| 0.25.2        | 2.0          | >= 0.14.0 ... <= 0.18.0 | <= 0.6.0     | >= 2.4.1      |
+| 0.26.0        | 2.0          | >= 0.16.2 ... <= 1.1.0  | <= 0.6.1     | >= 2.4.1      |
+| 0.27.0        | 2.0          | >= 0.16.2 ... <= 1.1.0  | >= 0.5.0     | >= 2.4.1      |
+| 0.32.0        | 2.0          | >= 0.16.2               | >= 0.5.0     | >= 2.4.1      |
+| 0.34.0        | 2.0          | >= 0.16.2 ... < 1.3.0   | >= 0.5.0     | >= 2.4.1      |
+| >= 1.0.0      | 2.0          | >= 1.3.0                | >= 0.5.0     | >= 2.4.1      |
 
 
 ## Swagger-Spec <a name="swagger-spec"></a>
@@ -743,9 +744,12 @@ end
 Exclude single optional parameter from the documentation
 
 ```ruby
+not_admins = lambda { |token_owner = nil| token_owner.nil? || !token_owner.admin? }
+
 params do
   optional :one, documentation: { hidden: true }
-  optional :two, documentation: { hidden: -> { true } }
+  optional :two, documentation: { hidden: -> { |t=nil| true } }
+  optional :three, documentation: { hidden: not_admins }
 end
 post :act do
   ...
@@ -855,10 +859,11 @@ get '/thing', failure: [
 end
 ```
 
-By adding a `model` key, e.g. this would be taken.
+By adding a `model` key, e.g. this would be taken. Setting an empty string will act like an empty body.
 ```ruby
 get '/thing', failure: [
   { code: 400, message: 'General error' },
+  { code: 403, message: 'Forbidden error', model: '' },
   { code: 422, message: 'Invalid parameter entry', model: Entities::ApiError }
 ] do
   # ...
@@ -1080,6 +1085,20 @@ or, for more definitions:
 route_setting :x_def, [{ for: 422, other: 'stuff' }, { for: 200, some: 'stuff' }]
 ```
 
+- `params` extension, add a `x` key to the `documentation` hash :
+```ruby
+requires :foo, type: String, documentation: { x: { some: 'stuff' } }
+```
+this would generate:
+```json
+{
+  "in": "formData",
+  "name": "foo",
+  "type": "string",
+  "required": true,
+  "x-some": "stuff"
+}
+```
 
 #### Response examples documentation <a name="response-examples"></a>
 
@@ -1363,6 +1382,94 @@ module API
 end
 ```
 
+#### Inheritance with allOf and discriminator
+```ruby
+module Entities
+  class Pet < Grape::Entity
+    expose :type, documentation: {
+      type: 'string',
+      is_discriminator: true,
+      required: true
+    }
+    expose :name, documentation: {
+      type: 'string',
+      required: true
+    }
+  end
+
+  class Cat < Pet
+    expose :huntingSkill, documentation: {
+      type: 'string',
+      description: 'The measured skill for hunting',
+      default: 'lazy',
+      values: %w[
+        clueless
+        lazy
+        adventurous
+        aggressive
+      ]
+    }
+  end
+end
+```
+
+Should generate this definitions:
+```JSON
+{
+  "definitions": {
+    "Pet": {
+      "type": "object",
+      "discriminator": "petType",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "petType": {
+          "type": "string"
+        }
+      },
+      "required": [
+        "name",
+        "petType"
+      ]
+    },
+    "Cat": {
+      "description": "A representation of a cat",
+      "allOf": [
+        {
+          "$ref": "#/definitions/Pet"
+        },
+        {
+          "type": "object",
+          "properties": {
+            "huntingSkill": {
+              "type": "string",
+              "description": "The measured skill for hunting",
+              "default": "lazy",
+              "enum": [
+                "clueless",
+                "lazy",
+                "adventurous",
+                "aggressive"
+              ]
+            },
+            "petType": {
+              "type": "string",
+              "enum": ["Cat"]
+            }
+          },
+          "required": [
+            "huntingSkill",
+            "petType"
+          ]
+        }
+      ]
+    }
+  }
+}
+```
+
+
 
 
 ## Securing the Swagger UI <a name="oauth"></a>
@@ -1482,13 +1589,19 @@ end
 
 ## Rake Tasks <a name="rake"></a>
 
-Add these lines to your Rakefile, and initialize the Task class with your Api class – be sure your Api class is available.
+Add these lines to your Rakefile, and initialize the Task class with your Api class.
 
 ```ruby
 require 'grape-swagger/rake/oapi_tasks'
 GrapeSwagger::Rake::OapiTasks.new(::Api::Base)
 ```
 
+You may initialize with the class name as a string if the class is not yet loaded at the time Rakefile is parsed:
+```ruby
+require 'grape-swagger/rake/oapi_tasks'
+GrapeSwagger::Rake::OapiTasks.new('::Api::Base')
+```
+
 #### OpenApi/Swagger Documentation
 
 ```