swagger_docs_generator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6671b4df077b9fb55feda1f126ee870194a31bd6
+  data.tar.gz: 31a02536ca38fc3c076c1c77af0a6d9634a1a045
+SHA512:
+  metadata.gz: 972e8e0407cd1b40c3121f46abd3ddb3434a77c330cbab22aef9304248a7a47b19471ee39443cfe0b4cbd8031703cb5f943c375e5df4f7c083b2d43bb94b59d7
+  data.tar.gz: 151b024e6714eac2b4a323865e8891a08c1b11af978bddbcef5c385e7c3367304cf8439ab891df255fe30dd990e324e328b51fb02aecf6fe3d18bf0ae543ce6c

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in swagger-docs-generator.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2016 VAILLANT Jeremy
+
+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,36 @@
+# Swagger::Docs::Generator
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/swagger/docs/generator`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'swagger-docs-generator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install swagger-docs-generator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/swagger-docs-generator. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/generators/swagger_docs_generator/initializer_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  # # Generator Rails
+  #
+  # Create a initializer for rails application
+  class InitializerGenerator < Rails::Generators::Base
+    desc 'Generate a initializer for Swagger Docs Generator'
+    INITIALIZER = <<-INIT
+# frozen_string_literal: true
+
+SwaggerDocsGenerator.configure do |config|
+  config.swagger = '2.2.4'
+  config.base_path = '/'
+  config.host = 'localhost:3000'
+end
+
+SwaggerDocsGenerator.configure_info do |info|
+  info.title = 'API example.com'
+  info.version = '1.0.0'
+end
+    INIT
+
+    # Create initializer
+    def copy_initializer
+      initializer 'swagger_docs_generator.rb', INITIALIZER
+    end
+  end
+end

data/lib/swagger_docs_generator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+# Information for this gem
+require 'swagger_docs_generator/info'
+
+# Class configuration
+require 'swagger_docs_generator/configuration/configuration'
+require 'swagger_docs_generator/configuration/configuration_info'
+
+# Modules methods in a controller
+require 'swagger_docs_generator/methods'
+require 'swagger_docs_generator/parser/parser'
+
+# Extractor verb
+require 'swagger_docs_generator/extractor'
+
+# Generator for swagger json file
+require 'swagger_docs_generator/generator'
+require 'swagger_docs_generator/metadata/metadata'
+
+# Tasks
+require 'swagger_docs_generator/railtie' if defined?(Rails)

data/lib/swagger_docs_generator/configuration/configuration.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# :reek:Attribute
+module SwaggerDocsGenerator
+  # # Configuration to swagger json file
+  #
+  # This class it's a DSL class. For customize default json file.
+  #
+  # @example
+  #   SwaggerDocsGenerator.configure do |config|
+  #     config.swagger = '2.0.0'
+  #   end
+  #
+  #   SwaggerDocsGenerator.config
+  #   => #<SwaggerDocsGenerator::Configuration:0x007f8ae49138d8
+  #    @swagger='2.0.0'>
+  #
+  # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
+  class Configuration
+    attr_accessor :swagger, :base_path, :schemes, :consumes, :produces,
+                  :host, :paths, :definitions, :security_definitions,
+                  :security, :tags, :external_docs
+
+    SWAGGER = '2.0'
+
+    # Initalize default value (and requried) for json swagger file
+    def initialize
+      @swagger = SWAGGER
+    end
+  end
+
+  class << self
+    def configure
+      block_given? ? yield(config) : config
+    end
+
+    def config
+      @config ||= Configuration.new
+    end
+  end
+end

data/lib/swagger_docs_generator/configuration/configuration_info.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# :reek:Attribute
+module SwaggerDocsGenerator
+  # # Information element
+  #
+  # Create a Hash element for information to API doc.
+  #
+  # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#info-object
+  class ConfigurationInfo
+    attr_accessor :title, :description, :terms_of_service, :contact, :license,
+                  :version
+
+    TITLE = 'Title Example API'
+    VERSION = '1.0.0'
+
+    # Initialize required element
+    def initialize
+      @title = TITLE
+      @version = VERSION
+    end
+  end
+
+  class << self
+    def configure_info
+      block_given? ? yield(info) : info
+    end
+
+    def info
+      @info ||= ConfigurationInfo.new
+    end
+  end
+end

data/lib/swagger_docs_generator/extractor.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  # # Extractor routes info
+  #
+  # Give information about routes
+  class Extractor
+    def initialize(controller, action)
+      @action = action
+      @controller = controller
+      @routes = Rails.application.routes.routes
+    end
+
+    def verb
+      router do |route|
+        route.verb.source.to_s.delete('$' + '^')
+      end
+    end
+
+    def path
+      router do |route|
+        route.path.spec.to_s.gsub('(.:format)', '.json').gsub(':id', '{id}')
+      end
+    end
+
+    private
+
+    def rte_controller(rte)
+      rte[:controller].eql?(controller_name)
+    end
+
+    def rte_action(rte)
+      rte[:action].eql?(@action.to_s)
+    end
+
+    def controller_name
+      @controller.controller_name
+    end
+
+    def router
+      data = nil
+      @routes.map do |route|
+        rte = route.defaults
+        data = yield(route, rte) if rte_controller(rte) && rte_action(rte)
+      end
+      data.downcase
+    end
+  end
+end

data/lib/swagger_docs_generator/generator.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module SwaggerDocsGenerator
+  # # Generate JSON file
+  #
+  # Create a json file for swagger-ui service
+  #
+  # @!attribute [r] swagger_file
+  #   @return [String] the swagger file name with path
+  class Generator
+    attr_reader :swagger_file
+
+    def initialize
+      @file = 'swagger.json'
+      @path = File.join(Dir.pwd, '/public')
+      @swagger_file = File.join(@path, @file)
+    end
+
+    # Open or create a swagger.json file
+    def generate_swagger_file
+      delete_file_before
+      create_version_folder
+      File.open(@swagger_file, 'a+') { |file| file.puts agregate_metadata }
+    end
+
+    # Delete files temporary
+    def delete_emporary_files
+      version = File.join(@path, SwaggerDocsGenerator.configure_info.version)
+      Dir.delete(File.join(@path, version))
+    end
+
+    private
+
+    attr_reader :meta
+
+    def delete_file_before
+      File.delete(@swagger_file) if File.exist?(@swagger_file)
+    end
+
+    def create_version_folder
+      version = File.join(@path, SwaggerDocsGenerator.configure_info.version)
+      FileUtils.mkdir_p(version) unless File.directory?(version)
+    end
+
+    # :reek:UtilityFunction
+    def write_in_swagger_file
+      hash = {}
+      hash.merge!(MetadataConfiguration.new.construct_swagger_file)
+      hash.merge!(MetadataInfo.new.construct_swagger_file)
+      hash.merge!(MetadataPath.new.construct_swagger_file)
+      hash.merge!(MetadataTag.new.construct_swagger_file)
+    end
+
+    def agregate_metadata
+      case defined?(Rails) && Rails.env
+      when 'production' || 'test'
+        write_in_swagger_file.to_json
+      else
+        JSON.pretty_generate write_in_swagger_file
+      end
+    end
+  end
+end

data/lib/swagger_docs_generator/info.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# :reek:TooManyConstants
+module SwaggerDocsGenerator
+  # Name to gem
+  GEM =           'swagger_docs_generator'
+  # Version to gem
+  VERSION =       '0.1.0'
+  # Authors contributed to gem
+  AUTHORS =       ['VAILLANT Jeremy'].freeze
+  # Email to ahuthors
+  EMAILS =        ['jeremy@dazzl.tv'].freeze
+  # Short description
+  SUMMARY =       'Swagger UI json file'
+  # Describe gem
+  DESCRIPTION =   'Generates swagger-ui json file for rails-api'
+  # Homepage
+  HOMEPAGE =      'https://github.com/Dev-Crea/swagger-docs-generator'
+  # License
+  LICENSE =       'MIT'
+end

data/lib/swagger_docs_generator/metadata/configuration.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  # # Metadata generated
+  #
+  # Generate metadata for block schema in swagger specification
+  #
+  # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#schema
+  class MetadataConfiguration < Metadata
+    def initialize
+      @config = SwaggerDocsGenerator.configure
+    end
+
+    protected
+
+    def swagger
+      { swagger: @config.swagger }
+    end
+
+    def base_path
+      { basePath: @config.base_path }
+    end
+
+    def schemes
+      { schemes: @config.schemes }
+    end
+
+    def host
+      { host: @config.host }
+    end
+
+    def definitions
+      { definitions: @config.definitions }
+    end
+
+    def external_docs
+      { externalDocs: @config.external_docs }
+    end
+
+    def security
+      { security: @config.security }
+    end
+  end
+end

data/lib/swagger_docs_generator/metadata/controller.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module SwaggerDocsGenerator
+  # # Metadata generated
+  #
+  # @abstract
+  #   Abstract class for metadata provide to controlloer in Rails application
+  class MetadataController < Metadata
+    def initialize
+      # Reload all controller before parsing
+      Rails.application.eager_load!
+      @path = File.join(Dir.pwd, 'public',
+                        SwaggerDocsGenerator.configure_info.version)
+      @controllers = ApplicationController.subclasses
+    end
+
+    private
+
+    attr_accessor :controllers, :path
+  end
+end
+
+require 'swagger_docs_generator/metadata/path'
+require 'swagger_docs_generator/metadata/tag'

data/lib/swagger_docs_generator/metadata/info.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  # # Metadata generated
+  #
+  # Generate metadata for block info in swagger specification
+  #
+  # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#info-object
+  class MetadataInfo < Metadata
+    def initialize
+      @config = SwaggerDocsGenerator.configure_info
+    end
+
+    def construct_swagger_file
+      { info: super }
+    end
+
+    protected
+
+    def title
+      { title: @config.title }
+    end
+
+    def version
+      { version: @config.version }
+    end
+
+    def description
+      { description: @config.description }
+    end
+
+    def terms_of_service
+      { terms_of_service: @config.terms_of_service }
+    end
+
+    def contact
+      { contact: @config.contact }
+    end
+
+    def license
+      { license: @config.license }
+    end
+  end
+end

data/lib/swagger_docs_generator/metadata/metadata.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  # # Metadata generated
+  #
+  # Metadata generated in swagger json file
+  class Metadata
+    def initialize
+      @config = nil
+    end
+
+    def construct_swagger_file
+      hash = {}
+      self.class.protected_instance_methods.each do |method|
+        hash.merge!(send(method)) unless @config.send(method).blank?
+      end
+      hash
+    end
+
+    private
+
+    attr_reader :config
+  end
+end
+
+require 'swagger_docs_generator/metadata/configuration'
+require 'swagger_docs_generator/metadata/info'
+require 'swagger_docs_generator/metadata/controller'

data/lib/swagger_docs_generator/metadata/path.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  # # Metadata generated
+  #
+  # Generate metadata for block paths in swagger specification
+  #
+  # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#pathsObject
+  class MetadataPath < MetadataController
+    def initialize
+      super
+    end
+
+    # Each controller parsed
+    def construct_swagger_file
+      hash = {}
+      controllers.each do |controller|
+        file = File.join(path, "#{controller.controller_name}.json")
+        hash.merge!(JSON.parse(File.read(file))['paths']) if File.exist?(file)
+      end
+      { paths: hash }
+    end
+  end
+end

data/lib/swagger_docs_generator/metadata/tag.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  # # Metadata generated
+  #
+  # Generate metadata for block tag in swagger specification
+  #
+  # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#tagObject
+  class MetadataTag < MetadataController
+    def initialize
+      super
+    end
+
+    # Create tag
+    def construct_swagger_file
+      array = []
+      controllers.each do |controller|
+        file = File.join(path, "#{controller.controller_name}.json")
+        array.push(JSON.parse(File.read(file))['tags']) if File.exist?(file)
+      end
+      { tags: array }
+    end
+  end
+end

data/lib/swagger_docs_generator/methods.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# :reek:UtilityFunction
+module SwaggerDocsGenerator
+  # # Methods for controller
+  #
+  # Methods adding to controller parsing in rails appliation
+  module Methods
+    # Create json file for controller
+    def swagger_controller(controller, description)
+      parse = ParserController.new(controller, description)
+      parse.adding_tag
+    end
+
+    # Complete json file with datas to method and controller, controller reading
+    def swagger_doc(controller, action, data = {})
+      parse = ParserAction.new(controller, action, data)
+      parse.adding_path
+    end
+  end
+end

data/lib/swagger_docs_generator/parser/action.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'swagger_docs_generator/parser/actions/actions'
+
+module SwaggerDocsGenerator
+  # # Parse action in controller classe to Rails application. It's adding
+  # paths to swagger docs file.
+  class ParserAction < Parser
+    def initialize(controller, action, data)
+      super(controller)
+      @action = action
+      @data = data
+    end
+
+    def adding_path
+      json = JSON.parse(File.read(controller_file))
+      File.open(controller_file, 'w') do |file|
+        path_exist(json, construct_routes)
+        file.puts(JSON.pretty_generate(json))
+      end
+    end
+
+    private
+
+    # :reek:UtilityFunction
+    def path_exist(json, hash)
+      old_route = json['paths']
+
+      keys_new = hash.keys[0]
+      keys_old = old_route.keys[0]
+
+      if keys_new.to_s.eql?(keys_old.to_s)
+        old_route[keys_old].merge!(hash[keys_new])
+      else
+        old_route.merge!(hash)
+      end
+    end
+
+    def construct_routes
+      extract = Extractor.new(controller, @action)
+      verb = extract.verb
+      path = extract.path
+      verb.eql?('put') ? route_update(path, verb) : route(path, verb)
+    end
+
+    def super_hash
+      hash = {}
+      SwaggerDocsGenerator::Actions::Actions.descendants.each do |klass|
+        hash.merge!(klass.new(expect_tag(klass)).hash)
+      end
+      hash
+    end
+
+    def expect_tag(klass)
+      klass.eql?(Actions::Tags) ? controller_name : @data
+    end
+
+    def route(path, verb)
+      { "#{path}": { "#{verb}": super_hash } }
+    end
+
+    def route_update(path, verb)
+      { "#{path}": { "#{verb}": super_hash }.merge!(patch: super_hash) }
+    end
+  end
+end

data/lib/swagger_docs_generator/parser/actions/actions.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  module Actions
+    # # Test value in actions
+    #
+    # @abstract classes for all actions class
+    # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#operation-object
+    class Actions
+      attr_reader :hash, :key
+
+      def initialize(key)
+        @key = key
+        @hash = { @key => {} }
+      end
+
+      def hash
+        @hash[@key] ? @hash : {}
+      end
+
+      # List to all childrens
+      def self.descendants
+        ObjectSpace.each_object(Class).select { |klass| klass < self }
+      end
+
+      private
+
+      def complete_hash(data)
+        raw ||= data[@key]
+        @hash[@key] = raw
+      end
+    end
+  end
+end
+
+require 'swagger_docs_generator/parser/actions/tags'
+require 'swagger_docs_generator/parser/actions/summary'
+require 'swagger_docs_generator/parser/actions/description'
+require 'swagger_docs_generator/parser/actions/response'
+require 'swagger_docs_generator/parser/actions/consumes'
+require 'swagger_docs_generator/parser/actions/produces'
+require 'swagger_docs_generator/parser/actions/parameters'

data/lib/swagger_docs_generator/parser/actions/consumes.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  module Actions
+    # # Test :consumes
+    #
+    # Complete consume field for action
+    class Consumes < Actions
+      VALUE = :consumes
+
+      def initialize(data)
+        super(VALUE)
+        complete_hash(data)
+      end
+
+      private
+
+      def complete_hash(data)
+        default = ['application/json']
+        raw = data.key?(key) ? data[key] : default
+        hash[key] = raw
+      end
+    end
+  end
+end

data/lib/swagger_docs_generator/parser/actions/description.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  module Actions
+    # # Test :description
+    #
+    # Complete description field for action
+    class Description < Actions
+      VALUE = :description
+
+      def initialize(data)
+        super(VALUE)
+        complete_hash(data)
+      end
+    end
+  end
+end

data/lib/swagger_docs_generator/parser/actions/parameters.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  module Actions
+    # # Test :parameters
+    #
+    # Complete parameters field for action
+    class Parameters < Actions
+      VALUE = :parameters
+
+      def initialize(data)
+        super(VALUE)
+        complete_hash(data)
+      end
+    end
+  end
+end

data/lib/swagger_docs_generator/parser/actions/produces.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  module Actions
+    # # Test :produces
+    #
+    # Complete consume field for action
+    class Produces < Actions
+      VALUE = :produces
+
+      def initialize(data)
+        super(VALUE)
+        complete_hash(data)
+      end
+
+      private
+
+      def complete_hash(data)
+        default = ['application/json']
+        raw = data.key?(key) ? data[key] : default
+        hash[key] = raw
+      end
+    end
+  end
+end

data/lib/swagger_docs_generator/parser/actions/response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  module Actions
+    # # Test :response
+    #
+    # Complete description field for action
+    class Response < Actions
+      VALUE = :responses
+
+      def initialize(data)
+        super(VALUE)
+        complete_hash(data)
+      end
+
+      private
+
+      def complete_hash(data)
+        default = { ok: { description: 'Request successfully processed.' } }
+        raw = data.key?(key) ? data[key] : default
+        hash[key] = raw
+      end
+    end
+  end
+end

data/lib/swagger_docs_generator/parser/actions/summary.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  module Actions
+    # # Test :summary
+    #
+    # Complete summary field for action
+    class Summary < Actions
+      VALUE = :summary
+
+      def initialize(data)
+        super(VALUE)
+        complete_hash(data)
+      end
+    end
+  end
+end

data/lib/swagger_docs_generator/parser/actions/tags.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  module Actions
+    # # Test :tags
+    #
+    # Complete tags field for action
+    class Tags < Actions
+      VALUE = :tags
+
+      def initialize(data)
+        super(VALUE)
+        complete_hash(data)
+      end
+
+      private
+
+      def complete_hash(data)
+        hash[key] = [data]
+      end
+    end
+  end
+end

data/lib/swagger_docs_generator/parser/controller.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  # # Parse Controller classes
+  #
+  # Parse controller classes in Rails application. It's create temporary file
+  # and adding automaticaly tags element.
+  class ParserController < Parser
+    def initialize(controller, description)
+      super(controller)
+      prepare_file
+      @description = description
+    end
+
+    def adding_tag
+      json = JSON.parse(File.read(controller_file))
+      File.open(controller_file, 'w') do |file|
+        hash = construct_tags(@description)
+        json['tags'].merge!(hash)
+        file.puts(JSON.pretty_generate(json))
+      end
+    end
+
+    private
+
+    def prepare_file
+      delete_file
+      base_file = { paths: {}, tags: {} }
+      File.open(controller_file, 'a+') { |file| file.puts(base_file.to_json) }
+    end
+
+    def delete_file
+      File.delete(controller_file) if File.exist?(controller_file)
+    end
+
+    def construct_tags(description)
+      { name: controller_name, description: description }
+    end
+  end
+end

data/lib/swagger_docs_generator/parser/parser.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  # # Parse classes
+  #
+  # @abstract Classes for parsing Rails classes
+  #
+  # @!attribute [r] controller
+  #   It's a name of controller parsed
+  # @!attribute [r] path
+  #   It's a path to temporary file
+  # @!attribute [r] version
+  #   It's a version to API documentation parsed
+  class Parser
+    attr_reader :controller, :path, :version
+
+    def initialize(controller)
+      @controller = controller
+      @path = File.join(Dir.pwd, 'public')
+      @version = SwaggerDocsGenerator.configure_info.version
+    end
+
+    def controller_file
+      File.join(@path, @version, "#{controller_name}.json")
+    end
+
+    private
+
+    def controller_name
+      @controller.controller_name
+    end
+  end
+end
+
+require 'swagger_docs_generator/parser/controller'
+require 'swagger_docs_generator/parser/action'

data/lib/swagger_docs_generator/railtie.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module SwaggerDocsGenerator
+  # # Rake action
+  #
+  # Create an action for rails apps and executed with rake
+  class Railtie < Rails::Railtie
+    railtie_name :swagger
+
+    rake_tasks do
+      tasks = File.join(File.dirname(__FILE__), '../tasks', '*.rake')
+      Dir[tasks].each { |file_task| load file_task }
+    end
+  end
+end

data/lib/tasks/swagger.rake

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+namespace :swagger do
+  desc 'Generate Swagger Documentation files'
+  task docs: :environment do
+    puts 'Create Swagger File in public/swagger.json'
+    SwaggerDocsGenerator::Generator.new.generate_swagger_file
+  end
+end

metadata

@@ -0,0 +1,207 @@
+--- !ruby/object:Gem::Specification
+name: swagger_docs_generator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- VAILLANT Jeremy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.34.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.34.2
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.42.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.42.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: json-schema-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+description: Generates swagger-ui json file for rails-api
+email:
+- jeremy@dazzl.tv
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/swagger_docs_generator/initializer_generator.rb
+- lib/swagger_docs_generator.rb
+- lib/swagger_docs_generator/configuration/configuration.rb
+- lib/swagger_docs_generator/configuration/configuration_info.rb
+- lib/swagger_docs_generator/extractor.rb
+- lib/swagger_docs_generator/generator.rb
+- lib/swagger_docs_generator/info.rb
+- lib/swagger_docs_generator/metadata/configuration.rb
+- lib/swagger_docs_generator/metadata/controller.rb
+- lib/swagger_docs_generator/metadata/info.rb
+- lib/swagger_docs_generator/metadata/metadata.rb
+- lib/swagger_docs_generator/metadata/path.rb
+- lib/swagger_docs_generator/metadata/tag.rb
+- lib/swagger_docs_generator/methods.rb
+- lib/swagger_docs_generator/parser/action.rb
+- lib/swagger_docs_generator/parser/actions/actions.rb
+- lib/swagger_docs_generator/parser/actions/consumes.rb
+- lib/swagger_docs_generator/parser/actions/description.rb
+- lib/swagger_docs_generator/parser/actions/parameters.rb
+- lib/swagger_docs_generator/parser/actions/produces.rb
+- lib/swagger_docs_generator/parser/actions/response.rb
+- lib/swagger_docs_generator/parser/actions/summary.rb
+- lib/swagger_docs_generator/parser/actions/tags.rb
+- lib/swagger_docs_generator/parser/controller.rb
+- lib/swagger_docs_generator/parser/parser.rb
+- lib/swagger_docs_generator/railtie.rb
+- lib/tasks/swagger.rake
+homepage: https://github.com/Dev-Crea/swagger-docs-generator
+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: Swagger UI json file
+test_files: []