salestation 3.5.1 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: a23825882ed43419fc0dd8a70d9cc4cf0b24b318
-  data.tar.gz: dfbe08b1eaa5bfd9097e4ba9adbe68dead5660ee
+SHA256:
+  metadata.gz: c185cbbf51aa9e484fad4fc0099a9b518d11954f5c5c2f11d03f9d086fdeee08
+  data.tar.gz: a8c356c5559e1ee1f02da859513badc848003d35cea3167ae66488c631309fca
 SHA512:
-  metadata.gz: 1d177e56a051fed32219225b9a7c4a8ad289eeb87c96d4a03a1826df7e198352913850bb6754818a6be912a90777cd4569733710b9c6d921a1fcd31c0dc33a53
-  data.tar.gz: fb1bfd02506a1d750f62e0ba045cbb1a12f0f6f0fd17a2d6065e4f973e2f0ad1191927626ccbbeb5184f5894ca960aece316df048041cae28bd797cd9cf9cdd2
+  metadata.gz: c028e25b401034206c66be282335e78e903edac248adaabecd0041bd5a187397f7bda59d894ed35ded3132aed762e3c8596d4aeeee92f6c5b93fbb9549245ec6
+  data.tar.gz: 4dc319fd28ae97aff269c0a6594a2cb271721da31c2ae48d7afd8927ccc352df1526fcfc486146ef55571788bca954de5649ce36a53b73c09767fb28eae99fb1

data/.travis.yml

@@ -1,6 +1,4 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.4
-  - 2.5
-before_install: gem install bundler -v 1.17.3
+  - 2.7

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.
@@ -142,14 +164,14 @@ end
 
 Salestation provides a StatsD middleware which can be used record request
 execution time. A `timing` call with elapsed seconds is made to the provided
-StatsD instance with `path`, `method`, `status` tags.
+StatsD instance with `path`, `method`, `status` and `status_class` tags.
 
 ```ruby
 class Webapp < Sinatra::Base
   # ...
   use Salestation::Web::StatsdMiddleware,
     Statsd.new(host, port),
-    metric: 'my-metric'
+    metric: 'my_service.response.time'
 end
 ```
 
@@ -157,7 +179,7 @@ You can configure per-request tags by defining `salestation.statsd.tags` in sina
 
 ```ruby
   def my_handler(env)
-    env['salestation.statsd.tags'] = ['foo', 'bar']
+    env['salestation.statsd.tags'] = ['foo:bar']
     # ...
   end
 ```

data/lib/salestation/app.rb

@@ -7,7 +7,7 @@ require 'dry-types'
 module Salestation
   class App
     module Types
-      include Dry::Types.module
+      include Dry::Types()
     end
 
     def initialize(env:, hooks: {})

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({})
+        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.rb

@@ -8,7 +8,7 @@ require 'json'
 module Salestation
   class Web < Module
     module Types
-      include Dry::Types.module
+      include Dry::Types()
     end
 
     def initialize(errors: {})

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

@@ -32,27 +32,37 @@ module Salestation
       class Error < Response
         attribute :status, Types::Strict::Integer
         attribute :message, Types::Strict::String
-        attribute :debug_message, Types::String.default('')
-        attribute :context, Types::Hash.default({})
-        attribute :headers, Types::Hash.default({})
+        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)
+
+        def body
+          super.merge(form_errors: form_errors)
         end
       end
 
       class Success < Response
         attribute :status, Types::Strict::Integer
         attribute :body, Types::Strict::Hash | Types::Strict::Array
-        attribute :headers, Types::Hash.default({})
+        attribute :headers, Types::Hash.default({}.freeze)
       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)
+          UnprocessableEntity.new(message: message, debug_message: debug_message, form_errors: errors, base_error: base_error)
         end
 
         def self.parse_errors(errors)
@@ -99,7 +109,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/lib/salestation/web/statsd_middleware.rb

@@ -27,9 +27,10 @@ module Salestation
           end
 
         tags = [
-          "path:#{ path }",
-          "method:#{ method }",
-          "status:#{ status }"
+          "path:#{path}",
+          "method:#{method}",
+          "status:#{status}",
+          "status_class:#{status / 100}xx"
         ] + env.fetch(EXTRA_TAGS_ENV_KEY, [])
 
         @statsd.timing(@metric, duration_ms(from: start), tags: tags)

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.5.1"
+  spec.version       = "3.9.0"
   spec.authors       = ["Glia TechMovers"]
   spec.email         = ["techmovers@glia.com"]
 
@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry", "~> 0.10.4"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salestation
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.9.0
 platform: ruby
 authors:
 - Glia TechMovers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2021-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.13'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -143,7 +143,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -158,9 +158,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.4
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: ''
 test_files: []