voomify_email_integrator 0.1.0

data/README.rdoc

@@ -0,0 +1,64 @@
+= email-integrator
+
+* http://github.com/voomify/email-integrator
+
+== DESCRIPTION:
+
+This gem will allow you to use email as a simple message queue like integrator
+
+== FEATURES/PROBLEMS:
+
+* Reads an email inbox and allows a derived class to process the message
+* Logs errors and ignored records
+* errors are sent to hoptoad
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+Hoptoad for error notifications
+
+== INSTALL:
+
+This gem is not published. You can install it locally using the following.
+For rails you should vendor the gem.
+
+git clone git://github.com/voomify/email-integrator.git
+
+# This is required by hoe and to install the gem locally you have to run it.
+$ sudo gem install rubyforge
+
+# create a default ~/.rubyforge/user-config.yml  file.
+# note the existence of the  ~/.rubyforge/user-config.yml  file.
+# you don't need a rubyforge account, only this file with ANY values in it
+$ rubyforge setup
+
+cd email-integrator
+rake install_gem
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2010 russelledens and Voomify, LLC
+
+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/lib/email_integrator.rb

@@ -0,0 +1,6 @@
+require File.dirname(__FILE__) + '/email_integrator/email_integrator.rb'
+
+
+module EmailIntegrator
+  VERSION = "0.0.1"
+end  

data/lib/email_integrator/email_integrator.rb

@@ -0,0 +1,75 @@
+require 'net/pop'
+require 'net/http'
+require 'uri'
+require 'pp'
+
+# This is the base class that iterates an email and processes inbound requests
+# It should be used with craken or cron
+#
+module EmailIntegrator
+  class POP3
+    def initialize(connection)
+      @connection = connection
+      [:server, :username, :password].each do |param|
+        raise ArgumentError, "missing argument #{param.to_s}" unless @connection.has_key? param
+      end
+
+    end
+
+    [:server, :username, :password].each do |method|
+      define_method method do
+        @connection[method]
+      end
+    end
+
+    def is_production?
+      ENV["RAILS_ENV"] == "production" ? true : false
+    end
+
+    def process(pattern)
+      #
+      # Connect to email server and look for emails
+      #
+      errors=[]
+      conn = Net::POP3.new(server)
+      conn.start(username,
+                 password) do |pop|
+        pop.mails.each do |msg|
+          begin
+            xml = msg.pop[pattern]
+            if xml
+              processed = yield(xml)
+              msg.delete if processed && is_production?
+            end
+          rescue Exception => e
+            errors << e
+          end
+        end
+      end
+      if errors.size>0
+        raise(RuntimeError,
+            "Processing email integration generated exception(#{errors.size}).\n"+
+            "Until it is resolved it the message will be stuck in the email inbox: (#{server}, #{username})."+
+            "Error Messages: " + error_messages(errors))
+      end        
+    end
+
+    def error_messages(errors)
+      message = ""
+      errors.each do |e|
+        message<< "#{e.class} #{e.message}\n#{clean_backtrace(e)}\n"
+      end
+      message
+    end
+
+    def clean_backtrace(exception)
+         if backtrace = exception.backtrace
+           if defined?(RAILS_ROOT)
+             backtrace.map { |line| line.sub(RAILS_ROOT, '')+"\n" }
+           else
+             backtrace
+           end
+         end
+       end
+  end
+end

data/spec/email_integrator_spec.rb

@@ -0,0 +1,86 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+
+# Time to add your specs!
+# http://rspec.info/
+describe EmailIntegrator do
+
+  before(:all) do
+    class HoptoadNotifier
+          def self.notify(args)
+            raise "Unexpected error"
+          end
+    end
+  end
+  
+  it "throws exception if server is not passed" do
+    should_throw_exception(ArgumentError) do
+      EmailIntegrator::POP3.new(:username=>"username",
+                          :password=>"password")
+    end
+  end
+
+  it "throws exception if username is not passed" do
+    should_throw_exception(ArgumentError) do
+      EmailIntegrator::POP3.new(:server=>"server",
+                          :password=>"password")
+    end
+  end
+
+  it "throws exception if password is not passed" do
+    should_throw_exception(ArgumentError) do
+      EmailIntegrator::POP3.new(:server=>"server",
+                          :username=>"username")
+    end
+  end
+
+
+  it "throws exception if bad server is passed" do
+      should_throw_exception(SocketError) do
+        EmailIntegrator::POP3.new(:server=>"garbage",
+                            :username=>"username",
+                            :password=>"password").process(/.*/) { |msg| }
+      end
+    end
+
+  it "process email" do
+
+    mock_message = mock('message')
+    mock_message.should_receive(:pop).and_return("look at me")
+
+    mock_connection = mock('connection')
+    mock_connection.should_receive(:mails).and_return([mock_message])
+    mock_connection.should_receive(:start).and_yield(mock_connection)
+
+    Net::POP3.should_receive(:new).and_return(mock_connection)
+
+
+    EmailIntegrator::POP3.new(:server=>"garbage",
+                             :username=>"username",
+                             :password=>"password").process(/.*/) do |xml|
+      xml.should == "look at me"
+    end
+
+  end
+
+  it "process email but don't find a message" do
+
+    mock_message = mock('message')
+    mock_message.should_receive(:pop).and_return("look at me")
+
+    mock_connection = mock('connection')
+    mock_connection.should_receive(:mails).and_return([mock_message])
+    mock_connection.should_receive(:start).and_yield(mock_connection)
+
+    #Net::POP3.should_receive(:new).and_return(MockConnection.new)
+    Net::POP3.should_receive(:new).and_return(mock_connection)
+
+    EmailIntegrator::POP3.new(:server=>"garbage",
+                             :username=>"username",
+                             :password=>"password").process(/anything/) do |xml|
+      raise 'This should not be called!'
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'email_integrator'
+
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir[File.expand_path(File.join(File.dirname(__FILE__),'support','**','*.rb'))].each {|f| require f}

data/spec/support/exception_helper.rb

@@ -0,0 +1,22 @@
+require 'spec/test/unit'
+require 'pp'
+
+def should_throw_exception(expected_exception_class, &block)
+
+  begin
+    block.call
+  rescue expected_exception_class
+    threw_error = true 
+  rescue Exception => err    
+  end
+  assert threw_error, message(expected_exception_class, err)
+end
+
+def message(expected_exception_class, err)
+   error = "The test did NOT throw the expected exception: #{expected_exception_class}"
+   if err
+    error << " threw #{err.class} instead"
+   else
+    error <<  " no exceptions were thrown"
+   end
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems' unless ENV['NO_RUBYGEMS']
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: voomify_email_integrator
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Russell Edens
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-05 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: This gem contains the logic for reading email from a pop3 mailbox
+email: russell@voomify.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/email_integrator.rb
+- lib/email_integrator/email_integrator.rb
+- tasks/rspec.rake
+- README.rdoc
+- spec/email_integrator_spec.rb
+- spec/support/exception_helper.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://www.github.com/voomify/email_integrator
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Voomify email integrator. Reads POP3 emails.
+test_files: 
+- spec/email_integrator_spec.rb
+- spec/support/exception_helper.rb
+- spec/spec_helper.rb