salestation 4.0.2 → 4.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85ac2feb504421f1ab20912abbf6994765d3ad6b743360a4e47c67a5bb362774
-  data.tar.gz: 3e6571aeb33d1c2edd94857a6de854e477f8e3a87a2abeac8d352634e01e3012
+  metadata.gz: ee690e689bb403535e57cdab44d34b9c909e40c45373ce2286d2d0d5548b2c1b
+  data.tar.gz: e2bef8563d3f2a1acd4d0a234da31989a9e4e26c271ebeb363a2c9398f581090
 SHA512:
-  metadata.gz: 6d0a4278a94c18bc1a5a5286c0b3941701fda3182d9bcbc27d5b29ccf57841b296b618a75ef67fe1e8a3e88f8c5a649fc3100803d2e79c1d812b0f90b2c13e12
-  data.tar.gz: 80a64adaf82c53f673926a47cc389ae8554c589aa52e41c84ee23a68807d1c49b098c72bf5a338cd0255f689176c0e44f15b7fe0389ea3a90ec89d0bd3a54827
+  metadata.gz: 5542762ed338dad4d06b993837cdac127fc813213ca8f0309183817893f3a0e84ee3dff126313cd5047c3d6a31253400c2e8cf854893ffe56bc820b16ce9339e
+  data.tar.gz: a3077f9493f67d0aaf5c5ad9769a164af0f379bbfce6690e53ac9d12a8678c58992759651f5acb808e9cd12155dd50de59673fb2f1b927abead0068fbb53d541

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

@@ -7,7 +7,12 @@ require 'dry-types'
 module Salestation
   class App
     module Types
-      include Dry::Types()
+      dry_types_version = Gem.loaded_specs['dry-types'].version
+      if dry_types_version < Gem::Version.new('0.15.0')
+        include Dry::Types.module
+      else
+        include Dry::Types()
+      end
     end
 
     def initialize(env:, hooks: {})

data/lib/salestation/app/errors.rb

@@ -12,44 +12,44 @@ module Salestation
       end
 
       class InvalidInput < Error
-        attribute :errors, Types::Strict::Hash
-        attribute :hints, Types::Coercible::Hash.default({}.freeze)
+        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 < Error
-        attribute :message, Types::Strict::String
+        attribute? :message, Types::Strict::String
         attribute? :debug_message, Types::Strict::String
       end
 
       class RequestedResourceNotFound < Error
-        attribute :message, Types::Strict::String
+        attribute? :message, Types::Strict::String
         attribute? :debug_message, Types::Strict::String
       end
 
       class Forbidden < Error
-        attribute :message, Types::Strict::String
+        attribute? :message, Types::Strict::String
         attribute? :debug_message, Types::Strict::String
       end
 
       class Conflict < Error
-        attribute :message, Types::Strict::String
-        attribute :debug_message, Types::Strict::String
+        attribute? :message, Types::Strict::String
+        attribute? :debug_message, Types::Strict::String
       end
 
       class NotAcceptable < Error
-        attribute :message, Types::Strict::String
-        attribute :debug_message, Types::Strict::String
+        attribute? :message, Types::Strict::String
+        attribute? :debug_message, Types::Strict::String
       end
 
       class UnsupportedMediaType < Error
-        attribute :message, Types::Strict::String
-        attribute :debug_message, Types::Strict::String
+        attribute? :message, Types::Strict::String
+        attribute? :debug_message, Types::Strict::String
       end
 
       class RequestEntityTooLarge < Error
-        attribute :message, Types::Strict::String
+        attribute? :message, Types::Strict::String
         attribute? :debug_message, Types::Strict::String
       end
     end

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/lib/salestation/web.rb

@@ -8,7 +8,12 @@ require 'json'
 module Salestation
   class Web < Module
     module Types
-      include Dry::Types()
+      dry_types_version = Gem.loaded_specs['dry-types'].version
+      if dry_types_version < Gem::Version.new('0.15.0')
+        include Dry::Types.module
+      else
+        include Dry::Types()
+      end
     end
 
     def initialize(errors: {})

data/lib/salestation/web/input_validators/accept_header.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'http/accept'
+
 module Salestation
   class Web < Module
     module InputValidators
@@ -15,9 +17,11 @@ module Salestation
         end
 
         def call(header_value)
-          header_valid = @allowed_headers.empty? || @allowed_headers.include?(header_value)
+          return Success(nil) if @allowed_headers.empty?
+
+          mime_types = HTTP::Accept::MediaTypes.parse(header_value).map(&:mime_type)
 
-          if header_valid
+          if (@allowed_headers & mime_types).any?
             Success(nil)
           else
             Failure(App::Errors::NotAcceptable.new(

data/lib/salestation/web/responses.rb

@@ -31,15 +31,23 @@ module Salestation
 
       class Error < Response
         attribute :status, Types::Strict::Integer
-        attribute :message, Types::Strict::String
-        attribute :debug_message, Types::Coercible::String.default('')
+        attribute? :message, Types::String.optional
+        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
           # Merge into `base_error` to ensure standard fields are not overriden
-          (base_error || {}).merge(message: message, debug_message: debug_message)
+          merge_not_nil(base_error || {}, :message, message)
+            .merge(debug_message: debug_message)
+        end
+
+        private
+
+        def merge_not_nil(map, key, value)
+          map[key] = value if value
+          map
         end
       end
 
@@ -58,9 +66,9 @@ module Salestation
       end
 
       class UnprocessableEntityFromSchemaErrors
-        def self.create(errors:, hints:, base_error: nil, form_errors: false)
-          message = parse_errors(errors)
-          debug_message = parse_hints(hints)
+        def self.create(errors: nil, hints: nil, base_error: nil, form_errors: false)
+          message = errors ? parse_errors(errors) : nil
+          debug_message = hints ? parse_hints(hints) : nil
 
           UnprocessableEntity.new(
             message: message,

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.0.2"
+  spec.version       = "4.3.1"
   spec.authors       = ["Glia TechMovers"]
   spec.email         = ["techmovers@glia.com"]
 
@@ -23,8 +23,11 @@ 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'
   spec.add_dependency 'dry-types'
+  spec.add_dependency 'http-accept', '~> 2.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salestation
 version: !ruby/object:Gem::Version
-  version: 4.0.2
+  version: 4.3.1
 platform: ruby
 authors:
 - Glia TechMovers
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-05-31 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
@@ -108,6 +136,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: http-accept
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 description: ''
 email:
 - techmovers@glia.com
@@ -128,6 +170,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