jsonapi-serializers 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea36d39568cd4df788499db7681358013569975f
-  data.tar.gz: 9487670f424a8d0191a157b6dc556a8964fc47c3
+  metadata.gz: ccad99bd078e37fa43bab5ffd42d9fae85414c33
+  data.tar.gz: c4d9d97a4550a955c7d9f95c9b59e70cc60896f2
 SHA512:
-  metadata.gz: de078d2a6e9eba0f0c3a18e90e2f2826997e7bbd7a9eb77ff24dd9eadc57d19011fe771db95a31c762efc80f178cefd1ba79e90dd088af762d9dc0553b58cde3
-  data.tar.gz: f0bbd2106ce7a6aec5e6d0d4b722d3e08e75266bb3688a8b92f615748c5586a048dae1f8ca9e2c36a4d412e0aaf5f5735d91d1eb1b9346e5619d4ab03cbcc384
+  metadata.gz: 6eb60b10f45d7892c4828b125b5a0efc139f41e1c0f737a48bcb4ffedea7162e78e5189d05e916ade934a197dec7f400b1a844c6f34bf5c1647896cee2098657
+  data.tar.gz: f3a8ec61f5c47a1ee73760865bf7dfc6903c77d12b7aa587753ee4c4626556f3e81697455f60a9118a14002ed4978a21129e7138b86fc118d0b9e2af58aabaed

data/README.md

