dj_mailer 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 1.9.2
+branches:
+  only:
+    - master

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,25 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  # Capybara request specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/requests/#{m[1]}_spec.rb" }
+end
+
+
+guard 'cucumber' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+end

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 andrea longhi
+
+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,84 @@
+# 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 (running the migrations for the db) on your
+own.
+
+
+## Note
+
+I could not make the current version of delayed_job_active_record (0.3.2) work
+with recent versions of ActionMailer, it does with 3.0.5. I will investigate
+the reason of the failure ASAP.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+  gem 'dj_mailer'
+```
+And then execute: `$ bundle`
+
+Or install it yourself as:
+```
+  $ gem install dj_mailer
+```
+
+
+## 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/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+desc 'Run those specs'
+task :spec do
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern    = 'spec/**/*_spec.rb'
+    t.rspec_path = 'bundle exec rspec'
+  end
+end
+
+desc 'Run cucumber features'
+task :cucumber do
+  require 'cucumber/rake/task'
+
+  Cucumber::Rake::Task.new do |t|
+    t.rcov = false
+  end
+end
+
+desc 'Runs tests on Travis CI'
+task :travis do
+  ["rspec spec", "rake cucumber"].each do |cmd|
+    puts "Starting to run #{cmd}..."
+    system("export DISPLAY=:99.0 && bundle exec #{cmd}")
+    raise "#{cmd} failed!" unless $?.exitstatus == 0
+  end
+end
+
+if ENV['TRAVIS']
+  task :default => :travis
+else
+  task :default => :spec
+end

data/dj_mailer.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/dj_mailer/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["andrea longhi"]
+  gem.email         = ["andrea@spaghetticode.it"]
+  gem.description   = %q{send automatically all emails via delayed_job}
+  gem.summary       = %q{Allows to send all ActionMailer 3 emails via delayed_job in a transparent way}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'dj_mailer'
+  gem.require_paths = ['lib']
+  gem.version       = DjMailer::VERSION
+
+  gem.add_dependency 'delayed_job_active_record'
+  gem.add_dependency 'actionmailer', '3.0.5'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'sqlite3'
+  gem.add_development_dependency 'cucumber'
+  gem.add_development_dependency 'guard-rspec'
+  gem.add_development_dependency 'guard-cucumber'
+  gem.add_development_dependency 'activerecord', '3.0.5'
+end

data/features/dj_mailer_deliver.feature

@@ -0,0 +1,29 @@
+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
+
+  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)
+  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.
+
+Scenario: Email is enqueued successfully
+  Given I have the following action mailer class:
+    """
+    class TestMailer < ActionMailer::Base
+      def test(recipient)
+        mail to: recipient, from: 'test@test.com', subject: 'asyncronous email'
+      end
+    end
+    """
+  When I try to send a test email with the following code:
+    """
+    TestMailer.test('sender@test.com')
+    """
+  Then a delayed job object should be returned
+  And I should see a new delayed_job record in the table

data/features/step_definitions/dj_mailer_deliver_steps.rb

@@ -0,0 +1,15 @@
+Given /^I have the following action mailer class:$/ do |class_definition|
+  context_module.class_eval(class_definition)
+end
+
+When /^I try to send a test email with the following code:$/ do |code|
+  self.result = context_module.class_eval(code)
+end
+
+Then /^a delayed job object should be returned$/ do
+  result.should be_a(Delayed::Backend::ActiveRecord::Job)
+end
+
+Then /^I should see a new delayed_job record in the table$/ do
+  Delayed::Job.count.should == 1
+end

data/features/support/env.rb

@@ -0,0 +1,42 @@
+# At the moment delayed_job_active_record is quite broken. It surely works
+# fine with actionmailer 3.0.5
+gem 'actionmailer', '3.0.5'
+require 'action_mailer'
+
+ActionMailer::Base.delivery_method = :test
+
+
+# Forcing actionmailer to v3.0.5 requires also activerecord to have same version,
+# this is to avoid dependencies conflicts (activesupport version, for example)
+gem 'activerecord', '3.0.5'
+require 'delayed_job_active_record'
+
+class DjMigration < 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
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Base.logger = Logger.new(StringIO.new)
+DjMigration.up
+
+
+require File.expand_path('../../../lib/dj_mailer', __FILE__)

data/features/support/world_extensions.rb

@@ -0,0 +1,9 @@
+module WorldExtensions
+  attr_accessor :result
+
+  def context_module
+    @context_module ||= Module.new
+  end
+end
+
+World(WorldExtensions)

data/lib/dj_mailer.rb

@@ -0,0 +1,28 @@
+# cucumber complains with require 'dj_mailer/version'
+require File.expand_path('../dj_mailer/version', __FILE__)
+
+module DjMailer
+  module Delayable
+    module Deliverable
+      def deliver; self; end
+    end
+
+    def self.extended(base)
+      class << base
+        alias_method_chain :method_missing, :delay
+      end
+    end
+
+    def method_missing_with_delay(method, *args)
+      if caller[1].include?('performable_mailer.rb')
+        method_missing_without_delay(method, *args)
+      else
+        delay.send(method, *args).tap do |dj_instance|
+          dj_instance.extend Deliverable
+        end
+      end
+    end
+  end
+end
+
+ActionMailer::Base.extend DjMailer::Delayable

data/lib/dj_mailer/version.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require File.expand_path('../../lib/dj_mailer', __FILE__)
+

metadata

@@ -0,0 +1,217 @@
+--- !ruby/object:Gem::Specification
+name: dj_mailer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- andrea longhi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: delayed_job_active_record
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: actionmailer
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+- !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: '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'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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: guard-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: guard-cucumber
+  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: 3.0.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.5
+description: send automatically all emails via delayed_job
+email:
+- andrea@spaghetticode.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- dj_mailer.gemspec
+- features/dj_mailer_deliver.feature
+- features/step_definitions/.gitkeep
+- features/step_definitions/dj_mailer_deliver_steps.rb
+- features/support/.gitkeep
+- features/support/env.rb
+- features/support/world_extensions.rb
+- lib/dj_mailer.rb
+- lib/dj_mailer/version.rb
+- spec/lib/.gitkeep
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+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: Allows to send all ActionMailer 3 emails via delayed_job in a transparent
+  way
+test_files:
+- features/dj_mailer_deliver.feature
+- features/step_definitions/.gitkeep
+- features/step_definitions/dj_mailer_deliver_steps.rb
+- features/support/.gitkeep
+- features/support/env.rb
+- features/support/world_extensions.rb
+- spec/lib/.gitkeep
+- spec/spec_helper.rb