viewpoint 1.1.1 → 2.0.0

data/lib/ews/types/attachment.rb

@@ -1,77 +1,78 @@
-=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
-  # A generic Attachment.  This class should not be instantiated directly.  You
-  # should use one of the subclasses like FileAttachment or ItemAttachment.
-  class Attachment
-    include Viewpoint::EWS
-    include Viewpoint::EWS::Types
-    include Viewpoint::EWS::Types::Item
-
-    ATTACH_KEY_PATHS = {
-      :id   => [:attachment_id, :attribs, :id],
-      :parent_item_id  => [:attachment_id, :attribs, :root_item_id],
-      :parent_change_key  => [:attachment_id, :attribs, :root_item_change_key],
-      :name => [:name, :text],
-      :content_type => [:content_type, :text],
-      :content_id => [:content_id],
-      :size => [:size, :text],
-      :last_modified_time => [:last_modified_time, :text],
-      :is_inline? => [:is_inline, :text],
-    }
-
-    ATTACH_KEY_TYPES = {
-      is_inline?:   ->(str){str.downcase == 'true'},
-      last_modified_type: ->(str){DateTime.parse(str)},
-      size: ->(str){str.to_i},
-      content_id: :fix_content_id,
-    }
-
-    ATTACH_KEY_ALIAS = { }
-
-    # @param [Hash] attachment The attachment ews_item
-    def initialize(item, attachment)
-      @item = item
-      super(item.ews, attachment)
+# frozen_string_literal: true
+
+#   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.
+
+module Viewpoint
+  module EWS
+    module Types
+      # A generic Attachment.  This class should not be instantiated directly.  You
+      # should use one of the subclasses like FileAttachment or ItemAttachment.
+      class Attachment
+        include Viewpoint::EWS
+        include Viewpoint::EWS::Types
+        include Viewpoint::EWS::Types::Item
+
+        ATTACH_KEY_PATHS = {
+          id: %i[attachment_id attribs id],
+          parent_item_id: %i[attachment_id attribs root_item_id],
+          parent_change_key: %i[attachment_id attribs root_item_change_key],
+          name: %i[name text],
+          content_type: %i[content_type text],
+          content_id: [:content_id],
+          size: %i[size text],
+          last_modified_time: %i[last_modified_time text],
+          is_inline?: %i[is_inline text]
+        }.freeze
+
+        ATTACH_KEY_TYPES = {
+          is_inline?: ->(str) { str.downcase == 'true' },
+          last_modified_type: ->(str) { DateTime.parse(str) },
+          size: lambda(&:to_i),
+          content_id: :fix_content_id
+        }.freeze
+
+        ATTACH_KEY_ALIAS = {}.freeze
+
+        # @param [Hash] attachment The attachment ews_item
+        def initialize(item, attachment)
+          @item = item
+          super(item.ews, attachment)
+        end
+
+        private
+
+        def key_paths
+          @key_paths ||= ATTACH_KEY_PATHS
+        end
+
+        def key_types
+          @key_types ||= ATTACH_KEY_TYPES
+        end
+
+        def key_alias
+          @key_alias ||= ATTACH_KEY_ALIAS
+        end
+
+        # Sometimes the SOAP response comes back with two identical content_ids.
+        # This method fishes them out no matter which way them come.
+        def fix_content_id(content_id)
+          content_id.is_a?(Array) ? content_id.last[:text] : content_id[:text]
+        end
+      end
     end
-
-
-    private
-
-
-    def key_paths
-      @key_paths ||= ATTACH_KEY_PATHS
-    end
-
-    def key_types
-      @key_types ||= ATTACH_KEY_TYPES
-    end
-
-    def key_alias
-      @key_alias ||= ATTACH_KEY_ALIAS
-    end
-
-    # Sometimes the SOAP response comes back with two identical content_ids.
-    # This method fishes them out no matter which way them come.
-    def fix_content_id(content_id)
-      content_id.is_a?(Array) ? content_id.last[:text] : content_id[:text]
-    end
-
   end
 end

data/lib/ews/types/attendee.rb

@@ -1,27 +1,29 @@
-=begin
-  This file is part of Viewpoint; the Ruby library for Microsoft Exchange Web Services.
+# frozen_string_literal: true
 
-  Copyright © 2011 Dan Wanek <dan.wanek@gmail.com>
+#   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.
 
