stxt-viewpoint 1.0.0.beta.3

data/lib/ews/soap/parsers/ews_sax_document.rb

@@ -0,0 +1,70 @@
+=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
+  # Parse the incoming response document via a SAX parser instead of the
+  # traditional DOM parser. In early benchmarks this was performing about
+  # 132% faster than the DOM-based parser for large documents.
+  class EwsSaxDocument < Nokogiri::XML::SAX::Document
+    include Viewpoint::EWS
+    include Viewpoint::StringUtils
+
+    attr_reader :struct
+
+    def initialize
+      @struct = {}
+      @elems  = []
+    end
+
+    def characters(string)
+      # FIXME: Move white space removal to somewhere else.
+      # This function can be called multiple times. In this case newlines in Text Bodies get stripped.
+      # See: https://github.com/zenchild/Viewpoint/issues/90
+      #string.strip!
+      return if string.empty?
+      if @elems.last[:text]
+        @elems.last[:text] += string
+      else
+        @elems.last[:text] = string
+      end
+    end
+
+    def start_element_namespace(name, attributes = [], prefix = nil, uri = nil, ns = [])
+      name = ruby_case(name).to_sym
+      elem = {}
+      unless attributes.empty?
+        elem[:attribs] = attributes.collect{|a|
+          { ruby_case(a.localname).to_sym => a.value}
+        }.inject(&:merge)
+      end
+      @elems << elem
+    end
+
+    def end_element_namespace name, prefix=nil, uri=nil
+      name = ruby_case(name).to_sym
+      elem = @elems.pop
+      if @elems.empty?
+        @struct[name] = elem
+      else
+        @elems.last[:elems] = [] unless @elems.last[:elems].is_a?(Array)
+        @elems.last[:elems] << {name => elem}
+      end
+    end
+
+  end
+end

data/lib/ews/soap/response_message.rb

@@ -0,0 +1,80 @@
+=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 ResponseMessage
+
+    attr_reader :message, :type
+
+    def initialize(message)
+      @type    = message.keys.first
+      @message = message[@type]
+    end
+
+    def response_class
+      message[:attribs][:response_class]
+    end
+    alias :status :response_class
+
+    def success?
+      response_class == 'Success'
+    end
+
+    def message_text
+      safe_hash_access message, [:elems, :message_text, :text]
+    end
+
+    def response_code
+      safe_hash_access message, [:elems, :response_code, :text]
+    end
+    alias :code :response_code
+
+    def message_xml
+      safe_hash_access message, [:elems, :message_xml, :text]
+    end
+
+    def items
+      safe_hash_access(message, [:elems, :items, :elems]) || []
+    end
+
+
+    private
+
+
+    def safe_hash_access(hsh, keys)
+      key = keys.shift
+      return nil unless hsh.is_a?(Hash) && hsh.has_key?(key)
+
+      if keys.empty?
+        hsh[key]
+      else
+        safe_hash_access hsh[key], keys
+      end
+    end
+
+  end
+end # Viewpoint::EWS::SOAP
+
+require_relative './responses/create_item_response_message'
+require_relative './responses/create_attachment_response_message'
+require_relative './responses/find_item_response_message'
+require_relative './responses/subscribe_response_message'
+require_relative './responses/get_events_response_message'
+require_relative './responses/send_notification_response_message'
+require_relative './responses/sync_folder_items_response_message'
+require_relative './responses/sync_folder_hierarchy_response_message'

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

@@ -0,0 +1,47 @@
+=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 CreateAttachmentResponseMessage < ResponseMessage
+    include Viewpoint::StringUtils
+
+    def attachments
+      return @attachments if @attachments
+
+      a = safe_hash_access message, [:elems, :attachments, :elems]
+      @attachments = a.nil? ? nil : parse_attachments(a)
+    end
+
+
+    private
+
+
+    def parse_attachments(att)
+      att.collect do |a|
+        type = a.keys.first
+        klass = Viewpoint::EWS::Types.const_get(camel_case(type))
+        item = OpenStruct.new
+        item.ews = nil
+        klass.new(item, a[type])
+      end
+    end
+
+  end # CreateAttachmentResponseMessage
+
+end # Viewpoint::EWS::SOAP

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

@@ -0,0 +1,25 @@
+=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 CreateItemResponseMessage < ResponseMessage
+
+  end # CreateItemResponseMessage
+
+end # Viewpoint::EWS::SOAP

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

@@ -0,0 +1,80 @@
+=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 RootFolder
+
+    attr_reader :root
+
+    def initialize(root)
+      @root = root
+    end
+
+    def indexed_paging_offset
+      attrib :index_paging_offset
+    end
+
+    def numerator_offset
+      attrib :numerator_offset
+    end
+
+    def absolute_denominator
+      attrib :absolute_denominator
+    end
+
+    def includes_last_item_in_range
+      attrib :includes_last_item_in_range
+    end
+
+    def total_items_in_view
+      attrib :total_items_in_view
+    end
+
+    def items
+      root[:elems][0][:items][:elems] || []
+    end
+
+    def groups
+      root[:elems][0][:groups][:elems]
+    end
+
+
+    private
+    
+
+    def attrib(key)
+      return nil unless root.has_key?(:attribs)
+      root[:attribs][key]
+    end
+
+  end
+
+
+  class FindItemResponseMessage < ResponseMessage
+
+    def root_folder
+      return @root_folder if @root_folder
+
+      rf = safe_hash_access message, [:elems, :root_folder]
+      @root_folder = rf.nil? ? nil : RootFolder.new(rf)
+    end
+
+  end # FindItemResponseMessage
+
+end # Viewpoint::EWS::SOAP

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

@@ -0,0 +1,53 @@
+=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 GetEventsResponseMessage < ResponseMessage
+
+    def notification
+      safe_hash_access message, [:elems, :notification, :elems]
+    end
+
+    def subscription_id
+      safe_hash_access notification[0], [:subscription_id, :text]
+    end
+
+    def previous_watermark
+      safe_hash_access notification[1], [:previous_watermark, :text]
+    end
+
+    def new_watermark
+      ev = notification.last
+      if ev
+        type = ev.keys.first
+        ev[type][:elems][0][:watermark][:text]
+      else
+        nil
+      end
+    end
+
+    def more_events?
+      safe_hash_access(notification[2], [:more_events, :text]) == 'true'
+    end
+
+    def events
+      notification[3..-1]
+    end
+
+  end # GetEventsResponseMessage
+end # Viewpoint::EWS::SOAP

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

@@ -0,0 +1,59 @@
+=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 SendNotificationResponseMessage < ResponseMessage
+    include Viewpoint::StringUtils
+
+    def notification
+      safe_hash_access message, [:elems, :notification, :elems]
+    end
+
+    def subscription_id
+      safe_hash_access notification[0], [:subscription_id, :text]
+    end
+
+    def previous_watermark
+      safe_hash_access notification[1], [:previous_watermark, :text]
+    end
+
+    def new_watermark
+      ev = notification.last
+      if ev
+        type = ev.keys.first
+        ev[type][:elems][0][:watermark][:text]
+      else
+        nil
+      end
+    end
+
+    def more_events?
+      safe_hash_access(notification[2], [:more_events, :text]) == 'true'
+    end
+
+    def events
+      @events ||=
+        notification[3..-1].collect do |ev|
+          type = ev.keys.first
+          klass = Viewpoint::EWS::Types.const_get(camel_case(type))
+          klass.new(nil, ev[type])
+        end
+    end
+
+  end # SendNotificationResponseMessage
+end # Viewpoint::EWS::SOAP

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/soap.rb

@@ -0,0 +1,63 @@
+=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
+
+# This module defines some constants and other niceties to make available to
+# the underlying SOAP classes and modules that do the actual work.
+module Viewpoint
+  module EWS
+    module SOAP
+
+      # CONSTANTS
+
+      NS_SOAP         = 'soap'.freeze
+      NS_EWS_TYPES    = 't'.freeze
+      NS_EWS_MESSAGES = 'm'.freeze
+      NAMESPACES = {
+        "xmlns:#{NS_SOAP}"         => 'http://schemas.xmlsoap.org/soap/envelope/',
+        "xmlns:#{NS_EWS_TYPES}"    => 'http://schemas.microsoft.com/exchange/services/2006/types',
+        "xmlns:#{NS_EWS_MESSAGES}" => 'http://schemas.microsoft.com/exchange/services/2006/messages',
+      }.freeze
+
+      # used in ResolveNames to determine where names are resolved
+      ActiveDirectory         = 'ActiveDirectory'
+      ActiveDirectoryContacts = 'ActiveDirectoryContacts'
+      Contacts                = 'Contacts'
+      ContactsActiveDirectory = 'ContactsActiveDirectory'
+
+      # Target specific Exchange Server versions
+      # @see http://msdn.microsoft.com/en-us/library/bb891876(v=exchg.140).aspx
+      VERSION_2007      = 'Exchange2007'
+      VERSION_2007_SP1  = 'Exchange2007_SP1'
+      VERSION_2010      = 'Exchange2010'
+      VERSION_2010_SP1  = 'Exchange2010_SP1'
+      VERSION_2010_SP2  = 'Exchange2010_SP2'
+      VERSION_2013      = 'Exchange2013'
+      VERSION_NONE      = 'none'
+
+      HARD_DELETE = 'HardDelete'
+      SOFT_DELETE = 'SoftDelete'
+      MOVE_TO_DELETED_ITEMS = 'MoveToDeletedItems'
+
+      def initialize
+        @log = Logging.logger[self.class.name.to_s.to_sym]
+        @default_ns = NAMESPACES["xmlns:#{NS_EWS_MESSAGES}"]
+      end
+
+    end # SOAP
+  end # EWS
+end # Viewpoint

data/lib/ews/templates/calendar_item.rb

@@ -0,0 +1,78 @@
+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
+        structure = {}
+        structure[:message_disposition] = (draft ? 'SaveOnly' : 'SendAndSaveCopy')
+        structure[:send_meeting_invitations] = 'SendToNone'
+
+        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