1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
|
require 'uri'
require 'email_spec/deliveries'
module EmailSpec
module Helpers
include Deliveries
A_TAG_BEGIN_REGEX = %r{<a[^>]*href=['"]?([^'"]*)['"]?[^>]*>\s*(?:(?!</a>).)*?\s*}
A_TAG_END_REGEX = %r{\s*(?:(?!</a>).)*?\s*</a>}
def visit_in_email(link_text, address = '')
if address.nil? || address.empty?
email = current_email
else
email = find_email!(address)
end
visit(parse_email_for_link(email, link_text))
end
def click_email_link_matching(regex, email = current_email)
url = links_in_email(email).detect { |link| link =~ regex }
raise "No link found matching #{regex.inspect} in #{email.default_part_body}" unless url
visit request_uri(url)
end
def click_first_link_in_email(email = current_email)
link = links_in_email(email).first
visit request_uri(link)
end
def open_email(address, opts={})
set_current_email(find_email!(address, opts))
end
alias_method :open_email_for, :open_email
def open_last_email
set_current_email(last_email_sent)
end
def open_last_email_for(address)
set_current_email(mailbox_for(address).last)
end
def current_email(address=nil)
address = convert_address(address)
email = address ? email_spec_hash[:current_emails][address] : email_spec_hash[:current_email]
exception_class = if defined?(RSpec)
RSpec::Expectations::ExpectationNotMetError
else
StandardError
end
raise exception_class, "Expected an open email but none was found. Did you forget to call open_email?" unless email
email
end
def current_email_attachments(address=nil)
current_email(address).attachments || Array.new
end
def unread_emails_for(address)
read_message_ids = read_emails_for(address).map(&:message_id)
mailbox_for(address).reject { |m| read_message_ids.include?(m.message_id) }
end
def read_emails_for(address)
email_spec_hash[:read_emails][convert_address(address)] ||= []
end
# Should be able to accept String or Regexp options.
def find_email(address, opts={})
address = convert_address(address)
if opts[:with_subject]
expected_subject = (opts[:with_subject].is_a?(String) ? Regexp.escape(opts[:with_subject]) : opts[:with_subject])
mailbox_for(address).find { |m| m.subject =~ Regexp.new(expected_subject) }
elsif opts[:with_text]
expected_text = (opts[:with_text].is_a?(String) ? Regexp.escape(opts[:with_text]) : opts[:with_text])
mailbox_for(address).find { |m| m.default_part_body =~ Regexp.new(expected_text) }
elsif opts[:from]
mailbox_for(address).find { |m| m.from.include? opts[:from] }
else
mailbox_for(address).first
end
end
def links_in_email(email)
links = URI::Parser.new.extract(email.default_part_body.to_s, ['http', 'https'])
links.map{|url| HTMLEntities.new.decode(url) }.uniq
end
private
def email_spec_hash
@email_spec_hash ||= {:read_emails => {}, :unread_emails => {}, :current_emails => {}, :current_email => nil}
end
def find_email!(address, opts={})
email = find_email(address, opts)
if current_email_address.nil?
raise EmailSpec::NoEmailAddressProvided, "No email address has been provided. Make sure current_email_address is returning something."
elsif email.nil?
error = "#{opts.keys.first.to_s.gsub("_", " ").downcase unless opts.empty?} #{('"' + opts.values.first.to_s + '"') unless opts.empty?}"
raise EmailSpec::CouldNotFindEmailError, "Could not find email #{error} in the mailbox for #{current_email_address}. \n Found the following emails:\n\n #{all_emails.to_s}"
end
email
end
def set_current_email(email)
return unless email
[email.to, email.cc, email.bcc].compact.flatten.each do |to|
read_emails_for(to) << email
email_spec_hash[:current_emails][to] = email
end
email_spec_hash[:current_email] = email
end
def parse_email_for_link(email, text_or_regex)
matcher = EmailSpec::Matchers::HaveBodyText.new(text_or_regex)
if defined?(RSpec)
RSpec::Expectations::PositiveExpectationHandler.handle_matcher(email, matcher)
else
assert_must matcher, email
end
url = parse_email_for_explicit_link(email, text_or_regex)
url ||= parse_email_for_anchor_text_link(email, text_or_regex)
raise "No link found matching #{text_or_regex.inspect} in #{email}" unless url
url
end
def request_uri(link)
return unless link
url = URI::parse(link)
url.fragment ? (url.request_uri + "#" + url.fragment) : url.request_uri
end
# e.g. confirm in http://confirm
def parse_email_for_explicit_link(email, regex)
regex = /#{Regexp.escape(regex)}/ unless regex.is_a?(Regexp)
url = links_in_email(email).detect { |link| link =~ regex }
request_uri(url)
end
# e.g. Click here in <a href="http://confirm">Click here</a>
def parse_email_for_anchor_text_link(email, link_text)
if textify_images(email.default_part_body) =~ %r{#{A_TAG_BEGIN_REGEX}#{link_text}#{A_TAG_END_REGEX}}
URI.split($1)[5..-1].compact!.join("?").gsub("&", "&")
# sub correct ampersand after rails switches it (http://dev.rubyonrails.org/ticket/4002)
else
return nil
end
end
def textify_images(email_body)
email_body.to_s.gsub(%r{<img[^>]*alt=['"]?([^'"]*)['"]?[^>]*?/>}) { $1 }
end
def parse_email_count(amount)
case amount
when "no"
0
when "an"
1
else
amount.to_i
end
end
attr_reader :last_email_address
def convert_address(address)
@last_email_address = (address || current_email_address)
AddressConverter.instance.convert(@last_email_address)
end
# Overwrite this method to set default email address, for example:
# last_email_address || @current_user.email
def current_email_address
last_email_address
end
def mailbox_for(address)
super(convert_address(address)) # super resides in Deliveries
end
def email_spec_deprecate(text)
puts ""
puts "DEPRECATION: #{text.split.join(' ')}"
puts ""
end
end
end
|