pheme 5.3.3 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1682f45cc6381c623808a02e81ec990267fb4cae120cd201d7308d1cdd04ae58
-  data.tar.gz: 3479b1a218f9210a0dbb79f03bbed0938f60610cc6586f44de4e521b4e4a054f
+  metadata.gz: 5c1f36f4d154e2fbd0ef4c5ff2c883e73568ac9ff6f7db10d555eba44f571241
+  data.tar.gz: e07dea65651b220d142bda320ae759d2bafc2a4c88ca480f353755ad7d7e08df
 SHA512:
-  metadata.gz: 9a70cdc3830479b6d971a7fa8610719d8da84cccbcd11c3f053250684051c6ce23239e5210fdfe1cb8225011a2c8820ffe7ac4f4f04fd46328840be8eb57cea8
-  data.tar.gz: c7451b4b7f28b9d2f0046c7ba35867471a50369e2042b8b52f25c65cac4f19aeed82a0189f477be60b2a9c2de918e85ef5013324c7bff90628cf8e034edeec38
+  metadata.gz: 790ad3e1a93632eafa4f591c49dc51999becc8746abe433c6f972cfc07c0d17cc07e8402b75b74e6368006bb48633c1ad9d10dc1f190e1bb1965c7fd0295dc50
+  data.tar.gz: 790646a9e3f3a14695f3f6cba9d9954eaf09e1579da1b8bb49a9e70fb42b58b20d19114eb2f3669cd53716830add50e1a53fb0ab0b7d766df020a8a5cf1b865e

data/.github/workflows/default.yaml

@@ -0,0 +1,15 @@
+---
+name: Default
+
+on:
+  push:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  build_and_publish:
+    name: Build and Publish
+    uses: wealthsimple/public-github-workflows/.github/workflows/ruby-gem-build.yaml@main
+    secrets: inherit

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

@@ -1,9 +1,20 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 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
+
 ## 5.3.3 - 2024-06-14
 ### Changed
 - Updated dependencies
@@ -169,7 +180,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 - Updated dependencies
 
-### 5.0.4 - 2022-04-01
+## 5.0.4 - 2022-04-01
 ### Changed
 - Updated workflows
 
@@ -246,17 +257,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Migrate CI from CircleCI to GitHub Actions
 
 ## 4.0.3 - 2021-03-08
+### Changed
 - Update documentation to include instructions on directly publishing to SQS
 
 ## 4.0.2 - 2020-12-17
+### Changed
 - Bump local dev version, rubocop fixes, add backstage catalog file + sonarqube project settings
 
 ## 4.0.1 - 2020-03-23
-### Fixes
+### Fixed
 - Fixes 4.0.0. Instead of expecting message attributes in the message from `poll`, retrieves them from the right place.
 
 ## 4.0.0 - 2020-03-18
-### Breaking Changes
+### Changed
 - Add the ability for SQS to receive message attributes
 - `handle` function of `QueuePoller` now takes a third parameter `message_attributes`
 - blocks or `MessageHandler`s passed to `QueuePoller` can use this `message_attributes`
@@ -302,6 +315,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ## 2.0.1 - 2019-01-03
 ### Changed
 - add internal gem spec to test standard gem behavior, reduces unnecessary copy and pasting
+
 ### Fixed
 - namespace for the VERSION constant was incorrectly set to Ws::Ws
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pheme (5.3.3)
+    pheme (6.0.0)
       activesupport (>= 4)
       aws-sdk-sns (~> 1.1)
       aws-sdk-sqs (~> 1.3)
@@ -63,13 +63,16 @@ GEM
     minitest (5.23.1)
     mutex_m (0.2.0)
     parallel (1.25.1)
+    parse_a_changelog (1.3.0)
+      treetop (~> 1.6)
     parser (3.3.3.0)
       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)
+    rack (3.1.6)
     rainbow (3.1.1)
     rake (13.2.1)
     rchardet (1.8.0)
@@ -149,6 +152,8 @@ GEM
       rubocop-rails (~> 2.23.1)
     strscan (3.1.0)
     thor (1.3.1)
+    treetop (1.6.12)
+      polyglot (~> 0.3)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
@@ -167,6 +172,7 @@ DEPENDENCIES
   bundler
   bundler-audit
   git
+  parse_a_changelog
   pheme!
   rake
   rspec

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.3'.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/pheme.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
 
   s.add_development_dependency 'bundler'
   s.add_development_dependency 'git'
+  s.add_development_dependency "parse_a_changelog"
   s.add_development_dependency 'rake'
   s.add_development_dependency 'rspec'
   s.add_development_dependency 'rspec-collection_matchers'

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

data/spec/version_spec.rb

@@ -1,35 +1,87 @@
 require 'git'
+require 'parse_a_changelog'
 
-describe Pheme do
+RSpec.describe 'a published gem' do # rubocop:disable RSpec/DescribeClass
   def get_version(git, branch = 'HEAD')
     git.grep('VERSION = ', 'lib/*/version.rb', { object: branch }).
       map { |_sha, matches| matches.first[1] }.
-      filter_map { |version_string| parse_version(version_string) }.
+      filter_map { |str| parse_version(str) }.
       first
+  rescue Git::GitExecuteError
+    # Catches failures for branch name being master
+    nil
   end
 
   def parse_version(string)
     string.match(/VERSION = ['"](.*)['"]/)[1]
   end
 
+  def main_branch
+    @main_branch ||=
+      if git.branches['origin/main']
+        'origin/main'
+      elsif git.branches['origin/master']
+        'origin/master'
+      else
+        raise StandardError,
+          <<~ERROR
+            Couldn't determine main branch.
+            Does 'origin/main' or 'origin/master' need to be fetched?
+          ERROR
+      end
+  end
+
+  def needs_version_bump?
+    base = git.merge_base(main_branch, 'HEAD').first&.sha
+    base ||= main_branch
+    git.diff(base, 'HEAD').any? { |diff|
+      not_gemfile?(diff) && not_dotfile?(diff) && not_docs?(diff) && not_spec?(diff)
+    }
+  end
+
+  def not_gemfile?(diff)
+    ['Gemfile', 'Gemfile.lock'].exclude?(diff.path)
+  end
+
+  def not_docs?(diff)
+    !diff.path.end_with?('.md')
+  end
+
+  def not_spec?(diff)
+    !diff.path.start_with?('spec/')
+  end
+
+  def not_dotfile?(diff)
+    # Ignore dotfiles, like .gitignore and CI files like .github/...
+    !diff.path.start_with?('.')
+  end
+
+  let(:git) { Git.open('.') }
+  let(:head_version) { get_version(git, 'HEAD') }
+
   it 'has a version number' do
-    git = Git.open('.')
-    head_version = get_version(git, 'HEAD')
     expect(head_version).not_to be_nil
   end
 
-  it 'has a bumped version' do
-    git = Git.open('.')
-    main_version = get_version(git, 'origin/main')
+  it 'has a bumped version committed' do
+    main_version = get_version(git, main_branch)
     skip('first time publishing, no need to compare versions') if main_version.nil?
 
-    is_main_branch = git.current_branch == 'main'
+    is_main_branch = git.current_branch == main_branch
     skip('already on main branch, no need to compare versions') if is_main_branch
 
-    head_version = get_version(git, 'HEAD')
-    puts "head_version " + head_version
-    raise 'no version.rb file found on the current branch' if head_version.nil?
+    skip('Diff only contains non-code changes, no need to bump version') unless needs_version_bump?
 
     expect(Gem::Version.new(head_version)).to be > Gem::Version.new(main_version)
   end
+
+  it 'has a CHANGELOG.md file' do
+    expect(File).to exist('CHANGELOG.md')
+  end
+
+  it 'has changelog entry for current version' do
+    parser = ParseAChangelog.parse('CHANGELOG.md')
+    versions = parser.elements[2].elements.map { |element| element.elements[1].text_value }
+    expect(versions.first).to include(head_version)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pheme
 version: !ruby/object:Gem::Version
-  version: 5.3.3
+  version: 6.0.0
 platform: ruby
 authors:
 - Peter Graham
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-06-14 00:00:00.000000000 Z
+date: 2024-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: parse_a_changelog
+  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: rake
   requirement: !ruby/object:Gem::Requirement
@@ -215,7 +229,7 @@ extra_rdoc_files: []
 files:
 - ".github/CODEOWNERS"
 - ".github/PULL_REQUEST_TEMPLATE.md"
-- ".github/workflows/main.yml"
+- ".github/workflows/default.yaml"
 - ".github/workflows/stale.yml"
 - ".gitignore"
 - ".rspec"
@@ -233,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/.github/workflows/main.yml

@@ -1,58 +0,0 @@
----
-name: Pipeline
-on:
-  push:
-concurrency:
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: true
-
-jobs:
-  build:
-    name: Build
-    runs-on: ubuntu-22.04
-    strategy:
-      matrix:
-        ruby-version: [3.1.4, 3.2.3, 3.3.0]
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Set up Ruby ${{ matrix.ruby-version }}
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-          ruby-version: ${{ matrix.ruby-version }}
-      - name: Lint
-        run: bundle exec rubocop
-      - name: Test
-        run: bundle exec rspec
-
-  # Separate `release` job from `build`, as we only want release to be run once
-  # and not run for each ruby version in the matrix:
-  release:
-    name: Release
-    if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/master'
-    needs: build
-    runs-on: ubuntu-22.04
-    steps:
-      - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          bundler-cache: true
-      - name: Release the gem
-        run: |
-          mkdir -p ~/.gem
-          cat << EOF > ~/.gem/credentials
-          ---
-          :github: Bearer ${GITHUB_TOKEN}
-          :rubygems_api_key: ${RUBYGEMS_API_KEY}
-          EOF
-          chmod 0600 ~/.gem/credentials
-          git config user.email "noreply@wealthsimple.com"
-          git config user.name "Wolfbot"
-          bundle exec rake release
-        env:
-          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}

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