mailtruck 0.0.1

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Bruz Marzolf
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,129 @@
+# Mailtruck
+
+[![Build Status](https://travis-ci.org/CXInc/mailtruck-ruby.png)](https://travis-ci.org/CXInc/mailtruck-ruby)
+
+There are occasions when it's necessary to receive an email and follow a link
+as part of an integration test, for instance email confirmation. When the
+email is being sent from the app where the test is running, there are some
+nice options (see Similar Projects below) to aid in integration testing. But
+if the email is being sent from another service you don't control, it's not as
+easy to hook into the process. Mailtruck aims to make that doable.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mailtruck'
+
+And then run:
+
+    $ bundle
+
+Or install it yourself with:
+
+    $ gem install mailtruck
+
+## Usage
+
+### Quick Start 
+
+```ruby
+mailtruck = Mailtruck.new
+
+# an email address where Mailtruck can pick up your email
+address = mailtruck.email_address
+# => somerandomstring@mailtruck.bruzilla.com
+
+# Mailtruck will wait until you receive
+emails = mailtruck.wait_for_emails do
+  # YOUR CODE TO SEND EMAIL TO address HERE
+end
+
+emails.each do |email|
+  puts "Email to, from, subject, body: #{email.to}, #{email.from}, " +
+       "#{email.subject}, #{email.body}"
+end
+```
+
+### Configuration
+
+```ruby
+Mailtruck.configure do |config|
+  # host where emails will be sent, defaults to mailtruck.bruzilla.com
+  config.email_host = "example.com"
+
+  # Mailtruck server, defaults to http://mailtruck.herokuapp.com/faye
+  config.receiver_url = "http://example.com/faye"
+
+  # timeout in seconds when waiting for email, defaults to 30
+  config.timeout = 60
+end
+```
+
+### Multiple emails
+
+When multiple emails are being sent, ask for the number of emails needed and
+it will wait for that number of emails.
+
+```ruby
+mailtruck = Mailtruck.new
+
+addresses = [mailtruck.email_address, mailtruck.email_address]
+
+emails = mailtruck.wait_for_emails do
+  # YOUR CODE TO SEND EMAIL TO EACH ADDRESS IN addresses HERE
+end
+```
+
+### Capybara
+
+When running Mailtruck in Capybara tests, the usual helper methods are
+available:
+
+```ruby
+emails = mailtruck.wait_for_emails do
+  # YOUR CODE TO SEND EMAIL TO address HERE
+end
+
+emails.first.body.should have_content("Way to go, champ!")
+```
+
+## How does it work?
+
+When `wait_for_emails` is called, Mailtruck connects to a service that will
+listen for email being received at the addresses it has provided with the
+`email_address` method. The code block passed to `wait_for_emails` is then
+run, and assuming it sends emails to the provided addresses, they will get
+posted back to the Mailtruck back end service. They messages are then passed
+to the listener and returned as instances of `Mailtruck::Email`.
+
+## Security
+
+There is none currently, so **consider any emails you send through Mailtruck
+public**. This may not be an issue if you're just sending dummy test data and
+content that's not sensitive, but if there's anything in your emails that
+you want to keep private then don't use Mailtruck.
+
+Making Mailtruck more secure is definitely a future possibility.
+
+## Tests
+
+Simply run:
+
+    rake test
+
+## Similar Projects
+
+- [CapybaraEmail](https://github.com/dockyard/capybara-email)
+- [Letter Opener](https://github.com/ryanb/letter_opener)
+- [MailCatcher](http://mailcatcher.me/)
+- [Mailtrap](http://mailtrap.io/)
+- [MailView](https://github.com/37signals/mail_view)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes, with tests (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+task :default => [:test]
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.pattern = "spec/lib/*_spec.rb"
+  # t.verbose = true
+end

data/lib/mailtruck.rb

@@ -0,0 +1,68 @@
+require "securerandom"
+require "faye"
+
+require "mailtruck/configuration"
+require "mailtruck/email"
+require "mailtruck/email_address"
+require "mailtruck/receiver"
+require "mailtruck/version"
+
+class Mailtruck
+
+  class Timeout < StandardError; end
+
+  # Configure Mailtruck.
+  #
+  #     Capybara.configure do |config|
+  #       config.timeout = 60
+  #     end
+  #
+  # === Options
+  #
+  # [email_host = String]    Host where emails will be sent, defaults to mailtruck.bruzilla.com
+  # [receiver_url = String]  Mailtruck server, defaults to http://mailtruck.herokuapp.com/faye
+  # [timeout = Integer]      Timeout in seconds when waiting for email, defaults to 30
+  #
+  def self.configure
+    yield configuration
+  end
+
+  # @return [Mailtruck::Configuration] the Mailtruck configuration.
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Generates an email address that Mailtruck can receive email at.
+  #
+  # @example
+  #   mailtruck = Mailtruck.new
+  #   address = mailtruck.email_address
+  #
+  #   emails = mailtruck.wait_for_emails do
+  #     MyApp.send_email_to(address)
+  #   end
+  #   
+  #
+  # @yield Block to run that should trigger emails
+  # @return [String] an email address
+  def email_address
+    address = EmailAddress.random
+    addresses << address
+
+    address.to_s
+  end
+
+  # Waits for emails to be sent to #email_address and returns them.
+  #
+  # @return [Array<Mailtruck::Email>] the received emails
+  def wait_for_emails(&block)
+    Receiver.wait_for(addresses, block)
+  end
+
+  private
+
+  def addresses
+    @addresses ||= []
+  end
+
+end

data/lib/mailtruck/configuration.rb

@@ -0,0 +1,9 @@
+class Mailtruck::Configuration
+  attr_accessor :email_host, :receiver_url, :timeout
+
+  def initialize(attributes = {})
+    @email_host = attributes[:email_host] || "mailtruck.bruzilla.com"
+    @receiver_url = attributes[:receiver_url] || "http://mailtruck.herokuapp.com/faye"
+    @timeout = attributes[:timeout] || 30
+  end
+end

data/lib/mailtruck/email.rb

@@ -0,0 +1,14 @@
+class Mailtruck::Email
+  attr_accessor :to, :from, :subject
+
+  def initialize(attributes)
+    [:to, :from, :subject, :html].each do |key|
+      instance_variable_set "@#{key}", attributes[key.to_s]
+    end
+  end
+
+  def body
+    @html
+  end
+
+end

data/lib/mailtruck/email_address.rb

@@ -0,0 +1,23 @@
+class Mailtruck::EmailAddress
+
+  attr_reader :prefix
+
+  def self.random
+    new(random_string)
+  end
+
+  def initialize(prefix)
+    @prefix = prefix
+  end
+
+  def to_s
+    "#{@prefix}@#{Mailtruck.configuration.email_host}"
+  end
+
+  private
+
+  def self.random_string
+    # SecureRandom.urlsafe_base64
+    "bob"
+  end
+end

data/lib/mailtruck/receiver.rb

@@ -0,0 +1,48 @@
+Thread.abort_on_exception = true
+
+class Mailtruck::Receiver
+
+  def self.wait_for(addresses, block)
+    receiver = new(addresses)
+    receiver.wait(block)
+  end
+
+  def initialize(addresses)
+    @addresses = addresses
+    @emails = []
+  end
+
+  def wait(block)
+    Timeout::timeout(Mailtruck.configuration.timeout) do
+      EM.run {
+        subscribe_to_addresses
+
+        block.call
+      }
+    end
+
+    @emails
+  rescue Timeout::Error => e
+    raise Mailtruck::Timeout
+  end
+
+  private
+
+  def subscribe_to_addresses
+    client.subscribe("/bob") do |message|
+      @emails << Mailtruck::Email.new(message)
+      check_emails
+    end
+  end
+
+  def client
+    @client ||= Faye::Client.new(Mailtruck.configuration.receiver_url)
+  end
+
+  def check_emails
+    if @emails.size >= @addresses.size
+      EM.stop_event_loop
+    end
+  end
+
+end

data/lib/mailtruck/version.rb

@@ -0,0 +1,3 @@
+class Mailtruck
+  VERSION = "0.0.1"
+end

data/mailtruck.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mailtruck/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mailtruck"
+  spec.version       = Mailtruck::VERSION
+  spec.authors       = ["Bruz Marzolf"]
+  spec.email         = ["bruz.marzolf@gmail.com"]
+  spec.description   = %q{Mailtruck helps with testing features that involve sending and receiving email from external services.}
+  spec.summary       = %q{Receive emails from external services for testing}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faye", "~> 0.8"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "mocha", "~> 0.14"
+end

data/spec/lib/mailtruck_spec.rb

@@ -0,0 +1,50 @@
+require_relative '../spec_helper'
+
+describe Mailtruck do
+
+  let(:mailtruck) { Mailtruck.new }
+
+  before(:each) do
+    Mailtruck.configure do |config|
+      config.email_host = "example.org"
+      config.timeout = 0.1
+    end
+  end
+
+  it "is configurable" do
+    Mailtruck.configure do |config|
+      config.email_host = "example.com"
+    end
+
+    Mailtruck.configuration.email_host.must_equal "example.com"
+  end
+  
+  it "provides email addresses to send emails to" do
+    mailtruck.email_address.must_match /.*@example.org/
+  end
+
+  it "runs some code and waits for emails to come in" do
+    address = mailtruck.email_address
+
+    client = Object.new
+    def client.address=(address)
+      @address = address
+    end
+    client.address = address
+
+    def client.subscribe(path)
+      yield "to" => @address
+    end
+
+    Faye::Client.stubs("new" => client)
+
+    emails = mailtruck.wait_for_emails do
+      # code that would trigger an email would go here
+    end
+
+    emails.size.must_equal 1
+    email = emails.first
+    email.to.must_equal(address)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha/setup'
+require File.expand_path('../../lib/mailtruck.rb', __FILE__)

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: mailtruck
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Bruz Marzolf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faye
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.14'
+description: Mailtruck helps with testing features that involve sending and receiving
+  email from external services.
+email:
+- bruz.marzolf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mailtruck.rb
+- lib/mailtruck/configuration.rb
+- lib/mailtruck/email.rb
+- lib/mailtruck/email_address.rb
+- lib/mailtruck/receiver.rb
+- lib/mailtruck/version.rb
+- mailtruck.gemspec
+- spec/lib/mailtruck_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3253366713766564001
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3253366713766564001
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Receive emails from external services for testing
+test_files:
+- spec/lib/mailtruck_spec.rb
+- spec/spec_helper.rb