jsonapi-serializers 0.6.5 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f3ea0a6b146f6d472d29baeab24e9250af5a445
-  data.tar.gz: 12b7df3f2f154caeebc75bcebb238437343ae908
+  metadata.gz: 41b4f33131c66343d6703be670fe9a9e58f32c91
+  data.tar.gz: 5660da86b24a037e99e5cb21b7d60f484a8e6884
 SHA512:
-  metadata.gz: 38c6c932bf6dc7d56876bdfdd4f03994bbbba29e9d548152d2d55c4366ef1a89d707dd23b5f2f160516ee183cfdc15b7408f48ece62835da5a28adea86760a6e
-  data.tar.gz: 14fc35998aab4db62f6b92f77b053120bb6ba69a911fdfbed63fd616bb17b2a51bb67017c1322f9121af4f3572cbcd18ca08704d7857ecc754a1bae3f7597f05
+  metadata.gz: dc1f3bd07a774a7e2703a00f700280b3013ada8eda1977b12fd9525c8f5fee9f162a831d0c0d6c91bd0c01db383e52904bd8916179d523aa9a5fd5e9f16173a8
+  data.tar.gz: 940b4a24eedd64d9f5e568592972bd3c2f6c4e3e04ddefeedbaefd977f02016e707f5fb672629720def6db6b82cb2ea3e64fac95178188a65e0cc492a30697c6

data/.travis.yml

@@ -1,7 +1,13 @@
 language: ruby
+sudo: false
+cache: bundler
 rvm:
   - 1.9.3
   - 2.1.1
   - 2.2.2
   - ruby-head
+before_install:
+  # TODO: remove this when this issue is fixed: https://github.com/travis-ci/travis-ci/issues/5798
+  - gem uninstall bundler -v 1.6.9
+  - gem install bundler
 script: bundle exec rspec

data/README.md

@@ -19,6 +19,7 @@ This library is up-to-date with the finalized v1 JSON API spec.
   * [More customizations](#more-customizations)
   * [Base URL](#base-url)
   * [Root metadata](#root-metadata)
+  * [Root errors](#root-errors)
   * [Explicit serializer discovery](#explicit-serializer-discovery)
 * [Relationships](#relationships)
   * [Compound documents and includes](#compound-documents-and-includes)
@@ -315,6 +316,15 @@ You can pass a `meta` argument to specify top-level metadata:
 JSONAPI::Serializer.serialize(post, meta: {copyright: 'Copyright 2015 Example Corp.'})
 ```
 
+### Root errors
+
+You can pass an `errors` argument 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)
+```
+
 ### Explicit serializer discovery
 
 By default, jsonapi-serializers assumes that the serializer class for `Namespace::User` is `Namespace::UserSerializer`. You can override this behavior on a per-object basis by implementing the `jsonapi_serializer_class_name` method.
@@ -652,6 +662,7 @@ end
 
 ## Release notes
 
+* 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.
 * v0.6.3: Fix support for underscore-formatted attribute names.

data/lib/jsonapi-serializers/serializer.rb

@@ -234,6 +234,7 @@ 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]
+      options[:errors] = options.delete('errors') || options[:errors]
 
       # Normalize includes.
       includes = options[:include]
@@ -284,6 +285,7 @@ module JSONAPI
         'data' => primary_data,
       }
       result['meta'] = options[:meta] if options[:meta]
+      result['errors'] = options[:errors] if options[:errors]
 
       # If 'include' relationships are given, recursively find and include each object.
       if includes

data/lib/jsonapi-serializers/version.rb

@@ -1,5 +1,5 @@
 module JSONAPI
   module Serializer
-    VERSION = '0.6.5'
+    VERSION = '0.7.0'
   end
 end

data/spec/serializer_spec.rb

@@ -381,6 +381,25 @@ describe JSONAPI::Serializer do
         'data' => serialize_primary(post, {serializer: MyApp::PostSerializer}),
       })
     end
+    it 'can include a top level errors node' do
+      post = create(:post)
+      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(post, errors: errors)).to eq({
+        'errors' => errors,
+        'data' => serialize_primary(post, {serializer: MyApp::PostSerializer}),
+      })
+    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.6.5
+  version: 0.7.0
 platform: ruby
 authors:
 - Mike Fotinakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-07 00:00:00.000000000 Z
+date: 2016-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -123,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Pure Ruby readonly serializers for the JSON:API spec.
@@ -132,4 +132,3 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/factory.rb
 - spec/support/serializers.rb
-has_rdoc: