grape-swagger 0.24.0 → 0.25.0

data/spec/swagger_v2/guarded_endpoint_spec.rb

@@ -21,6 +21,10 @@ class SampleAuth < Grape::Middleware::Base
     def access_token=(token)
       @_access_token = token
     end
+
+    def resource_owner
+      @resource_owner = true if access_token == '12345'
+    end
   end
 
   def context
@@ -50,9 +54,9 @@ end
 describe 'a guarded api endpoint' do
   before :all do
     class GuardedMountedApi < Grape::API
-      access_token_valid = proc { |token = nil| token.nil? || token != '12345' }
+      resource_owner_valid = proc { |token_owner = nil| token_owner.nil? }
 
-      desc 'Show endpoint if authenticated', hidden: access_token_valid
+      desc 'Show endpoint if authenticated', hidden: resource_owner_valid
       get '/auth' do
         { foo: 'bar' }
       end
@@ -62,7 +66,7 @@ describe 'a guarded api endpoint' do
       mount GuardedMountedApi
       add_swagger_documentation endpoint_auth_wrapper: SampleAuth,
                                 swagger_endpoint_guard: 'sample_auth false',
-                                oauth_token: 'access_token'
+                                token_owner: 'resource_owner'
     end
   end
 
@@ -82,6 +86,7 @@ describe 'a guarded api endpoint' do
         'swagger' => '2.0',
         'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
         'host' => 'example.org',
+        'tags' => [{ 'name' => 'auth', 'description' => 'Operations about auths' }],
         'paths' => {
           '/auth' => {
             'get' => {

data/spec/swagger_v2/namespace_tags_prefix_spec.rb

@@ -55,10 +55,7 @@ describe 'namespace tags check while using prefix and version' do
     specify do
       expect(subject['tags']).to eql(
         [
-          { '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' => 'colorado', 'description' => 'Operations about colorados' }
         ]
       )
 
@@ -75,10 +72,7 @@ describe 'namespace tags check while using prefix and version' do
       specify do
         expect(subject['tags']).to eql(
           [
-            { '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' => 'thames', 'description' => 'Operations about thames' }
           ]
         )
 

data/spec/swagger_v2/namespace_tags_spec.rb

@@ -48,10 +48,7 @@ describe 'namespace tags check' do
     specify do
       expect(subject['tags']).to eql(
         [
-          { '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' => 'colorado', 'description' => 'Operations about colorados' }
         ]
       )
 
@@ -68,10 +65,7 @@ describe 'namespace tags check' do
       specify do
         expect(subject['tags']).to eql(
           [
-            { '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' => 'thames', 'description' => 'Operations about thames' }
           ]
         )
 

data/spec/swagger_v2/params_array_spec.rb

@@ -1,6 +1,8 @@
 require 'spec_helper'
 
 describe 'Group Params as Array' do
+  include_context "#{MODEL_PARSER} swagger example"
+
   def app
     Class.new(Grape::API) do
       format :json
@@ -57,6 +59,14 @@ describe 'Group Params as Array' do
         { 'declared_params' => declared(params) }
       end
 
+      params do
+        requires :array_of_entities, type: Array[Entities::ApiError]
+      end
+
+      post '/array_of_entities' do
+        { 'declared_params' => declared(params) }
+      end
+
       add_swagger_documentation
     end
   end
@@ -156,4 +166,30 @@ describe 'Group Params as Array' do
       )
     end
   end
+
+  describe 'documentation for entity array parameters' do
+    let(:parameters) do
+      [
+        {
+          'in' => 'formData',
+          'name' => 'array_of_entities',
+          'type' => 'array',
+          'items' => {
+            '$ref' => '#/definitions/ApiError'
+          },
+          'required' => true
+        }
+      ]
+    end
+
+    subject do
+      get '/swagger_doc/array_of_entities'
+      JSON.parse(last_response.body)
+    end
+
+    specify do
+      expect(subject['definitions']['ApiError']).not_to be_blank
+      expect(subject['paths']['/array_of_entities']['post']['parameters']).to eql(parameters)
+    end
+  end
 end

data/spec/swagger_v2/simple_mounted_api_spec.rb

@@ -193,13 +193,7 @@ describe 'a simple mounted api' do
         'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
         'host' => 'example.org',
         'tags' => [
-          { 'name' => 'simple', 'description' => 'Operations about simples' },
-          { 'name' => 'simple-test', 'description' => 'Operations about simple-tests' },
-          { 'name' => 'simple-head-test', 'description' => 'Operations about simple-head-tests' },
-          { 'name' => 'simple-options-test', 'description' => 'Operations about simple-options-tests' },
-          { 'name' => 'simple_with_headers', 'description' => 'Operations about simple_with_headers' },
-          { 'name' => 'items', 'description' => 'Operations about items' },
-          { 'name' => 'custom', 'description' => 'Operations about customs' }
+          { 'name' => 'simple', 'description' => 'Operations about simples' }
         ],
         'paths' => {
           '/simple' => {
@@ -231,13 +225,7 @@ describe 'a simple mounted api' do
           'produces' => ['application/xml', 'application/json', 'application/octet-stream', 'text/plain'],
           'host' => 'example.org',
           'tags' => [
-            { 'name' => 'simple', 'description' => 'Operations about simples' },
-            { 'name' => 'simple-test', 'description' => 'Operations about simple-tests' },
-            { 'name' => 'simple-head-test', 'description' => 'Operations about simple-head-tests' },
-            { 'name' => 'simple-options-test', 'description' => 'Operations about simple-options-tests' },
-            { 'name' => 'simple_with_headers', 'description' => 'Operations about simple_with_headers' },
-            { 'name' => 'items', 'description' => 'Operations about items' },
-            { 'name' => 'custom', 'description' => 'Operations about customs' }
+            { 'name' => 'simple-test', 'description' => 'Operations about simple-tests' }
           ],
           'paths' => {
             '/simple-test' => {

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.25.0
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-23 00:00:00.000000000 Z
+date: 2016-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -126,16 +126,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: '0.40'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.40.0
+        version: '0.40'
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
@@ -238,6 +238,7 @@ files:
 - grape-swagger.gemspec
 - lib/grape-swagger.rb
 - lib/grape-swagger/doc_methods.rb
+- 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/headers.rb
@@ -258,6 +259,7 @@ files:
 - lib/grape-swagger/rake/oapi_tasks.rb
 - lib/grape-swagger/version.rb
 - spec/issues/403_versions_spec.rb
+- spec/issues/427_entity_as_string_spec.rb
 - spec/issues/430_entity_definitions_spec.rb
 - spec/lib/data_type_spec.rb
 - spec/lib/endpoint_spec.rb
@@ -346,13 +348,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.7
 signing_key: 
 specification_version: 4
-summary: A simple way to add auto generated documentation to your Grape API that can
-  be displayed with Swagger.
+summary: Add auto generated documentation to your Grape API that can be displayed
+  with Swagger.
 test_files:
 - spec/issues/403_versions_spec.rb
+- spec/issues/427_entity_as_string_spec.rb
 - spec/issues/430_entity_definitions_spec.rb
 - spec/lib/data_type_spec.rb
 - spec/lib/endpoint_spec.rb