webdrivers 3.8.1 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6896e06805c951acefc4a41cf1f647eb677bfb1a
-  data.tar.gz: 9dbc3a6e88ed3ac7e2d3c4ca885976ed236f589b
+  metadata.gz: bee44be9b5854e4de983328db68fd8735a0a7587
+  data.tar.gz: 8dede2a2bd5446c2cd58df1485fd5db8dffeedea
 SHA512:
-  metadata.gz: 95c2d9ff6ded3b07aeb40018bf4d27046d5c0a691153fee376a59fffefb46172e616bf2d712f8fe4aab08c32e3ea72b31c5b874dd11d8c54a300fd025a2bbfea
-  data.tar.gz: e7476ae99421fb154d8884f6815e40274d05a1a824015a4a229910167ae430f04eeed79e3f5c7c07051ff4e66e045de0e982fd519746b3d841735038f153bf43
+  metadata.gz: bbbc24fb35b58c3b161f7b09d5a662f73f004f88e28bc6222ea80fa8ffb6df3cda648376462491e9e39835420ea4e057d958028701aa2529dd2bae2cd2c587ca
+  data.tar.gz: 8f1bd1cbcbddb25e27ffc73e35c6da979fe1fa7805254782a00d70c35da3daa0a41ef42e266f8322d129634ae64aee8987e54b0dfdcee995c30514121f876e4f

data/.rubocop.yml

@@ -1,30 +1,39 @@
-require: rubocop-rspec
+AllCops:
+  TargetRubyVersion: 2.4.6
+
+require:
+  - rubocop-rspec
+  - rubocop-performance
+
+Layout/SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
 
 Layout/EndOfLine:
   EnforcedStyle: lf
 
 Metrics/LineLength:
   Max: 120
+  IgnoredPatterns:
+    - '\s+# rubocop:disable'
 
 Metrics/MethodLength:
-  Enabled: false
+  Max: 20
 
 Metrics/BlockLength:
   Exclude:
     - 'spec/**/*'
 
 Metrics/ClassLength:
-  Max: 110
-  Exclude:
-    - 'lib/webdrivers/common.rb'
-
-Metrics/AbcSize:
-  Exclude:
-    - 'lib/webdrivers/common.rb'
+  Max: 116
 
 Metrics/CyclomaticComplexity:
   Max: 8
 
+Metrics/AbcSize:
+  Max: 16
+  Exclude:
+    - 'lib/webdrivers/chromedriver.rb'
+
 Style/Documentation:
   Enabled: false
 

data/.travis.yml

@@ -20,5 +20,5 @@ matrix:
       env: RAKE_TASK=spec
     - rvm: 2.4.6
       env: RAKE_TASK=rubocop
-    - rvm: jruby-9.2.0.0
+    - rvm: jruby-9.2.7.0
       env: RAKE_TASK=spec

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+### 3.9.0 (2019-05-07)
+* Make public methods more obvious and deprecate unnecessary methods (issue #36)
+* Allow geckodriver binaries to be downloaded directly (issue #30)
+* Allow drivers to be cached to reduce unnecessary network calls (issue #29)
+* MSWebdriver class is removed as no longer supported 
+* Refactored to minimize network calls (issue #80)
+* Fix warnings about instance variables not initialized
+* Add support for managing specific drivers (issue #95)
+
 ### 3.8.1 (2019-05-04)
 * Downloads chromedriver with direct URL instead of parsing the downloads page
 * Raises exception if version of Chrome does not have a known version of the driver (issue #79)

data/LICENSE.txt

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2017: Titus Fortner
+Copyright (c) 2017-2019: Titus Fortner
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -2,7 +2,7 @@
 
 [![Gem Version](https://badge.fury.io/rb/webdrivers.svg)](https://badge.fury.io/rb/webdrivers)
 [![Build status](https://travis-ci.org/titusfortner/webdrivers.svg?branch=master)](https://travis-ci.org/titusfortner/webdrivers)
-[![AppVeyor status](https://ci.appveyor.com/api/projects/status/github/titusfortner/webdrivers?svg=true)](https://ci.appveyor.com/project/titusfortner/webdrivers)
+[![AppVeyor status](https://ci.appveyor.com/api/projects/status/ejh90xqbvkphq4cy/branch/master?svg=true)](https://ci.appveyor.com/project/titusfortner/webdrivers/branch/master)
 
 Run Selenium tests more easily with automatic installation and updates for all supported webdrivers.
 
@@ -13,7 +13,6 @@ Run Selenium tests more easily with automatic installation and updates for all s
 * [chromedriver](http://chromedriver.chromium.org/)
 * [geckodriver](https://github.com/mozilla/geckodriver)
 * [IEDriverServer](https://github.com/SeleniumHQ/selenium/wiki/InternetExplorerDriver)
-* [MicrosoftWebDriver](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/)
 
 ## Usage
 
@@ -30,6 +29,12 @@ require 'webdrivers'
 The drivers will now be automatically downloaded or updated when you launch a browser
 through Selenium. 
 
+If you want webdrivers to only manage specific drivers you can specify as follows:
+```ruby
+require 'webdrivers/chromedriver'
+require 'webdrivers/iedriver'
+```
+
 ### Download Location
 
 The default download location is `~/.webdrivers` directory, and this is configurable:
@@ -40,24 +45,24 @@ The default download location is `~/.webdrivers` directory, and this is configur
 
 ### Version Pinning
 
-If you would like to use a specific (older or beta) version, you can specify it for each driver. Otherwise, the latest (stable) 
-driver will be downloaded and passed to Selenium.
+If you would like to use a specific (older or beta) version, you can specify it for each driver. Otherwise, 
+the latest (stable) driver will be downloaded and passed to Selenium.
 
 ```ruby
 # Chrome
-Webdrivers::Chromedriver.version = '2.46'
+Webdrivers::Chromedriver.required_version = '2.46'
 
 # Firefox
-Webdrivers::Geckodriver.version  = '0.23.0'
+Webdrivers::Geckodriver.required_version  = '0.23.0'
 
 # Microsoft Internet Explorer
-Webdrivers::IEdriver.version     = '3.14.0'
+Webdrivers::IEdriver.required_version     = '3.14.0'
 
 # Microsoft Edge
-Webdrivers::MSWebdriver.version  = '17134'
+Webdrivers::MSWebdriver.required_version  = '17134'
 ```
 
-You can also trigger the update in your code, but it is not required:
+You can explicitly trigger the update in your code, but this will happen automatically when the driver is initialized:
 
 ```ruby
 Webdrivers::Chromedriver.update
@@ -107,33 +112,32 @@ Webdrivers.logger.level = :DEBUG
 
 ### Browser Specific Notes
 
-#### When using Chrome/Chromium
+#### Chrome/Chromium
 
 The version of `chromedriver` will depend on the version of Chrome you are using it with:
 
- * For versions >= 70, the downloaded version of `chromedriver` will match the installed version of Google Chrome. More information [here](http://chromedriver.chromium.org/downloads/version-selection).
+ * For versions >= 70, the downloaded version of `chromedriver` will match the installed version of Google Chrome. 
+ More information [here](http://chromedriver.chromium.org/downloads/version-selection).
  * For versions <=  69, `chromedriver` version 2.46 will be downloaded.
- * For beta versions, you'll have to set the desired beta version of `chromedriver` using `Webdrivers::Chromedriver.version`.
+ * For beta versions, you'll have to set the desired beta version of `chromedriver` 
+ using `Webdrivers::Chromedriver.required_version`.
  
-The gem, by default, looks for the Google Chrome version. You can override this by providing a path to the Chromium binary:
+The gem, by default, looks for the Google Chrome version. You can override this by providing a path to the 
+Chromium binary:
 
 ```ruby
 Selenium::WebDriver::Chrome.path = '/chromium/install/path/to/binary'
 ```
 
-This is also required if Google Chrome is not installed in its [default location](https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver).
-
-#### When using Microsoft Edge
+This is also required if Google Chrome is not installed in its 
+[default location](https://github.com/SeleniumHQ/selenium/wiki/ChromeDriver).
 
-After updating Microsoft Edge on Windows 10, you will need to delete the existing binary (`%USERPROFILE%/.webdrivers/MicrosoftWebDriver.exe`) to
-to be able to download the latest version through this gem.
+#### Microsoft Edge
 
-This is because `MicrosoftWebDriver.exe` is not backwards compatible and it does not have an argument to retrieve 
-the current version. We work around this limitation by querying the current Edge version from the registry and 
-fetching the corresponding binary IF a file does not already exist. If a file does exist, the gem assumes it is the 
-expected version and skips the download process.
+Microsoft Edge support has been removed for now, as it is currently unreliable.
 
-If you continue with the outdated binary, Selenium will throw an error: `unable to connect to MicrosoftWebDriver localhost:17556`.
+To use Microsoft Edge, please visit the 
+[Downloads and Installation page](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/#downloads)
 
 ## Wiki
 
@@ -150,5 +154,5 @@ Bug reports and pull requests are welcome [on GitHub](https://github.com/titusfo
 
 ## Copyright
 
-Copyright (c) 2017 Titus Fortner
+Copyright (c) 2017-2019 Titus Fortner
 See LICENSE for details

data/Rakefile

@@ -7,3 +7,5 @@ require 'rubocop/rake_task'
 RuboCop::RakeTask.new
 
 RSpec::Core::RakeTask.new(:spec)
+
+task default: %i[rubocop spec]

data/lib/webdrivers.rb

@@ -1,28 +1,6 @@
 # frozen_string_literal: true
 
-require 'webdrivers/selenium'
-require 'webdrivers/logger'
-require 'webdrivers/common'
 require 'webdrivers/chromedriver'
 require 'webdrivers/geckodriver'
 require 'webdrivers/iedriver'
 require 'webdrivers/mswebdriver'
-
-module Webdrivers
-  class << self
-    attr_accessor :proxy_addr, :proxy_port, :proxy_user, :proxy_pass, :install_dir
-
-    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
-end

data/lib/webdrivers/chromedriver.rb

@@ -1,34 +1,42 @@
 # frozen_string_literal: true
 
-require 'nokogiri'
 require 'shellwords'
+require 'webdrivers/common'
 
 module Webdrivers
   class Chromedriver < Common
     class << self
       def current_version
         Webdrivers.logger.debug 'Checking current version'
-        return nil unless downloaded?
+        return nil unless exists?
 
-        ver = `#{binary} --version`
-        Webdrivers.logger.debug "Current #{binary} version: #{ver}"
+        version = binary_version
+        return nil if version.nil?
 
         # Matches 2.46, 2.46.628411 and 73.0.3683.75
-        normalize_version ver[/\d+\.\d+(\.\d+)?(\.\d+)?/]
+        normalize_version version[/\d+\.\d+(\.\d+)?(\.\d+)?/]
       end
 
       def latest_version
-        return @latest_version if @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')
 
-        raise StandardError, 'Can not reach site' unless site_available?
+          latest_applicable = with_cache(file_name) { latest_point_release(release_version) }
 
-        # Versions before 70 do not have a LATEST_RELEASE file
-        return normalize_version('2.46') if release_version < normalize_version('70.0.3538')
+          Webdrivers.logger.debug "Latest version available: #{latest_applicable}"
+          normalize_version(latest_applicable)
+        end
+      end
 
-        latest_applicable = latest_point_release(release_version)
+      # Returns currently installed Chrome version
+      def chrome_version
+        ver = send("chrome_on_#{System.platform}").chomp
 
-        Webdrivers.logger.debug "Latest version available: #{latest_applicable}"
-        @latest_version = normalize_version(latest_applicable)
+        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
@@ -36,30 +44,20 @@ module Webdrivers
       def latest_point_release(version)
         release_file = "LATEST_RELEASE_#{version}"
         begin
-          normalize_version(get(URI.join(base_url, release_file)))
-        rescue Net::HTTPServerException
-          latest_release = normalize_version(get(URI.join(base_url, 'LATEST_RELEASE')))
+          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.version = <desired driver version>` to an known "\
+          msg = "#{msg}please set `Webdrivers::Chromedriver.required_version = <desired driver version>` to an known "\
 'chromedriver version: https://chromedriver.storage.googleapis.com/index.html'
-          raise StandardError, msg
-        end
-      end
-
-      def platform
-        if Selenium::WebDriver::Platform.linux?
-          'linux64'
-        elsif Selenium::WebDriver::Platform.mac?
-          'mac64'
-        else
-          'win32'
+          raise VersionError, msg
         end
       end
 
       def file_name
-        Selenium::WebDriver::Platform.windows? ? 'chromedriver.exe' : 'chromedriver'
+        System.platform == 'win' ? 'chromedriver.exe' : 'chromedriver'
       end
 
       def base_url
@@ -69,7 +67,14 @@ module Webdrivers
       def download_url
         return @download_url if @download_url
 
-        url = "#{base_url}/#{desired_version}/chromedriver_#{platform}.zip"
+        version = if required_version.version.empty?
+                    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
@@ -83,29 +88,10 @@ module Webdrivers
         normalize_version(chrome.segments[0..2].join('.'))
       end
 
-      # Returns currently installed Chrome version
-      def chrome_version
-        ver = case platform
-              when 'win32'
-                chrome_on_windows
-              when 'linux64'
-                chrome_on_linux
-              when 'mac64'
-                chrome_on_mac
-              else
-                raise NotImplementedError, 'Your OS is not supported by webdrivers gem.'
-              end.chomp
-
-        raise StandardError, '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
-
-      def chrome_on_windows
+      def chrome_on_win
         if browser_binary
           Webdrivers.logger.debug "Browser executable: '#{browser_binary}'"
-          return `powershell (Get-ItemProperty '#{browser_binary}').VersionInfo.ProductVersion`.strip
+          return System.call("powershell (Get-ItemProperty '#{browser_binary}').VersionInfo.ProductVersion").strip
         end
 
         # Workaround for Google Chrome when using Jruby on Windows.
@@ -114,39 +100,39 @@ module Webdrivers
           ver = 'powershell (Get-Item -Path ((Get-ItemProperty "HKLM:\\Software\\Microsoft' \
           "\\Windows\\CurrentVersion\\App` Paths\\chrome.exe\").\\'(default)\\'))" \
           '.VersionInfo.ProductVersion'
-          return `#{ver}`.strip
+          return System.call(ver).strip
         end
 
         # Default to Google Chrome
-        reg        = 'HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\App Paths\chrome.exe'
-        executable = `powershell (Get-ItemProperty '#{reg}' -Name '(default)').'(default)'`.strip
+        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"
-        `powershell #{ps}`.strip
+        System.call("powershell #{ps}").strip
       end
 
       def chrome_on_linux
         if browser_binary
           Webdrivers.logger.debug "Browser executable: '#{browser_binary}'"
-          return `#{Shellwords.escape browser_binary} --product-version`.strip
+          return System.call("#{Shellwords.escape browser_binary} --product-version").strip
         end
 
         # Default to Google Chrome
-        executable = `which google-chrome`.strip
+        executable = System.call('which google-chrome').strip
         Webdrivers.logger.debug "Browser executable: '#{executable}'"
-        `#{executable} --product-version`.strip
+        System.call("#{executable} --product-version").strip
       end
 
       def chrome_on_mac
         if browser_binary
           Webdrivers.logger.debug "Browser executable: '#{browser_binary}'"
-          return `#{Shellwords.escape browser_binary} --version`.strip
+          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}"
-        `#{executable} --version`.strip
+        System.call("#{executable} --version").strip
       end
 
       #
@@ -156,6 +142,26 @@ module Webdrivers
         # 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