strong_resources 0.6.3 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6fa1858d3151a0ccc3873ce7614ad1c739bd1934
-  data.tar.gz: ae7a5549f4996d14f1d568f05484d87b4b19f208
+  metadata.gz: 54ddba9d5512b6392e25f12d0d8e94b63f612aeb
+  data.tar.gz: 80626922f97af4ec215dd645faf0d1ecd42bc422
 SHA512:
-  metadata.gz: ff142dcd36ffadd091f4f44d86a4592660435e9a5953fa8227e812bf54736059f84f310f1e4097226c3fbdff2a0690132ed321bc3ec907511b78dfe30ee661ef
-  data.tar.gz: cfba12fff9d98c201c1c16e518335a8428203ba7d4bf597e51e794675f829e6fcb4b1575ba5c107ab3cb7a14f0ff3f550dd78de695c7a19823a4f8d3db31baa1
+  metadata.gz: 89340cb17fb8f8b08f2e9d0edbd3c3480787d5c0e5f910f4b02cbfb4f8576f07d64d488b541fcd11b7ad7db70c2ee9a2004d1777cd54504a2197e198840684bf
+  data.tar.gz: 31f4bc9bec27ffb25b5f40fa52e3bb14f32141061714a703be5724607562b90e84bd5b1970004ff13b125aae4d5633ad49cd8b47139bbd54e44f07afb651acfa

data/lib/strong_resources.rb

@@ -6,6 +6,10 @@ require "strong_resources/configuration"
 require "strong_resources/strong_resource"
 require "strong_resources/controller/mixin"
 
+if defined?(JsonapiErrorable)
+  require "strong_resources/exception_handler"
+end
+
 module StrongResources
   class UnregisteredResource < StandardError
     def initialize(name)
@@ -17,13 +21,20 @@ module StrongResources
     end
   end
 
-  class UnregisteredParam < StandardError
-    def initialize(name)
-      @name = name
+  class UnregisteredType < StandardError
+    def initialize(type)
+      @type = type
     end
 
     def message
-      "Parameter with name #{@name} not registered"
+      <<-MSG
+Type "#{@type}" was not found!
+
+This is the right-hand side of your strong_resource attributes.
+
+See the list of default types, and directions on how to register custom
+types, here: https://jsonapi-suite.github.io/strong_resources/#default-types
+      MSG
     end
   end
 
@@ -42,8 +53,8 @@ module StrongResources
   end
 
   def self.type_for_param(name)
-    found = config.strong_params[name][:type]
-    raise UnregisteredParam.new(name) unless found
-    found
+    found = config.strong_params[name]
+    raise UnregisteredType.new(name) unless found
+    found[:type]
   end
 end

data/lib/strong_resources/controller/mixin.rb

@@ -8,6 +8,16 @@ module StrongResources
             attr_accessor :_strong_resources
           end
         end
+
+        # In cases when the full jsonapi suite is being used, we
+        # can provide much better error feedback when parameters are
+        # incorrect.  Without this handler, errors would be generic
+        # 500's with unhelpful statuses, but this will give API consumers
+        # better feedback about formatting errors with a 400 response.
+        if respond_to?(:register_exception)
+          register_exception StrongerParameters::InvalidParameter,
+            handler: StrongResources::ExceptionHandler
+        end
       end
 
       # TODO: refactor
@@ -53,7 +63,10 @@ module StrongResources
       end
 
       def strong_resource
-        resource = self.class._strong_resources[action_name.to_sym]
+        resources = self.class._strong_resources
+        raise RuntimeError, "You need to define the `strong_resource` for #{self.class.name}" if resources.nil?
+        resource = resources[action_name.to_sym]
+        raise RuntimeError, "Missing `strong_resource` parameters for #{self.class.name}##{action_name}" if resource.nil?
         _params = params
         resource.permits(self)
       end

data/lib/strong_resources/exception_handler.rb

@@ -0,0 +1,35 @@
+module StrongResources
+  class ExceptionHandler < JsonapiErrorable::ExceptionHandler
+    SPLIT_REGEX = /^Invalid parameter: ([\w]+)\W(.*)/
+
+    def error_payload(error)
+      message_parse = error.message.match(SPLIT_REGEX)
+
+      attribute = message_parse[1]
+      message = message_parse[2]
+      error = {
+        code:   'unprocessable_entity',
+        status: '400',
+        title: 'Malformed Attribute',
+        detail: error.message,
+        source: { pointer: "/data/attributes/#{attribute}" },
+        meta:   {
+          attribute: attribute,
+          message: message
+        }
+      }
+
+      {
+        "errors" => [error]
+      }
+    end
+
+    def status_code(_)
+      400
+    end
+
+    def log?
+      false
+    end
+  end
+end

data/lib/strong_resources/strong_resource.rb

@@ -93,11 +93,11 @@ module StrongResources
 
     def permits(controller)
       base_permits(self, controller).tap do |permits|
+        permits[:relationships] ||= {}
         self.relations.each_pair do |relation_name, opts|
           related_resource = opts[:resource]
           related = related_permits(related_resource, controller)
-
-          permits[:relationships] ||= {}
+          
           permits[:relationships][relation_name] = related
           permits
         end

data/lib/strong_resources/version.rb

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

data/strong_resources.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "actionpack", [">= 4.1", "< 6.0"]
   spec.add_dependency "activesupport", [">= 4.1", "< 6.0"]
 
+  spec.add_development_dependency "jsonapi_errorable", "~> 0.9.0"
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: strong_resources
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4
 platform: ruby
 authors:
 - Lee Richmond
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-16 00:00:00.000000000 Z
+date: 2018-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jsonapi_compliable
@@ -78,6 +78,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: jsonapi_errorable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +186,7 @@ files:
 - lib/strong_resources.rb
 - lib/strong_resources/configuration.rb
 - lib/strong_resources/controller/mixin.rb
+- lib/strong_resources/exception_handler.rb
 - lib/strong_resources/strong_resource.rb
 - lib/strong_resources/version.rb
 - strong_resources.gemspec
@@ -195,7 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Auto-generate swagger docs and strong params