jsonapi_mapper 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 47223d6620e9fc3fff6740ffc29ab2667b18e2b8
-  data.tar.gz: a8453219e94d3fb0f412f4c64256ce8e563fb399
+  metadata.gz: 9883b69c0cc95639ba89dd3437199363426fb85a
+  data.tar.gz: a76c19f1d15ad85f037f30d3bac31f669b2774f5
 SHA512:
-  metadata.gz: 54fe745ec69e3012480a44b5a05eb67b764727a3c19be1beb45632962dcb4cf2e1ed4329dbc13e130e6d582bdd1d69775ca029600c9ea06cc23f7e2043ce69ae
-  data.tar.gz: 3b11530b50b1159e272e7b4d6957acef70c539a3a37390bccfb5ea5f80b2ef6217adc6e39300b02da68fbed33ab4639112458e15867a56acbf5e0730a43ade72
+  metadata.gz: 304d9fb7484f3a7c405afe014cfc159bc0a3c25f94983e00de6bd9264ed2aa25b724891e46707fd01931393696dcad64162226bfe693ea0194d310b67e1bf280
+  data.tar.gz: 7556af75805a07a6fc8acefdf303b0355d2bd1ed830169baf37695876bb1aa30be7a70c5e824d7a5f5cc624620f613a247286dfda73b29aefb3e88dcb5cb8cce

data/README.md

@@ -146,6 +146,54 @@ See the specs directory for more examples.
           pets: {nickname: :name},
         }  
       }).save_all
+
+
+      # If any resource in your document has errors, you can get a collection
+      # with pointers to the specific fields and the type and id of the resource
+      # that has the error.
+      document = {
+        data: [
+          { type: 'pets', attributes: { age: 3 } },
+          { type: 'pets', attributes: { age: 6 } },
+        ],
+        included: [
+          { type: 'pets', id: '@1', attributes: { age: 4 } }
+        ]
+      }
+      mapper = JsonapiMapper.doc(document,
+        { pets: [:nickname, country: 'uruguay'] },
+        { types: { pets: PetDog }, attributes: { pets: {nickname: :name} } }
+      )
+
+      # all_valid? triggers all validations and sets up errors.
+      mapper.all_valid?.should be_falsey
+
+      # Then all errors are presented like so, honoring remapped names too.
+      mapper.all_errors.should == {
+        errors: [
+          { status: 422,
+            title: "can't be blank",
+            detail: "can't be blank",
+            code: "can_t_be_blank",
+            meta: {type: "pets"},
+            source: {pointer: "/data/0/attributes/nickname"}
+          },
+          { status: 422,
+            title: "can't be blank",
+            detail: "can't be blank",
+            code: "can_t_be_blank",
+            meta: {type: "pets"},
+            source: {pointer: "/data/1/attributes/nickname"}
+          },
+          { status: 422,
+            title: "can't be blank",
+            detail: "can't be blank",
+            code: "can_t_be_blank",
+            meta: {type: "pets"},
+            source: {pointer: "/included/0/attributes/nickname"}
+          }
+        ]
+      }
 ```
 
 ## Development

data/lib/jsonapi_mapper/version.rb

@@ -1,3 +1,3 @@
 module JsonapiMapper
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/jsonapi_mapper.rb

@@ -66,15 +66,14 @@ module JsonapiMapper
         attrs = attrs.map(&:to_sym)
         scope.symbolize_keys!
 
-        danger = scope.keys.to_set & attrs.map{|a| renamed(type_name, a) }.to_set
+        danger = scope.keys.to_set & attrs.map{|a| renamed_attr(type_name, a) }.to_set
         if danger.count > 0
           raise RulesError.new("Don't let user set the scope: #{danger.to_a}")
         end
 
-        cls = renames.fetch(:types, {})[type_name] ||
-          type_name.to_s.singularize.camelize.constantize
+        cls = renamed_type(type_name)
 
-        attrs.map{|a| renamed(type_name, a) }.each do |attr|
+        attrs.map{|a| renamed_attr(type_name, a) }.each do |attr|
           unless cls.new.respond_to?(attr)
             raise NoMethodError.new("undefined method #{attr} for #{cls}")
           end
@@ -103,18 +102,17 @@ module JsonapiMapper
       relationships = {}
       json.fetch(:relationships, {}).each do |name, value|
         next unless type.rule.attributes.include?(name)
-        relationships[renamed(type.name, name)] = if value[:data].is_a?(Array)
+        relationships[renamed_attr(type.name, name)] = if value[:data].is_a?(Array)
           value[:data].map{|v| build_id(v) }
         else
           build_id(value[:data])
         end
       end
 
-      if attributes_to_be_set = json[:attributes]
+      if new_values = json[:attributes]
         type.rule.attributes.each do |name|
-          if value = attributes_to_be_set[name]
-            object.send("#{renamed(type.name, name)}=", value) 
-          end
+          next unless new_values.has_key?(name)
+          object.send("#{renamed_attr(type.name, name)}=", new_values[name]) 
         end
       end
 
@@ -149,10 +147,25 @@ module JsonapiMapper
           .new("Couldn't find #{id.type} with id=#{id.raw}")
     end
 
-    def renamed(type, attr)
+    def renamed_type(type_name)
+      renames.fetch(:types, {})[type_name] ||
+        type_name.to_s.singularize.camelize.constantize
+    end
+
+    def unrenamed_type(type)
+      type_name = type.to_s.underscore.pluralize
+      renames.fetch(:types, {}).find{|k,v| v == type }.try(:first) || type_name
+    end
+
+    def renamed_attr(type, attr)
       renames.fetch(:attributes, {}).fetch(type, {}).fetch(attr, attr)
     end
 
+    def unrenamed_attr(type_name, attr)
+      renames.fetch(:attributes, {}).fetch(type_name, {})
+        .find{|k,v| v == attr }.try(:first) || attr
+    end
+
     def all
       (data_mappable + included)
     end
@@ -163,6 +176,10 @@ module JsonapiMapper
       true
     end
 
+    def all_valid?
+      all.map(&:valid?).all? # This does not short-circuit, to get all errors.
+    end
+
     def collection?
       data.is_a?(Array)
     end
@@ -182,5 +199,44 @@ module JsonapiMapper
     def data_mappable
       collection? ? data : [data].compact
     end
+
+    def all_errors
+      errors = []
+
+      if collection?
+        data.each_with_index do |resource, i|
+          errors << serialize_errors_for("/data/#{i}", resource)
+        end
+      else
+        errors << serialize_errors_for("/data", data)
+      end
+      
+      included.each_with_index do |resource, i|
+        errors << serialize_errors_for("/included/#{i}", resource)
+      end
+
+      { errors: errors.flatten.compact }
+    end
+
+    private
+
+    def serialize_errors_for(prefix, model)
+      return if model.errors.empty?
+      model.errors.collect do |attr, value|
+        type_name = unrenamed_type(model.class)
+        meta = { type: type_name.to_s }
+        meta[:id] = model.id if model.id
+        {
+          status: 422,
+          title: value,
+          detail: value,
+          code: value.parameterize.underscore,
+          meta: meta,
+          source: {
+            pointer: "#{prefix}/attributes/#{unrenamed_attr(type_name, attr)}"
+          }
+        }
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_mapper
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - nubis
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-30 00:00:00.000000000 Z
+date: 2018-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport