qe 0.2.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 24925d0691189b9630c57dbce7ee24f17107fb6c
+  data.tar.gz: cb621b8762de804d541ae375627c31201127fadc
+SHA512:
+  metadata.gz: d4ca40ca8191277537bddef4fd7b29c0403d9cec5bdc3d30b2c3b07a8a9cf80b784d880fa7e022452ba28aafe0cda609a1b1fbc7eba9b9d4d71824ef3927df41
+  data.tar.gz: 91de3e84a38b61d045ccd3265a6e34d60a24c298498660e56986a3da0f43dc4cf8337ec2974d80543e7af843584f07a2eb0c3191076f7c78a6974c417ca51f0f

data/Gemfile

@@ -1,2 +1,6 @@
-source :rubygems
+source "https://rubygems.org"
 gemspec
+
+gem "delayed_job", "~> 4.0.0.beta2"
+gem "delayed_job_active_record", "~> 4.0.0.beta3"
+gem "rspec", "~> 2.14.0.rc1"

data/Gemfile.lock

@@ -1,91 +1,93 @@
 PATH
   remote: .
   specs:
-    qe (0.2.1)
+    qe (0.3.0)
+      activesupport
 
 GEM
-  remote: http://rubygems.org/
+  remote: https://rubygems.org/
   specs:
-    activemodel (3.2.11)
-      activesupport (= 3.2.11)
+    activemodel (3.2.13)
+      activesupport (= 3.2.13)
       builder (~> 3.0.0)
-    activerecord (3.2.11)
-      activemodel (= 3.2.11)
-      activesupport (= 3.2.11)
+    activerecord (3.2.13)
+      activemodel (= 3.2.13)
+      activesupport (= 3.2.13)
       arel (~> 3.0.2)
       tzinfo (~> 0.3.29)
-    activesupport (3.2.11)
-      i18n (~> 0.6)
+    activesupport (3.2.13)
+      i18n (= 0.6.1)
       multi_json (~> 1.0)
     arel (3.0.2)
     awesome_print (1.1.0)
-    backburner (0.3.2)
+    backburner (0.3.4)
       beaneater (~> 0.3.0)
       dante (~> 0.1.5)
     beaneater (0.3.0)
     builder (3.0.4)
-    celluloid (0.12.4)
-      facter (>= 1.6.12)
+    celluloid (0.14.1)
       timers (>= 1.0.0)
-    coderay (1.0.8)
-    connection_pool (1.0.0)
+    coderay (1.0.9)
+    connection_pool (1.1.0)
     dante (0.1.5)
-    delayed_job (3.0.5)
-      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.17)
+    delayed_job (4.0.0.beta2)
+      activesupport (>= 3.0, < 4.1)
+    delayed_job_active_record (4.0.0.beta3)
+      activerecord (>= 3.0, < 4.1)
+      delayed_job (>= 3.0, < 4.1)
+    diff-lcs (1.2.4)
     i18n (0.6.1)
+    json (1.8.0)
     method_source (0.8.1)
-    multi_json (1.5.0)
-    pry (0.9.11.4)
+    mono_logger (1.1.0)
+    multi_json (1.7.6)
+    pry (0.9.12.2)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.4)
     qu (0.2.0)
       multi_json
-    rack (1.5.1)
-    rack-protection (1.3.2)
+    rack (1.5.2)
+    rack-protection (1.5.0)
       rack
-    redis (3.0.2)
-    redis-namespace (1.2.1)
+    redis (3.0.4)
+    redis-namespace (1.3.0)
       redis (~> 3.0.0)
-    resque (1.23.0)
+    resque (1.24.1)
+      mono_logger (~> 1.0)
       multi_json (~> 1.0)
-      redis-namespace (~> 1.0)
+      redis-namespace (~> 1.2)
       sinatra (>= 0.9.2)
       vegas (~> 0.1.2)
-    resque-scheduler (2.0.0)
+    resque-scheduler (2.0.1)
       redis (>= 2.0.1)
       resque (>= 1.20.0)
       rufus-scheduler
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.2)
-    rufus-scheduler (2.0.17)
+    rspec (2.14.0.rc1)
+      rspec-core (= 2.14.0.rc1)
+      rspec-expectations (= 2.14.0.rc1)
+      rspec-mocks (= 2.14.0.rc1)
+    rspec-core (2.14.0.rc1)
+    rspec-expectations (2.14.0.rc1)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.0.rc1)
+    rufus-scheduler (2.0.19)
       tzinfo (>= 0.3.23)
-    sidekiq (2.6.5)
-      celluloid (~> 0.12.0)
-      connection_pool (~> 1.0)
-      multi_json (~> 1)
-      redis (~> 3)
+    sidekiq (2.12.1)
+      celluloid (>= 0.14.1)
+      connection_pool (>= 1.0.0)
+      json
+      redis (>= 3.0)
       redis-namespace
-    sinatra (1.3.4)
-      rack (~> 1.4)
-      rack-protection (~> 1.3)
-      tilt (~> 1.3, >= 1.3.3)
-    slop (3.4.3)
+    sinatra (1.4.2)
+      rack (~> 1.5, >= 1.5.2)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    slop (3.4.5)
     sqlite3 (1.3.7)
-    tilt (1.3.3)
+    tilt (1.4.1)
     timers (1.1.0)
-    tzinfo (0.3.35)
+    tzinfo (0.3.37)
     vegas (0.1.11)
       rack (>= 1.0.0)
 
@@ -96,12 +98,13 @@ DEPENDENCIES
   activerecord
   awesome_print
   backburner
-  delayed_job_active_record
+  delayed_job (~> 4.0.0.beta2)
+  delayed_job_active_record (~> 4.0.0.beta3)
   pry
   qe!
   qu
   resque
   resque-scheduler
-  rspec
+  rspec (~> 2.14.0.rc1)
   sidekiq
   sqlite3

data/README.md

@@ -137,6 +137,41 @@ class MailerWorker
 end
 ```
 
+This approach is good enough, but if you're using ActionMailer, try the `Qe::ActionMailer` instead, combining this extension as well.
+
+### ActionMailer integration
+
+Qe comes with an extension to send e-mails through ActionMailer. You can set the mailer and which mail will be sent.
+
+```ruby
+class Mailer < ActionMailer::Base
+  def welcome(options)
+    @options = options
+    mail :to => options[:email]
+  end
+end
+
+class MailerWorker
+  include Qe::Worker
+  include Qe::ActionMailer
+  include Qe::Locale
+
+  def mailer
+    Mailer
+  end
+end
+
+MailerWorker.enqueue(
+  :mail => :welcome,
+  :name => "John Doe",
+  :email => "john@example.org"
+)
+```
+
+If the `mailer()` method isn't defined, the `Qe::ActionMailer::AbstractMethodError` exception will be raised.
+
+If the `:mail` option isn't defined, the `Qe::ActionMailer::MissingMailNameError` exception will be raised.
+
 ### 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!

data/examples/workers.rb

@@ -1,6 +1,5 @@
-require "bundler"
-Bundler.setup(:default, ENV.fetch("GROUP"))
-Bundler.require
+require "bundler/setup"
+Bundler.require(:default, ENV.fetch("GROUP"))
 
 require "time"
 

data/lib/qe.rb

@@ -1,4 +1,7 @@
+require "active_support/hash_with_indifferent_access"
+
 require "qe/action"
+require "qe/action_mailer"
 require "qe/locale"
 require "qe/immediate"
 require "qe/version"

data/lib/qe/action_mailer.rb

@@ -0,0 +1,22 @@
+module Qe
+  module ActionMailer
+    MissingMailNameError = Class.new(StandardError)
+    AbstractMethodError = Class.new(StandardError)
+
+    def mail
+      raise MissingMailNameError,
+        "the :mail option is not defined" unless options[:mail]
+
+      mailer.public_send(options[:mail], options)
+    end
+
+    def mailer
+      raise AbstractMethodError,
+        "you must implement the mailer method"
+    end
+
+    def perform
+      mail.deliver
+    end
+  end
+end

data/lib/qe/version.rb

@@ -1,3 +1,3 @@
 module Qe
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/qe/worker/instance_methods.rb

@@ -2,7 +2,7 @@ module Qe
   module Worker
     module InstanceMethods
       def initialize(options)
-        @options = options
+        @options = options.with_indifferent_access
       end
 
       # Return options that were provided when

data/qe.gemspec

@@ -17,6 +17,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_dependency "activesupport"
+
   s.add_development_dependency "sidekiq"
   s.add_development_dependency "qu"
   s.add_development_dependency "delayed_job_active_record"

data/spec/qe/action_mailer_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+
+describe Qe::ActionMailer do
+  let(:worker) {
+    Class.new do
+      include Qe::Worker
+      include Qe::ActionMailer
+    end
+  }
+
+  let(:mailer) { double(:mailer) }
+
+  subject(:job) {
+    worker.new(
+      :name => "John Doe",
+      :email => "john@example.org",
+      :mail => :hello
+    )
+  }
+
+  describe "#mail" do
+    it "raises error when have no :mail" do
+      job.options.delete(:mail)
+
+      expect {
+        job.mail
+      }.to raise_error(Qe::ActionMailer::MissingMailNameError)
+    end
+
+    it "returns object for :mail option" do
+      job.stub :mailer => mailer
+
+      mailer
+        .should_receive(:hello)
+        .with(job.options)
+
+      job.mail
+    end
+  end
+
+  describe "#mailer" do
+    it "raises error when method implemented" do
+      expect {
+        job.mailer
+      }.to raise_error(Qe::ActionMailer::AbstractMethodError)
+    end
+  end
+
+  describe "#perform" do
+    it "delivers e-mail" do
+      mail = double(:mail)
+      job.stub :mail => mail
+
+      mail.should_receive(:deliver)
+
+      job.perform
+    end
+  end
+end

data/spec/qe/beanstalk_spec.rb

@@ -19,7 +19,7 @@ describe Qe::Beanstalk do
 
   context "enqueuing" do
     let(:worker) {
-      mock("worker", :queue => "some_queue", :name => "SomeWorker")
+      double("worker", :queue => "some_queue", :name => "SomeWorker")
     }
 
     before do
@@ -45,7 +45,7 @@ describe Qe::Beanstalk do
 
   context "scheduling" do
     let(:worker) {
-      mock("worker", :queue => "some_queue", :name => "SomeWorker")
+      double("worker", :queue => "some_queue", :name => "SomeWorker")
     }
 
     let(:date) { Time.parse("2012-12-05 02:00:00") }

data/spec/qe/delayed_job_spec.rb

@@ -22,7 +22,7 @@ describe Qe::DelayedJob do
 
   context "enqueuing" do
     let(:worker) {
-      mock("worker", :queue => "some_queue", :name => "SomeWorker")
+      double("worker", :queue => "some_queue", :name => "SomeWorker")
     }
 
     before do
@@ -46,7 +46,7 @@ describe Qe::DelayedJob do
     end
 
     it "enqueues job" do
-      job = mock("job")
+      job = double("job")
       Qe::DelayedJob::Worker.stub :new => job
 
       Delayed::Job
@@ -59,7 +59,7 @@ describe Qe::DelayedJob do
 
   context "scheduling" do
     let(:worker) {
-      mock("worker", :queue => "some_queue", :name => "SomeWorker")
+      double("worker", :queue => "some_queue", :name => "SomeWorker")
     }
 
     let(:date) { Time.now }
@@ -85,7 +85,7 @@ describe Qe::DelayedJob do
     end
 
     it "schedules job" do
-      job = mock("job")
+      job = double("job")
       Qe::DelayedJob::Worker.stub :new => job
 
       Delayed::Job

data/spec/qe/immediate_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe Qe::Immediate do
-  let(:job) { mock("job").as_null_object }
+  let(:job) { double("job").as_null_object }
 
   it "sets options" do
     HelloWorker

data/spec/qe/locale_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
 describe Qe::Locale do
-  let(:i18n) { mock("I18n", :locale => :en) }
+  let(:i18n) { double("I18n", :locale => :en) }
 
   before do
     stub_const("I18n", i18n)

data/spec/qe/qu_spec.rb

@@ -19,7 +19,7 @@ describe Qe::Qu do
 
   context "enqueuing" do
     let(:worker) {
-      mock("worker", :queue => "some_queue", :name => "SomeWorker")
+      double("worker", :queue => "some_queue", :name => "SomeWorker")
     }
 
     before do
@@ -43,7 +43,7 @@ describe Qe::Qu do
   context "scheduling" do
     it "raises exception" do
       expect {
-        Qe::Qu.schedule(stub, Time.now, :a => 1)
+        Qe::Qu.schedule(double, Time.now, :a => 1)
       }.to raise_error(Qe::UnsupportedFeatureError)
     end
   end

data/spec/qe/resque_spec.rb

@@ -19,7 +19,7 @@ describe Qe::Resque do
 
   context "enqueuing" do
     let(:worker) {
-      mock("worker", :queue => "some_queue", :name => "SomeWorker")
+      double("worker", :queue => "some_queue", :name => "SomeWorker")
     }
 
     before do
@@ -44,7 +44,7 @@ describe Qe::Resque do
     let(:date) { Time.now }
 
     let(:worker) {
-      mock("worker", :queue => "some_queue", :name => "SomeWorker")
+      double("worker", :queue => "some_queue", :name => "SomeWorker")
     }
 
     before do

data/spec/qe/sidekiq_spec.rb

@@ -23,7 +23,7 @@ describe Qe::Sidekiq do
 
   context "enqueuing" do
     let(:worker) {
-      mock("worker", :queue => "some_queue", :name => "SomeWorker")
+      double("worker", :queue => "some_queue", :name => "SomeWorker")
     }
 
     before do
@@ -49,7 +49,7 @@ describe Qe::Sidekiq do
 
   context "scheduling" do
     let(:worker) {
-      mock("worker", :queue => "some_queue", :name => "SomeWorker")
+      double("worker", :queue => "some_queue", :name => "SomeWorker")
     }
 
     before do

data/spec/qe/worker_spec.rb

@@ -8,11 +8,18 @@ describe Qe::Worker do
 
   it "returns options" do
     hello = HelloWorker.new(:a => 1)
-    expect(hello.options).to eql(:a => 1)
+    expect(hello.options).to include(:a => 1)
+  end
+
+  it "returns options as HashWithIndifferentAccess" do
+    hello = HelloWorker.new("a" => 1)
+
+    expect(hello.options[:a]).to eql(1)
+    expect(hello.options["a"]).to eql(1)
   end
 
   it "delegates #enqueue to adapter" do
-    adapter = mock("adapter")
+    adapter = double("adapter")
     adapter
       .should_receive(:enqueue)
       .with(HelloWorker, :a => 1)
@@ -23,7 +30,7 @@ describe Qe::Worker do
   end
 
   it "delegates scheduling to adapter" do
-    adapter = mock("adapter")
+    adapter = double("adapter")
     date = Time.now
     adapter
       .should_receive(:schedule)
@@ -35,7 +42,7 @@ describe Qe::Worker do
   end
 
   it "finds worker by its name" do
-    worker = mock("worker")
+    worker = double("worker")
     stub_const "Some::Weird::Worker", worker
 
     expect(Qe::Worker.find("Some::Weird::Worker")).to eql(worker)
@@ -55,7 +62,7 @@ describe Qe::Worker do
       HelloWorker
         .should_receive(:new)
         .with(:a => 1)
-        .and_return(mock.as_null_object)
+        .and_return(double.as_null_object)
 
       Qe::Worker.perform("HelloWorker", :a => 1)
     end

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
-require "bundler"
-Bundler.setup(:default, :development)
+require "bundler/setup"
 Bundler.require(:default, :development)
 
 require "qe"

metadata

@@ -1,190 +1,181 @@
 --- !ruby/object:Gem::Specification
 name: qe
 version: !ruby/object:Gem::Version
-  version: 0.2.1
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-02 00:00:00.000000000 Z
+date: 2013-06-07 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sidekiq
   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: qu
   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: delayed_job_active_record
   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: backburner
   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: resque
   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: resque-scheduler
   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: activerecord
   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: awesome_print
   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: pry
   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: '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: sqlite3
   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'
 description: A simple interface over several background job libraries like Resque,
@@ -217,6 +208,7 @@ files:
 - examples/workers.rb
 - lib/qe.rb
 - lib/qe/action.rb
+- lib/qe/action_mailer.rb
 - lib/qe/beanstalk.rb
 - lib/qe/delayed_job.rb
 - lib/qe/immediate.rb
@@ -231,6 +223,7 @@ files:
 - lib/qe/worker/class_methods.rb
 - lib/qe/worker/instance_methods.rb
 - qe.gemspec
+- spec/qe/action_mailer_spec.rb
 - spec/qe/action_spec.rb
 - spec/qe/beanstalk_spec.rb
 - spec/qe/delayed_job_spec.rb
@@ -246,27 +239,26 @@ files:
 - spec/support/localized_worker.rb
 homepage: http://rubygems.org/gems/qe
 licenses: []
+metadata: {}
 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.25
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A simple interface over several background job libraries like Resque, Sidekiq
   and DelayedJob.
 test_files: []