sidekiq-status 0.1.0 → 0.2.0

data/lib/sidekiq-status.rb

@@ -8,7 +8,7 @@ module Sidekiq
   module Status
     extend Storage
     DEFAULT_EXPIRY = 60 * 30
-    UUID_REGEXP = /[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}/
+    UUID_REGEXP = /[0-9A-F]{24}/i #RegEx for SecureRandom.hex(12) which is the format Sidekiq uses for its jid
 
     # Job status by id
     # @param [String] id job id returned by async_perform
@@ -16,5 +16,12 @@ module Sidekiq
     def self.get(id)
       read_field_for_id(id, :status)
     end
+
+    # Get all status fields for a job
+    # @params [String] id job id returned by async_perform
+    # @return [Hash] hash of all fields stored for the job
+    def self.get_all(id)
+      read_hash_for_id(id)
+    end
   end
 end

data/lib/sidekiq-status/client_middleware.rb

@@ -2,13 +2,13 @@ module Sidekiq::Status
 # Should be in the client middleware chain
   class ClientMiddleware
     include Storage
-    # Uses the first argument as id and puts :queued status in the job's Redis hash
+    # Uses msg['jid'] id and puts :queued status in the job's Redis hash
     # @param [Class] worker_class if includes Sidekiq::Status::Worker, the job gets processed with the plugin
-    # @param [Array] msg job arguments, the firs one becomes the id
+    # @param [Array] msg job arguments
     # @param [String] queue the queue's name
     def call(worker_class, msg, queue)
       if worker_class.include? Worker
-        store_for_id(msg['args'][0], :status => :queued)
+        store_for_id(msg['jid'], :status => :queued)
       end
       yield
     end

data/lib/sidekiq-status/server_middleware.rb

@@ -9,21 +9,21 @@ module Sidekiq::Status
       @expiration = opts[:expiration]
     end
 
-    # Takes out the first job argument to use as id
+    # Uses sidekiq's internal jid as id
     # puts :working status into Redis hash
     # initializes worker instance with id
     #
-    # Exception handler sets :failed status, re-inserts worker it to job args and re-throws the exception
+    # Exception handler sets :failed status, re-inserts worker and re-throws the exception
     # Worker::Stopped exception type are processed separately - :stopped status is set, no re-throwing
     #
     # @param [Worker] worker worker instance, processed here if its class includes Status::Worker
-    # @param [Array] msg job args, first of them used as job id, should have uuid format
+    # @param [Array] msg job args, should have jid format
     # @param [String] queue queue name
     def call(worker, msg, queue)
       if worker.is_a? Worker
-        worker.id = msg['args'].shift
+        worker.id = msg['jid']
         unless worker.id.is_a?(String) && UUID_REGEXP.match(worker.id)
-          raise ArgumentError, "First job argument for a #{worker.class.name} should have uuid format"
+          raise ArgumentError, "First job argument for a #{worker.class.name} should have jid format"
         end
         worker.store 'status' => 'working'
         yield
@@ -36,7 +36,6 @@ module Sidekiq::Status
     rescue
       if worker.is_a? Worker
         worker.store 'status' => 'failed'
-        msg['args'].unshift worker.id
       end
       raise
     ensure

data/lib/sidekiq-status/storage.rb

@@ -28,4 +28,13 @@ module Sidekiq::Status::Storage
       conn.hmget(uuid, field)[0]
     end
   end
-end
+
+  # Gets the whole status hash from the job status
+  # @param [String] id job id
+  # @return [Hash] Hash stored in redis
+  def read_hash_for_id(id)
+    Sidekiq.redis do |conn|
+      conn.hgetall id
+    end
+  end
+end

data/lib/sidekiq-status/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Status
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/sidekiq-status/worker.rb

@@ -1,26 +1,5 @@
-require "active_support"
-
 module Sidekiq::Status::Worker
   include Sidekiq::Status::Storage
-  extend ActiveSupport::Concern
-
-  # Adding ID generation to .perform_async
-  module ClassMethods
-    # :nodoc:
-    def self.extended(base)
-      class << base
-        alias_method_chain :perform_async, :uuid
-      end
-    end
-
-    # Add an id to job arguments
-    def perform_async_with_uuid(*args)
-      id = SecureRandom.uuid
-      args.unshift id
-      perform_async_without_uuid(*args)
-      id
-    end
-  end
 
   class Stopped < StandardError
   end
@@ -32,7 +11,7 @@ module Sidekiq::Status::Worker
   # @raise [RuntimeError] raised in case of second id initialization attempt
   # @return [String] id
   def id=(id)
-    raise RuntimeError("Worker ID is already set : #@id") if @id
+    raise RuntimeError("Worker ID is already set : #{@id}") if @id
     @id=id
   end
 

data/sidekiq-status.gemspec

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

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

@@ -3,20 +3,20 @@ require 'spec_helper'
 describe Sidekiq::Status::ClientMiddleware do
 
   let!(:redis) { Sidekiq.redis { |conn| conn } }
-  let!(:job_id) { SecureRandom.uuid }
+  let!(:job_id) { SecureRandom.hex(12) }
 
   # Clean Redis before each test
   before { redis.flushall }
 
   describe "#call" do
     it "sets queued status" do
-      SecureRandom.should_receive(:uuid).once.and_return(job_id)
+      SecureRandom.should_receive(:hex).once.and_return(job_id)
       StubJob.perform_async(:arg1 => 'val1').should == job_id
       redis.hget(job_id, :status).should == 'queued'
     end
 
     it "sets status hash ttl" do
-      SecureRandom.should_receive(:uuid).once.and_return(job_id)
+      SecureRandom.should_receive(:hex).once.and_return(job_id)
       StubJob.perform_async(:arg1 => 'val1').should == job_id
       (1..Sidekiq::Status::DEFAULT_EXPIRY).should cover redis.ttl(job_id)
     end

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

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe Sidekiq::Status::ServerMiddleware do
 
   let!(:redis) { Sidekiq.redis { |conn| conn } }
-  let!(:job_id) { SecureRandom.uuid }
+  let!(:job_id) { SecureRandom.hex(12) }
 
   # Clean Redis before each test
   # Seems like flushall has no effect on recently published messages,
@@ -13,7 +13,7 @@ describe Sidekiq::Status::ServerMiddleware do
   describe "#call" do
     it "sets working/complete status" do
       thread = confirmations_thread 4, "status_updates", "job_messages_#{job_id}"
-      SecureRandom.should_receive(:uuid).once.and_return(job_id)
+      SecureRandom.should_receive(:hex).once.and_return(job_id)
       start_server do
         ConfirmationJob.perform_async(:arg1 => 'val1').should == job_id
         thread.value.should == [job_id, job_id,
@@ -24,7 +24,7 @@ describe Sidekiq::Status::ServerMiddleware do
     end
 
     it "sets failed status" do
-      SecureRandom.should_receive(:uuid).once.and_return(job_id)
+      SecureRandom.should_receive(:hex).once.and_return(job_id)
       start_server do
         capture_status_updates(3) {
           FailingJob.perform_async.should == job_id
@@ -34,7 +34,7 @@ describe Sidekiq::Status::ServerMiddleware do
     end
 
     it "sets status hash ttl" do
-      SecureRandom.should_receive(:uuid).once.and_return(job_id)
+      SecureRandom.should_receive(:hex).once.and_return(job_id)
       StubJob.perform_async(:arg1 => 'val1').should == job_id
       (1..Sidekiq::Status::DEFAULT_EXPIRY).should cover redis.ttl(job_id)
     end

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

@@ -2,11 +2,11 @@ require 'spec_helper'
 
 describe Sidekiq::Status::Worker do
 
-  let!(:job_id) { SecureRandom.uuid }
+  let!(:job_id) { SecureRandom.hex(12) }
 
   describe ".perform_async" do
     it "generates and returns job id" do
-      SecureRandom.should_receive(:uuid).once.and_return(job_id)
+      SecureRandom.should_receive(:hex).once.and_return(job_id)
       StubJob.perform_async().should == job_id
     end
   end

data/spec/lib/sidekiq-status_spec.rb

@@ -3,8 +3,8 @@ require 'spec_helper'
 describe Sidekiq::Status do
 
   let!(:redis) { Sidekiq.redis { |conn| conn } }
-  let!(:job_id) { SecureRandom.uuid }
-  let!(:job_id_1) { SecureRandom.uuid }
+  let!(:job_id) { SecureRandom.hex(12) }
+  let!(:job_id_1) { SecureRandom.hex(12) }
 
   # Clean Redis before each test
   # Seems like flushall has no effect on recently published messages,
@@ -13,7 +13,7 @@ describe Sidekiq::Status do
 
   describe ".get" do
     it "gets job status by id" do
-      SecureRandom.should_receive(:uuid).once.and_return(job_id)
+      SecureRandom.should_receive(:hex).once.and_return(job_id)
 
       start_server do
         capture_status_updates(2) {
@@ -25,9 +25,25 @@ describe Sidekiq::Status do
     end
   end
 
+  describe ".get_all" do
+    it "gets the job hash by id" do
+      SecureRandom.should_receive(:hex).once.and_return(job_id)
+
+      start_server do
+        capture_status_updates(2) {
+          LongJob.perform_async(1).should == job_id
+        }.should == [job_id]*2
+        (hash = Sidekiq::Status.get_all(job_id)).should include 'status' => 'working'
+        hash.should include 'update_time'
+      end
+      (hash = Sidekiq::Status.get_all(job_id)).should include 'status' => 'complete'
+      hash.should include 'update_time'
+    end
+  end
+
   context "keeps normal Sidekiq functionality" do
     it "does jobs with and without status processing" do
-      SecureRandom.should_receive(:uuid).twice.and_return(job_id, job_id_1)
+      SecureRandom.should_receive(:hex).exactly(4).times.and_return(job_id, job_id_1)
       start_server do
         capture_status_updates(6) {
           StubJob.perform_async.should == job_id
@@ -42,7 +58,7 @@ describe Sidekiq::Status do
     end
 
     it "retries failed jobs" do
-      SecureRandom.should_receive(:uuid).once.and_return(job_id)
+      SecureRandom.should_receive(:hex).once.and_return(job_id)
       start_server do
         capture_status_updates(5) {
           RetriedJob.perform_async().should == job_id
@@ -52,4 +68,4 @@ describe Sidekiq::Status do
     end
   end
 
-end
+end

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require "rspec"
 
 require 'sidekiq'
+require 'sidekiq/processor'
+require 'sidekiq/manager'
 require 'sidekiq-status'
 
 
@@ -48,7 +50,7 @@ def start_server()
     require 'sidekiq/cli'
     Sidekiq.options[:queues] << 'default'
     Sidekiq.configure_server do |config|
-      config.redis = {:url => 'redis://localhost:6379'}
+      config.redis = Sidekiq::RedisConnection.create
       config.server_middleware do |chain|
         chain.add Sidekiq::Status::ServerMiddleware
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-status
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-19 00:00:00.000000000 Z
+date: 2013-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement