swagger-docs 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3eb51612948dcffe393a0fee74c1f79dcfb64ae9
-  data.tar.gz: ccaa3a9f4e00a1b022b1c71eb9431fba6675efee
+  metadata.gz: 67c64b2ae7bcb8d0a653d598dc5f6de70d223d8e
+  data.tar.gz: 95555f61513a11238944a1e9a4bd361f00e70159
 SHA512:
-  metadata.gz: 191427fd69bff4114b6a55a844430e373f7505eab2d0a63781c027fd468691b6f19fe36fb2fea1107a585b1e6acfc6152e2934a4ff96e5f022a0e944c7b822a8
-  data.tar.gz: 1fe19613a6cc7d7a7cf70cb1c1b2ee85d92bb9fc9a9aecb34d6b8c33b6d49180a9aceea273ff021b5f1d23f36cd1705d5d0b7d132bdc9081146ca10454b3dd9f
+  metadata.gz: c047b999407fc51017a1e6ded45582bff68c395446f643d3aaef3f2c3f0c5d397cc6f210c9021348337bce459b5f5e2d88a9eb6ac98814826fd86746b6046f14
+  data.tar.gz: 2a86f256d2298cb7ab8abadd4e350641bb37da943f77b1dad6f7cb2b1d7106b942b6d55c8efb39636c755464f7fec03a7d20effe3c655b37b96b9aaf2093e0c6

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.1.5
+- Delay processing docs DSL to allow changing the context of the controllers #47 @ldnunes
+
+## 0.1.4
+- An undocumentated action in a documented controller should not raise errors #43 @ldnunes
+- Allow reopening of docs definition for the swagger_api DSL command #44 @ldnunes
+- Refactor write_docs to split the documentation generation from file writing #45 @ldnunes
+
 ## 0.1.3
 - Fix issue where empty path throws error
 

data/README.md

@@ -216,6 +216,35 @@ https://github.com/richhollis/swagger-docs-sample
 
 ### Advanced Customization
 
+#### Recurring parameters
+
+If you have lots of recurring parameters then you can use this approach suggested by Lucas Dutra Nunes (@ldnunes):
+
+```
+class Api::BaseController < ActionController::Base
+  class << self
+    Swagger::Docs::Generator::set_real_methods
+
+    def inherited(subclass)
+      super
+      subclass.class_eval do
+        setup_basic_api_documentation
+      end
+    end
+
+    private
+
+    def setup_basic_api_documentation
+      [:index, :show, :create, :update, :delete].each do |api_action|
+        swagger_api api_action do
+          param :header, 'Authentication-Token', :string, :required, 'Authentication token'
+        end
+      end
+    end
+  end
+end
+```
+
 #### Inheriting from a custom Api controller
 
 By default swagger-docs is applied to controllers inheriting from ApplicationController.
@@ -565,7 +594,7 @@ users.json output:
 
 ## Thanks to our contributors
 
-Thanks to @jdar, @fotinakis, @stevschmid and all of our contributors for making swagger-docs better.
+Thanks to jdar, fotinakis, stevschmid, ldnunes and all of our contributors for making swagger-docs even better.
 
 ## Contributing
 

data/lib/swagger/docs/methods.rb

@@ -12,11 +12,22 @@ module Swagger
         end
 
         def swagger_actions
-          @swagger_dsl
+          swagger_dsl = {}
+          Array(@swagger_dsl).each do |action, controller, block|
+            dsl = SwaggerDSL.call(action, controller, &block)
+            swagger_dsl[action] ||= {}
+            swagger_dsl[action].deep_merge!(dsl) { |key, old, new| Array(old) + Array(new) }
+          end
+          swagger_dsl
         end
 
         def swagger_models
-          @swagger_model_dsls ||= {}
+          swagger_model_dsls ||= {}
+          Array(@swagger_model_dsls).each do |model_name, controller, block|
+            model_dsl = SwaggerModelDSL.call(model_name, controller, &block)
+            swagger_model_dsls[model_name] = model_dsl
+          end
+          swagger_model_dsls
         end
 
         def swagger_config
@@ -26,16 +37,13 @@ module Swagger
         private
 
         def swagger_api(action, &block)
-          @swagger_dsl ||= {}
-          dsl = SwaggerDSL.call(action, self, &block)
-          @swagger_dsl[action] ||= {}
-          @swagger_dsl[action].deep_merge!(dsl) { |key, old, new| Array(old) + Array(new) }
+          @swagger_dsl ||= []
+          @swagger_dsl << [action, self, block]
         end
 
         def swagger_model(model_name, &block)
-          @swagger_model_dsls ||= {}
-          model_dsl = SwaggerModelDSL.call(model_name, self, &block)
-          @swagger_model_dsls[model_name] = model_dsl
+          @swagger_model_dsls ||= []
+          @swagger_model_dsls << [model_name, self, block]
         end
       end
     end

data/lib/swagger/docs/version.rb

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

data/spec/fixtures/controllers/application_controller.rb

@@ -1,3 +1,4 @@
 class ApplicationController
-
+  cattr_accessor :context
+  self.context = "original"
 end

data/spec/fixtures/controllers/sample_controller.rb

@@ -62,6 +62,13 @@ module Api
         summary "Builds a new User item"
       end
 
+      swagger_api :context_dependent do
+        summary "An action dependent on the context of the controller " +
+          "class. Right now it is: " + ApplicationController.context
+        response :success
+        response :unauthorized
+      end
+
       # Support for Swagger complex types:
       # https://github.com/wordnik/swagger-core/wiki/Datatypes#wiki-complex-types
       swagger_model :Tag do

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

@@ -184,6 +184,25 @@ describe Swagger::Docs::Generator do
         it "writes out expected api count" do
           expect(response["apis"].count).to eq 7
         end
+        describe "context dependent documentation" do
+          after(:each) do
+            ApplicationController.context = "original"
+          end
+          let(:routes) {[stub_route("^GET$", "context_dependent", "api/v1/sample", "/api/v1/sample(.:format)")]}
+          let(:operations) { apis[0]["operations"] }
+          it "should be the original" do
+            ApplicationController.context = "original"
+            generate(config)
+            expect(operations.first["summary"]).to eq "An action dependent on the context of the controller class. Right now it is: original"
+          end
+          context "when modified" do
+            it "should be modified" do
+              ApplicationController.context = "modified"
+              generate(config)
+              expect(operations.first["summary"]).to eq "An action dependent on the context of the controller class. Right now it is: modified"
+            end
+          end
+        end
         context "apis" do
           context "index" do
             let(:api) { get_api_operation(apis, "sample", :get) }

data/swagger-docs.gemspec

@@ -23,8 +23,8 @@ Gem::Specification.new do |spec|
   spec.signing_key = File.expand_path("~/.gemcert/gem-private_key.pem") if $0 =~ /gem\z/
 
   spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "rails"
-  spec.add_development_dependency "appraisal"
+  spec.add_development_dependency "rake",  "~> 0"
+  spec.add_development_dependency "rspec",  "~> 0"
+  spec.add_development_dependency "rails",  "~> 0"
+  spec.add_development_dependency "appraisal",  "~> 0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagger-docs
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Rich Hollis
@@ -30,76 +30,76 @@ cert_chain:
   RYcsqDfanYBx7QcftOnbeQq7/Ep7Zx+W9+Ph3TiJLMLdAr7bLkgN1SjvrjTL5mQR
   FuQtYvE4LKiUQpG7vLTRB78dQBlSj9fnv2OM9w==
   -----END CERTIFICATE-----
-date: 2014-04-07 00:00:00.000000000 Z
+date: 2014-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: Generates json files for rails apps to use with swagger-ui
@@ -109,7 +109,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Appraisals
 - CHANGELOG.md
 - Gemfile
@@ -126,7 +126,6 @@ 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
@@ -143,17 +142,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Generates swagger-ui json files for rails apps with APIs. You add the swagger

metadata.gz.sig

@@ -1 +1 @@
-�c2��a�{�p���@nr4�	���v�gX0$�����F��.~��|2E��U}HQ
���;�3/�iD��=J�c����$T�D���B#�s�0QBd��������u�S3�/hXaE�?3���F)#P]��s�Dv��@ߊ�l��>�;�P��̻�����B��u$���i��RK��	�����@3�"��l�.�S��'�.�'��-�	�?�|�����1�[�G^��K�GҶ�)
+�aS9!fI}ª �@

data/pec

@@ -1,120 +0,0 @@
-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