bounce_fetcher 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Michael Guterl
+
+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,27 @@
+# Bounce Fetcher
+
+A set of tools for processing email bounces in a flexible way.
+
+## Usage
+
+    bounces = BounceFetcher.pop3('pop3.host.com', 'username', 'password')
+    bounces.each do |email|
+      # do something application specific
+      # For example: User.bounce_email(email)
+    end
+
+This will fetch each email from the POP3 server specified, if the email is a determined to be a permanent bounce, we will attempt to determine what email address the bounce is for, yield it to the block, and the email will be deleted from the POP3 server.
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2011 Michael Guterl. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/test_*.rb"
+end
+
+task :default => :test

data/bounce_fetcher.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "bounce_fetcher/version"
+
+Gem::Specification.new do |s|
+  s.name        = "bounce_fetcher"
+  s.version     = BounceFetcher::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Michael Guterl"]
+  s.email       = ["michael@diminishing.org"]
+  s.homepage    = "http://github.com/mguterl/bounce_fetcher"
+  s.summary     = %q{A set of tools for processing email bounces in a flexible way.}
+  s.description = %q{A set of tools for processing email bounces in a flexible way.}
+
+  s.rubyforge_project = "bounce_fetcher"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'tmail'
+  s.add_dependency 'bounce-email', '0.0.1'
+end

data/lib/bounce_fetcher.rb

@@ -0,0 +1,39 @@
+module BounceFetcher
+
+  def self.new(*args, &block)
+    BounceFetcher.new(*args, &block)
+  end
+
+  def self.pop3(host, username, password)
+    fetcher = PopFetcher.new(host, username, password)
+    extractor = Extractor.new
+    detector = Detector.new
+    new(fetcher, extractor, detector)
+  end
+
+  class BounceFetcher
+
+    def initialize(fetcher, extractor, detector)
+      @fetcher = fetcher
+      @extractor = extractor
+      @detector = detector
+    end
+
+    def each
+      @fetcher.each do |e|
+        if @detector.permanent_bounce?(e)
+          @extractor.extract_emails(e).each do |email|
+            yield email
+          end
+          e.delete
+        end
+      end
+    end
+
+  end
+
+end
+
+require 'bounce_fetcher/pop_fetcher'
+require 'bounce_fetcher/email_extractor'
+require 'bounce_fetcher/bounce_detector'

data/lib/bounce_fetcher/bounce_detector.rb

@@ -0,0 +1,14 @@
+require 'bounce-email'
+
+module BounceFetcher
+
+  class BounceDetector
+
+    def permanent_bounce?(email)
+      bounce = BounceEmail::Mail.new(email)
+      bounce.isbounce && bounce.type == "Permanent Failure"
+    end
+
+  end
+
+end

data/lib/bounce_fetcher/email_extractor.rb

@@ -0,0 +1,13 @@
+module BounceFetcher
+
+  class EmailExtractor
+
+    EMAIL_REGEX = /\b[A-Z0-9._%+-]+@[A-Z0-9.-]+\.[A-Z]{2,4}\b/i
+
+    def extract_emails(string)
+      string.scan(EMAIL_REGEX).compact.uniq
+    end
+
+  end
+
+end

data/lib/bounce_fetcher/pop_fetcher.rb

@@ -0,0 +1,54 @@
+# lifted from the action_mailer_verp plugin:
+# http://github.com/jamesgolick/action_mailer_verp
+
+module BounceProcessor
+
+  class PopFetcher
+
+    class Email
+      def initialize(email)
+        @email = email
+      end
+
+      def delete
+        @email.delete
+      end
+
+      def method_missing(meth, *args, &block)
+        parsed_email.send(meth, *args, &block)
+      end
+
+      private
+
+      def parsed_email
+        @parsed_email ||= TMail::Mail.parse(@email.pop)
+      end
+    end
+
+    def initialize(host, username, password)
+      @host = host
+      @username = username
+      @password = password
+    end
+
+    def each
+      connection.each_mail do |e|
+        yield Email.new(e)
+      end
+      connection.finish
+    end
+
+    private
+
+    def connection
+      if @connection.nil?
+        @connection = Net::POP3.new(@host)
+        @connection.start(@username, @password)
+      end
+
+      @connection
+    end
+
+  end
+
+end

data/lib/bounce_fetcher/version.rb

@@ -0,0 +1,3 @@
+module BounceFetcher
+  VERSION = "0.0.1"
+end

data/test/test_bounce_detector.rb

@@ -0,0 +1,44 @@
+require 'minitest/autorun'
+require 'bounce_fetcher'
+
+class TestBounceDetector < MiniTest::Unit::TestCase
+
+  class Email < Struct.new(:subject, :body)
+    def parts
+      []
+    end
+  end
+
+  class EmailWithBounceStatus
+    class Part < Struct.new(:body); end
+
+    def subject
+      "mail delivery failed"
+    end
+
+    def parts
+      [nil, Part.new("Status: 5.2.0")]
+    end
+  end
+
+  def setup
+    @detector = BounceFetcher::BounceDetector.new
+  end
+
+  def test_permanent_bounce_with_temporary_failure
+    assert !@detector.permanent_bounce?(Email.new("mail delivery failed"))
+  end
+
+  def test_permanent_bounce_with_out_of_town_auto_responder
+    assert !@detector.permanent_bounce?(Email.new("Out of Town"))
+  end
+
+  def test_permanent_bounce_with_a_permanent_bounce_body
+    assert @detector.permanent_bounce?(Email.new("mail delivery failed", "mailbox unavailable"))
+  end
+
+  def test_permanent_bounce_with_a_permanent_bounce_status
+    assert @detector.permanent_bounce?(EmailWithBounceStatus.new)
+  end
+
+end

data/test/test_bounce_fetcher.rb

@@ -0,0 +1,56 @@
+require 'minitest/autorun'
+require 'bounce_fetcher'
+
+class TestBounceFetcher < MiniTest::Unit::TestCase
+
+  class FakePopFetcher
+    def initialize(*emails)
+      @emails = emails
+    end
+
+    def each
+      @emails.each { |email| yield email }
+    end
+  end
+
+  class Email < Struct.new(:body, :permanent_bounce)
+    def delete
+      @deleted = true
+    end
+
+    def deleted?
+      @deleted
+    end
+  end
+
+  class FakeExtractor
+    def extract_emails(tmail)
+      [tmail.body]
+    end
+  end
+
+  class FakeBounceDetector
+    def permanent_bounce?(tmail)
+      tmail.permanent_bounce
+    end
+  end
+
+  def test_each_only_returns_emails_for_permanent_bounces
+    permanent_bounce = Email.new('foo@bar.com', true)
+    temporary_bounce = Email.new('bar@baz.com', false)
+    pop_fetcher = FakePopFetcher.new(permanent_bounce, temporary_bounce)
+    extractor = FakeExtractor.new
+    detector = FakeBounceDetector.new
+    fetcher = BounceFetcher.new(pop_fetcher, extractor, detector)
+
+    emails = []
+    fetcher.each do |email|
+      emails << email
+    end
+
+    assert_equal ['foo@bar.com'], emails
+    assert permanent_bounce.deleted?
+    assert !temporary_bounce.deleted?
+  end
+
+end

data/test/test_email_extractor.rb

@@ -0,0 +1,18 @@
+require 'minitest/autorun'
+require 'bounce_fetcher'
+
+class TestEmailExtractor < MiniTest::Unit::TestCase
+
+  def setup
+    @extractor = BounceFetcher::EmailExtractor.new
+  end
+
+  def test_extract_emails
+    assert_equal ['foo@bar.com', 'bar@baz.com'], @extractor.extract_emails("foo@bar.com\nbar@baz.com")
+  end
+
+  def test_extract_emails_ignores_duplicates
+    assert_equal ['foo@bar.com'], @extractor.extract_emails("foo@bar.com\nfoo@bar.com")
+  end
+
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: bounce_fetcher
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Guterl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-04-06 00:00:00.000000000 -04:00
+default_executable: 
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tmail
+  requirement: &2162141280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2162141280
+- !ruby/object:Gem::Dependency
+  name: bounce-email
+  requirement: &2162140740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - =
+      - !ruby/object:Gem::Version
+        version: 0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *2162140740
+description: A set of tools for processing email bounces in a flexible way.
+email:
+- michael@diminishing.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bounce_fetcher.gemspec
+- lib/bounce_fetcher.rb
+- lib/bounce_fetcher/bounce_detector.rb
+- lib/bounce_fetcher/email_extractor.rb
+- lib/bounce_fetcher/pop_fetcher.rb
+- lib/bounce_fetcher/version.rb
+- test/test_bounce_detector.rb
+- test/test_bounce_fetcher.rb
+- test/test_email_extractor.rb
+has_rdoc: true
+homepage: http://github.com/mguterl/bounce_fetcher
+licenses: []
+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: bounce_fetcher
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: A set of tools for processing email bounces in a flexible way.
+test_files:
+- test/test_bounce_detector.rb
+- test/test_bounce_fetcher.rb
+- test/test_email_extractor.rb