postpone 0.1.0

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/.rspec

@@ -0,0 +1,5 @@
+--color
+-fs
+-Ilib
+-Ispec
+--require spec_helper

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Linus Oleander
+
+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,97 @@
+# Postpone
+
+A [Beanstalkd](http://kr.github.com/beanstalkd/) backed asynchronous priority queue.
+
+## Why beanstalkd?
+
+In contrast to other asynchronous priority queues Beanstalkd doesn't use polling behind the scene.
+This means that your jobs will start faster.
+
+## Installation
+
+Add this line to your application's Gemfile:
+``` ruby
+gem "postpone"
+```
+
+And then execute:
+```
+$ bundle
+```
+
+Or install it yourself as:
+```    
+$ gem install postpone
+```
+
+## Invoke
+
+Call `postpone` on any given object to *postpone* the execution.
+
+``` ruby
+User.first.postpone.notify!
+```
+
+*Postpone* **cannot** postpone blocks. Why is explained [here](http://stackoverflow.com/a/38588/560073).
+
+``` ruby
+User.first.postpone.notify! { "How do you do?" }
+```
+
+## Worker
+
+*Postpone* is build on top of [beanstalkd](http://kr.github.com/beanstalkd/) and [stalker](https://github.com/adamwiggins/stalker) which means that you need an external worker.
+
+### Creating a worker
+
+Create a file called `jobs.rb` and add the following code to it
+
+``` ruby
+require "postpone/worker"
+```
+
+Add your own worker to the same file, if you have any.  
+Take a look at the [official stalker repo](https://github.com/han/stalker) for more information.
+
+``` ruby
+Stalker::job "email.send" do |args|
+  Pony.send(to: args['to'], subject: "Hello there")
+end
+```
+
+Start your worker using `stalk jobs.rb`
+
+## Hint
+
+Keep in mind that the object you are trying to *postpone* needs to be available on both sides.
+So if you're trying to *postpone* an operation on a rails object you need to load the rails environment on the worker side too.
+
+``` ruby
+# Loading rails
+require File.expand_path("../environment", __FILE__)
+
+# Loading postpone
+require "postpone/worker"
+```
+
+## Alternatives
+
+- [Delayed job](https://github.com/tobi/delayed_job) 
+- [resque](https://github.com/defunkt/resque)
+
+## Testing
+
+Start by installing [rspec](https://github.com/dchelimsky/rspec).  
+Then, run the tests using `rspec .`
+
+## 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
+
+## License
+
+*Postpone* is released under the *MIT License*.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/postpone.rb

@@ -0,0 +1,2 @@
+require_relative "./postpone/invoke"
+Object.send(:include, Postpone)

data/lib/postpone/invoke.rb

@@ -0,0 +1,20 @@
+require "stalker"
+
+module Postpone
+  def postpone; Invoke.new(self); end
+  def self.postpone; Invoke.new(self); end
+  
+  class Invoke
+    def initialize(object)
+      @object = object
+    end
+    
+    def method_missing(method, *args)
+      !! Stalker.enqueue("postpone.worker", {
+        method: method,
+        args: Marshal.dump(args),
+        object: Marshal.dump(@object)
+      })
+    end
+  end
+end

data/lib/postpone/worker.rb

@@ -0,0 +1,14 @@
+require "stalker"
+
+module Postpone
+  class Worker
+    def initialize(args)
+      Marshal.load(args["object"]).
+        send(args["method"], *Marshal.load(args["args"]))
+    end
+  end  
+end
+
+Stalker::job "postpone.worker" do |args|
+  Postpone::Worker.new(args)
+end

data/postpone.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.authors       = ["Linus Oleander"]
+  gem.email         = ["linus@oleander.nu"]
+  gem.description   = %q{Beanstalkd backed asynchronous priority queue}
+  gem.summary       = %q{Beanstalkd backed asynchronous priority queue}
+  gem.homepage      = "https://github.com/oleander/postpone-rb"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "postpone"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.1.0"
+  
+  gem.add_dependency("stalker")
+  gem.add_development_dependency("rspec")
+  gem.required_ruby_version = "~> 1.9.0"
+end

data/spec/postpone_spec.rb

@@ -0,0 +1,102 @@
+
+describe Postpone::Invoke do  
+  describe "instance" do
+    subject { Example.new }
+    it "should invoke stalker, without arguments" do
+      Stalker.should_receive(:enqueue).with("postpone.worker", translate({
+        args: [],
+        object: subject,
+        method: :method1
+      }))
+
+      subject.postpone.method1
+    end
+
+    it "should invoke stalker, with arguments" do
+      Stalker.should_receive(:enqueue).with("postpone.worker", translate({
+        args: ["value1", "value2"],
+        object: subject,
+        method: :method2
+      }))
+
+      subject.postpone.method2("value1", "value2")
+    end
+  end
+  
+  describe "class method" do
+    subject { Example }
+    it "should invoke stalker, without arguments" do
+      Stalker.should_receive(:enqueue).with("postpone.worker", translate({
+        args: [],
+        object: subject,
+        method: :method3
+      }))
+
+      subject.postpone.method3
+    end
+
+    it "should invoke stalker, with arguments" do
+      Stalker.should_receive(:enqueue).with("postpone.worker", translate({
+        args: ["value1", "value2"],
+        object: subject,
+        method: :method4
+      }))
+
+      subject.postpone.method4("value1", "value2")
+    end
+  end  
+end
+
+describe Postpone::Worker do
+  describe "instance" do
+    subject { Example.new }
+    
+    before(:all) { $method1, $method2 = nil, nil }
+    
+    it "should call instance method, without arguments" do
+      Postpone::Worker.new(translate({
+        args: [],
+        object: subject,
+        method: :method1
+      }, "string"))
+      
+      $method1.should_not be_nil
+    end
+    
+    it "should call instance method, with arguments" do
+      Postpone::Worker.new(translate({
+        args: ["value1", "value2"],
+        object: subject,
+        method: :method2
+      }, "string"))
+      
+      $method2.should_not be_nil
+    end    
+  end
+  
+  describe "class method" do
+    subject { Example }
+    
+    before(:all) { $method3, $method4 = nil, nil }
+    
+    it "should call instance method, without arguments" do
+      Postpone::Worker.new(translate({
+        args: [],
+        object: subject,
+        method: :method3
+      }, "string"))
+      
+      $method3.should_not be_nil
+    end
+    
+    it "should call instance method, with arguments" do
+      Postpone::Worker.new(translate({
+        args: ["value1", "value2"],
+        object: subject,
+        method: :method4
+      }, "string"))
+      
+      $method4.should_not be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+require "rspec"
+require_relative "../lib/postpone"
+require_relative "../lib/postpone/worker"
+
+module Helpers
+  def translate(hash, type = "symbol")
+    args = Marshal.dump(hash[:args])
+    object = Marshal.dump(hash[:object])
+    method = hash[:method]
+    
+    case type
+    when "symbol"
+      { args: args, object: object, method: method }
+    when "string"
+      { "args" => args, "object" => object, "method" => method }
+    end
+  end
+end
+
+class Example
+  def method1; $method1 = 1; end
+  def method2(value1, value2); $method2 = 1; end
+  def self.method3; $method3 = 1; end
+  def self.method4(value1, value2); $method4 = 1; end
+end
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.include Helpers
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification 
+name: postpone
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Linus Oleander
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-26 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: stalker
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: Beanstalkd backed asynchronous priority queue
+email: 
+- linus@oleander.nu
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/postpone.rb
+- lib/postpone/invoke.rb
+- lib/postpone/worker.rb
+- postpone.gemspec
+- spec/postpone_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/oleander/postpone-rb
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ~>
+    - !ruby/object:Gem::Version 
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: Beanstalkd backed asynchronous priority queue
+test_files: 
+- spec/postpone_spec.rb
+- spec/spec_helper.rb