sidekiq-middleware 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+branches:
+  only:
+    - master
+services:
+  - redis

data/Gemfile

@@ -1,2 +1,6 @@
 source 'https://rubygems.org'
 gemspec
+
+group :test do
+  gem 'simplecov', :require => false
+end

data/README.md

@@ -1,10 +1,8 @@
-# Additional sidekiq middleware
+# Additional sidekiq middleware [![Build Status](https://secure.travis-ci.org/krasnoukhov/sidekiq-middleware.png)](http://travis-ci.org/krasnoukhov/sidekiq-middleware)
 
 This gem provides additional middleware for [Sidekiq](github.com/mperham/sidekiq/).
 
-Now it contains the following middlewares:
-
-* UniqueJobs (both client and server)
+See [Sidekiq Wiki](https://github.com/mperham/sidekiq/wiki/Middleware) for more details.
 
 ## Installation
 
@@ -20,26 +18,38 @@ Or install it yourself as:
 
     $ gem install sidekiq-middleware
 
-## Usage
-
-For example (put this code in initialize section):
-
-	Sidekiq.configure_server do |config|
-	  config.server_middleware do |chain|
-	    chain.add Sidekiq::Middleware::Server::UniqueJobs
-	  end
-	  config.client_middleware do |chain|
-	    chain.add Sidekiq::Middleware::Client::UniqueJobs
-	  end
-	end
-
-	Sidekiq.configure_client do |config|
-	  config.client_middleware do |chain|
-	    chain.add Sidekiq::Middleware::Client::UniqueJobs
-	  end
-	end
-
-See [Sidekiq Wiki](https://github.com/mperham/sidekiq/wiki/Middleware) for more details.
+## Contents
+
+### UniqueJobs
+
+Provides uniqueness for jobs.
+
+**Usage**
+
+Example worker:
+
+```ruby
+  class UniqueWorker
+    include Sidekiq::Worker
+  
+    sidekiq_options({
+      # Should be set to true (enables uniqueness for async jobs)
+      # or :all (enables uniqueness for both async and scheduled jobs)
+      unique: :all,
+  
+      # Set this to true in case your job schedules itself
+      forever: true,
+  
+      # Unique expiration (optional, default is 30 minutes)
+      # For scheduled jobs calculates automatically if not provided
+      expiration: 24 * 60 * 60
+    })
+  
+    def perform
+      # Your code goes here
+    end
+  end
+```
 
 ## Contributing
 

data/Rakefile

@@ -1,2 +1,9 @@
 #!/usr/bin/env rake
 require "bundler/gem_tasks"
+require "rake/testtask"
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+end
+
+task :default => :test

data/lib/sidekiq-middleware.rb

@@ -1,3 +1,5 @@
+require "digest"
 require "sidekiq-middleware/version"
 require "sidekiq-middleware/server/unique_jobs"
-require "sidekiq-middleware/client/unique_jobs"
+require "sidekiq-middleware/client/unique_jobs"
+require "sidekiq-middleware/middleware"

data/lib/sidekiq-middleware/client/unique_jobs.rb

@@ -1,5 +1,3 @@
-require 'digest'
-
 module Sidekiq
   module Middleware
     module Client
@@ -18,13 +16,12 @@ module Sidekiq
               payload = item.clone
               payload.delete('at')
               payload.delete('jid')
-              payload_hash = Digest::MD5.hexdigest(Sidekiq.dump_json(Hash[payload.sort]))
             else
               expiration = worker_class.get_sidekiq_options['expiration'] || HASH_KEY_EXPIRATION
               payload = item.clone
               payload.delete('jid')
-              payload_hash = Digest::MD5.hexdigest(Sidekiq.dump_json(Hash[payload.sort]))
             end
+            payload_hash = Digest::MD5.hexdigest(Sidekiq.dump_json(Hash[payload.sort]))
 
             Sidekiq.redis do |conn|
               conn.watch(payload_hash)

data/lib/sidekiq-middleware/middleware.rb

@@ -0,0 +1,14 @@
+Sidekiq.configure_server do |config|
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Middleware::Server::UniqueJobs
+  end
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Middleware::Client::UniqueJobs
+  end
+end
+
+Sidekiq.configure_client do |config|
+  config.client_middleware do |chain|
+    chain.add Sidekiq::Middleware::Client::UniqueJobs
+  end
+end

data/lib/sidekiq-middleware/server/unique_jobs.rb

@@ -25,12 +25,11 @@ module Sidekiq
             payload = item.clone
             payload.delete('at')
             payload.delete('jid')
-            payload_hash = Digest::MD5.hexdigest(Sidekiq.dump_json(Hash[payload.sort]))
           else
             payload = item.clone
             payload.delete('jid')
-            payload_hash = Digest::MD5.hexdigest(Sidekiq.dump_json(Hash[payload.sort]))
           end
+          payload_hash = Digest::MD5.hexdigest(Sidekiq.dump_json(Hash[payload.sort]))
           
           Sidekiq.redis { |conn| conn.del(payload_hash) }
         end

data/lib/sidekiq-middleware/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Middleware
-    VERSION = "0.0.1"
+    VERSION = "0.0.2"
   end
 end

data/sidekiq-middleware.gemspec

@@ -14,5 +14,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Sidekiq::Middleware::VERSION
   
-  gem.add_dependency  'sidekiq'
+  gem.add_dependency                  'sidekiq'
+  gem.add_development_dependency      'rake'
+  gem.add_development_dependency      'minitest', '~> 3'
 end

data/test/helper.rb

@@ -0,0 +1,17 @@
+ENV['RACK_ENV'] = ENV['RAILS_ENV'] = 'test'
+if ENV.has_key?('SIMPLECOV')
+  require 'simplecov'
+  SimpleCov.start
+end
+
+require 'minitest/unit'
+require 'minitest/pride'
+require 'minitest/autorun'
+
+require 'sidekiq'
+require 'sidekiq/util'
+require 'sidekiq-middleware'
+Sidekiq.logger.level = Logger::ERROR
+
+require 'sidekiq/redis_connection'
+REDIS = Sidekiq::RedisConnection.create(:url => "redis://localhost/15", :namespace => 'testy')

data/test/test_unique_jobs.rb

@@ -0,0 +1,69 @@
+require 'securerandom'
+require 'helper'
+require 'sidekiq/client'
+require 'sidekiq/worker'
+require 'sidekiq/processor'
+require 'sidekiq-middleware'
+
+class TestUniqueJobs < MiniTest::Unit::TestCase
+  describe 'with real redis' do
+    before do
+      @boss = MiniTest::Mock.new
+      @processor = ::Sidekiq::Processor.new(@boss)
+      Celluloid.logger = nil
+      
+      Sidekiq.redis = REDIS
+      Sidekiq.redis {|c| c.flushdb }
+    end
+
+    class UniqueWorker
+      include Sidekiq::Worker
+      sidekiq_options queue: :unique_queue, unique: true
+
+      def perform(x)
+      end
+    end
+
+    it 'does not duplicate messages with enabled unique option' do
+      5.times { UniqueWorker.perform_async('args') }
+      assert_equal 1, Sidekiq.redis { |c| c.llen('queue:unique_queue') }
+    end
+
+    class NotUniqueWorker
+      include Sidekiq::Worker
+      sidekiq_options queue: :not_unique_queue, unique: false
+
+      def perform(x)
+      end
+    end
+
+    it 'duplicates messages with disabled unique option' do
+      5.times { NotUniqueWorker.perform_async('args') }
+      assert_equal 5, Sidekiq.redis { |c| c.llen('queue:not_unique_queue') }
+    end
+
+    class UniqueScheduledWorker
+      include Sidekiq::Worker
+      sidekiq_options queue: :unique_scheduled_queue, unique: :all, forever: true
+
+      def perform(x)
+        UniqueScheduledWorker.perform_in(60, x)
+      end
+    end
+
+    it 'does not duplicate scheduled messages with enabled unique option' do
+      5.times { |t| UniqueScheduledWorker.perform_in((t+1)*60, 'args') }
+      assert_equal 1, Sidekiq.redis { |c| c.zrangebyscore('schedule', '-inf', '+inf').length }
+    end
+
+    it 'once schedules job in future with enabled forever option' do
+      5.times {
+        msg = Sidekiq.dump_json({ 'class' => UniqueScheduledWorker.to_s, 'args' => ['forever'] })
+        @boss.expect(:processor_done!, nil, [@processor])
+        @processor.process(msg, 'default')
+        @boss.verify
+      }
+      assert_equal 1, Sidekiq.redis { |c| c.zrangebyscore('schedule', '-inf', '+inf').length }
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq-middleware
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-21 00:00:00.000000000 Z
+date: 2012-09-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sidekiq
@@ -27,6 +27,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
 description: Additional sidekiq middleware
 email:
 - dmitry@krasnoukhov.com
@@ -35,15 +67,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - lib/sidekiq-middleware.rb
 - lib/sidekiq-middleware/client/unique_jobs.rb
+- lib/sidekiq-middleware/middleware.rb
 - lib/sidekiq-middleware/server/unique_jobs.rb
 - lib/sidekiq-middleware/version.rb
 - sidekiq-middleware.gemspec
+- test/helper.rb
+- test/test_unique_jobs.rb
 homepage: http://github.com/krasnoukhov/sidekiq-middleware
 licenses: []
 post_install_message: 
@@ -56,16 +92,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2849267342138572133
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2849267342138572133
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Additional sidekiq middleware
-test_files: []
+test_files:
+- test/helper.rb
+- test/test_unique_jobs.rb