json_api_errors 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 219823740300d0c07615a10a0f91d246e2fbbc91
-  data.tar.gz: c59eb5ff63205364889f88bbb453cef5d0718ebc
+  metadata.gz: 36ac2c5fb9d968b75836ce8791362284e788566b
+  data.tar.gz: 28d1da3d6d77f5a8c8a4d27ce1bfe6f4437e361c
 SHA512:
-  metadata.gz: 38eefbf3667d3633a6daf1bb0eba66044092684d60966abc2100daa230fa1e2b39867c85343678ee0080461e112841e2a635b2fe19ae16c181a900e925e3f0a6
-  data.tar.gz: dd0c0a136d6f3dbdcd080ca3b0627605bd962c9ef56353ade8a77dbb1251a7ec30205771b89db973b1f616c29fe357c351d3e1b4a6cf8813e30dd5809a4afc74
+  metadata.gz: 67fe62cc645b89a55c5743b8717cc7854cc59a7ba034aed0e112a9fd025c2bbfd8cdf7aae5aa329485b636f37a2e5edc6c610e62eb892b5fa102eac9e9ac826a
+  data.tar.gz: 671bfedcf9fdc3a951b42497d707a0aed0873356980dcc2939678e0391d54dea56df228bb510f900cb262856208c35a74eb4adb52fbddb964416ab0ec9248ed0

data/lib/json_api_errors/default/code.rb

@@ -0,0 +1,21 @@
+# 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

@@ -0,0 +1,21 @@
+# 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

@@ -0,0 +1,18 @@
+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

@@ -0,0 +1,21 @@
+# 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

@@ -0,0 +1,26 @@
+# 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

@@ -0,0 +1,23 @@
+# 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

@@ -0,0 +1,31 @@
+# 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

@@ -0,0 +1,21 @@
+# 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

@@ -0,0 +1,23 @@
+# 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

data/lib/json_api_errors/error.rb

@@ -0,0 +1,134 @@
+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"
+
+# JsonApiErrors::Error
+# ====================
+#
+# An error object that by default conforms to the JsonAPI error spec.
+# See: http://jsonapi.org/format/#errors
+#
+# When you initialize a new instance of JsonApiErrors::Error without any
+# arguments, you receive an error object with default values. The defaults
+# only serve to demonstrate what an error following the entire spec looks like.
+# Other than that they are not helpful because it's difficult to know exactly
+# what a default error means. So you need to configure the error you wish to generate.
+#
+# 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.
+#
+
+module JsonApiErrors
+  class Error
+
+    attr_accessor :error, :id, :status, :links, :code, :title, :detail,
+                  :source, :meta
+
+    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 )
+
+      @error   = error
+      @id      = id
+      @status  = status
+      @code    = code
+      @links   = links
+      @title   = title
+      @detail  = detail
+      @source  = source
+      @meta    = meta
+
+      yield(self) if block_given?
+    end
+
+    def call
+      error.call(self)
+    end
+
+    def status_code
+      status.to_s
+    end
+  end
+end

data/lib/json_api_errors/error_collection.rb

@@ -0,0 +1,23 @@
+require 'delegate'
+
+module JsonApiErrors
+  class ErrorCollection < DelegateClass(Array)
+    def initialize
+      super([])
+    end
+
+    def add_error(error)
+      self << error
+    end
+
+    def call
+      {
+        errors: self.map! { |e| e.call }
+      }
+    end
+
+    def generic_status
+      200
+    end
+  end
+end

data/lib/json_api_errors/version.rb

@@ -1,3 +1,3 @@
 module JsonApiErrors
-  VERSION = "0.1.0"
+  VERSION = "0.1.2"
 end

data/lib/json_api_errors.rb

@@ -1,4 +1,6 @@
 require "json_api_errors/version"
+require "json_api_errors/error"
+require "json_api_errors/error_collection"
 
 module JsonApiErrors
   # Your code goes here...

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: json_api_errors
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - byelipk
@@ -72,6 +72,17 @@ files:
 - bin/setup
 - 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/version.rb
 homepage: https://github.com/byelipk/json_api_errors
 licenses: