swagger-api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 16f8848d68d8e83e8d88c3e6bbf3974c79c1f85149ebe59b7e208ab22b78524d
-  data.tar.gz: f55a8a8a95c9097ba09b0312eb61dd4eb0aa10f508e70fcfbfaab619ef0ca2f3
+  metadata.gz: 1a6147e6c08e3b29f19ed4955112635e165c11ae6f922d293125c51b8e8b6e9b
+  data.tar.gz: 41d314a1924914c9acd27e1f6cda6e12fcf9f18015bfa8d15921cf5b2fa00f06
 SHA512:
-  metadata.gz: 4fabfda39fd77b0302505de767de179db91cdcb88f5b45d2423021284499b8acc04430ce4fb314443e0a742f60c8642438199eb438bad1234cad4e41f7d0752d
-  data.tar.gz: 8dd7a9ac27ed97a88303dac2d2cc49a52c368f34e2c8eac6fd8bed07f32b3d00367ac186c5a4e05fa73e3056930512eaf0edb0e7f1e299e00af5ea13e5059a7c
+  metadata.gz: d8c3bd825606f6d379858a2df667682acf21dfbb7186b703df52278271775004750493fc88c096e484b078a86b96a5cc9ce4202fe55e29e3a7a7e72a53d8fd17
+  data.tar.gz: e83972c44bdda154f3807427c9b5c18ec138cbc645324f42ee4c1e5948feb30da54ce4572e4b65c9bb9832847e0714b4d2d505b6ffb29645565b3a37b283d75c

data/Gemfile.lock

@@ -0,0 +1,134 @@
+PATH
+  remote: .
+  specs:
+    swagger-api (0.1.1)
+      rails (>= 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.1.6)
+      actionpack (= 5.1.6)
+      nio4r (~> 2.0)
+      websocket-driver (~> 0.6.1)
+    actionmailer (5.1.6)
+      actionpack (= 5.1.6)
+      actionview (= 5.1.6)
+      activejob (= 5.1.6)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.1.6)
+      actionview (= 5.1.6)
+      activesupport (= 5.1.6)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.1.6)
+      activesupport (= 5.1.6)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.1.6)
+      activesupport (= 5.1.6)
+      globalid (>= 0.3.6)
+    activemodel (5.1.6)
+      activesupport (= 5.1.6)
+    activerecord (5.1.6)
+      activemodel (= 5.1.6)
+      activesupport (= 5.1.6)
+      arel (~> 8.0)
+    activesupport (5.1.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (8.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.0.5)
+    crass (1.0.4)
+    diff-lcs (1.3)
+    erubi (1.7.1)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (1.0.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.2)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.0)
+      mini_mime (>= 0.1.1)
+    method_source (0.9.0)
+    mini_mime (1.0.0)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    nio4r (2.3.0)
+    nokogiri (1.8.2)
+      mini_portile2 (~> 2.3.0)
+    rack (2.0.4)
+    rack-test (1.0.0)
+      rack (>= 1.0, < 3)
+    rails (5.1.6)
+      actioncable (= 5.1.6)
+      actionmailer (= 5.1.6)
+      actionpack (= 5.1.6)
+      actionview (= 5.1.6)
+      activejob (= 5.1.6)
+      activemodel (= 5.1.6)
+      activerecord (= 5.1.6)
+      activesupport (= 5.1.6)
+      bundler (>= 1.3.0)
+      railties (= 5.1.6)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.1.6)
+      actionpack (= 5.1.6)
+      activesupport (= 5.1.6)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (10.5.0)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    sprockets (3.7.1)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    websocket-driver (0.6.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  swagger-api!
+
+BUNDLED WITH
+   1.16.1

data/lib/swagger/api.rb

@@ -1,14 +1,7 @@
-module Swagger
-  class Api
-    include ActiveAttr::Model
-    include ActiveModel::Validations
-    attribute :openapi, type: String, default: '3.0.0'
-    attribute :servers, default: []
-    attribute :info, type: Object
-    attribute :security, default: [{api_key: []}]
-    attribute :paths, default: []
-    attribute :components, default: {}
+require 'swagger/api/version'
 
+module Swagger
+  module Api
     def self.prettify
       JSON.pretty_generate(JSON.parse(json))
     end
@@ -18,17 +11,17 @@ module Swagger
     end
 
     def self.create
-      @config ||= Swagger::Api.new(
+      @config ||= {
         info: info,
         servers: [{url: server_url}],
         paths: Paths.new(controllers: config.controllers).create,
         components: {
           responses: responses,
           schemas: Components.new(controllers: config.controllers).create,
-          requestBodies: Swagger::RequestBodies.new(controllers: config.controllers).create,
+          requestBodies: RequestBodies.new(controllers: config.controllers).create,
           securitySchemes: security_schemes,
         },
-      )
+      }
     end
 
     def self.config
@@ -110,3 +103,16 @@ module Swagger
     end
   end
 end
+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 @@
+module Swagger
+  module Api
+    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
+end

data/lib/swagger/api/column_schema.rb

@@ -0,0 +1,43 @@
+module Swagger
+  module Api
+    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
+end

data/lib/swagger/api/component_schema.rb

@@ -0,0 +1,52 @@
+module Swagger
+  module Api
+    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
+end

data/lib/swagger/api/components.rb

@@ -0,0 +1,16 @@
+module Swagger
+  module Api
+    class Components
+      include ActiveAttr::Model
+      attr_accessor :controllers
+
+      def create
+        components = {}
+        controllers.each do |controller|
+          components[controller.model] = ComponentSchema.new(controller: controller).create
+        end
+        components
+      end
+    end
+  end
+end

data/lib/swagger/api/concerns/columns.rb

@@ -0,0 +1,26 @@
+module Swagger
+  module Api
+    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
+end

data/lib/swagger/api/operations/base.rb

@@ -0,0 +1,92 @@
+module Swagger
+  module Api
+    module Operations
+      class Base
+        include ActiveAttr::Model
+        include Swagger::Api::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' }
+            },
+            {
+              '500' => { '$ref' => '#/components/responses/Unexpected' }
+            }
+          ]
+        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
+end

data/lib/swagger/api/operations/create.rb

@@ -0,0 +1,27 @@
+module Swagger
+  module Api
+    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 error_responses
+          super.reject do |error_response|
+            error_response.keys.first == '404'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/swagger/api/operations/delete.rb

@@ -0,0 +1,8 @@
+module Swagger
+  module Api
+    module Operations
+      class Delete < Base
+      end
+    end
+  end
+end

data/lib/swagger/api/operations/index.rb

@@ -0,0 +1,29 @@
+module Swagger
+  module Api
+    module Operations
+      class Index < Base
+        def parameters
+          columns.map do |column|
+            {
+              name: column.name,
+              in: 'query',
+              required: false,
+              description: "#{column.name} of #{model.name}",
+              schema: Swagger::Api::ColumnSchema.new(column: column).create,
+            }
+          end
+        end
+
+        def readable_action
+          'list'
+        end
+
+        def error_responses
+          super.reject do |error_response|
+            %w(404).include?(error_response.keys.first)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/swagger/api/operations/show.rb

@@ -0,0 +1,8 @@
+module Swagger
+  module Api
+    module Operations
+      class Show < Base
+      end
+    end
+  end
+end

data/lib/swagger/api/operations/update.rb

@@ -0,0 +1,19 @@
+module Swagger
+  module Api
+    module Operations
+      class Update < Base
+        def create
+          create = super
+          create[:requestBody] = request_body
+          create
+        end
+
+        def request_body
+          {
+            "$ref" => "#/components/requestBodies/#{model_name}"
+          }
+        end
+      end
+    end
+  end
+end

data/lib/swagger/api/paths.rb

@@ -0,0 +1,55 @@
+module Swagger
+  module Api
+    class Paths
+      include ActiveAttr::Model
+      attr_accessor :controllers
+
+      def create
+        return @paths unless @paths.nil?
+        @paths = {}
+        controllers.each do |controller|
+          if controller.custom_path_file.nil?
+            @paths.merge!(paths(controller))
+          else
+            @paths.merge!(custom_json(controller))
+          end
+        end
+        @paths
+      end
+
+      private
+
+      def paths(controller)
+        paths = {}
+        paths["#{route(controller)}"] = {}
+        paths["#{route(controller)}{id}/"] = {}
+        paths["#{route(controller)}"][:get] = Swagger::Api::Operations::Index.new(controller: controller).create if action?(controller, 'index')
+        paths["#{route(controller)}"][:post] = Swagger::Api::Operations::Create.new(controller: controller).create if action?(controller, 'create')
+        paths["#{route(controller)}{id}/"][:get] = Swagger::Api::Operations::Show.new(controller: controller).create if action?(controller, 'show')
+        paths["#{route(controller)}{id}/"][:put] = Swagger::Api::Operations::Update.new(controller: controller).create if action?(controller, 'update')
+        paths["#{route(controller)}{id}/"][:delete] = Swagger::Api::Operations::Delete.new(controller: controller).create if action?(controller, 'delete')
+        paths["#{route(controller)}"].delete if paths["#{route(controller)}"].blank?
+        paths["#{route(controller)}{id}/"].delete if paths["#{route(controller)}{id}/"].blank?
+        paths
+      end
+
+      def route(controller)
+        "/#{controller.name.demodulize.underscore.gsub('_controller', '')}/"
+      end
+
+      def custom_json(controller)
+        file = File.read(controller.custom_path_file)
+        JSON.parse(file)
+      end
+
+      def actions(controller)
+        Swagger::Api::Actions.new(controller: controller).all!
+      end
+
+      def action?(controller, action_name)
+        actions(controller).include?(action_name)
+      end
+    end
+  end
+end
+

data/lib/swagger/api/request_bodies.rb

@@ -0,0 +1,30 @@
+module Swagger
+  module Api
+    class RequestBodies
+      include ActiveAttr::Model
+      attr_accessor :controllers
+
+      def create
+        request_bodies = {}
+        controllers.each do |controller|
+          request_bodies[controller.model] = request_body(controller)
+        end
+        request_bodies
+      end
+
+      def request_body(controller)
+        {
+          content: {
+            'application/json' => {
+              schema: {
+                '$ref' => "#/components/schemas/#{controller.model}"
+              }
+            }
+          },
+          description: "audience attribute",
+          required: true
+        }
+      end
+    end
+  end
+end

data/lib/swagger/api/version.rb

@@ -1,5 +1,5 @@
 module Swagger
   module Api
-    VERSION = "0.1.1"
+    VERSION = "0.1.2"
   end
 end

data/swagger-api.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "rails", ">= 5.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagger-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Full Measure Education
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !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'
 description: A simple library for autocreating RESTful swagger api docs from Rails
   controllers.
 email:
@@ -65,12 +79,26 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
 - lib/swagger/api.rb
+- lib/swagger/api/actions.rb
+- lib/swagger/api/column_schema.rb
+- lib/swagger/api/component_schema.rb
+- lib/swagger/api/components.rb
+- lib/swagger/api/concerns/columns.rb
+- lib/swagger/api/operations/base.rb
+- lib/swagger/api/operations/create.rb
+- lib/swagger/api/operations/delete.rb
+- lib/swagger/api/operations/index.rb
+- lib/swagger/api/operations/show.rb
+- lib/swagger/api/operations/update.rb
+- lib/swagger/api/paths.rb
+- lib/swagger/api/request_bodies.rb
 - lib/swagger/api/version.rb
 - swagger-api.gemspec
 homepage: https://gitlab.com/fullmeasure/public/swagger-api/swagger-api