grape-swagger 0.33.0 → 1.0.0

data/spec/swagger_v2/api_swagger_v2_response_with_root_spec.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'response with root' do
+  include_context "#{MODEL_PARSER} swagger example"
+
+  before :all do
+    module TheApi
+      class ResponseApiWithRoot < Grape::API
+        format :json
+
+        desc 'This returns something',
+             http_codes: [{ code: 200, model: Entities::Something }]
+        get '/ordinary_response' do
+          { 'declared_params' => declared(params) }
+        end
+
+        desc 'This returns something',
+             is_array: true,
+             http_codes: [{ code: 200, model: Entities::Something }]
+        get '/response_with_array' do
+          { 'declared_params' => declared(params) }
+        end
+
+        route_setting :swagger, root: true
+        desc 'This returns something',
+             http_codes: [{ code: 200, model: Entities::Something }]
+        get '/response_with_root' do
+          { 'declared_params' => declared(params) }
+        end
+
+        route_setting :swagger, root: true
+        desc 'This returns underscored root',
+             http_codes: [{ code: 200, model: Entities::ApiError }]
+        get '/response_with_root_underscore' do
+          { 'declared_params' => declared(params) }
+        end
+
+        route_setting :swagger, root: true
+        desc 'This returns something',
+             is_array: true,
+             http_codes: [{ code: 200, model: Entities::Something }]
+        get '/response_with_array_and_root' do
+          { 'declared_params' => declared(params) }
+        end
+
+        route_setting :swagger, root: 'custom_root'
+        desc 'This returns something',
+             http_codes: [{ code: 200, model: Entities::Something }]
+        get '/response_with_custom_root' do
+          { 'declared_params' => declared(params) }
+        end
+
+        add_swagger_documentation
+      end
+    end
+  end
+
+  def app
+    TheApi::ResponseApiWithRoot
+  end
+
+  describe 'GET /ordinary_response' do
+    subject do
+      get '/swagger_doc/ordinary_response'
+      JSON.parse(last_response.body)
+    end
+
+    it 'does not add root or array' do
+      schema = subject.dig('paths', '/ordinary_response', 'get', 'responses', '200', 'schema')
+      expect(schema).to eq(
+        '$ref' => '#/definitions/Something'
+      )
+    end
+  end
+
+  describe 'GET /response_with_array' do
+    subject do
+      get '/swagger_doc/response_with_array'
+      JSON.parse(last_response.body)
+    end
+
+    it 'adds array to the response' do
+      schema = subject.dig('paths', '/response_with_array', 'get', 'responses', '200', 'schema')
+      expect(schema).to eq(
+        'type' => 'array', 'items' => { '$ref' => '#/definitions/Something' }
+      )
+    end
+  end
+
+  describe 'GET /response_with_root' do
+    subject do
+      get '/swagger_doc/response_with_root'
+      JSON.parse(last_response.body)
+    end
+
+    it 'adds root to the response' do
+      schema = subject.dig('paths', '/response_with_root', 'get', 'responses', '200', 'schema')
+      expect(schema).to eq(
+        'type' => 'object',
+        'properties' => { 'something' => { '$ref' => '#/definitions/Something' } }
+      )
+    end
+  end
+
+  describe 'GET /response_with_root_underscore' do
+    subject do
+      get '/swagger_doc/response_with_root_underscore'
+      JSON.parse(last_response.body)
+    end
+
+    it 'adds root to the response' do
+      schema = subject.dig('paths', '/response_with_root_underscore', 'get', 'responses', '200', 'schema')
+      expect(schema).to eq(
+        'type' => 'object',
+        'properties' => { 'api_error' => { '$ref' => '#/definitions/ApiError' } }
+      )
+    end
+  end
+
+  describe 'GET /response_with_array_and_root' do
+    subject do
+      get '/swagger_doc/response_with_array_and_root'
+      JSON.parse(last_response.body)
+    end
+
+    it 'adds root and array to the response' do
+      schema = subject.dig('paths', '/response_with_array_and_root', 'get', 'responses', '200', 'schema')
+      expect(schema).to eq(
+        'type' => 'object',
+        'properties' => {
+          'somethings' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/Something' } }
+        }
+      )
+    end
+  end
+
+  describe 'GET /response_with_custom_root' do
+    subject do
+      get '/swagger_doc/response_with_custom_root'
+      JSON.parse(last_response.body)
+    end
+
+    it 'adds root to the response' do
+      schema = subject.dig('paths', '/response_with_custom_root', 'get', 'responses', '200', 'schema')
+      expect(schema).to eq(
+        'type' => 'object',
+        'properties' => { 'custom_root' => { '$ref' => '#/definitions/Something' } }
+      )
+    end
+  end
+end

data/spec/swagger_v2/boolean_params_spec.rb

@@ -8,7 +8,7 @@ describe 'Boolean Params' do
       format :json
 
       params do
-        requires :a_boolean, type: Virtus::Attribute::Boolean
+        requires :a_boolean, type: Grape::API::Boolean
       end
       post :splines do
       end

data/spec/swagger_v2/description_not_initialized_spec.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'has no description, if details or description are nil' do
+  include_context "#{MODEL_PARSER} swagger example"
+
+  before :all do
+    module TheApi
+      class GfmRcDetailApi < Grape::API
+        format :json
+
+        desc nil,
+             detail: nil,
+             entity: Entities::UseResponse,
+             failure: [{ code: 400, model: Entities::ApiError }]
+        get '/use_gfm_rc_detail' do
+          { 'declared_params' => declared(params) }
+        end
+
+        add_swagger_documentation
+      end
+    end
+  end
+
+  def app
+    TheApi::GfmRcDetailApi
+  end
+
+  subject do
+    get '/swagger_doc'
+    JSON.parse(last_response.body)
+  end
+
+  specify do
+    expect(subject['paths']['/use_gfm_rc_detail']['get']).not_to include('description')
+    expect(subject['paths']['/use_gfm_rc_detail']['get']['description']).to eql(nil)
+  end
+end

data/spec/swagger_v2/endpoint_versioned_path_spec.rb

@@ -52,6 +52,39 @@ describe 'Grape::Endpoint#path_and_definitions' do
         expect(subject.first['/v1/item'][:get][:tags]).to eq ['special-item']
       end
     end
+
+    context 'when parameter with a custom type is specified' do
+      let(:item) do
+        Class.new(Grape::API) do
+          Color = Struct.new(:value) do
+            def self.parse(value)
+              new(value: value)
+            end
+          end
+
+          class ColorEntity < Grape::Entity
+            expose :value
+          end
+
+          version 'v1', using: :path
+
+          resource :item do
+            params do
+              requires :root, type: Hash do
+                optional :color, type: Color, documentation: { type: ColorEntity }
+              end
+            end
+            post '/'
+          end
+        end
+      end
+
+      it 'creates a reference to the model instead of using the non-existent type' do
+        color = subject.dig(1, 'postV1Item', :properties, :root, :properties, :color)
+        expect(color).not_to eq(type: 'ColorEntity')
+        expect(color).to eq('$ref' => '#/definitions/ColorEntity')
+      end
+    end
   end
 
   context 'when mounting an API more than once', if: GrapeVersion.satisfy?('>= 1.2.0') do

data/spec/swagger_v2/mounted_target_class_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe 'docs mounted separately from api' do
+xdescribe 'docs mounted separately from api' do
   before :all do
     class ActualApi < Grape::API
       desc 'Document root'

data/spec/swagger_v2/namespace_tags_prefix_spec.rb

@@ -29,12 +29,25 @@ describe 'namespace tags check while using prefix and version' do
           end
         end
       end
+
+      class NestedPrefixApi < Grape::API
+        version :v1
+        prefix 'nested_prefix/api'
+
+        namespace :deep_namespace do
+          desc 'This gets something within a deeply nested resource'
+          get '/deep' do
+            { bla: 'something' }
+          end
+        end
+      end
     end
 
     class TagApi < Grape::API
       prefix :api
       mount TheApi::CascadingVersionApi
       mount TheApi::NamespaceApi
+      mount TheApi::NestedPrefixApi
       add_swagger_documentation
     end
   end
@@ -55,7 +68,8 @@ describe 'namespace tags check while using prefix and version' do
           { 'name' => 'hudson', 'description' => 'Operations about hudsons' },
           { 'name' => 'colorado', 'description' => 'Operations about colorados' },
           { 'name' => 'thames', 'description' => 'Operations about thames' },
-          { 'name' => 'niles', 'description' => 'Operations about niles' }
+          { 'name' => 'niles', 'description' => 'Operations about niles' },
+          { 'name' => 'deep_namespace', 'description' => 'Operations about deep_namespaces' }
         ]
       )
 

data/spec/swagger_v2/params_array_spec.rb

@@ -123,10 +123,10 @@ describe 'Group Params as Array' do
             'type' => 'object',
             'properties' => {
               'array_of_string' => {
-                'type' => 'string', 'description' => 'nested array of strings'
+                'items' => { 'type' => 'string' }, 'type' => 'array', 'description' => 'nested array of strings'
               },
               'array_of_integer' => {
-                'type' => 'integer', 'format' => 'int32', 'description' => 'nested array of integers'
+                'items' => { 'type' => 'integer', 'format' => 'int32' }, 'type' => 'array', 'description' => 'nested array of integers'
               }
             },
             'required' => %w[array_of_string array_of_integer]

data/spec/swagger_v2/parent_less_namespace_spec.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'a parent less namespace' do
+  include_context 'namespace example'
+
+  before :all do
+    class ParentLessApi < Grape::API
+      prefix :api
+      mount TheApi::ParentLessNamespaceApi
+      add_swagger_documentation version: 'v1'
+    end
+  end
+
+  def app
+    ParentLessApi
+  end
+
+  describe 'retrieves swagger-documentation on /swagger_doc' do
+    let(:route_name) { ':animal/:breed/queues/:queue_id/reservations' }
+    subject do
+      get '/api/swagger_doc.json'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/api/{animal}/{breed}/queues/{queue_id}/reservations']['get']['operationId'])
+        .to eql('getApiAnimalBreedQueuesQueueIdReservations')
+    end
+  end
+end

data/spec/swagger_v2/{reference_entity.rb → reference_entity_spec.rb}

@@ -58,20 +58,27 @@ describe 'referenceEntity' do
     expect(subject['paths']['/kind']['get']['parameters']).to eq [{
       'in' => 'query',
       'name' => 'something',
-      'description' => 'something as parameter',
-      'type' => 'string',
-      'required' => false,
-      'allowMultiple' => false
+      'description' => 'Something interesting.',
+      'type' => 'SomethingCustom',
+      'required' => false
     }]
 
-    expect(subject['definitions'].keys).to include 'Something'
-    expect(subject['definitions']['Something']).to eq(
-      'type' => 'object', 'properties' => { 'text' => { 'type' => 'string' } }
+    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 'Kind'
-    expect(subject['definitions']['Kind']).to eq(
-      'properties' => { 'something' => { '$ref' => '#/definitions/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'
     )
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.33.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-21 00:00:00.000000000 Z
+date: 2020-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: 1.3.0
 description: 
 email:
 - tim.vandecasteele@gmail.com
@@ -59,6 +59,7 @@ files:
 - lib/grape-swagger/doc_methods/build_model_definition.rb
 - lib/grape-swagger/doc_methods/data_type.rb
 - lib/grape-swagger/doc_methods/extensions.rb
+- lib/grape-swagger/doc_methods/format_data.rb
 - lib/grape-swagger/doc_methods/headers.rb
 - lib/grape-swagger/doc_methods/move_params.rb
 - lib/grape-swagger/doc_methods/operation_id.rb
@@ -93,10 +94,12 @@ files:
 - spec/issues/605_root_route_documentation_spec.rb
 - 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/lib/data_type_spec.rb
 - spec/lib/endpoint/params_parser_spec.rb
 - spec/lib/endpoint_spec.rb
 - spec/lib/extensions_spec.rb
+- spec/lib/format_data_spec.rb
 - spec/lib/model_parsers_spec.rb
 - spec/lib/move_params_spec.rb
 - spec/lib/oapi_tasks_spec.rb
@@ -136,13 +139,14 @@ 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_root_spec.rb
 - spec/swagger_v2/api_swagger_v2_spec.rb
 - spec/swagger_v2/api_swagger_v2_status_codes_spec.rb
 - spec/swagger_v2/api_swagger_v2_type-format_spec.rb
 - spec/swagger_v2/boolean_params_spec.rb
 - spec/swagger_v2/default_api_spec.rb
 - spec/swagger_v2/deprecated_field_spec.rb
-- spec/swagger_v2/description_not_initialized.rb
+- spec/swagger_v2/description_not_initialized_spec.rb
 - spec/swagger_v2/endpoint_versioned_path_spec.rb
 - spec/swagger_v2/errors_spec.rb
 - spec/swagger_v2/float_api_spec.rb
@@ -165,8 +169,8 @@ files:
 - spec/swagger_v2/params_array_spec.rb
 - spec/swagger_v2/params_hash_spec.rb
 - spec/swagger_v2/params_nested_spec.rb
-- spec/swagger_v2/parent_less_namespace.rb
-- spec/swagger_v2/reference_entity.rb
+- spec/swagger_v2/parent_less_namespace_spec.rb
+- spec/swagger_v2/reference_entity_spec.rb
 - spec/swagger_v2/security_requirement_spec.rb
 - spec/swagger_v2/simple_mounted_api_spec.rb
 - spec/version_spec.rb
@@ -189,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Add auto generated documentation to your Grape API that can be displayed
@@ -212,10 +216,12 @@ test_files:
 - spec/issues/605_root_route_documentation_spec.rb
 - 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/lib/data_type_spec.rb
 - spec/lib/endpoint/params_parser_spec.rb
 - spec/lib/endpoint_spec.rb
 - spec/lib/extensions_spec.rb
+- spec/lib/format_data_spec.rb
 - spec/lib/model_parsers_spec.rb
 - spec/lib/move_params_spec.rb
 - spec/lib/oapi_tasks_spec.rb
@@ -255,13 +261,14 @@ 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_root_spec.rb
 - spec/swagger_v2/api_swagger_v2_spec.rb
 - spec/swagger_v2/api_swagger_v2_status_codes_spec.rb
 - spec/swagger_v2/api_swagger_v2_type-format_spec.rb
 - spec/swagger_v2/boolean_params_spec.rb
 - spec/swagger_v2/default_api_spec.rb
 - spec/swagger_v2/deprecated_field_spec.rb
-- spec/swagger_v2/description_not_initialized.rb
+- spec/swagger_v2/description_not_initialized_spec.rb
 - spec/swagger_v2/endpoint_versioned_path_spec.rb
 - spec/swagger_v2/errors_spec.rb
 - spec/swagger_v2/float_api_spec.rb
@@ -284,8 +291,8 @@ test_files:
 - spec/swagger_v2/params_array_spec.rb
 - spec/swagger_v2/params_hash_spec.rb
 - spec/swagger_v2/params_nested_spec.rb
-- spec/swagger_v2/parent_less_namespace.rb
-- spec/swagger_v2/reference_entity.rb
+- spec/swagger_v2/parent_less_namespace_spec.rb
+- spec/swagger_v2/reference_entity_spec.rb
 - spec/swagger_v2/security_requirement_spec.rb
 - spec/swagger_v2/simple_mounted_api_spec.rb
 - spec/version_spec.rb

data/spec/swagger_v2/description_not_initialized.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe 'details' do
-  describe 'has no description, if details or description are nil' do
-    before :all do
-      module TheApi
-        class GfmRcDetailApi < Grape::API
-          format :json
-
-          desc nil,
-               detail: nil,
-               entity: Entities::UseResponse,
-               failure: [{ code: 400, model: Entities::ApiError }]
-          get '/use_gfm_rc_detail' do
-            { 'declared_params' => declared(params) }
-          end
-
-          add_swagger_documentation markdown: GrapeSwagger::Markdown::RedcarpetAdapter.new
-        end
-      end
-    end
-
-    def app
-      TheApi::GfmRcDetailApi
-    end
-
-    subject do
-      get '/swagger_doc'
-      JSON.parse(last_response.body)
-    end
-
-    specify do
-      expect(subject['paths']['/use_gfm_rc_detail']['get']).not_to include('description')
-      expect(subject['paths']['/use_gfm_rc_detail']['get']['description']).to eql(nil)
-    end
-  end
-end

data/spec/swagger_v2/parent_less_namespace.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require 'spec_helper'
-
-describe 'a parent less namespace' do
-  include_context 'namespace example'
-
-  before :all do
-    class ParentLessApi < Grape::API
-      prefix :api
-      mount TheApi::ParentLessNamespaceApi
-      add_swagger_documentation version: 'v1'
-    end
-  end
-
-  def app
-    ParentLessApi
-  end
-
-  describe 'retrieves swagger-documentation on /swagger_doc' do
-    let(:route_name) { ':animal/:breed/queues/:queue_id/reservations' }
-    subject do
-      get '/api/swagger_doc.json'
-      JSON.parse(last_response.body)
-    end
-
-    context 'not raises error' do
-      specify do
-        expect(subject['tags']).to eql([{ 'name' => 'queues', 'description' => 'Operations about queues' }])
-        expect(subject['paths']['/api/{animal}/{breed}/queues/{queue_id}/reservations']['get']['operationId'])
-          .to eql('getApiAnimalBreedQueuesQueueIdReservations')
-      end
-    end
-
-    context 'raises error' do
-      specify do
-        allow_any_instance_of(ParentLessApi)
-          .to receive(:extract_parent_route).with(route_name).and_return(':animal') # BUT IT'S NOT STUBBING, CAUSE IT'S A PRIVATE METHODS
-        expect { subject }.to raise_error NoMethodError
-      end
-    end
-
-    context 'ParentLessApi.extract_parent_route' do
-      specify do
-        expect(ParentLessApi.send(:extract_parent_route, route_name)).to eq('queues')
-      end
-    end
-  end
-end