kns_email_endpoint 0.1.0

data/spec/lib/kns_email_endpoint/connection_spec.rb

@@ -0,0 +1,133 @@
+require 'lib/kns_email_endpoint'
+
+RSpec.configure do |c|
+  #c.filter_run :filter => true
+end
+
+
+module KNSEmailEndpoint
+  # Select which connection to test against
+  #  - test: Doesn't actually connect to any mail system so it's fast
+  #  - gmail: Uses a test gmail account so it's slow
+  # All tests should work for either test or gmail.
+  $CONN_TO_TEST = "test"
+  test_config_file = File.join(File.dirname(__FILE__), '../..', 'test_config_file.yml') 
+  Configuration.load_from_file test_config_file
+  
+
+  describe ConnectionFactory, :filter => true do
+
+    before :all do 
+      
+      class TestConnection
+        include ConnectionFactory
+
+        def initialize
+          begin
+            setup_mail_connections $CONN_TO_TEST
+          rescue => e
+            ap e.message
+            ap e.backtrace
+          end
+        end
+
+      end
+
+      @conn = TestConnection.new
+
+    end
+
+    it "should have a valid name" do
+      @conn.name.should eql $CONN_TO_TEST
+    end
+
+    it "should have a valid log" do
+      @conn.conn_log.class.should eql Logger
+    end
+
+    it "should have a retriever method" do
+      @conn.retriever.should_not be_nil
+      [Mail::TestRetriever, Mail::IMAP, Mail::POP3].
+        should include @conn.retriever.class
+    end
+
+    it "should have a sender method" do
+      @conn.sender.should_not be_nil
+      [Mail::TestMailer, Mail::SMTP].
+        should include @conn.sender.class
+    end
+
+  end
+
+  describe Connection, :filter => true do
+    before :all do 
+      @conn = Connection.new $CONN_TO_TEST
+    end
+
+    it "should have a valid name" do
+      @conn.name.should eql $CONN_TO_TEST
+    end
+
+    describe "sending messages", :filter => true do
+      before :all do 
+        @conn.retriever.delete_all
+        @message = Mail.new do
+          from 'kynetx.endpoint.test@gmail.com'
+          to   'kynetx.endpoint.test@gmail.com'
+          subject 'testing 123'
+          body    'Testing 123'
+        end
+      end
+
+      it "should send an email" do
+        begin
+          lambda { @conn.sender.deliver!(@message) }.
+            should_not raise_error
+        rescue => e
+          ap e.message
+          ap e.backtrace
+        end
+      end
+
+      # Copy the sent emails to the retrievers email to simulate
+      # emailing one's self. Only needed if using "test"
+      after :all do 
+        Mail::TestRetriever.emails = Mail::TestMailer.deliveries if @conn.name == "test"
+      end
+
+    end
+
+    describe "receiving messages", :filter => false do
+      before :all do
+        @message = @conn.retriever.find(:count => 1)
+      end
+
+      it "should get mail from test" do
+        messages = @conn.retriever.find :count => 2
+        messages.should_not be_empty
+      end
+
+
+      it "should be a valid message" do
+        @message.to.first.should eql 'kynetx.endpoint.test@gmail.com'
+      end
+
+      it "should allow me to delete the message" do
+        # demonstrates how to use find to delete messages
+        begin
+          @conn.retriever.find(:count => 1, :delete_after_find => true) do |msg|
+            msg.mark_for_delete = true
+          end
+          messages = @conn.retriever.find
+          messages.should be_empty
+        rescue => e
+          ap e.message
+          ap e.backtrace
+        end
+      end
+      
+    end
+
+
+  end
+end

data/spec/lib/kns_email_endpoint/email_endpoint_spec.rb

@@ -0,0 +1,97 @@
+require 'lib/kns_email_endpoint'
+require 'ap'
+#$KNS_ENDPOINT_DEBUG = true
+
+module KNSEmailEndpoint
+  test_config_file = File.join(File.dirname(__FILE__), '../..', 'test_config_file.yml') 
+  Configuration.load_from_file(test_config_file)
+  
+
+  describe EmailEndpoint do
+    include ConnectionFactory
+
+
+    before :all do
+      setup_mail_connections "test"
+
+      @mail = EmailEndpoint.new("test", {
+        :ruleset => :a18x34,
+        :environment => :development,
+        :use_session => true,
+        :logging => true
+      }, sender)
+
+      MessageState.set_storage :memcache, {}
+
+      @test_message_file = File.join(File.dirname(__FILE__), '../..', 'test_email.eml')
+      @test_message = Mail.new(File.open(@test_message_file, "r").read);
+    end
+
+
+    describe "Events" do 
+      it "should send an mail received event" do
+        lambda {@mail.received(:msg => @test_message, :test_rule => "parts", :extract_label => true)}.
+          should_not raise_error
+        @mail.status.should eql :processed
+      end
+
+      it "should receive a delete directive" do
+        @mail.received(:msg => @test_message, :test_rule => "delete_me")
+        @mail.status.should eql :deleted
+      end
+
+      describe "reply" do
+        before :all do 
+          Mail::TestMailer.deliveries = []
+          @mail.received(:msg => @test_message, :test_rule => "reply")
+        end
+
+        subject { @mail.status }
+        it { should eql :replied }
+
+        it "should be included in deliveries" do
+          reply = Mail::TestMailer.deliveries.first
+          reply.to.first.should eql "mjf@kynetx.com"
+        end
+        
+      end
+
+      describe "reply and delete" do
+        before :all do
+          @mail.received(:msg => @test_message, :test_rule => "reply and delete")
+        end
+
+        subject { @mail.status }
+        it { should eql :deleted }
+      end
+
+      describe "forward" do
+        before :all do
+          Mail::TestMailer.deliveries = []
+          @mail.received(:msg => @test_message, :test_rule => "forward", :forward_to => "test@example.com")
+        end
+
+        subject { @mail }
+        its (:status) { should eql :forwarded }
+
+        it "should be included in deliveries" do
+          forward = Mail::TestMailer.deliveries.first
+          forward.to.first.should eql "test@example.com"
+        end
+      end
+
+      describe "forward and delete" do
+        before :all do
+          @mail.received(:msg => @test_message, :test_rule => "forward and delete", :forward_to => "test@example.com")
+        end
+
+        subject { @mail.status }
+        it { should eql :deleted }
+      end
+
+    end
+
+
+
+  end
+end

data/spec/lib/kns_email_endpoint/message_state_spec.rb

@@ -0,0 +1,69 @@
+require 'lib/kns_email_endpoint'
+
+module KNSEmailEndpoint
+  MessageState.set_storage :memcache, {} 
+
+  describe MessageState do
+
+    before :all do 
+      @message = Mail.new do
+        to "test@example.com"
+        from "joe@example.com"
+        subject "This is a test"
+        body "This is a test body"
+      end
+      @message.add_message_id('1234')
+
+      @message_state = MessageState.new("test", @message)
+      @message_state.reset_state
+    end
+
+    it "should have an initial state of :unprocessed" do
+      @message_state.state.should eql :unprocessed
+    end
+
+    it "should have a message_id" do
+      @message.has_message_id?.should eql true
+    end
+
+    it "should have a unique_id" do 
+      @message_state.unique_id.should_not be_nil
+    end
+    
+    it "should have a retry count of 0" do
+      @message_state.retry_count.should eql 0
+    end
+
+    it "should have a message_id" do
+      @message_state.message_id.should eql "1234"
+    end
+
+    it "should not allow a message without a message_id" do
+      lambda { MessageState.new('test', Mail.new) }.
+        should raise_error
+    end
+
+    it "should allow me to update the state" do
+      @message_state.state = :new_state
+      @message_state.state.should eql :new_state
+    end
+
+    it "should allow me to increment the retry count" do
+      rc = @message_state.retry_count
+      @message_state.retry
+      @message_state.retry_count.should eql rc + 1
+    end
+
+    it "should allow me to reset the retry count" do
+      @message_state.retry
+      @message_state.reset
+      @message_state.retry_count.should eql 0
+    end
+
+    it "should allow me to delete the message" do
+      @message_state.delete
+      @message_state.state.should == :deleted
+    end
+
+  end
+end

data/spec/lib/kns_email_endpoint/process_email_spec.rb

@@ -0,0 +1,67 @@
+require 'lib/kns_email_endpoint'
+
+$CONN_TO_TEST = "test"
+$NUM_TEST_EMAIL = 10 # make sure you tone this down if testing on a connection other than "test"
+
+module KNSEmailEndpoint
+  test_config_file = File.join(File.dirname(__FILE__), '../..', 'test_config_file.yml') 
+  Configuration.load_from_file(test_config_file)
+  
+  describe ProcessEmail do 
+
+
+
+    before :all do 
+      # Setup some email to test against
+      @conn = Connection.new($CONN_TO_TEST)
+      @conn.retriever.delete_all
+      Mail::TestMailer.deliveries = []
+      $NUM_TEST_EMAIL.times do |x|
+        @conn.sender.deliver!(Mail.new do
+          to "kynetx.endpoint.test@gmail.com"
+          from "kynetx.endpoint.test@gmail.com"
+          subject "Testing #{x}"
+          body "Testing body #{x}"
+          message_id "TESTEMAIL::#{x}"
+        end)
+      end
+
+      Mail::TestRetriever.emails = Mail::TestMailer.deliveries if @conn.name == "test"
+      
+    end
+
+    it "should have 3 email messages ready for testing" do
+      @conn.retriever.find.size.should eql $NUM_TEST_EMAIL
+    end
+
+
+    describe "go" do
+      before :all do
+
+      end
+
+      it "should go" do
+        #lambda { ProcessEmail.go(@conn) }.should_not raise_error
+        begin
+          ProcessEmail.go(@conn)
+        rescue => e
+          ap e.message
+          ap e.backtrace
+        end
+        Mail::TestRetriever.emails.should be_empty
+      end
+
+    end
+
+    describe "flush" do
+      it "should flush" do
+        ProcessEmail.flush.should eql true
+      end
+    end
+
+
+
+
+
+  end
+end

data/spec/lib/kns_email_endpoint/storage/file_storage_spec.rb

@@ -0,0 +1,16 @@
+require 'lib/kns_email_endpoint'
+require 'spec/lib/kns_email_endpoint/storage/shared_storage'
+
+
+describe KNSEmailEndpoint::Storage::FileStorage do
+  storage_dir = "/tmp/kns_email_endpoint/test_file_storage"
+  FileUtils.mkdir_p storage_dir
+  settings = {
+    :file_location => storage_dir
+  }
+  storage = KNSEmailEndpoint::Storage.get_storage(:file, settings)
+
+  it_should_behave_like "a storage engine", storage
+
+
+end

data/spec/lib/kns_email_endpoint/storage/memcache_storage_spec.rb

@@ -0,0 +1,17 @@
+require 'lib/kns_email_endpoint'
+require 'spec/lib/kns_email_endpoint/storage/shared_storage'
+
+
+describe KNSEmailEndpoint::Storage::MemcacheStorage do
+  storage_dir = "/tmp/kns_email_endpoint/test_file_storage"
+  FileUtils.mkdir_p storage_dir
+  settings = {
+    :file_location => storage_dir
+  }
+  storage = KNSEmailEndpoint::Storage.get_storage(:memcache, settings)
+  storage.delete_all
+
+  it_should_behave_like "a storage engine", storage
+
+
+end

data/spec/lib/kns_email_endpoint/storage/shared_storage.rb

@@ -0,0 +1,65 @@
+shared_examples_for "a storage engine" do |storage|
+
+  test_unique_id = "a1235456789"
+
+  describe "CRUD" do
+    
+    it 'should delete a record' do
+      storage.find(test_unique_id)
+      if storage.unique_id
+        storage.delete.should eql true
+      end
+    end
+
+    it 'should create a new file' do
+      storage.create({
+        :unique_id => test_unique_id,
+        :message_id => "abcd"
+      })
+
+      storage.unique_id.should eql test_unique_id
+    end
+
+    it "should find a unique_id" do
+      s = storage.find(test_unique_id)
+      s.unique_id.should eql test_unique_id
+    end
+
+   
+    it "should return a valid message_id" do
+      storage.message_id.should eql 'abcd'
+    end
+
+    it "should increment the retry count" do
+      storage.retry_count = 1
+      storage.retry_count.should eql 1
+    end
+
+    it "should be able to set the state" do
+      storage.state = :finished
+      storage.state.should eql :finished
+    end
+
+    it "should use find_or_create method to create a row" do
+      alt_unique_id = 'b123456789'
+      s = storage.find_or_create({:unique_id => alt_unique_id, :message_id => 'abcd'})
+      s.unique_id.should eql alt_unique_id
+    end
+
+    it "should raise an error if unique_id is not provided" do
+      lambda {storage.find_or_create({:message_id => ""})}.
+        should raise_error
+    end
+
+    it "should raise an error if message_id is not provided" do
+      lambda {storage.find_or_create({:unique_id => "abc"})}.
+        should raise_error
+    end
+
+    it "should return nil if not found" do
+      s = storage.find('mombojombo')
+      s.should be_nil
+    end
+
+  end
+end

data/spec/lib/kns_email_endpoint/storage/storage_spec.rb

@@ -0,0 +1,14 @@
+require 'lib/kns_email_endpoint'
+
+
+describe KNSEmailEndpoint::Storage do
+  it "should get a FileStorage class" do
+    KNSEmailEndpoint::Storage.get_storage(:file, {:file_location => "/tmp"}).class.
+      should eql KNSEmailEndpoint::Storage::FileStorage
+  end
+
+  it "should get a MemcacheStorage class" do
+    KNSEmailEndpoint::Storage.get_storage(:memcache, {}).class.
+      should eql KNSEmailEndpoint::Storage::MemcacheStorage
+  end
+end

data/spec/test_config_file.yml

@@ -0,0 +1,65 @@
+logdir: /tmp/email_endpoint # Set to log directory
+logginglevel: debug # can be: debug, info, warn, error, fatal
+storage:
+     engine: memcache
+     host: localhost
+     port: 11211
+     ttl: nil # Time to live in seconds, nil = forever
+# Other storage example
+    # engine: file
+    # file_location: # location to store the message state, should be a directory. It will be created if it doesn't exist
+workthreads: 5 # Set to number of work threads based on observed performance of Kynetx application. *Warning* incorrectly setting this value to low/high can significantly impact performance of the application
+polldelayinseconds: 30 # Recommended setting is '30'
+connections:
+    - name: gmail # Connection name. Should be set to human readable name
+      appid: a18x34 # Appid of Kynetx application called to process email
+      appversion: dev #prod or dev - defaults to prod
+      processmode: repeat #repeat or single - defaults to single
+      specialgeneral: false #puts this connection into general mode - not for general use.
+      args: #optional arguments to publish with each mail recieved event
+          test_rule: parts
+          #arg2: value2
+      incoming:
+          method: imap # imap or pop3
+          host: imap.gmail.com #Hostname of the IMAP server (e.g. hostname.domain.tld)
+          username: kynetx.endpoint.test@gmail.com # Username for IMAP server
+          password: kynetx3mail # Password for IMAP server user
+          mailbox: INBOX # Name of mailbox being watched (e.g. INBOX)
+          port: 993
+          ssl: true
+      smtp:
+          method: smtp
+          host: smtp.gmail.com # Hostname of SMTP mail server (e.g. hostname.domain.tld)
+          username: kynetx.endpoint.test@gmail.com # Username for SMTP. *Note* only needed if SMTP authentication is turned on at SMTP - Check with email provider 
+          password: kynetx3mail # Password for SMTP user
+          port: 587 # SMTP port number *Note* usually this is set to port 25, but could be any port depending on email provider - Check with email provider
+          helo_domain: cpe.cableone.net # Domain name of sending domain *Note* this domain must match the domain of the sender and should be resolvable via DNS (i.e. don't make it up)
+          authentication: plain # can be login, plain, cram_md5, or it can be commented out if server doesn't require auth
+          tls: true
+      logfile: gmail.log # Name of logfile for this connection
+    - name: test 
+      appid: a18x34 
+      appversion: dev 
+      processmode: repeat 
+      max_retry_count: 3
+      args: 
+          test_rule: delete_me
+          #arg2: value2
+      incoming:
+          method: test
+          host: localhost
+          username: doesntmatter
+          password: doesntmatter
+          mailbox: INBOX
+          port: 0 
+          ssl: true
+      smtp:
+          method: test
+          host: localhost
+          username: doesntmatter
+          password: doesntmatter
+          port: 0
+          helo_domain: kynetx.com
+          authentication: plain 
+          tls: true
+      logfile: test.log 

data/spec/test_email.eml

@@ -0,0 +1,43 @@
+Delivered-To: mike.farmer.imap@gmail.com
+Received: by 10.220.178.141 with SMTP id bm13cs253841vcb;
+        Thu, 6 Jan 2011 13:54:52 -0800 (PST)
+Received: from mr.google.com ([10.227.146.149])
+        by 10.227.146.149 with SMTP id h21mr18229971wbv.43.1294350892087 (num_hops = 1);
+        Thu, 06 Jan 2011 13:54:52 -0800 (PST)
+Received: by 10.227.146.149 with SMTP id h21mr14739590wbv.43.1294350892052;
+        Thu, 06 Jan 2011 13:54:52 -0800 (PST)
+X-Forwarded-To: mike.farmer.imap@gmail.com
+X-Forwarded-For: mike.farmer@gmail.com mike.farmer.imap@gmail.com
+Delivered-To: mike.farmer+test@gmail.com
+Received: by 10.227.133.78 with SMTP id e14cs66419wbt;
+        Thu, 6 Jan 2011 13:54:51 -0800 (PST)
+Received: by 10.42.164.135 with SMTP id g7mr80494icy.504.1294350890863;
+        Thu, 06 Jan 2011 13:54:50 -0800 (PST)
+Return-Path: <mjf@kynetx.com>
+Received: from mail.kynetx.com (mail.kynetx.com [209.41.75.70])
+        by mx.google.com with ESMTP id r10si181340ict.24.2011.01.06.13.54.50;
+        Thu, 06 Jan 2011 13:54:50 -0800 (PST)
+Received-SPF: pass (google.com: domain of mjf@kynetx.com designates 209.41.75.70 as permitted sender) client-ip=209.41.75.70;
+Authentication-Results: mx.google.com; spf=pass (google.com: domain of mjf@kynetx.com designates 209.41.75.70 as permitted sender) smtp.mail=mjf@kynetx.com
+Received: from localhost (localhost.localdomain [127.0.0.1])
+	by mail.kynetx.com (Postfix) with ESMTP id E67511D7A26;
+	Thu,  6 Jan 2011 14:54:49 -0700 (MST)
+X-Virus-Scanned: amavisd-new at corpserver.kobj.net
+Received: from mail.kynetx.com ([127.0.0.1])
+	by localhost (mail.kynetx.com [127.0.0.1]) (amavisd-new, port 10024)
+	with ESMTP id KdeiV1dT7FrP; Thu,  6 Jan 2011 14:54:49 -0700 (MST)
+Received: from [192.168.1.133] (24-119-21-78.cpe.cableone.net [24.119.21.78])
+	by mail.kynetx.com (Postfix) with ESMTPSA id 707281D7A23;
+	Thu,  6 Jan 2011 14:54:47 -0700 (MST)
+From: Michael Farmer <mjf@kynetx.com>
+Content-Type: text/plain; charset=us-ascii
+Content-Transfer-Encoding: 7bit
+Subject: Please ignore this
+Date: Thu, 6 Jan 2011 14:54:45 -0700
+Message-Id: <76B78C79-F47D-4083-974B-6823F1CB86F4@kynetx.com>
+To: Sara Farmer <sarafarmer@gmail.com>,
+ mike.farmer+test@gmail.com
+Mime-Version: 1.0 (Apple Message framework v1082)
+X-Mailer: Apple Mail (2.1082)
+
+Just testing out my email endpoint. Just ignore this please :)