animoto_gmail 0.0.1

data/Manifest

@@ -0,0 +1,7 @@
+Manifest
+README
+Rakefile
+animoto_gmail.gemspec
+lib/gmail.rb
+test/gmail_test.rb
+test/test_helper.rb

data/README

@@ -0,0 +1,50 @@
+ABOUT
+-----
+This Ruby gem wraps around Net::IMAP and TMail to provide GMail functionality.
+
+AUTHOR
+------
+Animoto.com
+
+INSTALL
+-------
+
+This gem is hosted on gemcutter.org. You must install the gemcutter gem and add it as a repository.
+sudo gem install gemcutter
+gem tumble
+
+USAGE
+-----
+
+gem 'animoto_gmail', :lib => "gmail"
+require 'gmail'
+
+Animoto::GMail.logger = Logger.new(STDOUT)
+gmail = Animoto::GMail.new(EMAIL, PASSWORD)
+conditions = {:subject => SUBJECT, :since => "1-Dec-2009", :before => "2-Dec-2009"}
+messages = gmail.search(:conditions => conditions, :full_message => true, :limit => 10)
+puts "MESSAGE COUNT #{messages.size}"
+messages.each { |m|
+  # DO WHAT YOU GOTTA DO
+}
+
+Please review IMAP RFC for parameters for searching.
+http://ruby-doc.org/stdlib/libdoc/net/imap/rdoc/classes/Net/IMAP.html#M000738
+
+:limit is an optional argument to limit the number of fetches done on subsequent calls to retrieve the email body. Without this argument, every message from the search will be fetched.
+
+TESTING
+-------
+Tests can be executed via:
+
+rake test
+
+There is a simple test. To test yourself, please enable INTEGRATION and add your gmail email and password to the test file.
+
+VERSION HISTORY
+---------------
+.0.0.1 - Initial gem-ification process of original code.
+
+TO DO
+-----
+

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('animoto_gmail', '0.0.1') do |p|
+  p.description    = "Ruby Gmail Client over IMAP."
+  p.url            = "http://animoto.com"
+  p.author         = "Animoto"
+  p.email          = "theteam@animoto.com"
+  p.ignore_pattern = ["tmp/*", "script/*"]
+  p.runtime_dependencies = ["tmail", "activesupport", "logging"]
+end

data/animoto_gmail.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{animoto_gmail}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Animoto"]
+  s.date = %q{2009-12-02}
+  s.description = %q{Ruby Gmail Client over IMAP.}
+  s.email = %q{theteam@animoto.com}
+  s.extra_rdoc_files = ["README", "lib/gmail.rb"]
+  s.files = ["Manifest", "README", "Rakefile", "animoto_gmail.gemspec", "lib/gmail.rb", "test/gmail_test.rb", "test/test_helper.rb"]
+  s.homepage = %q{http://animoto.com}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Animoto_gmail", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{animoto_gmail}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby Gmail Client over IMAP.}
+  s.test_files = ["test/gmail_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<tmail>, [">= 0"])
+      s.add_runtime_dependency(%q<activesupport>, [">= 0"])
+      s.add_runtime_dependency(%q<logging>, [">= 0"])
+    else
+      s.add_dependency(%q<tmail>, [">= 0"])
+      s.add_dependency(%q<activesupport>, [">= 0"])
+      s.add_dependency(%q<logging>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<tmail>, [">= 0"])
+    s.add_dependency(%q<activesupport>, [">= 0"])
+    s.add_dependency(%q<logging>, [">= 0"])
+  end
+end

data/lib/gmail.rb

@@ -0,0 +1,91 @@
+require 'logger'
+require 'net/imap'        #ruby imap connector
+require 'tmail'           #ruby email parser
+require 'activesupport'   #for cattr_accessor
+ 
+# Animoto::GMail
+# Search for messages in a gmail account using the IMAP interface
+# 
+# To initialize:
+#   theguys = Animoto::GMail.new('theguys@animoto.com', 'theguys_password')
+# 
+# To search:
+#   conditions = {  :subject => 'Animoto for Education Application',
+#                   :since => Time.now.utc - 1.day }
+#   msgs = theguys.search( :conditions => conditions, :full_message => true )
+ 
+module Animoto
+  class GMail
+    cattr_accessor :logger
+    attr_accessor :imap
+    
+    def logger
+      self.class.logger
+    end
+        
+    # connects to gmail server and selects the global mailbox
+    def initialize(login, password, mailbox = "[Gmail]/All Mail")
+      @messages = []   
+      @messages_mutex = Mutex.new
+      
+      # connect to gmail server
+      @imap = Net::IMAP.new('imap.gmail.com', 993, true)
+      @imap.login(login, password)
+      
+      # select the mailbox with "all" messages
+      @imap.select(mailbox)    # tag to select         
+    end
+ 
+    # clean interface for searching an imap mailbox
+    # accepts a conditions hash with search options
+    def search(options)
+      conditions = options.delete(:conditions) || {}
+      mailbox = conditions.delete(:label)
+      @imap.select( mailbox ) if mailbox
+ 
+      # allow user to pass in custom clause
+      custom = conditions.delete(:custom) || []
+      
+      # validate search flags
+      # http://tools.ietf.org/html/rfc3501#section-6.4.4
+      valid_flags = %w(before body cc from label new not or on since subject to)
+      if bad_flag = conditions.keys.detect{ |flag| !valid_flags.include?(flag.to_s) }
+        raise ArgumentError, "Invalid search flag '#{bad_flag}'"
+      end
+ 
+      # imap requires search params to be in a flattened array
+      # e.g. ['TO', 'stevie@animoto.com', 'BEFORE', Time.now]
+      keys = [ *conditions.map{|k,v| [k.to_s.upcase, v] }.flatten ] + custom 
+      logger.info { "Executing IMAP search with #{keys.join(',')}" }
+      msg_ids = @imap.search(keys)
+      msg_ids = msg_ids[0, options[:limit].to_i] unless options[:limit].nil?
+      retrieve_messages(msg_ids, !!options[:full_message])
+    end
+    
+    private
+    
+    # retrieve all messages
+    # will return TMail::Mail objects for full messages,
+    # and Net::IMAP::Envelope objects for headers only
+    def retrieve_messages(msg_ids, full_message = false)
+      if full_message 
+        raw_msgs = @imap.fetch(msg_ids, 'RFC822')
+        messages = raw_msgs.map { |msg|
+          TMail::Mail.parse(msg.attr['RFC822'])
+        }
+      else
+        raw_msgs = @imap.fetch(msg_ids, 'ENVELOPE')
+        messages = raw_msgs.map{ |msg| msg.attr['ENVELOPE'] }
+      end
+      messages
+    end
+    
+  end
+end
+ 
+# helper extension for getting email address
+class Net::IMAP::Address
+  def email
+    "#{mailbox}@#{host}"
+  end
+end

data/test/gmail_test.rb

@@ -0,0 +1,28 @@
+require 'test_helper'
+require 'gmail'
+require 'gmail_util'
+
+class GMailTest < Test::Unit::TestCase
+  EMAIL = "PUT YOUR GMAIL EMAIL HERE"
+  PASSWORD = "PUT YOUR GMAIL PASSWORD HERE"
+  INTEGRATION = false
+
+  def test_gmail_search
+    return if !INTEGRATION
+    Animoto::GMail.logger = Logger.new(STDOUT)
+    gmail = Animoto::GMail.new(EMAIL, PASSWORD)
+    conditions = {:subject => "Contact [Account Inquiry] from Debora Daniel"}
+    messages = gmail.search(:conditions => conditions, :full_message => true, :limit => 1)
+    assert_not_nil messages
+    assert_equal messages.size, 1
+  end
+
+  def test_gmail_search_2
+    return if !INTEGRATION
+    Animoto::GMail.logger = Logger.new(STDOUT)
+    gmail = Animoto::GMail.new(EMAIL, PASSWORD)    
+    conditions = {:subject => "Returned mail: see transcript for details"}
+    messages = gmail.search(:conditions => conditions, :full_message => true, :limit => 100)
+    assert_not_nil messages
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require 'rubygems'

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: animoto_gmail
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Animoto
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-02 00:00:00 -05:00
+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: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: logging
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Ruby Gmail Client over IMAP.
+email: theteam@animoto.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- lib/gmail.rb
+files: 
+- Manifest
+- README
+- Rakefile
+- animoto_gmail.gemspec
+- lib/gmail.rb
+- test/gmail_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://animoto.com
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Animoto_gmail
+- --main
+- README
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: animoto_gmail
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby Gmail Client over IMAP.
+test_files: 
+- test/gmail_test.rb
+- test/test_helper.rb