viewpoint 1.1.1 → 2.0.0

data/lib/ews/errors.rb

@@ -1,56 +1,62 @@
-=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::Errors
-  class ResponseError < RuntimeError
-    attr_reader :response
-
-    def initialize(message, response)
-      super(message)
-      @response = response
-    end
-
-    def status
-      response.status
-    end
-
-    def body
-      response.body
-    end
-  end
-
-  class UnhandledResponseError < ResponseError
-  end
-
-  class ServerError < ResponseError
-  end
-
-  class UnauthorizedResponseError < ResponseError
-  end
-
-  class SoapResponseError < ResponseError
-    attr_reader :faultcode,
-                :faultstring
-
-    def initialize(message, response, faultcode, faultstring)
-      super(message, response)
-      @faultcode = faultcode
-      @faultstring = faultstring
+# 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 Errors
+      # Raised for EWS error responses.
+      class ResponseError < RuntimeError
+        attr_reader :response
+
+        def initialize(message, response)
+          super(message)
+          @response = response
+        end
+
+        def status
+          response.status
+        end
+
+        def body
+          response.body
+        end
+      end
+
+      class UnhandledResponseError < ResponseError
+      end
+
+      class ServerError < ResponseError
+      end
+
+      class UnauthorizedResponseError < ResponseError
+      end
+
+      # Raised for SOAP-level error responses.
+      class SoapResponseError < ResponseError
+        attr_reader :faultcode,
+                    :faultstring
+
+        def initialize(message, response, faultcode, faultstring)
+          super(message, response)
+          @faultcode = faultcode
+          @faultstring = faultstring
+        end
+      end
     end
   end
 end

data/lib/ews/ews_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ews/folder_accessors'
 require 'ews/item_accessors'
 require 'ews/message_accessors'
@@ -10,96 +12,107 @@ require 'ews/convert_accessors'
 require 'ews/meeting_accessors'
 
 # This class is the glue between the Models and the Web Service.
-class Viewpoint::EWSClient
-  include Viewpoint::EWS
-  include Viewpoint::EWS::FolderAccessors
-  include Viewpoint::EWS::ItemAccessors
-  include Viewpoint::EWS::MessageAccessors
-  include Viewpoint::EWS::MailboxAccessors
-  include Viewpoint::EWS::PushSubscriptionAccessors
-  include Viewpoint::EWS::CalendarAccessors
-  include Viewpoint::EWS::RoomAccessors
-  include Viewpoint::EWS::RoomlistAccessors
-  include Viewpoint::EWS::ConvertAccessors
-  include Viewpoint::EWS::MeetingAccessors
-  include Viewpoint::StringUtils
+module Viewpoint
+  # Main entry point for the Exchange Web Services client.
+  class EWSClient
+    include Viewpoint::EWS
+    include Viewpoint::EWS::FolderAccessors
+    include Viewpoint::EWS::ItemAccessors
+    include Viewpoint::EWS::MessageAccessors
+    include Viewpoint::EWS::MailboxAccessors
+    include Viewpoint::EWS::PushSubscriptionAccessors
+    include Viewpoint::EWS::CalendarAccessors
+    include Viewpoint::EWS::RoomAccessors
+    include Viewpoint::EWS::RoomlistAccessors
+    include Viewpoint::EWS::ConvertAccessors
+    include Viewpoint::EWS::MeetingAccessors
+    include Viewpoint::StringUtils
 
-  # The instance of Viewpoint::EWS::SOAP::ExchangeWebService
-  attr_reader :ews, :endpoint, :username
+    # The instance of Viewpoint::EWS::SOAP::ExchangeWebService
+    attr_reader :ews, :endpoint, :username
 
-  # Initialize the EWSClient instance.
-  # @param [String] endpoint The EWS endpoint we will be connecting to
-  # @param [String] user The user to authenticate as. If you are using
-  #   NTLM or Negotiate authentication you do not need to pass this parameter.
-  # @param [String] pass The user password. If you are using NTLM or
-  #   Negotiate authentication you do not need to pass this parameter.
-  # @param [Hash] opts Various options to pass to the backends
-  # @option opts [String] :server_version The Exchange server version to
-  #   target. See the VERSION_* constants in
-  #   Viewpoint::EWS::SOAP::ExchangeWebService.
-  # @option opts [Object] :http_class specify an alternate HTTP connection class.
-  # @option opts [Hash] :http_opts options to pass to the connection
-  def initialize(endpoint, username, password, opts = {})
-    # dup all. @see ticket https://github.com/zenchild/Viewpoint/issues/68
-    @endpoint = endpoint.dup
-    @username = username.dup
-    password  = password.dup
-    opts      = opts.dup
-    http_klass = opts[:http_class] || Viewpoint::EWS::Connection
-    con = http_klass.new(endpoint, opts[:http_opts] || {})
-    con.set_auth @username, password
-    @ews = SOAP::ExchangeWebService.new(con, opts)
-  end
+    # Initialize the EWSClient instance.
+    # @param [Hash] auth authentication details
+    # @option auth [String] :endpoint The EWS endpoint we will be connecting to
+    # @option auth [String] :type the authentication type: 'basic' or 'oauth'
+    # @option auth [String] :user The user to authenticate as (basic auth). If
+    #   you are using NTLM or Negotiate authentication you do not need to pass
+    #   this parameter.
+    # @option auth [String] :password The user password (basic auth). If you are
+    #   using NTLM or Negotiate authentication you do not need to pass this
+    #   parameter.
+    # @option auth [String] :token The OAuth bearer token (oauth auth)
+    # @param [Hash] opts Various options to pass to the backends
+    # @option opts [String] :server_version The Exchange server version to
+    #   target. See the VERSION_* constants in
+    #   Viewpoint::EWS::SOAP::ExchangeWebService.
+    # @option opts [Object] :http_class specify an alternate HTTP connection class.
+    # @option opts [Hash] :http_opts options to pass to the connection
+    def initialize(auth, opts = {})
+      # dup all. @see ticket https://github.com/zenchild/Viewpoint/issues/68
+      auth = auth.dup
+      opts = opts.dup
+
+      @auth_type  = auth[:type]
+      @auth_token = auth[:token]
+
+      @endpoint = auth[:endpoint]
+      @username = auth[:user]
+      password  = @auth_type == 'basic' ? auth[:password] : nil
 
-  # @param deepen [Boolean] true to autodeepen, false otherwise
-  # @param behavior [Symbol] :raise, :nil When setting autodeepen to false you
-  #   can choose what the behavior is when an attribute does not exist. The
-  #   default is to raise a EwsMinimalObjectError.
-  def set_auto_deepen(deepen, behavior = :raise)
-    if deepen
-      ews.auto_deepen = true
-    else
-      behavior = [:raise, :nil].include?(behavior) ? behavior : :raise
-      ews.no_auto_deepen_behavior = behavior
-      ews.auto_deepen = false
+      http_klass = opts[:http_class] || Viewpoint::EWS::Connection
+      connection = http_klass.new(auth, opts[:http_opts] || {})
+      connection.set_auth(@username, password) unless password.nil?
+
+      @ews = SOAP::ExchangeWebService.new(connection, opts)
     end
-  end
 
-  def auto_deepen=(deepen)
-    set_auto_deepen deepen
-  end
+    # @param deepen [Boolean] true to autodeepen, false otherwise
+    # @param behavior [Symbol] :raise, :nil When setting autodeepen to false you
+    #   can choose what the behavior is when an attribute does not exist. The
+    #   default is to raise a EwsMinimalObjectError.
+    def set_auto_deepen(deepen, behavior = :raise)
+      if deepen
+        ews.auto_deepen = true
+      else
+        behavior = %i[raise nil].include?(behavior) ? behavior : :raise
+        ews.no_auto_deepen_behavior = behavior
+        ews.auto_deepen = false
+      end
+    end
 
-  # Specify a default time zone context for all time attributes
-  # @param id [String] Identifier of a Microsoft well known time zone (e.g: 'UTC', 'W. Europe Standard Time')
-  # @note A list of time zones known by the server can be requested via {EWS::SOAP::ExchangeTimeZones#get_time_zones}
-  def set_time_zone(microsoft_time_zone_id)
-    ews.set_time_zone_context microsoft_time_zone_id
-  end
+    def auto_deepen=(deepen)
+      set_auto_deepen deepen
+    end
 
-  private
+    # Specify a default time zone context for all time attributes
+    # @param id [String] Identifier of a Microsoft well known time zone (e.g: 'UTC', 'W. Europe Standard Time')
+    # @note A list of time zones known by the server can be requested via {EWS::SOAP::ExchangeTimeZones#get_time_zones}
+    def set_time_zone(microsoft_time_zone_id) # rubocop:disable Naming/AccessorMethodName -- public API name
+      ews.set_time_zone_context microsoft_time_zone_id
+    end
 
+    private
 
-  # This method also exists in EWS::Types, but there is a lot of other stuff
-  # in there that I didn't want to include directly in this class.
-  def class_by_name(cname)
-    if(cname.instance_of? Symbol)
-      cname = camel_case(cname)
+    # This method also exists in EWS::Types, but there is a lot of other stuff
+    # in there that I didn't want to include directly in this class.
+    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
 
-  # Used for multiple accessors
-  def merge_restrictions!(obj, merge_type = :and)
-    if obj.opts[:restriction] && !obj.opts[:restriction].empty? && !obj.restriction.empty?
-      obj.opts[:restriction] = {
-        merge_type => [
-          obj.opts.delete(:restriction),
-          obj.restriction
-        ]
-      }
-    elsif !obj.restriction.empty?
-      obj.opts[:restriction] = obj.restriction
+    # Used for multiple accessors
+    def merge_restrictions!(obj, merge_type = :and)
+      if obj.opts[:restriction] && !obj.opts[:restriction].empty? && !obj.restriction.empty?
+        obj.opts[:restriction] = {
+          merge_type => [
+            obj.opts.delete(:restriction),
+            obj.restriction
+          ]
+        }
+      elsif !obj.restriction.empty?
+        obj.opts[:restriction] = obj.restriction
+      end
     end
   end
-
 end

data/lib/ews/exceptions/exceptions.rb

@@ -1,61 +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
-
-  # Generic Ews Error
-  class EwsError < StandardError; end
-
-  # Raise when authentication/authorization issues occur.
-  class EwsLoginError < EwsError; end
-
-  class EwsSubscriptionError < EwsError; end
-
-  # Raised when a user tries to query a folder subscription after the
-  # subscription has timed out.
-  class EwsSubscriptionTimeout < EwsSubscriptionError; end
-
-  # Represents a function in EWS that is not yet implemented in Viewpoint
-  class EwsNotImplemented < EwsError; end
-
-  # Raised when an method is called in the wrong way
-  class EwsBadArgumentError < EwsError; end
-
-  # Raised when an item that is asked for is not found
-  class EwsItemNotFound < EwsError; end
-
-  # Raised when a folder that is asked for is not found
-  class EwsFolderNotFound < EwsError; end
-
-  # Raise an Exchange Server version error. This is in case some functionality
-  # does not exist in a particular Server version but is called.
-  class EwsServerVersionError < EwsError; end
-
-  # Raised when #auto_deepen == false and a method is called for attributes
-  # that have not yet been fetched.
-  class EwsMinimalObjectError < EwsError; end
-
-  class EwsFrozenObjectError < EwsError; end
-
-  # Failed to save an object back to the EWS store.
-  class SaveFailed < EwsError; end
-
-  class EwsCreateItemError < EwsError; end
-
-  class EwsSendItemError < EwsError; end
-
-end # Viewpoint::EWS
+# 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
+    # Generic Ews Error
+    class EwsError < StandardError; end
+
+    # Raise when authentication/authorization issues occur.
+    class EwsLoginError < EwsError; end
+
+    class EwsSubscriptionError < EwsError; end
+
+    # Raised when a user tries to query a folder subscription after the
+    # subscription has timed out.
+    class EwsSubscriptionTimeout < EwsSubscriptionError; end
+
+    # Represents a function in EWS that is not yet implemented in Viewpoint
+    class EwsNotImplemented < EwsError; end
+
+    # Raised when an method is called in the wrong way
+    class EwsBadArgumentError < EwsError; end
+
+    # Raised when an item that is asked for is not found
+    class EwsItemNotFound < EwsError; end
+
+    # Raised when a folder that is asked for is not found
+    class EwsFolderNotFound < EwsError; end
+
+    # Raise an Exchange Server version error. This is in case some functionality
+    # does not exist in a particular Server version but is called.
+    class EwsServerVersionError < EwsError; end
+
+    # Raised when #auto_deepen == false and a method is called for attributes
+    # that have not yet been fetched.
+    class EwsMinimalObjectError < EwsError; end
+
+    class EwsFrozenObjectError < EwsError; end
+
+    # Failed to save an object back to the EWS store.
+    class SaveFailed < EwsError; end
+
+    class EwsCreateItemError < EwsError; end
+
+    class EwsSendItemError < EwsError; end
+  end
+end