glia-errors 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9f3f981c61ebf8676c66ee15e0b326d052978374f8099574d8f84370247e834
-  data.tar.gz: a4d50d5aabad297607ef9a8c3f2fef743ba1620212cde790e95547ee9559216d
+  metadata.gz: f938565ae0608918f0808c950e1d2621f7d8ef2d347cb9146a37fc1af461a519
+  data.tar.gz: 7d8d9672987fe83c77884532e052adee18e3e980462176b6482dd1a41fb755ec
 SHA512:
-  metadata.gz: fcf46277d4d7f2368999acab163f89e192d76ca0db527e94c39fdbcefe6b4bdf83dd2e6a116eef2eb2568e0a4d005f86dc06729925aa50b1dc9e050564d62093
-  data.tar.gz: '04281d7946a62f546d3a2e4474336289a83142a2283a622a3abe13988f3d29bf24b66ff1e9aba02a5ce1043cd5232fc262138d1ee061a283e6d4b31a1f13ad98'
+  metadata.gz: f09300cb765f7ce0fe8d57cce7f8259303acd5dec9ffd61a36307ba0afb9d89c17ca95eb8010526a442ab0028da8fc9c61821f7fbe3cd5727c5d0df2a33e3821
+  data.tar.gz: 8208ee1f6c9e00975df486a1d8fb3f1457f38a576970f15485191f9639340b0ff5247dbcf527f2474ef1f0696ff519994985e9917c91949c33c9e6bcbc9a3c42

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.6.1'
+  spec.version       = '0.7.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,7 +18,7 @@ module Glia
       def initialize(field:, message: nil)
         super(
           type: INVALID_NUMBER_ERROR,
-          ref: "https://example.com/errors/#{INVALID_NUMBER_ERROR}.html",
+          ref: create_ref(INVALID_NUMBER_ERROR),
           message: message || "#{humanize(field)} value is invalid"
         )
       end
@@ -28,7 +28,7 @@ module Glia
       def initialize(field:, message: nil)
         super(
           type: INVALID_VALUE_ERROR,
-          ref: "https://example.com/errors/#{INVALID_VALUE_ERROR}.html",
+          ref: create_ref(INVALID_VALUE_ERROR),
           message: message || "#{humanize(field)} value is invalid"
         )
       end
@@ -38,7 +38,7 @@ module Glia
       def initialize(field:, message: nil)
         super(
           type: INVALID_LENGTH_ERROR,
-          ref: "https://example.com/errors/#{INVALID_LENGTH_ERROR}.html",
+          ref: create_ref(INVALID_LENGTH_ERROR),
           message: message || "#{humanize(field)} length is invalid"
         )
       end
@@ -57,7 +57,7 @@ module Glia
           format ? "has invalid format, required format is #{format}" : 'has invalid format'
         super(
           type: INVALID_FORMAT_ERROR,
-          ref: "https://example.com/errors/#{INVALID_FORMAT_ERROR}.html",
+          ref: create_ref(INVALID_FORMAT_ERROR),
           message: message || "#{humanize(field)} #{default_message}"
         )
       end
@@ -76,7 +76,7 @@ module Glia
       def initialize(field:, type:, message: nil)
         super(
           type: INVALID_TYPE_ERROR,
-          ref: "https://example.com/errors/#{INVALID_TYPE_ERROR}.html",
+          ref: create_ref(INVALID_TYPE_ERROR),
           message: message || "#{humanize(field)} must be of type #{type}",
           error_details: { type: type }
         )
@@ -87,7 +87,7 @@ module Glia
       def initialize(field:, message: nil)
         super(
           type: MISSING_VALUE_ERROR,
-          ref: "https://example.com/errors/#{MISSING_VALUE_ERROR}.html",
+          ref: create_ref(MISSING_VALUE_ERROR),
           message: message || "#{humanize(field)} is missing"
         )
       end
@@ -97,7 +97,7 @@ module Glia
       def initialize(field:, message: nil)
         super(
           type: UNKNOWN_ERROR,
-          ref: "https://example.com/errors/#{UNKNOWN_ERROR}.html",
+          ref: create_ref(UNKNOWN_ERROR),
           message: message || "#{humanize(field)} validation failed with unknown error"
         )
       end
@@ -109,7 +109,7 @@ module Glia
 
         super(
           type: RESOURCE_NOT_FOUND_ERROR,
-          ref: "https://example.com/errors/#{RESOURCE_NOT_FOUND_ERROR}.html",
+          ref: create_ref(RESOURCE_NOT_FOUND_ERROR),
           message: message || "#{humanize(resource)} not found",
           error_details: { resource: resource }
         )
@@ -122,7 +122,7 @@ module Glia
 
         super(
           type: NOT_VERIFIED_ERROR,
-          ref: "https://example.com/errors/#{NOT_VERIFIED_ERROR}.html",
+          ref: create_ref(NOT_VERIFIED_ERROR),
           message: message || "#{humanize(resource)} is not verified",
           error_details: { resource: resource }
         )
@@ -140,7 +140,7 @@ module Glia
           }(s)"
         super(
           type: REMAINING_ASSOCIATION_ERROR,
-          ref: "https://example.com/errors/#{REMAINING_ASSOCIATION_ERROR}.html",
+          ref: create_ref(REMAINING_ASSOCIATION_ERROR),
           message: message || "#{humanize(resource)} #{default_message}",
           error_details: { resource: resource, associated_resource: associated_resource }
         )
@@ -153,7 +153,7 @@ module Glia
 
         super(
           type: LIMIT_EXCEEDED_ERROR,
-          ref: "https://example.com/errors/#{LIMIT_EXCEEDED_ERROR}.html",
+          ref: create_ref(LIMIT_EXCEEDED_ERROR),
           message: message || "#{humanize(resource)} count must not exceed #{max}",
           error_details: { resource: resource, max: max }
         )
@@ -166,7 +166,7 @@ module Glia
 
         super(
           type: RESOURCE_ALREADY_EXISTS_ERROR,
-          ref: "https://example.com/errors/#{RESOURCE_ALREADY_EXISTS_ERROR}.html",
+          ref: create_ref(RESOURCE_ALREADY_EXISTS_ERROR),
           message: message || "#{humanize(resource)} already exists",
           error_details: { resource: resource }
         )
@@ -180,7 +180,7 @@ module Glia
 
         super(
           type: INVALID_RESOURCE_STATE_ERROR,
-          ref: "https://example.com/errors/#{INVALID_RESOURCE_STATE_ERROR}.html",
+          ref: create_ref(INVALID_RESOURCE_STATE_ERROR),
           message: message || "#{humanize(resource)} is in invalid state: #{state}",
           error_details: { resource: resource, state: state }
         )
@@ -191,7 +191,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,8 +201,7 @@ 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

data/lib/glia/errors/error.rb

@@ -54,6 +54,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/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.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Glia TechMovers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-03-05 00:00:00.000000000 Z
 dependencies: []
 description: ''
 email: