pheme 5.3.4 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 219b35c7c69ba33d474d1063586cc0d357a4ab129b84eb80a9d9229570680a15
-  data.tar.gz: 3dce2f5202292466c7f4653e2b68928121a7b9aa5ba0c51375d01d0575159510
+  metadata.gz: 5c1f36f4d154e2fbd0ef4c5ff2c883e73568ac9ff6f7db10d555eba44f571241
+  data.tar.gz: e07dea65651b220d142bda320ae759d2bafc2a4c88ca480f353755ad7d7e08df
 SHA512:
-  metadata.gz: e76e2a025181932da7cb730fa624e2ff101a5e48bf565bec1b1e75448ee59c3a92b16c79444014ca1ef202db0cfb944f03214afdffcb13b8bc62ca6e54d5764a
-  data.tar.gz: db2eced35f5b27bd0db443aaaa7825008c25dd06b2c3a4c4c2173435f92ace7dbf056e48604cdb0d2b0b2f76ab94a8ea26a733f939d338523253c0e3f4e9afd4
+  metadata.gz: 790ad3e1a93632eafa4f591c49dc51999becc8746abe433c6f972cfc07c0d17cc07e8402b75b74e6368006bb48633c1ad9d10dc1f190e1bb1965c7fd0295dc50
+  data.tar.gz: 790646a9e3f3a14695f3f6cba9d9954eaf09e1579da1b8bb49a9e70fb42b58b20d19114eb2f3669cd53716830add50e1a53fb0ab0b7d766df020a8a5cf1b865e

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,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## 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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pheme (5.3.4)
+    pheme (6.0.0)
       activesupport (>= 4)
       aws-sdk-sns (~> 1.1)
       aws-sdk-sqs (~> 1.3)
@@ -72,7 +72,7 @@ GEM
     process_executer (1.1.0)
     public_suffix (5.0.5)
     racc (1.8.0)
-    rack (3.1.3)
+    rack (3.1.6)
     rainbow (3.1.1)
     rake (13.2.1)
     rchardet (1.8.0)

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.0'.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/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.0
 platform: ruby
 authors:
 - Peter Graham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-02 00:00:00.000000000 Z
+date: 2024-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -247,23 +247,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