swagger_api 0.1.43

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/swagger_api.rb

@@ -0,0 +1,123 @@
+require 'swagger_api/version'
+require 'rails'
+
+module SwaggerApi
+  class Generator
+    def prettify
+      JSON.pretty_generate(JSON.parse(json))
+    end
+
+    def json
+      create.to_json
+    end
+
+    def create
+      @config ||= {
+        openapi: '3.0.0',
+        security: [{api_key: []}],
+        info: info,
+        servers: [{url: server_url}],
+        paths: Paths.new(controllers: config.controllers).create,
+        components: {
+          responses: responses,
+          schemas: Components.new(controllers: config.controllers).create,
+          requestBodies: RequestBodies.new(controllers: config.controllers).create,
+          securitySchemes: security_schemes,
+        },
+      }
+    end
+
+    def config
+      @yaml_config ||= JSON.parse(YAML.load_file("#{Rails.root.to_s}/config/swagger.yml").to_json, object_class: OpenStruct)
+    end
+
+    def security_schemes
+      {
+        api_key: {
+          type: 'apiKey',
+          name: 'Authorization',
+          in: 'header'
+        }
+      }
+    end
+
+    def responses
+      @responses ||= custom_responses || default_responses
+    end
+
+    def custom_responses
+      custom_responses_path = "#{Rails.root.to_s}/config/swagger_custom_responses.json"
+      return unless File.exist?(custom_responses_path)
+      @custom_responses ||= JSON.parse(File.read(custom_responses_path), object_class: OpenStruct)
+    end
+
+    def default_responses
+      {
+        NotFound: {
+          description: "The specified resource was not found",
+          content: {
+            'application/json; charset=utf-8' => {
+              schema: {
+                type: 'string',
+                example: 'Not Found'
+              }
+            }
+          }
+        },
+        Unauthorized: {
+          description: "Unauthorized",
+          content: {
+            'application/json; charset=utf-8' => {
+              schema: {
+                type: 'string',
+                example: 'Not Authorized'
+              }
+            }
+          }
+        },
+        BadRequest: {
+          description: "Bad Request",
+          content: {
+            'application/json; charset=utf-8' => {
+              schema: {
+                example: ['The field name is invalid.', 'The id must be present'],
+                type: 'array',
+                items: {
+                  type: 'string'
+                }
+              }
+            }
+          }
+        }
+      }
+    end
+
+    def info
+      {
+        version: config.info.version,
+        title: config.info.title,
+        description: config.info.description,
+      }
+    end
+
+    def server_url
+      return unless config.server.respond_to?(Rails.env)
+      config.servers.send(Rails.env).url
+    end
+  end
+end
+require 'swagger_api/railtie'
+
+require 'swagger_api/actions'
+require 'swagger_api/concerns/columns'
+require 'swagger_api/column_schema'
+require 'swagger_api/component_schema'
+require 'swagger_api/components'
+require 'swagger_api/operations/base'
+require 'swagger_api/operations/create'
+require 'swagger_api/operations/delete'
+require 'swagger_api/operations/index'
+require 'swagger_api/operations/show'
+require 'swagger_api/operations/update'
+require 'swagger_api/paths'
+require 'swagger_api/request_bodies'

data/lib/swagger_api/actions.rb

@@ -0,0 +1,43 @@
+require 'active_attr'
+
+module SwaggerApi
+  class Actions
+    include ActiveAttr::Model
+
+    validate :validate_actions
+    attr_accessor :controller
+
+
+    def all!
+      raise self.errors.full_messages unless self.valid?
+      return only_actions unless only_actions.blank?
+      defined_actions
+    end
+
+    def defined_actions
+      (restful_actions + controller_actions) - except_actions
+    end
+
+    def controller_actions
+      return [] unless controller.actions.is_a? Array
+      controller.actions
+    end
+
+    def only_actions
+      controller.actions.try(:only) || []
+    end
+
+    def except_actions
+      controller.actions.try(:except) || []
+    end
+
+    def restful_actions
+      %w(index show create update delete)
+    end
+
+    def validate_actions
+      errors.add(:base, "`actions` must include at least one of #{restful_actions}") if restful_actions.blank?
+      errors.add(:base, "`actions` can only include one of #{restful_actions}. #{(defined_actions - restful_actions)} are not allowed") unless (defined_actions - restful_actions).blank?
+    end
+  end
+end

data/lib/swagger_api/column_schema.rb

@@ -0,0 +1,41 @@
+module SwaggerApi
+  class ColumnSchema
+    include ActiveAttr::Model
+    attr_accessor :column
+
+    def create
+      schema = {
+        type: type_from_column,
+        format: format_from_column
+      }
+      schema[:minimum] = 1 if column.type == :integer && column.name.to_s.ends_with?('id')
+      schema[:minimum] = 0 if column.type == :integer && !column.name.to_s.ends_with?('id')
+      schema
+    end
+
+    def type_from_column
+      if %i(datetime date time).include?(column.type)
+        :string
+      elsif %i(float double).include?(column.type)
+        :number
+      else
+        column.type
+      end
+    end
+
+    def format_from_column
+      case column.type
+        when :datetime
+          'date-time'
+        when :integer
+          :int64
+        else
+          if column.name.to_s == 'email'
+            :email
+          else
+            column.type
+          end
+      end
+    end
+  end
+end

data/lib/swagger_api/component_schema.rb

@@ -0,0 +1,50 @@
+module SwaggerApi
+  class ComponentSchema
+    include ActiveAttr::Model
+    include Concerns::Columns
+    attr_accessor :controller
+
+    def create
+      {
+        required: required,
+        properties: properties,
+        type: 'object'
+      }
+    end
+
+    private
+
+    def required
+      controller.try(:columns).try(:required) ||
+      columns.map(&:name) & clean_required_attributes
+    end
+
+    def clean_required_attributes
+      required_attributes.map do |attribute|
+        if model.reflect_on_all_associations(:belongs_to).map(&:name).map(&:to_s).include?(attribute)
+          "#{attribute}_id"
+        else
+          attribute
+        end
+      end.compact.uniq.map(&:to_s)
+    end
+
+    def required_attributes
+      model.validators.map do |validator|
+        validator.attributes if validator.is_a?(ActiveRecord::Validations::PresenceValidator)
+      end.compact.flatten.uniq.map(&:to_s)
+    end
+
+    def properties
+      properties = {}
+      columns.each do |column|
+        properties[column.name] = ColumnSchema.new(column: column).create
+      end
+      properties
+    end
+
+    def model
+      controller.model.constantize
+    end
+  end
+end

data/lib/swagger_api/components.rb

@@ -0,0 +1,24 @@
+module SwaggerApi
+  class Components
+    include ActiveAttr::Model
+    attr_accessor :controllers
+
+    def create
+      return @components unless @components.nil?
+      @components = {}
+      controllers.each do |controller|
+        if controller.custom_model_file.nil?
+          @components[controller.model] = ComponentSchema.new(controller: controller).create
+        else
+          @components.merge!(custom_json(controller.custom_model_file))
+        end
+      end
+      @components
+    end
+
+    def custom_json(custom_model_file)
+      file = File.read(custom_model_file)
+      JSON.parse(file)
+    end
+  end
+end

data/lib/swagger_api/concerns/columns.rb

@@ -0,0 +1,24 @@
+module SwaggerApi
+  module Concerns
+    module Columns
+      extend ActiveSupport::Concern
+
+      included do
+        def columns
+          if controller.columns.try(:only).present?
+            model.columns.select! do |column|
+              controller.columns.only.include?(column.name)
+            end
+          end
+
+          if controller.columns.try(:except).present?
+            model.columns.reject! do |column|
+              controller.columns.except.include?(column.name)
+            end
+          end
+          model.columns
+        end
+      end
+    end
+  end
+end

data/lib/swagger_api/operations/base.rb

@@ -0,0 +1,86 @@
+module SwaggerApi
+  module Operations
+    class Base
+      include ActiveAttr::Model
+      include SwaggerApi::Concerns::Columns
+
+      attr_accessor :controller, :action
+
+      def create
+        {
+          summary: "#{readable_action} #{model_name}",
+          description: "#{readable_action} #{model_name.downcase}'s information",
+          parameters: parameters,
+          responses: responses,
+          tags: [model_name],
+        }
+      end
+
+      def parameters
+        [
+          {
+            name: 'id',
+            in: 'path',
+            description: "ID of #{model_name}",
+            required: true,
+            schema: {
+              type: :integer,
+              format: :int64,
+              minimum: 1
+            },
+          }
+        ]
+      end
+
+      def responses
+        return @responses unless @responses.nil?
+        @responses = success_response
+        error_responses.each do |error_response|
+          @responses.merge!(error_response)
+        end
+        @responses
+      end
+
+      def success_response
+        {
+          '200' => {
+            description: "#{readable_action} #{model_name.downcase}'s information",
+            content: {
+              'application/json; charset=utf-8' => {
+                schema: {
+                  '$ref' => "#/components/schemas/#{model_name}"
+                }
+              }
+            }
+          }
+        }
+      end
+
+      def error_responses
+        [
+          {
+            '404' => { '$ref' => '#/components/responses/NotFound' }
+          },
+          {
+            '401' => { '$ref' => '#/components/responses/Unauthorized' }
+          },
+          {
+            '422' => { '$ref' => '#/components/responses/BadRequest' }
+          }
+        ]
+      end
+
+      def readable_action
+        @readable_action ||= self.class.name.demodulize.downcase
+      end
+
+      def model_name
+        @model_name ||= controller.model
+      end
+
+      def model
+        @model ||= model_name.constantize
+      end
+    end
+  end
+end

data/lib/swagger_api/operations/create.rb

@@ -0,0 +1,39 @@
+module SwaggerApi
+  module Operations
+    class Create < Base
+      def create
+        create = super
+        create[:requestBody] = request_body
+        create.delete(:parameters)
+        create
+      end
+
+      def request_body
+        {
+          "$ref" => "#/components/requestBodies/#{model_name}"
+        }
+      end
+
+      def success_response
+        {
+          '303' => {
+            description: "#{readable_action} #{model_name.downcase}'s information",
+            headers: {
+              Location: {
+                schema: {
+                  type: :string
+                }
+              }
+            }
+          }
+        }
+      end
+
+      def error_responses
+        super.reject do |error_response|
+          %w(404).include?(error_response.keys.first)
+        end
+      end
+    end
+  end
+end