salestation 5.0.1 → 5.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f13d59875d14de627bc0a9acb2f52ac9e09ac1fac38b8741199aa6342852ca8
-  data.tar.gz: 505233565865a9f2e527deaed88e1b89788b1bfbfab873ec15b0a85dd5fe1503
+  metadata.gz: 2e5fcc23d8c9f54b0aaa72e76f5f38d791c92330a462427bf5a16e8abe18a14b
+  data.tar.gz: fe02f21991d869abd3c6eb71c2bbc7163c36a61f0e7850384fe9b4030a01f868
 SHA512:
-  metadata.gz: 3f26ae48f7f8169d0457938205dc3c08136bcb112a445e071beb2e6d2a792d4b47ebb1afe2497f7e18bcb08bf4daa70168ff85665f59ee07e8e37eafc4771990
-  data.tar.gz: 0fde7366029cf2123d7a7b51c524e412f638eb6da3fc2285675bdd8ce89e6572b0c6d80d8d7244ed7c018dc9c2d292bea19301e3f446b827a5fe381b94c144cf
+  metadata.gz: c877ea4130f851227bb93461deef52e72b27c92c504cd8bc837d866d43be045ae632036772a571c8dbc01239afa455d8440bdcd90bcbad52732fcc2cd732b3dd
+  data.tar.gz: a74f378182c0306e5b88b13adf8c25a48ba6bb4efc13ae1e5392b97c3392ede261bb0445cef7e36110fc11e78adda79fe000896769e9c300a19329a48a469b5b

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+.rspec_persistence

data/README.md

@@ -104,6 +104,14 @@ Multiple extractors can be merged together. If two or more extractors use the sa
 
 `coercions` can optionally be provided to `BodyParamExtractor` and `QueryParamExtractor`. These can be used to transform the values of the extracted parameters.
 
+#### ParamExtractor
+
+ParamExtractor, which is also used by `BodyParamExtractor` and `QueryParamExtractor`, 
+extracts only the content of such root level keys that are specified when creating the
+extractor instance. All other root level keys are discarded. Everything inside the 
+whitelisted root level keys is automatically whitelisted.
+
+
 Define a route
 
 ```ruby

data/lib/salestation/rspec/glia_input_validation_error_matcher.rb

@@ -12,37 +12,73 @@ module Salestation
       def initialize
         @fields = []
         @field_error_types = {}
+        @field_error_messages = {}
       end
 
-      def on(field)
-        @fields << field
+      def on(*nested_fields)
+        @fields << nested_fields
         self
       end
 
       def with_type(*types)
-        @field_error_types[@fields.last] = types
+        @field_error_types[field_to_key(@fields.last)] = types
+        self
+      end
+
+      def with_message(*messages)
+        @field_error_messages[field_to_key(@fields.last)] = messages
         self
       end
 
       def matches?(actual)
         @fields.all? do |field|
-          check_field_exists(field, actual) &&
-            check_field_error_types(field, actual)
+          check_field_exists(actual, *field) &&
+            check_field_error_types(field, actual) &&
+            check_field_error_messages(field, actual)
         end
       end
 
       private
 
-      def check_field_exists(field, actual)
-        actual[:error_details].key?(field)
+      def check_field_exists(actual, field, *nested_fields)
+        actual[:error_details].key?(field) &&
+          (
+            nested_fields.empty? ||
+            actual[:error_details][field].any? do |nested_hash|
+              check_field_exists(nested_hash, *nested_fields)
+            end
+          )
       end
 
       def check_field_error_types(field, actual)
-        return true unless @field_error_types[field]
+        return true unless @field_error_types[field_to_key(field)]
+
+        actual_error_types = fetch_field_attribute_nested(actual, :type, *field)
+        (@field_error_types[field_to_key(field)] - actual_error_types).empty?
+      end
+
+      def check_field_error_messages(field, actual)
+        return true unless @field_error_messages[field_to_key(field)]
 
-        actual_error_types = actual[:error_details].fetch(field).map { |f| f.fetch(:type) }
+        actual_error_messages = fetch_field_attribute_nested(actual, :message, *field)
+        (@field_error_messages[field_to_key(field)] - actual_error_messages).empty?
+      end
+
+
+      def fetch_field_attribute_nested(actual, attribute, field, *nested_fields)
+        if nested_fields.empty?
+          actual[:error_details].fetch(field).map { |f| f.fetch(attribute) }
+        else
+          actual[:error_details][field]
+            .lazy
+            .map { |error_hash| fetch_field_attribute_nested(error_hash, attribute, *nested_fields) }
+            .reject(&:nil?)
+            .first
+        end
+      end
 
-        (@field_error_types[field] - actual_error_types).empty?
+      def field_to_key(fields)
+        fields.join('->').to_sym
       end
     end
   end

data/lib/salestation/rspec.rb

@@ -44,6 +44,23 @@ module Salestation
     #         .on(:phone_number).with_type(Glia::Errors::INVALID_FORMAT_ERROR)
     #     )
     #
+    # also has support for nested errors:
+    #  nesting can be represented by calling `on` method with multiple arguments, for example when
+    #  you have a hash like
+    #  {
+    #    nested: {
+    #      name: ''
+    #    }
+    #  }
+    #  Then you can call it like glia_input_validation_error.on(:nested, :name)
+    #
+    #   expect(result).to be_failure
+    #     .with_invalid_input
+    #     .containing(
+    #       glia_input_validation_error
+    #         .on(:nested, :name).with_type(Glia::Errors::INVALID_VALUE_ERROR)
+    #     )
+    #
     # Everything after be_failure is optional. You could also use `.containing`
     # multiple times like this:
     #

data/lib/salestation/web/extractors.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+require "symbolizer"
 
 module Salestation
   class Web < Module
@@ -192,35 +193,18 @@ module Salestation
         end
 
         def self.extract(filters, request_hash)
-          filters.each_with_object({}) do |filter, extracted_data|
-            case filter
-            when Symbol
-              stringified_key = filter.to_s
-              extracted_data[filter] = request_hash[stringified_key] if request_hash.key?(stringified_key)
-              if extracted_data[filter].is_a?(Array)
-                extracted_data[filter] = extracted_data[filter].map{ |hash|
-                  if hash.is_a?(Hash)
-                    hash.transform_keys(&:to_sym) if hash.is_a?(Hash)
-                  else
-                    hash
-                  end
-                }
-              end
-            when Hash
-              filter.each do |key, nested_filters|
-                stringified_key = key.to_s
-                if request_hash.key?(stringified_key)
-                  value = request_hash.fetch(stringified_key)
-                  extracted_data[key] =
-                    if !value.is_a?(Hash)
-                      value
-                    else
-                      extract(nested_filters, value)
-                    end
-                end
-              end
-            end
-          end
+          # Filter as a hash is used in some existing implementations that did not expect full 
+          # recursive symbolizing of keys. In this case hash objects at the highest level of object 
+          # are represented as hash of filter keys. This is no longer needed, but we support it 
+          # to avoid a breaking change.
+
+          filters_flat = filters
+                          .flat_map {|filter| filter.is_a?(Hash) ? filter.keys : filter}
+                          .map(&:to_s)
+
+          request_hash = request_hash.select {|k,v| filters_flat.include?(k)}
+
+          Symbolizer.symbolize(request_hash)
         end
       end
 

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       = "5.0.1"
+  spec.version       = "5.2.0"
   spec.authors       = ["Glia TechMovers"]
   spec.email         = ["techmovers@glia.com"]
 
@@ -30,4 +30,5 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'dry-struct'
   spec.add_dependency 'dry-types'
   spec.add_dependency 'http-accept', '~> 2.1'
+  spec.add_dependency 'symbolizer'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salestation
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 5.2.0
 platform: ruby
 authors:
 - Glia TechMovers
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-06-10 00:00:00.000000000 Z
+date: 2022-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,6 +150,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: symbolizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: ''
 email:
 - techmovers@glia.com