viewpoint 1.2.0 → 2.0.0

data/lib/ews/types/out_of_office.rb

@@ -1,147 +1,148 @@
-=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}"
+# 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
+      OOF_KEY_PATHS = {
+        enabled?: %i[oof_settings oof_state],
+        scheduled?: %i[oof_settings oof_state],
+        duration: %i[oof_settings duration]
+      }.freeze
+
+      OOF_KEY_TYPES = {
+        enabled?: ->(str) { str == :enabled },
+        scheduled?: ->(str) { str == :scheduled },
+        duration: ->(hsh) { hsh[:start_time]..hsh[:end_time] }
+      }.freeze
+
+      OOF_KEY_ALIAS = {}.freeze
+
+      # 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)
+          raise SaveFailed, "Could not save #{self.class}. #{resp.code}: #{resp.message}" unless resp.success?
+
+          @changed = false
+          true
+        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
     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
 end

data/lib/ews/types/post_item.rb

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

data/lib/ews/types/search_folder.rb

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

data/lib/ews/types/status_event.rb

@@ -1,39 +1,40 @@
-=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
+# 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
+      # Status Event EWS data type.
+      class StatusEvent
+        include Viewpoint::EWS
+        include Viewpoint::EWS::Types
+        include Viewpoint::EWS::Types::Item
+
+        STATUS_EVENT_KEY_PATHS = {
+          watermark: %i[watermark text]
+        }.freeze
+
+        private
+
+        def key_paths
+          @key_paths ||= STATUS_EVENT_KEY_PATHS
+        end
+      end
     end
-
   end
 end

data/lib/ews/types/task.rb

@@ -1,41 +1,47 @@
-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],
-      percent_complete:  [:percent_complete, :text],
-      status:            [:status, :text],
-   }
+# frozen_string_literal: true
 
-    TASK_KEY_TYPES = {
-      recurring?:       ->(str){str.downcase == 'true'},
-      complete?:        ->(str){str.downcase == 'true'},
-      reminder?:        ->(str){str.downcase == 'true'},
-      percent_complete: ->(str){str.to_i},
-    }
-    TASK_KEY_ALIAS = {}
+module Viewpoint
+  module EWS
+    module Types
+      # Task EWS data type.
+      class Task
+        include Viewpoint::EWS
+        include Viewpoint::EWS::Types
+        include Viewpoint::EWS::Types::Item
 
-    private
+        TASK_KEY_PATHS = {
+          complete?: %i[is_complete text],
+          recurring?: %i[is_recurring text],
+          start_date: %i[start_date text],
+          due_date: %i[end_date text],
+          reminder_due_by: %i[reminder_due_by text],
+          reminder?: %i[reminder_is_set text],
+          percent_complete: %i[percent_complete text],
+          status: %i[status text]
+        }.freeze
 
-    def key_paths
-      super.merge(TASK_KEY_PATHS)
-    end
+        TASK_KEY_TYPES = {
+          recurring?: ->(str) { str.downcase == 'true' },
+          complete?: ->(str) { str.downcase == 'true' },
+          reminder?: ->(str) { str.downcase == 'true' },
+          percent_complete: lambda(&:to_i)
+        }.freeze
+        TASK_KEY_ALIAS = {}.freeze
 
-    def key_types
-      super.merge(TASK_KEY_TYPES)
-    end
+        private
 
-    def key_alias
-      super.merge(TASK_KEY_ALIAS)
-    end
+        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
   end
 end

data/lib/ews/types/tasks_folder.rb

@@ -1,29 +1,35 @@
-module Viewpoint::EWS::Types
-  class TasksFolder
-    include Viewpoint::EWS
-    include Viewpoint::EWS::Types
-    include Viewpoint::EWS::Types::GenericFolder
+# frozen_string_literal: true
 
-    # 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
-        if rm
-          raise EwsCreateItemError, "Could not create item in folder. #{rm.code}: #{rm.message_text}"
-        else
-          raise EwsCreateItemError, "Could not create item in folder."
+module Viewpoint
+  module EWS
+    module Types
+      # Tasks Folder EWS data type.
+      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: id, change_key: change_key }
+          rm = ews.create_item(template.to_ews_create).response_messages.first
+          if 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}" if rm
+
+            raise EwsCreateItemError, 'Could not create item in folder.'
+
+          end
         end
       end
     end