erratum 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2da98504e0fc6cdcd8b3ce54cba33ceb9fc7858
-  data.tar.gz: 870ea8ac1b0ec66795a7eed5afa465d3d5eda9c6
+  metadata.gz: 982e57d709215c3038efc5bec08ee2c2fe3ec196
+  data.tar.gz: 7bb38ea005d8ca877560a156ae4ee28f897b4741
 SHA512:
-  metadata.gz: 9eab5d1b08efc6a0ebaaef24900b5f600eba5a55723a87f189d14f597c609c62ffd0f1c2bf7c107b2b7fb6464e41a644c66f9b32f6f78ffdb76f623688a4978a
-  data.tar.gz: 94254658a01cf4bb7eb62efe55d132e8bdd542e27328c0eaba6f012c1ac655895e801ebdd528361e2e50391f7a5b5f0dfbea5a8668598a585b5af107e0dc4cfd
+  metadata.gz: 5251259e5374837ab0d30bdd78b90345c85c30754efc395b70041a0b785b2412084f631eeed8e912d2af0dd7da2f796fd1574ddd84a5ea71bebb09a9f7adba5f
+  data.tar.gz: 075e5ce7e21137754139f8c67a5afb691a501ad48186e9af9f348c76be4970d25d26cab979596da5f8fe299970f638b9bc346f97fb939db62c0c2a8242b9d5a6

data/lib/erratum/error.rb

@@ -31,20 +31,16 @@ module  Error
 
   def as_json(_options = {})
     {
-      errors: [
-                {
-                  id:     id,
-                  links:  {
-                    about:         external_documentation_url,
-                    documentation: developer_documentation_url,
-                  },
-                  status: http_status,
-                  code:   code,
-                  title:  title,
-                  detail: detail,
-                  source: source,
-                },
-              ],
+      id:     id,
+      links:  {
+        about:         external_documentation_url,
+        documentation: developer_documentation_url,
+      },
+      status: http_status,
+      code:   code,
+      title:  title,
+      detail: detail,
+      source: source,
     }
   end
 

data/lib/erratum/errors/crud_errors/resource_persistence_error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require 'erratum/error'
 require 'erratum/errors/crud_error'
 
 class   Erratum
@@ -7,23 +8,26 @@ class   ResourcePersistenceError < RuntimeError
   include Error
   include CrudError
 
-  attr_accessor :errors,
-                :attributes
+  attr_accessor :pointer,
+                :attribute,
+                :value
 
   def self.convert(original_error, overrides = {})
-    initialization_parameters = {}
-
     case original_error.class.name
     when 'ActiveRecord::RecordInvalid',
          'ActiveRecord::RecordNotSaved'
 
-      initialization_parameters = {
-        attributes: original_error.record.attributes,
-        errors:     original_error.record.errors.full_messages,
-      }
-    end
+      original_error.record.errors.each_with_object([]) do |(attribute, error), errors|
+        initialization_parameters = {
+          attribute: attribute.to_s.camelize(:lower),
+          detail:    "#{attribute.to_s.humanize} #{error}",
+          pointer:   "/data/attributes/#{attribute}",
+          value:     original_error.record.public_send(attribute).to_s,
+        }
 
-    new(initialization_parameters.merge(overrides))
+        errors << new(initialization_parameters.merge(overrides))
+      end
+    end
   end
 
   def http_status
@@ -35,14 +39,15 @@ class   ResourcePersistenceError < RuntimeError
   end
 
   def detail
-    "One or more of the attributes on the #{resource_name} you attempted " \
-    "to #{action} is invalid."
+    @detail || "One or more of the attributes on the #{resource_name} you attempted " \
+               "to #{action} is invalid."
   end
 
   def source
     {
-      'errors'     => errors,
-      'attributes' => attributes,
+      'pointer'   => pointer,
+      'parameter' => attribute,
+      'value'     => value,
     }
   end
 end

data/lib/erratum/rescuable_resource.rb

@@ -15,14 +15,17 @@ module  RescuableResource
       erratum = Erratum.convert(exception,
                                 resource_name: self.class.singular_resource_name,
                                 action:        action_name)
+      erratum = Array(erratum)
 
-      render json:   erratum,
-             status: erratum.http_status
+      render json:   Hash['errors' => erratum.as_json],
+             status: erratum.first.http_status
     end
 
     base.rescue_from 'Erratum::Error' do |exception|
-      render json:   exception,
-             status: exception.http_status
+      exception = Array(exception)
+
+      render json:   Hash['errors' => exception.as_json],
+             status: exception.first.http_status
     end
   end
 end

data/lib/erratum/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 class Erratum
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

data/spec/lib/erratum/error_spec.rb

@@ -57,20 +57,16 @@ RSpec.describe  Error do
     )
 
     expect(custom_error.as_json).to eql(
-      errors: [
-                {
-                  id:     'identifier',
-                  links:  {
-                    about:         'jinkies/87654321',
-                    documentation: 'asimof/jibbit?version=janky',
-                  },
-                  status: 'flibbity',
-                  code:   'jibbit',
-                  title:  'roll dem bones and stones',
-                  detail: 'I cannot receive any satisfaction',
-                  source: 'But perhaps if I attempt it one more time, I can',
-                },
-              ],
+              id:     'identifier',
+              links:  {
+                about:         'jinkies/87654321',
+                documentation: 'asimof/jibbit?version=janky',
+              },
+              status: 'flibbity',
+              code:   'jibbit',
+              title:  'roll dem bones and stones',
+              detail: 'I cannot receive any satisfaction',
+              source: 'But perhaps if I attempt it one more time, I can',
     )
   end
 
@@ -98,20 +94,16 @@ RSpec.describe  Error do
     )
 
     expect(custom_error.as_json).to eql(
-      errors: [
-                {
-                  id:     'identifier',
-                  links:  {
-                    about:         'http://example.com/edu',
-                    documentation: 'http://example.com/ddu',
-                  },
-                  status: 'flibbity',
-                  code:   'jibbit',
-                  title:  'roll dem bones and stones',
-                  detail: 'I cannot receive any satisfaction',
-                  source: 'But perhaps if I attempt it one more time, I can',
-                },
-              ],
+              id:     'identifier',
+              links:  {
+                about:         'http://example.com/edu',
+                documentation: 'http://example.com/ddu',
+              },
+              status: 'flibbity',
+              code:   'jibbit',
+              title:  'roll dem bones and stones',
+              detail: 'I cannot receive any satisfaction',
+              source: 'But perhaps if I attempt it one more time, I can',
     )
   end
 
@@ -141,20 +133,16 @@ RSpec.describe  Error do
     )
 
     expect(custom_error.as_json).to eql(
-      errors: [
-                {
-                  id:     'identifier',
-                  links:  {
-                    about:         'hinkies/87654321',
-                    documentation: 'hasimof/jibbit?version=hanky',
-                  },
-                  status: 'flibbity',
-                  code:   'jibbit',
-                  title:  'roll dem bones and stones',
-                  detail: 'I cannot receive any satisfaction',
-                  source: 'But perhaps if I attempt it one more time, I can',
-                },
-              ],
+              id:     'identifier',
+              links:  {
+                about:         'hinkies/87654321',
+                documentation: 'hasimof/jibbit?version=hanky',
+              },
+              status: 'flibbity',
+              code:   'jibbit',
+              title:  'roll dem bones and stones',
+              detail: 'I cannot receive any satisfaction',
+              source: 'But perhaps if I attempt it one more time, I can',
     )
   end
 
@@ -169,20 +157,16 @@ RSpec.describe  Error do
     )
 
     expect(custom_error.as_json).to eql(
-      errors: [
-                {
-                  id:     'identifier',
-                  links:  {
-                    about:         nil,
-                    documentation: nil,
-                  },
-                  status: 'flibbity',
-                  code:   'jibbit',
-                  title:  'roll dem bones and stones',
-                  detail: 'I cannot receive any satisfaction',
-                  source: 'But perhaps if I attempt it one more time, I can',
-                },
-              ],
+              id:     'identifier',
+              links:  {
+                about:         nil,
+                documentation: nil,
+              },
+              status: 'flibbity',
+              code:   'jibbit',
+              title:  'roll dem bones and stones',
+              detail: 'I cannot receive any satisfaction',
+              source: 'But perhaps if I attempt it one more time, I can',
     )
   end
 end

data/spec/lib/erratum/errors/crud_errors/resource_persistence_error_spec.rb

@@ -51,33 +51,41 @@ RSpec.describe  ResourcePersistenceError do
   end
 
   it 'includes the resource name and action in the source' do
-    error = ResourcePersistenceError.new errors:     'lots of errors',
-                                         attributes: 'winter is coming'
+    error = ResourcePersistenceError.new pointer:   '/data/pointer/stuff',
+                                         attribute: 'my_attribute',
+                                         value:     'my_value'
 
-    expect(error.source).to eql('errors'     => 'lots of errors',
-                                'attributes' => 'winter is coming')
+    expect(error.source).to eql('pointer'   => '/data/pointer/stuff',
+                                'parameter' => 'my_attribute',
+                                'value'     => 'my_value')
   end
 
   it 'can convert an "ActiveRecord::RecordNotSaved"' do
     record = ErratumTestModel.new
     record.valid?
     resource_persistence_error = ActiveRecord::RecordNotSaved.new('message', record)
-    error                      = ResourcePersistenceError.
+    errors                     = ResourcePersistenceError.
                                    convert(resource_persistence_error)
+    error                      = errors.first
 
-    expect(error.attributes).to eql('some_attribute' => nil)
-    expect(error.errors).to     eql ["Some attribute can't be blank"]
+    expect(error.pointer).to   eql '/data/attributes/some_attribute'
+    expect(error.attribute).to eql 'someAttribute'
+    expect(error.value).to     eql ''
+    expect(error.detail).to    eql "Some attribute can't be blank"
   end
 
   it 'can convert an "ActiveRecord::RecordInvalid"' do
     record = ErratumTestModel.new
     record.valid?
     resource_persistence_error = ActiveRecord::RecordInvalid.new(record)
-    error                      = ResourcePersistenceError.
+    errors                     = ResourcePersistenceError.
                                    convert(resource_persistence_error)
+    error                      = errors.first
 
-    expect(error.attributes).to eql('some_attribute' => nil)
-    expect(error.errors).to     eql ["Some attribute can't be blank"]
+    expect(error.pointer).to   eql '/data/attributes/some_attribute'
+    expect(error.attribute).to eql 'someAttribute'
+    expect(error.value).to     eql ''
+    expect(error.detail).to    eql "Some attribute can't be blank"
   end
 end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: erratum
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - thegranddesign
@@ -31,7 +31,7 @@ cert_chain:
   zRIv8lqQM8QFT76rzP5SBCERwN+ltKAFbQ5/FwmZNGWYnmCP3RZMQiRnbh+9H9lh
   mlbwaYZTjgsXq6cy8N38EecewgBbZYS1IYJraE/M
   -----END CERTIFICATE-----
-date: 2016-05-12 00:00:00.000000000 Z
+date: 2016-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec