gardelea-email_spec 1.3.0

data/History.txt

@@ -0,0 +1,257 @@
+== 1.3.x (git)
+
+  * removing jeweler in favor of just using bundler for all that gem management type stuff
+
+== 1.3.0 2011-04-07
+
+Many thanks to Derek Hammer and George Ardeleanu who both spontaneously cleaned up various parts of the project 
+and helped get the release out the door. Yay opensoruce!
+
+ === New features
+  * Launchy is now used to open up the email viewer.  (Matt Burke)
+  * Email Viewer now works in Rails 3 (Woody Peterson)
+  * Email Viewer now works with UTF-8. (Woody Peterson)
+  * Documentation for email matchers. (Derek Hammer)
+
+== 1.2.1 2011-06-20
+
+  === Bugfixes
+  * find_email now allows with_subject and with_text to be either a String or Regexp. Issue #67. (Curtis Miller)
+
+== 1.2.0 2011-06-16
+
+ === New features
+  * [he|she] options for steps. (Dan Croak)
+  * cc_to RSpec matcher. (Arie on github)
+  * Check both html and text parts of multipart emails in Cucumber step. (Charles Barbier)
+  * delivery_method is not set by email_spec to allow for SMTP (e.g. MockSMTP) delivery (Donald Piret)
+
+ === Bugfixes
+  * delivered_to matcher now compares both sender name and email address. (Jason Garber)
+  * find_email now matches with_subject and with_text containing text with regex sensitive characters. Issue #31. (Curtis Miller)
+  * current_email_address to work outside of the context of Cucumber. (Szymon Przybył)
+
+== 1.1.1 2010-12-29
+  * Require "action_mailer" to avoid deprecation warnings. (Ryan Bigg)
+  * Relaxes pessimistic version dependency on RSpec. (GH-41 Dan Pickett)
+
+== 1.1.0 2010-12-20
+
+ === Bugfixes
+  * anchor tags are no longer ignored when clicking links in emails (Anders Törnqist and Nicklas Ramhöj)
+  * set_current_email handles cases where To to blank but may contain CC, or BCC recipients (Murray Steele)
+  * Doc fixes (Florent Guilleux)
+
+
+== 1.0 2010-07-31 Rails 3.0 Release
+  This release makes email-spec compatible with Rails 3 and RSpec 2.x.
+
+  IMPORTANT: As of 1.0 email-spec is no longer backwards compatible wit Rails 2.x.  I will be maintaining a 0.6
+  branch on github/rubygems for Rails 2 compatibility if anyone wants new features backported.
+
+  This was truly a community effort and I appreciate all of time and effort donated by those involved. Specifically:
+    * Maxim Chernyak for the initial conversion work to Rails 3
+    * Tim Harper for ironing out various matcher bugs
+    * Patrick Muldoon for doing a fantastic job of cleaning up the features and specs.  He also fixed the
+      DelayedJob support and worked through all the bundler issues the project was facing.
+
+ === Bugfixes
+  * Further checks for older DelayedJob versions to fix compatibility issues. (Andrea Longhi and others)
+
+== 0.6.2 2010-03-21
+
+ === New features
+  * New reply_to matcher. (David Balatero)
+
+== 0.6.1 2010-03-17
+
+ === New features
+  * Ability to click image links via the image alt tag. (Tim Harper)
+
+== 0.6.0 2010-03-05
+
+ === New features
+  * Ability to open a list of attachments on an email (with corresponding steps and EmailViewer support). (Kieran Pilkington)
+
+ === Bugfixes
+  * Spelling mistake in steps. (Ben Mabey)
+  * Delayed Job background processor fixes
+    * Narrow delayed job collisions with other apps defining Delayed constant. (Kieran Pilkington)
+    * Fix compatibility with earlier versions of DelayedJob (Michael Baumgarten and Kieran Pilkington)
+
+ === Changes
+  * Deprecated steps were removed. (Kieran Pilkington)
+
+ === Bugfixes
+
+== 0.5.0 2010-02-22
+
+ === New features
+  * "should receive <x> emails with subject <the_subject>" step definition (Balint Erdi)
+  * "should receive an email with the following body:" step definition (Ben Mabey)
+  * Debugging steps that tie into EmailViewer: (Ben Mabey)
+    * "save and open current email"
+    * "save and open all text emails"
+    * "save and open all html emails"
+    * "save and open all raw emails"
+
+ === Bugfixes
+  * Gracefully handle cases where emails do not have a 'to' value. (Kieran Pilkington)
+
+ === Bugfixes
+
+== 0.4.0 2010-01-07
+
+ === New features
+    * Added support for action_mailer_cache_delivery plugin. (Dan Dofter)
+      You must use the fork at: http://github.com/liangzan/action_mailer_cache_delivery
+
+ === Bugfixes
+    * be_delivered_from matcher now compares both sender name and email address. (Dan Dofter)
+
+== 0.3.8 2009-12-23
+
+ === Bugfixes
+    * Guard against cc and bcc fields being nil for ActionMailer. (Piotr Sarnacki)
+
+== 0.3.7 2009-12-17
+
+ === New features
+ * Matchers are now Ruby 1.9 compatible. (John Dewey)
+
+== 0.3.6 2009-12-16
+
+ === New features
+ * Cucumber steps for be_delivered_from, have_header matchers. (Joseph Holsten)
+ * Explicit regular expression steps. i.e. "I should see /foo/ in the email body" (Joseph Holsten)
+
+== 0.3.5 2009-09-30 The Pony Release!
+
+ === New features
+ * Support for Pony mailer library. (Rob Holland)
+
+== 0.3.4 2009-09-26
+
+=== Bugfixes
+ * Typo and logic fixes for DeliverFrom matcher. (Yury Kotlyarov)
+
+ == 0.3.3 2009-09-18
+
+ === New features
+ * DeliverFrom matcher. i.e. email.should deliver_from(blah) or email.should be_delivered_from(blah) (Diego Carrion)
+
+ == 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
+and the newer step definistions including the new third-person forms.
+
+Some of the generated steps are being removed in favor of some of the newer ones.  The older ones
+will remain until 0.4.0 but will issue deprecation warnings.
+
+Big shoutout to Kieran Pilkington who did the majority of work for this release.
+
+ == 0.3.0 2009-08-13
+
+ === New features
+  * New helper #last_email_address which returns the last address used by email-spec for that scenario. (Ben Mabey)
+  * Steps now support third person language. (Kieran P)
+  * "[email] should receive ... " now supports "an" instead of just an integer. (Kieran Pilkington)
+    With these changes, the following is now possible:
+
+      Then "jack@example.com" should receive an email
+      When they open the email
+      Then they should see "Account has been created" in the subject
+
+  * Additional default steps (Balint Erdi)
+    * Then /^I should not receive any emails?$/
+    * When %r{^"([^"]*?)" opens? the email$} do |address|
+
+ === Bugfixes
+
+ == 0.2.1 2009-5-29
+
+ === New Features
+  * BCC RSpec matcher. (Josh Nichols)
+
+ === Bugfixes
+  * Include BCCed and CCed messsages in the mailbox. (Jakub Kosiński)
+
+== 0.2.0 2009-6-08
+No changes. Bumping version for RubyForge release.
+
+
+ == 0.1.4 2009-5-29
+
+ === Bugfixes
+  * Require deliveries in the helpers so it doesn't blow up with RSpec. (Craig Webster)
+
+ == 0.1.3 2009-4-15
+
+ === Bugfixes
+  * Fixed regular expressions in genertaed steps. (Ben Mabey)
+  * World semantics changed in cucumber (0.2.3.2), email_spec now uses the new API. (Hector Morales)
+
+ == 0.1.2 2009-4-05
+
+ === New features
+ === Bugfixes
+  * Actually added the renamed generators to the gem so people could use it! D'oh! (Ben Mabey)
+    * You can either use "./script generate email_spec" or "rubigen rails email_spec"
+  * Removed Rake tasks from example application to prevent conflicts when used as a plugin. (Ben Mabey)
+
+ == 0.1.1 2009-3-26
+ === New features
+  * Switched dir structure over to support rubigen. (Dr. Nic)
+
+ === Bugfixes
+
+ == 0.1.0 2009-3-25
+ === New features
+  * Change Rakefile to run all specs and features, as well as prepare the db (Mischa Fierer)
+  * Allow for array to be passed into deliver_to matcher. (Diego Carrion)
+  * Added matcher for checking if a collision of emails includes an email with a particular subject (Luke Melia, Noah Davis)
+  * Introduced hook to convert objects to email addresses (Luke Melia and Lee Bankewitz)
+
+    This allows you, in your step matcher, to say something like:
+    maillbox_for(some_user)
+
+    Use it in your cucumber env.rb like so:
+
+      EmailSpec::AddressConverter.instance.conversion do |input|
+       if input.is_a?(User)
+         input.email
+       else
+         input
+       end
+      end
+
+=== Bugfixes
+ * Revert parse_email_for_link helper method to allow for text links as well as explicit link finding. (Mischa Fierer)
+ * Isolated variances between using email-spec with an ARMailer project. (Luke Melia)
+
+
+== 0.0.9 2009-2-15
+ === New features
+  * have_body_text, have_header matchers (Luke Melia)
+  * EmailViewer - opens all sent emails in a given scenario when the environment variables are set. (Luke Melia)
+  * Added compatibility with using ARMailer in test mode. (Luke Melia)
+ === Bugfixes
+  * set_current_email now works with multiple addresses in To field. (Brian McManus, Ben Mabey)
+
+== 0.0.7 2009-1-20
+ === New features
+  * have_subject matcher (Ben Mabey)
+
+== 0.0.6 2008-12-23
+ === New features
+  * Improved RSpec documentation and refactorings. (Ben Mabey)
+ === Bugfixes
+  * Removed sample app Rake Tasks to have it play nice with environments that use Cucumber as plugin- not gem. (Ben Mabey, Ivor- on github)
+
+== 0.0.5 2008-12-18
+  * Initial release - see this post for full history and contributors: http://www.benmabey.com/2008/12/18/github-rocks/

data/MIT-LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2008-2009 Ben Mabey
+
+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,277 @@
+
+[![Build Status](https://secure.travis-ci.org/bmabey/email-spec.png)](http://travis-ci.org/bmabey/email-spec)
+
+## Email Spec
+
+A collection of RSpec matchers and Cucumber steps to make testing emails go smoothly.
+
+This library works with ActionMailer and Pony.  When using it with ActionMailer it works with
+DelayedJob, ActiveRecord Mailer, and action_mailer_cache_delivery.
+
+If you are testing emails in conjunction with an automated browser solution, like Selenium,
+you will want to use [action_mailer_cache_delivery](http://rubygems.org/gems/action_mailer_cache_delivery) in your test environment.  (This is
+because your test process and server processes are distinct and therefore need an
+intermediate store for the emails.) DelayedJob and ActiveRecord Mailer will also work but
+you generally don't want to include those projects unless you need them in production.
+
+## Setup
+
+```bash
+script/plugin install git://github.com/bmabey/email-spec.git
+```
+
+### Gem Setup
+
+```ruby
+gem install email_spec
+
+# Gemfile
+group :test do
+  gem 'email_spec'
+end
+```
+
+### Cucumber
+
+To use the steps in features put the following in your env.rb:
+
+```ruby
+# Make sure this require is after you require cucumber/rails/world.
+require 'email_spec' # add this line if you use spork
+require 'email_spec/cucumber'
+```
+
+This will load all the helpers that the steps rely on.
+It will also add a Before hook for Cucumber so that emails are cleared at the start of each scenario.
+
+Then:
+
+```bash
+rails generate email_spec:steps
+```
+
+This will give you a bunch of steps to get started with in step_definitions/email_steps.rb
+
+By default, the generated file will look for email to example@example.com. You can either change this
+by editing the current_email_address method in email_steps.rb, or by simply specifying the target
+email in your features:
+
+```gherkin
+Scenario: A new person signs up
+    Given I am at "/"
+    When I fill in "Email" with "quentin@example.com"
+    And I press "Sign up"
+    And "quentin@example.com" should receive an email   # Specify who should receive the email
+```
+
+### RSpec
+
+First you need to require email_spec in your spec_helper.rb:
+
+```ruby
+require "email_spec"
+```
+
+You will then need to include EmailSpec::Helpers and EmailSpec::Matchers in your example groups.
+If you want to have access to the helpers and matchers in all of your examples you can do the following in your spec_helper.rb:
+
+```ruby
+RSpec.configure do |config|
+  config.include(EmailSpec::Helpers)
+  config.include(EmailSpec::Matchers)
+end
+```
+
+Otherwise, you will need to include them in the example groups you wish to use them:
+
+```ruby
+describe "Signup Email" do
+  include EmailSpec::Helpers
+  include EmailSpec::Matchers
+  ...
+end
+```
+
+## Usage
+
+### Cucumber
+
+```gherkin
+Scenario: A new person signs up
+    Given I am at "/"
+    When I fill in "Email" with "quentin@example.com"
+    And I press "Sign up"
+    And I should receive an email
+    When I open the email
+    Then I should see "confirm" in the email body
+    When I follow "confirm" in the email
+    Then I should see "Confirm your new account"
+```
+
+For more examples, check out examples/rails_root in the source for a small example app that implements these steps.
+
+### Cucumber Matchers (Ruby)
+
+See RSpec Matchers (they are the same)
+
+### RSpec
+
+#### Testing In Isolation
+It is often useful to test your mailers in isolation.  You can accomplish this by using mocks to verify that the mailer is being called in the correct place and then write focused examples for the actual mailer.  This is a simple example from the sample app found in the gem:
+
+Verify that the mailer is used correctly in the controller (this would apply to a model as well):
+
+```ruby
+describe "POST /signup (#signup)" do
+  it "should deliver the signup email" do
+    # expect
+    UserMailer.should_receive(:deliver_signup).with("email@example.com", "Jimmy Bean")
+    # when
+    post :signup, "Email" => "email@example.com", "Name" => "Jimmy Bean"
+  end
+end
+```
+
+Examples for the #signup method in UserMailer:
+
+```ruby
+describe "Signup Email" do
+  include EmailSpec::Helpers
+  include EmailSpec::Matchers
+  # include ActionController::UrlWriter - old rails
+  include Rails.application.routes.url_helpers
+
+  before(:all) do
+    @email = UserMailer.create_signup("jojo@yahoo.com", "Jojo Binks")
+  end
+
+  it "should be set to be delivered to the email passed in" do
+    @email.should deliver_to("jojo@yahoo.com")
+  end
+
+  it "should contain the user's message in the mail body" do
+    @email.should have_body_text(/Jojo Binks/)
+  end
+
+  it "should contain a link to the confirmation link" do
+    @email.should have_body_text(/#{confirm_account_url}/)
+  end
+
+  it "should have the correct subject" do
+    @email.should have_subject(/Account confirmation/)
+  end
+
+end
+```
+
+#### RSpec Matchers
+
+##### reply_to(email)
+alias: `have_reply_to`
+
+This checks that the Reply-To header's email address (the bob@example.com of
+"Bob Saget <bob@example.com>") is set to the given string.
+
+```ruby
+email = UserMailer.create_signup("jojo@yahoo.com", "Jojo Binks")
+email.should reply_to("support@myapp.com")
+```
+
+
+##### deliver_to(*email_addresses)
+alias: `be_delivered_to`
+
+This checks that the To header's email addresses (the bob@example.com of
+"Bob Saget <bob@example.com>") are set to the addresses.
+
+```ruby
+email = UserMailer.create_signup("jojo@yahoo.com", "Jojo Binks")
+email.should deliver_to("jojo@yahoo.com")
+```
+
+
+##### deliver_from(email)
+alias: `be_delivered_from`
+
+This checks that the From header's email address (the bob@example.com of
+"Bob Saget <bob@example.com>") is set to the given string.
+
+```ruby
+email = UserMailer.create_signup("jojo@yahoo.com", "Jojo Binks")
+email.should deliver_from("sally@yahoo.com")
+```
+
+
+##### bcc_to(*email_addresses)
+
+This checks that the BCC header's email addresses (the bob@example.com of
+"Bob Saget <bob@example.com>") are set to the addresses.
+
+```ruby
+email = UserMailer.create_signup("jojo@yahoo.com", "Jojo Binks")
+email.should bcc_to("sue@yahoo.com", "bill@yahoo.com")
+```
+
+
+##### cc_to(*email_addresses)
+
+This checks that the CC header's email addresses (the bob@example.com of
+"Bob Saget <bob@example.com>") are set to the addresses.
+
+```ruby
+email = UserMailer.create_signup("jojo@yahoo.com", "Jojo Binks")
+email.should cc_to("sue@yahoo.com", "bill@yahoo.com")
+```
+
+
+##### have_subject(subject)
+
+This checks that the Subject header's value is set to the given subject.
+
+```ruby
+email = UserMailer.create_signup("jojo@yahoo.com", "Jojo Binks")
+email.should have_subject("Welcome!")
+```
+
+
+##### include_email_with_subject(subject)
+Note: subject can be either a String or a Regexp
+
+This checks that one of the given emails' subjects includes the subject.
+
+```ruby
+email = UserMailer.create_signup("jojo@yahoo.com", "Jojo Binks")
+email2 = UserMailer.forgot_password("jojo@yahoo.com", "Jojo Binks")
+[email, email2].should include_email_with_subject("Welcome!")
+```
+
+
+##### have_body_text(text)
+Note: text can be either a String or a Regexp
+
+This checks that the text of the body has the given body.
+
+```ruby
+email = UserMailer.create_signup("jojo@yahoo.com", "Jojo Binks")
+email.should have_body_text(/Hi Jojo Binks,/)
+```
+
+
+##### have_header(key, value)
+
+This checks that the expected key/value pair is in the headers of the email.
+
+```ruby
+email = UserMailer.create_signup("jojo@yahoo.com", "Jojo Binks")
+email.should have_header("X-Campaign", "1234abc")
+```
+
+#### Using the helpers when not testing in isolation
+
+Don't. :)  Seriously, if you do just take a look at the helpers and use them as you wish.
+
+## Original Authors
+
+Ben Mabey, Aaron Gibralter, Mischa Fierer
+
+Please see History.txt for upcoming changsets and other contributors.