swagger_codegen_rails 0.1.01

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '00846a9be00eb053e473ed67d05ed24a8a9fe9c5'
+  data.tar.gz: aec9d081a43f8ef8f8496e3a592b74320a1357c1
+SHA512:
+  metadata.gz: 944f49516f35680d4ccf1cc8f595885ae8234d7477c5518d0efe63c8cc5b6a114e2458a09449f095dcb8cc9c8b5c5e2f123ab2dacc3ce0b2c5aa98f0e7b0e85e
+  data.tar.gz: e5c0f1927d789fd9f509d3425e2cbc42b063c896245f35f2073f36663ca49139d78cad26f6364be2362f1f5a781262bc069303c3e359471e956d75faaca65059

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 
+
+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,100 @@
+[![Gem Version](https://badge.fury.io/rb/swagger_codegen_rails.svg)](https://badge.fury.io/rb/swagger_codegen_rails)
+[![Build Status](https://travis-ci.org/technobrain/swagger_codegen_rails.svg?branch=master)](https://travis-ci.org/technobrain/swagger_codegen_rails)
+[![CircleCI](https://circleci.com/gh/technobrain/swagger_codegen_rails.svg?style=svg)](https://circleci.com/gh/technobrain/swagger_codegen_rails)
+[![Maintainability](https://api.codeclimate.com/v1/badges/b80adfbb67fff2493c4e/maintainability)](https://codeclimate.com/github/technobrain/swagger_codegen_rails/maintainability)
+
+# SwaggerCodegenRails
+this plugin generate SWAGGER API document's templates for [swagger-blocks](https://github.com/fotinakis/swagger-blocks), [swagger_ui_engine](https://github.com/zuzannast/swagger_ui_engine).
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swagger_codegen_rails'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install swagger_codegen_rails
+```
+
+## Usage
+### Demo
+```bash
+$ rails g swagger:install
+$ rails g swagger:init /api/v1
+$ rails g swagger:add /api/v1 /api/v1/user/:id id:path:integer:true
+```
+
+### Create intializer file
+```bash
+$ rails g swagger:install
+```
+  
+### Modify **config/intializers/swagger_codegen_rails.rb**, example below
+```Ruby
+# config/initializers/swagger_codegen_rails.rb
+
+SwaggerCodegenRails.configure do |config|
+  config.versioned = false # boolean
+
+  config.versions_url = {
+    v1: 'api/v1',
+    v2: 'api/v2'
+  }
+
+  config.concern_dir = "/path/to/your/concern/directory"
+  # default: /app/controllers/concerns
+
+  config.schema_dir = "/path/to/your/schema/dir"
+  # default: /app/models/concerns
+end
+```
+
+Options:  
+
+|configurations|type|default|description|
+|:------|:----|:-|:-------------------------|
+|config.versioned|boolean|false|set path of versioned API documentations|
+config.versions_url|hash|EMPTY|define versioned path|
+|config.concern_dir|string|/app/controllers/concern|set root path of endpoint documentations|
+|config.schema_dir|string|/app/models/concern|set root path of response schema documentations|
+  
+
+### To Create Namespace
+```bash
+$ rails g swagger:init NAMESPACE
+```
+
+### To add Endpoint
+```bash
+$ rails g swagger:add NAMESPACE HTTP_METHOD URI [PARAMETERS; name:in:type:required]
+$ # If you do NOT want namespace, example below
+$ rails g swagger:add . GET /users id:path:integer:true
+```
+
+Parameters:
+
+||description|
+|:-|:-|
+|name|parameter name|
+|in|ex) in =\> /items?id=###, query =\> parameter is id.|
+|type|data type|
+|required|required|
+
+
+## Contributing
+1. Fork it ( https://github.com/technobrain/swagger_codegen_rails )
+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
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,23 @@
+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    = 'SwaggerCodegenRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+

data/lib/generators/swagger.rb

@@ -0,0 +1,3 @@
+module Swagger
+
+end

data/lib/generators/swagger/add/add_generator.rb

@@ -0,0 +1,41 @@
+module Swagger
+  class AddGenerator < ::Rails::Generators::NamedBase
+    argument :http_method, type: :string, required: true
+    argument :uri, type: :string, required: true
+    argument :parameter, type: :array, required: false, banner: 'name:in:type:required'
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def arguments
+      @params = ::SwaggerCodegenRails.parse(parameter)
+    end
+
+    def create_endpoint_doc
+      template '_swagger.rb.tt', File.join(swagger_path, "_#{swagger_file_name}.rb") if swagger_file_name
+    end
+
+    private
+
+    def module_name
+      swagger_file_name.camelize
+    end
+
+    def name_space
+      config = SwaggerCodegenRails.configuration.versions_url
+      config ? (config[name.to_sym] || name) : name
+    end
+
+    def swagger_path
+      base_path = SwaggerCodegenRails.configuration.concern_dir
+      File.join(base_path, name_space)
+    end
+
+    def slash_replace(str)
+      str&.gsub("/","_")&.gsub(/\A_*/, '')
+    end
+
+    def swagger_file_name
+      slash_replace(uri.sub(name_space, ''))
+    end
+  end
+end

data/lib/generators/swagger/add/templates/_swagger.rb.tt

@@ -0,0 +1,53 @@
+<% module_namespacing do -%>
+module <%= module_name %>
+  extend ActiveSupport::Concern
+  Dir.glob[<%= SwaggerCodegenRails.configuration.schema_dir %> + "/**/*.rb"].each do |schema|
+    include schema
+  end
+
+  included do
+    swagger_path '<%= uri %>' do
+      operation <%= http_method %> do
+        key :description, "TODO: describe endpoint here"
+        key :operationId, "TODO: "
+        key :produces, [
+          'application/join',
+        ]
+        key :tags, [
+          # A list of tags used by the specification with additional metadata.
+        ]
+
+<% @params&.each do |param| -%>
+        parameter do
+          key :name, :<%= param.name %>
+          key :in, :<%= param.in %>
+          key :description, "TODO: "
+          key :type, :<%= param.type %>
+          key :required, <%= param.required %>
+        end
+<%= "\n" %>
+<% end -%>
+        response 200 do
+          key :description, "TODO: "
+          schema do
+            key :'$ref', TODO:
+          end
+        end
+  
+        response 404 do
+          key :description, "TODO: "
+          schema do
+            key :'$ref', TODO:
+          end
+        end
+  
+        response 501 do
+          key :description, "TODO: "
+          schema do
+            key :'$ref', TODO:
+          end
+        end
+      end
+    end
+  end
+<% end -%>

data/lib/generators/swagger/init/init_generator.rb

@@ -0,0 +1,38 @@
+require 'swagger_codegen_rails/namespace'
+
+module Swagger
+  class InitGenerator < ::Rails::Generators::NamedBase
+    
+    include SwaggerCodegenRails::Namespace
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_concern_dir
+      empty_directory concern_dir
+    end
+
+    def create_namespace_dir
+      empty_directory namespace_dir
+    end
+
+    def create_swagger_controller_file
+      template "_swagger_controller.rb.tt", swagger_controller_path
+    end
+
+    def insert_route
+      route namespaced_route
+    end
+
+    private
+    def swagger_controller_path
+      File.join("app/controllers", name, "swagger_controller.rb")
+    end
+
+    def concern_dir
+      SwaggerCodegenRails.configuration.concern_dir
+    end
+
+    def namespace_dir
+      File.join(concern_dir, name)
+    end
+  end
+end

data/lib/generators/swagger/init/templates/_swagger_controller.rb.tt

@@ -0,0 +1,27 @@
+<% module_namespacing do %>
+class SwaggerController < ActionController::Base
+  include Swagger::Blocks
+  Dir.glob("<%= namespace_dir -%>/**/*.rb").each do |swagger|
+    include swagger
+  end
+  
+  swagger_root do
+    key :swagger, "2.0"
+    info do
+      key :title, 'TODO: api title'
+      key :version, '0.0.1'
+      key :termsOfService, 'TODO: set your service URL'
+    end
+    key :consumes, ['application/json']
+    key :produces, ['application/json']
+  end
+
+  SWAGGER_CLASSES = [
+    self,
+  ].freeze
+
+  def index
+    render json: Swagger::Blocks.build_root_json(SWAGGER_CLASSES)
+  end
+end
+<% end -%>

data/lib/generators/swagger/install/install_generator.rb

@@ -0,0 +1,29 @@
+module Swagger
+  class InstallGenerator < ::Rails::Generators::Base
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    def create_initializer_file
+      template "_initializer.rb.tt", "config/initializers/swagger_codegen_rails.rb" 
+    end
+
+    def create_swagger_ui_initializer_file
+      template "_swagger_ui_initializer.rb.tt", "config/initializers/swagger_ui_engine.rb"
+    end
+
+    def insert_ui_route
+      route "mount SwaggerUiEngine::Engine, at: '/swagger'"
+    end
+
+    def insert_gemfile
+      gem 'swagger_ui_engine'
+      gem 'swagger-blocks'
+    end
+
+    private
+    def initializer_exist?
+      initializer_path = "config/initializers/swagger_ui_engine.rb"
+      File.exist?(initializer_path)
+    end
+  end
+end

data/lib/generators/swagger/install/templates/_initializer.rb.tt

@@ -0,0 +1,13 @@
+SwaggerCodegenRails.configure do |config|
+  # version namespace
+  config.versions_url = {
+    # v1: 'api/v1',
+    # v2: 'api/v2'
+  }
+
+  # directory swagger document files placed
+  config.concern_dir = "app/controllers/concerns"
+  
+  # directory swagger response schema placed
+  config.schema_dir = "app/models/concerns"
+end

data/lib/generators/swagger/install/templates/_swagger_ui_initializer.rb.tt

@@ -0,0 +1,22 @@
+# config/initializers/swagger_codegen_rails.rb
+
+SwaggerUiEngine.configure do |config|
+  config.swagger_url = SwaggerCodegenRails.configuration.swagger_url
+  # Controls how the API listing is displayed. It can be set to 'none' (default), 'list' (shows operations for each resource), or 'full' (fully expanded: shows operations and their details).
+  config.doc_expansion = 'list'
+
+  # Controls how models are shown when the API is first rendered. It can be set to 'model' or 'schema', and the default is 'schema'.
+  config.model_rendering = 'model'
+
+  # Whether or not to show the headers that were sent when making a request via the 'Try it out!' option. Defaults to false.
+  # config.request_headers = false
+
+  # Enables a graphical view for editing complex bodies. Defaults to false.
+  # config.json_editor = false
+
+  # Enables Swagger Ui translations. Defaults to false.
+  # config.translator_enabled = false
+
+  # Enables documentation validator. Defaults to false (validatorUrl: 'null').
+  # config.validator_enabled = false
+end

data/lib/swagger_codegen_rails.rb

@@ -0,0 +1,23 @@
+require 'swagger_codegen_rails/version'
+require 'swagger_codegen_rails/configuration'
+require 'swagger_codegen_rails/defaults'
+require 'swagger_codegen_rails/parameter'
+require 'swagger_codegen_rails/parser'
+
+require 'generators/swagger'
+
+SwaggerCodegenRails.extend(SwaggerCodegenRails::Parser)
+
+module SwaggerCodegenRails
+  class << self
+    delegate(*Configuration::OPTIONS, to: :configuration)
+  
+    def configuration
+      @configuration ||= Configuration.new
+    end
+  
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/lib/swagger_codegen_rails/configuration.rb

@@ -0,0 +1,22 @@
+module SwaggerCodegenRails
+  class Configuration
+    OPTIONS = %i(
+      concern_dir
+      schema_dir
+      versioned
+      versions_url
+    ).freeze
+
+    attr_accessor(*OPTIONS)
+
+    def initialize
+      DEFAULTS.each do |default|
+        self.class.send(:define_method, default.first) { default.last }
+      end
+    end
+
+    def swagger_url
+      self.versions_url.map { |k, v| [k, File.join("/", v, "swagger.json")] }.to_h
+    end
+  end
+end

data/lib/swagger_codegen_rails/defaults.rb

@@ -0,0 +1,7 @@
+module SwaggerCodegenRails
+  DEFAULTS = {
+    concern_dir:  "app/controllers/concerns",
+    schema_dir:   "app/models/concerns",
+    versioned:    false
+  }
+end

data/lib/swagger_codegen_rails/namespace.rb

@@ -0,0 +1,54 @@
+module SwaggerCodegenRails
+  module Namespace
+
+    def module_namespacing(&block)
+      return unless namespaced?
+      content = capture(&block)
+      namespaces.reverse.each do |name|
+        content = wrap_with_namespace(content, name)
+      end
+      concat(content)
+    end
+
+    def namespaced_route
+      depth = 0
+      lines = []
+
+      namespaces.map(&:underscore).each do |ns|
+        lines << indent("namespace :#{ns} do\n", depth*2)
+        depth += 1
+      end
+
+      lines << indent("resources :swagger, only: :index\n", depth*2)
+
+      until depth.zero?
+        depth -= 1
+        lines << indent("end\n", depth*2)
+      end
+
+      lines.join
+    end
+   
+    def namespaces
+      name.gsub('.','').split("/").reject(&:blank?).map(&:camelize)
+    end
+
+    def namespace
+      File.join(name, "swagger").sub(/\A\//, '').sub(/\/\Z/, '')
+    end
+
+    def namespaced?
+      namespaces
+    end
+
+    def wrap_with_namespace(content, namespace)
+      content = indent(content).chomp
+      "module #{namespace}\n#{content}\nend\n"
+    end
+
+    def indent(content, multiplier = 2)
+      spaces = " " * multiplier
+      content.each_line.map { |line| line.blank? ? line : "#{spaces}#{line}" }.join
+    end
+  end
+end

data/lib/swagger_codegen_rails/parameter.rb

@@ -0,0 +1,22 @@
+module SwaggerCodegenRails
+  class Parameter < Struct.new(:name,
+                               :in,
+                               :type,
+                               :required)
+
+    def map_params(str)
+      params = devide(str)
+      self.each_with_index do |_v, i|
+        self[i] = params[i].blank? ? "TODO" : params[i]
+      end
+    rescue IndexError => e
+      logger.error e
+      logger.error e.backtrace.join("\n")
+      return nil
+    end
+
+    def devide(arg_str)
+      arg_str.split(":", 4)
+    end
+  end
+end

data/lib/swagger_codegen_rails/parser.rb

@@ -0,0 +1,8 @@
+module SwaggerCodegenRails::Parser
+  def parse(param_strings)
+    param_strings&.map do |str|
+      params = SwaggerCodegenRails::Parameter.new
+      params.map_params(str)
+    end
+  end
+end

data/lib/swagger_codegen_rails/version.rb

@@ -0,0 +1,5 @@
+module SwaggerCodegenRails
+  #VERSION = '0.0.1' 2018/02/26
+  #VERSION = '0.0.12' #2018/02/27
+  VERSION = '0.1.01' #2018/02/28
+end

data/lib/tasks/swagger_codegen_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :swagger_codegen_rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: swagger_codegen_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.01
+platform: ruby
+authors:
+- Akifumi Tomiyama
+- technobrain
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: swagger-blocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: swagger_ui_engine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: ammeter
+  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: byebug
+  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-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: SWAGGER generator for rails APIs working with swagger_ui_engine and swagger-block.
+email:
+- akifumi_tomiyama@tbn.co.jp
+- techno.rb@tbn.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/swagger.rb
+- lib/generators/swagger/add/add_generator.rb
+- lib/generators/swagger/add/templates/_swagger.rb.tt
+- lib/generators/swagger/init/init_generator.rb
+- lib/generators/swagger/init/templates/_swagger_controller.rb.tt
+- lib/generators/swagger/install/install_generator.rb
+- lib/generators/swagger/install/templates/_initializer.rb.tt
+- lib/generators/swagger/install/templates/_swagger_ui_initializer.rb.tt
+- lib/swagger_codegen_rails.rb
+- lib/swagger_codegen_rails/configuration.rb
+- lib/swagger_codegen_rails/defaults.rb
+- lib/swagger_codegen_rails/namespace.rb
+- lib/swagger_codegen_rails/parameter.rb
+- lib/swagger_codegen_rails/parser.rb
+- lib/swagger_codegen_rails/version.rb
+- lib/tasks/swagger_codegen_rails_tasks.rake
+homepage: https://github.com/technobrain/swagger_codegen_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.6.14
+signing_key: 
+specification_version: 4
+summary: Generator for swagger-blocks and swagger_ui_engine
+test_files: []