pheme 5.3.4 → 6.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 219b35c7c69ba33d474d1063586cc0d357a4ab129b84eb80a9d9229570680a15
-  data.tar.gz: 3dce2f5202292466c7f4653e2b68928121a7b9aa5ba0c51375d01d0575159510
+  metadata.gz: 02e5305726664194fc17af6ce32ea478b8352ec579ab7964de35e296b89ecc4e
+  data.tar.gz: 5b1404acf1ce1d35d5857dc504ce6fac5f90c9dbcc0821b0ce18f85cc38b96bc
 SHA512:
-  metadata.gz: e76e2a025181932da7cb730fa624e2ff101a5e48bf565bec1b1e75448ee59c3a92b16c79444014ca1ef202db0cfb944f03214afdffcb13b8bc62ca6e54d5764a
-  data.tar.gz: db2eced35f5b27bd0db443aaaa7825008c25dd06b2c3a4c4c2173435f92ace7dbf056e48604cdb0d2b0b2f76ab94a8ea26a733f939d338523253c0e3f4e9afd4
+  metadata.gz: e133f4596ac54129c7fc3102ce140d364c87f784f9742f5640cd3bc313fa2710c4d37592a800f607081e499bf5a3c350755cbd137b832cc6b5cf54750c2a2cab
+  data.tar.gz: 3b5b6c6809222a38bd5552f5c143d43ac2c0eb66457cb3984a5ed74071c095bff605808165d1de32e9297f851a03c0a040f37325f880ebf887b93d6802e2b0e7

data/.github/workflows/guardrails.yaml

@@ -0,0 +1,15 @@
+---
+name: 'Guardrails'
+
+on:
+  pull_request:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+jobs:
+  stale:
+    name: Check Guardrails
+    uses: wealthsimple/github-workflows/.github/workflows/guardrails.yml@v1
+    secrets: inherit

data/.github/workflows/stale.yml

@@ -5,7 +5,7 @@ on:
 
 jobs:
   stale:
-    runs-on: ubuntu-22.04
+    runs-on: ${{ vars.DEFAULT_RUNS_ON }}
     steps:
       - uses: actions/stale@v8
         with:

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-06-14 14:59:19 UTC using RuboCop version 1.64.1.
+# on 2024-07-04 21:40:31 UTC using RuboCop version 1.64.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -19,20 +19,19 @@ RSpec/NoExpectationExample:
     - 'spec/logger_spec.rb'
     - 'spec/queue_poller_spec.rb'
 
-# Offense count: 9
+# Offense count: 8
 # Configuration parameters: Include, CustomTransform, IgnoreMethods, IgnoreMetadata.
 # Include: **/*_spec.rb
 RSpec/SpecFilePathFormat:
   Exclude:
     - 'spec/configuration_spec.rb'
+    - 'spec/error_reporting_spec.rb'
     - 'spec/logger_spec.rb'
     - 'spec/message_handler_spec.rb'
     - 'spec/message_type/aws_event_spec.rb'
     - 'spec/message_type/sns_message_spec.rb'
     - 'spec/queue_poller_spec.rb'
-    - 'spec/rollbar_spec.rb'
     - 'spec/topic_publisher_spec.rb'
-    - 'spec/version_spec.rb'
 
 # Offense count: 2
 # Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.

data/CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 6.0.1 - 2025-02-13
+### Changed
+- Updated dependencies
+- Added rexml as explicit dependency
+
+## 6.0.0 - 2024-07-04
+### Changed
+- **breaking changes** Removed support for Rollbar configuration. `config.rollbar` is no longer supported.
+- Added support for passing `error_reporting_func` as a config option.
+
 ## 5.3.4 - 2024-06-14
 ### Changed
 - Updated dependencies

data/Gemfile.lock

@@ -1,163 +1,170 @@
 PATH
   remote: .
   specs:
-    pheme (5.3.4)
+    pheme (6.0.1)
       activesupport (>= 4)
       aws-sdk-sns (~> 1.1)
       aws-sdk-sqs (~> 1.3)
       resource-struct (~> 0.4)
+      rexml (~> 3.4)
       smarter_csv (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3.4)
+    activesupport (8.0.1)
       base64
+      benchmark (>= 0.3)
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
-    addressable (2.8.6)
-      public_suffix (>= 2.0.2, < 6.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
+      uri (>= 0.13.1)
+    addressable (2.8.7)
+      public_suffix (>= 2.0.2, < 7.0)
     ast (2.4.2)
     aws-eventstream (1.3.0)
-    aws-partitions (1.944.0)
-    aws-sdk-core (3.197.0)
+    aws-partitions (1.1050.0)
+    aws-sdk-core (3.218.1)
       aws-eventstream (~> 1, >= 1.3.0)
-      aws-partitions (~> 1, >= 1.651.0)
-      aws-sigv4 (~> 1.8)
+      aws-partitions (~> 1, >= 1.992.0)
+      aws-sigv4 (~> 1.9)
+      base64
       jmespath (~> 1, >= 1.6.1)
-    aws-sdk-sns (1.77.0)
-      aws-sdk-core (~> 3, >= 3.197.0)
-      aws-sigv4 (~> 1.1)
-    aws-sdk-sqs (1.76.0)
-      aws-sdk-core (~> 3, >= 3.197.0)
-      aws-sigv4 (~> 1.1)
-    aws-sigv4 (1.8.0)
+    aws-sdk-sns (1.95.0)
+      aws-sdk-core (~> 3, >= 3.216.0)
+      aws-sigv4 (~> 1.5)
+    aws-sdk-sqs (1.92.0)
+      aws-sdk-core (~> 3, >= 3.216.0)
+      aws-sigv4 (~> 1.5)
+    aws-sigv4 (1.11.0)
       aws-eventstream (~> 1, >= 1.0.2)
     base64 (0.2.0)
-    bigdecimal (3.1.8)
-    bundler-audit (0.9.1)
+    benchmark (0.4.0)
+    bigdecimal (3.1.9)
+    bundler-audit (0.9.2)
       bundler (>= 1.2.0, < 3)
       thor (~> 1.0)
-    concurrent-ruby (1.3.3)
-    connection_pool (2.4.1)
+    concurrent-ruby (1.3.5)
+    connection_pool (2.5.0)
     diff-lcs (1.5.1)
-    docile (1.4.0)
+    docile (1.4.1)
     drb (2.2.1)
-    git (2.1.1)
+    git (2.3.3)
       activesupport (>= 5.0)
       addressable (~> 2.8)
       process_executer (~> 1.1)
       rchardet (~> 1.8)
-    i18n (1.14.5)
+    i18n (1.14.7)
       concurrent-ruby (~> 1.0)
     jmespath (1.6.2)
-    json (2.7.2)
-    language_server-protocol (3.17.0.3)
+    json (2.10.1)
+    language_server-protocol (3.17.0.4)
     lint_roller (1.1.0)
-    minitest (5.23.1)
-    mutex_m (0.2.0)
-    parallel (1.25.1)
-    parse_a_changelog (1.3.0)
+    logger (1.6.5)
+    minitest (5.25.4)
+    parallel (1.26.3)
+    parse_a_changelog (1.3.3)
       treetop (~> 1.6)
-    parser (3.3.3.0)
+    parser (3.3.7.1)
       ast (~> 2.4.1)
       racc
     polyglot (0.3.5)
-    process_executer (1.1.0)
-    public_suffix (5.0.5)
-    racc (1.8.0)
-    rack (3.1.3)
+    process_executer (1.2.0)
+    public_suffix (6.0.1)
+    racc (1.8.1)
+    rack (3.1.10)
     rainbow (3.1.1)
     rake (13.2.1)
-    rchardet (1.8.0)
-    regexp_parser (2.9.2)
+    rchardet (1.9.0)
+    regexp_parser (2.10.0)
     resource-struct (0.4.0)
-    rexml (3.3.0)
-      strscan
+    rexml (3.4.0)
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
     rspec-collection_matchers (1.2.1)
       rspec-expectations (>= 2.99.0.beta1)
-    rspec-core (3.13.0)
+    rspec-core (3.13.3)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.1)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-its (1.3.0)
-      rspec-core (>= 3.0.0)
-      rspec-expectations (>= 3.0.0)
-    rspec-mocks (3.13.1)
+    rspec-its (2.0.0)
+      rspec-core (>= 3.13.0)
+      rspec-expectations (>= 3.13.0)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.1)
+    rspec-support (3.13.2)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.64.1)
+    rubocop (1.71.2)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.31.3)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.38.0)
       parser (>= 3.3.1.0)
     rubocop-factory_bot (2.26.1)
       rubocop (~> 1.61)
-    rubocop-performance (1.21.0)
+    rubocop-performance (1.23.1)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rails (2.23.1)
+    rubocop-rails (2.26.2)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 1.33.0, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-    rubocop-rspec (3.0.1)
+      rubocop (>= 1.52.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rspec (3.4.0)
       rubocop (~> 1.61)
-    rubocop-vendor (0.13.0)
+    rubocop-vendor (0.13.2)
       rubocop
     ruby-progressbar (1.13.0)
+    securerandom (0.4.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
-    simplecov-html (0.12.3)
+    simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
-    smarter_csv (1.10.3)
-    standard (1.37.0)
+    smarter_csv (1.13.1)
+    standard (1.45.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
-      rubocop (~> 1.64.0)
+      rubocop (~> 1.71.0)
       standard-custom (~> 1.0.0)
-      standard-performance (~> 1.4)
+      standard-performance (~> 1.6)
     standard-custom (1.0.2)
       lint_roller (~> 1.0)
       rubocop (~> 1.50)
-    standard-performance (1.4.0)
+    standard-performance (1.6.0)
       lint_roller (~> 1.1)
-      rubocop-performance (~> 1.21.0)
-    standard-rails (1.0.2)
+      rubocop-performance (~> 1.23.0)
+    standard-rails (1.2.0)
       lint_roller (~> 1.0)
-      rubocop-rails (~> 2.23.1)
-    strscan (3.1.0)
-    thor (1.3.1)
-    treetop (1.6.12)
+      rubocop-rails (~> 2.26.0)
+    thor (1.3.2)
+    treetop (1.6.14)
       polyglot (~> 0.3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
-    ws-style (7.5.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+    uri (1.0.2)
+    ws-style (7.6.1)
       rubocop-factory_bot (>= 2.26.0)
       rubocop-rspec (>= 3.0.0)
       rubocop-vendor (>= 0.11)
@@ -166,7 +173,9 @@ GEM
       standard-rails (>= 0.1.0)
 
 PLATFORMS
+  arm64-darwin-23
   ruby
+  x86_64-linux
 
 DEPENDENCIES
   bundler

data/README.md

@@ -34,6 +34,13 @@ Pheme.configure do |config|
   config.sqs_client = AWS_SQS_CLIENT
   config.sns_client = AWS_SNS_CLIENT
   config.logger = Logger.new(STDOUT) # Optionally replace with your app logger, e.g. `Rails.logger`
+  
+  # Internal wealthsimple error handler
+  config.error_reporting_func = Ws::Railway::ErrorReporting.capture_exception
+  # Sentry
+  config.error_reporting_func = Sentry.capture_exception
+  # Rollbar
+  config.error_reporting_func = Rollbar.error
 end
 ```
 

data/lib/pheme/configuration.rb

@@ -17,9 +17,10 @@ module Pheme
 
   class Configuration
     ATTRIBUTES = %i[sns_client sqs_client logger].freeze
-    OPTIONAL_ATTRIBUTES = %i[rollbar].freeze
+    OPTIONAL_ATTRIBUTES = %i[error_reporting_func].freeze
+    DEPRECATED_ATTRIBUTES = %i[rollbar].freeze
 
-    attr_accessor(*ATTRIBUTES, *OPTIONAL_ATTRIBUTES)
+    attr_accessor(*ATTRIBUTES, *OPTIONAL_ATTRIBUTES, *DEPRECATED_ATTRIBUTES)
 
     def initialize
       @logger ||= Logger.new($stdout) # rubocop:disable Lint/DisjunctiveAssignmentInConstructor
@@ -32,6 +33,10 @@ module Pheme
       end
       raise "sns_client must be a Aws::SNS::Client" unless sns_client.is_a?(Aws::SNS::Client)
       raise "sns_client must be a Aws::SQS::Client" unless sqs_client.is_a?(Aws::SQS::Client)
+
+      if respond_to?(:rollbar)
+        @logger.warn("config.rollbar is deprecated. Please use config.error_reporting_func instead.")
+      end
     end
   end
 end

data/lib/pheme/error_reporting.rb

@@ -0,0 +1,7 @@
+module Pheme
+  def self.capture_exception(exception, message, data = {})
+    return if configuration.error_reporting_func.nil?
+
+    configuration.error_reporting_func.call(exception, message, data)
+  end
+end

data/lib/pheme/queue_poller.rb

@@ -69,7 +69,7 @@ module Pheme
           throw :stop_polling
         rescue StandardError => e
           Pheme.logger.error(e)
-          Pheme.rollbar(e, "#{self.class} failed to process message", { message: content })
+          Pheme.capture_exception(e, "#{self.class} failed to process message", { message: content })
         end
       end
       log_polling_end(time_start)

data/lib/pheme/version.rb

@@ -1,3 +1,3 @@
 module Pheme
-  VERSION = '5.3.4'.freeze
+  VERSION = '6.0.1'.freeze
 end

data/lib/pheme.rb

@@ -8,7 +8,7 @@ require 'smarter_csv'
 require 'pheme/version'
 require 'pheme/configuration'
 require 'pheme/logger'
-require 'pheme/rollbar'
+require 'pheme/error_reporting'
 require 'pheme/topic_publisher'
 require 'pheme/message_handler'
 require 'pheme/queue_poller'

data/pheme.gemspec

@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'aws-sdk-sns', '~> 1.1'
   s.add_dependency 'aws-sdk-sqs', '~> 1.3'
   s.add_dependency 'resource-struct', '~> 0.4'
+  s.add_dependency 'rexml', '~> 3.4'
   s.add_dependency 'smarter_csv', '~> 1'
 
   s.add_development_dependency 'bundler'

data/spec/configuration_spec.rb

@@ -49,6 +49,26 @@ describe Pheme do
           expect { subject }.not_to raise_error
         end
       end
+
+      context 'deprecated attributes' do
+        let(:sns_client) { instance_double(Aws::SNS::Client) }
+        let(:sqs_client) { instance_double(Aws::SQS::Client) }
+
+        before do
+          allow(sns_client).to receive(:is_a?).with(Aws::SNS::Client).and_return(true)
+          allow(sqs_client).to receive(:is_a?).with(Aws::SQS::Client).and_return(true)
+
+          configuration.sns_client = sns_client
+          configuration.sqs_client = sqs_client
+          configuration.rollbar = double
+        end
+
+        it "warns if passed a deprecated config attribute" do
+          expect(configuration.logger).to receive(:warn).with("config.rollbar is deprecated. Please use config.error_reporting_func instead.")
+
+          expect { subject }.not_to raise_error
+        end
+      end
     end
   end
 end

data/spec/error_reporting_spec.rb

@@ -0,0 +1,22 @@
+RSpec.describe Pheme do
+  let(:error_reporting_func) { double }
+
+  describe '.capture_exception' do
+    subject { described_class.capture_exception(exception, message, data) }
+
+    let(:exception) { StandardError }
+    let(:message) { 'Unable to poll for messages' }
+    let(:data) { { sqs_url: 'arn::foo::bar' } }
+
+    before do
+      described_class.configure do |config|
+        config.error_reporting_func = error_reporting_func
+      end
+    end
+
+    it 'sends error message to configured error_reporter' do
+      expect(error_reporting_func).to receive(:call).with(exception, message, data)
+      subject
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pheme
 version: !ruby/object:Gem::Version
-  version: 5.3.4
+  version: 6.0.1
 platform: ruby
 authors:
 - Peter Graham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2025-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
 - !ruby/object:Gem::Dependency
   name: smarter_csv
   requirement: !ruby/object:Gem::Requirement
@@ -230,6 +244,7 @@ files:
 - ".github/CODEOWNERS"
 - ".github/PULL_REQUEST_TEMPLATE.md"
 - ".github/workflows/default.yaml"
+- ".github/workflows/guardrails.yaml"
 - ".github/workflows/stale.yml"
 - ".gitignore"
 - ".rspec"
@@ -247,23 +262,23 @@ files:
 - lib/pheme.rb
 - lib/pheme/compression.rb
 - lib/pheme/configuration.rb
+- lib/pheme/error_reporting.rb
 - lib/pheme/logger.rb
 - lib/pheme/message_handler.rb
 - lib/pheme/message_type/aws_event.rb
 - lib/pheme/message_type/sns_message.rb
 - lib/pheme/queue_poller.rb
-- lib/pheme/rollbar.rb
 - lib/pheme/topic_publisher.rb
 - lib/pheme/version.rb
 - pheme.gemspec
 - sonar-project.properties
 - spec/configuration_spec.rb
+- spec/error_reporting_spec.rb
 - spec/logger_spec.rb
 - spec/message_handler_spec.rb
 - spec/message_type/aws_event_spec.rb
 - spec/message_type/sns_message_spec.rb
 - spec/queue_poller_spec.rb
-- spec/rollbar_spec.rb
 - spec/spec_helper.rb
 - spec/support/example_aws_event_queue_poller.rb
 - spec/support/example_message_handler.rb

data/lib/pheme/rollbar.rb

@@ -1,7 +0,0 @@
-module Pheme
-  def self.rollbar(exception, message, data = {})
-    return if configuration.rollbar.nil?
-
-    configuration.rollbar.error(exception, message, data)
-  end
-end

data/spec/rollbar_spec.rb

@@ -1,22 +0,0 @@
-RSpec.describe Pheme do
-  let(:rollbar) { double }
-
-  describe '.rollbar' do
-    subject { described_class.rollbar(exception, message, data) }
-
-    let(:exception) { StandardError }
-    let(:message) { 'Unable to poll for messages' }
-    let(:data) { { sqs_url: 'arn::foo::bar' } }
-
-    before do
-      described_class.configure do |config|
-        config.rollbar = rollbar
-      end
-    end
-
-    it 'sends error message to rollbar' do
-      expect(rollbar).to receive(:error).with(exception, message, data)
-      subject
-    end
-  end
-end