mischa-email-spec 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-12-18
+
+* 1 major enhancement:
+  * Initial release

data/MIT-LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2007 Bryan Helmkamp, Seth Fitzsimmons
+
+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.rdoc

@@ -0,0 +1,56 @@
+= Email Spec
+
+A collection of RSpec matchers and Cucumber steps to make testing emails go smoothly.
+
+
+== Setup
+
+  script/plugin install git://github.com/bmabey/email-spec.git
+
+=== Cucumber
+
+To use the steps in features put the following in your env.rb:
+
+  # Make sure this require is after you require cucumber/rails/world.
+  require 'email_spec_feature_setup'
+
+=== RSpec
+	
+The matchers and helpers should be available for your specs by default, but you need to include them into the example groups you want to use them in.  To include them in all of your specs you can do this in your spec_helper.rb:
+
+  Spec::Runner.configure do |config|
+    config.include(EmailSpec::Helpers)
+    config.include(EmailSpec::Matchers)
+  end
+
+== Usage
+
+=== Cucumber
+
+  Scenario: A new person signs up
+      Given I am at "/"
+      And a clear email queue
+      When I fill in "Email" with "quentin@example.com"
+      And I fill in "Password" with "monkey"
+      And I fill in "Password confirmation" with "monkey"
+      And I press "Sign up"
+      Then "quentin@example.com" should receive 1 email
+      And "quentin@example.com" should have 1 email
+      And "foo@bar.com" should not receive an email
+      When I open the email
+      Then I should see "confirm" in the email
+      And I should see "Account confirmation" in the subject
+      When I follow "confirm" in the email
+      Then I should see "Confirm your new account"
+
+Check out an app that implements these features at http://github.com/bmabey/email-spec-sample-app
+
+== TODO:
+
+- refactor!
+- provide custom matchers to give better messages
+
+== Authors
+
+Ben Mabey, Aaron Gibralter, Mischa Fierer
+

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require "rake/gempackagetask"
+require 'rake/rdoctask'
+require "rake/clean"
+require 'spec'
+require 'spec/rake/spectask'
+require File.expand_path('./lib/email_spec.rb')
+
+# Package && release
+spec = Gem::Specification.new do |s|
+  s.name         = "email-spec"
+  s.version      = EmailSpec::VERSION
+  s.platform     = Gem::Platform::RUBY
+  s.authors      = ['Ben Mabrey', 'Aaron Gibralter', 'Mischa Fierer']
+  s.email        = "f.mischa@gmail.com"
+  s.homepage     = "http://github.com/bmabey/email-spec/"
+  s.summary      = "Easily test email in rspec and cucumber"
+  s.bindir       = "bin"
+  s.description  = s.summary
+  s.require_path = "lib"
+  s.files        = %w(History.txt install.rb MIT-LICENSE.txt README.rdoc Rakefile) + Dir["lib/**/*"]
+  # rdoc
+  s.has_rdoc         = true
+  s.extra_rdoc_files = %w(README.rdoc MIT-LICENSE.txt)
+end
+
+desc 'Show information about the gem.'
+task :debug_gem do
+  puts spec.to_ruby
+end
+
+CLEAN.include ["pkg", "*.gem", "doc", "ri", "coverage", '**/.*.sw?', '*.gem', '.config', '**/.DS_Store', '**/*.class', '**/*.jar', '**/.*.swp' ]
+
+desc 'Install the package as a gem.'
+task :install_gem => [:clean, :package] do
+  gem = Dir['pkg/*.gem'].first
+  sh "sudo gem install --local #{gem}"
+end
+
+task :gemspec do
+  system "rake debug_gem | grep -v \"(in \" > email-spec.gemspec"
+end
+
+task :features do
+  system("cd spec/rails_root; rake features; cd ../..")
+end
+
+task :default => :features
+

data/lib/email_spec/email_spec_feature_setup.rb

@@ -0,0 +1,19 @@
+# require this in your env.rb file after you require cucumber/rails/world
+
+%w[steps].each do |file|
+  require File.join(File.dirname(__FILE__), "email_spec_#{file}.rb")
+end
+
+# Global Setup
+ActionMailer::Base.delivery_method = :test
+ActionMailer::Base.perform_deliveries = true
+
+Before do 
+  # Scenario setup
+  ActionMailer::Base.deliveries.clear
+end
+
+World do |world|
+  world.extend EmailSpec::Helpers
+  world.extend EmailSpec::Matchers
+end

data/lib/email_spec/email_spec_helpers.rb

@@ -0,0 +1,70 @@
+require 'uri'
+
+module EmailSpec
+
+  module Helpers
+
+    def self.extended(base)
+      base.instance_eval do
+        @email_spec_hash = {}
+        @email_spec_hash[:read_emails] = {}
+        @email_spec_hash[:unread_emails] = {}
+        @email_spec_hash[:current_emails] = {}
+        @email_spec_hash[:current_email] = nil
+      end
+    end
+    
+    def reset_mailer
+      ActionMailer::Base.deliveries.clear
+    end
+    
+    def open_email(email_address, opts={})
+      if opts[:with_subject]
+        email = mailbox_for(email_address).find { |m| m.subject =~ Regexp.new(opts[:with_subject]) }
+      elsif opts[:with_text]
+        email = mailbox_for(email_address).find { |m| m.body =~ Regexp.new(opts[:with_text]) }
+      else
+        email = mailbox_for(email_address).first
+      end
+            
+      read_emails_for(email_address) << email if email
+      @email_spec_hash[:current_emails][email_address] = email
+      @email_spec_hash[:current_email] = email
+    end
+
+    def open_last_email
+      email = ActionMailer::Base.deliveries.last
+      read_emails_for(email.to) << email if email
+      @email_spec_hash[:current_emails][email.to] = email
+      @email_spec_hash[:current_email] = email
+    end
+    
+    def current_email(email_address=nil)
+      email_address ? @email_spec_hash[:current_emails][email_address] : @email_spec_hash[:current_email]
+    end
+    
+    def unread_emails_for(email_address)
+      mailbox_for(email_address) - read_emails_for(email_address)
+    end
+    
+    def read_emails_for(email_address)
+      @email_spec_hash[:read_emails][email_address] ||= []
+    end
+    
+    def mailbox_for(email)
+      ActionMailer::Base.deliveries.select { |m| m.to.include?(email) }
+    end
+    
+    def parse_email_for_link(mail, link_text)
+      if mail.body.include?(link_text)
+        if link_text =~ %r{^/.*$}
+          # if it's an explicit link
+          link_text
+        elsif mail.body =~ %r{<a[^>]*href=['"]?([^'"]*)['"]?[^>]*?>[^<]*?#{link_text}[^<]*?</a>}
+          # if it's an anchor tag
+          URI.split($~[1])[5..-1].compact!.join("?")
+        end
+      end
+    end
+  end
+end

data/lib/email_spec/email_spec_matchers.rb

@@ -0,0 +1,34 @@
+module EmailSpec
+
+    module Matchers
+          
+    class DeliverTo
+
+      def initialize(expected_email_addresses)
+        @expected_email_addresses = expected_email_addresses.sort
+      end
+
+      def matches?(email)
+        @email = email
+        @actual_recipients = (email.to || []).sort
+        @actual_recipients.should == @expected_email_addresses
+        true
+      end
+
+      def failure_message
+        "expected #{@email.inspect} to deliver to #{@expected_email_addresses.inspect}, but it delievered to #{@actual_recipients.inspect}"
+      end
+
+      def negative_failure_message
+        "expected #{@email.inspect} not to deliver to #{@expected_email_addresses.inspect}, but it did"
+      end
+    end
+
+    def deliver_to(*expected_email_addresses_or_objects_that_respond_to_email)
+      emails = expected_email_addresses_or_objects_that_respond_to_email.map do |email_or_object|
+        email_or_object.kind_of?(String) ? email_or_object : email_or_object.email
+      end
+      DeliverTo.new(emails)
+    end
+  end
+end

data/lib/email_spec/email_spec_steps.rb

@@ -0,0 +1,46 @@
+Given /^(?:a clear email queue|no emails have been sent)$/ do
+  reset_mailer
+end
+
+# Action
+#
+When /^I open the email$/ do
+  open_last_email.should_not be_nil
+end
+
+When /^I follow "(.*)" in the email$/ do |link_text|
+  current_email.should_not be_nil
+  link = parse_email_for_link(current_email, link_text)
+  visit(link)
+end
+
+When /^I click "(.*)" in the email$/ do |link_text|
+  current_email.should_not be_nil
+  link = parse_email_for_link(current_email, link_text)
+  visit(link)
+end
+
+
+# Verification
+Then /^"([^']*?)" should receive (\d+) emails?$/ do |email, n|
+  unread_emails_for(email).size.should == n.to_i
+end
+
+Then /^"([^']*?)" should have (\d+) emails?$/ do |email, n|
+  mailbox_for(email).size.should == n.to_i
+end
+
+Then /^"([^']*?)" should not receive an email$/ do |email|
+  open_email(email).should be_nil
+end
+
+Then /^I should see "(.*)" in the subject$/ do |text|
+  raise ArgumentError, "To check the subject, you must first open an e-mail" if current_email.nil?
+  current_email.should_not be_nil
+  current_email.subject.should =~ Regexp.new(text)
+end
+
+Then /^I should see "(.*)" in the email$/ do |text|
+  current_email.should_not be_nil
+  current_email.body.should =~ Regexp.new(text)
+end

data/lib/email_spec.rb

@@ -0,0 +1,3 @@
+class EmailSpec
+  VERSION = '0.0.1'
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: mischa-email-spec
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ben Mabrey
+- Aaron Gibralter
+- Mischa Fierer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-18 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Easily test email in rspec and cucumber
+email: f.mischa@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- MIT-LICENSE.txt
+files: 
+- History.txt
+- install.rb
+- MIT-LICENSE.txt
+- README.rdoc
+- Rakefile
+- lib/email_spec
+- lib/email_spec/email_spec_feature_setup.rb
+- lib/email_spec/email_spec_helpers.rb
+- lib/email_spec/email_spec_matchers.rb
+- lib/email_spec/email_spec_steps.rb
+- lib/email_spec.rb
+has_rdoc: true
+homepage: http://github.com/bmabey/email-spec/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Easily test email in rspec and cucumber
+test_files: []
+