grape-swagger 0.8.0 → 0.9.0

data/spec/hash_params_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe 'Hash Params' do
+  def app
+    Class.new(Grape::API) do
+      format :json
+
+      params do
+        requires :a_hash, type: Hash
+      end
+      post :splines do
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  subject do
+    get '/swagger_doc/splines'
+    expect(last_response.status).to eq 200
+    body = JSON.parse last_response.body
+    body['apis'].first['operations'].first['parameters']
+  end
+
+  it 'declares hash types as object' do
+    expect(subject).to eq [
+      { 'paramType' => 'form', 'name' => 'a_hash', 'description' => nil, 'type' => 'object', 'required' => true, 'allowMultiple' => false }
+    ]
+  end
+end

data/spec/hide_api_spec.rb

@@ -36,7 +36,7 @@ describe 'a hide mounted api' do
       'apiVersion' => '0.1',
       'swaggerVersion' => '1.2',
       'info' => {},
-      'produces' => ['application/xml', 'application/json', 'application/vnd.api+json', 'text/plain'],
+      'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
       'apis' => [
         { 'path' => '/simple.{format}', 'description' => 'Operations about simples' },
         { 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }
@@ -77,7 +77,7 @@ describe 'a hide mounted api with same namespace' do
       'apiVersion' => '0.1',
       'swaggerVersion' => '1.2',
       'info' => {},
-      'produces' => ['application/xml', 'application/json', 'application/vnd.api+json', 'text/plain'],
+      'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
       'apis' => [
         { 'path' => '/simple.{format}', 'description' => 'Operations about simples' },
         { 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }
@@ -92,7 +92,7 @@ describe 'a hide mounted api with same namespace' do
       'swaggerVersion' => '1.2',
       'basePath' => 'http://example.org',
       'resourcePath' => '/simple',
-      'produces' => ['application/xml', 'application/json', 'application/vnd.api+json', 'text/plain'],
+      'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
       'apis' => [{
         'path' => '/simple/show.{format}',
         'operations' => [{

data/spec/non_default_api_spec.rb

@@ -50,7 +50,7 @@ describe 'options: ' do
 
       class SimpleApiWithProcBasePath < Grape::API
         mount ProcBasePathMountedApi
-        add_swagger_documentation base_path: proc { |request| "#{request.base_url}/some_value" }
+        add_swagger_documentation base_path: proc { |request| [request.base_url, request.params[:base_path], 'some_value'].compact.join('/') }
       end
     end
 
@@ -58,18 +58,26 @@ describe 'options: ' do
       SimpleApiWithProcBasePath
     end
 
-    subject do
-      get '/swagger_doc/something.json'
-      JSON.parse(last_response.body)
+    context 'default' do
+      subject do
+        get '/swagger_doc/something.json'
+        JSON.parse(last_response.body)
+      end
+
+      it 'retrieves the same given base-path for mounted-api' do
+        expect(subject['basePath']).to eq 'http://example.org/some_value'
+      end
     end
 
-    # it "retrieves the given base-path on /swagger_doc" do
-    #   get '/swagger_doc.json'
-    #   JSON.parse(last_response.body)["basePath"].should == "http://example.org/some_value"
-    # end
+    context 'param' do
+      subject do
+        get '/swagger_doc/something.json?base_path=foobar'
+        JSON.parse(last_response.body)
+      end
 
-    it 'retrieves the same given base-path for mounted-api' do
-      expect(subject['basePath']).to eq 'http://example.org/some_value'
+      it 're-evaluates base-path' do
+        expect(subject['basePath']).to eq 'http://example.org/foobar/some_value'
+      end
     end
   end
 
@@ -97,11 +105,6 @@ describe 'options: ' do
       JSON.parse(last_response.body)
     end
 
-    # it "retrieves the given base-path on /swagger_doc" do
-    #   get '/swagger_doc.json'
-    #   JSON.parse(last_response.body)["basePath"].should == "http://example.org/some_value"
-    # end
-
     it 'retrieves the same given base-path for mounted-api' do
       get '/swagger_doc/something.json'
       expect(subject['basePath']).to eq 'http://example.org/some_value'
@@ -168,7 +171,7 @@ describe 'options: ' do
         'apiVersion' => '0.1',
         'swaggerVersion' => '1.2',
         'info' => {},
-        'produces' => ['application/xml', 'application/json', 'application/vnd.api+json', 'text/plain'],
+        'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
         'apis' => [
           { 'path' => '/something.{format}', 'description' => 'Operations about somethings' },
           { 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }
@@ -184,7 +187,7 @@ describe 'options: ' do
         'swaggerVersion' => '1.2',
         'basePath' => 'http://example.org',
         'resourcePath' => '/something',
-        'produces' => ['application/xml', 'application/json', 'application/vnd.api+json', 'text/plain'],
+        'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
         'apis' => [{
           'path' => '/0.1/something.{format}',
           'operations' => [{
@@ -229,7 +232,7 @@ describe 'options: ' do
         'apiVersion' => '0.1',
         'swaggerVersion' => '1.2',
         'info' => {},
-        'produces' => ['application/xml', 'application/json', 'application/vnd.api+json', 'text/plain'],
+        'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
         'apis' => [
           { 'path' => '/something.{format}', 'description' => 'Operations about somethings' }
         ]
@@ -269,7 +272,7 @@ describe 'options: ' do
         'swaggerVersion' => '1.2',
         'basePath' => 'http://example.org',
         'resourcePath' => '/something',
-        'produces' => ['application/xml', 'application/json', 'application/vnd.api+json', 'text/plain'],
+        'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
         'apis' => [{
           'path' => '/abc/something.{format}',
           'operations' => [{
@@ -320,7 +323,7 @@ describe 'options: ' do
         'swaggerVersion' => '1.2',
         'basePath' => 'http://example.org',
         'resourcePath' => '/something',
-        'produces' => ['application/xml', 'application/json', 'application/vnd.api+json', 'text/plain'],
+        'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
         'apis' => [{
           'path' => '/abc/v20/something.{format}',
           'operations' => [{
@@ -561,7 +564,7 @@ describe 'options: ' do
         'apiVersion' => '0.1',
         'swaggerVersion' => '1.2',
         'info' => {},
-        'produces' => ['application/xml', 'application/json', 'application/vnd.api+json', 'text/plain'],
+        'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
         'apis' => [
           { 'path' => '/first.{format}', 'description' => 'Operations about firsts' }
         ]
@@ -574,7 +577,7 @@ describe 'options: ' do
         'apiVersion' => '0.1',
         'swaggerVersion' => '1.2',
         'info' => {},
-        'produces' => ['application/xml', 'application/json', 'application/vnd.api+json', 'text/plain'],
+        'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
         'apis' => [
           { 'path' => '/second.{format}', 'description' => 'Operations about seconds' }
         ]

data/spec/response_model_spec.rb

@@ -4,17 +4,21 @@ describe 'responseModel' do
   before :all do
     module MyAPI
       module Entities
-        class BaseEntity < Grape::Entity
-          def self.entity_name
-            name.sub(/^MyAPI::Entities::/, '')
-          end
+        class Kind < Grape::Entity
+          expose :title, documentation: { type: 'string', desc: 'Title of the kind.' }
         end
 
-        class Something < BaseEntity
+        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 :relation, using: 'MyAPI::Entities::Relation', documentation: { type: 'MyAPI::Relation', desc: 'A related model.' }
+        end
+
+        class Relation < Grape::Entity
+          expose :name, documentation: { type: 'string', desc: 'Name' }
         end
 
-        class Error < BaseEntity
+        class Error < Grape::Entity
           expose :code, documentation: { type: 'string', desc: 'Error code' }
           expose :message, documentation: { type: 'string', desc: 'Error message' }
         end
@@ -59,22 +63,49 @@ describe 'responseModel' do
         {
           'code' => 200,
           'message' => 'OK',
-          'responseModel' => 'Something'
+          'responseModel' => 'MyAPI::Something'
         },
         {
           'code' => 403,
           'message' => 'Refused to return something',
-          'responseModel' => 'Error'
+          'responseModel' => 'MyAPI::Error'
         }
       ]
     )
-    expect(subject['models'].keys).to include 'Error'
-    expect(subject['models']['Error']).to eq(
-      'id' => 'Error',
+
+    expect(subject['models'].keys).to include 'MyAPI::Error'
+    expect(subject['models']['MyAPI::Error']).to eq(
+      'id' => 'MyAPI::Error',
       'properties' => {
         'code' => { 'type' => 'string', 'description' => 'Error code' },
         'message' => { 'type' => 'string', 'description' => 'Error message' }
       }
     )
+
+    expect(subject['models'].keys).to include 'MyAPI::Something'
+    expect(subject['models']['MyAPI::Something']).to eq(
+      'id' => 'MyAPI::Something',
+      'properties' => {
+        'text' => { 'type' => 'string', 'description' => 'Content of something.' },
+        'kind' => { '$ref' => 'MyAPI::Kind', 'description' => 'The kind of this something.' },
+        'relation' => { '$ref' => 'MyAPI::Relation', 'description' => 'A related model.' }
+      }
+    )
+
+    expect(subject['models'].keys).to include 'MyAPI::Kind'
+    expect(subject['models']['MyAPI::Kind']).to eq(
+      'id' => 'MyAPI::Kind',
+      'properties' => {
+        'title' => { 'type' => 'string', 'description' => 'Title of the kind.' }
+      }
+    )
+
+    expect(subject['models'].keys).to include 'MyAPI::Relation'
+    expect(subject['models']['MyAPI::Relation']).to eq(
+      'id' => 'MyAPI::Relation',
+      'properties' => {
+        'name' => { 'type' => 'string', 'description' => 'Name' }
+      }
+    )
   end
 end

data/spec/simple_mounted_api_spec.rb

@@ -72,7 +72,7 @@ describe 'a simple mounted api' do
       'apiVersion' => '0.1',
       'swaggerVersion' => '1.2',
       'info' => {},
-      'produces' => ['application/xml', 'application/json', 'application/vnd.api+json', 'text/plain'],
+      'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
       'apis' => [
         { 'path' => '/simple.{format}', 'description' => 'Operations about simples' },
         { 'path' => '/simple-test.{format}', 'description' => 'Operations about simple-tests' },
@@ -91,7 +91,7 @@ describe 'a simple mounted api' do
       'swaggerVersion' => '1.2',
       'basePath' => 'http://example.org',
       'resourcePath' => '/simple',
-      'produces' => ['application/xml', 'application/json', 'application/vnd.api+json', 'text/plain'],
+      'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
       'apis' => [{
         'path' => '/simple.{format}',
         'operations' => [{
@@ -114,7 +114,7 @@ describe 'a simple mounted api' do
         'swaggerVersion' => '1.2',
         'basePath' => 'http://example.org',
         'resourcePath' => '/simple-test',
-        'produces' => ['application/xml', 'application/json', 'application/vnd.api+json', 'text/plain'],
+        'produces' => Grape::ContentTypes::CONTENT_TYPES.values.uniq,
         'apis' => [{
           'path' => '/simple-test.{format}',
           'operations' => [{

data/spec/spec_helper.rb

@@ -20,4 +20,5 @@ RSpec.configure do |config|
   config.include RSpec::Matchers
   config.mock_with :rspec
   config.include Rack::Test::Methods
+  config.raise_errors_for_deprecations!
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-31 00:00:00.000000000 Z
+date: 2014-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: grape-entity
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.1
+        version: 0.27.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.1
+        version: 0.27.0
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
@@ -203,6 +203,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
@@ -214,6 +215,9 @@ files:
 - RELEASING.md
 - Rakefile
 - UPGRADING.md
+- example/api.rb
+- example/config.ru
+- example/splines.png
 - grape-swagger.gemspec
 - lib/grape-swagger.rb
 - lib/grape-swagger/errors.rb
@@ -224,10 +228,15 @@ files:
 - spec/api_description_spec.rb
 - spec/api_global_models_spec.rb
 - spec/api_models_spec.rb
+- spec/api_paths_spec.rb
+- spec/api_root_spec.rb
+- spec/boolean_params_spec.rb
 - spec/default_api_spec.rb
 - spec/form_params_spec.rb
 - spec/grape-swagger_helper_spec.rb
 - spec/grape-swagger_spec.rb
+- spec/group_params_spec.rb
+- spec/hash_params_spec.rb
 - spec/hide_api_spec.rb
 - spec/markdown/kramdown_adapter_spec.rb
 - spec/markdown/markdown_spec.rb
@@ -238,9 +247,6 @@ files:
 - spec/simple_mounted_api_spec.rb
 - spec/spec_helper.rb
 - spec/version_spec.rb
-- test/api.rb
-- test/config.ru
-- test/splines.png
 homepage: https://github.com/tim-vandecasteele/grape-swagger
 licenses:
 - MIT
@@ -270,10 +276,15 @@ test_files:
 - spec/api_description_spec.rb
 - spec/api_global_models_spec.rb
 - spec/api_models_spec.rb
+- spec/api_paths_spec.rb
+- spec/api_root_spec.rb
+- spec/boolean_params_spec.rb
 - spec/default_api_spec.rb
 - spec/form_params_spec.rb
 - spec/grape-swagger_helper_spec.rb
 - spec/grape-swagger_spec.rb
+- spec/group_params_spec.rb
+- spec/hash_params_spec.rb
 - spec/hide_api_spec.rb
 - spec/markdown/kramdown_adapter_spec.rb
 - spec/markdown/markdown_spec.rb
@@ -284,6 +295,3 @@ test_files:
 - spec/simple_mounted_api_spec.rb
 - spec/spec_helper.rb
 - spec/version_spec.rb
-- test/api.rb
-- test/config.ru
-- test/splines.png