stxt-viewpoint 1.0.0.beta.3

data/lib/ews/types/out_of_office.rb

@@ -0,0 +1,147 @@
+=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::Types
+
+    OOF_KEY_PATHS = {
+      :enabled?   => [:oof_settings, :oof_state],
+      :scheduled? => [:oof_settings, :oof_state],
+      :duration   => [:oof_settings, :duration],
+    }
+
+    OOF_KEY_TYPES = {
+      :enabled?   => ->(str){str == :enabled},
+      :scheduled? => ->(str){str == :scheduled},
+      :duration   => ->(hsh){ hsh[:start_time]..hsh[:end_time] },
+    }
+
+    OOF_KEY_ALIAS = {}
+
+  # This represents OutOfOffice settings
+  # @see http://msdn.microsoft.com/en-us/library/aa563465.aspx
+  class OutOfOffice
+    include Viewpoint::EWS
+    include Viewpoint::EWS::Types
+
+    attr_reader :user
+
+    # @param [MailboxUser] user
+    # @param [Hash] ews_item
+    def initialize(user, ews_item)
+      @ews =  user.ews
+      @user = user
+      @ews_item = ews_item
+      @changed = false
+      simplify!
+    end
+
+    def changed?
+      @changed
+    end
+
+    def save!
+      return true unless changed?
+      opts = { mailbox: {address: user.email_address} }.merge(@ews_item[:oof_settings])
+      resp = @ews.set_user_oof_settings(opts)
+      if resp.success?
+        @changed = false
+        true
+      else
+        raise SaveFailed, "Could not save #{self.class}. #{resp.code}: #{resp.message}"
+      end
+    end
+
+    def enable
+      return true if enabled?
+      @changed = true
+      @ews_item[:oof_settings][:oof_state] = :enabled
+    end
+
+    def disable
+      return true unless enabled? || scheduled?
+      @changed = true
+      @ews_item[:oof_settings][:oof_state] = :disabled
+    end
+
+    # Schedule an out of office.
+    # @param [DateTime] start_time
+    # @param [DateTime] end_time
+    def schedule(start_time, end_time)
+      @changed = true
+      @ews_item[:oof_settings][:oof_state] = :scheduled
+      set_duration start_time, end_time
+    end
+
+    # Specify a duration for this Out Of Office setting
+    # @param [DateTime] start_time
+    # @param [DateTime] end_time
+    def set_duration(start_time, end_time)
+      @changed = true
+      @ews_item[:oof_settings][:duration][:start_time] = start_time
+      @ews_item[:oof_settings][:duration][:end_time] = end_time
+    end
+
+    # A message to send to internal users
+    # @param [String] message
+    def internal_reply=(message)
+      @changed = true
+      @ews_item[:oof_settings][:internal_reply] = message
+    end
+
+    # A message to send to external users
+    # @param [String] message
+    def external_reply=(message)
+      @changed = true
+      @ews_item[:oof_settings][:external_reply] = message
+    end
+
+
+private
+
+    def key_paths
+      @key_paths ||= super.merge(OOF_KEY_PATHS)
+    end
+
+    def key_types
+      @key_types ||= super.merge(OOF_KEY_TYPES)
+    end
+
+    def key_alias
+      @key_alias ||= super.merge(OOF_KEY_ALIAS)
+    end
+
+    def simplify!
+      oof_settings = @ews_item[:oof_settings][:elems].inject(:merge)
+      oof_settings[:oof_state] = oof_settings[:oof_state][:text].downcase.to_sym
+      oof_settings[:external_audience] = oof_settings[:external_audience][:text]
+      if oof_settings[:duration]
+        dur = oof_settings[:duration][:elems].inject(:merge)
+        oof_settings[:duration] = {
+          start_time: DateTime.iso8601(dur[:start_time][:text]),
+          end_time:   DateTime.iso8601(dur[:end_time][:text])
+        }
+      end
+      oof_settings[:internal_reply] = oof_settings[:internal_reply][:elems][0][:message][:text] || ""
+      oof_settings[:external_reply] = oof_settings[:external_reply][:elems][0][:message][:text] || ""
+      @ews_item[:oof_settings] = oof_settings
+      @ews_item[:allow_external_oof] = @ews_item[:allow_external_oof][:text]
+    end
+
+  end #OutOfOffice
+
+end

data/lib/ews/types/search_folder.rb

@@ -0,0 +1,8 @@
+module Viewpoint::EWS::Types
+  class SearchFolder
+    include Viewpoint::EWS
+    include Viewpoint::EWS::Types
+    include Viewpoint::EWS::Types::GenericFolder
+
+  end
+end

data/lib/ews/types/status_event.rb

@@ -0,0 +1,39 @@
+=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::Types
+
+  class StatusEvent
+    include Viewpoint::EWS
+    include Viewpoint::EWS::Types
+    include Viewpoint::EWS::Types::Item
+
+    STATUS_EVENT_KEY_PATHS = {
+      :watermark  => [:watermark, :text],
+    }
+
+
+    private
+
+
+    def key_paths
+      @key_paths ||= STATUS_EVENT_KEY_PATHS
+    end
+
+  end
+end

data/lib/ews/types/task.rb

@@ -0,0 +1,37 @@
+module Viewpoint::EWS::Types
+  class Task
+    include Viewpoint::EWS
+    include Viewpoint::EWS::Types
+    include Viewpoint::EWS::Types::Item
+    
+    TASK_KEY_PATHS = {
+      complete?:   [:is_complete, :text],
+      recurring?:   [:is_recurring, :text],
+      start_date:   [:start_date, :text],
+      due_date:   [:end_date, :text],
+      reminder_due_by:   [:reminder_due_by, :text],
+      reminder?:   [:reminder_is_set, :text],
+   }
+
+    TASK_KEY_TYPES = {
+      recurring?:   ->(str){str.downcase == 'true'},
+      complete?:     ->(str){str.downcase == 'true'},
+      reminder?:     ->(str){str.downcase == 'true'},
+    }
+    TASK_KEY_ALIAS = {}
+
+    private
+
+    def key_paths
+      super.merge(TASK_KEY_PATHS)
+    end
+
+    def key_types
+      super.merge(TASK_KEY_TYPES)
+    end
+
+    def key_alias
+      super.merge(TASK_KEY_ALIAS)
+    end
+  end
+end

data/lib/ews/types/tasks_folder.rb

@@ -0,0 +1,27 @@
+module Viewpoint::EWS::Types
+  class TasksFolder
+    include Viewpoint::EWS
+    include Viewpoint::EWS::Types
+    include Viewpoint::EWS::Types::GenericFolder
+
+    # Creates a new task
+    # @param attributes [Hash] Parameters of the task. Some example attributes are listed below.
+    # @option attributes :subject [String]
+    # @option attributes :start_date [Time]
+    # @option attributes :due_date [Time]
+    # @option attributes :reminder_due_by [Time]
+    # @option attributes :reminder_is_set [Boolean]
+    # @return [Task]
+    # @see Template::Task
+    def create_item(attributes)
+      template = Viewpoint::EWS::Template::Task.new attributes
+      template.saved_item_folder_id = {id: self.id, change_key: self.change_key}
+      rm = ews.create_item(template.to_ews_create).response_messages.first
+      if rm && rm.success?
+        Task.new ews, rm.items.first[:task][:elems].first
+      else
+        raise EwsCreateItemError, "Could not create item in folder. #{rm.code}: #{rm.message_text}" unless rm
+      end
+    end
+  end
+end

data/lib/ews/types.rb

@@ -0,0 +1,191 @@
+module Viewpoint::EWS
+  module Types
+    include Viewpoint::StringUtils
+
+    KEY_PATHS = {
+      extended_properties: [:extended_property],
+    }
+    KEY_TYPES = {
+      extended_properties: :build_extended_properties,
+    }
+    KEY_ALIAS = {}
+
+    attr_reader :ews_item
+
+    # @param [SOAP::ExchangeWebService] ews the EWS reference
+    # @param [Hash] ews_item the EWS parsed response document
+    def initialize(ews, ews_item)
+      @ews      = ews
+      @ews_item = ews_item
+      @shallow  = true
+      @frozen = false
+    end
+
+    def method_missing(method_sym, *arguments, &block)
+      if method_keys.include?(method_sym)
+        type_convert( method_sym, resolve_method(method_sym) )
+      else
+        super
+      end
+    end
+
+    def to_s
+      "#{self.class.name}: EWS METHODS: #{self.ews_methods.sort.join(', ')}"
+    end
+
+    def frozen?
+      @frozen
+    end
+
+    # @param ronly [Boolean] true to freeze
+    def freeze!
+      @frozen = true
+    end
+
+    def unfreeze!
+      @frozen = false
+    end
+
+    def shallow?
+      @shallow
+    end
+
+    def mark_deep!
+      @shallow = false
+    end
+
+    def auto_deepen?
+      ews.auto_deepen
+    end
+
+    def deepen!
+      if shallow?
+        self.get_all_properties!
+        @shallow = false
+        true
+      end
+    end
+    alias_method :enlighten!, :deepen!
+
+    # @see http://www.ruby-doc.org/core/classes/Object.html#M000333
+    def respond_to?(method_sym, include_private = false)
+      if method_keys.include?(method_sym)
+        true
+      else
+        super
+      end
+    end
+
+    def methods(include_super = true)
+      super + ews_methods
+    end
+
+    def ews_methods
+      key_paths.keys + key_alias.keys
+    end
+
+    protected # things like OutOfOffice need protected level access
+
+    def ews
+      @ews
+    end
+
+    private
+
+    def key_paths
+      KEY_PATHS
+    end
+
+    def key_types
+      KEY_TYPES
+    end
+
+    def key_alias
+      KEY_ALIAS
+    end
+
+    def class_by_name(cname)
+      if(cname.instance_of? Symbol)
+        cname = camel_case(cname)
+      end
+      Viewpoint::EWS::Types.const_get(cname)
+    end
+
+    def type_convert(key,str)
+      return nil if str.nil?
+      key = key_alias[key] || key
+      if key_types[key]
+        key_types[key].is_a?(Symbol) ? method(key_types[key]).call(str) : key_types[key].call(str)
+      else
+        str
+      end
+    end
+
+    def resolve_method(method_sym)
+      begin
+        resolve_key_path(@ews_item, method_path(method_sym))
+      rescue
+        if shallow?
+          if frozen?
+            raise EwsFrozenObjectError, "Could not resolve :#{method_sym} on frozen object."
+          elsif auto_deepen?
+            enlighten!
+            retry
+          else
+            if !auto_deepen?
+              if ews.no_auto_deepen_behavior == :raise
+                raise EwsMinimalObjectError, "Could not resolve :#{method_sym}. #auto_deepen set to false"
+              else
+                nil
+              end
+            else
+            end
+          end
+        else
+          nil
+        end
+      end
+    end
+
+    def resolve_key_path(hsh, path)
+      k = path.first
+      return hsh[k] if path.length == 1
+      resolve_key_path(hsh[k],path[1..-1])
+    end
+
+    def method_keys
+      key_paths.keys + key_alias.keys
+    end
+
+    # Resolve the method path with or without an alias
+    def method_path(sym)
+      key_paths[key_alias[sym] || sym]
+    end
+
+    def build_extended_properties(eprops)
+      h = {}
+      # todo
+      # the return pattern seems broken in some cases,
+      # probably needs fixing via a dedicated response parser
+      eprops.each do |e|
+        if e.size == 1
+          e[:elems].each_cons(2) do |k,v|
+            key = k[:extended_field_u_r_i][:attribs][:property_name].downcase.to_sym
+            val = v[:value][:text]
+            h.store(key,val)
+          end
+        elsif e.size == 2
+          e[1].each_cons(2) do |k,v|
+            key = k[:extended_field_u_r_i][:attribs][:property_name].downcase.to_sym
+            val = v[:value][:text]
+            h.store(key,val)
+          end
+        else
+          raise EwsMinimalObjectError, "Not prepared to deal with elements greater than 2"
+        end
+      end
+      h
+    end
+
+  end
+end

data/lib/viewpoint/logging/config.rb

@@ -0,0 +1,24 @@
+=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
+  module EWS
+    Logging.logger.root.level = :debug
+    Logging.logger.root.appenders = Logging.appenders.stdout
+  end # EWS
+end

data/lib/viewpoint/logging.rb

@@ -0,0 +1,27 @@
+=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
+  module EWS
+    attr_reader :logger
+
+    def self.root_logger
+      Logging.logger.root
+    end
+  end # EWS
+end

data/lib/viewpoint/string_utils.rb

@@ -0,0 +1,44 @@
+=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
+  # Collection of utility methods for working with Strings
+  module StringUtils
+
+    def self.included(klass)
+      klass.extend StringUtils
+    end
+
+    private
+
+    # Change CamelCased strings to ruby_cased strings
+    # It uses the lookahead assertion ?=  In this case it basically says match
+    # anything followed by a capital letter, but not the capital letter itself.
+    # @see http://www.pcre.org/pcre.txt The PCRE guide for more details
+    def ruby_case(input)
+      input.to_s.split(/(?=[A-Z])/).join('_').downcase
+    end
+
+    # Change a ruby_cased string to CamelCased
+    def camel_case(input)
+      input.to_s.split(/_/).map { |i|
+        i.sub(/^./) { |s| s.upcase }
+      }.join
+    end
+  end # StringUtils
+end # Viewpoint

data/lib/viewpoint.rb

@@ -0,0 +1,109 @@
+=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
+
+require 'kconv' if(RUBY_VERSION.start_with? '1.9') # bug in rubyntlm with ruby 1.9.x
+require 'date'
+require 'base64'
+require 'nokogiri'
+require 'ostruct'
+require 'logging'
+
+# String utilities
+require 'viewpoint/string_utils'
+
+# Load the logging setup
+require 'viewpoint/logging'
+
+# Load the Exception classes
+require 'ews/exceptions/exceptions'
+
+# Load the backend SOAP / EWS infrastructure.
+require 'ews/soap'
+require 'ews/soap/response_message'
+require 'ews/soap/ews_response'
+require 'ews/soap/ews_soap_response'
+require 'ews/soap/ews_soap_availability_response'
+require 'ews/soap/ews_soap_free_busy_response'
+require 'ews/soap/ews_soap_room_response'
+require 'ews/soap/ews_soap_roomlist_response'
+require 'ews/soap/builders/ews_builder'
+require 'ews/soap/parsers/ews_parser'
+require 'ews/soap/parsers/ews_sax_document'
+# Mix-ins for the ExchangeWebService
+require 'ews/soap/exchange_data_services'
+require 'ews/soap/exchange_notification'
+require 'ews/soap/exchange_synchronization'
+require 'ews/soap/exchange_availability'
+require 'ews/soap/exchange_user_configuration'
+require 'ews/soap/exchange_time_zones'
+require 'ews/soap/exchange_web_service'
+
+require 'ews/errors'
+require 'ews/connection_helper'
+require 'ews/connection'
+
+require 'ews/impersonation'
+
+# Base Types
+require 'ews/types'
+require 'ews/types/item_field_uri_map'
+require 'ews/types/generic_folder'
+require 'ews/types/item'
+# Folders
+require 'ews/types/folder'
+require 'ews/types/calendar_folder'
+require 'ews/types/contacts_folder'
+require 'ews/types/tasks_folder'
+require 'ews/types/search_folder'
+# Items
+require 'ews/types/message'
+require 'ews/types/calendar_item'
+require 'ews/types/contact'
+require 'ews/types/distribution_list'
+require 'ews/types/meeting_message'
+require 'ews/types/meeting_request'
+require 'ews/types/meeting_response'
+require 'ews/types/meeting_cancellation'
+require 'ews/types/task'
+require 'ews/types/attachment'
+require 'ews/types/file_attachment'
+require 'ews/types/item_attachment'
+require 'ews/types/mailbox_user'
+require 'ews/types/out_of_office'
+require 'ews/types/export_items_response_message'
+
+# Events
+require 'ews/types/event'
+require 'ews/types/copied_event'
+require 'ews/types/created_event'
+require 'ews/types/deleted_event'
+require 'ews/types/free_busy_changed_event'
+require 'ews/types/modified_event'
+require 'ews/types/moved_event'
+require 'ews/types/new_mail_event'
+require 'ews/types/status_event'
+
+# Template Objects
+require 'ews/templates/message'
+require 'ews/templates/forward_item'
+require 'ews/templates/reply_to_item'
+require 'ews/templates/calendar_item'
+require 'ews/templates/task'
+
+# The proxy between the models and the web service
+require 'ews/ews_client'