grape-swagger 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 80476f6e354bf1964123a1f592e8a6ca9fd38d54
-  data.tar.gz: b9c15ab8ac8cacbd87e69e187a1afd2a838ff7d7
+  metadata.gz: 5cfbc79e708b79d924566658b3638c783fb3aed7
+  data.tar.gz: 9e83444251591329c9017ffc0c2a721474f8775a
 SHA512:
-  metadata.gz: 4f6d6e3da7140010e92a6a94a716572cf2da3093bc2233c172c6a9d0caa420a4108da068d73a145ae901dd61cc2c754c22974881cab22a5959fb55439fdfaeb1
-  data.tar.gz: 04db505e755cf5fa4f72684becaa3ad2a580a1f83baf566fb8c7407f2c1b425f809d813b1151c7b286f0f4ed90e587307be53c15f3ab9ef90b579af4d5c8d803
+  metadata.gz: a69ba696f61ea547d04b345c56ecebe9219f132d8a4c4054efbec31eb72d85767952d630b91bfb9f08ab5af47941e01a90d5bb9c7b738502d4b13bfc16bb5040
+  data.tar.gz: f29dc09e59558e2a60c03bf887dfeee5ef8d4ff505d81a50dcd62c6cda8b5359b684d10b175a828982e4ac062ffe33e3190b29d23a92e720918f2e1f643a740c

data/.rubocop_todo.yml

@@ -1,32 +1,32 @@
 # This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-02-26 15:04:26 +0100 using RuboCop version 0.27.0.
+# on 2015-03-11 10:53:03 -0400 using RuboCop version 0.27.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 9
+# Offense count: 10
 Metrics/AbcSize:
   Max: 347
 
 # Offense count: 1
 # Configuration parameters: CountComments.
 Metrics/ClassLength:
-  Max: 485
+  Max: 486
 
 # Offense count: 6
 Metrics/CyclomaticComplexity:
   Max: 99
 
-# Offense count: 289
+# Offense count: 294
 # Configuration parameters: AllowURI, URISchemes.
 Metrics/LineLength:
   Max: 254
 
-# Offense count: 17
+# Offense count: 20
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 368
+  Max: 369
 
 # Offense count: 5
 Metrics/PerceivedComplexity:

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 0.10.1 (March 11, 2015)
+
+* [#227](https://github.com/tim-vandecasteele/grape-swagger/issues/227): Fix: nested routes under prefix not documented - [@dblock](https://github.com/dblock).
+* [#226](https://github.com/tim-vandecasteele/grape-swagger/issues/226): Fix: be defensive with nil exposure types - [@dblock](https://github.com/dblock).
+
 ### 0.10.0 (March 10, 2015)
 
 #### Features

data/UPGRADING.md

@@ -3,11 +3,11 @@ Upgrading Grape-swagger
 
 ### Upgrading to >= 0.9.0
 
-#### Changes in Configuration
+#### Grape-Swagger-Rails
 
 If you're using [grape-swagger-rails](https://github.com/BrandyMint/grape-swagger-rails), remove the `.json` extension from `GrapeSwaggerRails.options.url`.
 
-For example, change 
+For example, change
 
 ```ruby
 GrapeSwaggerRails.options.url = '/api/v1/swagger_doc.json'
@@ -21,6 +21,10 @@ GrapeSwaggerRails.options.url = '/api/v1/swagger_doc'
 
 See [#187](https://github.com/tim-vandecasteele/grape-swagger/issues/187) for more information.
 
+#### Grape 0.10.0
+
+If your API uses Grape 0.10.0 or newer with a single `format :json` directive, add `hide_format: true` to `add_swagger_documentation`. Otherwise nested routes will render with `.json` links to your API documentation, which will fail with a 404 Not Found.
+
 ### Upgrading to >= 0.8.0
 
 #### Changes in Configuration

data/lib/grape-swagger/version.rb

@@ -1,3 +1,3 @@
 module GrapeSwagger
-  VERSION = '0.10.0'
+  VERSION = '0.10.1'
 end

data/lib/grape-swagger.rb

@@ -68,7 +68,7 @@ module Grape
           parent_route = @combined_routes[parent_route_name]
           # fetch all routes that are within the current namespace
           namespace_routes = parent_route.collect do |route|
-            route if (route.route_path.start_with?("/#{name}") || route.route_path.start_with?("/:version/#{name}")) &&
+            route if (route.route_path.start_with?(route.route_prefix ? "/#{route.route_prefix}/#{name}" : "/#{name}") || route.route_path.start_with?((route.route_prefix ? "/#{route.route_prefix}/:version/#{name}" : "/:version/#{name}"))) &&
                      (route.instance_variable_get(:@options)[:namespace] == "/#{name}" || route.instance_variable_get(:@options)[:namespace] == "/:version/#{name}")
           end.compact
 
@@ -332,8 +332,9 @@ module Grape
 
                   type = if p[:type]
                            p.delete(:type)
-                         elsif (entity = model.exposures[property_name][:using])
-                           parse_entity_name(entity)
+                         else
+                           exposure = model.exposures[property_name]
+                           parse_entity_name(exposure[:using]) if exposure
                          end
 
                   if p.delete(:is_array)

data/spec/api_with_nil_types.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe 'API with minimally documented models' do
+  def app
+    entity_klass = Class.new do
+      def self.exposures
+        {}
+      end
+
+      def self.documentation
+        {
+          bar: { type: String },
+          foo: {}
+        }
+      end
+
+      def self.entity_name
+        'Foo'
+      end
+    end
+
+    Class.new(Grape::API) do
+      format :json
+
+      get :foo do
+      end
+
+      add_swagger_documentation \
+        format: :json,
+        models: [Class.new(entity_klass)]
+    end
+  end
+
+  subject do
+    get '/swagger_doc/foo'
+    JSON.parse(last_response.body)['models']
+  end
+
+  it 'returns model' do
+    expect(subject).to eq(
+      'Foo' => {
+        'id' => 'Foo',
+        'properties' => {
+          'bar' => { 'type' => 'string' },
+          'foo' => { '$ref' => nil }
+        }
+      }
+    )
+  end
+end

data/spec/api_with_prefix_and_namespace_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe 'API with Prefix and Namespace' do
+  def app
+    Class.new(Grape::API) do
+      format :json
+      prefix 'api'
+
+      namespace :status do
+        desc 'Retrieve status.'
+        get do
+        end
+      end
+
+      add_swagger_documentation
+    end
+  end
+
+  subject do
+    get '/api/swagger_doc'
+    expect(last_response.status).to eq 200
+    body = JSON.parse last_response.body
+    body['apis']
+  end
+
+  it 'gets array types' do
+    expect(subject).to eq([
+      { 'path' => '/status.{format}', 'description' => 'Operations about statuses' },
+      { 'path' => '/swagger_doc.{format}', 'description' => 'Operations about swagger_docs' }
+    ])
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-swagger
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - Tim Vandecasteele
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-10 00:00:00.000000000 Z
+date: 2015-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -230,7 +230,9 @@ files:
 - spec/api_models_spec.rb
 - spec/api_paths_spec.rb
 - spec/api_root_spec.rb
+- spec/api_with_nil_types.rb
 - spec/api_with_path_versioning_spec.rb
+- spec/api_with_prefix_and_namespace_spec.rb
 - spec/api_with_standalone_namespace_spec.rb
 - spec/array_params_spec.rb
 - spec/boolean_params_spec.rb
@@ -284,7 +286,9 @@ test_files:
 - spec/api_models_spec.rb
 - spec/api_paths_spec.rb
 - spec/api_root_spec.rb
+- spec/api_with_nil_types.rb
 - spec/api_with_path_versioning_spec.rb
+- spec/api_with_prefix_and_namespace_spec.rb
 - spec/api_with_standalone_namespace_spec.rb
 - spec/array_params_spec.rb
 - spec/boolean_params_spec.rb