salestation 3.8.1 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b5082a680af9f209df45163e85fbaf36ee19c08f752f8bba5fdcc6b33268da7f
-  data.tar.gz: 367153d32a664158e42d94d9b61f9e96693ee054b6d0944ad9c2ef0f299902fb
+  metadata.gz: c185cbbf51aa9e484fad4fc0099a9b518d11954f5c5c2f11d03f9d086fdeee08
+  data.tar.gz: a8c356c5559e1ee1f02da859513badc848003d35cea3167ae66488c631309fca
 SHA512:
-  metadata.gz: c4a938998c2bc6b4480d9de13390998fccce96de4d2a65ad5814d033ef647aafce66ab7250546cf5e3f3794c4ab0341c411d91fefe4a562db2078aad2c2b91f4
-  data.tar.gz: 4884f0bff30fea0101d0b34bb47d0fdccea566c0c273da98ba91bc1f8798416506e8aafa922f2de642dd0b212dd34565fa0826f825374604927f77fa2041e65b
+  metadata.gz: c028e25b401034206c66be282335e78e903edac248adaabecd0041bd5a187397f7bda59d894ed35ded3132aed762e3c8596d4aeeee92f6c5b93fbb9549245ec6
+  data.tar.gz: 4dc319fd28ae97aff269c0a6594a2cb271721da31c2ae48d7afd8927ccc352df1526fcfc486146ef55571788bca954de5649ce36a53b73c09767fb28eae99fb1

data/README.md

@@ -75,6 +75,28 @@ Salestation allows and recommends you to define your own custom errors. This is
   })
 ```
 
+### Providing custom error fields
+
+If you need to specify additional error fields you can use `from` method.
+`from` accepts base error on which the rest of the response is built.
+Base error must be a hash or implement `to_h` method.
+
+Example:
+
+```
+App::Errors::Conflict.from({details: 'details'}, message: 'message', debug_message: 'debug_message')
+```
+
+Response:
+
+```javascript
+{
+  "details": "details",
+  "message": "message",
+  "debug_message": "debug_message"
+}
+```
+
 ### Using Extractors
 
 Salestation provides extractors to fetch parameters from the request and pass them to the chain.

data/lib/salestation/app/errors.rb

@@ -3,43 +3,51 @@
 module Salestation
   class App
     module Errors
-      class InvalidInput < Dry::Struct
+      class Error < Dry::Struct
+        attribute? :base_error, Types::Coercible::Hash
+
+        def self.from(base_error, overrides = {})
+          new(**overrides, base_error: base_error.to_h)
+        end
+      end
+
+      class InvalidInput < Error
         attribute :errors, Types::Strict::Hash
         attribute :hints, Types::Coercible::Hash.default({}.freeze)
         attribute? :debug_message, Types::Strict::String
       end
 
-      class DependencyCurrentlyUnavailable < Dry::Struct
+      class DependencyCurrentlyUnavailable < Error
         attribute :message, Types::Strict::String
         attribute? :debug_message, Types::Strict::String
       end
 
-      class RequestedResourceNotFound < Dry::Struct
+      class RequestedResourceNotFound < Error
         attribute :message, Types::Strict::String
         attribute? :debug_message, Types::Strict::String
       end
 
-      class Forbidden < Dry::Struct
+      class Forbidden < Error
         attribute :message, Types::Strict::String
         attribute? :debug_message, Types::Strict::String
       end
 
-      class Conflict < Dry::Struct
+      class Conflict < Error
         attribute :message, Types::Strict::String
         attribute :debug_message, Types::Strict::String
       end
 
-      class NotAcceptable < Dry::Struct
+      class NotAcceptable < Error
         attribute :message, Types::Strict::String
         attribute :debug_message, Types::Strict::String
       end
 
-      class UnsupportedMediaType < Dry::Struct
+      class UnsupportedMediaType < Error
         attribute :message, Types::Strict::String
         attribute :debug_message, Types::Strict::String
       end
 
-      class RequestEntityTooLarge < Dry::Struct
+      class RequestEntityTooLarge < Error
         attribute :message, Types::Strict::String
         attribute? :debug_message, Types::Strict::String
       end

data/lib/salestation/web/error_mapper.rb

@@ -12,26 +12,27 @@ module Salestation
         App::Errors::DependencyCurrentlyUnavailable => -> (error) {
           Responses::ServiceUnavailable.new(
             message: error.message,
-            debug_message: "Please try again later"
+            debug_message: "Please try again later",
+            base_error: error.base_error
           )
         },
         App::Errors::RequestedResourceNotFound => -> (error) {
-          Responses::NotFound.new(message: error.message, debug_message: error.debug_message)
+          Responses::NotFound.new(message: error.message, debug_message: error.debug_message, base_error: error.base_error)
         },
         App::Errors::Forbidden => -> (error) {
-          Responses::Forbidden.new(message: error.message, debug_message: error.debug_message)
+          Responses::Forbidden.new(message: error.message, debug_message: error.debug_message, base_error: error.base_error)
         },
         App::Errors::Conflict => -> (error) {
-          Responses::Conflict.new(message: error.message, debug_message: error.debug_message)
+          Responses::Conflict.new(message: error.message, debug_message: error.debug_message, base_error: error.base_error)
         },
         App::Errors::NotAcceptable => -> (error) {
-          Responses::NotAcceptable.new(message: error.message, debug_message: error.debug_message)
+          Responses::NotAcceptable.new(message: error.message, debug_message: error.debug_message, base_error: error.base_error)
         },
         App::Errors::UnsupportedMediaType => -> (error) {
-          Responses::UnsupportedMediaType.new(message: error.message, debug_message: error.debug_message)
+          Responses::UnsupportedMediaType.new(message: error.message, debug_message: error.debug_message, base_error: error.base_error)
         },
         App::Errors::RequestEntityTooLarge => -> (error) {
-          Responses::RequestEntityTooLarge.new(message: error.message, debug_message: error.debug_message)
+          Responses::RequestEntityTooLarge.new(message: error.message, debug_message: error.debug_message, base_error: error.base_error)
         }
       }.freeze
 

data/lib/salestation/web/responses.rb

@@ -35,9 +35,11 @@ module Salestation
         attribute :debug_message, Types::Coercible::String.default('')
         attribute :context, Types::Hash.default({}.freeze)
         attribute :headers, Types::Hash.default({}.freeze)
+        attribute? :base_error, Types::Coercible::Hash
 
         def body
-          {message: message, debug_message: debug_message}
+          # Merge into `base_error` to ensure standard fields are not overriden
+          (base_error || {}).merge(message: message, debug_message: debug_message)
         end
       end
 
@@ -56,11 +58,11 @@ module Salestation
       end
 
       class UnprocessableEntityFromSchemaErrors
-        def self.create(errors:, hints:)
+        def self.create(errors:, hints:, base_error: nil)
           message = parse_errors(errors)
           debug_message = parse_hints(hints)
 
-          UnprocessableEntity.new(message: message, debug_message: debug_message, form_errors: errors)
+          UnprocessableEntity.new(message: message, debug_message: debug_message, form_errors: errors, base_error: base_error)
         end
 
         def self.parse_errors(errors)

data/salestation.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "salestation"
-  spec.version       = "3.8.1"
+  spec.version       = "3.9.0"
   spec.authors       = ["Glia TechMovers"]
   spec.email         = ["techmovers@glia.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salestation
 version: !ruby/object:Gem::Version
-  version: 3.8.1
+  version: 3.9.0
 platform: ruby
 authors:
 - Glia TechMovers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-03 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,7 +143,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,8 +158,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: ''
 test_files: []