resque_sliding_window 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in resque_sliding_window.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jon Phenow
+
+MIT License
+
+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.md

@@ -0,0 +1,70 @@
+# ResqueSlidingWindow
+
+Want a sliding window for debouncing bursty Resque events? Here it is.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'resque_sliding_window'
+gem 'resque-scheduler', require: 'resque_scheduler', git: "https://github.com/jonhyman/resque-scheduler.git" # prefered repo
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Usage
+
+```ruby
+module Jobs
+  class Publish
+    extend Resque::Plugins::SlidingWindow
+
+    @queue = :low
+
+    def self.perform(id)
+      # Crazy stuff
+    end
+  end
+end
+
+Resque.enqueue_in(30, Jobs::Publish, id)
+```
+
+This will put a job in a delayed queue for 30 seconds. If a similar job is entered (same args, same klass),
+it will be deleted in favor of the new 30-second job. However, it can only be
+pushed off for a 1m 30s from its initial queue-time before it force runs one. When it forces
+one through, others will not be run.
+
+Default `max_time` is 1m and 30s. To change this:
+
+```ruby
+module Jobs
+  class Publish
+    extend Resque::Plugins::SlidingWindow
+
+    @queue = :low
+
+    def self.max_time
+      30.minutes
+    end
+
+    def self.perform(id)
+      # Crazy stuff
+    end
+  end
+end
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/resque/plugins/sliding_window.rb

@@ -0,0 +1,13 @@
+module Resque
+  module Plugins
+    module SlidingWindow
+      def before_schedule_sliding_window(*args)
+        ResqueSlidingWindow::WindowSlider.new(self, args).slide
+      end
+
+      def after_perform_sliding_window(*args)
+        ResqueSlidingWindow::WindowSlider.new(self, args).close
+      end
+    end
+  end
+end

data/lib/resque_sliding_window.rb

@@ -0,0 +1,4 @@
+require "resque_sliding_window/version"
+require "resque_sliding_window/window_slider"
+require "resque_sliding_window/resque_extensions"
+require "resque/plugins/sliding_window"

data/lib/resque_sliding_window/resque_extensions.rb

@@ -0,0 +1,35 @@
+require 'resque'
+require 'resque_scheduler'
+require 'resque/scheduler'
+module ResqueSlidingWindow
+  module SchedulerPatches
+    def self.extended(base)
+      class << base
+        alias_method :delayed_timestamp_peek_without_rescue, :delayed_timestamp_peek
+        alias_method :delayed_timestamp_peek, :delayed_timestamp_peek_with_rescue
+      end
+    end
+
+    def next_item_for_timestamp(timestamp)
+      key = "delayed:#{timestamp.to_i}"
+
+      item = patched_decode redis.lpop(key)
+
+      # If the list is empty, remove it.
+      clean_up_timestamp(key, timestamp)
+      item
+    end
+
+    def delayed_timestamp_peek_with_rescue(timestamp, start, count)
+      delayed_timestamp_peek_without_rescue timestamp, start, count
+    rescue Resque::Helpers::DecodeException => e
+      []
+    end
+
+    def patched_decode(payload)
+      decode payload
+    rescue Exception => e
+    end
+  end
+end
+Resque.extend ResqueSlidingWindow::SchedulerPatches

data/lib/resque_sliding_window/version.rb

@@ -0,0 +1,3 @@
+module ResqueSlidingWindow
+  VERSION = "0.0.1"
+end

data/lib/resque_sliding_window/window_slider.rb

@@ -0,0 +1,119 @@
+module ResqueSlidingWindow
+  class WindowSlider
+    extend Forwardable
+
+    attr_accessor :klass
+    attr_accessor :args
+
+    def_delegators :Resque, :job_to_hash, :encode, :redis, :remove_delayed_job_from_timestamp
+
+    def initialize(klass, args)
+      self.klass = klass
+      self.args = args
+    end
+
+    def slide
+      if first?
+        mark_first
+      elsif should_requeue?
+        requeue
+      else
+        false
+      end
+    end
+
+    def close
+      redis.del(slide_key)
+    end
+
+    private
+
+    def first?
+      !on_queue?
+    end
+
+    def mark_first
+      mark_time
+    end
+
+    def requeue
+      matching_delayed.each do |key, _|
+        remove_delayed_job_from_timestamp(key_to_timestamp(key), klass, *args)
+      end
+      true
+    end
+
+    def should_requeue?
+      !maxed_out?
+    end
+
+    def matching_delayed
+      delayed_key_values.select { |_, value| value == search }
+    end
+
+    def search
+      encode(job_to_hash klass, args)
+    end
+
+    def on_queue?
+      matching_delayed.count > 0
+    end
+
+    def max_time
+      klass.respond_to?(:max_time) ? klass.public_send(:max_time) : 1.minute
+    end
+
+    def maxed_out?
+      (redis.get(slide_key).to_i + max_time) <= Time.now.utc.to_i
+    end
+
+    def slide_key
+      "sliding:#{klass.name}:#{keyify(args)}:count"
+    end
+
+    def mark_time
+      redis.set(slide_key, Time.now.utc.to_i)
+    end
+
+    def keyify(args)
+      "(#{args.map { |arg|
+        if arg.is_a?(Array)
+          keyify(arg)
+        elsif arg.respond_to?(:to_a) && !(arg.is_a?(String) || arg.is_a?(Symbol) || arg.is_a?(Numeric))
+          keyify(arg.to_a)
+        else
+          if arg.respond_to?(:to_key)
+            arg.to_key
+          else
+            arg.to_s
+          end
+        end
+      }.join(",").gsub(/\s/,"")})"
+    end
+
+    def key_to_timestamp(key)
+      key.to_s.gsub(/delayed:/, "").to_i
+    end
+
+    def timestamp_to_key(timestamp)
+      "delayed:#{timestamp}"
+    end
+
+    def delayed_timestamps
+      redis.zrange(:delayed_queue_schedule, 0,-1)
+    end
+
+    def get(key)
+      redis.rpop(key).tap { |val|
+        redis.rpush(key, val)
+      }
+    end
+
+    def delayed_key_values
+      delayed_timestamps.inject({}) do |hash, timestamp|
+        hash[timestamp_to_key(timestamp)] = get(timestamp_to_key(timestamp))
+        hash
+      end
+    end
+  end
+end

data/resque_sliding_window.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resque_sliding_window/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "resque_sliding_window"
+  spec.version       = ResqueSlidingWindow::VERSION
+  spec.authors       = ["Jon Phenow"]
+  spec.email         = ["j.phenow@gmail.com"]
+  spec.description   = %q{Sliding Window unique-job workflow for Resque jobs}
+  spec.summary       = %q{Sliding Window unique-job workflow for Resque jobs}
+  spec.homepage      = "https://github.com/sportngin/resque_sliding_window"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'resque', '~> 1.21'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: resque_sliding_window
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jon Phenow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rake
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: resque
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  prerelease: false
+description: Sliding Window unique-job workflow for Resque jobs
+email:
+- j.phenow@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/resque/plugins/sliding_window.rb
+- lib/resque_sliding_window.rb
+- lib/resque_sliding_window/resque_extensions.rb
+- lib/resque_sliding_window/version.rb
+- lib/resque_sliding_window/window_slider.rb
+- resque_sliding_window.gemspec
+homepage: https://github.com/sportngin/resque_sliding_window
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: '0'
+      hash: -1390516187519382713
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      version: '0'
+      hash: -1390516187519382713
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Sliding Window unique-job workflow for Resque jobs
+test_files: []