@@ -325,6 +325,27 @@ errors = [{ "title": "Invalid Attribute", "detail": "First name must contain at
 JSONAPI::Serializer.serialize_errors(errors)
 ```
 
+If you are using Rails models (ActiveModel by default), you can pass in an object's errors:
+
+```ruby
+JSONAPI::Serializer.serialize_errors(user.errors)
+```
+
+A more complete usage example (assumes ActiveModel):
+
+```
+class Api::V1::ReposController < Api::V1::BaseController
+  def create
+    post = Post.create(post_params)
+    if post.errors
+      render json: JSONAPI::Serializer.serialize_errors(post.errors)
+    else
+      render json: JSONAPI::Serializer.serialize(post)
+    end
+  end
+end
+```
+
 ### 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.
@@ -654,35 +675,15 @@ module Api
 end
 ```
 
+## Changelog
+
+See [Releases](https://github.com/fotinakis/jsonapi-serializers/releases).
+
 ## Unfinished business
 
-* Support for passing `context` through to serializers is partially complete, but needs more work.
 * Support for the `fields` spec is planned, would love a PR contribution for this.
 * Support for pagination/sorting is unlikely to be supported because it would likely involve coupling to ActiveRecord, but please open an issue if you have ideas of how to support this generically.
 
-## 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.
-* v0.6.3: Fix support for underscore-formatted attribute names.
-* v0.6.2: Internal style updates and performance fixes.
-* v0.6.1: Spec compliance fix, include intermediate resources on compound documents.
-* v0.6.0: Support for polymorphic collections and inheriting serializer attributes.
-* v0.5.0: Support for explicit serializer discovery.
-* v0.4.0: Support for declaring multiple `attributes`.
-* v0.3.1: Improve performance of loading included relationships.
-* v0.3.0: Add top-level `meta` support.
-* v0.2.6: Add `base_url` support.
-* v0.2.5: Allow disabling ambiguous collection checks for Sequel support.
-* v0.2.4: Improve handling for nil relationship links.
-* v0.2.3: Support serializers with no attributes.
-* v0.2.2: Compliance fix for excluding empty relationship objects.
-* v0.2.1: Compliance fix for self links.
-* v0.2.0: Initial release with support for the final v1 JSON API spec.
-
 ## Contributing
 
 1. Fork it ( https://github.com/fotinakis/jsonapi-serializers/fork )

data/jsonapi-serializers.gemspec

@@ -23,4 +23,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.2"
   spec.add_development_dependency "factory_girl", "~> 4.5"
+  spec.add_development_dependency "activemodel", "~> 4.2"
 end

data/lib/jsonapi-serializers/serializer.rb

@@ -316,8 +316,31 @@ module JSONAPI
       result
     end
 
-    def self.serialize_errors(errors)
-      {'errors' => errors}
+    def self.serialize_errors(raw_errors)
+      if is_activemodel_errors?(raw_errors)
+        {'errors' => activemodel_errors(raw_errors)}
+      else
+        {'errors' => raw_errors}
+      end
+    end
+
+    def self.activemodel_errors(raw_errors)
+      raw_errors.to_hash(full_messages: true).inject([]) do |result, (attribute, messages)|
+        result += messages.map { |message| single_error(attribute.to_s, message) }
+      end
+    end
+
+    def self.is_activemodel_errors?(raw_errors)
+      raw_errors.respond_to?(:to_hash) && raw_errors.respond_to?(:full_messages)
+    end
+
+    def self.single_error(attribute, message)
+      {
+        'source' => {
+          'pointer' => "/data/attributes/#{attribute.dasherize}"
+        },
+        'detail' => message
+      }
     end
 
     def self.serialize_primary(object, options = {})

data/lib/jsonapi-serializers/version.rb

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

data/spec/serializer_spec.rb

@@ -1,3 +1,7 @@
+require 'active_model/errors'
+require 'active_model/naming'
+require 'active_model/translation'
+
 describe JSONAPI::Serializer do
   def serialize_primary(object, options = {})
     # Note: intentional high-coupling to protected method for tests.
@@ -350,6 +354,65 @@ describe JSONAPI::Serializer do
     end
   end
 
+  # The members data and errors MUST NOT coexist in the same document.
+  describe 'JSONAPI::Serializer.serialize_errors' do
+    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 'works for active_record' do
+      # DummyUser exists so we can test calling user.errors.to_hash(full_messages: true)
+      class DummyUser
+        extend ActiveModel::Naming
+        extend ActiveModel::Translation
+
+        def initialize
+          @errors = ActiveModel::Errors.new(self)
+          @errors.add(:email, :invalid, message: 'is invalid')
+          @errors.add(:email, :blank, message: "can't be blank")
+          @errors.add(:first_name, :blank, message: "can't be blank")
+        end
+
+        attr_accessor :first_name, :email
+        attr_reader :errors
+
+        def read_attribute_for_validation(attr)
+          send(attr)
+        end
+      end
+      user = DummyUser.new
+      jsonapi_errors = [
+        {
+          'source' => { 'pointer' => '/data/attributes/email' },
+          'detail' => 'Email is invalid'
+        },
+        {
+          'source' => { 'pointer' => '/data/attributes/email' },
+          'detail' => "Email can't be blank"
+        },
+        {
+          'source' => { 'pointer' => '/data/attributes/first-name' },
+          'detail' => "First name can't be blank"
+        }
+      ]
+      expect(JSONAPI::Serializer.serialize_errors(user.errors)).to eq({
+        'errors' => jsonapi_errors,
+      })
+    end
+  end
+
   describe 'JSONAPI::Serializer.serialize' do
     # The following tests rely on the fact that serialize_primary has been tested above, so object
     # primary data is not explicitly tested here. If things are broken, look above here first.
@@ -381,6 +444,7 @@ describe JSONAPI::Serializer do
         'data' => serialize_primary(post, {serializer: MyApp::PostSerializer}),
       })
     end
+    # TODO: remove this code on next major release
     it 'can include a top level errors node - deprecated' do
       post = create(:post)
       errors = [
@@ -400,21 +464,6 @@ 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.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Mike Fotinakis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-14 00:00:00.000000000 Z
+date: 2016-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.5'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 description: ''
 email:
 - mike@fotinakis.com
@@ -123,7 +137,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Pure Ruby readonly serializers for the JSON:API spec.
@@ -132,3 +146,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/factory.rb
 - spec/support/serializers.rb
+has_rdoc: