sidekiq_status 1.0.7 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 63be21ef3fd839f7e92df3df5e368ff4a68e8bfc
-  data.tar.gz: 52df11955cfcfdeb08834b17f4270bb59d999a72
+  metadata.gz: f4e3282b9acea7633ee8a90aed6fe8982bc17946
+  data.tar.gz: a480a2d256f63636be9ef162cfd791cea7ebaa32
 SHA512:
-  metadata.gz: dda533578c80113a584638eed5bae730a2e2f24e69ea3f25d3e18c72aab79a8392d18a798c67af879174543df0de0c1ceb514c41eaa52fbdc4559105d2cd5383
-  data.tar.gz: 442cebe74cc81e84510d2b6ca767553cdab771a8e93ff8176b54d5d60f6b78c5f016c3d8ebc0c15ddcd1bd0ea99e2e141d698265af0559bb022f9e0b3ede401f
+  metadata.gz: 61f4121815255d2d704cf262a9619a3ed0108a383e563188afbfb4cdd0367eb4acc32e6f14aed118c3d2eab0734046cf32571e703b3a097e0fc43debac79f1a6
+  data.tar.gz: dd87aa7efdb084aa718d0cd257c7b768d573fe6158b4f5d563172d01dd16f1608e06dccbd43c93f71de93fe95d727cf37727627b30c8188022d6e98f5a201d8e

data/.ruby-gemset

@@ -0,0 +1 @@
+sidekiq_status

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.4

data/.travis.yml

@@ -1,21 +1,27 @@
 language: ruby
 rvm:
-  - 1.9.2
-  - 1.9.3
-  - 2.0.0
-#  - jruby-19mode # JRuby in 1.9 mode
-#  - rbx-19mode
+  - 2.1.10
+  - 2.2.4
+  - 2.3.0
+  - rbx-3.14
 env:
   global:
     - SHOW_SIDEKIQ=true
   matrix:
-    - SIDEKIQ_VERSION="~>2.4.0"
-    - SIDEKIQ_VERSION="~>2.6.5"
-    - SIDEKIQ_VERSION="~>2.8.0"
-    - SIDEKIQ_VERSION="~>2.10.0"
-    - SIDEKIQ_VERSION="~>2.12.0"
-    - SIDEKIQ_VERSION="~>2.13.0"
-    - SIDEKIQ_VERSION="~>2.14.0"
-    - SIDEKIQ_VERSION="~>2.15.0"
-    - SIDEKIQ_VERSION="~>2.16.0"
+    - SIDEKIQ_VERSION="~>4.1.0"
+    - SIDEKIQ_VERSION="~>4.0.2"
+    - SIDEKIQ_VERSION="~>3.5.4"
+    - SIDEKIQ_VERSION="~>3.4.2"
+    - SIDEKIQ_VERSION="~>3.3.4"
+
+before_install:
+  - sudo apt-get -qq update
+  - sudo apt-get install libgmp3-dev
+  - gem update --system
+  - gem update bundler
+  - gem --version
+  - bundle --version
+
 script: bundle exec rake
+services:
+  - redis-server

data/README.md

@@ -147,6 +147,17 @@ and clean status containers.
 
 ## Changelog
 
+### 1.1.0
+
+  * Support for sidekiq 4.1, 4.0, 3.5, 3.4
+  * No more replacement of original job arguments with generated unique jid. 
+    This is not needed anymore as Sidekiq started to do it. 
+    This change should make integration with other middlewares easier.
+  * Dropped support for sidekiq versions older than 3.3
+  * Dropped support for ruby 1.9.x, 2.0.x
+  * Experimental support for Rubinius
+
+
 ### 1.0.7
 
    * Sidekiq 2.16 support

data/lib/sidekiq_status/client_middleware.rb

@@ -2,7 +2,7 @@
 
 module SidekiqStatus
   class ClientMiddleware
-    def call(worker, item, queue)
+    def call(worker, item, queue, redis_pool = nil)
       worker = worker.constantize if worker.is_a?(String)
       return yield unless worker < SidekiqStatus::Worker
 
@@ -23,7 +23,6 @@ module SidekiqStatus
 
       jid  = item['jid']
       args = item['args']
-      item['args'] = [jid]
 
       SidekiqStatus::Container.create(
           'jid'    => jid,

data/lib/sidekiq_status/container.rb

@@ -156,7 +156,7 @@ module SidekiqStatus
     # @param [Array<#to_s>] jids a list of job identifiers to load data for
     # @return [Hash{String => Hash}] A hash of job-id to deserialized data pairs
     def self.load_data_multi(jids)
-      keys = jids.map { |jid| status_key(jid) }
+      keys = jids.map(&method(:status_key))
 
       return {} if keys.empty?
 
@@ -260,6 +260,8 @@ module SidekiqStatus
     # @return [Integer] Job progress in percents (reported solely by {SidekiqStatus::Worker job})
     def pct_complete
       (at.to_f / total * 100).round
+    rescue FloatDomainError, ZeroDivisionError
+      0  
     end
 
     # @param [Fixnum] at Report the progress of a job which is tracked by the current {SidekiqStatus::Container}

data/lib/sidekiq_status/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
 module SidekiqStatus
   # SidekiqStatus version
-  VERSION = "1.0.7"
+  VERSION = "1.1.0"
 end

data/lib/sidekiq_status/worker.rb

@@ -14,13 +14,13 @@ module SidekiqStatus
     end
 
     module Prepending
-      def perform(jid)
+      def perform(*args)
         @status_container = SidekiqStatus::Container.load(jid)
 
         begin
           catch(:killed) do
             set_status('working')
-            super(*@status_container.args)
+            super(*args)
             set_status('complete')
           end
         rescue Exception => exc

data/sidekiq_status.gemspec

@@ -16,10 +16,11 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = SidekiqStatus::VERSION
 
-  gem.add_runtime_dependency("sidekiq", ">= 2.4", "< 2.17")
+  gem.add_runtime_dependency("sidekiq", ">= 3.3", "< 4.2")
 
   gem.add_development_dependency("activesupport")
-  gem.add_development_dependency("rspec")
+  gem.add_development_dependency("rspec", '>= 3.4.0')
+  gem.add_development_dependency("rspec-its")
   gem.add_development_dependency("simplecov")
   gem.add_development_dependency("rake")
   gem.add_development_dependency("timecop")

data/spec/client_middleware_spec.rb

@@ -5,7 +5,7 @@ describe SidekiqStatus::ClientMiddleware do
   describe "cryo28/sidekiq_status#11 regression" do
     describe "#call" do
       before do
-        SidekiqStatus::Container.should_receive(:create).with(hash_including('worker' => 'TestWorker1'))
+        expect(SidekiqStatus::Container).to receive(:create).with(hash_including('worker' => 'TestWorker1'))
       end
 
       it "accepts a worker class" do
@@ -21,7 +21,7 @@ describe SidekiqStatus::ClientMiddleware do
   end
 
   it "does not create container for scheduled job" do
-    SidekiqStatus::Container.should_not_receive(:create)
+    expect(SidekiqStatus::Container).to_not receive(:create)
 
     subject.call("TestWorker1", { "at" => Time.now }, nil) do
     end

data/spec/container_spec.rb

@@ -91,7 +91,7 @@ describe SidekiqStatus::Container do
   end
 
   specify ".create" do
-    SecureRandom.should_receive(:hex).with(12).and_return(jid)
+    expect(SecureRandom).to receive(:hex).with(12).and_return(jid)
     args = ['arg1', 'arg2', {arg3: 'val3'}]
 
     container = described_class.create('args' => args)
@@ -102,7 +102,7 @@ describe SidekiqStatus::Container do
     test_container(container, described_class::DEFAULTS.reject{|k, v| k == 'args' }, jid)
 
     Sidekiq.redis do |conn|
-      conn.exists(status_key).should be_true
+      conn.exists(status_key).should be true
     end
   end
 
@@ -112,7 +112,7 @@ describe SidekiqStatus::Container do
     end
 
     it "loads a container from the redis key" do
-      json = MultiJson.dump(sample_json_hash)
+      json = Sidekiq.dump_json(sample_json_hash)
       Sidekiq.redis { |conn| conn.set(status_key, json) }
 
       container = described_class.load(jid)
@@ -128,7 +128,7 @@ describe SidekiqStatus::Container do
         )
       end
 
-      json = MultiJson.dump(sample_json_hash)
+      json = Sidekiq.dump_json(sample_json_hash)
       Sidekiq.redis { |conn| conn.set(status_key, json) }
       described_class.load(jid)
 
@@ -151,7 +151,7 @@ describe SidekiqStatus::Container do
     described_class.new(jid, hash).save
 
     result = Sidekiq.redis{ |conn| conn.get(status_key) }
-    result = MultiJson.load(result)
+    result = Sidekiq.load_json(result)
 
     result.should == hash.merge('last_updated_at' => Time.now.to_i)
 
@@ -168,14 +168,14 @@ describe SidekiqStatus::Container do
     container.delete
 
     Sidekiq.redis do |conn|
-      conn.exists(status_key).should be_false
+      conn.exists(status_key).should be false
       conn.zscore(described_class.kill_key, jid).should be_nil
     end
   end
 
   specify "#request_kill, #should_kill?, #killable?" do
     container = described_class.new(jid)
-    container.kill_requested?.should be_false
+    container.kill_requested?.should be_falsey
     container.should be_killable
 
     Sidekiq.redis do |conn|
@@ -220,8 +220,17 @@ describe SidekiqStatus::Container do
     container.at = 5
     container.total = 200
     container.pct_complete.should == 3 # 2.5.round(0) => 3
+
+    container.at = Float::INFINITY
+    container.pct_complete.should == 0 # FloatDomainError
+
+    container.at = 5
+    container.total = 0
+    container.pct_complete.should == 0 # ZeroDivisionError
   end
 
+  
+
   context "setters" do
     let(:container) { described_class.new(jid) }
 
@@ -302,12 +311,12 @@ describe SidekiqStatus::Container do
       context "status is #{status_name1}" do
         subject{ described_class.create().tap{|c| c.status = status_name1} }
 
-        its("#{status_name1}?") { should be_true }
+        its("#{status_name1}?") { should be true }
 
         (described_class::STATUS_NAMES - [status_name1]).each do |status_name2|
-          its("#{status_name2}?") { should be_false }
+          its("#{status_name2}?") { should be false }
         end
       end
     end
   end
-end
+end

data/spec/spec_helper.rb

@@ -13,6 +13,7 @@ end
 require 'coveralls'
 Coveralls.wear!
 
+require 'rspec/its'
 require 'sidekiq_status'
 require 'sidekiq/util'
 
@@ -24,6 +25,10 @@ Sidekiq.logger.level = Logger::ERROR
 require GEM_ROOT.join('spec/dummy/boot.rb')
 
 RSpec.configure do |c|
+  c.expect_with :rspec do |expectations|
+    expectations.syntax = [:should, :expect]
+  end
+
   c.before do
     Sidekiq.redis{ |conn| conn.flushdb }
   end

data/spec/worker_spec.rb

@@ -26,10 +26,11 @@ describe Sidekiq::Worker do
   describe "#perform (Worker context)" do
     let(:worker) { SomeWorker.new }
 
-    it "receives jid as parameters, loads container and runs original perform with enqueued args" do
-      worker.should_receive(:some_method).with(*args)
+    it "loads container using @jid and runs original perform" do
+      expect(worker).to receive(:some_method).with(*args)
       jid = SomeWorker.perform_async(*args)
-      worker.perform(jid)
+      worker.jid = jid.freeze
+      worker.perform(*args)
     end
 
     it "changes status to working" do
@@ -42,18 +43,20 @@ describe Sidekiq::Worker do
       end)
 
       jid = SomeWorker.perform_async(*args)
-      worker.perform(jid)
+      worker.jid = jid.freeze
+      worker.perform(*args)
 
-      has_been_run.should be_true
+      has_been_run.should be true
       worker.status_container.reload.status.should == 'complete'
     end
 
     it "intercepts failures and set status to 'failed' then re-raises the exception" do
       exc = RuntimeError.new('Some error')
-      worker.stub(:some_method).and_raise(exc)
+      allow(worker).to receive(:some_method).and_raise(exc)
 
       jid = SomeWorker.perform_async(*args)
-      expect{ worker.perform(jid) }.to raise_exception{ |error| error.object_id.should == exc.object_id }
+      worker.jid = jid.freeze
+      expect{ worker.perform(*args) }.to raise_exception{ |error| error.object_id.should == exc.object_id }
 
       container = SidekiqStatus::Container.load(jid)
       container.status.should == 'failed'
@@ -61,7 +64,8 @@ describe Sidekiq::Worker do
 
     it "sets status to 'complete' if finishes without errors" do
       jid = SomeWorker.perform_async(*args)
-      worker.perform(jid)
+      worker.jid = jid.freeze
+      worker.perform(*args)
 
       container = SidekiqStatus::Container.load(jid)
       container.status.should == 'complete'
@@ -69,10 +73,12 @@ describe Sidekiq::Worker do
 
     it "handles kill requests if kill requested before job execution" do
       jid = SomeWorker.perform_async(*args)
+      worker.jid = jid.freeze
+
       container = SidekiqStatus::Container.load(jid)
       container.request_kill
 
-      worker.perform(jid)
+      worker.perform(*args)
 
       container.reload
       container.status.should == 'killed'
@@ -80,6 +86,8 @@ describe Sidekiq::Worker do
 
     it "handles kill requests if kill requested amid job execution" do
       jid = SomeWorker.perform_async(*args)
+      worker.jid = jid.freeze
+
       container = SidekiqStatus::Container.load(jid)
       container.status.should == 'waiting'
 
@@ -117,6 +125,8 @@ describe Sidekiq::Worker do
 
     it "allows to set at, total and customer payload from the worker" do
       jid = SomeWorker.perform_async(*args)
+      worker.jid = jid.freeze
+
       container = SidekiqStatus::Container.load(jid)
 
       lets_stop = false

metadata

@@ -1,131 +1,145 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_status
 version: !ruby/object:Gem::Version
-  version: 1.0.7
+  version: 1.1.0
 platform: ruby
 authors:
 - Artem Ignatyev
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-11 00:00:00.000000000 Z
+date: 2016-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.4'
-    - - <
+        version: '3.3'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.17'
+        version: '4.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.4'
-    - - <
+        version: '3.3'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.17'
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   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: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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: simplecov
   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
     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: timecop
   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: yard
   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: maruku
   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'
 description: Job status tracking extension for Sidekiq
@@ -135,11 +149,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .rvmrc
-- .travis.yml
-- .yardopts
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- ".yardopts"
 - Gemfile
 - LICENSE
 - README.md
@@ -172,17 +187,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.10
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A Sidekiq extension to track job execution statuses and return job results

data/.rvmrc

@@ -1 +0,0 @@
-rvm use 2.0.0-p247@sidekiq_status --create