redis_mail 0.8.0

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,16 @@
+---
+language: ruby
+script: bundle exec rspec
+rvm:
+- 1.9.3
+services:
+  - redis-server
+notifications:
+  email: false
+  campfire:
+    rooms:
+    - secure: ! 'j8CJevgIDpE/cQwKm9z5uVY8nXmvQFOoQP/OIieEBMPd7IaSv6YVNMmjHju3
+
+        rKVL0471g0/+hfK1etfxeaygHjLVg1GmOnYH/CK97l3I3BnP5pEu7zz0wSs3
+
+        5Legz1OnsK11U1FAjfSkv088V3/IgyTVegU/SaSiSi03uUsRSVs='

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 PeopleAdmin
+
+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,106 @@
+# RedisMail
+
+A Redis-backed `delivery_method` for the Mail gem (and therefore, Rails'
+ActionMailer).
+
+If your tests run in the same process as the code you are testing, use the
+:test delivery method (`Mail::TestMailer`) instead.
+
+However, in acceptance test scenarios, your test code often runs in a separate
+process from the code being tested. This makes the `Mail::TestMailer.deliveries`
+in-memory array useless.
+
+The :file delivery method (`Mail::FileDelivery`) is another option, however it
+stores all messages to a recipient in a single file, with no easy way to parse
+the messages individually.
+
+RedisMail allows you to capture e-mails sent from one process (your application
+under test) and make assertions in another (your test code). Each message
+can be retrieived and parsed individually.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'redis_mail'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_mail
+
+## Configre your application
+
+### Rails 3.x +
+
+Configure ActionMailer to use RedisMail. In *config/environments/test.rb*:
+
+    config.action_mailer.delivery_method = RedisMail::Deliverer
+
+Set your connection to redis. In *config/initializers/redismail.rb*:
+
+    RedisMail.redis = Redis.new(:host => myredis.host.com)
+
+### Outside of Rails (using Mail gem)
+
+Set the delivery method on the mail message:
+
+    message = Mail.new(:to => "someone@example.com", :subject => "Hello")
+    message.delivery_method(RedisMail::Deliverer, {})
+
+## Retrieving message information
+
+### RedisMail.clear_all
+
+Clears all received messages for any recipient. Run this between each test!
+
+### RedisMail.clear_mailbox(recipient)
+
+Clears all recieved messages for a specific recipient.
+
+### RedisMail.delivieries_count
+
+Total number of messages delivered to any recipient.
+
+Example usage:
+
+    RedisMail.clear_all
+    invoke_action_in_application_that_sends_two_emails
+    raise "Expected emails missing" unless RedisMail.deliveries_count == 2
+
+### RedisMail.delivieries_count_to(recipient)
+
+Total number of messages delivered to a specific recipient.
+
+### RedisMail.delivieries
+
+An array of all messages delivered to any receipient. Each message can be
+parsed using classes provided by the `Mail` gem, for finer grained assertions.
+
+Example usage:
+
+    RedisMail.clear_all
+    invoke_action_that_sends_welcome_email
+    sent_message = Mail.new(RedisMail.deliveries.first)
+    raise "Unexpected subject" unless sent_message.subject == "Welcome!"
+
+### RedisMail.delivieries_to
+
+An array of messages delivered to a given recipient. Messages are ordered from
+oldest to newest.
+
+### RedisMail.mailboxes
+
+An array of recipient addresses that can be used in calls to `deliveries_to`,
+`deliveries_count_to`, or `clear_mailbox`.
+
+## Contributing
+
+1. [Fork it](https://github.com/PeopleAdmin/redis_mail/fork_select)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. [Create new Pull Request](https://github.com/PeopleAdmin/redis_mail/pull/new/master)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/redis_mail/deliverer.rb

@@ -0,0 +1,16 @@
+require 'redis-namespace'
+module RedisMail
+  class Deliverer
+    attr :settings
+
+    def initialize(values)
+      @settings = values
+    end
+
+    def deliver!(mail)
+      mail.destinations.uniq.each do |to|
+        RedisMail.deliver to, mail.to_s
+      end
+    end
+  end
+end

data/lib/redis_mail/version.rb

@@ -0,0 +1,3 @@
+module RedisMail
+  VERSION = "0.8.0"
+end

data/lib/redis_mail.rb

@@ -0,0 +1,59 @@
+require "redis_mail/version"
+require "redis_mail/deliverer"
+
+module RedisMail
+  extend self
+
+  def redis=(server)
+    @redis = Redis::Namespace.new(:redis_mail, redis: server)
+  end
+
+  def redis
+    raise "RedisMail.redis must be set to a Redis connection" unless @redis
+    @redis
+  end
+
+  def clear_mailbox(recipient)
+    redis.del mailbox_key(recipient)
+    redis.srem :mailboxes, recipient
+  end
+
+  def clear_all
+    mailboxes.reduce(false) do |cleared,mailbox|
+      clear_mailbox(mailbox) || cleared
+    end
+  end
+
+  def mailboxes
+    redis.smembers :mailboxes
+  end
+
+  def deliveries_to(recipient)
+    redis.lrange mailbox_key(recipient), 0, -1
+  end
+
+  def deliveries
+    mailboxes.map{|recipient| deliveries_to(recipient)}.flatten
+  end
+
+  def deliveries_count
+    mailboxes.reduce(0){|sum, recipient|
+      sum + redis.llen(mailbox_key(recipient))
+    }
+  end
+
+  def deliveries_count_to(recipient)
+    redis.llen(mailbox_key(recipient))
+  end
+
+  def deliver(recipient, message)
+    redis.sadd :mailboxes, recipient
+    redis.rpush mailbox_key(recipient), message
+  end
+
+  private
+
+  def mailbox_key(recipient)
+    "mailbox:#{recipient}"
+  end
+end

data/redis_mail.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'redis_mail/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "redis_mail"
+  gem.version       = RedisMail::VERSION
+  gem.authors       = ["Joshua Flanagan"]
+  gem.email         = ["jflanagan@peopleadmin.com"]
+  gem.description   = %q{A Redis-backed delivery_method for Mail gem}
+  gem.summary       = %q{Stores emails in Redis for easy retrieval in test scenarios.}
+  gem.homepage      = "https://github.com/PeopleAdmin/redis_mail"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  gem.add_dependency "redis", ">= 2.2.0"
+  gem.add_dependency "redis-namespace"
+  gem.add_development_dependency "mail"
+  gem.add_development_dependency "rspec"
+end

data/spec/deliverer_spec.rb

@@ -0,0 +1,75 @@
+require 'mail'
+require 'redis'
+require 'redis_mail'
+
+describe RedisMail::Deliverer do
+  let(:redis) { RedisMail.redis = Redis.new.tap {|r| r.select 15} }
+
+  before { redis.flushdb }
+
+  context "delivering a message" do
+    let(:sent_message) {
+      Mail.new {
+        to "someone@example.com"
+        to << "another@example.com"
+        from "author@example.com"
+        subject "Hello world"
+        body "This is the test email"
+        cc "interested@example.com"
+      }
+    }
+
+    before do
+      sent_message.delivery_method(RedisMail::Deliverer, {})
+      sent_message.deliver!
+    end
+
+    it "creates a mailbox for tracking messages to each recipient" do
+      mailboxes = redis.smembers "redis_mail:mailboxes"
+      mailboxes.should have(3).items
+      mailboxes.should include "someone@example.com"
+      mailboxes.should include "another@example.com"
+      mailboxes.should include "interested@example.com"
+    end
+
+    it "stores the entire message for each recipient" do
+      sent = redis.lpop "redis_mail:mailbox:someone@example.com"
+      sent.should_not be_nil
+      sent.should == sent_message.to_s
+
+      sent = redis.lpop "redis_mail:mailbox:another@example.com"
+      sent.should_not be_nil
+      sent.should == sent_message.to_s
+
+      sent = redis.lpop "redis_mail:mailbox:interested@example.com"
+      sent.should_not be_nil
+      sent.should == sent_message.to_s
+    end
+
+    context "delivering multiple message to same recipient" do
+      let(:second_message) { Mail.new to: "someone@example.com", subject: "second"  }
+      let(:third_message) { Mail.new to: "someone@example.com", subject: "third"  }
+
+      before do
+        [second_message, third_message].each do |message|
+          message.delivery_method(RedisMail::Deliverer, {redis: redis})
+          message.deliver!
+        end
+      end
+
+      it "stores the messages in chronological order" do
+        sent = redis.lpop "redis_mail:mailbox:someone@example.com"
+        Mail.new(sent).should == sent_message
+
+        sent = redis.lpop "redis_mail:mailbox:someone@example.com"
+        Mail.new(sent).should == second_message
+
+        sent = redis.lpop "redis_mail:mailbox:someone@example.com"
+        Mail.new(sent).should == third_message
+
+        sent = redis.lpop "redis_mail:mailbox:someone@example.com"
+        sent.should be_nil
+      end
+    end
+  end
+end

data/spec/redis_mail_spec.rb

@@ -0,0 +1,170 @@
+require 'mail'
+require 'redis'
+require 'redis_mail'
+
+describe RedisMail do
+  let(:redis) { RedisMail.redis = Redis.new.tap {|r| r.select 15} }
+  before { redis.flushdb }
+
+  describe ".clear_mailbox" do
+    before do
+      send "someone@example.com", "First"
+      send "someone@example.com", "Second"
+      send "someone@example.com", "Third"
+    end
+
+    it "removes all messages from the given mailbox" do
+      redis.llen("redis_mail:mailbox:someone@example.com").should == 3
+      RedisMail.clear_mailbox "someone@example.com"
+      redis.llen("redis_mail:mailbox:someone@example.com").should == 0
+    end
+
+    it "removes the mailbox" do
+      redis.smembers("redis_mail:mailboxes").should include("someone@example.com")
+      RedisMail.clear_mailbox "someone@example.com"
+      redis.smembers("redis_mail:mailboxes").should_not include("someone@example.com")
+    end
+
+    it "returns true when messages are cleared" do
+      RedisMail.clear_mailbox("someone@example.com").should be_true
+    end
+  end
+
+  describe ".clear_all" do
+    before do
+      send "someone@example.com", "First"
+      send "another@example.com", "Second"
+      send "different@example.com", "Third"
+    end
+
+    it "removes all messages from all given mailboxes" do
+      redis.llen("redis_mail:mailbox:someone@example.com").should == 1
+      redis.llen("redis_mail:mailbox:another@example.com").should == 1
+      redis.llen("redis_mail:mailbox:different@example.com").should == 1
+      RedisMail.clear_all
+      redis.llen("redis_mail:mailbox:someone@example.com").should == 0
+      redis.llen("redis_mail:mailbox:another@example.com").should == 0
+      redis.llen("redis_mail:mailbox:different@example.com").should == 0
+    end
+
+    it "removes the mailboxes" do
+      redis.scard("redis_mail:mailboxes").should == 3
+      RedisMail.clear_all
+      redis.scard("redis_mail:mailboxes").should == 0
+    end
+
+    it "returns true when messages are cleared" do
+      RedisMail.clear_all.should be_true
+    end
+  end
+
+  describe ".deliveries_to" do
+    before do
+      send "someone@example.com", "Beta"
+      send "another@example.com", "Gamma"
+      send "someone@example.com", "Alpha"
+    end
+
+    it "returns the messages for a given recipient, in chronological order" do
+      deliveries = RedisMail.deliveries_to "someone@example.com"
+      deliveries.should have(2).items
+      deliveries[0].should include("Beta")
+      deliveries[1].should include("Alpha")
+    end
+  end
+
+  describe ".deliveries" do
+    before do
+      send "someone@example.com", "Beta"
+      send "another@example.com", "Gamma"
+      send "someone@example.com", "Alpha"
+    end
+
+    it "returns all messages received" do
+      deliveries = RedisMail.deliveries
+      deliveries.should have(3).items
+      deliveries.any?{|d| d.include?("Alpha")}.should be_true
+      deliveries.any?{|d| d.include?("Beta")}.should be_true
+      deliveries.any?{|d| d.include?("Gamma")}.should be_true
+    end
+  end
+
+  describe ".deliveries_count" do
+    before do
+      send "someone@example.com", "Beta"
+      send "another@example.com", "Gamma"
+      send "someone@example.com", "Alpha"
+    end
+
+    it "returns the number of messages received" do
+      RedisMail.deliveries_count.should == 3
+    end
+  end
+
+  describe ".deliveries_count_to" do
+    before do
+      send "someone@example.com", "Beta"
+      send "another@example.com", "Gamma"
+      send "someone@example.com", "Alpha"
+    end
+
+    it "returns the number of messages sent to a given address" do
+      RedisMail.deliveries_count_to("someone@example.com").should == 2
+    end
+  end
+
+  describe ".mailboxes" do
+    before do
+      send "someone@example.com", "Beta"
+      send "another@example.com", "Gamma"
+      send "someone@example.com", "Alpha"
+    end
+
+    it "returns a list of email address which have received messages" do
+      mailboxes = RedisMail.mailboxes
+      mailboxes.should have(2).recipients
+      mailboxes.should include("someone@example.com")
+      mailboxes.should include("another@example.com")
+    end
+  end
+
+  context "when no messages have been sent" do
+    it "returns an empty array for .mailboxes" do
+      RedisMail.mailboxes.should == []
+    end
+
+    it "returns an empty array for .deliveries" do
+      RedisMail.deliveries.should == []
+    end
+
+    it "returns an empty array for .deliveries_to" do
+      RedisMail.deliveries_to("someone@example.com").should == []
+    end
+
+    it "returns 0 for .deliveries_count" do
+      RedisMail.deliveries_count.should == 0
+    end
+
+    it "returns 0 for .deliveries_count_to" do
+      RedisMail.deliveries_count_to("someone@example.com").should == 0
+    end
+
+    it "returns false for .clear_mailbox" do
+      RedisMail.clear_mailbox("someone@example.com").should be_false
+    end
+
+    it "returns false for .clear_all" do
+      RedisMail.clear_all.should be_false
+    end
+  end
+
+  def send(recipient, subject)
+    message = Mail.new {
+        to recipient
+        from "author@example.com"
+        subject subject
+    }
+    message.delivery_method(RedisMail::Deliverer, {redis: redis})
+    message.deliver!
+  end
+end

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: redis_mail
+version: !ruby/object:Gem::Version
+  version: 0.8.0
+  prerelease: 
+platform: ruby
+authors:
+- Joshua Flanagan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+    none: false
+- !ruby/object:Gem::Dependency
+  name: redis-namespace
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :runtime
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  name: mail
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  name: rspec
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :development
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+description: A Redis-backed delivery_method for Mail gem
+email:
+- jflanagan@peopleadmin.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/redis_mail.rb
+- lib/redis_mail/deliverer.rb
+- lib/redis_mail/version.rb
+- redis_mail.gemspec
+- spec/deliverer_spec.rb
+- spec/redis_mail_spec.rb
+homepage: https://github.com/PeopleAdmin/redis_mail
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Stores emails in Redis for easy retrieval in test scenarios.
+test_files:
+- spec/deliverer_spec.rb
+- spec/redis_mail_spec.rb