sidekiq_publisher 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35ad0d16467d78de77ede70a744b248a9dbe33d6f4ceec9c37df10c8478693d1
-  data.tar.gz: af3f7362bb2f539a1a8d4b506f8004fc9cdf9b9927685fc09fc49f74b569cf54
+  metadata.gz: aa63cc2e02febd7a4fe0da8a1deba89df521cf9df46d453626ee80c45cb441c1
+  data.tar.gz: 8c4ba92a29040892080f1b0248dfec8a6f1193063f054c48d6736e3fc15a9e40
 SHA512:
-  metadata.gz: 549f8fd72294075b7f5cca99edcf2b6a2682210f1a494fcf9ce1639c91bd43f8139a269bc1045108de6c52820e5416277fdd04497a795ed5c123a5a2ae77f33c
-  data.tar.gz: 62f6cd338b10e13a82ab4421d55817df95f5d791ac83a5f2e2f4dbdae2327c69a0e09d7b914711d7216651294d30788d411d9ab0eb8208d78b941c6dd8da98ce
+  metadata.gz: '01874b1f9cad7364bf28af24830f62278c3e6aea796a5af4b66ca1fc5c3a63806f48fe3a44892f40c18759dabe58f825d444f28fb48f7b76777440c988120728'
+  data.tar.gz: 9c1c712c199f2abc7fa86c61d9739c1739d78200978071cb0b4ee0cb470091c5d84cf310f0a523f5cb31c98b87ed0ef2afd42ca61d3d743c7f605dde45b32663

data/Appraisals

@@ -36,6 +36,12 @@ appraise "rails-5.2-sidekiq-6.2" do
   gem "sidekiq", "~> 6.2.0"
 end
 
+appraise "rails-5.2-sidekiq-6.3" do
+  gem "activejob", "~> 5.2.0"
+  gem "activesupport", "~> 5.2.0"
+  gem "sidekiq", "~> 6.3.0"
+end
+
 appraise "rails-6.0-sidekiq-5.2" do
   gem "activejob", "~> 6.0.0"
   gem "activesupport", "~> 6.0.0"
@@ -60,6 +66,12 @@ appraise "rails-6.0-sidekiq-6.2" do
   gem "sidekiq", "~> 6.2.0"
 end
 
+appraise "rails-6.0-sidekiq-6.3" do
+  gem "activejob", "~> 6.0.0"
+  gem "activesupport", "~> 6.0.0"
+  gem "sidekiq", "~> 6.3.0"
+end
+
 appraise "rails-6.1-sidekiq-5.2" do
   gem "activejob", "~> 6.1.0"
   gem "activesupport", "~> 6.1.0"
@@ -83,3 +95,9 @@ appraise "rails-6.1-sidekiq-6.2" do
   gem "activesupport", "~> 6.1.0"
   gem "sidekiq", "~> 6.2.0"
 end
+
+appraise "rails-6.1-sidekiq-6.3" do
+  gem "activejob", "~> 6.1.0"
+  gem "activesupport", "~> 6.1.0"
+  gem "sidekiq", "~> 6.3.0"
+end

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # sidekiq_publisher
 
+## 2.1.0
+- Add support for sidekiq `7.0.0` by using `Sidekiq::Job` instead of
+  `Sidekiq::Worker` in sidekiq `>= 6.3.0` to handle name changes outlined in
+  mperham/sidekiq#4971 and first introduced in 6.2.2.
+
 ## 2.0.1
 - Changing the `Job#args` validator to be a manual check instead of using the `exclusions` validator.  This is to fix an issue introduced with rails 6.1 and the condition of `in: [nil]`.  More details [here](https://github.com/rails/rails/issues/41051).
 

data/README.md

@@ -138,22 +138,23 @@ end
 
 #### ActiveJob Exception Reporting
 
-Many exception monitoring service (e.g. Sentry, Airbrake, Honeybadger, etc) already provide basic integration support for `Sidekiq`. 
-These integration should also work with `SidekiqPublisher`. 
-However, you may need to explicitly include 
+Many exception monitoring service (e.g. Sentry, Airbrake, Honeybadger, etc) already provide basic integration support for `Sidekiq`.
+These integration should also work with `SidekiqPublisher`.
+However, you may need to explicitly include
 `ActiveJob::QueueAdapters::SidekiqPublisherAdapter` as a compatible adapter for this to work properly.
 
 Alternatively, you can manually report the exception:
 
  ```ruby
 retry_on SomeError, attempts: 10 do |_job, exception|
-  Raven.capture_exception(exception, extra: { custom: :foo }) # Reporting using the Sentry gem 
+  Raven.capture_exception(exception, extra: { custom: :foo }) # Reporting using the Sentry gem
 end
 ```
 
 ### SidekiqPublisher::Worker
 
-Sidekiq workers are usually defined by including `Sidekiq::Worker` in a class.
+Sidekiq workers are usually defined by including `Sidekiq::Job` or
+`Sidekiq::Worker` in a class.
 
 To use the `SidekiqPublisher`, this can be replaced by including
 `SidekiqPublisher::Worker`. The usual `perform_async`, etc methods will be

data/lib/sidekiq_publisher/compatibility.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module SidekiqPublisher
+  module Compatibility
+    class << self
+      # Sidekiq::Worker will be renamed to Sidekiq::Job in sidekiq 7.0.0 and a
+      # deprecation warning will be printed in sidekiq 6.4.0, per
+      # mperham/sidekiq#4971. Sidekiq 6.2.2 (mperham/sidekiq@8e36432) introduces
+      # an alias and 6.3.0 includes it when the gem is loaded. This alias is
+      # used here to ensure future compatibility.
+      def sidekiq_job_class
+        @_sidekiq_job_class ||= Gem::Dependency.new("sidekiq", ">= 6.3.0").then do |dependency|
+          if dependency.match?(Gem.loaded_specs["sidekiq"])
+            Sidekiq::Job
+          else
+            Sidekiq::Worker
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sidekiq_publisher/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SidekiqPublisher
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

data/lib/sidekiq_publisher/worker.rb

@@ -3,7 +3,7 @@
 module SidekiqPublisher
   module Worker
     def self.included(base)
-      base.include(Sidekiq::Worker)
+      base.include(SidekiqPublisher::Compatibility.sidekiq_job_class)
       base.singleton_class.public_send(:alias_method, :sidekiq_client_push, :client_push)
       base.extend(ClassMethods)
     end

data/lib/sidekiq_publisher.rb

@@ -3,6 +3,7 @@
 require "active_support"
 require "active_support/core_ext/numeric/time"
 require "sidekiq_publisher/version"
+require "sidekiq_publisher/compatibility"
 require "sidekiq_publisher/instrumenter"
 require "sidekiq_publisher/metrics_reporter"
 require "sidekiq_publisher/exception_reporter"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_publisher
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-01 00:00:00.000000000 Z
+date: 2021-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -311,6 +311,7 @@ files:
 - lib/generators/sidekiq_publisher/templates/create_sidekiq_publisher_jobs.rb
 - lib/sidekiq_publisher.rb
 - lib/sidekiq_publisher/client.rb
+- lib/sidekiq_publisher/compatibility.rb
 - lib/sidekiq_publisher/datadog_apm.rb
 - lib/sidekiq_publisher/engine.rb
 - lib/sidekiq_publisher/exception_reporter.rb
@@ -345,7 +346,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Publisher for enqueuing jobs to Sidekiq