viewpoint 0.0.1

data/lib/folder.rb

@@ -0,0 +1,269 @@
+#############################################################################
+# Copyright © 2009 Dan Wanek <dan.wanek@gmail.com>
+#
+#
+# This file is part of Viewpoint.
+# 
+# Viewpoint is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+# 
+# Viewpoint is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
+# Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with Viewpoint.  If not, see <http://www.gnu.org/licenses/>.
+#############################################################################
+require 'rubygems'
+require 'viewpoint'
+
+# This class is inherited by all folder subtypes such as Mail, Calendar,
+# Tasks and Search.  It will serve as the brain for all of the methods that
+# each of these folder types have in common.
+class Viewpoint::Folder
+	include Viewpoint
+
+	attr_accessor :folder_id, :parent_id, :display_name
+	def initialize(folder)
+		@folder_id = folder.folderId.xmlattr_Id
+		@parent_id = folder.parentFolderId.xmlattr_Id unless folder.parentFolderId == nil
+		@display_name = folder.displayName
+		@sync_state = nil
+		@subscription_id = nil
+		@watermark = nil
+	end
+
+	# Subscribe to folder and save the subscription_id into the database.  Subsequent calls
+	# to check_subscription will use that id.
+	# Returns true if the operation is successful, false otherwise
+	def subscribe
+		subscribe = SubscribeType.new
+		pull = PullSubscriptionRequestType.new
+
+		# Set-up folder Id
+		dist_fid = DistinguishedFolderIdType.new
+		dist_fid.xmlattr_Id = DistinguishedFolderIdNameType::Calendar
+		f_ids = NonEmptyArrayOfBaseFolderIdsType.new()
+		f_ids.distinguishedFolderId = dist_fid
+		pull.folderIds = f_ids
+
+		# Set-up event types
+		event_types = NonEmptyArrayOfNotificationEventTypesType.new
+		#event_types.push(NotificationEventTypeType::NewMailEvent)
+		event_types.push(NotificationEventTypeType::CreatedEvent)
+		event_types.push(NotificationEventTypeType::DeletedEvent)
+		#event_types.push(NotificationEventTypeType::ModifiedEvent)
+		event_types.push(NotificationEventTypeType::MovedEvent)
+		pull.eventTypes = event_types
+
+		pull.timeout = 10
+
+		subscribe.pullSubscriptionRequest = pull
+		
+		resp = ExchWebServ.instance.ews.subscribe(subscribe).responseMessages.subscribeResponseMessage[0]
+		@subscription_id = resp.subscriptionId
+		@watermark = resp.watermark
+
+		return (resp.responseCode == "NoError")? true: false
+	end
+
+
+	# Fetch events with the subscription_id.  If one does not exists or is expired,
+	# call subscribe.
+	def check_subscription
+		begin
+			if( @subscription_id == nil or @watermark == nil) then
+				self.subscribe
+			end
+			ge = GetEventsType.new(@subscription_id, @watermark)
+
+			resp = ExchWebServ.instance.ews.getEvents(ge).responseMessages.getEventsResponseMessage[0] 
+
+			#TODO:  Add more event processing
+			
+
+			notifications = resp.notification
+
+			# Process Notifications
+			if( notifications.createdEvent != nil)
+				notifications.createdEvent.each do |note|
+					@watermark = note.watermark
+				end
+			end
+
+			if( notifications.deletedEvent != nil)
+				notifications.deletedEvent.each do |note|
+					@watermark = note.watermark
+				end
+			end
+
+			if( notifications.movedEvent != nil)
+				notifications.movedEvent.each do |note|
+					@watermark = note.watermark
+				end
+			end
+
+			if( notifications.statusEvent != nil)
+				notifications.statusEvent.each do |note|
+					@watermark = note.watermark
+				end
+			end
+
+		end
+
+		return resp
+	end
+
+
+	# This is a proxy for the SyncFolderItems operation detailed here: http://msdn.microsoft.com/en-us/library/aa563967.aspx
+	# It returns a SyncFolderItemsResponseType object
+	def sync_folder(max_items = 256)
+		begin
+			# ItemResponseShapeType
+			itemshapeT = ItemResponseShapeType.new(DefaultShapeNamesType::IdOnly, false)
+ 
+			# TargetFolderIdType
+			tfolderidT = TargetFolderIdType.new
+			folderidT = FolderIdType.new
+			folderidT.xmlattr_Id = self.folder_id
+			tfolderidT.folderId = folderidT
+
+			# SyncFolderItemsType
+			syncitemsT = SyncFolderItemsType.new(itemshapeT,tfolderidT,self.sync_state,nil,max_items)
+
+			# Call Sync => returns SyncFolderItemsResponseType
+			resp = ExchWebServ.instance.ews.syncFolderItems(syncitemsT).responseMessages.syncFolderItemsResponseMessage[0]
+			@sync_state = resp.syncState
+			return resp
+		rescue
+			puts "** Something happened during synchronizing folder => #{self.display_name}"
+			raise
+		end
+	end
+
+
+	# Wrapper around EWS's FindItem method:  http://msdn.microsoft.com/en-us/library/aa566107.aspx
+	# The specifics of this method should be set up in the child classes and then this method should
+	# be called with a parameter of FindItemType:  http://msdn.microsoft.com/en-us/library/aa566370.aspx
+	# This allows for a central place of error handling.  See Calendar::get_events for an example
+	# of how this works.
+	def find_items(find_item_t)
+		# FindItemResponseMessageType: http://msdn.microsoft.com/en-us/library/aa566424.aspx
+		resp = ExchWebServ.instance.ews.findItem(find_item_t).responseMessages.findItemResponseMessage[0]
+
+		#TODO: Error handling
+		if resp.xmlattr_ResponseClass == "Success"
+			return resp
+		else
+			return nil
+		end
+	end
+
+
+	# Fetch item by item_id
+	# Params: item_id: ItemIdType
+	#         item_type: String (message, calendarItem)
+	#         all_props: boolean; default is to get just the Default props
+	# Returns:  a Item type of some sort ( depends on 'item_type' parameter )
+	def get_item(item_id, item_type = nil, all_props = false)
+		get_item = GetItemType.new
+
+		if all_props
+			shape_name = DefaultShapeNamesType::AllProperties
+		else
+			shape_name = DefaultShapeNamesType::Default
+		end
+
+		item_shape = ItemResponseShapeType.new( shape_name, false, BodyTypeResponseType::Text )
+
+		#additional_props = NonEmptyArrayOfPathsToElementType.new
+		#prop_a = PathToUnindexedFieldType.new
+		#prop_b = PathToUnindexedFieldType.new
+		#prop_c = PathToUnindexedFieldType.new
+		#prop_d = PathToUnindexedFieldType.new
+		#prop_a.xmlattr_FieldURI = UnindexedFieldURIType::CalendarMeetingTimeZone
+		#prop_b.xmlattr_FieldURI = UnindexedFieldURIType.new("calendar:EndTimeZone")
+		#prop_c.xmlattr_FieldURI = UnindexedFieldURIType::ItemInternetMessageHeaders
+		#prop_d.xmlattr_FieldURI = UnindexedFieldURIType::MessageFrom
+		#additional_props.upath << prop_a
+		#additional_props.upath << prop_b
+		#additional_props.upath << prop_c
+		#additional_props << prop_d
+		#item_shape.additionalProperties = additional_props
+
+
+		
+		item_id_t = ItemIdType.new
+		item_id_t.xmlattr_Id = item_id
+		item_ids = NonEmptyArrayOfBaseItemIdsType.new([item_id_t])
+
+		get_item.itemShape = item_shape
+		get_item.itemIds= item_ids
+
+		# ItemInfoResponseMessageType: http://msdn.microsoft.com/en-us/library/aa565417.aspx
+		resp = ExchWebServ.instance.ews.getItem(get_item).responseMessages.getItemResponseMessage[0]
+
+		#TODO: Error handling
+		if resp.xmlattr_ResponseClass == "Success"
+			item = resp.items.send(item_type)
+			if( item.length > 1 )
+				puts "ERROR:  Item Id should only resolve to a single item!"
+			end
+			return item[0]
+		else
+			return nil
+		end
+	end
+
+
+	# More info: http://msdn.microsoft.com/en-us/library/aa565781.aspx
+	def move_item(item_id, new_folder)
+		return false unless new_folder.kind_of?(Viewpoint::Folder)
+
+		folder_id_t = FolderIdType.new
+		folder_id_t.xmlattr_Id =  new_folder.folder_id
+		target_folder_t = TargetFolderIdType.new(folder_id_t)
+
+		item_ids = NonEmptyArrayOfBaseItemIdsType.new
+		item_t = ItemIdType.new
+		item_t.xmlattr_Id = item_id
+		item_ids.itemId << item_t
+
+		move_t = MoveItemType.new(target_folder_t, item_ids)
+		resp = ExchWebServ.instance.ews.moveItem(move_t).responseMessages.moveItemResponseMessage.first
+		#TODO: Error handling
+		if resp.xmlattr_ResponseClass == "Success"
+			return true
+		else
+			return false
+		end
+	end
+
+	# Delete item by item_id
+	# More info: http://msdn.microsoft.com/en-us/library/aa580484.aspx
+	def delete_item(item_id, delete_type=DisposalType::HardDelete)
+		item_ids = NonEmptyArrayOfBaseItemIdsType.new
+		item = ItemIdType.new
+		item.xmlattr_Id = item_id
+		item_ids.itemId << item
+
+		delete = DeleteItemType.new(item_ids)
+		delete.xmlattr_DeleteType = delete_type
+		resp = ExchWebServ.instance.ews.deleteItem(delete).responseMessages.deleteItemResponseMessage.first
+
+		#TODO: Error handling
+		if resp.xmlattr_ResponseClass == "Success"
+			return true
+		else
+			return false
+		end
+	end
+
+	# Move item to Deleted Items folder instead of deleting it
+	def recycle_item(item_id)
+		delete_item(item_id, DisposalType::MoveToDeletedItems)
+	end
+end

data/lib/item.rb

@@ -0,0 +1,56 @@
+#############################################################################
+# Copyright © 2009 Dan Wanek <dan.wanek@gmail.com>
+#
+#
+# This file is part of Viewpoint.
+# 
+# Viewpoint is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+# 
+# Viewpoint is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
+# Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with Viewpoint.  If not, see <http://www.gnu.org/licenses/>.
+#############################################################################
+require 'viewpoint'
+
+
+# This class is inherited by all Item subtypes such as Message, Event,
+# and Task.  It will serve as the brain for all of the methods that
+# each of these Item types have in common.
+class Viewpoint::Item
+	include Viewpoint
+
+	attr_accessor :item_id
+
+	# Initialize an Exchange Web Services item
+	def initialize(ews_item, parent_folder)
+		@item_id = ews_item.itemId.xmlattr_Id
+		@parent_folder = parent_folder
+	end
+
+	# Takes an object of type Viewpoint::Folder as an argument
+	# Returns a boolean value, true if the move ocurred, false otherwise.
+	def move_to!(new_folder)
+		retval = @parent_folder.move_item(@item_id, new_folder)
+		@parent_folder = new_folder if retval
+
+		return retval
+	end
+
+
+	# Returns a boolean value, true if the delete ocurred, false otherwise.
+	def delete!
+		@parent_folder.delete_item(@item_id)
+	end
+
+	# Returns a boolean value, true if the recycle ocurred, false otherwise.
+	def recycle!
+		@parent_folder.recycle_item(@item_id)
+	end
+end

data/lib/mail.rb

@@ -0,0 +1,118 @@
+#############################################################################
+# Copyright © 2009 Dan Wanek <dan.wanek@gmail.com>
+#
+#
+# This file is part of Viewpoint.
+# 
+# Viewpoint is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+# 
+# Viewpoint is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
+# Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with Viewpoint.  If not, see <http://www.gnu.org/licenses/>.
+#############################################################################
+$:.unshift(File.dirname(__FILE__))
+require 'rubygems'
+require 'wsdl/exchangeServiceBinding'
+# --- Folder Types ---
+require 'folder'
+# --- Item Types ---
+require 'message'
+
+require 'viewpoint'
+
+
+class Viewpoint::MailFolder < Viewpoint::Folder
+	include Viewpoint
+	
+	# initialize with an item of MailFolderType
+	def initialize(folder)
+		super(folder)
+	end
+
+	def get_todays_messages
+		get_messages( DateTime.parse(Date.today.to_s).to_s )
+	end
+
+	# Get messages between a certain time period.  Defaults to "today"
+	# Input: DateTime of start, DateTime of end
+	# This method will return an Array of Message
+	def get_messages(since = (DateTime.parse(Date.today.to_s)) )
+		# Set-up FindItemType
+		find_item_t = FindItemType.new
+		find_item_t.xmlattr_Traversal = ItemQueryTraversalType::Shallow
+		item_shape = ItemResponseShapeType.new(DefaultShapeNamesType::IdOnly, false)
+
+		additional_props = NonEmptyArrayOfPathsToElementType.new
+		prop_a = PathToUnindexedFieldType.new
+		prop_b = PathToUnindexedFieldType.new
+		prop_c = PathToUnindexedFieldType.new
+		prop_d = PathToUnindexedFieldType.new
+		prop_e = PathToUnindexedFieldType.new
+		prop_f = PathToUnindexedFieldType.new
+		prop_a.xmlattr_FieldURI = UnindexedFieldURIType::ItemSubject
+		prop_b.xmlattr_FieldURI = UnindexedFieldURIType::ItemDateTimeReceived
+		prop_c.xmlattr_FieldURI = UnindexedFieldURIType::MessageSender 
+		prop_d.xmlattr_FieldURI = UnindexedFieldURIType::MessageFrom
+		prop_e.xmlattr_FieldURI = UnindexedFieldURIType::MessageIsRead
+		prop_f.xmlattr_FieldURI = UnindexedFieldURIType::MessageInternetMessageId
+		additional_props.upath << prop_a
+		additional_props.upath << prop_b
+		additional_props.upath << prop_c
+		additional_props.upath << prop_d
+		additional_props.upath << prop_e
+		additional_props.upath << prop_f
+		item_shape.additionalProperties = additional_props
+		find_item_t.itemShape = item_shape
+
+
+		# Set-up folder Ids to search in
+		folder_ids = NonEmptyArrayOfBaseFolderIdsType.new()
+		dist_folder = DistinguishedFolderIdType.new
+		dist_folder.xmlattr_Id = DistinguishedFolderIdNameType.new(@display_name.downcase)
+		folder_ids.distinguishedFolderId = dist_folder
+		find_item_t.parentFolderIds = folder_ids
+
+
+		# Set-up date-based restriction.
+		restriction = RestrictionType.new
+		search_type = IsGreaterThanOrEqualToType.new
+		fielduri = PathToUnindexedFieldType.new
+		fielduri.xmlattr_FieldURI = UnindexedFieldURIType::ItemDateTimeReceived
+		const = FieldURIOrConstantType.new
+		c = ConstantValueType.new
+		c.xmlattr_Value = (DateTime.now - 2).new_offset(0).to_s
+		const.constant = c
+		search_type.path = fielduri
+		search_type.fieldURIOrConstant = const
+		restriction.isGreaterThanOrEqualTo = search_type
+
+		find_item_t.restriction = restriction
+
+		resp = find_items(find_item_t)
+		
+		if resp != nil
+			messages = []
+			resp.rootFolder.items.message.each do |msg|
+				messages << Message.new(msg, self)
+			end
+
+			return messages
+		else
+			return resp
+		end
+
+	end
+	
+
+	# See docs for Folder::get_item
+	def get_item(item_id)
+		msg = super(item_id, "message", true)
+	end
+end

data/lib/message.rb

@@ -0,0 +1,134 @@
+#############################################################################
+# Copyright © 2009 Dan Wanek <dan.wanek@gmail.com>
+#
+#
+# This file is part of Viewpoint.
+# 
+# Viewpoint is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+# 
+# Viewpoint is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
+# Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with Viewpoint.  If not, see <http://www.gnu.org/licenses/>.
+#############################################################################
+$:.unshift(File.dirname(__FILE__))
+require 'item'
+require 'viewpoint'
+
+class Viewpoint::Message < Viewpoint::Item
+	include Viewpoint
+
+	attr_reader :subject, :parent_folder, :sender, :date_time_recieved
+	attr_reader :ews_item if $DEBUG
+
+	# Initialize an Exchange Web Services item of MessageType
+	def initialize(ews_item, parent_folder)
+		# keep this now for debuging
+		@ews_item = ews_item if $DEBUG
+		@subject = ews_item.subject # String
+		@sender = ews_item.sender.mailbox.name if ews_item.sender # String
+		@recipients = 
+		@is_read = ews_item.isRead  # boolean
+		@date_time_recieved = ews_item.dateTimeReceived # DateTime
+
+		# This is where the entire message object gets loaded if it
+		# is requested.  Think of it like IMAP downloading the
+		# body when the message is viewed.
+		@message = nil
+
+		super(ews_item, parent_folder)
+	end
+
+	def body
+		get_message if @message == nil
+		return @message.body
+	end
+
+	def recipients
+		get_message if @message == nil
+		to_recipients = ''
+		@message.toRecipients.each do |r|
+			to_recipients += ', ' if to_recipients != ''
+			to_recipients += "#{r.name} <#{r.emailAddress}>"
+		end
+
+		return to_recipients
+	end
+
+	def cc_recipients
+		get_message if @message == nil
+		if( @message.ccRecipients != nil)
+			cc = ''
+			@message.ccRecipients.each do |r|
+				cc += ', ' if cc != ''
+				cc += "#{r.name} <#{r.emailAddress}>"
+			end
+			return cc
+		end
+		return nil
+	end
+
+	def bcc_recipients
+		get_message if @message == nil
+		if( @message.bccRecipients != nil)
+			bcc = ''
+			@message.bccRecipients.each do |r|
+				bcc += ', ' if bcc != ''
+				bcc += "#{r.name} <#{r.emailAddress}>"
+			end
+			return bcc
+		end
+		return nil
+	end
+
+	def get_message
+		@message = @parent_folder.get_item(@item_id)
+	end
+
+	# Output the message in RFC 822 format: http://www.ietf.org/rfc/rfc0822.txt
+	def to_rfc822
+		get_message if @message == nil
+		rfc822 = []
+		rfc822.push 'Return-Path'  => @message.sender.mailbox.emailAddress
+		rfc822.push 'Delivered-To' => @message.receivedBy.mailbox.emailAddress
+		@message.internetMessageHeaders.each do |hdr|
+			# TODO: Quick Fix... needs more research
+			if( hdr.xmlattr_HeaderName == 'Content-Type' && hdr =~ /tnef/ )
+				rfc822.push hdr.xmlattr_HeaderName => 'multipart/alternative'
+			else
+				rfc822.push hdr.xmlattr_HeaderName => hdr
+			end
+		end
+
+		# From
+		rfc822.push 'From'  => "#{@message.sender.mailbox.name} <#{@message.sender.mailbox.emailAddress}>"
+
+		# To
+		rfc822.push 'To' => self.recipients
+
+		# CC
+		if( ( cc = self.cc_recipients) != nil)
+			rfc822.push 'Cc' => cc
+		end
+
+		# BCC
+		if( ( bcc = self.bcc_recipients) != nil)
+			rfc822.push 'Bcc' => bcc
+		end
+
+		rfc822_msg = ""
+		rfc822.each do |line|
+			line.each_pair do |key,val|
+				rfc822_msg += "#{key}: #{val}\n"
+			end
+		end
+
+		rfc822_msg += "\n\n#{@message.body}"
+	end
+end