webdrivers 3.9.1 → 3.9.2

data/lib/webdrivers.rb

@@ -1,6 +1,6 @@
-# frozen_string_literal: true
-
-require 'webdrivers/chromedriver'
-require 'webdrivers/geckodriver'
-require 'webdrivers/iedriver'
-require 'webdrivers/mswebdriver'
+# frozen_string_literal: true
+
+require 'webdrivers/chromedriver'
+require 'webdrivers/geckodriver'
+require 'webdrivers/iedriver'
+require 'webdrivers/mswebdriver'

data/lib/webdrivers/chromedriver.rb

@@ -1,167 +1,185 @@
-# frozen_string_literal: true
-
-require 'shellwords'
-require 'webdrivers/common'
-
-module Webdrivers
-  class Chromedriver < Common
-    class << self
-      def current_version
-        Webdrivers.logger.debug 'Checking current version'
-        return nil unless exists?
-
-        version = binary_version
-        return nil if version.nil?
-
-        # Matches 2.46, 2.46.628411 and 73.0.3683.75
-        normalize_version version[/\d+\.\d+(\.\d+)?(\.\d+)?/]
-      end
-
-      def latest_version
-        @latest_version ||= begin
-          # Versions before 70 do not have a LATEST_RELEASE file
-          return normalize_version('2.41') if release_version < normalize_version('70')
-
-          latest_applicable = with_cache(file_name) { latest_point_release(release_version) }
-
-          Webdrivers.logger.debug "Latest version available: #{latest_applicable}"
-          normalize_version(latest_applicable)
-        end
-      end
-
-      # Returns currently installed Chrome version
-      def chrome_version
-        ver = send("chrome_on_#{System.platform}").chomp
-
-        raise VersionError, 'Failed to find Chrome binary or its version.' if ver.nil? || ver.empty?
-
-        Webdrivers.logger.debug "Browser version: #{ver}"
-        normalize_version ver[/\d+\.\d+\.\d+\.\d+/] # Google Chrome 73.0.3683.75 -> 73.0.3683.75
-      end
-
-      private
-
-      def latest_point_release(version)
-        release_file = "LATEST_RELEASE_#{version}"
-        begin
-          normalize_version(Network.get(URI.join(base_url, release_file)))
-        rescue StandardError
-          latest_release = normalize_version(Network.get(URI.join(base_url, 'LATEST_RELEASE')))
-          Webdrivers.logger.debug "Unable to find a driver for: #{version}"
-
-          msg = version > latest_release ? 'you appear to be using a non-production version of Chrome; ' : ''
-          msg = "#{msg}please set `Webdrivers::Chromedriver.required_version = <desired driver version>` to an known "\
-'chromedriver version: https://chromedriver.storage.googleapis.com/index.html'
-          raise VersionError, msg
-        end
-      end
-
-      def file_name
-        System.platform == 'win' ? 'chromedriver.exe' : 'chromedriver'
-      end
-
-      def base_url
-        'https://chromedriver.storage.googleapis.com'
-      end
-
-      def download_url
-        return @download_url if @download_url
-
-        version = if required_version == EMPTY_VERSION
-                    latest_version
-                  else
-                    normalize_version(required_version)
-                  end
-
-        file_name = System.platform == 'win' ? 'win32' : "#{System.platform}64"
-        url = "#{base_url}/#{version}/chromedriver_#{file_name}.zip"
-        Webdrivers.logger.debug "chromedriver URL: #{url}"
-        @download_url = url
-      end
-
-      # Returns release version from the currently installed Chrome version
-      #
-      # @example
-      #   73.0.3683.75 -> 73.0.3683
-      def release_version
-        chrome = normalize_version(chrome_version)
-        normalize_version(chrome.segments[0..2].join('.'))
-      end
-
-      def chrome_on_win
-        if browser_binary
-          Webdrivers.logger.debug "Browser executable: '#{browser_binary}'"
-          return System.call("powershell (Get-ItemProperty '#{browser_binary}').VersionInfo.ProductVersion").strip
-        end
-
-        # Workaround for Google Chrome when using Jruby on Windows.
-        # @see https://github.com/titusfortner/webdrivers/issues/41
-        if RUBY_PLATFORM == 'java'
-          ver = 'powershell (Get-Item -Path ((Get-ItemProperty "HKLM:\\Software\\Microsoft' \
-          "\\Windows\\CurrentVersion\\App` Paths\\chrome.exe\").\\'(default)\\'))" \
-          '.VersionInfo.ProductVersion'
-          return System.call(ver).strip
-        end
-
-        # Default to Google Chrome
-        reg = 'HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\chrome.exe'
-        executable = System.call("powershell (Get-ItemProperty '#{reg}' -Name '(default)').'(default)'").strip
-        Webdrivers.logger.debug "Browser executable: '#{executable}'"
-        ps = "(Get-Item (Get-ItemProperty '#{reg}').'(default)').VersionInfo.ProductVersion"
-        System.call("powershell #{ps}").strip
-      end
-
-      def chrome_on_linux
-        if browser_binary
-          Webdrivers.logger.debug "Browser executable: '#{browser_binary}'"
-          return System.call("#{Shellwords.escape browser_binary} --product-version").strip
-        end
-
-        # Default to Google Chrome
-        executable = System.call('which google-chrome').strip
-        Webdrivers.logger.debug "Browser executable: '#{executable}'"
-        System.call("#{executable} --product-version").strip
-      end
-
-      def chrome_on_mac
-        if browser_binary
-          Webdrivers.logger.debug "Browser executable: '#{browser_binary}'"
-          return System.call("#{Shellwords.escape browser_binary} --version").strip
-        end
-
-        # Default to Google Chrome
-        executable = Shellwords.escape '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome'
-        Webdrivers.logger.debug "Browser executable: #{executable}"
-        System.call("#{executable} --version").strip
-      end
-
-      #
-      # Returns user defined browser executable path from Selenium::WebDrivers::Chrome#path.
-      #
-      def browser_binary
-        # For Chromium, Brave, or whatever else
-        Selenium::WebDriver::Chrome.path
-      end
-
-      def sufficient_binary?
-        super && current_version && (current_version < normalize_version('70.0.3538') ||
-            current_version.segments.first == release_version.segments.first)
-      end
-    end
-  end
-end
-
-if ::Selenium::WebDriver::Service.respond_to? :driver_path=
-  ::Selenium::WebDriver::Chrome::Service.driver_path = proc { ::Webdrivers::Chromedriver.update }
-else
-  # v3.141.0 and lower
-  module Selenium
-    module WebDriver
-      module Chrome
-        def self.driver_path
-          @driver_path ||= Webdrivers::Chromedriver.update
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'shellwords'
+require 'webdrivers/common'
+
+module Webdrivers
+  class Chromedriver < Common
+    class << self
+      #
+      # Returns current chromedriver version.
+      #
+      # @return [Gem::Version]
+      def current_version
+        Webdrivers.logger.debug 'Checking current version'
+        return nil unless exists?
+
+        version = binary_version
+        return nil if version.nil?
+
+        # Matches 2.46, 2.46.628411 and 73.0.3683.75
+        normalize_version version[/\d+\.\d+(\.\d+)?(\.\d+)?/]
+      end
+
+      #
+      # Returns latest available chromedriver version.
+      #
+      # @return [Gem::Version]
+      def latest_version
+        @latest_version ||= begin
+          # Versions before 70 do not have a LATEST_RELEASE file
+          return normalize_version('2.41') if release_version < normalize_version('70')
+
+          latest_applicable = with_cache(file_name) { latest_point_release(release_version) }
+
+          Webdrivers.logger.debug "Latest version available: #{latest_applicable}"
+          normalize_version(latest_applicable)
+        end
+      end
+
+      #
+      # Returns currently installed Chrome/Chromium version.
+      #
+      # @return [Gem::Version]
+      def chrome_version
+        ver = send("chrome_on_#{System.platform}").chomp
+
+        raise VersionError, 'Failed to find Chrome binary or its version.' if ver.nil? || ver.empty?
+
+        Webdrivers.logger.debug "Browser version: #{ver}"
+        normalize_version ver[/\d+\.\d+\.\d+\.\d+/] # Google Chrome 73.0.3683.75 -> 73.0.3683.75
+      end
+
+      private
+
+      def latest_point_release(version)
+        normalize_version(Network.get(URI.join(base_url, "LATEST_RELEASE_#{version}")))
+      rescue NetworkError
+        msg = "Unable to find latest point release version for #{version}."
+        msg = begin
+          latest_release = normalize_version(Network.get(URI.join(base_url, 'LATEST_RELEASE')))
+          if version > latest_release
+            "#{msg} You appear to be using a non-production version of Chrome."
+          else
+            msg
+          end
+              rescue NetworkError
+                "#{msg} A network issue is preventing determination of latest chromedriver release."
+        end
+
+        msg = "#{msg} Please set `Webdrivers::Chromedriver.required_version = <desired driver version>` "\
+'to a known chromedriver version: https://chromedriver.storage.googleapis.com/index.html'
+
+        Webdrivers.logger.debug msg
+        raise VersionError, msg
+      end
+
+      def file_name
+        System.platform == 'win' ? 'chromedriver.exe' : 'chromedriver'
+      end
+
+      def base_url
+        'https://chromedriver.storage.googleapis.com'
+      end
+
+      def download_url
+        return @download_url if @download_url
+
+        version = if required_version == EMPTY_VERSION
+                    latest_version
+                  else
+                    normalize_version(required_version)
+                  end
+
+        file_name = System.platform == 'win' ? 'win32' : "#{System.platform}64"
+        url = "#{base_url}/#{version}/chromedriver_#{file_name}.zip"
+        Webdrivers.logger.debug "chromedriver URL: #{url}"
+        @download_url = url
+      end
+
+      # Returns release version from the currently installed Chrome version
+      #
+      # @example
+      #   73.0.3683.75 -> 73.0.3683
+      def release_version
+        chrome = normalize_version(chrome_version)
+        normalize_version(chrome.segments[0..2].join('.'))
+      end
+
+      def chrome_on_win
+        if browser_binary
+          Webdrivers.logger.debug "Browser executable: '#{browser_binary}'"
+          return System.call("powershell (Get-ItemProperty '#{browser_binary}').VersionInfo.ProductVersion").strip
+        end
+
+        # Workaround for Google Chrome when using Jruby on Windows.
+        # @see https://github.com/titusfortner/webdrivers/issues/41
+        if RUBY_PLATFORM == 'java'
+          ver = 'powershell (Get-Item -Path ((Get-ItemProperty "HKLM:\\Software\\Microsoft' \
+          "\\Windows\\CurrentVersion\\App` Paths\\chrome.exe\").\\'(default)\\'))" \
+          '.VersionInfo.ProductVersion'
+          return System.call(ver).strip
+        end
+
+        # Default to Google Chrome
+        reg = 'HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\chrome.exe'
+        executable = System.call("powershell (Get-ItemProperty '#{reg}' -Name '(default)').'(default)'").strip
+        Webdrivers.logger.debug "Browser executable: '#{executable}'"
+        ps = "(Get-Item (Get-ItemProperty '#{reg}').'(default)').VersionInfo.ProductVersion"
+        System.call("powershell #{ps}").strip
+      end
+
+      def chrome_on_linux
+        if browser_binary
+          Webdrivers.logger.debug "Browser executable: '#{browser_binary}'"
+          return System.call("#{Shellwords.escape browser_binary} --product-version").strip
+        end
+
+        # Default to Google Chrome
+        executable = System.call('which google-chrome').strip
+        Webdrivers.logger.debug "Browser executable: '#{executable}'"
+        System.call("#{executable} --product-version").strip
+      end
+
+      def chrome_on_mac
+        if browser_binary
+          Webdrivers.logger.debug "Browser executable: '#{browser_binary}'"
+          return System.call("#{Shellwords.escape browser_binary} --version").strip
+        end
+
+        # Default to Google Chrome
+        executable = Shellwords.escape '/Applications/Google Chrome.app/Contents/MacOS/Google Chrome'
+        Webdrivers.logger.debug "Browser executable: #{executable}"
+        System.call("#{executable} --version").strip
+      end
+
+      #
+      # Returns user defined browser executable path from Selenium::WebDrivers::Chrome#path.
+      #
+      def browser_binary
+        # For Chromium, Brave, or whatever else
+        Selenium::WebDriver::Chrome.path
+      end
+
+      def sufficient_binary?
+        super && current_version && (current_version < normalize_version('70.0.3538') ||
+            current_version.segments.first == release_version.segments.first)
+      end
+    end
+  end
+end
+
+if ::Selenium::WebDriver::Service.respond_to? :driver_path=
+  ::Selenium::WebDriver::Chrome::Service.driver_path = proc { ::Webdrivers::Chromedriver.update }
+else
+  # v3.141.0 and lower
+  module Selenium
+    module WebDriver
+      module Chrome
+        def self.driver_path
+          @driver_path ||= Webdrivers::Chromedriver.update
+        end
+      end
+    end
+  end
+end

data/lib/webdrivers/common.rb

@@ -1,157 +1,191 @@
-# frozen_string_literal: true
-
-require 'rubygems/package'
-require 'zip'
-require 'webdrivers/logger'
-require 'webdrivers/network'
-require 'webdrivers/system'
-require 'selenium-webdriver'
-
-module Webdrivers
-  class ConnectionError < StandardError
-  end
-
-  class VersionError < StandardError
-  end
-
-  class << self
-    attr_accessor :proxy_addr, :proxy_port, :proxy_user, :proxy_pass, :install_dir
-
-    attr_writer :cache_time
-
-    def cache_time
-      @cache_time || 0
-    end
-
-    def logger
-      @logger ||= Webdrivers::Logger.new
-    end
-
-    def configure
-      yield self
-    end
-
-    def net_http_ssl_fix
-      raise 'Webdrivers.net_http_ssl_fix is no longer available.' \
-      ' Please see https://github.com/titusfortner/webdrivers#ssl_connect-errors.'
-    end
-end
-
-  class Common
-    class << self
-      attr_writer :required_version
-      attr_reader :cache_warning
-
-      def version
-        Webdrivers.logger.deprecate("#{self.class}#version", "#{self.class}#required_version")
-        required_version
-      end
-
-      def version=(version)
-        Webdrivers.logger.deprecate("#{self.class}#version=", "#{self.class}#required_version=")
-        self.required_version = version
-      end
-
-      def required_version
-        normalize_version @required_version
-      end
-
-      def update
-        if correct_binary?
-          Webdrivers.logger.debug 'The required webdriver version is already on the system'
-          return driver_path
-        end
-
-        remove
-        System.download(download_url, driver_path)
-      end
-
-      def desired_version
-        old = "#{self.class}#desired_version"
-        new = "#{self.class}#required_version or #{self.class}#latest_version"
-        Webdrivers.logger.deprecate(old, new)
-
-        desired_version == EMPTY_VERSION ? latest_version : normalize_version(desired_version)
-      end
-
-      def remove
-        @download_url = nil
-        @latest_version = nil
-        System.delete "#{System.install_dir}/#{file_name.gsub('.exe', '')}.version"
-        System.delete driver_path
-      end
-
-      def download
-        Webdrivers.logger.deprecate('#download', '#update')
-        System.download(download_url, driver_path)
-      end
-
-      def binary
-        Webdrivers.logger.deprecate('#binary', '#driver_path')
-        driver_path
-      end
-
-      def driver_path
-        File.join System.install_dir, file_name
-      end
-
-      private
-
-      def download_url
-        @download_url ||= if required_version == EMPTY_VERSION
-                            downloads[downloads.keys.max]
-                          else
-                            downloads[normalize_version(required_version)]
-                          end
-      end
-
-      def exists?
-        System.exists? driver_path
-      end
-
-      def correct_binary?
-        current_version == if required_version == EMPTY_VERSION
-                             latest_version
-                           else
-                             normalize_version(required_version)
-                           end
-      rescue ConnectionError
-        driver_path if sufficient_binary?
-      end
-
-      def sufficient_binary?
-        exists?
-      end
-
-      def normalize_version(version)
-        Gem::Version.new(version.to_s)
-      end
-
-      def binary_version
-        version = System.call("#{driver_path} --version")
-        Webdrivers.logger.debug "Current version of #{driver_path} is #{version}"
-        version
-      rescue Errno::ENOENT
-        Webdrivers.logger.debug "No Such File or Directory: #{driver_path}"
-        nil
-      end
-
-      def with_cache(file_name)
-        if System.valid_cache?(file_name)
-          normalize_version System.cached_version(file_name)
-        else
-          unless cache_warning
-            Webdrivers.logger.warn 'Driver caching is turned off in this version, but will be '\
-                                  'enabled by default in 4.x. Set the value with `Webdrivers#cache_time=` in seconds'
-            @cache_warning = true
-          end
-          version = yield
-          System.cache_version(file_name, version)
-          normalize_version version
-        end
-      end
-
-      EMPTY_VERSION = Gem::Version.new('')
-    end
-  end
-end
+# frozen_string_literal: true
+
+require 'rubygems/package'
+require 'zip'
+require 'webdrivers/logger'
+require 'webdrivers/network'
+require 'webdrivers/system'
+require 'selenium-webdriver'
+
+module Webdrivers
+  class ConnectionError < StandardError
+  end
+
+  class VersionError < StandardError
+  end
+
+  class NetworkError < StandardError
+  end
+
+  class << self
+    attr_accessor :proxy_addr, :proxy_port, :proxy_user, :proxy_pass, :install_dir
+
+    attr_writer :cache_time
+
+    #
+    # Returns the amount of time (Seconds) the gem waits between two update checks.
+    #
+    def cache_time
+      @cache_time || 0
+    end
+
+    def logger
+      @logger ||= Webdrivers::Logger.new
+    end
+
+    #
+    # Provides a convenient way to configure the gem.
+    #
+    # @example Configure proxy and cache_time
+    #   Webdrivers.configure do |config|
+    #     config.proxy_addr = 'myproxy_address.com'
+    #     config.proxy_port = '8080'
+    #     config.proxy_user = 'username'
+    #     config.proxy_pass = 'password'
+    #     config.cache_time = 604_800 # 7 days
+    #   end
+    #
+    def configure
+      yield self
+    end
+
+    def net_http_ssl_fix
+      raise 'Webdrivers.net_http_ssl_fix is no longer available.' \
+      ' Please see https://github.com/titusfortner/webdrivers#ssl_connect-errors.'
+    end
+end
+
+  class Common
+    class << self
+      attr_writer :required_version
+      attr_reader :cache_warning
+
+      def version
+        Webdrivers.logger.deprecate("#{self.class}#version", "#{self.class}#required_version")
+        required_version
+      end
+
+      def version=(version)
+        Webdrivers.logger.deprecate("#{self.class}#version=", "#{self.class}#required_version=")
+        self.required_version = version
+      end
+
+      #
+      # Returns the user defined required version.
+      #
+      # @return [Gem::Version]
+      def required_version
+        normalize_version @required_version
+      end
+
+      #
+      # Triggers an update check.
+      #
+      # @return [String] Path to the driver binary.
+      def update
+        if correct_binary?
+          msg = required_version != EMPTY_VERSION ?  'The required webdriver version' : 'A working webdriver version'
+          Webdrivers.logger.debug "#{msg} is already on the system"
+          return driver_path
+        end
+
+        remove
+        System.download(download_url, driver_path)
+      end
+
+      def desired_version
+        old = "#{self.class}#desired_version"
+        new = "#{self.class}#required_version or #{self.class}#latest_version"
+        Webdrivers.logger.deprecate(old, new)
+
+        desired_version == EMPTY_VERSION ? latest_version : normalize_version(desired_version)
+      end
+
+      #
+      # Deletes the existing driver binary.
+      #
+      def remove
+        @download_url = nil
+        @latest_version = nil
+        System.delete "#{System.install_dir}/#{file_name.gsub('.exe', '')}.version"
+        System.delete driver_path
+      end
+
+      def download
+        Webdrivers.logger.deprecate('#download', '#update')
+        System.download(download_url, driver_path)
+      end
+
+      def binary
+        Webdrivers.logger.deprecate('#binary', '#driver_path')
+        driver_path
+      end
+
+      #
+      # Returns path to the driver binary.
+      #
+      # @return [String]
+      def driver_path
+        File.join System.install_dir, file_name
+      end
+
+      private
+
+      def download_url
+        @download_url ||= if required_version == EMPTY_VERSION
+                            downloads[downloads.keys.max]
+                          else
+                            downloads[normalize_version(required_version)]
+                          end
+      end
+
+      def exists?
+        System.exists? driver_path
+      end
+
+      def correct_binary?
+        current_version == if required_version == EMPTY_VERSION
+                             latest_version
+                           else
+                             normalize_version(required_version)
+                           end
+      rescue ConnectionError, VersionError
+        driver_path if sufficient_binary?
+      end
+
+      def sufficient_binary?
+        exists?
+      end
+
+      def normalize_version(version)
+        Gem::Version.new(version.to_s)
+      end
+
+      def binary_version
+        version = System.call("#{driver_path} --version")
+        Webdrivers.logger.debug "Current version of #{driver_path} is #{version}"
+        version
+      rescue Errno::ENOENT
+        Webdrivers.logger.debug "No Such File or Directory: #{driver_path}"
+        nil
+      end
+
+      def with_cache(file_name)
+        if System.valid_cache?(file_name)
+          normalize_version System.cached_version(file_name)
+        else
+          unless cache_warning
+            Webdrivers.logger.warn 'Driver caching is turned off in this version, but will be '\
+                                  'enabled by default in 4.x. Set the value with `Webdrivers#cache_time=` in seconds'
+            @cache_warning = true
+          end
+          version = yield
+          System.cache_version(file_name, version)
+          normalize_version version
+        end
+      end
+
+      EMPTY_VERSION = Gem::Version.new('')
+    end
+  end
+end