jsonapi_swagger_helpers 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a3dfcaaab57c8cb5ada6eaa60ce15e1f757ce9d
-  data.tar.gz: bff654e5ad534fe599455bcffa1897ddc3524614
+  metadata.gz: 120127d5171433f69fb65d417989dc398c21741b
+  data.tar.gz: 06017e09e6276039f7707fb0e79a7991038ebb99
 SHA512:
-  metadata.gz: 51f6f447aafe7d3aeabbc73cefb44bc5f348e0c36d13e5ae107b3b206c3f6313ada232b669dc2993b78f530369c0396da627b63db22ee9b7e64d906fd087ccbf
-  data.tar.gz: 91795f5a74a1e3fec13283e2d674b6925fa4c543fd501b3d29fffb1573bdd42fd8b11c9ba05ff761b060685599d1386c2ba47c48718f52ee96218a0524885864
+  metadata.gz: 63d037d7b0d6b6b1f9b1397503eab836e3ddce5d29e556703cabfc1cd2d2a3dc38251459af9f32635e2583b6cf362bd379c591754d37755fcf27bc4209a5ee8d
+  data.tar.gz: 0bb06960deed1908866deda9e5d0f543cb9ea7f1f23628b7b54fa398970d802d896bb0d9382dc675b03575599f816069795f4f64022425c8e22937f3ca45e3e8

data/jsonapi_swagger_helpers.gemspec

@@ -22,8 +22,11 @@ Gem::Specification.new do |spec|
   # TODO: above 0.4.2
   spec.add_dependency 'jsonapi_spec_helpers', ['< 1']
   spec.add_dependency 'jsonapi_compliable', ['~> 0.10']
+  spec.add_runtime_dependency 'strong_resources', '>= 0'
 
+  spec.add_development_dependency "activesupport", ">= 4.1"
   spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "byebug", ">= 0"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
 end

data/lib/jsonapi_swagger_helpers/configuration.rb

@@ -6,7 +6,8 @@ module JsonapiSwaggerHelpers
         integer: [Integer, Bignum],
         number: [Float],
         boolean: [TrueClass, FalseClass],
-        object: [Hash]
+        object: [Hash],
+        array: [Array]
       }
     end
   end

data/lib/jsonapi_swagger_helpers/destroy_action.rb

@@ -14,7 +14,7 @@ module JsonapiSwaggerHelpers
         key :operationId, _self.operation_id
         key :tags, _self.tags
 
-        _self.util.id_in_url(self)
+        _self.util.id_in_url(self) unless _self.singular
 
         response 200 do
           key :description, 'API Response'

data/lib/jsonapi_swagger_helpers/errors.rb

@@ -12,7 +12,7 @@ Could not find type mapping for payload "#{@payload_name}", key "#{@attribute}".
 
 To add a custom mapping:
 
-JsonapiSwaggerHelpers.config do |c|
+JsonapiSwaggerHelpers.configure do |c|
   c.type_mapping[:string] << MyCustomType
 end
         STR

data/lib/jsonapi_swagger_helpers/readable.rb

@@ -1,21 +1,25 @@
+# frozen_string_literal: true
+
 module JsonapiSwaggerHelpers
   module Readable
     def self.included(klass)
       klass.class_eval do
         attr_reader :node,
-          :controller,
-          :resource,
-          :description,
-          :tags
+                    :controller,
+                    :resource,
+                    :description,
+                    :tags,
+                    :singular
       end
     end
 
-    def initialize(node, controller, description: nil, tags: [])
+    def initialize(node, controller, description: nil, tags: [], singular: false)
       @node = node
       @controller = controller
       @resource = controller._jsonapi_compliable
       @description = description || default_description
       @tags = tags
+      @singular = singular
     end
 
     def default_description

data/lib/jsonapi_swagger_helpers/resource_mixin.rb

@@ -5,13 +5,15 @@ module JsonapiSwaggerHelpers
                          tags: [],
                          descriptions: {},
                          only: [],
-                         except: [])
+                         except: [],
+                         singular: false)
       self.resources << {
         base_path: base_path,
         tags: tags,
         descriptions: descriptions,
         only: only,
-        except: except
+        except: except,
+        singular: singular
       }
     end
 
@@ -21,8 +23,9 @@ module JsonapiSwaggerHelpers
       descriptions = config[:descriptions]
       only = config[:only]
       except = config[:except]
+      singular = config[:singular]
 
-      actions = [:index, :show, :create, :update, :destroy]
+      actions = %i[index show create update destroy]
       actions.select! { |a| only.include?(a) } unless only.empty?
       actions.reject! { |a| except.include?(a) } unless except.empty?
 
@@ -30,43 +33,19 @@ module JsonapiSwaggerHelpers
       full_path  = [prefix, base_path].join('/').gsub('//', '/')
       controller = JsonapiSwaggerHelpers::Util.controller_for(full_path)
 