-  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
-
-  # This represents a Mailbox object in the Exchange data store
-  # @see http://msdn.microsoft.com/en-us/library/aa565036.aspx MSDN docs
-  # @todo Design a Class method that resolves to an Array of MailboxUsers
-  class Attendee < MailboxUser
-  end # Attendee
-
-end # Viewpoint::EWS::Types
+module Viewpoint
+  module EWS
+    module Types
+      # This represents a Mailbox object in the Exchange data store
+      # @see http://msdn.microsoft.com/en-us/library/aa565036.aspx MSDN docs
+      # @todo Design a Class method that resolves to an Array of MailboxUsers
+      class Attendee < MailboxUser
+      end
+    end
+  end
+end

data/lib/ews/types/calendar_folder.rb

@@ -1,50 +1,66 @@
-module Viewpoint::EWS::Types
-  class CalendarFolder
-    include Viewpoint::EWS
-    include Viewpoint::EWS::Types
-    include Viewpoint::EWS::Types::GenericFolder
+# frozen_string_literal: true
 
-    # Fetch items between a given time period
-    # @param [DateTime] start_date the time to start fetching Items from
-    # @param [DateTime] end_date the time to stop fetching Items from
-    def items_between(start_date, end_date, opts={})
-      items do |obj|
-        obj.restriction = { :and =>
-          [
-            {:is_greater_than_or_equal_to =>
-              [
-                {:field_uRI => {:field_uRI=>'calendar:Start'}},
-                {:field_uRI_or_constant=>{:constant => {:value =>start_date}}}
-              ]
-            },
-            {:is_less_than_or_equal_to =>
-              [
-                {:field_uRI => {:field_uRI=>'calendar:End'}},
-                {:field_uRI_or_constant=>{:constant => {:value =>end_date}}}
-              ]
-            }
-          ]
-        }
-      end
-    end
+module Viewpoint
+  module EWS
+    module Types
+      # Calendar Folder EWS data type.
+      class CalendarFolder
+        include Viewpoint::EWS
+        include Viewpoint::EWS::Types
+        include Viewpoint::EWS::Types::GenericFolder
+
+        # Fetch items between a given time period
+        # @param [DateTime] start_date the time to start fetching Items from
+        # @param [DateTime] end_date the time to stop fetching Items from
+        def items_between(start_date, end_date, _opts = {})
+          items do |obj|
+            obj.restriction = { and: [
+              { is_greater_than_or_equal_to: [
+                { field_uRI: { field_uRI: 'calendar:Start' } },
+                { field_uRI_or_constant: { constant: { value: start_date } } }
+              ] },
+              { is_less_than_or_equal_to: [
+                { field_uRI: { field_uRI: 'calendar:End' } },
+                { field_uRI_or_constant: { constant: { value: end_date } } }
+              ] }
+            ] }
+          end
+        end
+
+        # Fetch items between a given time period using a calendar view.
+        # The calendar view will include occurences of recurring calendar items
+        # next to the regular single calendar items.
+        # @param [DateTime] start_date the time to start fetching Items from
+        # @param [DateTime] end_date the time to stop fetching Items from
+        # @param opts [Hash]
+        # @option opts :max_entries_returned [Integer] the maximum number of entries to return
+        def items_between_calendar_view(start_date, end_date, opts = {})
+          view_opts = { start_date: start_date, end_date: end_date }
+          view_opts[:max_entries_returned] = opts.delete(:max_entries_returned) if opts[:max_entries_returned]
+          items(opts.merge(calendar_view: view_opts))
+        end
 
-    # Creates a new appointment
-    # @param attributes [Hash] Parameters of the calendar item. Some example attributes are listed below.
-    # @option attributes :subject [String]
-    # @option attributes :start [Time]
-    # @option attributes :end [Time]
-    # @return [CalendarItem]
-    # @see Template::CalendarItem
-    def create_item(attributes, to_ews_create_opts = {})
-      template = Viewpoint::EWS::Template::CalendarItem.new attributes
-      template.saved_item_folder_id = {id: self.id, change_key: self.change_key}
-      rm = ews.create_item(template.to_ews_create(to_ews_create_opts)).response_messages.first
-      if rm && rm.success?
-        CalendarItem.new ews, rm.items.first[:calendar_item][:elems].first
-      else
-        raise EwsCreateItemError, "Could not create item in folder. #{rm.code}: #{rm.message_text}" unless rm
+        # Creates a new appointment
+        # @param attributes [Hash] Parameters of the calendar item. Some example attributes are listed below.
+        # @option attributes :subject [String]
+        # @option attributes :start [Time]
+        # @option attributes :end [Time]
+        # @return [CalendarItem]
+        # @see Template::CalendarItem
+        def create_item(attributes, to_ews_create_opts = {})
+          template = Viewpoint::EWS::Template::CalendarItem.new attributes
+          template.saved_item_folder_id = { id: id, change_key: change_key }
+          rm = ews.create_item(template.to_ews_create(to_ews_create_opts)).response_messages.first
+          if rm&.success?
+            CalendarItem.new ews, rm.items.first[:calendar_item][:elems].first
+          else
+            raise EwsCreateItemError, "Could not create item in folder. #{rm.code}: #{rm.message_text}" if rm
+
+            raise EwsCreateItemError, 'Could not create item in folder.'
+
+          end
+        end
       end
     end
-
   end
 end

data/lib/ews/types/calendar_item.rb

@@ -1,130 +1,148 @@
-module Viewpoint::EWS::Types
-  class CalendarItem
-    include Viewpoint::EWS
-    include Viewpoint::EWS::Types
-    include Viewpoint::EWS::Types::Item
-    include Viewpoint::StringUtils
-
-    CALENDAR_ITEM_KEY_PATHS = {
-      recurring?:   [:is_recurring, :text],
-      meeting?:     [:is_meeting, :text],
-      cancelled?:   [:is_cancelled, :text],
-      duration:     [:duration, :text],
-      time_zone:    [:time_zone, :text],
-      start:        [:start, :text],
-      end:          [:end, :text],
-      location:     [:location, :text],
-      all_day?:     [:is_all_day_event, :text],
-      legacy_free_busy_status: [:legacy_free_busy_status, :text],
-      my_response_type:   [:my_response_type, :text],
-      organizer: [:organizer, :elems, 0, :mailbox, :elems],
-      optional_attendees: [:optional_attendees, :elems ],
-      required_attendees: [:required_attendees, :elems ],
-      recurrence: [:recurrence, :elems ],
-      deleted_occurrences: [:deleted_occurrences, :elems ],
-      modified_occurrences: [:modified_occurrences, :elems ]
-   }
-
-    CALENDAR_ITEM_KEY_TYPES = {
-      start:        ->(str){DateTime.parse(str)},
-      end:          ->(str){DateTime.parse(str)},
-      recurring?:   ->(str){str.downcase == 'true'},
-      meeting?:     ->(str){str.downcase == 'true'},
-      cancelled?:   ->(str){str.downcase == 'true'},
-      all_day?:     ->(str){str.downcase == 'true'},
-      organizer: :build_mailbox_user,
-      optional_attendees: :build_attendees_users,
-      required_attendees: :build_attendees_users,
-      deleted_occurrences: :build_deleted_occurrences,
-      modified_occurrences: :build_modified_occurrences
-    }
-    CALENDAR_ITEM_KEY_ALIAS = {}
-
-    # Updates the specified item attributes
-    #
-    # Uses `SetItemField` if value is present and `DeleteItemField` if value is nil
-    # @param updates [Hash] with (:attribute => value)
-    # @param options [Hash]
-    # @option options :conflict_resolution [String] one of 'NeverOverwrite', 'AutoResolve' (default) or 'AlwaysOverwrite'
-    # @option options :send_meeting_invitations_or_cancellations [String] one of 'SendToNone' (default), 'SendOnlyToAll',
-    #   'SendOnlyToChanged', 'SendToAllAndSaveCopy' or 'SendToChangedAndSaveCopy'
-    # @return [CalendarItem, false]
-    # @example Update Subject and Body
-    #   item = #...
-    #   item.update_item!(subject: 'New subject', body: 'New Body')
-    # @see http://msdn.microsoft.com/en-us/library/exchange/aa580254.aspx
-    # @todo AppendToItemField updates not implemented
-    def update_item!(updates, options = {})
-      item_updates = []
-      updates.each do |attribute, value|
-        item_field = FIELD_URIS[attribute][:text] if FIELD_URIS.include? attribute
-        field = {field_uRI: {field_uRI: item_field}}
-
-        if value.nil? && item_field
-          # Build DeleteItemField Change
-          item_updates << {delete_item_field: field}
-        elsif item_field
-          # Build SetItemField Change
-          item = Viewpoint::EWS::Template::CalendarItem.new(attribute => value)
-
-          # Remap attributes because ews_builder #dispatch_field_item! uses #build_xml!
-          item_attributes = item.to_ews_item.map do |name, value|
-            if value.is_a? String
-              {name => {text: value}}
-            elsif value.is_a? Hash
-              node = {name => {}}
-              value.each do |attrib_key, attrib_value|
-                attrib_key = camel_case(attrib_key) unless attrib_key == :text
-                node[name][attrib_key] = attrib_value
-              end
-              node
-            else
-              {name => value}
+# frozen_string_literal: true
+
+module Viewpoint
+  module EWS
+    module Types
+      # Calendar Item EWS data type.
+      class CalendarItem
+        include Viewpoint::EWS
+        include Viewpoint::EWS::Types
+        include Viewpoint::EWS::Types::Item
+        include Viewpoint::StringUtils
+
+        CALENDAR_ITEM_KEY_PATHS = {
+          recurring?: %i[is_recurring text],
+          meeting?: %i[is_meeting text],
+          cancelled?: %i[is_cancelled text],
+          duration: %i[duration text],
+          time_zone: %i[time_zone text],
+          start: %i[start text],
+          end: %i[end text],
+          location: %i[location text],
+          all_day?: %i[is_all_day_event text],
+          legacy_free_busy_status: %i[legacy_free_busy_status text],
+          my_response_type: %i[my_response_type text],
+          organizer: [:organizer, :elems, 0, :mailbox, :elems],
+          optional_attendees: %i[optional_attendees elems],
+          required_attendees: %i[required_attendees elems],
+          recurrence: %i[recurrence elems],
+          deleted_occurrences: %i[deleted_occurrences elems],
+          modified_occurrences: %i[modified_occurrences elems]
+        }.freeze
+
+        CALENDAR_ITEM_KEY_TYPES = {
+          start: ->(str) { DateTime.parse(str) },
+          end: ->(str) { DateTime.parse(str) },
+          recurring?: ->(str) { str.downcase == 'true' },
+          meeting?: ->(str) { str.downcase == 'true' },
+          cancelled?: ->(str) { str.downcase == 'true' },
+          all_day?: ->(str) { str.downcase == 'true' },
+          organizer: :build_mailbox_user,
+          optional_attendees: :build_attendees_users,
+          required_attendees: :build_attendees_users,
+          deleted_occurrences: :build_deleted_occurrences,
+          modified_occurrences: :build_modified_occurrences
+        }.freeze
+        CALENDAR_ITEM_KEY_ALIAS = {}.freeze
+
+        # Delete this calendar item
+        # @param deltype [Symbol] The delete type; must be :hard, :soft, or :recycle.
+        #   By default EWS will do a  hard delete of this calendar item.  See the=
+        #   MSDN docs for more info: http://msdn.microsoft.com/en-us/library/aa562961.aspx
+        # @param cancel_type [String] 'SendToNone'/'SendOnlyToAll'/'SendToAllAndSaveCopy'
+        #   Default is 'SendOnlyToAll'
+        # @return [Boolean] Whether or not the calendar item was deleted
+        def delete!(deltype = :hard, cancel_type = 'SendOnlyToAll', opts = {})
+          opts = opts.merge(send_meeting_cancellations: cancel_type)
+          super(deltype, opts)
+        end
+
+        # Updates the specified item attributes
+        #
+        # Uses `SetItemField` if value is present and `DeleteItemField` if value is nil
+        # @param updates [Hash] with (:attribute => value)
+        # @param options [Hash]
+        # @option options :conflict_resolution [String] one of 'NeverOverwrite', 'AutoResolve' (default)
+        #   or 'AlwaysOverwrite'
+        # @option options :send_meeting_invitations_or_cancellations [String] one of 'SendToNone' (default),
+        #   'SendOnlyToAll',
+        #   'SendOnlyToChanged', 'SendToAllAndSaveCopy' or 'SendToChangedAndSaveCopy'
+        # @return [CalendarItem, false]
+        # @example Update Subject and Body
+        #   item = #...
+        #   item.update_item!(subject: 'New subject', body: 'New Body')
+        # @see http://msdn.microsoft.com/en-us/library/exchange/aa580254.aspx
+        # @todo AppendToItemField updates not implemented
+        def update_item!(updates, options = {})
+          item_updates = []
+          updates.each do |attribute, value|
+            item_field = FIELD_URIS[attribute][:text] if FIELD_URIS.include? attribute
+            field = { field_uRI: { field_uRI: item_field } }
+
+            if value.nil? && item_field
+              # Build DeleteItemField Change
+              item_updates << { delete_item_field: field }
+            elsif item_field
+              # Build SetItemField Change
+              item = Viewpoint::EWS::Template::CalendarItem.new(attribute => value)
+
+              # Remap attributes because ews_builder #dispatch_field_item! uses #build_xml!
+              item_attributes = item.to_ews_item.map { |name, value|
+                if value.is_a? String
+                  { name => { text: value } }
+                elsif value.is_a? Hash
+                  node = { name => {} }
+                  value.each do |attrib_key, attrib_value|
+                    attrib_key = camel_case(attrib_key) unless attrib_key == :text
+                    node[name][attrib_key] = attrib_value
+                  end
+                  node
+                else
+                  { name => value }
+                end
+              }
+
+              item_updates << { set_item_field: field.merge(calendar_item: { sub_elements: item_attributes }) }
             end
           end
 
-          item_updates << {set_item_field: field.merge(calendar_item: {sub_elements: item_attributes})}
-        else
-          # Ignore unknown attribute
-        end
-      end
-
-      if item_updates.any?
-        data = {}
-        data[:conflict_resolution] = options[:conflict_resolution] || 'AutoResolve'
-        data[:send_meeting_invitations_or_cancellations] = options[:send_meeting_invitations_or_cancellations] || 'SendToNone'
-        data[:item_changes] = [{item_id: self.item_id, updates: item_updates}]
-        rm = ews.update_item(data).response_messages.first
-        if rm && rm.success?
-          self.get_all_properties!
-          self
-        else
-          raise EwsCreateItemError, "Could not update calendar item. #{rm.code}: #{rm.message_text}" unless rm
-        end
-      end
+          return unless item_updates.any?
 
-    end
+          data = {}
+          data[:conflict_resolution] = options[:conflict_resolution] || 'AutoResolve'
+          data[:send_meeting_invitations_or_cancellations] =
+            options[:send_meeting_invitations_or_cancellations] || 'SendToNone'
+          data[:item_changes] = [{ item_id: item_id, updates: item_updates }]
+          rm = ews.update_item(data).response_messages.first
+          if rm&.success?
+            get_all_properties!
+            self
+          else
+            raise EwsCreateItemError, "Could not update calendar item. #{rm.code}: #{rm.message_text}" if rm
 
-    def duration_in_seconds
-      iso8601_duration_to_seconds(duration)
-    end
+            raise EwsCreateItemError, 'Could not update calendar item.'
 
+          end
+        end
 
-    private
+        def duration_in_seconds
+          iso8601_duration_to_seconds(duration)
+        end
 
+        private
 
-    def key_paths
-      super.merge(CALENDAR_ITEM_KEY_PATHS)
-    end
+        def key_paths
+          super.merge(CALENDAR_ITEM_KEY_PATHS)
+        end
 
-    def key_types
-      super.merge(CALENDAR_ITEM_KEY_TYPES)
-    end
+        def key_types
+          super.merge(CALENDAR_ITEM_KEY_TYPES)
+        end
 
-    def key_alias
-      super.merge(CALENDAR_ITEM_KEY_ALIAS)
+        def key_alias
+          super.merge(CALENDAR_ITEM_KEY_ALIAS)
+        end
+      end
     end
-
-
   end
 end

data/lib/ews/types/contact.rb

@@ -1,7 +1,13 @@
-module Viewpoint::EWS::Types
-  class Contact
-    include Viewpoint::EWS
-    include Viewpoint::EWS::Types
-    include Viewpoint::EWS::Types::Item
+# frozen_string_literal: true
+
+module Viewpoint
+  module EWS
+    module Types
+      class Contact
+        include Viewpoint::EWS
+        include Viewpoint::EWS::Types
+        include Viewpoint::EWS::Types::Item
+      end
+    end
   end
 end

data/lib/ews/types/contacts_folder.rb

@@ -1,8 +1,13 @@
-module Viewpoint::EWS::Types
-  class ContactsFolder
-    include Viewpoint::EWS
-    include Viewpoint::EWS::Types
-    include Viewpoint::EWS::Types::GenericFolder
+# frozen_string_literal: true
 
+module Viewpoint
+  module EWS
+    module Types
+      class ContactsFolder
+        include Viewpoint::EWS
+        include Viewpoint::EWS::Types
+        include Viewpoint::EWS::Types::GenericFolder
+      end
+    end
   end
 end