rexchange 0.1.1 → 0.1.2

data/CHANGELOG

@@ -1,3 +1,9 @@
--- 1.1
+-- 0.1.2: Minor documentation/cleanup
+* Removed a double-dash in the README that was apparently causing some viewing errors
+* Changed Session initialize to a ternary condition
+* Added RExchange::Message#has_attachments?
+* Added documentation for most methods in RExchange::Message and RExchange::Folder
+
+-- 0.1.1
 * Fleshed out the README
 * Copied the RAKEFILE from the Rools project

data/RAKEFILE

@@ -7,7 +7,7 @@ require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 # require 'pscp'
 
-PACKAGE_VERSION = '0.1.1'
+PACKAGE_VERSION = '0.1.2'
 
 PACKAGE_FILES = FileList[
   'README',

data/README

@@ -1,4 +1,6 @@
-= RExchange -- A pure ruby wrapper for the Microsoft Exchange Server WebDAV API
+= RExchange
+
+RExchange is a pure ruby wrapper for the Microsoft Exchange Server WebDAV API
 
 == Things you should know
 

data/lib/rexchange/folder.rb

@@ -19,6 +19,8 @@ module RExchange
     
     alias :old_method_missing :method_missing
     
+    # Used to access subfolders. If the subfolder does not
+    # exist, then old_method_missing is called.
     def method_missing(sym, *args)
       if subfolder_exist?(sym.to_s)
         Folder.new(@credentials, self, sym )
@@ -27,25 +29,34 @@ module RExchange
       end
     end
     
+    # Iterate through each RExchange::Message in this folder
     def each
       messages.each do |msg|
         yield msg
       end  
     end
     
+    # Retrieve an Array of messages from a specific folder
+    # === Example
+    #   RExchange::open(uri, :user => 'bob', :password => 'random') do |mailbox|
+    #     mailbox.messages_in('inbox/archive').each do |message|
+    #       p message.from
+    #     end
+    #   end
     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
     
+    # Retrieve an Array of messages in this folder
     def messages
     
       body = <<DABODY
 				<?xml version="1.0"?>
 				<D:searchrequest xmlns:D = "DAV:">
 					 <D:sql>
-					 SELECT "DAV:href", 
+					 SELECT "DAV:href", 
               "urn:schemas:httpmail:from", "urn:schemas:httpmail:to", "urn:schemas:mailheader:message-id",
 							"urn:schemas:httpmail:subject", "DAV:href", "urn:schemas:httpmail:date",
 							"urn:schemas:httpmail:importance", "urn:schemas:httpmail:hasattachment",
@@ -53,13 +64,13 @@ module RExchange
 					 FROM SCOPE('shallow traversal of "#{to_s}"')
 					 WHERE "DAV:ishidden" = false
 						 AND "DAV:isfolder" = false
-						 AND "DAV:contentclass" = 'urn:content-classes:message'
+						 AND "DAV:contentclass" = 'urn:content-classes:message'
             </D:sql>
 				</D:searchrequest>
 DABODY
       
-      response = DavSearchRequest.execute(@credentials, :body => body)
-      
+      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| 
@@ -69,18 +80,22 @@ DABODY
       return mail_messages
     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('/')
     end
     
+    # Return an Array of subfolders for this folder
     def folders
       @folders ||= get_folders
     end
     
+    # Check to see if a particular subfolder exists
     def subfolder_exist?(folder)
       folders.include? normalize_folder_name(folder)    
     end
     
+    # Return the absolute path to this folder (but not the full URI)
     def to_s
       Folder.join(@parent, @folder)
     end
@@ -116,4 +131,4 @@ DA_QUERY
       return folders
     end
   end
-end
+end

data/lib/rexchange/message.rb

@@ -9,17 +9,34 @@ module RExchange
     
     attr_accessor :attributes  
     
+    # 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
+    
+    # Returns the body of the message. This is either a httpmail:textdescription,
+    # or a httpmail:htmldescription
     def body
       @attributes['textdescription'] || @attributes['htmldescription']
-    end
+    end
     
     def initialize(session, dav_property_node)
       @attributes = {}
@@ -30,14 +47,20 @@ module RExchange
       end
       
       return self    
-    end
-    
-    def move_to(folder)
+    end
+    
+    # Move this message to the specified folder.
+    # The folder can be a string such as 'inbox/archive' or a RExchange::Folder.
+    # === Example
+    #   mailbox.inbox.each do |message|
+    #     message.move_to mailbox.inbox.archive
+    #   end
+    def move_to(folder)
       source = URI.parse(self.href).path
-      destination = @session.uri.path.ensure_ends_with('/') + folder.ensure_ends_with('/') + source.split('/').last
-      
-      DavMoveRequest.execute(@session, source, destination)
+      destination = @session.uri.path.ensure_ends_with('/') + folder.to_s.ensure_ends_with('/') + source.split('/').last
+      
+      DavMoveRequest.execute(@session, source, destination)
     end
     
-  end
+  end
 end

data/lib/rexchange/session.rb

@@ -22,13 +22,9 @@ module RExchange
       @parent = @credentials.uri.path
       @folder = ''
       
-      if block_given?
-        yield self
-      else
-        return self
-      end
+      block_given? ? yield self : return self
     end
       
   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.1
-date: 2006-01-27
+  version: 0.1.2
+date: 2006-01-28
 summary: "A simple wrapper around Microsoft Exchange Server's WebDAV API"
 require_paths: 
   - lib