sidekiq_publisher 2.0.0.rc0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bef2eda10ec3e9fc09d95fe0af551b408331b8d3a42ff35d6c0f1012ea744e2
-  data.tar.gz: 317a3f1d450d71e0504fc351b33792002f83a0c9d36e2e2f6cf1c985d546c62b
+  metadata.gz: 5ca992a4d903fe216977ebf332301a80d363f3e4f9b16e096c9709cd160e628c
+  data.tar.gz: 1634e4fc0793db4de6329a208abf16b215ec43854bf17ee9b96f23914e8dc35c
 SHA512:
-  metadata.gz: c6dc3e3765c0b2e819087aa249add2fb2baf7b625394def4702e7340d210aeb6e2f51be9d529d19be4731742ec66f7a940867f8f28b1dd09112abafc7a620929
-  data.tar.gz: '09598e9b91cd23c47f8aa583155acfb16d54b01a534ef727463f77692999776f29db0df7dfa826b961688f9e20ed6beda568e5c6bd8abb76148717411604f2ce'
+  metadata.gz: d5a40a98bfc841382ed03e468028728a832dbe0867bdfe90209b6e6aca458e7c2ce89c95e8a075fc43ec017438b1e2661f863d391bc337fba700a944fda6cfe8
+  data.tar.gz: 1114316164932338779521dde2fa7a36cf18cfcf810fc7642b7af2b55f6777e8700eccd3489bfe0d4b66265accda5894b6a7efdfda004fbbc6e94ddebcf76d40

data/Appraisals

@@ -30,6 +30,18 @@ appraise "rails-5.2-sidekiq-6.1" do
   gem "sidekiq", "~> 6.1.0"
 end
 
+appraise "rails-5.2-sidekiq-6.2" do
+  gem "activejob", "~> 5.2.0"
+  gem "activesupport", "~> 5.2.0"
+  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"
@@ -48,6 +60,18 @@ appraise "rails-6.0-sidekiq-6.1" do
   gem "sidekiq", "~> 6.1.0"
 end
 
+appraise "rails-6.0-sidekiq-6.2" do
+  gem "activejob", "~> 6.0.0"
+  gem "activesupport", "~> 6.0.0"
+  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"
@@ -65,3 +89,15 @@ appraise "rails-6.1-sidekiq-6.1" do
   gem "activesupport", "~> 6.1.0"
   gem "sidekiq", "~> 6.1.0"
 end
+
+appraise "rails-6.1-sidekiq-6.2" do
+  gem "activejob", "~> 6.1.0"
+  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,11 +1,23 @@
 # sidekiq_publisher
 
-## v2.0.0 (unreleased)
+## 2.1.1
+- Opt-in to [Rubygems MFA](https://guides.rubygems.org/mfa-requirement-opt-in/)
+  for privileged operations
+
+## 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).
+
+## v2.0.0
 - Transition from defining a Railtie to becoming a Rails Engine
   [(#44)](https://github.com/ezcater/sidekiq_publisher/pull/44). This change was
   made to better support Ruby 3.0 and Rails 6.1. The change is *not* expected to
   be breaking but it does represent a major change in the gem's implementation
-  change and that is the reason for the major version bump.
+  and that is the reason for the major version bump.
 - Require Ruby 2.6 or later.
 
 ## v1.8.0

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/app/models/sidekiq_publisher/job.rb

@@ -10,7 +10,11 @@ module SidekiqPublisher
     before_save :ensure_string_job_class
 
     validates :job_class, presence: true
-    validates :args, exclusion: { in: [nil] }
+    # This exclusion rule currently has a bug in rails 6.1. For now, we will use a manual implementation
+    # Github Issue: https://github.com/rails/rails/issues/41051
+    # Possible PR: https://github.com/rails/rails/pull/41412
+    # validates :args, exclusion: { in: [nil] }
+    validate :args_not_nil
 
     scope :unpublished, -> { where(published_at: nil) }
     scope :published, -> { where.not(published_at: nil) }
@@ -54,6 +58,10 @@ module SidekiqPublisher
 
     private
 
+    def args_not_nil
+      errors.add(:args, "is reserved") if args.nil?
+    end
+
     def ensure_job_id
       self.job_id ||= self.class.generate_sidekiq_jid
     end

data/gemfiles/rails_5.2_sidekiq_6.2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activejob", "~> 5.2.0"
+gem "activesupport", "~> 5.2.0"
+gem "sidekiq", "~> 6.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_6.0_sidekiq_6.2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activejob", "~> 6.0.0"
+gem "activesupport", "~> 6.0.0"
+gem "sidekiq", "~> 6.2.0"
+
+gemspec path: "../"

data/gemfiles/rails_6.1_sidekiq_6.2.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activejob", "~> 6.1.0"
+gem "activesupport", "~> 6.1.0"
+gem "sidekiq", "~> 6.2.0"
+
+gemspec path: "../"

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.0.rc0"
+  VERSION = "2.1.1"
 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"

data/sidekiq_publisher.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |spec|
   # Set "allowed_push_post" to control where this gem can be published.
   if spec.respond_to?(:metadata)
     spec.metadata["allowed_push_host"] = "https://rubygems.org"
-
+    spec.metadata["rubygems_mfa_required"] = "true"
   else
     raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_publisher
 version: !ruby/object:Gem::Version
-  version: 2.0.0.rc0
+  version: 2.1.1
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-09 00:00:00.000000000 Z
+date: 2021-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -297,17 +297,21 @@ files:
 - gemfiles/rails_5.2_sidekiq_5.2.gemfile
 - gemfiles/rails_5.2_sidekiq_6.0.gemfile
 - gemfiles/rails_5.2_sidekiq_6.1.gemfile
+- gemfiles/rails_5.2_sidekiq_6.2.gemfile
 - gemfiles/rails_6.0_sidekiq_5.2.gemfile
 - gemfiles/rails_6.0_sidekiq_6.0.gemfile
 - gemfiles/rails_6.0_sidekiq_6.1.gemfile
+- gemfiles/rails_6.0_sidekiq_6.2.gemfile
 - gemfiles/rails_6.1_sidekiq_5.2.gemfile
 - gemfiles/rails_6.1_sidekiq_6.0.gemfile
 - gemfiles/rails_6.1_sidekiq_6.1.gemfile
+- gemfiles/rails_6.1_sidekiq_6.2.gemfile
 - lib/active_job/queue_adapters/sidekiq_publisher_adapter.rb
 - lib/generators/sidekiq_publisher/install_generator.rb
 - 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
@@ -327,6 +331,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -338,12 +343,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 2.7.6.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Publisher for enqueuing jobs to Sidekiq