swagger_api 0.1.48 → 0.2.1

data/lib/swagger_api/operations/show.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module SwaggerApi
   module Operations
     class Show < Base
       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

data/lib/swagger_api/operations/update.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwaggerApi
   module Operations
     class Update < Base
@@ -23,4 +25,4 @@ module SwaggerApi
       end
     end
   end
-end
+end

data/lib/swagger_api/paths.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwaggerApi
   class Paths
     include ActiveAttr::Model
@@ -20,16 +22,40 @@ module SwaggerApi
 
     def paths(controller)
       paths = {}
-      paths["#{route(controller)}"] = {}
+      paths[route(controller)] = {}
       paths["#{route(controller)}{id}/"] = {}
-      paths["#{route(controller)}"][:get] = SwaggerApi::Operations::Index.new(controller: controller).create if action?(controller, 'index')
-      paths["#{route(controller)}"][:post] = SwaggerApi::Operations::Create.new(controller: controller).create if action?(controller, 'create')
+      collection_paths(paths, controller)
+      member_paths(paths, controller)
+      paths
+    end
+
+    def collection_paths(paths, controller)
+      paths[route(controller)][:get] = SwaggerApi::Operations::Index.new(controller: controller).create if action?(controller, 'index')
+      paths[route(controller)][:post] = SwaggerApi::Operations::Create.new(controller: controller).create if action?(controller, 'create')
+    end
+
+    def member_paths(paths, controller)
+      show_path(paths, controller)
+      update_path(paths, controller)
+      delete_path(paths, controller)
+      clean_out_delete_path(paths, controller)
+    end
+
+    def show_path(paths, controller)
       paths["#{route(controller)}{id}/"][:get] = SwaggerApi::Operations::Show.new(controller: controller).create if action?(controller, 'show')
+    end
+
+    def update_path(paths, controller)
       paths["#{route(controller)}{id}/"][:put] = SwaggerApi::Operations::Update.new(controller: controller).create if action?(controller, 'update')
+    end
+
+    def delete_path(paths, controller)
       paths["#{route(controller)}{id}/"][:delete] = SwaggerApi::Operations::Delete.new(controller: controller).create if action?(controller, 'delete')
-      paths["#{route(controller)}"].delete if paths["#{route(controller)}"].blank?
+    end
+
+    def clean_out_delete_path(paths, controller)
+      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)

data/lib/swagger_api/railtie.rb

@@ -1,6 +1,13 @@
+# frozen_string_literal: true
+
 require 'rails'
-class SwaggerApi::Railtie < Rails::Railtie
-  rake_tasks do
-    load 'swagger_api/tasks/swagger.rake'
+
+#:nocov:#
+module SwaggerApi
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'swagger_api/tasks/swagger.rake'
+    end
   end
-end
+end
+#:nocov:#

data/lib/swagger_api/request_bodies.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwaggerApi
   class RequestBodies
     include ActiveAttr::Model
@@ -17,7 +19,7 @@ module SwaggerApi
       {
         content: {
           'application/json' => {
-            schema: schema(controller.model.safe_constantize || controller.model)
+            schema: schema(controller.model.try(:safe_constantize) || controller.model)
           }
         },
         description: "#{controller.model} attribute",

data/lib/swagger_api/tasks/swagger.rake

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 
 namespace :swagger do
   desc 'Create a local version of the swagger api json file'
@@ -10,4 +11,4 @@ namespace :swagger do
       file.write(generator.prettify)
     end
   end
-end
+end

data/lib/swagger_api/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SwaggerApi
-  VERSION = "0.1.48"
+  VERSION = '0.2.1'
 end

data/lib/swagger_api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'swagger_api/version'
 require 'rails'
 
@@ -14,21 +16,25 @@ module SwaggerApi
     def create
       @config ||= {
         openapi: '3.0.0',
-        security: [{api_key: []}],
+        security: [{ api_key: [] }],
         info: info,
-        servers: [{url: server_url}],
+        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,
-        },
+        components: components
+      }
+    end
+
+    def 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)
+      @yaml_config ||= JSON.parse(YAML.load_file("#{Rails.root}/config/swagger.yml").to_json, object_class: OpenStruct)
     end
 
     def security_schemes
@@ -42,19 +48,17 @@ module SwaggerApi
     end
 
     def responses
-      @responses ||= custom_responses || default_responses
+      @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)
+    def default_responses
+      {}.merge(default_not_found_response).merge(default_unauthorized_response).merge(default_bad_request_response)
     end
 
-    def default_responses
+    def default_not_found_response
       {
         NotFound: {
-          description: "The specified resource was not found",
+          description: 'The specified resource was not found',
           content: {
             'application/json; charset=utf-8' => {
               schema: {
@@ -63,9 +67,14 @@ module SwaggerApi
               }
             }
           }
-        },
+        }
+      }
+    end
+
+    def default_unauthorized_response
+      {
         Unauthorized: {
-          description: "Unauthorized",
+          description: 'Unauthorized',
           content: {
             'application/json; charset=utf-8' => {
               schema: {
@@ -74,9 +83,14 @@ module SwaggerApi
               }
             }
           }
-        },
+        }
+      }
+    end
+
+    def default_bad_request_response
+      {
         BadRequest: {
-          description: "Bad Request",
+          description: 'Bad Request',
           content: {
             'application/json; charset=utf-8' => {
               schema: {
@@ -96,12 +110,12 @@ module SwaggerApi
       {
         version: config.info.version,
         title: config.info.title,
-        description: config.info.description,
+        description: config.info.description
       }
     end
 
     def server_url
-      return unless config.server.respond_to?(Rails.env)
+      return unless config.servers.respond_to?(Rails.env)
       config.servers.send(Rails.env).url
     end
   end

data/swagger_api.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'swagger_api/version'
@@ -8,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Full Measure Education']
   spec.email         = ['devops@fullmeasureed.com']
 
-  spec.summary       = %q{A simple library for autocreating RESTful swagger api docs from Rails controllers.}
-  spec.description   = %q{A simple library for autocreating RESTful swagger api docs from Rails controllers.}
+  spec.summary       = 'A simple library for autocreating RESTful swagger api docs from Rails controllers.'
+  spec.description   = 'A simple library for autocreating RESTful swagger api docs from Rails controllers.'
   spec.homepage      = 'https://gitlab.com/fullmeasure/public/swagger-api/swagger_api'
   spec.license       = 'MIT'
 
@@ -18,8 +20,7 @@ Gem::Specification.new do |spec|
   if spec.respond_to?(:metadata)
     spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   else
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
   end
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: swagger_api
 version: !ruby/object:Gem::Version
-  version: 0.1.48
+  version: 0.2.1
 platform: ruby
 authors:
 - Full Measure Education
@@ -106,6 +106,7 @@ files:
 - ".gitignore"
 - ".gitlab-ci.yml"
 - ".rspec"
+- ".rubocop.yml"
 - ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile