human_error 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d614b3e79926582dbf282a7e05f85dd8efdeceda
-  data.tar.gz: 3dde7cb56afebb5614dd2a14b4afd6129bbb344d
+  metadata.gz: f2554d092cad72ca391ae12a0d685e65c7cd5f87
+  data.tar.gz: 86be8d5d478e44f36bc91d4553da0c36cef75052
 SHA512:
-  metadata.gz: 114f36605d067ddca3a8177a01f5d4aa9c8217898015a6a2de30b3bf7ba0e472beca0572097a9e5bdd218fea3bfaea2702b130860b77502e57a43bd43c261502
-  data.tar.gz: 958028969aa5fa69fe61808ec2c7acabf448a7083632637aed696622eb1dbd4c43484d60c51577b181936b02281400b1614a019b4f3c98ffe6c19f7821693b0b
+  metadata.gz: 0260892f92309a5efe0b665fe615b685eb25dac08623eea49dbffd62bb47fdca762c567f7b6234eceac9268d8ac9a2869bfe27c2789ab287ee85726e3b88f489
+  data.tar.gz: d44beaf3bd2c32dd1fa6c3f7d18eb111af1f0f0beb95dd1b69cd51de3bd0965601d1a90bf80c7a6b4f2bfef151aafd72f8e6f6f2911daf84e77428e3b631a9f4

data/README.md

@@ -1,5 +1,7 @@
 # HumanError
 
+[![Build Status](https://secure.travis-ci.org/thekompanee/human_error.png?branch=master)](http://travis-ci.org/thekompanee/human_error) [![Code Climate](https://codeclimate.com/github/thekompanee/human_error.png)](https://codeclimate.com/github/thekompanee/human_error) [![Code Climate](https://codeclimate.com/github/thekompanee/human_error/coverage.png)](https://codeclimate.com/github/thekompanee/human_error)
+
 TODO: Write a gem description
 
 ## Installation

data/lib/human_error/configuration.rb

@@ -0,0 +1,15 @@
+module  HumanError
+  class Configuration
+    attr_accessor :api_version,
+                  :api_error_documentation_url,
+                  :knowledgebase_url
+  end
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+end

data/lib/human_error/error.rb

@@ -1,9 +1,37 @@
+require 'human_error/configuration'
+require 'human_error/error_code_directory'
+
 module  HumanError
 module  Error
+  attr_accessor :api_version,
+                :api_error_documentation_url,
+                :knowledgebase_url,
+                :code
+
+  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|
+      self.send("#{variable}=", value)
+    end
+  end
+
+  def code
+    @code || ErrorCodeDirectory.lookup(self.class.name)
+  end
+
   def wrap(other)
     wrapped_error = new "#{other.class.name}: #{other.message}"
     wrapped_error.set_backtrace other.backtrace
     wrapped_error
   end
+
+  private
+
+  def configuration
+    HumanError.configuration
+  end
 end
 end

data/lib/human_error/error_code_directory.rb

@@ -0,0 +1,18 @@
+module  HumanError
+class   ErrorCodeDirectory
+  def self.lookup(error_class)
+    directory[error_class]
+  end
+
+  private
+
+  def self.directory
+    {
+      'HumanError::Errors::InvalidTokenError'              => 1003,
+      'HumanError::Errors::InvalidUsernameOrPasswordError' => 1004,
+      'HumanError::Errors::ResourceNotFoundError'          => 1005,
+      'HumanError::Errors::ResourcePersistenceError'       => 1006,
+    }
+  end
+end
+end

data/lib/human_error/errors/authentication_error.rb

@@ -0,0 +1,6 @@
+module  HumanError
+module  Errors
+module  AuthenticationError
+end
+end
+end

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

@@ -0,0 +1,38 @@
+require 'human_error/errors/request_error'
+require 'human_error/errors/authentication_error'
+
+module  HumanError
+module  Errors
+class   InvalidTokenError < RequestError
+  include AuthenticationError
+
+  attr_accessor :authentication_token
+
+  def initialize(authentication_token: nil, **args)
+    self.authentication_token = authentication_token
+
+    super **args
+  end
+
+  def http_status
+    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
+
+  def developer_details
+    { 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

@@ -0,0 +1,38 @@
+require 'human_error/errors/request_error'
+require 'human_error/errors/authentication_error'
+
+module  HumanError
+module  Errors
+class   InvalidUsernameOrPasswordError < RequestError
+  include AuthenticationError
+
+  attr_accessor :username
+
+  def initialize(username: nil, **args)
+    self.username = username
+
+    super **args
+  end
+
+  def http_status
+    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
+
+  def developer_details
+    { :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_error.rb

@@ -0,0 +1,17 @@
+module  HumanError
+module  Errors
+module  CrudError
+  attr_accessor :resource_name,
+                :action,
+                :resource_id
+
+  def initialize(resource_name: nil, action: nil, resource_id: nil, **args)
+    self.resource_name = resource_name
+    self.action        = action
+    self.resource_id   = resource_id
+
+    super **args
+  end
+end
+end
+end

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

@@ -0,0 +1,30 @@
+require 'human_error/errors/crud_error'
+require 'human_error/errors/request_error'
+
+module  HumanError
+module  Errors
+class   ResourceNotFoundError < RequestError
+  include CrudError
+
+  def http_status
+    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
+
+  def developer_details
+    { "#{resource_name}_id" => resource_id }
+  end
+
+  def friendly_message
+    "Sorry! The #{resource_name} you tried to #{action} does not exist."
+  end
+end
+end
+end

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

@@ -0,0 +1,43 @@
+require 'human_error/errors/crud_error'
+require 'human_error/errors/request_error'
+
+module  HumanError
+module  Errors
+class   ResourcePersistenceError < RequestError
+  include CrudError
+
+  attr_accessor :errors,
+                :attributes
+
+  def initialize(errors: nil, attributes: nil, **args)
+    self.errors     = errors
+    self.attributes = attributes
+
+    super **args
+  end
+
+  def http_status
+    422
+  end
+
+  def knowledgebase_article_id
+    '1234567890'
+  end
+
+  def developer_message
+    "One or more of the attributes on the #{resource_name} you attempted to #{action} is invalid."
+  end
+
+  def developer_details
+    {
+      'errors'     => errors,
+      'attributes' => attributes,
+    }
+  end
+
+  def friendly_message
+    "Sorry! We had a problem when tried to #{action} that #{resource_name}."
+  end
+end
+end
+end

data/lib/human_error/errors/request_error.rb

@@ -0,0 +1,57 @@
+require 'human_error/error'
+require 'human_error/utilities/string'
+
+module  HumanError
+module  Errors
+class   RequestError < RuntimeError
+  include HumanError::Error
+
+  attr_accessor :http_status,
+                :developer_message,
+                :developer_details,
+                :friendly_message,
+                :knowledgebase_article_id
+
+  def as_json(options = {})
+    {
+      error: {
+        status:                      http_status,
+        code:                        code,
+        developer_documentation_uri: developer_documentation_uri,
+        customer_support_uri:        customer_support_uri,
+        developer_message_key:       developer_message_key,
+        developer_message:           developer_message,
+        developer_details:           developer_details,
+        friendly_message_key:        friendly_message_key,
+        friendly_message:            friendly_message,
+      }
+    }
+  end
+
+  private
+
+  def developer_documentation_uri
+    "#{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).
+      gsub(%r{\A[^/]+/}, '').
+      gsub(%r{[_/]}, '.')
+  end
+
+  def developer_message_key
+    "#{base_message_key}.developer"
+  end
+
+  def friendly_message_key
+    "#{base_message_key}.friendly"
+  end
+end
+end
+end

data/lib/human_error/utilities/string.rb

@@ -0,0 +1,15 @@
+module  HumanError
+module  Utilities
+class   String
+  def self.underscore(other)
+    word = other.to_s.gsub('::', '/')
+    word.gsub!(/(?:([A-Za-z\d])|^)(?=\b|[^a-z])/) { "#{$1}#{$1 && ''}" }
+    word.gsub!(/([A-Z\d]+)([A-Z][a-z])/,'\1_\2')
+    word.gsub!(/([a-z\d])([A-Z])/,'\1_\2')
+    word.tr!("-", "_")
+    word.downcase!
+    word
+  end
+end
+end
+end

data/lib/human_error/version.rb

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

data/lib/human_error.rb

@@ -1,5 +1,6 @@
 require 'human_error/version'
 require 'human_error/error'
+require 'human_error/errors'
 
 module  HumanError
 end

data/spec/lib/human_error/configuration_spec.rb

@@ -0,0 +1,27 @@
+require 'rspectacular'
+require 'human_error/configuration'
+
+module    HumanError
+describe  Configuration do
+  it 'can set the API version' do
+    configuration = Configuration.new
+    configuration.api_version = 'whateeeeeever'
+
+    expect(configuration.api_version).to eql 'whateeeeeever'
+  end
+
+  it 'can set the API error documentation URL' do
+    configuration = Configuration.new
+    configuration.api_error_documentation_url = 'whateeeeeever'
+
+    expect(configuration.api_error_documentation_url).to eql 'whateeeeeever'
+  end
+
+  it 'can set the knowledgebase URL' do
+    configuration = Configuration.new
+    configuration.knowledgebase_url = 'whateeeeeever'
+
+    expect(configuration.knowledgebase_url).to eql 'whateeeeeever'
+  end
+end
+end

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

@@ -0,0 +1,34 @@
+require 'rspectacular'
+require 'human_error/errors/authentication_errors/invalid_token_error'
+
+module    HumanError
+module    Errors
+describe  InvalidTokenError do
+  let(:error) { InvalidTokenError.new }
+
+  it 'has a status of 401' do
+    expect(error.http_status).to eql 401
+  end
+
+  it 'has a code of 1003' do
+    expect(error.code).to eql 1003
+  end
+
+  it 'has a knowledgebase article ID of 1234567890' do
+    expect(error.knowledgebase_article_id).to eql '1234567890'
+  end
+
+  it 'can output the developer message' do
+    expect(error.developer_message).to eql 'The token you attempted to use for this request is invalid for this resource.  Please double-check and try again.'
+  end
+
+  it 'can output the developer details' do
+    expect(error.developer_details).to eql(token: '[FILTERED]')
+  end
+
+  it 'can output the friendly message' do
+    expect(error.friendly_message).to eql 'Sorry! You are not authorized to view this.'
+  end
+end
+end
+end

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

@@ -0,0 +1,36 @@
+require 'rspectacular'
+require 'human_error/errors/authentication_errors/invalid_username_or_password_error'
+
+module    HumanError
+module    Errors
+describe  InvalidUsernameOrPasswordError do
+  let(:error) { InvalidUsernameOrPasswordError.new }
+
+  it 'has a status of 401' do
+    expect(error.http_status).to eql 401
+  end
+
+  it 'has a code of 1004' do
+    expect(error.code).to eql 1004
+  end
+
+  it 'has a knowledgebase article ID of 1234567890' do
+    expect(error.knowledgebase_article_id).to eql '1234567890'
+  end
+
+  it 'can output the developer message' do
+    expect(error.developer_message).to eql 'Either the username or password passed in or this request is invalid.  Please double-check and try again.'
+  end
+
+  it 'can output the developer details' do
+    error = InvalidUsernameOrPasswordError.new username: 'neo'
+
+    expect(error.developer_details).to eql(:username => 'neo', :password => '[FILTERED]')
+  end
+
+  it 'can output the friendly message' do
+    expect(error.friendly_message).to eql 'Either your email or password is incorrect.  Please double-check and try again.'
+  end
+end
+end
+end

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

@@ -0,0 +1,43 @@
+require 'rspectacular'
+require 'human_error/errors/crud_errors/resource_not_found_error'
+
+module    HumanError
+module    Errors
+describe  ResourceNotFoundError do
+  let(:error) { ResourceNotFoundError.new }
+
+  it 'has a status of 404' do
+    expect(error.http_status).to eql 404
+  end
+
+  it 'has a code of 1005' do
+    expect(error.code).to eql 1005
+  end
+
+  it 'has a knowledgebase article ID of 1234567890' do
+    expect(error.knowledgebase_article_id).to eql '1234567890'
+  end
+
+  it 'includes the resource name and action in the developer message' do
+    error = ResourceNotFoundError.new resource_name: 'black leather trenchcoat',
+                                      action:        'bullet time'
+
+    expect(error.developer_message).to eql "The black leather trenchcoat you attempted to bullet time for this request is either not authorized for the authenticated user or does not exist."
+  end
+
+  it 'includes the resource name and action in the developer details' do
+    error = ResourceNotFoundError.new resource_name: 'black leather trenchcoat',
+                                      resource_id:   123
+
+    expect(error.developer_details).to eql("black leather trenchcoat_id" => 123)
+  end
+
+  it 'includes the resource name and action in the friendly message' do
+    error = ResourceNotFoundError.new resource_name: 'black leather trenchcoat',
+                                      action:        'bullet time'
+
+    expect(error.friendly_message).to eql "Sorry! The black leather trenchcoat you tried to bullet time does not exist."
+  end
+end
+end
+end

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

@@ -0,0 +1,44 @@
+require 'rspectacular'
+require 'human_error/errors/crud_errors/resource_persistence_error'
+
+module    HumanError
+module    Errors
+describe  ResourcePersistenceError do
+  let(:error) { ResourcePersistenceError.new }
+
+  it 'has a status of 422' do
+    expect(error.http_status).to eql 422
+  end
+
+  it 'has a code of 1006' do
+    expect(error.code).to eql 1006
+  end
+
+  it 'has a knowledgebase article ID of 1234567890' do
+    expect(error.knowledgebase_article_id).to eql '1234567890'
+  end
+
+  it 'includes the resource name and action in the developer message' do
+    error = ResourcePersistenceError.new resource_name: 'black leather trenchcoat',
+                                         action:        'bullet time'
+
+    expect(error.developer_message).to eql "One or more of the attributes on the black leather trenchcoat you attempted to bullet time is invalid."
+  end
+
+  it 'includes the resource name and action in the developer details' do
+    error = ResourcePersistenceError.new errors:      'lots of errors',
+                                         attributes:  'what is the matrix'
+
+    expect(error.developer_details).to eql('errors'     => 'lots of errors',
+                                           'attributes' => 'what is the matrix')
+  end
+
+  it 'includes the resource name and action in the friendly message' do
+    error = ResourcePersistenceError.new resource_name: 'black leather trenchcoat',
+                                         action:        'bullet time'
+
+    expect(error.friendly_message).to eql "Sorry! We had a problem when tried to bullet time that black leather trenchcoat."
+  end
+end
+end
+end

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

@@ -0,0 +1,95 @@
+require 'rspectacular'
+require 'human_error/errors/request_error'
+
+module    HumanError
+module    Errors
+describe  RequestError do
+  it 'can generate error data' do
+    request_error = RequestError.new(http_status:                 'flibbity',
+                                     code:                        'jibbit',
+                                     developer_message:           'I cannot receive any satisfaction',
+                                     developer_details:           'But perhaps if I attempt it one more time, I can',
+                                     friendly_message:            'receive what I need',
+                                     knowledgebase_article_id:    '87654321',
+                                     api_version:                 'janky',
+                                     api_error_documentation_url: 'asimof',
+                                     knowledgebase_url:           'jinkies')
+
+    expect(request_error.as_json).to eql({
+      error: {
+        status:                      'flibbity',
+        code:                        'jibbit',
+        developer_documentation_uri: 'asimof/jibbit?version=janky',
+        customer_support_uri:        'jinkies/87654321',
+        developer_message_key:       'errors.request.error.developer',
+        developer_message:           'I cannot receive any satisfaction',
+        developer_details:           'But perhaps if I attempt it one more time, I can',
+        friendly_message_key:        'errors.request.error.friendly',
+        friendly_message:            'receive what I need',
+      }
+    })
+  end
+
+  it 'can extract configuration from the global config if it is not passed in' do
+    HumanError.configure do |config|
+      config.api_version                 = 'janky'
+      config.api_error_documentation_url = 'asimof'
+      config.knowledgebase_url           = 'jinkies'
+    end
+
+    request_error = RequestError.new(http_status:                 'flibbity',
+                                     code:                        'jibbit',
+                                     developer_message:           'I cannot receive any satisfaction',
+                                     developer_details:           'But perhaps if I attempt it one more time, I can',
+                                     friendly_message:            'receive what I need',
+                                     knowledgebase_article_id:    '87654321')
+
+    expect(request_error.as_json).to eql({
+      error: {
+        status:                      'flibbity',
+        code:                        'jibbit',
+        developer_documentation_uri: 'asimof/jibbit?version=janky',
+        customer_support_uri:        'jinkies/87654321',
+        developer_message_key:       'errors.request.error.developer',
+        developer_message:           'I cannot receive any satisfaction',
+        developer_details:           'But perhaps if I attempt it one more time, I can',
+        friendly_message_key:        'errors.request.error.friendly',
+        friendly_message:            'receive what I need',
+      }
+    })
+  end
+
+  it 'can override the global config if it is set, but an explicit value is passed in' do
+    HumanError.configure do |config|
+      config.api_version                 = 'janky'
+      config.api_error_documentation_url = 'asimof'
+      config.knowledgebase_url           = 'jinkies'
+    end
+
+    request_error = RequestError.new(http_status:                 'flibbity',
+                                     code:                        'jibbit',
+                                     developer_message:           'I cannot receive any satisfaction',
+                                     developer_details:           'But perhaps if I attempt it one more time, I can',
+                                     friendly_message:            'receive what I need',
+                                     knowledgebase_article_id:    '87654321',
+                                     api_version:                 'hanky',
+                                     api_error_documentation_url: 'hasimof',
+                                     knowledgebase_url:           'hinkies')
+
+    expect(request_error.as_json).to eql({
+      error: {
+        status:                      'flibbity',
+        code:                        'jibbit',
+        developer_documentation_uri: 'hasimof/jibbit?version=hanky',
+        customer_support_uri:        'hinkies/87654321',
+        developer_message_key:       'errors.request.error.developer',
+        developer_message:           'I cannot receive any satisfaction',
+        developer_details:           'But perhaps if I attempt it one more time, I can',
+        friendly_message_key:        'errors.request.error.friendly',
+        friendly_message:            'receive what I need',
+      }
+    })
+  end
+end
+end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: human_error
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - jfelchner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-24 00:00:00.000000000 Z
+date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,14 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0.22'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.3.0
 description: ''
 email: accounts+git@thekompanee.com
 executables: []
@@ -48,9 +62,25 @@ files:
 - README.md
 - Rakefile
 - lib/human_error.rb
+- lib/human_error/configuration.rb
 - lib/human_error/error.rb
+- lib/human_error/error_code_directory.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
+- lib/human_error/errors/crud_error.rb
+- 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/utilities/string.rb
 - lib/human_error/version.rb
+- spec/lib/human_error/configuration_spec.rb
 - spec/lib/human_error/error_spec.rb
+- spec/lib/human_error/errors/authentication_errors/invalid_token_error_spec.rb
+- spec/lib/human_error/errors/authentication_errors/invalid_username_or_password_error_spec.rb
+- 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
 homepage: https://github.com/thekompanee/human_error
 licenses: []
 metadata: {}
@@ -76,5 +106,11 @@ signing_key:
 specification_version: 4
 summary: Common Error Extensions and Helpers
 test_files:
+- spec/lib/human_error/configuration_spec.rb
 - spec/lib/human_error/error_spec.rb
+- spec/lib/human_error/errors/authentication_errors/invalid_token_error_spec.rb
+- spec/lib/human_error/errors/authentication_errors/invalid_username_or_password_error_spec.rb
+- 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
 has_rdoc: