caprese 0.3.6 → 0.3.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 700367fd0c3a1b6334342c39e957f925c807fb76
-  data.tar.gz: cb81d72150d9ed56af418d447b72069dd49d09aa
+  metadata.gz: 1411527e1ecd7ef00676128c958c74414fb50b30
+  data.tar.gz: c96f3f3938d48b99c885107f7670f886d5b81dcb
 SHA512:
-  metadata.gz: f7b66a6904741cbea9943b0897582663599efc01100608f8e7138c6b917377ee07300f2dacce5dc3ef24ba839b51560bd2fab33e87192e233df2916c23d5bdee
-  data.tar.gz: 3146086e5e4627a0326ad1ed380ca18bb90b84f40564d77b8d28ffb1899096bd35d95766518112cda6dcf44a8f433a7c09ec83332bdd0531f3ab086f8d9e2452
+  metadata.gz: 9d4417c5faa6901736c30076beaee8ab27db4f0139021515ceb45736516a3fe3823b846d198729b6509e2230b7ed0401a59ab71bb2d6015947f72be1cd506435
+  data.tar.gz: d5a26e58f9619aad4e473161bb4653a07c2ee727ebc87ed961a03bd90a39c4fee50d40b9a697d348ea83aae208a029038d5c84ff951cbdad32c7b4956e141a09

data/CHANGELOG.md

@@ -31,3 +31,7 @@
 ## 0.3.6
 
 * Only allow resource identifiers in request documents to use `id` for primary key (JSON API adherent) (93c90eb)
+
+## 0.3.7
+
+* Completes error source pointer determination to include primary data items and relationship primary data items

data/lib/caprese/adapter/json_api/error.rb

@@ -7,6 +7,17 @@ module Caprese
         # rubocop:disable Style/AsciiComments
         UnknownSourceTypeError = Class.new(ArgumentError)
 
+        def self.param_errors(error_serializer, options)
+          error_attributes = error_serializer.as_json
+          [
+            {
+              code: error_attributes[:code],
+              detail: error_attributes[:message],
+              source: error_source(:parameter, nil, error_attributes[:field])
+            }
+          ]
+        end
+
         # Builds a JSON API Errors Object
         # {http://jsonapi.org/format/#errors JSON API Errors}
         #
@@ -20,20 +31,6 @@ module Caprese
           end
         end
 
-        # FIXME: param_errors implies multiple errors, but since we use a fail first
-        # strategy, there will only be one param error ever, as reflected by this method's
-        # definition
-        def self.param_errors(error_serializer, options)
-          error_attributes = error_serializer.as_json
-          [
-            {
-              code: error_attributes[:code],
-              detail: error_attributes[:message],
-              source: error_source(:parameter, nil, error_attributes[:field])
-            }
-          ]
-        end
-
         # definition:
         #   JSON Object
         #
@@ -92,20 +89,32 @@ module Caprese
         #       parameter: 'pres'
         #     }
         #   end
+        RESERVED_ATTRIBUTES = %w(type)
         def self.error_source(source_type, record, attribute_name)
           case source_type
           when :pointer
-            if record.has_attribute?(attribute_name)
+            # [type ...] and other primary data variables
+            if RESERVED_ATTRIBUTES.include?(attribute_name.to_s)
               {
-                pointer: JsonApi::JsonPointer.new(:attribute, record, attribute_name)
+                pointer: JsonApi::JsonPointer.new(:primary_data, record, attribute_name)
               }
-            elsif attribute_name.to_s.split('.').size > 1
+            elsif record.has_attribute?(attribute_name)
               {
-                pointer: JsonApi::JsonPointer.new(:relationship_attribute, record, attribute_name)
+                pointer: JsonApi::JsonPointer.new(:attribute, record, attribute_name)
               }
+            elsif (relationship_data_items = attribute_name.to_s.split('.')).size > 1
+              if RESERVED_ATTRIBUTES.include?(relationship_data_items.last)
+                {
+                  pointer: JsonApi::JsonPointer.new(:relationship_primary_data, record, relationship_data_items)
+                }
+              else
+                {
+                  pointer: JsonApi::JsonPointer.new(:relationship_attribute, record, attribute_name)
+                }
+              end
             else
               {
-                pointer: JsonApi::JsonPointer.new(:relationship, record, attribute_name)
+                pointer: JsonApi::JsonPointer.new(:relationship_base, record, attribute_name)
               }
             end
           when :parameter

data/lib/caprese/adapter/json_api/json_pointer.rb

@@ -6,8 +6,10 @@ module Caprese
 
         POINTERS = {
           attribute:    '/data/attributes/%s'.freeze,
-          relationship: '/data/relationships/%s'.freeze,
-          primary_data: '/data%s'.freeze
+          relationship_attribute: '/data/relationships/%s'.freeze,
+          relationship_base: '/data/relationships/%s/data'.freeze,
+          relationship_primary_data: '/data/relationships/%s/data/%s'.freeze,
+          primary_data: '/data/%s'.freeze
         }.freeze
 
         # Iterates over the field of an error and converts it to a pointer in JSON API format
@@ -25,6 +27,8 @@ module Caprese
         #   => '/data/relationships/post/data/relationships/user/data/attributes/name'
         #
         # @param [Symbol] pointer_type the type of pointer: :attribute, :relationship, :primary_data
+        # @param [Record] the record that owns the errors
+        # @param [Object,Array<Object>]
         def new(pointer_type, record, value)
           if pointer_type == :relationship_attribute
             value.to_s.split('.').inject('') do |pointer, v|
@@ -37,13 +41,13 @@ module Caprese
                       record.send(v)
                     end
 
-                  format(POINTERS[:relationship], v)
+                  format(POINTERS[:relationship_attribute], v)
                 else
                   format(POINTERS[:attribute], v)
                 end
             end
           else
-            format(POINTERS[pointer_type], value)
+            format(POINTERS[pointer_type], *[value].flatten)
           end
         end
       end

data/lib/caprese/controller/concerns/persistence.rb

@@ -292,7 +292,7 @@ module Caprese
         end
       else
         # { id: '...' } && { attributes: { ... } }
-        owner.errors.add(relationship_name)
+        owner.errors.add("#{relationship_name}.type")
         nil
       end
     end

data/lib/caprese/controller/concerns/typing.rb

@@ -27,12 +27,22 @@ module Caprese
     end
 
     # Checks if a given type mismatches the controller type
-    # @note Throws :invalid_type error if true
     #
     # @param [String] type the pluralized type to check ('products','orders',etc.)
     def fail_on_type_mismatch(type)
-      unless record_class(type) == controller_record_class
-        fail InvalidTypeError.new(type)
+      failed = false
+
+      begin
+        failed = record_class(type) != controller_record_class
+      rescue NameError
+        failed = true
+      end
+
+      if failed
+        invalid_typed_record = controller_record_class.new
+        invalid_typed_record.errors.add(:type)
+
+        fail RecordInvalidError.new(invalid_typed_record)
       end
     end
   end

data/lib/caprese/errors.rb

@@ -58,12 +58,4 @@ module Caprese
       @header = { status: :forbidden }
     end
   end
-
-  # Thrown when an attempt was made to create a record of type that is different than the type
-  # of the controller that the data was sent to
-  class InvalidTypeError < Error
-    def initialize(type)
-      super code: :invalid_type, t: { type: type }
-    end
-  end
 end

data/lib/caprese/version.rb

@@ -1,3 +1,3 @@
 module Caprese
-  VERSION = '0.3.6'
+  VERSION = '0.3.7'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: caprese
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.3.7
 platform: ruby
 authors:
 - Nick Landgrebe
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-02-08 00:00:00.000000000 Z
+date: 2017-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers