capybara-email 0.0.2 → 0.1.0

data/README.md

@@ -1,12 +1,16 @@
 # CapybaraEmail #
 
-Easily test ActionMailer and Mail emails in your Capybara integration tests
+[![Build Status](http://travis-ci.org/dockyard/capybara-email.png)](http://travis-ci.org/dockyard/capybara-email)
+
+Easily test [ActionMailer](https://github.com/rails/rails/tree/master/actionmailer) and [Mail](https://github.com/mikel/mail) messages in your Capybara integration tests
 
 ## Installation ##
 
 Add this line to your application's Gemfile:
 
-    gem 'capybara-email'
+```ruby
+gem 'capybara-email'
+```
 
 And then execute:
 
@@ -18,16 +22,20 @@ Or install it yourself as:
 
 ## Usage ##
 
-```ruby
-# rspec example
+### RSpec ###
+
+Require `capybara/email/rspec` in your `spec_helper`
 
+Example:
+
+```ruby
 feature 'Emailer' do
   background do
-    # will clear the mail queue
+    # will clear the message queue
     clear_emails
     visit email_trigger_path
     # Will find an email sent to test@example.com
-    # and set the `current_email` helper
+    # and set `current_email`
     open_email('test@example.com')
   end
 
@@ -39,6 +47,51 @@ feature 'Emailer' do
   scenario 'testing for content' do
     current_email.should have_content 'Hello Joe!'
   end
+
+  scenario 'view the email body in your browser' do
+    # the `launchy` gem is required
+    current_email.save_and_open
+  end
+end
+```
+
+### Test::Unit ###
+
+Include `Capybara::Email::DSL` in your test class
+
+```ruby
+class ActionController::IntegrationTest
+  include Capybara::Email::DSL
+end
+```
+
+Example:
+
+```ruby
+class EmailTriggerControllerTest < ActionController::IntegrationTest
+  def setup
+    # will clear the message queue
+    clear_emails
+    visit email_trigger_path
+
+    # Will find an email sent to `test@example.com`
+    # and set `current_email`
+    open_email('test@example.com')
+  end
+
+  test 'following a link' do
+    current_email.click_link 'your profile'
+    page.should have_content 'Profile page'
+  end
+
+  test 'testing for content' do
+    current_email.should have_content 'Hello Joe!'
+  end
+
+  test 'view the email body in your browser' do
+    # the `launchy` gem is required
+    current_email.save_and_open
+  end
 end
 ```
 

data/lib/capybara-email.rb

@@ -1,6 +1,3 @@
-require 'capybara/email/version'
-
 module Capybara
-  module Email
-  end
+  autoload :Email, 'capybara/email'
 end

data/lib/capybara/email.rb

@@ -4,6 +4,7 @@ module Capybara
   end
 
   module Email
+    autoload :DSL,      'capybara/email/dsl'
     autoload :Node,     'capybara/email/node'
     autoload :Driver,   'capybara/email/driver'
     autoload :Version,  'capybara/email/version'

data/lib/capybara/email/{rspec/helpers.rb → dsl.rb}

@@ -1,10 +1,24 @@
-module Capybara::Email::RSpecHelpers
-  attr_accessor :current_email, :current_emails
+module Capybara::Email::DSL
 
+  # Returns the currently set email.
+  # If no email set will return nil.
+  #
+  # @return [Mail::Message, nil]
+  attr_accessor :current_email
+  attr_accessor :current_emails
+
+  # Access all emails
+  #
+  # @return [Array]
   def all_emails
 		Mail::TestMailer.deliveries
   end
 
+  # Access all emails for a recipient.
+  #
+  # @param [String]
+  #
+  # @return [Array<Mail::Message>]
   def emails_sent_to(recipient)
     self.current_emails = all_emails.select { |email| email.to.include?(recipient) }.map do |email|
       driver = Capybara::Email::Driver.new(email)
@@ -12,15 +26,24 @@ module Capybara::Email::RSpecHelpers
     end
   end
 
+  # Access the first email for a recipient and set it to.
+  #
+  # @param [String]
+  #
+  # @return [Mail::Message]
   def first_email_sent_to(recipient)
     self.current_email = emails_sent_to(recipient).first
   end
   alias :open_email :first_email_sent_to
 
+  # Returns a collection of all current emails retrieved
+  #
+  # @return [Array<Mail::Message>]
   def current_emails
     @current_emails || []
   end
 
+  # Clear the email queue
   def clear_emails
     all_emails.clear
     self.current_emails = nil

data/lib/capybara/email/rspec.rb

@@ -1,7 +1,6 @@
 require 'capybara/email'
-require 'capybara/email/rspec/helpers'
 
 RSpec.configure do |config|
-  config.include Capybara::Email::RSpecHelpers, :type => :request
-  config.include Capybara::Email::RSpecHelpers, :type => :acceptance
+  config.include Capybara::Email::DSL, :type => :request
+  config.include Capybara::Email::DSL, :type => :acceptance
 end

data/lib/capybara/email/version.rb

@@ -1,5 +1,5 @@
 module Capybara
   module Email
-    VERSION = '0.0.2'
+    VERSION = '0.1.0'
   end
 end

data/lib/capybara/node/email.rb

@@ -1,21 +1,34 @@
 class Capybara::Node::Email < Capybara::Node::Document
 
+  # Delgate to the email body
+  #
+  # @return [Mail::Message#body]
   def body
     base.raw
   end
 
+  # Delgate to the email subject
+  #
+  # @return [Mail::Message#subject]
   def subject
     base.subject
   end
 
+  # Delgate to the email to
+  #
+  # @return [Mail::Message#to]
   def to
     base.to
   end
 
+  # Delgate to the email from
+  #
+  # @return [Mail::Message#from]
   def from
     base.from
   end
 
+  # Will open the email body in your browser
   def save_and_open
     require 'capybara/util/save_and_open_page'
     ::Capybara.save_and_open_page(body)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: capybara-email
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-04 00:00:00.000000000Z
+date: 2012-03-05 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
-  requirement: &70133949377220 !ruby/object:Gem::Requirement
+  requirement: &70105786630540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70133949377220
+  version_requirements: *70105786630540
 - !ruby/object:Gem::Dependency
   name: actionmailer
-  requirement: &70133949376800 !ruby/object:Gem::Requirement
+  requirement: &70105786630120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,21 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70133949376800
-- !ruby/object:Gem::Dependency
-  name: sinatra
-  requirement: &70133949376380 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70133949376380
+  version_requirements: *70105786630120
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70133949375960 !ruby/object:Gem::Requirement
+  requirement: &70105786629700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70133949375960
+  version_requirements: *70105786629700
 - !ruby/object:Gem::Dependency
   name: bourne
-  requirement: &70133949375540 !ruby/object:Gem::Requirement
+  requirement: &70105774149520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70133949375540
+  version_requirements: *70105774149520
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70133949375120 !ruby/object:Gem::Requirement
+  requirement: &70105774149100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,8 +65,8 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70133949375120
-description: Test your ActionMailer emails in Capybara
+  version_requirements: *70105774149100
+description: Test your ActionMailer and Mailer messages in Capybara
 email:
 - bcardarella@gmail.com
 - brian@dockyard.com
@@ -85,24 +74,16 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- Gemfile
 - LICENSE
 - README.md
-- Rakefile
-- capybara-email.gemspec
 - lib/capybara-email.rb
 - lib/capybara/email.rb
 - lib/capybara/email/driver.rb
+- lib/capybara/email/dsl.rb
 - lib/capybara/email/node.rb
 - lib/capybara/email/rspec.rb
-- lib/capybara/email/rspec/helpers.rb
 - lib/capybara/email/version.rb
 - lib/capybara/node/email.rb
-- spec/email/driver_spec.rb
-- spec/node/email_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/dockyard/capybara-email
 licenses: []
 post_install_message: 
@@ -126,5 +107,6 @@ rubyforge_project:
 rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
-summary: Test your ActionMailer emails in Capybara
+summary: Test your ActionMailer and Mailer messages in Capybara
 test_files: []
+has_rdoc: 

data/.gitignore

@@ -1,18 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-tmp
-*.sw?

data/.rspec

@@ -1 +0,0 @@
---colour

data/Gemfile

@@ -1,4 +0,0 @@
-source 'https://rubygems.org'
-
-# Specify your gem's dependencies in capybara-email.gemspec
-gemspec

data/Rakefile

@@ -1,2 +0,0 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"

data/capybara-email.gemspec

@@ -1,24 +0,0 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/capybara/email/version', __FILE__)
-
-Gem::Specification.new do |gem|
-  gem.authors       = ['Brian Cardarella']
-  gem.email         = ['bcardarella@gmail.com', 'brian@dockyard.com']
-  gem.description   = %q{Test your ActionMailer emails in Capybara}
-  gem.summary       = %q{Test your ActionMailer emails in Capybara}
-  gem.homepage      = 'https://github.com/dockyard/capybara-email'
-
-  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  gem.files         = `git ls-files`.split("\n")
-  gem.test_files    = `git ls-files -- {spec}/*`.split("\n")
-  gem.name          = 'capybara-email'
-  gem.require_paths = ['lib']
-  gem.version       = Capybara::Email::VERSION
-
-  gem.add_development_dependency 'mail'
-  gem.add_development_dependency 'actionmailer'
-  gem.add_development_dependency 'sinatra'
-  gem.add_development_dependency 'capybara'
-  gem.add_development_dependency 'bourne'
-  gem.add_development_dependency 'rspec'
-end

data/spec/email/driver_spec.rb

@@ -1,86 +0,0 @@
-require 'spec_helper'
-
-class TestApp
-  def self.call(env)
-    [200, {"Content-Type" => "text/plain"}, ["Hello world!"]]
-  end
-end
-
-feature 'Integration test' do
-  background do
-    clear_email
-    Capybara.app = ::TestApp
-  end
-
-  scenario 'html email' do
-    email = deliver(html_email)
-
-		open_email('test@example.com')
-    current_email.click_link 'example'
-    page.should have_content 'Hello world!'
-    current_email.should have_content 'This is only a html test'
-		
-		all_emails.first.should == email
-		
-		clear_emails()
-		all_emails.should be_empty
-
-  end
-
-  scenario 'plain text email' do
-    email = deliver(plain_email)
-
-    open_email('test@example.com')
-    current_email.click_link 'http://example.com'
-    page.should have_content 'Hello world!'
-    current_email.should have_content 'This is only a plain test.'
-
-		all_emails.first.should == email
-		
-		clear_emails()
-		all_emails.should be_empty
-  end
-
-	scenario 'via ActionMailer' do
-		email = deliver(plain_email)
-
-		all_emails.first.should == email
-
-		clear_emails
-		all_emails.should be_empty
-	end
-
-	scenario 'via Mail' do
-		email = plain_email.deliver!
-
-		all_emails.first.should == email
-		
-		clear_emails
-		all_emails.should be_empty
-	end
-end
-
-def deliver(email)
-  ActionMailer::Base.deliveries << email
-	email
-end
-
-def html_email
-  Mail::Message.new(:body => <<-HTML, :content_type => 'text/html', :to => 'test@example.com')
-<html>
-  <body>
-    <p>
-      This is only a html test.
-      <a href="http://example.com">example</a>
-    </p>
-  </body>
-</html>
-  HTML
-end
-
-def plain_email
-  Mail::Message.new(:body => <<-PLAIN, :content_type => 'text/plain', :to => 'test@example.com')
-This is only a plain test.
-http://example.com
-  PLAIN
-end

data/spec/node/email_spec.rb

@@ -1,73 +0,0 @@
-require 'spec_helper'
-
-describe Capybara::Node::Email do
-  let(:message) { Mail::Message.new }
-  let(:email) { Capybara::Node::Email.new(nil, Capybara::Email::Driver.new(message)) }
-
-  describe '#body' do
-    context 'html' do
-      before do
-        message.content_type = 'text/html'
-        message.body = '<a href="http://example.com">example</a>'
-      end
-
-      it 'delegates to the base' do
-        email.body.should eq '<a href="http://example.com">example</a>'
-      end
-    end
-
-    context 'plain' do
-      before do
-        message.content_type = 'text/plain'
-        message.body = 'http://example.com'
-      end
-
-      it 'delegates to the base' do
-        email.body.should eq 'http://example.com'
-      end
-    end
-  end
-
-  describe '#subject' do
-    before do
-      message.subject = 'Test subject'
-    end
-
-    it 'delegates to the base' do
-      email.subject.should eq 'Test subject'
-    end
-  end
-
-  describe '#to' do
-    before do
-      message.to = 'test@example.com'
-    end
-
-    it 'delegates to the base' do
-      email.to.should include 'test@example.com'
-    end
-  end
-
-  describe '#from' do
-    before do
-      message.from = 'test@example.com'
-    end
-
-    it 'delegates to the base' do
-      email.from.should include 'test@example.com'
-    end
-  end
-
-  describe '#save_and_open' do
-    before do
-      require 'capybara/util/save_and_open_page'
-      message.body = 'Test message'
-      ::Capybara.stubs(:save_and_open_page)
-    end
-
-    it 'delegates to Capybara.save_and_open_page' do
-      email.save_and_open
-      Capybara.should have_received(:save_and_open_page).with('Test message')
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,14 +0,0 @@
-require 'rspec'
-require 'mail'
-require 'bourne'
-require 'action_mailer'
-require 'capybara/rspec'
-require 'capybara/email/rspec'
-
-Mail.defaults do
-  delivery_method :test
-end
-
-RSpec.configure do |config|
-  config.mock_with :mocha
-end