sidekiq 1.0.0 → 1.1.0

data/Changes.md

@@ -1,3 +1,30 @@
+HEAD
+-----------
+
+- The Sidekiq license has switched from GPLv3 to LGPLv3!
+- Sidekiq::Client.push now returns whether the actual Redis
+  operation succeeded or not. [#123]
+- Remove UniqueJobs from the default middleware chain.  Its
+  functionality, while useful, is unexpected for new Sidekiq
+  users.  You can re-enable it with the following config.
+  Read #119 for more discussion.
+
+```ruby
+Sidekiq.configure_client do |config|
+  require 'sidekiq/middleware/client/unique_jobs'
+  cnfig.client_middleware do |chain|
+    chain.add Sidekiq::Middleware::Client::UniqueJobs
+  end
+end
+Sidekiq.configure_server do |config|
+  require 'sidekiq/middleware/server/unique_jobs'
+  config.server_middleware do |chain|
+    chain.add Sidekiq::Middleware::Server::UniqueJobs
+  end
+end
+```
+
+
 1.0.0
 -----------
 

data/LICENSE

@@ -2,9 +2,9 @@ Copyright (c) Mike Perham
 
 You may choose to license Sidekiq in one of two ways:
 
-- Open Source under the GPLv3
+- Open Source under the LGPLv3
 
-  Please see <http://www.gnu.org/licenses/gpl-3.0.html> for license text.
+  Please see <http://www.gnu.org/licenses/lgpl-3.0.html> for license text.
 
 - Commercial License
 

data/examples/clockwork.rb

@@ -0,0 +1,44 @@
+# Sidekiq defers scheduling to other, better suited gems.
+# If you want to run a job regularly, here's an example
+# of using the 'clockwork' gem to push jobs to Sidekiq
+# regularly.
+
+# require boot & environment for a Rails app
+# require_relative "../config/boot"
+# require_relative "../config/environment"
+require "clockwork"
+
+class MyWorker
+  include Sidekiq::Worker
+
+  def perform(count)
+    puts "Job ##{count}: Late night, so tired..."
+  end
+
+  def self.late_night_work
+    10.times do |x|
+      perform_async(x)
+    end
+  end
+end
+
+class HourlyWorker
+  include Sidekiq::Worker
+
+  def perform
+    cleanup_database
+    format_hard_drive
+  end
+end
+
+module Clockwork
+  # Kick off a bunch of jobs early in the morning
+  every 1.day, 'my_worker.late_night_work', :at => '4:30 am' do
+    MyWorker.late_night_work
+  end
+
+  every 1.hour do
+    HourlyWorker.perform_async
+  end
+end
+

data/examples/config.yml

@@ -2,8 +2,9 @@
 # Options here can still be overridden by cmd line args.
 #   sidekiq -C config.yml
 ---
-:verbose:      false
+:verbose: false
 :concurrency:  25
 :queues:
   - [often, 7]
+  - [default, 5]
   - [seldom, 3]

data/lib/sidekiq/client.rb

@@ -8,7 +8,6 @@ module Sidekiq
 
     def self.default_middleware
       Middleware::Chain.new do |m|
-        m.add Middleware::Client::UniqueJobs
       end
     end
 
@@ -41,14 +40,13 @@ module Sidekiq
       Sidekiq.client_middleware.invoke(worker_class, item, queue) do
         payload = MultiJson.encode(item)
         Sidekiq.redis do |conn|
-          conn.multi do
+          _, pushed = conn.multi do
             conn.sadd('queues', queue)
             conn.rpush("queue:#{queue}", payload)
           end
         end
-        pushed = true
       end
-      pushed
+      !! pushed
     end
 
     # Redis compatibility helper.  Example usage:

data/lib/sidekiq/processor.rb

@@ -3,7 +3,6 @@ require 'sidekiq/util'
 
 require 'sidekiq/middleware/server/active_record'
 require 'sidekiq/middleware/server/exception_handler'
-require 'sidekiq/middleware/server/unique_jobs'
 require 'sidekiq/middleware/server/retry_jobs'
 require 'sidekiq/middleware/server/logging'
 
@@ -16,7 +15,6 @@ module Sidekiq
       Middleware::Chain.new do |m|
         m.add Middleware::Server::ExceptionHandler
         m.add Middleware::Server::Logging
-        m.add Middleware::Server::UniqueJobs
         m.add Middleware::Server::RetryJobs
         m.add Middleware::Server::ActiveRecord
       end

data/lib/sidekiq/version.rb

@@ -1,3 +1,3 @@
 module Sidekiq
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/test/test_client.rb

@@ -15,12 +15,18 @@ class TestClient < MiniTest::Unit::TestCase
     end
 
     it 'does not push duplicate messages when configured for unique only' do
+      Sidekiq.client_middleware do |chain|
+        chain.add Sidekiq::Middleware::Client::UniqueJobs
+      end
       QueueWorker.sidekiq_options :unique => true
       10.times { Sidekiq::Client.push('class' => QueueWorker, 'args' => [1, 2]) }
       assert_equal 1, Sidekiq.redis {|c| c.llen("queue:customqueue") }
     end
 
     it 'does push duplicate messages when not configured for unique only' do
+      Sidekiq.client_middleware do |chain|
+        chain.add Sidekiq::Middleware::Client::UniqueJobs
+      end
       QueueWorker.sidekiq_options :unique => false
       10.times { Sidekiq::Client.push('class' => QueueWorker, 'args' => [1, 2]) }
       assert_equal 10, Sidekiq.redis {|c| c.llen("queue:customqueue") }
@@ -30,7 +36,7 @@ class TestClient < MiniTest::Unit::TestCase
   describe 'with mock redis' do
     before do
       @redis = MiniTest::Mock.new
-      def @redis.multi; yield if block_given?; end
+      def @redis.multi; [yield] * 2 if block_given?; end
       def @redis.set(*); true; end
       def @redis.sadd(*); true; end
       def @redis.srem(*); true; end
@@ -74,6 +80,13 @@ class TestClient < MiniTest::Unit::TestCase
       @redis.verify
     end
 
+    it 'handles perform_async on failure' do
+      @redis.expect :rpush, nil, ['queue:default', String]
+      pushed = MyWorker.perform_async(1, 2)
+      refute pushed
+      @redis.verify
+    end
+
     it 'enqueues messages to redis' do
       @redis.expect :rpush, 1, ['queue:default', String]
       pushed = Sidekiq::Client.enqueue(MyWorker, 1, 2)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-10 00:00:00.000000000 Z
+date: 2012-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
-  requirement: &70330798429280 !ruby/object:Gem::Requirement
+  requirement: &70154555190180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70330798429280
+  version_requirements: *70154555190180
 - !ruby/object:Gem::Dependency
   name: redis-namespace
-  requirement: &70330798428820 !ruby/object:Gem::Requirement
+  requirement: &70154555189740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70330798428820
+  version_requirements: *70154555189740
 - !ruby/object:Gem::Dependency
   name: connection_pool
-  requirement: &70330798428040 !ruby/object:Gem::Requirement
+  requirement: &70154555189240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.9.0
   type: :runtime
   prerelease: false
-  version_requirements: *70330798428040
+  version_requirements: *70154555189240
 - !ruby/object:Gem::Dependency
   name: celluloid
-  requirement: &70330798427300 !ruby/object:Gem::Requirement
+  requirement: &70154555188740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 0.10.0
   type: :runtime
   prerelease: false
-  version_requirements: *70330798427300
+  version_requirements: *70154555188740
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70330798426740 !ruby/object:Gem::Requirement
+  requirement: &70154555188360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70330798426740
+  version_requirements: *70154555188360
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70330798426000 !ruby/object:Gem::Requirement
+  requirement: &70154555204260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70330798426000
+  version_requirements: *70154555204260
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &70330798425580 !ruby/object:Gem::Requirement
+  requirement: &70154555203840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70330798425580
+  version_requirements: *70154555203840
 - !ruby/object:Gem::Dependency
   name: slim
-  requirement: &70330798425160 !ruby/object:Gem::Requirement
+  requirement: &70154555203420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70330798425160
+  version_requirements: *70154555203420
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70330798424740 !ruby/object:Gem::Requirement
+  requirement: &70154555203000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -109,10 +109,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70330798424740
+  version_requirements: *70154555203000
 - !ruby/object:Gem::Dependency
   name: actionmailer
-  requirement: &70330798424140 !ruby/object:Gem::Requirement
+  requirement: &70154555202500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: '3'
   type: :development
   prerelease: false
-  version_requirements: *70330798424140
+  version_requirements: *70154555202500
 - !ruby/object:Gem::Dependency
   name: activerecord
-  requirement: &70330798439980 !ruby/object:Gem::Requirement
+  requirement: &70154555202000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,7 +131,7 @@ dependencies:
         version: '3'
   type: :development
   prerelease: false
-  version_requirements: *70330798439980
+  version_requirements: *70154555202000
 description: Simple, efficient message processing for Ruby
 email:
 - mperham@gmail.com
@@ -158,6 +158,7 @@ files:
 - examples/chef/cookbooks/sidekiq/templates/default/monitrc.conf.erb
 - examples/chef/cookbooks/sidekiq/templates/default/sidekiq.erb
 - examples/chef/cookbooks/sidekiq/templates/default/sidekiq.yml.erb
+- examples/clockwork.rb
 - examples/config.yml
 - examples/monitrc.conf
 - examples/por.rb