salestation 5.3.1 → 5.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6df52858cd7f5226e95ecf1336818ed60f021222f749e6f3a4969e6c05c309b
-  data.tar.gz: 2221e592b6070e403ef763f94834ae142ec03ac7277674c9dc16668a54bbbecb
+  metadata.gz: e67e18c608d03d9fa6f1e3cff2345dd87eb55f76d7e087e57a75c4ce2b6f591f
+  data.tar.gz: '086a420e0dcd1483b346253be2d3a18405f02ee310956ae69501dd47832a1800'
 SHA512:
-  metadata.gz: c10039d2261c8bfdec7a434de314d2152b59f8b50a55b4d12d0f47e59b14417f40181332be990924673dbb13131e4453267f352f0a63daa94e3ab0ccc3a08f16
-  data.tar.gz: e9691491f6c13690129f5297b411d49034eb8fd628869e7b6b71c0f07551e477c5ca288beea2d0c679ca2ae98b334ebb441d12412946e7f2f6e41e2161eb2371
+  metadata.gz: 0fc035f130d5e795c15facde88ab5b2961a188e6c33bd40fa742f8b7700996c6b6a2dabc637b4a9083b4c364e9ed37ba97aca977231051a3410d91adb6fd4657
+  data.tar.gz: 4a1e69e9fd30f9c6c1e7d46853849f5db4614c684051ae38c39af0075fad267ad5ecba456c559866bb032f909bbf95bbe838ada29390c6a8b062f881758d8747

data/.github/workflows/publish.yml

@@ -15,8 +15,9 @@ jobs:
 
 
       - name: Release Gem
-        uses: discourse/publish-rubygems-action@b55d7b91b55e61752dc6cbc2972f8e16fe6c1a02
+        uses: discourse/publish-rubygems-action@4bd305c65315cb691bad1e8de97a87aaf29a0a85
         env:
-          GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
           RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_API_KEY}}
           RELEASE_COMMAND: rake release
+          GIT_EMAIL: support@salemove.com
+          GIT_NAME: sm-deployer

data/.github/workflows/ruby.yml

@@ -15,15 +15,13 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ['2.7', '3.0', '3.1', '3.2']
 
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
-    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
-    # change this to (see https://github.com/ruby/setup-ruby#versioning):
-    # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      # Automatically get bug fixes and new Ruby versions for ruby/setup-ruby
+      uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically

data/.yardopts

@@ -0,0 +1 @@
+--plugin yard-doctest

data/CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# Contributing to salestation
+
+We currently do not accept any contributions from external sources.
+
+The code is still open source and if you wish to add any changes, feel free to fork it and add changes to your fork.
+
+Issues for any security-related bugs found are still welcome, but we offer no guarantees on whether or when they will be acted upon.
+
+For any exceptional cases, please contact us at open-source@glia.com.

data/Rakefile

@@ -1,6 +1,13 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard/doctest/rake'
 
 RSpec::Core::RakeTask.new(:spec)
+YARD::Doctest::RakeTask.new
 
-task :default => :spec
+task :default do
+  Rake::Task['spec'].invoke
+  Rake::Task['yard:doctest'].invoke
+end

data/lib/salestation/app/errors.rb

@@ -52,6 +52,11 @@ module Salestation
         attribute? :message, Types::Strict::String
         attribute? :debug_message, Types::Strict::String
       end
+
+      class BadRequest < Error
+        attribute? :message, Types::Strict::String
+        attribute? :debug_message, Types::Strict::String
+      end
     end
   end
 end

data/lib/salestation/app.rb

@@ -7,12 +7,7 @@ require 'dry-types'
 module Salestation
   class App
     module 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
+      include Dry::Types()
     end
 
     def initialize(env:, hooks: {})

data/lib/salestation/rspec/glia_input_validation_error_matcher.rb

@@ -13,6 +13,7 @@ module Salestation
         @fields = []
         @field_error_types = {}
         @field_error_messages = {}
+        @expect_exact_match = false
       end
 
       def on(*nested_fields)
@@ -20,6 +21,11 @@ module Salestation
         self
       end
 
+      def exactly
+        @expect_exact_match = true
+        self
+      end
+
       def with_type(*types)
         @field_error_types[field_to_key(@fields.last)] = types
         self
@@ -31,15 +37,32 @@ module Salestation
       end
 
       def matches?(actual)
-        @fields.all? do |field|
-          check_field_exists(actual, *field) &&
-            check_field_error_types(field, actual) &&
-            check_field_error_messages(field, actual)
-        end
+        check_exact_match(actual, self.class.path_list_to_trie(@fields)) &&
+          @fields.all? do |field|
+            check_field_exists(actual, *field) &&
+              check_field_error_types(field, actual) &&
+              check_field_error_messages(field, actual)
+          end
       end
 
       private
 
+      def check_exact_match(actual, field_trie)
+        return true unless @expect_exact_match
+
+        actual[:error_details].keys.all? do |key|
+          field_trie.any? do |field, nested_field_trie|
+            if nested_field_trie.empty?
+              field == key
+            else
+              actual[:error_details][field].all? do |nested_actual|
+                check_exact_match(nested_actual, nested_field_trie)
+              end
+            end
+          end
+        end
+      end
+
       def check_field_exists(actual, field, *nested_fields)
         actual[:error_details].key?(field) &&
           (
@@ -80,6 +103,33 @@ module Salestation
       def field_to_key(fields)
         fields.join('->').to_sym
       end
+
+      class << self
+        # @example
+        #  path_list_to_trie([[:a, :b, :c], [:a, :b, :d], [:a, :e]])
+        #  #=> {a: {b: {c: {}, d: {}}, e: {}}}
+        def path_list_to_trie(paths)
+          paths.reduce({}) do |acc, path|
+            deep_merge(acc, path_to_trie(*path))
+          end
+        end
+
+        private
+
+        # @example
+        #  path_to_trie(*[:a, :b, :c])
+        #  #=> {a: {b: {c: {}}}}
+        def path_to_trie(element, *rest)
+          {element.to_sym => rest.empty? ? {} : path_to_trie(*rest)}
+        end
+
+        # @example
+        #  deep_merge({a: {b: {c: {}}}}, {a: {b: {d: {}}, e: {}}})
+        #  #=> {a: {b: {c: {}, d: {}}, e: {}}}
+        def deep_merge(a, b)
+          a.merge(b) { |_key, nested_a, nested_b| deep_merge(nested_a, nested_b) }
+        end
+      end
     end
   end
 end

data/lib/salestation/web/error_mapper.rb

@@ -31,6 +31,9 @@ module Salestation
         App::Errors::UnsupportedMediaType => -> (error) {
           Responses::UnsupportedMediaType.new(message: error.message, debug_message: error.debug_message, base_error: error.base_error)
         },
+        App::Errors::BadRequest => -> (error) {
+          Responses::BadRequest.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, base_error: error.base_error)
         }

data/lib/salestation/web/extractors.rb

@@ -61,14 +61,15 @@ module Salestation
       # Handles coercing input values
       #
       # @example
-      #  extractor = BodyParamExtractor[:x, :y]
+      #  extractor = Salestation::Web::Extractors::BodyParamExtractor[:x, :y]
       #    .coerce(x: ->(value) { "x_#{value}"})
       #  input = {
       #   'x' => 'a',
       #   'y' => 'b',
       #  }
       #  # rack_request is Rack::Request with 'rack.request.form_hash' set to input
-      #  extractor.call(rack_request).value #=> {x: 'x_a', y: 'b'}
+      #  extractor.call(rack_request(input)).value
+      #  #=> {x: 'x_a', y: 'b'}
       class InputCoercer
         def initialize(extractor, rules)
           @extractor = extractor
@@ -106,28 +107,25 @@ module Salestation
       # values can be compared in rename.
       #
       # @example
-      #  original_input = {
-      #    x: 'a',
-      #    y: 'b'
+      #  input = {
+      #    'x' => 'a',
+      #    'y' => 'b'
       #  }
       #
-      #  extractor = BodyParamExtractor[:x, :y]
+      #  extractor = Salestation::Web::Extractors::BodyParamExtractor[:x, :y]
       #    .rename(x: :z)
-      #  input = {
-      #    z: 'a',
-      #    y: 'b'
-      #  }
+      #  extractor.call(rack_request(input)).value
+      #  #=> {z: 'a', y: 'b'}
       #
-      #  extractor = BodyParamExtractor[:x, :y]
+      #  extractor = Salestation::Web::Extractors::BodyParamExtractor[:x, :y]
       #    .rename(x: :y)
-      #  input = {
-      #    y: 'b'
-      #  }
-      #  extractor = BodyParamExtractor[:x, :y]
+      #  extractor.call(rack_request(input)).value
+      #  #=> {y: 'b'}
+      #
+      #  extractor = Salestation::Web::Extractors::BodyParamExtractor[:x, :y]
       #    .rename(x: {new_key: :y, override: true})
-      #  input = {
-      #    y: 'a'
-      #  }
+      #  extractor.call(rack_request(input)).value
+      #  #=> {y: 'a'}
       class InputRenamer
         def initialize(extractor, rules)
           @extractor = extractor
@@ -217,7 +215,7 @@ module Salestation
       # Extracts and symbolizes params from request body
       #
       # @example
-      #  extractor = BodyParamExtractor[:x, :y, {foo: [:bar, :baz]}, :aaa]
+      #  extractor = Salestation::Web::Extractors::BodyParamExtractor[:x, :y, {foo: [:bar, :baz]}, :aaa]
       #  input = {
       #   'x' => '1',
       #   'y' => '2',
@@ -232,7 +230,8 @@ module Salestation
       #    ]
       #  }
       #  # rack_request is Rack::Request with 'rack.request.form_hash' set to input
-      #  extractor.call(rack_request).value #=> {x: 1, y: 2, foo: {bar: 'qq'}, aaa: [{bb: 'cc'}]}
+      #  extractor.call(rack_request(input)).value
+      #  #=> {x: '1', y: '2', foo: {bar: 'qq'}, aaa: [{bb: 'cc'}]}
       #
       class BodyParamExtractor
         def self.[](*filters)

data/lib/salestation/web/responses.rb

@@ -115,6 +115,7 @@ module Salestation
       Accepted = Success.with_code(202)
       NoContent = Success.with_code(204)
 
+      BadRequest = Error.with_code(400)
       Unauthorized = Error.with_code(401)
       Forbidden = Error.with_code(403)
       NotFound = Error.with_code(404)

data/lib/salestation/web.rb

@@ -8,12 +8,7 @@ require 'json'
 module Salestation
   class Web < Module
     module 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
+      include Dry::Types()
     end
 
     def initialize(errors: {})

data/salestation.gemspec

@@ -4,9 +4,9 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "salestation"
-  spec.version       = "5.3.1"
+  spec.version       = "5.3.3"
   spec.authors       = ["Glia TechMovers"]
-  spec.email         = ["techmovers@glia.com"]
+  spec.email         = ["open-source@glia.com"]
 
   spec.summary       = %q{}
   spec.description   = %q{}
@@ -22,9 +22,10 @@ Gem::Specification.new do |spec|
   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"
+  spec.add_development_dependency "pry", "~> 0.14.2"
   spec.add_development_dependency "glia-errors", "~> 0.11.4"
   spec.add_development_dependency "dry-validation", "~> 1.7"
+  spec.add_development_dependency "yard-doctest", "~> 0.1.17"
 
   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: 5.3.1
+  version: 5.3.3
 platform: ruby
 authors:
 - Glia TechMovers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-18 00:00:00.000000000 Z
+date: 2023-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.4
+        version: 0.14.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.4
+        version: 0.14.2
 - !ruby/object:Gem::Dependency
   name: glia-errors
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: yard-doctest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.17
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.17
 - !ruby/object:Gem::Dependency
   name: deterministic
   requirement: !ruby/object:Gem::Requirement
@@ -166,7 +180,7 @@ dependencies:
         version: '0'
 description: ''
 email:
-- techmovers@glia.com
+- open-source@glia.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -175,6 +189,8 @@ files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
+- ".yardopts"
+- CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -204,7 +220,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -219,8 +235,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.5.3
+signing_key:
 specification_version: 4
 summary: ''
 test_files: []