viewpoint 0.1.7 → 0.1.8

data/VERSION

@@ -1 +1 @@
-0.1.7
+0.1.8

data/lib/model/{meeting_message.rb → attendee.rb}

@@ -20,11 +20,20 @@
 
 module Viewpoint
   module EWS
-    class MeetingMessage < Item
 
-      def initialize(ews_item)
-        super(ews_item)
+    # This represents a Mailbox object in the Exchange data store
+    # @see http://msdn.microsoft.com/en-us/library/aa565036.aspx MSDN docs
+    # @todo Design a Class method that resolves to an Array of MailboxUsers
+    class Attendee < MailboxUser
+      include Model
+
+      attr_reader :response
+
+      def initialize(attendee)
+        @response = attendee[:response_type][:text]
+        super(attendee[:mailbox])
       end
-    end # MeetingMessage
+
+    end # Attendee
   end # EWS
 end # Viewpoint

data/lib/model/calendar_folder.rb

@@ -63,6 +63,19 @@ module Viewpoint
         end
         super(opts)
       end
+      alias :items_between :find_items
+      
+      # Fetch only items from today (since midnight)
+      def todays_items
+        #This is a bit convoluted for pre-1.9.x ruby versions that don't support to_datetime
+        find_items(DateTime.parse(Date.today.to_s), DateTime.parse((Date.today + 1).to_s))
+      end
+
+      # Fetch items since a give DateTime
+      # @param [DateTime] start_date_time the time to fetch Items since.
+      def items_since(start_date_time)
+        find_items(start_date_time, DateTime.now)
+      end
 
     end # CalendarFolder
   end # EWS

data/lib/model/calendar_item.rb

@@ -122,7 +122,7 @@ module Viewpoint
 
       def init_methods
         super
-        define_str_var :calendar_item_type, :duration, :time_zone, :when, :location
+        define_str_var :calendar_item_type, :duration, :time_zone, :when, :location, :u_i_d, {:u_i_d => :uid}
         define_str_var :legacy_free_busy_status, :my_response_type, :meeting_workspace_url, :net_show_url
         define_int_var :adjacent_meeting_count, :appointment_sequence_number, :appointment_state
         define_int_var :conference_type, :conflicting_meeting_count
@@ -130,12 +130,12 @@ module Viewpoint
         define_bool_var :is_all_day_event, :is_cancelled, :is_meeting, :is_online_meeting, :is_recurring
         define_bool_var :allow_new_time_proposal, :meeting_request_was_sent
         define_datetime_var :appointment_reply_time, :start, :end, :original_start
+        define_attendees :required_attendees, :optional_attendees, :resources
 
         # @todo Handle:
         #   <AdjacentMeetings/> <ConflictingMeetings/> <DeletedOccurrences/>
         #   <FirstOccurrence/> <LastOccurrence/> <ModifiedOccurrences/>
         #   <StartTimeZone/> <EndTimeZone/> <MeetingTimeZone/>
-        #   <OptionalAttendees/> <RequiredAttendees/> <Resources/>
         #   <Recurrence/>
       end
 

data/lib/model/generic_folder.rb

@@ -40,6 +40,12 @@ module Viewpoint
 
       @@event_types = %w{CopiedEvent CreatedEvent DeletedEvent ModifiedEvent MovedEvent NewMailEvent}
 
+      # Get a specific folder by its ID.
+      # @param [String,Symbol] folder_id either a DistinguishedFolderID or simply a FolderID
+      # @param [String,nil] act_as User to act on behalf as.  This user must have been given
+      #   delegate access to this folder or else this operation will fail.
+      # @param [Hash] folder_shape
+      # @option folder_shape [String] :base_shape IdOnly/Default/AllProperties
       def self.get_folder(folder_id, act_as = nil, folder_shape = {:base_shape => 'Default'})
         resp = (Viewpoint::EWS::EWS.instance).ews.get_folder( [normalize_id(folder_id)], folder_shape, act_as )
         if(resp.status == 'Success')
@@ -88,6 +94,7 @@ module Viewpoint
 
       # Gets a folder by name.  This name must match the folder name exactly.
       # @param [String] name The name of the folder to fetch.
+      # @param [String] shape the shape of the object to return IdOnly/Default/AllProperties
       def self.get_folder_by_name(name, shape = 'Default')
         # For now the :field_uRI and :field_uRI_or_constant must be in an Array for Ruby 1.8.7 because Hashes
         # are not positional at insertion until 1.9
@@ -212,12 +219,15 @@ module Viewpoint
         end
       end
 
+      # Fetch only items from today (since midnight)
       def todays_items
         #opts = {:query_string => ["Received:today"]}
         #This is a bit convoluted for pre-1.9.x ruby versions that don't support to_datetime
         items_since(DateTime.parse(Date.today.to_s))
       end
 
+      # Fetch items since a give DateTime
+      # @param [DateTime] date_time the time to fetch Items since.
       def items_since(date_time)
         restr = {:restriction =>
           {:is_greater_than_or_equal_to => 
@@ -227,6 +237,9 @@ module Viewpoint
         find_items(restr)
       end
 
+      # Fetch items between a given time period
+      # @param [DateTime] start_date the time to start fetching Items from
+      # @param [DateTime] end_date the time to stop fetching Items from
       def items_between(start_date, end_date)
         restr = {:restriction =>  {:and => [
           {:is_greater_than_or_equal_to => 
@@ -271,6 +284,9 @@ module Viewpoint
       end
 
       # Get Item
+      # @param [String] item_id the ID of the item to fetch
+      # @param [String] change_key specify an optional change_key if you want to
+      #   make sure you are fetching a specific version of the object.
       def get_item(item_id, change_key = nil)
         resp = (Viewpoint::EWS::EWS.instance).ews.get_item([item_id])
         if(resp.status == 'Success')

data/lib/model/item.rb

@@ -209,22 +209,12 @@ module Viewpoint
         @parent_folder_id = @ews_item[:parent_folder_id][:id] if @ews_item[:parent_folder_id].is_a?(Hash)
         @conversation_id  = @ews_item[:conversation_id][:id] if @ews_item[:conversation_id].is_a?(Hash)
         @ews_methods << :item_id
-        if(@ews_item[:body] && @ews_item[:body][:body_type])
-          @body_type = @ews_item[:body][:body_type]
-          @ews_methods << :body_type
-        end
-        if(@ews_item[:unique_body] && @ews_item[:unique_body][:body_type])
-          @unique_body_type = @ews_item[:body][:body_type]
-          @ews_methods << :unique_body_type
-        end
-        if(@ews_item[:mime_content] && @ews_item[:mime_content][:character_set])
-          @mime_charset = @ews_item[:mime_content][:character_set]
-          @ews_methods << :mime_charset
-        end
         define_str_var :subject, :sensitivity, :body, :item_class, :importance, :in_reply_to, :unique_body
         define_str_var :display_cc, :display_to, :culture, :last_modified_name, :mime_content
         define_str_var :web_client_read_form_query_string, :web_client_edit_form_query_string
         define_attr_str_var :body, :body_type
+        define_attr_str_var :unique_body, :body_type
+        define_attr_str_var :mime_content, :character_set
         define_int_var :size, :reminder_minutes_before_start
         define_bool_var :has_attachments, :is_submitted, :is_draft, :is_from_me, :is_resend, :is_unmodified, :reminder_is_set, :is_associated
         define_datetime_var :date_time_sent, :date_time_created, :date_time_received, :reminder_due_by, :last_modified_time

data/lib/model/message.rb

@@ -112,6 +112,15 @@ module Viewpoint
             body msg.body
           end
         end
+
+        # add attachments
+        if(self.has_attachments?)
+          self.attachments.each do |att|
+            if(att.is_a?(FileAttachment))
+              mail.attachments[att.file_name] = Base64.decode64(att.content)
+            end
+          end
+        end
         mail
       end
 

data/lib/model/model.rb

@@ -47,16 +47,21 @@ module Viewpoint
       # Define a method that returns a string.  The vars are the keys in the 
       # hash that contain a :text key.  In the original SOAP packet this would
       # look something like this:
+      # @param [Array<Symbol,Hash>] *vars the symbols to map to methods.  If the
+      #   last item is a hash it will be used to map methods names.  For instance
+      #   UID comes through like this :u_i_d so we can map it like so {:u_i_d => :uid}
       # @example
       #   <method_name>
       #      This is the text
       #   </method_name>
       def define_str_var(*vars)
+        map = ( vars.last.is_a?(Hash) ? vars.pop : {}) 
         vars.each do |var|
           if(@ews_item[var])
-            @ews_methods << var
+            mname = ( map.has_key?(var) ? map[var] : var )
+            @ews_methods << mname
             self.instance_eval <<-EOF
-            def #{var}
+            def #{mname}
               @ews_item[:#{var}][:text]
             end
             EOF
@@ -71,7 +76,8 @@ module Viewpoint
       # to by :text.  In the orignal SOAP it may have looked like this:
       # @example
       #   <node my_method='this is the text'/>
-      # @param
+      #   so you would specify this...
+      #   define_attr_str_var :node, :my_method
       def define_attr_str_var(parent, *vars)
         return unless @ews_item[parent]
         vars.each do |var|
@@ -160,6 +166,7 @@ module Viewpoint
         end
       end
 
+
       def define_mbox_user(*vars)
         vars.each do |var|
           if(@ews_item[var])
@@ -174,6 +181,36 @@ module Viewpoint
           end
         end
       end
+      
+
+      # Define meeting attendees
+      # @param [String] *attendee_types the type of attendee we are defining :required_attendees, :optional_attendees
+      def define_attendees(*attendee_types)
+        attendee_types.each do |attendee_type|
+          if(@ews_item.has_key?(attendee_type))
+            @ews_methods << attendee_type
+            self.instance_eval <<-EOF
+            def #{attendee_type}
+              return @#{attendee_type} if defined?(@#{attendee_type})
+              if( (@ews_item[:#{attendee_type}][:attendee]).is_a?(Hash) )
+                @#{attendee_type} = [Attendee.new(@ews_item[:#{attendee_type}][:attendee])]
+              elsif( (@ews_item[:#{attendee_type}][:attendee]).is_a?(Array) )
+                @#{attendee_type} = []
+                @ews_item[:#{attendee_type}][:attendee].each do |i|
+                  @#{attendee_type} << Attendee.new(i)
+                end
+              else
+                raise EwsError, "Bad value for mailbox: " + @ews_item[:#{attendee_type}][:attendee]
+              end
+              @#{attendee_type}
+            end
+            EOF
+          else
+            @ews_methods_undef << attendee_type
+          end
+        end
+      end
+
 
       # After a delete is called on an object this method will clear
       # out all of the defined EWS methods so they can't be called on the

data/lib/soap/handsoap/ews_service.rb

@@ -360,12 +360,22 @@ module Viewpoint
           parse!(resp)
         end
 
+        # Defines a request to synchronize a folder hierarchy on a client
+        # @see http://msdn.microsoft.com/en-us/library/aa580990.aspx
         def sync_folder_hierarchy
+          sync_state = nil
+          folder_id = :publicfoldersroot
           action = "#{SOAP_ACTION_PREFIX}/SyncFolderHierarchy"
-          resp = invoke("#{NS_EWS_MESSAGES}:SyncFolderHierarchy", action) do |sync_folder_hierarchy|
-            build_sync_folder_hierarchy!(sync_folder_hierarchy)
+          resp = invoke("#{NS_EWS_MESSAGES}:SyncFolderHierarchy", action) do |root|
+            build!(root) do
+              folder_shape!(root, {:base_shape => 'Default'})
+              root.add("#{NS_EWS_MESSAGES}:SyncFolderId") do |sfid|
+                folder_id!(sfid, folder_id)
+              end
+              sync_state!(root, sync_state) unless sync_state.nil?
+            end
           end
-          parse_sync_folder_hierarchy(resp)
+          parse!(resp)
         end
 
         # Synchronizes items between the Exchange server and the client

data/lib/viewpoint.rb

@@ -33,6 +33,7 @@ require 'soap/soap_provider'
 # Base Models
 require 'model/model'
 require 'model/mailbox_user'
+require 'model/attendee'
 require 'model/generic_folder'
 require 'model/item'
 # Specific Models
@@ -47,10 +48,6 @@ require 'model/message'
 require 'model/calendar_item'
 require 'model/contact'
 require 'model/distribution_list'
-require 'model/meeting_message'
-require 'model/meeting_request'
-require 'model/meeting_response'
-require 'model/meeting_cancellation'
 require 'model/task'
 require 'model/attachment'
 require 'model/file_attachment'

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 1
-  - 7
-  version: 0.1.7
+  - 8
+  version: 0.1.8
 platform: ruby
 authors: 
 - Dan Wanek
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-14 00:00:00 -06:00
+date: 2010-11-24 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -118,6 +118,7 @@ files:
 - lib/exceptions/exceptions.rb
 - lib/extensions/string.rb
 - lib/model/attachment.rb
+- lib/model/attendee.rb
 - lib/model/calendar_folder.rb
 - lib/model/calendar_item.rb
 - lib/model/contact.rb
@@ -130,10 +131,6 @@ files:
 - lib/model/item.rb
 - lib/model/item_attachment.rb
 - lib/model/mailbox_user.rb
-- lib/model/meeting_cancellation.rb
-- lib/model/meeting_message.rb
-- lib/model/meeting_request.rb
-- lib/model/meeting_response.rb
 - lib/model/message.rb
 - lib/model/model.rb
 - lib/model/search_folder.rb

data/lib/model/meeting_cancellation.rb

@@ -1,28 +0,0 @@
-#############################################################################
-# Copyright © 2010 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/>.
-#############################################################################
-
-module Viewpoint
-  module EWS
-    # Meeting cancellations have the exact same elements as a Meeting Message
-    # so MeetingCancellation is just a subclass of that.
-    class MeetingCancellation < MeetingMessage
-    end # MeetingCancellation
-  end # EWS
-end # Viewpoint

data/lib/model/meeting_request.rb

@@ -1,41 +0,0 @@
-#############################################################################
-# Copyright © 2010 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/>.
-#############################################################################
-
-module Viewpoint
-  module EWS
-    class MeetingRequest < Item
-
-
-      private
-
-      def init_methods
-        super()
-        define_str_var :conversation_index, :conversation_topic, :internet_message_id, :references
-        define_mbox_users :to_recipients, :cc_recipients, :bcc_recipients, :reply_to, :required_attendees, :optional_attendees
-        define_mbox_user :from, :sender, :received_by, :received_representing, :organizer
-        define_bool_var :is_read, :is_read_receipt_requested, :is_response_requested, :is_delivery_receipt_requested, :is_draft, :is_from_me
-        define_bool_var :is_all_day_event, :is_cancelled, :is_delegated, :is_meeting, :is_out_of_date, :is_recurring, :is_resend
-        define_bool_var :is_submitted, :is_unmodified, :allow_new_time_proposal
-        define_int_var :adjacent_meeting_count, :appointment_sequence_number, :appointment_state, :conflicting_meeting_count
-        define_datetime_var :start, :end
-      end
-    end # MeetingRequest
-  end # EWS
-end # Viewpoint

data/lib/model/meeting_response.rb

@@ -1,26 +0,0 @@
-#############################################################################
-# Copyright © 2010 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/>.
-#############################################################################
-
-module Viewpoint
-  module EWS
-    class MeetingResponse < Item
-    end # MeetingResponse
-  end # EWS
-end # Viewpoint