backgrounder 0.0.1

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,2 @@
+--color
+--format=d

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Zbigniew Humeniuk
+
+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,64 @@
+# Backgrounder
+
+Create background jobs using Redis with ease.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'backgrounder'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install backgrounder
+
+## Usage
+
+    class Dummy < ActiveRecord::Base
+      include Backgrounder::Handler
+
+      @queue = :high
+
+      def self.foo
+        # ...
+      end
+
+      def bar
+        # ...
+      end
+    end
+
+    dummy = Dummy.create
+
+    Backgrounder::Placer.new(Dummy, :foo).place
+
+    Backgrounder::Placer.new(dummy, :bar, queue: :processing).place
+
+
+    class Puppet
+      include Backgrounder::Handler
+
+      def initialize args={}
+        # ...
+      end
+
+      def foo
+        # ...
+      end
+    end
+
+    Backgrounder::Placer.new(Puppet, :foo, args: {
+      init_args: {content: 'foo', phone: 'bar'}
+    }, queue: :critical).place  # Puppet.new('content' => 'foo', 'phone' => 'bar'}).foo
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/backgrounder.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'backgrounder/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "backgrounder"
+  spec.version       = Backgrounder::VERSION
+  spec.authors       = ["Zbigniew Humeniuk"]
+  spec.email         = ["zbigniew.humeniuk@gmail.com"]
+  spec.description   = %q{Create background jobs using Redis with ease.}
+  spec.summary       = %q{Create background jobs using Redis with ease.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'activesupport', '>= 3.0.0'
+  spec.add_dependency 'resque', '>= 1.24.1'
+  spec.add_dependency 'json', '>= 1.7.7'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.13.0"
+  spec.add_development_dependency "resque_spec", "~> 0.13.0"
+end

data/lib/backgrounder.rb

@@ -0,0 +1,10 @@
+module Backgrounder
+end
+
+require 'active_support/concern' unless defined?(ActiveSupport::Concern)
+require 'resque'
+
+require "backgrounder/version"
+require "backgrounder/handler"
+require "backgrounder/placer"
+require "backgrounder/resque/queue"

data/lib/backgrounder/handler.rb

@@ -0,0 +1,21 @@
+module Backgrounder::Handler
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def perform(id, action, *args)
+      case id
+      when 'new'
+        obj = if args.any? && args.first.is_a?(Hash) && args.first['init_args']
+          new args.first['init_args']
+        else
+          new
+        end
+        obj.send action
+      when nil
+        send action
+      else
+        find(id).send(action)
+      end
+    end
+  end
+end

data/lib/backgrounder/placer.rb

@@ -0,0 +1,33 @@
+class Backgrounder::Placer
+  def initialize(obj, method_name, opts = {})
+    if obj.class == Class
+      @klass = obj
+      @obj_id = opts[:args] && opts[:args][:init_args] ? 'new' : nil
+    else
+      @klass = obj.class
+      @obj_id = fetch_id obj
+    end
+    @method_name = method_name
+    @queue = opts[:queue] ? opts[:queue] : fetch_queue_name
+    @args = opts[:args] ? opts[:args] : nil
+  end
+
+  def place
+    Resque::Job.create @queue, @klass, @obj_id, @method_name, @args
+  end
+
+
+  private
+
+    def fetch_queue_name
+      @klass.instance_variable_get "@queue"
+    end
+
+    def fetch_id obj
+      if obj.respond_to? :id
+        obj.id ? obj.id : 'new'
+      else
+        'new'
+      end
+    end
+end

data/lib/backgrounder/resque/queue.rb

@@ -0,0 +1,8 @@
+# coding: utf-8
+module Backgrounder::Resque
+  module Queue
+    Critical = :critical
+    High = :high
+    Low = :low
+  end
+end

data/lib/backgrounder/version.rb

@@ -0,0 +1,3 @@
+module Backgrounder
+  VERSION = "0.0.1"
+end

data/spec/fixtures/backgrounder/dummy.rb

@@ -0,0 +1,9 @@
+class Backgrounder::Dummy
+  include Backgrounder::Handler
+
+  @queue = Backgrounder::Resque::Queue::High
+
+  def id
+    123
+  end
+end

data/spec/lib/backgrounder/handler_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe Backgrounder::Handler do
+  it "includes perform class method" do
+    Backgrounder::Dummy.stub(:perform){ |arg1, arg2| true }
+    Backgrounder::Dummy.perform(1, :dummy_method).should be_true
+  end
+
+  context "id is set" do
+    it "calls method passed as second arg on object with ID passed as first arg" do
+      Backgrounder::Dummy.stub(:find).with(1){ Backgrounder::Dummy.new }
+      Backgrounder::Dummy.any_instance.stub(:dummy_method){ true }
+      Backgrounder::Dummy.should_receive(:find).with(1)
+      Backgrounder::Dummy.any_instance.should_receive(:dummy_method)
+      Backgrounder::Dummy.perform(1, :dummy_method)
+    end
+  end
+
+  context "id is nil" do
+    it "calls class method passed as second arg" do
+      Backgrounder::Dummy.stub(:dummy_method){ true }
+      Backgrounder::Dummy.should_receive(:dummy_method)
+      Backgrounder::Dummy.perform(nil, :dummy_method)
+    end
+  end
+
+  context "id is 'new'" do
+    it "calls method on new object" do
+      Backgrounder::Dummy.any_instance.stub(:dummy_method){ true }
+      Backgrounder::Dummy.any_instance.should_receive(:dummy_method)
+      Backgrounder::Dummy.perform('new', :dummy_method)
+    end
+
+    it "initialize new object with init_args" do
+      dummy = double('backgrounder_dummy')
+      Backgrounder::Dummy.stub(:new).with({'foo' => 'bar', 'fuz' => 'buz'}).and_return{ dummy }
+      dummy.should_receive(:dummy_method).once
+      Backgrounder::Dummy.perform 'new', :dummy_method, {'init_args' => {'foo' => 'bar', 'fuz' => 'buz'}}
+    end
+  end
+end

data/spec/lib/backgrounder/placer_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Backgrounder::Placer do
+  describe "instance methods" do
+    describe "#initialize" do
+      it "can get 3 parameters" do
+        Backgrounder::Placer.new(Backgrounder::Dummy.new, :dummy_method, queue: :processing).
+          should be_instance_of(Backgrounder::Placer)
+      end
+    end
+
+    describe "#place" do
+      it "adds dummy_method to the processing queue of Backgrounder::Dummy" do
+        Backgrounder::Placer.new(Backgrounder::Dummy.new, :dummy_method, queue: :processing).place
+        Backgrounder::Dummy.should have_queued(123, :dummy_method, nil).in(:processing)
+      end
+
+      it "adds dummy_method to the default queue of Backgrounder::Dummy" do
+        Backgrounder::Placer.new(Backgrounder::Dummy.new, :dummy_method).place
+        Backgrounder::Dummy.should have_queued(123, :dummy_method, nil).in(:high)
+      end
+
+      it "adds nil as first arg of queue if placer works on class" do
+        Backgrounder::Placer.new(Backgrounder::Dummy, :dummy_method).place
+        Backgrounder::Dummy.should have_queued(nil, :dummy_method, nil)
+      end
+
+      it "adds args to queue" do
+        Backgrounder::Placer.new(Backgrounder::Dummy.new, :dummy_method, args: {'foo' => {'bar' => 'baz'}}).place
+        Backgrounder::Dummy.should have_queued(123, :dummy_method, {'foo' => {'bar' => 'baz'}})
+      end
+
+      it "adds new as first arg if object's ID is nil" do
+        obj = Backgrounder::Dummy.new
+        obj.stub(:id){ nil }
+        Backgrounder::Placer.new(obj, :dummy_method).place
+        Backgrounder::Dummy.should have_queued('new', :dummy_method, nil)
+      end
+
+      it "adds new as first arg if object does not respond to id" do
+        obj = Backgrounder::Dummy.new
+        obj.stub(:id){ raise NoMethodError, 'undefined method id' }
+        obj.stub(:respond_to?).with(:id).and_return{ false }
+        Backgrounder::Placer.new(obj, :dummy_method).place
+        Backgrounder::Dummy.should have_queued('new', :dummy_method, nil)
+      end
+
+      it "adds new as first arg if placer works on class and init_args are passed" do
+        Backgrounder::Placer.new(Backgrounder::Dummy, :dummy_method, args: {init_args: {'foo' => 'bar'}}).place
+        Backgrounder::Dummy.should have_queued('new', :dummy_method, {init_args: {'foo' => 'bar'}})
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'bundler/setup'
+require 'resque_spec'
+
+Bundler.require
+
+Dir["#{File.dirname(__FILE__)}/fixtures/**/*.rb"].each{|f| require f}
+
+RSpec.configure do |config|
+  config.order = "random"
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: backgrounder
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Zbigniew Humeniuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: resque
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.24.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.24.1
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: resque_spec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+description: Create background jobs using Redis with ease.
+email:
+- zbigniew.humeniuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- backgrounder.gemspec
+- lib/backgrounder.rb
+- lib/backgrounder/handler.rb
+- lib/backgrounder/placer.rb
+- lib/backgrounder/resque/queue.rb
+- lib/backgrounder/version.rb
+- spec/fixtures/backgrounder/dummy.rb
+- spec/lib/backgrounder/handler_spec.rb
+- spec/lib/backgrounder/placer_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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.24
+signing_key: 
+specification_version: 3
+summary: Create background jobs using Redis with ease.
+test_files:
+- spec/fixtures/backgrounder/dummy.rb
+- spec/lib/backgrounder/handler_spec.rb
+- spec/lib/backgrounder/placer_spec.rb
+- spec/spec_helper.rb