email_spec 1.6.0 → 2.0.0

data/examples/rails4_root/db/migrate/20141119224309_add_queue_to_delayed_jobs.rb

@@ -0,0 +1,9 @@
+class AddQueueToDelayedJobs < ActiveRecord::Migration
+  def self.up
+    add_column :delayed_jobs, :queue, :string
+  end
+
+  def self.down
+    remove_column :delayed_jobs, :queue
+  end
+end

data/examples/rails4_root/db/schema.rb

@@ -0,0 +1,35 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20141119224309) do
+
+  create_table "delayed_jobs", force: :cascade 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"
+    t.string   "queue"
+  end
+
+  create_table "users", force: :cascade do |t|
+    t.string "email"
+    t.string "name"
+  end
+
+end

data/examples/rails4_root/db/seeds.rb

@@ -0,0 +1,7 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
+#
+# Examples:
+#
+#   cities = City.create([{ :name => 'Chicago' }, { :name => 'Copenhagen' }])
+#   Mayor.create(:name => 'Daley', :city => cities.first)

data/examples/rails4_root/doc/README_FOR_APP

@@ -0,0 +1,2 @@
+Use this README file to introduce your application and point to useful places in the API for learning more.
+Run "rake doc:app" to generate API documentation for your models, controllers, helpers, and libraries.

data/examples/rails4_root/features/attachments.feature

@@ -0,0 +1,27 @@
+Feature: Attachment testing support
+  In order for developers to test attachments in emails
+  I want to be able to provide working steps which inspect attachments
+
+  Scenario: Email with Attachments
+    Given no emails have been sent
+    And I go to request attachments be sent to me
+    Then I should receive an email
+    When I open the email
+    Then I should see 2 attachments with the email
+    And there should be an attachment named "image.png"
+    And there should be an attachment named "document.pdf"
+    And attachment 1 should be named "image.png"
+    And attachment 2 should be named "document.pdf"
+    And there should be an attachment of type "image/png"
+    And there should be an attachment of type "application/pdf"
+    And attachment 1 should be of type "image/png"
+    And attachment 2 should be of type "application/pdf"
+    And all attachments should not be blank
+
+  Scenario: Email without Attachments
+    Given no emails have been sent
+    And I am on the homepage
+    And I submit my registration information
+    Then I should receive an email
+    When I open the email
+    Then I should see no attachments with the email

data/examples/rails4_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/rails4_root/features/errors.feature

@@ -0,0 +1,40 @@
+Feature: Email-spec errors example
+  In order to help alleviate email testing in apps
+  As a email-spec contributor I a newcomer
+  Should be able to easily determine where I have gone wrong
+  These scenarios should fail with helpful messages
+
+  Background:
+    Given I am on the homepage
+    And no emails have been sent
+    When I fill in "Email" with "example@example.com"
+    And I press "Sign up"
+
+  Scenario: I fail to open an email with incorrect subject
+    Then I should receive an email
+    When "example@example.com" opens the email with subject "no email"
+
+  Scenario: I fail to open an email with incorrect subject
+    Then I should receive an email
+    When "example@example.com" opens the email with subject /no email/
+
+  Scenario: I fail to open an email with incorrect text
+    Then I should receive an email
+    When "example@example.com" opens the email with text "no email"
+
+  Scenario: I fail to open an email with incorrect text
+    Then I should receive an email
+    When "example@example.com" opens the email with text /no email/
+
+  Scenario: I fail to receive an email with the expected link
+    Then I should receive an email
+    When I open the email
+    When I follow "link that doesn't exist" in the email
+
+  Scenario: I attempt to operate on an email that is not opened
+    Then I should receive an email
+    When I follow "confirm" in the email
+
+  Scenario: I attempt to check out an unopened email
+    Then I should see "confirm" in the email body
+    And I should see "Account confirmation" in the email subject

data/examples/rails4_root/features/example.feature

@@ -0,0 +1,93 @@
+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 three 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
+
+    # Opening email #3
+    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 three 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
+
+    # Opening email #3
+    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
+  
+  Scenario: Checking for text in different parts
+    Then I should receive an email
+    And I should have 1 email
+
+    # Opening email #1
+    When I open the email
+    Then I should see "This is the HTML part" in the email html part body
+    And I should see "This is the text part" in the email text part body
+
+    # Opening email #2
+    When I open the email with text "This is the HTML part"
+    Then I should see "This is the HTML part" in the email html part body
+    And I should see "This is the text part" in the email text part body
+
+    # Opening email #3
+    When I open the email with text /This is the HTML part/
+    Then I should see "This is the HTML part" in the email html part body
+    And I should see "This is the text part" in the email text part body

data/examples/rails4_root/features/step_definitions/email_steps.rb

@@ -0,0 +1,210 @@
+# Commonly used email steps
+#
+# To add your own steps make a custom_email_steps.rb
+# The provided methods are:
+#
+# last_email_address
+# reset_mailer
+# open_last_email
+# visit_in_email
+# unread_emails_for
+# mailbox_for
+# current_email
+# open_email
+# read_emails_for
+# find_email
+#
+# General form for email scenarios are:
+#   - clear the email queue (done automatically by email_spec)
+#   - execute steps that sends an email
+#   - check the user received an/no/[0-9] emails
+#   - open the email
+#   - inspect the email contents
+#   - interact with the email (e.g. click links)
+#
+# The Cucumber steps below are setup in this order.
+
+module EmailHelpers
+  def current_email_address
+    # Replace with your a way to find your current email. e.g @current_user.email
+    # last_email_address will return the last email address used by email spec to find an email.
+    # Note that last_email_address will be reset after each Scenario.
+    last_email_address || "example@example.com"
+  end
+end
+
+World(EmailHelpers)
+
+#
+# Reset the e-mail queue within a scenario.
+# This is done automatically before each scenario.
+#
+
+Given /^(?:a clear email queue|no emails have been sent)$/ do
+  reset_mailer
+end
+
+#
+# Check how many emails have been sent/received
+#
+
+Then /^(?:I|they|"([^"]*?)") should receive (an|no|\d+) emails?$/ do |address, amount|
+  expect(unread_emails_for(address).size).to eql parse_email_count(amount)
+end
+
+Then /^(?:I|they|"([^"]*?)") should have (an|no|\d+) emails?$/ do |address, amount|
+  expect(mailbox_for(address).size).to eql parse_email_count(amount)
+end
+
+Then /^(?:I|they|"([^"]*?)") should receive (an|no|\d+) emails? with subject "([^"]*?)"$/ do |address, amount, subject|
+  expect(unread_emails_for(address).select { |m| m.subject =~ Regexp.new(Regexp.escape(subject)) }.size).to eql parse_email_count(amount)
+end
+
+Then /^(?:I|they|"([^"]*?)") should receive (an|no|\d+) emails? with subject \/([^"]*?)\/$/ do |address, amount, subject|
+  expect(unread_emails_for(address).select { |m| m.subject =~ Regexp.new(subject) }.size).to eql parse_email_count(amount)
+end
+
+Then /^(?:I|they|"([^"]*?)") should receive an email with the following body:$/ do |address, expected_body|
+  open_email(address, :with_text => expected_body)
+end
+
+#
+# Accessing emails
+#
+
+# Opens the most recently received email
+When /^(?:I|they|"([^"]*?)") opens? the email$/ do |address|
+  open_email(address)
+end
+
+When /^(?:I|they|"([^"]*?)") opens? the email with subject "([^"]*?)"$/ do |address, subject|
+  open_email(address, :with_subject => subject)
+end
+
+When /^(?:I|they|"([^"]*?)") opens? the email with subject \/([^"]*?)\/$/ do |address, subject|
+  open_email(address, :with_subject => Regexp.new(subject))
+end
+
+When /^(?:I|they|"([^"]*?)") opens? the email with text "([^"]*?)"$/ do |address, text|
+  open_email(address, :with_text => text)
+end
+
+When /^(?:I|they|"([^"]*?)") opens? the email with text \/([^"]*?)\/$/ do |address, text|
+  open_email(address, :with_text => Regexp.new(text))
+end
+
+#
+# Inspect the Email Contents
+#
+
+Then /^(?:I|they) should see "([^"]*?)" in the email subject$/ do |text|
+  expect(current_email).to have_subject(text)
+end
+
+Then /^(?:I|they) should see \/([^"]*?)\/ in the email subject$/ do |text|
+  expect(current_email).to have_subject(Regexp.new(text))
+end
+
+Then /^(?:I|they) should see "([^"]*?)" in the email body$/ do |text|
+  expect(current_email.default_part_body.to_s).to include(text)
+end
+
+Then /^(?:I|they) should see \/([^"]*?)\/ in the email body$/ do |text|
+  expect(current_email.default_part_body.to_s).to match Regexp.new(text)
+end
+
+Then /^(?:I|they) should see the email delivered from "([^"]*?)"$/ do |text|
+  expect(current_email).to be_delivered_from(text)
+end
+
+Then /^(?:I|they) should see the email reply to "([^"]*?)"$/ do |text|
+  current_email.should have_reply_to(text)
+end
+
+Then /^(?:I|they) should see "([^\"]*)" in the email "([^"]*?)" header$/ do |text, name|
+  expect(current_email).to have_header(name, text)
+end
+
+Then /^(?:I|they) should see \/([^\"]*)\/ in the email "([^"]*?)" header$/ do |text, name|
+  expect(current_email).to have_header(name, Regexp.new(text))
+end
+
+Then /^I should see it is a multi\-part email$/ do
+    expect(current_email).to be_multipart
+end
+
+Then /^(?:I|they) should see "([^"]*?)" in the email html part body$/ do |text|
+    expect(current_email.html_part.body.to_s).to include(text)
+end
+
+Then /^(?:I|they) should see "([^"]*?)" in the email text part body$/ do |text|
+    expect(current_email.text_part.body.to_s).to include(text)
+end
+
+#
+# Inspect the Email Attachments
+#
+
+Then /^(?:I|they) should see (an|no|\d+) attachments? with the email$/ do |amount|
+  expect(current_email_attachments.size).to eql parse_email_count(amount)
+end
+
+Then /^there should be (an|no|\d+) attachments? named "([^"]*?)"$/ do |amount, filename|
+  expect(current_email_attachments.select { |a| a.filename == filename }.size).to eql parse_email_count(amount)
+end
+
+Then /^attachment (\d+) should be named "([^"]*?)"$/ do |index, filename|
+  expect(current_email_attachments[(index.to_i - 1)].filename).to eql filename
+end
+
+Then /^there should be (an|no|\d+) attachments? of type "([^"]*?)"$/ do |amount, content_type|
+  expect(current_email_attachments.select { |a| a.content_type.include?(content_type) }.size).to eql parse_email_count(amount)
+end
+
+Then /^attachment (\d+) should be of type "([^"]*?)"$/ do |index, content_type|
+  expect(current_email_attachments[(index.to_i - 1)].content_type).to include(content_type)
+end
+
+Then /^all attachments should not be blank$/ do
+  current_email_attachments.each do |attachment|
+    expect(attachment.read.size).to_not eql 0
+  end
+end
+
+Then /^show me a list of email attachments$/ do
+  EmailSpec::EmailViewer::save_and_open_email_attachments_list(current_email)
+end
+
+#
+# Interact with Email Contents
+#
+
+When /^(?:I|they|"([^"]*?)") follows? "([^"]*?)" in the email$/ do |address, link|
+  visit_in_email(link, address)
+end
+
+When /^(?:I|they) click the first link in the email$/ do
+  click_first_link_in_email
+end
+
+#
+# Debugging
+# These only work with Rails and OSx ATM since EmailViewer uses RAILS_ROOT and OSx's 'open' command.
+# Patches accepted. ;)
+#
+
+Then /^save and open current email$/ do
+  EmailSpec::EmailViewer::save_and_open_email(current_email)
+end
+
+Then /^save and open all text emails$/ do
+  EmailSpec::EmailViewer::save_and_open_all_text_emails
+end
+
+Then /^save and open all html emails$/ do
+  EmailSpec::EmailViewer::save_and_open_all_html_emails
+end
+
+Then /^save and open all raw emails$/ do
+  EmailSpec::EmailViewer::save_and_open_all_raw_emails
+end