viewpoint2 1.3.0

data/lib/ews/soap/responses/subscribe_response_message.rb

@@ -0,0 +1,35 @@
+=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::SOAP
+  class SubscribeResponseMessage < ResponseMessage
+
+    def subscription
+      safe_hash_access message, [:elems]
+    end
+
+    def subscription_id
+      safe_hash_access subscription, [:subscription_id, :text]
+    end
+
+    def watermark
+      safe_hash_access subscription, [:watermark, :text]
+    end
+
+  end # SubscribeResponseMessage
+end # Viewpoint::EWS::SOAP

data/lib/ews/soap/responses/sync_folder_hierarchy_response_message.rb

@@ -0,0 +1,36 @@
+=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::SOAP
+  class SyncFolderHierarchyResponseMessage < ResponseMessage
+
+    def sync_state
+      safe_hash_access message, [:elems, :sync_state, :text]
+    end
+
+    def includes_last_folder_in_range?
+      ans = safe_hash_access message, [:elems, :includes_last_folder_in_range, :text]
+      ans.downcase == 'true'
+    end
+
+    def changes
+      safe_hash_access(message, [:elems, :changes, :elems]) || []
+    end
+
+  end # SyncFolderHierarchyResponseMessage
+end # Viewpoint::EWS::SOAP

data/lib/ews/soap/responses/sync_folder_items_response_message.rb

@@ -0,0 +1,36 @@
+=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::SOAP
+  class SyncFolderItemsResponseMessage < ResponseMessage
+
+    def sync_state
+      safe_hash_access message, [:elems, :sync_state, :text]
+    end
+
+    def includes_last_item_in_range?
+      ans = safe_hash_access message, [:elems, :includes_last_item_in_range, :text]
+      ans.downcase == 'true'
+    end
+
+    def changes
+      safe_hash_access(message, [:elems, :changes, :elems]) || []
+    end
+
+  end # SyncFolderItemsResponseMessage
+end # Viewpoint::EWS::SOAP

data/lib/ews/templates/calendar_item.rb

@@ -0,0 +1,79 @@
+module Viewpoint::EWS
+  module Template
+  # Template for creating CalendarItems
+  # @see http://msdn.microsoft.com/en-us/library/exchange/aa564765.aspx
+  class CalendarItem < 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 start end
+        original_start is_all_day_event legacy_free_busy_status location when is_meeting is_cancelled is_recurring
+        meeting_request_was_sent is_response_requested calendar_item_type my_response_type organizer
+        required_attendees optional_attendees resources conflicting_meeting_count adjacent_meeting_count
+        conflicting_meetings adjacent_meetings duration time_zone appointment_reply_time appointment_sequence_number
+        appointment_state recurrence first_occurrence last_occurrence modified_occurrences deleted_occurrences
+        meeting_time_zone start_time_zone end_time_zone conference_type allow_new_time_proposal is_online_meeting
+        meeting_workspace_url net_show_url 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 CalendarItem template
+      def initialize(opts = {})
+        super opts.dup
+      end
+
+      # EWS CreateItem container
+      # @return [Hash]
+      def to_ews_create(opts = {})
+        structure = {}
+        structure[:message_disposition] = (draft ? 'SaveOnly' : 'SendAndSaveCopy')
+        # options
+        structure[:send_meeting_invitations] = (opts.has_key?(:send_meeting_invitations) ? opts[:send_meeting_invitations] : 'SendToAllAndSaveCopy')
+
+        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] = [{calendar_item: 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, :end
+                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/templates/forward_item.rb

@@ -0,0 +1,24 @@
+module Viewpoint::EWS
+  module Template
+    class ForwardItem < 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: [{forward_item: msg}]})
+      end
+
+      private
+
+
+      def init_defaults!
+        super
+        self.new_body_content ||= ''
+        self.new_body_type ||= 'Text'
+      end
+
+    end
+  end
+end

data/lib/ews/templates/message.rb

@@ -0,0 +1,76 @@
+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.is_read = true if is_read.nil?
+        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[:is_read] = is_read
+
+        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.rb

@@ -0,0 +1,194 @@
+module Viewpoint::EWS
+  module Types
+    include Viewpoint::StringUtils
+
+    KEY_PATHS = {
+      extended_properties: [:extended_property],
+    }
+    KEY_TYPES = {
+      extended_properties: :build_extended_properties,
+    }
+    KEY_ALIAS = {}
+
+    attr_reader :ews_item
+
+    # @param [SOAP::ExchangeWebService] ews the EWS reference
+    # @param [Hash] ews_item the EWS parsed response document
+    def initialize(ews, ews_item)
+      @ews      = ews
+      @ews_item = ews_item
+      @shallow  = true
+      @frozen = false
+    end
+
+    def method_missing(method_sym, *arguments, &block)
+      if method_keys.include?(method_sym)
+        type_convert( method_sym, resolve_method(method_sym) )
+      else
+        super
+      end
+    end
+
+    def to_s
+      "#{self.class.name}: EWS METHODS: #{self.ews_methods.sort.join(', ')}"
+    end
+
+    def frozen?
+      @frozen
+    end
+
+    # @param ronly [Boolean] true to freeze
+    def freeze!
+      @frozen = true
+    end
+
+    def unfreeze!
+      @frozen = false
+    end
+
+    def shallow?
+      @shallow
+    end
+
+    def mark_deep!
+      @shallow = false
+    end
+
+    def auto_deepen?
+      ews.auto_deepen
+    end
+
+    def deepen!
+      if shallow?
+        self.get_all_properties!
+        @shallow = false
+        true
+      end
+    end
+    alias_method :enlighten!, :deepen!
+
+    # @see http://www.ruby-doc.org/core/classes/Object.html#M000333
+    def respond_to?(method_sym, include_private = false)
+      if method_keys.include?(method_sym)
+        true
+      else
+        super
+      end
+    end
+
+    def methods(include_super = true)
+      super + ews_methods
+    end
+
+    def ews_methods
+      key_paths.keys + key_alias.keys
+    end
+
+    protected # things like OutOfOffice need protected level access
+
+    def ews
+      @ews
+    end
+
+    private
+
+    def key_paths
+      KEY_PATHS
+    end
+
+    def key_types
+      KEY_TYPES
+    end
+
+    def key_alias
+      KEY_ALIAS
+    end
+
+    def class_by_name(cname)
+      if(cname.instance_of? Symbol)
+        cname = camel_case(cname)
+      end
+      Viewpoint::EWS::Types.const_get(cname)
+    end
+
+    def type_convert(key,str)
+      begin
+        key = key_alias[key] || key
+        if key_types[key]
+          key_types[key].is_a?(Symbol) ? method(key_types[key]).call(str) : key_types[key].call(str)
+        else
+          str
+        end
+      rescue
+        nil
+      end
+    end
+
+    def resolve_method(method_sym)
+      begin
+        resolve_key_path(@ews_item, method_path(method_sym))
+      rescue
+        if shallow?
+          if frozen?
+            raise EwsFrozenObjectError, "Could not resolve :#{method_sym} on frozen object."
+          elsif auto_deepen?
+            enlighten!
+            retry
+          else
+            if !auto_deepen?
+              if ews.no_auto_deepen_behavior == :raise
+                raise EwsMinimalObjectError, "Could not resolve :#{method_sym}. #auto_deepen set to false"
+              else
+                nil
+              end
+            else
+            end
+          end
+        else
+          nil
+        end
+      end
+    end
+
+    def resolve_key_path(hsh, path)
+      k = path.first
+      return hsh[k] if path.length == 1
+      resolve_key_path(hsh[k],path[1..-1])
+    end
+
+    def method_keys
+      key_paths.keys + key_alias.keys
+    end
+
+    # Resolve the method path with or without an alias
+    def method_path(sym)
+      key_paths[key_alias[sym] || sym]
+    end
+
+    def build_extended_properties(eprops)
+      h = {}
+      # todo
+      # the return pattern seems broken in some cases,
+      # probably needs fixing via a dedicated response parser
+      eprops.each do |e|
+        if e.size == 1
+          e[:elems].each_cons(2) do |k,v|
+            key = k[:extended_field_u_r_i][:attribs][:property_name].downcase.to_sym
+            val = v[:value][:text]
+            h.store(key,val)
+          end
+        elsif e.size == 2
+          e[1].each_cons(2) do |k,v|
+            key = k[:extended_field_u_r_i][:attribs][:property_name].downcase.to_sym
+            val = v[:value][:text]
+            h.store(key,val)
+          end
+        else
+          raise EwsMinimalObjectError, "Not prepared to deal with elements greater than 2"
+        end
+      end
+      h
+    end
+
+  end
+end