grape-swagger 1.1.0 → 1.4.2

data/spec/swagger_v2/reference_entity_spec.rb

@@ -22,6 +22,20 @@ describe 'referenceEntity' do
           expose :title, documentation: { type: 'string', desc: 'Title of the kind.' }
           expose :something, documentation: { type: Something, desc: 'Something interesting.' }
         end
+
+        class Base < Grape::Entity
+          def self.entity_name
+            parts = to_s.split('::')
+
+            "MyAPI::#{parts.last}"
+          end
+
+          expose :title, documentation: { type: 'string', desc: 'Title of the parent.' }
+        end
+
+        class Child < Base
+          expose :child, documentation: { type: 'string', desc: 'Child property.' }
+        end
       end
 
       class ResponseModelApi < Grape::API
@@ -40,6 +54,16 @@ describe 'referenceEntity' do
           present kind, with: Entities::Kind
         end
 
+        desc 'This returns a child entity',
+             entity: Entities::Child,
+             http_codes: [
+               { code: 200, message: 'OK', model: Entities::Child }
+             ]
+        get '/child' do
+          child = OpenStruct.new text: 'child'
+          present child, with: Entities::Child
+        end
+
         add_swagger_documentation # models: [MyAPI::Entities::Something, MyAPI::Entities::Kind]
       end
     end
@@ -49,36 +73,57 @@ describe 'referenceEntity' do
     MyAPI::ResponseModelApi
   end
 
-  subject do
-    get '/swagger_doc/kind'
-    JSON.parse(last_response.body)
+  describe 'kind' do
+    subject do
+      get '/swagger_doc/kind'
+      JSON.parse(last_response.body)
+    end
+
+    it 'should document specified models' do
+      expect(subject['paths']['/kind']['get']['parameters']).to eq [{
+        'in' => 'query',
+        'name' => 'something',
+        'description' => 'Something interesting.',
+        'type' => 'SomethingCustom',
+        'required' => false
+      }]
+
+      expect(subject['definitions'].keys).to include 'SomethingCustom'
+      expect(subject['definitions']['SomethingCustom']).to eq(
+        'type' => 'object', 'properties' => { 'text' => { 'type' => 'string', 'description' => 'Content of something.' } }
+      )
+
+      expect(subject['definitions'].keys).to include 'KindCustom'
+      expect(subject['definitions']['KindCustom']).to eq(
+        'type' => 'object',
+        'properties' => {
+          'title' => { 'type' => 'string', 'description' => 'Title of the kind.' },
+          'something' => {
+            '$ref' => '#/definitions/SomethingCustom',
+            'description' => 'Something interesting.'
+          }
+        },
+        'description' => 'KindCustom model'
+      )
+    end
   end
 
-  it 'should document specified models' do
-    expect(subject['paths']['/kind']['get']['parameters']).to eq [{
-      'in' => 'query',
-      'name' => 'something',
-      'description' => 'Something interesting.',
-      'type' => 'SomethingCustom',
-      'required' => false
-    }]
-
-    expect(subject['definitions'].keys).to include 'SomethingCustom'
-    expect(subject['definitions']['SomethingCustom']).to eq(
-      'type' => 'object', 'properties' => { 'text' => { 'type' => 'string', 'description' => 'Content of something.' } }
-    )
-
-    expect(subject['definitions'].keys).to include 'KindCustom'
-    expect(subject['definitions']['KindCustom']).to eq(
-      'type' => 'object',
-      'properties' => {
-        'title' => { 'type' => 'string', 'description' => 'Title of the kind.' },
-        'something' => {
-          '$ref' => '#/definitions/SomethingCustom',
-          'description' => 'Something interesting.'
-        }
-      },
-      'description' => 'This returns kind and something or an error'
-    )
+  describe 'child' do
+    subject do
+      get '/swagger_doc/child'
+      JSON.parse(last_response.body)
+    end
+
+    it 'should document specified models' do
+      expect(subject['definitions'].keys).to include 'MyAPI::Child'
+      expect(subject['definitions']['MyAPI::Child']).to eq(
+        'type' => 'object',
+        'properties' => {
+          'title' => { 'type' => 'string', 'description' => 'Title of the parent.' },
+          'child' => { 'type' => 'string', 'description' => 'Child property.' }
+        },
+        'description' => 'MyAPI::Child model'
+      )
+    end
   end
 end

data/spec/swagger_v2/security_requirement_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 describe 'security requirement on endpoint method' do
   def app
     Class.new(Grape::API) do
-      desc 'Endpoint with security requirement', security: [oauth_pets: ['read:pets', 'write:pets']]
+      desc 'Endpoint with security requirement', security: [{ oauth_pets: ['read:pets', 'write:pets'] }]
       get '/with_security' do
         { foo: 'bar' }
       end
@@ -37,7 +37,7 @@ describe 'security requirement on endpoint method' do
   end
 
   it 'defines the security requirement on the endpoint method' do
-    expect(subject['paths']['/with_security']['get']['security']).to eql ['oauth_pets' => ['read:pets', 'write:pets']]
+    expect(subject['paths']['/with_security']['get']['security']).to eql [{ 'oauth_pets' => ['read:pets', 'write:pets'] }]
   end
 
   it 'defines an empty security requirement on the endpoint method' do

data/spec/swagger_v2/simple_mounted_api_spec.rb

@@ -4,11 +4,14 @@ 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'
       get do
+        { message: 'hi' }
       end
 
       desc 'This gets something.',

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.2
 platform: ruby
 authors:
+- LeFnord
 - Tim Vandecasteele
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-20 00:00:00.000000000 Z
+date: 2021-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -16,28 +17,31 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.3.0
-description: 
+        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
@@ -95,7 +99,10 @@ 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/issues/832_array_hash_float_decimal_spec.rb
 - spec/lib/data_type_spec.rb
 - spec/lib/endpoint/params_parser_spec.rb
 - spec/lib/endpoint_spec.rb
@@ -121,6 +128,7 @@ files:
 - spec/support/namespace_tags.rb
 - spec/support/the_paths_definitions.rb
 - spec/swagger_v2/api_documentation_spec.rb
+- spec/swagger_v2/api_swagger_v2_additional_properties_spec.rb
 - spec/swagger_v2/api_swagger_v2_body_definitions_spec.rb
 - spec/swagger_v2/api_swagger_v2_definitions-models_spec.rb
 - spec/swagger_v2/api_swagger_v2_detail_spec.rb
@@ -140,6 +148,7 @@ files:
 - spec/swagger_v2/api_swagger_v2_response_spec.rb
 - spec/swagger_v2/api_swagger_v2_response_with_examples_spec.rb
 - spec/swagger_v2/api_swagger_v2_response_with_headers_spec.rb
+- spec/swagger_v2/api_swagger_v2_response_with_models_spec.rb
 - spec/swagger_v2/api_swagger_v2_response_with_root_spec.rb
 - spec/swagger_v2/api_swagger_v2_spec.rb
 - spec/swagger_v2/api_swagger_v2_status_codes_spec.rb
@@ -156,6 +165,7 @@ files:
 - spec/swagger_v2/guarded_endpoint_spec.rb
 - spec/swagger_v2/hide_api_spec.rb
 - spec/swagger_v2/host_spec.rb
+- spec/swagger_v2/inheritance_and_discriminator_spec.rb
 - spec/swagger_v2/mount_override_api_spec.rb
 - spec/swagger_v2/mounted_target_class_spec.rb
 - spec/swagger_v2/namespace_tags_prefix_spec.rb
@@ -166,8 +176,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
@@ -179,7 +190,7 @@ homepage: https://github.com/ruby-grape/grape-swagger
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -187,15 +198,15 @@ 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.2
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Add auto generated documentation to your Grape API that can be displayed
   with Swagger.
@@ -218,7 +229,10 @@ 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/issues/832_array_hash_float_decimal_spec.rb
 - spec/lib/data_type_spec.rb
 - spec/lib/endpoint/params_parser_spec.rb
 - spec/lib/endpoint_spec.rb
@@ -244,6 +258,7 @@ test_files:
 - spec/support/namespace_tags.rb
 - spec/support/the_paths_definitions.rb
 - spec/swagger_v2/api_documentation_spec.rb
+- spec/swagger_v2/api_swagger_v2_additional_properties_spec.rb
 - spec/swagger_v2/api_swagger_v2_body_definitions_spec.rb
 - spec/swagger_v2/api_swagger_v2_definitions-models_spec.rb
 - spec/swagger_v2/api_swagger_v2_detail_spec.rb
@@ -263,6 +278,7 @@ test_files:
 - spec/swagger_v2/api_swagger_v2_response_spec.rb
 - spec/swagger_v2/api_swagger_v2_response_with_examples_spec.rb
 - spec/swagger_v2/api_swagger_v2_response_with_headers_spec.rb
+- spec/swagger_v2/api_swagger_v2_response_with_models_spec.rb
 - spec/swagger_v2/api_swagger_v2_response_with_root_spec.rb
 - spec/swagger_v2/api_swagger_v2_spec.rb
 - spec/swagger_v2/api_swagger_v2_status_codes_spec.rb
@@ -279,6 +295,7 @@ test_files:
 - spec/swagger_v2/guarded_endpoint_spec.rb
 - spec/swagger_v2/hide_api_spec.rb
 - spec/swagger_v2/host_spec.rb
+- spec/swagger_v2/inheritance_and_discriminator_spec.rb
 - spec/swagger_v2/mount_override_api_spec.rb
 - spec/swagger_v2/mounted_target_class_spec.rb
 - spec/swagger_v2/namespace_tags_prefix_spec.rb
@@ -289,8 +306,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,35 +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.1
-env:
-  - GRAPE_VERSION=1.3.0 MODEL_PARSER=grape-swagger-entity
-  - GRAPE_VERSION=1.3.0 MODEL_PARSER=grape-swagger-representable
-  - GRAPE_VERSION=1.3.0
-  - GRAPE_VERSION=HEAD
-
-jobs:
-  fast_finish: true
-
-  include:
-    - rvm: 2.4.10
-      env:
-    - rvm: ruby-head
-      env:
-    - rvm: jruby-head
-      env:
-
-  allow_failures:
-    - rvm: 2.4.10
-    - rvm: ruby-head
-    - rvm: jruby-head