viewpoint2 1.3.0

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

@@ -0,0 +1,43 @@
+=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 EwsParser
+    include Viewpoint::EWS
+
+    # @param [String] soap_resp
+    def initialize(soap_resp)
+      @soap_resp  = soap_resp
+      @sax_doc    = EwsSaxDocument.new
+    end
+
+    def parse(opts = {})
+      opts[:response_class] ||= EwsSoapResponse
+      sax_parser.parse(@soap_resp)
+      opts[:response_class].new @sax_doc.struct
+    end
+
+
+    private
+
+    def sax_parser
+      @parser ||= Nokogiri::XML::SAX::Parser.new(@sax_doc)
+    end
+
+  end # EwsParser
+end # Viewpoint

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