stxt-viewpoint 1.0.0.beta.3

data/lib/ews/templates/message.rb

@@ -0,0 +1,73 @@
+module Viewpoint::EWS
+  module Template
+    class Message < OpenStruct
+
+      def initialize(opts = {})
+        super opts.clone
+        init_defaults!
+      end
+
+      # Format this object for EWS backend consumption.
+      def to_ews
+        ews_opts, msg = to_ews_basic
+        ews_opts.merge({items: [{message: msg}]})
+      end
+
+      def has_attachments?
+        !(file_attachments.empty? && item_attachments.empty? && inline_attachments.empty?)
+      end
+
+
+      private
+
+
+      def init_defaults!
+        self.subject ||= nil
+        self.body ||= nil
+        self.body_type ||= 'Text'
+        self.importance ||= 'Normal'
+        self.draft ||= false
+        self.to_recipients ||= []
+        self.cc_recipients ||= []
+        self.bcc_recipients ||= []
+        self.file_attachments ||= []
+        self.item_attachments ||= []
+        self.inline_attachments ||= []
+        self.extended_properties ||= []
+      end
+
+      def to_ews_basic
+        ews_opts = {}
+        ews_opts[:message_disposition] = (draft ? 'SaveOnly' : 'SendAndSaveCopy')
+
+        if saved_item_folder_id
+          if saved_item_folder_id.kind_of?(Hash)
+            ews_opts[:saved_item_folder_id] = saved_item_folder_id
+          else
+            ews_opts[:saved_item_folder_id] = {id: saved_item_folder_id}
+          end
+        end
+
+        msg = {}
+        msg[:subject] = subject if subject
+        msg[:body] = {text: body, body_type: body_type} if body
+
+        msg[:importance] = importance if importance
+
+        to_r = to_recipients.collect{|r| {mailbox: {email_address: r}}}
+        msg[:to_recipients] = to_r unless to_r.empty?
+
+        cc_r = cc_recipients.collect{|r| {mailbox: {email_address: r}}}
+        msg[:cc_recipients] = cc_r unless cc_r.empty?
+
+        bcc_r = bcc_recipients.collect{|r| {mailbox: {email_address: r}}}
+        msg[:bcc_recipients] = bcc_r unless bcc_r.empty?
+
+        msg[:extended_properties] = extended_properties unless extended_properties.empty?
+
+        [ews_opts, msg]
+      end
+
+    end
+  end
+end

data/lib/ews/templates/reply_to_item.rb

@@ -0,0 +1,25 @@
+module Viewpoint::EWS
+  module Template
+    class ReplyToItem < Message
+
+      # Format this object for EWS backend consumption.
+      def to_ews
+        ews_opts, msg = to_ews_basic
+        msg[:reference_item_id] = reference_item_id
+        msg[:new_body_content]  = {text: new_body_content, body_type: new_body_type}
+        ews_opts.merge({items: [{ews_type => msg}]})
+      end
+
+      private
+
+
+      def init_defaults!
+        super
+        self.new_body_content ||= ''
+        self.new_body_type ||= 'Text'
+        self.ews_type = :reply_to_item
+      end
+
+    end
+  end
+end

data/lib/ews/templates/task.rb

@@ -0,0 +1,74 @@
+module Viewpoint::EWS
+  module Template
+  # Template for creating Tasks
+  # @see http://msdn.microsoft.com/en-us/library/exchange/aa564765.aspx
+  class Task < OpenStruct
+
+      # Available parameters with the required ordering
+      PARAMETERS = %w{mime_content item_id parent_folder_id item_class subject sensitivity body attachments
+            date_time_received size categories in_reply_to is_submitted is_draft is_from_me is_resend
+            is_unmodified internet_message_headers date_time_sent date_time_created response_objects
+            reminder_due_by reminder_is_set reminder_minutes_before_start display_cc display_to
+            has_attachments extended_property culture actual_work assigned_time billing_information
+            change_count companies complete_date contacts delegation_state delegator due_date
+            is_assignment_editable is_complete is_recurring is_team_task mileage owner percent_complete
+            recurrence start_date status status_description total_work effective_rights last_modified_name
+            last_modified_time is_associated web_client_read_form_query_string
+            web_client_edit_form_query_string conversation_id unique_body 
+      }.map(&:to_sym).freeze
+
+      # Returns a new Task template
+      def initialize(opts = {})
+        super opts.dup
+      end
+
+      # EWS CreateItem container
+      # @return [Hash]
+      def to_ews_create
+        structure = {}
+
+        if self.saved_item_folder_id
+          if self.saved_item_folder_id.kind_of?(Hash)
+            structure[:saved_item_folder_id] = saved_item_folder_id
+          else
+            structure[:saved_item_folder_id] = {id: saved_item_folder_id}
+          end
+        end
+
+        structure[:items] = [{task: to_ews_item}]
+        structure
+      end
+
+      # EWS Item hash
+      #
+      # Puts all known parameters in the required ordering and structure
+      # @return [Hash]
+      def to_ews_item
+        item_parameters = {}
+        PARAMETERS.each do |key|
+          if !(value = self.send(key)).nil?
+
+            # Convert non duplicable values to String
+            case value
+              when NilClass, FalseClass, TrueClass, Symbol, Numeric
+                value = value.to_s
+            end
+
+            # Convert attributes
+            case key
+              when :start_date, :due_date
+                item_parameters[key] = {text: value.respond_to?(:iso8601) ? value.iso8601 : value}
+              when :body
+                item_parameters[key] = {body_type: self.body_type || 'Text', text: value.to_s}
+              else
+                item_parameters[key] = value
+            end
+          end
+        end
+
+        item_parameters
+      end
+
+    end
+  end
+end

