glia-errors 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf61f6be102a1651954298dacfe9e93cfeb27f81ad078e52ec7bf16542bf402b
-  data.tar.gz: 2c9d1373869e3f9525d9f01116ecff9b5a09396b855c7c8ce1e3d9fc96eb43d2
+  metadata.gz: 603e9be432c9f317013ed3fb16c5861c75c844a3584d08ac3d4f39f1ba58ace4
+  data.tar.gz: 7c88ac1f5d039ce62ec55f7ecb0ad4001138f48452a34d5697678c318873c753
 SHA512:
-  metadata.gz: ec694ade2f6c374c638832d8ad3a6d67523c218e296901b92560807dae34a29b173edc1eacde316c15c616ec063831886aec324da280b81fed6cc97840c435d4
-  data.tar.gz: d69081a24657b4647e7146d72c165e68b70698f548e7a0b2f1216ade437161a48d873a74b88adcb18f886f10d7fef4b60e0df589ce12466df707e40c7380d48f
+  metadata.gz: 737bc0b2593e79b79fb41c61bafe9ec2ef6b7d4deb9cd3175167fd5bcd30dcb79b4d85bf1c366f8fff5cd6a35ec75e76ce2903919da336bba4b53f118a2e4311
+  data.tar.gz: '0129e0df64a24f03a7b54d013f4c83b76ff1a66fd2e599fcdd7520859e45a4b68900e73a007e51042b171c9f4cbb391918dfdc6a49f9eabb96723ad1be50b245'

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.2

data/glia-errors.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = 'glia-errors'
-  spec.version       = '0.5.0'
+  spec.version       = '0.5.1'
   spec.authors       = ['Glia TechMovers']
   spec.email         = ['techmovers@glia.com']
 

data/lib/glia/errors.rb

@@ -3,6 +3,7 @@
 require_relative './errors/error'
 require_relative './errors/error_types'
 require_relative './errors/client_errors'
+require_relative './errors/server_errors'
 require_relative './errors/mapper'
 
 module Glia

data/lib/glia/errors/client_errors.rb

@@ -19,7 +19,7 @@ module Glia
         super(
           type: INVALID_NUMBER_ERROR,
           ref: "https://example.com/errors/#{INVALID_NUMBER_ERROR}.html",
-          message: "#{humanize(field)} " + (message || 'is invalid')
+          message: "#{humanize(field)} " + (message || 'value is invalid')
         )
       end
     end
@@ -29,7 +29,7 @@ module Glia
         super(
           type: INVALID_VALUE_ERROR,
           ref: "https://example.com/errors/#{INVALID_VALUE_ERROR}.html",
-          message: "#{humanize(field)} " + (message || 'is invalid')
+          message: "#{humanize(field)} " + (message || 'value is invalid')
         )
       end
     end
@@ -77,7 +77,8 @@ module Glia
         super(
           type: INVALID_TYPE_ERROR,
           ref: "https://example.com/errors/#{INVALID_TYPE_ERROR}.html",
-          message: "#{humanize(field)} " + (message || "must be of type #{type}")
+          message: "#{humanize(field)} " + (message || "must be of type #{type}"),
+          error_details: { type: type }
         )
       end
     end
@@ -104,6 +105,8 @@ module Glia
 
     class ResourceNotFoundError < Error
       def initialize(resource:, message: nil)
