perform_later 0.0.1 → 0.0.2

data/README.md

@@ -4,3 +4,10 @@
 Perform later is a gem meant to work with the [Resque](http://github.com/defunkt/resque) queue system.
 
 The gem handles queuing tasks without the need to have additional "Worker" classes or with any changes to your original model/object code base.
+
+## Contribute / Bug reports
+If you have an issue with this gem, please open an issue in the main repo, it will help tons if you could supply a failing spec with that, so I can better track where the bug is coming from, if not, no worries, just report I will do my best to address it as fast and efficient as I can.
+
+If you want to contribute (awesome), open a feature branch, base it on master.
+
+Be as descriptive as you can in the pull request description, just to be clear what problem you are solving or what feature are you adding.

data/init.rb

@@ -0,0 +1,2 @@
+# init
+require 'perform_later'

data/lib/active_record_perform_later.rb

@@ -0,0 +1,24 @@
+module ActiveRecordPerformLater
+  module InstanceMethods
+    def perform_later(queue, method, *args)
+      if ResquePerformLater.config['enabled']
+        args = ResquePerformLater.args_to_resque(args)
+        
+        Resque::Job.create( queue,
+                            ActiveRecordWorker,
+                            self.class.name,
+                            self.id,
+                            method,
+                            *args)
+      else
+        self.send( method, *args )
+      end
+    end
+  end
+  
+  def self.included(receiver)
+    receiver.send :include, InstanceMethods
+  end
+end
+
+ActiveRecord::Base.send :include, ActiveRecordPerformLater

data/lib/active_record_worker.rb

@@ -0,0 +1,9 @@
+class ActiveRecordWorker
+	def self.perform(klass, id, method, *args)
+	  args = ResquePerformLater.args_from_resque(args)
+	  runner_klass = eval(klass)
+	  
+	  record = runner_klass.where(:id => id).first
+	  record.send(method, *args) if record
+	end
+end

data/lib/object_perform_later.rb

@@ -0,0 +1,12 @@
+module ObjectPerformLater
+  def perform_later(queue, method, *args)
+    if ResquePerformLater.config['enabled']
+      args = ResquePerformLater.args_to_resque(args)      
+      Resque::Job.create(queue, ObjectWorker, self.name, method, *args)
+    else
+      self.send(method, *args)
+    end
+  end
+end
+
+Object.send :include, ObjectPerformLater

data/lib/object_worker.rb

@@ -0,0 +1,10 @@
+class ObjectWorker
+  # @param klass_name [The class name that you should work on]
+  # @param method [method you should send on the class]
+  # @param args [method args]
+  def self.perform(klass_name, method, *args)
+    args = ResquePerformLater.args_from_resque(args)
+    
+    klass_name.constantize.send(method, *args)
+  end
+end

data/lib/perform_later.rb

@@ -1,4 +1,11 @@
-require "perform_later/version"
+require 'perform_later/version'
+require 'active_record'
+require 'resque_perform_later'
+require 'resque_mailer_patch'
+require 'object_worker'
+require 'object_perform_later'
+require 'active_record_worker'
+require 'active_record_perform_later'
 
 module PerformLater
   # Your code goes here...

data/lib/perform_later/version.rb

@@ -1,3 +1,3 @@
 module PerformLater
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/resque_mailer_patch.rb

@@ -0,0 +1,17 @@
+module Resque
+  module Mailer
+    module ClassMethods
+      def perform(action, *args)
+        args = ResquePerformLater.args_from_resque(args)
+        self.send(:new, action, *args).message.deliver
+      end
+    end
+
+    class MessageDecoy
+      def deliver
+        args = ResquePerformLater.args_to_resque(@args)
+        resque.enqueue(@mailer_class, @method_name, *args)
+      end
+    end
+  end
+end

data/lib/resque_perform_later.rb

@@ -0,0 +1,66 @@
+class ResquePerformLater
+  APP_ROOT = File.expand_path((defined?(Rails) && Rails.root.to_s.length > 0) ? Rails.root : ".") unless defined?(APP_ROOT)
+  DEFAULT_CONFIG_PATH = File.join(APP_ROOT, 'config', 'resque_perform_later.yml')
+  DEFAULT_CONFIG = {
+    'enabled' => true
+  }
+
+  # inspired by DelayedJob
+
+  CLASS_STRING_FORMAT = /^CLASS\:([A-Z][\w\:]+)$/
+  AR_STRING_FORMAT    = /^AR\:([A-Z][\w\:]+)\:(\d+)$/
+  YAML_STRING_FORMAT  = /\A---/
+
+  def self.args_to_resque(*args)
+    args = args.map { |o|
+      case o
+        when ActiveRecord::Base
+          "AR:#{o.class.name}:#{o.id}"
+        when Class, Module
+          "CLASS:#{o.name}"
+        when Hash
+          o.to_yaml
+        else
+          o
+      end
+    } if args
+  end
+  
+  def self.args_from_resque(*args)
+    args = args.map { |o|
+      if o
+        case o
+        when CLASS_STRING_FORMAT  then $1.constantize
+        when AR_STRING_FORMAT     then $1.constantize.find_by_id($2)
+        when YAML_STRING_FORMAT   then YAML.load(o)
+        else o
+        end
+      end
+    } if args
+  end
+
+  private
+  def self.env_str
+    if defined? Rails
+      Rails.env.to_s
+    elsif defined? Rack
+      Rack.env.to_s
+    else
+      'production'
+    end
+  end
+
+  @@_config = nil
+
+  def self.config
+    return @@_config if @@_config && self.env_str != 'development'
+
+    if File.exists?(DEFAULT_CONFIG_PATH)
+      config = YAML.load(ERB.new(IO.read(DEFAULT_CONFIG_PATH)).result)[self.env_str]
+    end
+
+    config = {}.merge(DEFAULT_CONFIG || {}).merge(config || {})
+
+    @@_config = config
+  end
+end

data/license

@@ -0,0 +1,20 @@
+Copyright (c) Avi Tzurel
+
+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/perform_later.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = PerformLater::VERSION
   s.authors     = ["Avi Tzurel"]
   s.email       = ["avi@kensodev.com"]
-  s.homepage    = ""
+  s.homepage    = "http://www.github.com/kensodev/perform_later"
   s.summary     = %q{Queue any method in any class or instance with no need for additional Worker class and no extra code}
   s.description = %q{Queue any method in any class or instance with no need for additional Worker class and no extra code}
 
@@ -19,6 +19,11 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  s.add_dependency 'activerecord', ">= 3.0.0"
+  s.add_dependency 'redis'
+  s.add_dependency 'resque'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'sqlite3'
 end

data/spec/lib/resque_perform_later_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe ResquePerformLater do
+  let(:user) { User.create }
+
+  context "args to resque" do
+    it "should convert the AR object to the proper string" do
+      user_id = user.id
+
+      ResquePerformLater.args_to_resque(user).length.should == 1
+      ResquePerformLater.args_to_resque(user)[0].should == "AR:User:#{user_id}"
+    end
+
+    it "should convert a hash into YAML string so that Resque will be able to JSON convert it" do
+      hash = {name: "something", other: "something else"}
+      ResquePerformLater.args_to_resque(hash)[0].class.name.should == "String"
+    end
+
+    it "should be able to load a yaml from the string and translate it into the same hash again" do
+      hash = {name: "something", other: "something else"}
+      yaml = ResquePerformLater.args_to_resque(hash)[0]
+
+      loaded_yaml = YAML.load(yaml)
+      
+      loaded_yaml[:name].should == "something"
+      loaded_yaml[:other].should == "something else"
+    end
+
+    it "should convert a class to the proper string representation" do
+      klass = User
+      ResquePerformLater.args_to_resque(klass)[0].should == "CLASS:User"
+    end
+  end
+
+  context "args from resque" do
+    it "should give me a hash back when I pass a yaml representation of it" do
+      hash = {name: "something", other: "something else"}   
+      yaml = hash.to_yaml
+
+      args = ResquePerformLater.args_from_resque(yaml)
+      args[0].class.name.should == "Hash"
+      args[0][:name].should == "something"
+      args[0][:other].should == "something else"
+    end
+
+    it "Should give me a user model back when I pass the proper string" do
+      args = ResquePerformLater.args_from_resque("AR:User:#{user.id}")
+      args[0].should == user
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,55 @@
+require "perform_later"
+require "rspec"
+require "support/database_connection"
+require "support/database_models"
+require "redis"
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+
+  config.before(:all) do
+    dir = File.join(File.dirname(__FILE__), 'support/db')
+    
+    old_db = File.join(dir, 'test.sqlite3')
+    FileUtils.rm(old_db) if File.exists?(old_db)
+    FileUtils.cp(File.join(dir, '.blank.sqlite3'), File.join(dir, 'test.sqlite3'))
+  end
+
+  root = File.dirname(__FILE__)
+  REDIS_PID = File.join(root, "tmp/pids/redis-test.pid")
+  REDIS_CACHE_PATH = File.join(root, "tmp/cache/")
+
+  FileUtils.mkdir_p File.join(root, "tmp/pids")
+  FileUtils.mkdir_p File.join(root, "tmp/cache")
+
+  config.before(:suite) do
+    redis_options = {
+      "daemonize"     => 'yes',
+      "pidfile"       => REDIS_PID,
+      "port"          => 9726,
+      "timeout"       => 300,
+      "save 900"      => 1,
+      "save 300"      => 1,
+      "save 60"       => 10000,
+      "dbfilename"    => "dump.rdb",
+      "dir"           => REDIS_CACHE_PATH,
+      "loglevel"      => "debug",
+      "logfile"       => "stdout",
+      "databases"     => 16
+    }.map { |k, v| "#{k} #{v}" }.join('\n')
+    cmd = "echo '#{redis_options}' | redis-server -"
+    system cmd
+    
+    
+    uri = URI.parse("http://localhost:9726")
+    $redis = Redis.new(host: uri.host, port: uri.port)
+  end
+    
+  config.after(:suite) do
+    %x{
+      cat #{REDIS_PID} | xargs kill -QUIT
+      rm -f #{REDIS_CACHE_PATH}dump.rdb
+      rm -f #{REDIS_PID}
+    }
+  end
+end

data/spec/support/database_connection.rb

@@ -0,0 +1 @@
+ActiveRecord::Base.establish_connection adapter: "sqlite3", database: File.join(File.dirname(__FILE__), "db/test.sqlite3")

data/spec/support/database_models.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: perform_later
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,73 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2012-02-19 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70120073048240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70120073048240
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: &70120073047640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70120073047640
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: &70120073046940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70120073046940
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70120073046500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70120073046500
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70120073045940 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70120073045940
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70120073045260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70120073045260
 description: Queue any method in any class or instance with no need for additional
   Worker class and no extra code
 email:
@@ -23,10 +89,24 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- init.rb
+- lib/active_record_perform_later.rb
+- lib/active_record_worker.rb
+- lib/object_perform_later.rb
+- lib/object_worker.rb
 - lib/perform_later.rb
 - lib/perform_later/version.rb
+- lib/resque_mailer_patch.rb
+- lib/resque_perform_later.rb
+- license
 - perform_later.gemspec
-homepage: ''
+- spec/lib/resque_perform_later_spec.rb
+- spec/spec_helper.rb
+- spec/support/database_connection.rb
+- spec/support/database_models.rb
+- spec/support/db/.blank.sqlite3
+- spec/support/db/test.sqlite3
+homepage: http://www.github.com/kensodev/perform_later
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -51,4 +131,10 @@ signing_key:
 specification_version: 3
 summary: Queue any method in any class or instance with no need for additional Worker
   class and no extra code
-test_files: []
+test_files:
+- spec/lib/resque_perform_later_spec.rb
+- spec/spec_helper.rb
+- spec/support/database_connection.rb
+- spec/support/database_models.rb
+- spec/support/db/.blank.sqlite3
+- spec/support/db/test.sqlite3