swagger_yard-rails 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0d248d4671c0286e33c03fdcc1f76bcb5ea90f01
-  data.tar.gz: bd8680420703b96511d1c0fb1ea2105aec6d49ec
+  metadata.gz: 282e5f9bbc7d5b2c59bdfdf2240c48b70912bb6a
+  data.tar.gz: ed70441ac1bf98a36b0005bd0ace4bc622847b16
 SHA512:
-  metadata.gz: bd8c8db718238a6b20205b3aacd390e963593b40015c5c090d47bb0c921658bd1b2398bb95e7737c751481f25d10b2e6122e51c09081295e5832f445348dce25
-  data.tar.gz: 750229999539fdb1e544932d454ac6889750d5a2dd83474ab2ec80c9e149d36f0f572361f444fb80e2d8c40b2ee8585d07f5c90bfaa7bfe724ee2ccad6bd2fae
+  metadata.gz: e605ac864174175af0a3c40a57720baae8a6d710756bb0faa6281112090ade40fc7351cc8e0cd94afe96616f6c4e8b515f7e4b32aec151095fd274a52b3164b8
+  data.tar.gz: e0745dcda80f5dc9dfbe04708d139d4efa7dc9f7f036873f62f9d39425b9b5a8be50560cda6c2baa7fa3edb89dd6756889d0dd7529c10e5496779ca256e5f028

data/.ruby-version

@@ -1 +1 @@
-2.2.2
+2.2.5

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # SwaggerYard-Rails Changelog
 
+## 0.3.3 25-07-2016 ##
+
+* Descend into engine routes when searching for matches. This allows documented
+  APIs in engines to be included in the spec.
+
 ## 0.3.2 29-01-2016 ##
 
 * Use `#controller_path` instead of duplicating controller name logic

data/README.md

@@ -1,5 +1,9 @@
 # SwaggerYard::Rails
 
+[![TravisCI](https://secure.travis-ci.org/livingsocial/swagger_yard-rails.png "TravisCI")](http://travis-ci.org/livingsocial/swagger_yard-rails "Travis-CI swagger_yard-rails")
+[![Gem Version](https://badge.fury.io/rb/swagger_yard-rails.svg)](https://rubygems.org/gems/swagger_yard-rails)
+
+
 The SwaggerYard::Rails gem is a Rails Engine designed to parse your Yardocs API controllers using SwaggerYard. It'll create a Swagger-UI complaint JSON to be served out through where you mount SwaggerYard::Rails::Engine.
 
 ## Installation
@@ -111,7 +115,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/swagger_yard-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/livingsocial/swagger_yard-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
 
 ## License
 

data/lib/swagger_yard/rails/route_inspector.rb

@@ -16,15 +16,18 @@ module SwaggerYard
         def call(yard_obj)
           return nil if skip_object?(yard_obj)
 
-          info   = yard_info(yard_obj)
-          route  = find_route(info)
-          method = route.verb.source.gsub(/[$^]/, '')
+          info      = yard_info(yard_obj)
+          route_arr = find_route(info)
+          route     = route_arr.last
+          method    = route.verb.source.gsub(/[$^]/, '')
 
           raise Error, "no http method: #{info.inspect}" if method.empty?
 
-          path = route.parts.inject(route.ast.to_s) do |p,sym|
-            p.sub(sym.inspect, "{#{sym}}")
-          end
+          path = route_arr.map do |r|
+            r.parts.inject(r.ast.to_s) do |p,sym|
+              p.sub(sym.inspect, "{#{sym}}")
+            end
+          end.join
 
           # FIXME: always remove format parameter?
           path = path.sub('(.{format})', '')
@@ -59,20 +62,31 @@ module SwaggerYard
         end
 
         def find_route(info)
-          matching_routes = @routes.select do |r|
-            if info[:route]
-              r.name == info[:route]
-            else
-              r.defaults[:controller] == info[:controller] &&
-                r.defaults[:action] == info[:action]
-            end
-          end
+          matching_routes = walk_routes(info)
 
           raise Error, "too many matches: #{info.inspect}"  if matching_routes.size > 1
           raise Error, "no matching route: #{info.inspect}" if matching_routes.size < 1
 
           matching_routes.first
         end
+
+        def walk_routes(info, routes = @routes, stack = [])
+          selected_routes = []
+
+          routes.each do |r|
+            if info[:route] && r.name == info[:route]
+              selected_routes << stack + [r]
+            elsif info[:controller] && info[:action] &&
+                  r.defaults[:controller] == info[:controller] &&
+                r.defaults[:action] == info[:action]
+              selected_routes << stack + [r]
+            elsif r.app && r.app.respond_to?(:routes)
+              selected_routes += walk_routes(info, r.app.routes.set, stack + [r])
+            end
+          end
+
+          selected_routes
+        end
       end
     end
   end

data/lib/swagger_yard/rails/version.rb

@@ -1,5 +1,5 @@
 module SwaggerYard
   module Rails
-    VERSION = "0.3.2"
+    VERSION = "0.3.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_yard-rails
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Tony Pitale
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-01-29 00:00:00.000000000 Z
+date: 2016-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -185,9 +185,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Rails engine to parse and render json for Swagger UI
 test_files: []
-has_rdoc: