viewpoint 0.0.5 → 0.1.0

data/lib/soap/handsoap/parser.rb

@@ -0,0 +1,106 @@
+#############################################################################
+# Copyright © 2010 Dan Wanek <dan.wanek@gmail.com>
+#
+#
+# This file is part of Viewpoint.
+# 
+# Viewpoint is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+# 
+# Viewpoint is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
+# Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with Viewpoint.  If not, see <http://www.gnu.org/licenses/>.
+#############################################################################
+module Viewpoint
+  module EWS
+    module SOAP
+      module Parser
+
+        def initialize(response)
+          # Unwrap SOAP Envelope
+          @response = response
+          @response_type = (response/"//#{NS_SOAP}:Body/*").first.node_name
+
+          rmsg = (response/'//m:ResponseMessages/*[@ResponseClass]').first
+          @response_message = EwsSoapResponse.new(rmsg['ResponseClass'],
+                                                  (rmsg/'m:ResponseCode/text()').first.to_s,
+                                                  (rmsg/'m:MessageText/text()').first.to_s)
+
+          @response_message.set_soap_resp(response)
+
+        end
+
+        # This is the main parser method.  It takes the response type and tries to
+        # call a Ruby method of the same name.
+        # @todo Decide on an appropriate response if a method does not exist.
+        def parse(opts)
+          resp_method = @response_type.ruby_case
+          if(respond_to?(resp_method))
+            puts "Method Exists: #{resp_method}" if $DEBUG
+            method(resp_method).call(opts)
+          else
+            puts "No Method: #{resp_method}" if $DEBUG
+          end
+          @response_message
+        end
+
+        private
+
+        def method_exists?(method_name)
+          return self.methods.include?(method_name)
+        end
+
+        # Create a Hash from a Nokogiri element tree
+        # @param [Nokogiri::XML::Element, Nokogiri::XML::Text] nokoelem The Nokogiri element passed to this method
+        # @example XML
+        #   <tiptop>
+        #     <top Id="32fss">TestText</top>
+        #     <middle Id='TestTestMiddle' />
+        #     <bottom />
+        #   </tiptop>
+        #   becomes...
+        #   {:tiptop=>{:top=>{:id=>"32fss", :text=>"TestText"}, :middle=>{:id=>"TestTestMiddle"}}} 
+        def xml_to_hash!(nokoelem)
+          e_hash = {}
+          node_name = nokoelem.name.ruby_case.to_sym
+
+          if nokoelem.is_a? Nokogiri::XML::Element
+            nokoelem.attributes.each_pair do |k, v|
+              e_hash[k.ruby_case.to_sym] = v.value
+            end
+            nokoelem.children.each do |c|
+              new_hash = xml_to_hash!(c)
+              unless new_hash.nil?
+                e_hash.merge!(new_hash) do |k,v1,v2|
+                  if(v1.is_a?(Array))
+                    v1 << v2
+                  else
+                    [v1, v2]
+                  end
+                end
+              end
+            end
+            return e_hash.empty? ? nil : {node_name => e_hash}
+          elsif nokoelem.is_a? Nokogiri::XML::Text
+            # Return a :text to value hash or nil if the text is empty
+            return {node_name => nokoelem.text} if nokoelem.text != "\n"
+            nil
+          else
+            # If something strange gets passed just return nil
+            return nil
+          end
+        end
+
+
+      end # Parser
+    end # SOAP
+  end # SPWS
+end # Viewpoint
+
+require 'parsers/ews_parser'

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

@@ -0,0 +1,165 @@
+#############################################################################
+# Copyright © 2010 Dan Wanek <dan.wanek@gmail.com>
+#
+#
+# This file is part of Viewpoint.
+#
+# Viewpoint is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+#
+# Viewpoint is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
+# Public License for more details.
+#
+# You should have received a copy of the GNU General Public License along
+# with Viewpoint.  If not, see <http://www.gnu.org/licenses/>.
+#############################################################################
+
+module Viewpoint
+  module EWS
+    module SOAP
+      class EwsParser
+        include Parser
+
+        # Parsing Methods
+        # ---------------
+
+        def resolve_names_response(opts)
+          @response_message.items = resolution_set
+        end
+
+        def get_folder_response(opts)
+          @response_message.items = folders
+        end
+
+        def find_folder_response(opts)
+          folders = []
+          (@response/"//#{NS_EWS_MESSAGES}:FindFolderResponseMessage//#{NS_EWS_TYPES}:Folders/*").each do |f|
+            folders << xml_to_hash!(f.native_element)
+          end
+          @response_message.items = folders
+        end
+
+        def get_events_response(opts)
+          if @response_message.status == 'Success'
+            events = []
+            events << {}
+            events.first[:subscription_id] = (@response/"//#{NS_EWS_MESSAGES}:Notification/#{NS_EWS_TYPES}:SubscriptionId").first.to_s
+            events.first[:more_events] = (@response/"//#{NS_EWS_MESSAGES}:Notification/#{NS_EWS_TYPES}:SubscriptionId").first.to_boolean
+
+            (@response/"//#{NS_EWS_MESSAGES}:Notification/*[position()>3]").each do |e|
+              events << xml_to_hash!(e.native_element)
+              events.first[:watermark] = events.last[events.last.keys.first][:watermark][:text]
+            end
+
+            @response_message.items = events
+          else
+            raise EwsSubscriptionTimeout.new("#{@response_message.code}: #{@response_message.message}")
+          end
+        end
+
+        def find_item_response(opts)
+          items = []
+          items << {}
+          items.first[:total_items_in_view] = (@response/"//#{NS_EWS_MESSAGES}:FindItemResponseMessage/#{NS_EWS_MESSAGES}:RootFolder/@TotalItemsInView").first.to_i
+
+          (@response/"//#{NS_EWS_MESSAGES}:FindItemResponseMessage//#{NS_EWS_TYPES}:Items/*").each do |i|
+            items << xml_to_hash!(i.native_element)
+          end
+
+          @response_message.items = items
+        end
+
+        # Parsers the response from the SOAP Subscribe operation
+        # @see http://msdn.microsoft.com/en-us/library/aa566188.aspx
+        #
+        # @return [Hash] A hash with the keys :watermark and :subscription_id
+        # @raise [EwsError] Raise an error if the ResponseClass is not Success
+        def subscribe_response(opts)
+          subscription = []
+          sid = xml_to_hash!((@response/"//#{NS_EWS_MESSAGES}:SubscriptionId").first.native_element)
+          wmk = xml_to_hash!((@response/"//#{NS_EWS_MESSAGES}:Watermark").first.native_element)
+          subscription << sid.merge(wmk)
+          @response_message.items = subscription
+        end
+
+        # @todo Better handle error messages
+        def unsubscribe_response(opts)
+          @response_message
+        end
+
+        def get_item_response(opts)
+          if(@response_message.status == 'Success')
+            @response_message.items << xml_to_hash!((@response/"//#{NS_EWS_MESSAGES}:Items/*").first.native_element)
+          else
+            raise EwsError, "#{@response_message.code}: #{@response_message.message}"
+          end
+        end
+
+        # @todo need to find out out to us XPath to get ItemId.  It doesn't seem to work now.
+        def create_item_response(opts)
+          if(@response_message.status == 'Success')
+            items = []
+            (@response/"//#{NS_EWS_MESSAGES}:Items/*").each do |i|
+              items << xml_to_hash!(i.native_element)
+            end
+            @response_message.items = items
+          else
+            raise EwsError, "#{@response_message.code}: #{@response_message.message}"
+          end
+        end
+
+        def sync_folder_items_response(opts)
+          if(@response_message.status == 'Success')
+            sync = []
+            sync << {}
+            sync.first[:sync_state] = (@response/"//#{NS_EWS_MESSAGES}:SyncState").first.to_s
+            sync.first[:includes_last_item_in_range] = (@response/"//#{NS_EWS_MESSAGES}:IncludesLastItemInRange").first.to_boolean
+            (@response/"//m:Changes/*").each do |c|
+              sync << xml_to_hash!(c.native_element)
+            end
+            @response_message.items = sync
+          else
+            raise EwsError, "#{@response_message.code}: #{@response_message.message}"
+          end
+
+        end
+
+        # Parse out a Mailbox element
+        # @param [XML] mbox The <t:Mailbox> element
+        # @return [Hash] Values of EWS Mailbox type :name, :email_address, :routing_type, :mailbox_type, :item_id
+        def mailbox(mbox_xml)
+          xml_to_hash!(mbox_xml.native_element)
+        end
+
+        def contact(contact_xml)
+          xml_to_hash!(contact_xml.native_element)
+        end
+
+        # Parse out Resolutions from a ResolutionSet from the ResolveNames operation
+        # @return [Array] An array of :mailbox,:contact Hashes that resolved.
+        def resolution_set
+          resolution_set = []
+          (@response/"//#{NS_EWS_MESSAGES}:ResolutionSet/*").each do |r|
+            mbox_hash    = mailbox((r/"#{NS_EWS_TYPES}:Mailbox").first)
+            contact_hash = contact((r/"#{NS_EWS_TYPES}:Contact").first)
+            resolution_set << mbox_hash.merge(contact_hash)
+          end
+          resolution_set
+        end
+
+        def folders
+          folders = []
+          (@response/"//#{NS_EWS_MESSAGES}:Folders/*").each do |f|
+            folders << xml_to_hash!(f.native_element)
+          end
+          folders
+        end
+
+      end # EwsParser
+    end # SOAP
+  end # EWS
+end # Viewpoint

data/lib/soap/soap_provider.rb

@@ -0,0 +1,75 @@
+#############################################################################
+# Copyright © 2010 Dan Wanek <dan.wanek@gmail.com>
+#
+#
+# This file is part of Viewpoint.
+# 
+# Viewpoint is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+# 
+# Viewpoint is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
+# Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with Viewpoint.  If not, see <http://www.gnu.org/licenses/>.
+#############################################################################
+
+# This file requires the appropriate SOAP Library (Handsoap today) and also
+# defines certain contants that SOAP methods may use.
+module Viewpoint
+  module EWS
+    module SOAP
+
+      # CONSTANTS
+
+      NS_SOAP         = 'soap' # http://schemas.xmlsoap.org/soap/envelope/
+      NS_EWS_TYPES    = 't'    # http://schemas.microsoft.com/exchange/services/2006/types
+      NS_EWS_MESSAGES = 'm'    # http://schemas.microsoft.com/exchange/services/2006/messages
+
+      # used in ResolveNames to determine where names are resolved
+      ActiveDirectory = 'ActiveDirectory'
+      ActiveDirectoryContacts = 'ActiveDirectoryContacts'
+      Contacts = 'Contacts'
+      ContactsActiveDirectory = 'ContactsActiveDirectory'
+
+
+
+      # A Generic Class for SOAP returns.
+      # @attr_reader [String] :message The text from the EWS element <m:ResponseCode>
+      class EwsSoapResponse
+
+        attr_reader :status, :code, :message, :soap_response
+        attr_accessor :items
+
+        def initialize(status, code, message)
+          @status, @code, @message = status, code, message
+
+          # Items is an array where hash types get stored for return
+          @items = []
+        end
+
+        def set_soap_resp(response)
+          @soap_response = response
+        end
+
+      end # EwsSoapResponse
+
+
+    end # SOAP
+  end # EWS
+end # Viewpoint
+
+require 'soap/handsoap/ews_service'
+
+module Viewpoint
+  module EWS
+    module SOAP
+    end
+  end
+end
+
+

data/lib/viewpoint.rb

@@ -1,5 +1,100 @@
+#############################################################################
+# Copyright © 2010 Dan Wanek <dan.wanek@gmail.com>
+#
+#
+# This file is part of Viewpoint.
+# 
+# Viewpoint is free software: you can redistribute it and/or
+# modify it under the terms of the GNU General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or (at
+# your option) any later version.
+# 
+# Viewpoint is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General
+# Public License for more details.
+# 
+# You should have received a copy of the GNU General Public License along
+# with Viewpoint.  If not, see <http://www.gnu.org/licenses/>.
+#############################################################################
+
+# We only what one instance of this class so include Singleton
+require 'singleton'
+require 'date'
+
+# Class Extensions
+require 'extensions/string'
+
+# Load the backend SOAP infrastructure.  Today this is Handsoap.
+require 'soap/soap_provider'
+
+# Load the model classes
+# Base Models
+require 'model/model'
+require 'model/mailbox_user'
+require 'model/generic_folder'
+require 'model/item'
+# Specific Models
+# Folders
+require 'model/folder'
+require 'model/calendar_folder'
+require 'model/contacts_folder'
+require 'model/search_folder'
+require 'model/tasks_folder'
+# Items
+require 'model/message'
+require 'model/calendar_item'
+require 'model/contact'
+require 'model/distribution_list'
+require 'model/meeting_message'
+require 'model/meeting_request'
+require 'model/meeting_response'
+require 'model/meeting_cancellation'
+require 'model/task'
+
+# Load the Exception classes
+require 'exceptions/exceptions'
+
+
+# This is the Singlenton class that controls access and presentation to Exchange
+# Web Services.  It is possible to just use the SOAP classes themselves but this
+# is what ties all the pieces together.
+# @attr_reader [SOAP::ExchangeWebService] :ews The SOAP object used to make calls
+#   to the Exchange Web Service.
 module Viewpoint
-end
+  module EWS
+    # @attr_reader [Viewpoint::EWS::SOAP::ExchangeWebService] :ews The EWS object used
+    #   to make SOAP calls.  You typically don't need to use this, but if you want to
+    #   play around with the SOAP back-end it's available.
+    class EWS
+      include Singleton
+      include Viewpoint
 
-require 'viewpoint/errors'
-require 'viewpoint/exchwebserv'
+      attr_reader :ews
+
+      def self.endpoint=(endpoint, version = 1)
+        @@endpoint = endpoint
+        SOAP::ExchangeWebService.endpoint(:uri => endpoint, :version => version)
+      end
+
+      def self.endpoint
+        @@endpoint
+      end
+
+      def self.set_auth(user,pass)
+        @@user = user
+        SOAP::ExchangeWebService.set_auth(user,pass)
+      end
+
+      def initialize
+        @ews = SOAP::ExchangeWebService.new
+      end
+
+      # The MailboxUser object that represents the user connected to EWS.
+      def me
+        @me ||= MailboxUser.find_user("#{@@user}@")
+      end
+
+    end # class EWS
+  end # EWS
+end