salestation 3.8.0 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fe9755ef3152c1d5e9821aa2a7be920245b35f7ee95f26fd1e0fe3fb5934468
-  data.tar.gz: f9b1e080731f605cfe7f3ccd2194b923fe70b668757198b105c5ee697ca29637
+  metadata.gz: 85ac2feb504421f1ab20912abbf6994765d3ad6b743360a4e47c67a5bb362774
+  data.tar.gz: 3e6571aeb33d1c2edd94857a6de854e477f8e3a87a2abeac8d352634e01e3012
 SHA512:
-  metadata.gz: c5988265e60fdfa3f8dc7fe1915e38cd6d3afc1aabeca923de08bf9726c21db355d04ce6d9047bfda8d7b8fa4773104fdacbd169a12de6c75ce702aafbd5e6dd
-  data.tar.gz: 1f3351524846ddea69d54281ab5262ffaa138a4fdf83092614030ca7d60bcb99d44a4944aa1690c04ecf88e41e39cf1d3209588e6730bd92566cf25e66393cec
+  metadata.gz: 6d0a4278a94c18bc1a5a5286c0b3941701fda3182d9bcbc27d5b29ccf57841b296b618a75ef67fe1e8a3e88f8c5a649fc3100803d2e79c1d812b0f90b2c13e12
+  data.tar.gz: 80a64adaf82c53f673926a47cc389ae8554c589aa52e41c84ee23a68807d1c49b098c72bf5a338cd0255f689176c0e44f15b7fe0389ea3a90ec89d0bd3a54827

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,52 @@
 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
+        attribute? :form_errors, Types::Strict::Bool.default(false)
       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/extractors.rb

@@ -125,8 +125,10 @@ module Salestation
               extracted_data[filter] = request_hash[stringified_key] if request_hash.key?(stringified_key)
             when Hash
               filter.each do |key, nested_filters|
-                if request_hash.key?(key.to_s)
-                  extracted_data[key] = extract(nested_filters, request_hash.fetch(key.to_s))
+                stringified_key = key.to_s
+                if request_hash.key?(stringified_key)
+                  value = request_hash.fetch(stringified_key)
+                  extracted_data[key] = value.nil? ? nil : extract(nested_filters, value)
                 end
               end
             end

data/lib/salestation/web/responses.rb

@@ -35,17 +35,19 @@ 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
 
       class UnprocessableEntityError < Error
-        attribute :form_errors, Types::Hash.default({}.freeze)
+        attribute? :form_errors, Types::Coercible::Hash.optional
 
         def body
-          super.merge(form_errors: errors)
+          super.merge({form_errors: form_errors}.compact)
         end
       end
 
@@ -56,11 +58,16 @@ module Salestation
       end
 
       class UnprocessableEntityFromSchemaErrors
-        def self.create(errors:, hints:)
+        def self.create(errors:, hints:, base_error: nil, form_errors: false)
           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: form_errors ? errors : nil,
+            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.0"
+  spec.version       = "4.0.2"
   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.0
+  version: 4.0.2
 platform: ruby
 authors:
 - Glia TechMovers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-03 00:00:00.000000000 Z
+date: 2021-02-26 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: []