jsonapi-serializers 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cd3e1e9535b28c3bd4aa6649bce141d36c312edc
-  data.tar.gz: 44a9e5b6079c4b8fc61a871f28e63914df7b6d94
+  metadata.gz: ea36d39568cd4df788499db7681358013569975f
+  data.tar.gz: 9487670f424a8d0191a157b6dc556a8964fc47c3
 SHA512:
-  metadata.gz: a70aa04850d27c037bed576a368f74d76b4e8eda1ef40b65b933e04b1abcf2151245026461114dd19fe61b3f0e13265a9ba513e7606acbe4d10927d20bc48d87
-  data.tar.gz: d41530712d4454f0e73dead332a0e657853fe74d5f3a1f1ee2c400b7fb7c150d57e074af0c628b30106ced93ef2ed41d5c44a98d90fe195964ec37be2a369ecf
+  metadata.gz: de078d2a6e9eba0f0c3a18e90e2f2826997e7bbd7a9eb77ff24dd9eadc57d19011fe771db95a31c762efc80f178cefd1ba79e90dd088af762d9dc0553b58cde3
+  data.tar.gz: f0bbd2106ce7a6aec5e6d0d4b722d3e08e75266bb3688a8b92f615748c5586a048dae1f8ca9e2c36a4d412e0aaf5f5735d91d1eb1b9346e5619d4ab03cbcc384

data/README.md

@@ -318,11 +318,11 @@ JSONAPI::Serializer.serialize(post, meta: {copyright: 'Copyright 2015 Example Co
 
 ### Root errors
 
-You can pass an `errors` argument to specify top-level errors:
+You can use `serialize_errors` method in order to specify top-level errors:
 
 ```ruby
 errors = [{ "title": "Invalid Attribute", "detail": "First name must contain at least three characters." }]
-JSONAPI::Serializer.serialize(post, errors: errors)
+JSONAPI::Serializer.serialize_errors(errors)
 ```
 
 ### Explicit serializer discovery
@@ -662,6 +662,8 @@ end
 
 ## Release notes
 
+* v0.9.0: Add initial `serialize_errors` support.
+* v0.8.0: Pass context through recursive relationships.
 * v0.7.0: Support for root error objects.
 * v0.6.5: Exclude attributes when empty.
 * v0.6.4: Fix regression of including links when empty.

data/lib/jsonapi-serializers/serializer.rb

@@ -235,6 +235,8 @@ module JSONAPI
       options[:skip_collection_check] = options.delete('skip_collection_check') || options[:skip_collection_check] || false
       options[:base_url] = options.delete('base_url') || options[:base_url]
       options[:meta] = options.delete('meta') || options[:meta]
+
+      # Deprecated: use serialize_errors method instead
       options[:errors] = options.delete('errors') || options[:errors]
 
       # Normalize includes.
@@ -314,6 +316,10 @@ module JSONAPI
       result
     end
 
+    def self.serialize_errors(errors)
+      {'errors' => errors}
+    end
+
     def self.serialize_primary(object, options = {})
       serializer_class = options[:serializer] || find_serializer_class(object)
 
@@ -400,11 +406,8 @@ module JSONAPI
         # We're finding relationships for compound documents, so skip anything that doesn't exist.
         next if object.nil?
 
-        # We only include parent values if the sential value _include is set. This satifies the
-        # spec note: A request for comments.author should not automatically also include comments
-        # in the response. This can happen if the client already has the comments locally, and now
-        # wants to fetch the associated authors without fetching the comments again.
-        # http://jsonapi.org/format/#fetching-includes
+        # Full linkage: a request for comments.author MUST automatically include comments
+        # in the response.
         objects = is_collection ? object : [object]
         if child_inclusion_tree[:_include] == true
           # Include the current level objects if the _include attribute exists.

data/lib/jsonapi-serializers/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Serializer
-    VERSION = '0.8.0'
+    VERSION = '0.9.0'
   end
 end

data/spec/serializer_spec.rb

@@ -381,7 +381,7 @@ describe JSONAPI::Serializer do
         'data' => serialize_primary(post, {serializer: MyApp::PostSerializer}),
       })
     end
-    it 'can include a top level errors node' do
+    it 'can include a top level errors node - deprecated' do
       post = create(:post)
       errors = [
         {
@@ -400,6 +400,21 @@ describe JSONAPI::Serializer do
         'data' => serialize_primary(post, {serializer: MyApp::PostSerializer}),
       })
     end
+    it 'can include a top level errors node' do
+      errors = [
+        {
+          "source" => { "pointer" => "/data/attributes/first-name" },
+          "title" => "Invalid Attribute",
+          "detail" => "First name must contain at least three characters."
+        },
+        {
+          "source" => { "pointer" => "/data/attributes/first-name" },
+          "title" => "Invalid Attribute",
+          "detail" => "First name must contain an emoji."
+        }
+      ]
+      expect(JSONAPI::Serializer.serialize_errors(errors)).to eq({'errors' => errors})
+    end
     it 'can serialize a single object with an `each` method by passing skip_collection_check: true' do
       post = create(:post)
       post.define_singleton_method(:each) do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi-serializers
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Mike Fotinakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-12 00:00:00.000000000 Z
+date: 2016-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport