swagger-docs 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fae3be7ad414552f11679fa9038c9bdadc8e313a
-  data.tar.gz: d669dca205c935dcd57af4b405fe5e777cd014ff
+  metadata.gz: 3eb51612948dcffe393a0fee74c1f79dcfb64ae9
+  data.tar.gz: ccaa3a9f4e00a1b022b1c71eb9431fba6675efee
 SHA512:
-  metadata.gz: 0c6cc1f82349ef06372e0443312f7abd7e154942b35631f4176b450e841d3b83c905e396d665d22c7874aa244c8dd5b1422b9451e8f2c6de84a9a04243b05b9c
-  data.tar.gz: fd41c0368dc912c349bcf58ab3e286b6b3506a4295afcb5fda9e8452e13851cf048ad8ddd28b489dcdf20ca47645a3dd673f2edfc116b167c465e97300e42cf8
+  metadata.gz: 191427fd69bff4114b6a55a844430e373f7505eab2d0a63781c027fd468691b6f19fe36fb2fea1107a585b1e6acfc6152e2934a4ff96e5f022a0e944c7b822a8
+  data.tar.gz: 1fe19613a6cc7d7a7cf70cb1c1b2ee85d92bb9fc9a9aecb34d6b8c33b6d49180a9aceea273ff021b5f1d23f36cd1705d5d0b7d132bdc9081146ca10454b3dd9f

data/lib/swagger/docs/dsl.rb

@@ -97,4 +97,4 @@ module Swagger
       end
     end
   end
-end
+end

data/lib/swagger/docs/generator.rb

@@ -17,34 +17,53 @@ module Swagger
         end
 
         def write_docs(apis = nil)
+          results = generate_docs(apis)
+          results.each{|api_version, result| write_doc(result) }
+        end
+
+        def write_doc(result)
+          settings = result[:settings]
+          config = result[:config]
+          create_output_paths(settings[:api_file_path])
+          clean_output_paths(settings[:api_file_path]) if config[:clean_directory] || false
+          root = result[:root]
+          resources = root.delete 'resources'
+          write_to_file("#{settings[:api_file_path]}/api-docs.json", root, config)
+          resources.each do |resource|
+            resource_file_path = resource.delete 'resourceFilePath'
+            write_to_file(File.join(settings[:api_file_path], "#{resource_file_path}.json"), resource, config)
+          end
+          result
+        end
+
+        def generate_docs(apis=nil)
           apis ||= Config.registered_apis
           results = {}
           set_real_methods
-          unless apis.empty?
-            apis.each do |api_version,config|
-              config.reverse_merge!(DEFAULT_CONFIG)
-              results[api_version] = write_doc(api_version, config)
-            end
-          else
-            results[DEFAULT_VER] = write_doc(DEFAULT_VER, DEFAULT_CONFIG)
+
+          apis[DEFAULT_VER] = DEFAULT_CONFIG if apis.empty?
+
+          apis.each do |api_version, config|
+            settings = get_settings(api_version, config)
+            config.reverse_merge!(DEFAULT_CONFIG)
+            results[api_version] = generate_doc(api_version, settings, config)
+            results[api_version][:settings] = settings
+            results[api_version][:config] = config
           end
           results
         end
 
-        def write_doc(api_version, config)
-          settings = get_settings(api_version, config)
-
-          create_output_paths(settings[:api_file_path])
-          clean_output_paths(settings[:api_file_path]) if config[:clean_directory] || false
-
+        def generate_doc(api_version, settings, config)
           root = { :api_version => api_version, :swagger_version => "1.2", :base_path => settings[:base_path] + "/", :apis => []}
           results = {:processed => [], :skipped => []}
+          resources = []
 
           get_route_paths(settings[:controller_base_path]).each do |path|
             ret = process_path(path, root, config, settings)
             results[ret[:action]] << ret
             if ret[:action] == :processed
-              create_resource_file(ret[:path], ret[:apis], ret[:models], settings, root, config)
+              resource = generate_resource(ret[:path], ret[:apis], ret[:models], settings, root, config)
+              resources << resource
               debased_path = get_debased_path(ret[:path], settings[:controller_base_path])
               resource_api = {
                 path: "#{Config.transform_path(trim_leading_slash(debased_path))}.{format}",
@@ -53,9 +72,9 @@ module Swagger
               root[:apis] << resource_api
             end
           end
-
+          root[:resources] = resources
           camelize_keys_deep!(root)
-          write_to_file("#{settings[:api_file_path]}/api-docs.json", root, config)
+          results[:root] = root
           results
         end
 
@@ -115,7 +134,7 @@ module Swagger
           {action: :processed, path: path, apis: apis, models: models, klass: klass}
         end
 
-        def create_resource_file(path, apis, models, settings, root, config)
+        def generate_resource(path, apis, models, settings, root, config)
           debased_path = get_debased_path(path, settings[:controller_base_path])
           demod = "#{debased_path.to_s.camelize}".demodulize.camelize.underscore
           resource_path = trim_leading_slash(debased_path.to_s.underscore)
@@ -123,24 +142,24 @@ module Swagger
           camelize_keys_deep!(resource)
           # Add the already-normalized models to the resource.
           resource = resource.merge({:models => models}) if models.present?
-          # write controller resource file
-          write_to_file(File.join(settings[:api_file_path], "#{resource_path}.json"), resource, config)
+          resource[:resource_file_path] = resource_path
+          resource
         end
 
         def get_route_path_apis(path, route, klass, settings, config)
           models, apis = {}, []
           action = route.defaults[:action]
           verb = route.verb.source.to_s.delete('$'+'^').downcase.to_sym
-          return apis if !operations = klass.swagger_actions[action.to_sym]
+          return {apis: apis, models: models} if !operations = klass.swagger_actions[action.to_sym]
           operations = Hash[operations.map {|k, v| [k.to_s.gsub("@","").to_sym, v.respond_to?(:deep_dup) ? v.deep_dup : v.dup] }] # rename :@instance hash keys
           operations[:method] = verb
           operations[:nickname] = "#{path.camelize}##{action}"
-          
+
           api_path = transform_spec_to_api_path(route.path.spec, settings[:controller_base_path], config[:api_extension_type])
           operations[:parameters] = filter_path_params(api_path, operations[:parameters]) if operations[:parameters]
 
           apis << {:path => api_path, :operations => [operations]}
-          models = get_klass_models(klass)          
+          models = get_klass_models(klass)
 
           {apis: apis, models: models}
         end
@@ -164,8 +183,8 @@ module Swagger
           base_path = trim_trailing_slash(config[:base_path] || "")
           controller_base_path = trim_leading_slash(config[:controller_base_path] || "")
           base_path += "/#{controller_base_path}" unless controller_base_path.empty?
-          api_file_path = config[:api_file_path]          
-          settings = { 
+          api_file_path = config[:api_file_path]
+          settings = {
             base_path: base_path,
             controller_base_path: controller_base_path,
             api_file_path: api_file_path

data/lib/swagger/docs/methods.rb

@@ -27,9 +27,9 @@ module Swagger
 
         def swagger_api(action, &block)
           @swagger_dsl ||= {}
-          return if @swagger_dsl[action]
           dsl = SwaggerDSL.call(action, self, &block)
-          @swagger_dsl[action] = dsl
+          @swagger_dsl[action] ||= {}
+          @swagger_dsl[action].deep_merge!(dsl) { |key, old, new| Array(old) + Array(new) }
         end
 
         def swagger_model(model_name, &block)

data/lib/swagger/docs/task.rb

@@ -6,4 +6,4 @@ module Swagger
       end
     end
   end
-end
+end

data/lib/swagger/docs/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   module Docs
-    VERSION = "0.1.3"
+    VERSION = "0.1.4"
   end
 end

data/pec

@@ -0,0 +1,120 @@
+diff --git a/lib/swagger/docs/generator.rb b/lib/swagger/docs/generator.rb
+index ed18606..6455c92 100644
+--- a/lib/swagger/docs/generator.rb
++++ b/lib/swagger/docs/generator.rb
+@@ -17,34 +17,56 @@ module Swagger
+         end
+ 
+         def write_docs(apis = nil)
+-          apis ||= Config.registered_apis
+-          results = {}
+-          set_real_methods
+-          unless apis.empty?
+-            apis.each do |api_version,config|
+-              config.reverse_merge!(DEFAULT_CONFIG)
+-              results[api_version] = write_doc(api_version, config)
+-            end
+-          else
+-            results[DEFAULT_VER] = write_doc(DEFAULT_VER, DEFAULT_CONFIG)
++          results = generate_docs(apis)
++          results.each do |api_version, result|
++            write_doc(result)
+           end
+           results
+         end
+ 
+-        def write_doc(api_version, config)
+-          settings = get_settings(api_version, config)
+-
++        def write_doc(result)
++          settings = result[:settings]
++          config = result[:config]
+           create_output_paths(settings[:api_file_path])
+           clean_output_paths(settings[:api_file_path]) if config[:clean_directory] || false
++          root = result[:root]
++          resources = root.delete 'resources'
++          write_to_file("#{settings[:api_file_path]}/api-docs.json", root, config)
++          resources.each do |resource|
++            resource_file_path = resource.delete 'resourceFilePath'
++            write_to_file(File.join(settings[:api_file_path], "#{resource_file_path}.json"), resource, config)
++          end
++          result
++        end
+ 
++        def generate_docs(apis=nil)
++          apis ||= Config.registered_apis
++          results = {}
++          set_real_methods
++
++          apis[DEFAULT_VER] = DEFAULT_CONFIG if apis.empty?
++
++          apis.each do |api_version, config|
++            settings = get_settings(api_version, config)
++            config.reverse_merge!(DEFAULT_CONFIG)
++            results[api_version] = generate_doc(api_version, settings, config)
++            results[api_version][:settings] = settings
++            results[api_version][:config] = config
++          end
++          results
++        end
++
++        def generate_doc(api_version, settings, config)
+           root = { :api_version => api_version, :swagger_version => "1.2", :base_path => settings[:base_path] + "/", :apis => []}
+           results = {:processed => [], :skipped => []}
++          resources = []
+ 
+           get_route_paths(settings[:controller_base_path]).each do |path|
+             ret = process_path(path, root, config, settings)
+             results[ret[:action]] << ret
+             if ret[:action] == :processed
+-              create_resource_file(ret[:path], ret[:apis], ret[:models], settings, root, config)
++              resource = generate_resource(ret[:path], ret[:apis], ret[:models], settings, root, config)
++              resources << resource
+               debased_path = get_debased_path(ret[:path], settings[:controller_base_path])
+               resource_api = {
+                 path: "#{Config.transform_path(trim_leading_slash(debased_path))}.{format}",
+@@ -53,9 +75,9 @@ module Swagger
+               root[:apis] << resource_api
+             end
+           end
+-
++          root[:resources] = resources
+           camelize_keys_deep!(root)
+-          write_to_file("#{settings[:api_file_path]}/api-docs.json", root, config)
++          results[:root] = root
+           results
+         end
+ 
+@@ -115,7 +137,7 @@ module Swagger
+           {action: :processed, path: path, apis: apis, models: models, klass: klass}
+         end
+ 
+-        def create_resource_file(path, apis, models, settings, root, config)
++        def generate_resource(path, apis, models, settings, root, config)
+           debased_path = get_debased_path(path, settings[:controller_base_path])
+           demod = "#{debased_path.to_s.camelize}".demodulize.camelize.underscore
+           resource_path = trim_leading_slash(debased_path.to_s.underscore)
+@@ -123,8 +145,8 @@ module Swagger
+           camelize_keys_deep!(resource)
+           # Add the already-normalized models to the resource.
+           resource = resource.merge({:models => models}) if models.present?
+-          # write controller resource file
+-          write_to_file(File.join(settings[:api_file_path], "#{resource_path}.json"), resource, config)
++          resource[:resource_file_path] = resource_path
++          resource
+         end
+ 
+         def get_route_path_apis(path, route, klass, settings, config)
+diff --git a/spec/lib/swagger/docs/generator_spec.rb b/spec/lib/swagger/docs/generator_spec.rb
+index d319ac3..ba57ccd 100644
+--- a/spec/lib/swagger/docs/generator_spec.rb
++++ b/spec/lib/swagger/docs/generator_spec.rb
+@@ -298,7 +298,7 @@ describe Swagger::Docs::Generator do
+                 }
+               }
+             }
+-            expect(models['Tag']).to eq expected_model
++            expect(models['tag']).to eq expected_model
+           end
+         end
+       end

data/spec/fixtures/controllers/application_controller.rb

@@ -1,3 +1,3 @@
 class ApplicationController
 
-end
+end

data/spec/fixtures/controllers/ignored_controller.rb

@@ -3,4 +3,4 @@ module Api
     class IgnoredController
     end
   end
-end
+end

data/spec/fixtures/controllers/sample_controller.rb

@@ -10,7 +10,13 @@ module Api
         param :query, :page, :integer, :optional, "Page number"
         param :path, :nested_id, :integer, :optional, "Team Id"
         response :unauthorized
+      end
+
+      swagger_api :index do
         response :not_acceptable, "The request you made is not acceptable"
+      end
+
+      swagger_api :index do
         response :requested_range_not_satisfiable
       end
 

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

@@ -19,7 +19,8 @@ describe Swagger::Docs::Generator do
     stub_route("^PUT$", "update", "api/v1/sample", "/api/v1/sample/:id(.:format)"),
     stub_route("^DELETE$", "destroy", "api/v1/sample", "/api/v1/sample/:id(.:format)"),
     stub_route("^GET$", "new", "api/v1/sample", "/api/v1/sample/new(.:format)"), # no parameters for this method
-    stub_route("^GET$", "index", "", "/api/v1/empty_path") # intentional empty path should not cause any errors
+    stub_route("^GET$", "index", "", "/api/v1/empty_path"), # intentional empty path should not cause any errors
+    stub_route("^GET$", "ignored", "api/v1/sample", "/api/v1/ignored(.:format)") # an action without documentation should not cause any errors
   ]}
 
   let(:tmp_dir) { Pathname.new('/tmp/swagger-docs/') }
@@ -298,7 +299,7 @@ describe Swagger::Docs::Generator do
                 }
               }
             }
-            expect(models['Tag']).to eq expected_model
+            expect(models['tag']).to eq expected_model
           end
         end
       end

data/spec/spec_helper.rb

@@ -41,4 +41,3 @@ end
 def get_api_parameter(api, name)
   api["parameters"].each{|param| return param if param["name"] == name}
 end
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagger-docs
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Rich Hollis
@@ -30,7 +30,7 @@ cert_chain:
   RYcsqDfanYBx7QcftOnbeQq7/Ep7Zx+W9+Ph3TiJLMLdAr7bLkgN1SjvrjTL5mQR
   FuQtYvE4LKiUQpG7vLTRB78dQBlSj9fnv2OM9w==
   -----END CERTIFICATE-----
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2014-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -126,6 +126,7 @@ files:
 - lib/swagger/docs/task.rb
 - lib/swagger/docs/version.rb
 - lib/tasks/swagger.rake
+- pec
 - spec/fixtures/controllers/application_controller.rb
 - spec/fixtures/controllers/ignored_controller.rb
 - spec/fixtures/controllers/sample_controller.rb