viewpoint 1.2.0 → 2.0.0

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

@@ -1,53 +1,54 @@
-=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 GetEventsResponseMessage < ResponseMessage
-
-    def notification
-      safe_hash_access message, [:elems, :notification, :elems]
-    end
-
-    def subscription_id
-      safe_hash_access notification[0], [:subscription_id, :text]
-    end
-
-    def previous_watermark
-      safe_hash_access notification[1], [:previous_watermark, :text]
-    end
-
-    def new_watermark
-      ev = notification.last
-      if ev
-        type = ev.keys.first
-        ev[type][:elems][0][:watermark][:text]
-      else
-        nil
+# 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 SOAP
+      # Parses the Get Events operation SOAP response.
+      class GetEventsResponseMessage < ResponseMessage
+        def notification
+          safe_hash_access message, %i[elems notification elems]
+        end
+
+        def subscription_id
+          safe_hash_access notification[0], %i[subscription_id text]
+        end
+
+        def previous_watermark
+          safe_hash_access notification[1], %i[previous_watermark text]
+        end
+
+        def new_watermark
+          ev = notification.last
+          return unless ev
+
+          type = ev.keys.first
+          ev[type][:elems][0][:watermark][:text]
+        end
+
+        def more_events?
+          safe_hash_access(notification[2], %i[more_events text]) == 'true'
+        end
+
+        def events
+          notification[3..]
+        end
       end
     end
-
-    def more_events?
-      safe_hash_access(notification[2], [:more_events, :text]) == 'true'
-    end
-
-    def events
-      notification[3..-1]
-    end
-
-  end # GetEventsResponseMessage
-end # Viewpoint::EWS::SOAP
+  end
+end

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

@@ -1,59 +1,61 @@
-=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 SendNotificationResponseMessage < ResponseMessage
-    include Viewpoint::StringUtils
+# 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 SOAP
+      # Parses the Send Notification operation SOAP response.
+      class SendNotificationResponseMessage < ResponseMessage
+        include Viewpoint::StringUtils
+
+        def notification
+          safe_hash_access message, %i[elems notification elems]
+        end
 
-    def notification
-      safe_hash_access message, [:elems, :notification, :elems]
-    end
+        def subscription_id
+          safe_hash_access notification[0], %i[subscription_id text]
+        end
 
-    def subscription_id
-      safe_hash_access notification[0], [:subscription_id, :text]
-    end
+        def previous_watermark
+          safe_hash_access notification[1], %i[previous_watermark text]
+        end
 
-    def previous_watermark
-      safe_hash_access notification[1], [:previous_watermark, :text]
-    end
+        def new_watermark
+          ev = notification.last
+          return unless ev
 
-    def new_watermark
-      ev = notification.last
-      if ev
-        type = ev.keys.first
-        ev[type][:elems][0][:watermark][:text]
-      else
-        nil
-      end
-    end
+          type = ev.keys.first
+          ev[type][:elems][0][:watermark][:text]
+        end
 
-    def more_events?
-      safe_hash_access(notification[2], [:more_events, :text]) == 'true'
-    end
+        def more_events?
+          safe_hash_access(notification[2], %i[more_events text]) == 'true'
+        end
 
-    def events
-      @events ||=
-        notification[3..-1].collect do |ev|
-          type = ev.keys.first
-          klass = Viewpoint::EWS::Types.const_get(camel_case(type))
-          klass.new(nil, ev[type])
+        def events
+          @events ||=
+            notification[3..].collect { |ev|
+              type = ev.keys.first
+              klass = Viewpoint::EWS::Types.const_get(camel_case(type))
+              klass.new(nil, ev[type])
+            }
         end
+      end
     end
-
-  end # SendNotificationResponseMessage
-end # Viewpoint::EWS::SOAP
+  end
+end

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

@@ -1,35 +1,38 @@
-=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 SubscribeResponseMessage < ResponseMessage
-
-    def subscription
-      safe_hash_access message, [:elems]
+# 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 SOAP
+      # Parses the Subscribe operation SOAP response.
+      class SubscribeResponseMessage < ResponseMessage
+        def subscription
+          safe_hash_access message, [:elems]
+        end
+
+        def subscription_id
+          safe_hash_access subscription, %i[subscription_id text]
+        end
+
+        def watermark
+          safe_hash_access subscription, %i[watermark text]
+        end
+      end
     end
-
-    def subscription_id
-      safe_hash_access subscription, [:subscription_id, :text]
-    end
-
-    def watermark
-      safe_hash_access subscription, [:watermark, :text]
-    end
-
-  end # SubscribeResponseMessage
-end # Viewpoint::EWS::SOAP
+  end
+end

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

@@ -1,36 +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::SOAP
-  class SyncFolderHierarchyResponseMessage < ResponseMessage
-
-    def sync_state
-      safe_hash_access message, [:elems, :sync_state, :text]
+# 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 SOAP
+      # Parses the Sync Folder Hierarchy operation SOAP response.
+      class SyncFolderHierarchyResponseMessage < ResponseMessage
+        def sync_state
+          safe_hash_access message, %i[elems sync_state text]
+        end
+
+        def includes_last_folder_in_range?
+          ans = safe_hash_access message, %i[elems includes_last_folder_in_range text]
+          ans.downcase == 'true'
+        end
+
+        def changes
+          safe_hash_access(message, %i[elems changes elems]) || []
+        end
+      end
     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
+  end
+end

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

@@ -1,36 +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::SOAP
-  class SyncFolderItemsResponseMessage < ResponseMessage
-
-    def sync_state
-      safe_hash_access message, [:elems, :sync_state, :text]
+# 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 SOAP
+      # Parses the Sync Folder Items operation SOAP response.
+      class SyncFolderItemsResponseMessage < ResponseMessage
+        def sync_state
+          safe_hash_access message, %i[elems sync_state text]
+        end
+
+        def includes_last_item_in_range?
+          ans = safe_hash_access message, %i[elems includes_last_item_in_range text]
+          ans.downcase == 'true'
+        end
+
+        def changes
+          safe_hash_access(message, %i[elems changes elems]) || []
+        end
+      end
     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
+  end
+end

data/lib/ews/soap.rb

@@ -1,43 +1,45 @@
-=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
+#   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.
 
 # This module defines some constants and other niceties to make available to
 # the underlying SOAP classes and modules that do the actual work.
 module Viewpoint
   module EWS
+    # SOAP message building, dispatch, and response parsing.
     module SOAP
-
       # CONSTANTS
 
-      NS_SOAP         = 'soap'.freeze
-      NS_EWS_TYPES    = 't'.freeze
-      NS_EWS_MESSAGES = 'm'.freeze
+      NS_SOAP         = 'soap'
+      NS_EWS_TYPES    = 't'
+      NS_EWS_MESSAGES = 'm'
       NAMESPACES = {
         "xmlns:#{NS_SOAP}"         => 'http://schemas.xmlsoap.org/soap/envelope/',
         "xmlns:#{NS_EWS_TYPES}"    => 'http://schemas.microsoft.com/exchange/services/2006/types',
-        "xmlns:#{NS_EWS_MESSAGES}" => 'http://schemas.microsoft.com/exchange/services/2006/messages',
+        "xmlns:#{NS_EWS_MESSAGES}" => 'http://schemas.microsoft.com/exchange/services/2006/messages'
       }.freeze
 
       # used in ResolveNames to determine where names are resolved
+      # rubocop:disable Naming/ConstantName -- public API names
       ActiveDirectory         = 'ActiveDirectory'
       ActiveDirectoryContacts = 'ActiveDirectoryContacts'
       Contacts                = 'Contacts'
       ContactsActiveDirectory = 'ContactsActiveDirectory'
+      # rubocop:enable Naming/ConstantName
 
       # Target specific Exchange Server versions
       # @see http://msdn.microsoft.com/en-us/library/bb891876(v=exchg.140).aspx
@@ -55,10 +57,9 @@ module Viewpoint
       MOVE_TO_DELETED_ITEMS = 'MoveToDeletedItems'
 
       def initialize
-        @log = Logging.logger[self.class.name.to_s.to_sym]
+        @log = Viewpoint::EWS.root_logger
         @default_ns = NAMESPACES["xmlns:#{NS_EWS_MESSAGES}"]
       end
-
-    end # SOAP
-  end # EWS
-end # Viewpoint
+    end
+  end
+end