bounce_fu 0.0.3

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 James Golick
+
+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.rdoc

@@ -0,0 +1,7 @@
+= bounce_fu
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 James Golick. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "bounce_fu"
+    gem.summary = %Q{TODO}
+    gem.email = "james@giraffesoft.ca"
+    gem.homepage = "http://github.com/giraffesoft/bounce_fu"
+    gem.authors = ["James Golick"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bounce_fu #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION

@@ -0,0 +1 @@
+0.0.3

data/bounce_fu.gemspec

@@ -0,0 +1,62 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bounce_fu}
+  s.version = "0.0.3"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James Golick"]
+  s.date = %q{2009-06-10}
+  s.email = %q{james@giraffesoft.ca}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bounce_fu.gemspec",
+     "lib/bounce_fu.rb",
+     "lib/bounce_fu/abstract_handler.rb",
+     "lib/bounce_fu/bounce.rb",
+     "lib/bounce_fu/pop_fetcher.rb",
+     "lib/bounce_fu/test_fetcher.rb",
+     "test/abstract_handler_test.rb",
+     "test/bounce_fu_test.rb",
+     "test/bounce_test.rb",
+     "test/fixtures/hotmail-unavailable.email",
+     "test/fixtures/permanent.email",
+     "test/fixtures/temporary.email",
+     "test/pop_fetcher_test.rb",
+     "test/test_fetcher_test.rb",
+     "test/test_helper.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/giraffesoft/bounce_fu}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{TODO}
+  s.test_files = [
+    "test/abstract_handler_test.rb",
+     "test/bounce_fu_test.rb",
+     "test/bounce_test.rb",
+     "test/pop_fetcher_test.rb",
+     "test/test_fetcher_test.rb",
+     "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/bounce_fu.rb

@@ -0,0 +1,24 @@
+require 'bounce_fu/bounce'
+require 'bounce_fu/pop_fetcher'
+require 'bounce_fu/abstract_handler'
+require 'bounce_fu/test_fetcher'
+
+module BounceFu
+  class MissingConfigOption < ArgumentError; end
+
+  class << self
+    def configuration
+      @configuration ||= {}
+    end
+    
+    def handle_bounces
+      [:host, :username, :password, :handler].each do |key|
+        raise MissingConfigOption, "You must configure BounceFu with a #{key}" if configuration[key].nil?
+      end
+
+      fetcher = (configuration[:fetcher] || PopFetcher).new
+      configuration[:handler].new(fetcher).handle_bounces
+    end
+  end
+end
+

data/lib/bounce_fu/abstract_handler.rb

@@ -0,0 +1,19 @@
+module BounceFu
+  class AbstractHandler
+    attr_accessor :fetcher
+
+    def initialize(fetcher)
+      @fetcher = fetcher
+    end
+
+    def handle_bounces
+      fetcher.each do |m|
+        handle_bounce(Bounce.new(m))
+      end
+    end
+
+    def handle_bounce(bounce)
+      raise UnimplementedError, "Subclass BounceFu::AbstractHandler to add the applicable bounce handling strategy for your application."
+    end
+  end
+end

data/lib/bounce_fu/bounce.rb

@@ -0,0 +1,31 @@
+module BounceFu
+  class Bounce
+    attr_reader :message_body, :email_address
+
+    def initialize(message_body)
+      @message_body = message_body
+      parse
+    end
+
+    def permanent?
+      @permanent
+    end
+
+    def temporary?
+      !permanent?
+    end
+
+    protected
+      def parse
+        if message_body.match(/This is a permanent error. The following address\(es\) failed:(.+)/m)
+          @permanent     = true
+          $1.split("\n").each do |line|
+            if line.match(/([\w]+@[\w\.]+)/)
+              @email_address = $1.strip
+              break
+            end
+          end
+        end
+      end
+  end
+end

data/lib/bounce_fu/pop_fetcher.rb

@@ -0,0 +1,26 @@
+require 'net/pop'
+
+module BounceFu
+  class PopFetcher
+    include Enumerable
+
+    def connection
+      if @connection.nil?
+        @connection = Net::POP3.new(BounceFu.configuration[:host])
+        @connection.start(BounceFu.configuration[:username],
+                            BounceFu.configuration[:password])
+      end
+
+      @connection
+    end
+
+    def each
+      connection.each_mail do |e|
+        yield e.pop
+        e.delete
+      end
+      connection.finish
+    end
+  end
+end
+

data/lib/bounce_fu/test_fetcher.rb

@@ -0,0 +1,14 @@
+module BounceFu
+  class TestFetcher
+    include Enumerable
+
+    class << self
+      attr_accessor :messages
+    end
+
+    def each(&block)
+      self.class.messages.each(&block)
+    end
+  end
+end
+

data/test/abstract_handler_test.rb

@@ -0,0 +1,17 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class AbstractHandlerTest < Test::Unit::TestCase
+  context "Handling bounced mail from a fetcher" do
+    setup do
+      @fetcher = BounceFu::PopFetcher.new
+      @fetcher.stubs(:each).yields("a message")
+    end
+    
+    should "call Handler#handle_bounce for each message yielded" do
+      count = 0
+      @handler = BounceFu::AbstractHandler.new(@fetcher)
+      @handler.expects(:handle_bounce).with(instance_of(BounceFu::Bounce)).once
+      @handler.handle_bounces
+    end
+  end
+end

data/test/bounce_fu_test.rb

@@ -0,0 +1,66 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class BounceFuTest < Test::Unit::TestCase
+  context "Setting the configuration" do
+    should "behave like a hash" do
+      BounceFu.configuration[:host] = "whatever.com"
+      assert_equal "whatever.com", BounceFu.configuration[:host]
+    end
+  end
+
+  context "Starting a bounce handling session " do
+    setup    { BounceFu.configuration.clear }
+    teardown { BounceFu.configuration.clear }
+
+    should "raise if there's no host" do
+      assert_raise(BounceFu::MissingConfigOption) {
+        BounceFu.handle_bounces
+      }
+    end
+
+    should "raise if there's no username" do
+      BounceFu.configuration[:host] = "somewhere.com"
+      assert_raise(BounceFu::MissingConfigOption) {
+        BounceFu.handle_bounces
+      }
+    end
+
+    should "raise if there's no password" do
+      BounceFu.configuration[:host]     = "somewhere.com"
+      BounceFu.configuration[:username] = "somebody@somewhere.com"
+      assert_raise(BounceFu::MissingConfigOption) {
+        BounceFu.handle_bounces
+      }
+    end
+
+    should "raise if there's no handler" do
+      BounceFu.configuration[:host]     = "somewhere.com"
+      BounceFu.configuration[:username] = "somebody@somewhere.com"
+      BounceFu.configuration[:password] = "somebody@somewhere.com"
+      assert_raise(BounceFu::MissingConfigOption) {
+        BounceFu.handle_bounces
+      }
+    end
+
+    should "start the handler if the configuration is complete" do
+      BounceFu.configuration[:host]     = "somewhere.com"
+      BounceFu.configuration[:username] = "somebody@somewhere.com"
+      BounceFu.configuration[:password] = "somebody@somewhere.com"
+      BounceFu.configuration[:handler]  = BounceFu::AbstractHandler
+
+      BounceFu::AbstractHandler.expects(:new).with(instance_of(BounceFu::PopFetcher)).returns(mock(:handle_bounces => true))
+      BounceFu.handle_bounces
+    end
+
+    should "use the supplied fetcher if one is supplied" do
+      BounceFu.configuration[:host]     = "somewhere.com"
+      BounceFu.configuration[:username] = "somebody@somewhere.com"
+      BounceFu.configuration[:password] = "somebody@somewhere.com"
+      BounceFu.configuration[:handler]  = BounceFu::AbstractHandler
+      BounceFu.configuration[:fetcher]  = BounceFu::TestFetcher
+
+      BounceFu::AbstractHandler.expects(:new).with(instance_of(BounceFu::TestFetcher)).returns(mock(:handle_bounces => true))
+      BounceFu.handle_bounces
+    end
+  end
+end

data/test/bounce_test.rb

@@ -0,0 +1,49 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class BounceTest < Test::Unit::TestCase
+  context "A permanently bounced email" do
+    setup do
+      @email = BounceFu::Bounce.new(fixture("permanent"))
+    end
+
+    should "be permanent?" do
+      assert @email.permanent?
+    end
+
+    should "not be temporary?" do
+      assert !@email.temporary?
+    end
+
+    should "return the email address that failed" do
+      assert_equal "someuser@yahoo.com", @email.email_address
+    end
+  end
+
+  context "A temporarily bounced email" do
+    setup do
+      @email = BounceFu::Bounce.new(fixture("temporary"))
+    end
+
+    should "be temporary?" do
+      assert @email.temporary?
+    end
+
+    should "not be permanent" do
+      assert !@email.permanent?
+    end
+  end
+
+  context "An abuse email from Hotmail" do
+    setup do
+      @email = BounceFu::Bounce.new(fixture("hotmail-unavailable"))
+    end
+
+    should "be permanent" do
+      assert @email.permanent?
+    end
+
+    should "process the email correctly" do
+      assert_equal "someuser@live.com", @email.email_address
+    end
+  end
+end

data/test/fixtures/hotmail-unavailable.email

@@ -0,0 +1,61 @@
+Return-path: <>
+Envelope-to: donotreply@app.yourapp.com.com
+Delivery-date: Wed, 10 Jun 2009 15:03:46 -0700
+Received: from [10.4.65.128] (helo=smtp.ey04.emailhost.com.com)
+        by smtpi.ey04.emailhost.com.com with esmtp (Exim 4.69)
+        id 1MEVta-0003y0-KE
+        for donotreply@app.yourapp.com.com; Wed, 10 Jun 2009 15:03:46 -0700
+Received: from mail by smtp.ey04.emailhost.com.com with local (Exim 4.69)
+        id 1MEVta-0006kG-IL
+        for donotreply@app.yourapp.com.com; Wed, 10 Jun 2009 15:03:46 -0700
+X-Failed-Recipients: someuser@live.com
+Auto-Submitted: auto-replied
+From: Mail Delivery System <Mailer-Daemon@smtp.ey04.emailhost.com.com>
+To: donotreply@app.yourapp.com.com
+Subject: Mail delivery failed: returning message to sender
+Message-Id: <E1MEVta-0006kG-IL@smtp.ey04.emailhost.com.com>
+Date: Wed, 10 Jun 2009 15:03:46 -0700
+X-Spam_score: -1.4
+X-Spam_score_int: -13
+X-Spam_bar: -
+X-Spam_report: Spam detection software, running on the system "ey04-s00031.ey04.emailhost.com.com", has
+        identified this incoming email as possible spam.  The original message
+        has been attached to this so you can view it (if it isn't spam) or label
+        similar future email.  If you have any questions, see
+        the administrator of that system for details.
+        Content preview:  This message was created automatically by mail delivery software.
+        A message that you sent could not be delivered to one or more of its recipients.
+        This is a permanent error. The following address(es) failed: [...] 
+        Content analysis details:   (-1.4 points, 5.0 required)
+        pts rule name              description
+        ---- ---------------------- --------------------------------------------------
+        -1.4 ALL_TRUSTED            Passed through trusted hosts only via SMTP
+
+This message was created automatically by mail delivery software.
+
+A message that you sent could not be delivered to one or more of its
+recipients. This is a permanent error. The following address(es) failed:
+
+  someuser@live.com
+    SMTP error from remote mail server after RCPT TO:<someuser@live.com>:
+    host mx3.hotmail.com [65.54.245.72]: 550 Requested action not taken:
+    mailbox unavailable
+
+------ This is a copy of the message, including all the headers. ------
+
+Return-path: <donotreply@app.yourapp.com.com>
+Received: from [10.4.65.147] (helo=yourapp.com.com)
+        by smtp.ey04.emailhost.com.com with esmtp (Exim 4.69)
+        (envelope-from <donotreply@app.yourapp.com.com>)
+        id 1MEVtZ-0006kB-8H
+        for someuser@live.com; Wed, 10 Jun 2009 15:03:45 -0700
+Date: Wed, 10 Jun 2009 15:03:45 -0700
+From: Your App <donotreply@app.yourapp.com.com>
+To: someuser@live.com
+Message-Id: <4a302dc13cf4d_45c15a0b8943c48436323@ey04-s00402.tmail>
+Subject: stuff
+Mime-Version: 1.0
+Content-Type: text/plain; charset=utf-8
+X-Custom-Ip-Tag: yourapp.com
+
+http://yourapp.com.com/users/xyz

data/test/fixtures/permanent.email

@@ -0,0 +1,28 @@
+This message was created automatically by mail delivery software.
+
+A message that you sent could not be delivered to one or more of its
+recipients. This is a permanent error. The following address(es) failed:
+
+ someuser@yahoo.com
+
+------ This is a copy of the message, including all the headers. ------
+
+Return-path: <donotreply@app.myapp.com>
+Received: from [10.4.64.85] (helo=myapp.com)
+  by smtp.ey04.engineyard.com with esmtp (Exim 4.69)
+  (envelope-from <donotreply@app.myapp.com>)
+  id 1MCMU4-0003mU-Ch
+  for someuser@yahoo.com; Thu, 04 Jun 2009 16:36:32 -0700
+Date: Thu, 4 Jun 2009 16:36:32 -0700
+From: MyApp <donotreply@app.myapp.com>
+To: someuser@yahoo.com
+Message-Id: <4a285a805de1f_37df159bfda883fc120662c@ey04-s00084.tmail>
+Subject: A new discussion titled 'Tesla' was started in Some Forum '
+Mime-Version: 1.0
+Content-Type: text/plain; charset=utf-8
+X-Custom-Ip-Tag: myapp
+
+SomeUser started a new discussion in Some Forum .
+
+To view the discussion click on the link below:
+http://myapp.com/groups/1234/group_posts/5678

data/test/fixtures/temporary.email

@@ -0,0 +1,18 @@
+This message was created automatically by mail delivery software.
+A message that you sent has not yet been delivered to one or more of its
+recipients after more than 24 hours on the queue on smtp.ey04.engineyard.com.
+
+The message identifier is:     1MBVws-0000Fn-4J
+The date of the message is:    Tue, 2 Jun 2009 08:30:46 -0700
+The subject of the message is: A new discussion titled 'STUFF IS AWESOME' was started in  Some Forum '
+
+The address to which the message has not yet been delivered is:
+
+ someuser@yahoo.com
+   Delay reason: SMTP error from remote mail server after initial connection:
+   host g.mx.mail.yahoo.com [206.190.53.191]: 421 Message from (74.217.48.48) temporarily deferred - 4.16.50. Please refer to http://help.yahoo.com/help/us/mail/defer/defer-06.html
+
+No action is required on your part. Delivery attempts will continue for
+some time, and this warning may be repeated at intervals if the message
+remains undelivered. Eventually the mail delivery software will give up,
+and when that happens, the message will be returned to you.

data/test/pop_fetcher_test.rb

@@ -0,0 +1,35 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class PopFetcherTest < Test::Unit::TestCase
+  def setup
+    @sample_config = {
+      :host     => "smtp.example.com",
+      :username => "example",
+      :password => "swordfish"
+    }
+    BounceFu.stubs(:configuration).returns(@sample_config)
+  end
+
+  should "fetch the POP3 host from the config object" do
+    Net::POP3.any_instance.stubs(:start)
+    BounceFu::PopFetcher.new.connection
+  end
+
+  should "fetch the POP3 credentials from the config object" do
+    Net::POP3.any_instance.expects(:start).with("example", "swordfish")
+    BounceFu::PopFetcher.new.connection
+  end
+
+  should "iterate over each email from the pop collection" do
+    fetcher = BounceFu::PopFetcher.new
+    Net::POP3.any_instance.stubs(:start)
+    connection_mock = mock
+    connection_mock.expects(:pop)
+    connection_mock.expects(:delete)
+    Net::POP3.any_instance.expects(:each_mail).yields(connection_mock)
+    Net::POP3.any_instance.expects(:finish)
+
+    fetcher.each do |e|
+    end
+  end
+end

data/test/test_fetcher_test.rb

@@ -0,0 +1,14 @@
+require File.expand_path('../test_helper', __FILE__)
+
+class TestFetcherTest < Test::Unit::TestCase
+  context "The test fetcher" do
+    should "return the mails it's given" do
+      BounceFu::TestFetcher.messages = ["a message", "another message"]
+      fetcher = BounceFu::TestFetcher.new
+      fetcher.each_with_index do |message_body, i|
+        expected = i == 0 ? "a message" : "another message"
+        assert_equal expected, message_body
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'bounce_fu'
+
+class Test::Unit::TestCase
+  protected
+    def fixture_path(filename)
+      File.join(File.dirname(__FILE__), "fixtures", filename)
+    end
+
+    def fixture(filename)
+      File.read(fixture_path(filename + ".email"))
+    end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: bounce_fu
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- James Golick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-10 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: 
+email: james@giraffesoft.ca
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bounce_fu.gemspec
+- lib/bounce_fu.rb
+- lib/bounce_fu/abstract_handler.rb
+- lib/bounce_fu/bounce.rb
+- lib/bounce_fu/pop_fetcher.rb
+- lib/bounce_fu/test_fetcher.rb
+- test/abstract_handler_test.rb
+- test/bounce_fu_test.rb
+- test/bounce_test.rb
+- test/fixtures/hotmail-unavailable.email
+- test/fixtures/permanent.email
+- test/fixtures/temporary.email
+- test/pop_fetcher_test.rb
+- test/test_fetcher_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/giraffesoft/bounce_fu
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: TODO
+test_files: 
+- test/abstract_handler_test.rb
+- test/bounce_fu_test.rb
+- test/bounce_test.rb
+- test/pop_fetcher_test.rb
+- test/test_fetcher_test.rb
+- test/test_helper.rb