human_error 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae7626c4412e2cb61249a059dffe4ce61a0a5781
-  data.tar.gz: 2d86051488201bfa3edb0ec68994d6025fd1316c
+  metadata.gz: 8bcd73a9e09835dff5279ebae166f1b379ff3b26
+  data.tar.gz: ce33687c79d3c4a7b00e14603bbccd77dad48feb
 SHA512:
-  metadata.gz: 7b5a792a22cb283d12e9170cb50c5f91c9efbcde54c1b94d8950b37e2860a585716a669ecc54a92634869b4996801a081b72ec86f656cdb5d6f6ee8635f4b6f5
-  data.tar.gz: 0883edbf5941bfc16d7aa86f41d192130c2ddc0c82e6da88515214b36789aab72e77a4720296c67dbd657f66c7ce716a9d7be9eca2cc353c86b193d8e9b15cf5
+  metadata.gz: 4c2de3573c9de4666ea9810dc849a76924fc7ec592f2615fbc9904bf7a7f0ed3dfc5f035a363f32c92a1751e83aa7d1189432cb45ecb84cb4864d648690630c9
+  data.tar.gz: f373af39d2dfe44009ed2a3901cf66aaefe0ea48898f6bc74c032dc3f04294bd123b3ac3073d261007ad01f6852a6a53a84319a9118fed3d656ec5d50ccb9f8e

data/lib/human_error.rb

@@ -1,5 +1,7 @@
 require 'human_error/configuration'
 require 'human_error/error'
+require 'human_error/errors/authorization_error'
+require 'human_error/errors/authorization_errors/forbidden_error'
 require 'human_error/errors/authentication_error'
 require 'human_error/errors/authentication_errors/duplicate_authentication_error'
 require 'human_error/errors/authentication_errors/invalid_token_error'
@@ -40,6 +42,6 @@ class   HumanError
   end
 
   def self.raise(error_type, **args)
-    Kernel.raise build(error_type, **args)
+    Kernel.fail build(error_type, **args)
   end
 end

data/lib/human_error/errors/authentication_error.rb

@@ -1,3 +1,5 @@
+require 'human_error/error'
+
 class   HumanError
 module  Errors
 module  AuthenticationError

data/lib/human_error/errors/authorization_error.rb

@@ -0,0 +1,8 @@
+require 'human_error/error'
+
+class   HumanError
+module  Errors
+module  AuthorizationError
+end
+end
+end

data/lib/human_error/errors/authorization_errors/forbidden_error.rb

@@ -0,0 +1,47 @@
+require 'human_error/errors/authorization_error'
+
+class   HumanError
+module  Errors
+class   ForbiddenError < RuntimeError
+  include Error
+  include AuthorizationError
+
+  NON_SPECIFIC_RESOURCE_ACTIONS = %w{index create}.freeze
+
+  attr_accessor :resource_name,
+                :resource_id,
+                :action
+
+  def http_status
+    403
+  end
+
+  def title
+    'Forbidden'
+  end
+
+  def detail
+    detail_quantity = if NON_SPECIFIC_RESOURCE_ACTIONS.include? action.to_s
+                        "#{action} a #{resource_name}"
+                      else
+                        "#{action} the #{resource_name} with ID #{resource_id}"
+                      end
+
+    "You do not have access to #{detail_quantity}. Providing a different set of " \
+    'credentials may potentially allow you access to this resource.'
+  end
+
+  def source
+    @source ||= {
+      'resource_name' => resource_name,
+      'resource_id'   => resource_id,
+      'action'        => @action,
+    }
+  end
+
+  def action
+    @action || 'access'
+  end
+end
+end
+end

data/lib/human_error/version.rb

@@ -1,3 +1,3 @@
 class HumanError
-  VERSION = '3.0.1'
+  VERSION = '3.1.0'.freeze
 end

data/spec/lib/human_error/errors/authorization_errors/forbidden_error_spec.rb

@@ -0,0 +1,51 @@
+require 'rspectacular'
+require 'human_error/errors/authorization_errors/forbidden_error'
+
+class     HumanError
+module    Errors
+describe  ForbiddenError do
+  let(:error) { ForbiddenError.new }
+
+  it 'has a status of 403' do
+    expect(error.http_status).to eql 403
+  end
+
+  it 'has a code' do
+    expect(error.code).to eql 'errors.forbidden_error'
+  end
+
+  it 'has a title' do
+    expect(error.title).to eql 'Forbidden'
+  end
+
+  it 'can output the detail for actions affecting a specific resource' do
+    error = ForbiddenError.new(resource_name: 'resource',
+                               resource_id:   '123',
+                               action:        'show')
+
+    expect(error.detail).to eql \
+    'You do not have access to show the resource with ID 123. Providing a different ' \
+    'set of credentials may potentially allow you access to this resource.'
+  end
+
+  it 'can output the detail for actions affecting multiple resources' do
+    error = ForbiddenError.new(resource_name: 'resource',
+                               action:        'create')
+
+    expect(error.detail).to eql \
+    'You do not have access to create a resource. Providing a different ' \
+    'set of credentials may potentially allow you access to this resource.'
+  end
+
+  it 'can output the source' do
+    error = ForbiddenError.new(resource_name: 'resource',
+                               resource_id:   '123',
+                               action:        'show')
+
+    expect(error.source).to eql('resource_name' => 'resource',
+                                'resource_id'   => '123',
+                                'action'        => 'show')
+  end
+end
+end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: human_error
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - jfelchner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-12 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -82,6 +82,8 @@ files:
 - lib/human_error/errors/authentication_errors/duplicate_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/authorization_error.rb
+- lib/human_error/errors/authorization_errors/forbidden_error.rb
 - lib/human_error/errors/crud_error.rb
 - lib/human_error/errors/crud_errors/association_error.rb
 - lib/human_error/errors/crud_errors/resource_not_found_error.rb
@@ -97,6 +99,7 @@ files:
 - spec/lib/human_error/errors/authentication_errors/duplicate_authentication_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/authorization_errors/forbidden_error_spec.rb
 - 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
@@ -134,6 +137,7 @@ test_files:
 - spec/lib/human_error/errors/authentication_errors/duplicate_authentication_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/authorization_errors/forbidden_error_spec.rb
 - 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