viewpoint 1.0.0.beta.1 → 1.0.0

data/lib/ews/soap/ews_response.rb

@@ -20,6 +20,7 @@ module Viewpoint::EWS::SOAP
 
   # A Generic Class for SOAP returns.
   class EwsResponse
+    include Viewpoint::StringUtils
 
     def initialize(sax_hash)
       @resp = sax_hash
@@ -70,7 +71,7 @@ module Viewpoint::EWS::SOAP
     def class_by_name(cname)
       begin
         if(cname.instance_of? Symbol)
-          cname = cname.to_s.camel_case
+          cname = camel_case(cname)
         end
         Viewpoint::EWS::SOAP.const_get(cname)
       rescue NameError => e

data/lib/ews/soap/ews_soap_free_busy_response.rb

@@ -46,7 +46,8 @@ module Viewpoint::EWS::SOAP
     end
 
     def calendar_event_array
-      get_user_availability_response[1][:free_busy_view][:elems][1][:calendar_event_array][:elems]
+      result = find_in_hash_list(get_user_availability_response[1][:free_busy_view][:elems], :calendar_event_array)
+      result ? result[:elems] : []
     end
 
     def working_hours
@@ -54,7 +55,7 @@ module Viewpoint::EWS::SOAP
     end
 
     def response_message
-      get_user_availability_response.first[:response_message]
+      find_in_hash_list(get_user_availability_response, :response_message)
     end
 
     def response_class
@@ -63,7 +64,8 @@ module Viewpoint::EWS::SOAP
     alias :status :response_class
 
     def response_code
-      response_message[:elems].first[:response_code][:text]
+      result = find_in_hash_list(response_message[:elems], :response_code)
+      result ? result[:text] : nil
     end
     alias :code :response_code
 
@@ -103,6 +105,14 @@ module Viewpoint::EWS::SOAP
       end
     end
 
+    # Find the first element in a list of hashes or return nil
+    # Example:
+    #     find_in_hash_list([{:foo => :bar}, {:bar => :baz}], :foo)
+    #     => :bar
+    def find_in_hash_list(collection, key)
+      result = collection.find { |hsh| hsh.keys.include?(key) }
+      result ? result[key] : nil
+    end
 
   end # EwsSoapFreeBusyResponse
 

data/lib/ews/soap/ews_soap_response.rb

@@ -45,7 +45,7 @@ module Viewpoint::EWS::SOAP
 
     def response_messages
       key = response.keys.first
-      response[key][:elems][0][:response_messages][:elems]
+      response[key][:elems].find{|e| e.keys.include? :response_messages }[:response_messages][:elems]
     end
 
     def response_message

data/lib/ews/soap/ews_soap_room_response.rb

@@ -0,0 +1,53 @@
+=begin
+  This file is a contribution to Viewpoint; the Ruby library for Microsoft Exchange Web Services.
+
+  Copyright © 2013 Camille Baldock <viewpoint@camillebaldock.co.uk>
+
+  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
+
+  # A class for roomlists SOAP returns.
+  # @attr_reader [String] :message The text from the EWS element <m:ResponseCode>
+  class EwsSoapRoomResponse < EwsSoapResponse
+
+    def response_messages
+      key = response.keys.first
+      subresponse = response[key][:elems][1]
+      response_class = subresponse.keys.first
+      subresponse[response_class][:elems]
+    end
+
+    def roomsArray
+      response[:get_rooms_response][:elems][1][:rooms][:elems]
+    end
+
+    def success?
+      response.first[1][:attribs][:response_class] == "Success"
+    end
+
+    private
+
+    def simplify!
+      if response_messages
+        response_messages.each do |rm|
+          key = rm.keys.first
+          rm[key][:elems] = rm[key][:elems].inject(&:merge)
+        end
+      end
+    end
+
+  end # EwsSoapRoomResponse
+
+end # Viewpoint::EWS::SOAP

data/lib/ews/soap/ews_soap_roomlist_response.rb

@@ -0,0 +1,54 @@
+=begin
+  This file is a contribution to Viewpoint; the Ruby library for Microsoft Exchange Web Services.
+
+  Copyright © 2013 Camille Baldock <viewpoint@camillebaldock.co.uk>
+
+  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
+
+  # A class for roomlists SOAP returns.
+  # @attr_reader [String] :message The text from the EWS element <m:ResponseCode>
+  class EwsSoapRoomlistResponse < EwsSoapResponse
+
+    def response_messages
+      key = response.keys.first
+      subresponse = response[key][:elems][1]
+      response_class = subresponse.keys.first
+      subresponse[response_class][:elems]
+    end
+
+    def roomListsArray
+      response[:get_room_lists_response][:elems][1][:room_lists][:elems]
+    end
+
+    def success?
+      response.first[1][:attribs][:response_class] == "Success"
+    end
+
+    private
+
+
+    def simplify!
+      if response_messages
+        response_messages.each do |rm|
+          key = rm.keys.first
+          rm[key][:elems] = rm[key][:elems].inject(&:merge)
+        end
+      end
+    end
+
+  end # EwsSoapRoomlistResponse
+
+end # Viewpoint::EWS::SOAP

data/lib/ews/soap/exchange_data_services.rb

@@ -37,9 +37,10 @@ module Viewpoint::EWS::SOAP
       req = build_soap! do |type, builder|
         if(type == :header)
         else
-          builder.nbuild.FindItem(:Traversal => opts[:traversal].to_s.camel_case) {
+          builder.nbuild.FindItem(:Traversal => camel_case(opts[:traversal])) {
             builder.nbuild.parent.default_namespace = @default_ns
             builder.item_shape!(opts[:item_shape])
+            builder.indexed_page_item_view!(opts[:indexed_page_item_view]) if opts[:indexed_page_item_view]
             # @todo add FractionalPageFolderView
             builder.calendar_view!(opts[:calendar_view]) if opts[:calendar_view]
             builder.contacts_view!(opts[:contacts_view]) if opts[:contacts_view]
@@ -137,11 +138,11 @@ module Viewpoint::EWS::SOAP
             builder.saved_item_folder_id!(opts[:saved_item_folder_id]) if opts[:saved_item_folder_id]
             builder.nbuild.Items {
               opts[:items].each {|i|
-              # The key can be any number of item types like :message,
-              #   :calendar, etc
-              ikey = i.keys.first
-              builder.send("#{ikey}!",i[ikey])
-            }
+                # The key can be any number of item types like :message,
+                #   :calendar, etc
+                ikey = i.keys.first
+                builder.send("#{ikey}!",i[ikey])
+              }
             }
           }
         end
@@ -364,6 +365,26 @@ module Viewpoint::EWS::SOAP
       do_soap_request(req, response_class: EwsResponse)
     end
 
+    # Export items as a base64 string
+    # @see http://msdn.microsoft.com/en-us/library/ff709503(v=exchg.140).aspx
+    #
+    # (Requires Exchange version equal or newer than VERSION 2010 SP 1)
+    #
+    # @param ids [Array] array of item ids. Can also be a single id value
+    def export_items(ids)
+      validate_version(VERSION_2010_SP1)
+      ids = ids.clone
+      [:item_ids].each do |k|
+        validate_param(ids, k, true)
+      end
+      req = build_soap! do |type, builder|
+        if(type == :header)
+        else
+      builder.export_item_ids!(ids[:item_ids])
+        end
+      end
+      do_soap_request(req, response_class: EwsResponse)
+    end
 
     # ------------- Folder Operations ------------
 
@@ -471,7 +492,7 @@ module Viewpoint::EWS::SOAP
       req = build_soap! do |type, builder|
         if(type == :header)
         else
-          builder.nbuild.FindFolder(:Traversal => opts[:traversal].to_s.camel_case) {
+          builder.nbuild.FindFolder(:Traversal => camel_case(opts[:traversal])) {
             builder.nbuild.parent.default_namespace = @default_ns
             builder.folder_shape!(opts[:folder_shape])
             builder.restriction!(opts[:restriction]) if opts[:restriction]
@@ -580,7 +601,7 @@ module Viewpoint::EWS::SOAP
       validate_version(VERSION_2010_SP1)
       ef_opts = {}
       [:delete_type, :delete_sub_folders].each do |k|
-        ef_opts[k.to_s.camel_case] = validate_param(opts, k, true)
+        ef_opts[camel_case(k)] = validate_param(opts, k, true)
       end
       fids = validate_param opts, :folder_ids, true
 
@@ -654,6 +675,9 @@ module Viewpoint::EWS::SOAP
               opts[:items].each do |ia|
                 builder.item_attachment!(ia)
               end
+              opts[:inline_files].each do |fi|
+                builder.inline_attachment!(fi)
+              end
             }
           }
         end
@@ -728,14 +752,28 @@ module Viewpoint::EWS::SOAP
     # @todo Needs to be finished
     def convert_id(opts)
       opts = opts.clone
+
+      [:id, :format, :destination_format, :mailbox ].each do |k|
+        validate_param(opts, k, true)
+      end
+
       req = build_soap! do |type, builder|
         if(type == :header)
         else
-        builder.nbuild.ConvertId {|x|
-        }
+          builder.nbuild.ConvertId {|x|
+            builder.nbuild.parent.default_namespace = @default_ns
+            x.parent['DestinationFormat'] = opts[:destination_format].to_s.camel_case
+            x.SourceIds { |x|
+              x[NS_EWS_TYPES].AlternateId { |x|
+                x.parent['Format'] = opts[:format].to_s.camel_case
+                x.parent['Id'] = opts[:id]
+                x.parent['Mailbox'] = opts[:mailbox]
+              }
+            }
+          }
         end
       end
-      do_soap_request(req)
+      do_soap_request(req, response_class: EwsResponse)
     end
 
   end #ExchangeDataServices

data/lib/ews/soap/exchange_synchronization.rb

@@ -0,0 +1,93 @@
+=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
+
+  # Exchange Synchronization operations as listed in the EWS Documentation.
+  # @see http://msdn.microsoft.com/en-us/library/bb409286.aspx
+  module ExchangeSynchronization
+    include Viewpoint::EWS::SOAP
+
+    # Defines a request to synchronize a folder hierarchy on a client
+    # @see http://msdn.microsoft.com/en-us/library/aa580990.aspx
+    # @param [Hash] opts
+    # @option opts [Hash] :folder_shape The folder shape properties
+    #   Ex: {:base_shape => 'Default', :additional_properties => 'bla bla bla'}
+    # @option opts [Hash] :sync_folder_id An optional Hash that represents a FolderId or
+    #   DistinguishedFolderId.
+    #   Ex: {:id => :inbox}
+    # @option opts [Hash] :sync_state The Base64 sync state id. If this is the
+    #   first time syncing this does not need to be passed.
+    def sync_folder_hierarchy(opts)
+      opts = opts.clone
+      req = build_soap! do |type, builder|
+        if(type == :header)
+        else
+          builder.nbuild.SyncFolderHierarchy {
+            builder.nbuild.parent.default_namespace = @default_ns
+            builder.folder_shape!(opts[:folder_shape])
+            builder.sync_folder_id!(opts[:sync_folder_id]) if opts[:sync_folder_id]
+            builder.sync_state!(opts[:sync_state]) if opts[:sync_state]
+          }
+        end
+      end
+      do_soap_request(req, response_class: EwsResponse)
+    end
+
+    # Synchronizes items between the Exchange server and the client
+    # @see http://msdn.microsoft.com/en-us/library/aa563967(v=EXCHG.140).aspx
+    # @param [Hash] opts
+    # @option opts [Hash] :item_shape The item shape properties
+    #   Ex: {:base_shape => 'Default', :additional_properties => 'bla bla bla'}
+    # @option opts [Hash] :sync_folder_id A Hash that represents a FolderId or
+    #   DistinguishedFolderId. [ Ex: {:id => :inbox} ] OPTIONAL
+    # @option opts [String] :sync_state The Base64 sync state id. If this is the
+    #   first time syncing this does not need to be passed. OPTIONAL on first call
+    # @option opts [Array <String>] :ignore An Array of ItemIds for items to ignore
+    #   during the sync process. Ex: [{:id => 'id1', :change_key => 'ck'}, {:id => 'id2'}]
+    #   OPTIONAL
+    # @option opts [Integer] :max_changes_returned ('required') The amount of items to sync per call.
+    # @option opts [String] :sync_scope specifies whether just items or items and folder associated
+    #   information are returned. OPTIONAL
+    #   options: 'NormalItems' or 'NormalAndAssociatedItems'
+    # @example
+    #   { :item_shape => {:base_shape => 'Default'},
+    #     :sync_folder_id => {:id => :inbox},
+    #     :sync_state => myBase64id,
+    #     :max_changes_returned => 256 }
+    def sync_folder_items(opts)
+      opts = opts.clone
+      req = build_soap! do |type, builder|
+        if(type == :header)
+        else
+          builder.nbuild.SyncFolderItems {
+            builder.nbuild.parent.default_namespace = @default_ns
+            builder.item_shape!(opts[:item_shape])
+            builder.sync_folder_id!(opts[:sync_folder_id]) if opts[:sync_folder_id]
+            builder.sync_state!(opts[:sync_state]) if opts[:sync_state]
+            builder.ignore!(opts[:ignore]) if opts[:ignore]
+            builder.max_changes_returned!(opts[:max_changes_returned])
+            builder.sync_scope!(opts[:sync_scope]) if opts[:sync_scope]
+          }
+        end
+      end
+      do_soap_request(req, response_class: EwsResponse)
+    end
+
+  end #ExchangeSynchronization
+end

data/lib/ews/soap/exchange_time_zones.rb

@@ -0,0 +1,56 @@
+module Viewpoint::EWS::SOAP
+
+  module ExchangeTimeZones
+    include Viewpoint::EWS::SOAP
+
+    # Request list of server known time zones
+    # @param full [Boolean] Request full time zone definition? Returns only name and id if false.
+    # @param ids [Array] Returns only the specified time zones instead of all if present
+    # @return [Array] Array of Objects responding to #id() and #name()
+    # @example Retrieving server zime zones
+    #   ews_client = Viewpoint::EWSClient.new # ...
+    #   zones = ews_client.ews.get_time_zones
+    # @todo Implement TimeZoneDefinition with sub elements Periods, TransitionsGroups and Transitions
+    def get_time_zones(full = false, ids = nil)
+      req = build_soap! do |type, builder|
+        unless type == :header
+          builder.get_server_time_zones!(full: full, ids: ids)
+        end
+      end
+      result = do_soap_request req, response_class: EwsSoapResponse
+
+      if result.success?
+        zones = []
+        result.response_messages.each do |message|
+          elements = message[:get_server_time_zones_response_message][:elems][:time_zone_definitions][:elems]
+          elements.each do |definition|
+            data = {
+                id: definition[:time_zone_definition][:attribs][:id],
+                name: definition[:time_zone_definition][:attribs][:name]
+            }
+            zones << OpenStruct.new(data)
+          end
+        end
+        zones
+      else
+        raise EwsError, "Could not get time zones"
+      end
+    end
+
+    # Sets the time zone context header
+    # @param id [String] Identifier of a Microsoft well known time zone
+    # @example Set time zone context for connection
+    #   ews_client = Viewpoint::EWSClient.new # ...
+    #   ews_client.set_time_zone 'AUS Central Standard Time'
+    #   # subsequent request will send the TimeZoneContext header
+    # @see EWSClient#set_time_zone
+    def set_time_zone_context(id)
+      if id
+        @time_zone_context = {id: id}
+      else
+        @time_zone_context = nil
+      end
+    end
+
+  end
+end

data/lib/ews/soap/exchange_web_service.rb

@@ -20,12 +20,15 @@ module Viewpoint::EWS::SOAP
   class ExchangeWebService
     include Viewpoint::EWS
     include Viewpoint::EWS::SOAP
+    include Viewpoint::StringUtils
     include ExchangeDataServices
     include ExchangeNotification
     include ExchangeAvailability
     include ExchangeUserConfiguration
+    include ExchangeSynchronization
+    include ExchangeTimeZones
 
-    attr_accessor :server_version, :auto_deepen, :connection
+    attr_accessor :server_version, :auto_deepen, :no_auto_deepen_behavior, :connection, :impersonation_type, :impersonation_address
 
     # @param [Viewpoint::EWS::Connection] connection the connection object
     # @param [Hash] opts additional options to the web service
@@ -38,70 +41,9 @@ module Viewpoint::EWS::SOAP
       @connection = connection
       @server_version = opts[:server_version] ? opts[:server_version] : VERSION_2010
       @auto_deepen    = true
-    end
-
-    # Defines a request to synchronize a folder hierarchy on a client
-    # @see http://msdn.microsoft.com/en-us/library/aa580990.aspx
-    # @param [Hash] opts
-    # @option opts [Hash] :folder_shape The folder shape properties
-    #   Ex: {:base_shape => 'Default', :additional_properties => 'bla bla bla'}
-    # @option opts [Hash] :sync_folder_id An optional Hash that represents a FolderId or
-    #   DistinguishedFolderId.
-    #   Ex: {:id => :inbox}
-    # @option opts [Hash] :sync_state The Base64 sync state id. If this is the
-    #   first time syncing this does not need to be passed.
-    def sync_folder_hierarchy(opts)
-      req = build_soap! do |type, builder|
-        if(type == :header)
-        else
-          builder.nbuild.SyncFolderHierarchy {
-            builder.nbuild.parent.default_namespace = @default_ns
-            builder.folder_shape!(opts[:folder_shape])
-            builder.sync_folder_id!(opts[:sync_folder_id]) if opts[:sync_folder_id]
-            builder.sync_state!(opts[:sync_state]) if opts[:sync_state]
-          }
-        end
-      end
-      do_soap_request(req)
-    end
-
-    # Synchronizes items between the Exchange server and the client
-    # @see http://msdn.microsoft.com/en-us/library/aa563967(v=EXCHG.140).aspx
-    # @param [Hash] opts
-    # @option opts [Hash] :item_shape The item shape properties
-    #   Ex: {:base_shape => 'Default', :additional_properties => 'bla bla bla'}
-    # @option opts [Hash] :sync_folder_id A Hash that represents a FolderId or
-    #   DistinguishedFolderId. [ Ex: {:id => :inbox} ] OPTIONAL
-    # @option opts [String] :sync_state The Base64 sync state id. If this is the
-    #   first time syncing this does not need to be passed. OPTIONAL on first call
-    # @option opts [Array <String>] :ignore An Array of ItemIds for items to ignore
-    #   during the sync process. Ex: [{:id => 'id1', :change_key => 'ck'}, {:id => 'id2'}]
-    #   OPTIONAL
-    # @option opts [Integer] :max_changes_returned ('required') The amount of items to sync per call.
-    # @option opts [String] :sync_scope specifies whether just items or items and folder associated
-    #   information are returned. OPTIONAL
-    #   options: 'NormalItems' or 'NormalAndAssociatedItems'
-    # @example
-    #   { :item_shape => {:base_shape => 'Default'},
-    #     :sync_folder_id => {:id => :inbox},
-    #     :sync_state => myBase64id,
-    #     :max_changes_returned => 256 }
-    def sync_folder_items(opts)
-      req = build_soap! do |type, builder|
-        if(type == :header)
-        else
-          builder.nbuild.SyncFolderItems {
-            builder.nbuild.parent.default_namespace = @default_ns
-            builder.item_shape!(opts[:item_shape])
-            builder.sync_folder_id!(opts[:sync_folder_id]) if opts[:sync_folder_id]
-            builder.sync_state!(opts[:sync_state]) if opts[:sync_state]
-            builder.ignore!(opts[:ignore]) if opts[:ignore]
-            builder.max_changes_returned!(opts[:max_changes_returned])
-            builder.sync_scope!(opts[:sync_scope]) if opts[:sync_scope]
-          }
-        end
-      end
-      do_soap_request(req)
+      @no_auto_deepen_behavior = :raise
+      @impersonation_type = ""
+      @impersonation_address = ""
     end
 
     def delete_attachment
@@ -226,6 +168,33 @@ module Viewpoint::EWS::SOAP
       do_soap_request(req, response_class: EwsSoapFreeBusyResponse)
     end
 
+    # Gets the rooms that are in the specified room distribution list
+    # @see http://msdn.microsoft.com/en-us/library/aa563465.aspx
+    # @param [string] roomDistributionList
+    def get_rooms(roomDistributionList)
+      req = build_soap! do |type, builder|
+        if(type == :header)
+        else
+          builder.nbuild.GetRooms {|x|
+            x.parent.default_namespace = @default_ns
+            builder.room_list!(roomDistributionList)
+          }
+        end
+      end
+      do_soap_request(req, response_class: EwsSoapRoomResponse)
+    end
+
+    # Gets the room lists that are available within the Exchange organization.
+    # @see http://msdn.microsoft.com/en-us/library/aa563465.aspx
+    def get_room_lists
+      req = build_soap! do |type, builder|
+        if(type == :header)
+        else
+          builder.room_lists!
+        end
+      end
+      do_soap_request(req, response_class: EwsSoapRoomlistResponse)
+    end
 
     # Send the SOAP request to the endpoint and parse it.
     # @param [String] soapmsg an XML formatted string
@@ -286,7 +255,8 @@ module Viewpoint::EWS::SOAP
 
     # Build the common elements in the SOAP message and yield to any custom elements.
     def build_soap!(&block)
-      opts = { :server_version => server_version }
+      opts = { :server_version => server_version, :impersonation_type => impersonation_type, :impersonation_mail => impersonation_address }
+      opts[:time_zone_context] = @time_zone_context if @time_zone_context
       EwsBuilder.new.build!(opts, &block)
     end