viewpoint 1.0.0.beta.1 → 1.0.0

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

@@ -22,6 +22,7 @@ module Viewpoint::EWS::SOAP
   # 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
 
@@ -31,7 +32,10 @@ module Viewpoint::EWS::SOAP
     end
 
     def characters(string)
-      string.strip!
+      # 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
@@ -41,18 +45,18 @@ module Viewpoint::EWS::SOAP
     end
 
     def start_element_namespace(name, attributes = [], prefix = nil, uri = nil, ns = [])
-      name = name.ruby_case.to_sym
+      name = ruby_case(name).to_sym
       elem = {}
       unless attributes.empty?
         elem[:attribs] = attributes.collect{|a|
-          {a.localname.ruby_case.to_sym => a.value}
+          { ruby_case(a.localname).to_sym => a.value}
         }.inject(&:merge)
       end
       @elems << elem
     end
 
     def end_element_namespace name, prefix=nil, uri=nil
-      name = name.ruby_case.to_sym
+      name = ruby_case(name).to_sym
       elem = @elems.pop
       if @elems.empty?
         @struct[name] = elem

data/lib/ews/soap/response_message.rb

@@ -19,7 +19,7 @@
 module Viewpoint::EWS::SOAP
   class ResponseMessage
 
-    attr_reader :message
+    attr_reader :message, :type
 
     def initialize(message)
       @type    = message.keys.first
@@ -76,3 +76,5 @@ 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

@@ -19,6 +19,7 @@
 module Viewpoint::EWS::SOAP
 
   class CreateAttachmentResponseMessage < ResponseMessage
+    include Viewpoint::StringUtils
 
     def attachments
       return @attachments if @attachments
@@ -34,7 +35,7 @@ module Viewpoint::EWS::SOAP
     def parse_attachments(att)
       att.collect do |a|
         type = a.keys.first
-        klass = Viewpoint::EWS::Types.const_get(type.to_s.camel_case)
+        klass = Viewpoint::EWS::Types.const_get(camel_case(type))
         item = OpenStruct.new
         item.ews = nil
         klass.new(item, a[type])

data/lib/ews/soap/responses/send_notification_response_message.rb

@@ -18,6 +18,7 @@
 
 module Viewpoint::EWS::SOAP
   class SendNotificationResponseMessage < ResponseMessage
+    include Viewpoint::StringUtils
 
     def notification
       safe_hash_access message, [:elems, :notification, :elems]
@@ -49,7 +50,7 @@ module Viewpoint::EWS::SOAP
       @events ||=
         notification[3..-1].collect do |ev|
           type = ev.keys.first
-          klass = Viewpoint::EWS::Types.const_get(type.to_s.camel_case)
+          klass = Viewpoint::EWS::Types.const_get(camel_case(type))
           klass.new(nil, ev[type])
         end
     end

data/lib/{extensions/string.rb → ews/soap/responses/sync_folder_hierarchy_response_message.rb}

@@ -16,20 +16,21 @@
   limitations under the License.
 =end
 
-# Custom extensions to the class String
-class String
-  # 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
-    self.split(/(?=[A-Z])/).join('_').downcase
-  end
-
-  # Change a ruby_cased string to CamelCased
-  def camel_case
-    self.split(/_/).map { |i|
-      i.sub(/^./) { |s| s.upcase }
-    }.join
-  end
-end # String
+module Viewpoint::EWS::SOAP
+  class SyncFolderHierarchyResponseMessage < ResponseMessage
+
+    def sync_state
+      safe_hash_access message, [:elems, :sync_state, :text]
+    end
+
+    def includes_last_folder_in_range?
+      ans = safe_hash_access message, [:elems, :includes_last_folder_in_range, :text]
+      ans.downcase == 'true'
+    end
+
+    def changes
+      safe_hash_access(message, [:elems, :changes, :elems]) || []
+    end
+
+  end # SyncFolderHierarchyResponseMessage
+end # Viewpoint::EWS::SOAP

data/lib/ews/soap/responses/sync_folder_items_response_message.rb

@@ -0,0 +1,36 @@
+=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 SyncFolderItemsResponseMessage < ResponseMessage
+
+    def sync_state
+      safe_hash_access message, [:elems, :sync_state, :text]
+    end
+
+    def includes_last_item_in_range?
+      ans = safe_hash_access message, [:elems, :includes_last_item_in_range, :text]
+      ans.downcase == 'true'
+    end
+
+    def changes
+      safe_hash_access(message, [:elems, :changes, :elems]) || []
+    end
+
+  end # SyncFolderItemsResponseMessage
+end # Viewpoint::EWS::SOAP

data/lib/ews/templates/calendar_item.rb

@@ -0,0 +1,78 @@
+module Viewpoint::EWS
+  module Template
+  # Template for creating CalendarItems
+  # @see http://msdn.microsoft.com/en-us/library/exchange/aa564765.aspx
+  class CalendarItem < OpenStruct
+
+      # Available parameters with the required ordering
+      PARAMETERS = %w{mime_content item_id parent_folder_id item_class subject sensitivity body attachments
+        date_time_received size categories in_reply_to is_submitted is_draft is_from_me is_resend is_unmodified
+        internet_message_headers date_time_sent date_time_created response_objects reminder_due_by reminder_is_set
+        reminder_minutes_before_start display_cc display_to has_attachments extended_property culture start end
+        original_start is_all_day_event legacy_free_busy_status location when is_meeting is_cancelled is_recurring
+        meeting_request_was_sent is_response_requested calendar_item_type my_response_type organizer
+        required_attendees optional_attendees resources conflicting_meeting_count adjacent_meeting_count
+        conflicting_meetings adjacent_meetings duration time_zone appointment_reply_time appointment_sequence_number
+        appointment_state recurrence first_occurrence last_occurrence modified_occurrences deleted_occurrences
+        meeting_time_zone start_time_zone end_time_zone conference_type allow_new_time_proposal is_online_meeting
+        meeting_workspace_url net_show_url effective_rights last_modified_name last_modified_time is_associated
+        web_client_read_form_query_string web_client_edit_form_query_string conversation_id unique_body
+      }.map(&:to_sym).freeze
+
+      # Returns a new CalendarItem template
+      def initialize(opts = {})
+        super opts.dup
+      end
+
+      # EWS CreateItem container
+      # @return [Hash]
+      def to_ews_create
+        structure = {}
+        structure[:message_disposition] = (draft ? 'SaveOnly' : 'SendAndSaveCopy')
+        structure[:send_meeting_invitations] = 'SendToNone'
+
+        if self.saved_item_folder_id
+          if self.saved_item_folder_id.kind_of?(Hash)
+            structure[:saved_item_folder_id] = saved_item_folder_id
+          else
+            structure[:saved_item_folder_id] = {id: saved_item_folder_id}
+          end
+        end
+
+        structure[:items] = [{calendar_item: to_ews_item}]
+        structure
+      end
+
+      # EWS Item hash
+      #
+      # Puts all known parameters in the required ordering and structure
+      # @return [Hash]
+      def to_ews_item
+        item_parameters = {}
+        PARAMETERS.each do |key|
+          if !(value = self.send(key)).nil?
+
+            # Convert non duplicable values to String
+            case value
+              when NilClass, FalseClass, TrueClass, Symbol, Numeric
+                value = value.to_s
+            end
+
+            # Convert attributes
+            case key
+              when :start, :end
+                item_parameters[key] = {text: value.respond_to?(:iso8601) ? value.iso8601 : value}
+              when :body
+                item_parameters[key] = {body_type: self.body_type || 'Text', text: value.to_s}
+              else
+                item_parameters[key] = value
+            end
+          end
+        end
+
+        item_parameters
+      end
+
+    end
+  end
+end

data/lib/ews/templates/message.rb

@@ -14,7 +14,7 @@ module Viewpoint::EWS
       end
 
       def has_attachments?
-        !(file_attachments.empty? && item_attachments.empty?)
+        !(file_attachments.empty? && item_attachments.empty? && inline_attachments.empty?)
       end
 
 
@@ -25,12 +25,15 @@ module Viewpoint::EWS
         self.subject ||= nil
         self.body ||= nil
         self.body_type ||= 'Text'
+        self.importance ||= 'Normal'
         self.draft ||= false
         self.to_recipients ||= []
         self.cc_recipients ||= []
         self.bcc_recipients ||= []
         self.file_attachments ||= []
         self.item_attachments ||= []
+        self.inline_attachments ||= []
+        self.extended_properties ||= []
       end
 
       def to_ews_basic
@@ -49,6 +52,8 @@ module Viewpoint::EWS
         msg[:subject] = subject if subject
         msg[:body] = {text: body, body_type: body_type} if body
 
+        msg[:importance] = importance if importance
+
         to_r = to_recipients.collect{|r| {mailbox: {email_address: r}}}
         msg[:to_recipients] = to_r unless to_r.empty?
 
