human_error 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f2554d092cad72ca391ae12a0d685e65c7cd5f87
-  data.tar.gz: 86be8d5d478e44f36bc91d4553da0c36cef75052
+  metadata.gz: c2a02b1eac36cbd434a65f917be7e4a2fcd46b15
+  data.tar.gz: a644e1253d0fd7707c8d2a96b9bc6309ac5f18b5
 SHA512:
-  metadata.gz: 0260892f92309a5efe0b665fe615b685eb25dac08623eea49dbffd62bb47fdca762c567f7b6234eceac9268d8ac9a2869bfe27c2789ab287ee85726e3b88f489
-  data.tar.gz: d44beaf3bd2c32dd1fa6c3f7d18eb111af1f0f0beb95dd1b69cd51de3bd0965601d1a90bf80c7a6b4f2bfef151aafd72f8e6f6f2911daf84e77428e3b631a9f4
+  metadata.gz: 7db25d17b98cbcb92a16e267fb847a6708d3140ab682148c8c27037884feb5fdcf1c95ad432481f7ee01cfa86b1d5d73e02ac5fd41f0eb3423849b1650dd1032
+  data.tar.gz: 42450a0be1844e0483c3157829ec0275ffcf7b650cbe52cb6f31e22501b6f99ba33d89b26a58b51ac15d89083fb31474ad849cdbaf3211514e7bc70ee0aec9eb

data/lib/human_error/error.rb

@@ -1,11 +1,14 @@
+require 'json'
 require 'human_error/configuration'
 require 'human_error/error_code_directory'
+require 'human_error/knowledgebase_id_directory'
 
 module  HumanError
 module  Error
   attr_accessor :api_version,
                 :api_error_documentation_url,
                 :knowledgebase_url,
+                :knowledgebase_article_id,
                 :code
 
   def initialize(**args)
@@ -22,6 +25,18 @@ module  Error
     @code || ErrorCodeDirectory.lookup(self.class.name)
   end
 
+  def knowledgebase_article_id
+    @knowledgebase_article_id || KnowledgebaseIdDirectory.lookup(self.class.name)
+  end
+
+  def customer_support_uri
+    "#{knowledgebase_url}/#{knowledgebase_article_id}"
+  end
+
+  def to_json
+    JSON.dump(as_json)
+  end
+
   def wrap(other)
     wrapped_error = new "#{other.class.name}: #{other.message}"
     wrapped_error.set_backtrace other.backtrace

data/lib/human_error/error_code_directory.rb

@@ -12,6 +12,7 @@ class   ErrorCodeDirectory
       'HumanError::Errors::InvalidUsernameOrPasswordError' => 1004,
       'HumanError::Errors::ResourceNotFoundError'          => 1005,
       'HumanError::Errors::ResourcePersistenceError'       => 1006,
+      'Apill::Errors::InvalidApiRequestError'              => 1007,
     }
   end
 end

data/lib/human_error/errors/authentication_errors/invalid_token_error.rb

@@ -18,10 +18,6 @@ class   InvalidTokenError < RequestError
     401
   end
 
-  def knowledgebase_article_id
-    '1234567890'
-  end
-
   def developer_message
     'The token you attempted to use for this request is invalid for this resource.  Please double-check and try again.'
   end

data/lib/human_error/errors/authentication_errors/invalid_username_or_password_error.rb

@@ -18,10 +18,6 @@ class   InvalidUsernameOrPasswordError < RequestError
     401
   end
 
-  def knowledgebase_article_id
-    '1234567890'
-  end
-
   def developer_message
     'Either the username or password passed in or this request is invalid.  Please double-check and try again.'
   end

data/lib/human_error/errors/crud_errors/resource_not_found_error.rb

@@ -10,10 +10,6 @@ class   ResourceNotFoundError < RequestError
     404
   end
 
-  def knowledgebase_article_id
-    '1234567890'
-  end
-
   def developer_message
     "The #{resource_name} you attempted to #{action} for this request is either not authorized for the authenticated user or does not exist."
   end

data/lib/human_error/errors/request_error.rb

@@ -9,8 +9,7 @@ class   RequestError < RuntimeError
   attr_accessor :http_status,
                 :developer_message,
                 :developer_details,
-                :friendly_message,
-                :knowledgebase_article_id
+                :friendly_message
 
   def as_json(options = {})
     {
@@ -34,10 +33,6 @@ class   RequestError < RuntimeError
     "#{api_error_documentation_url}/#{code}?version=#{api_version}"
   end
 
-  def customer_support_uri
-    "#{knowledgebase_url}/#{knowledgebase_article_id}"
-  end
-
   def base_message_key
     HumanError::Utilities::String.
       underscore(self.class.name).

data/lib/human_error/errors.rb

@@ -0,0 +1,7 @@
+require 'human_error/errors/request_error'
+require 'human_error/errors/authentication_error'
+require 'human_error/errors/authentication_errors/invalid_token_error'
+require 'human_error/errors/authentication_errors/invalid_username_or_password_error'
+require 'human_error/errors/crud_error'
+require 'human_error/errors/crud_errors/resource_not_found_error'
+require 'human_error/errors/crud_errors/resource_persistence_error'

data/lib/human_error/knowledgebase_id_directory.rb

@@ -0,0 +1,19 @@
+module  HumanError
+class   KnowledgebaseIdDirectory
+  def self.lookup(error_class)
+    directory[error_class]
+  end
+
+  private
+
+  def self.directory
+    {
+      'HumanError::Errors::InvalidTokenError'              => '1234567890',
+      'HumanError::Errors::InvalidUsernameOrPasswordError' => '1234567890',
+      'HumanError::Errors::ResourceNotFoundError'          => '1234567890',
+      'HumanError::Errors::ResourcePersistenceError'       => '1234567890',
+      'Apill::Errors::InvalidApiRequestError'              => '1234567890',
+    }
+  end
+end
+end

data/lib/human_error/version.rb

@@ -1,3 +1,3 @@
 module HumanError
-  VERSION = '1.0.0'
+  VERSION = '1.1.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: human_error
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - jfelchner
@@ -65,6 +65,7 @@ files:
 - lib/human_error/configuration.rb
 - lib/human_error/error.rb
 - lib/human_error/error_code_directory.rb
+- lib/human_error/errors.rb
 - lib/human_error/errors/authentication_error.rb
 - lib/human_error/errors/authentication_errors/invalid_token_error.rb
 - lib/human_error/errors/authentication_errors/invalid_username_or_password_error.rb
@@ -72,6 +73,7 @@ files:
 - lib/human_error/errors/crud_errors/resource_not_found_error.rb
 - lib/human_error/errors/crud_errors/resource_persistence_error.rb
 - lib/human_error/errors/request_error.rb
+- lib/human_error/knowledgebase_id_directory.rb
 - lib/human_error/utilities/string.rb
 - lib/human_error/version.rb
 - spec/lib/human_error/configuration_spec.rb