sidekiq-status 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 70899fafcf4e5aa712b2df57e34700cba6d001fe
-  data.tar.gz: cd4801e8d4678b515f3a597438953c3430066a30
+  metadata.gz: c4b871d99e1ab00e5786f91d61a3f0fc4c17087e
+  data.tar.gz: 6909a5063a68811982f9e38580b1aeb146f5313f
 SHA512:
-  metadata.gz: 1669fb78f47cc77930d4b93f7c7a1537526d426cf0e99c4c5bb8b13e271ed66711e15276959a381216710aca8cfac60f90fc0790719db2c9a8f4c3faaa046a41
-  data.tar.gz: d7e697fdb8ee26e50f125b73b44abe2f5c796e74ad9242d76bc85964e526c33b9d81916fa49a3623c29bb55b2b9a5126b30db8e730c5668d34d1a6f7dbcfd024
+  metadata.gz: 952fb2284e645179db9b5242bf4a9adcc6f8512b02335b60056b964711498c2c87d633e6f1b95116d576524ca4e3931db25fa51a22eab4d67cc41ac86e84099f
+  data.tar.gz: 249eba2c142648813996c685d6bb5e03b08765580bd36139ce24f348ddc3a1cd19ec0569a9c398d9c08a2d948a2f64d7e537695df6d93b45869416a1546a16ef

data/CHANGELOG

@@ -1 +1,2 @@
+Version 0.5.0:Sidekiq v3 support, redis pools support
 Version 0.4.0:WebUI added, per-worker expiration setting enabled

data/README.md

@@ -1,5 +1,5 @@
 # Sidekiq::Status
-
+[![Gem Version](https://badge.fury.io/rb/sidekiq-status.png)](http://badge.fury.io/rb/sidekiq-status)
 [![Code Climate](https://codeclimate.com/github/utgarda/sidekiq-status.png)](https://codeclimate.com/github/utgarda/sidekiq-status)
 [![Build Status](https://secure.travis-ci.org/utgarda/sidekiq-status.png)](http://travis-ci.org/utgarda/sidekiq-status)
 
@@ -92,7 +92,8 @@ class MyJob
     # your code goes here
 
     # the common idiom to track progress of your task
-    at 5, 100, "Almost done"
+    total 100 # by default
+    at 5, "Almost done"
 
     # a way to associate data with your job
     store vino: 'veritas'
@@ -107,7 +108,7 @@ job_id = MyJob.perform_async(*args)
 data = Sidekiq::Status::get_all job_id
 data # => {status: 'complete', update_time: 1360006573, vino: 'veritas'}
 Sidekiq::Status::get     job_id, :vino #=> 'veritas'
-Sidekiq::Status::num     job_id #=> 5
+Sidekiq::Status::at      job_id #=> 5
 Sidekiq::Status::total   job_id #=> 100
 Sidekiq::Status::message job_id #=> "Almost done"
 Sidekiq::Status::pct_complete job_id #=> 5
@@ -121,6 +122,18 @@ Sidekiq::Status.cancel scheduled_job_id #=> true
 Sidekiq::Status.unschedule scheduled_job_id #=> true
 ```
 
+### Sidekiq web integration
+
+Sidekiq::Status also provides an extension to Sidekiq web interface with a `/statuses` page.
+
+Setup Sidekiq web interface according to Sidekiq documentation and add the Sidekiq::Status::Web require:
+
+``` ruby
+require 'sidekiq/web'
+require 'sidekiq-status/web'
+```
+
+
 ### Testing
 
 Drawing analogy from [sidekiq testing by inlining](https://github.com/mperham/sidekiq/wiki/Testing#testing-workers-inline),

data/lib/sidekiq-status.rb

@@ -45,8 +45,8 @@ module Sidekiq::Status
     end
 
     # Methods for retrieving job completion
-    def num(job_id)
-      get(job_id, :num).to_i
+    def at(job_id)
+      get(job_id, :at).to_i
     end
 
     def total(job_id)
@@ -54,7 +54,7 @@ module Sidekiq::Status
     end
 
     def pct_complete(job_id)
-      (num(job_id).to_f / total(job_id)) * 100
+      (at(job_id).to_f / total(job_id)) * 100
     end
 
     def message(job_id)

data/lib/sidekiq-status/client_middleware.rb

@@ -6,8 +6,9 @@ module Sidekiq::Status
     # @param [Class] worker_class if includes Sidekiq::Status::Worker, the job gets processed with the plugin
     # @param [Array] msg job arguments
     # @param [String] queue the queue's name
-    def call(worker_class, msg, queue)
-      store_status msg['jid'], :queued
+    # @param [ConnectionPool] redis_pool optional redis connection pool
+    def call(worker_class, msg, queue, redis_pool=nil)
+      store_status msg['jid'], :queued, nil, redis_pool
       yield
     end
   end

data/lib/sidekiq-status/storage.rb

@@ -8,9 +8,11 @@ module Sidekiq::Status::Storage
   # sets last update time
   # @param [String] id job id
   # @param [Hash] status_updates updated values
+  # @param [Integer] expiration optional expire time in seconds
+  # @param [ConnectionPool] redis_pool optional redis connection pool
   # @return [String] Redis operation status code
-  def store_for_id(id, status_updates, expiration = nil)
-    Sidekiq.redis do |conn|
+  def store_for_id(id, status_updates, expiration = nil, redis_pool=nil)
+    redis_connection(redis_pool) do |conn|
       conn.multi do
         conn.hmset  id, 'update_time', Time.now.to_i, *(status_updates.to_a.flatten(1))
         conn.expire id, (expiration || Sidekiq::Status::DEFAULT_EXPIRY)
@@ -23,9 +25,11 @@ module Sidekiq::Status::Storage
   # only in case of :failed or :stopped job
   # @param [String] id job id
   # @param [Symbol] job status
+  # @param [Integer] expiration optional expire time in seconds
+  # @param [ConnectionPool] redis_pool optional redis connection pool
   # @return [String] Redis operation status code
-  def store_status(id, status, expiration = nil)
-    store_for_id id, {status: status}, expiration
+  def store_status(id, status, expiration = nil, redis_pool=nil)
+    store_for_id id, {status: status}, expiration, redis_pool
   end
 
   # Unschedules the job and deletes the Status
@@ -90,4 +94,18 @@ module Sidekiq::Status::Storage
     scheduled_jobs.each { |job_listing| (return job_listing) if job_listing.include?("\"jid\":\"#{job_id}") }
     nil
   end
+
+  # Yields redis connection. Uses redis pool if available.
+  # @param [ConnectionPool] redis_pool optional redis connection pool
+  def redis_connection(redis_pool=nil)
+    if redis_pool
+      redis_pool.with do |conn|
+        yield conn
+      end
+    else
+      Sidekiq.redis do |conn|
+        yield conn
+      end
+    end
+  end
 end

data/lib/sidekiq-status/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Status
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

data/lib/sidekiq-status/web.rb

@@ -19,14 +19,14 @@ module Sidekiq::Status
         queue = Sidekiq::Workers.new
         @statuses = []
 
-        queue.each do |name, work, started_at|
+        queue.each do |process, name, work, started_at|
           job = Struct.new(:jid, :klass, :args).new(work["payload"]["jid"], work["payload"]["class"], work["payload"]["args"])
           status = Sidekiq::Status::get_all job.jid
-          next if !status || status.count <= 2
+          next if !status || status.count < 2
           status["worker"] = job.klass
           status["args"] = job.args
           status["jid"] = job.jid
-          status["pct_complete"] = ((status["num"].to_f / status["total"].to_f) * 100).to_i
+          status["pct_complete"] = ((status["at"].to_f / status["total"].to_f) * 100).to_i if status["total"].to_f > 0
           @statuses << OpenStruct.new(status)
         end
 
@@ -43,4 +43,4 @@ if Sidekiq::Web.tabs.is_a?(Array)
   Sidekiq::Web.tabs << "statuses"
 else
   Sidekiq::Web.tabs["Statuses"] = "statuses"
-end
+end

data/lib/sidekiq-status/worker.rb

@@ -24,11 +24,18 @@ module Sidekiq::Status::Worker
   # Sets current task progress
   # (inspired by resque-status)
   # @param Fixnum number of tasks done
-  # @param Fixnum total number of tasks
   # @param String optional message
   # @return [String]
-  def at(num, total, message=nil)
-    store({num: num, total: total, message: message})
+  def at(num, message = nil)
+    total(100) if retrieve(:total).nil?
+    store(at: num, message: message)
+  end
+
+  # Sets total number of tasks
+  # @param Fixnum total number of tasks
+  # @return [String]
+  def total(num)
+    store(total: num)
   end
 
 end

data/sidekiq-status.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ['lib']
   gem.version       = Sidekiq::Status::VERSION
 
-  gem.add_dependency                  'sidekiq', '~> 2.7'
+  gem.add_dependency                  'sidekiq', '>= 2.7', '< 3.1'
   gem.add_development_dependency      'rake'
   gem.add_development_dependency      'rspec'
 end

data/spec/lib/sidekiq-status/client_middleware_spec.rb

@@ -22,5 +22,20 @@ describe Sidekiq::Status::ClientMiddleware do
       (1..Sidekiq::Status::DEFAULT_EXPIRY).should cover redis.ttl(job_id)
     end
 
+    context "when redis_pool passed" do
+      it "uses redis_pool" do
+        redis_pool = double(:redis_pool)
+        redis_pool.should_receive(:with)
+        Sidekiq.should_not_receive(:redis)
+        Sidekiq::Status::ClientMiddleware.new.call(StubJob, {'jid' => SecureRandom.hex}, :queued, redis_pool) do end
+      end
+    end
+
+    context "when redis_pool is not passed" do
+      it "uses Sidekiq.redis" do
+        Sidekiq.should_receive(:redis)
+        Sidekiq::Status::ClientMiddleware.new.call(StubJob, {'jid' => SecureRandom.hex}, :queued) do end
+      end
+    end
   end
-end
+end

data/spec/lib/sidekiq-status_spec.rb

@@ -48,7 +48,7 @@ describe Sidekiq::Status do
     end
   end
 
-  describe ".num, .total, .pct_complete, .message" do
+  describe ".at, .total, .pct_complete, .message" do
     it "should return job progress with correct type to it" do
       SecureRandom.should_receive(:hex).once.and_return(job_id)
 
@@ -57,7 +57,7 @@ describe Sidekiq::Status do
           ProgressJob.perform_async.should == job_id
         }.should == [job_id]*3
       end
-      Sidekiq::Status.num(job_id).should == 100
+      Sidekiq::Status.at(job_id).should == 100
       Sidekiq::Status.total(job_id).should == 500
       Sidekiq::Status.pct_complete(job_id).should == 20
       Sidekiq::Status.message(job_id).should == 'howdy, partner?'

data/spec/support/test_jobs.rb

@@ -25,7 +25,8 @@ end
 
 class ProgressJob < StubJob
   def perform
-    at 100, 500, 'howdy, partner?'
+    total 500
+    at 100, 'howdy, partner?'
     sleep 0.1
   end
 end

data/web/views/statuses.erb

@@ -9,7 +9,7 @@
     <th>Progress</th>
     <th>Message</th>
   </tr>
-  <% @statuses.each do |container| -%>
+  <% @statuses.each do |container| %>
     <tr>
       <td>
           <%= container.worker %>
@@ -27,10 +27,10 @@ color: white;">
         </div>
       <td><%= container.message %></td>
     </tr>
-  <% end -%>
-  <% if @statuses.empty? -%>
+  <% end %>
+  <% if @statuses.empty? %>
     <tr>
       <td colspan="6"></td>
     </tr>
-  <% end -%>
-</table>
+  <% end %>
+</table>

metadata

@@ -1,55 +1,61 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-status
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Evgeniy Tsvigun
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-11 00:00:00.000000000 Z
+date: 2014-05-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 - !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: rspec
   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: 
@@ -59,9 +65,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - LICENSE
@@ -94,17 +100,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.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: An extension to the sidekiq message processing to track your jobs
@@ -116,3 +122,4 @@ test_files:
 - spec/lib/sidekiq-status_spec.rb
 - spec/spec_helper.rb
 - spec/support/test_jobs.rb
+has_rdoc: