human_error 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8b87c5a22db771619d2acebf4366be06025cf2fa
-  data.tar.gz: 9264a39f94e6c6b054b608564ada1347418c907f
+  metadata.gz: 40266972f0c31dc4ec24f48df7d66a46f19a89a1
+  data.tar.gz: 08b74ad4f42e1ee8fa9fe53a51baf0dae31861b5
 SHA512:
-  metadata.gz: d2cf3e74bda9aca504b2f17aef58a0533d29df07f91974ca94d43a81427b408fd255acbc88b6de1c71d26c470a6c8f0dd28a92130417975530b3eba8e1205315
-  data.tar.gz: f14a129a5374268528578006185a1851168be6c7ef99c2d04da8337ffe83b1ff153ae3d8cca8964bf04bc1334b79e4b9076e858f0b32cb0b26de2b53976bdb7b
+  metadata.gz: c64dc30c85833c395b3b2b2a943ca972ad1c94ceb68a1a2f71a2a68e5020f0d1f22794ae4bca3f87e1bdd31318c6c5424892260c37f0ef251614277406d3d5fa
+  data.tar.gz: a6b564f1d96f02b53e7ffb01aaa0864035b20465125267d5fc3eefb266465b1d89e14eda573145238084f0afd70aeaf6474aac63c77016c3f668a50d665d361c

data/lib/human_error.rb

@@ -2,5 +2,23 @@ require 'human_error/version'
 require 'human_error/error'
 require 'human_error/errors'
 
-module  HumanError
+class   HumanError
+  attr_accessor :configuration
+
+  def initialize
+    self.configuration = Configuration.new
+
+    yield configuration if block_given?
+  end
+
+  def fetch(error_type, **args)
+    Object.const_get("HumanError::Errors::#{error_type}").
+      new(configuration.to_h.merge(**args))
+  end
+
+  def raise(error_type, **args)
+    error = fetch(error_type, **args)
+
+    Kernel.raise error
+  end
 end

data/lib/human_error/configuration.rb

@@ -1,8 +1,16 @@
-module  HumanError
+class   HumanError
   class Configuration
     attr_accessor :api_version,
                   :api_error_documentation_url,
                   :knowledgebase_url
+
+    def to_h
+      {
+        knowledgebase_url:            knowledgebase_url,
+        api_error_documentation_url:  api_error_documentation_url,
+        api_version:                  api_version,
+      }
+    end
   end
 
   def self.configure

data/lib/human_error/error.rb

@@ -3,7 +3,7 @@ require 'human_error/configuration'
 require 'human_error/error_code_directory'
 require 'human_error/knowledgebase_id_directory'
 
-module  HumanError
+class   HumanError
 module  Error
   attr_accessor :api_version,
                 :api_error_documentation_url,

data/lib/human_error/error_code_directory.rb

@@ -1,4 +1,4 @@
-module  HumanError
+class   HumanError
 class   ErrorCodeDirectory
   def self.lookup(error_class)
     directory[error_class]

data/lib/human_error/errors/authentication_error.rb

@@ -1,4 +1,4 @@
-module  HumanError
+class   HumanError
 module  Errors
 module  AuthenticationError
 end

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

@@ -1,7 +1,7 @@
 require 'human_error/errors/request_error'
 require 'human_error/errors/authentication_error'
 
-module  HumanError
+class   HumanError
 module  Errors
 class   DuplicateAuthenticationError < RequestError
   include AuthenticationError

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

@@ -1,7 +1,7 @@
 require 'human_error/errors/request_error'
 require 'human_error/errors/authentication_error'
 
-module  HumanError
+class   HumanError
 module  Errors
 class   InvalidTokenError < RequestError
   include AuthenticationError

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

@@ -1,7 +1,7 @@
 require 'human_error/errors/request_error'
 require 'human_error/errors/authentication_error'
 
-module  HumanError
+class   HumanError
 module  Errors
 class   InvalidUsernameOrPasswordError < RequestError
   include AuthenticationError

data/lib/human_error/errors/crud_error.rb

@@ -1,4 +1,4 @@
-module  HumanError
+class   HumanError
 module  Errors
 module  CrudError
   attr_accessor :resource_name,

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

@@ -1,7 +1,7 @@
 require 'human_error/errors/crud_error'
 require 'human_error/errors/request_error'
 
-module  HumanError
+class   HumanError
 module  Errors
 class   ResourceNotFoundError < RequestError
   include CrudError

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

@@ -1,7 +1,7 @@
 require 'human_error/errors/crud_error'
 require 'human_error/errors/request_error'
 
-module  HumanError
+class   HumanError
 module  Errors
 class   ResourcePersistenceError < RequestError
   include CrudError

data/lib/human_error/errors/request_error.rb

@@ -1,7 +1,7 @@
 require 'human_error/error'
 require 'human_error/utilities/string'
 
-module  HumanError
+class   HumanError
 module  Errors
 class   RequestError < RuntimeError
   include HumanError::Error

data/lib/human_error/knowledgebase_id_directory.rb

@@ -1,4 +1,4 @@
-module  HumanError
+class   HumanError
 class   KnowledgebaseIdDirectory
   def self.lookup(error_class)
     directory[error_class]

data/lib/human_error/utilities/string.rb

@@ -1,4 +1,4 @@
-module  HumanError
+class   HumanError
 module  Utilities
 class   String
   def self.underscore(other)

data/lib/human_error/version.rb

@@ -1,3 +1,3 @@
-module HumanError
-  VERSION = '1.3.0'
+class HumanError
+  VERSION = '1.4.0'
 end

data/spec/lib/human_error/configuration_spec.rb

@@ -1,7 +1,7 @@
 require 'rspectacular'
 require 'human_error/configuration'
 
-module    HumanError
+class     HumanError
 describe  Configuration do
   it 'can set the API version' do
     configuration = Configuration.new
@@ -23,5 +23,17 @@ describe  Configuration do
 
     expect(configuration.knowledgebase_url).to eql 'whateeeeeever'
   end
+
+  it 'can convert itself into a hash' do
+    configuration                             = Configuration.new
+    configuration.knowledgebase_url           = 'knowledgebase_url'
+    configuration.api_error_documentation_url = 'api_error_documentation_url'
+    configuration.api_version                 = 'api_version'
+
+    expect(configuration.to_h).to eql(
+      knowledgebase_url:           'knowledgebase_url',
+      api_error_documentation_url: 'api_error_documentation_url',
+      api_version:                 'api_version',)
+  end
 end
 end

data/spec/lib/human_error/error_spec.rb

@@ -5,7 +5,7 @@ class CustomError < RuntimeError
   extend HumanError::Error
 end
 
-module    HumanError
+class     HumanError
 describe  Error do
   it 'can wrap an error with another error' do
     original_error = RuntimeError.new('My Runtime Error Message')

data/spec/lib/human_error/errors/authentication_errors/duplicate_authentication_error_spec.rb

@@ -1,7 +1,7 @@
 require 'rspectacular'
 require 'human_error/errors/authentication_errors/duplicate_authentication_error'
 
-module    HumanError
+class     HumanError
 module    Errors
 describe  DuplicateAuthenticationError do
   let(:error) { DuplicateAuthenticationError.new(provider:         'flibbity',

data/spec/lib/human_error/errors/authentication_errors/invalid_token_error_spec.rb

@@ -1,7 +1,7 @@
 require 'rspectacular'
 require 'human_error/errors/authentication_errors/invalid_token_error'
 
-module    HumanError
+class     HumanError
 module    Errors
 describe  InvalidTokenError do
   let(:error) { InvalidTokenError.new }

data/spec/lib/human_error/errors/authentication_errors/invalid_username_or_password_error_spec.rb

@@ -1,7 +1,7 @@
 require 'rspectacular'
 require 'human_error/errors/authentication_errors/invalid_username_or_password_error'
 
-module    HumanError
+class     HumanError
 module    Errors
 describe  InvalidUsernameOrPasswordError do
   let(:error) { InvalidUsernameOrPasswordError.new }

data/spec/lib/human_error/errors/crud_errors/resource_not_found_error_spec.rb

@@ -1,7 +1,7 @@
 require 'rspectacular'
 require 'human_error/errors/crud_errors/resource_not_found_error'
 
-module    HumanError
+class     HumanError
 module    Errors
 describe  ResourceNotFoundError do
   let(:error) { ResourceNotFoundError.new }

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

@@ -1,7 +1,7 @@
 require 'rspectacular'
 require 'human_error/errors/crud_errors/resource_persistence_error'
 
-module    HumanError
+class     HumanError
 module    Errors
 describe  ResourcePersistenceError do
   let(:error) { ResourcePersistenceError.new }

data/spec/lib/human_error/errors/request_error_spec.rb

@@ -1,7 +1,7 @@
 require 'rspectacular'
 require 'human_error/errors/request_error'
 
-module    HumanError
+class     HumanError
 module    Errors
 describe  RequestError do
   it 'can generate error data' do

data/spec/lib/human_error_spec.rb

@@ -0,0 +1,62 @@
+require 'rspectacular'
+require 'human_error'
+
+describe HumanError do
+  it 'can create an instance of HumanError' do
+    expect(HumanError.new).to be_a HumanError
+  end
+
+  it 'can configure each instance' do
+    human_error = HumanError.new do |config|
+                    config.api_version = 'foo'
+                  end
+
+    expect(human_error.configuration.api_version).to eql 'foo'
+  end
+
+  it 'can lookup errors' do
+    human_error = HumanError.new
+
+    expect(human_error.fetch('RequestError')).to be_a HumanError::Errors::RequestError
+  end
+
+  it 'can lookup errors based on the local configuration' do
+    human_error = HumanError.new do |config|
+      config.api_version = 'foo'
+    end
+
+    fetched_error = human_error.fetch('RequestError')
+
+    expect(fetched_error.api_version).to eql 'foo'
+  end
+
+  it 'can override values in the global configuration with values in the local configuration when looking up an error' do
+    HumanError.configure do |config|
+      config.api_version = 'bar'
+    end
+
+    human_error = HumanError.new do |config|
+      config.api_version = 'foo'
+    end
+
+    fetched_error = human_error.fetch('RequestError')
+
+    expect(fetched_error.api_version).to eql 'foo'
+  end
+
+  it 'can override values in the local configuration with explicit values passed when looking up an error' do
+    human_error = HumanError.new do |config|
+      config.api_version = 'foo'
+    end
+
+    fetched_error = human_error.fetch('RequestError', api_version: 'bar')
+
+    expect(fetched_error.api_version).to eql 'bar'
+  end
+
+  it 'can raise an error' do
+    human_error = HumanError.new
+
+    expect { human_error.raise('RequestError') }.to raise_error HumanError::Errors::RequestError
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: human_error
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - jfelchner
@@ -85,6 +85,7 @@ files:
 - spec/lib/human_error/errors/crud_errors/resource_not_found_error_spec.rb
 - spec/lib/human_error/errors/crud_errors/resource_persistence_error_spec.rb
 - spec/lib/human_error/errors/request_error_spec.rb
+- spec/lib/human_error_spec.rb
 homepage: https://github.com/thekompanee/human_error
 licenses: []
 metadata: {}
@@ -118,4 +119,5 @@ test_files:
 - spec/lib/human_error/errors/crud_errors/resource_not_found_error_spec.rb
 - spec/lib/human_error/errors/crud_errors/resource_persistence_error_spec.rb
 - spec/lib/human_error/errors/request_error_spec.rb
+- spec/lib/human_error_spec.rb
 has_rdoc: