glia-errors 0.5.1 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 603e9be432c9f317013ed3fb16c5861c75c844a3584d08ac3d4f39f1ba58ace4
-  data.tar.gz: 7c88ac1f5d039ce62ec55f7ecb0ad4001138f48452a34d5697678c318873c753
+  metadata.gz: f6960566975ff5446a08dfc290bf2b1ebe1d3543df49e79ffb2ec24ad8f87763
+  data.tar.gz: 06f24196271555ebc4f5e2ac217399c8ad161fb0f6717cbe990fd8b7cc607da7
 SHA512:
-  metadata.gz: 737bc0b2593e79b79fb41c61bafe9ec2ef6b7d4deb9cd3175167fd5bcd30dcb79b4d85bf1c366f8fff5cd6a35ec75e76ce2903919da336bba4b53f118a2e4311
-  data.tar.gz: '0129e0df64a24f03a7b54d013f4c83b76ff1a66fd2e599fcdd7520859e45a4b68900e73a007e51042b171c9f4cbb391918dfdc6a49f9eabb96723ad1be50b245'
+  metadata.gz: bf8a1d4cc12a450424668ddf201f7cdf20293e8cca5c4269f6a405bbd91718b40e2e6011537cd39643728510fd75b0e51e05f84dcebf85ea5bcadb3a637f6ce2
+  data.tar.gz: 9ae41cf5a5f711c9a795ca7aeb6e67bc31c57c2926e05bd898b3645c4e4be6acfd1e94eafbbc687a6c0bb8bda512e0cbaa77a6c01f4c6a1b360149f8effcb231

data/README.md

@@ -18,7 +18,18 @@ require 'glia/errors'
 
 ### For Glia developers
 
-#### Map from `dry-validation` result
+#### Create Glia error manually
+
+1. Select error from the [error list](https://internal-docs.at.samo.io/glia-errors/elixir/api-reference.html#modules)
+  - Documentation is for Elixir, however, the errors are the same and their initiation is very similar
+2. Initialize the error according to the error documentation
+
+Example:
+```
+glia_error = Glia::Errors::ResourceNotFoundError.new(resource: :engagement)
+```
+
+#### Create Glia error from `dry-validation` result
 
 Currently 2 `dry-validation` versions are supported:
 * `v0` up to `0.13`
@@ -29,11 +40,10 @@ schema = Dry::Validation.Schema do
   # ...
 end
 result = schema.(input)
-error = Glia::Errors.from_dry_validation_result(result)
-response = error.to_h
+glia_error = Glia::Errors.from_dry_validation_result(result)
 ```
 
-#### Specifying mapping for custom error message
+#### Create Glia error from `dry-validation` that contains custom errors
 
 If you have custom `dry-validation` predicates and error messages you can specify a custom error map.
 Custom error map takes priority over standard error mapping.
@@ -46,8 +56,15 @@ ERROR_MAP = {
     Glia::Errors::InvalidFormatError.new(field: field)
   end
 }
-error = Glia::Errors.from_dry_validation_result(result, ERROR_MAP)
-response = error.to_h
+glia_error = Glia::Errors.from_dry_validation_result(result, ERROR_MAP)
+```
+
+#### Convert Glia error to a hash
+
+You can use this to convert Glia error to hash, so that later it can be converted to JSON.
+
+```ruby
+glia_error.to_h
 ```
 
 ### For REST API integrators

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.1'
+  spec.version       = '0.9.0'
   spec.authors       = ['Glia TechMovers']
   spec.email         = ['techmovers@glia.com']
 

data/lib/glia/errors/client_errors.rb

@@ -7,8 +7,8 @@ module Glia
       def initialize(error_details:, message: nil)
         super(
           type: INPUT_VALIDATION_ERROR,
-          ref: "https://example.com/errors/#{INPUT_VALIDATION_ERROR}.html",
-          message: message,
+          ref: create_ref(INPUT_VALIDATION_ERROR),
+          message: message || 'Input is invalid',
           error_details: error_details
         )
       end
@@ -18,8 +18,8 @@ module Glia
       def initialize(field:, message: nil)
         super(
           type: INVALID_NUMBER_ERROR,
-          ref: "https://example.com/errors/#{INVALID_NUMBER_ERROR}.html",
-          message: "#{humanize(field)} " + (message || 'value is invalid')
+          ref: create_ref(INVALID_NUMBER_ERROR),
+          message: message || "#{Naming.humanize(field)} value is invalid"
         )
       end
     end
@@ -28,8 +28,8 @@ module Glia
       def initialize(field:, message: nil)
         super(
           type: INVALID_VALUE_ERROR,
-          ref: "https://example.com/errors/#{INVALID_VALUE_ERROR}.html",
-          message: "#{humanize(field)} " + (message || 'value is invalid')
+          ref: create_ref(INVALID_VALUE_ERROR),
+          message: message || "#{Naming.humanize(field)} value is invalid"
         )
       end
     end
@@ -38,8 +38,8 @@ module Glia
       def initialize(field:, message: nil)
         super(
           type: INVALID_LENGTH_ERROR,
-          ref: "https://example.com/errors/#{INVALID_LENGTH_ERROR}.html",
-          message: "#{humanize(field)} " + (message || 'length is invalid')
+          ref: create_ref(INVALID_LENGTH_ERROR),
+          message: message || "#{Naming.humanize(field)} length is invalid"
         )
       end
     end
@@ -54,13 +54,34 @@ module Glia
 
       def initialize(field:, format: nil, message: nil)
         default_message =
-          format ? "has invalid format, required format is #{format}" : 'has invalid format'
+          if format
+            "has invalid format, required format is #{humanize_format(format)}"
+          else
+            'has invalid format'
+          end
         super(
           type: INVALID_FORMAT_ERROR,
-          ref: "https://example.com/errors/#{INVALID_FORMAT_ERROR}.html",
-          message: "#{humanize(field)} " + (message || default_message)
+          ref: create_ref(INVALID_FORMAT_ERROR),
+          message: message || "#{Naming.humanize(field)} #{default_message}"
         )
       end
+
+      private
+
+      def humanize_format(format)
+        case format
+        when Formats::DATE
+          'ISO-8601 date'
+        when Formats::TIME
+          'ISO-8601 time'
+        when Formats::DATE_TIME
+          'ISO-8601 date and time'
+        when Formats::UUID
+          'UUID'
+        else
+          raise 'Unexpected InvalidFormatError format'
+        end
+      end
     end
 
     class InvalidTypeError < Error
@@ -76,8 +97,8 @@ module Glia
       def initialize(field:, type:, message: nil)
         super(
           type: INVALID_TYPE_ERROR,
-          ref: "https://example.com/errors/#{INVALID_TYPE_ERROR}.html",
-          message: "#{humanize(field)} " + (message || "must be of type #{type}"),
+          ref: create_ref(INVALID_TYPE_ERROR),
+          message: message || "#{Naming.humanize(field)} must be of type #{type}",
           error_details: { type: type }
         )
       end
@@ -87,18 +108,23 @@ module Glia
       def initialize(field:, message: nil)
         super(
           type: MISSING_VALUE_ERROR,
-          ref: "https://example.com/errors/#{MISSING_VALUE_ERROR}.html",
-          message: "#{humanize(field)} " + (message || 'is missing')
+          ref: create_ref(MISSING_VALUE_ERROR),
+          message: message || "#{Naming.humanize(field)} is missing"
         )
       end
     end
 
     class UnknownError < Error
-      def initialize(field:, message: nil)
+      def initialize(field: nil, message: nil)
         super(
           type: UNKNOWN_ERROR,
-          ref: "https://example.com/errors/#{UNKNOWN_ERROR}.html",
-          message: "#{humanize(field)} " + (message || 'validation failed with unknown error')
+          ref: create_ref(UNKNOWN_ERROR),
+          message:
+            if field
+              message || "#{Naming.humanize(field)} validation failed with unknown error"
+            else
+              message || 'Failed with unknown error'
+            end
         )
       end
     end
@@ -109,8 +135,8 @@ module Glia
 
         super(
           type: RESOURCE_NOT_FOUND_ERROR,
-          ref: "https://example.com/errors/#{RESOURCE_NOT_FOUND_ERROR}.html",
-          message: "#{humanize(resource)} " + (message || 'not found'),
+          ref: create_ref(RESOURCE_NOT_FOUND_ERROR),
+          message: message || "#{Naming.humanize(resource)} not found",
           error_details: { resource: resource }
         )
       end
@@ -122,8 +148,8 @@ module Glia
 
         super(
           type: NOT_VERIFIED_ERROR,
-          ref: "https://example.com/errors/#{NOT_VERIFIED_ERROR}.html",
-          message: "#{humanize(resource)} " + (message || 'is not verified'),
+          ref: create_ref(NOT_VERIFIED_ERROR),
+          message: message || "#{Naming.humanize(resource)} is not verified",
           error_details: { resource: resource }
         )
       end
@@ -136,25 +162,25 @@ module Glia
 
         default_message =
           "cannot be modified/deleted because it is associated to one or more #{
-            humanize(associated_resource)
+            Naming.humanize(associated_resource)
           }(s)"
         super(
           type: REMAINING_ASSOCIATION_ERROR,
-          ref: "https://example.com/errors/#{REMAINING_ASSOCIATION_ERROR}.html",
-          message: "#{humanize(resource)} " + (message || default_message),
+          ref: create_ref(REMAINING_ASSOCIATION_ERROR),
+          message: message || "#{Naming.humanize(resource)} #{default_message}",
           error_details: { resource: resource, associated_resource: associated_resource }
         )
       end
     end
 
-    class LimitExceededError < Error
+    class ResourceLimitExceededError < 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",
-          message: "#{humanize(resource)} " + (message || "count must not exceed #{max}"),
+          ref: create_ref(LIMIT_EXCEEDED_ERROR),
+          message: message || "#{Naming.humanize(resource)} count must not exceed #{max}",
           error_details: { resource: resource, max: max }
         )
       end
@@ -166,8 +192,8 @@ module Glia
 
         super(
           type: RESOURCE_ALREADY_EXISTS_ERROR,
-          ref: "https://example.com/errors/#{RESOURCE_ALREADY_EXISTS_ERROR}.html",
-          message: "#{humanize(resource)} " + (message || 'already exists'),
+          ref: create_ref(RESOURCE_ALREADY_EXISTS_ERROR),
+          message: message || "#{Naming.humanize(resource)} already exists",
           error_details: { resource: resource }
         )
       end
@@ -180,8 +206,8 @@ module Glia
 
         super(
           type: INVALID_RESOURCE_STATE_ERROR,
-          ref: "https://example.com/errors/#{INVALID_RESOURCE_STATE_ERROR}.html",
-          message: "#{humanize(resource)} " + (message || "is in invalid state: #{state}"),
+          ref: create_ref(INVALID_RESOURCE_STATE_ERROR),
+          message: message || "#{Naming.humanize(resource)} is in invalid state: #{state}",
           error_details: { resource: resource, state: state }
         )
       end
@@ -191,7 +217,7 @@ module Glia
       def initialize(message: nil)
         super(
           type: AUTHORIZATION_ERROR,
-          ref: "https://example.com/errors/#{AUTHORIZATION_ERROR}.html",
+          ref: create_ref(AUTHORIZATION_ERROR),
           message: message || 'You do not have permissions to perform the action'
         )
       end
@@ -201,12 +227,101 @@ module Glia
       def initialize(message: nil)
         super(
           type: RECIPIENT_OPTED_OUT_ERROR,
-          ref:
-            'https://docs.glia.com/glia-dev/reference/webhooks#example-engagementrequestfailure-event-with-fail_error',
+          ref: create_ref(RECIPIENT_OPTED_OUT_ERROR),
           message: message || 'Recipient has opted out'
         )
       end
     end
+
+    class RouteNotFoundError < Error
+      def initialize(message: nil)
+        super(
+          type: ROUTE_NOT_FOUND_ERROR,
+          ref: create_ref(ROUTE_NOT_FOUND_ERROR),
+          message: message || 'Route not found'
+        )
+      end
+    end
+
+    class MalformedInputError < Error
+      def initialize(message: nil)
+        super(
+          type: MALFORMED_INPUT_ERROR,
+          ref: create_ref(MALFORMED_INPUT_ERROR),
+          message: message || 'Request is malformed'
+        )
+      end
+    end
+
+    class CarrierError < Error
+      def initialize(message: nil)
+        super(
+          type: CARRIER_ERROR,
+          ref: create_ref(CARRIER_ERROR),
+          message: message || 'Downstream carrier issue occurred'
+        )
+      end
+    end
+
+    class GeographicPermissionError < Error
+      def initialize(message: nil)
+        super(
+          type: GEOGRAPHIC_PERMISSION_ERROR,
+          ref: create_ref(GEOGRAPHIC_PERMISSION_ERROR),
+          message: message || 'Insufficient permissions for geographic region'
+        )
+      end
+    end
+
+    class MessageBlockedError < Error
+      def initialize(message: nil)
+        super(
+          type: MESSAGE_BLOCKED_ERROR,
+          ref: create_ref(MESSAGE_BLOCKED_ERROR),
+          message: message || 'Message blocked or filtered'
+        )
+      end
+    end
+
+    class TelephonyProviderRateLimitExceededError < Error
+      def initialize(message: nil)
+        super(
+          type: TELEPHONY_PROVIDER_RATE_LIMIT_EXCEEDED_ERROR,
+          ref: create_ref(TELEPHONY_PROVIDER_RATE_LIMIT_EXCEEDED_ERROR),
+          message: message || 'Telephony provider message send rate limit exceeded'
+        )
+      end
+    end
+
+    class TelephonyProviderQueueLimitExceededError < Error
+      def initialize(message: nil)
+        super(
+          type: TELEPHONY_PROVIDER_QUEUE_LIMIT_EXCEEDED_ERROR,
+          ref: create_ref(TELEPHONY_PROVIDER_QUEUE_LIMIT_EXCEEDED_ERROR),
+          message: message || 'Telephony provider message send queue is full'
+        )
+      end
+    end
+
+    class TwilioMessagingServiceConfigurationError < Error
+      def initialize(message: nil)
+        super(
+          type: TWILIO_MESSAGING_SERVICE_CONFIGURATION_ERROR,
+          ref: create_ref(TWILIO_MESSAGING_SERVICE_CONFIGURATION_ERROR),
+          message: message || 'Invalid Twilio Messaging Service configuration'
+        )
+      end
+    end
+
+    class UnreachableDestinationError < Error
+      def initialize(message: nil)
+        super(
+          type: UNREACHABLE_DESTINATION_ERROR,
+          ref: create_ref(UNREACHABLE_DESTINATION_ERROR),
+          message: message || 'Destination is unreachable'
+        )
+      end
+    end
     # rubocop:enable Style/Documentation
   end
 end

data/lib/glia/errors/error.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative './naming'
+
 module Glia
   module Errors
     # Base error
@@ -39,13 +41,8 @@ module Glia
       end
 
       def primitive?(details)
-        details.nil? || [TrueClass, FalseClass, String, Integer, Float].include?(details.class)
-      end
-
-      # Converts from camel_case to capitalized more human readable value
-      # first_name => "First name"
-      def humanize(value)
-        value.to_s.capitalize.gsub('_', ' ')
+        details.nil? ||
+          [TrueClass, FalseClass, String, Integer, Float, Symbol].include?(details.class)
       end
 
       def assert_snake_case(value)
@@ -53,6 +50,11 @@ module Glia
 
         raise ArgumentError, "Expected '#{value}' to be in snake case"
       end
+
+      def create_ref(type)
+        fragment = type.gsub('_', '-')
+        "https://docs.glia.com/glia-dev/reference/errors##{fragment}"
+      end
     end
   end
 end

data/lib/glia/errors/error_types.rb

@@ -19,6 +19,15 @@ module Glia
     INVALID_RESOURCE_STATE_ERROR = 'invalid_resource_state_error'
     AUTHORIZATION_ERROR = 'authorization_error'
     RECIPIENT_OPTED_OUT_ERROR = 'recipient_opted_out_error'
+    ROUTE_NOT_FOUND_ERROR = 'route_not_found_error'
+    MALFORMED_INPUT_ERROR = 'malformed_input_error'
+    CARRIER_ERROR = 'carrier_error'
+    GEOGRAPHIC_PERMISSION_ERROR = 'geographic_permission_error'
+    MESSAGE_BLOCKED_ERROR = 'message_blocked_error'
+    TELEPHONY_PROVIDER_RATE_LIMIT_EXCEEDED_ERROR = 'telephony_provider_rate_limit_exceeded_error'
+    TELEPHONY_PROVIDER_QUEUE_LIMIT_EXCEEDED_ERROR = 'telephony_provider_queue_limit_exceeded_error'
+    TWILIO_MESSAGING_SERVICE_CONFIGURATION_ERROR = 'twilio_messaging_service_configuration_error'
+    UNREACHABLE_DESTINATION_ERROR = 'unreachable_destination_error'
 
     # Server errors
     INTERNAL_SERVER_ERROR = 'internal_server_error'

data/lib/glia/errors/naming.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Glia
+  module Errors
+    # Utilities for variable and resouce names
+    module Naming
+      # Converts from camel_case to more human readable value
+      # first_name => "First name"
+      # site_id => "Site ID"
+      def self.humanize(value)
+        result = value.to_s.split('_').map { |word| upcase_if_abbreviation(word) }.join(' ')
+
+        upcase_first(result)
+      end
+
+      ABBREVIATIONS = %w[id uuid saml sip sms mms].freeze
+      PLURAL_ABBREVIATIONS = %w[ids uuids].freeze
+
+      private_class_method def self.upcase_if_abbreviation(value)
+        if ABBREVIATIONS.include?(value)
+          value.upcase
+        elsif PLURAL_ABBREVIATIONS.include?(value)
+          value[0..-2].upcase.concat('s')
+        else
+          value
+        end
+      end
+
+      private_class_method def self.upcase_first(value)
+        value[0].upcase.concat(value[1..-1])
+      end
+    end
+  end
+end

data/lib/glia/errors/server_errors.rb

@@ -7,7 +7,7 @@ module Glia
       def initialize(message: nil)
         super(
           type: INTERNAL_SERVER_ERROR,
-          ref: "https://example.com/errors/#{INTERNAL_SERVER_ERROR}.html",
+          ref: create_ref(INTERNAL_SERVER_ERROR),
           message: message || 'Internal server error'
         )
       end
@@ -17,7 +17,7 @@ module Glia
       def initialize(message: nil)
         super(
           type: SERVICE_UNAVAILABLE_ERROR,
-          ref: "https://example.com/errors/#{SERVICE_UNAVAILABLE_ERROR}.html",
+          ref: create_ref(SERVICE_UNAVAILABLE_ERROR),
           message: message || 'Service unavailable'
         )
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glia-errors
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.9.0
 platform: ruby
 authors:
 - Glia TechMovers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-02 00:00:00.000000000 Z
+date: 2021-03-17 00:00:00.000000000 Z
 dependencies: []
 description: ''
 email:
@@ -37,6 +37,7 @@ files:
 - lib/glia/errors/error.rb
 - lib/glia/errors/error_types.rb
 - lib/glia/errors/mapper.rb
+- lib/glia/errors/naming.rb
 - lib/glia/errors/server_errors.rb
 homepage:
 licenses: