rexchange 0.1.4 → 0.2.0

data/CHANGELOG

@@ -1,3 +1,9 @@
+-- 0.2.0:
+* Fixed a bug in Message#move_to when passing folders
+* Added support for Contact browsing
+* Added GenericItem to abstract Contacts and Messages
+* Renamed Folder#messages to Folder#get_messages to avoid naming collisions
+
 -- 0.1.4:
 * Moved Folder::normalize_folder_name to String#normalize, and added support for MixedCase sources.
 * Fixed a bug where the normalized folder name was being used for the Folder#to_s result.

data/RAKEFILE

@@ -7,7 +7,7 @@ require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 require 'pscp'
 
-PACKAGE_VERSION = '0.1.4'
+PACKAGE_VERSION = '0.2.0'
 
 PACKAGE_FILES = FileList[
   'README',

data/lib/r_exchange.rb

@@ -0,0 +1,2 @@
+# Provided for compatibility with RubyOnRails auto-require functionality.
+require 'rexchange'

data/lib/rexchange.rb

@@ -1,8 +1,22 @@
 require 'rexchange/session'
 
+class String
+  def ends_with?(partial)
+    self[self.size - partial.size..self.size] == partial
+  end
+  
+  def ensure_ends_with(partial)
+    self.ends_with?(partial) ? self : self + partial
+  end
+  
+  def normalize
+    self.split(/(?=[A-Z][a-z]*)/).join('_').tr('- ', '_').squeeze('_').downcase
+  end
+end 
+
 module RExchange
   # Use STDOUT or another stream if you'd like to capture the HTTP debug output
-  DEBUG_STREAM = nil
+  DEBUG_STREAM = $log
   
   # A shortcut to RExchange::Session#new's block syntax
   def self.open(uri, options = {})

data/lib/rexchange/contact.rb

@@ -0,0 +1,45 @@
+require 'rexchange/generic_item'
+
+module RExchange
+  class Contact < GenericItem
+    
+    attribute_mappings :first_name => 'given_name',
+      :middle_name => 'middlename',
+      :last_name => 'sn',
+      :created_at => 'creationdate',
+      :address => 'mailingstreet',
+      :city => 'mailingcity',
+      :state => 'st',
+      :zip_code => 'mailingpostalcode',
+      :country => 'co',
+      :phone => 'home_phone',
+      :business_phone => 'telephone_number',
+      :fax => 'facsimiletelephonenumber',      
+      :email => 'email1',
+      :website => 'businesshomepage',
+      :company => 'o'
+    
+    def self.query(path)
+      <<-QBODY
+				<?xml version="1.0"?>
+				<D:searchrequest xmlns:D = "DAV:">
+					 <D:sql>
+					 SELECT "urn:schemas:contacts:givenName", "urn:schemas:contacts:middlename",
+					  "urn:schemas:contacts:sn", "urn:schemas:contacts:title",
+					  "urn:schemas:contacts:mailingstreet", "urn:schemas:contacts:mailingcity",
+					  "urn:schemas:contacts:st", "urn:schemas:contacts:mailingpostalcode",
+					  "urn:schemas:contacts:co", "urn:schemas:contacts:homePhone",
+					  "urn:schemas:contacts:telephoneNumber", "urn:schemas:contacts:facsimiletelephonenumber",
+					  "urn:schemas:contacts:mobile", "urn:schemas:contacts:email1",
+					  "urn:schemas:contacts:businesshomepage", "urn:schemas:contacts:o", "DAV:creationdate"
+					 FROM SCOPE('shallow traversal of "#{path}"')
+					 WHERE "DAV:ishidden" = false
+						 AND "DAV:isfolder" = false
+						 AND "DAV:contentclass" = 'urn:content-classes:person'
+                    </D:sql>
+				</D:searchrequest>
+      QBODY
+    end
+
+  end
+end

data/lib/rexchange/folder.rb

@@ -1,8 +1,8 @@
 require 'rexml/document'
 require 'net/https'
-require 'rexchange/extensions'
 require 'rexchange/dav_search_request'
 require 'rexchange/message'
+require 'rexchange/contact'
 
 module RExchange
 
@@ -31,8 +31,12 @@ module RExchange
     
     # Iterate through each RExchange::Message in this folder
     def each
-      messages.each do |msg|
-        yield msg
+      if @folder =~ /^contacts$/i || @parent =~ /\/contacts\//i
+        get_contacts
+      else
+        get_messages
+      end.each do |item|
+        yield item
       end  
     end
     
@@ -46,13 +50,17 @@ module RExchange
     def messages_in(folder)
       folder.split('/').inject(@credentials.uri.path) do |final_path, current_path|
         Folder.new(@credentials, final_path, current_path)
-      end.messages
+      end.get_messages
     end
     
-    def messages
+    def get_messages
       RExchange::Message::find(@credentials, to_s)
     end
     
+    def get_contacts
+      RExchange::Contact::find(@credentials, to_s)
+    end
+    
     # Join the strings passed in with '/'s between them
     def self.join(*args)
       args.collect { |f| f.to_s.ensure_ends_with('/') }.to_s.squeeze('/')

data/lib/rexchange/generic_item.rb

@@ -0,0 +1,64 @@
+require 'rexml/document'
+require 'ostruct'
+require 'rexchange/dav_move_request'
+require 'time'
+
+module RExchange
+  class GenericItem
+    include REXML
+    include Enumerable
+    
+    attr_accessor :attributes  
+    
+    # Used to access the attributes of the item as a hash.
+    def [](key)
+      return @attributes[key]
+    end
+    
+    # Used to access the attributes of the item.
+    def method_missing(sym, *args)
+      return @attributes[sym.to_s] if @attributes.include?(sym.to_s)
+    end
+    
+    def initialize(session, dav_property_node)
+      @attributes = {}
+      @session = session
+      
+      dav_property_node.elements.each do |element|
+        if element.name.normalize =~ /date$/i
+          @attributes[element.name.normalize] = Time::parse(element.text)
+        else
+          @attributes[element.name.normalize] = element.text
+        end
+      end
+      
+      return self    
+    end
+    
+    def self.attribute_mappings(mappings)
+      mappings.each_pair do |k,v|
+        define_method k do
+          @attributes[v]
+        end
+      end
+    end
+    
+    def self.query(path)
+      raise 'YOU MUST DEFINE THIS'
+    end
+
+    # Retrieve an Array of items (such as Contact, Message, etc)
+    def self.find(credentials, path)      
+      response = DavSearchRequest.execute(credentials, :body => query(path))
+      
+      items = []
+      xpath_query = "//a:propstat[a:status/text() = 'HTTP/1.1 200 OK']/a:prop"
+      
+      Document.new(response.body).elements.each(xpath_query) do |m|
+        items << self.new(credentials, m)
+      end
+      
+      return items
+    end
+  end
+end

data/lib/rexchange/message.rb

@@ -1,40 +1,13 @@
-require 'rexml/document'
-require 'ostruct'
-require 'rexchange/dav_move_request'
+require 'rexchange/generic_item'
 
 module RExchange
-  class Message
-    include REXML
-    include Enumerable
-    
-    attr_accessor :attributes  
+  class Message < GenericItem
     
     def to_s
       "To: #{to}, From: #{from}, Subject: #{subject}"
     end
     
-    # Used to access the attributes of the message as a hash.
-    def [](key)
-      return @attributes[key]
-    end
-    
-    # Used to access the attributes of the message. The following are available:
-    # * href
-    # * from
-    # * to
-    # * subject
-    # * message-id
-    # * date
-    # * importance
-    # * hasattachment
-    def method_missing(sym, *args)
-      return @attributes[sym.to_s] if @attributes.include?(sym.to_s)
-    end
-    
-    # This is an alias for httpmail:hasattachment attribute.
-    def has_attachments?
-      return self['hasattachment']
-    end
+    attribute_mappings 'has_attachments?' => 'hasattachment'
     
     # Returns the body of the message. This is either a httpmail:textdescription,
     # or a httpmail:htmldescription
@@ -42,17 +15,6 @@ module RExchange
       @attributes['textdescription'] || @attributes['htmldescription']
     end
     
-    def initialize(session, dav_property_node)
-      @attributes = {}
-      @session = session
-      
-      dav_property_node.elements.each do |element|
-        @attributes[element.name.tr('-', '_')] = element.text
-      end
-      
-      return self    
-    end
-    
     # Move this message to the specified folder.
     # The folder can be a string such as 'inbox/archive' or a RExchange::Folder.
     # === Example
@@ -61,15 +23,18 @@ module RExchange
     #   end
     def move_to(folder)
       source = URI.parse(self.href).path
-      destination = @session.uri.path.ensure_ends_with('/') + folder.to_s.ensure_ends_with('/') + source.split('/').last
+      destination = if folder.is_a?(RExchange::Folder)
+        folder.to_s.ensure_ends_with('/') + source.split('/').last
+      else
+        @session.uri.path.ensure_ends_with('/') + folder.to_s.ensure_ends_with('/') + source.split('/').last
+      end
       
+      $log.debug "move_to: source => \"#{source}\", destination => \"#{destination}\""
       DavMoveRequest.execute(@session, source, destination)
     end
     
-    # Retrieve an Array of messages in this folder
-    def Message.find(credentials, path)
-    
-      body = <<DABODY
+    def self.query(path)
+      <<-QBODY
 				<?xml version="1.0"?>
 				<D:searchrequest xmlns:D = "DAV:">
 					 <D:sql>
@@ -84,18 +49,7 @@ module RExchange
 						 AND "DAV:contentclass" = 'urn:content-classes:message'
                     </D:sql>
 				</D:searchrequest>
-DABODY
-      
-      response = DavSearchRequest.execute(credentials, :body => body)
-      
-      mail_messages = []
-      xpath_query = "//a:propstat[a:status/text() = 'HTTP/1.1 200 OK']/a:prop"
-      
-      Document.new(response.body).elements.each(xpath_query) do |m|
-        mail_messages << Message.new(credentials, m)
-      end
-      
-      return mail_messages
+      QBODY
     end
   end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: rexchange
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
-date: 2006-02-01
+  version: 0.2.0
+date: 2006-02-23
 summary: "A simple wrapper around Microsoft Exchange Server's WebDAV API"
 require_paths: 
   - lib
@@ -31,13 +31,15 @@ files:
   - README
   - CHANGELOG
   - RAKEFILE
+  - lib/r_exchange.rb
   - lib/rexchange.rb
+  - lib/rexchange/contact.rb
   - lib/rexchange/credentials.rb
   - lib/rexchange/dav_move_request.rb
   - lib/rexchange/dav_search_request.rb
   - lib/rexchange/exchange_request.rb
-  - lib/rexchange/extensions.rb
   - lib/rexchange/folder.rb
+  - lib/rexchange/generic_item.rb
   - lib/rexchange/message.rb
   - lib/rexchange/session.rb
   - test/functional.rb

data/lib/rexchange/extensions.rb

@@ -1,13 +0,0 @@
-class String
-  def ends_with?(partial)
-    self[self.size - partial.size..self.size] == partial
-  end
-  
-  def ensure_ends_with(partial)
-    self.ends_with?(partial) ? self : self + partial
-  end
-  
-  def normalize
-    self.split(/(?=[A-Z][a-z]*)/).join('_').tr('- ', '_').squeeze('_').downcase
-  end
-end