rexchange 0.3.3 → 0.3.4

data/CHANGELOG

@@ -1,3 +1,8 @@
+-- 0.3.4:
+* Updated the README so it jives with the current version
+* Removed Folder::join since it's only used by Folder#to_s, and just used a simpler
+	solution in Folder#to_s instead
+
 -- 0.3.3:
 * Folder objects now default to using the Message class for enumeration 
   if no class is associated with the content_type of the Folder.

data/RAKEFILE

@@ -8,7 +8,7 @@ require 'rake/gempackagetask'
 require 'rake/contrib/rubyforgepublisher'
 require 'pscp'
 
-PACKAGE_VERSION = '0.3.3'
+PACKAGE_VERSION = '0.3.4'
 
 PACKAGE_FILES = FileList[
   'README',

data/README

@@ -15,53 +15,61 @@ RExchange is a pure ruby wrapper for the Microsoft Exchange Server WebDAV API
 
 == Example
 
-	uri = 'https://example.com/exchange/admin/'
-	options = { :user => 'mydomain\admin', :password => 'random' }
-	
-	# We pass our uri (pointing directly to a mailbox), and options hash to RExchange::open
-	# to create a RExchange::Session.
-	RExchange::open(uri, options) do |mailbox|
-	
+	# We pass our uri (pointing directly to a mailbox), a username, and a password to RExchange::open
+	# to create a RExchange::Session. Notice that we escape the "\" in our username.
+	RExchange::open('https://example.com/exchange/admin/', 'mydomain\\admin', 'secret') do |mailbox|
+  
 		# The block parameter ("mailbox" in this case) is actually the Session itself.
 		# You can refer to folders by chaining them as method calls. "inbox" in this case
 		# isn't a defined method for Session, but part of the DSL to refer to folder names.
 		# Each folder name returns a RExchange::Folder. The folder is Enumerable, allowing
-		# iteration over the messages in the folder.
-	  mailbox.inbox.each do |message|
-	
+		# iteration over the items in the folder, depending on the DAV:content-class of
+		# the folder.
+		mailbox.inbox.each do |message|
+    
 			# The "message" block parameter is a RExchange::Message object. You have access to
-			# several attributes of the message, including: href, from, to, message-id, date,
-			# importance, hasattachment and body.
-	 		p message.subject
-	
+			# several attributes of the message, including: href, from, to, message_id, date,
+			# importance, has_attachment? and body.
+			p message.subject
+    
 			# The RExchange::Message#move_to method moves the message to another folder, in this
 			# case, an "archive" folder off of the inbox.
-			message.move_to mailbox.inbox.archive # or you could pass the string: '/inbox/archive'
+			message.move_to mailbox.inbox.archive
 		end
-		
-		# You can also call the RExchange::Folder#messages method if you find calling "each"
-		# on a folder directly a little obscure.
-		mailbox.inbox.archive.messages.each do |m|
-		
-			# Our previous message should show up in here now.
-			p m.subject
-		end
-		
-		# The RExchange::Folder#message_in method is less expensive than the DSL folder-chaining
-		# methods. Since the folder-chaining is cached in the Session it's a small hit, and some
-		# may prefer the readability of them, but if you're looking for absolute performance
-		# or have really deep folder structures then this may be the method for you.
-		mailbox.messages_in '/inbox/' do |m|
-			
-			# Since we moved all our messages to the archive earlier, this shouldn't display
-			# anything.
-			p m.from
-		end
-		
+  
 		# Folder names are "normalized", replacing dashes and spaces with underscores,
 		# squeezing out multiple underscores in a row, and downcasing the whole thing.
 		# So a folder name such as "My Very-long Folder Name" would look like:
 		mailbox.my_very_long_folder_name
+  
+		# The Enumerable mixin gives us an Folder#entries method in case we just want to
+		# return an array.
+		messages = mailbox.inbox.entries
+	
+		# Other methods, like Enumerable#map and Enumerable#sort_by let us manipulate
+		# the Folder in fun ways:
+		puts mailbox.contacts.sort_by { |contact| contact.first_name }.map do |contact|
+			<<-CONTACT
+				Name:    #{contact.first_name} #{contact.last_name}
+				Email:   #{contact.email}
+				Phone:   #{contact.phone}
+			CONTACT
+		end
+	
+	end
+
+	# We can access the Global Address Book by accessing the "/public" folder:
+	RExchange::open('https://example.com/public', 'mydomain\\somebody', 'secret') do |mailbox|
+
+		puts mailbox.company_contacts.each do |contact|
+			<<-CONTACT
+				Company: #{contact.company}
+				Name:    #{contact.first_name} #{contact.last_name}
+				Email:   #{contact.email}
+				Phone:   #{contact.phone}
+			CONTACT
+	 end
+
 	end
 	
 == Caveats

data/lib/rexchange.rb

@@ -18,7 +18,7 @@ module RExchange
   # Use STDOUT or another stream if you'd like to capture the HTTP debug output
   DEBUG_STREAM = $log
   
-  # A shortcut to RExchange::Session#new's block syntax
+  # A shortcut to RExchange::Session#new
   def self.open(uri, username = nil, password = nil)
     session = RExchange::Session.new(uri, username, password)
     

data/lib/rexchange/credentials.rb

@@ -7,7 +7,7 @@ module RExchange
   class Credentials
     attr_reader :user, :password, :uri
 
-    # You must pass a uri, and an options hash containing :user and :password
+    # You must pass a uri, a username and a password
     def initialize(uri, username = nil, password = nil)
       @uri = URI.parse(uri)
       @use_ssl = (@uri.scheme.downcase == 'https')

data/lib/rexchange/folder.rb

@@ -40,15 +40,12 @@ module RExchange
       end
     end
     
+    # Not Implemented!
     def search(conditions = {})
+      raise NotImplementedError.new('Bad Touch!')
       @content_type::find(@credentials, to_s, conditions)
     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 ||= begin
@@ -83,7 +80,7 @@ module RExchange
     
     # Return the absolute path to this folder (but not the full URI)
     def to_s
-      Folder.join(@parent, @name)
+      "#@parent/#@name/".squeeze('/')
     end
   end
 end

data/lib/rexchange/generic_item.rb

@@ -77,7 +77,7 @@ module RExchange
     
     # Defines what attributes are used in queries, and
     # what methods they map to in instances. You should
-    # pass a Hash of method_name and namespaced-attribute-name pairs.
+    # pass a Hash of method_name symbols and namespaced-attribute-name pairs.
     def self.attribute_mappings(mappings)
       
       mappings.merge! :uid => 'DAV:uid',

data/lib/rexchange/session.rb

@@ -8,10 +8,7 @@ module RExchange
     
     # Creates a Credentials instance to pass to subfolders
     # === Example
-    #   uri = 'https://mydomain.com/exchange/demo'
-    #   options = { :user => 'test', :password => 'random' }
-    # 
-    #   RExchange::Session.new(uri, 'bob', 'secret') do |mailbox|
+    #   RExchange::Session.new('https://mydomain.com/exchange/demo', 'mydomain\\bob', 'secret') do |mailbox|
     #     mailbox.test.each do |message|
     #       puts message.subject
     #     end

metadata

@@ -3,7 +3,7 @@ rubygems_version: 0.9.0
 specification_version: 1
 name: rexchange
 version: !ruby/object:Gem::Version 
-  version: 0.3.3
+  version: 0.3.4
 date: 2007-01-10 00:00:00 -06:00
 summary: A simple wrapper around Microsoft Exchange Server's WebDAV API
 require_paths: 
@@ -34,8 +34,8 @@ files:
 - CHANGELOG
 - RAKEFILE
 - MIT-LICENSE
-- lib/rexchange.rb
 - lib/r_exchange.rb
+- lib/rexchange.rb
 - lib/rexchange/appointment.rb
 - lib/rexchange/contact.rb
 - lib/rexchange/credentials.rb