grape-swagger 0.24.0 → 0.25.0

data/spec/issues/430_entity_definitions_spec.rb

@@ -10,19 +10,53 @@ describe 'definition names' do
           module AnotherGroupingModule
             class Class1
               class Entity < Grape::Entity
-                expose :one_thing
+                expose :first_thing
               end
             end
 
             class Class2
+              class Entities < Grape::Entity
+                expose :second_thing
+              end
+            end
+
+            class Class3
               class Entity < Grape::Entity
-                expose :another_thing
+                expose :third_thing
 
                 def self.entity_name
                   'FooKlass'
                 end
               end
             end
+
+            class Class4
+              class FourthEntity < Grape::Entity
+                expose :fourth_thing
+              end
+            end
+
+            class Class5
+              class FithEntity < Class4::FourthEntity
+                expose :fith_thing
+              end
+            end
+
+            class Class6
+              class SixthEntity < Grape::Entity
+                expose :sixth_thing
+
+                def self.entity_name
+                  'BarKlass'
+                end
+              end
+            end
+
+            class Class7
+              class SeventhEntity < Class6::SixthEntity
+                expose :seventh_thing
+              end
+            end
           end
         end
       end
@@ -30,7 +64,12 @@ describe 'definition names' do
       class NameApi < Grape::API
         add_swagger_documentation models: [
           DummyEntities::WithVeryLongName::AnotherGroupingModule::Class1::Entity,
-          DummyEntities::WithVeryLongName::AnotherGroupingModule::Class2::Entity
+          DummyEntities::WithVeryLongName::AnotherGroupingModule::Class2::Entities,
+          DummyEntities::WithVeryLongName::AnotherGroupingModule::Class3::Entity,
+          DummyEntities::WithVeryLongName::AnotherGroupingModule::Class4::FourthEntity,
+          DummyEntities::WithVeryLongName::AnotherGroupingModule::Class5::FithEntity,
+          DummyEntities::WithVeryLongName::AnotherGroupingModule::Class6::SixthEntity,
+          DummyEntities::WithVeryLongName::AnotherGroupingModule::Class7::SeventhEntity
         ]
       end
     end
@@ -43,6 +82,11 @@ describe 'definition names' do
     JSON.parse(last_response.body)['definitions']
   end
 
-  specify { expect(subject).to include 'AnotherGroupingModuleClass1' }
+  specify { expect(subject).to include 'Class1' }
+  specify { expect(subject).to include 'Class2' }
   specify { expect(subject).to include 'FooKlass' }
+  specify { expect(subject).to include 'FourthEntity' }
+  specify { expect(subject).to include 'FithEntity' }
+  specify { expect(subject).to include 'BarKlass' }
+  specify { expect(subject).to include 'SeventhEntity' }
 end

data/spec/support/model_parsers/entity_parser.rb

@@ -57,6 +57,13 @@ RSpec.shared_context 'entity swagger example' do
         expose :message, documentation: { type: String, desc: 'error message' }
       end
 
+      module NestedModule
+        class ApiResponse < Grape::Entity
+          expose :status, documentation: { type: String }
+          expose :error, documentation: { type: ::Entities::ApiError }
+        end
+      end
+
       class SecondApiError < Grape::Entity
         expose :code, documentation: { type: Integer }
         expose :severity, documentation: { type: String }