@@ -58,6 +63,8 @@ module Viewpoint::EWS
         bcc_r = bcc_recipients.collect{|r| {mailbox: {email_address: r}}}
         msg[:bcc_recipients] = bcc_r unless bcc_r.empty?
 
+        msg[:extended_properties] = extended_properties unless extended_properties.empty?
+
         [ews_opts, msg]
       end
 

data/lib/ews/templates/task.rb

@@ -0,0 +1,74 @@
+module Viewpoint::EWS
+  module Template
+  # Template for creating Tasks
+  # @see http://msdn.microsoft.com/en-us/library/exchange/aa564765.aspx
+  class Task < OpenStruct
+
+      # Available parameters with the required ordering
+      PARAMETERS = %w{mime_content item_id parent_folder_id item_class subject sensitivity body attachments
+            date_time_received size categories in_reply_to is_submitted is_draft is_from_me is_resend
+            is_unmodified internet_message_headers date_time_sent date_time_created response_objects
+            reminder_due_by reminder_is_set reminder_minutes_before_start display_cc display_to
+            has_attachments extended_property culture actual_work assigned_time billing_information
+            change_count companies complete_date contacts delegation_state delegator due_date
+            is_assignment_editable is_complete is_recurring is_team_task mileage owner percent_complete
+            recurrence start_date status status_description total_work effective_rights last_modified_name
+            last_modified_time is_associated web_client_read_form_query_string
+            web_client_edit_form_query_string conversation_id unique_body 
+      }.map(&:to_sym).freeze
+
+      # Returns a new Task template
+      def initialize(opts = {})
+        super opts.dup
+      end
+
+      # EWS CreateItem container
+      # @return [Hash]
+      def to_ews_create
+        structure = {}
+
+        if self.saved_item_folder_id
+          if self.saved_item_folder_id.kind_of?(Hash)
+            structure[:saved_item_folder_id] = saved_item_folder_id
+          else
+            structure[:saved_item_folder_id] = {id: saved_item_folder_id}
+          end
+        end
+
+        structure[:items] = [{task: to_ews_item}]
+        structure
+      end
+
+      # EWS Item hash
+      #
+      # Puts all known parameters in the required ordering and structure
+      # @return [Hash]
+      def to_ews_item
+        item_parameters = {}
+        PARAMETERS.each do |key|
+          if !(value = self.send(key)).nil?
+
+            # Convert non duplicable values to String
+            case value
+              when NilClass, FalseClass, TrueClass, Symbol, Numeric
+                value = value.to_s
+            end
+
+            # Convert attributes
+            case key
+              when :start_date, :due_date
+                item_parameters[key] = {text: value.respond_to?(:iso8601) ? value.iso8601 : value}
+              when :body
+                item_parameters[key] = {body_type: self.body_type || 'Text', text: value.to_s}
+              else
+                item_parameters[key] = value
+            end
+          end
+        end
+
+        item_parameters
+      end
+
+    end
+  end
+end

data/lib/ews/types.rb

@@ -1,5 +1,6 @@
 module Viewpoint::EWS
   module Types
+    include Viewpoint::StringUtils
 
     KEY_PATHS = {
       extended_properties: [:extended_property],
@@ -16,7 +17,8 @@ module Viewpoint::EWS
     def initialize(ews, ews_item)
       @ews      = ews
       @ews_item = ews_item
-      @shallow      = true
+      @shallow  = true
+      @frozen = false
     end
 
     def method_missing(method_sym, *arguments, &block)
@@ -31,6 +33,19 @@ module Viewpoint::EWS
       "#{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
@@ -91,18 +106,21 @@ module Viewpoint::EWS
 
     def class_by_name(cname)
       if(cname.instance_of? Symbol)
-        cname = cname.to_s.camel_case
+        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
+      begin
+        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
+      rescue
+        nil
       end
     end
 
@@ -111,11 +129,20 @@ module Viewpoint::EWS
         resolve_key_path(@ews_item, method_path(method_sym))
       rescue
         if shallow?
-          if auto_deepen?
+          if frozen?
+            raise EwsFrozenObjectError, "Could not resolve :#{method_sym} on frozen object."
+          elsif auto_deepen?
             enlighten!
             retry
           else
-            raise EwsMinimalObjectError, "Could not resolve :#{method_sym}. #auto_deepen set to false"
+            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
@@ -139,7 +166,28 @@ module Viewpoint::EWS
     end
 
     def build_extended_properties(eprops)
-      eprops.collect.collect {|e| e[:elems]}
+      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