swagger-doc-rails 1.0.0

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

@@ -0,0 +1,56 @@
+require "rails"
+require "swagger/docs"
+require "ostruct"
+require "json"
+require 'pathname'
+
+DEFAULT_VER = Swagger::Docs::Generator::DEFAULT_VER
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+  config.color = true
+
+  config.before(:each) do
+    Swagger::Docs::Config.base_api_controller = nil # use default object
+  end
+end
+
+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},
+    :path => double("path", :spec => spec)
+  )
+end
+
+def get_api_paths(apis, path)
+  apis.select{|api| api["path"] == path}
+end
+
+def get_api_operations(apis, path)
+  apis = get_api_paths(apis, path)
+  apis.collect{|api| api["operations"]}.flatten
+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-doc-rails.gemspec

@@ -0,0 +1,31 @@
+# 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-doc-rails"
+  spec.version       = Swagger::Docs::VERSION
+  spec.authors       = ["zxhe"]
+  spec.email         = ["zx.he@163.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/eagle168/swagger-doc-rails"
+  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", "~> 10"
+  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_development_dependency "appraisal", "~> 1"
+
+  spec.add_runtime_dependency "rails", ">= 3"
+  spec.add_runtime_dependency "activesupport", ">= 3"
+end

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: swagger-doc-rails
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- zxhe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-10 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: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Generates json files for rails apps to use with swagger-ui
+email:
+- zx.he@163.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Appraisals
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- certs/gem-public_cert.pem
+- lib/swagger/docs.rb
+- lib/swagger/docs/api_declaration_file.rb
+- lib/swagger/docs/api_declaration_file_metadata.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/custom_resource_path_controller.rb
+- spec/fixtures/controllers/ignored_controller.rb
+- spec/fixtures/controllers/multiple_routes_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-doc-rails.gemspec
+homepage: https://github.com/eagle168/swagger-doc-rails
+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.5.1
+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/custom_resource_path_controller.rb
+- spec/fixtures/controllers/ignored_controller.rb
+- spec/fixtures/controllers/multiple_routes_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