swagger-docs 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 850e7d77a965af9ee323f25bc7ab3e3a91d370c8
-  data.tar.gz: 6b724ad6dd87abc8cab15e2b4a30055c6910e198
+  metadata.gz: 6967e0a36e6f1cc25402a43fda60f0bc05a20edc
+  data.tar.gz: 5c29130f3e23ae163f11dd6d6493f18a173da361
 SHA512:
-  metadata.gz: e155052e677d44500ce278b910766d6c0e9eae07cacd5bc9514b79af5f61a98d510dd073ce1bc86ad0be3d4bdcc5eb4e8fd8e3f2cd51b66523e40ce2c7344cac
-  data.tar.gz: 66cf934624dbf944215ddc98401dc3a6a8c3608014fb62b4de88b9500394d2deabcdd89bd668240fe9cd7f379392d6565b29de3ab2c8f3f8ee0d13547bce2c4a
+  metadata.gz: 85b1277dab91eded46667469d7bc3fd95dee21001d995f08e0c410081fea39ea84cc35d97f06aeb6bb9dd1bb0ca1fe0f0f07f6d2ac45bcd666a88f29673d1d4c
+  data.tar.gz: 3fffa2a1d4153a28db13ada078ac381cdc7b4408e00df6cfd1303c084c143e084423fa9b9c0cda485a1a22b4f34f300ff3de1e63e54d7a1504413fcf1978aa9b

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.7
+
+- Fix issue "NoMethodError: undefined method `<' for false:FalseClass" (#133) - thanks to @heaven
+
 ## 0.2.6
 
 - swagger_controller DSL can accept a resource_path which will be used over a generated path #126 @sb8244

data/README.md

@@ -12,7 +12,7 @@ Generates swagger-ui json files for rails apps with APIs. You add the swagger DS
 
 ## Swagger Version Specification Support
 
-This project supports elements of the v1.2 swagger specification. It *does not* support the v2 specification. If you are looking for support for the newer specification the please see the [swagger-blocks](https://github.com/fotinakis/swagger-blocks/) project. I don't currently have any plans to add support for v2.0 at this time.
+This project supports elements of the v1.2 swagger specification. It *does not* support the v2 specification. If you are looking for support for the newer specification the please see the [swagger-blocks](https://github.com/fotinakis/swagger-blocks/) project. I don't currently have any plans to add support for v2.0 at this time due to time constraints, but I'm open to accepting a PR on  this. Contact me if you are interested in helping with that effort - thanks!
 
 ## Example usage
 
@@ -138,7 +138,7 @@ The following table shows all the current configuration options and their defaul
 <tr>
 <td><b>parent_controller</b></td>
 <td>Assign a different controller to use for the configuration</td>
-<td>ClassName</td>
+<td></td>
 </tr>
 
 </tbody>

data/lib/swagger/docs/generator.rb

@@ -136,7 +136,7 @@ module Swagger
           klass = Config.log_exception { "#{path.to_s.camelize}Controller".constantize } rescue nil
           return {action: :skipped, path: path, reason: :klass_not_present} if !klass
           return {action: :skipped, path: path, reason: :not_swagger_resource} if !klass.methods.include?(:swagger_config) or !klass.swagger_config[:controller]
-          return {action: :skipped, path: path, reason: :not_kind_of_parent_controller} if config[:parent_controller] && !klass < config[:parent_controller]
+          return {action: :skipped, path: path, reason: :not_kind_of_parent_controller} if config[:parent_controller] && !(klass < config[:parent_controller])
           apis, models, defined_nicknames = [], {}, []
           routes.select{|i| i.defaults[:controller] == path}.each do |route|
             unless nickname_defined?(defined_nicknames, path, route) # only add once for each route once e.g. PATCH, PUT 

data/lib/swagger/docs/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   module Docs
-    VERSION = "0.2.6"
+    VERSION = "0.2.7"
   end
 end

data/spec/lib/swagger/docs/generator_spec.rb

@@ -5,6 +5,8 @@ describe Swagger::Docs::Generator do
   require "fixtures/controllers/application_controller"
   require "fixtures/controllers/ignored_controller"
 
+  class FooParentController; end
+
   before(:each) do
     FileUtils.rm_rf(tmp_dir)
     stub_const('ActionController::Base', ApplicationController)
@@ -32,6 +34,24 @@ describe Swagger::Docs::Generator do
   let(:file_resource_nested) { tmp_dir + 'nested.json' }
   let(:file_resource_custom_resource_path) { tmp_dir + 'custom_resource_path.json' }
 
+  let(:default_config) { 
+    {
+      :controller_base_path => "api/v1", 
+      :api_file_path => "#{tmp_dir}", 
+      :base_path => "http://api.no.where/",
+      :attributes => {
+        :info => {
+          "title" => "Swagger Sample App",
+          "description" => "This is a sample description.",
+          "termsOfServiceUrl" => "http://helloreverb.com/terms/",
+          "contact" => "apiteam@wordnik.com",
+          "license" => "Apache 2.0",
+          "licenseUrl" => "http://www.apache.org/licenses/LICENSE-2.0.html"
+        }
+      } 
+    }
+  }
+
   let(:controllers) { [
     "fixtures/controllers/sample_controller",
     "fixtures/controllers/nested_controller",
@@ -100,20 +120,7 @@ describe Swagger::Docs::Generator do
     end
   end
   context "with controller base path" do
-    let(:config) { Swagger::Docs::Config.register_apis({
-       DEFAULT_VER => {:controller_base_path => "api/v1", :api_file_path => "#{tmp_dir}", :base_path => "http://api.no.where/",
-       :attributes => {
-          :info => {
-            "title" => "Swagger Sample App",
-            "description" => "This is a sample description.",
-            "termsOfServiceUrl" => "http://helloreverb.com/terms/",
-            "contact" => "apiteam@wordnik.com",
-            "license" => "Apache 2.0",
-            "licenseUrl" => "http://www.apache.org/licenses/LICENSE-2.0.html"
-         }
-        } 
-      }
-    })}
+    let(:config) { Swagger::Docs::Config.register_apis({DEFAULT_VER => default_config})}
     let(:file_resource) { tmp_dir + 'sample.json' }
     let(:resource) { file_resource.read }
     let(:response) { JSON.parse(resource) }
@@ -131,6 +138,15 @@ describe Swagger::Docs::Generator do
         expect(file_resource).to_not exist
       end
     end
+    describe "#generate" do
+      it "respects parent_controller config option" do
+        new_config = default_config
+        new_config[:parent_controller] = ApplicationController
+        api_config = Swagger::Docs::Config.register_apis(DEFAULT_VER => new_config)
+        results = generate(api_config)
+        expect(results[DEFAULT_VER][:processed].count).to eq(controllers.count)
+      end
+    end
     describe "#write_docs" do
       context "no apis registered" do
         before(:each) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger-docs
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Rich Hollis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-13 00:00:00.000000000 Z
+date: 2016-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler