erratum 0.0.1

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

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+require 'rspeckled'
+require 'erratum/errors/crud_errors/resource_persistence_error'
+require 'active_support'
+require 'active_model'
+require 'active_record/errors'
+require 'active_record/validations'
+
+class ErratumTestModel
+  include ActiveModel::Model
+  include ActiveModel::AttributeMethods
+
+  attr_accessor :some_attribute
+
+  validates_presence_of :some_attribute
+
+  def attributes
+    {
+      'some_attribute' => @some_attribute,
+    }
+  end
+end
+
+class           Erratum
+module          Errors
+RSpec.describe  ResourcePersistenceError do
+  it 'has a status of 422' do
+    error = ResourcePersistenceError.new
+
+    expect(error.http_status).to eql 422
+  end
+
+  it 'has a code' do
+    error = ResourcePersistenceError.new
+
+    expect(error.code).to eql 'errors.resource_persistence_error'
+  end
+
+  it 'has a title' do
+    error = ResourcePersistenceError.new
+
+    expect(error.title).to eql 'Resource Persistence Error'
+  end
+
+  it 'includes the resource name and action in the detail' do
+    error = ResourcePersistenceError.new resource_name: 'dragon',
+                                         action:        'ride'
+
+    expect(error.detail).to eql 'One or more of the attributes on the dragon you ' \
+                                'attempted to ride is invalid.'
+  end
+
+  it 'includes the resource name and action in the source' do
+    error = ResourcePersistenceError.new errors:     'lots of errors',
+                                         attributes: 'winter is coming'
+
+    expect(error.source).to eql('errors'     => 'lots of errors',
+                                'attributes' => 'winter is coming')
+  end
+
+  it 'can convert an "ActiveRecord::RecordNotSaved"' do
+    record = ErratumTestModel.new
+    record.valid?
+    resource_persistence_error = ActiveRecord::RecordNotSaved.new('message', record)
+    error                      = ResourcePersistenceError.
+                                   convert(resource_persistence_error)
+
+    expect(error.attributes).to eql('some_attribute' => nil)
+    expect(error.errors).to     eql ["Some attribute can't be blank"]
+  end
+
+  it 'can convert an "ActiveRecord::RecordInvalid"' do
+    record = ErratumTestModel.new
+    record.valid?
+    resource_persistence_error = ActiveRecord::RecordInvalid.new(record)
+    error                      = ResourcePersistenceError.
+                                   convert(resource_persistence_error)
+
+    expect(error.attributes).to eql('some_attribute' => nil)
+    expect(error.errors).to     eql ["Some attribute can't be blank"]
+  end
+end
+end
+end

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+require 'rspeckled'
+require 'erratum'
+require 'action_controller'
+
+class           Erratum
+module          Errors
+RSpec.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 resource_name: 'dragon',
+                                      action:        'create',
+                                      parameter:     'color'
+
+    expect(error.detail).to eql "When attempting to create a dragon, 'color' is " \
+                                "a required parameter."
+  end
+
+  it 'includes the resource name and action in the source' do
+    error = ParameterMissingError.new parameter: 'dragon'
+
+    expect(error.source).to eql('required_parameter' => 'dragon')
+  end
+
+  it 'can convert an "ActionController::ParameterMissing"' do
+    parameter_missing_error = ActionController::ParameterMissing.new('dragon')
+    error                   = ParameterMissingError.convert(parameter_missing_error)
+
+    expect(error.parameter).to eql 'dragon'
+  end
+
+  it 'can convert an "ActionController::ParameterMissing" while overriding attributes' do
+    parameter_missing_error = ActionController::ParameterMissing.new('dragon')
+    error                   = ParameterMissingError.convert(parameter_missing_error,
+                                                            parameter: 'westeros')
+
+    expect(error.parameter).to eql 'westeros'
+  end
+end
+end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+require 'rspeckled'
+require 'erratum'
+require 'action_controller'
+
+class           Erratum
+module          Errors
+RSpec.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 resource_name: 'dragon',
+                                           action:        'create',
+                                           parameters:    'color'
+
+    expect(error.detail).to eql 'Attempting to create a dragon with the ' \
+                                'following parameters is not allowed: color'
+  end
+
+  it 'includes the resource name and action in the detail' do
+    error = UnpermittedParametersError.new resource_name: 'dragon',
+                                           action:        'create',
+                                           parameters:    %w{color size}
+
+    expect(error.detail).to eql 'Attempting to create a dragon with the ' \
+                                'following parameters is not allowed: color, size'
+  end
+
+  it 'includes the resource name and action in the source' do
+    error = UnpermittedParametersError.new parameters: 'dragon'
+
+    expect(error.source).to eql('unpermitted_parameters' => ['dragon'])
+  end
+
+  it 'can convert an "ActionController::UnpermittedParameters"' do
+    parameters_error = ActionController::UnpermittedParameters.new(%w{dragon})
+    error            = UnpermittedParametersError.convert(parameters_error)
+
+    expect(error.parameters).to eql %w{dragon}
+  end
+
+  it 'can convert an "ActionController::ParameterMissing" while overriding attributes' do
+    parameters_error = ActionController::UnpermittedParameters.new(%w{dragon})
+    error            = UnpermittedParametersError.convert(parameters_error,
+                                                          parameters: 'westeros')
+
+    expect(error.parameters).to eql %w{westeros}
+  end
+end
+end
+end

data/spec/lib/erratum/rescuable_resource_spec.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+require 'rspeckled'
+require 'erratum/rescuable_resource'
+
+class           Erratum
+RSpec.describe  RescuableResource do
+end
+end

data/spec/lib/human_error_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+require 'rspeckled'
+require 'erratum'
+require 'active_record/errors'
+
+RSpec.describe Erratum do
+  let(:original_error) do
+    ActiveRecord::RecordNotFound.new("Couldn't find resource with 'id'=3")
+  end
+
+  it 'can lookup errors' do
+    expect(Erratum.fetch('InvalidTokenError')).to \
+      eql Erratum::Errors::InvalidTokenError
+  end
+
+  it 'can raise an error' do
+    expect { Erratum.raise('InvalidTokenError') }.to \
+      raise_error Erratum::Errors::InvalidTokenError
+  end
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: erratum
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- thegranddesign
+autorequire: 
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDqjCCApKgAwIBAgIBATANBgkqhkiG9w0BAQUFADBNMREwDwYDVQQDDAhydWJ5
+  Z2VtczEjMCEGCgmSJomT8ixkARkWE2xpdmluZ2hpZ2hvbnRoZWJsb2cxEzARBgoJ
+  kiaJk/IsZAEZFgNjb20wHhcNMTYwNTAxMDIzMDIzWhcNMTcwNTAxMDIzMDIzWjBN
+  MREwDwYDVQQDDAhydWJ5Z2VtczEjMCEGCgmSJomT8ixkARkWE2xpdmluZ2hpZ2hv
+  bnRoZWJsb2cxEzARBgoJkiaJk/IsZAEZFgNjb20wggEiMA0GCSqGSIb3DQEBAQUA
+  A4IBDwAwggEKAoIBAQC/Oxo4PMAOCC3dfzGt7DZJwoDY9MGBXoWkbWIEP91yyKIB
+  mWheQ1epDXkj1R6SM1+iclwgUKJQvFrSeD5i1NS9+3qRrD6gPCf3RDAbWNdUpyei
+  F/W4+G7eCxGC6FHv7WsBjrGWQVTjZtKYOiQCxwwkPlZSX8aBXViO8D9bZJAURocY
+  CbsMGeS0sPISRb0GCnI8VOIoab7GM8tdmIj4Uv0lzp4uOlKRJBss5/Sjp1mjgCvI
+  vuXy0X+r1l2xiXL3/uTT/Tch3lPWctEEDw9rUzNz0N5oTGK4vooq4m4AIzU1pa1Z
+  ZneO33rn3QVWVpOsK6NQVpBNhSism+Ju1mlvdmKFAgMBAAGjgZQwgZEwCQYDVR0T
+  BAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFLpr4AqEQwV9hUch3fxKvCkHUw3i
+  MCsGA1UdEQQkMCKBIHJ1YnlnZW1zQGxpdmluZ2hpZ2hvbnRoZWJsb2cuY29tMCsG
+  A1UdEgQkMCKBIHJ1YnlnZW1zQGxpdmluZ2hpZ2hvbnRoZWJsb2cuY29tMA0GCSqG
+  SIb3DQEBBQUAA4IBAQB5lDS+51DxC1GMpILDt++z5Isx2gSybmGKhNFFWWWo5iVW
+  6jLsj7H1T934Bn31sVET2cvrFGMVLKoitGgZuZPxjzkmm2+TDPbt02ThsLqjsh7W
+  000RFl0u7xJE8dg9y3Kmntar83Mr/Uf1F88/4mQsvGNnxGa39QP9IY4p6FkyEO3L
+  RRz+3xE8j0OBl1FNALFtP74/A3zmBRbCizr8En/jbQe/DISJG2o8QOyqm/64uNoy
+  zRIv8lqQM8QFT76rzP5SBCERwN+ltKAFbQ5/FwmZNGWYnmCP3RZMQiRnbh+9H9lh
+  mlbwaYZTjgsXq6cy8N38EecewgBbZYS1IYJraE/M
+  -----END CERTIFICATE-----
+date: 2016-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rspeckled
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: ''
+email: rubygems@livinghighontheblog.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/erratum.rb
+- lib/erratum/configuration.rb
+- lib/erratum/error.rb
+- lib/erratum/errors/authentication_error.rb
+- lib/erratum/errors/authentication_errors/duplicate_authentication_error.rb
+- lib/erratum/errors/authentication_errors/invalid_token_error.rb
+- lib/erratum/errors/authentication_errors/invalid_username_or_password_error.rb
+- lib/erratum/errors/authorization_error.rb
+- lib/erratum/errors/authorization_errors/forbidden_error.rb
+- lib/erratum/errors/crud_error.rb
+- lib/erratum/errors/crud_errors/association_error.rb
+- lib/erratum/errors/crud_errors/resource_not_found_error.rb
+- lib/erratum/errors/crud_errors/resource_persistence_error.rb
+- lib/erratum/errors/request_errors/parameter_missing_error.rb
+- lib/erratum/errors/request_errors/unpermitted_parameters_error.rb
+- lib/erratum/rescuable_resource.rb
+- lib/erratum/resource_naming.rb
+- lib/erratum/utilities/string.rb
+- lib/erratum/verifiable_resource.rb
+- lib/erratum/version.rb
+- spec/lib/erratum/configuration_spec.rb
+- spec/lib/erratum/error_spec.rb
+- spec/lib/erratum/errors/authentication_errors/duplicate_authentication_error_spec.rb
+- spec/lib/erratum/errors/authentication_errors/invalid_token_error_spec.rb
+- spec/lib/erratum/errors/authentication_errors/invalid_username_or_password_error_spec.rb
+- spec/lib/erratum/errors/authorization_errors/forbidden_error_spec.rb
+- spec/lib/erratum/errors/crud_errors/association_error_spec.rb
+- spec/lib/erratum/errors/crud_errors/resource_not_found_error_spec.rb
+- spec/lib/erratum/errors/crud_errors/resource_persistence_error_spec.rb
+- spec/lib/erratum/errors/request_errors/parameter_missing_error_spec.rb
+- spec/lib/erratum/errors/request_errors/unpermitted_parameters_error_spec.rb
+- spec/lib/erratum/rescuable_resource_spec.rb
+- spec/lib/human_error_spec.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Errors Need Love
+test_files:
+- spec/lib/erratum/configuration_spec.rb
+- spec/lib/erratum/error_spec.rb
+- spec/lib/erratum/errors/authentication_errors/duplicate_authentication_error_spec.rb
+- spec/lib/erratum/errors/authentication_errors/invalid_token_error_spec.rb
+- spec/lib/erratum/errors/authentication_errors/invalid_username_or_password_error_spec.rb
+- spec/lib/erratum/errors/authorization_errors/forbidden_error_spec.rb
+- spec/lib/erratum/errors/crud_errors/association_error_spec.rb
+- spec/lib/erratum/errors/crud_errors/resource_not_found_error_spec.rb
+- spec/lib/erratum/errors/crud_errors/resource_persistence_error_spec.rb
+- spec/lib/erratum/errors/request_errors/parameter_missing_error_spec.rb
+- spec/lib/erratum/errors/request_errors/unpermitted_parameters_error_spec.rb
+- spec/lib/erratum/rescuable_resource_spec.rb
+- spec/lib/human_error_spec.rb