qe 0.1.3

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+*.sqlite3
+*.rdb
+pkg

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation --order random

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/Gemfile.lock

@@ -0,0 +1,100 @@
+PATH
+  remote: .
+  specs:
+    qe (0.1.3)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    awesome_print (1.1.0)
+    backburner (0.2.5)
+      beaneater (~> 0.1.2)
+      dante (~> 0.1.5)
+    beaneater (0.1.2)
+    builder (3.0.4)
+    celluloid (0.12.3)
+      facter (>= 1.6.12)
+      timers (>= 1.0.0)
+    coderay (1.0.8)
+    connection_pool (0.9.2)
+    dante (0.1.5)
+    delayed_job (3.0.3)
+      activesupport (~> 3.0)
+    delayed_job_active_record (0.3.3)
+      activerecord (>= 2.1.0, < 4)
+      delayed_job (~> 3.0)
+    diff-lcs (1.1.3)
+    facter (1.6.14)
+    i18n (0.6.1)
+    method_source (0.8.1)
+    multi_json (1.3.7)
+    pry (0.9.10)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.3.1)
+    qu (0.2.0)
+      multi_json
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    redis (3.0.2)
+    redis-namespace (1.2.1)
+      redis (~> 3.0.0)
+    resque (1.23.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.0)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    sidekiq (2.5.2)
+      celluloid (~> 0.12.0)
+      connection_pool (~> 0.9.2)
+      multi_json (~> 1)
+      redis (~> 3)
+      redis-namespace
+    sinatra (1.3.3)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    slop (3.3.3)
+    sqlite3 (1.3.6)
+    tilt (1.3.3)
+    timers (1.0.1)
+    tzinfo (0.3.35)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  awesome_print
+  backburner
+  delayed_job_active_record
+  pry
+  qe!
+  qu
+  resque
+  rspec
+  sidekiq
+  sqlite3

data/README.md

@@ -0,0 +1,144 @@
+# Qe
+
+A simple interface over several background job libraries like Resque, Sidekiq and DelayedJob.
+
+## Usage
+
+In this wild world where a new asynchronous job processing
+library is released every once in a while, Qe tries to keep a unified
+interface that works with the most famous libraries:
+
+* [Sidekiq](http://mperham.github.com/sidekiq/)
+* [Resque](https://github.com/defunkt/resque/)
+* [DelayedJob](https://github.com/collectiveidea/delayed_job)
+* [Qu](https://github.com/bkeepers/qu)
+* [Beanstalk](https://github.com/kr/beanstalkd)/[Backburner](http://nesquena.github.com/backburner/)
+
+To set the adapter, just load the file according to your adapter:
+
+``` ruby
+require "qe/resque"
+require "qe/qu"
+require "qe/delayed_job"
+require "qe/beanstalk"
+```
+
+You also need to require the library you're going to use. If you're using Rails with Bundler, you can simple require the correct file and dependency.
+
+``` ruby
+source :rubygems
+gem "rails", "3.2.8"
+
+gem "sidekiq"
+gem "qe", :require => "qe/sidekiq"
+
+gem "resque"
+gem "qe", :require => "qe/resque"
+
+gem "qu"
+gem "qe", :require => "qe/qu"
+
+gem "backburner"
+gem "qe", :require => "qe/beanstalk"
+```
+
+Create a worker that will send e-mails through `ActionMailer`.
+
+``` ruby
+class MailerWorker
+  include Qe::Worker
+
+  def perform
+    Mailer.public_send(options[:mail], options).deliver
+  end
+end
+```
+
+Define our `Mailer` class.
+
+``` ruby
+class Mailer < ActionMailer::Base
+  def welcome(options)
+    @options = options
+    mail :to => options[:email]
+  end
+end
+```
+
+Enqueue a job to be processed asynchronously.
+
+``` ruby
+MailerWorker.enqueue({
+  :mail => :welcome,
+  :email => "john@example.org",
+  :name => "John Doe"
+})
+```
+
+## Development support
+
+Qe comes with development support. Instead of starting up workers on development environment, you can use the `Qe::Immediate` adapter, which executes your worker right away!
+
+``` ruby
+Qe.adapter = Qe::Immediate
+```
+
+If you're using Rails, you can add the line above to your `config/environments/development.rb` file.
+
+## Testing support
+
+Qe also comes with testing support. Just require the `qe/testing.rb` file
+and a fake queuing adapter will be used. All enqueued jobs will be stored
+at `Qe.jobs`. Note that this method is only available on testing mode.
+
+``` ruby
+require "qe/testing"
+Qe.adapter = Qe::Testing
+```
+
+If you"re using RSpec, you can require the `qe/testing/rspec.rb` file
+instead. This will reset `Qe.jobs` before every spec and will add a
+`enqueue` matcher.
+
+``` ruby
+# Add the following like to your spec_helper.rb file
+require "qe/testing/rspec"
+
+describe "Enqueuing a job" do
+  it "enqueues job" do
+    expect {
+      # do something
+    }.to enqueue(MailerWorker).with(:email => "john@example.org")
+  end
+end
+```
+
+
+Maintainer
+----------
+
+* Nando Vieira (<http://nandovieira.com.br>)
+
+License:
+--------
+
+(The 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/Rakefile

@@ -0,0 +1,5 @@
+require "bundler"
+Bundler::GemHelper.install_tasks
+
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new

data/examples/.env

@@ -0,0 +1,3 @@
+QUEUES="mail,default"
+QUEUE="mail,default"
+BEANSTALK_URL="beanstalk://localhost/"

data/examples/Gemfile

@@ -0,0 +1,14 @@
+source :rubygems
+
+gem "sidekiq"
+gem "backburner"
+gem "beanstalkd_view"
+gem "rake"
+gem "thin"
+gem "resque"
+gem "activerecord"
+gem "delayed_job_active_record"
+gem "sqlite3"
+gem "daemons"
+gem "qu-redis"
+gem "slim"

data/examples/Gemfile.lock

@@ -0,0 +1,119 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activerecord (3.2.8)
+      activemodel (= 3.2.8)
+      activesupport (= 3.2.8)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    backburner (0.2.0)
+      beaneater (~> 0.1.2)
+      dante (~> 0.1.5)
+    backports (2.6.5)
+    beaneater (0.1.2)
+    beanstalkd_view (1.1.0)
+      beaneater (~> 0.1.0)
+      json
+      sinatra (>= 1.3.0)
+      sinatra-assetpack (>= 0.0.11)
+      sinatra-contrib (>= 1.3.0)
+      vegas (~> 0.1.2)
+    builder (3.0.4)
+    celluloid (0.12.3)
+      facter (>= 1.6.12)
+      timers (>= 1.0.0)
+    connection_pool (0.9.2)
+    daemons (1.1.9)
+    dante (0.1.5)
+    delayed_job (3.0.3)
+      activesupport (~> 3.0)
+    delayed_job_active_record (0.3.3)
+      activerecord (>= 2.1.0, < 4)
+      delayed_job (~> 3.0)
+    eventmachine (1.0.0)
+    facter (1.6.14)
+    i18n (0.6.1)
+    jsmin (1.0.1)
+    json (1.7.5)
+    multi_json (1.3.7)
+    qu (0.2.0)
+      multi_json
+    qu-redis (0.2.0)
+      qu (= 0.2.0)
+      redis-namespace
+      simple_uuid
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (0.9.2.2)
+    redis (3.0.2)
+    redis-namespace (1.2.1)
+      redis (~> 3.0.0)
+    resque (1.23.0)
+      multi_json (~> 1.0)
+      redis-namespace (~> 1.0)
+      sinatra (>= 0.9.2)
+      vegas (~> 0.1.2)
+    sidekiq (2.5.2)
+      celluloid (~> 0.12.0)
+      connection_pool (~> 0.9.2)
+      multi_json (~> 1)
+      redis (~> 3)
+      redis-namespace
+    simple_uuid (0.2.0)
+    sinatra (1.3.3)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    sinatra-assetpack (0.0.11)
+      jsmin
+      rack-test
+      sinatra
+      tilt (>= 1.3.0)
+    sinatra-contrib (1.3.2)
+      backports (>= 2.0)
+      eventmachine
+      rack-protection
+      rack-test
+      sinatra (~> 1.3.0)
+      tilt (~> 1.3)
+    slim (1.3.3)
+      temple (~> 0.5.5)
+      tilt (~> 1.3.3)
+    sqlite3 (1.3.6)
+    temple (0.5.5)
+    thin (1.5.0)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    tilt (1.3.3)
+    timers (1.0.1)
+    tzinfo (0.3.35)
+    vegas (0.1.11)
+      rack (>= 1.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activerecord
+  backburner
+  beanstalkd_view
+  daemons
+  delayed_job_active_record
+  qu-redis
+  rake
+  resque
+  sidekiq
+  slim
+  sqlite3
+  thin

data/examples/Procfile

@@ -0,0 +1,20 @@
+redis: redis-server redis.conf
+# beanstalkd: beanstalkd
+
+# Uncomment the following lines to enable Sidekiq
+sidekiq: bundle exec sidekiq -r ./workers.rb -q default -q mail
+sidekiq_web: bundle exec thin -R sidekiq.ru -p 9292 -V start
+
+# Uncomment the following lines to enable Beanstalk/Backburner
+# backburner: bundle exec rake backburner:work
+# beanstalkd_view: bundle exec thin -R beanstalkd.ru -p 9292 -V start
+
+# Uncomment the following line to enable DelayedJob
+# delayed_job: bundle exec rake jobs:work
+
+# Uncomment the following line to enable Qu
+# qu: bundle exec rake qu:work
+
+# Uncomment the following lines to enable Resque
+# resque: bundle exec rake resque:work
+# resque_web: bundle exec thin -R resque.ru -p 9292 -V start

data/examples/README.md

@@ -0,0 +1,9 @@
+# Running examples
+
+1. First, start processes with `$ foreman start`
+2. Then execute `$ ruby sample.rb`
+3. Go back to the Foreman's terminal and watch the output
+
+Tweak the `Procfile` to enable different libraries and web panels.
+
+You'll need to install Redis and/or Beanstalkd.

data/examples/Rakefile

@@ -0,0 +1,14 @@
+require "backburner/tasks"
+require "resque/tasks"
+require "delayed/tasks"
+require "qu/tasks"
+
+task :environment do #=> required by Backburner
+  require "./workers"
+
+  Backburner.configure do |config|
+    config.logger = Logger.new(STDOUT)
+  end
+end
+
+task "resque:setup" => :environment