data/lib/ews/types/attachment.rb

@@ -0,0 +1,77 @@
+=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
+  # A generic Attachment.  This class should not be instantiated directly.  You
+  # should use one of the subclasses like FileAttachment or ItemAttachment.
+  class Attachment
+    include Viewpoint::EWS
+    include Viewpoint::EWS::Types
+    include Viewpoint::EWS::Types::Item
+
+    ATTACH_KEY_PATHS = {
+      :id   => [:attachment_id, :attribs, :id],
+      :parent_item_id  => [:attachment_id, :attribs, :root_item_id],
+      :parent_change_key  => [:attachment_id, :attribs, :root_item_change_key],
+      :name => [:name, :text],
+      :content_type => [:content_type, :text],
+      :content_id => [:content_id],
+      :size => [:size, :text],
+      :last_modified_time => [:last_modified_time, :text],
+      :is_inline? => [:is_inline, :text],
+    }
+
+    ATTACH_KEY_TYPES = {
+      is_inline?:   ->(str){str.downcase == 'true'},
+      last_modified_type: ->(str){DateTime.parse(str)},
+      size: ->(str){str.to_i},
+      content_id: :fix_content_id,
+    }
+
+    ATTACH_KEY_ALIAS = { }
+
+    # @param [Hash] attachment The attachment ews_item
+    def initialize(item, attachment)
+      @item = item
+      super(item.ews, attachment)
+    end
+
+
+    private
+
+
+    def key_paths
+      @key_paths ||= ATTACH_KEY_PATHS
+    end
+
+    def key_types
+      @key_types ||= ATTACH_KEY_TYPES
+    end
+
+    def key_alias
+      @key_alias ||= ATTACH_KEY_ALIAS
+    end
+
+    # Sometimes the SOAP response comes back with two identical content_ids.
+    # This method fishes them out no matter which way them come.
+    def fix_content_id(content_id)
+      content_id.is_a?(Array) ? content_id.last[:text] : content_id[:text]
+    end
+
+  end
+end

data/lib/ews/types/attendee.rb

@@ -0,0 +1,27 @@
+=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 Attendee < MailboxUser
+  end # Attendee
+
+end # Viewpoint::EWS::Types

data/lib/ews/types/calendar_folder.rb

@@ -0,0 +1,50 @@
+module Viewpoint::EWS::Types
+  class CalendarFolder
+    include Viewpoint::EWS
+    include Viewpoint::EWS::Types
+    include Viewpoint::EWS::Types::GenericFolder
+
+    # 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, opts={})
+      items do |obj|
+        obj.restriction = { :and =>
+          [
+            {:is_greater_than_or_equal_to =>
+              [
+                {:field_uRI => {:field_uRI=>'calendar:Start'}},
+                {:field_uRI_or_constant=>{:constant => {:value =>start_date}}}
+              ]
+            },
+            {:is_less_than_or_equal_to =>
+              [
+                {:field_uRI => {:field_uRI=>'calendar:End'}},
+                {:field_uRI_or_constant=>{:constant => {:value =>end_date}}}
+              ]
+            }
+          ]
+        }
+      end
+    end
+
+    # Creates a new appointment
+    # @param attributes [Hash] Parameters of the calendar item. Some example attributes are listed below.
+    # @option attributes :subject [String]
+    # @option attributes :start [Time]
+    # @option attributes :end [Time]
+    # @return [CalendarItem]
+    # @see Template::CalendarItem
+    def create_item(attributes)
+      template = Viewpoint::EWS::Template::CalendarItem.new attributes
+      template.saved_item_folder_id = {id: self.id, change_key: self.change_key}
+      rm = ews.create_item(template.to_ews_create).response_messages.first
+      if rm && rm.success?
+        CalendarItem.new ews, rm.items.first[:calendar_item][:elems].first
+      else
+        raise EwsCreateItemError, "Could not create item in folder. #{rm.code}: #{rm.message_text}" unless rm
+      end
+    end
+
+  end
+end

data/lib/ews/types/calendar_item.rb

@@ -0,0 +1,122 @@
+module Viewpoint::EWS::Types
+  class CalendarItem
+    include Viewpoint::EWS
+    include Viewpoint::EWS::Types
+    include Viewpoint::EWS::Types::Item
+    include Viewpoint::StringUtils
+
+    CALENDAR_ITEM_KEY_PATHS = {
+      recurring?:   [:is_recurring, :text],
+      meeting?:     [:is_meeting, :text],
+      cancelled?:   [:is_cancelled, :text],
+      duration:   [:duration, :text],
+      time_zone:   [:time_zone, :text],
+      start:   [:start, :text],
+      end:   [:end, :text],
+      location:   [:location, :text],
+      all_day?:   [:is_all_day_event, :text],
+      my_response_type:   [:my_response_type, :text],
+      organizer: [:organizer, :elems, 0, :mailbox, :elems],
+      required_attendees: [:required_attendees, :elems ],
+      recurrence: [:recurrence, :elems ],
+      deleted_occurrences: [:deleted_occurrences, :elems ],
+      modified_occurrences: [:modified_occurrences, :elems ],
+      has_attachments?: [:has_attachments, :text ],
+      attachments: [:attachments, :elems ]
+   }
+
+    CALENDAR_ITEM_KEY_TYPES = {
+      recurring?:   ->(str){str.downcase == 'true'},
+      meeting?:     ->(str){str.downcase == 'true'},
+      cancelled?:   ->(str){str.downcase == 'true'},
+      all_day?:   ->(str){str.downcase == 'true'},
+      organizer: :build_mailbox_user,
+      required_attendees: :build_attendees_users,
+      deleted_occurrences: :build_deleted_occurrences,
+      modified_occurrences: :build_modified_occurrences
+    }
+    CALENDAR_ITEM_KEY_ALIAS = {}
+
+    # Updates the specified item attributes
+    #
+    # Uses `SetItemField` if value is present and `DeleteItemField` if value is nil
+    # @param updates [Hash] with (:attribute => value)
+    # @param options [Hash]
+    # @option options :conflict_resolution [String] one of 'NeverOverwrite', 'AutoResolve' (default) or 'AlwaysOverwrite'
+    # @option options :send_meeting_invitations_or_cancellations [String] one of 'SendToNone' (default), 'SendOnlyToAll',
+    #   'SendOnlyToChanged', 'SendToAllAndSaveCopy' or 'SendToChangedAndSaveCopy'
+    # @return [CalendarItem, false]
+    # @example Update Subject and Body
+    #   item = #...
+    #   item.update_item!(subject: 'New subject', body: 'New Body')
+    # @see http://msdn.microsoft.com/en-us/library/exchange/aa580254.aspx
+    # @todo AppendToItemField updates not implemented
+    def update_item!(updates, options = {})
+      item_updates = []
+      updates.each do |attribute, value|
+        item_field = FIELD_URIS[attribute][:text] if FIELD_URIS.include? attribute
+        field = {field_uRI: {field_uRI: item_field}}
+
+        if value.nil? && item_field
+          # Build DeleteItemField Change
+          item_updates << {delete_item_field: field}
+        elsif item_field
+          # Build SetItemField Change
+          item = Viewpoint::EWS::Template::CalendarItem.new(attribute => value)
+
+          # Remap attributes because ews_builder #dispatch_field_item! uses #build_xml!
+          item_attributes = item.to_ews_item.map do |name, value|
+            if value.is_a? String
+              {name => {text: value}}
+            elsif value.is_a? Hash
+              node = {name => {}}
+              value.each do |attrib_key, attrib_value|
+                attrib_key = camel_case(attrib_key) unless attrib_key == :text
+                node[name][attrib_key] = attrib_value
+              end
+              node
+            else
+              {name => value}
+            end
+          end
+
+          item_updates << {set_item_field: field.merge(calendar_item: {sub_elements: item_attributes})}
+        else
+          # Ignore unknown attribute
+        end
+      end
+
+      if item_updates.any?
+        data = {}
+        data[:conflict_resolution] = options[:conflict_resolution] || 'AutoResolve'
+        data[:send_meeting_invitations_or_cancellations] = options[:send_meeting_invitations_or_cancellations] || 'SendToNone'
+        data[:item_changes] = [{item_id: self.item_id, updates: item_updates}]
+        rm = ews.update_item(data).response_messages.first
+        if rm && rm.success?
+          self.get_all_properties!
+          self
+        else
+          raise EwsCreateItemError, "Could not update calendar item. #{rm.code}: #{rm.message_text}" unless rm
+        end
+      end
+
+    end
+
+
+    private
+
+    def key_paths
+      super.merge(CALENDAR_ITEM_KEY_PATHS)
+    end
+
+    def key_types
+      super.merge(CALENDAR_ITEM_KEY_TYPES)
+    end
+
+    def key_alias
+      super.merge(CALENDAR_ITEM_KEY_ALIAS)
+    end
+
+
+  end
+end

data/lib/ews/types/contact.rb

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

data/lib/ews/types/contacts_folder.rb

@@ -0,0 +1,8 @@
+module Viewpoint::EWS::Types
+  class ContactsFolder
+    include Viewpoint::EWS
+    include Viewpoint::EWS::Types
+    include Viewpoint::EWS::Types::GenericFolder
+
+  end
+end

data/lib/ews/types/copied_event.rb

@@ -0,0 +1,51 @@
+=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 CopiedEvent < Event
+
+    COPIED_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],
+    }
+
+    COPIED_EVENT_KEY_TYPES = {
+    }
+
+    COPIED_EVENT_KEY_ALIAS = { }
+
+
+    private
+
+
+    def key_paths
+      @key_paths ||= super.merge COPIED_EVENT_KEY_PATHS
+    end
+
+    def key_types
+      @key_types ||= super.merge COPIED_EVENT_KEY_TYPES
+    end
+
+    def key_alias
+      @key_alias ||= super.merge COPIED_EVENT_KEY_ALIAS
+    end
+
+  end
+end

data/lib/ews/types/created_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 CreatedEvent < Event
+
+  end
+end

data/lib/ews/types/deleted_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 DeletedEvent < Event
+
+  end
+end

data/lib/ews/types/distribution_list.rb

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

data/lib/ews/types/event.rb

@@ -0,0 +1,62 @@
+=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 Event
+    include Viewpoint::EWS
+    include Viewpoint::EWS::Types
+    include Viewpoint::EWS::Types::Item
+
+    EVENT_KEY_PATHS = {
+      :watermark  => [:watermark, :text],
+      :timestamp  => [:time_stamp, :text],
+      :item_id    => [:item_id, :attribs],
+      :folder_id  => [:folder_id, :attribs],
+      :parent_folder_id  => [:parent_folder_id, :attribs],
+    }
+
+    EVENT_KEY_TYPES = {
+      :timestamp  => ->(ts){ DateTime.iso8601(ts) }
+    }
+
+    EVENT_KEY_ALIAS = { }
+
+    def initialize(ews, event)
+      @ews = ews
+      super(ews, event)
+    end
+
+
+    private
+
+
+    def key_paths
+      @key_paths ||= EVENT_KEY_PATHS
+    end
+
+    def key_types
+      @key_types ||= EVENT_KEY_TYPES
+    end
+
+    def key_alias
+      @key_alias ||= EVENT_KEY_ALIAS
+    end
+
+  end
+end

data/lib/ews/types/export_items_response_message.rb

@@ -0,0 +1,52 @@
+module Viewpoint::EWS::Types
+  
+  class ExportItemsResponseMessage
+    include Viewpoint::EWS
+    include Viewpoint::EWS::Types
+    include Viewpoint::EWS::Types::Item
+
+    BULK_KEY_PATHS = {
+      :id          => [:item_id, :attribs, :id],
+      :change_key  => [:item_id, :attribs, :change_key],
+      :data        => [:data, :text]
+    }
+
+    BULK_KEY_TYPES = { }
+
+    BULK_KEY_ALIAS = { }
+
+    def initialize(ews, bulk_item)
+      super(ews, bulk_item)
+      @item = bulk_item
+      @ews = ews
+    end
+
+    def id
+      @item[:item_id][:attribs][:id]
+    end
+
+    def change_key
+      @item[:item_id][:attribs][:change_key]
+    end
+
+    def data
+      @item[:data][:text]
+    end
+
+
+    private
+
+    def key_paths
+      @key_paths ||= BULK_KEY_PATHS
+    end
+
+    def key_types
+      @key_types ||= BULK_KEY_TYPES
+    end
+
+    def key_alias
+      @key_alias ||= BULK_KEY_ALIAS
+    end
+
+  end
+end