viewpoint 1.1.1 → 2.0.0

data/lib/ews/types.rb

@@ -1,194 +1,189 @@
-module Viewpoint::EWS
-  module Types
-    include Viewpoint::StringUtils
-
-    KEY_PATHS = {
-      extended_properties: [:extended_property],
-    }
-    KEY_TYPES = {
-      extended_properties: :build_extended_properties,
-    }
-    KEY_ALIAS = {}
-
-    attr_reader :ews_item
-
-    # @param [SOAP::ExchangeWebService] ews the EWS reference
-    # @param [Hash] ews_item the EWS parsed response document
-    def initialize(ews, ews_item)
-      @ews      = ews
-      @ews_item = ews_item
-      @shallow  = true
-      @frozen = false
-    end
+# frozen_string_literal: true
+
+module Viewpoint
+  module EWS
+    # EWS data type models.
+    module Types
+      include Viewpoint::StringUtils
+
+      KEY_PATHS = {
+        extended_properties: [:extended_property]
+      }.freeze
+      KEY_TYPES = {
+        extended_properties: :build_extended_properties
+      }.freeze
+      KEY_ALIAS = {}.freeze
+
+      attr_reader :ews_item
+
+      # @param [SOAP::ExchangeWebService] ews the EWS reference
+      # @param [Hash] ews_item the EWS parsed response document
+      def initialize(ews, ews_item)
+        @ews      = ews
+        @ews_item = ews_item
+        @shallow  = true
+        @frozen = false
+      end
 
-    def method_missing(method_sym, *arguments, &block)
-      if method_keys.include?(method_sym)
-        type_convert( method_sym, resolve_method(method_sym) )
-      else
-        super
+      def method_missing(method_sym, *arguments, &block)
+        if method_keys.include?(method_sym)
+          type_convert(method_sym, resolve_method(method_sym))
+        else
+          super
+        end
       end
-    end
 
-    def to_s
-      "#{self.class.name}: EWS METHODS: #{self.ews_methods.sort.join(', ')}"
-    end
+      def respond_to_missing?(method_sym, include_private = false)
+        method_keys.include?(method_sym) || super
+      end
 
-    def frozen?
-      @frozen
-    end
+      def to_s
+        "#{self.class.name}: EWS METHODS: #{ews_methods.sort.join(', ')}"
+      end
 
-    # @param ronly [Boolean] true to freeze
-    def freeze!
-      @frozen = true
-    end
+      def frozen?
+        @frozen
+      end
 
-    def unfreeze!
-      @frozen = false
-    end
+      # @param ronly [Boolean] true to freeze
+      def freeze!
+        @frozen = true
+      end
 
-    def shallow?
-      @shallow
-    end
+      def unfreeze!
+        @frozen = false
+      end
 
-    def mark_deep!
-      @shallow = false
-    end
+      def shallow?
+        @shallow
+      end
 
-    def auto_deepen?
-      ews.auto_deepen
-    end
+      def mark_deep!
+        @shallow = false
+      end
+
+      def auto_deepen?
+        ews.auto_deepen
+      end
 
-    def deepen!
-      if shallow?
-        self.get_all_properties!
+      def deepen!
+        return unless shallow?
+
+        get_all_properties!
         @shallow = false
         true
       end
-    end
-    alias_method :enlighten!, :deepen!
+      alias enlighten! deepen!
 
-    # @see http://www.ruby-doc.org/core/classes/Object.html#M000333
-    def respond_to?(method_sym, include_private = false)
-      if method_keys.include?(method_sym)
-        true
-      else
-        super
+      # @see http://www.ruby-doc.org/core/classes/Object.html#M000333
+      # rubocop:disable Style/OptionalBooleanParameter -- must match Ruby's core respond_to? signature
+      def respond_to?(method_sym, include_private = false)
+        method_keys.include?(method_sym) || super
       end
-    end
+      # rubocop:enable Style/OptionalBooleanParameter
 
-    def methods(include_super = true)
-      super + ews_methods
-    end
+      # rubocop:disable Style/OptionalBooleanParameter -- must match Ruby's core Object#methods signature
+      def methods(include_super = true)
+        super + ews_methods
+      end
+      # rubocop:enable Style/OptionalBooleanParameter
 
-    def ews_methods
-      key_paths.keys + key_alias.keys
-    end
+      def ews_methods
+        key_paths.keys + key_alias.keys
+      end
 
-    protected # things like OutOfOffice need protected level access
+      protected # things like OutOfOffice need protected level access
 
-    def ews
-      @ews
-    end
+      def ews
+        @ews
+      end
 
-    private
+      private
 
-    def key_paths
-      KEY_PATHS
-    end
+      def key_paths
+        KEY_PATHS
+      end
 
-    def key_types
-      KEY_TYPES
-    end
+      def key_types
+        KEY_TYPES
+      end
 
-    def key_alias
-      KEY_ALIAS
-    end
+      def key_alias
+        KEY_ALIAS
+      end
 
-    def class_by_name(cname)
-      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::Types.const_get(cname)
       end
-      Viewpoint::EWS::Types.const_get(cname)
-    end
 
-    def type_convert(key,str)
-      begin
+      def type_convert(key, str)
         key = key_alias[key] || key
         if key_types[key]
           key_types[key].is_a?(Symbol) ? method(key_types[key]).call(str) : key_types[key].call(str)
         else
           str
         end
-      rescue
+      rescue StandardError
         nil
       end
-    end
 
-    def resolve_method(method_sym)
-      begin
+      def resolve_method(method_sym)
         resolve_key_path(@ews_item, method_path(method_sym))
-      rescue
+      rescue StandardError
         if shallow?
           if frozen?
             raise EwsFrozenObjectError, "Could not resolve :#{method_sym} on frozen object."
           elsif auto_deepen?
             enlighten!
             retry
-          else
-            if !auto_deepen?
-              if ews.no_auto_deepen_behavior == :raise
-                raise EwsMinimalObjectError, "Could not resolve :#{method_sym}. #auto_deepen set to false"
-              else
-                nil
-              end
-            else
-            end
+          elsif !auto_deepen? && (ews.no_auto_deepen_behavior == :raise)
+            raise EwsMinimalObjectError, "Could not resolve :#{method_sym}. #auto_deepen set to false"
+
           end
-        else
-          nil
         end
       end
-    end
 
-    def resolve_key_path(hsh, path)
-      k = path.first
-      return hsh[k] if path.length == 1
-      resolve_key_path(hsh[k],path[1..-1])
-    end
+      def resolve_key_path(hsh, path)
+        k = path.first
+        return hsh[k] if path.length == 1
 
-    def method_keys
-      key_paths.keys + key_alias.keys
-    end
+        resolve_key_path(hsh[k], path[1..])
+      end
 
-    # Resolve the method path with or without an alias
-    def method_path(sym)
-      key_paths[key_alias[sym] || sym]
-    end
+      def method_keys
+        key_paths.keys + key_alias.keys
+      end
 
-    def build_extended_properties(eprops)
-      h = {}
-      # todo
-      # the return pattern seems broken in some cases,
-      # probably needs fixing via a dedicated response parser
-      eprops.each do |e|
-        if e.size == 1
-          e[:elems].each_cons(2) do |k,v|
-            key = k[:extended_field_u_r_i][:attribs][:property_name].downcase.to_sym
-            val = v[:value][:text]
-            h.store(key,val)
-          end
-        elsif e.size == 2
-          e[1].each_cons(2) do |k,v|
-            key = k[:extended_field_u_r_i][:attribs][:property_name].downcase.to_sym
-            val = v[:value][:text]
-            h.store(key,val)
+      # Resolve the method path with or without an alias
+      def method_path(sym)
+        key_paths[key_alias[sym] || sym]
+      end
+
+      def build_extended_properties(eprops)
+        h = {}
+        # todo
+        # the return pattern seems broken in some cases,
+        # probably needs fixing via a dedicated response parser
+        eprops.each do |e|
+          if e.size == 1
+            e[:elems].each_cons(2) do |k, v|
+              key = k[:extended_field_u_r_i][:attribs][:property_name].downcase.to_sym
+              val = v[:value][:text]
+              h.store(key, val)
+            end
+          elsif e.size == 2
+            e[1].each_cons(2) do |k, v|
+              key = k[:extended_field_u_r_i][:attribs][:property_name].downcase.to_sym
+              val = v[:value][:text]
+              h.store(key, val)
+            end
+          else
+            raise EwsMinimalObjectError, 'Not prepared to deal with elements greater than 2'
           end
-        else
-          raise EwsMinimalObjectError, "Not prepared to deal with elements greater than 2"
         end
+        h
       end
-      h
     end
-
   end
 end

data/lib/viewpoint/logging/config.rb

@@ -1,24 +1,24 @@
-=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.
 
 module Viewpoint
+  # Exchange Web Services (EWS) client namespace.
   module EWS
-    Logging.logger.root.level = :debug
-    Logging.logger.root.appenders = Logging.appenders.stdout
-  end # EWS
+    root_logger.level = Logger::DEBUG
+  end
 end

data/lib/viewpoint/logging.rb

@@ -1,27 +1,33 @@
-=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>
+#   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.
 
-  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
+require 'logger' unless defined?(Logger)
 
 module Viewpoint
+  # Exchange Web Services (EWS) client namespace.
   module EWS
     attr_reader :logger
 
+    @root_logger = Logger.new($stdout)
+    @root_logger.level = Logger::WARN
+
     def self.root_logger
-      Logging.logger.root
+      @root_logger
     end
-  end # EWS
+  end
 end

data/lib/viewpoint/string_utils.rb

@@ -1,36 +1,34 @@
-=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.
 
 module Viewpoint
-
-  class StringFormatException < ::Exception; end
+  class StringFormatException < ::StandardError; end
 
   # Collection of utility methods for working with Strings
   module StringUtils
-
     DURATION_RE = /
       (?<start>P)
-      ((?<weeks>\d+)W)?
-      ((?<days>\d+)D)?
+      (?:(?<weeks>\d+)W)?
+      (?:(?<days>\d+)D)?
       (?<time>T
-        ((?<hours>\d+)H)?
-        ((?<minutes>\d+)M)?
-        ((?<seconds>\d+)S)?
+        (?:(?<hours>\d+)H)?
+        (?:(?<minutes>\d+)M)?
+        (?:(?<seconds>\d+)S)?
       )?
       /x
 
@@ -51,7 +49,7 @@ module Viewpoint
     # Change a ruby_cased string to CamelCased
     def camel_case(input)
       input.to_s.split(/_/).map { |i|
-        i.sub(/^./) { |s| s.upcase }
+        i.sub(/^./, &:upcase)
       }.join
     end
 
@@ -62,15 +60,16 @@ module Viewpoint
     #   nil if there is no known duration
     def iso8601_duration_to_seconds(input)
       return nil if input.nil? || input.empty?
+
       match_data = DURATION_RE.match(input)
-      raise(StringFormatException, "Invalid duration given") if match_data.nil?
+      raise(StringFormatException, 'Invalid duration given') if match_data.nil?
+
       duration = 0
-      duration += match_data[:weeks].to_i   * 604800
-      duration += match_data[:days].to_i    * 86400
+      duration += match_data[:weeks].to_i   * 604_800
+      duration += match_data[:days].to_i    * 86_400
       duration += match_data[:hours].to_i   * 3600
       duration += match_data[:minutes].to_i * 60
-      duration += match_data[:seconds].to_i
+      duration + match_data[:seconds].to_i
     end
-
-  end # StringUtils
-end # Viewpoint
+  end
+end

data/lib/viewpoint.rb

@@ -1,27 +1,27 @@
-=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>
+#   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.
 
-  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
-
-require 'kconv' if(RUBY_VERSION.start_with? '1.9') # bug in rubyntlm with ruby 1.9.x
+require 'kconv' if RUBY_VERSION.start_with? '1.9' # bug in rubyntlm with ruby 1.9.x
 require 'date'
 require 'base64'
 require 'nokogiri'
 require 'ostruct'
-require 'logging'
+require 'logger' unless defined?(Logger)
 
 # String utilities
 require 'viewpoint/string_utils'