email_pop_reader 0.0.1

data/README

@@ -0,0 +1,45 @@
+Author
+====
+Niranjan Sarade
+
+About the utility - EmailPopReader
+====
+POP3 (Post Office Protocol) is the standard client/server protocol to receive emails.
+In ruby, we have a libray called Net::POP3 which provides functionality for retrieving 
+email via POP3. In that, you basically start the pop session for accessing the emails
+and close the pop session at the end.
+
+TMail library has a complete way to handle and manipulate emails from within ruby code.
+It allows you to treat an email totally as an object.
+
+There can be a business requirement for scanning emails and storing those in some sort of data structure to process further.
+This utility makes use of Net::POP3 and TMail libraries and provides with some handy methods such as 
+'retrieve emails' as array of hashes. The hash has email's from,to,cc,bcc,subject,body fields. Email body with attachment has not been considered
+for simplicity.
+
+It also provides 'delete_emails(unique_email_ids=[])' method which takes array of unique email ids (retrieved with pop email unique_id) as parameter
+and deletes those.
+
+This gem has a TMail gem dependency.
+
+Example
+====
+
+You can set the following three valiables in either environment.rb file in RAILS application or as global constants.
+POP_HOST
+POP_USERNAME
+POP_PASSWORD
+
+pop_reader = EmailPopReader.new
+emails = pop_reader.retrieve_emails
+pop_reader.delete_emails <array of email unique ids to be deleted>
+
+Install
+====
+gem install http://github.com/NiranjanSarade/email-pop-reader.git/
+
+Uninstall
+====
+gem uninstall email_pop_reader
+
+

data/lib/email_pop_reader.rb

@@ -0,0 +1,87 @@
+require 'tmail'
+require 'net/pop'
+
+class EmailPopReader
+  
+  def initialize
+    @pop = Net::POP.new(POP_HOST)
+  end
+  
+  def retrieve_emails
+    ids, emails, email_list = Array.new, Array.new, Array.new
+    begin      
+      @pop.start(POP_USERNAME, POP_PASSWORD) do |pop|
+        if pop.mails.empty?
+          puts "No new email is received "
+        else  
+          pop.each_mail do |m|
+            begin
+              ids << m.unique_id
+              emails << TMail::Mail.parse(m.pop)
+            rescue Exception => e
+              log_exception e
+            end
+          end
+          puts "#{@pop.mails.size} mails read."
+        end    
+      end
+      unless emails.empty?
+        email_list = store_emails emails, ids
+      end    
+    rescue Exception => excep
+      puts "There may be some problem with pop3 connectivity."
+      log_exception excep
+    end   
+    email_list
+  end      
+ 
+  def delete_emails uid_array=[]
+      begin
+        @pop.start(POP_USERNAME, POP_PASSWORD) do |pop|
+          pop.mails.select { |m| need_pop?(uid_array, m.unique_id) }.each do |m|
+              puts "deleting mail with id #{m.unique_id}"
+              m.delete
+          end
+        end
+      rescue => excep
+        log_exception excep
+      end   
+   end
+  
+  private
+    
+  def store_emails mails, ids
+    count = 0
+    mails.collect { |email|
+      email_hash = Hash.new
+      begin
+        email_hash['body'] = email.body
+        email_hash['date_sent'] = email.date
+        email_hash['subject'] = email.subject
+        email_hash['from'] = email.from
+        email_hash['to'] = !email.to ? [] : email.to
+        email_hash['cc'] = !email.cc ? [] : email.cc
+        email_hash['bcc'] = !email.bcc ? [] : email.bcc
+      rescue Exception => e
+        puts "There is exception while parsing email fields."
+        log_exception e
+      end
+      email_hash['unique_id'] = ids[count]
+      count = count + 1
+      email_hash
+    }
+  end
+  
+  def need_pop?(uid_array, id)
+    uid_array.include?(id)
+  end
+  
+  def log_exception excep
+    puts excep.class.name
+    puts excep.message
+    puts excep.backtrace.join("\n") if excep.backtrace
+  end
+  
+end
+
+ 

data/spec/lib/email_pop_reader_spec.rb

@@ -0,0 +1,53 @@
+require 'ostruct'
+require File.expand_path(File.dirname(__FILE__) + "/../../lib/email_pop_reader")
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe EmailPopReader do
+  POP_HOST = "test"
+  POP_USERNAME = "test"
+  POP_PASSWORD = "test"
+  
+  before(:each) do
+    Net::POP.expects(:new).with(POP_HOST).returns(@pop3 = mock("pop"))
+    @pop_reader = EmailPopReader.new
+  end
+
+  it "should throw error and should not retrieve mail if failed to open TCP connection" do
+    @pop3.expects(:start).with(POP_USERNAME,POP_PASSWORD).raises("Authentication error")
+    @pop_reader.retrieve_emails.should == []
+  end
+  
+  it "should not throw error and should retrieve zero mails" do
+    @pop3.expects(:start).with(POP_USERNAME,POP_PASSWORD).yields(popmail = mock("popmail"))
+    popmail.expects(:mails).returns([])
+    @pop_reader.retrieve_emails.should == []
+  end
+  
+  it "should not throw error and should retrieve a mail" do
+    @pop3.expects(:start).with(POP_USERNAME,POP_PASSWORD).yields(popmail = mock("popmail"))
+    @pop3.expects(:mails).returns(["mail1"])
+    popmail.expects(:mails).returns(["mail1"])
+    popmail.expects(:each_mail).yields(mail = mock("mail"))
+    mail.expects(:unique_id).returns("12")
+    mail.expects(:pop).returns(true)
+    email = OpenStruct.new({'to' => 'address@domain.com', 'cc' => '', 'bcc' => '', 'from' => 'add@domain.com', 'date_sent' => Time.now, 'subject' => 'subject' })
+    TMail::Mail.expects(:parse).with(true).returns(email)
+    @pop_reader.retrieve_emails.size.should == 1
+  end
+  
+  it "should not throw error and should delete a mail" do
+    @pop3.expects(:start).with(POP_USERNAME,POP_PASSWORD).yields(popmail = mock("popmail"))
+    mail = mock("mail")
+    mail.expects(:unique_id).returns("12").times(2)
+    popmail.expects(:mails).returns([mail])
+    mail.expects(:delete).returns(true)
+    @pop_reader.delete_emails(["12"]).should be_nil
+  end
+  
+  it "should not delete a mail if it throws error" do
+    @pop3.expects(:start).with(POP_USERNAME,POP_PASSWORD).raises("Authentication error")
+    @pop_reader.delete_emails(["12"]).should be_nil
+  end
+  
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+gem 'rspec'
+require 'spec'
+require 'spec/autorun'
+gem 'mocha'
+require 'mocha'
+
+Spec::Runner.configure do |config|
+  config.mock_with :mocha
+end
+

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification 
+name: email_pop_reader
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Niranjan Sarade
+autorequire: email_pop_reader
+bindir: bin
+cert_chain: []
+
+date: 2010-01-19 00:00:00 +05:30
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: tmail
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3.1
+    version: 
+description: 
+email: nirusuma@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- ./README
+files: 
+- lib/email_pop_reader.rb
+- ./README
+has_rdoc: true
+homepage: http://github.com/NiranjanSarade/email-pop-reader
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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.5
+signing_key: 
+specification_version: 3
+summary: A utility in ruby to read the emails from pop3 as array of hashes and delete emails with specified email unique ids
+test_files: 
+- spec/spec_helper.rb
+- spec/lib/email_pop_reader_spec.rb