swagger_docs_generator 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 88cb5ca367ad15e76eb3c350fd799a9463b14ebd
-  data.tar.gz: 7fe85ae4081c3e680a69c66c36b4b8833c359a07
+  metadata.gz: 6c5734093ec6f9cbab3b957e7a2a6d90b0d780ae
+  data.tar.gz: 96a39e44e18eadde0f0e0a530c41437d84f00e71
 SHA512:
-  metadata.gz: 433a1104b08265a7bbd596243523a6dac7bd19ae48f872821f3bd70892fffa547743fa071f1c367464655b87f7effc60dbee2293f3603f456ebcba287e3d326c
-  data.tar.gz: d1dda1c6e3d952e331d09a58dcca9c5750ebf49b2a753892ce4fc7602b5551a6596c66029e1170c6fec3faa73c11387a1cb896978c0170a64d2610072721f918
+  metadata.gz: 00cf5fbd1e2fa923f38f64ef2c8ddd15f3d148682b1967b8d99aa7f6876ab395db61049e5088281b5ba192a89877f996e5a06c7c6a48c50edee01f33573f4127
+  data.tar.gz: 4b8db2dddcc67381a419f5bf84dc54cf32e71253914b6953df2df56ba78a793471b33c926d39d267c241bf700d5e1619feadfc539a0597509871ceb9da6b1d51

data/lib/swagger_docs_generator/generator.rb

@@ -11,10 +11,10 @@ module SwaggerDocsGenerator
     attr_reader :swagger_file
 
     def initialize
+      @hash = {}
       @file = 'swagger.json'
-      @path = File.join(Dir.pwd, '/public')
-      @swagger_file = File.join(@path, @file)
-      @version = File.join(@path, SwaggerDocsGenerator.configure_info.version)
+      @swagger_file = File.join(path, @file)
+      @version = File.join(path, SwaggerDocsGenerator.configure_info.version)
       create_version_folder
     end
 
@@ -25,14 +25,20 @@ module SwaggerDocsGenerator
     end
 
     # Delete files temporary
+    # @todo necessary ?
     def delete_temporary_files
-      FileUtils.rm_rf(@version)
+      # FileUtils.rm_rf(@version)
     end
 
     private
 
     attr_reader :meta
 
+    # :reek:UtilityFunction
+    def path
+      File.join(Dir.pwd, '/public')
+    end
+
     def delete_file_before
       File.delete(@swagger_file) if File.exist?(@swagger_file)
     end
@@ -41,13 +47,24 @@ module SwaggerDocsGenerator
       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)
+      write_in_swagger_file_configurations
+      write_in_swagger_file_controllers
+      write_in_swagger_file_models
+    end
+
+    def write_in_swagger_file_configurations
+      @hash.merge!(MetadataConfiguration.new.construct_swagger_file)
+      @hash.merge!(MetadataInfo.new.construct_swagger_file)
+    end
+
+    def write_in_swagger_file_controllers
+      @hash.merge!(MetadataPath.new.construct_swagger_file)
+      @hash.merge!(MetadataTag.new.construct_swagger_file)
+    end
+
+    def write_in_swagger_file_models
+      @hash.merge!(MetadataDefinition.new.construct_swagger_file)
     end
 
     def agregate_metadata

data/lib/swagger_docs_generator/info.rb

@@ -5,7 +5,7 @@ module SwaggerDocsGenerator
   # Name to gem
   GEM =           'swagger_docs_generator'
   # Version to gem
-  VERSION =       '0.1.1'
+  VERSION =       '0.1.2'
   # Authors contributed to gem
   AUTHORS =       ['VAILLANT Jeremy'].freeze
   # Email to ahuthors

data/lib/swagger_docs_generator/metadata/controller.rb

@@ -7,8 +7,8 @@ module SwaggerDocsGenerator
   #   Abstract class for metadata provide to controlloer in Rails application
   class MetadataController < Metadata
     def initialize
-      @path = File.join(Dir.pwd, 'public',
-                        SwaggerDocsGenerator.configure_info.version)
+      @file_path = File.join(Dir.pwd, 'public',
+                             SwaggerDocsGenerator.configure_info.version)
       conf = SwaggerDocsGenerator.configure.base_controller
       @controllers = if conf.is_a?(String)
                        ApplicationController.subclasses
@@ -19,9 +19,10 @@ module SwaggerDocsGenerator
 
     private
 
-    attr_accessor :controllers, :path
+    attr_accessor :controllers, :file_path
   end
 end
 
 require 'swagger_docs_generator/metadata/path'
 require 'swagger_docs_generator/metadata/tag'
+require 'swagger_docs_generator/metadata/definition'

data/lib/swagger_docs_generator/metadata/definition.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'swagger_docs_generator/parser/model'
+
+module SwaggerDocsGenerator
+  # # Metadata generated
+  #
+  # Generate metadata for block definition in swagger file
+  #
+  # @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#definitions-object
+  class MetadataDefinition < MetadataController
+    def initialize
+      super
+      @model = nil
+    end
+
+    def construct_swagger_file
+      { definitions: find_models }
+    end
+
+    private
+
+    # :reek:NilCheck
+    def find_models
+      hash = {}
+      controllers.each do |controller|
+        data = each_controller(controller)
+        hash.merge!(data) unless data.nil?
+      end
+      hash
+    end
+
+    def each_controller(controller)
+      @model = Model.new(controller)
+      contruct_hash
+    rescue NameError => message
+      puts "Error model name : #{message.name}"
+    end
+
+    def contruct_hash
+      {
+        @model.name => {
+          type: 'object',
+          properties: @model.attribute_properties
+        }
+      }
+    end
+  end
+end

data/lib/swagger_docs_generator/metadata/metadata.rb

@@ -5,6 +5,9 @@ module SwaggerDocsGenerator
   #
   # Metadata generated in swagger json file
   class Metadata
+    ACCEPT = %i(title version contact description host schemes base_path
+                swagger).freeze
+
     def initialize
       @config = nil
     end
@@ -12,7 +15,9 @@ module SwaggerDocsGenerator
     def construct_swagger_file
       hash = {}
       self.class.protected_instance_methods.each do |method|
-        hash.merge!(send(method)) unless @config.send(method).blank?
+        if ACCEPT.include?(method) || method.is_a?(Hash)
+          hash.merge!(send(method)) unless @config.send(method).blank?
+        end
       end
       hash
     end

data/lib/swagger_docs_generator/metadata/path.rb

@@ -15,7 +15,7 @@ module SwaggerDocsGenerator
     def construct_swagger_file
       hash = {}
       controllers.each do |controller|
-        file = File.join(path, "#{controller.controller_name}.json")
+        file = File.join(file_path, "#{controller.controller_name}.json")
         hash.merge!(JSON.parse(File.read(file))['paths']) if File.exist?(file)
       end
       { paths: hash }

data/lib/swagger_docs_generator/metadata/tag.rb

@@ -15,7 +15,7 @@ module SwaggerDocsGenerator
     def construct_swagger_file
       array = []
       controllers.each do |controller|
-        file = File.join(path, "#{controller.controller_name}.json")
+        file = File.join(file_path, "#{controller.controller_name}.json")
         array.push(JSON.parse(File.read(file))['tags']) if File.exist?(file)
       end
       { tags: array }

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

@@ -39,4 +39,5 @@ 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/deprecated'
 require 'swagger_docs_generator/parser/actions/parameters'

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

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

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# :reek:UtilityFunction
 module SwaggerDocsGenerator
   module Actions
     # # Test :parameters
@@ -10,7 +11,80 @@ module SwaggerDocsGenerator
 
       def initialize(data)
         super(VALUE)
-        complete_hash(data)
+        complete_hash(data) if data[VALUE].present?
+      end
+
+      private
+
+      # name:             0
+      # in:               1 -- [query, header, path, formData, body]
+      # description:      2
+      # type: || schema:  3 -- [string, number, integer, boolean, array, file]
+      # required:         4
+      # other:            5
+      def complete_hash(data)
+        all_parameters = []
+        raw ||= data[key]
+        raw.each do |parameter|
+          all_parameters.push(write_param(parameter))
+        end
+        hash[key] = all_parameters
+      end
+
+      def write_param(param)
+        hash = case param_in(param)
+               when 'body'
+                 body(param)
+               else
+                 classic(param)
+               end
+        type_or_schema = param[5]
+        hash.merge!(type_or_schema) if type_or_schema.present?
+        hash
+      end
+
+      def classic(param)
+        {
+          name: param_name(param),
+          in: param_in(param),
+          description: param_description(param),
+          type: param_type(param),
+          required: param_required(param)
+        }
+      end
+
+      def body(param)
+        {
+          name: param_name(param),
+          in: param_in(param),
+          description: param_description(param),
+          schema: { '$ref': param_schema(param) },
+          required: param_required(param)
+        }
+      end
+
+      def param_name(param)
+        param[0].to_s
+      end
+
+      def param_in(param)
+        param[1].to_s.camelize(:lower)
+      end
+
+      def param_description(param)
+        param[2].humanize
+      end
+
+      def param_type(param)
+        param[3]
+      end
+
+      def param_required(param)
+        param[4] || false
+      end
+
+      def param_schema(param)
+        param[3]
       end
     end
   end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+# :reek:UtilityFunction
+
 module SwaggerDocsGenerator
   module Actions
     # # Test :response
@@ -16,9 +18,61 @@ module SwaggerDocsGenerator
       private
 
       def complete_hash(data)
-        default = { ok: { description: 'Request successfully processed.' } }
-        raw = data.key?(key) ? data[key] : default
-        hash[key] = raw
+        raw = data[key]
+        hash[key] = raw.present? ? each_response(raw) : no_response
+      end
+
+      def each_response(raw)
+        sh = {}
+        raw.each do |code|
+          case code
+          when Array
+            sh.merge!(one_response_with_schema(code))
+          when Integer
+            sh.merge!(one_response(code))
+          end
+        end
+        sh
+      end
+
+      def no_response
+        one_response(200)
+      end
+
+      def one_response(code)
+        response = ActionDispatch::Response.new(code)
+        { response.code => { description: response.message } }
+      end
+
+      # :reek:FeatureEnvy
+      def one_response_with_schema(code)
+        key = code[0]
+        response = ActionDispatch::Response.new(key)
+        {
+          response.code => {
+            'description' => response.message,
+            'schema' => type_or_not(code)
+          }
+        }
+      end
+
+      def type_or_not(code)
+        code.length.eql?(3) ? include_type(code) : no_type(code)
+      end
+
+      def include_type(code)
+        {
+          'type' => code[1],
+          'items' => {
+            '$ref' => code[2]
+          }
+        }
+      end
+
+      def no_type(code)
+        {
+          '$ref' => code[1]
+        }
       end
     end
   end

data/lib/swagger_docs_generator/parser/model.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'swagger_docs_generator/parser/models/mongo'
+require 'swagger_docs_generator/parser/models/active_record'
+
+module SwaggerDocsGenerator
+  # Parser models
+  class Model
+    attr_reader :name
+
+    def initialize(controller)
+      @name = controller.controller_name.singularize.camelize
+      @orm = if defined?(Mongoid)
+               ModelMongo.new(name)
+             else
+               ModelActiveRecord.new(name)
+             end
+    end
+
+    def attribute_properties
+      @orm.attribute_properties
+    end
+  end
+end

data/lib/swagger_docs_generator/parser/models/active_record.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+# rubocop:disable Lint/Eval
+module SwaggerDocsGenerator
+  # # Parse Active Record model
+  class ModelActiveRecord
+    NAME = :active_record
+    TYPES = {
+      'binary' =>       { type: 'string', format: 'binary' },
+      'boolean' =>      { type: 'boolean' },
+      'date' =>         { type: 'string', format: 'date' },
+      'datetime' =>     { type: 'string', format: 'date-time' },
+      'decimal' =>      { type: 'number', format: 'double' },
+      'float' =>        { type: 'number', format: 'float' },
+      'integer' =>      { type: 'integer', format: 'int32' },
+      'bigint' =>       { type: 'integer', format: 'int64' },
+      'primary_key' =>  { type: 'integer', format: 'int32' },
+      'references' =>   { type: 'integer', format: 'int32' },
+      'string' =>       { type: 'string' },
+      'text' =>         { type: 'string' },
+      'time' =>         { type: 'string', format: 'date-time' },
+      'timestamp' =>    { type: 'string', format: 'date-time' }
+    }.freeze
+
+    def initialize(model)
+      @model = eval(model)
+    end
+
+    def attribute_properties
+      propertie = {}
+      @model.columns_hash.each do |name, _value|
+        propertie.merge!(attribute_propertie(name))
+      end
+      propertie
+    end
+
+    private
+
+    def attribute_propertie(name)
+      {
+        name => TYPES[@model.columns_hash[name].type.to_s]
+      }
+    end
+  end
+end
+# rubocop:enable Lint/Eval

data/lib/swagger_docs_generator/parser/models/mongo.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# rubocop:disable Lint/Eval
+module SwaggerDocsGenerator
+  # # Parse Mongo model
+  class ModelMongo
+    NAME = :mongo
+    TYPES = {
+      'Array' =>            { type: 'string' },
+      'BigDecimal' =>       { type: 'number', format: 'double' },
+      'Mongoid::Boolean' => { type: 'boolean' },
+      'Date' =>             { type: 'string', format: 'date' },
+      'DateTime' =>         { type: 'string', format: 'date-time' },
+      'Float' =>            { type: 'number', format: 'float' },
+      'Hash' =>             { type: 'string' },
+      'Integer' =>          { type: 'integer', format: 'int64' },
+      'BSON::ObjectId' =>   { type: 'string' },
+      'Object' =>           { type: 'string' },
+      'BSON::Binary' =>     { type: 'string', format: 'binary' },
+      'Range' =>            { type: 'string' },
+      'String' =>           { type: 'string' },
+      'Symbol' =>           { type: 'string' },
+      'Time' =>             { type: 'string', format: 'date-time' },
+      'TimeWithZone' =>     { type: 'string', format: 'date-time' }
+    }.freeze
+
+    def initialize(model)
+      @model = eval(model)
+    end
+
+    def attribute_properties
+      propertie = {}
+      @model.fields.each do |name, _value|
+        propertie.merge!(attribute_propertie(name))
+      end
+      propertie
+    end
+
+    private
+
+    def attribute_propertie(name)
+      {
+        name => TYPES.fetch(@model.fields[name].type.to_s)
+      }
+    end
+  end
+end
+# rubocop:enable Lint/Eval

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagger_docs_generator
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - VAILLANT Jeremy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-05 00:00:00.000000000 Z
+date: 2017-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -162,6 +162,7 @@ files:
 - 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/definition.rb
 - lib/swagger_docs_generator/metadata/info.rb
 - lib/swagger_docs_generator/metadata/metadata.rb
 - lib/swagger_docs_generator/metadata/path.rb
@@ -170,6 +171,7 @@ files:
 - 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/deprecated.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
@@ -177,6 +179,9 @@ files:
 - 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/model.rb
+- lib/swagger_docs_generator/parser/models/active_record.rb
+- lib/swagger_docs_generator/parser/models/mongo.rb
 - lib/swagger_docs_generator/parser/parser.rb
 - lib/swagger_docs_generator/railtie.rb
 - lib/tasks/swagger.rake