zero-rails_openapi 1.0.0

data/lib/open_api/generator.rb

@@ -0,0 +1,75 @@
+require 'active_support/hash_with_indifferent_access'
+
+module OpenApi
+  module Generator
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def generate_docs(api_name = nil)
+        Rails.application.eager_load!
+        if api_name.present?
+          { api_name => generate_doc(api_name) }
+        else
+          OpenApi.apis.keys.map { |api_key| { api_key => generate_doc(api_key)} }.reduce({ }, :merge)
+        end
+      end
+
+      def generate_doc(api_name)
+        settings = OpenApi.apis[api_name]
+        doc = { openapi: '3.0.0' }.merge(settings.slice :info, :servers).merge({
+                security: settings[:global_security], tags: [ ], paths: { },
+                components: {
+                    securitySchemes: settings[:global_security_schemes],
+                    schemas: { }
+                }
+              })
+
+        settings[:root_controller].descendants.each do |ctrl|
+          doc[:paths].merge! ctrl.instance_variable_get('@_api_infos')
+          doc[:tags] << ctrl.instance_variable_get('@_ctrl_infos')[:tag]
+          doc[:components].merge! ctrl.instance_variable_get('@_ctrl_infos')[:components]
+        end
+        doc[:components].delete_if { |_,v| v.blank? }
+        ($open_apis ||= { })[api_name] ||= HashWithIndifferentAccess.new doc.delete_if { |_,v| v.blank? }
+      end
+
+      def write_docs
+        docs = generate_docs
+        # puts docs
+        output_path = OpenApi.config.file_output_path
+        FileUtils.mkdir_p output_path
+        docs.each do |api_name, doc|
+          File.open("#{output_path}/#{api_name}.json", 'w') { |file| file.write JSON.pretty_generate doc }
+        end
+      end
+    end
+
+    def self.generate_routes_list
+      # ref https://github.com/rails/rails/blob/master/railties/lib/rails/tasks/routes.rake
+      require './config/routes'
+      all_routes = Rails.application.routes.routes
+      require 'action_dispatch/routing/inspector'
+      inspector = ActionDispatch::Routing::RoutesInspector.new(all_routes)
+
+      inspector.format(ActionDispatch::Routing::ConsoleFormatter.new, nil).split("\n").drop(1).map do |line|
+        infos = line.match(/[A-Z].*/).to_s.split(' ') # => [GET, /api/v1/examples/:id, api/v1/examples#index]
+        {
+            http_verb: infos[0].downcase, # => "get"
+            path: infos[1][0..-11].split('/').map do |item|
+                    item.match?(/:/) ? "{#{item[1..-1]}}" : item
+                  end.join('/'),          # => "/api/v1/examples/{id}"
+            action_path: infos[2]         # => "api/v1/examples#index"
+        }
+      end.group_by {|api| api[:action_path].split('#').first } # => { "api/v1/examples" => [..] }, group by paths
+    end
+
+    def self.get_actions_by_ctrl_path(path)
+      @routes_list ||= generate_routes_list
+      @routes_list[path].map do |action_info|
+        action_info[:action_path].split('#').last
+      end
+    end
+  end
+end

data/lib/open_api/version.rb

@@ -0,0 +1,3 @@
+module OpenApi
+  VERSION = '1.0.0'
+end

data/lib/takes/open_api.rake

@@ -0,0 +1,6 @@
+namespace :openapi do
+  desc 'Generate OpenApi documentation files'
+  task :api => [:environment] do |t, args|
+    OpenApi.write_docs
+  end
+end

data/zero-rails_openapi.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "open_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "zero-rails_openapi"
+  spec.version       = OpenApi::VERSION
+  spec.authors       = ["zhandao"]
+  spec.email         = ["x@skippingcat.com"]
+
+  spec.summary       = %q{Generate the OpenAPI Specification JSON file for Rails application.}
+  spec.description   = %q{Provide concise DSL for you to generate the OpenAPI Specification 3 (Swagger 3)
+                         JSON file for Rails application, then you can use Swagger-UI 3.2.0+ to show the documentation.}
+  spec.homepage      = "https://github.com/zhandao/zero-rails_openapi"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16.a"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: zero-rails_openapi
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- zhandao
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-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.16.a
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.16.a
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |-
+  Provide concise DSL for you to generate the OpenAPI Specification 3 (Swagger 3)
+                           JSON file for Rails application, then you can use Swagger-UI 3.2.0+ to show the documentation.
+email:
+- x@skippingcat.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/examples/examples_controller.rb
+- lib/examples/open_api.rb
+- lib/oas_objs/helpers.rb
+- lib/oas_objs/media_type_obj.rb
+- lib/oas_objs/param_obj.rb
+- lib/oas_objs/ref_obj.rb
+- lib/oas_objs/request_body_obj.rb
+- lib/oas_objs/response_obj.rb
+- lib/oas_objs/schema_obj.rb
+- lib/open_api.rb
+- lib/open_api/config.rb
+- lib/open_api/dsl.rb
+- lib/open_api/dsl_inside_block.rb
+- lib/open_api/generator.rb
+- lib/open_api/version.rb
+- lib/takes/open_api.rake
+- zero-rails_openapi.gemspec
+homepage: https://github.com/zhandao/zero-rails_openapi
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Generate the OpenAPI Specification JSON file for Rails application.
+test_files: []