+        assert_snake_case(resource)
+
         super(
           type: RESOURCE_NOT_FOUND_ERROR,
           ref: "https://example.com/errors/#{RESOURCE_NOT_FOUND_ERROR}.html",
@@ -115,6 +118,8 @@ module Glia
 
     class NotVerifiedError < Error
       def initialize(resource:, message: nil)
+        assert_snake_case(resource)
+
         super(
           type: NOT_VERIFIED_ERROR,
           ref: "https://example.com/errors/#{NOT_VERIFIED_ERROR}.html",
@@ -126,6 +131,9 @@ module Glia
 
     class RemainingAssociationError < Error
       def initialize(resource:, associated_resource:, message: nil)
+        assert_snake_case(resource)
+        assert_snake_case(associated_resource)
+
         default_message =
           "cannot be modified/deleted because it is associated to one or more #{
             humanize(associated_resource)
@@ -141,6 +149,8 @@ module Glia
 
     class LimitExceededError < Error
       def initialize(resource:, max:, message: nil)
+        assert_snake_case(resource)
+
         super(
           type: LIMIT_EXCEEDED_ERROR,
           ref: "https://example.com/errors/#{LIMIT_EXCEEDED_ERROR}.html",
@@ -152,6 +162,8 @@ module Glia
 
     class ResourceAlreadyExistsError < Error
       def initialize(resource:, message: nil)
+        assert_snake_case(resource)
+
         super(
           type: RESOURCE_ALREADY_EXISTS_ERROR,
           ref: "https://example.com/errors/#{RESOURCE_ALREADY_EXISTS_ERROR}.html",
@@ -163,6 +175,9 @@ module Glia
 
     class InvalidResourceStateError < Error
       def initialize(resource:, state:, message: nil)
+        assert_snake_case(resource)
+        assert_snake_case(state)
+
         super(
           type: INVALID_RESOURCE_STATE_ERROR,
           ref: "https://example.com/errors/#{INVALID_RESOURCE_STATE_ERROR}.html",
@@ -186,7 +201,8 @@ module Glia
       def initialize(message: nil)
         super(
           type: RECIPIENT_OPTED_OUT_ERROR,
-          ref: "https://example.com/errors/#{RECIPIENT_OPTED_OUT_ERROR}.html",
+          ref:
+            'https://docs.glia.com/glia-dev/reference/webhooks#example-engagementrequestfailure-event-with-fail_error',
           message: message || 'Recipient has opted out'
         )
       end

data/lib/glia/errors/error.rb

@@ -4,6 +4,7 @@ module Glia
   module Errors
     # Base error
     class Error
+      SNAKE_CASE_REGEX = /^[a-z0-9]+(_[a-z0-9]+)*$/.freeze
       attr_reader :type, :ref, :message, :error_details
 
       def initialize(type:, ref:, message: nil, error_details: nil)
@@ -46,6 +47,12 @@ module Glia
       def humanize(value)
         value.to_s.capitalize.gsub('_', ' ')
       end
+
+      def assert_snake_case(value)
+        return if value.to_s.match(SNAKE_CASE_REGEX)
+
+        raise ArgumentError, "Expected '#{value}' to be in snake case"
+      end
     end
   end
 end

data/lib/glia/errors/error_types.rb

@@ -2,6 +2,7 @@
 
 module Glia
   module Errors
+    # Client errors
     INPUT_VALIDATION_ERROR = 'input_validation_error'
     INVALID_TYPE_ERROR = 'invalid_type_error'
     INVALID_NUMBER_ERROR = 'invalid_number_error'
@@ -18,5 +19,9 @@ module Glia
     INVALID_RESOURCE_STATE_ERROR = 'invalid_resource_state_error'
     AUTHORIZATION_ERROR = 'authorization_error'
     RECIPIENT_OPTED_OUT_ERROR = 'recipient_opted_out_error'
+
+    # Server errors
+    INTERNAL_SERVER_ERROR = 'internal_server_error'
+    SERVICE_UNAVAILABLE_ERROR = 'service_unavailable_error'
   end
 end

data/lib/glia/errors/server_errors.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Glia
+  module Errors
+    # rubocop:disable Style/Documentation
+    class InternalServerError < Error
+      def initialize(message: nil)
+        super(
+          type: INTERNAL_SERVER_ERROR,
+          ref: "https://example.com/errors/#{INTERNAL_SERVER_ERROR}.html",
+          message: message || 'Internal server error'
+        )
+      end
+    end
+
+    class ServiceUnavailableError < Error
+      def initialize(message: nil)
+        super(
+          type: SERVICE_UNAVAILABLE_ERROR,
+          ref: "https://example.com/errors/#{SERVICE_UNAVAILABLE_ERROR}.html",
+          message: message || 'Service unavailable'
+        )
+      end
+    end
+    # rubocop:enable Style/Documentation
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glia-errors
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Glia TechMovers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-22 00:00:00.000000000 Z
+date: 2021-03-02 00:00:00.000000000 Z
 dependencies: []
 description: ''
 email:
@@ -22,6 +22,7 @@ files:
 - ".prettierrc"
 - ".rspec"
 - ".rubocop.yml"
+- ".ruby-version"
 - ".travis.yml"
 - Appraisals
 - Gemfile
@@ -36,6 +37,7 @@ files:
 - lib/glia/errors/error.rb
 - lib/glia/errors/error_types.rb
 - lib/glia/errors/mapper.rb
+- lib/glia/errors/server_errors.rb
 homepage:
 licenses:
 - MIT
@@ -55,7 +57,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Glia REST API errors