resque-waiting-room 0.1.3

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.3-p0

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format Fuubar
+--drb

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in resque-waiting-room.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+guard 'rspec', :version => 2, :cli => "--drb --format Fuubar --color" do
+  watch('lib/resque/plugins/job.rb')
+  watch('lib/resque/plugins/waiting_room.rb')
+  watch('spec/resque/plugins/job_spec.rb')
+  watch('spec/resque/plugins/waiting_room_spec.rb')
+  watch('spec/spec_helper.rb')
+end
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) Julien Blanchard
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+Software), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED AS IS, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,28 @@
+Resque Waiting Room
+===================
+
+A [Resque][rq] plugin. Requires Resque 1.19.0.
+
+If you want to limit the number of performs of a job for a given period, extend it
+with this module.
+
+For example:
+
+    require 'resque/plugins/waiting_room'
+
+    class UpdateDataFromExternalAPI
+      extend Resque::Plugins::WaitingRoom
+
+      # This job can be performed 10 times every 30 seconds
+      can_be_performed times: 10, period: 30
+
+      def self.perform(repo_id)
+        blah
+      end
+    end
+
+If 10 UpdateDataFromExternalAPI jobs have been performed in less than
+30 seconds, next job will be placed placed in the waiting_room queue
+and processed when possible.
+
+[rq]: http://github.com/julienXX/resque

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/resque/plugins/job.rb

@@ -0,0 +1,23 @@
+module Resque
+  class Job
+    class <<self
+      alias_method :origin_reserve, :reserve
+
+      def reserve(queue)
+        if queue =~ /^waiting_room/ && Resque.size(queue) > 0
+          payload = Resque.pop(queue)
+          if payload
+            klass = constantize(payload['class'])
+            repushed_in_waiting_room = klass.repush(*payload['args'])
+
+            return new(queue, payload) unless repushed_in_waiting_room
+          end
+          return nil
+        else
+          origin_reserve(queue)
+        end
+      end
+
+    end
+  end
+end

data/lib/resque/plugins/version.rb

@@ -0,0 +1,7 @@
+module Resque
+  module Plugins
+    module WaitingRoom
+      VERSION="0.1.3"
+    end
+  end
+end

data/lib/resque/plugins/waiting_room.rb

@@ -0,0 +1,49 @@
+module Resque
+  module Plugins
+    module WaitingRoom
+      class MissingParams < RuntimeError; end
+
+      def can_be_performed(params)
+        raise MissingParams unless params.is_a?(Hash) && params.keys.sort == [:period, :times]
+
+        @period ||= params[:period]
+        @max_performs ||= params[:times].to_i
+      end
+
+      def waiting_room_redis_key
+        [self.to_s, "remaining_performs"].compact.join(":")
+      end
+
+      def before_perform_waiting_room(*args)
+        key = waiting_room_redis_key
+
+        if has_remaining_performs_key?(key)
+          performs_left = Resque.redis.decrby(key, 1).to_i
+
+          if performs_left < 1
+            Resque.push 'waiting_room', :class => self.to_s, :args => args
+            raise Resque::Job::DontPerform
+          end
+        end
+      end
+
+      def has_remaining_performs_key?(key)
+        # Redis SETNX: sets the keys if it doesn't exist, returns true if key was created
+        new_key = Resque.redis.setnx(key, @max_performs - 1)
+        Resque.redis.expire(key, @period) if new_key
+
+        return !new_key
+      end
+
+      def repush(*args)
+        key = waiting_room_redis_key
+        value = Resque.redis.get(key)
+        no_performs_left = value && value != "" && value.to_i <= 0
+        Resque.push 'waiting_room', class: self.to_s, args: args if no_performs_left
+
+        return no_performs_left
+      end
+    end
+  end
+end
+

data/lib/resque-waiting-room.rb

@@ -0,0 +1,4 @@
+require 'resque'
+require 'resque/plugins/version'
+require 'resque/plugins/job'
+require 'resque/plugins/waiting_room'

data/resque-waiting-room.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib/resque/plugins", __FILE__)
+require "version"
+
+Gem::Specification.new do |s|
+  s.name        = "resque-waiting-room"
+  s.version     = Resque::Plugins::WaitingRoom::VERSION
+  s.authors     = ["Julien Blanchard"]
+  s.email       = ["julien@sideburns.eu"]
+  s.homepage    = "https://www.github.com/julienXX/resque-waiting-room"
+  s.summary     = %q{Put your Resque jobs in a waiting room}
+  s.description = %q{Throttle your Resque jobs}
+
+  s.rubyforge_project = "resque-waiting-room"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.files         += Dir.glob("lib/**/*")
+  s.files         += Dir.glob("spec/**/*")
+
+  s.add_development_dependency 'rake', '~>0.9.2.2'
+  s.add_development_dependency 'resque', '~>1.19.0'
+  s.add_development_dependency 'rspec', '~>2.8.0'
+  s.add_development_dependency 'fuubar', '~>1.0.0'
+  s.add_development_dependency 'spork', '~>0.9.0'
+  s.add_development_dependency 'guard', '~>0.10.0'
+  s.add_development_dependency 'guard-rspec', '~>0.6.0'
+  s.add_development_dependency 'guard-spork', '~>0.3.0'
+  s.add_development_dependency 'rb-fsevent', '~>0.4.3.1'
+end

data/spec/resque/plugins/job_spec.rb

@@ -0,0 +1,41 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Resque::Job do
+  before(:each) do
+    Resque.redis.flushall
+  end
+
+  context "normal job" do
+    it "should trigger original reserve" do
+      Resque.push('normal', :class => 'DummyJob', :args => ['any args'])
+      Resque::Job.reserve('normal').should == Resque::Job.new('normal', {'class' => 'DummyJob', 'args' => ['any args']})
+      Resque::Job.reserve('waiting_room').should be_nil
+    end
+  end
+
+  context "waiting_room job" do
+    it "should push in the waiting_room queue when reserve from waiting_room queue" do
+      Resque.push('waiting_room', :class => 'DummyJob', :args => ['any args'])
+      Resque::Job.reserve('waiting_room').should == Resque::Job.new('waiting_room', {'class' => 'DummyJob', 'args' => ['any args']})
+      Resque::Job.reserve('normal').should be_nil
+    end
+
+    it "should push back to waiting_room queue when still restricted" do
+      Resque.push('waiting_room', :class => 'DummyJob', :args => ['any args'])
+      DummyJob.should_receive(:repush).with('any args')
+      Resque::Job.reserve('waiting_room').should == Resque::Job.new('waiting_room', {'class' => 'DummyJob', 'args' => ['any args']})
+      Resque::Job.reserve('waiting_room').should be_nil
+      Resque::Job.reserve('normal').should be_nil
+    end
+
+    it "should not repush when reserve normal queue" do
+      Resque.push('normal', :class => 'DummyJob', :args => ['any args'])
+      DummyJob.should_not_receive(:repush).with('any args')
+      Resque::Job.reserve('normal').should == Resque::Job.new('normal', {'class' => 'DummyJob', 'args' => ['any args']})
+      Resque::Job.reserve('normal').should be_nil
+      Resque::Job.reserve('waiting_room').should be_nil
+    end
+  end
+
+end
+

data/spec/resque/plugins/waiting_room_spec.rb

@@ -0,0 +1,118 @@
+require File.join(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe Resque::Plugins::WaitingRoom do
+  before(:each) do
+    Resque.redis.flushall
+  end
+
+  it "should validate the Resque linter" do
+    Resque::Plugin.lint(Resque::Plugins::WaitingRoom)
+  end
+
+  context "can_be_performed" do
+    it "should raise InvalidParams" do
+      expect {DummyJob.can_be_performed('lol')}.should raise_error(Resque::Plugins::WaitingRoom::MissingParams)
+    end
+
+    it "should assign @period and @max_performs" do
+      DummyJob.instance_variable_get("@period").should == 30
+      DummyJob.instance_variable_get("@max_performs").should == 10
+    end
+  end
+
+  context "waiting_room_redis_key" do
+    it "should generate a redis key name based on the class" do
+      DummyJob.waiting_room_redis_key.should == 'DummyJob:remaining_performs'
+    end
+  end
+
+  context "before_perform_waiting_room" do
+    it "should call waiting_room_redis_key" do
+      DummyJob.should_receive(:waiting_room_redis_key).and_return('DummyJob:remaining_performs')
+      DummyJob.before_perform_waiting_room('args')
+    end
+
+    it "should call has_remaining_performs_key?" do
+      DummyJob.should_receive(:has_remaining_performs_key?).and_return(false)
+      DummyJob.before_perform_waiting_room('args')
+    end
+
+    it "should decrement performs" do
+      DummyJob.before_perform_waiting_room('args')
+      Resque.redis.get("DummyJob:remaining_performs").should =="9"
+      DummyJob.before_perform_waiting_room('args')
+      Resque.redis.get("DummyJob:remaining_performs").should =="8"
+      DummyJob.before_perform_waiting_room('args')
+      Resque.redis.get("DummyJob:remaining_performs").should =="7"
+    end
+
+    it "should prevent perform once there are no performs left" do
+      9.times {DummyJob.before_perform_waiting_room('args')}
+      Resque.redis.get("DummyJob:remaining_performs").should =="1"
+      expect { DummyJob.before_perform_waiting_room('args') }.should raise_exception(Resque::Job::DontPerform)
+    end
+  end
+
+  context "has_remaining_performs_key?" do
+    it "should set a redis key" do
+      Resque.redis.should_receive(:setnx)
+      DummyJob.has_remaining_performs_key?(DummyJob.waiting_room_redis_key)
+    end
+
+    it "should expire the redis key" do
+      Resque.redis.should_receive(:setnx).and_return(true)
+      Resque.redis.should_receive(:expire)
+      DummyJob.has_remaining_performs_key?(DummyJob.waiting_room_redis_key)
+    end
+
+    it "should not re-expire the redis key if it is already created" do
+      Resque.redis.should_receive(:setnx).and_return(true)
+      Resque.redis.should_receive(:expire)
+      DummyJob.has_remaining_performs_key?(DummyJob.waiting_room_redis_key)
+      Resque.redis.should_receive(:setnx).and_return(false)
+      Resque.redis.should_not_receive(:expire)
+      DummyJob.has_remaining_performs_key?(DummyJob.waiting_room_redis_key)
+    end
+
+    it "should return false if the key is new" do
+      Resque.redis.should_receive(:setnx).and_return(true)
+      Resque.redis.should_receive(:expire)
+      DummyJob.has_remaining_performs_key?(DummyJob.waiting_room_redis_key).should == false
+    end
+
+    it "should return true if the key was already created" do
+      Resque.redis.should_receive(:setnx).and_return(false)
+      DummyJob.has_remaining_performs_key?(DummyJob.waiting_room_redis_key).should == true
+    end
+  end
+
+  context "repush" do
+    it "should call waiting_room_redis_key" do
+      DummyJob.should_receive(:waiting_room_redis_key).and_return('DummyJob:remaining_performs')
+      DummyJob.repush('args')
+    end
+
+    it "should get the key" do
+      Resque.redis.should_receive(:get).with(DummyJob.waiting_room_redis_key)
+      DummyJob.repush('args')
+    end
+
+    it "should push in the waiting_room if there are no performs left" do
+      Resque.redis.should_receive(:get).with(DummyJob.waiting_room_redis_key).and_return('0')
+      Resque.should_receive(:push).with('waiting_room', class: 'DummyJob', args: ['args']).and_return(true)
+      DummyJob.repush('args')
+    end
+
+    it "should return true if there were no performs left" do
+      Resque.redis.should_receive(:get).with(DummyJob.waiting_room_redis_key).and_return('0')
+      DummyJob.repush('args').should == true
+    end
+
+    it "should return false if there were performs left" do
+      Resque.redis.should_receive(:get).with(DummyJob.waiting_room_redis_key).and_return('1')
+      DummyJob.repush('args').should == false
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'spork'
+require 'resque'
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'resque-waiting-room'))
+
+Spork.prefork do
+  spec_dir = File.dirname(__FILE__)
+  lib_dir  = File.expand_path(File.join(spec_dir, '..', 'lib'))
+  $:.unshift(lib_dir)
+  $:.uniq!
+  RSpec.configure do |config|
+    config.mock_framework = :rspec
+  end
+
+  # Require ruby files in support dir.
+  Dir[File.expand_path('spec/support/*.rb')].each { |file| require file }
+end

data/spec/support/dummy_job.rb

@@ -0,0 +1,8 @@
+require File.join(File.dirname(__FILE__) + '/../spec_helper')
+
+class DummyJob
+  extend Resque::Plugins::WaitingRoom
+  can_be_performed times: 10, period: 30
+
+  def self.perform(*args); end
+end

metadata

@@ -0,0 +1,166 @@
+--- !ruby/object:Gem::Specification
+name: resque-waiting-room
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+  prerelease: 
+platform: ruby
+authors:
+- Julien Blanchard
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70112971736560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *70112971736560
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &70112971735960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.19.0
+  type: :development
+  prerelease: false
+  version_requirements: *70112971735960
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70112971735380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70112971735380
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: &70112971734900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *70112971734900
+- !ruby/object:Gem::Dependency
+  name: spork
+  requirement: &70112971734380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: *70112971734380
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70112971733860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: *70112971733860
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70112971733260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :development
+  prerelease: false
+  version_requirements: *70112971733260
+- !ruby/object:Gem::Dependency
+  name: guard-spork
+  requirement: &70112971732640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :development
+  prerelease: false
+  version_requirements: *70112971732640
+- !ruby/object:Gem::Dependency
+  name: rb-fsevent
+  requirement: &70112971731760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.3.1
+  type: :development
+  prerelease: false
+  version_requirements: *70112971731760
+description: Throttle your Resque jobs
+email:
+- julien@sideburns.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rbenv-version
+- .rspec
+- Gemfile
+- Guardfile
+- LICENSE
+- README.markdown
+- Rakefile
+- lib/resque-waiting-room.rb
+- lib/resque/plugins/job.rb
+- lib/resque/plugins/version.rb
+- lib/resque/plugins/waiting_room.rb
+- resque-waiting-room.gemspec
+- spec/resque/plugins/job_spec.rb
+- spec/resque/plugins/waiting_room_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_job.rb
+homepage: https://www.github.com/julienXX/resque-waiting-room
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: resque-waiting-room
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Put your Resque jobs in a waiting room
+test_files:
+- spec/resque/plugins/job_spec.rb
+- spec/resque/plugins/waiting_room_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_job.rb
+has_rdoc: