swagger_api 0.1.48 → 0.2.1

data/Gemfile

@@ -1,6 +1,18 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
 
-# Specify your gem's dependencies in swagger-api.gemspec
-gemspec
+# Specify your gem's dependencies in cubes.gemspec
+gemspec
+
+gem 'attr_encrypted'
+gem 'pg'
+gem 'rails'
+gem 'simplecov'
+gem 'webmock'
+
+group :development, :test do
+  gem 'factory_bot'
+  gem 'pry'
+  gem 'pry-byebug'
+end

data/Gemfile.lock

@@ -53,16 +53,30 @@ GEM
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
     arel (9.0.0)
+    attr_encrypted (3.1.0)
+      encryptor (~> 3.0.0)
     builder (3.2.3)
+    byebug (10.0.2)
+    coderay (1.1.2)
     concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
     crass (1.0.4)
     diff-lcs (1.3)
+    docile (1.3.1)
+    encryptor (3.0.0)
     erubi (1.7.1)
+    factory_bot (4.10.0)
+      activesupport (>= 3.0.0)
     globalid (0.4.1)
       activesupport (>= 4.2.0)
+    hashdiff (0.3.7)
     i18n (1.0.1)
       concurrent-ruby (~> 1.0)
+    json (2.1.0)
     loofah (2.2.2)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
@@ -78,6 +92,14 @@ GEM
     nio4r (2.3.1)
     nokogiri (1.8.3)
       mini_portile2 (~> 2.3.0)
+    pg (1.0.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (3.0.2)
     rack (2.0.5)
     rack-test (1.0.0)
       rack (>= 1.0, < 3)
@@ -127,6 +149,12 @@ GEM
       rspec-mocks (~> 3.7.0)
       rspec-support (~> 3.7.0)
     rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     sprockets (3.7.1)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -138,6 +166,10 @@ GEM
     thread_safe (0.3.6)
     tzinfo (1.2.5)
       thread_safe (~> 0.1)
+    webmock (3.4.2)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
     websocket-driver (0.7.0)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.3)
@@ -146,10 +178,18 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  attr_encrypted
   bundler (~> 1.16)
+  factory_bot
+  pg
+  pry
+  pry-byebug
+  rails
   rake (~> 10.0)
   rspec (~> 3.0)
+  simplecov
   swagger_api!
+  webmock
 
 BUNDLED WITH
    1.16.1

data/Rakefile

@@ -1,5 +1,7 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 

data/lib/swagger_api/actions.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_attr'
 
 module SwaggerApi
@@ -7,20 +9,14 @@ module SwaggerApi
     validate :validate_actions
     attr_accessor :controller
 
-
     def all!
-      raise self.errors.full_messages unless self.valid?
+      raise errors.full_messages unless 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
+      restful_actions - except_actions
     end
 
     def only_actions
@@ -32,12 +28,16 @@ module SwaggerApi
     end
 
     def restful_actions
-      %w(index show create update delete)
+      %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?
+      errors.add(:base, "`actions` can only include one of #{restful_actions}. #{(defined_actions - restful_actions)} are not allowed") unless extra_actions.blank?
+    end
+
+    def extra_actions
+      defined_actions - restful_actions
     end
   end
-end
+end

data/lib/swagger_api/column_schema.rb

@@ -1,22 +1,33 @@
+# frozen_string_literal: true
+
 module SwaggerApi
   class ColumnSchema
     include ActiveAttr::Model
     attr_accessor :column
 
     def create
-      schema = {
+      schema = default_schema
+      if column.type == :integer
+        schema[:minimum] = if column.name.to_s.ends_with?('id')
+                             1
+                           else
+                             0
+                           end
+      end
+      schema
+    end
+
+    def default_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)
+      if %i[datetime date time].include?(column.type)
         :string
-      elsif %i(float double).include?(column.type)
+      elsif %i[float double].include?(column.type)
         :number
       else
         column.type
@@ -25,16 +36,16 @@ module SwaggerApi
 
     def format_from_column
       case column.type
-        when :datetime
-          'date-time'
-        when :integer
-          :int64
+      when :datetime
+        'date-time'
+      when :integer
+        :int64
+      else
+        if column.name.to_s == 'email'
+          :email
         else
-          if column.name.to_s == 'email'
-            :email
-          else
-            column.type
-          end
+          column.type
+        end
       end
     end
   end

data/lib/swagger_api/component_schema.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwaggerApi
   class ComponentSchema
     include ActiveAttr::Model
@@ -43,16 +45,18 @@ module SwaggerApi
 
     def properties
       columns.map do |column|
-        next if column.name.end_with? '_iv'
-        next if absence_attributes.include? column.name
+        next if column_should_skip column.name
         attribute_name = column.name.gsub(/^encrypted_/, '')
         [attribute_name, ColumnSchema.new(column: column).create]
       end.compact.to_h
     end
 
+    def column_should_skip(column_name)
+      column_name.end_with?('_iv') || absence_attributes.include?(column_name)
+    end
 
     def model
       controller.model.constantize
     end
   end
-end
+end

data/lib/swagger_api/components.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwaggerApi
   class Components
     include ActiveAttr::Model
@@ -24,15 +26,19 @@ module SwaggerApi
     end
 
     def create_model_components_from_controller(controller)
-      if is_sti?(controller.model)
-        controller.model.constantize.descendants.map do |klass|
-          [klass.name, ComponentSchema.new(controller: OpenStruct.new(model: klass.name)).create]
-        end.to_h
+      if sti?(controller.model)
+        sti_models(controller.model.constantize)
       else
         {
           controller.model => ComponentSchema.new(controller: controller).create
         }
       end
     end
+
+    def sti_models(model_klass)
+      model_klass.descendants.map do |klass|
+        [klass.name, ComponentSchema.new(controller: OpenStruct.new(model: klass.name)).create]
+      end.to_h
+    end
   end
 end

data/lib/swagger_api/concerns/columns.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwaggerApi
   module Concerns
     module Columns
@@ -5,18 +7,27 @@ module SwaggerApi
 
       included do
         def columns
+          filter_except_columns(filter_only_columns(model.columns))
+        end
+
+        def filter_only_columns(columns)
           if controller.columns.try(:only).present?
-            model.columns.select! do |column|
+            columns.select do |column|
               controller.columns.only.include?(column.name)
             end
+          else
+            columns
           end
+        end
 
+        def filter_except_columns(columns)
           if controller.columns.try(:except).present?
-            model.columns.reject! do |column|
+            columns.reject do |column|
               controller.columns.except.include?(column.name)
             end
+          else
+            columns
           end
-          model.columns
         end
       end
     end

data/lib/swagger_api/concerns/sti_schema.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 module SwaggerApi
   module Concerns
     module StiSchema
       extend ActiveSupport::Concern
 
       included do
-        def is_sti?(model)
-          model_klass = model&.safe_constantize || model
-          return false if model_klass.is_a? String
+        def sti?(model)
+          model_klass = model.try(:safe_constantize) || model
+          return false if model_klass.is_a?(String) || model_klass.nil?
           Rails.application.eager_load!
           model_klass.descendants.count != 0
         end
 
         def schema(model)
-          if is_sti?(model)
+          if sti?(model)
             {
               oneOf: model.descendants.map do |klass|
                 { '$ref' => "#/components/schemas/#{klass.name}" }

data/lib/swagger_api/operations/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwaggerApi
   module Operations
     class Base
@@ -13,7 +15,7 @@ module SwaggerApi
           description: "#{readable_action} #{model_name.downcase}'s information",
           parameters: parameters,
           responses: responses,
-          tags: [model_name],
+          tags: [model_name]
         }
       end
 
@@ -28,7 +30,7 @@ module SwaggerApi
               type: :integer,
               format: :int64,
               minimum: 1
-            },
+            }
           }
         ]
       end
@@ -88,4 +90,4 @@ module SwaggerApi
       end
     end
   end
-end
+end

data/lib/swagger_api/operations/create.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwaggerApi
   module Operations
     class Create < Base
@@ -25,9 +27,9 @@ module SwaggerApi
 
       def error_responses
         super.reject do |error_response|
-          %w(404).include?(error_response.keys.first)
+          %w[404].include?(error_response.keys.first)
         end
       end
     end
   end
-end
+end

data/lib/swagger_api/operations/delete.rb

@@ -1,20 +1,21 @@
+# frozen_string_literal: true
+
 module SwaggerApi
   module Operations
     class Delete < Base
       def success_response
         {
           '204' => {
-            description: "#{readable_action} #{model_name.downcase}'s information",
+            description: "#{readable_action} #{model_name.downcase}'s information"
           }
         }
       end
 
-
       def error_responses
         super.reject do |error_response|
-          %w(422).include?(error_response.keys.first)
+          %w[422].include?(error_response.keys.first)
         end
       end
     end
   end
-end
+end

data/lib/swagger_api/operations/index.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwaggerApi
   module Operations
     class Index < Base
@@ -7,14 +9,14 @@ module SwaggerApi
             schema: {
               type: :integer
             },
-            description: 'total results available',
+            description: 'total results available'
           },
           'x-link-next' => {
             schema: {
               type: :string
             },
-            description: 'uri for next page of results',
-          },
+            description: 'uri for next page of results'
+          }
         }
       end
 
@@ -25,7 +27,7 @@ module SwaggerApi
             in: 'query',
             required: false,
             description: "#{column.name} of #{model.name}",
-            schema: SwaggerApi::ColumnSchema.new(column: column).create,
+            schema: SwaggerApi::ColumnSchema.new(column: column).create
           }
         end
       end
@@ -42,9 +44,9 @@ module SwaggerApi
 
       def error_responses
         super.reject do |error_response|
-          %w(404 422).include?(error_response.keys.first)
+          %w[404 422].include?(error_response.keys.first)
         end
       end
     end
   end
-end
+end