json_api_errors 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4efbecc44a6f1b6d441e174b89002870d943f0c6
-  data.tar.gz: b26b6d1af206276ce292be1b45032833e72545a1
+  metadata.gz: 85d06f167f7623264a1e0da8cf01dccba411f60a
+  data.tar.gz: 5c00220d6f9251084aef53416805de62f2b0a718
 SHA512:
-  metadata.gz: 0f659defbe116065118a2de7941d2bff3764945388fc4a1faeda85d1ef5aac1db3a0e9716b55555e04f5027efc54ffb8d7bbfd476da00bf9ff100e636255ede8
-  data.tar.gz: a504608277be45cbf8b6ed5df8adc5303dddf98c2d568f3717c4a73db09cee0388d66daf9c9b172e712f586824e38d52b368e7f1e3f8a9b56f78a9066e5517e9
+  metadata.gz: fbb9c009e3ca161a76249452e1d20994f9b08a22aeef1b414ed5516771d3c12a46775aeab98dfb3143c9fded10a7f72f07ff90bed55d608f8a9a00709d9d22dd
+  data.tar.gz: a96ac527f00904eb7e8f41554d2b646b0ba683bb78eb539a0f4f08add6ca1d6df3b83d019bccefb0866c39110b03e5e905073fd8b365b63d334d5659a3f59c04

data/README.md

@@ -76,7 +76,7 @@ So you want an error object? Well, all you need to do is this:
      @title=#<JsonApiErrors::Default::Title:0x007ff753941568>>
 ```
 
-A `JsonApiError::Error` implements `#call`. So to get a hash representation
+A `JsonApiErrors::Error` implements `#call`. So to get a hash representation
 of your error, which can be serialized into JSON, you need to send the `#call`
 message to your error object:
 
@@ -220,7 +220,7 @@ override either the `#to_s` or `#to_h`. (This project was built using Ruby 2.2.2
 
 The [Json API spec](http://jsonapi.org/format/#error-objects) mentions that all
 errors MUST have the keyword `errors` at the root. For this purpose there is
-`JsonApiError::ErrorCollection`. To get a fully qualified hash representation
+`JsonApiErrors::ErrorCollection`. To get a fully qualified hash representation
 of your error you can:
 
 ```ruby

data/lib/json_api_errors/error.rb

@@ -1,12 +1,6 @@
-require "json_api_errors/default/id"
-require "json_api_errors/default/code"
-require "json_api_errors/default/status"
-require "json_api_errors/default/title"
-require "json_api_errors/default/detail"
-require "json_api_errors/default/links"
-require "json_api_errors/default/source"
-require "json_api_errors/default/meta"
-require "json_api_errors/default/error"
+require "json_api_errors/templates"
+require "json_api_errors/templates/default"
+require "forwardable"
 
 # JsonApiErrors::Error
 # ====================
@@ -22,109 +16,33 @@ require "json_api_errors/default/error"
 #
 # There are two parts to configuring an error object:
 #
-# First, you'll need to create a template.
-#
-# Second, you'll need to configure the attributes you want to be displayed
-# in the template.
-#
-# The easiest way to do this is by creating a lambda whose body is a hash
-# representing the template you wish to be displayed. Then pass a block to the
-# initializer:
-#
-#       template = ->(error) do
-#         {
-#           status: error.status,
-#           code:   error.code
-#         }
-#       end
-#
-#       error = JsonApiErrors::Error.new do |config|
-#         config.error  = template
-#         config.status = "400"
-#         config.code   = "Bad Request"
-#       end
-#
-#       error.call  => { status: "400", code: "Bad Request" }
-#
-#
-# You can also pass in literal values for the attributes for the attributes
-# as well as inject them into the initializer:
-#
-#       JsonApiErrors::Error.new( error:  CustomError.new,
-#                                 status: CustomStatus.new,
-#                                 code:   CustomCode.new,
-#                                 links:  CustomLinks.new )
-#
-#
-#       error.call  => { status: "400",
-#                        code: "Bad Request",
-#                        links: {
-#                          about: "www.example.org"
-#                         }
-#                       }
-#
-# Here's how you would define those classes:
-#
-#      class CustomError
-#        def call(error)
-#          {
-#            status: error.status.to_s,
-#            code:   error.code.to_s,
-#            links:  error.links.to_h
-#          }
-#        end
-#      end
-#
-#      class CustomStatus
-#        def to_s; "400"; end
-#      end
-#
-#      class CustomCode
-#        def to_s; "Bad Request"; end
-#      end
-#
-#      class CustomLinks
-#        def to_h; { about: "www.example.com" }; end
-#      end
-#
-# Note:
-# =====
-# The error class must implement #call and it receives an error object as an argument.
-# Classes that define id, status, code, title, detail must implement #to_s.
-# Classes that define links, source, and meta must implement #to_h.
-#
+# TODO: I've overhauled the mechanism for creating error objects. I've opted to
+# inject error templates into the error object. The initializer no longer takes
+# an implicit block. I need to document this change.
+
 
 module JsonApiErrors
   class Error
 
-    attr_accessor :error, :id, :status, :links, :code, :title, :detail,
-                  :source, :meta
+    extend Forwardable
 
-    def initialize( error:  JsonApiErrors::Default::Error.new,
-                    id:     JsonApiErrors::Default::Id.new,
-                    status: JsonApiErrors::Default::Status.new,
-                    code:   JsonApiErrors::Default::Code.new,
-                    links:  JsonApiErrors::Default::Links.new,
-                    title:  JsonApiErrors::Default::Title.new,
-                    detail: JsonApiErrors::Default::Detail.new,
-                    source: JsonApiErrors::Default::Source.new,
-                    meta:   JsonApiErrors::Default::Meta.new )
+    attr_accessor :template
 
-      @error   = error
-      @id      = id
-      @status  = status
-      @code    = code
-      @links   = links
-      @title   = title
-      @detail  = detail
-      @source  = source
-      @meta    = meta
-
-      yield(self) if block_given?
+    def initialize(template: JsonApiErrors::Templates::Default.new)
+      @template = template
     end
 
+    def_delegators :template, :id,
+                              :status,
+                              :code,
+                              :links,
+                              :title,
+                              :detail,
+                              :source,
+                              :meta
+
     def call
-      error.call(self)
+      template.call
     end
 
     def status_code

data/lib/json_api_errors/templates/default.rb

@@ -0,0 +1,57 @@
+module JsonApiErrors
+  module Templates
+    class Default
+      def call
+        {
+          id:     id,
+          status: status,
+          code:   code,
+          links:  links,
+          title:  title,
+          detail: detail,
+          source: source,
+          meta:   meta
+        }
+      end
+
+      def id
+        "default-id"
+      end
+
+      def status
+        "default_status"
+      end
+
+      def code
+        "default-code"
+      end
+
+      def links
+        {
+          about: "default-links"
+        }
+      end
+
+      def title
+        "default-title"
+      end
+
+      def detail
+        "default_detail"
+      end
+
+      def source
+        {
+          pointer: "default-pointer",
+          parameter: "default-parameter"
+        }
+      end
+
+      def meta
+        {
+          meta: "default-meta"
+        }
+      end
+    end
+  end
+end

data/lib/json_api_errors/templates.rb

@@ -0,0 +1,4 @@
+module JsonApiErrors
+  module Templates
+  end
+end

data/lib/json_api_errors/version.rb

@@ -1,3 +1,3 @@
 module JsonApiErrors
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: json_api_errors
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - byelipk
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-20 00:00:00.000000000 Z
+date: 2015-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -70,21 +70,13 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- json_api_errors-0.1.2.gem
-- json_api_errors-0.1.3.gem
+- json_api_errors-0.1.4.gem
 - json_api_errors.gemspec
 - lib/json_api_errors.rb
-- lib/json_api_errors/default/code.rb
-- lib/json_api_errors/default/detail.rb
-- lib/json_api_errors/default/error.rb
-- lib/json_api_errors/default/id.rb
-- lib/json_api_errors/default/links.rb
-- lib/json_api_errors/default/meta.rb
-- lib/json_api_errors/default/source.rb
-- lib/json_api_errors/default/status.rb
-- lib/json_api_errors/default/title.rb
 - lib/json_api_errors/error.rb
 - lib/json_api_errors/error_collection.rb
+- lib/json_api_errors/templates.rb
+- lib/json_api_errors/templates/default.rb
 - lib/json_api_errors/version.rb
 homepage: https://github.com/byelipk/json_api_errors
 licenses:

data/lib/json_api_errors/default/code.rb

@@ -1,21 +0,0 @@
-# DefaultCode
-# ===========
-#
-# This is the default error code. To override this you can create your own
-# class that implements #to_s and inject it into the constructor
-# like this:
-#
-# JsonAPI::Error.new(status: MySpecialErrorCodeClass.new)
-#
-# From the api docs:
-#
-# an application-specific error code, expressed as a string value.
-module JsonApiErrors
-  module Default
-    class Code
-      def to_s
-        "default-code"
-      end
-    end
-  end
-end

data/lib/json_api_errors/default/detail.rb

@@ -1,21 +0,0 @@
-# DefaultDetail
-# =============
-#
-# This is the default error detail. To override this you can create your own
-# class that implements #to_s and inject it into the constructor
-# like this:
-#
-# JsonAPI::Error.new(detail: MySpecialErrorDetailClass.new)
-#
-# From the api docs:
-#
-# a human-readable explanation specific to this occurrence of the problem.
-module JsonApiErrors
-  module Default
-    class Detail
-      def to_s
-        "default-detail"
-      end
-    end
-  end
-end

data/lib/json_api_errors/default/error.rb

@@ -1,18 +0,0 @@
-module JsonApiErrors
-  module Default
-    class Error
-      def call(error)
-        {
-          id:     error.id.to_s,
-          links:  error.links.to_h,
-          status: error.status.to_s,
-          code:   error.code.to_s,
-          title:  error.title.to_s,
-          detail: error.detail.to_s,
-          source: error.source.to_h,
-          meta:   error.meta.to_h
-        }
-      end
-    end
-  end
-end

data/lib/json_api_errors/default/id.rb

@@ -1,21 +0,0 @@
-# DefaultId
-# =========
-#
-# This is the default error id. To override this you can create your own
-# class that implements #to_s and inject it into the constructor
-# like this:
-#
-# JsonAPI::Error.new(id: MySpecialErrorIdClass.new)
-#
-# From the api docs:
-#
-# a unique identifier for this particular occurrence of the problem.
-module JsonApiErrors
-  module Default
-    class Id
-      def to_s
-        "default-id"
-      end
-    end
-  end
-end

data/lib/json_api_errors/default/links.rb

@@ -1,26 +0,0 @@
-# DefaultLinks
-# ============
-#
-# This is the default error links. To override this you can create your own
-# class that implements #to_hash and inject it into the constructor
-# like this:
-#
-# JsonAPI::Error.new(links: MySpecialErrorLinksClass.new)
-#
-# From the api docs:
-#
-# a links object containing the following members:
-#
-# about: a link that leads to further details about this particular
-#        occurrence of the problem.
-module JsonApiErrors
-  module Default
-    class Links
-      def to_h
-        {
-          about: "default-links"
-        }
-      end
-    end
-  end
-end

data/lib/json_api_errors/default/meta.rb

@@ -1,23 +0,0 @@
-# DefaultMeta
-# ===========
-#
-# This is the default error meta information. To override this you can create your own
-# class that implements #to_hash and inject it into the constructor
-# like this:
-#
-# JsonAPI::Error.new(meta: MySpecialErrorMetaClass.new)
-#
-# From the api docs:
-#
-# a meta object containing non-standard meta-information about the error.
-module JsonApiErrors
-  module Default
-    class Meta
-      def to_h
-        {
-          extra_info: "default-meta"
-        }
-      end
-    end
-  end
-end

data/lib/json_api_errors/default/source.rb

@@ -1,31 +0,0 @@
-# DefaultSource
-# =============
-#
-# This is the default error source. To override this you can create your own
-# class that implements #to_hash and inject it into the constructor
-# like this:
-#
-# JsonAPI::Error.new(source: MySpecialErrorSourceClass.new)
-#
-# From the api docs:
-#
-# an object containing references to the source of the error, optionally
-# including any of the following members:
-#
-# pointer: a JSON Pointer [RFC6901] to the associated entity in the
-#          request document [e.g. "/data" for a primary data object,
-#          or "/data/attributes/title" for a specific attribute].
-#
-# parameter: a string indicating which query parameter caused the error.
-module JsonApiErrors
-  module Default
-    class Source
-      def to_h
-        {
-          pointer: "default-pointer",
-          parameter: "default-parameter"
-        }
-      end
-    end
-  end
-end

data/lib/json_api_errors/default/status.rb

@@ -1,21 +0,0 @@
-# DefaultStatus
-# =============
-#
-# This is the default error status code. To override this you can create your own
-# class that implements #to_s and inject it into the constructor
-# like this:
-#
-# JsonAPI::Error.new(status: MySpecialErrorStatusClass.new)
-#
-# From the api docs:
-#
-# the HTTP status code applicable to this problem, expressed as a string value.
-module JsonApiErrors
-  module Default
-    class Status
-      def to_s
-        "422"
-      end
-    end
-  end
-end

data/lib/json_api_errors/default/title.rb

@@ -1,23 +0,0 @@
-# DefaultTitle
-# ============
-#
-# This is the default error title. To override this you can create your own
-# class that implements #to_s and inject it into the constructor
-# like this:
-#
-# JsonAPI::Error.new(title: MySpecialErrorTitleClass.new)
-#
-# From the api docs:
-#
-# a short, human-readable summary of the problem that SHOULD NOT change
-# from occurrence to occurrence of the problem, except for purposes of
-# localization.
-module JsonApiErrors
-  module Default
-    class Title
-      def to_s
-        "default-title"
-      end
-    end
-  end
-end