zero-rails_openapi 1.3.2 → 1.3.3

data/lib/open_api/generator.rb

@@ -21,6 +21,7 @@ module OpenApi
       def generate_doc(api_name)
         settings = Config.docs[api_name]
         doc = { openapi: '3.0.0' }.merge(settings.slice :info, :servers).merge(
+                # TODO: rename to just `security`
                 security: settings[:global_security], tags: [ ], paths: { },
                 components: {
                     securitySchemes: settings[:global_security_schemes],
@@ -34,6 +35,7 @@ module OpenApi
           doc[:paths].merge! ctrl.instance_variable_get('@_api_infos') || { }
           doc[:tags] << ctrl_infos[:tag]
           doc[:components].merge! ctrl_infos[:components] || { }
+          ($api_paths_index ||= { })[ctrl.instance_variable_get('@_ctrl_path')] = api_name
         end
         doc[:components].delete_if { |_, v| v.blank? }
         doc[:tags]  = doc[:tags].sort { |a, b| a[:name] <=> b[:name] }
@@ -67,19 +69,20 @@ module OpenApi
       FileUtils.mkdir_p dir_path
       file_path = "#{dir_path}/#{action}.json.jbuilder"
 
-      unless !Config.overwrite_jbuilder_file && File::exists?(file_path)
+      if Config.overwrite_jbuilder_file || !File.exists?(file_path)
         File.open(file_path, 'w') { |file| file.write Config.jbuilder_templates[builder] }
         puts "[ZRO] JBuilder file has been generated: #{path}/#{action}"
       end
     end
 
-    def self.generate_routes_list
+    def self.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)
 
+      @routes_list ||=
       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]
         {
@@ -92,11 +95,19 @@ module OpenApi
       end.compact.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|
+    def self.get_actions_by_ctrl_path(ctrl_path)
+      routes_list[ctrl_path]&.map do |action_info|
         action_info[:action_path].split('#').last
       end
     end
+
+    def self.find_path_httpverb_by(ctrl_path, action)
+      routes_list[ctrl_path]&.map do |action_info|
+        if action_info[:action_path].split('#').last == action.to_s
+          return [ action_info[:path], action_info[:http_verb] ]
+        end
+      end
+      nil
+    end
   end
 end

data/lib/open_api/version.rb

@@ -1,3 +1,3 @@
 module OpenApi
-  VERSION = '1.3.2'
+  VERSION = '1.3.3'
 end

data/zero-rails_openapi.gemspec

@@ -16,15 +16,6 @@ Gem::Specification.new do |spec|
   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
@@ -35,4 +26,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16.a"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_runtime_dependency "rails", ">= 3"
+  spec.add_runtime_dependency "activesupport", ">= 3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zero-rails_openapi
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.3
 platform: ruby
 authors:
 - zhandao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-10 00:00:00.000000000 Z
+date: 2017-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !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: |-
   Provide concise DSL for generating the OpenAPI Specification 3 (OAS3)
                            documentation JSON file for Rails application,
@@ -76,10 +104,10 @@ files:
 - bin/setup
 - documentation/examples/auto_gen_desc.rb
 - documentation/examples/auto_gen_doc.rb
-- documentation/examples/example_output_doc.json
 - documentation/examples/examples_controller.rb
 - documentation/examples/goods_doc.rb
 - documentation/examples/open_api.rb
+- documentation/examples/output_example.json
 - documentation/parameter.md
 - lib/oas_objs/example_obj.rb
 - lib/oas_objs/helpers.rb