swagger-docs 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f911cef6a9a1c31b6a3eb7b20a9475708d84b450
+  data.tar.gz: 7c7561937304375ceacc3738e4fcd68c4b3cc228
+SHA512:
+  metadata.gz: 862ec9249db73769611ae420128215e7ac356911cf42983560eb22083f9a8dc11ff9c46c4bbb20daecc09afe613b930dddf18c0bdd0e741b8a4edb21c229c14d
+  data.tar.gz: 878c2194761ad4d6ce4be794fa782dbb8c2dff643ebd239d368c466090b2f7fe2025cf953c27048a8360c24429896a41a538219f632908cdffdbaea56bd810ef

checksums.yaml.gz.sig

@@ -0,0 +1 @@
+�����9�4�~�o,�"�W��������(z��6;�:#�x�9�ƺ%�h�'�_P��u�����[�V�'��j�A~}��؟�_��Wq��QE�IfQ�W֪a�\�1ߛ���Z���0�}���
�Aܙ9�y^6��v�j�CM{|�؂��&����%ddB�m���y���-�ۗS��y�eW��͞ir~�_-�Y,ط�9	;)��H��`[�1B
���)=�E�s��ř�0
k��

data.tar.gz.sig

@@ -0,0 +1,2 @@
+��Ƿ��C`K_�8�yʭ-��k��&RZ�#���e����$��hn�x�I0�������dF~SbS7���כnj�,����@���NU�N��}w��{)��A�1y��?�ˢ���dNkL
뒂��HC/�J�˃���ޅ��{w:5��TL2*�K����ǒ���?�y]=z�z��	
�ݯjKv�,
+�j�<5�*��!�g���71�_�ћ3M�40�{;4���P�΄F�
v�c�͜-|��8x�K

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in swagger-docs.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Rich Hollis
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,334 @@
+# Swagger::Docs
+
+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.
+
+Here is an extract of the DSL from a user controller API class:
+
+```
+swagger_controller :users, "User Management"
+
+swagger_api :index do
+  summary "Fetches all User items"
+  param :query, :page, :integer, :optional, "Page number"
+  response :unauthorized
+  response :not_acceptable
+  response :requested_range_not_satisfiable
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'swagger-docs'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swagger-docs
+
+## Usage
+
+### Create Initializer
+
+Create an initializer in config/initializers (e.g. swagger_docs.rb) and define your APIs:
+
+```
+Swagger::Docs::Config.register_apis({
+  "1.0" => {:controller_base_path => "api/v1", :api_file_path => "public/api/v1/"}
+})
+```
+
+### Documenting a controller
+
+```
+class Api::V1::UsersController < ApiController
+
+  swagger_controller :users, "User Management"
+
+  swagger_api :index do
+    summary "Fetches all User items"
+    param :query, :page, :integer, :optional, "Page number"
+    response :unauthorized
+    response :not_acceptable
+    response :requested_range_not_satisfiable
+  end
+
+  swagger_api :show do
+    summary "Fetches a single User item"
+    param :path, :id, :integer, :optional, "User Id"
+    response :unauthorized
+    response :not_acceptable
+    response :not_found
+  end
+
+  swagger_api :create do
+    summary "Creates a new User"
+    param :form, :first_name, :string, :required, "First name"
+    param :form, :last_name, :string, :required, "Last name"
+    param :form, :email, :string, :required, "Email address"
+    response :unauthorized
+    response :not_acceptable
+  end
+
+  swagger_api :update do
+    summary "Updates an existing User"
+    param :path, :id, :integer, :required, "User Id"
+    param :form, :first_name, :string, :optional, "First name"
+    param :form, :last_name, :string, :optional, "Last name"
+    param :form, :email, :string, :optional, "Email address"
+    response :unauthorized
+    response :not_found
+    response :not_acceptable
+  end
+
+  swagger_api :destroy do
+    summary "Deletes an existing User item"
+    param :path, :id, :integer, :optional, "User Id"
+    response :unauthorized
+    response :not_found
+  end
+
+end
+```
+
+### Run rake task to generate docs
+
+```
+rake swagger:docs
+```
+
+### Swagger-ui JSON files should now be present in your api_file_path (e.g. ./public/api/v1)
+
+api-docs.json output:
+
+
+```
+{
+  "apiVersion": "1.0",
+  "swaggerVersion": "1.2",
+  "basePath": "/api/v1",
+  "apis": [
+    {
+      "path": "/users.{format}",
+      "description": "User Management"
+    }
+  ]
+}
+```
+
+users.json output:
+
+```
+{
+  "apiVersion": "1.0",
+  "swaggerVersion": "1.2",
+  "basePath": "/api/v1",
+  "resourcePath": "/users",
+  "apis": [
+    {
+      "path": "/users",
+      "operations": [
+        {
+          "summary": "Fetches all User items",
+          "parameters": [
+            {
+              "paramType": "query",
+              "name": "page",
+              "type": "integer",
+              "description": "Page number",
+              "required": false
+            }
+          ],
+          "responseMessages": [
+            {
+              "code": 401,
+              "message": "Unauthorized"
+            },
+            {
+              "code": 406,
+              "message": "Not Acceptable"
+            },
+            {
+              "code": 416,
+              "message": "Requested Range Not Satisfiable"
+            }
+          ],
+          "method": "get",
+          "nickname": "Api::V1::Users#index"
+        }
+      ]
+    },
+    {
+      "path": "/users",
+      "operations": [
+        {
+          "summary": "Creates a new User",
+          "parameters": [
+            {
+              "paramType": "form",
+              "name": "first_name",
+              "type": "string",
+              "description": "First name",
+              "required": true
+            },
+            {
+              "paramType": "form",
+              "name": "last_name",
+              "type": "string",
+              "description": "Last name",
+              "required": true
+            },
+            {
+              "paramType": "form",
+              "name": "email",
+              "type": "string",
+              "description": "Email address",
+              "required": true
+            }
+          ],
+          "responseMessages": [
+            {
+              "code": 401,
+              "message": "Unauthorized"
+            },
+            {
+              "code": 406,
+              "message": "Not Acceptable"
+            }
+          ],
+          "method": "post",
+          "nickname": "Api::V1::Users#create"
+        }
+      ]
+    },
+    {
+      "path": "/users/{id}",
+      "operations": [
+        {
+          "summary": "Fetches a single User item",
+          "parameters": [
+            {
+              "paramType": "path",
+              "name": "id",
+              "type": "integer",
+              "description": "User Id",
+              "required": false
+            }
+          ],
+          "responseMessages": [
+            {
+              "code": 401,
+              "message": "Unauthorized"
+            },
+            {
+              "code": 404,
+              "message": "Not Found"
+            },
+            {
+              "code": 406,
+              "message": "Not Acceptable"
+            }
+          ],
+          "method": "get",
+          "nickname": "Api::V1::Users#show"
+        }
+      ]
+    },
+    {
+      "path": "/users/{id}",
+      "operations": [
+        {
+          "summary": "Updates an existing User",
+          "parameters": [
+            {
+              "paramType": "path",
+              "name": "id",
+              "type": "integer",
+              "description": "User Id",
+              "required": true
+            },
+            {
+              "paramType": "form",
+              "name": "first_name",
+              "type": "string",
+              "description": "First name",
+              "required": false
+            },
+            {
+              "paramType": "form",
+              "name": "last_name",
+              "type": "string",
+              "description": "Last name",
+              "required": false
+            },
+            {
+              "paramType": "form",
+              "name": "email",
+              "type": "string",
+              "description": "Email address",
+              "required": false
+            }
+          ],
+          "responseMessages": [
+            {
+              "code": 401,
+              "message": "Unauthorized"
+            },
+            {
+              "code": 404,
+              "message": "Not Found"
+            },
+            {
+              "code": 406,
+              "message": "Not Acceptable"
+            }
+          ],
+          "method": "put",
+          "nickname": "Api::V1::Users#update"
+        }
+      ]
+    },
+    {
+      "path": "/users/{id}",
+      "operations": [
+        {
+          "summary": "Deletes an existing User item",
+          "parameters": [
+            {
+              "paramType": "path",
+              "name": "id",
+              "type": "integer",
+              "description": "User Id",
+              "required": false
+            }
+          ],
+          "responseMessages": [
+            {
+              "code": 401,
+              "message": "Unauthorized"
+            },
+            {
+              "code": 404,
+              "message": "Not Found"
+            }
+          ],
+          "method": "delete",
+          "nickname": "Api::V1::Users#destroy"
+        }
+      ]
+    }
+  ]
+}
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/certs/gem-public_cert.pem

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMRMwEQYDVQQDDApyaWNo
+aG9sbGlzMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZFgNj
+b20wHhcNMTMxMDIyMTMwMzI3WhcNMTQxMDIyMTMwMzI3WjBBMRMwEQYDVQQDDApy
+aWNoaG9sbGlzMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZ
+FgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDppQTU++yinAuC
+ydu87c/vDGTmE5Go9/zI48/T0kTco+JbUn4BPUaK0DWCEpZULvqwQAqVQm8JQnIU
+6Z3k1tAQbhtgbG2oWNIxyC7SyXMQw/ag5qoAhw6k3DFE+jGKrREzADFb7vG+nPYp
+4yinx27jCTIAv7/z2AVt6HoHOYh1s0HniJQWCebi7QgNXboMY8MpFxSwNkcFjl14
+KMSf9SX7iOyiwqgcJmN0fN4be8pH5j/EdinUL1rWlwldcUo2+6LChBswRPmtdaZv
+UyICuX5VfVJA0KrA/ihIMLaZVO5esFso+YrpP+QgbvhLwhn5e/sB5dr3a+y0+GJZ
+zPGtm60bAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+BBShIiKLL1E1JG++RUVAOSPO7rZV0TAfBgNVHREEGDAWgRRyaWNoaG9sbGlzQGdt
+YWlsLmNvbTAfBgNVHRIEGDAWgRRyaWNoaG9sbGlzQGdtYWlsLmNvbTANBgkqhkiG
+9w0BAQUFAAOCAQEAe4P1TzJlVhUn60Wx/431wNnuHZS9K4gSzmNr4zuZU6lP3rxx
+rMsSY1nJY1nTBqX9W62hO+KS14ncbZvNU59ao5YVXHDflEB3Yz20DP9E2Uws64Bx
+ify0Dwuq4VV2PiQbczuTGhGupzQpkMttWNZqVdjDbH5k8sGx3MumNX7YUJwUerhZ
+bTBme5soNyJzAeWBqCBPT9p98rC6vqhcBfAVF6RbERYL6MPyoBZWqGeuMR4H2X/v
+RYcsqDfanYBx7QcftOnbeQq7/Ep7Zx+W9+Ph3TiJLMLdAr7bLkgN1SjvrjTL5mQR
+FuQtYvE4LKiUQpG7vLTRB78dQBlSj9fnv2OM9w==
+-----END CERTIFICATE-----

data/lib/swagger/docs.rb

@@ -0,0 +1,12 @@
+require "swagger/docs/config"
+require "swagger/docs/dsl"
+require "swagger/docs/generator"
+require "swagger/docs/impotent_methods"
+require "swagger/docs/methods"
+require "swagger/docs/task"
+require "swagger/docs/version"
+
+module Swagger
+  module Docs
+  end
+end

data/lib/swagger/docs/config.rb

@@ -0,0 +1,15 @@
+module Swagger
+  module Docs
+    class Config
+      class << self
+        def register_apis(versions)
+          ApplicationController.send(:include, ImpotentMethods)
+          @versions = versions
+        end
+        def registered_apis
+          @versions ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/swagger/docs/dsl.rb

@@ -0,0 +1,56 @@
+module Swagger
+  module Docs
+    class SwaggerDSL
+      # http://stackoverflow.com/questions/5851127/change-the-context-binding-inside-a-block-in-ruby/5851325#5851325
+      def self.call(action, caller, &blk)
+        # Create a new CommandDSL instance, and instance_eval the block to it
+        instance = new
+        instance.instance_eval(&blk)
+        # Now return all of the set instance variables as a Hash
+        instance.instance_variables.inject({}) { |result_hash, instance_variable|
+          result_hash[instance_variable] = instance.instance_variable_get(instance_variable)
+          result_hash # Gotta have the block return the result_hash
+        }
+      end
+
+      def summary(text)
+        @summary = text
+      end
+
+      def method(method)
+        @method = method
+      end
+
+      def type(type)
+        @type = type
+      end
+
+      def nickname(nickname)
+        @nickname = nickname
+      end
+
+      def parameters
+        @parameters ||= []
+      end
+
+      def param(param_type, name, type, required, description = nil, hash={})
+        parameters << {:param_type => param_type, :name => name, :type => type,
+          :description => description, :required => required == :required ? true : false}.merge(hash)
+      end
+
+      def response_messages
+        @response_messages ||= []
+      end
+
+      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 => status.to_s.titleize}
+        else
+          response_messages << {:code => status, :message => text}
+        end
+        response_messages.sort_by!{|i| i[:code]}
+      end
+    end
+  end
+end

data/lib/swagger/docs/generator.rb

@@ -0,0 +1,93 @@
+module Swagger
+  module Docs
+    class Generator
+      class << self
+
+        def camelize_keys_deep!(h)
+          h.keys.each do |k|
+            ks    = k.to_s.camelize(:lower)
+            h[ks] = h.delete k
+            camelize_keys_deep! h[ks] if h[ks].kind_of? Hash
+            if h[ks].kind_of? Array
+              h[ks].each do |a|
+                next unless a.kind_of? Hash
+                camelize_keys_deep! a
+              end
+            end
+          end
+        end
+
+        def get_api_path(spec)
+          path_api = spec.to_s.gsub("(.:format)", "")
+          parts_new = []
+          path_api.split("/").each do |path_part|
+            part = path_part
+            if part[0] == ":"
+              part[0] = "{"
+              part << "}"
+            end
+            parts_new << part
+          end
+          path_api = parts_new*"/"
+        end
+
+        def set_real_methods
+          ApplicationController.send(:include, Methods) # replace impotent methods with live ones
+        end
+
+        def write_docs(apis)
+          results = {}
+          set_real_methods
+          Config.registered_apis.each do |api_version,config|
+            results[api_version] = write_doc(api_version, config)
+          end
+          results
+        end
+
+        def write_doc(api_version, config)
+          base_path = config[:controller_base_path]
+          api_file_path = config[:api_file_path]
+          results = {:processed => [], :skipped => []}
+
+          FileUtils.mkdir_p(api_file_path) # recursively create out output path
+          Dir.foreach(api_file_path) {|f| fn = File.join(api_file_path, f); File.delete(fn) if !File.directory?(fn)} # clean output path
+
+          header = { :api_version => api_version, :swagger_version => "1.2", :base_path => "/#{base_path}"}
+          resources = header.merge({:apis => []})
+
+          paths = Rails.application.routes.routes.map{|i| "#{i.defaults[:controller]}" }
+          paths = paths.uniq.select{|i| i.start_with?(base_path)}
+          paths.each do |path|
+            klass = "#{path.to_s.camelize}Controller".constantize
+            if !klass.methods.include?(:swagger_config) or !klass.swagger_config[:controller]
+              results[:skipped] << path
+              next
+            end
+            apis = []
+            Rails.application.routes.routes.select{|i| i.defaults[:controller] == path}.each do |route|
+              action = route.defaults[:action]
+              verb = route.verb.source.to_s.delete('$'+'^').downcase.to_sym
+              next if !operations = klass.swagger_actions[action.to_sym]
+              operations = Hash[operations.map {|k, v| [k.to_s.gsub("@","").to_sym, v] }] # rename :@instance hash keys
+              operations[:method] = verb
+              operations[:nickname] = "#{path.camelize}##{action}"
+              apis << {:path => get_api_path(route.path.spec).gsub("/#{base_path}",""), :operations => [operations]}
+            end
+            demod = "#{path.to_s.camelize}".demodulize.camelize.underscore
+            resource = header.merge({:resource_path => "/#{demod}", :apis => apis})
+            camelize_keys_deep!(resource)
+            # write controller resource file
+            File.open("#{api_file_path}#{demod}.json", 'w') { |file| file.write(resource.to_json) }
+            # append resource to resources array (for writing out at end)
+            resources[:apis] << {path: "/#{demod}.{format}", description: klass.swagger_config[:description]}
+            results[:processed] << path
+          end
+          # write master resource file
+          camelize_keys_deep!(resources)
+          File.open("#{api_file_path}api-docs.json", 'w') { |file| file.write(resources.to_json) }
+          results
+        end
+      end
+    end
+  end
+end

data/lib/swagger/docs/impotent_methods.rb

@@ -0,0 +1,21 @@
+module Swagger
+  module Docs
+    module ImpotentMethods
+
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        private
+
+        def swagger_api(action, &block)
+        end
+
+        def swagger_controller(controller, description)
+        end
+      end
+
+    end
+  end
+end

data/lib/swagger/docs/methods.rb

@@ -0,0 +1,39 @@
+module Swagger
+  module Docs
+    module Methods
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+        def swagger_controller(controller, description)
+          swagger_config[:controller] = controller
+          swagger_config[:description] = description
+        end
+
+        def swagger_model(model)
+          swagger_config[:model] = model
+        end
+
+        def swagger_actions
+          @swagger_dsl
+        end
+
+        def swagger_config
+          @swagger_config ||= {}
+        end
+
+        private
+
+        def swagger_api(action, &block)
+          @swagger_dsl ||= {}
+          controller_action = "#{name}##{action} #{self.class}"
+          return if @swagger_dsl[action]
+          route = Rails.application.routes.routes.select{|i| "#{i.defaults[:controller].to_s.camelize}Controller##{i.defaults[:action]}" == controller_action }.first
+          dsl = SwaggerDSL.call(action, self, &block)
+          @swagger_dsl[action] = dsl
+        end
+      end
+    end
+  end
+end

data/lib/swagger/docs/task.rb

@@ -0,0 +1,9 @@
+module Swagger
+  module Docs
+    class Task < Rails::Railtie
+      rake_tasks do
+        Dir[File.join(File.dirname(__FILE__),'../../tasks/*.rake')].each { |f| load f }
+      end
+    end
+  end
+end

data/lib/swagger/docs/version.rb

@@ -0,0 +1,5 @@
+module Swagger
+  module Docs
+    VERSION = "0.0.1"
+  end
+end

data/lib/tasks/swagger.rake

@@ -0,0 +1,10 @@
+namespace :swagger do
+
+  desc "Generate Swagger documentation files"
+  task :docs => [:environment] do |t,args|
+    results = Swagger::Docs::Generator.write_docs(Swagger::Docs::Config.registered_apis)
+    results.each do |k,v|
+      puts "#{k}: #{v[:processed].count} processed / #{v[:skipped].count} skipped"
+    end
+  end
+end

data/spec/fixtures/controllers/application_controller.rb

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

data/spec/fixtures/controllers/ignored_controller.rb

@@ -0,0 +1,6 @@
+module Api
+  module V1
+    class IgnoredController
+    end
+  end
+end

data/spec/fixtures/controllers/sample_controller.rb

@@ -0,0 +1,52 @@
+module Api
+  module V1
+    class SampleController < ApplicationController
+
+      swagger_controller :users, "User Management"
+
+      swagger_api :index do
+        summary "Fetches all User items"
+        param :query, :page, :integer, :optional, "Page number"
+        response :unauthorized
+        response :not_acceptable
+        response :requested_range_not_satisfiable
+      end
+
+      swagger_api :show do
+        summary "Fetches a single User item"
+        param :path, :id, :integer, :optional, "User Id"
+        response :unauthorized
+        response :not_acceptable
+        response :not_found
+      end
+
+      swagger_api :create do
+        summary "Creates a new User"
+        param :form, :first_name, :string, :required, "First name"
+        param :form, :last_name, :string, :required, "Last name"
+        param :form, :email, :string, :required, "Email address"
+        response :unauthorized
+        response :not_acceptable
+      end
+
+      swagger_api :update do
+        summary "Updates an existing User"
+        param :path, :id, :integer, :required, "User Id"
+        param :form, :first_name, :string, :optional, "First name"
+        param :form, :last_name, :string, :optional, "Last name"
+        param :form, :email, :string, :optional, "Email address"
+        response :unauthorized
+        response :not_found
+        response :not_acceptable
+      end
+
+      swagger_api :destroy do
+        summary "Deletes an existing User item"
+        param :path, :id, :integer, :optional, "User Id"
+        response :unauthorized
+        response :not_found
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,154 @@
+require 'spec_helper'
+
+describe Swagger::Docs::Generator do
+
+  require "fixtures/controllers/application_controller"
+  require "fixtures/controllers/ignored_controller"
+
+  def stub_route(verb, action, controller, spec)
+    double("route", :verb => double("verb", :source => verb),
+                  :defaults => {:action => action, :controller => controller},
+                  :path => double("path", :spec => spec)
+    )
+  end
+
+  before(:each) do
+    FileUtils.rm_rf(TMP_DIR)
+    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("^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)")
+    ]
+    @config = Swagger::Docs::Config.register_apis({
+      "1.0" => {:controller_base_path => "api/v1", :api_file_path => "#{TMP_DIR}api/v1/"}
+    })
+    Rails.stub_chain(:application, :routes, :routes).and_return(routes)
+    Swagger::Docs::Generator.set_real_methods
+    require "fixtures/controllers/sample_controller"
+  end
+
+  context "test suite initialization" do
+    it "the resources file does not exist" do
+      expect(File.exists?(FILE_RESOURCES)).to be_false
+    end
+    it "the resource file does not exist" do
+      expect(File.exists?(FILE_RESOURCE)).to be_false
+    end
+  end
+
+  describe "#write_docs" do
+    let(:generate) { Swagger::Docs::Generator::write_docs(@config) }
+    before(:each) do
+      generate
+    end
+    it "writes the resources file" do
+      expect(File.exists?(FILE_RESOURCES)).to be_true
+    end
+    it "writes the resource file" do
+      expect(File.exists?(FILE_RESOURCE)).to be_true
+    end
+    it "returns results hash" do
+      results = generate
+      expect(results["1.0"][:processed].count).to eq 1
+      expect(results["1.0"][:skipped].count).to eq 1
+    end
+    context "resources files" do
+      let(:resources) { File.read(FILE_RESOURCES)}
+      let(:response) { JSON.parse(resources) }
+      it "writes version correctly" do
+        expect(response["apiVersion"]).to eq "1.0"
+      end
+      it "writes swaggerVersion correctly" do
+        expect(response["swaggerVersion"]).to eq "1.2"
+      end
+      it "writes basePath correctly" do
+        expect(response["basePath"]).to eq "/api/v1"
+      end
+      it "writes apis correctly" do
+        expect(response["apis"].count).to eq 1
+      end
+      it "writes api path correctly" do
+        expect(response["apis"][0]["path"]).to eq "/sample.{format}"
+      end
+      it "writes api description correctly" do
+        expect(response["apis"][0]["description"]).to eq "User Management"
+      end
+    end
+    context "resource file" do
+      let(:resource) { File.read(FILE_RESOURCE)}
+      let(:response) { JSON.parse(resource) }
+      let(:first) { response["apis"].first }
+      let(:operations) { first["operations"] }
+      let(:params) { operations.first["parameters"] }
+      let(:response_msgs) { operations.first["responseMessages"] }
+      # {"apiVersion":"1.0","swaggerVersion":"1.2","basePath":"/api/v1","resourcePath":"/sample"
+      it "writes version correctly" do
+        expect(response["apiVersion"]).to eq "1.0"
+      end
+      it "writes swaggerVersion correctly" do
+        expect(response["swaggerVersion"]).to eq "1.2"
+      end
+      it "writes basePath correctly" do
+        expect(response["basePath"]).to eq "/api/v1"
+      end
+      it "writes resourcePath correctly" do
+        expect(response["resourcePath"]).to eq "/sample"
+      end
+      it "writes out expected api count" do
+        expect(response["apis"].count).to eq 5
+      end
+      context "first api" do
+        #"apis":[{"path":" /sample","operations":[{"summary":"Fetches all User items"
+        #,"method":"get","nickname":"Api::V1::Sample#index"}]
+        it "writes path correctly" do
+          expect(first["path"]).to eq "/sample"
+        end
+        it "writes summary correctly" do
+          expect(operations.first["summary"]).to eq "Fetches all User items"
+        end
+        it "writes method correctly" do
+          expect(operations.first["method"]).to eq "get"
+        end
+        it "writes nickname correctly" do
+          expect(operations.first["nickname"]).to eq "Api::V1::Sample#index"
+        end
+        #"parameters":[{"paramType":"query","name":"page","type":"integer","description":"Page number","required":false}]
+        context "parameters" do
+          it "has correct count" do
+            expect(params.count).to eq 1
+          end
+          it "writes paramType correctly" do
+            expect(params.first["paramType"]).to eq "query"
+          end
+          it "writes name correctly" do
+            expect(params.first["name"]).to eq "page"
+          end
+          it "writes type correctly" do
+            expect(params.first["type"]).to eq "integer"
+          end
+          it "writes description correctly" do
+            expect(params.first["description"]).to eq "Page number"
+          end
+          it "writes required correctly" do
+            expect(params.first["required"]).to be_false
+          end
+        end
+        #"responseMessages":[{"code":401,"message":"Unauthorized"},{"code":406,"message":"Not Acceptable"},{"code":416,"message":"Requested Range Not Satisfiable"}]
+        context "response messages" do
+          it "has correct count" do
+            expect(response_msgs.count).to eq 3
+          end
+          it "writes code correctly" do
+            expect(response_msgs.first["code"]).to eq 401
+          end
+          it "writes message correctly" do
+            expect(response_msgs.first["message"]).to eq "Unauthorized"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require "rails"
+require "swagger/docs"
+require "ostruct"
+require "json"
+
+TMP_DIR = "/tmp/swagger-docs/"
+TMP_API_DIR = "/tmp/swagger-docs/api/v1/"
+FILE_RESOURCES = "#{TMP_API_DIR}api-docs.json"
+FILE_RESOURCE = "#{TMP_API_DIR}sample.json"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+  config.color_enabled = true
+end

data/swagger-docs.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'swagger/docs/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "swagger-docs"
+  spec.version       = Swagger::Docs::VERSION
+  spec.authors       = ["Rich Hollis"]
+  spec.email         = ["richhollis@gmail.com"]
+  spec.description   = %q{Generates json files for rails apps to use with swagger-ui}
+  spec.summary       = %q{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.
+}
+  spec.homepage      = "https://github.com/richhollis/swagger-docs"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.cert_chain  = ['certs/gem-public_cert.pem']
+  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"
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: swagger-docs
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rich Hollis
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDeDCCAmCgAwIBAgIBATANBgkqhkiG9w0BAQUFADBBMRMwEQYDVQQDDApyaWNo
+  aG9sbGlzMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZFgNj
+  b20wHhcNMTMxMDIyMTMwMzI3WhcNMTQxMDIyMTMwMzI3WjBBMRMwEQYDVQQDDApy
+  aWNoaG9sbGlzMRUwEwYKCZImiZPyLGQBGRYFZ21haWwxEzARBgoJkiaJk/IsZAEZ
+  FgNjb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDppQTU++yinAuC
+  ydu87c/vDGTmE5Go9/zI48/T0kTco+JbUn4BPUaK0DWCEpZULvqwQAqVQm8JQnIU
+  6Z3k1tAQbhtgbG2oWNIxyC7SyXMQw/ag5qoAhw6k3DFE+jGKrREzADFb7vG+nPYp
+  4yinx27jCTIAv7/z2AVt6HoHOYh1s0HniJQWCebi7QgNXboMY8MpFxSwNkcFjl14
+  KMSf9SX7iOyiwqgcJmN0fN4be8pH5j/EdinUL1rWlwldcUo2+6LChBswRPmtdaZv
+  UyICuX5VfVJA0KrA/ihIMLaZVO5esFso+YrpP+QgbvhLwhn5e/sB5dr3a+y0+GJZ
+  zPGtm60bAgMBAAGjezB5MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
+  BBShIiKLL1E1JG++RUVAOSPO7rZV0TAfBgNVHREEGDAWgRRyaWNoaG9sbGlzQGdt
+  YWlsLmNvbTAfBgNVHRIEGDAWgRRyaWNoaG9sbGlzQGdtYWlsLmNvbTANBgkqhkiG
+  9w0BAQUFAAOCAQEAe4P1TzJlVhUn60Wx/431wNnuHZS9K4gSzmNr4zuZU6lP3rxx
+  rMsSY1nJY1nTBqX9W62hO+KS14ncbZvNU59ao5YVXHDflEB3Yz20DP9E2Uws64Bx
+  ify0Dwuq4VV2PiQbczuTGhGupzQpkMttWNZqVdjDbH5k8sGx3MumNX7YUJwUerhZ
+  bTBme5soNyJzAeWBqCBPT9p98rC6vqhcBfAVF6RbERYL6MPyoBZWqGeuMR4H2X/v
+  RYcsqDfanYBx7QcftOnbeQq7/Ep7Zx+W9+Ph3TiJLMLdAr7bLkgN1SjvrjTL5mQR
+  FuQtYvE4LKiUQpG7vLTRB78dQBlSj9fnv2OM9w==
+  -----END CERTIFICATE-----
+date: 2013-10-22 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'
+description: Generates json files for rails apps to use with swagger-ui
+email:
+- richhollis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- certs/gem-public_cert.pem
+- lib/swagger/docs.rb
+- lib/swagger/docs/config.rb
+- lib/swagger/docs/dsl.rb
+- lib/swagger/docs/generator.rb
+- lib/swagger/docs/impotent_methods.rb
+- lib/swagger/docs/methods.rb
+- lib/swagger/docs/task.rb
+- lib/swagger/docs/version.rb
+- lib/tasks/swagger.rake
+- spec/fixtures/controllers/application_controller.rb
+- spec/fixtures/controllers/ignored_controller.rb
+- spec/fixtures/controllers/sample_controller.rb
+- spec/lib/swagger/docs/generator_spec.rb
+- spec/spec_helper.rb
+- swagger-docs.gemspec
+homepage: https://github.com/richhollis/swagger-docs
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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
+signing_key: 
+specification_version: 4
+summary: 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.
+test_files:
+- spec/fixtures/controllers/application_controller.rb
+- spec/fixtures/controllers/ignored_controller.rb
+- spec/fixtures/controllers/sample_controller.rb
+- spec/lib/swagger/docs/generator_spec.rb
+- spec/spec_helper.rb

metadata.gz.sig

@@ -0,0 +1,2 @@
+O94�Mt�!<�"����w�3w��pPԢ�F׺K�P^�оO��qȡL��Kݗ�&�1>]$.�O_�F����QI7-��/��b��L�$���>n:��,1�?���`�됬i��qQ4���2>zY��v^���}j�~m�K���<X��CѴ#�a��
+f�hAsiZ�0ֿ
x����#�����03�UTF���_��:��Zs�[#�\sw;-h