backgrounded-resque 2.0.0.pre1

data/.gitignore

@@ -0,0 +1,13 @@
+.document
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+*.sqlite3
+*.log
+
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/.rvmrc

@@ -0,0 +1,5 @@
+rvm use 1.9.3@backgrounded --create
+if ! command -v bundle ; then
+  gem install bundler
+  bundle install --local
+fi

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ryan Sonnek
+
+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.rdoc

@@ -0,0 +1,37 @@
+= Backgrounded
+
+The cleanest way to integrate background processing into your application.
+
+Backgrounded provides a thin wrapper around any background processing framework that implements the Backgrounded handler API which makes it trivial to swap out processing frameworks with no impact to your code.
+
+This library is an extension which add support for the Resque job processing framework
+see http://github.com/defunkt/resque/
+
+= Features
+* execute class or instance level methods within resque background workers
+* supports enqueing jobs into custom queues
+
+= Installation
+
+Bundler Gemfile configuration
+
+  gem 'backgrounded-resque'
+
+Backgrounded Configuration
+
+  # config/initializers/backgrounded.rb
+  require 'backgrounded/handler/resque_handler'
+  Backgrounded.handler = Backgrounded::Handler::ResqueHandler.new
+
+= Usage
+  user = User.new
+
+  # perform work on the default backgrounded queue
+  user.backgrounded.do_something
+
+  # perform work on a custom queue
+  user.backgrounded(:queue => 'custom').do_something_else
+
+== Copyright
+
+Copyright (c) 2012 Ryan Sonnek. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+task :default => :test

data/backgrounded.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "backgrounded/version"
+
+Gem::Specification.new do |s|
+  s.name        = "backgrounded-resque"
+  s.version     = Backgrounded::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Ryan Sonnek"]
+  s.email       = ["ryan@codecrate.com"]
+  s.homepage    = "http://github.com/wireframe/backgrounded"
+  s.summary     = %q{Simple API to perform work in the background}
+  s.description = %q{Execute any ActiveRecord Model method in the background}
+
+  s.rubyforge_project = "backgrounded"
+
+  s.add_runtime_dependency(%q<backgrounded>, [">= 2.0.0.pre1"])
+  s.add_runtime_dependency(%q<resque>, [">= 0.17.1"])
+  s.add_development_dependency(%q<shoulda>, [">= 0"])
+  s.add_development_dependency(%q<resque_unit>, [">= 0.3.7"])
+  s.add_development_dependency(%q<resque_unit>, [">= 0.3.7"])
+  s.add_development_dependency(%q<mocha>, [">= 0"])
+  s.add_development_dependency(%q<sqlite3-ruby>, [">= 1.3.2"])
+  s.add_development_dependency(%q<rake>, [">= 0.9.2.2"])
+
+  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.require_paths = ["lib"]
+end

data/lib/backgrounded/handler/pseudo_resque_handler.rb

@@ -0,0 +1,14 @@
+require 'resque'
+
+# handler that acts like the in process handler but marshalls the arguments
+# this simulates how resque encodes/decodes values to/from redis
+# useful when passing symbols to arguments and they end up being processed as strings
+module Backgrounded
+  module Handler
+    class PseudoResqueHandler
+      def request(object, method, args, options={})
+        object.send method, *Resque.decode(Resque.encode(args))
+      end
+    end
+  end
+end

data/lib/backgrounded/handler/resque_handler.rb

@@ -0,0 +1,37 @@
+require 'resque'
+
+module Backgrounded
+  module Handler
+    #enque requests in resque
+    class ResqueHandler
+      DEFAULT_QUEUE = 'backgrounded'
+      INVALID_ID = -1
+      @@queue = DEFAULT_QUEUE
+
+      def request(object, method, args, options={})
+        @@queue = options[:queue] || DEFAULT_QUEUE
+        instance, id = instance_identifiers(object)
+        Resque.enqueue(ResqueHandler, instance, id, method, *args)
+      end
+      def self.queue
+        @@queue
+      end
+      def self.perform(clazz, id, method, *args)
+        find_instance(clazz, id, method).send(method, *args)
+      end
+
+      private
+      def self.find_instance(clazz, id, method)
+        clazz = clazz.constantize
+        id.to_i == INVALID_ID ? clazz : clazz.find(id)
+      end
+      def instance_identifiers(object)
+        instance, id = if object.is_a?(Class) 
+          [object.name, INVALID_ID]
+        else
+          [object.class.name, object.id]
+        end
+      end
+    end
+  end
+end

data/lib/backgrounded/version.rb

@@ -0,0 +1,3 @@
+module Backgrounded
+  VERSION = "2.0.0.pre1"
+end

data/test/backgrounded/handler/resque_handler_test.rb

@@ -0,0 +1,120 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'test_helper')
+require 'backgrounded/handler/resque_handler'
+require 'resque_unit'
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :blogs, :force => true do |t|
+    t.column :name, :string
+  end
+
+  create_table :users, :force => true do |t|
+    t.column :name, :string
+  end
+
+  create_table :posts, :force => true do |t|
+    t.column :title, :string
+  end
+end
+
+class ResqueHandlerTest < Test::Unit::TestCase
+  class User < ActiveRecord::Base
+    def do_stuff
+    end
+  end
+
+  class Post < ActiveRecord::Base
+    def do_stuff
+    end
+  end
+
+  class Blog < ActiveRecord::Base
+    class << self
+      def do_stuff
+      end
+    end
+    def do_stuff
+    end
+  end
+
+  context 'when backgrounded is configured with resque' do
+    setup do
+      Resque.reset!
+      @handler = Backgrounded::Handler::ResqueHandler.new
+      Backgrounded.handler = @handler
+    end
+
+    context 'a class level backgrounded method' do
+      context "invoking backgrounded method" do
+        setup do
+          Blog.backgrounded.do_stuff
+        end
+        should "enqueue job to resque" do
+          assert_queued Backgrounded::Handler::ResqueHandler, [Blog.to_s, -1, 'do_stuff']
+          assert_equal Backgrounded::Handler::ResqueHandler::DEFAULT_QUEUE, Resque.queue_from_class(Backgrounded::Handler::ResqueHandler)
+        end
+        context "running background job" do
+          setup do
+            Blog.expects(:do_stuff)
+            Resque.run!
+          end
+          should "invoke method on class" do end #see expectations
+        end
+      end
+      context 'with an instance level backgrounded method of the same name' do
+        setup do
+          @blog = Blog.create
+          @blog.backgrounded.do_stuff
+        end
+        should "enqueue instance method job to resque" do
+          assert_queued Backgrounded::Handler::ResqueHandler, [Blog.to_s, @blog.id, 'do_stuff']
+          assert_equal Backgrounded::Handler::ResqueHandler::DEFAULT_QUEUE, Resque.queue_from_class(Backgrounded::Handler::ResqueHandler)
+        end
+        context "running background job" do
+          setup do
+            Blog.expects(:do_stuff).never
+            Blog.any_instance.expects(:do_stuff)
+            Resque.run!
+          end
+          should "invoke method on instance" do end #see expectations
+        end
+      end
+    end
+
+    context 'a persisted object with a single backgrounded method' do
+      setup do
+        @user = User.create
+      end
+      context "invoking backgrounded method" do
+        setup do
+          @user.backgrounded.do_stuff
+        end
+        should "enqueue job to resque" do
+          assert_queued Backgrounded::Handler::ResqueHandler, [User.to_s, @user.id, 'do_stuff']
+          assert_equal Backgrounded::Handler::ResqueHandler::DEFAULT_QUEUE, Resque.queue_from_class(Backgrounded::Handler::ResqueHandler)
+        end
+        context "running background job" do
+          should "invoke method on user object" do
+            User.any_instance.expects(:do_stuff)
+            Resque.run!
+          end
+        end
+      end
+
+      context 'a persisted object with backgrounded method with options' do
+        setup do
+          @post = Post.create
+        end
+        context "invoking backgrounded method" do
+          setup do
+            @post.backgrounded(:queue => 'important').do_stuff
+          end
+          should "use configured queue" do
+            assert_equal 'important', Backgrounded::Handler::ResqueHandler.queue
+            assert_equal 'important', Resque.queue_from_class(Backgrounded::Handler::ResqueHandler)
+            assert_equal 1, Resque.queue('important').length
+          end
+        end
+      end
+    end
+  end
+end

data/test/database.yml

@@ -0,0 +1,3 @@
+sqlite:
+  adapter: sqlite3
+  database: test/backgrounded.sqlite3

data/test/test_helper.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'active_record'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'backgrounded'
+
+Backgrounded.logger.level = Logger::DEBUG
+
+config = YAML::load(IO.read(File.join(File.dirname(__FILE__), 'database.yml')))
+ActiveRecord::Base.logger = Logger.new(File.join(File.dirname(__FILE__), "debug.log"))
+ActiveRecord::Base.establish_connection(config[ENV['DB'] || 'sqlite'])
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: backgrounded-resque
+version: !ruby/object:Gem::Version
+  version: 2.0.0.pre1
+  prerelease: 6
+platform: ruby
+authors:
+- Ryan Sonnek
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: backgrounded
+  requirement: &2179202580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0.pre1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2179202580
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &2179202060 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.17.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2179202060
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2179201580 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2179201580
+- !ruby/object:Gem::Dependency
+  name: resque_unit
+  requirement: &2179201100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+  type: :development
+  prerelease: false
+  version_requirements: *2179201100
+- !ruby/object:Gem::Dependency
+  name: resque_unit
+  requirement: &2179200620 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.7
+  type: :development
+  prerelease: false
+  version_requirements: *2179200620
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &2179200140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2179200140
+- !ruby/object:Gem::Dependency
+  name: sqlite3-ruby
+  requirement: &2179199660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.3.2
+  type: :development
+  prerelease: false
+  version_requirements: *2179199660
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &2179199180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: *2179199180
+description: Execute any ActiveRecord Model method in the background
+email:
+- ryan@codecrate.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- backgrounded.gemspec
+- lib/backgrounded/handler/pseudo_resque_handler.rb
+- lib/backgrounded/handler/resque_handler.rb
+- lib/backgrounded/version.rb
+- test/backgrounded/handler/resque_handler_test.rb
+- test/database.yml
+- test/test_helper.rb
+homepage: http://github.com/wireframe/backgrounded
+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'
+      segments:
+      - 0
+      hash: 3144533850957425411
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>'
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubyforge_project: backgrounded
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Simple API to perform work in the background
+test_files:
+- test/backgrounded/handler/resque_handler_test.rb
+- test/database.yml
+- test/test_helper.rb