bmabey-email_spec 0.3.1 → 0.3.2

data/History.txt

@@ -3,6 +3,11 @@
  === New features
  === Bufixes
 
+ == 0.3.2 2009-09-10
+
+ === New features
+  * Support for delayed_job. (Kieran Pilkington)
+
  == 0.3.1 2009-08-19
 This release is a general refactoring of the steps and helpers.
 The example rails app was also updated to use the lateset rails and webrat.  It also takes advantages

data/Rakefile

@@ -25,12 +25,13 @@ rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end
 
-
-begin
-  gem 'fixjour'
-rescue Gem::LoadError
-  puts "Installing fixjour for the example rails app..."
-  puts `gem install fixjour --no-rdoc --no-ri`
+%w[collectiveidea-delayed_job fixjour].each do |gem_name|
+  begin
+    gem gem_name
+  rescue Gem::LoadError
+    puts "Installing #{gem_name} for the example rails app..."
+    puts `gem install #{gem_name} --no-rdoc --no-ri`
+  end
 end
 
 begin

data/examples/rails_root/Rakefile

@@ -5,3 +5,9 @@ require 'rake/testtask'
 require 'rake/rdoctask'
 
 require 'tasks/rails'
+
+begin
+  require 'delayed/tasks'
+rescue LoadError
+  STDERR.puts "Run `rake gems:install` to install delayed_job"
+end

data/examples/rails_root/app/controllers/welcome_controller.rb

@@ -6,4 +6,7 @@ class WelcomeController < ApplicationController
   def confirm
   end
 
+  def newsletter
+    UserMailer.send_later(:deliver_newsletter, params['Email'], params['Name'])
+  end
 end

data/examples/rails_root/app/models/user_mailer.rb

@@ -8,4 +8,11 @@ class UserMailer < ActionMailer::Base
     @body[:name] = name
   end
 
+  def newsletter(email, name)
+    @recipients  = email
+    @from        = "admin@example.com"
+    @subject     = "Newsletter sent"
+    @sent_on     = Time.now
+    @body[:name] = name
+  end
 end

data/examples/rails_root/app/views/user_mailer/newsletter.erb

@@ -0,0 +1,8 @@
+Hello <%= @name %>!
+
+This week.....
+.....
+.....
+
+Regards
+Rails Example App

data/examples/rails_root/config/environment.rb

@@ -5,7 +5,7 @@
 # ENV['RAILS_ENV'] ||= 'production'
 
 # Specifies gem version of Rails to use when vendor/rails is not present
-RAILS_GEM_VERSION = '2.3.3' unless defined? RAILS_GEM_VERSION
+RAILS_GEM_VERSION = '2.3.4' unless defined? RAILS_GEM_VERSION
 
 # Bootstrap the Rails environment, frameworks, and default configuration
 require File.join(File.dirname(__FILE__), 'boot')

data/examples/rails_root/config/environments/test.rb

@@ -22,8 +22,9 @@ config.action_controller.allow_forgery_protection    = false
 config.action_mailer.delivery_method = :test
 config.action_mailer.default_url_options = { :host => "example.com" }
 
-config.gem 'cucumber',         :lib => false
-config.gem 'webrat',           :lib => false
-config.gem 'rspec',            :lib => false
-config.gem 'rspec-rails',      :lib => 'spec/rails'
-config.gem 'fixjour', :lib => 'fixjour'
+config.gem 'cucumber',                   :lib => false
+config.gem 'webrat',                     :lib => false
+config.gem 'rspec',                      :lib => false
+config.gem 'rspec-rails',                :lib => 'spec/rails'
+config.gem 'fixjour',                    :lib => 'fixjour'
+config.gem 'collectiveidea-delayed_job', :lib => 'delayed_job', :source => 'http://gems.github.com'

data/examples/rails_root/config/routes.rb

@@ -17,7 +17,7 @@ ActionController::Routing::Routes.draw do |map|
 
   # Sample resource route with sub-resources:
   #   map.resources :products, :has_many => [ :comments, :sales ], :has_one => :seller
-  
+
   # Sample resource route with more complex sub-resources
   #   map.resources :products do |products|
   #     products.resources :comments
@@ -33,6 +33,7 @@ ActionController::Routing::Routes.draw do |map|
   # You can have the root of your site routed with map.root -- just remember to delete public/index.html.
   map.root :controller => "welcome", :action => "index"
   map.confirm_account "/confirm", :controller => "welcome", :action => "confirm"
+  map.request_newsletter "/newsletter", :controller => "welcome", :action => "newsletter"
   # See how all your routes lay out with "rake routes"
 
   # Install the default routes as the lowest priority.

data/examples/rails_root/db/migrate/20090908054656_create_delayed_jobs.rb

@@ -0,0 +1,20 @@
+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.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.timestamps
+    end
+
+  end
+  
+  def self.down
+    drop_table :delayed_jobs  
+  end
+end

data/examples/rails_root/db/schema.rb

@@ -9,7 +9,20 @@
 #
 # It's strongly recommended to check this file into your version control system.
 
-ActiveRecord::Schema.define(:version => 20090125013728) do
+ActiveRecord::Schema.define(:version => 20090908054656) do
+
+  create_table "delayed_jobs", :force => true do |t|
+    t.integer  "priority",   :default => 0
+    t.integer  "attempts",   :default => 0
+    t.text     "handler"
+    t.text     "last_error"
+    t.datetime "run_at"
+    t.datetime "locked_at"
+    t.datetime "failed_at"
+    t.string   "locked_by"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
 
   create_table "users", :force => true do |t|
     t.string "email"

data/examples/rails_root/features/delayed_job.feature

@@ -0,0 +1,13 @@
+Feature: Delayed Job support
+  In order for developers using delayed_job to test emails
+  I want to be able to provide a compatibility layer, which
+  should run all delayed jobs before checking email boxes
+  In order to populate deliveries done via send_later
+
+  Scenario: Newsletter
+    Given no emails have been sent
+    And I go to request a newsletter
+    Then I should receive an email
+    And I should have 1 email
+    When I open the email
+    Then I should see "Newsletter sent" in the email subject

data/examples/rails_root/features/support/paths.rb

@@ -11,6 +11,9 @@ module NavigationHelpers
     when /the homepage/
       '/'
 
+    when /request a newsletter/
+      request_newsletter_url('Name' => 'Joe Someone', 'Email' => 'example@example.com')
+
     else
       raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
         "Now, go and add a mapping in #{__FILE__}"

data/examples/rails_root/script/delayed_job

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'config', 'environment'))
+require 'delayed/command'
+Delayed::Command.new(ARGV).daemonize

data/lib/email_spec/background_processes.rb

@@ -0,0 +1,31 @@
+module EmailSpec
+  module BackgroundProcesses
+    module DelayedJob
+      def all_emails
+        Delayed::Job.work_off
+        super
+      end
+
+      def last_email_sent
+        Delayed::Job.work_off
+        super
+      end
+
+      def reset_mailer
+        Delayed::Job.work_off
+        super
+      end
+
+      def mailbox_for(address)
+        Delayed::Job.work_off
+        super
+      end
+    end
+
+    module Compatibility
+      if defined?(Delayed)
+        include EmailSpec::BackgroundProcesses::DelayedJob
+      end
+    end
+  end
+end

data/lib/email_spec/deliveries.rb

@@ -49,6 +49,7 @@ module EmailSpec
     else
       include EmailSpec::TestDeliveries
     end
+    include EmailSpec::BackgroundProcesses::Compatibility
   end
 end
 

data/lib/email_spec.rb

@@ -5,6 +5,7 @@ end
 
 $LOAD_PATH.unshift(File.expand_path(File.dirname(__FILE__))) unless $LOAD_PATH.include?(File.expand_path(File.dirname(__FILE__)))
 
+require 'email_spec/background_processes'
 require 'email_spec/deliveries'
 require 'email_spec/address_converter'
 require 'email_spec/email_viewer'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bmabey-email_spec
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - Ben Mabey
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-19 00:00:00 -07:00
+date: 2009-09-10 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -33,6 +33,7 @@ files:
 - lib/email-spec.rb
 - lib/email_spec.rb
 - lib/email_spec/address_converter.rb
+- lib/email_spec/background_processes.rb
 - lib/email_spec/cucumber.rb
 - lib/email_spec/deliveries.rb
 - lib/email_spec/email_viewer.rb
@@ -85,10 +86,12 @@ test_files:
 - examples/rails_root/app/models/user_mailer.rb
 - examples/rails_root/app/views
 - examples/rails_root/app/views/user_mailer
+- examples/rails_root/app/views/user_mailer/newsletter.erb
 - examples/rails_root/app/views/user_mailer/signup.erb
 - examples/rails_root/app/views/welcome
 - examples/rails_root/app/views/welcome/confirm.html.erb
 - examples/rails_root/app/views/welcome/index.html.erb
+- examples/rails_root/app/views/welcome/newsletter.html.erb
 - examples/rails_root/app/views/welcome/signup.html.erb
 - examples/rails_root/config
 - examples/rails_root/config/boot.rb
@@ -106,10 +109,12 @@ test_files:
 - examples/rails_root/db
 - examples/rails_root/db/migrate
 - examples/rails_root/db/migrate/20090125013728_create_users.rb
+- examples/rails_root/db/migrate/20090908054656_create_delayed_jobs.rb
 - examples/rails_root/db/schema.rb
 - examples/rails_root/doc
 - examples/rails_root/doc/README_FOR_APP
 - examples/rails_root/features
+- examples/rails_root/features/delayed_job.feature
 - examples/rails_root/features/errors.feature
 - examples/rails_root/features/example.feature
 - examples/rails_root/features/step_definitions
@@ -140,6 +145,7 @@ test_files:
 - examples/rails_root/script/console
 - examples/rails_root/script/cucumber
 - examples/rails_root/script/dbconsole
+- examples/rails_root/script/delayed_job
 - examples/rails_root/script/destroy
 - examples/rails_root/script/generate
 - examples/rails_root/script/performance