sidekiq_publisher 1.5.0 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 253cd9228ac0f0dbd5b1c62656da427ca5a70974e9f7b8b310266520e0aaa841
-  data.tar.gz: 4e1f95c9bc0c42049bf80f9f2782649b2741cbbaae877c5d31d7dbd5735ebdea
+  metadata.gz: 9995be94eaf8bfefa408b212d26f713137516b0ffd7846a47e51d8511a41383c
+  data.tar.gz: 8a23b6f5df56a8cc03569570f1943939b3ed54f9d916f8b4da0a3da51341aa65
 SHA512:
-  metadata.gz: c727d2b2aff3e503ce76c04f5afc99962ad18837b885ba281c4d9fdcd3af60e11afabacaa836162f07654a601821a62a59687af142906985c5949f61d8f6d5fb
-  data.tar.gz: 7f5b6cdda88db63c148985c7b00d2c24106244294d224c83d8549e5741a1be8321f80e5e9ce28fac19b0c17df2b107689fb90a96ef24dc67676cc3221f5b8ade
+  metadata.gz: 181dfdf294e496b3f2182692b37d62bd3d51749eda4ef57f4eb3ce05d092c622bef3f43a0b89eb84e7086651743bdfa3790434e07b45d3084874c7b27229d060
+  data.tar.gz: 878301b5e3f3f7d8b0f9bdd8078106aa71490ad887f351c5cd47e2ebca95f53d951d3ee71b0fcc89730ecd3e18cff1d15147f319709afaa446442e8978b1a426

data/.tool-versions

@@ -0,0 +1 @@
+ruby 2.5.5

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # sidekiq_publisher
 
+## v1.6.3
+- Handle client middleware that returns false.
+
+## v1.6.2
+- Gracefully respond to `INT` and `TERM` process signals.
+
+## v1.6.1
+- Remove the `private_attr` top-level gem dependency.
+
+## v1.6.0
+- Support `Sidekiq::Testing` modes. This only applies to `SidekiqPublisher::Worker`
+  and not the `ActiveJob` adapter.
+
 ## v1.5.0
 - Expand sidekiq support to v5.0.x-v6.0.x.
 

data/Dockerfile

@@ -0,0 +1,4 @@
+FROM ezcater-production.jfrog.io/ruby:f08726283c
+RUN mkdir /usr/src/gem
+WORKDIR /usr/src/gem
+ADD . /usr/src/gem

data/README.md

@@ -150,6 +150,31 @@ can be run with a rake task that is added via Railtie for Rails applications:
 bundle exec rake sidekiq_publisher:publish
 ```
 
+## Testing
+
+### Sidekiq
+
+When using sidekiq_publisher directly with Sidekiq workers, the testing modes
+provided by Sidekiq are supported.
+
+Require the `sidekiq_publisher/testing` file. (This should only be done in test!)
+
+```ruby
+require "sidekiq_publisher/testing"
+```
+
+This file requires "sidekiq/testing" so there is no need to explictly require both.
+Note that by default, Sidekiq sets the test mode to `fake` and stores jobs in a
+`jobs` array for each worker class.
+
+To have `SidekiqPublisher` continue to insert jobs into a table within tests
+call `Sidekiq::Testing.disable!`.
+
+### ActiveJob
+
+When using the sidekiq_publisher adapter for `ActiveJob`, use the `ActiveJob`
+test adapter if you want to run jobs inline during tests.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then,

data/docker-compose.yml

@@ -0,0 +1,43 @@
+version: "3.4"
+volumes:
+  bundle-volume:
+  shared-volume:
+x-environment: &default-environment
+  PRYRC: /usr/src/app/.docker-pryrc
+  BUNDLE_IGNORE_CONFIG: 1
+  BUNDLE_DISABLE_SHARED_GEMS: "true"
+  PGUSER: postgres
+  PGHOST: sidekiq-publisher-postgres
+  PGPORT: 5432
+  PGDATABASE: sidekiq_publisher_test
+  REDIS_URL: redis://sidekiq-publisher-redis:6379
+x-service: &default-service
+  build:
+    context: .
+    args:
+      - BUNDLE_EZCATER__JFROG__IO
+  volumes:
+    - .:/usr/src/gem
+    - bundle-volume:/usr/local/bundle:delegated
+    - shared-volume:/usr/src/shared:delegated
+  tty: true
+  stdin_open: true
+services:
+  sidekiq-publisher-redis:
+    container_name: sidekiq-publisher-redis_1
+    image: redis:5.0.3-alpine
+  sidekiq-publisher-postgres:
+    container_name: sidekiq-publisher-postgres_1
+    image: postgres:10.6
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_DB: sidekiq_publisher_test
+  sidekiq-publisher-console:
+    <<: *default-service
+    container_name: sidekiq-publisher-console_1
+    environment:
+      <<: *default-environment
+    command: bash
+    depends_on:
+      - sidekiq-publisher-redis
+      - sidekiq-publisher-postgres

data/lib/sidekiq_publisher.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "private_attr"
 require "sidekiq_publisher/version"
 require "sidekiq_publisher/report_unpublished_count"
 require "sidekiq_publisher/job"

data/lib/sidekiq_publisher/client.rb

@@ -7,7 +7,7 @@ module SidekiqPublisher
     def bulk_push(items)
       payloads = items.map do |item|
         normed = normalize_item(item)
-        process_single(item["class"], normed)
+        process_single(item["class"], normed) || nil
       end.compact
 
       pushed = 0

data/lib/sidekiq_publisher/job.rb

@@ -18,6 +18,15 @@ module SidekiqPublisher
     scope :published, -> { where.not(published_at: nil) }
     scope :purgeable, -> { where("published_at < ?", Time.now.utc - job_retention_period) }
 
+    def self.create_job!(item)
+      create!(
+        job_class: item["class"].to_s,
+        args: item["args"],
+        run_at: item["at"],
+        queue: item["queue"]
+      )
+    end
+
     def self.generate_sidekiq_jid
       SecureRandom.hex(12)
     end

data/lib/sidekiq_publisher/publisher.rb

@@ -5,10 +5,6 @@ require "active_support/core_ext/object/try"
 
 module SidekiqPublisher
   class Publisher
-    extend PrivateAttr
-
-    private_attr_reader :client, :job_class_cache
-
     def initialize
       @client = SidekiqPublisher::Client.new
       @job_class_cache = {}
@@ -37,6 +33,8 @@ module SidekiqPublisher
 
     private
 
+    attr_reader :client, :job_class_cache
+
     def publish_batch(batch, items)
       pushed_count = client.bulk_push(items)
       published_count = update_jobs_as_published!(batch)

data/lib/sidekiq_publisher/runner.rb

@@ -4,13 +4,9 @@ require "activerecord-postgres_pub_sub"
 
 module SidekiqPublisher
   class Runner
-    extend PrivateAttr
-
     LISTENER_TIMEOUT_SECONDS = 60
     CHANNEL_NAME = "sidekiq_publisher_job"
 
-    private_attr_reader :publisher
-
     def self.run
       new.run
     end
@@ -32,6 +28,8 @@ module SidekiqPublisher
 
     private
 
+    attr_reader :publisher
+
     def listener_timeout
       if Job.unpublished.exists?
         SidekiqPublisher.logger&.warn(

data/lib/sidekiq_publisher/tasks.rake

@@ -2,6 +2,9 @@
 
 namespace :sidekiq_publisher do
   task publish: [:environment] do
+    Signal.trap("INT") { exit(0) }
+    Signal.trap("TERM") { exit(0) }
+
     SidekiqPublisher::Runner.run
   end
 end

data/lib/sidekiq_publisher/testing.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "sidekiq_publisher"
+require "sidekiq/testing"
+
+module SidekiqPublisher
+  module Testing
+    def self.prepended(base)
+      base.singleton_class.public_send(:alias_method, :original_create_job!, :create_job!)
+      base.singleton_class.prepend(ClassMethods)
+    end
+
+    module ClassMethods
+      def create_job!(item)
+        if Sidekiq::Testing.enabled?
+          item["class"].sidekiq_client_push(item)
+        else
+          original_create_job!(item)
+        end
+      end
+    end
+  end
+end
+
+SidekiqPublisher::Job.prepend(SidekiqPublisher::Testing)

data/lib/sidekiq_publisher/version.rb

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

data/lib/sidekiq_publisher/worker.rb

@@ -10,12 +10,7 @@ module SidekiqPublisher
 
     module ClassMethods
       def client_push(item)
-        SidekiqPublisher::Job.create!(
-          job_class: item["class"].to_s,
-          args: item["args"],
-          run_at: item["at"],
-          queue: item["queue"]
-        )
+        SidekiqPublisher::Job.create_job!(item)
       end
     end
   end

data/sidekiq_publisher.gemspec

@@ -54,10 +54,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.4"
   spec.add_development_dependency "rspec_junit_formatter", "0.2.2"
   spec.add_development_dependency "shoulda-matchers"
-  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "simplecov", "< 0.18"
 
   spec.add_runtime_dependency "activerecord-postgres_pub_sub", ">= 0.4.0"
   spec.add_runtime_dependency "activesupport", ">= 5.1", "< 6.1"
-  spec.add_runtime_dependency "private_attr"
   spec.add_runtime_dependency "sidekiq", ">= 5.0.4", "< 6.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_publisher
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.3
 platform: ruby
 authors:
 - ezCater, Inc
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-11 00:00:00.000000000 Z
+date: 2020-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activejob
@@ -196,16 +196,16 @@ dependencies:
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: activerecord-postgres_pub_sub
   requirement: !ruby/object:Gem::Requirement
@@ -240,20 +240,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.1'
-- !ruby/object:Gem::Dependency
-  name: private_attr
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
@@ -282,11 +268,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".tool-versions"
 - Appraisals
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
+- docker-compose.yml
 - gemfiles/rails_5.1.gemfile
 - gemfiles/rails_5.2.gemfile
 - gemfiles/rails_5.2_sidekiq_5.0.gemfile
@@ -306,6 +295,7 @@ files:
 - lib/sidekiq_publisher/report_unpublished_count.rb
 - lib/sidekiq_publisher/runner.rb
 - lib/sidekiq_publisher/tasks.rake
+- lib/sidekiq_publisher/testing.rb
 - lib/sidekiq_publisher/version.rb
 - lib/sidekiq_publisher/worker.rb
 - log/.gitkeep
@@ -330,7 +320,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Publisher for enqueuing jobs to Sidekiq