swagger-docs 0.1.8 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf18b79ce15cb8436f59367c1ece509850b4f671
-  data.tar.gz: cd5ee26cc156d613d0e1446a9a7744b112d421ef
+  metadata.gz: 9c266ba841a5bdacb059df2348ef839408bb1b8b
+  data.tar.gz: 85475fb831183dded5e7ed8b858e9c2df590350f
 SHA512:
-  metadata.gz: a25491571a345ecdb99060f71b5ed468275901ce3b9099339eecd146a3ac300b883d96c465a7d64804ac687d58f1bf6843cbe353b1ff20f5fe6af53b71ec01b0
-  data.tar.gz: ff752bfbb69eec66ada69efdeebf46c6e648a17f67345a7d8a8689bf69fbe15d918a7155270bdfeddb2c2356bc0f75f6bba8bea5d7530631f2e49d266ac6444d
+  metadata.gz: d5919f6cdf9462d5074db8e1749e4ef518dec92e08148de8f005ce518b7b0c90b0fefe40f638997cff400ca27f1b78af23b87b1944989503cf461c4987130509
+  data.tar.gz: 5511929b22b9b62174cacbe09ac160763337ccd600a2fb75b634445e29cbaba23ffce392fac3181ada7b38f7e6a3cb323e442533145277140faba98aeb768437

checksums.yaml.gz.sig

@@ -1 +1,2 @@
-�Z�;��9z1����_Q�%��	����Sj3�8�1�5�DǢ\����D�Hm�ͳ���N4),zi�?}�ٟ��.�.�:�M&�ˣDYW��D�e���ΰA^��[MÀ����n��qW���'	�BO�d��UR�iF��	��2������$����2-���3@(���	�Xmր�R�oJ����Bq�S50�*:C�B��L�҆ޮ6�8@�z]U�S���Ł>l���r�y�M����ZǕ�/D��
++�B�;=Ї0��-g�ӥ�x���޸�[}�`0yM��"���f�xMZ-%9�^�vk S�Fb{�7��
+)'�|�>��U��f	*��������C��j {�=O:���╬~a��ĩ`ۧo���w����URR��k�M6�4�
��8�xK�����u�;|��

data.tar.gz.sig

@@ -1 +1,3 @@
-���6^���y����R�]@H�`{)j���G����O���@���i�z!	k�"c��q�E����u���XYG����1-"�c���4�
}���qL)�f�Fu�o�%x^H���$��R���؈g�e(��o��	�rd 0�x���x�� ��[>&1Yϟ�+凯
+��n��Ҵ~)8��!@zs��7p��XZ�	����-���Ws7���3ۘ��۲��
+`�:�Վ"���Z�1p �;.`K�v+#O����ۢl��Q�,M!�P�O��S�.�w���(�Q�"`���@8����>�˜�k��|v+i��^C�_�>��&�c;$�uϮ?����
+�"�b��>{	_]D<���cQ�Ł��$�?��
����|�Q�DoK���l��

data/CHANGELOG.md

@@ -1,3 +1,18 @@
+## 0.1.10
+
+(next release - not released yet)
+
+## 0.1.9
+
+- Adding support for multiple engines #65
+- Add ability for swagger_api to accept parameters (e.g. consumes, produces)
+- Update dependencies #64
+- Address issue with routing verbs where some verbs do not have a route.verb.source attribute only route.verb #58
+- Add ability to set custom attributes (like info block) on api-docs file #67
+- Ensure API endpoint/nickname (e.g. "Api::V1::Some#update") is only written out once per resource file. Addresses PATCH, POST duplication issue #70
+- Add "consumes" dsl method #74
+- Expose API version on transform_path for easier “No Server Integrations” #79
+
 ## 0.1.8
 
 - Fix issue with gem build open-ended dependency warnings in gemspec

data/README.md

@@ -2,6 +2,15 @@
 
 Generates swagger-ui json files for rails apps with APIs. You add the swagger DSL to your controller classes and then run one rake task to generate the json files.
 
+[![Gem Version](https://badge.fury.io/rb/swagger-docs.png)][gem]
+[![Dependency Status](https://gemnasium.com/richhollis/swagger-docs.png?travis)][gemnasium]
+
+[gem]: https://rubygems.org/gems/swagger-docs
+[travis]: http://travis-ci.org/richhollis/swagger-docs
+[gemnasium]: https://gemnasium.com/richhollis/swagger-docs
+[coveralls]: https://coveralls.io/r/richhollis/swagger-docs
+
+
 Here is an extract of the DSL from a user controller API class:
 
 ```ruby
@@ -47,7 +56,18 @@ Swagger::Docs::Config.register_apis({
     # the URL base path to your API
     :base_path => "http://api.somedomain.com",
     # if you want to delete all .json files at each generation
-    :clean_directory => false
+    :clean_directory => false,
+    # add custom attributes to api-docs
+    :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"
+      }
+    }
   }
 })
 ```
@@ -132,6 +152,7 @@ class Api::V1::UsersController < ApplicationController
   swagger_api :show do
     summary "Fetches a single User item"
     param :path, :id, :integer, :optional, "User Id"
+    response :success, "Success", :User
     response :unauthorized
     response :not_acceptable
     response :not_found
@@ -288,6 +309,25 @@ class Swagger::Docs::Config
 end
 ```
 
+If you want swagger to find controllers in `Rails.application` and/or multiple
+engines you can override `base_application` to return an array. 
+
+```ruby
+class Swagger::Docs::Config
+  def self.base_application; [Rails.application, Api::Engine, SomeOther::Engine] end
+end
+```
+
+Or, if you prefer you can override `base_applications` for this purpose. The plural
+`base_applications` takes precedence over `base_application` and MUST return an
+array.
+
+```ruby
+class Swagger::Docs::Config
+  def self.base_applications; [Rails.application, Api::Engine, SomeOther::Engine] end
+end
+```
+
 #### Transforming the `path` variable
 
 Swagger allows a distinction between the API documentation server and the hosted API
@@ -296,8 +336,8 @@ class method in your initializer:
 
 ```ruby
 class Swagger::Docs::Config
-  def self.transform_path(path)
-    "http://example.com/api-docs/#{path}"
+  def self.transform_path(path, api_version)
+    "http://example.com/api-docs/#{api_version}/#{path}"
   end
 end
 ```
@@ -616,6 +656,14 @@ users.json output:
 
 Thanks to jdar, fotinakis, stevschmid, ldnunes, aaronrenner and all of our contributors for making swagger-docs even better.
 
+## Related Projects
+
+**[@fotinakis](https://github.com/fotinakis/)** has created Swagger::Blocks - a DSL for pure Ruby code blocks: [swagger-blocks](https://github.com/fotinakis/swagger-blocks/)
+
+## More About Me
+
+[Rich Hollis](http://richhollis.co.uk)
+
 ## Contributing
 
 When raising a Pull Request please ensure that you have provided good test coverage for the request you are making.

data/lib/swagger/docs/config.rb

@@ -12,6 +12,10 @@ module Swagger
           @@base_api_controller = controller
         end
 
+        def base_applications
+          Array(base_application)
+        end
+
         def base_application
           Rails.application 
         end
@@ -25,7 +29,7 @@ module Swagger
           @versions ||= {}
         end
         
-        def transform_path(path)
+        def transform_path(path, api_version)
           # This is only for overriding, so don't perform any path transformations by default.
           path
         end

data/lib/swagger/docs/dsl.rb

@@ -16,7 +16,7 @@ module Swagger
       def summary(text)
         @summary = text
       end
-      
+
       def notes(text)
         @notes = text
       end
@@ -29,6 +29,10 @@ module Swagger
         @type = type
       end
 
+      def consumes(mime_types)
+        @consumes = mime_types
+      end
+
       def nickname(nickname)
         @nickname = nickname
       end
@@ -55,9 +59,9 @@ module Swagger
       def response(status, text = nil, model = nil)
         if status.is_a? Symbol
           status_code = Rack::Utils.status_code(status)
-          response_messages << {:code => status_code, :message => text || status.to_s.titleize}
+          response_messages << {:code => status_code, :responseModel => model, :message => text || status.to_s.titleize}
         else
-          response_messages << {:code => status, :message => text}
+          response_messages << {:code => status, :responseModel => model, :message => text}
         end
         response_messages.sort_by!{|i| i[:code]}
       end

data/lib/swagger/docs/generator.rb

@@ -28,7 +28,10 @@ module Swagger
           clean_output_paths(settings[:api_file_path]) if config[:clean_directory] || false
           root = result[:root]
           resources = root.delete 'resources'
+          root.merge!(config[:attributes] || {}) # merge custom user attributes like info
+          # write the api-docs file
           write_to_file("#{settings[:api_file_path]}/api-docs.json", root, config)
+          # write the individual resource files
           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)
@@ -54,7 +57,7 @@ module Swagger
         end
 
         def generate_doc(api_version, settings, config)
-          root = { "apiVersion" => api_version, "swaggerVersion" => "1.2", "basePath" => settings[:base_path] + "/", :apis => []}
+          root = { "apiVersion" => api_version, "swaggerVersion" => "1.2", "basePath" => settings[:base_path] + "/", :apis => [] }
           results = {:processed => [], :skipped => []}
           resources = []
 
@@ -65,7 +68,7 @@ module Swagger
               resources << generate_resource(ret[:path], ret[:apis], ret[:models], settings, root, config)
               debased_path = get_debased_path(ret[:path], settings[:controller_base_path])
               resource_api = {
-                path: "#{Config.transform_path(trim_leading_slash(debased_path))}.{format}",
+                path: "#{Config.transform_path(trim_leading_slash(debased_path), api_version)}.{format}",
                 description: ret[:klass].swagger_config[:description]
               }
               root[:apis] << resource_api
@@ -123,15 +126,34 @@ module Swagger
           klass = "#{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]
-          apis, models = [], {}
-          Config.base_application.routes.routes.select{|i| i.defaults[:controller] == path}.each do |route|
-            ret = get_route_path_apis(path, route, klass, settings, config)
-            apis = apis + ret[:apis]
-            models.merge!(ret[:models])
+          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 
+              ret = get_route_path_apis(path, route, klass, settings, config)
+              apis = apis + ret[:apis]
+              models.merge!(ret[:models])
+              defined_nicknames << ret[:nickname] if ret[:nickname].present?
+            end
           end
           {action: :processed, path: path, apis: apis, models: models, klass: klass}
         end
 
+        def route_verb(route)
+          if defined?(route.verb.source) then route.verb.source.to_s.delete('$'+'^') else route.verb end.downcase.to_sym 
+        end
+
+        def path_route_nickname(path, route)
+          action = route.defaults[:action]
+          "#{path.camelize}##{action}"
+        end
+
+        def nickname_defined?(defined_nicknames, path, route)
+          verb = route_verb(route)
+          target_nickname = path_route_nickname(path, route)
+          defined_nicknames.each{|nickname| return true if nickname == target_nickname }
+          false
+        end
+
         def generate_resource(path, apis, models, settings, root, config)
           metadata = ApiDeclarationFileMetadata.new(root["apiVersion"], path, root["basePath"],
                                                    settings[:controller_base_path],
@@ -141,22 +163,27 @@ module Swagger
           declaration.generate_resource
         end
 
+        def routes
+          Config.base_applications.map{|app| app.routes.routes.to_a }.flatten
+        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: apis, models: models} if !operations = klass.swagger_actions[action.to_sym]
+          verb = route_verb(route)
+          return {apis: apis, models: models, nickname: nil} 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}"
+          nickname = operations[:nickname] = path_route_nickname(path, route)
 
-          api_path = transform_spec_to_api_path(route.path.spec, settings[:controller_base_path], config[:api_extension_type])
+          route_path = if defined?(route.path.spec) then route.path.spec else route.path end
+          api_path = transform_spec_to_api_path(route_path, 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)
 
-          {apis: apis, models: models}
+          {apis: apis, models: models, nickname: nickname}
         end
 
         def get_klass_models(klass)
@@ -187,7 +214,7 @@ module Swagger
         end
 
         def get_route_paths(controller_base_path)
-          paths = Config.base_application.routes.routes.map{|i| "#{i.defaults[:controller]}" }
+          paths = routes.map{|i| "#{i.defaults[:controller]}" }
           paths.uniq.select{|i| i.start_with?(controller_base_path)}
         end
 

data/lib/swagger/docs/impotent_methods.rb

@@ -9,7 +9,7 @@ module Swagger
       module ClassMethods
         private
 
-        def swagger_api(action, &block)
+        def swagger_api(action, params = {}, &block)
         end
 
         def swagger_model(model_name, &block)

data/lib/swagger/docs/methods.rb

@@ -1,3 +1,4 @@
+require "active_support/core_ext/hash/deep_merge"
 module Swagger
   module Docs
     module Methods
@@ -6,17 +7,18 @@ module Swagger
       end
 
       module ClassMethods
-        def swagger_controller(controller, description)
+        def swagger_controller(controller, description, params = {})
           swagger_config[:controller] = controller
           swagger_config[:description] = description
         end
 
         def swagger_actions
           swagger_dsl = {}
-          Array(@swagger_dsl).each do |action, controller, block|
+          Array(@swagger_dsl).each do |action, params, controller, block|
             dsl = SwaggerDSL.call(action, controller, &block)
             swagger_dsl[action] ||= {}
             swagger_dsl[action].deep_merge!(dsl) { |key, old, new| Array(old) + Array(new) }
+            swagger_dsl[action].deep_merge!(params) # merge in user api parameters
           end
           swagger_dsl
         end
@@ -34,11 +36,9 @@ module Swagger
           @swagger_config ||= {}
         end
 
-        private
-
-        def swagger_api(action, &block)
+        def swagger_api(action, params = {}, &block)
           @swagger_dsl ||= []
-          @swagger_dsl << [action, self, block]
+          @swagger_dsl << [action, params, self, block]
         end
 
         def swagger_model(model_name, &block)

data/lib/swagger/docs/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   module Docs
-    VERSION = "0.1.8"
+    VERSION = "0.1.9"
   end
 end

data/spec/fixtures/controllers/nested_controller.rb

@@ -0,0 +1,18 @@
+module Api
+  module V1
+    class SuperclassController < ApplicationController
+    end
+    class NestedController < SuperclassController
+      swagger_controller :nested, "User Management"
+
+      swagger_api :index do
+        summary "Fetches all User items"
+        param :query, :page, :integer, :optional, "Page number"
+        param :path, :nested_id, :integer, :optional, "Team Id"
+        response :unauthorized
+        response :not_acceptable, "The request you made is not acceptable"
+        response :requested_range_not_satisfiable
+      end
+    end
+  end
+end

data/spec/fixtures/controllers/sample_controller.rb

@@ -9,14 +9,9 @@ module Api
         summary "Fetches all User items"
         param :query, :page, :integer, :optional, "Page number"
         param :path, :nested_id, :integer, :optional, "Team Id"
+        response :success, "Some text", :Tag
         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
 
@@ -30,10 +25,12 @@ module Api
 
       swagger_api :create do
         summary "Creates a new User"
+        consumes [ "application/json", "text/xml" ]
         param :form, :first_name, :string, :required, "First name"
         param :form, :last_name, :string, :required, "Last name"
         param :form, :email, :string, :required, "Email address"
         param_list :form, :role, :string, :required, "Role", [ "admin", "superadmin", "user" ]
+        param :body, :body, :json, :required, 'JSON formatted body'
         response :unauthorized
         response :not_acceptable
       end

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

@@ -22,7 +22,8 @@ describe Swagger::Docs::ApiDeclarationFile do
             ],
             :notes=>"Only the given fields are updated.",
             :method=>:put,
-            :nickname=>"Api::V1::Sample#update"
+            :nickname=>"Api::V1::Sample#update",
+            :consumes=>["application/json", "text/xml"]
           }
         ]
       }
@@ -187,7 +188,8 @@ describe Swagger::Docs::ApiDeclarationFile do
               ],
               "notes"=>"Only the given fields are updated.",
               "method"=>:put,
-              "nickname"=>"Api::V1::Sample#update"
+              "nickname"=>"Api::V1::Sample#update",
+              "consumes"=>["application/json", "text/xml"]
             }
           ]
         }

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

@@ -28,4 +28,12 @@ describe Swagger::Docs::Config do
     end
   end
 
+  describe "::base_applications" do
+    before(:each) { allow( subject ).to receive(:base_application).and_return(:app) }
+    it "defaults to Rails.application an an Array" do
+      expect(subject.base_applications).to eq [:app]
+    end
+  end
+
+
  end

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

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Swagger::Docs::SwaggerDSL do
+
+  subject { described_class.new() }
+
+  describe "#response" do
+    it "adds code, responseModel and message to response_messages" do
+      subject.response(:success, "Some sample text", "Tag")
+      expect(subject.response_messages).to eq([{:code=>500, :responseModel=>"Tag", :message=>"Some sample text"}])
+    end
+  end
+
+end
+

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

@@ -11,21 +11,23 @@ describe Swagger::Docs::Generator do
   end
 
   let(:routes) {[
-    stub_route("^GET$", "index", "api/v1/ignored", "/api/v1/ignored(.:format)"),
-    stub_route("^GET$", "index", "api/v1/sample", "/api/v1/sample(.:format)"),
-    stub_route("^GET$", "index", "api/v1/sample", "/api/v1/nested/:nested_id/sample(.:format)"),
-    stub_route("^POST$", "create", "api/v1/sample", "/api/v1/sample(.:format)"),
-    stub_route("^GET$", "show", "api/v1/sample", "/api/v1/sample/:id(.:format)"),
-    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$", "ignored", "api/v1/sample", "/api/v1/ignored(.:format)") # an action without documentation should not cause any errors
+    stub_route(            "^GET$",    "index",   "api/v1/ignored", "/api/v1/ignored(.:format)"),
+    stub_route(            "^GET$",    "index",   "api/v1/sample",  "/api/v1/sample(.:format)"),
+    stub_string_verb_route("GET",      "index",   "api/v1/nested",  "/api/v1/nested/:nested_id/nested_sample(.:format)"),
+    stub_route(            "^PATCH$",  "create",  "api/v1/sample",  "/api/v1/sample(.:format)"),
+    stub_route(            "^PUT$",    "create",  "api/v1/sample",  "/api/v1/sample(.:format)"), # intentional duplicate of above route to ensure PATCH is used
+    stub_route(            "^GET$",    "show",    "api/v1/sample",  "/api/v1/sample/:id(.:format)"),
+    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$",    "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/') }
   let(:file_resources) { tmp_dir + 'api-docs.json' }
   let(:file_resource) { tmp_dir + 'api/v1/sample.json' }
+  let(:file_resource_nested) { tmp_dir + 'nested.json' }
 
   context "without controller base path" do
     let(:config) {
@@ -65,7 +67,7 @@ describe Swagger::Docs::Generator do
         expect(response["resourcePath"]).to eq "sample"
       end
       it "writes out expected api count" do
-        expect(response["apis"].count).to eq 7
+        expect(response["apis"].count).to eq 6
       end
       context "first api" do
         #"apis":[{"path":" /sample","operations":[{"summary":"Fetches all User items"
@@ -79,13 +81,25 @@ describe Swagger::Docs::Generator do
 
   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"}
+       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(:file_resource) { tmp_dir + 'sample.json' }
     before(:each) do
       allow(Rails).to receive_message_chain(:application, :routes, :routes).and_return(routes)
       Swagger::Docs::Generator.set_real_methods
       require "fixtures/controllers/sample_controller"
+      require "fixtures/controllers/nested_controller"
     end
 
     context "test suite initialization" do
@@ -104,12 +118,31 @@ describe Swagger::Docs::Generator do
         end
         it "generates using default config" do
           results = generate({})
-          expect(results[DEFAULT_VER][:processed].count).to eq 1
+          expect(results[DEFAULT_VER][:processed].count).to eq 2
         end
       end
       before(:each) do
         generate(config)
       end
+      context "api-docs resources file" do
+        it "writes the file" do
+         expect(file_resources).to exist
+        end
+        context "custom user attributes" do
+          let(:parsed_resources) {
+            JSON.parse(File.read file_resources)
+          }
+          it "it has info hash" do
+            expect(parsed_resources.keys).to include("info")
+          end
+          it "has title field" do
+            expect(parsed_resources["info"]["title"]).to eq "Swagger Sample App"
+          end
+          it "has description field" do
+            expect(parsed_resources["info"]["description"]).to eq "This is a sample description."
+          end
+        end
+      end
       it "cleans json files in directory when set" do
         file_to_delete = Pathname.new(File.join(config['1.0'][:api_file_path], 'delete_me.json'))
         File.open(file_to_delete, 'w') {|f| f.write("{}") }
@@ -125,15 +158,12 @@ describe Swagger::Docs::Generator do
         generate(config)
         expect(file_to_keep).to exist
       end
-      it "writes the resources file" do
-         expect(file_resources).to exist
-      end
       it "writes the resource file" do
          expect(file_resource).to exist
       end
       it "returns results hash" do
         results = generate(config)
-        expect(results[DEFAULT_VER][:processed].count).to eq 1
+        expect(results[DEFAULT_VER][:processed].count).to eq 2
         expect(results[DEFAULT_VER][:skipped].count).to eq 1
       end
       it "writes pretty json files when set" do
@@ -155,7 +185,7 @@ describe Swagger::Docs::Generator do
           expect(response["basePath"]).to eq "http://api.no.where/api/v1/"
         end
         it "writes apis correctly" do
-          expect(response["apis"].count).to eq 1
+          expect(response["apis"].count).to eq 2
         end
         it "writes api path correctly" do
           expect(response["apis"][0]["path"]).to eq "sample.{format}"
@@ -164,7 +194,23 @@ describe Swagger::Docs::Generator do
           expect(response["apis"][0]["description"]).to eq "User Management"
         end
       end
-      context "resource file" do
+      context "nested resource file" do
+        let(:resource) { file_resource_nested.read }
+        let(:response) { JSON.parse(resource) }
+        let(:apis) { response["apis"] }
+        context "apis" do
+          context "show" do
+            let(:api) { get_api_operation(apis, "nested/{nested_id}/nested_sample", :get) }
+            let(:operations) { get_api_operations(apis, "nested/{nested_id}/nested_sample") }
+            context "parameters" do
+              it "has correct count" do
+                expect(api["parameters"].count).to eq 2
+              end
+            end
+          end
+        end
+      end
+      context "sample resource file" do
         let(:resource) { file_resource.read }
         let(:response) { JSON.parse(resource) }
         let(:apis) { response["apis"] }
@@ -182,7 +228,7 @@ describe Swagger::Docs::Generator do
           expect(response["resourcePath"]).to eq "sample"
         end
         it "writes out expected api count" do
-          expect(response["apis"].count).to eq 7
+          expect(response["apis"].count).to eq 6
         end
         describe "context dependent documentation" do
           after(:each) do
@@ -226,6 +272,9 @@ describe Swagger::Docs::Generator do
             it "writes nickname correctly" do
               expect(operations.first["nickname"]).to eq "Api::V1::Sample#index"
             end
+            it "writes responseModel attribute" do
+              expect(api["responseMessages"].find{|m| m["responseModel"] == "Tag"}).to_not be_nil
+            end
             #"parameters"=>[
             # {"paramType"=>"query", "name"=>"page", "type"=>"integer", "description"=>"Page number", "required"=>false},
             # {"paramType"=>"path", "name"=>"nested_id", "type"=>"integer", "description"=>"Team Id", "required"=>false}], "responseMessages"=>[{"code"=>401, "message"=>"Unauthorized"}, {"code"=>406, "message"=>"The request you made is not acceptable"}, {"code"=>416, "message"=>"Requested Range Not Satisfiable"}], "method"=>"get", "nickname"=>"Api::V1::Sample#index"}
@@ -252,7 +301,7 @@ describe Swagger::Docs::Generator do
               end
             end
             context "list parameter" do
-              let(:api) { get_api_operation(apis, "sample", :post) }
+              let(:api) { get_api_operation(apis, "sample", :patch) }
               let(:params) {api["parameters"] }
               it "writes description correctly" do
                 expect(params[3]["description"]).to eq "Role"
@@ -262,7 +311,7 @@ describe Swagger::Docs::Generator do
             context "response messages" do
               let(:response_msgs) { operations.first["responseMessages"] }
               it "has correct count" do
-                expect(response_msgs.count).to eq 3
+                expect(response_msgs.count).to eq 4
               end
               it "writes code correctly" do
                 expect(response_msgs.first["code"]).to eq 401
@@ -275,20 +324,18 @@ describe Swagger::Docs::Generator do
               end
             end
           end
-          context "show" do
-            let(:api) { get_api_operation(apis, "nested/{nested_id}/sample", :get) }
-            let(:operations) { get_api_operations(apis, "nested/{nested_id}/sample") }
-            context "parameters" do
-              it "has correct count" do
-                expect(api["parameters"].count).to eq 2
-              end
-            end
-          end
           context "create" do
-            let(:api) { get_api_operation(apis, "sample", :post) }
+            let(:api) { get_api_operation(apis, "sample", :patch) }
             it "writes list parameter values correctly" do
               expected_param = {"valueType"=>"LIST", "values"=>["admin", "superadmin", "user"]}
+              expected_body = {"paramType"=>"body", "name"=>"body", "type"=>"json", "description"=>"JSON formatted body", "required"=>true}
+              expected_consumes = ["application/json", "text/xml"]
               expect(get_api_parameter(api, "role")["allowableValues"]).to eq expected_param
+              expect(get_api_parameter(api, "body")).to eq expected_body
+              expect(api["consumes"]).to eq ["application/json", "text/xml"]
+            end
+            it "doesn't write out route put method" do
+              expect(get_api_operation(apis, "sample", :put)).to be_nil
             end
           end
           context "update" do

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

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Swagger::Docs::Methods do
+
+  describe "#swagger_actions" do
+    it "merges additional configuration parameters into dsl" do
+      methods = Object.new
+      methods.extend(Swagger::Docs::Methods::ClassMethods)
+      methods.swagger_api("test", {produces: [ "application/json" ], consumes: [ "multipart/form-data" ]}) do
+      end
+      expect(methods.swagger_actions()).to eq({"test"=>{:produces=>["application/json"], :consumes=>["multipart/form-data"]}})
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -21,6 +21,13 @@ def generate(config)
     Swagger::Docs::Generator::write_docs(config)
 end
 
+def stub_string_verb_route(verb, action, controller, spec)
+  double("route", :verb => verb,
+    :defaults => {:action => action, :controller => controller},
+    :path => spec
+  )
+end
+
 def stub_route(verb, action, controller, spec)
   double("route", :verb => double("verb", :source => verb),
     :defaults => {:action => action, :controller => controller},
@@ -40,8 +47,10 @@ end
 def get_api_operation(apis, path, method)
   operations = get_api_operations(apis, path)
   operations.each{|operation| return operation if operation["method"] == method.to_s}
+  nil
 end
 
 def get_api_parameter(api, name)
   api["parameters"].each{|param| return param if param["name"] == name}
+  nil
 end

data/swagger-docs.gemspec

@@ -25,6 +25,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10"
   spec.add_development_dependency "rspec", "~> 3"
-  spec.add_development_dependency "active_support", "~> 3"
   spec.add_development_dependency "appraisal", "~> 1"
+
+  spec.add_runtime_dependency "rails", ">= 3","< 5"
+  spec.add_runtime_dependency "activesupport", ">= 3","< 5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagger-docs
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.1.9
 platform: ruby
 authors:
 - Rich Hollis
@@ -30,7 +30,7 @@ cert_chain:
   RYcsqDfanYBx7QcftOnbeQq7/Ep7Zx+W9+Ph3TiJLMLdAr7bLkgN1SjvrjTL5mQR
   FuQtYvE4LKiUQpG7vLTRB78dQBlSj9fnv2OM9w==
   -----END CERTIFICATE-----
-date: 2014-06-23 00:00:00.000000000 Z
+date: 2014-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,33 +75,59 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
-  name: active_support
+  name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
-  name: appraisal
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
-  type: :development
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '3'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5'
 description: Generates json files for rails apps to use with swagger-ui
 email:
 - richhollis@gmail.com
@@ -130,11 +156,14 @@ files:
 - lib/tasks/swagger.rake
 - spec/fixtures/controllers/application_controller.rb
 - spec/fixtures/controllers/ignored_controller.rb
+- spec/fixtures/controllers/nested_controller.rb
 - spec/fixtures/controllers/sample_controller.rb
 - spec/lib/swagger/docs/api_declaration_file_metadata_spec.rb
 - spec/lib/swagger/docs/api_declaration_file_spec.rb
 - spec/lib/swagger/docs/config_spec.rb
+- spec/lib/swagger/docs/dsl_spec.rb
 - spec/lib/swagger/docs/generator_spec.rb
+- spec/lib/swagger/docs/methods.rb
 - spec/spec_helper.rb
 - swagger-docs.gemspec
 homepage: https://github.com/richhollis/swagger-docs
@@ -165,9 +194,12 @@ summary: Generates swagger-ui json files for rails apps with APIs. You add the s
 test_files:
 - spec/fixtures/controllers/application_controller.rb
 - spec/fixtures/controllers/ignored_controller.rb
+- spec/fixtures/controllers/nested_controller.rb
 - spec/fixtures/controllers/sample_controller.rb
 - spec/lib/swagger/docs/api_declaration_file_metadata_spec.rb
 - spec/lib/swagger/docs/api_declaration_file_spec.rb
 - spec/lib/swagger/docs/config_spec.rb
+- spec/lib/swagger/docs/dsl_spec.rb
 - spec/lib/swagger/docs/generator_spec.rb
+- spec/lib/swagger/docs/methods.rb
 - spec/spec_helper.rb

metadata.gz.sig

@@ -1 +1,4 @@
-�_T���գE3�y%}�h���!��
�X�t��kuH"ݒh0gS&%�X-A���,���4.�e�;��:�tY�Hz�6�1L�_=N���`��#����%�dmL�Y���>�\)��SF_Er2~��khCB���֯~�R���
+Y�(
+Q�~屗2(0P�ރY��V�E������H��$"��^���/�Zޱ�dVW9���[�K~Q�hs=/�Hrp�I)'I�R.�r�7<�Wc����(�<n:��?w������D��ҤV�w�]p��G��'3���)�|cn|�7�)���ǂA�nE+נ�-J�H$4q��*�����
+q]�No��	�u�whC:
_����5�l�Q�k��>
+P!.��GA�c����u;+���Rrp����&|��