viewpoint 0.1.25 → 0.1.26

data/README

@@ -97,7 +97,11 @@ DESIGN GOALS/GUIDELINES:
     where they do not and I have deviated somewhat.  For example,
     an instance method named delete_folder doesn't make much sense, but
     an instance method named delete! is pretty clear what it deletes.
-
+--------------------------------------------------------------------------
+!!!SHOUTS OUT!!!
+--------------------------------------------------------------------------
+* Thanks to Harold Lee (https://github.com/haroldl) for working on the
+  get_user_availability code.
 --------------------------------------------------------------------------
 DISCLAIMER:  If you see something that could be done better or would like
 to help out in the development of this code please feel free to clone the

data/lib/model/mailbox_user.rb

@@ -47,6 +47,20 @@ module Viewpoint
         end
       end
 
+      # Get information about when the user with the given email address is available.
+      # @param [String] email_address The email address of the person to find availability for.
+      # @param [String] start_time The start of the time range to check as an xs:dateTime.
+      # @param [String] end_time The end of the time range to check as an xs:dateTime.
+      # @see http://msdn.microsoft.com/en-us/library/aa494212.aspx
+      def self.get_user_availability(email_address, start_time, end_time)
+        resp = (Viewpoint::EWS::EWS.instance).ews.get_user_availability(email_address, start_time, end_time)
+        if(resp.status == 'Success')
+          return resp.items
+        else
+          raise EwsError, "GetUserAvailability produced an error: #{resp.code}: #{resp.message}"
+        end
+      end
+
       def initialize(mbox_user)
         super() # Calls initialize in Model (creates @ews_methods Array)
         @ews_item = mbox_user
@@ -66,6 +80,14 @@ module Viewpoint
         true
       end
       
+      # Get information about when this user is available.
+      # @param [String] start_time The start of the time range to check as an xs:dateTime.
+      # @param [String] end_time The end of the time range to check as an xs:dateTime.
+      # @see http://msdn.microsoft.com/en-us/library/aa494212.aspx
+      def get_user_availability(start_time, end_time)
+        return MailboxUser.get_user_availability(self.email_address, start_time, end_time)
+      end
+
       # Adds one or more delegates to a principal's mailbox and sets specific access permissions
       # @see http://msdn.microsoft.com/en-us/library/bb856527.aspx
       #

data/lib/soap/handsoap/builders/ews_builder.rb

@@ -80,6 +80,29 @@ module Viewpoint
           end
         end
 
+        # Build the request XML for GetUserAvailability.
+        # @see http://msdn.microsoft.com/en-us/library/aa494212.aspx
+        def get_user_availability!(email_address, start_time, end_time)
+          add_time_zone_info
+          @node.add("#{NS_EWS_MESSAGES}:MailboxDataArray") do |mda|
+            mda.add("#{NS_EWS_TYPES}:MailboxData") do |mbdata|
+              mbdata.add("#{NS_EWS_TYPES}:Email") do |email|
+                email.add("#{NS_EWS_TYPES}:Name")
+                email.add("#{NS_EWS_TYPES}:Address", email_address)
+              end
+              mbdata.add("#{NS_EWS_TYPES}:AttendeeType", 'Required')
+            end
+          end
+          @node.add("#{NS_EWS_TYPES}:FreeBusyViewOptions") do |fbvo|
+            fbvo.add("#{NS_EWS_TYPES}:TimeWindow") do |tw|
+              tw.add("#{NS_EWS_TYPES}:StartTime", start_time)
+              tw.add("#{NS_EWS_TYPES}:EndTime", end_time)
+            end
+            fbvo.add("#{NS_EWS_TYPES}:MergedFreeBusyIntervalInMinutes", 10)
+            fbvo.add("#{NS_EWS_TYPES}:RequestedView", 'MergedOnly')
+          end
+        end
+
         # This is forthcoming in Exchange 2010.  It will replace much of the Restriction
         # based code.
         # @param [Array] An array of query strings
@@ -90,6 +113,33 @@ module Viewpoint
           end
         end
 
+        private
+
+        # Add a description of the time zone to the request XML.
+        # The timezone information defaults to US/Pacific time.
+        def add_time_zone_info(offset_hours_std = -8, offset_hours_dst = -7)
+          base_bias = (-1 * offset_hours_std * 60).to_s
+          standard_bias = '0'
+          savings_bias = (offset_hours_std - offset_hours_dst).to_s
+          @node.add("#{NS_EWS_TYPES}:TimeZone") do |tz|
+            tz.add("#{NS_EWS_TYPES}:Bias", base_bias) # e.g. '480'
+            tz.add("#{NS_EWS_TYPES}:StandardTime") do |stime|
+              stime.add("#{NS_EWS_TYPES}:Bias", standard_bias) # e.g. '0'
+              stime.add("#{NS_EWS_TYPES}:Time", '02:00:00')
+              stime.add("#{NS_EWS_TYPES}:DayOrder", '1')
+              stime.add("#{NS_EWS_TYPES}:Month", '11')
+              stime.add("#{NS_EWS_TYPES}:DayOfWeek", 'Sunday')
+            end
+            tz.add("#{NS_EWS_TYPES}:DaylightTime") do |dtime|
+              dtime.add("#{NS_EWS_TYPES}:Bias", savings_bias) # e.g. '-60'
+              dtime.add("#{NS_EWS_TYPES}:Time", '02:00:00')
+              dtime.add("#{NS_EWS_TYPES}:DayOrder", '2')
+              dtime.add("#{NS_EWS_TYPES}:Month", '3')
+              dtime.add("#{NS_EWS_TYPES}:DayOfWeek", 'Sunday')
+            end
+          end
+        end
+
       end # EwsBuilder
     end # SOAP
   end # EWS

data/lib/soap/handsoap/ews_service.rb

@@ -728,12 +728,14 @@ module Viewpoint
         # Provides detailed information about the availability of a set of users, rooms, and resources
         # within a specified time window.
         # @see http://msdn.microsoft.com/en-us/library/aa564001.aspx
-        def get_user_availability
+        def get_user_availability(email_address, start_time, end_time)
           action = "#{SOAP_ACTION_PREFIX}/GetUserAvailability"
-          resp = invoke("#{NS_EWS_MESSAGES}:GetUserAvailability", action) do |get_user_availability|
-            build_get_user_availability!(get_user_availability)
+          resp = invoke("#{NS_EWS_MESSAGES}:GetUserAvailabilityRequest", action) do |root|
+            build!(root) do
+              get_user_availability!(email_address, start_time, end_time)
+            end
           end
-          parse_get_user_availability(resp)
+          parse!(resp)
         end
 
         # Gets a mailbox user's Out of Office (OOF) settings and messages.

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

@@ -202,6 +202,12 @@ module Viewpoint
           @response_message.items = xml_to_hash!((@response/"//#{NS_EWS_TYPES}:OofSettings").first.native_element)
         end
 
+        # Parse out the free/busy time.
+        # @see http://msdn.microsoft.com/en-us/library/aa494212.aspx
+        def get_user_availability_response(opts)
+          @response_message.items = xml_to_hash!((@response/"//#{NS_EWS_MESSAGES}:FreeBusyView").first.native_element)
+        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

metadata

@@ -2,7 +2,7 @@
 name: viewpoint
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.25
+  version: 0.1.26
 platform: ruby
 authors: 
 - Dan Wanek
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-18 00:00:00 Z
+date: 2011-11-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: handsoap