glennr-email_spec 0.3.5

data/examples/sinatra/features/example.feature

@@ -0,0 +1,62 @@
+Feature: EmailSpec Example -- Prevent Bots from creating accounts
+
+  In order to help alleviate email testing in apps
+  As an email-spec contributor I want new users of the library
+  to easily adopt email-spec in their app by following this example
+
+  In order to prevent bots from setting up new accounts
+  As a site manager I want new users
+  to verify their email address with a confirmation link
+
+  Background:
+    Given no emails have been sent
+    And I am a real person wanting to sign up for an account
+    And I am on the homepage
+    And I submit my registration information
+
+  Scenario: First person signup (as myself) with two ways of opening email
+    Then I should receive an email
+    And I should have 1 email
+
+    # Opening email #1
+    When I open the email
+    Then I should see "Account confirmation" in the email subject
+    And I should see "Joe Someone" in the email body
+    And I should see "confirm" in the email body
+
+    # Opening email #2
+    When I open the email with subject "Account confirmation"
+    Then I should see "Account confirmation" in the email subject
+    And I should see "Joe Someone" in the email body
+    And I should see "confirm" in the email body
+
+    When I follow "Click here to confirm your account!" in the email
+    Then I should see "Confirm your new account"
+
+    And "foo@bar.com" should have no emails
+
+  Scenario: Third person signup (emails sent to others) with two ways of opening email
+    Then "foo@bar.com" should have no emails
+    And "example@example.com" should receive an email
+    And "example@example.com" should have 1 email
+
+    # Opening email #1
+    When they open the email
+    Then they should see "Account confirmation" in the email subject
+    And they should see "Joe Someone" in the email body
+    And they should see "confirm" in the email body
+
+    # Opening email #2
+    When "example@example.com" opens the email with subject "Account confirmation"
+    Then they should see "Account confirmation" in the email subject
+    And they should see "Joe Someone" in the email body
+    And they should see "confirm" in the email body
+
+    When they follow "Click here to confirm your account!" in the email
+    Then they should see "Confirm your new account"
+
+  Scenario: Declarative First Person signup
+    Then I should receive an email with a link to a confirmation page
+
+  Scenario: Declarative First Person signup
+    Then they should receive an email with a link to a confirmation page

data/examples/sinatra/features/step_definitions/user_steps.rb

@@ -0,0 +1,26 @@
+Given "I am a real person wanting to sign up for an account" do
+  # no-op.. for documentation purposes only!
+end
+
+When /^I submit my registration information$/ do
+  fill_in "Name", :with => 'Joe Someone'
+  fill_in "Email", :with => 'example@example.com'
+  click_button
+end
+
+Then /^(?:I|they) should receive an email with a link to a confirmation page$/ do
+  unread_emails_for(current_email_address).size.should == 1
+
+  # this call will store the email and you can access it with current_email
+  open_last_email_for(last_email_address)
+  current_email.should have_subject(/Account confirmation/)
+  current_email.should have_body_text('Joe Someone')
+
+  click_email_link_matching /confirm/
+  response_body.should contain("Confirm your new account")
+end
+
+# Basically aliases "I should see [text]", but for third person
+Then /^they should see "([^\"]*)"$/ do |text|
+  Then "I should see \"#{text}\""
+end

data/examples/sinatra/features/step_definitions/webrat_steps.rb

@@ -0,0 +1,137 @@
+require File.expand_path(File.join(File.dirname(__FILE__), "..", "support", "paths"))
+
+# Commonly used webrat steps
+# http://github.com/brynary/webrat
+
+Given /^I am on (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^I go to (.+)$/ do |page_name|
+  visit path_to(page_name)
+end
+
+When /^I press "([^\"]*)"$/ do |button|
+  click_button(button)
+end
+
+When /^I follow "([^\"]*)"$/ do |link|
+  click_link(link)
+end
+
+When /^I follow "([^\"]*)" within "([^\"]*)"$/ do |link, parent|
+  click_link_within(parent, link)
+end
+
+When /^I fill in "([^\"]*)" with "([^\"]*)"$/ do |field, value|
+  fill_in(field, :with => value)
+end
+
+When /^I select "([^\"]*)" from "([^\"]*)"$/ do |value, field|
+  select(value, :from => field)
+end
+
+# Use this step in conjunction with Rail's datetime_select helper. For example:
+# When I select "December 25, 2008 10:00" as the date and time
+When /^I select "([^\"]*)" as the date and time$/ do |time|
+  select_datetime(time)
+end
+
+# Use this step when using multiple datetime_select helpers on a page or
+# you want to specify which datetime to select. Given the following view:
+#   <%%= f.label :preferred %><br />
+#   <%%= f.datetime_select :preferred %>
+#   <%%= f.label :alternative %><br />
+#   <%%= f.datetime_select :alternative %>
+# The following steps would fill out the form:
+# When I select "November 23, 2004 11:20" as the "Preferred" date and time
+# And I select "November 25, 2004 10:30" as the "Alternative" date and time
+When /^I select "([^\"]*)" as the "([^\"]*)" date and time$/ do |datetime, datetime_label|
+  select_datetime(datetime, :from => datetime_label)
+end
+
+# Use this step in conjunction with Rail's time_select helper. For example:
+# When I select "2:20PM" as the time
+# Note: Rail's default time helper provides 24-hour time-- not 12 hour time. Webrat
+# will convert the 2:20PM to 14:20 and then select it.
+When /^I select "([^\"]*)" as the time$/ do |time|
+  select_time(time)
+end
+
+# Use this step when using multiple time_select helpers on a page or you want to
+# specify the name of the time on the form.  For example:
+# When I select "7:30AM" as the "Gym" time
+When /^I select "([^\"]*)" as the "([^\"]*)" time$/ do |time, time_label|
+  select_time(time, :from => time_label)
+end
+
+# Use this step in conjunction with Rail's date_select helper.  For example:
+# When I select "February 20, 1981" as the date
+When /^I select "([^\"]*)" as the date$/ do |date|
+  select_date(date)
+end
+
+# Use this step when using multiple date_select helpers on one page or
+# you want to specify the name of the date on the form. For example:
+# When I select "April 26, 1982" as the "Date of Birth" date
+When /^I select "([^\"]*)" as the "([^\"]*)" date$/ do |date, date_label|
+  select_date(date, :from => date_label)
+end
+
+When /^I check "([^\"]*)"$/ do |field|
+  check(field)
+end
+
+When /^I uncheck "([^\"]*)"$/ do |field|
+  uncheck(field)
+end
+
+When /^I choose "([^\"]*)"$/ do |field|
+  choose(field)
+end
+
+When /^I attach the file at "([^\"]*)" to "([^\"]*)"$/ do |path, field|
+  attach_file(field, path)
+end
+
+Then /^I should see "([^\"]*)"$/ do |text|
+  response_body.should contain(text)
+end
+
+Then /^I should see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+  response_body.should contain(regexp)
+end
+
+Then /^I should not see "([^\"]*)"$/ do |text|
+  response_body.should_not contain(text)
+end
+
+Then /^I should not see \/([^\/]*)\/$/ do |regexp|
+  regexp = Regexp.new(regexp)
+  response_body.should_not contain(regexp)
+end
+
+Then /^the "([^\"]*)" field should contain "([^\"]*)"$/ do |field, value|
+  field_labeled(field).value.should =~ /#{value}/
+end
+
+Then /^the "([^\"]*)" field should not contain "([^\"]*)"$/ do |field, value|
+  field_labeled(field).value.should_not =~ /#{value}/
+end
+
+Then /^the "([^\"]*)" checkbox should be checked$/ do |label|
+  field_labeled(label).should be_checked
+end
+
+Then /^the "([^\"]*)" checkbox should not be checked$/ do |label|
+  field_labeled(label).should_not be_checked
+end
+
+Then /^I should be on (.+)$/ do |page_name|
+  URI.parse(current_url).path.should == path_to(page_name)
+end
+
+Then /^show me the page$/ do
+  save_and_open_page
+end

data/examples/sinatra/features/support/env.rb

@@ -0,0 +1,33 @@
+# Sets up the Rails environment for Cucumber
+ENV["RACK_ENV"] ||= "test"
+require File.expand_path(File.dirname(__FILE__) + '/../../app.rb')
+
+# Comment out the next line if you don't want Cucumber Unicode support
+require 'cucumber/formatter/unicode'
+
+require 'rack/test'
+require 'webrat'
+require 'cucumber/webrat/table_locator' # Lets you do table.diff!(table_at('#my_table').to_a)
+
+Webrat.configure do |config|
+  config.mode = :rack
+end
+
+require 'webrat/core/matchers'
+
+# email testing in cucumber
+require 'activesupport'
+require File.expand_path(File.dirname(__FILE__) + '../../../../../lib/email_spec')
+require 'email_spec/cucumber'
+
+class AppWorld
+  include Rack::Test::Methods
+  include Webrat::Methods
+  include Webrat::Matchers
+
+  def app
+    Sinatra::Application.new
+  end
+end
+
+World { AppWorld.new }

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

@@ -0,0 +1,24 @@
+module NavigationHelpers
+  # Maps a name to a path. Used by the
+  #
+  #   When /^I go to (.+)$/ do |page_name|
+  #
+  # step definition in webrat_steps.rb
+  #
+  def path_to(page_name)
+    case page_name
+
+    when /the homepage/
+      '/'
+
+    when /request a newsletter/
+      "/newsletter/Joe Someone/example@example.com"
+
+    else
+      raise "Can't find mapping from \"#{page_name}\" to a path.\n" +
+        "Now, go and add a mapping in #{__FILE__}"
+    end
+  end
+end
+
+World(NavigationHelpers)

data/lib/email-spec.rb

@@ -0,0 +1 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'email_spec'))

data/lib/email_spec.rb

@@ -0,0 +1,15 @@
+unless defined?(Pony) or defined?(ActionMailer)
+  Kernel.warn("Neither Pony nor ActionMailer appear to be loaded so email-spec is requiring ActionMailer.")
+  require 'actionmailer'
+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'
+require 'email_spec/helpers'
+require 'email_spec/matchers'
+
+

data/lib/email_spec/address_converter.rb

@@ -0,0 +1,29 @@
+require 'singleton'
+
+module EmailSpec
+  class AddressConverter
+    include Singleton
+  
+    attr_accessor :converter
+  
+    # The block provided to conversion should convert to an email
+    # address string or return the input untouched. For example:
+    #
+    #  EmailSpec::AddressConverter.instance.conversion do |input|
+    #   if input.is_a?(User)
+    #     input.email
+    #   else
+    #     input
+    #   end
+    #  end
+    #    
+    def conversion(&block)
+      self.converter = block
+    end
+  
+    def convert(input)
+      return input unless converter
+      converter.call(input)
+    end
+  end
+end

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/cucumber.rb

@@ -0,0 +1,21 @@
+# require this in your env.rb file after you require cucumber/rails/world
+
+# Global Setup
+if defined?(ActionMailer)
+  ActionMailer::Base.delivery_method = :test unless ActionMailer::Base.delivery_method == :activerecord
+  ActionMailer::Base.perform_deliveries = true
+
+  Before do
+    # Scenario setup
+    ActionMailer::Base.deliveries.clear if ActionMailer::Base.delivery_method == :test
+  end
+end
+
+After do
+  EmailSpec::EmailViewer.save_and_open_all_raw_emails if ENV['SHOW_EMAILS']
+  EmailSpec::EmailViewer.save_and_open_all_html_emails if ENV['SHOW_HTML_EMAILS']
+  EmailSpec::EmailViewer.save_and_open_all_text_emails if ENV['SHOW_TEXT_EMAILS']
+end
+
+World(EmailSpec::Helpers)
+World(EmailSpec::Matchers)

data/lib/email_spec/deliveries.rb

@@ -0,0 +1,71 @@
+module EmailSpec
+  module MailerDeliveries
+    def all_emails
+      mailer.deliveries
+    end
+
+    def last_email_sent
+      mailer.deliveries.last || raise("No email has been sent!")
+    end
+
+    def reset_mailer
+      mailer.deliveries.clear
+    end
+
+    def mailbox_for(address)
+      mailer.deliveries.select { |m| m.to.include?(address) || (m.bcc && m.bcc.include?(address)) || (m.cc && m.cc.include?(address)) }
+    end
+  end
+
+  module ARMailerDeliveries
+    def all_emails
+      Email.all.map{ |email| parse_to_tmail(email) }
+    end
+
+    def last_email_sent
+      if email = Email.last
+        TMail::Mail.parse(email.mail)
+      else
+        raise("No email has been sent!")
+      end
+    end
+
+    def reset_mailer
+      Email.delete_all
+    end
+
+    def mailbox_for(address)
+      Email.all.select { |email| email.to.include?(address) || (email.bcc && email.bcc.include?(address)) || (email.cc && email.cc.include?(address)) }.map{ |email| parse_to_tmail(email) }
+    end
+
+    def parse_to_tmail(email)
+      TMail::Mail.parse(email.mail)
+    end
+  end
+
+  if defined?(Pony)
+    module ::Pony
+      def self.deliveries
+        @deliveries ||= []
+      end
+
+      def self.mail(options)
+        deliveries << build_tmail(options)
+      end
+    end
+  end
+
+  module Deliveries
+    if defined?(Pony)
+      def mailer; Pony; end
+      include EmailSpec::MailerDeliveries
+    elsif ActionMailer::Base.delivery_method == :activerecord
+      include EmailSpec::ARMailerDeliveries
+    else
+      def mailer; ActionMailer::Base; end
+      include EmailSpec::MailerDeliveries
+    end
+    include EmailSpec::BackgroundProcesses::Compatibility
+  end
+end
+