salestation 4.1.0 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68e2a18e5e9afcefd5ebec1ff8ed6fce053049fc71dbc04ef863662810fbcc69
-  data.tar.gz: 935756c02ffb2d60138c3be7b8506215ed0b9a720e85c6e606751eb71b13ebd9
+  metadata.gz: 95319eaf34503c8cdbe7c7ebbaefbd23e92090417ee6588fe394714981c87efe
+  data.tar.gz: 9ec9d477a27876759501d401981a5dcdcacc00d543c3af954da325fce42a8b08
 SHA512:
-  metadata.gz: 2cb946c7702e75dc9c00f4bbf80f758a7ec5cde1501d6e7b36e6093a500a854ba5a209a1d62973c113aa7534cb7d620be82ad27f0cccad32b6adb774d8e5d26a
-  data.tar.gz: 9aaf105fa50b0e82e3fcd613e53d2dba9023930ada4281edcf53cc1be5ee6cdb44966c02bedb5a0f6a6cb3bd306d9dd40dd56dcc2a6891679a23b2f139d0f9f7
+  metadata.gz: 85caaf8b2e31975fc302dff5492dabf42fb2affd681e4f038de544d48b9a3df4903a8eb11f2b2dbe3a244be13061a225e01f458ffcf5c6c008aab7ec0e61bef0
+  data.tar.gz: 11a0e53eea71d877032836b2b11762d4f20fabf42a86b2742ba4db6b8ad9b0ad26df3d3fadaa2d00231e0048bb9b288b118a2ef05f3d92ddf447cc8d7cca67ea

data/README.md

@@ -184,6 +184,29 @@ You can configure per-request tags by defining `salestation.statsd.tags` in sina
   end
 ```
 
+## RSpec helpers
+
+
+To use Salestation RSpec matchers you first need to include them:
+
+```
+require 'salestation/rspec'
+
+RSpec.configure do |config|
+  config.include Salestation::RSpec::Matchers
+end
+```
+
+After that it's possible to match against error results like this:
+
+```
+expect(result).to be_failure
+  .with_conflict
+  .containing(message: 'Oh noes')
+```
+
+See lib/salestation/rspec.rb for more examples.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/salestation/rspec.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'rspec/expectations'
+require 'salestation/app'
+
+require_relative './rspec/failure_matcher'
+require_relative './rspec/glia_input_validation_error_matcher'
+
+module Salestation
+  module RSpec
+    # Usage:
+    #
+    # In your RSpec configuration first include the matchers:
+    #
+    #   RSpec.configure do |config|
+    #     config.include Salestation::RSpec::Matchers
+    #   end
+    #
+    # Then you can use the matchers like this:
+    #
+    #   expect(result).to be_failure
+    #     .with_conflict
+    #     .containing(message: 'Oh noes')
+    #
+    # or when using Glia Errors:
+    #
+    #   expect(result).to be_failure
+    #     .with_requested_resource_not_found
+    #     .containing(Glia::Errors::ResourceNotFoundError.new(resource: :user))
+    #
+    # or when matching input errors from Glia Errors:
+    #
+    #   expect(result).to be_failure
+    #     .with_invalid_input
+    #     .containing(glia_input_validation_error.on(:name).with_type(Glia::Errors::INVALID_VALUE_ERROR))
+    #
+    # or you could even match multiple input errors at the same time:
+    #   expect(result).to be_failure
+    #     .with_invalid_input
+    #     .containing(
+    #       glia_input_validation_error
+    #         .on(:name).with_type(Glia::Errors::INVALID_VALUE_ERROR)
+    #         .on(:email)
+    #         .on(:phone_number).with_type(Glia::Errors::INVALID_FORMAT_ERROR)
+    #     )
+    #
+    # Everything after be_failure is optional. You could also use `.containing`
+    # multiple times like this:
+    #
+    #   expect(result).to be_failure
+    #     .containing(Glia::Errors::ResourceNotFoundError.new(resource: :user))
+    #     .containing(hash_including(message: 'Overriden message'))
+    #
+    module Matchers
+      def be_failure
+        FailureMatcher.new
+      end
+
+      def glia_input_validation_error
+        GliaInputValidationErrorMatcher.new
+      end
+    end
+  end
+end

data/lib/salestation/rspec/failure_matcher.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+require 'rspec/expectations'
+
+module Salestation
+  module RSpec
+    class FailureMatcher
+      include ::RSpec::Matchers::Composable
+
+      attr_reader :expected, :actual, :failure_message
+
+      def initialize
+        @contents_matchers = []
+      end
+
+      def with(error_class)
+        @error_class = error_class
+        self
+      end
+
+      # From: active_support/inflector/methods.rb
+      def self.underscore(camel_cased_word)
+        return camel_cased_word unless /[A-Z-]|::/.match?(camel_cased_word)
+        word = camel_cased_word.to_s.gsub("::", "/")
+        word.gsub!(/([A-Z\d]+)([A-Z][a-z])/, '\1_\2')
+        word.gsub!(/([a-z\d])([A-Z])/, '\1_\2')
+        word.tr!("-", "_")
+        word.downcase!
+        word
+      end
+      private_class_method :underscore
+
+      # Defined methods using error class names:
+      #   with_conflict
+      #   with_invalid_input
+      #   ...
+      Salestation::App::Errors.constants.each do |class_name|
+        define_method(:"with_#{underscore(class_name.to_s)}") do
+          with(Salestation::App::Errors.const_get(class_name))
+          self
+        end
+      end
+
+      def containing(matcher)
+        @contents_matchers << matcher
+        self
+      end
+
+      def matches?(actual)
+        check_failure(actual) &&
+          check_error_type(actual) &&
+          check_contents(actual)
+      end
+
+      def diffable?
+        true
+      end
+
+      private
+
+      def check_failure(actual)
+        return true if actual.class == Deterministic::Result::Failure
+
+        @failure_message = "Expected Failure(...), but got #{actual.inspect}"
+        @expected = Deterministic::Result::Failure
+        @actual = actual.class
+        false
+      end
+
+      def check_error_type(actual)
+        return true unless @error_class
+        return true if actual.value.class == @error_class
+
+        @failure_message = "Expected failure to include #{@error_class}, but got #{actual.value.inspect}"
+        @expected = @error_class
+        @actual = actual.value.class
+        false
+      end
+
+      def check_contents(actual)
+        return true if @contents_matchers.empty?
+
+        has_error = @contents_matchers.detect do |contents_matcher|
+          if contents_matcher.is_a?(Hash) || rspec_matcher?(contents_matcher)
+            verify_contents_using_regular_matcher!(contents_matcher, actual)
+          else
+            verify_contents_using_base_error!(contents_matcher, actual)
+          end
+        end
+
+        !has_error
+      end
+
+      # Returns true when error was detected
+      def verify_contents_using_regular_matcher!(contents_matcher, actual)
+        return false if values_match?(contents_matcher, actual.value.to_h)
+
+        @failure_message = "Contents in #{actual.value.class} do not match"
+        @expected = contents_matcher
+        @actual = actual.value.to_h
+
+        true
+      end
+
+      # Returns true when error was detected
+      def verify_contents_using_base_error!(contents_matcher, actual)
+        # Compare hashes if possible, otherwise expect it to respond to `#matches?`.
+        contents_matcher = contents_matcher.to_h if contents_matcher.respond_to?(:to_h)
+
+        return false if values_match?(contents_matcher, actual.value[:base_error])
+
+        @failure_message = "Expected failure to be based on #{contents_matcher}, but got #{actual.value.inspect}"
+        @expected = contents_matcher
+        @actual = actual.value[:base_error].to_h
+
+        true
+      end
+
+      def rspec_matcher?(matcher)
+        # Didn't find a better way to detect matchers like HashIncludingMatcher
+        matcher.class.to_s.start_with?('RSpec')
+      end
+    end
+  end
+end

data/lib/salestation/rspec/glia_input_validation_error_matcher.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'rspec/expectations'
+
+module Salestation
+  module RSpec
+    class GliaInputValidationErrorMatcher
+      include ::RSpec::Matchers::Composable
+
+      attr_reader :expected, :actual, :failure_message
+
+      def initialize
+        @fields = []
+        @field_error_types = {}
+      end
+
+      def on(field)
+        @fields << field
+        self
+      end
+
+      def with_type(*types)
+        @field_error_types[@fields.last] = types
+        self
+      end
+
+      def matches?(actual)
+        @fields.all? do |field|
+          check_field_exists(field, actual) &&
+            check_field_error_types(field, actual)
+        end
+      end
+
+      private
+
+      def check_field_exists(field, actual)
+        actual[:error_details].key?(field)
+      end
+
+      def check_field_error_types(field, actual)
+        return true unless @field_error_types[field]
+
+        actual_error_types = actual[:error_details].fetch(field).map { |f| f.fetch(:type) }
+
+        (@field_error_types[field] - actual_error_types).empty?
+      end
+    end
+  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       = "4.1.0"
+  spec.version       = "4.2.0"
   spec.authors       = ["Glia TechMovers"]
   spec.email         = ["techmovers@glia.com"]
 
@@ -23,6 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry", "~> 0.10.4"
+  spec.add_development_dependency "glia-errors", "~> 0.8"
+  spec.add_development_dependency "dry-validation"
 
   spec.add_dependency 'deterministic'
   spec.add_dependency 'dry-struct'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salestation
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Glia TechMovers
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-04 00:00:00.000000000 Z
+date: 2021-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: glia-errors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: deterministic
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +156,9 @@ files:
 - lib/salestation/app/input_verification.rb
 - lib/salestation/app/request.rb
 - lib/salestation/result_helper.rb
+- lib/salestation/rspec.rb
+- lib/salestation/rspec/failure_matcher.rb
+- lib/salestation/rspec/glia_input_validation_error_matcher.rb
 - lib/salestation/web.rb
 - lib/salestation/web/active_record_connection_management.rb
 - lib/salestation/web/error_mapper.rb
@@ -143,7 +174,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -158,8 +189,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key:
+rubygems_version: 3.0.9
+signing_key: 
 specification_version: 4
 summary: ''
 test_files: []