resque-approval 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+Gemfile.lock
+.rvmrc
+spec/tmp

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Earle Clubb
+
+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,100 @@
+# resque-approval
+
+A Resque plugin allowing jobs to be sent to a temporary queue to await approval.
+Once the job is approved, it is placed on its normal queue.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'resque-approval'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install resque-approval
+
+## Usage
+
+To enable approval holding for a job class, simply extend that class with
+Resque::Plugins::Approval, like so:
+
+```ruby
+class Job
+  extend Resque::Plugins::Approval
+
+  @queue = 'dummy'
+
+  def self.perform
+    # ...
+  end
+end
+```
+
+Then, when you want to queue up a job of that class, add a couple special
+arguments to your job:
+
+```ruby
+Resque.enqueue(Job, :requires_approval => true, :approval_message => 'Test')
+```
+
+`:requires_approval` tells resque-approval to put your job in a special queue to
+wait for approval.  If its missing or false, your job is placed in its default
+queue.
+
+`:approval_message` is an optional message you can reference later.
+
+To get a list of pending jobs:
+```ruby
+Resque::Plugins::Approval.pending_job_keys
+```
+This will return a list in first-in, first-out order.  Each entry contains an id
+and any message you may have specified when enqueueing the job.
+
+To approve a job:
+```ruby
+Job.approve(key)
+```
+where key is an entry from the list returned by pending_job_keys.  This will
+move the job from the approval_required queue to the default queue for that job.
+
+To reject a job:
+```ruby
+Job.reject(key)
+```
+This will delete the job from the approval_required queue, but will not move it
+to the job's default queue.  This effectively drops the job from the system.
+
+## Example
+
+A sample session using the Job class above might look like this:
+
+```ruby
+# Queue up a job with a message.
+Resque.enqueue(Job, :requires_approval => true, :approval_message => 'Just a test')
+
+# Queue up a job without a message.
+Resque.enqueue(Job, :requires_approval => true)
+
+# List the ids and messages.
+pending_actions = Resque::Plugins::Approval.pending_job_keys
+pending_actions.each do |action|
+  puts "id: #{action['id'], message: #{action['approval_message']}"
+end
+
+# Approve the first job...
+Job.approve(pending_actions[0])
+
+# But reject the second
+Job.reject(pending_actions[1])
+```
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec
+
+desc 'Run guard'
+task :guard do
+  sh %{ bundle exec guard --notify false}
+end

data/lib/resque-approval.rb

@@ -0,0 +1,72 @@
+require 'resque-approval/version'
+require 'resque'
+
+module Resque
+  module Plugins
+    module Approval
+      def self.pending_job_keys
+        keys = Resque.redis.hkeys('pending_jobs')
+        keys.map! { |key| JSON.parse(key) }
+        keys.sort! { |a, b| a['id'] <=> b['id'] }
+      end
+
+      def before_enqueue_approval(*args)
+        args = args[0] || {}
+
+        requires_approval = args.delete(:requires_approval) || args.delete('requires_approval')
+        if requires_approval
+          enqueue_for_approval(args)
+          allow_enqueue = false
+        else
+          allow_enqueue = true
+        end
+
+        allow_enqueue
+      end
+
+      def enqueue_for_approval(*args)
+        args = args[0] || {}
+
+        message = args.delete(:approval_message) || args.delete('approval_message')
+
+        Resque.enqueue_to(:approval_required, self, args)
+
+        id = Resque.size(:approval_required) - 1
+
+        if message
+          key = {:id => id, :approval_message => message}.to_json
+        else
+          key = { :id => id }.to_json
+        end
+
+        job = Resque.peek(:approval_required, id)
+        value = job.to_json
+
+        Resque.redis.hset('pending_jobs', key, value)
+      end
+
+      def approve(key)
+        value = Resque.redis.hget('pending_jobs', key)
+
+        return false if value.nil?
+
+        job = JSON.parse(value)
+
+        Resque.redis.hdel('pending_jobs', key)
+        Resque.redis.lrem('queue:approval_required', 1, job.to_json)
+        Resque.push(Resque.queue_from_class(self), job)
+      end
+
+      def reject(key)
+        value = Resque.redis.hget('pending_jobs', key)
+
+        return false if value.nil?
+
+        job = JSON.parse(value)
+
+        Resque.redis.hdel('pending_jobs', key)
+        Resque.redis.lrem('queue:approval_required', 1, job.to_json)
+      end
+    end
+  end
+end

data/lib/resque-approval/version.rb

@@ -0,0 +1,7 @@
+module Resque
+  module Plugins
+    module Approval
+      VERSION = '1.0.0'
+    end
+  end
+end

data/resque-approval.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/resque-approval/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name          = 'resque-approval'
+  gem.version       = Resque::Plugins::Approval::VERSION
+  gem.date          = Time.now.strftime('%Y-%m-%d')
+  gem.description   = %q{A Resque plugin allowing jobs to be sent to a temporary
+                         queue to await approval.  Once the job is approved, it
+                         is placed on its normal queue.}
+  gem.summary       = %q{A Resque plugin allowing jobs to be sent to a temporary
+                         queue to await approval.}
+  gem.homepage      = 'https://github.com/eclubb/resque-approval'
+  gem.authors       = ['Earle Clubb']
+  gem.email         = ['eclubb@valcom.com']
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'resque'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'guard'
+  gem.add_development_dependency 'guard-rspec'
+end

data/spec/lib/resque-approval_spec.rb

@@ -0,0 +1,153 @@
+require 'spec_helper'
+
+class Job
+  extend Resque::Plugins::Approval
+
+  @queue = 'dummy'
+
+  def self.perform
+  end
+end
+
+describe "Resque::Plugins::Approval" do
+  before do
+    Resque.remove_queue(:dummy)
+    Resque.remove_queue(:approval_required)
+    Resque.redis.del('pending_jobs')
+  end
+
+  it "is a valid Resque plugin" do
+    lambda { Resque::Plugin.lint(Resque::Plugins::Approval) }.should_not raise_error
+  end
+
+  describe "#pending_job_keys" do
+    it "lists keys (ordered by id) for all jobs that are waiting for approval" do
+      Job.enqueue_for_approval(:approval_message => 'test message 1')
+      Job.enqueue_for_approval
+      Job.enqueue_for_approval(:approval_message => 'test message 2')
+
+      keys = [{'id' => 0, 'approval_message' => 'test message 1'},
+              {'id' => 1},
+              {'id' => 2, 'approval_message' => 'test message 2'}]
+      Resque::Plugins::Approval.pending_job_keys.should == keys
+    end
+  end
+
+  describe ".before_enqueue_approval" do
+    context "when a job requires approval (via symbol or string)" do
+      it "calls enqueue_for_approval" do
+        Job.should_receive(:enqueue_for_approval).twice.with({})
+        Resque.enqueue(Job, :requires_approval => true)
+        Resque.enqueue(Job, 'requires_approval' => true)
+      end
+    end
+
+    context "when a job does not require approval" do
+      it "does not call enqueue_for_approval" do
+        Job.should_not_receive(:enqueue_for_approval)
+        Resque.enqueue(Job)
+      end
+    end
+  end
+
+  describe ".enqueue_for_approval" do
+    it "adds the job to the appoval queue" do
+      Job.enqueue_for_approval
+      Resque.size(:approval_required).should == 1
+    end
+
+    it "does not add the job to the dummy queue" do
+      Job.enqueue_for_approval
+      Resque.size(:dummy).should == 0
+    end
+
+    it "adds an entry to the 'pending_jobs' hash" do
+      Job.enqueue_for_approval()
+
+      key = '{"id":0}'
+      value = '{"class":"Job","args":[{}]}'
+
+      Resque.redis.hget('pending_jobs', key).should == value
+    end
+
+    context "with an approval message (via symbol)" do
+      it "includes the message in the 'pending_jobs' hash entry" do
+        Job.enqueue_for_approval(:approval_message => 'symbol test message')
+
+        key = '{"id":0,"approval_message":"symbol test message"}'
+        value = '{"class":"Job","args":[{}]}'
+
+        Resque.redis.hget('pending_jobs', key).should == value
+      end
+    end
+
+    context "with an approval message (via string)" do
+      it "includes the message in the 'pending_jobs' hash entry" do
+        Job.enqueue_for_approval('approval_message' => 'string test message')
+
+        key = '{"id":0,"approval_message":"string test message"}'
+        value = '{"class":"Job","args":[{}]}'
+
+        Resque.redis.hget('pending_jobs', key).should == value
+      end
+    end
+  end
+
+  describe ".approve" do
+    it "moves the job from the approval queue to its normal queue" do
+      key = '{"id":0}'
+
+      Resque.enqueue(Job, :requires_approval => true)
+      Job.approve(key)
+
+      Resque.size(:approval_required).should == 0
+      Resque.size(:dummy).should == 1
+    end
+
+    it "deletes the entry in the 'pending_jobs' hash" do
+      key = '{"id":0}'
+
+      Resque.enqueue(Job, :requires_approval => true)
+      Job.approve(key)
+
+      Resque.redis.hget('pending_jobs', key).should be_nil
+    end
+
+    it "returns false when key can not be found" do
+      Job.approve('bad key').should == false
+    end
+  end
+
+  describe ".reject" do
+    it "deletes the job from the approval queue" do
+      key = '{"id":0}'
+
+      Resque.enqueue(Job, :requires_approval => true)
+      Job.reject(key)
+
+      Resque.size(:approval_required).should == 0
+    end
+
+    it "does not add  the job to its normal queue" do
+      key = '{"id":0}'
+
+      Resque.enqueue(Job, :requires_approval => true)
+      Job.reject(key)
+
+      Resque.size(:dummy).should == 0
+    end
+
+    it "deletes the entry in the 'pending_jobs' hash" do
+      key = '{"id":0}'
+
+      Resque.enqueue(Job, :requires_approval => true)
+      Job.reject(key)
+
+      Resque.redis.hget('pending_jobs', key).should be_nil
+    end
+
+    it "returns false when key can not be found" do
+      Job.reject('bad key').should == false
+    end
+  end
+end

