email_spec 0.2.0

data/examples/rails_root/config/database.yml

@@ -0,0 +1,22 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/examples/rails_root/config/environment.rb

@@ -0,0 +1,22 @@
+# Be sure to restart your server when you modify this file
+
+# Uncomment below to force Rails into production mode when
+# you don't control web/app server and can't set it the proper way
+# ENV['RAILS_ENV'] ||= 'production'
+
+# Specifies gem version of Rails to use when vendor/rails is not present
+RAILS_GEM_VERSION = '2.2.2' unless defined? RAILS_GEM_VERSION
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+
+  config.time_zone = 'UTC'
+ 
+  config.action_controller.session = {
+    :session_key => '_es_session',
+    :secret      => 'b9327c7967925fb36f8901e43f47e0a3e8fc7856ae1b4533ddeda776381548f9ac051721446fdbc4ccc88c7353124708e73d8b0950a30487571d8f8eb5b24732'
+  }
+
+end

data/examples/rails_root/config/environments/development.rb

@@ -0,0 +1,17 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# In the development environment your application's code is reloaded on
+# every request.  This slows down response time but is perfect for development
+# since you don't have to restart the webserver when you make code changes.
+config.cache_classes = false
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_view.debug_rjs                         = true
+config.action_controller.perform_caching             = false
+
+# Don't care if the mailer can't send
+config.action_mailer.raise_delivery_errors = false

data/examples/rails_root/config/environments/production.rb

@@ -0,0 +1,24 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The production environment is meant for finished, "live" apps.
+# Code is not reloaded between requests
+config.cache_classes = true
+
+# Enable threaded mode
+# config.threadsafe!
+
+# Use a different logger for distributed setups
+# config.logger = SyslogLogger.new
+
+# Full error reports are disabled and caching is turned on
+config.action_controller.consider_all_requests_local = false
+config.action_controller.perform_caching             = true
+
+# Use a different cache store in production
+# config.cache_store = :mem_cache_store
+
+# Enable serving of images, stylesheets, and javascripts from an asset server
+# config.action_controller.asset_host                  = "http://assets.example.com"
+
+# Disable delivery errors, bad email addresses will be ignored
+# config.action_mailer.raise_delivery_errors = false

data/examples/rails_root/config/environments/test.rb

@@ -0,0 +1,33 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite.  You never need to work with it otherwise.  Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs.  Don't rely on the data there!
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching             = false
+
+# Disable request forgery protection in test environment
+config.action_controller.allow_forgery_protection    = false
+
+# Tell Action Mailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test
+
+
+# I HATE config.gem.. it doesn't work as advertised...
+config.gem 'webrat', :source => "http://gems.github.com"
+#config.gem 'rspec', :lib => 'spec'
+#config.gem 'rspec-rails', :lib => 'spec/rails'
+config.gem 'cucumber', :source => "http://gems.github.com" # aslakhellesoy-cucumber
+config.gem 'nakajima-fixjour', :lib => 'fixjour', :source => "http://gems.github.com" # nakajima-fixjour
+
+
+

data/examples/rails_root/config/initializers/inflections.rb

@@ -0,0 +1,10 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format 
+# (all these examples are active by default):
+# ActiveSupport::Inflector.inflections do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end

data/examples/rails_root/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone

data/examples/rails_root/config/initializers/new_rails_defaults.rb

@@ -0,0 +1,17 @@
+# These settings change the behavior of Rails 2 apps and will be defaults
+# for Rails 3. You can remove this initializer when Rails 3 is released.
+
+if defined?(ActiveRecord)
+  # Include Active Record class name as root for JSON serialized output.
+  ActiveRecord::Base.include_root_in_json = true
+
+  # Store the full class name (including module namespace) in STI type column.
+  ActiveRecord::Base.store_full_sti_class = true
+end
+
+# Use ISO 8601 format for JSON serialized times and dates.
+ActiveSupport.use_standard_json_time_format = true
+
+# Don't escape HTML entities in JSON, leave that for the #json_escape helper.
+# if you're including raw json in an HTML page.
+ActiveSupport.escape_html_entities_in_json = false

data/examples/rails_root/config/routes.rb

@@ -0,0 +1,43 @@
+ActionController::Routing::Routes.draw do |map|
+  # The priority is based upon order of creation: first created -> highest priority.
+
+  # Sample of regular route:
+  #   map.connect 'products/:id', :controller => 'catalog', :action => 'view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   map.purchase 'products/:id/purchase', :controller => 'catalog', :action => 'purchase'
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   map.resources :products
+
+  # Sample resource route with options:
+  #   map.resources :products, :member => { :short => :get, :toggle => :post }, :collection => { :sold => :get }
+
+  # Sample resource route with sub-resources:
+  #   map.resources :products, :has_many => [ :comments, :sales ], :has_one => :seller
+  
+  # Sample resource route with more complex sub-resources
+  #   map.resources :products do |products|
+  #     products.resources :comments
+  #     products.resources :sales, :collection => { :recent => :get }
+  #   end
+
+  # Sample resource route within a namespace:
+  #   map.namespace :admin do |admin|
+  #     # Directs /admin/products/* to Admin::ProductsController (app/controllers/admin/products_controller.rb)
+  #     admin.resources :products
+  #   end
+
+  # You can have the root of your site routed with map.root -- just remember to delete public/index.html.
+  map.root :controller => "welcome", :action => "index"
+  map.confirm_account "/confirm", :controller => "welcome", :action => "confirm"
+  # See how all your routes lay out with "rake routes"
+
+  # Install the default routes as the lowest priority.
+  # Note: These default routes make all actions in every controller accessible via GET requests. You should
+  # consider removing the them or commenting them out if you're using named routes and resources.
+  map.connect ':controller/:action/:id'
+  map.connect ':controller/:action/:id.:format'
+end

data/examples/rails_root/cucumber.yml

@@ -0,0 +1 @@
+default: features/example.feature

data/examples/rails_root/db/migrate/20090125013728_create_users.rb

@@ -0,0 +1,11 @@
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string :email, :name
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

data/examples/rails_root/db/schema.rb

@@ -0,0 +1,19 @@
+# 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 to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20090125013728) do
+
+  create_table "users", :force => true do |t|
+    t.string "email"
+    t.string "name"
+  end
+
+end

data/examples/rails_root/doc/README_FOR_APP

@@ -0,0 +1,5 @@
+To build the guides:
+
+* Install source-highlighter (http://www.gnu.org/software/src-highlite/source-highlight.html)
+* Install the mizuho gem (http://github.com/FooBarWidget/mizuho/tree/master)
+* Run `rake guides` from the railties directory

data/examples/rails_root/features/errors.feature

@@ -0,0 +1,42 @@
+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
+
+    Scenario: I fail to receive an email
+      Given I am at "/"
+      And no emails have been sent
+      When I fill in "Email" with "quentin@example.com"
+      And I press "Sign up"
+      And I should receive an email
+      When "quentin@example.com" opens the email with subject "no email"
+
+    Scenario: I fail to receive an email with the expected link
+      Given I am at "/"
+      And no emails have been sent
+      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
+      When I follow "link that doesn't exist" in the email
+
+    Scenario: I attempt to operate on an email that is not opened
+      Given I am at "/"
+      And no emails have been sent
+      When I fill in "Email" with "quentin@example.com"
+      And I press "Sign up"
+      And I should receive an email
+      When I follow "confirm" in the email
+
+    Scenario: I attempt to check out an unopened email
+      Given I am at "/"
+      And no emails have been sent
+      When I fill in "Email" with "quentin@example.com"
+      And I press "Sign up"
+      Then I should see "confirm" in the email
+      And I should see "Account confirmation" in the subject
+
+
+

data/examples/rails_root/features/example.feature

@@ -0,0 +1,59 @@
+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
+
+Scenario: A new person signs up imperatively 
+    Given I am a real person wanting to sign up for an account
+    And I am at "/"
+
+    When I fill in "Email" with "quentin@example.com"
+    And I fill in "Name" with "Quentin Jones"
+    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 "quentin@example.com" opens the email with subject "Account confirmation"
+
+    Then I should see "confirm" in the email
+    And I should see "Quentin Jones" in the email
+    And I should see "Account confirmation" in the subject
+
+    When I follow "Click here to confirm your account!" in the email
+    Then I should see "Confirm your new account"
+
+
+Scenario: slightly more declarative, but still mostly imperative
+    Given I am a real person wanting to sign up for an account
+    And I'm on the signup page
+
+    When I fill in "Email" with "quentin@example.com"
+    And I fill in "Name" with "Quentin Jones"
+    And I press "Sign up"
+
+    Then I should receive an email
+
+    When I open the email
+    Then I should see "Account confirmation" in the subject
+
+    When I follow "http:///confirm" in the email
+    Then I should see "Confirm your new account"
+
+
+ Scenario: declarative
+    Given I am a real person wanting to sign up for an account
+    And I'm on the signup page
+
+    When I submit my registration information
+    Then I should receive an email with a link to a confirmation page
+
+
+
+

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

@@ -0,0 +1,74 @@
+#Commonly used email steps
+#
+# To add your own steps make a custom_email_steps.rb
+# The provided methods are:
+#
+# reset_mailer 
+# open_last_email
+# visit_in_email
+# unread_emails_for
+# mailbox_for
+# current_email
+# open_email
+# read_emails_for
+# find_email
+
+module EmailHelpers
+  def current_email_address
+    "quentin@example.com" # Replace with your a way to find your current_email. e.g current_user.email
+  end
+end
+World(EmailHelpers)
+
+# Use this step to 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
+
+# Use this step to open the most recently sent e-mail. 
+When /^I open the email$/ do
+  open_email(current_email_address)
+end
+
+When %r{^I follow "([^"]*?)" in the email$} do |link|
+  visit_in_email(link)
+end
+
+Then /^I should receive (an|\d+) emails?$/ do |amount|
+  amount = 1 if amount == "an"
+  unread_emails_for(current_email_address).size.should == amount.to_i
+end
+
+Then %r{^"([^"]*?)" should receive (\d+) emails?$} do |address, n|
+  unread_emails_for(address).size.should == n.to_i 
+end
+
+Then %r{^"([^"]*?)" should have (\d+) emails?$} do |address, n|
+  mailbox_for(address).size.should == n.to_i
+end
+
+Then %r{^"([^"]*?)" should not receive an email$} do |address|
+  find_email(address).should be_nil
+end
+
+Then %r{^I should see "([^"]*?)" in the subject$} do |text|
+  current_email.should have_subject(Regexp.new(text))
+end
+
+Then %r{^I should see "([^"]*?)" in the email$} do |text|
+  current_email.body.should =~ Regexp.new(text)
+end
+
+When %r{^"([^"]*?)" opens? the email with subject "([^"]*?)"$} do |address, subject|
+  open_email(address, :with_subject => subject)
+end
+
+When %r{^"([^"]*?)" opens? the email with text "([^"]*?)"$} do |address, text|
+  open_email(address, :with_text => text)
+end
+
+When /^I click the first link in the email$/ do
+  click_first_link_in_email
+end
+

data/examples/rails_root/features/step_definitions/user_steps.rb

@@ -0,0 +1,23 @@
+Given "I am a real person wanting to sign up for an account" do
+  # no-op.. for documentation purposes only!
+end
+
+When /^I submit my registration information$/ do
+  fill_in "Name", :with => valid_user_attributes[:name]
+  fill_in "Email", :with => valid_user_attributes[:email]
+  click_button
+end
+
+Then /^I should receive an email with a link to a confirmation page$/ do
+  unread_emails_for(valid_user_attributes[:email]).size.should == 1 
+  
+  # this call will store the email and you can access it with current_email
+  open_last_email_for(valid_user_attributes[:email])
+  current_email.should have_subject(/Account confirmation/)
+  current_email.should have_body_text(valid_user_attributes[:name])
+
+  click_email_link_matching /confirm/
+  response.should include_text("Confirm your new account")
+  
+end
+