viewpoint 0.1.26 → 1.1.1

data/lib/{model → ews/types}/item_field_uri_map.rb

@@ -20,17 +20,14 @@ module Viewpoint
   module EWS
     module ItemFieldUriMap
 
-      FIELD_URIS= {:folder_id  => {:text => 'older:FolderId', :writable => true},
-        :parent_folder_id  => {:text => 'folder:ParentFolderId', :writable => true},
-        :display_name  => {:text => 'folder:DisplayName', :writable => true},
-        :unread_count  => {:text => 'folder:UnreadCount', :writable => true},
+      FIELD_URIS= {
+        :folder_id  => {:text => 'folder:FolderId', :writable => true},
         :total_count  => {:text => 'folder:TotalCount', :writable => true},
         :child_folder_count  => {:text => 'folder:ChildFolderCount', :writable => true},
         :folder_class  => {:text => 'folder:FolderClass', :writable => true},
         :search_parameters  => {:text => 'folder:SearchParameters', :writable => true},
         :managed_folder_information  => {:text => 'folder:ManagedFolderInformation', :writable => true},
         :permission_set  => {:text => 'folder:PermissionSet', :writable => true},
-        :effective_rights  => {:text => 'folder:EffectiveRights', :writable => true},
         :sharing_effective_rights  => {:text => 'folder:SharingEffectiveRights', :writable => true},
         :item_id  => {:text => 'item:ItemId', :writable => true},
         :parent_folder_id  => {:text => 'item:ParentFolderId', :writable => true},
@@ -39,10 +36,6 @@ module Viewpoint
         :attachments  => {:text => 'item:Attachments', :writable => true},
         :subject  => {:text => 'item:Subject', :writable => true},
         :date_time_received  => {:text => 'item:DateTimeReceived', :writable => true},
-        :size  => {:text => 'item:Size', :writable => true},
-        :categories  => {:text => 'item:Categories', :writable => true},
-        :has_attachments  => {:text => 'item:HasAttachments', :writable => true},
-        :importance  => {:text => 'item:Importance', :writable => true},
         :in_reply_to  => {:text => 'item:InReplyTo', :writable => true},
         :internet_message_headers  => {:text => 'item:InternetMessageHeaders', :writable => true},
         :is_associated  => {:text => 'item:IsAssociated', :writable => true},
@@ -61,19 +54,15 @@ module Viewpoint
         :reminder_minutes_before_start  => {:text => 'item:ReminderMinutesBeforeStart', :writable => true},
         :display_to  => {:text => 'item:DisplayTo', :writable => true},
         :display_cc  => {:text => 'item:DisplayCc', :writable => true},
-        :culture  => {:text => 'item:Culture', :writable => true},
         :effective_rights  => {:text => 'item:EffectiveRights', :writable => true},
         :last_modified_name  => {:text => 'item:LastModifiedName', :writable => true},
         :last_modified_time  => {:text => 'item:LastModifiedTime', :writable => true},
-        :conversation_id  => {:text => 'item:ConversationId', :writable => true},
         :unique_body  => {:text => 'item:UniqueBody', :writable => true},
         :web_client_read_form_query_string  => {:text => 'item:WebClientReadFormQueryString', :writable => true},
         :web_client_edit_form_query_string  => {:text => 'item:WebClientEditFormQueryString', :writable => true},
         :conversation_index  => {:text => 'message:ConversationIndex', :writable => true},
-        :conversation_topic  => {:text => 'message:ConversationTopic', :writable => true},
         :internet_message_id  => {:text => 'message:InternetMessageId', :writable => true},
         :is_read  => {:text => 'message:IsRead', :writable => true},
-        :is_response_requested  => {:text => 'message:IsResponseRequested', :writable => true},
         :is_read_receipt_requested  => {:text => 'message:IsReadReceiptRequested', :writable => true},
         :is_delivery_receipt_requested  => {:text => 'message:IsDeliveryReceiptRequested', :writable => true},
         :references  => {:text => 'message:References', :writable => true},
@@ -99,7 +88,6 @@ module Viewpoint
         :when  => {:text => 'calendar:When', :writable => true},
         :is_meeting  => {:text => 'calendar:IsMeeting', :writable => true},
         :is_cancelled  => {:text => 'calendar:IsCancelled', :writable => true},
-        :is_recurring  => {:text => 'calendar:IsRecurring', :writable => true},
         :meeting_request_was_sent  => {:text => 'calendar:MeetingRequestWasSent', :writable => true},
         :is_response_requested  => {:text => 'calendar:IsResponseRequested', :writable => true},
         :calendar_item_type  => {:text => 'calendar:CalendarItemType', :writable => true},
@@ -117,7 +105,6 @@ module Viewpoint
         :appointment_reply_time  => {:text => 'calendar:AppointmentReplyTime', :writable => true},
         :appointment_sequence_number  => {:text => 'calendar:AppointmentSequenceNumber', :writable => true},
         :appointment_state  => {:text => 'calendar:AppointmentState', :writable => true},
-        :recurrence  => {:text => 'calendar:Recurrence', :writable => true},
         :first_occurrence  => {:text => 'calendar:FirstOccurrence', :writable => true},
         :last_occurrence  => {:text => 'calendar:LastOccurrence', :writable => true},
         :modified_occurrences  => {:text => 'calendar:ModifiedOccurrences', :writable => true},
@@ -137,7 +124,6 @@ module Viewpoint
         :assigned_time  => {:text => 'task:AssignedTime', :writable => true},
         :billing_information  => {:text => 'task:BillingInformation', :writable => true},
         :change_count  => {:text => 'task:ChangeCount', :writable => true},
-        :companies  => {:text => 'task:Companies', :writable => true},
         :complete_date  => {:text => 'task:CompleteDate', :writable => true},
         :contacts  => {:text => 'task:Contacts', :writable => true},
         :delegation_state  => {:text => 'task:DelegationState', :writable => true},
@@ -147,7 +133,6 @@ module Viewpoint
         :is_complete  => {:text => 'task:IsComplete', :writable => true},
         :is_recurring  => {:text => 'task:IsRecurring', :writable => true},
         :is_team_task  => {:text => 'task:IsTeamTask', :writable => true},
-        :mileage  => {:text => 'task:Mileage', :writable => true},
         :owner  => {:text => 'task:Owner', :writable => true},
         :percent_complete  => {:text => 'task:PercentComplete', :writable => true},
         :recurrence  => {:text => 'task:Recurrence', :writable => true},
@@ -218,7 +203,6 @@ module Viewpoint
         :item_ids  => {:text => 'conversation:ItemIds', :writable => true},
         :global_item_ids  => {:text => 'conversation:GlobalItemIds', :writable => true}
       }
-
     end
   end
 end

data/lib/ews/types/mailbox_user.rb

@@ -0,0 +1,156 @@
+=begin
+  This file is part of Viewpoint; the Ruby library for Microsoft Exchange Web Services.
+
+  Copyright © 2011 Dan Wanek <dan.wanek@gmail.com>
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+=end
+
+module Viewpoint::EWS::Types
+
+  # 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 MailboxUser
+    include Viewpoint::EWS
+    include Viewpoint::EWS::Types
+
+    MAILBOX_KEY_PATHS = {
+      name: [:name],
+      email_address: [:email_address],
+    }
+    MAILBOX_KEY_TYPES = {}
+    MAILBOX_KEY_ALIAS = {
+      email: :email_address,
+    }
+
+    def initialize(ews, mbox_user)
+      @ews = ews
+      @ews_item = mbox_user
+      simplify!
+    end
+
+    def out_of_office_settings
+      mailbox = {:address => self.email_address}
+      resp = @ews.get_user_oof_settings(mailbox)
+      ewsi = resp.response.clone
+      ewsi.delete(:response_message)
+      return OutOfOffice.new(self,ewsi)
+      s = resp[:oof_settings]
+      @oof_state = s[:oof_state][:text]
+      @oof_ext_audience = s[:external_audience][:text]
+      @oof_start = DateTime.parse(s[:duration][:start_time][:text])
+      @oof_end = DateTime.parse(s[:duration][:end_time][:text])
+      @oof_internal_reply = s[:internal_reply][:message][:text]
+      @oof_external_reply = s[:internal_reply][:message][:text]
+      true
+    end
+
+    # Get information about when the user with the given email address is available.
+    # @param [String] email_address The email address of the person to find availability for.
+    # @param [DateTime] start_time The start of the time range to check as an xs:dateTime.
+    # @param [DateTime] end_time The end of the time range to check as an xs:dateTime.
+    # @see http://msdn.microsoft.com/en-us/library/aa563800(v=exchg.140)
+    def get_user_availability(email_address, start_time, end_time)
+      opts = {
+        mailbox_data: [ :email =>{:address => email_address} ],
+        free_busy_view_options: {
+        time_window: {start_time: start_time, end_time: end_time},
+      }
+      }
+      resp = (Viewpoint::EWS::EWS.instance).ews.get_user_availability(opts)
+      if(resp.status == 'Success')
+        return resp.items
+      else
+        raise EwsError, "GetUserAvailability produced an error: #{resp.code}: #{resp.message}"
+      end
+    end
+
+    # Adds one or more delegates to a principal's mailbox and sets specific access permissions
+    # @see http://msdn.microsoft.com/en-us/library/bb856527.aspx
+    #
+    # @param [String,MailboxUser] delegate_email The user you would like to give delegate access to.
+    #   This can either be a simple String e-mail address or you can pass in a MailboxUser object.
+    # @param [Hash] permissions A hash of folder type keys and permission type values. An example
+    #   would be {:calendar_folder_permission_level => 'Editor'}.  Possible keys are:
+    #   :calendar_folder_permission_level, :tasks_folder_permission_level, :inbox_folder_permission_level
+    #   :contacts_folder_permission_level, :notes_folder_permission_level, :journal_folder_permission_level
+    #   and possible values are:  None/Editor/Reviewer/Author/Custom
+    # @return [true] This method either returns true or raises an error with the message
+    #   as to why this operation did not succeed.
+    def add_delegate!(delegate_email, permissions)
+      # Use a new hash so the passed hash is not modified in case we are in a loop.
+      # Thanks to Markus Roberts for pointing this out.
+      formatted_perms = {}
+      # Modify permissions so we can pass it to the builders
+      permissions.each_pair do |k,v|
+        formatted_perms[k] = {:text => v}
+      end
+
+      resp = (Viewpoint::EWS::EWS.instance).ews.add_delegate(self.email_address, delegate_email, formatted_perms)
+      if(resp.status == 'Success')
+        return true
+      else
+        raise EwsError, "Could not add delegate access for user #{delegate_email}: #{resp.code}, #{resp.message}"
+      end
+    end
+
+    def update_delegate!(delegate_email, permissions)
+      # Modify permissions so we can pass it to the builders
+      formatted_perms = {}
+      permissions.each_pair do |k,v|
+        formatted_perms[k] = {:text => v}
+      end
+
+      resp = (Viewpoint::EWS::EWS.instance).ews.update_delegate(self.email_address, delegate_email, formatted_perms)
+      if(resp.status == 'Success')
+        return true
+      else
+        raise EwsError, "Could not update delegate access for user #{delegate_email}: #{resp.code}, #{resp.message}"
+      end
+    end
+
+    def get_delegate_info()
+      resp = (Viewpoint::EWS::EWS.instance).ews.get_delegate(self.email_address)
+      # if(resp.status == 'Success')
+      #   return true
+      # else
+      #   raise EwsError, "Could not update delegate access for user #{delegate_email}: #{resp.code}, #{resp.message}"
+      # end
+    end
+
+
+    private
+
+
+    def simplify!
+      @ews_item = @ews_item.inject({}){|m,o|
+        m[o.keys.first] = o.values.first[:text];
+        m
+      }
+    end
+
+    def key_paths
+      @key_paths ||= super.merge(MAILBOX_KEY_PATHS)
+    end
+
+    def key_types
+      @key_types ||= super.merge(MAILBOX_KEY_TYPES)
+    end
+
+    def key_alias
+      @key_alias ||= super.merge(MAILBOX_KEY_ALIAS)
+    end
+
+  end # MailboxUser
+end # Viewpoint::EWS::Types

data/lib/ews/types/meeting_cancellation.rb

@@ -0,0 +1,7 @@
+module Viewpoint::EWS::Types
+  class MeetingCancellation
+    include Viewpoint::EWS
+    include Viewpoint::EWS::Types
+    include Viewpoint::EWS::Types::Item
+  end
+end

data/lib/ews/types/meeting_message.rb

@@ -0,0 +1,7 @@
+module Viewpoint::EWS::Types
+  class MeetingMessage
+    include Viewpoint::EWS
+    include Viewpoint::EWS::Types
+    include Viewpoint::EWS::Types::Item
+  end
+end

data/lib/ews/types/meeting_request.rb

@@ -0,0 +1,7 @@
+module Viewpoint::EWS::Types
+  class MeetingRequest
+    include Viewpoint::EWS
+    include Viewpoint::EWS::Types
+    include Viewpoint::EWS::Types::Item
+  end
+end

data/lib/ews/types/meeting_response.rb

@@ -0,0 +1,7 @@
+module Viewpoint::EWS::Types
+  class MeetingResponse
+    include Viewpoint::EWS
+    include Viewpoint::EWS::Types
+    include Viewpoint::EWS::Types::Item
+  end
+end

data/lib/ews/types/message.rb

@@ -0,0 +1,7 @@
+module Viewpoint::EWS::Types
+  class Message
+    include Viewpoint::EWS
+    include Viewpoint::EWS::Types
+    include Viewpoint::EWS::Types::Item
+  end
+end

data/lib/ews/types/modified_event.rb

@@ -0,0 +1,48 @@
+=begin
+  This file is part of Viewpoint; the Ruby library for Microsoft Exchange Web Services.
+
+  Copyright © 2011 Dan Wanek <dan.wanek@gmail.com>
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+=end
+
+module Viewpoint::EWS::Types
+
+  class ModifiedEvent < Event
+
+    MODIFIED_EVENT_KEY_PATHS = {
+    }
+
+    MODIFIED_EVENT_KEY_TYPES = {
+    }
+
+    MODIFIED_EVENT_KEY_ALIAS = { }
+
+
+    private
+
+
+    def key_paths
+      @key_paths ||= super.merge MODIFIED_EVENT_KEY_PATHS
+    end
+
+    def key_types
+      @key_types ||= super.merge MODIFIED_EVENT_KEY_TYPES
+    end
+
+    def key_alias
+      @key_alias ||= super.merge MODIFIED_EVENT_KEY_ALIAS
+    end
+
+  end
+end

data/lib/{extensions/string.rb → ews/types/moved_event.rb}

@@ -16,20 +16,36 @@
   limitations under the License.
 =end
 
-# Custom extensions to the class String
-class String
-  # Change CamelCased strings to ruby_cased strings
-  # It uses the lookahead assertion ?=  In this case it basically says match
-  # anything followed by a capital letter, but not the capital letter itself.
-  # @see http://www.pcre.org/pcre.txt The PCRE guide for more details
-  def ruby_case
-    self.split(/(?=[A-Z])/).join('_').downcase
-  end
+module Viewpoint::EWS::Types
+
+  class MovedEvent < Event
+
+    MOVED_EVENT_KEY_PATHS = {
+      :old_item_id    => [:old_item_id, :attribs],
+      :old_folder_id  => [:old_folder_id, :attribs],
+      :old_parent_folder_id  => [:old_parent_folder_id, :attribs],
+    }
+
+    MOVED_EVENT_KEY_TYPES = {
+    }
+
+    MOVED_EVENT_KEY_ALIAS = { }
+
+
+    private
+
+
+    def key_paths
+      @key_paths ||= super.merge MOVED_EVENT_KEY_PATHS
+    end
+
+    def key_types
+      @key_types ||= super.merge MOVED_EVENT_KEY_TYPES
+    end
+
+    def key_alias
+      @key_alias ||= super.merge MOVED_EVENT_KEY_ALIAS
+    end
 
-  # Change a ruby_cased string to CamelCased
-  def camel_case
-    self.split(/_/).map { |i|
-      i.sub(/^./) { |s| s.upcase }
-    }.join
   end
-end # String
+end

data/lib/ews/types/new_mail_event.rb

@@ -0,0 +1,24 @@
+=begin
+  This file is part of Viewpoint; the Ruby library for Microsoft Exchange Web Services.
+
+  Copyright © 2011 Dan Wanek <dan.wanek@gmail.com>
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+=end
+
+module Viewpoint::EWS::Types
+
+  class NewMailEvent < Event
+
+  end
+end

data/lib/ews/types/out_of_office.rb

@@ -0,0 +1,147 @@
+=begin
+  This file is part of Viewpoint; the Ruby library for Microsoft Exchange Web Services.
+
+  Copyright © 2011 Dan Wanek <dan.wanek@gmail.com>
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+=end
+
+module Viewpoint::EWS::Types
+
+    OOF_KEY_PATHS = {
+      :enabled?   => [:oof_settings, :oof_state],
+      :scheduled? => [:oof_settings, :oof_state],
+      :duration   => [:oof_settings, :duration],
+    }
+
+    OOF_KEY_TYPES = {
+      :enabled?   => ->(str){str == :enabled},
+      :scheduled? => ->(str){str == :scheduled},
+      :duration   => ->(hsh){ hsh[:start_time]..hsh[:end_time] },
+    }
+
+    OOF_KEY_ALIAS = {}
+
+  # This represents OutOfOffice settings
+  # @see http://msdn.microsoft.com/en-us/library/aa563465.aspx
+  class OutOfOffice
+    include Viewpoint::EWS
+    include Viewpoint::EWS::Types
+
+    attr_reader :user
+
+    # @param [MailboxUser] user
+    # @param [Hash] ews_item
+    def initialize(user, ews_item)
+      @ews =  user.ews
+      @user = user
+      @ews_item = ews_item
+      @changed = false
+      simplify!
+    end
+
+    def changed?
+      @changed
+    end
+
+    def save!
+      return true unless changed?
+      opts = { mailbox: {address: user.email_address} }.merge(@ews_item[:oof_settings])
+      resp = @ews.set_user_oof_settings(opts)
+      if resp.success?
+        @changed = false
+        true
+      else
+        raise SaveFailed, "Could not save #{self.class}. #{resp.code}: #{resp.message}"
+      end
+    end
+
+    def enable
+      return true if enabled?
+      @changed = true
+      @ews_item[:oof_settings][:oof_state] = :enabled
+    end
+
+    def disable
+      return true unless enabled? || scheduled?
+      @changed = true
+      @ews_item[:oof_settings][:oof_state] = :disabled
+    end
+
+    # Schedule an out of office.
+    # @param [DateTime] start_time
+    # @param [DateTime] end_time
+    def schedule(start_time, end_time)
+      @changed = true
+      @ews_item[:oof_settings][:oof_state] = :scheduled
+      set_duration start_time, end_time
+    end
+
+    # Specify a duration for this Out Of Office setting
+    # @param [DateTime] start_time
+    # @param [DateTime] end_time
+    def set_duration(start_time, end_time)
+      @changed = true
+      @ews_item[:oof_settings][:duration][:start_time] = start_time
+      @ews_item[:oof_settings][:duration][:end_time] = end_time
+    end
+
+    # A message to send to internal users
+    # @param [String] message
+    def internal_reply=(message)
+      @changed = true
+      @ews_item[:oof_settings][:internal_reply] = message
+    end
+
+    # A message to send to external users
+    # @param [String] message
+    def external_reply=(message)
+      @changed = true
+      @ews_item[:oof_settings][:external_reply] = message
+    end
+
+
+private
+
+    def key_paths
+      @key_paths ||= super.merge(OOF_KEY_PATHS)
+    end
+
+    def key_types
+      @key_types ||= super.merge(OOF_KEY_TYPES)
+    end
+
+    def key_alias
+      @key_alias ||= super.merge(OOF_KEY_ALIAS)
+    end
+
+    def simplify!
+      oof_settings = @ews_item[:oof_settings][:elems].inject(:merge)
+      oof_settings[:oof_state] = oof_settings[:oof_state][:text].downcase.to_sym
+      oof_settings[:external_audience] = oof_settings[:external_audience][:text]
+      if oof_settings[:duration]
+        dur = oof_settings[:duration][:elems].inject(:merge)
+        oof_settings[:duration] = {
+          start_time: DateTime.iso8601(dur[:start_time][:text]),
+          end_time:   DateTime.iso8601(dur[:end_time][:text])
+        }
+      end
+      oof_settings[:internal_reply] = oof_settings[:internal_reply][:elems][0][:message][:text] || ""
+      oof_settings[:external_reply] = oof_settings[:external_reply][:elems][0][:message][:text] || ""
+      @ews_item[:oof_settings] = oof_settings
+      @ews_item[:allow_external_oof] = @ews_item[:allow_external_oof][:text]
+    end
+
+  end #OutOfOffice
+
+end