data/spec/redis-test.conf

@@ -0,0 +1,7 @@
+daemonize yes
+pidfile /tmp/redis-test.pid
+port 9736
+dbfilename redis-test-dump.rdb
+dir /tmp
+loglevel debug
+logfile stdout

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'resque-approval'
+
+ROOT_PATH = File.expand_path('..', __FILE__)
+TMP_PATH = '/tmp'
+
+def start_redis
+  puts 'Starting redis for testing at localhost:9736...'
+  `redis-server #{ROOT_PATH}/redis-test.conf`
+  Resque.redis = 'localhost:9736'
+  sleep 0.1
+end
+
+def stop_redis
+  puts "\nKilling test redis server..."
+  %x{
+    cat #{TMP_PATH}/redis-test.pid | xargs kill -QUIT
+    rm -f #{TMP_PATH}/redis-test-dump.rdb
+  }
+end
+
+RSpec.configure do |config|
+  config.before(:suite) do
+    start_redis
+  end
+
+  config.after(:suite) do
+    stop_redis
+  end
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: resque-approval
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Earle Clubb
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &12740880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *12740880
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &12740240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12740240
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &12739480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12739480
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &12737500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12737500
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &12732800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *12732800
+description: ! "A Resque plugin allowing jobs to be sent to a temporary\n                         queue
+  to await approval.  Once the job is approved, it\n                         is placed
+  on its normal queue."
+email:
+- eclubb@valcom.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/resque-approval.rb
+- lib/resque-approval/version.rb
+- resque-approval.gemspec
+- spec/lib/resque-approval_spec.rb
+- spec/redis-test.conf
+- spec/spec_helper.rb
+homepage: https://github.com/eclubb/resque-approval
+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: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: A Resque plugin allowing jobs to be sent to a temporary queue to await approval.
+test_files:
+- spec/lib/resque-approval_spec.rb
+- spec/redis-test.conf
+- spec/spec_helper.rb