openapi3_definition_generator-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01ef57221283427bc3b5d85dbf6b79bfc199ff04546e2853928dd0831c3f4186
+  data.tar.gz: 629ea8f06cdf55a397f4a0a189cb0e425d91501967f24e3e7c1f4a0f93279ed9
+SHA512:
+  metadata.gz: 4931b18f71044b964d1cbdaeb675f05393e5189944670c37da922fdeec95a26ec1a934da84537f241edf076d5d101c746d323a0a85b35b6b2a21b23f3ecd0ed8
+  data.tar.gz: a0bf0ce7b226cb3cc33423b83e050d0f8e6a3c3aa5cb31065c9e7da10e425673c611d19519f3e542f614026ded6a39bf84c41a2ebb1f01c8b2b1af95c29a4537

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Yusuke Nakamura
+
+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,28 @@
+# Openapi3DefinitionGenerator::Rails
+[![CircleCI](https://circleci.com/gh/unasuke/openapi3_definition_generator-rails.svg?style=svg)](https://circleci.com/gh/unasuke/openapi3_definition_generator-rails)
+
+Generate minimum OpenAPI 3 definition YAML from `config/routes.rb` in your Rails application.
+
+:warning: This gem uses Rails private API so may be broken in future.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openapi3_definition_generator-rails'
+```
+
+And then execute:
+
+```bash
+$ bin/rails openapi3_definition:generate_yaml
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Openapi3DefinitionGenerator::Rails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/openapi3_definition_generator/rails.rb

@@ -0,0 +1,7 @@
+require "openapi3_definition_generator/rails/railtie"
+
+module Openapi3DefinitionGenerator
+  module Rails
+    # Your code goes here...
+  end
+end

data/lib/openapi3_definition_generator/rails/openapi3_formatter.rb

@@ -0,0 +1,49 @@
+require 'action_dispatch/routing/inspector'
+require 'yaml'
+
+module ActionDispatch
+  module Routing
+    class OpenAPI3Formatter
+      def initialize()
+        @view  = nil
+        @buffer = []
+        @openapi_structute = {
+          'openapi' => '3.0.0',
+          'info' => {
+            'title' => '',
+            'description' => '',
+            'version' => '0.1.0'
+          },
+          'paths' => {}
+        }
+      end
+
+      def section_title(title)
+      end
+
+      def section(routes)
+        routes.filter do |r|
+          !r[:verb].empty?
+        end.each do |r|
+          @openapi_structute['paths'][r[:path]] ||= {}
+          @openapi_structute['paths'][r[:path]][r[:verb].downcase] = {}
+          @openapi_structute['paths'][r[:path]][r[:verb].downcase] = {
+            'summary' => r[:name],
+            'description' => r[:reqs],
+            'responses' => nil
+          }
+        end
+      end
+
+      def header(routes)
+      end
+
+      def no_routes(*)
+      end
+
+      def result
+        YAML.dump @openapi_structute
+      end
+    end
+  end
+end

data/lib/openapi3_definition_generator/rails/railtie.rb

@@ -0,0 +1,9 @@
+module Openapi3DefinitionGenerator
+  module Rails
+    class Railtie < ::Rails::Railtie
+      rake_tasks do
+        load 'tasks/openapi3_definition_generator/rails_tasks.rake'
+      end
+    end
+  end
+end

data/lib/openapi3_definition_generator/rails/version.rb

@@ -0,0 +1,5 @@
+module Openapi3DefinitionGenerator
+  module Rails
+    VERSION = '0.1.0'
+  end
+end

data/lib/tasks/openapi3_definition_generator/rails_tasks.rake

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+namespace :openapi3_definition do
+  desc 'Generate OpenAPI3 definition YAML from condig/routes.rb'
+  task generate_yaml: :environment do
+    require 'action_dispatch/routing/inspector'
+    require 'openapi3_definition_generator/rails/openapi3_formatter'
+
+    inspector = ActionDispatch::Routing::RoutesInspector.new(Rails.application.routes.routes)
+
+    puts inspector.format(ActionDispatch::Routing::OpenAPI3Formatter.new, nil)
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: openapi3_definition_generator-rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yusuke Nakamura
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-08-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.3
+description: Generate minimum OpenAPI 3 definition YAML from config/routes.rb in your
+  Rails application.
+email:
+- yusuke1994525@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/openapi3_definition_generator/rails.rb
+- lib/openapi3_definition_generator/rails/openapi3_formatter.rb
+- lib/openapi3_definition_generator/rails/railtie.rb
+- lib/openapi3_definition_generator/rails/version.rb
+- lib/tasks/openapi3_definition_generator/rails_tasks.rake
+homepage: https://github.com/unasuke/openapi3_definition_generator-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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Generate minimum OpenAPI 3 definition YAML from config/routes.rb in your
+  Rails application.
+test_files: []