human_error 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 17aba5f28df14fa69f37785ddb08659985741d9b
-  data.tar.gz: a39be0f21794151eaebf056663e327b3499b3b91
+  metadata.gz: ce3584e03d830added3a0b58d9fa67995aba2b62
+  data.tar.gz: ce828a6fd224bc186e2da06ce1c007ea3cbad3fa
 SHA512:
-  metadata.gz: 88747c7a2352b0cdd2d7b9867c481f033b987f353b1af78faa649ebfeb6c015dc23fdf2b0b550eb01e63e0710d397549da10857ab72d85395ea28a2ca97bd8ec
-  data.tar.gz: 1d4b15fbb41d93ed4eb13854d21d39535a7a402ecbbcb66b4fd4c9504ebcd656534efd3ba2081214539d0832bcf0cd5ed3eccfc1350d135a8c29e1ca70b75ce7
+  metadata.gz: 2383d7ae1f37c0ae716b39526cd6ade1365f09ffd9eaeb5784957e26f8cfa46e77c1593f64a0afc71c4e93627096d363887b31550125cfdd73be29d8b803ccb5
+  data.tar.gz: cb3efadd3dd1f368b5889474b27ca8830bd971470b18c4888589f09bcbddae1877a133f1d903268d6f14647273cf038aeaa1daeb970adc1848d3cfc1c4183209

data/lib/human_error.rb

@@ -1,31 +1,29 @@
-require 'human_error/version'
+require 'human_error/configuration'
 require 'human_error/error'
-require 'human_error/errors'
+require 'human_error/errors/authentication_error'
+require 'human_error/errors/authentication_errors/duplicate_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/association_error'
+require 'human_error/errors/crud_errors/resource_not_found_error'
+require 'human_error/errors/crud_errors/resource_persistence_error'
+require 'human_error/errors/request_errors/parameter_missing_error'
+require 'human_error/errors/request_errors/unpermitted_parameters_error'
 require 'human_error/rescuable_resource'
-require 'human_error/verifiable_model'
+require 'human_error/verifiable_resource'
+require 'human_error/version'
 
 class   HumanError
-  attr_accessor :configuration
-
-  def initialize
-    self.configuration = Configuration.new
-
-    yield configuration if block_given?
-  end
-
-  def fetch(error_type)
+  def self.fetch(error_type)
     Object.const_get("HumanError::Errors::#{error_type}")
   end
 
-  def build(error_type, overrides = {})
-    overrides = configuration.to_h.merge(overrides)
-
+  def self.build(error_type, overrides = {})
     fetch(error_type).new(overrides)
   end
 
-  def convert(original_error, overrides = {})
-    overrides = configuration.to_h.merge(overrides)
-
+  def self.convert(original_error, overrides = {})
     case original_error.class.name
     when 'ActiveRecord::InvalidForeignKey'
       fetch('AssociationError').convert(original_error, overrides)
@@ -34,10 +32,14 @@ class   HumanError
     when 'ActiveRecord::RecordInvalid',
          'ActiveRecord::RecordNotSaved'
       fetch('ResourcePersistenceError').convert(original_error, overrides)
+    when 'ActionController::ParameterMissing',
+      fetch('ParameterMissingError').convert(original_error, overrides)
+    when 'ActionController::UnpermittedParameters'
+      fetch('UnpermittedParametersError').convert(original_error, overrides)
     end
   end
 
-  def raise(error_type, **args)
+  def self.raise(error_type, **args)
     Kernel.raise build(error_type, **args)
   end
 end

data/lib/human_error/configuration.rb

@@ -1,16 +1,36 @@
+require 'singleton'
+
 class   HumanError
   class Configuration
-    attr_accessor :api_version,
-                  :api_error_documentation_url,
-                  :knowledgebase_url
+    include Singleton
+
+    attr_accessor :url_mappings
+
+    def external_documentation_urls
+      @external_documentation_urls ||= url_mappings['external_documentation_urls']
+    end
+
+    def developer_documentation_urls
+      @developer_documentation_urls ||= url_mappings['developer_documentation_urls']
+    end
 
     def to_h
       {
-        knowledgebase_url:           knowledgebase_url,
-        api_error_documentation_url: api_error_documentation_url,
-        api_version:                 api_version,
+        external_documentation_urls:  external_documentation_urls,
+        developer_documentation_urls: developer_documentation_urls,
       }
     end
+
+    def url_mappings
+      @url_mappings ||= {
+        'external_documentation_urls'  => {},
+        'developer_documentation_urls' => {},
+      }
+    end
+  end
+
+  def configuration
+    Configuration.instance
   end
 
   def self.configure
@@ -18,6 +38,6 @@ class   HumanError
   end
 
   def self.configuration
-    @configuration ||= Configuration.new
+    Configuration.instance
   end
 end

data/lib/human_error/error.rb

@@ -1,7 +1,6 @@
 require 'json'
 require 'human_error/configuration'
-require 'human_error/error_code_directory'
-require 'human_error/knowledgebase_id_directory'
+require 'human_error/utilities/string'
 
 class   HumanError
 module  Error
@@ -13,41 +12,80 @@ module  Error
     end
   end
 
-  attr_accessor :api_version,
-                :api_error_documentation_url,
-                :knowledgebase_url,
-                :knowledgebase_article_id,
+  attr_accessor :id,
+                :external_documentation_url,
+                :developer_documentation_url,
+                :http_status,
                 :code,
+                :title,
+                :detail,
+                :source,
                 :message
 
   def initialize(**args)
-    self.api_version                 = configuration.api_version
-    self.api_error_documentation_url = configuration.api_error_documentation_url
-    self.knowledgebase_url           = configuration.knowledgebase_url
-
     args.each do |variable, value|
-      send("#{variable}=", value)
+      public_send("#{variable}=", value)
     end
   end
 
-  def code
-    @code || ErrorCodeDirectory.lookup(self.class.name)
+  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,
+        },
+      ],
+    }
   end
 
-  def knowledgebase_article_id
-    @knowledgebase_article_id || KnowledgebaseIdDirectory.lookup(self.class.name)
+  def to_json(_options = {})
+    JSON.dump(as_json)
   end
 
-  def developer_documentation_uri
-    "#{api_error_documentation_url}/#{code}?version=#{api_version}"
+  def id
+    @id ||= SecureRandom.uuid
   end
 
-  def customer_support_uri
-    "#{knowledgebase_url}/#{knowledgebase_article_id}"
+  def external_documentation_url
+    @external_documentation_url ||= configuration.external_documentation_urls[code]
   end
 
-  def to_json(_options = {})
-    JSON.dump(as_json)
+  def developer_documentation_url
+    @developer_documentation_url ||= configuration.developer_documentation_urls[code]
+  end
+
+  def http_status
+    @http_status ||= 500
+  end
+
+  alias_method :status, :http_status
+
+  def code
+    @code ||= HumanError::Utilities::String.
+                underscore(self.class.name).
+                gsub(%r{\A[^/]+/}, '').
+                gsub(%r{/}, '.')
+  end
+
+  def title
+    @title ||= self.class.name
+  end
+
+  def detail
+    @detail ||= 'The server encountered an error.'
+  end
+
+  def source
+    @source ||= {}
   end
 
   def message
@@ -55,13 +93,7 @@ module  Error
   end
 
   def to_s
-    @message || developer_message
-  rescue NoMethodError
-    super
-  end
-
-  def developer_message
-    fail NoMethodError, 'This method must be implemented in a subclass'
+    @message || detail
   end
 
   def self.included(base)

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

@@ -1,9 +1,9 @@
-require 'human_error/errors/request_error'
 require 'human_error/errors/authentication_error'
 
 class   HumanError
 module  Errors
-class   DuplicateAuthenticationError < RequestError
+class   DuplicateAuthenticationError < RuntimeError
+  include Error
   include AuthenticationError
 
   attr_accessor :provider,
@@ -14,23 +14,23 @@ class   DuplicateAuthenticationError < RequestError
     409
   end
 
-  def developer_message
+  def title
+    'Duplicate Authentication'
+  end
+
+  def detail
     'The authentication you attempted to register has already been registered by ' \
     'another user. We do not currently support allowing multiple users to be connected ' \
     'to the same authentication.'
   end
 
-  def developer_details
+  def source
     {
       'provider'         => provider,
       'provider_user_id' => provider_user_id,
       'user_id'          => user_id,
     }
   end
-
-  def friendly_message
-    "Sorry! Someone else has already registered this #{provider} login."
-  end
 end
 end
 end

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

@@ -1,9 +1,9 @@
-require 'human_error/errors/request_error'
 require 'human_error/errors/authentication_error'
 
 class   HumanError
 module  Errors
-class   InvalidTokenError < RequestError
+class   InvalidTokenError < RuntimeError
+  include Error
   include AuthenticationError
 
   attr_accessor :authentication_token
@@ -12,18 +12,18 @@ class   InvalidTokenError < RequestError
     401
   end
 
-  def developer_message
+  def title
+    'Invalid Token'
+  end
+
+  def detail
     'The token you attempted to use for this request is invalid for this resource.  ' \
     'Please double-check and try again.'
   end
 
-  def developer_details
+  def source
     { token: '[FILTERED]' }
   end
-
-  def friendly_message
-    'Sorry! You are not authorized to view this.'
-  end
 end
 end
 end

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

@@ -1,9 +1,9 @@
-require 'human_error/errors/request_error'
 require 'human_error/errors/authentication_error'
 
 class   HumanError
 module  Errors
-class   InvalidUsernameOrPasswordError < RequestError
+class   InvalidUsernameOrPasswordError < RuntimeError
+  include Error
   include AuthenticationError
 
   attr_accessor :username
@@ -12,18 +12,18 @@ class   InvalidUsernameOrPasswordError < RequestError
     401
   end
 
-  def developer_message
+  def title
+    'Invalid Username/Password'
+  end
+
+  def detail
     'Either the username or password passed in or this request is invalid.  Please ' \
     'double-check and try again.'
   end
 
-  def developer_details
+  def source
     { username: username, password: '[FILTERED]' }
   end
-
-  def friendly_message
-    'Either your email or password is incorrect.  Please double-check and try again.'
-  end
 end
 end
 end

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

@@ -1,9 +1,9 @@
 require 'human_error/errors/crud_error'
-require 'human_error/errors/request_error'
 
 class   HumanError
 module  Errors
-class   AssociationError < RequestError
+class   AssociationError < RuntimeError
+  include Error
   include CrudError
 
   attr_accessor :association_name,
@@ -33,22 +33,21 @@ class   AssociationError < RequestError
     422
   end
 
-  def developer_message
+  def title
+    'Association Error'
+  end
+
+  def detail
     "The #{association_name} that you attempted to associate with " \
     "the #{resource_name} was not valid."
   end
 
-  def developer_details
+  def source
     {
       resource_name            => attributes,
       "#{association_name} id" => association_id,
     }
   end
-
-  def friendly_message
-    "Sorry! There was a problem when we tried to set the #{association_name} on " \
-    "that #{resource_name}."
-  end
 end
 end
 end

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

@@ -1,9 +1,9 @@
 require 'human_error/errors/crud_error'
-require 'human_error/errors/request_error'
 
 class   HumanError
 module  Errors
-class   ResourceNotFoundError < RequestError
+class   ResourceNotFoundError < RuntimeError
+  include Error
   include CrudError
 
   def self.convert(original_error, overrides = {})
@@ -30,19 +30,19 @@ class   ResourceNotFoundError < RequestError
     404
   end
 
-  def developer_message
+  def title
+    'Resource Not Found'
+  end
+
+  def detail
     "The #{resource_name} you attempted to #{action} for this request is either " \
     'not authorized for the authenticated user or does not exist.'
   end
 
-  def developer_details
+  def source
     { "#{resource_name_underscored}_id" => resource_id }
   end
 
-  def friendly_message
-    "Sorry! The #{resource_name} you tried to #{action} does not exist."
-  end
-
   def action
     @action || 'access'
   end

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

@@ -1,9 +1,9 @@
 require 'human_error/errors/crud_error'
-require 'human_error/errors/request_error'
 
 class   HumanError
 module  Errors
-class   ResourcePersistenceError < RequestError
+class   ResourcePersistenceError < RuntimeError
+  include Error
   include CrudError
 
   attr_accessor :errors,
@@ -29,21 +29,21 @@ class   ResourcePersistenceError < RequestError
     422
   end
 
-  def developer_message
+  def title
+    'Resource Persistence Error'
+  end
+
+  def detail
     "One or more of the attributes on the #{resource_name} you attempted " \
     "to #{action} is invalid."
   end
 
-  def developer_details
+  def source
     {
       'errors'     => errors,
       'attributes' => attributes,
     }
   end
-
-  def friendly_message
-    "Sorry! We had a problem when tried to #{action} that #{resource_name}."
-  end
 end
 end
 end