mail-store-agent 0.1.0

data/README.mkd

@@ -0,0 +1,51 @@
+# MailStoreAgent
+
+## Background
+
+Most websites that authenticate users require some form of user account self-management.
+Users need to register with e-mail and password, verify their e-mail address,
+and to occasionally reset their e-mail and password.
+
+I like to delegate this to other services with [OpenID](http://en.wikipedia.org/wiki/OpenID)
+ and [OAuth](http://en.wikipedia.org/wiki/Oauth),
+but not all clients agree to delegate ownership of their customers' authentication records.
+
+So I'm often stuck with implementing these boilerplace features yet again,
+each of the above use-cases require sending out e-mails to confirm or facilitate.
+Testing this can be a pain-in-the-butt.
+
+Fortunately, [Mikel Lindsaar](https://github.com/mikel)'s
+[Mail](https://github.com/mikel/mail) gem
+has a simple and effective way to store and not send e-mails in order to facilitate test scripts.
+
+    Mail::TestMailer
+
+    Mail.defaults do
+      delivery_method :test
+    end
+
+    # send a few mails ...
+
+    Mail::TestMailer.deliveries.is_a? Array # ==> true
+    Mail::TestMailer.deliveries.first.is_a? Mail::Message # ==> true
+
+I want to take this a step further so that I can verify that mail got sent to the right people in the right order:
+
+## SYNOPSIS
+
+    require 'mail'
+    require 'mail-store-agent'
+
+    Mail.defaults do
+      delivery_method :test
+    end
+
+    Mail::TestMailer.deliveries = MailStoreAgent.new
+
+    # send some mail to someone@someplace.com ...
+
+    Mail::TestMailer.deliveries.get('someone@someplace.com').is_a? Mail::Message # or nil
+
+## LICENSE
+* <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/"><img alt="Creative Commons License" style="border-width:0" src="http://i.creativecommons.org/l/by-sa/3.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" href="http://purl.org/dc/dcmitype/Text" property="dct:title" rel="dct:type">mail-store-agent.gem</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="http://westside-consulting.com/" property="cc:attributionName" rel="cc:attributionURL">Lawrence Siden</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/3.0/">Creative Commons Attribution-ShareAlike 3.0 Unported License</a>.<br />Based on a work at <a xmlns:dct="http://purl.org/dc/terms/" href="https://github.com/lsiden" rel="dct:source">github.com</a>.
+* [Ruby License](http://www.ruby-lang.org/en/LICENSE.txt)

data/lib/mail-store-agent.rb

@@ -0,0 +1,35 @@
+
+class MailStoreAgent < Array
+
+  def initialize
+    @queues = {}
+    @next_unsorted = 0  # index of next unsorted e-mail
+  end
+
+  def accounts
+    self.sort_mail!
+    return @queues.keys
+  end
+
+  def get(address)
+    self.sort_mail!
+    return @queues[address] ? @queues[address].shift : nil
+  end
+
+  protected
+  def sort_mail!
+    self[@next_unsorted..self.length].each do |email|
+      #raise "MailStoreAgent is intended to be used as value for Mail::TestMailer.deliveries=().  See README" \
+       # unless email.respond_to?(:destinations) && email.destinations.respond_to?(:each)
+
+      if email.respond_to?(:destinations) && email.destinations.respond_to?(:each) then
+        email.destinations.each do |dest|
+          @queues[dest] = [] if @queues[dest].nil?
+          @queues[dest].push email
+        end
+      end
+    end
+    @next_unsorted = self.length
+  end
+
+end

data/spec/mail_store_agent_spec.rb

@@ -0,0 +1,98 @@
+require 'rubygems'
+require 'rspec'
+require 'mail'
+
+require File.join(File.dirname(__FILE__), %w[ .. lib mail-store-agent ])
+
+describe MailStoreAgent do
+  before(:all) do
+    Mail.defaults do
+      delivery_method :test # don't use '='!
+      Mail::TestMailer.deliveries = MailStoreAgent.new
+    end
+  end
+
+  it 'is an instance of Array' do
+    MailStoreAgent.is_a? Array
+  end
+
+  it 'can be given as argument to Mail::TestMailer#deliveries=()' do
+    Mail::TestMailer.deliveries.is_a? MailStoreAgent
+    Mail::TestMailer.deliveries.should have(0).messages
+
+  end
+
+  it 'can store mail' do
+    mail = Mail.deliver do
+      to 'tarzan@jungle.com'
+      from 'tarzan@jungle.com'
+      subject 'just testing'
+      body 'get this?'
+    end
+    mail.should be_instance_of Mail::Message
+    mail.perform_deliveries.should == true
+    mail.errors.each {|e| puts e}
+    Mail::TestMailer.deliveries.should have(1).message
+
+    Mail.deliver do
+      to 'tarzan@jungle.com'
+      from 'tarzan@jungle.com'
+      subject 'still testing'
+      body 'get this, too?'
+    end
+
+    Mail.deliver do
+      to 'jane@jungle.com'
+      from 'tarzan@jungle.com'
+      subject 'testing now'
+      body 'get this?'
+    end
+
+    mail = Mail.deliver do
+      to 'tarzan@jungle.com'
+      from 'tarzan@jungle.com'
+      subject 'keep on testing'
+      body 'what about this?'
+    end
+    Mail::TestMailer.deliveries.should have(4).messages
+  end
+
+  it 'knows what accounts have been sent mail' do
+    Mail::TestMailer.deliveries.accounts == ['tarzan@jungle.com', 'jane@jungle.com']
+  end
+
+  it 'can return next e-mail for any given address' do
+    mail = Mail::TestMailer.deliveries.get('jane@jungle.com')
+    mail.should be_kind_of Mail::Message
+    mail.to[0].should == 'jane@jungle.com'
+    mail.subject.should == 'testing now'
+  end
+
+  it 'returns nil if there is no more mail for address' do
+    Mail::TestMailer.deliveries.get('jane@jungle.com').should be_nil
+  end
+
+  it 'returns nil if given a non-existent address' do
+    Mail::TestMailer.deliveries.get('blah@foo.bar').should be_nil
+  end
+
+  it 'returns emails in order' do
+    Mail::TestMailer.deliveries.get('tarzan@jungle.com').subject.should == 'just testing'
+    Mail::TestMailer.deliveries.get('tarzan@jungle.com').subject.should == 'still testing'
+    Mail::TestMailer.deliveries.get('tarzan@jungle.com').subject.should == 'keep on testing'
+    Mail::TestMailer.deliveries.get('tarzan@jungle.com').should be_nil
+  end
+
+  it 'does not delete the mail' do
+    Mail::TestMailer.deliveries.should have(4).entries
+  end
+
+  it 'acts like Array and ignores contents that are not instances of Mail::Message' do
+    Mail::TestMailer.deliveries.push :foo
+    Mail::TestMailer.deliveries.push 'baz'
+    Mail::TestMailer.deliveries.push Object.new
+    Mail::TestMailer.deliveries.accounts == ['tarzan@jungle.com', 'jane@jungle.com']
+    Mail::TestMailer.deliveries.get('tarzan@jungle.com').should be_nil
+    Mail::TestMailer.deliveries.should have(7).items
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: mail-store-agent
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Larry Siden, Westside Consulting LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: &79348610 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *79348610
+description: Provides per-email-account sequential access to Mail::TestMailer.deliveries
+email: lsiden@westside-consulting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.mkd
+- lib/mail-store-agent.rb
+- spec/mail_store_agent_spec.rb
+homepage: http://github.com/lsiden/mail-store-agent/
+licenses:
+- Creative Commons Share-Alike Unported
+- Ruby License
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Tiny mail agent for extracting delivered mail messages from Mail::TestMailer
+test_files: []