viewpoint 1.2.0 → 2.0.0

data/lib/ews/types/mailbox_user.rb

@@ -1,156 +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
-
-  # 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 MailboxUser
-    include Viewpoint::EWS
-    include Viewpoint::EWS::Types
-
-    MAILBOX_KEY_PATHS = {
-      name: [:name],
-      email_address: [:email_address],
-    }
-    MAILBOX_KEY_TYPES = {}
-    MAILBOX_KEY_ALIAS = {
-      email: :email_address,
-    }
-
-    def initialize(ews, mbox_user)
-      @ews = ews
-      @ews_item = mbox_user
-      simplify!
-    end
-
-    def out_of_office_settings
-      mailbox = {:address => self.email_address}
-      resp = @ews.get_user_oof_settings(mailbox)
-      ewsi = resp.response.clone
-      ewsi.delete(:response_message)
-      return OutOfOffice.new(self,ewsi)
-      s = resp[:oof_settings]
-      @oof_state = s[:oof_state][:text]
-      @oof_ext_audience = s[:external_audience][:text]
-      @oof_start = DateTime.parse(s[:duration][:start_time][:text])
-      @oof_end = DateTime.parse(s[:duration][:end_time][:text])
-      @oof_internal_reply = s[:internal_reply][:message][:text]
-      @oof_external_reply = s[:internal_reply][:message][:text]
-      true
-    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 [DateTime] start_time The start of the time range to check as an xs:dateTime.
-    # @param [DateTime] end_time The end of the time range to check as an xs:dateTime.
-    # @see http://msdn.microsoft.com/en-us/library/aa563800(v=exchg.140)
-    def get_user_availability(email_address, start_time, end_time)
-      opts = {
-        mailbox_data: [ :email =>{:address => email_address} ],
-        free_busy_view_options: {
-        time_window: {start_time: start_time, end_time: end_time},
-      }
-      }
-      resp = (Viewpoint::EWS::EWS.instance).ews.get_user_availability(opts)
-      if(resp.status == 'Success')
-        return resp.items
-      else
-        raise EwsError, "GetUserAvailability produced an error: #{resp.code}: #{resp.message}"
-      end
-    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
-    #
-    # @param [String,MailboxUser] delegate_email The user you would like to give delegate access to.
-    #   This can either be a simple String e-mail address or you can pass in a MailboxUser object.
-    # @param [Hash] permissions A hash of folder type keys and permission type values. An example
-    #   would be {:calendar_folder_permission_level => 'Editor'}.  Possible keys are:
-    #   :calendar_folder_permission_level, :tasks_folder_permission_level, :inbox_folder_permission_level
-    #   :contacts_folder_permission_level, :notes_folder_permission_level, :journal_folder_permission_level
-    #   and possible values are:  None/Editor/Reviewer/Author/Custom
-    # @return [true] This method either returns true or raises an error with the message
-    #   as to why this operation did not succeed.
-    def add_delegate!(delegate_email, permissions)
-      # Use a new hash so the passed hash is not modified in case we are in a loop.
-      # Thanks to Markus Roberts for pointing this out.
-      formatted_perms = {}
-      # Modify permissions so we can pass it to the builders
-      permissions.each_pair do |k,v|
-        formatted_perms[k] = {:text => v}
-      end
-
-      resp = (Viewpoint::EWS::EWS.instance).ews.add_delegate(self.email_address, delegate_email, formatted_perms)
-      if(resp.status == 'Success')
-        return true
-      else
-        raise EwsError, "Could not add delegate access for user #{delegate_email}: #{resp.code}, #{resp.message}"
-      end
-    end
-
-    def update_delegate!(delegate_email, permissions)
-      # Modify permissions so we can pass it to the builders
-      formatted_perms = {}
-      permissions.each_pair do |k,v|
-        formatted_perms[k] = {:text => v}
-      end
-
-      resp = (Viewpoint::EWS::EWS.instance).ews.update_delegate(self.email_address, delegate_email, formatted_perms)
-      if(resp.status == 'Success')
-        return true
-      else
-        raise EwsError, "Could not update delegate access for user #{delegate_email}: #{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
+      # 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 MailboxUser
+        include Viewpoint::EWS
+        include Viewpoint::EWS::Types
+
+        MAILBOX_KEY_PATHS = {
+          name: [:name],
+          email_address: [:email_address]
+        }.freeze
+        MAILBOX_KEY_TYPES = {}.freeze
+        MAILBOX_KEY_ALIAS = {
+          email: :email_address
+        }.freeze
+
+        def initialize(ews, mbox_user)
+          @ews = ews
+          @ews_item = mbox_user
+          simplify!
+        end
+
+        def out_of_office_settings
+          mailbox = { address: email_address }
+          resp = @ews.get_user_oof_settings(mailbox)
+          ewsi = resp.response.clone
+          ewsi.delete(:response_message)
+          OutOfOffice.new(self, ewsi)
+        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 [DateTime] start_time The start of the time range to check as an xs:dateTime.
+        # @param [DateTime] end_time The end of the time range to check as an xs:dateTime.
+        # @see http://msdn.microsoft.com/en-us/library/aa563800(v=exchg.140)
+        def get_user_availability(email_address, start_time, end_time)
+          opts = {
+            mailbox_data: [{ email: { address: email_address } }],
+            free_busy_view_options: {
+              time_window: { start_time: start_time, end_time: end_time }
+            }
+          }
+          resp = Viewpoint::EWS::EWS.instance.ews.get_user_availability(opts)
+          unless resp.status == 'Success'
+            raise EwsError, "GetUserAvailability produced an error: #{resp.code}: #{resp.message}"
+          end
+
+          resp.items
+        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
+        #
+        # @param [String,MailboxUser] delegate_email The user you would like to give delegate access to.
+        #   This can either be a simple String e-mail address or you can pass in a MailboxUser object.
+        # @param [Hash] permissions A hash of folder type keys and permission type values. An example
+        #   would be {:calendar_folder_permission_level => 'Editor'}.  Possible keys are:
+        #   :calendar_folder_permission_level, :tasks_folder_permission_level, :inbox_folder_permission_level
+        #   :contacts_folder_permission_level, :notes_folder_permission_level, :journal_folder_permission_level
+        #   and possible values are:  None/Editor/Reviewer/Author/Custom
+        # @return [true] This method either returns true or raises an error with the message
+        #   as to why this operation did not succeed.
+        def add_delegate!(delegate_email, permissions)
+          # Use a new hash so the passed hash is not modified in case we are in a loop.
+          # Thanks to Markus Roberts for pointing this out.
+          formatted_perms = {}
+          # Modify permissions so we can pass it to the builders
+          permissions.each_pair do |k, v|
+            formatted_perms[k] = { text: v }
+          end
+
+          resp = Viewpoint::EWS::EWS.instance.ews.add_delegate(email_address, delegate_email, formatted_perms)
+          unless resp.status == 'Success'
+            raise EwsError, "Could not add delegate access for user #{delegate_email}: #{resp.code}, #{resp.message}"
+          end
+
+          true
+        end
+
+        def update_delegate!(delegate_email, permissions)
+          # Modify permissions so we can pass it to the builders
+          formatted_perms = {}
+          permissions.each_pair do |k, v|
+            formatted_perms[k] = { text: v }
+          end
+
+          resp = Viewpoint::EWS::EWS.instance.ews.update_delegate(email_address, delegate_email, formatted_perms)
+          unless resp.status == 'Success'
+            raise EwsError, "Could not update delegate access for user #{delegate_email}: #{resp.code}, #{resp.message}"
+          end
+
+          true
+        end
+
+        def get_delegate_info # rubocop:disable Naming/AccessorMethodName -- public API name
+          Viewpoint::EWS::EWS.instance.ews.get_delegate(email_address)
+          # if(resp.status == 'Success')
+          #   return true
+          # else
+          #   raise EwsError, "Could not update delegate access for user #{delegate_email}: " \
+          #                  "#{resp.code}, #{resp.message}"
+          # end
+        end
+
+        private
+
+        def simplify!
+          @ews_item = @ews_item.each_with_object({}) { |o, m|
+            m[o.keys.first] = o.values.first[:text]
+          }
+        end
+
+        def key_paths
+          @key_paths ||= super.merge(MAILBOX_KEY_PATHS)
+        end
+
+        def key_types
+          @key_types ||= super.merge(MAILBOX_KEY_TYPES)
+        end
+
+        def key_alias
+          @key_alias ||= super.merge(MAILBOX_KEY_ALIAS)
+        end
       end
     end
-
-    def get_delegate_info()
-      resp = (Viewpoint::EWS::EWS.instance).ews.get_delegate(self.email_address)
-      # if(resp.status == 'Success')
-      #   return true
-      # else
-      #   raise EwsError, "Could not update delegate access for user #{delegate_email}: #{resp.code}, #{resp.message}"
-      # end
-    end
-
-
-    private
-
-
-    def simplify!
-      @ews_item = @ews_item.inject({}){|m,o|
-        m[o.keys.first] = o.values.first[:text];
-        m
-      }
-    end
-
-    def key_paths
-      @key_paths ||= super.merge(MAILBOX_KEY_PATHS)
-    end
-
-    def key_types
-      @key_types ||= super.merge(MAILBOX_KEY_TYPES)
-    end
-
-    def key_alias
-      @key_alias ||= super.merge(MAILBOX_KEY_ALIAS)
-    end
-
-  end # MailboxUser
-end # Viewpoint::EWS::Types
+  end
+end

data/lib/ews/types/meeting_cancellation.rb

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

data/lib/ews/types/meeting_message.rb

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

data/lib/ews/types/meeting_request.rb

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

data/lib/ews/types/meeting_response.rb

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

data/lib/ews/types/message.rb

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

data/lib/ews/types/modified_event.rb

@@ -1,48 +1,46 @@
-=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 ModifiedEvent < Event
-
-    MODIFIED_EVENT_KEY_PATHS = {
-    }
-
-    MODIFIED_EVENT_KEY_TYPES = {
-    }
-
-    MODIFIED_EVENT_KEY_ALIAS = { }
-
-
-    private
-
-
-    def key_paths
-      @key_paths ||= super.merge MODIFIED_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
+      # Modified Event EWS data type.
+      class ModifiedEvent < Event
+        MODIFIED_EVENT_KEY_PATHS = {}.freeze
+
+        MODIFIED_EVENT_KEY_TYPES = {}.freeze
+
+        MODIFIED_EVENT_KEY_ALIAS = {}.freeze
+
+        private
+
+        def key_paths
+          @key_paths ||= super.merge MODIFIED_EVENT_KEY_PATHS
+        end
+
+        def key_types
+          @key_types ||= super.merge MODIFIED_EVENT_KEY_TYPES
+        end
+
+        def key_alias
+          @key_alias ||= super.merge MODIFIED_EVENT_KEY_ALIAS
+        end
+      end
     end
-
-    def key_types
-      @key_types ||= super.merge MODIFIED_EVENT_KEY_TYPES
-    end
-
-    def key_alias
-      @key_alias ||= super.merge MODIFIED_EVENT_KEY_ALIAS
-    end
-
   end
 end

data/lib/ews/types/moved_event.rb

@@ -1,51 +1,50 @@
-=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 MovedEvent < Event
-
-    MOVED_EVENT_KEY_PATHS = {
-      :old_item_id    => [:old_item_id, :attribs],
-      :old_folder_id  => [:old_folder_id, :attribs],
-      :old_parent_folder_id  => [:old_parent_folder_id, :attribs],
-    }
-
-    MOVED_EVENT_KEY_TYPES = {
-    }
-
-    MOVED_EVENT_KEY_ALIAS = { }
-
-
-    private
-
-
-    def key_paths
-      @key_paths ||= super.merge MOVED_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
+      # Moved Event EWS data type.
+      class MovedEvent < Event
+        MOVED_EVENT_KEY_PATHS = {
+          old_item_id: %i[old_item_id attribs],
+          old_folder_id: %i[old_folder_id attribs],
+          old_parent_folder_id: %i[old_parent_folder_id attribs]
+        }.freeze
+
+        MOVED_EVENT_KEY_TYPES = {}.freeze
+
+        MOVED_EVENT_KEY_ALIAS = {}.freeze
+
+        private
+
+        def key_paths
+          @key_paths ||= super.merge MOVED_EVENT_KEY_PATHS
+        end
+
+        def key_types
+          @key_types ||= super.merge MOVED_EVENT_KEY_TYPES
+        end
+
+        def key_alias
+          @key_alias ||= super.merge MOVED_EVENT_KEY_ALIAS
+        end
+      end
     end
-
-    def key_types
-      @key_types ||= super.merge MOVED_EVENT_KEY_TYPES
-    end
-
-    def key_alias
-      @key_alias ||= super.merge MOVED_EVENT_KEY_ALIAS
-    end
-
   end
 end

data/lib/ews/types/new_mail_event.rb

@@ -1,24 +1,26 @@
-=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>
-
-  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 NewMailEvent < Event
+#   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
+      class NewMailEvent < Event
+      end
+    end
   end
 end