viewpoint 1.2.0 → 2.0.0

data/lib/ews/soap/ews_soap_response.rb

@@ -1,103 +1,101 @@
-=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
-
-  # A Generic Class for SOAP returns.
-  # @attr_reader [String] :message The text from the EWS element <m:ResponseCode>
-  class EwsSoapResponse
-
-    def initialize(sax_hash)
-      @resp = sax_hash
-      simplify!
-    end
-
-    def envelope
-      @resp[:envelope][:elems]
-    end
-
-    def header
-      envelope[0][:header][:elems]
-    end
-
-    def body
-      envelope[1][:body][:elems]
-    end
-
-    def response
-      body[0]
-    end
-
-    def response_messages
-      key = response.keys.first
-      response[key][:elems].find{|e| e.keys.include? :response_messages }[:response_messages][:elems]
-    end
-
-    def response_message
-      key = response_messages[0].keys.first
-      response_messages[0][key]
-    end
-
-    def response_class
-      response_message[:attribs][:response_class]
-    end
-    alias :status :response_class
-
-    def response_code
-      response_message[:elems][:response_code][:text]
-    end
-    alias :code :response_code
-
-    def response_message_text
-      guard_hash response_message[:elems], [:message_text, :text]
-    end
-    alias :message :response_message_text
-
-    def success?
-      response_class == "Success"
-    end
-
-
-    private
-
-
-    def simplify!
-      response_messages.each do |rm|
-        key = rm.keys.first
-        rm[key][:elems] = rm[key][:elems].inject(&:merge)
+# 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
+      # A Generic Class for SOAP returns.
+      # @attr_reader [String] :message The text from the EWS element <m:ResponseCode>
+      class EwsSoapResponse
+        def initialize(sax_hash)
+          @resp = sax_hash
+          simplify!
+        end
+
+        def envelope
+          @resp[:envelope][:elems]
+        end
+
+        def header
+          envelope[0][:header][:elems]
+        end
+
+        def body
+          envelope[1][:body][:elems]
+        end
+
+        def response
+          body[0]
+        end
+
+        def response_messages
+          key = response.keys.first
+          response[key][:elems].find { |e| e.keys.include? :response_messages }[:response_messages][:elems]
+        end
+
+        def response_message
+          key = response_messages[0].keys.first
+          response_messages[0][key]
+        end
+
+        def response_class
+          response_message[:attribs][:response_class]
+        end
+        alias status response_class
+
+        def response_code
+          response_message[:elems][:response_code][:text]
+        end
+        alias code response_code
+
+        def response_message_text
+          guard_hash response_message[:elems], %i[message_text text]
+        end
+        alias message response_message_text
+
+        def success?
+          response_class == 'Success'
+        end
+
+        private
+
+        def simplify!
+          response_messages.each do |rm|
+            key = rm.keys.first
+            rm[key][:elems] = rm[key][:elems].inject(&:merge)
+          end
+        end
+
+        # If the keys don't exist in the Hash return nil
+        # @param[Hash] hsh
+        # @param[Array<Symbol,String>] keys keys to follow in the array
+        # @return [Object, nil]
+        def guard_hash(hsh, keys)
+          key = keys.shift
+          return nil unless hsh.is_a?(Hash) && hsh.key?(key)
+
+          if keys.empty?
+            hsh[key]
+          else
+            guard_hash hsh[key], keys
+          end
+        end
       end
     end
-
-    # If the keys don't exist in the Hash return nil
-    # @param[Hash] hsh
-    # @param[Array<Symbol,String>] keys keys to follow in the array
-    # @return [Object, nil]
-    def guard_hash(hsh, keys)
-      key = keys.shift
-      return nil unless hsh.is_a?(Hash) && hsh.has_key?(key)
-
-      if keys.empty?
-        hsh[key]
-      else
-        guard_hash hsh[key], keys
-      end
-    end
-
-  end # EwsSoapResponse
-
-end # Viewpoint::EWS::SOAP
+  end
+end

data/lib/ews/soap/ews_soap_room_response.rb

@@ -1,53 +1,53 @@
-=begin
-  This file is a contribution to Viewpoint; the Ruby library for Microsoft Exchange Web Services.
-
-  Copyright © 2013 Camille Baldock <viewpoint@camillebaldock.co.uk>
-
-  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
-
-  # A class for roomlists SOAP returns.
-  # @attr_reader [String] :message The text from the EWS element <m:ResponseCode>
-  class EwsSoapRoomResponse < EwsSoapResponse
+# frozen_string_literal: true
+
+#   This file is a contribution to Viewpoint; the Ruby library for Microsoft Exchange Web Services.
+#
+#   Copyright © 2013 Camille Baldock <viewpoint@camillebaldock.co.uk>
+#
+#   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
+      # A class for roomlists SOAP returns.
+      # @attr_reader [String] :message The text from the EWS element <m:ResponseCode>
+      class EwsSoapRoomResponse < EwsSoapResponse
+        def response_messages
+          key = response.keys.first
+          subresponse = response[key][:elems][1]
+          response_class = subresponse.keys.first
+          subresponse[response_class][:elems]
+        end
 
-    def response_messages
-      key = response.keys.first
-      subresponse = response[key][:elems][1]
-      response_class = subresponse.keys.first
-      subresponse[response_class][:elems]
-    end
+        def roomsArray # rubocop:disable Naming/MethodName -- public API name
+          response[:get_rooms_response][:elems][1][:rooms][:elems]
+        end
 
-    def roomsArray
-      response[:get_rooms_response][:elems][1][:rooms][:elems]
-    end
+        def success?
+          response.first[1][:attribs][:response_class] == 'Success'
+        end
 
-    def success?
-      response.first[1][:attribs][:response_class] == "Success"
-    end
+        private
 
-    private
+        def simplify!
+          return unless response_messages
 
-    def simplify!
-      if response_messages
-        response_messages.each do |rm|
-          key = rm.keys.first
-          rm[key][:elems] = rm[key][:elems].inject(&:merge)
+          response_messages.each do |rm|
+            key = rm.keys.first
+            rm[key][:elems] = rm[key][:elems].inject(&:merge)
+          end
         end
       end
     end
-
-  end # EwsSoapRoomResponse
-
-end # Viewpoint::EWS::SOAP
+  end
+end

data/lib/ews/soap/ews_soap_roomlist_response.rb

@@ -1,54 +1,53 @@
-=begin
-  This file is a contribution to Viewpoint; the Ruby library for Microsoft Exchange Web Services.
-
-  Copyright © 2013 Camille Baldock <viewpoint@camillebaldock.co.uk>
-
-  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
-
-  # A class for roomlists SOAP returns.
-  # @attr_reader [String] :message The text from the EWS element <m:ResponseCode>
-  class EwsSoapRoomlistResponse < EwsSoapResponse
-
-    def response_messages
-      key = response.keys.first
-      subresponse = response[key][:elems][1]
-      response_class = subresponse.keys.first
-      subresponse[response_class][:elems]
-    end
+# frozen_string_literal: true
+
+#   This file is a contribution to Viewpoint; the Ruby library for Microsoft Exchange Web Services.
+#
+#   Copyright © 2013 Camille Baldock <viewpoint@camillebaldock.co.uk>
+#
+#   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
+      # A class for roomlists SOAP returns.
+      # @attr_reader [String] :message The text from the EWS element <m:ResponseCode>
+      class EwsSoapRoomlistResponse < EwsSoapResponse
+        def response_messages
+          key = response.keys.first
+          subresponse = response[key][:elems][1]
+          response_class = subresponse.keys.first
+          subresponse[response_class][:elems]
+        end
 
-    def roomListsArray
-      response[:get_room_lists_response][:elems][1][:room_lists][:elems]
-    end
+        def roomListsArray # rubocop:disable Naming/MethodName -- public API name
+          response[:get_room_lists_response][:elems][1][:room_lists][:elems]
+        end
 
-    def success?
-      response.first[1][:attribs][:response_class] == "Success"
-    end
+        def success?
+          response.first[1][:attribs][:response_class] == 'Success'
+        end
 
-    private
+        private
 
+        def simplify!
+          return unless response_messages
 
-    def simplify!
-      if response_messages
-        response_messages.each do |rm|
-          key = rm.keys.first
-          rm[key][:elems] = rm[key][:elems].inject(&:merge)
+          response_messages.each do |rm|
+            key = rm.keys.first
+            rm[key][:elems] = rm[key][:elems].inject(&:merge)
+          end
         end
       end
     end
-
-  end # EwsSoapRoomlistResponse
-
-end # Viewpoint::EWS::SOAP
+  end
+end

data/lib/ews/soap/exchange_availability.rb

@@ -1,61 +1,63 @@
-module Viewpoint::EWS::SOAP
+# frozen_string_literal: true
 
-  # Exchange Availability operations as listed in the EWS Documentation.
-  # @see http://msdn.microsoft.com/en-us/library/bb409286.aspx
-  module ExchangeAvailability
-    include Viewpoint::EWS::SOAP
+module Viewpoint
+  module EWS
+    module SOAP
+      # Exchange Availability operations as listed in the EWS Documentation.
+      # @see http://msdn.microsoft.com/en-us/library/bb409286.aspx
+      module ExchangeAvailability
+        include Viewpoint::EWS::SOAP
 
-    # -------------- Availability Operations -------------
+        # -------------- Availability Operations -------------
 
-    # Gets a mailbox user's Out of Office (OOF) settings and messages.
-    # @see http://msdn.microsoft.com/en-us/library/aa563465.aspx
-    # @param [Hash] opts
-    # @option opts [String] :address the email address of the user
-    # @option opts [String] :name the user display name (optional)
-    # @option opts [String] :routing_type the routing protocol (optional and stupid)
-    def get_user_oof_settings(opts)
-      opts = opts.clone
-      [:address].each do |k|
-        validate_param(opts, k, true)
-      end
-      req = build_soap! do |type, builder|
-        if(type == :header)
-        else
-        builder.nbuild.GetUserOofSettingsRequest {|x|
-          x.parent.default_namespace = @default_ns
-          builder.mailbox!(opts)
-        }
+        # Gets a mailbox user's Out of Office (OOF) settings and messages.
+        # @see http://msdn.microsoft.com/en-us/library/aa563465.aspx
+        # @param [Hash] opts
+        # @option opts [String] :address the email address of the user
+        # @option opts [String] :name the user display name (optional)
+        # @option opts [String] :routing_type the routing protocol (optional and stupid)
+        def get_user_oof_settings(opts)
+          opts = opts.clone
+          [:address].each do |k|
+            validate_param(opts, k, true)
+          end
+          req = build_soap! { |type, builder|
+            unless type == :header
+              builder.nbuild.GetUserOofSettingsRequest { |x|
+                x.parent.default_namespace = @default_ns
+                builder.mailbox!(opts)
+              }
+            end
+          }
+          do_soap_request(req, response_class: EwsSoapAvailabilityResponse)
         end
-      end
-      do_soap_request(req, response_class: EwsSoapAvailabilityResponse)
-    end
 
-    # Sets a mailbox user's Out of Office (OOF) settings and message.
-    # @see http://msdn.microsoft.com/en-us/library/aa580294.aspx
-    # @param [Hash] opts
-    # @option opts [Hash] :mailbox the mailbox hash for the use
-    # @option opts [String,Symbol] :oof_state :enabled, :disabled, :scheduled
-    # @option opts [Hash] :duration {start_time: DateTime, end_time: DateTime}
-    # @option opts [String] :internal_reply
-    # @option opts [String] :external_reply
-    # @option opts [String,Symbol] :external_audience :none, :known, :all
-    def set_user_oof_settings(opts)
-      opts = opts.clone
-      [:mailbox, :oof_state].each do |k|
-        validate_param(opts, k, true)
-      end
-      req = build_soap! do |type, builder|
-        if(type == :header)
-        else
-        builder.nbuild.SetUserOofSettingsRequest {|x|
-          x.parent.default_namespace = @default_ns
-          builder.mailbox! opts.delete(:mailbox)
-          builder.user_oof_settings!(opts)
-        }
+        # Sets a mailbox user's Out of Office (OOF) settings and message.
+        # @see http://msdn.microsoft.com/en-us/library/aa580294.aspx
+        # @param [Hash] opts
+        # @option opts [Hash] :mailbox the mailbox hash for the use
+        # @option opts [String,Symbol] :oof_state :enabled, :disabled, :scheduled
+        # @option opts [Hash] :duration {start_time: DateTime, end_time: DateTime}
+        # @option opts [String] :internal_reply
+        # @option opts [String] :external_reply
+        # @option opts [String,Symbol] :external_audience :none, :known, :all
+        def set_user_oof_settings(opts) # rubocop:disable Naming/AccessorMethodName -- public API name
+          opts = opts.clone
+          %i[mailbox oof_state].each do |k|
+            validate_param(opts, k, true)
+          end
+          req = build_soap! { |type, builder|
+            unless type == :header
+              builder.nbuild.SetUserOofSettingsRequest { |x|
+                x.parent.default_namespace = @default_ns
+                builder.mailbox! opts.delete(:mailbox)
+                builder.user_oof_settings!(opts)
+              }
+            end
+          }
+          do_soap_request(req, response_class: EwsSoapAvailabilityResponse)
         end
       end
-      do_soap_request(req, response_class: EwsSoapAvailabilityResponse)
     end
-
-  end #ExchangeAvailability
+  end
 end