backgrounded 0.3.1 → 0.4.1

data/.gitignore

@@ -3,3 +3,5 @@
 coverage
 rdoc
 pkg
+*.sqlite3
+*.log

data/README.rdoc

@@ -5,7 +5,7 @@ Background processing done right.
 = Features
 * clean and concise API
 * testable
-* integrates with any background processing framework (DelayedJob, JobFu, Workling, etc)
+* integrates with any background processing framework (DelayedJob, Resque, JobFu, Workling, etc)
 
 = Usage
 
@@ -25,11 +25,15 @@ Background processing done right.
 
 Command line installation
 
-  sudo gem install wireframe-backgrounded
+  sudo gem install backgrounded
 
 Rails environment.rb configuration
 
-  config.gem 'wireframe-backgrounded', :source => 'http://gems.github.com', :lib => 'backgrounded'
+  config.gem 'backgrounded'
+
+Gemfile configuration
+
+  gem 'backgrounded'
 
 = Configuration
 
@@ -40,22 +44,32 @@ Backgrounded provides a thin wrapper around any background processing framework
 An implementation for DelayedJob is packaged directly with Backgrounded for a slick out of the box experience.
 see http://github.com/tobi/delayed_job/tree/master
 
-  # rails config/initializers/backgrounded.rb
+  # config/initializers/backgrounded.rb
+  require 'backgrounded/handler/delayed_job_handler'
   Backgrounded.handler = Backgrounded::Handler::DelayedJobHandler.new
 
+= Resque
+
+An implementation for Resque is packaged directly with Backgrounded for a slick out of the box experience.
+see http://github.com/defunkt/resque/
+
+  # config/initializers/backgrounded.rb
+  require 'backgrounded/handler/resque_handler'
+  Backgrounded.handler = Backgrounded::Handler::ResqueHandler.new
+
 = JobFu
 
 Developers using the JobFu library have it easy as well!
 see http://github.com/jnstq/job_fu/tree
 
-  # rails config/initializers/backgrounded.rb
+  # config/initializers/backgrounded.rb
   Backgrounded.handler = JobFu::Backgrounded::Handler.new
 
 = Custom Handlers
 
 It's trivial to write your own plugin for processing Backgrounded events! 
 
-  # rails config/initializers/backgrounded.rb
+  # config/initializers/backgrounded.rb
   class MyHandler
     def request(object, method, *args)
       #process the call however you want!

data/Rakefile

@@ -9,6 +9,10 @@ begin
     gem.email = "ryan.sonnek@gmail.com"
     gem.homepage = "http://github.com/wireframe/backgrounded"
     gem.authors = ["Ryan Sonnek"]
+    gem.add_runtime_dependency "activerecord", ">= 2.2.3"
+    gem.add_runtime_dependency "activesupport", ">= 2.2.3"
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency 'resque_unit', ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION.yml

@@ -1,5 +1,5 @@
 --- 
 :major: 0
+:minor: 4
 :build: 
-:minor: 3
 :patch: 1

data/backgrounded.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{backgrounded}
-  s.version = "0.3.1"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Sonnek"]
-  s.date = %q{2009-10-26}
+  s.date = %q{2010-09-27}
   s.email = %q{ryan.sonnek@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -24,19 +24,25 @@ Gem::Specification.new do |s|
      "VERSION.yml",
      "backgrounded.gemspec",
      "lib/backgrounded.rb",
-     "lib/handler.rb",
-     "lib/handler/delayed_job_handler.rb",
-     "lib/handler/inprocess_handler.rb",
+     "lib/backgrounded/class_methods.rb",
+     "lib/backgrounded/handler/delayed_job_handler.rb",
+     "lib/backgrounded/handler/inprocess_handler.rb",
+     "lib/backgrounded/handler/resque_handler.rb",
+     "test/backgrounded/handler/delayed_job_handler_test.rb",
+     "test/backgrounded/handler/resque_handler_test.rb",
      "test/backgrounded_test.rb",
+     "test/database.yml",
      "test/test_helper.rb"
   ]
   s.homepage = %q{http://github.com/wireframe/backgrounded}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Simple API to run Model methods in the background}
   s.test_files = [
-    "test/backgrounded_test.rb",
+    "test/backgrounded/handler/delayed_job_handler_test.rb",
+     "test/backgrounded/handler/resque_handler_test.rb",
+     "test/backgrounded_test.rb",
      "test/test_helper.rb"
   ]
 
@@ -44,10 +50,22 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 2.2.3"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 2.2.3"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<resque_unit>, [">= 0"])
     else
+      s.add_dependency(%q<activerecord>, [">= 2.2.3"])
+      s.add_dependency(%q<activesupport>, [">= 2.2.3"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<resque_unit>, [">= 0"])
     end
   else
+    s.add_dependency(%q<activerecord>, [">= 2.2.3"])
+    s.add_dependency(%q<activesupport>, [">= 2.2.3"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<resque_unit>, [">= 0"])
   end
 end
 

data/lib/backgrounded.rb

@@ -1,37 +1,14 @@
-require 'activesupport'
+require 'active_support/all'
+
+require File.join(File.dirname(__FILE__), 'backgrounded', 'class_methods')
+require File.join(File.dirname(__FILE__), 'backgrounded', 'handler', 'inprocess_handler')
+
+Object.send(:include, Backgrounded::ClassMethods)
 
 module Backgrounded
   mattr_accessor :handler
   def self.handler
     @@handler ||= Backgrounded::Handler::InprocessHandler.new
   end
-  
-  autoload :Handler, 'handler'
-        
-  module Model
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    module ClassMethods
-      def backgrounded(*methods)
-        methods.each do |method|
-          method_basename, punctuation = method.to_s.sub(/([?!=])$/, ''), $1
-          define_method :"#{method_basename}_backgrounded#{punctuation}" do |*args|
-            Backgrounded.handler.request(self, method, *args)
-          end
-        end
-        include Backgrounded::Model::InstanceMethods
-        extend Backgrounded::Model::SingletonMethods
-      end
-    end
-
-    module SingletonMethods
-    end
-
-    module InstanceMethods
-    end
-  end
 end
 
-Object.send(:include, Backgrounded::Model)

data/lib/backgrounded/class_methods.rb

@@ -0,0 +1,12 @@
+module Backgrounded
+  module ClassMethods
+    def backgrounded(*methods)
+      methods.each do |method|
+        method_basename, punctuation = method.to_s.sub(/([?!=])$/, ''), $1
+        define_method "#{method_basename}_backgrounded#{punctuation}" do |*args|
+          Backgrounded.handler.request(self, method, *args)
+        end
+      end
+    end
+  end
+end

data/lib/backgrounded/handler/resque_handler.rb

@@ -0,0 +1,19 @@
+require 'resque'
+
+module Backgrounded
+  module Handler
+    #enque requests in resque
+    class ResqueHandler
+      def request(object, method, *args)
+        Resque.enqueue(ResqueHandler, object.class.name, object.id, method, *args)
+      end
+      def self.queue
+        'backgrounded'
+      end
+
+      def self.perform(clazz, id, method, *args)
+        clazz.constantize.find(id).send(method, *args)
+      end
+    end
+  end
+end

data/test/backgrounded/handler/delayed_job_handler_test.rb

@@ -0,0 +1,53 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'test_helper')
+require 'backgrounded/handler/delayed_job_handler'
+require 'delayed/backend/active_record'
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users, :force => true do |t|
+    t.column :name, :string
+  end
+  create_table :delayed_jobs, :force => true do |table|
+    table.integer  :priority, :default => 0      # Allows some jobs to jump to the front of the queue
+    table.integer  :attempts, :default => 0      # Provides for retries, but still fail eventually.
+    table.text     :handler                      # YAML-encoded string of the object that will do work
+    table.string   :last_error                   # reason for last failure (See Note below)
+    table.datetime :run_at                       # When to run. Could be Time.now for immediately, or sometime in the future.
+    table.datetime :locked_at                    # Set when a client is working on this object
+    table.datetime :failed_at                    # Set when all retries have failed (actually, by default, the record is deleted instead)
+    table.string   :locked_by                    # Who is working on this object (if locked)
+    table.timestamps
+  end
+end
+
+class User < ActiveRecord::Base
+  backgrounded :do_stuff
+
+  def do_stuff
+  end
+end
+
+class DelayedJobHandlerTest < Test::Unit::TestCase
+  context 'when backgrounded is configured with delayed_job' do
+    setup do
+      Delayed::Worker.backend = :active_record
+      @handler = Backgrounded::Handler::DelayedJobHandler.new
+      Backgrounded.handler = @handler
+    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.do_stuff_backgrounded
+        end
+        should_create Delayed::Job
+        should 'create delayed job' do
+          job = Delayed::Job.last
+          puts job.inspect
+        end
+      end
+    end
+  end
+end

data/test/backgrounded/handler/resque_handler_test.rb

@@ -0,0 +1,45 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'test_helper')
+require 'backgrounded/handler/resque_handler'
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :users, :force => true do |t|
+    t.column :name, :string
+  end
+end
+
+class User < ActiveRecord::Base
+  backgrounded :do_stuff
+
+  def do_stuff
+  end
+end
+
+class ResqueHandlerTest < Test::Unit::TestCase
+  context 'when backgrounded is configured with resque' do
+    setup do
+      Resque.reset!
+      @handler = Backgrounded::Handler::ResqueHandler.new
+      Backgrounded.handler = @handler
+    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.do_stuff_backgrounded
+        end
+        should "enqueue job to resque" do
+          assert_queued 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
+    end
+  end
+end

data/test/database.yml

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

data/test/test_helper.rb

@@ -2,10 +2,16 @@ require 'rubygems'
 require 'test/unit'
 require 'shoulda'
 require 'mocha'
+require 'active_record'
+require 'resque_unit'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'backgrounded'
 
+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

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: backgrounded
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  hash: 13
+  prerelease: false
+  segments: 
+  - 0
+  - 4
+  - 1
+  version: 0.4.1
 platform: ruby
 authors: 
 - Ryan Sonnek
@@ -9,10 +15,69 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-26 00:00:00 -05:00
+date: 2010-09-27 00:00:00 -05:00
 default_executable: 
-dependencies: []
-
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 2
+        - 3
+        version: 2.2.3
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 2
+        - 2
+        - 3
+        version: 2.2.3
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: resque_unit
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: 
 email: ryan.sonnek@gmail.com
 executables: []
@@ -31,10 +96,14 @@ files:
 - VERSION.yml
 - backgrounded.gemspec
 - lib/backgrounded.rb
-- lib/handler.rb
-- lib/handler/delayed_job_handler.rb
-- lib/handler/inprocess_handler.rb
+- lib/backgrounded/class_methods.rb
+- lib/backgrounded/handler/delayed_job_handler.rb
+- lib/backgrounded/handler/inprocess_handler.rb
+- lib/backgrounded/handler/resque_handler.rb
+- test/backgrounded/handler/delayed_job_handler_test.rb
+- test/backgrounded/handler/resque_handler_test.rb
 - test/backgrounded_test.rb
+- test/database.yml
 - test/test_helper.rb
 has_rdoc: true
 homepage: http://github.com/wireframe/backgrounded
@@ -46,24 +115,32 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Simple API to run Model methods in the background
 test_files: 
+- test/backgrounded/handler/delayed_job_handler_test.rb
+- test/backgrounded/handler/resque_handler_test.rb
 - test/backgrounded_test.rb
 - test/test_helper.rb

data/lib/handler.rb

@@ -1,10 +0,0 @@
-require 'activesupport'
-
-module Backgrounded
-  module Handler
-    Dir["#{File.dirname(__FILE__)}/#{name.demodulize.underscore}/*.rb"].each do |handler_file|
-      handler_name = File.basename(handler_file, '.rb').camelize.to_sym
-      autoload handler_name, File.expand_path(handler_file)
-    end
-  end
-end