-      ctx = self
-      if [:create, :index].any? { |a| actions.include?(a) }
-        swagger_path base_path do
-          if actions.include?(:index) && controller.action_methods.include?('index')
-            index_action = JsonapiSwaggerHelpers::IndexAction.new \
-              self, controller, tags: tags, description: descriptions[:index]
-            index_action.generate
-          end
-
-          if actions.include?(:create) && controller.action_methods.include?('create')
-            create_action = JsonapiSwaggerHelpers::CreateAction.new \
-              self, controller, tags: tags, description: descriptions[:create]
-            create_action.generate
-          end
-        end
-      end
-
-      if [:show, :update, :destroy].any? { |a| actions.include?(a) }
-        ctx = self
-        swagger_path "#{base_path}/{id}" do
-          if actions.include?(:show) && controller.action_methods.include?('show')
-            show_action = JsonapiSwaggerHelpers::ShowAction.new \
-              self, controller, tags: tags, description: descriptions[:show]
-            show_action.generate
-          end
-
-          if actions.include?(:update) && controller.action_methods.include?('update')
-            update_action = JsonapiSwaggerHelpers::UpdateAction.new \
-              self, controller, tags: tags, description: descriptions[:update]
-            update_action.generate
-          end
-
-          if actions.include?(:destroy) && controller.action_methods.include?('destroy')
-            destroy_action = JsonapiSwaggerHelpers::DestroyAction.new \
-              self, controller, tags: tags, description: descriptions[:destroy]
-            destroy_action.generate
-          end
+      actions.each do |action|
+        next unless controller.action_methods.include?(action.to_s)
+        path = if !singular && %i[show update destroy].include?(action)
+                 "#{base_path}/{id}"
+               else
+                 base_path
+               end
+        swagger_path path do
+          action_class_name = "#{action.to_s.camelize}Action"
+          action_class = JsonapiSwaggerHelpers.const_get(action_class_name)
+          action_object = action_class.new \
+            self, controller, tags: tags, description: descriptions[action], singular: singular
+          action_object.generate
         end
       end
     end

data/lib/jsonapi_swagger_helpers/show_action.rb

@@ -22,7 +22,7 @@ module JsonapiSwaggerHelpers
           end
         end
 
-        _self.util.id_in_url(self)
+        _self.util.id_in_url(self) unless _self.singular
         _self.util.jsonapi_fields(self, _self.jsonapi_type)
 
         if _self.has_extra_fields?

data/lib/jsonapi_swagger_helpers/update_action.rb

@@ -15,7 +15,7 @@ module JsonapiSwaggerHelpers
         key :operationId, _self.operation_id
         key :tags, _self.all_tags
 
-        _self.util.id_in_url(self)
+        _self.util.id_in_url(self) unless _self.singular
 
         parameter do
           key :name, :payload

data/lib/jsonapi_swagger_helpers/util.rb

@@ -7,7 +7,7 @@ module JsonapiSwaggerHelpers
       if route
         "#{route[:controller]}_controller".classify.constantize
       else
-        Rails.logger.error("JsonapiSwaggerHelpers: No controller found for #{path}!") unless route
+        raise ArgumentError.new("JsonapiSwaggerHelpers: No controller found for #{path}!")
       end
     end
 

data/lib/jsonapi_swagger_helpers/version.rb

@@ -1,3 +1,3 @@
 module JsonapiSwaggerHelpers
-  VERSION = "0.6.3"
+  VERSION = "0.6.4"
 end

data/lib/jsonapi_swagger_helpers/writeable.rb

@@ -1,21 +1,25 @@
+# frozen_string_literal: true
+
 module JsonapiSwaggerHelpers
   module Writeable
     def self.included(klass)
       klass.class_eval do
         attr_reader :node,
-          :controller,
-          :resource,
-          :description,
-          :tags
+                    :controller,
+                    :resource,
+                    :description,
+                    :tags,
+                    :singular
       end
     end
 
-    def initialize(node, controller, description: nil, tags: [])
+    def initialize(node, controller, description: nil, tags: [], singular: false)
       @node = node
       @controller = controller
       @resource = controller._jsonapi_compliable
       @description = description || default_description
       @tags = tags
+      @singular = singular
     end
 
     def util
@@ -41,7 +45,7 @@ module JsonapiSwaggerHelpers
     def payload_tags
       tags = [:"payload-#{strong_resource.name}_#{action_name}"]
 
-      strong_resource.relations.each_pair do |relation_name, relation_config|
+      strong_resource.relations.each_pair do |relation_name, _relation_config|
         tags << :"payload-#{strong_resource.name}_#{relation_name}_#{action_name}"
       end
 
@@ -68,7 +72,7 @@ module JsonapiSwaggerHelpers
           key :'$ref', :"#{_self.strong_resource.name}_#{_self.action_name}"
         end
 
-        _self.each_strong_relation(_self.strong_resource) do |relation_name, relation_config|
+        _self.each_strong_relation(_self.strong_resource) do |relation_name, _relation_config|
           property relation_name do
             key :'$ref', :"#{_self.strong_resource.name}_#{relation_name}_#{_self.action_name}"
           end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_swagger_helpers
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Lee Richmond
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-16 00:00:00.000000000 Z
+date: 2018-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: swagger-blocks
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: strong_resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -148,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Swagger helpers for jsonapi.org-compatible APIs