viewpoint 1.1.1 → 2.0.0

data/lib/ews/soap/ews_response.rb

@@ -1,84 +1,79 @@
-=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.
-  class EwsResponse
-    include Viewpoint::StringUtils
-
-    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
+# 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.
+      class EwsResponse
+        include Viewpoint::StringUtils
+
+        def initialize(sax_hash)
+          @resp = sax_hash
+          simplify!
+        end
 
-    def response
-      body[0]
-    end
+        def envelope
+          @resp[:envelope][:elems]
+        end
 
-    def response_messages
-      return @response_messages if @response_messages
+        def header
+          envelope[0][:header][:elems]
+        end
 
-      @response_messages = []
-      response_type = response.keys.first
-      response[response_type][:elems][0][:response_messages][:elems].each do |rm|
-        response_message_type = rm.keys[0]
-        rm_klass = class_by_name(response_message_type)
-        @response_messages << rm_klass.new(rm)
-      end
-      @response_messages
-    end
+        def body
+          envelope[1][:body][:elems]
+        end
 
+        def response
+          body[0]
+        end
 
-    private
+        def response_messages
+          return @response_messages if @response_messages
+
+          @response_messages = []
+          response_type = response.keys.first
+          response[response_type][:elems][0][:response_messages][:elems].each do |rm|
+            response_message_type = rm.keys[0]
+            rm_klass = class_by_name(response_message_type)
+            @response_messages << rm_klass.new(rm)
+          end
+          @response_messages
+        end
 
+        private
 
-    def simplify!
-      response_type = response.keys.first
-      response[response_type][:elems][0][:response_messages][:elems].each do |rm|
-        key = rm.keys.first
-        rm[key][:elems] = rm[key][:elems].inject(&:merge)
-      end
-    end
+        def simplify!
+          response_type = response.keys.first
+          response[response_type][:elems][0][:response_messages][:elems].each do |rm|
+            key = rm.keys.first
+            rm[key][:elems] = rm[key][:elems].inject(&:merge)
+          end
+        end
 
-    def class_by_name(cname)
-      begin
-        if(cname.instance_of? Symbol)
-          cname = camel_case(cname)
+        def class_by_name(cname)
+          cname = camel_case(cname) if cname.instance_of? Symbol
+          Viewpoint::EWS::SOAP.const_get(cname)
+        rescue NameError
+          ResponseMessage
         end
-        Viewpoint::EWS::SOAP.const_get(cname)
-      rescue NameError => e
-        ResponseMessage
       end
     end
-
-  end # EwsSoapResponse
-
-end # Viewpoint::EWS::SOAP
+  end
+end

data/lib/ews/soap/ews_soap_availability_response.rb

@@ -1,58 +1,58 @@
-=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
-
-  # This is a speciality response class to handle the idiosynracies of
-  # Availability responses.
-  # @attr_reader [String] :message The text from the EWS element <m:ResponseCode>
-  class EwsSoapAvailabilityResponse < EwsSoapResponse
-
-    def response_messages
-      nil
-    end
-
-    def response
-      body[0][response_key]
-    end
-
-    def response_message
-      key = response.keys.first
-      response[key]
-    end
-
-    def response_code
-      response_message[:elems][:response_code][:text]
-    end
-    alias :code :response_code
-
-    def response_key
-      key = body[0].keys.first
+# 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
+      # This is a speciality response class to handle the idiosynracies of
+      # Availability responses.
+      # @attr_reader [String] :message The text from the EWS element <m:ResponseCode>
+      class EwsSoapAvailabilityResponse < EwsSoapResponse
+        def response_messages
+          nil
+        end
+
+        def response
+          body[0][response_key]
+        end
+
+        def response_message
+          key = response.keys.first
+          response[key]
+        end
+
+        def response_code
+          response_message[:elems][:response_code][:text]
+        end
+        alias code response_code
+
+        def response_key
+          body[0].keys.first
+        end
+
+        private
+
+        def simplify!
+          key = response_key
+          body[0][key] = body[0][key][:elems].inject(:merge)
+          response_message[:elems] = response_message[:elems].inject(:merge)
+        end
+      end
     end
-
-    private
-
-    def simplify!
-      key = response_key
-      body[0][key] = body[0][key][:elems].inject(:merge)
-      response_message[:elems] = response_message[:elems].inject(:merge)
-    end
-
-  end # EwsSoapAvailabilityResponse
-
-end # Viewpoint::EWS::SOAP
+  end
+end

data/lib/ews/soap/ews_soap_free_busy_response.rb

@@ -1,119 +1,117 @@
-=begin
-  This file is a cotribution to Viewpoint; the Ruby library for Microsoft Exchange Web Services.
-
-  Copyright © 2013 Mark McCahill <mark.mccahill@duke.edu>
-
-  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 EwsSoapFreeBusyResponse  < 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 get_user_availability_response
-      body.first[:get_user_availability_response][:elems].first[:free_busy_response_array][:elems].first[:free_busy_response][:elems]
-    end
-
-    def response
-      body
-    end
-
-    def calendar_event_array
-      result = find_in_hash_list(get_user_availability_response[1][:free_busy_view][:elems], :calendar_event_array)
-      result ? result[:elems] : []
-    end
-
-    def working_hours
-      get_user_availability_response[1][:free_busy_view][:elems][2][:working_hours][:elems]
-    end
-
-    def response_message
-      find_in_hash_list(get_user_availability_response, :response_message)
-    end
-
-    def response_class
-      response_message[:attribs][:response_class]
-    end
-    alias :status :response_class
-
-    def response_code
-      result = find_in_hash_list(response_message[:elems], :response_code)
-      result ? result[:text] : nil
-    end
-    alias :code :response_code
-
-    def response_message_text
-      guard_hash response_message[:elems], [:message_text, :text]
-    end
-    alias :message :response_message_text
-
-    def response_key
-      response_message[:elems]
-    end
-
-    def success?
-      response_class == "Success"
-    end
-
-    private
-
-    def simplify!
-#     key = response_key
-#     body[0][key] = body[0][key][:elems].inject(:merge)
-#     response_message[:elems] = response_message[:elems].inject(:merge)
-    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
+# frozen_string_literal: true
+
+#   This file is a cotribution to Viewpoint; the Ruby library for Microsoft Exchange Web Services.
+#
+#   Copyright © 2013 Mark McCahill <mark.mccahill@duke.edu>
+#
+#   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 GetUserAvailability SOAP responses.
+      class EwsSoapFreeBusyResponse < EwsSoapResponse
+        def envelope
+          @resp[:envelope][:elems]
+        end
+
+        def header
+          envelope[0][:header][:elems]
+        end
+
+        def body
+          envelope[1][:body][:elems]
+        end
+
+        def get_user_availability_response # rubocop:disable Naming/AccessorMethodName -- public API name
+          body.first[:get_user_availability_response][:elems]
+              .first[:free_busy_response_array][:elems]
+              .first[:free_busy_response][:elems]
+        end
+
+        def response
+          body
+        end
+
+        def calendar_event_array
+          result = find_in_hash_list(get_user_availability_response[1][:free_busy_view][:elems], :calendar_event_array)
+          result ? result[:elems] : []
+        end
+
+        def working_hours
+          get_user_availability_response[1][:free_busy_view][:elems][2][:working_hours][:elems]
+        end
+
+        def response_message
+          find_in_hash_list(get_user_availability_response, :response_message)
+        end
+
+        def response_class
+          response_message[:attribs][:response_class]
+        end
+        alias status response_class
+
+        def response_code
+          result = find_in_hash_list(response_message[:elems], :response_code)
+          result ? result[:text] : nil
+        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 response_key
+          response_message[:elems]
+        end
+
+        def success?
+          response_class == 'Success'
+        end
+
+        private
+
+        def simplify!
+          #     key = response_key
+          #     body[0][key] = body[0][key][:elems].inject(:merge)
+          #     response_message[:elems] = response_message[:elems].inject(:merge)
+        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
+
+        # Find the first element in a list of hashes or return nil
+        # Example:
+        #     find_in_hash_list([{:foo => :bar}, {:bar => :baz}], :foo)
+        #     => :bar
+        def find_in_hash_list(collection, key)
+          result = collection.find { |hsh| hsh.keys.include?(key) }
+          result ? result[key] : nil
+        end
       end
     end
-
-    # Find the first element in a list of hashes or return nil
-    # Example:
-    #     find_in_hash_list([{:foo => :bar}, {:bar => :baz}], :foo)
-    #     => :bar
-    def find_in_hash_list(collection, key)
-      result = collection.find { |hsh| hsh.keys.include?(key) }
-      result ? result[key] : nil
-    end
-
-  end # EwsSoapFreeBusyResponse
-
-end # Viewpoint::EWS::SOAP
+  end
+end