@@ -297,11 +304,13 @@ RSpec.shared_context 'entity swagger example' do
       'definitions' => {
         'QueryInput' => {
           'type' => 'object',
+          'required' => ['elements'],
           'properties' => { 'elements' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/QueryInputElement' }, 'description' => 'Set of configuration' } },
           'description' => 'nested route inside namespace'
         },
         'QueryInputElement' => {
           'type' => 'object',
+          'required' => %w(key value),
           'properties' => { 'key' => { 'type' => 'string', 'description' => 'Name of parameter' }, 'value' => { 'type' => 'string', 'description' => 'Value of parameter' } }
         },
         'ApiError' => {
@@ -327,5 +336,5 @@ RSpec.shared_context 'entity swagger example' do
 end
 
 def mounted_paths
-  %w( /thing /other_thing /dummy )
+  %w(/thing /other_thing /dummy)
 end

data/spec/support/model_parsers/mock_parser.rb

@@ -53,6 +53,9 @@ RSpec.shared_context 'mock swagger example' do
       class SecondApiError < OpenStruct; end
       class RecursiveModel < OpenStruct; end
       class DocumentedHashAndArrayModel < OpenStruct; end
+      module NestedModule
+        class ApiResponse < OpenStruct; end
+      end
     end
   end
 
@@ -329,5 +332,5 @@ RSpec.shared_context 'mock swagger example' do
 end
 
 def mounted_paths
-  %w( /thing /other_thing /dummy )
+  %w(/thing /other_thing /dummy)
 end

data/spec/support/model_parsers/representable_parser.rb

@@ -91,6 +91,15 @@ RSpec.shared_context 'representable swagger example' do
         property :message, documentation: { type: String, desc: 'error message' }
       end
 
+      module NestedModule
+        class ApiResponse < Representable::Decorator
+          include Representable::JSON
+
+          property :status, documentation: { type: String }
+          property :error, documentation: { type: ::Entities::ApiError }
+        end
+      end
+
       class SecondApiError < Representable::Decorator
         include Representable::JSON
 
@@ -236,7 +245,7 @@ RSpec.shared_context 'representable swagger example' do
       'prop_file' => { 'description' => 'prop_file description', 'type' => 'file' },
       'prop_float' => { 'description' => 'prop_float description', 'type' => 'number', 'format' => 'float' },
       'prop_integer' => { 'description' => 'prop_integer description', 'type' => 'integer', 'format' => 'int32' },
-      'prop_json' => { 'description' => 'prop_json description', 'type' => 'Representable::JSON' },
+      'prop_json' => { 'description' => 'prop_json description', 'type' => 'JSON' },
       'prop_long' => { 'description' => 'prop_long description', 'type' => 'integer', 'format' => 'int64' },
       'prop_password' => { 'description' => 'prop_password description', 'type' => 'string', 'format' => 'password' },
       'prop_string' => { 'description' => 'prop_string description', 'type' => 'string' },
@@ -367,11 +376,13 @@ RSpec.shared_context 'representable swagger example' do
       'definitions' => {
         'QueryInput' => {
           'type' => 'object',
+          'required' => ['elements'],
           'properties' => { 'elements' => { 'type' => 'array', 'items' => { '$ref' => '#/definitions/QueryInputElement' }, 'description' => 'Set of configuration' } },
           'description' => 'nested route inside namespace'
         },
         'QueryInputElement' => {
           'type' => 'object',
+          'required' => %w(key value),
           'properties' => { 'key' => { 'type' => 'string', 'description' => 'Name of parameter' }, 'value' => { 'type' => 'string', 'description' => 'Value of parameter' } }
         },
         'ApiError' => {
@@ -397,5 +408,5 @@ RSpec.shared_context 'representable swagger example' do
 end
 
 def mounted_paths
-  %w( /thing /other_thing /dummy )
+  %w(/thing /other_thing /dummy)
 end

data/spec/swagger_v2/api_swagger_v2_detail_spec.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-
 require 'spec_helper'
 
 def details

data/spec/swagger_v2/api_swagger_v2_param_type_body_spec.rb

@@ -54,6 +54,17 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
           end
         end
 
+        namespace :with_entity_param do
+          desc 'put in body with entity parameter'
+          params do
+            optional :data, type: ::Entities::NestedModule::ApiResponse, documentation: { desc: 'request data' }
+          end
+
+          post do
+            { 'declared_params' => declared(params) }
+          end
+        end
+
         add_swagger_documentation
       end
     end
@@ -156,4 +167,49 @@ describe 'setting of param type, such as `query`, `path`, `formData`, `body`, `h
       )
     end
   end
+
+  describe 'complex entity given' do
+    let(:request_parameters_definition) do
+      [
+        {
+          'name' => 'WithEntityParam',
+          'in' => 'body',
+          'required' => true,
+          'schema' => {
+            '$ref' => '#/definitions/postWithEntityParam'
+          }
+        }
+      ]
+    end
+
+    let(:request_body_parameters_definition) do
+      {
+        'type' => 'object',
+        'properties' => {
+          'data' => {
+            '$ref' => '#/definitions/ApiResponse',
+            'description' => 'request data'
+          }
+        },
+        'description' => 'put in body with entity parameter'
+      }
+    end
+
+    subject do
+      get '/swagger_doc/with_entity_param'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['paths']['/with_entity_param']['post']['parameters']).to eql(request_parameters_definition)
+    end
+
+    specify do
+      expect(subject['definitions']['ApiResponse']).not_to be_nil
+    end
+
+    specify do
+      expect(subject['definitions']['postWithEntityParam']).to eql(request_body_parameters_definition)
+    end
+  end
 end

data/spec/swagger_v2/api_swagger_v2_spec.rb

@@ -118,91 +118,117 @@ describe 'swagger spec v2.0' do
     end
   end
 
-  before do
-    get '/v3/swagger_doc'
-  end
+  describe 'whole documentation' do
+    subject do
+      get '/v3/swagger_doc'
+      JSON.parse(last_response.body)
+    end
 
-  let(:json) { JSON.parse(last_response.body) }
+    describe 'swagger object' do
+      describe 'required keys' do
+        it { expect(subject.keys).to include 'swagger' }
+        it { expect(subject['swagger']).to eql '2.0' }
+        it { expect(subject.keys).to include 'info' }
+        it { expect(subject['info']).to be_a Hash }
+        it { expect(subject.keys).to include 'paths' }
+        it { expect(subject['paths']).to be_a Hash }
+      end
 
-  describe 'swagger object' do
-    describe 'required keys' do
-      it { expect(json.keys).to include 'swagger' }
-      it { expect(json['swagger']).to eql '2.0' }
-      it { expect(json.keys).to include 'info' }
-      it { expect(json['info']).to be_a Hash }
-      it { expect(json.keys).to include 'paths' }
-      it { expect(json['paths']).to be_a Hash }
-    end
+      describe 'info object required keys' do
+        let(:info) { subject['info'] }
+
+        it { expect(info.keys).to include 'title' }
+        it { expect(info['title']).to be_a String }
+        it { expect(info.keys).to include 'version' }
+        it { expect(info['version']).to be_a String }
 
-    describe 'info object required keys' do
-      let(:info) { json['info'] }
+        describe 'license object' do
+          let(:license) { subject['info']['license'] }
 
-      it { expect(info.keys).to include 'title' }
-      it { expect(info['title']).to be_a String }
-      it { expect(info.keys).to include 'version' }
-      it { expect(info['version']).to be_a String }
+          it { expect(license.keys).to include 'name' }
+          it { expect(license['name']).to be_a String }
+          it { expect(license.keys).to include 'url' }
+          it { expect(license['url']).to be_a String }
+        end
 
-      describe 'license object' do
-        let(:license) { json['info']['license'] }
+        describe 'contact object' do
+          let(:contact) { subject['info']['contact'] }
 
-        it { expect(license.keys).to include 'name' }
-        it { expect(license['name']).to be_a String }
-        it { expect(license.keys).to include 'url' }
-        it { expect(license['url']).to be_a String }
-      end
+          it { expect(contact.keys).to include 'name' }
+          it { expect(contact['name']).to be_a String  }
+          it { expect(contact.keys).to include 'email' }
+          it { expect(contact['email']).to be_a String }
+          it { expect(contact.keys).to include 'url' }
+          it { expect(contact['url']).to be_a String }
+        end
 
-      describe 'contact object' do
-        let(:contact) { json['info']['contact'] }
+        describe 'global tags' do
+          let(:tags) { subject['tags'] }
 
-        it { expect(contact.keys).to include 'name' }
-        it { expect(contact['name']).to be_a String  }
-        it { expect(contact.keys).to include 'email' }
-        it { expect(contact['email']).to be_a String }
-        it { expect(contact.keys).to include 'url' }
-        it { expect(contact['url']).to be_a String }
+          it { expect(tags).to be_a Array }
+          it { expect(tags).not_to be_empty }
+        end
       end
-    end
 
-    describe 'path object' do
-      let(:paths) { json['paths'] }
+      describe 'path object' do
+        let(:paths) { subject['paths'] }
 
-      it 'hides documentation paths per default' do
-        expect(paths.keys).not_to include '/swagger_doc', '/swagger_doc/{name}'
-      end
+        it 'hides documentation paths per default' do
+          expect(paths.keys).not_to include '/swagger_doc', '/swagger_doc/{name}'
+        end
 
-      specify do
-        paths.each_pair do |path, value|
-          expect(path).to start_with('/')
-          expect(value).to be_a Hash
-          expect(value).not_to be_empty
+        specify do
+          paths.each_pair do |path, value|
+            expect(path).to start_with('/')
+            expect(value).to be_a Hash
+            expect(value).not_to be_empty
 
-          value.each do |method, declaration|
-            expect(http_verbs).to include method
-            expect(declaration).to have_key('responses')
+            value.each do |method, declaration|
+              expect(http_verbs).to include method
+              expect(declaration).to have_key('responses')
 
-            declaration['responses'].each do |status_code, response|
-              expect(status_code).to match(/\d{3}/)
-              expect(response).to have_key('description')
+              declaration['responses'].each do |status_code, response|
+                expect(status_code).to match(/\d{3}/)
+                expect(response).to have_key('description')
+              end
             end
           end
         end
       end
-    end
 
-    describe 'definitions object' do
-      let(:definitions) { json['definitions'] }
-      specify do
-        definitions.each do |model, properties|
-          expect(model).to match(/\w+/)
-          expect(properties).to have_key('properties')
+      describe 'definitions object' do
+        let(:definitions) { subject['definitions'] }
+
+        specify do
+          definitions.each do |model, properties|
+            expect(model).to match(/\w+/)
+            expect(properties).to have_key('properties')
+          end
         end
       end
     end
+
+    describe 'swagger file' do
+      it do
+        expect(subject).to eql swagger_json
+      end
+    end
   end
 
-  describe 'swagger file' do
-    it do
-      expect(json).to eql swagger_json
+  describe 'specific resource documentation' do
+    subject do
+      get '/v3/swagger_doc/other_thing'
+      JSON.parse(last_response.body)
+    end
+
+    let(:tags) { subject['tags'] }
+    specify do
+      expect(tags).to eql [
+        {
+          'name' => 'other_thing',
+          'description' => 'Operations about other_things'
+        }
+      ]
     end
   end
 end

data/spec/swagger_v2/endpoint_versioned_path_spec.rb

@@ -1,17 +1,21 @@
 require 'spec_helper'
 
 describe 'Grape::Endpoint#path_and_definitions' do
-  let(:api) do
-    item = Class.new(Grape::API) do
+  let(:item) do
+    Class.new(Grape::API) do
       version 'v1', using: :path
 
       resource :item do
         get '/'
       end
     end
+  end
+
+  let(:api) do
+    item_api = item
 
     Class.new(Grape::API) do
-      mount item
+      mount item_api
       add_swagger_documentation add_version: true
     end
   end
@@ -28,4 +32,21 @@ describe 'Grape::Endpoint#path_and_definitions' do
   it 'tags the endpoint with the resource name' do
     expect(subject.first['/v1/item'][:get][:tags]).to eq ['item']
   end
+
+  context 'when custom tags are specified' do
+    let(:item) do
+      Class.new(Grape::API) do
+        version 'v1', using: :path
+
+        resource :item do
+          desc 'Item description', tags: ['special-item']
+          get '/'
+        end
+      end
+    end
+
+    it 'tags the endpoint with the custom tags' do
+      expect(subject.first['/v1/item'][:get][:tags]).to eq ['special-item']
+    end
+  end
 end