salestation 3.7.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c1c39aa648194b22cc8f4e75bccddaa3d51992c5fcd6c85facadb6960f52db0
-  data.tar.gz: 9d2132d9c51921bec0146a5a22c7cc7f6c5dbbf3ef5a044cd1f405d4e4953e78
+  metadata.gz: ee35e90cf574b4f34cc2105366dbd8a5b9a3fedd8f1c5dd8313b45406055a553
+  data.tar.gz: 91c6dec1705886e385d4c40ddad5c974b62bc315faa4d1e5419e9db2479900a7
 SHA512:
-  metadata.gz: 3f6ba6c35d4e30f10ee547b484457948602d19fcc91da64912bda45ed8043378bea84ceb29d2a5a6912be5c85eb4dc3bf4520b4c96b93e50e4a4e1bebeaf1c57
-  data.tar.gz: c116c954f2a544fb5d100718f27c1a599aa1b83b7efa0d0216f365e1137af64d8811a5da362f0652497eb949816bb50e0e1276be0acef67b9caac4b55fefad6f
+  metadata.gz: b6c123447543bf3fd0c7e9a6633e6137816d729fd516c7bc1372299203b9827f3d8c1a84f4e90d40af09f79194b1cb8d3fe86cc078a0835f5438b19c8a667a81
+  data.tar.gz: 0a6a27008d3556219cdbcf2109799b80ef71dc34f4b945c0ad159e278a13852a5532915e45c51a2b53705125f0da9635853e52b8c17ac57853d5c0fb4e27b39b

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/responses.rb

@@ -35,9 +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::Coercible::Hash.optional
+
+        def body
+          super.merge({form_errors: form_errors}.compact)
         end
       end
 
@@ -48,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)
+          UnprocessableEntity.new(
+            message: message,
+            debug_message: debug_message,
+            form_errors: form_errors ? errors : nil,
+            base_error: base_error
+          )
         end
 
         def self.parse_errors(errors)
@@ -99,7 +114,7 @@ module Salestation
       Conflict = Error.with_code(409)
       RequestEntityTooLarge = Error.with_code(413)
       UnsupportedMediaType = Error.with_code(415)
-      UnprocessableEntity = Error.with_code(422)
+      UnprocessableEntity = UnprocessableEntityError.with_code(422)
 
       InternalError = Error.with_code(500)
       ServiceUnavailable = Error.with_code(503)

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.7.0"
+  spec.version       = "4.0.1"
   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.7.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Glia TechMovers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-06-25 00:00:00.000000000 Z
+date: 2021-02-12 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: []