glia-errors 0.7.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f938565ae0608918f0808c950e1d2621f7d8ef2d347cb9146a37fc1af461a519
-  data.tar.gz: 7d8d9672987fe83c77884532e052adee18e3e980462176b6482dd1a41fb755ec
+  metadata.gz: c39d2869c04082f96dec69d927b471a4ea9a94444cd1b1fefa27c1927599f6d6
+  data.tar.gz: f7858bf6b262b96e3dbd8c2463c6d62c299d9adb6a911b91cb0aa2c814196bdc
 SHA512:
-  metadata.gz: f09300cb765f7ce0fe8d57cce7f8259303acd5dec9ffd61a36307ba0afb9d89c17ca95eb8010526a442ab0028da8fc9c61821f7fbe3cd5727c5d0df2a33e3821
-  data.tar.gz: 8208ee1f6c9e00975df486a1d8fb3f1457f38a576970f15485191f9639340b0ff5247dbcf527f2474ef1f0696ff519994985e9917c91949c33c9e6bcbc9a3c42
+  metadata.gz: 2e01e99725306a950aa584ca37c00535f8a9bdcf1194e01961e325eb24393010df7afefadcd8e681536cc23c4594afec98e5622f4650b15c216a9e80ecce9149
+  data.tar.gz: 0626d5fc71db27e69180411f3bf77fb436357d1ff3b12019646115cf09f129edabd0faf40a0d8b704c023739f804e4b07de61768f852a8221d35385e04c16335

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

data/lib/glia/errors.rb

@@ -12,7 +12,7 @@ module Glia
     def self.from_dry_validation_result(result, custom_error_map = {})
       dry_validation_version = Gem.loaded_specs['dry-validation'].version
       if dry_validation_version < Gem::Version.new('1.0')
-        Mapper.from_dry_validation_result(result.output, result.messages, custom_error_map)
+        Mapper.from_dry_validation_result(result.output, result.errors, custom_error_map)
       elsif dry_validation_version <= Gem::Version.new('1.6')
         Mapper.from_dry_validation_result(result.to_h, result.errors.to_h, custom_error_map)
       else

data/lib/glia/errors/client_errors.rb

@@ -5,6 +5,12 @@ module Glia
     # rubocop:disable Style/Documentation
     class InputValidationError < Error
       def initialize(error_details:, message: nil)
+        raise ArgumentError, 'At least 1 error detail is required' if error_details.keys.count.zero?
+
+        error_details.each_value do |value|
+          raise ArgumentError, 'error_details values must be lists' unless value.is_a?(Array)
+        end
+
         super(
           type: INPUT_VALIDATION_ERROR,
           ref: create_ref(INPUT_VALIDATION_ERROR),
@@ -19,7 +25,7 @@ module Glia
         super(
           type: INVALID_NUMBER_ERROR,
           ref: create_ref(INVALID_NUMBER_ERROR),
-          message: message || "#{humanize(field)} value is invalid"
+          message: message || "#{Naming.humanize(field)} value is invalid"
         )
       end
     end
@@ -29,7 +35,7 @@ module Glia
         super(
           type: INVALID_VALUE_ERROR,
           ref: create_ref(INVALID_VALUE_ERROR),
-          message: message || "#{humanize(field)} value is invalid"
+          message: message || "#{Naming.humanize(field)} value is invalid"
         )
       end
     end
@@ -39,7 +45,7 @@ module Glia
         super(
           type: INVALID_LENGTH_ERROR,
           ref: create_ref(INVALID_LENGTH_ERROR),
-          message: message || "#{humanize(field)} length is invalid"
+          message: message || "#{Naming.humanize(field)} length is invalid"
         )
       end
     end
@@ -54,13 +60,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: create_ref(INVALID_FORMAT_ERROR),
-          message: message || "#{humanize(field)} #{default_message}"
+          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
@@ -77,7 +104,7 @@ module Glia
         super(
           type: INVALID_TYPE_ERROR,
           ref: create_ref(INVALID_TYPE_ERROR),
-          message: message || "#{humanize(field)} must be of type #{type}",
+          message: message || "#{Naming.humanize(field)} must be of type #{type}",
           error_details: { type: type }
         )
       end
@@ -88,29 +115,34 @@ module Glia
         super(
           type: MISSING_VALUE_ERROR,
           ref: create_ref(MISSING_VALUE_ERROR),
-          message: message || "#{humanize(field)} is missing"
+          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: create_ref(UNKNOWN_ERROR),
-          message: message || "#{humanize(field)} validation failed with unknown error"
+          message:
+            if field
+              message || "#{Naming.humanize(field)} validation failed with unknown error"
+            else
+              message || 'Failed with unknown error'
+            end
         )
       end
     end
 
     class ResourceNotFoundError < Error
       def initialize(resource:, message: nil)
-        assert_snake_case(resource)
+        Naming.assert_snake_case(resource)
 
         super(
           type: RESOURCE_NOT_FOUND_ERROR,
           ref: create_ref(RESOURCE_NOT_FOUND_ERROR),
-          message: message || "#{humanize(resource)} not found",
+          message: message || "#{Naming.humanize(resource)} not found",
           error_details: { resource: resource }
         )
       end
@@ -118,12 +150,12 @@ module Glia
 
     class NotVerifiedError < Error
       def initialize(resource:, message: nil)
-        assert_snake_case(resource)
+        Naming.assert_snake_case(resource)
 
         super(
           type: NOT_VERIFIED_ERROR,
           ref: create_ref(NOT_VERIFIED_ERROR),
-          message: message || "#{humanize(resource)} is not verified",
+          message: message || "#{Naming.humanize(resource)} is not verified",
           error_details: { resource: resource }
         )
       end
@@ -131,30 +163,30 @@ module Glia
 
     class RemainingAssociationError < Error
       def initialize(resource:, associated_resource:, message: nil)
-        assert_snake_case(resource)
-        assert_snake_case(associated_resource)
+        Naming.assert_snake_case(resource)
+        Naming.assert_snake_case(associated_resource)
 
         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: create_ref(REMAINING_ASSOCIATION_ERROR),
-          message: message || "#{humanize(resource)} #{default_message}",
+          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)
+        Naming.assert_snake_case(resource)
 
         super(
           type: LIMIT_EXCEEDED_ERROR,
           ref: create_ref(LIMIT_EXCEEDED_ERROR),
-          message: message || "#{humanize(resource)} count must not exceed #{max}",
+          message: message || "#{Naming.humanize(resource)} count must not exceed #{max}",
           error_details: { resource: resource, max: max }
         )
       end
@@ -162,12 +194,12 @@ module Glia
 
     class ResourceAlreadyExistsError < Error
       def initialize(resource:, message: nil)
-        assert_snake_case(resource)
+        Naming.assert_snake_case(resource)
 
         super(
           type: RESOURCE_ALREADY_EXISTS_ERROR,
           ref: create_ref(RESOURCE_ALREADY_EXISTS_ERROR),
-          message: message || "#{humanize(resource)} already exists",
+          message: message || "#{Naming.humanize(resource)} already exists",
           error_details: { resource: resource }
         )
       end
@@ -175,13 +207,13 @@ module Glia
 
     class InvalidResourceStateError < Error
       def initialize(resource:, state:, message: nil)
-        assert_snake_case(resource)
-        assert_snake_case(state)
+        Naming.assert_snake_case(resource)
+        Naming.assert_snake_case(state)
 
         super(
           type: INVALID_RESOURCE_STATE_ERROR,
           ref: create_ref(INVALID_RESOURCE_STATE_ERROR),
-          message: message || "#{humanize(resource)} is in invalid state: #{state}",
+          message: message || "#{Naming.humanize(resource)} is in invalid state: #{state}",
           error_details: { resource: resource, state: state }
         )
       end
@@ -206,6 +238,115 @@ module Glia
         )
       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
+
+    class HeadersValidationError < Error
+      def initialize(error_details:, message: nil)
+        raise ArgumentError, 'At least 1 error detail is required' if error_details.keys.count.zero?
+
+        error_details.each_value do |value|
+          raise ArgumentError, 'error_details values must be lists' unless value.is_a?(Array)
+        end
+
+        error_details.each_key { |key| Naming.assert_header(key) }
+
+        super(
+          type: HEADERS_VALIDATION_ERROR,
+          ref: create_ref(HEADERS_VALIDATION_ERROR),
+          message: message || 'Headers are invalid',
+          error_details: error_details
+        )
+      end
+    end
     # rubocop:enable Style/Documentation
   end
 end

data/lib/glia/errors/error.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
+require_relative './naming'
+
 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)
@@ -43,18 +44,6 @@ module Glia
           [TrueClass, FalseClass, String, Integer, Float, Symbol].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('_', ' ')
-      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
-
       def create_ref(type)
         fragment = type.gsub('_', '-')
         "https://docs.glia.com/glia-dev/reference/errors##{fragment}"

data/lib/glia/errors/error_types.rb

@@ -19,6 +19,16 @@ 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'
+    HEADERS_VALIDATION_ERROR = 'headers_validation_error'
 
     # Server errors
     INTERNAL_SERVER_ERROR = 'internal_server_error'

data/lib/glia/errors/naming.rb

@@ -0,0 +1,50 @@
+# 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 uri url].freeze
+      PLURAL_ABBREVIATIONS = %w[ids uuids uris urls].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
+
+      SNAKE_CASE_REGEX = /\A[a-z0-9]+(_[a-z0-9]+)*\z/.freeze
+
+      def self.assert_snake_case(value)
+        return if value.to_s.match(SNAKE_CASE_REGEX)
+
+        raise ArgumentError, "Expected '#{value}' to be in snake case"
+      end
+
+      HEADER_REGEX = /\A[A-Z0-9]+[a-z0-9]*(-[A-Z0-9]+[a-zz0-9]*)*\z/.freeze
+
+      def self.assert_header(value)
+        return if value.to_s.match(HEADER_REGEX)
+
+        raise ArgumentError, "Expected '#{value}' to be a valid header"
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glia-errors
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Glia TechMovers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-05 00:00:00.000000000 Z
+date: 2021-05-31 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: