human_error 2.0.0 → 3.0.0

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

@@ -10,26 +10,22 @@ describe  InvalidTokenError do
     expect(error.http_status).to eql 401
   end
 
-  it 'has a code of 1003' do
-    expect(error.code).to eql 1003
+  it 'has a code' do
+    expect(error.code).to eql 'errors.invalid_token_error'
   end
 
-  it 'has a knowledgebase article ID of 1234567890' do
-    expect(error.knowledgebase_article_id).to eql '1234567890'
+  it 'has a title' do
+    expect(error.title).to eql 'Invalid Token'
   end
 
-  it 'can output the developer message' do
-    expect(error.developer_message).to eql 'The token you attempted to use for this ' \
+  it 'can output the detail' do
+    expect(error.detail).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.'
+  it 'can output the source' do
+    expect(error.source).to eql(token: '[FILTERED]')
   end
 end
 end

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

@@ -10,29 +10,24 @@ describe  InvalidUsernameOrPasswordError do
     expect(error.http_status).to eql 401
   end
 
-  it 'has a code of 1004' do
-    expect(error.code).to eql 1004
+  it 'has a code' do
+    expect(error.code).to eql 'errors.invalid_username_or_password_error'
   end
 
-  it 'has a knowledgebase article ID of 1234567890' do
-    expect(error.knowledgebase_article_id).to eql '1234567890'
+  it 'has a title' do
+    expect(error.title).to eql 'Invalid Username/Password'
   end
 
-  it 'can output the developer message' do
-    expect(error.developer_message).to eql 'Either the username or password passed in ' \
+  it 'can output the detail' do
+    expect(error.detail).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
+  it 'can output the source' 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.'
+    expect(error.source).to eql(username: 'neo', password: '[FILTERED]')
   end
 end
 end

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

@@ -15,47 +15,39 @@ describe  AssociationError do
     expect(error.http_status).to eql 422
   end
 
-  it 'has a code of 1009' do
+  it 'has a code' do
     error = AssociationError.new
 
-    expect(error.code).to eql 1009
+    expect(error.code).to eql 'errors.association_error'
   end
 
-  it 'has a knowledgebase article ID of 1234567890' do
+  it 'has a title' do
     error = AssociationError.new
 
-    expect(error.knowledgebase_article_id).to eql '1234567890'
+    expect(error.title).to eql 'Association Error'
   end
 
-  it 'includes the resource name and action in the developer message' do
+  it 'includes the resource name and action in the detail' do
     error = AssociationError.new association_name: 'black leather trenchcoat',
                                  resource_name:    'Neo'
 
-    expect(error.developer_message).to eql 'The black leather trenchcoat that you ' \
+    expect(error.detail).to eql 'The black leather trenchcoat that you ' \
                                            'attempted to associate with the Neo was ' \
                                            'not valid.'
   end
 
-  it 'includes the resource name and action in the developer details' do
+  it 'includes the resource name and action in the source' do
     error = AssociationError.new association_name: 'black leather trenchcoat',
                                  resource_name:    'Neo',
                                  attributes:       'what is the matrix',
                                  association_id:   '123'
 
-    expect(error.developer_details).to eql(
+    expect(error.source).to eql(
       'Neo'                         => 'what is the matrix',
       'black leather trenchcoat id' => '123',
     )
   end
 
-  it 'includes the resource name and action in the friendly message' do
-    error = AssociationError.new association_name: 'black leather trenchcoat',
-                                 resource_name:    'Neo'
-
-    expect(error.friendly_message).to eql 'Sorry! There was a problem when we tried to ' \
-                                          'set the black leather trenchcoat on that Neo.'
-  end
-
   it 'can convert an "ActiveRecord::InvalidForeignKey"' do
     error = AssociationError.convert(foreign_key_error)
 

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

@@ -11,48 +11,40 @@ describe  ResourceNotFoundError do
     expect(error.http_status).to eql 404
   end
 
-  it 'has a code of 1005' do
+  it 'has a code' do
     error = ResourceNotFoundError.new
 
-    expect(error.code).to eql 1005
+    expect(error.code).to eql 'errors.resource_not_found_error'
   end
 
-  it 'has a knowledgebase article ID of 1234567890' do
+  it 'has a title' do
     error = ResourceNotFoundError.new
 
-    expect(error.knowledgebase_article_id).to eql '1234567890'
+    expect(error.title).to eql 'Resource Not Found'
   end
 
-  it 'includes the resource name and action in the developer message' do
+  it 'includes the resource name and action in the detail' do
     error = ResourceNotFoundError.new resource_name: 'black leather trenchcoat',
                                       action:        'bullet time'
 
-    expect(error.developer_message).to eql 'The black leather trenchcoat you attempted ' \
+    expect(error.detail).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
+  it 'includes the resource name and action in the source' do
     error = ResourceNotFoundError.new resource_name: 'black leather trenchcoat',
                                       resource_id:   123
 
-    expect(error.developer_details).to eql('black_leather_trenchcoat_id' => 123)
+    expect(error.source).to eql('black_leather_trenchcoat_id' => 123)
   end
 
   it 'can accept an array of IDs' do
     error = ResourceNotFoundError.new resource_name: 'black leather trenchcoat',
                                       resource_id:   %w{123 456}
 
-    expect(error.developer_details).to eql('black_leather_trenchcoat_id' => %w{123 456})
-  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.'
+    expect(error.source).to eql('black_leather_trenchcoat_id' => %w{123 456})
   end
 
   it 'can convert an "ActiveRecord::RecordNotFound" with no IDs' do

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

@@ -29,41 +29,33 @@ describe  ResourcePersistenceError do
     expect(error.http_status).to eql 422
   end
 
-  it 'has a code of 1006' do
+  it 'has a code' do
     error = ResourcePersistenceError.new
 
-    expect(error.code).to eql 1006
+    expect(error.code).to eql 'errors.resource_persistence_error'
   end
 
-  it 'has a knowledgebase article ID of 1234567890' do
+  it 'has a title' do
     error = ResourcePersistenceError.new
 
-    expect(error.knowledgebase_article_id).to eql '1234567890'
+    expect(error.title).to eql 'Resource Persistence Error'
   end
 
-  it 'includes the resource name and action in the developer message' do
+  it 'includes the resource name and action in the detail' 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 ' \
+    expect(error.detail).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
+  it 'includes the resource name and action in the source' 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.'
+    expect(error.source).to eql('errors'     => 'lots of errors',
+                                'attributes' => 'what is the matrix')
   end
 
   it 'can convert an "ActiveRecord::RecordNotSaved"' do

data/spec/lib/human_error/errors/request_errors/parameter_missing_error_spec.rb

@@ -0,0 +1,55 @@
+require 'rspectacular'
+require 'human_error'
+require 'action_controller'
+
+class     HumanError
+module    Errors
+describe  ParameterMissingError do
+  it 'has a status' do
+    error = ParameterMissingError.new
+
+    expect(error.http_status).to eql 400
+  end
+
+  it 'has a code' do
+    error = ParameterMissingError.new
+
+    expect(error.code).to eql 'errors.parameter_missing_error'
+  end
+
+  it 'has a title' do
+    error = ParameterMissingError.new
+
+    expect(error.title).to eql 'Missing Parameter'
+  end
+
+  it 'includes the resource name and action in the detail' do
+    error = ParameterMissingError.new parameter: 'trenchcoat'
+
+    expect(error.detail).to eql 'trenchcoat is a required parameter, but you did not ' \
+                                'supply it.'
+  end
+
+  it 'includes the resource name and action in the source' do
+    error = ParameterMissingError.new parameter: 'trenchcoat'
+
+    expect(error.source).to eql('required_parameter' => 'trenchcoat')
+  end
+
+  it 'can convert an "ActionController::ParameterMissing"' do
+    parameter_missing_error = ActionController::ParameterMissing.new('trenchcoat')
+    error                   = ParameterMissingError.convert(parameter_missing_error)
+
+    expect(error.parameter).to eql 'trenchcoat'
+  end
+
+  it 'can convert an "ActionController::ParameterMissing" while overriding attributes' do
+    parameter_missing_error = ActionController::ParameterMissing.new('trenchcoat')
+    error                   = ParameterMissingError.convert(parameter_missing_error,
+                                                            parameter: 'matrix')
+
+    expect(error.parameter).to eql 'matrix'
+  end
+end
+end
+end

data/spec/lib/human_error/errors/request_errors/unpermitted_parameters_error_spec.rb

@@ -0,0 +1,62 @@
+require 'rspectacular'
+require 'human_error'
+require 'action_controller'
+
+class     HumanError
+module    Errors
+describe  UnpermittedParametersError do
+  it 'has a status' do
+    error = UnpermittedParametersError.new
+
+    expect(error.http_status).to eql 400
+  end
+
+  it 'has a code' do
+    error = UnpermittedParametersError.new
+
+    expect(error.code).to eql 'errors.unpermitted_parameters_error'
+  end
+
+  it 'has a title' do
+    error = UnpermittedParametersError.new
+
+    expect(error.title).to eql 'Unpermitted Parameters'
+  end
+
+  it 'includes the resource name and action in the detail' do
+    error = UnpermittedParametersError.new parameters: 'trenchcoat'
+
+    expect(error.detail).to eql 'The following parameters passed are not allowed: ' \
+                                'trenchcoat'
+  end
+
+  it 'includes the resource name and action in the detail' do
+    error = UnpermittedParametersError.new parameters: %w{trenchcoat matrix}
+
+    expect(error.detail).to eql 'The following parameters passed are not allowed: ' \
+                                'trenchcoat, matrix'
+  end
+
+  it 'includes the resource name and action in the source' do
+    error = UnpermittedParametersError.new parameters: 'trenchcoat'
+
+    expect(error.source).to eql('unpermitted_parameters' => ['trenchcoat'])
+  end
+
+  it 'can convert an "ActionController::UnpermittedParameters"' do
+    parameters_error = ActionController::UnpermittedParameters.new(%w{trenchcoat})
+    error            = UnpermittedParametersError.convert(parameters_error)
+
+    expect(error.parameters).to eql %w{trenchcoat}
+  end
+
+  it 'can convert an "ActionController::ParameterMissing" while overriding attributes' do
+    parameters_error = ActionController::UnpermittedParameters.new(%w{trenchcoat})
+    error            = UnpermittedParametersError.convert(parameters_error,
+                                                          parameters: 'matrix')
+
+    expect(error.parameters).to eql %w{matrix}
+  end
+end
+end
+end

data/spec/lib/human_error_spec.rb

@@ -7,66 +7,13 @@ describe HumanError do
     ActiveRecord::RecordNotFound.new("Couldn't find resource with 'id'=3")
   end
 
-  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 eql 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.convert(original_error)
-
-    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.convert(original_error)
-
-    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.convert(original_error, api_version: 'bar')
-
-    expect(fetched_error.api_version).to eql 'bar'
+    expect(HumanError.fetch('InvalidTokenError')).to \
+      eql HumanError::Errors::InvalidTokenError
   end
 
   it 'can raise an error' do
-    human_error = HumanError.new
-
-    expect { human_error.raise('RequestError') }.to \
-      raise_error HumanError::Errors::RequestError
+    expect { HumanError.raise('InvalidTokenError') }.to \
+      raise_error HumanError::Errors::InvalidTokenError
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: human_error
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - jfelchner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-11 00:00:00.000000000 Z
+date: 2015-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '0.64'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.50'
+        version: '0.64'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
 description: ''
 email: accounts+git@thekompanee.com
 executables: []
@@ -64,8 +78,6 @@ files:
 - 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.rb
 - lib/human_error/errors/authentication_error.rb
 - lib/human_error/errors/authentication_errors/duplicate_authentication_error.rb
 - lib/human_error/errors/authentication_errors/invalid_token_error.rb
@@ -74,11 +86,11 @@ files:
 - lib/human_error/errors/crud_errors/association_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/knowledgebase_id_directory.rb
+- lib/human_error/errors/request_errors/parameter_missing_error.rb
+- lib/human_error/errors/request_errors/unpermitted_parameters_error.rb
 - lib/human_error/rescuable_resource.rb
 - lib/human_error/utilities/string.rb
-- lib/human_error/verifiable_model.rb
+- lib/human_error/verifiable_resource.rb
 - lib/human_error/version.rb
 - spec/lib/human_error/configuration_spec.rb
 - spec/lib/human_error/error_spec.rb
@@ -88,7 +100,8 @@ files:
 - spec/lib/human_error/errors/crud_errors/association_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
+- spec/lib/human_error/errors/request_errors/parameter_missing_error_spec.rb
+- spec/lib/human_error/errors/request_errors/unpermitted_parameters_error_spec.rb
 - spec/lib/human_error/rescuable_resource_spec.rb
 - spec/lib/human_error_spec.rb
 homepage: https://github.com/thekompanee/human_error
@@ -111,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Common Error Extensions and Helpers
@@ -124,6 +137,7 @@ test_files:
 - spec/lib/human_error/errors/crud_errors/association_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
+- spec/lib/human_error/errors/request_errors/parameter_missing_error_spec.rb
+- spec/lib/human_error/errors/request_errors/unpermitted_parameters_error_spec.rb
 - spec/lib/human_error/rescuable_resource_spec.rb
 - spec/lib/human_error_spec.rb