resque-restriction 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+spec/dump.rdb

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Richard Huang (flyerhzm@gmail.com)
+
+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,49 @@
+resque-restriction
+===============
+
+Resque Restriction is a plugin for the [Resque][0] queueing system (http://github.com/defunkt/resque). It adds two functions:
+
+1. it will limit the execution number of certain jobs in a period time. For example, it can limit a certain job can be executed 1000 times per day, 100 time per hour and 30 times per 300 seconds.
+
+2. it will execute the exceeded jobs at the next period. For example, you restrict the email sending jobs to run 1000 times per day. If your system generates 1010 email sending jobs, only 1000 email sending jobs can be executed today, and the other 10 email sending jobs will be executed tomorrow.
+
+Resque Restriction requires Resque 1.7.0.
+
+To use
+------
+
+The job you wish to restrict should inherit from Resque::Plugins::RestrictionJob class and add restrict definition. Example:
+
+	class MyRestrictionJob < Resque::Plugins::RestrictionJob
+	  restrict :per_day => 1000, :per_hour => 1000, :per_300 => 30
+
+	  #rest of your class here
+	end
+
+MyRestrictionJob can be run 1000 times per day, 100 times per hour and 30 times per 300 seconds.
+
+The argument of restrict method is a hash, the key of the hash is a period time, including :per_minute, :per_hour, :per_day, :per_week, :per_month, :per_year, and you can also define any period like :per_300 means per 300 seconds. the value of the hash is the job execution limit number in a period.
+
+Contributing
+------------
+
+Once you've made your commits:
+
+1. [Fork][1] Resque Restriction
+2. Create a topic branch - `git checkout -b my_branch`
+3. Push to your branch - `git push origin my_branch`
+4. Create an [Issue][2] with a link to your branch
+5. That's it!
+
+Author
+------
+Richard Huang :: flyerhzm@gmail.com :: @flyerhzm
+
+Copyright
+---------
+Copyright (c) 2010 Richard Huang. See LICENSE for details.
+
+[0]: http://github.com/defunkt/resque
+[1]: http://help.github.com/forking/
+[2]: http://github.com/flyerhzm/resque-restriction/issues
+

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rake'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+
+desc 'Default: run unit tests.'
+task :default => :spec
+
+desc 'Generate documentation for the resque-restriction plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'resque_restriction'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "resque-restriction"
+    gemspec.summary = "resque-restriction is an extension to resque queue system that restricts the execution number of certain jobs in a period time."
+    gemspec.description = "resque-restriction is an extension to resque queue system that restricts the execution number of certain jobs in a period time, the exceeded jobs will be executed at the next period."
+    gemspec.email = "flyerhzm@gmail.com"
+    gemspec.homepage = "http://github.com/flyerhzm/resque-restriction"
+    gemspec.authors = ["Richard Huang"]
+    gemspec.add_dependency "resque", ">=1.7.0"
+  end
+  Jeweler::GemcutterTasks.new
+rescue
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__) + '/rails/init')

data/lib/resque-restriction/job.rb

@@ -0,0 +1,15 @@
+module Resque
+  class Job
+    class <<self
+      alias_method :origin_reserve, :reserve
+      
+      def reserve(queue)
+        if queue == 'restriction' && payload = Resque.peek(queue)
+          constantize(payload['class']).repush
+          return
+        end
+        origin_reserve(queue)
+      end
+    end
+  end
+end

data/lib/resque-restriction/restriction_job.rb

@@ -0,0 +1,86 @@
+module Resque
+  module Plugins
+    class RestrictionJob
+      SECONDS = {
+        :per_minute => 60,
+        :per_hour => 60*60,
+        :per_day => 24*60*60,
+        :per_week => 7*24*60*60,
+        :per_month => 31*24*60*60,
+        :per_year => 366*24*60*60
+      }
+
+      class <<self
+        def settings
+          @options ||= {}
+        end
+
+        def restrict(options={})
+          settings.merge!(options)
+        end
+        
+        def before_perform_restriction(*args)
+          settings.each do |period, number|
+            key = redis_key(period)
+            value = get_restrict(key)
+
+            if value.nil? or value == ""
+              set_restrict(key, seconds(period), number)
+            elsif value.to_i <= 0
+              Resque.push "restriction", :class => to_s, :args => args
+              raise Resque::Job::DontPerform
+            end
+          end
+        end
+        
+        def after_perform_restriction(*args)
+          settings.each do |period, number|
+            key = redis_key(period)
+            Resque.redis.decrby(key, 1)
+          end
+        end
+
+        def redis_key(period)
+          period_str = case period
+                       when :per_minute, :per_hour, :per_day, :per_week then (Time.now.to_i / SECONDS[period]).to_s
+                       when :per_month then Date.today.strftime("%Y-%m")
+                       when :per_year then Date.today.year.to_s
+                       else period.to_s =~ /^per_(\d+)$/ and (Time.now.to_i / $1.to_i).to_s end
+          [self.to_s, period_str].compact.join(":")
+        end
+
+        def seconds(period)
+          if SECONDS.keys.include? period
+            SECONDS[period]
+          else
+            period.to_s =~ /^per_(\d+)$/ and $1
+          end
+        end
+
+        def repush
+          settings.each do |period, number|
+            key = redis_key(period)
+            value = get_restrict(key)
+            queue_name = Resque.queue_from_class(self)
+            if value.nil? or value == ""
+              Resque.redis.rpoplpush('queue:restriction', "queue:#{queue_name}")
+            end
+          end
+        end
+
+        private
+          # after operation incrby - expire, then decrby will reset the value to 0 first
+          # use operation set - expire - incrby instead
+          def set_restrict(key, seconds, number)
+            Resque.redis.set(key, '')
+            Resque.redis.expire(key, seconds)
+            Resque.redis.incrby(key, number)
+          end
+
+          def get_restrict(key)
+            Resque.redis.get(key)
+          end
+      end
+    end
+  end
+end

data/lib/resque-restriction.rb

@@ -0,0 +1,3 @@
+require 'resque'
+require 'resque-restriction/job'
+require 'resque-restriction/restriction_job'

data/rails/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__) + '/../lib/resque-restriction')

data/spec/redis-test.conf

