dj_mailer 0.0.2 → 0.0.3

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 andrea longhi
+Copyright (c) 2012 Andrea Longhi
 
 MIT License
 
@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -36,6 +36,21 @@ Or install it yourself as:
   gem install dj_mailer
 ```
 
+## Configuration
+
+Delayed e-mails is an awesome thing in production environments, but for e-mail specs/tests in testing environments it can be a mess causing specs/tests to fail because the e-mail haven't been sent directly. Therefore you can configure what environments that should be excluded like so:
+
+```ruby
+  # config/initializers/dj_mailer.rb
+
+  DjMailer::Delayable.excluded_environments = [:test, :cucumber]  # etc.
+```
+
+## Documentation
+
+You can find some more documentation on the workings of the gem on relish:
+https://www.relishapp.com/spaghetticode/dj-mailer/docs
+
 
 ## Tests
 

data/Rakefile

@@ -34,5 +34,5 @@ end
 if ENV['TRAVIS']
   task :default => :travis
 else
-  task :default => :spec
+  task :default => [:spec, :cucumber]
 end

data/contributors

@@ -0,0 +1,2 @@
+Andrea Longhi (spaghetticode)
+Tomasz Gieniusz (tomgi)

data/features/dj_mailer_deliver.feature

@@ -1,14 +1,23 @@
-Feature: deliver email asyncronously with delayed_job in a transparent way
-In order to add asyncronous email delivery without modifing the existing codebase
-As an action mailer 3 and delayed_job user
-I want to deliver email asyncronously without modifying existing code
+Feature: deliver email asyncronously with delayed_job
+
+As an action mailer 3 and *delayed_job* user
+I want to deliver email asyncronously transparently
+in order to avoid updating the existing syncronous codebase
 
   This is the current delayed job recommended syntax to run asyncronous
   email delivers:
-    without delayed_job: Notifier.signup(@user).deliver
-    with delayed_job:    Notifier.delay.signup(@user)
+
+    without *delayed_job*:
+
+      Notifier.signup(@user).deliver
+
+    with *delayed_job*:
+
+      Notifier.delay.signup(@user)
+
   The syntax is quite different, so if you have a big codebase that doesn't use
   yet delayed job it could become rather nasty to replace all the deliver calls.
+
   This gem allows you to keep the old interface and still get the delayed job
   asyncronous functionality.
 
@@ -17,13 +26,13 @@ Scenario: Email is enqueued successfully
     """
     class TestMailer < ActionMailer::Base
       def test(recipient)
-        mail to: recipient, from: 'test@test.com', subject: 'asyncronous email'
+        mail to: recipient, from: 'test@test.it', subject: 'async email'
       end
     end
     """
   When I try to send a test email with the following code:
     """
-    TestMailer.test('sender@test.com')
+    TestMailer.test('sender@test.com').deliver
     """
   Then a delayed job object should be returned
   And I should see a new delayed_job record in the table

data/features/readme.md

@@ -0,0 +1,104 @@
+# DjMailer
+
+[![Build Status](https://secure.travis-ci.org/spaghetticode/dj_mailer.png)](http://travis-ci.org/spaghetticode/dj_mailer)
+
+This gem allows you to send emails asyncronously via delayed_job_active_record
+without modifying the existing codebase, keeping the standard action mailer
+interface.
+
+Currenlty delayed_job_active_record requires that you replace all your email
+deliver calls as follows:
+
+```ruby
+  # without delayed job
+  Notifier.signup(@user).deliver
+
+  # with delayed job
+  Notifier.delay.signup(@user)
+```
+
+By adding this gem in your gemfile all your current emails will be automatically
+handled by delayed job without any interface change. At the moment you have
+to setup the delayed job environment on your own running the migrations for the
+db.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+  gem 'dj_mailer'
+```
+And then execute: `bundle`
+
+Or install it yourself as:
+```bash
+  gem install dj_mailer
+```
+
+## Configuration
+
+Delayed e-mails is an awesome thing in production environments, but for e-mail specs/tests in testing environments it can be a mess causing specs/tests to fail because the e-mail haven't been sent directly. Therefore you can configure what environments that should be excluded like so:
+
+```ruby
+  # config/initializers/dj_mailer.rb
+
+  DjMailer::Delayable.excluded_environments = [:test, :cucumber]  # etc.
+```
+
+## Documentation
+
+You can find some more documentation on the workings of the gem on relish:
+https://www.relishapp.com/spaghetticode/dj-mailer/docs
+
+
+## Tests
+
+to run the specs:
+```bash
+  bundle exec rake spec
+```
+to run the cucumber features:
+```bash
+  bundle exec rake cucumber
+```
+
+
+## Sample delay job migration
+
+Just a reminder I have to add the generator (via rails you can simply run `rails generate delayed_job:active_record)`
+
+```ruby
+class CreateDelayedJobs < ActiveRecord::Migration
+  def self.up
+    create_table :delayed_jobs, :force => true do |table|
+      table.integer  :priority, :default => 0      # Allows some jobs to jump to the front of the queue
+      table.integer  :attempts, :default => 0      # Provides for retries, but still fail eventually.
+      table.text     :handler                      # YAML-encoded string of the object that will do work
+      table.text     :last_error                   # reason for last failure (See Note below)
+      table.datetime :run_at                       # When to run. Could be Time.zone.now for immediately, or sometime in the future.
+      table.datetime :locked_at                    # Set when a client is working on this object
+      table.datetime :failed_at                    # Set when all retries have failed (actually, by default, the record is deleted instead)
+      table.string   :locked_by                    # Who is working on this object (if locked)
+      table.string   :queue                        # The name of the queue this job is in
+      table.timestamps
+    end
+
+    add_index :delayed_jobs, [:priority, :run_at], :name => 'delayed_jobs_priority'
+  end
+
+  def self.down
+    drop_table :delayed_jobs
+  end
+end
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Add your feature tests to the rspec/cucumber test suite
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/lib/dj_mailer.rb

@@ -15,7 +15,7 @@ module DjMailer
     end
 
     def method_missing_with_delay(method, *args)
-      if respond_to?(method) and !caller.grep('delayed_job').present?
+      if !environment_excluded? && respond_to?(method) and !caller.grep(/delayed_job/).present?
         enqueue_with_delayed_job(method, *args)
       else
         method_missing_without_delay(method, *args)
@@ -27,6 +27,18 @@ module DjMailer
         dj_instance.extend Deliverable
       end
     end
+
+    def environment_excluded?
+      defined?(Rails) && ::DjMailer::Delayable.excluded_environments.include?(Rails.env.to_sym)
+    end
+
+    def self.excluded_environments=(*environments)
+      @@excluded_environments = environments && environments.flatten.collect! { |env| env.to_sym }
+    end
+
+    def self.excluded_environments
+      @@excluded_environments ||= []
+    end
   end
 end
 

data/lib/dj_mailer/version.rb

@@ -1,3 +1,3 @@
 module DjMailer
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/spec/lib/deliverable_spec.rb

@@ -21,21 +21,30 @@ module DjMailer
           before {subject.should_receive(:respond_to?).and_return(true)}
 
           context 'when the caller is delayed_job' do
-            it 'should delegate to the original method_missing' do
-              subject.stub(:caller => ['delayed_job'])
+            it 'delegates to the original method_missing' do
+              subject.stub(:caller => ["/gems/delayed_job-3.0.2/lib/delayed/performable_mailer.rb:6:in `perform'"])
               subject.should_receive(:method_missing_without_delay)
               subject.method_missing_with_delay(:responding)
             end
           end
 
           context 'when the caller is not delayed_job' do
-            it 'should equeue the email for late delivery' do
+            it 'equeues the email for late delivery' do
               subject.stub(:caller => [])
               subject.should_receive(:enqueue_with_delayed_job)
               subject.method_missing_with_delay(:responding)
             end
           end
         end
+
+        it 'delegates to original method_missing if this environment is excluded' do
+          with_stub_const(:Rails, double(:env => 'test')) do
+            with_excluded_environments([:test]) do
+              subject.should_receive(:method_missing_without_delay)
+              subject.method_missing_with_delay(:responding)
+            end
+          end
+        end
       end
     end
   end

data/spec/spec_helper.rb

@@ -1,2 +1,27 @@
 require File.expand_path('../../lib/dj_mailer', __FILE__)
 
+def with_stub_const(const, value)
+  if Object.const_defined?(const)
+    begin
+      @const = const
+      Object.const_set(const, value)
+      yield
+    ensure
+      Object.const_set(const, @const)
+    end
+  else
+    begin
+      Object.const_set(const, value)
+      yield
+    ensure
+      Object.send(:remove_const, const)
+    end
+  end
+end
+
+def with_excluded_environments(envs)
+  DjMailer::Delayable.excluded_environments = envs
+  yield
+ensure
+  DjMailer::Delayable.excluded_environments = []
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dj_mailer
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-21 00:00:00.000000000 Z
+date: 2012-08-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -170,8 +170,10 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- contributors
 - dj_mailer.gemspec
 - features/dj_mailer_deliver.feature
+- features/readme.md
 - features/step_definitions/.gitkeep
 - features/step_definitions/dj_mailer_deliver_steps.rb
 - features/support/.gitkeep
@@ -210,6 +212,7 @@ summary: Allows to send all ActionMailer 3 emails via delayed_job in a transpare
   way
 test_files:
 - features/dj_mailer_deliver.feature
+- features/readme.md
 - features/step_definitions/.gitkeep
 - features/step_definitions/dj_mailer_deliver_steps.rb
 - features/support/.gitkeep
@@ -219,3 +222,4 @@ test_files:
 - spec/lib/.gitkeep
 - spec/lib/deliverable_spec.rb
 - spec/spec_helper.rb
+has_rdoc: