grape-swagger 0.9.0 → 0.10.0

data/spec/form_params_spec.rb

@@ -30,6 +30,15 @@ describe 'Form Params' do
         {}
       end
 
+      params do
+        requires :id, type: Integer, desc: 'id of item'
+        requires :name, type: String, desc: 'name of item'
+        optional :conditions, type: Symbol, desc: 'conditions of item', values: [:one, :two]
+      end
+      post '/items/:id' do
+        {}
+      end
+
       add_swagger_documentation
     end
   end
@@ -46,5 +55,11 @@ describe 'Form Params' do
     expect(subject['apis'][1]['path']).to start_with '/items/{id}'
     expect(subject['apis'][1]['operations'][0]['method']).to eq 'PUT'
     expect(subject['apis'][1]['operations'][1]['method']).to eq 'PATCH'
+    expect(subject['apis'][1]['operations'][2]['method']).to eq 'POST'
+  end
+
+  it 'treats Symbol parameter as form param' do
+    expect(subject['apis'][1]['operations'][2]['parameters'][2]['paramType']).to eq 'form'
+    expect(subject['apis'][1]['operations'][2]['parameters'][2]['type']).to eq 'string'
   end
 end

data/spec/grape-swagger_helper_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe 'helpers' do
-
   before :all do
     class HelperTestAPI < Grape::API
     end
@@ -59,7 +58,25 @@ describe 'helpers' do
           allowMultiple: false
         }
       ]
+    end
 
+    it 'parses symbol param as string' do
+      params = {
+        animal: { type: 'Symbol', desc: 'An animal you like', required: true, values: [:cat, :dog] }
+      }
+      path = '/coolness'
+      method = 'POST'
+      expect(subject.parse_params(params, path, method)).to eq [
+        {
+          paramType: 'form',
+          name: :animal,
+          description: 'An animal you like',
+          type: 'string',
+          required: true,
+          allowMultiple: false,
+          enum: [:cat, :dog]
+        }
+      ]
     end
 
     context 'custom type' do
@@ -78,7 +95,6 @@ describe 'helpers' do
         ]
       end
     end
-
   end
 
   context 'parsing the path' do
@@ -120,5 +136,4 @@ describe 'helpers' do
       ]
     end
   end
-
 end

data/spec/hide_api_spec.rb

@@ -14,6 +14,13 @@ describe 'a hide mounted api' do
       get '/hide' do
         { foo: 'bar' }
       end
+
+      desc 'Lazily show endpoint',
+           hidden: -> { false }
+
+      get '/lazy' do
+        { foo: 'bar' }
+      end
     end
 
     class HideApi < Grape::API
@@ -39,6 +46,7 @@ describe 'a hide mounted api' do
       'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
       'apis' => [
         { 'path' => '/simple.{format}', 'description' => 'Operations about simples' },
+        { 'path' => '/lazy.{format}', 'description' => 'Operations about lazies' },
         { 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }
       ]
     )
@@ -59,6 +67,13 @@ describe 'a hide mounted api with same namespace' do
       get '/simple/hide' do
         { foo: 'bar' }
       end
+
+      desc 'Lazily hide endpoint',
+           hidden: -> { true }
+
+      get '/simple/lazy' do
+        { foo: 'bar' }
+      end
     end
 
     class HideNamespaceApi < Grape::API

data/spec/markdown/kramdown_adapter_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe GrapeSwagger::Markdown::KramdownAdapter do
-
   context 'initialization' do
     it 'uses GFM as default input and disable coderay' do
       adapter = GrapeSwagger::Markdown::KramdownAdapter.new

data/spec/markdown/redcarpet_adapter_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
 
 describe GrapeSwagger::Markdown::RedcarpetAdapter, unless: RUBY_PLATFORM.eql?('java') do
-
   context 'initialization' do
     context 'initialization' do
       it 'uses fenced_code_blocks, auto_links and rouge as default.' do

data/spec/mutually_exclusive_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe 'Mutually exclusive group params' do
+  def app
+    Class.new(Grape::API) do
+      format :json
+
+      params do
+        requires :required_group, type: Hash do
+          group :param_group_1, type: Hash do
+            requires :param_1, type: String
+          end
+          optional :param_group_2, type: Array do
+            requires :param_2, type: String
+          end
+          mutually_exclusive :param_group_1, :param_group_2
+        end
+      end
+      post '/groups' do
+        {}
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  it 'marks the nested required params in a group as optional if the group is in a mutually_exclusive set' do
+    get '/swagger_doc/groups'
+
+    body = JSON.parse last_response.body
+    parameters = body['apis'].first['operations'].first['parameters']
+    expect(parameters).to eq [
+      { 'paramType' => 'form', 'name' => 'required_group[param_group_1][param_1]', 'description' => nil, 'type' => 'string', 'required' => false, 'allowMultiple' => false },
+      { 'paramType' => 'form', 'name' => 'required_group[param_group_2][][param_2]', 'description' => nil, 'type' => 'string', 'required' => true, 'allowMultiple' => false }]
+  end
+end

data/spec/non_default_api_spec.rb

@@ -3,7 +3,6 @@ require 'spec_helper'
 describe 'options: ' do
   context 'overriding the basepath' do
     before :all do
-
       class BasePathMountedApi < Grape::API
         desc 'This gets something.'
         get '/something' do
@@ -17,7 +16,6 @@ describe 'options: ' do
         mount BasePathMountedApi
         add_swagger_documentation base_path: NON_DEFAULT_BASE_PATH
       end
-
     end
 
     def app
@@ -254,7 +252,6 @@ describe 'options: ' do
         mount HideDocumentationPathPrefixedMountedApi
         add_swagger_documentation hide_documentation_path: true
       end
-
     end
 
     def app
@@ -286,7 +283,6 @@ describe 'options: ' do
         }]
       )
     end
-
   end
 
   context 'overriding hiding the documentation paths in prefixed and versioned API' do
@@ -338,7 +334,6 @@ describe 'options: ' do
         }]
       )
     end
-
   end
 
   context 'overriding the mount-path' do

data/spec/range_values_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe 'Range Params' do
+  def app
+    Class.new(Grape::API) do
+      format :json
+
+      params do
+        requires :letter, type: String, values: 'a'..'z'
+      end
+      post :letter do
+      end
+
+      params do
+        requires :number, type: Integer, values: -5..5
+      end
+      post :integer do
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  subject(:letter) do
+    get '/swagger_doc/letter'
+    expect(last_response.status).to eq 200
+    body = JSON.parse last_response.body
+    body['apis'].first['operations'].first['parameters']
+  end
+
+  it 'has letter range values' do
+    expect(letter).to eq [
+      { 'paramType' => 'form', 'name' => 'letter', 'description' => nil, 'type' => 'string', 'required' => true, 'allowMultiple' => false, 'enum' => ('a'..'z').to_a }
+    ]
+  end
+
+  subject(:number) do
+    get '/swagger_doc/integer'
+    expect(last_response.status).to eq 200
+    body = JSON.parse last_response.body
+    body['apis'].first['operations'].first['parameters']
+  end
+
+  it 'has number range values' do
+    expect(number).to eq [
+      { 'paramType' => 'form', 'name' => 'number', 'description' => nil, 'type' => 'integer', 'required' => true, 'allowMultiple' => false, 'format' => 'int32', 'enum' => (-5..5).to_a }
+    ]
+  end
+end

data/spec/response_model_spec.rb

@@ -11,6 +11,9 @@ describe 'responseModel' do
         class Something < Grape::Entity
           expose :text, documentation: { type: 'string', desc: 'Content of something.' }
           expose :kind, using: Kind, documentation: { type: 'MyAPI::Kind', desc: 'The kind of this something.' }
+          expose :kind2, using: Kind, documentation: { desc: 'Secondary kind.' }
+          expose :kind3, using: 'MyAPI::Entities::Kind', documentation: { desc: 'Tertiary kind.' }
+          expose :tags, using: 'MyAPI::Entities::Tag', documentation: { desc: 'Tags.', is_array: true }
           expose :relation, using: 'MyAPI::Entities::Relation', documentation: { type: 'MyAPI::Relation', desc: 'A related model.' }
         end
 
@@ -18,6 +21,10 @@ describe 'responseModel' do
           expose :name, documentation: { type: 'string', desc: 'Name' }
         end
 
+        class Tag < Grape::Entity
+          expose :name, documentation: { type: 'string', desc: 'Name' }
+        end
+
         class Error < Grape::Entity
           expose :code, documentation: { type: 'string', desc: 'Error code' }
           expose :message, documentation: { type: 'string', desc: 'Error message' }
@@ -88,6 +95,9 @@ describe 'responseModel' do
       'properties' => {
         'text' => { 'type' => 'string', 'description' => 'Content of something.' },
         'kind' => { '$ref' => 'MyAPI::Kind', 'description' => 'The kind of this something.' },
+        'kind2' => { '$ref' => 'MyAPI::Kind', 'description' => 'Secondary kind.' },
+        'kind3' => { '$ref' => 'MyAPI::Kind', 'description' => 'Tertiary kind.' },
+        'tags' => { 'items' => { '$ref' => 'MyAPI::Tag' }, 'type' => 'array', 'description' => 'Tags.' },
         'relation' => { '$ref' => 'MyAPI::Relation', 'description' => 'A related model.' }
       }
     )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-19 00:00:00.000000000 Z
+date: 2015-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -230,8 +230,12 @@ files:
 - spec/api_models_spec.rb
 - spec/api_paths_spec.rb
 - spec/api_root_spec.rb
+- spec/api_with_path_versioning_spec.rb
+- spec/api_with_standalone_namespace_spec.rb
+- spec/array_params_spec.rb
 - spec/boolean_params_spec.rb
 - spec/default_api_spec.rb
+- spec/float_api_spec.rb
 - spec/form_params_spec.rb
 - spec/grape-swagger_helper_spec.rb
 - spec/grape-swagger_spec.rb
@@ -241,8 +245,10 @@ files:
 - spec/markdown/kramdown_adapter_spec.rb
 - spec/markdown/markdown_spec.rb
 - spec/markdown/redcarpet_adapter_spec.rb
+- spec/mutually_exclusive_spec.rb
 - spec/namespaced_api_spec.rb
 - spec/non_default_api_spec.rb
+- spec/range_values_spec.rb
 - spec/response_model_spec.rb
 - spec/simple_mounted_api_spec.rb
 - spec/spec_helper.rb
@@ -278,8 +284,12 @@ test_files:
 - spec/api_models_spec.rb
 - spec/api_paths_spec.rb
 - spec/api_root_spec.rb
+- spec/api_with_path_versioning_spec.rb
+- spec/api_with_standalone_namespace_spec.rb
+- spec/array_params_spec.rb
 - spec/boolean_params_spec.rb
 - spec/default_api_spec.rb
+- spec/float_api_spec.rb
 - spec/form_params_spec.rb
 - spec/grape-swagger_helper_spec.rb
 - spec/grape-swagger_spec.rb
@@ -289,8 +299,10 @@ test_files:
 - spec/markdown/kramdown_adapter_spec.rb
 - spec/markdown/markdown_spec.rb
 - spec/markdown/redcarpet_adapter_spec.rb
+- spec/mutually_exclusive_spec.rb
 - spec/namespaced_api_spec.rb
 - spec/non_default_api_spec.rb
+- spec/range_values_spec.rb
 - spec/response_model_spec.rb
 - spec/simple_mounted_api_spec.rb
 - spec/spec_helper.rb