@@ -0,0 +1,132 @@
+# Redis configuration file example
+
+# By default Redis does not run as a daemon. Use 'yes' if you need it.
+# Note that Redis will write a pid file in /var/run/redis.pid when daemonized.
+daemonize yes
+
+# When run as a daemon, Redis write a pid file in /var/run/redis.pid by default.
+# You can specify a custom pid file location here.
+pidfile ./spec/redis-test.pid
+
+# Accept connections on the specified port, default is 6379
+port 9736
+
+# If you want you can bind a single interface, if the bind option is not
+# specified all the interfaces will listen for connections.
+#
+# bind 127.0.0.1
+
+# Close the connection after a client is idle for N seconds (0 to disable)
+timeout 300
+
+# Save the DB on disk:
+#
+#   save <seconds> <changes>
+#
+#   Will save the DB if both the given number of seconds and the given
+#   number of write operations against the DB occurred.
+#
+#   In the example below the behaviour will be to save:
+#   after 900 sec (15 min) if at least 1 key changed
+#   after 300 sec (5 min) if at least 10 keys changed
+#   after 60 sec if at least 10000 keys changed
+save 900 1
+save 300 10
+save 60 10000
+
+# The filename where to dump the DB
+dbfilename dump.rdb
+
+# For default save/load DB in/from the working directory
+# Note that you must specify a directory not a file name.
+dir ./spec/
+
+# Set server verbosity to 'debug'
+# it can be one of:
+# debug (a lot of information, useful for development/testing)
+# notice (moderately verbose, what you want in production probably)
+# warning (only very important / critical messages are logged)
+loglevel debug
+
+# Specify the log file name. Also 'stdout' can be used to force
+# the demon to log on the standard output. Note that if you use standard
+# output for logging but daemonize, logs will be sent to /dev/null
+logfile stdout
+
+# Set the number of databases. The default database is DB 0, you can select
+# a different one on a per-connection basis using SELECT <dbid> where
+# dbid is a number between 0 and 'databases'-1
+databases 16
+
+################################# REPLICATION #################################
+
+# Master-Slave replication. Use slaveof to make a Redis instance a copy of
+# another Redis server. Note that the configuration is local to the slave
+# so for example it is possible to configure the slave to save the DB with a
+# different interval, or to listen to another port, and so on.
+
+# slaveof <masterip> <masterport>
+
+################################## SECURITY ###################################
+
+# Require clients to issue AUTH <PASSWORD> before processing any other
+# commands.  This might be useful in environments in which you do not trust
+# others with access to the host running redis-server.
+#
+# This should stay commented out for backward compatibility and because most
+# people do not need auth (e.g. they run their own servers).
+
+# requirepass foobared
+
+################################### LIMITS ####################################
+
+# Set the max number of connected clients at the same time. By default there
+# is no limit, and it's up to the number of file descriptors the Redis process
+# is able to open. The special value '0' means no limts.
+# Once the limit is reached Redis will close all the new connections sending
+# an error 'max number of clients reached'.
+
+# maxclients 128
+
+# Don't use more memory than the specified amount of bytes.
+# When the memory limit is reached Redis will try to remove keys with an
+# EXPIRE set. It will try to start freeing keys that are going to expire
+# in little time and preserve keys with a longer time to live.
+# Redis will also try to remove objects from free lists if possible.
+#
+# If all this fails, Redis will start to reply with errors to commands
+# that will use more memory, like SET, LPUSH, and so on, and will continue
+# to reply to most read-only commands like GET.
+#
+# WARNING: maxmemory can be a good idea mainly if you want to use Redis as a
+# 'state' server or cache, not as a real DB. When Redis is used as a real
+# database the memory usage will grow over the weeks, it will be obvious if
+# it is going to use too much memory in the long run, and you'll have the time
+# to upgrade. With maxmemory after the limit is reached you'll start to get
+# errors for write operations, and this may even lead to DB inconsistency.
+
+# maxmemory <bytes>
+
+############################### ADVANCED CONFIG ###############################
+
+# Glue small output buffers together in order to send small replies in a
+# single TCP packet. Uses a bit more CPU but most of the times it is a win
+# in terms of number of queries per second. Use 'yes' if unsure.
+glueoutputbuf yes
+
+# Use object sharing. Can save a lot of memory if you have many common
+# string in your dataset, but performs lookups against the shared objects
+# pool so it uses more CPU and can be a bit slower. Usually it's a good
+# idea.
+#
+# When object sharing is enabled (shareobjects yes) you can use
+# shareobjectspoolsize to control the size of the pool used in order to try
+# object sharing. A bigger pool size will lead to better sharing capabilities.
+# In general you want this value to be at least the double of the number of
+# very common strings you have in your dataset.
+#
+# WARNING: object sharing is experimental, don't enable this feature
+# in production before of Redis 1.0-stable. Still please try this feature in
+# your development environment so that we can test it better.
+#shareobjects no
+#shareobjectspoolsize 1024

data/spec/resque-restriction/job_spec.rb

@@ -0,0 +1,17 @@
+require File.join(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Resque::Job do
+  it "should repush restrictioin queue when reserve" do
+    Resque.redis.flushall
+    Resque.push('restriction', :class => 'OneHourRestrictionJob', :args => 'any args')
+    Resque::Job.reserve('restriction').should be_nil
+    Resque::Job.reserve('normal').should == Resque::Job.new('normal', {'class' => 'OneHourRestrictionJob', 'args' => 'any args'})
+    Resque::Job.reserve('normal').should be_nil
+  end
+
+  it "should not repush when reserve normal queue" do
+    Resque.push('normal', :class => 'OneHourRestrictionJob', :args => 'any args')
+    Resque::Job.reserve('normal').should == Resque::Job.new('normal', {'class' => 'OneHourRestrictionJob', 'args' => 'any args'})
+    Resque::Job.reserve('normal').should be_nil
+  end
+end

data/spec/resque-restriction/restriction_job_spec.rb

@@ -0,0 +1,83 @@
+require File.join(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Resque::Plugins::RestrictionJob do
+  it "should follow the convention" do
+    Resque::Plugin.lint(Resque::Plugins::RestrictionJob)
+  end
+
+  context "redis_key" do
+    it "should get redis_key with different period" do
+      Resque::Plugins::RestrictionJob.redis_key(:per_minute).should == "Resque::Plugins::RestrictionJob:#{Time.now.to_i / 60}"
+      Resque::Plugins::RestrictionJob.redis_key(:per_hour).should == "Resque::Plugins::RestrictionJob:#{Time.now.to_i / (60*60)}"
+      Resque::Plugins::RestrictionJob.redis_key(:per_day).should == "Resque::Plugins::RestrictionJob:#{Time.now.to_i / (24*60*60)}"
+      Resque::Plugins::RestrictionJob.redis_key(:per_month).should == "Resque::Plugins::RestrictionJob:#{Date.today.strftime("%Y-%m")}"
+      Resque::Plugins::RestrictionJob.redis_key(:per_year).should == "Resque::Plugins::RestrictionJob:#{Date.today.year}"
+    end
+
+    it "should accept customization" do
+      Resque::Plugins::RestrictionJob.redis_key(:per_1800).should == "Resque::Plugins::RestrictionJob:#{Time.now.to_i / 1800}"
+      Resque::Plugins::RestrictionJob.redis_key(:per_7200).should == "Resque::Plugins::RestrictionJob:#{Time.now.to_i / 7200}"
+    end
+  end
+  
+  context "settings" do
+    it "get correct number to restriction jobs" do
+      OneDayRestrictionJob.settings.should == {:per_day => 100}
+      OneHourRestrictionJob.settings.should == {:per_hour => 10}
+      MultipleRestrictionJob.settings.should == {:per_hour => 10, :per_300 => 2}
+      MultiCallRestrictionJob.settings.should == {:per_hour => 10, :per_300 => 2}
+    end
+  end
+  
+  context "resque" do
+    include PerformJob
+
+    before(:each) do
+      Resque.redis.flushall
+    end
+    
+    it "should set execution number and decrement it when one job first executed" do
+      result = perform_job(OneHourRestrictionJob, "any args")
+      result.should be_true
+      Resque.redis.get(OneHourRestrictionJob.redis_key(:per_hour)).should == "9"
+    end
+
+    it "should decrement execution number when one job executed" do
+      Resque.redis.set(OneHourRestrictionJob.redis_key(:per_hour), 6)
+      result = perform_job(OneHourRestrictionJob, "any args")
+      result.should be_true
+      Resque.redis.get(OneHourRestrictionJob.redis_key(:per_hour)).should == "5"
+    end
+
+    it "should put the job into restriction queue when execution count <= 0" do
+      Resque.redis.set(OneHourRestrictionJob.redis_key(:per_hour), 0)
+      result = perform_job(OneHourRestrictionJob, "any args")
+      result.should_not be_true
+      Resque.redis.get(OneHourRestrictionJob.redis_key(:per_hour)).should == "0"
+      Resque.redis.lrange("queue:restriction", 0, -1).should == [Resque.encode(:class => "OneHourRestrictionJob", :args => ["any args"])]
+    end
+
+    context "multiple restrict" do
+      it "should restrict per_minute" do
+        result = perform_job(MultipleRestrictionJob, "any args")
+        Resque.redis.get(MultipleRestrictionJob.redis_key(:per_hour)).should == "9"
+        Resque.redis.get(MultipleRestrictionJob.redis_key(:per_300)).should == "1"
+        result = perform_job(MultipleRestrictionJob, "any args")
+        result = perform_job(MultipleRestrictionJob, "any args")
+        Resque.redis.get(MultipleRestrictionJob.redis_key(:per_hour)).should == "8"
+        Resque.redis.get(MultipleRestrictionJob.redis_key(:per_300)).should == "0"
+      end
+
+      it "should restrict per_hour" do
+        Resque.redis.set(MultipleRestrictionJob.redis_key(:per_hour), 1)
+        Resque.redis.set(MultipleRestrictionJob.redis_key(:per_300), 2)
+        result = perform_job(MultipleRestrictionJob, "any args")
+        Resque.redis.get(MultipleRestrictionJob.redis_key(:per_hour)).should == "0"
+        Resque.redis.get(MultipleRestrictionJob.redis_key(:per_300)).should == "1"
+        result = perform_job(MultipleRestrictionJob, "any args")
+        Resque.redis.get(MultipleRestrictionJob.redis_key(:per_hour)).should == "0"
+        Resque.redis.get(MultipleRestrictionJob.redis_key(:per_300)).should == "1"
+      end
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,8 @@
+--colour
+--format
+specdoc
+--reverse
+--timeout
+20
+--loadby
+mtime

data/spec/spec_helper.rb

@@ -0,0 +1,86 @@
+require 'rubygems'
+require 'spec/autorun'
+require 'mocha'
+
+dir = File.dirname(__FILE__)
+$LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__) + "/../lib"))
+require 'resque-restriction'
+
+#
+# make sure we can run redis
+#
+
+if !system("which redis-server")
+  puts '', "** can't find `redis-server` in your path"
+  puts "** try running `sudo rake install`"
+  abort ''
+end
+
+
+#
+# start our own redis when the tests start,
+# kill it when they end
+#
+
+at_exit do
+  next if $!
+
+  exit_code = Spec::Runner.run
+
+  pid = `ps -e -o pid,command | grep [r]edis-test`.split(" ")[0]
+  puts "Killing test redis server..."
+  `rm -f #{dir}/dump.rdb`
+  Process.kill("KILL", pid.to_i)
+  exit exit_code
+end
+
+puts "Starting redis for testing at localhost:9736..."
+`redis-server #{dir}/redis-test.conf`
+Resque.redis = 'localhost:9736'
+
+##
+# Helper to perform job classes
+#
+module PerformJob
+  def perform_job(klass, *args)
+    resque_job = Resque::Job.new(:testqueue, 'class' => klass, 'args' => args)
+    resque_job.perform
+  end
+end
+
+class OneDayRestrictionJob < Resque::Plugins::RestrictionJob
+  restrict :per_day => 100
+
+  @queue = 'normal'
+  
+  def self.perform(args)
+  end
+end
+
+class OneHourRestrictionJob < Resque::Plugins::RestrictionJob
+  restrict :per_hour => 10
+
+  @queue = 'normal'
+
+  def self.perform(args)
+  end
+end
+
+class MultipleRestrictionJob < Resque::Plugins::RestrictionJob
+  restrict :per_hour => 10, :per_300 => 2
+
+  @queue = 'normal'
+
+  def self.perform(args)
+  end
+end
+
+class MultiCallRestrictionJob < Resque::Plugins::RestrictionJob
+  restrict :per_hour => 10
+  restrict :per_300 => 2
+
+  @queue = 'normal'
+
+  def self.perform(args)
+  end
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: resque-restriction
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Richard Huang
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-30 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: resque
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
+description: resque-restriction is an extension to resque queue system that restricts the execution number of certain jobs in a period time, the exceeded jobs will be executed at the next period.
+email: flyerhzm@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- init.rb
+- lib/resque-restriction.rb
+- lib/resque-restriction/job.rb
+- lib/resque-restriction/restriction_job.rb
+- rails/init.rb
+- spec/redis-test.conf
+- spec/resque-restriction/job_spec.rb
+- spec/resque-restriction/restriction_job_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/flyerhzm/resque-restriction
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: resque-restriction is an extension to resque queue system that restricts the execution number of certain jobs in a period time.
+test_files: 
+- spec/resque-restriction/job_spec.rb
+- spec/resque-restriction/restriction_job_spec.rb
+- spec/spec_helper.rb