mailinator-spec 0.0.1

data/.gitignore

@@ -0,0 +1,39 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+#
+# For TextMate
+#*.tmproj
+#tmtags
+#
+# For emacs:
+#*~
+#\#*
+#.\#*
+#
+# For vim:
+#*.swp

data/README.rdoc

@@ -0,0 +1,102 @@
+= mailinator-spec
+
+Mailinator is a great little service that provides you with temporary email addresses, and provides a way to access. You can send email to any address at mailinator.com, and you're able to access that from the a browser or through rss and atom. 
+
+Now, imagine you are doing integration tests of funcaionality that send email. Ideally, you'd want to actually send the email, and verify that the message went through. Feasibly, you could send the  email to mailinator and then use their atom feed to check that the email went through. This is essentially what mailinator-spec comes in.
+
+
+  Scenario: Cucumber integration
+    Given I have mailinator email address
+    And I've manually sent an email to it
+    When I wait 2 seconds for mail to process
+    Then the email subject should match /omgwtfbbq/
+    And the email body should match /http:\/\/zombo\.com/
+
+
+== Setup
+
+Start off with the usual gem install:
+
+  gem install mailinator-spec
+
+mailinator-spec comes with two main modules:
+
+ * Mailinator::Spec::Matchers
+ * Mailinator::Spec::Helpers
+
+For RSpec, you can add these to spec/spec_helper.rb:
+
+  require 'mailinator'
+  Spec::Runner.configure do |config|
+    config.include Mailinator::Spec::Matchers
+    config.include Mailinator::Spec::Helpers
+  end
+
+It's also usable from cucumber:
+
+  require 'mailinator/spec'
+  require 'mailinator/steps'
+  World(Mailinator::Spec::Matchers)
+  World(Mailinator::Spec::Helpers)
+
+== Usage
+
+At the core of mailinator-spec is the Mailinator class. This represents a mailbox over at http://mailinator.com. It provides you an easy way to get URLs for accessing the mailbox, as well as providing TMail objects of the emails in the mailbox.
+
+  mailinator = Mailinator.new('zombo-consumer')
+  mailinator.email # => "zombo-consumer@mailinator.com"
+  mailinator.inbox_url # => "http://mailinator.com/maildir.jsp?email=zombo-consumer@mailinator.com"
+  mailinator.rss_url # => "http://mailinator.com/rss.jsp?email=zombo-consumer@mailinator.com"
+  mailinator.atom_url # => "http://mailinator.com/atom.jsp?email=zombo-consumer@mailinator.com"
+  mailinator.mailbox # => [#<TMail::Mail port=#<TMail::StringPort:id=0x8110d1d8> bodyport=#<TMail::StringPort:id=0x8110c0f8>>]
+  mailinator.mailbox.first.from # => "noreply@zombo.com"
+  mailinator.mailbox.first.subject # => "Welcome to zombo.com!"
+  mailinator.mailbox.first.to # => "The only limitation... is you!"
+  mailinator.mailbox.first.body # => "The only limitation... is you!"
+
+You might not actually care what the address is that you receive email to. For this case, there's a convenience method for creating a (mostly) random one:
+
+  mailinator = Mailinator.mostly_random
+  mailinator.email # => "7d6f4373dbfde6a698f1000eb@mailinator.com"
+  mailinator = Mailinator.new('zombo-consumer')
+  mailinator.email # => "zombo-consumer@mailinator.com"
+
+You can also change which domain is used for the email address. This is useful if your application specifically prevents users from using mailinator addresses.
+
+  Mailinator.domain = 'mailinator.zombo.com'
+  mailinator = Mailinator.new('zombo-consumer')
+  mailinator.email # => "zombo-consumer@mailinator.zombo.com"
+
+For this to properly work, you'd need to FIXME to provide that information
+
+
+For RSpec and Cucumber, this is exposed slightly more convenient way, and there are matchers (courtesy of email-spec)
+
+   describe "zombo.com welcome" do
+     before do
+       @to = mailinator.email # for a random address
+       # @to = mailinator('me') # for a specific address
+
+       # send some email
+
+       @email = last_mailinator_email # shorthand for mailinator.mailbox.last
+     end
+
+     it "is from noreply@zombo.com" do
+       @email.should be_delivered_from('noreply@zombo.com')
+     end
+
+     it "has welcoming subject" do
+       @email.should have_subject('Welcome to zombo.com')
+     end
+
+     it "tells us our about our limitation" do
+       @email.should have_body_text("The only limitation... is you!")
+     end
+   end
+
+In cucumber, you can use the same exact techniques. In addition, there are handful of step definitions provided:
+
+    When I wait 2 seconds for mail to process
+    Then the email subject should match /omgwtfbbq/
+    And the email body should match /http:\/\/zombo\.com/

data/Rakefile

@@ -0,0 +1,62 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mailinator-spec"
+    gem.summary = %Q{mailinate the contryside... from rspec and cucumber}
+    gem.description = %Q{mailinator-spec is a library for using mailinator for testing email from rspec and cucumber} 
+    gem.email = "josh@technicalpickles.com"
+    gem.homepage = "http://github.com/technicalpickles/mailinator-spec"
+    gem.authors = ["Joshua Nichols"]
+    gem.add_dependency 'email_spec'
+    gem.add_dependency 'mail'
+    gem.add_development_dependency "rspec", "~> 1.3.0"
+    gem.version = "0.0.1"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+
+task :spec => :check_dependencies
+
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+
+  task :features => :check_dependencies
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "cucumber-mailinator #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/features/mailinator.feature

@@ -0,0 +1,8 @@
+Feature: Mailinator
+
+  Scenario: Cucumber integration
+    Given I have mailinator email address
+    And I've manually sent an email to it
+    When I wait 2 seconds for mail to process
+    Then the email subject should match /omgwtfbbq/
+    And the email body should match /http:\/\/zombo\.com/

data/features/step_definitions/mailinator_steps.rb

@@ -0,0 +1,8 @@
+Given /^I have mailinator email address$/ do
+  @mailinator_email = mailinator('zomgwtfbbbbbbbq').email
+end
+
+Given /^I've manually sent an email to it$/ do
+  # no-op
+end
+

data/features/support/env.rb

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'lib'))
+
+require 'spec/matchers'
+require 'mailinator'
+require 'mailinator/spec'
+require 'mailinator/steps'
+require 'email-spec'
+
+World(Mailinator::Spec::Helpers)
+World(Mailinator::Spec::Matchers)

data/lib/mailinator.rb

@@ -0,0 +1,77 @@
+require 'digest/sha1'
+require 'open-uri'
+require 'nokogiri'
+require 'cgi'
+require 'mail'
+
+class Mailinator
+  BASE_URL = 'http://mailinator.com'
+
+  attr_accessor :email, :name
+
+  def initialize(name = nil, opts = {})
+    @name = name
+    @email = format_email(name)
+  end
+
+  def inbox_url
+    action_url('maildir')
+  end
+
+  def rss_url
+    action_url('rss')
+  end
+
+  def atom_url
+    action_url('atom')
+  end
+
+  def widget_url(width = '250', height = '250')
+    URI.parse("#{BASE_URL}/widget/mailin8r.jsp?w=#{width}&h=#{height}&b=#{@name}").to_s
+  end
+
+  def mailbox
+    doc = Nokogiri::HTML(open(atom_url))
+
+    doc.css('feed entry').map do |entry|
+      mail = Mail.new
+
+      mail.subject = entry.at_css('title').text
+      mail.body = entry.at_css('summary').text
+
+      mail.to = @email
+      mail.from = entry.at_css('author name').text
+
+      mail
+    end
+  end
+
+  def self.mostly_random
+    now = Time.now
+    sha = Digest::SHA1.hexdigest("#{now.to_i}#{now.usec}").to_s
+    
+    new(sha.slice(0, 25))
+  end
+
+  def self.domain=(domain)
+    @domain = domain
+  end
+
+  def self.reset_domain!
+    @domain = nil
+  end
+
+  def self.domain
+    @domain ||= "mailinator.com"
+  end
+
+ private
+
+  def action_url(action)
+    URI.parse("#{BASE_URL}/#{action}.jsp?email=#{@name}").to_s
+  end
+
+  def format_email(email)
+    email =~ /^[a-zA-Z0-9]+@#{self.class.domain}$/ ? email : "#{email}@#{self.class.domain}"
+  end
+end

data/lib/mailinator/spec.rb

@@ -0,0 +1,29 @@
+require 'mailinator'
+require 'email-spec'
+
+class Mailinator
+  module Spec
+    module Matchers
+      include EmailSpec::Matchers
+    end
+
+    module Helpers
+
+      def mailinator(email = nil)
+        @mailinator ||= begin
+                          if email
+                            Mailinator.new(email)
+                          else
+                            Mailinator.mostly_random
+                          end
+                        end
+      end
+
+      def last_mailinator_email
+        mailinator.mailbox.last
+      end
+
+    end
+
+  end
+end

data/lib/mailinator/steps.rb

@@ -0,0 +1,15 @@
+When /I wait (\d+) seconds for mail to process/ do |count|
+  sleep(count.to_i)
+end
+
+Then "I should have one email in my inbox" do
+  pending
+end
+
+Then /^the email subject should match \/(.*)\/$/ do |subject_regexp|
+  last_mailinator_email.should have_subject(Regexp.new(subject_regexp))
+end
+
+Then /^the email body should match \/(.*)\/$/ do |body_regexp|
+  last_mailinator_email.should have_body_text(Regexp.new(body_regexp))
+end

data/spec/mailinator_spec.rb

@@ -0,0 +1,56 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe Mailinator do
+  context "with default domain" do
+    before(:each) do
+      @random_name = "awesomemail#{rand(420)}"
+      @primary_email = "#{@random_name}@mailinator.com"
+      @mail = Mailinator.new(@random_name)
+    end
+
+    it 'should have a primary email address' do
+      @mail.email.should == @primary_email
+    end
+
+    it 'should have an inbox URL' do
+      @mail.inbox_url.should == "http://mailinator.com/maildir.jsp?email=#{@random_name}"
+    end
+
+    it 'should have an RSS URL' do
+      @mail.rss_url.should == "http://mailinator.com/rss.jsp?email=#{@random_name}"
+    end
+
+    it 'should have an RSS URL' do
+      @mail.atom_url.should == "http://mailinator.com/atom.jsp?email=#{@random_name}"
+    end
+
+    it 'should have a widget URL' do
+      width  = '500'
+      height = '250'
+      widget_url = "http://mailinator.com/widget/mailin8r.jsp?w=#{width}&h=#{height}&b=#{@random_name}"
+      @mail.widget_url(width, height).should == widget_url
+    end
+
+    it 'should have an alternate email address'
+    it 'should have an RSS feed'
+    it 'should fetch a random primary email address'
+  end
+
+  context "configured custom domain" do
+    before(:each) do
+      Mailinator.domain = "zombo.com"
+
+      @random_name = "awesomemail#{rand(420)}"
+      @primary_email = "#{@random_name}@zombo.com"
+      @mail = Mailinator.new(@random_name)
+    end
+
+    after(:each) do
+      Mailinator.reset_domain!
+    end
+
+    it "should figure use the correct domain"  do
+      @mail.email.should == @primary_email
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'spec'
+require 'mailinator'
+
+Spec::Runner.configure do
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification 
+name: mailinator-spec
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Joshua Nichols
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-28 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: email_spec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mail
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id003
+description: mailinator-spec is a library for using mailinator for testing email from rspec and cucumber
+email: josh@technicalpickles.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- .gitignore
+- README.rdoc
+- Rakefile
+- features/mailinator.feature
+- features/step_definitions/mailinator_steps.rb
+- features/support/env.rb
+- lib/mailinator.rb
+- lib/mailinator/spec.rb
+- lib/mailinator/steps.rb
+- spec/mailinator_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/technicalpickles/mailinator-spec
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: mailinate the contryside... from rspec and cucumber
+test_files: 
+- spec/mailinator_spec.rb
+- spec/spec_helper.rb