dm-imap-adapter 0.0.1

data/.gitignore

@@ -0,0 +1 @@
+pkg/*

data/README

@@ -0,0 +1,66 @@
+IMAP Adapter for DataMapper
+===========================
+
+There exist other implementations of an imap adapter but they are either not 0.10 compatible or I couldn't find a working version. Also, I am picky and want to do this right.
+
+Philosophy
+==========
+
+A resource is a mailbox. So you will probably end up with a Gmail::Inbox and a Gmail::Trash. To move an item to the trash you would resource.move_to(Gmail::Trash) [not implemented yet]. Various Types are provided to make it easier to work with the different things like From and To and CC and all of that. These also help with the queries [not implemented yet].
+
+Specs
+=====
+
+I use bacon. It's the best testing library that exists.
+
+gem install bacon
+
+bacon spec/dm-imap-adapter_spec.rb
+
+or use autotest (although I'm not sure I got that setup perfectly).
+
+The specs currently assume you have a test account with test as the password on localhost which has an INBOX. All emails in this inbox will be deleted, just like a test database.
+
+How to use
+==========
+
+Check the specs!
+
+Also, do this for your model:
+
+class Inbox
+  include DataMapper::Resource
+  include DataMapper::Types::Imap
+  
+  def self.default_repository_name
+    :test_inbox
+  end
+
+  property :uid, UID, :key => true # do we need :key here since UID is a serial?
+  property :message_id, MessageId
+  property :subject, Subject
+  property :sender, Sender
+  property :from, From
+  property :to, To
+  property :body, BodyText
+  property :raw_body, Body
+  property :date, InternalDate
+  property :envelope_date, EnvelopeDate
+  property :size, Size
+  property :sequence, Sequence
+end
+
+How can I help?
+===============
+
+Glad you asked!
+
+There are lots of things that don't work yet, mostly because I don't need them to (all I need is #all and #destroy). Here are the big things that don't work yet:
+
+* #update
+* #create should use update to set any attributes that can't be set during the initial append to the mailbox
+* Flags - a Type needs to be created that manages an array of symbols. Maybe base it off the Enum?
+* Searching should actually use the uid_search method and not rely on the in memory query filter. If you got 1000 emails in your inbox your currently screwed.
+* Figuring out why I had to hack net/imap so much to support dovecot on my machine. Seems strange that I had to open the class like that.
+* Extend other net/imap structs like the Address one.
+* Better specs!

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "dm-imap-adapter"
+    gemspec.summary = "An IMAP adapter for DM"
+    gemspec.description = "DataMapper IMAP adapter"
+    gemspec.email = "nathan@myobie.com"
+    gemspec.homepage = "http://github.com/myobie/dm-imap-adapter"
+    gemspec.authors = ["Nathan Herald"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/dm-imap-adapter.gemspec

@@ -0,0 +1,53 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dm-imap-adapter}
+  s.version = "0.0.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Nathan Herald"]
+  s.date = %q{2009-10-20}
+  s.description = %q{DataMapper IMAP adapter}
+  s.email = %q{nathan@myobie.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    ".gitignore",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "dm-imap-adapter.gemspec",
+     "lib/dm-imap-adapter.rb",
+     "lib/dm-imap-adapter/net_imap_ext.rb",
+     "lib/dm-imap-adapter/types.rb",
+     "spec/.bacon",
+     "spec/dm-imap-adapter_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/watchr.rb"
+  ]
+  s.homepage = %q{http://github.com/myobie/dm-imap-adapter}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{An IMAP adapter for DM}
+  s.test_files = [
+    "spec/dm-imap-adapter_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/watchr.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
+    else
+    end
+  else
+  end
+end
+

data/lib/dm-imap-adapter/net_imap_ext.rb

@@ -0,0 +1,45 @@
+require 'net/imap'
+
+class Net::IMAP::ResponseParser
+  def resp_text_code
+    @lex_state = EXPR_BEG
+    match(T_LBRA)
+    token = match(T_ATOM)
+    name = token.value.upcase
+    case name
+    when /\A(?:ALERT|PARSE|READ-ONLY|READ-WRITE|TRYCREATE|NOMODSEQ|CLOSED)\z/n
+      result = Net::IMAP::ResponseCode.new(name, nil)
+    when /\A(?:PERMANENTFLAGS)\z/n
+      match(T_SPACE)
+      result = Net::IMAP::ResponseCode.new(name, flag_list)
+    when /\A(?:UIDVALIDITY|UIDNEXT|UNSEEN)\z/n
+      match(T_SPACE)
+      result = Net::IMAP::ResponseCode.new(name, number)
+    else
+      # match(T_SPACE)
+      ### start new
+      if match(T_SPACE, T_RBRA).symbol == T_RBRA
+        @lex_state = EXPR_RTEXT
+        return Net::IMAP::ResponseCode.new(name, nil)
+      end
+      ### end new
+      @lex_state = EXPR_CTEXT
+      token = match(T_TEXT)
+      @lex_state = EXPR_BEG
+      result = Net::IMAP::ResponseCode.new(name, token.value)
+    end
+    match(T_RBRA)
+    @lex_state = EXPR_RTEXT
+    return result
+  end
+end
+
+class Net::IMAP::Address
+  def email
+    "#{mailbox}@#{host}"
+  end
+  
+  def to_s
+    "#{name} <#{email}>".strip
+  end
+end

data/lib/dm-imap-adapter/types.rb

@@ -0,0 +1,209 @@
+module DataMapper
+  module Types
+    module Imap
+      module NetIMAPAddressType
+        def self.load(value, property)
+          typecast(value, property)
+        end
+        
+        def self.dump(value, property)
+          typecast(value, property)
+        end
+        
+        def self.typecast(value, property)
+          if value.nil? || value.empty?
+            []
+          else
+            # TODO: don't just test the first element of the array
+            if value.is_a?(Array) && value.first.is_a?(Net::IMAP::Address)
+              value
+            else
+              value = [value].flatten
+              
+              value.map do |val|
+              
+                if val =~ /<.*>$/
+                  matches = val.match(/(.*)<(.*)@(.*)>/)
+                  if matches
+                    n = Net::IMAP::Address.new
+                    n.name = matches[0].strip
+                    n.mailbox = matches[1].strip
+                    n.host = matches[2].strip
+                    n
+                  else
+                    nil
+                  end#matches
+                else
+                  matches = val.split "@"
+                  if matches
+                    n = Net::IMAP::Address.new
+                    n.mailbox = matches[0].strip
+                    n.host = matches[1].strip
+                    n
+                  else
+                    nil
+                  end#matches
+                end#val =~
+                
+              end.compact #end of each
+            end#value.is_a?
+          end#if value.nil?
+        end#self.typecast
+      end#Net::
+    end#Imap
+  end#Types
+end#DataMapper
+
+module DataMapper
+  module Types
+    
+    module Imap
+      
+      class ImapType < DataMapper::Type
+        class << self
+          attr_reader :query_details, :envelope_name, :attr_name, :method_name
+          
+          def imap_query(name)
+            @query_details = name
+          end
+          
+          def envelope(name)
+            attr "ENVELOPE"
+            @envelope_name = name
+          end
+          
+          def envelope?
+            !!@envelope_name
+          end
+          
+          def attr(name)
+            meth :attr
+            @attr_name = name
+          end
+          
+          def meth(name)
+            @method_name = name
+          end
+          
+          def attr?
+            !!@attr_name
+          end
+        end
+      end#ImapType
+      
+      class Sequence < ImapType
+        primitive Integer
+        meth :seqno
+      end
+      
+      class Uid < ImapType
+        primitive Integer
+        serial true
+        min 1
+        attr "UID"
+        imap_query(:eql => ["UID"], :like => ["UID"])
+      end
+      UID = Uid
+      
+      class BodyText < ImapType
+        primitive String
+        attr "RFC822.TEXT"
+        imap_query(:eql => ["BODY"], :like => ["BODY"])
+      end
+      
+      class Body < ImapType
+        primitive String
+        attr "RFC822"
+        imap_query(:eql => ["RFC822"], :like => ["RFC822"])
+      end
+      
+      class InternalDate < ImapType
+        primitive DateTime
+        attr "INTERNALDATE"
+        imap_query(:lt => ["BEFORE"], :eql => ["ON"], :gt => ["SINCE"])
+      end
+
+      class EnvelopeDate < ImapType
+        primitive DateTime
+        envelope :date
+        imap_query(:lt => ["SENTBEFORE"], :eql => ["SENTON"], :gt => ["SENTSINCE"])
+      end
+
+      class Size < ImapType
+        primitive Integer
+        attr "RFC822.SIZE"
+        imap_query(:lt => ["SMALLER"], :gt => ["LARGER"])
+      end
+
+      class Header < ImapType
+        primitive String
+        attr "RFC822.HEADER"
+        imap_query(:eql => ["HEADER"])
+      end
+      
+      class From < ImapType
+        primitive ::Object
+        envelope :from
+        imap_query(:eql => ["FROM"], :like => ["FROM"])
+        include DataMapper::Types::Imap::NetIMAPAddressType
+      end
+      
+      class Sender < ImapType
+        primitive ::Object
+        envelope :sender
+        imap_query(:eql => ["HEADER", "Sender"], :like => ["HEADER", "Sender"])
+        include DataMapper::Types::Imap::NetIMAPAddressType
+      end
+      
+      class ReplyTo < ImapType
+        primitive ::Object
+        envelope :reply_to
+        imap_query(:eql => ["HEADER", "Reply-To"], :like => ["HEADER", "Reply-To"])
+        include DataMapper::Types::Imap::NetIMAPAddressType
+      end
+      
+      class Cc < ImapType
+        primitive ::Object
+        envelope :cc
+        imap_query(:eql => ["CC"], :like => ["CC"])
+        include DataMapper::Types::Imap::NetIMAPAddressType
+      end
+      CC = Cc
+      
+      class To < ImapType
+        primitive ::Object
+        envelope :to
+        imap_query(:eql => ["TO"], :like => ["TO"])
+        include DataMapper::Types::Imap::NetIMAPAddressType
+      end
+      
+      class Bcc < ImapType
+        primitive ::Object
+        envelope :bcc
+        imap_query(:eql => ["BCC"], :like => ["BCC"])
+        include DataMapper::Types::Imap::NetIMAPAddressType
+      end
+      BCC = Bcc
+      
+      class Subject < ImapType
+        primitive String
+        envelope :subject
+        imap_query(:eql => ["SUBJECT"], :like => ["SUBJECT"])
+      end
+      
+      class InReplyTo < ImapType
+        primitive String
+        envelope :in_reply_to
+        imap_query(:eql => ["HEADER", "In-Reply-To"], :like => ["HEADER", "In-Reply-To"])
+      end
+      
+      class MessageId < ImapType
+        primitive String
+        envelope :message_id
+        imap_query(:eql => ["HEADER", "Message-ID"], :like => ["HEADER", "Message-ID"])
+      end
+      
+    end#Imap
+    
+  end#Types
+end#DataMapper

data/lib/dm-imap-adapter.rb

@@ -0,0 +1,174 @@
+require 'dm-core'
+require 'net/imap'
+require File.dirname(__FILE__) + '/dm-imap-adapter/net_imap_ext'
+require File.dirname(__FILE__) + '/dm-imap-adapter/types'
+
+### Hack for frozen object problem
+
+module DataMapper
+  module Resource
+    def original_attributes
+      @original_attributes || {} # Fix for frozen crap
+    end
+  end
+end
+
+###
+
+module DataMapper
+  module Adapters
+    
+    class ImapAdapter < AbstractAdapter
+      
+      def create(resources)
+        resources.map do |resource|
+          with_connection(resource.model) do |connection|
+            
+            last_email = connection.uid_fetch(-1, "UID")
+            if last_email
+              next_uid = last_email.first.attr[:UID].to_i
+            else
+              next_uid = 1
+            end
+            
+            initialize_serial(resource, next_uid)
+            
+#             email_text = <<EOT.gsub(/\n/, "\r\n")
+# Subject: #{resource.subject}
+# From: #{resource.from}
+# To: #{resource.to}
+# 
+# #{resource.body}
+# EOT
+#             
+            email_text = ""
+            
+            email_text << "Subject: #{resource.subject}\n" if resource.respond_to?(:subject)
+            email_text << "From: #{resource.from}\n" if resource.respond_to?(:from)
+            email_text << "To: #{resource.to}\n" if resource.respond_to?(:to)
+            email_text << "\n#{resource.body}" if resource.respond_to?(:body)
+            
+            email_text = email_text.gsub(/\n/, "\r\n")
+            
+            if resource.respond_to?(:date)
+              date = resource.date
+            else
+              date = Time.now
+            end
+            
+            if resource.respond_to?(:flags)
+              flags = resources.flags
+            else
+              flags = []
+            end
+            
+            connection.append(@options[:path].gsub(%r{^/}, ""), email_text, flags, date)
+            
+          end
+        end.size
+      end
+      
+      def read(query)
+        with_connection(query.model) do |connection|
+          
+          attr_props = query.model.properties.select { |prop| prop.type.attr? }
+          attrs = attr_props.collect { |prop| prop.type.attr_name }.compact.uniq
+          
+          # TODO: don't do 1..-1, but instead do a search and then fetch the uids returned
+          uids = 1..-1
+          
+          # if query.conditions
+          #   query_array = []
+          #   debugger
+          #   query.conditions.each do |op, property, value|
+          #     query_array += (property.type.query_details[op] + [value])
+          #   end
+          #   uids = connection.uid_search(query_array)
+          # else
+          #   uids = 1..-1
+          # end
+          
+          mails = connection.uid_fetch(uids, attrs) || []
+          
+          results = materialize_records_for(query.model, mails)
+          query.filter_records(results.dup)
+          # results.dup
+          
+        end#with_connection
+      end#read
+
+      def update(attributes, collection)
+        raise NotImplemented
+      end
+
+      def delete(collection)
+        with_connection(collection.query.model) do |connection|
+          connection.uid_store(collection.collect { |record| record.uid }, "+FLAGS", [:Deleted])
+          connection.expunge
+        end
+      end
+
+      private
+
+      def initialize(name, options = {})
+        super
+        # @connection = create_connection
+      end
+      
+    protected
+      def create_connection(model)
+        args = [@options[:host], @options[:port], @options[:ssl]].compact
+        imap = Net::IMAP.new(*args)
+        begin
+          imap.authenticate "login"
+        rescue
+        ensure
+          imap.login(@options[:user], @options[:password])
+        end
+        mailbox = @options[:path].gsub(%r{^/}, "")
+        imap.select(mailbox) rescue raise("Mailbox #{mailbox} not found")
+        imap
+      end
+      
+      def with_connection(model)
+        begin
+          connection = create_connection(model)
+          return yield(connection)
+        rescue => error
+          DataMapper.logger.error(error.to_s)
+          raise error
+        ensure
+          close_connection(connection) if connection
+        end
+      end
+      
+      def close_connection(connection)
+        connection.disconnect
+      end
+      
+      def materialize_records_for(model, mails)
+        # Array
+        mails.collect do |mail|
+          # of Hashes (one hash per loop)
+          model.properties.inject({}) do |hash, prop|
+            hash[prop.field] = mail.send(prop.type.method_name.to_sym)
+            
+            if prop.type.attr?
+              hash[prop.field] = hash[prop.field][prop.type.attr_name]
+            end#if
+            
+            if prop.type.envelope?
+              hash[prop.field] = hash[prop.field][prop.type.envelope_name]
+            end
+            
+            hash
+          end#inject
+        end#collect
+      end#materialize_records_for
+      
+    end#ImapAdapter
+    
+    const_added(:ImapAdapter)
+    
+  end#Adapters
+end#DataMapper

data/spec/dm-imap-adapter_spec.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+class LocalInbox
+  include DataMapper::Resource
+  include DataMapper::Types::Imap
+  
+  def self.default_repository_name
+    :test_inbox
+  end
+
+  property :uid, UID, :key => true
+  property :message_id, MessageId
+  property :subject, Subject
+  property :sender, Sender
+  property :from, From
+  property :to, To
+  property :body, BodyText
+  property :raw_body, Body
+  property :date, InternalDate
+  property :envelope_date, EnvelopeDate
+  property :size, Size
+  property :sequence, Sequence
+end
+
+describe DataMapper::Adapters::ImapAdapter do
+  
+  before do
+    LocalInbox.all.map { |l| l.destroy }
+
+    LocalInbox.create :to => "test@localhost",
+                      :from => "Me <me@example.com>",
+                      :subject => "Test email 1",
+                      :body => "Hello there, how are you?"
+
+    LocalInbox.create :to => "test@localhost",
+                      :from => "me@example.com",
+                      :subject => "Test email 2 boo ya",
+                      :body => "Hi,\n\nTest."
+                      
+    LocalInbox.create :to => "test@localhost",
+                      :from => "Me <me@example.com>",
+                      :subject => "Test email 3",
+                      :body => "Hello there."
+
+    LocalInbox.create :to => "test@localhost",
+                      :from => "me@example.com",
+                      :subject => "Test email 4 rabbit",
+                      :body => "Hi,\n\nHow's it going?\n\nGive us a call.\n\nTest."
+  end
+  
+  should "successfully connect to the local imap server" do
+    lambda { LocalInbox.all }.should.not.raise
+  end
+  
+  should "have two emails in the inbox" do
+    LocalInbox.all.length.should == 4
+  end
+  
+  should "know who sent the email" do
+    LocalInbox.first.from.first.name.should == "Me"
+    LocalInbox.first.from.first.email.should == "me@example.com"
+    LocalInbox.first.from.first.to_s.should == "Me <me@example.com>"
+  end
+  
+  should "know how the email was sent to" do
+    LocalInbox.first.to.first.to_s.should == "<test@localhost>"
+  end
+  
+  should "create a new email" do
+    lambda { 
+      LocalInbox.create(:to => "test", :from => "test", :subject => "Test", :body => "Test")
+    }.should.increase { LocalInbox.all.length }
+  end
+  
+  should "destroy an email" do
+    lambda { LocalInbox.first.destroy }.should.decrease { LocalInbox.all.length }
+  end
+  
+  should "find the email with the subject containing 'rabbit'" do
+    LocalInbox.first(:subject.like => "rabbit").subject.should == "Test email 4 rabbit"
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,71 @@
+require "dm-core"
+require "bacon"
+require "mocha"
+require File.dirname(__FILE__) + "/../lib/dm-imap-adapter"
+
+DataMapper.setup(:test_inbox, "imap://test:test@localhost/INBOX")
+
+class Proc
+  def increase?
+    pre_result = yield
+    called = call
+    post_result = yield
+    pre_result < post_result
+  end
+  
+  def decrease?
+    pre_result = yield
+    called = call
+    post_result = yield
+    pre_result > post_result
+  end
+end
+
+# from 1 to 10 how likely, 1 being not very likely and 10 being all the time
+def do_i?(i = 5)
+  rand(500) < 50 * i
+end
+
+
+
+
+##
+# Hash additions.
+#
+# From 
+#   * http://wincent.com/knowledge-base/Fixtures_considered_harmful%3F
+#   * Neil Rahilly
+
+class Hash
+
+  ##
+  # Filter keys out of a Hash.
+  #
+  #   { :a => 1, :b => 2, :c => 3 }.except(:a)
+  #   => { :b => 2, :c => 3 }
+
+  def except(*keys)
+    self.reject { |k,v| keys.include?(k || k.to_sym) }
+  end
+
+  ##
+  # Override some keys.
+  #
+  #   { :a => 1, :b => 2, :c => 3 }.with(:a => 4)
+  #   => { :a => 4, :b => 2, :c => 3 }
+  
+  def with(overrides = {})
+    self.merge overrides
+  end
+
+  ##
+  # Returns a Hash with only the pairs identified by +keys+.
+  #
+  #   { :a => 1, :b => 2, :c => 3 }.only(:a)
+  #   => { :a => 1 }
+  
+  def only(*keys)
+    self.reject { |k,v| !keys.include?(k || k.to_sym) }
+  end
+
+end

data/spec/watchr.rb

@@ -0,0 +1,39 @@
+# Run me with:
+#
+#   $ watchr spec/watchr.rb
+
+# --------------------------------------------------
+# Convenience Methods
+# --------------------------------------------------
+def all_test_files
+  Dir['spec/**/*_spec.rb']
+end
+
+def run(cmd)
+  puts(cmd)
+  system(cmd)
+end
+
+def run_all_tests
+  cmd = "bacon '%w( #{all_test_files.join(' ')} ).each {|file| require file }'"
+  run(cmd)
+end
+
+# --------------------------------------------------
+# Watchr Rules
+# --------------------------------------------------
+watch( '^spec.*/.*_spec\.rb'   )   { |m| run( "bacon %s"                     % m[0] ) }
+watch( '^lib/(.*)\.rb'         )   { |m| run( "bacon spec/%s_spec.rb" % m[1] ) }
+watch( '^spec/spec_helper\.rb' )   { run_all_tests }
+
+# --------------------------------------------------
+# Signal Handling
+# --------------------------------------------------
+# Ctrl-\
+Signal.trap('QUIT') do
+  puts " --- Running all tests ---\n\n"
+  run_all_tests
+end
+
+# Ctrl-C
+Signal.trap('INT') { abort("\n") }

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: dm-imap-adapter
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nathan Herald
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-20 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: DataMapper IMAP adapter
+email: nathan@myobie.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- README
+- Rakefile
+- VERSION
+- dm-imap-adapter.gemspec
+- lib/dm-imap-adapter.rb
+- lib/dm-imap-adapter/net_imap_ext.rb
+- lib/dm-imap-adapter/types.rb
+- spec/.bacon
+- spec/dm-imap-adapter_spec.rb
+- spec/spec_helper.rb
+- spec/watchr.rb
+has_rdoc: true
+homepage: http://github.com/myobie/dm-imap-adapter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: An IMAP adapter for DM
+test_files: 
+- spec/dm-imap-adapter_spec.rb
+- spec/spec_helper.rb
+- spec/watchr.rb