pony-test 0.1.0

data/README.rdoc

@@ -0,0 +1,101 @@
+= Pony-Test
+
+A collection of helper methods and Cucumber steps to make testing email with Pony a piece of cake.
+It works simply by overwriting the Pony mail method with one that stores the email in an array instead of sending it.
+You can access this email with the helper methods and perform whatever checks you want.
+
+== Usage
+
+=== Helper methods
+
+<tt>deliveries</tt>, <tt>all_email</tt> returns the whole array of emails
+
+<tt>current_email</tt> returns either the last email sent, or the last email "opened"
+
+<tt>current_email_address</tt> returns the last address used in a lookup operation
+
+<tt>reset_mailer</tt> clears everything
+
+<tt>last_email_sent</tt> "opens" the last email sent
+
+<tt>inbox</tt>, <tt>inbox_for</tt> returns all emails, filterable by address, pass the option <tt>:address => 'foo@example.com'</tt>
+
+<tt>open_email</tt>, <tt>open_email_for</tt> "opens" the first email matching all criteria, accepts options <tt>:address</tt>, <tt>:with_subject</tt>, and <tt>:with_body</tt>
+
+<tt>find_email</tt>, <tt>find_email_for</tt> returns all email matching all criteria, accepts options <tt>:address</tt>, <tt>:with_subject</tt>, and <tt>:with_body</tt> 
+
+<tt>email_links</tt> returns all links in an email body, searching <tt>current_email</tt> by default
+
+<tt>email_links_matching</tt> returns all links matching a pattern
+
+=== Cucumber
+
+  Scenario: A new person signs up
+      Given I am at "/"
+      When I fill in "Email" with "quentin@example.com"
+      And I press "Sign up"
+      Then I should have an email
+      And I should see "confirm" in the email body
+
+      When I visit "confirm" in the email
+      Then I should see "Confirm your new account"
+
+Please read <tt>lib/email_steps.rb</tt> for the other steps.  For more examples, check out the <tt>examples</tt> folder for a small example app that implements the steps.
+
+== Setup
+
+For now, I am including this project into others with a symlink. If you clone this project next to your current working project, run this inside you current project:
+
+  ln -s ../pony-test pony-test
+
+To require files from this folder, you may first want to add the <tt>lib</tt> dir to the load path.  For example, from the file <tt>spec/spec_helper.rb</tt> you could add:
+
+  $: << File.join(File.expand_path(File.dirname(__FILE__)), %w{ .. pony-test lib })
+  
+  ...
+  require 'pony-test'
+
+A gem for this project is coming soon.
+
+=== Cucumber
+
+To use pony-test in Cucumber include the helpers in <tt>features/support/env.rb</tt>:
+
+  World do
+    ...
+    include Pony::TestHelpers
+  end
+
+This will load all the helpers that the steps rely on. You probably want all emails to be cleared for each scenario:
+
+  Before do
+    reset_mailer
+  end
+
+Also, copy <tt>email_steps.rb</tt> to <tt>features/step_definitions</tt> to get access to many predifined steps.
+
+=== RSpec
+
+You will need to include Pony::TestHelpers in your example groups.
+If you want to have access to the helpers in all of your examples you can do the following in your <tt>spec_helper.rb</tt>:
+
+  Spec::Runner.configure do |config|
+    config.include(Pony::TestHelpers)
+  end
+
+Otherwise, you will need to include them in the example groups you wish to use them:
+
+  describe "Signup Email" do
+    include Pony::TestHelpers
+    ...
+  end
+
+Remember to call <tt>reset_mailer</tt> in a <tt>before</tt> block or whenever you want the emails to be reset.
+
+== Acknowledgements
+
+This project is a major simplification and rewrite of the Email-Spec project:
+
+http://github.com/bmabey/email-spec
+
+If you are a Rails/ActionMailer user, you may want to check it out.

data/Rakefile

@@ -0,0 +1,118 @@
+require "rubygems"
+require "rake/gempackagetask"
+require "rake/rdoctask"
+
+task :default => :spec
+
+require "spec"
+require "spec/rake/spectask"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = %w(--format specdoc --colour)
+  t.libs = ["spec"]
+end
+
+# This builds the actual gem. For details of what all these options
+# mean, and other ones you can add, check the documentation here:
+#
+#   http://rubygems.org/read/chapter/20
+#
+spec = Gem::Specification.new do |s|
+
+  # Change these as appropriate
+  s.name              = "pony-test"
+  s.version           = "0.1.0"
+  s.summary           = "Collection of helper methods and Cucumber steps for testing email through Pony"
+  s.author            = "John Mendonca"
+  s.email             = "joaosihno@gmail.com"
+  s.homepage          = "http://github.com/johnmendonca/pony-test"
+
+  s.has_rdoc          = true
+  s.extra_rdoc_files  = %w(README.rdoc)
+  s.rdoc_options      = %w(--main README.rdoc)
+
+  # Add any extra files to include in the gem
+  s.files             = %w(Rakefile README.rdoc) + Dir.glob("{spec,lib/**/*}")
+  s.require_paths     = ["lib"]
+
+  # If you want to depend on other gems, add them here, along with any
+  # relevant versions
+  # s.add_dependency("")
+
+  # If your tests use any gems, include them here
+  s.add_development_dependency("pony", "~> 0.6.0")
+  s.add_development_dependency("rspec")
+  s.add_development_dependency("cucumber")
+  s.add_development_dependency("webrat")
+  s.add_development_dependency("rack-test")
+
+  # If you want to publish automatically to rubyforge, you'll may need
+  # to tweak this, and the publishing task below too.
+  s.rubyforge_project = "pony-test"
+end
+
+# This task actually builds the gem. We also regenerate a static
+# .gemspec file, which is useful if something (i.e. GitHub) will
+# be automatically building a gem for this project. If you're not
+# using GitHub, edit as appropriate.
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+
+  # Generate the gemspec file for github.
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, "w") {|f| f << spec.to_ruby }
+end
+
+# Generate documentation
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+  rd.rdoc_dir = "rdoc"
+end
+
+desc 'Clear out RDoc and generated packages'
+task :clean => [:clobber_rdoc, :clobber_package] do
+  rm "#{spec.name}.gemspec"
+end
+
+# If you want to publish to RubyForge automatically, here's a simple
+# task to help do that. If you don't, just get rid of this.
+# Be sure to set up your Rubyforge account details with the Rubyforge
+# gem; you'll need to run `rubyforge setup` and `rubyforge config` at
+# the very least.
+begin
+  require "rake/contrib/sshpublisher"
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Release a new version of this gem"
+      task :gem => [:package] do
+        require 'rubyforge'
+        rubyforge = RubyForge.new
+        rubyforge.configure
+        rubyforge.login
+        rubyforge.userconfig['release_notes'] = spec.summary
+        path_to_gem = File.join(File.dirname(__FILE__), "pkg", "#{spec.name}-#{spec.version}.gem")
+        puts "Publishing #{spec.name}-#{spec.version.to_s} to Rubyforge..."
+        rubyforge.add_release(spec.rubyforge_project, spec.name, spec.version.to_s, path_to_gem)
+      end
+
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/pony-test/" # Should be the same as the rubyforge project name
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end

data/lib/email_steps.rb

@@ -0,0 +1,111 @@
+# Commonly used email steps
+#
+# The available methods are:
+#
+# deliveries, all_email
+# current_email
+# current_email_address
+# reset_mailer
+# last_email_sent
+# inbox, inbox_for
+# open_email, open_email_for
+# find_email, find_email_for
+# email_links
+# email_links_matching
+#
+
+#
+# A couple methods to handle some words in these steps
+#
+
+module EmailStepsWordHelpers
+  def get_address(word)
+    return nil if word == "I" || word == "they"
+    word
+  end
+
+  def get_amount(word)
+    return 0 if word == "no"
+    return 1 if word == "a" || word == "an"
+    word.to_i
+  end
+end
+
+World(EmailStepsWordHelpers)
+
+#
+# Reset the e-mail queue within a 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 have (an|no|\d+) emails?$/ do |person, amount|
+  inbox_for(:address => get_address(person)).size.should == get_amount(amount)
+end
+
+#
+# Accessing email
+#
+
+When /^(?:I|they|"([^"]*?)") opens? the email$/ do |person|
+  open_email(:address => get_address(person))
+end
+
+When /^(?:I|they|"([^"]*?)") opens? the email with subject "([^"]*?)"$/ do |person, subject|
+  open_email(:address => get_address(person), :with_subject => subject)
+end
+
+When /^(?:I|they|"([^"]*?)") opens? the email with body "([^"]*?)"$/ do |person, body|
+  open_email(:address => get_address(person), :with_body => body)
+end
+
+#
+# Inspect the Email Contents
+#
+
+Then /^(?:I|they) should see "([^"]*?)" in the email subject$/ do |text|
+  current_email.subject.should include(text)
+end
+
+Then /^(?:I|they) should see \/([^"]*?)\/ in the email subject$/ do |text|
+  current_email.subject.should =~ Regexp.new(text)
+end
+
+Then /^(?:I|they) should see "([^"]*?)" in the email body$/ do |text|
+  current_email.body.should include(text)
+end
+
+Then /^(?:I|they) should see \/([^"]*?)\/ in the email body$/ do |text|
+  current_email.body.should =~ Regexp.new(text)
+end
+
+Then /^(?:I|they) should see the email is delivered from "([^"]*?)"$/ do |text|
+  current_email.from.should include(text)
+end
+
+Then /^(?:I|they) should see "([^\"]*)" in the email "([^"]*?)" header$/ do |text, name|
+  current_email.header[name].should include(text)
+end
+
+Then /^(?:I|they) should see \/([^\"]*)\/ in the email "([^"]*?)" header$/ do |text, name|
+  current_email.header[name].should include(Regexp.new(text))
+end
+
+#
+# Interact with Email Contents
+#
+
+When /^(?:I|they) visit "([^"]*?)" in the email$/ do |text|
+  visit email_links_matching(text).first
+end
+
+When /^(?:I|they) visit the first link in the email$/ do
+  visit email_links.first
+end
+

data/lib/pony-test.rb

@@ -0,0 +1,115 @@
+require 'uri'
+
+unless defined?(Pony)
+  raise("pony-test requires Pony")
+end
+
+#reopen Pony module and replace mail method
+module Pony
+  def self.mail(options)
+    TestHelpers.deliver(build_tmail(options))
+  end
+
+  module TestHelpers
+    @@deliveries = []
+    @@current_email = nil
+    @@current_email_address = nil
+
+    def self.deliver(email)
+      @@deliveries << email
+      @@current_email = email
+    end
+
+    def deliveries
+      @@deliveries
+    end
+    alias_method :all_email, :deliveries
+
+    def current_email
+      @@current_email || raise('No current email')
+    end
+
+    def current_email=(email)
+      @@current_email = email
+    end
+
+    def current_email_address
+      @@current_email_address
+    end
+
+    def current_email_address=(address)
+      @@current_email_address = address
+    end
+
+    def reset_mailer
+      self.deliveries.clear
+      self.current_email_address = nil
+      self.current_email = nil
+    end
+
+    def last_email_sent
+      self.current_email = deliveries.last
+      self.current_email
+    end
+
+    def inbox_for(opts = {})
+      address = opts[:address]
+      if address.nil? || address.empty?
+        address = self.current_email_address
+      end
+
+      unless address.nil? || address.empty?
+        self.current_email_address = address
+      end
+
+      #current_email_address should either be nil or have a specific address
+      if current_email_address.nil?
+        deliveries
+      else
+        deliveries.select do |email| 
+          (email.to && email.to.include?(address)) || 
+            (email.bcc && email.bcc.include?(address)) || 
+            (email.cc && email.cc.include?(address))
+        end
+      end
+    end
+    alias_method :inbox, :inbox_for
+
+    def open_email_for(opts = {})
+      self.current_email = find_email(opts).first
+    end
+    alias_method :open_email, :open_email_for
+
+    def find_email_for(opts = {})
+      email = inbox_for(opts)
+
+      if opts[:with_subject]
+        email = email.select { |m| m.subject =~ Regexp.new(opts[:with_subject]) }
+      end
+
+      if opts[:with_body]
+        email = email.select { |m| m.body =~ Regexp.new(opts[:with_body]) }
+      end
+
+      if email.empty?
+        raise "Could not find email. \n Found the following email:\n\n #{deliveries.to_s}"
+      end
+
+      email
+    end
+    alias_method :find_email, :find_email_for
+
+    def email_links(email = current_email)
+      links = URI.extract(email.body, ['http', 'https'])
+      raise "No links found in #{email.body}" if links.nil? || links.empty?
+      links
+    end
+
+    def email_links_matching(pattern, email = current_email)
+      pattern = /#{Regexp.escape(pattern)}/ unless pattern.is_a?(Regexp)
+      links = email_links(email).select { |link| link =~ pattern }
+      raise "No link found matching #{pattern.inspect} in #{email.body}" if links.nil? || links.empty?
+      links
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification 
+name: pony-test
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- John Mendonca
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-03 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: pony
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: webrat
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: joaosihno@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Rakefile
+- README.rdoc
+- lib/email_steps.rb
+- lib/pony-test.rb
+has_rdoc: true
+homepage: http://github.com/johnmendonca/pony-test
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+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: pony-test
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Collection of helper methods and Cucumber steps for testing email through Pony
+test_files: []
+