webdrivers 3.7.1 → 3.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 57609975e2a5d45294e3bc698ded693c3c6eef7df57b758264afb9e5d132c71a
-  data.tar.gz: 8975564b199c769158c5bd4cf247b84276ac4718fafbce031fc025d2a4150e19
+  metadata.gz: 6ef60a7f9627b14fa90b684a1f807e8b853a0eda388bd21d8a3017ca98da585d
+  data.tar.gz: 8d221be9ff66fd793c50934990c12236349a0ad04a1b0e9a9fcfc7d65632231a
 SHA512:
-  metadata.gz: 4e69935404700371ab1bad72ce3122064e850e8d89ae152b25cefe97ad7282527340c8f3e4f7fb2e45bed124ca248795f9b483393f72c6f606898c118f859b34
-  data.tar.gz: 4ce41c8a7fe0d16825828865bee12166557092f6ef633e728042118ffc1b05f6edb5457d69c787f513d98e319729b54b4bd0d65786a15f95c4d6063a3f956535
+  metadata.gz: 32bb8a8f53ad38f1d6a6e7f25c62787039db4e4e165f5d52f08877a05da8230bcb1fc2387cfd8cd75aa653aed689ee06eb21ea0fd25e3b491c0605d5f2c0ca86
+  data.tar.gz: 3dc0a5206c967a98b25aa5e0bf1b257769d362894f4f00141a988b6fdd6bd395cbc40785dee73c88e016b0cb40c3b0198696e950db4a6cdda43e38d1278349f5

data/.gitignore

@@ -1,6 +1,7 @@
-*.gem
-.bundle
-Gemfile.lock
-pkg/*
-chromedriver.log
-/.idea/
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+chromedriver.log
+/.idea/
+coverage/

data/.rubocop.yml

@@ -0,0 +1,19 @@
+require: rubocop-rspec
+Metrics/LineLength:
+  Enabled: false
+Metrics/MethodLength:
+  Enabled: false
+Metrics/BlockLength:
+  Enabled: false
+Metrics/ClassLength:
+  Enabled: false
+Metrics/AbcSize:
+  Enabled: false
+Metrics/CyclomaticComplexity:
+  Enabled: false
+Style/Documentation:
+  Enabled: false
+RSpec/ExampleLength:
+  Enabled: false
+RSpec/MultipleExpectations:
+  Enabled: false

data/.travis.yml

@@ -1,4 +1,3 @@
-sudo: required
 os:
   - linux
   - osx
@@ -6,9 +5,12 @@ language: ruby
 cache: bundler
 rvm:
   - 2.4.1
+  - 2.5
+  - 2.6
   - jruby-9.2.0.0
 addons:
+  apt:
+    packages:
+      - chromium-browser
+      - libgconf-2-4
   chrome: stable
-
-before_script:
-  - if [[ "$TRAVIS_OS_NAME" == "linux" ]]; then sudo apt-get install chromium-browser libgconf-2-4 ; fi

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 3.7.2 (2019-03-29)
+* Fix bugs in methods that retrieve Chrome/Chromium version. See [#43](https://github.com/titusfortner/webdrivers/pull/43) and [#52](https://github.com/titusfortner/webdrivers/issues/52).
+* Add workaround for a Jruby bug when retrieving Chrome version on Windows. See [#41](https://github.com/titusfortner/webdrivers/issues/41).
+* Update README with more information.
+
 ### 3.7.1 (2019-03-25)
 * Use `Selenium::WebDriver::Chrome#path` to check for a user given browser executable before defaulting to Google Chrome. Addresses [#38](https://github.com/titusfortner/webdrivers/issues/38).
 * Download `chromedriver` v2.46 if Chrome/Chromium version is less than 70.

data/Gemfile

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in webdrivers.gemspec
-gemspec
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in webdrivers.gemspec
+gemspec

data/LICENSE.txt

@@ -1,22 +1,22 @@
-(The MIT License)
-
-Copyright (c) 2017: Titus Fortner
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+(The MIT License)
+
+Copyright (c) 2017: Titus Fortner
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -7,19 +7,12 @@ Run Selenium tests more easily with automatic installation and updates for all s
 
 # Description
 
-`webdrivers` downloads drivers and directs Selenium to use them.
+`webdrivers` downloads drivers and directs Selenium to use them. Currently supports:
 
-Currently supported:
-* `chromedriver`
-* `geckodriver`
-* `IEDriverServer`
-* `MicrosoftWebDriver`
-
-Drivers are stored in `~/.webdrivers` directory, and this is configurable:
- 
- ```ruby
- Webdrivers.install_dir = '/webdrivers/install/dir'
-```
+* [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
 
@@ -33,6 +26,44 @@ In your project:
 require 'webdrivers'
 ```
 
+The drivers will now be automatically downloaded or updated when you launch a browser
+through Selenium. 
+
+**Download Location**
+
+The default download location is `~/.webdrivers` directory, and this is configurable:
+ 
+ ```ruby
+ Webdrivers.install_dir = '/webdrivers/install/dir'
+```
+
+**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.
+
+```ruby
+# Chrome
+Webdrivers::Chromedriver.version = '2.46'
+
+# Firefox
+Webdrivers::Geckodriver.version  = '0.23.0'
+
+# Microsoft Internet Explorer
+Webdrivers::IEdriver.version     = '3.14.0'
+
+# Microsoft Edge
+Webdrivers::MSWebdriver.version  = '17134'
+```
+
+You can also trigger the update in your code, but it is not required:
+
+```ruby
+Webdrivers::Chromedriver.update
+```
+
+# Proxy
+
 If there is a proxy between you and the Internet then you will need to configure
 the gem to use the proxy.  You can do this by calling the `configure` method.
 
@@ -45,33 +76,43 @@ Webdrivers.configure do |config|
 end
 ````
 
-If you are getting an error like this (especially common on Windows)  
+If you are getting an error like this (especially common on Windows):
+ 
 `SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed`
 
-add the following to your code:
+Add the following to your code:
 
 ````ruby
 Webdrivers.net_http_ssl_fix
 ````
 
-You can also specify the webdriver versions if you don't want the latest:
+# Logging
+
+The logging level can be configured for debugging purpose:
 
 ```ruby
-Webdrivers::Chromedriver.version = '2.46'
-Webdrivers::Geckodriver.version  = '0.17.0'
-Webdrivers::IEdriver.version     = '3.14.0'
-Webdrivers::MSWebdriver.version  = '17134'
+Webdrivers.logger.level = :DEBUG
 ```
 
-**Note when using Chrome/Chromium with Selenium**
+# Browser Specific Notes
 
-You can configure the gem to use a specific browser version (Chrome vs Chromium) by providing the path to its binary:
+**When using 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 <=  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`.
+ 
+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'
+Selenium::WebDriver::Chrome.path = '/chromium/install/path/to/binary'
 ```
 
-**Note 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).
+
+**When using Microsoft Edge**
 
 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.
@@ -83,6 +124,10 @@ expected version and skips the download process.
 
 If you continue with the outdated binary, Selenium will throw an error: `unable to connect to MicrosoftWebDriver localhost:17556`.
 
+# Wiki
+
+Please see the [wiki](https://github.com/titusfortner/webdrivers/wiki) for solutions to commonly reported issues.
+
 # License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT),
@@ -91,7 +136,7 @@ see LICENSE.txt for full details and copyright.
 
 # Contributing
 
-Bug reports and pull requests are welcome [on GitHub](https://github.com/titusfortner/webdrivers).
+Bug reports and pull requests are welcome [on GitHub](https://github.com/titusfortner/webdrivers). Run `bundle exec rake` and squash the commits in your PRs.
 
 
 ## Copyright

data/Rakefile

@@ -1,6 +1,9 @@
-require "bundler/gem_tasks"
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task :default => :spec
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: %w[spec rubocop]

data/lib/webdrivers.rb

@@ -1,15 +1,13 @@
-require "webdrivers/selenium"
-require "webdrivers/logger"
-require "webdrivers/common"
-require "webdrivers/chromedriver"
-require "webdrivers/geckodriver"
-require "webdrivers/iedriver"
-require "webdrivers/mswebdriver"
+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
@@ -21,7 +19,7 @@ module Webdrivers
     end
 
     def net_http_ssl_fix
-      require "net_http_ssl_fix"
+      require 'net_http_ssl_fix'
     end
   end
 end

data/lib/webdrivers/chromedriver.rb

@@ -1,9 +1,9 @@
 require 'nokogiri'
+require 'shellwords'
 
 module Webdrivers
   class Chromedriver < Common
     class << self
-
       def current_version
         Webdrivers.logger.debug 'Checking current version'
         return nil unless downloaded?
@@ -31,7 +31,7 @@ module Webdrivers
       private
 
       def file_name
-        platform == "win" ? "chromedriver.exe" : "chromedriver"
+        platform == 'win' ? 'chromedriver.exe' : 'chromedriver'
       end
 
       def base_url
@@ -43,10 +43,10 @@ module Webdrivers
 
         @downloads ||= begin
           doc   = Nokogiri::XML.parse(get(base_url))
-          items = doc.css("Contents Key").collect(&:text)
+          items = doc.css('Contents Key').collect(&:text)
           items.select! { |item| item.include?(platform) }
           ds = items.each_with_object({}) do |item, hash|
-            key       = normalize item[/^[^\/]+/]
+            key       = normalize item[%r{^[^/]+}]
             hash[key] = "#{base_url}/#{item}"
           end
           Webdrivers.logger.debug "Versions now located on downloads site: #{ds.keys}"
@@ -65,28 +65,35 @@ module Webdrivers
       # Returns currently installed Chrome version
       def chrome_version
         ver = case platform
-                when 'win'
-                  chrome_on_windows
-                when /linux/
-                  chrome_on_linux
-                when 'mac'
-                  chrome_on_mac
-                else
-                  raise NotImplementedError, 'Your OS is not supported by webdrivers gem.'
+              when 'win'
+                chrome_on_windows
+              when /linux/
+                chrome_on_linux
+              when 'mac'
+                chrome_on_mac
+              else
+                raise NotImplementedError, 'Your OS is not supported by webdrivers gem.'
               end.chomp
 
-        if ver.nil? || ver.empty?
-          raise StandardError, 'Failed to find Chrome binary or its version.'
-        end
+        raise StandardError, 'Failed to find Chrome binary or its version.' if ver.nil? || ver.empty?
 
         # Google Chrome 73.0.3683.75 -> 73.0.3683.75
-        ver[/(\d|\.)+/]
+        ver[/\d+\.\d+\.\d+\.\d+/]
       end
 
       def chrome_on_windows
         if browser_binary
           Webdrivers.logger.debug "Browser executable: '#{browser_binary}'"
-          return `powershell (Get-ItemProperty '#{browser_binary}').VersionInfo.ProductVersion`
+          return `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' && platform == 'win'
+          ver = 'powershell (Get-Item -Path ((Get-ItemProperty "HKLM:\\Software\\Microsoft' \
+          "\\Windows\\CurrentVersion\\App` Paths\\chrome.exe\").\\'(default)\\'))" \
+          '.VersionInfo.ProductVersion'
+          return `#{ver}`.strip
         end
 
         # Default to Google Chrome
@@ -100,7 +107,7 @@ module Webdrivers
       def chrome_on_linux
         if browser_binary
           Webdrivers.logger.debug "Browser executable: '#{browser_binary}'"
-          return `#{browser_binary} --product-version`.strip
+          return `#{Shellwords.escape browser_binary} --product-version`.strip
         end
 
         # Default to Google Chrome
@@ -112,7 +119,7 @@ module Webdrivers
       def chrome_on_mac
         if browser_binary
           Webdrivers.logger.debug "Browser executable: '#{browser_binary}'"
-          return `#{browser_binary} --version`.strip
+          return `#{Shellwords.escape browser_binary} --version`.strip
         end
 
         # Default to Google Chrome

data/lib/webdrivers/common.rb

@@ -4,7 +4,6 @@ require 'zip'
 module Webdrivers
   class Common
     class << self
-
       attr_accessor :version
 
       def update
@@ -13,7 +12,7 @@ module Webdrivers
         end
 
         # Newer not specified or latest not found, so use existing
-        return binary if desired_version.nil? && File.exists?(binary)
+        return binary if desired_version.nil? && File.exist?(binary)
 
         # Can't find desired and no existing binary
         if desired_version.nil?
@@ -22,7 +21,7 @@ module Webdrivers
         end
 
         if correct_binary?
-          Webdrivers.logger.debug "Expected webdriver version found"
+          Webdrivers.logger.debug 'Expected webdriver version found'
           return binary
         end
 
@@ -31,19 +30,19 @@ module Webdrivers
       end
 
       def desired_version
-        if self.version.is_a?(Gem::Version)
+        if version.is_a?(Gem::Version)
           version
-        elsif self.version.nil?
+        elsif version.nil?
           latest_version
         else
-          Gem::Version.new(self.version.to_s)
+          Gem::Version.new(version.to_s)
         end
       end
 
       def latest_version
-        raise StandardError, "Can not reach site" unless site_available?
+        raise StandardError, 'Can not reach site' unless site_available?
 
-        downloads.keys.sort.last
+        downloads.keys.max
       end
 
       def remove
@@ -52,21 +51,22 @@ module Webdrivers
       end
 
       def download
-        raise StandardError, "Can not reach site" unless site_available?
+        raise StandardError, 'Can not reach site' unless site_available?
 
         url = downloads[desired_version]
         filename = File.basename url
 
-        FileUtils.mkdir_p(install_dir) unless File.exists?(install_dir)
+        FileUtils.mkdir_p(install_dir) unless File.exist?(install_dir)
         Dir.chdir install_dir do
           FileUtils.rm_f filename
-          open(filename, "wb") do |file|
+          File.open(filename, 'wb') do |file|
             file.print get(url)
           end
-          raise "Could not download #{url}" unless File.exists? filename
+          raise "Could not download #{url}" unless File.exist? filename
+
           Webdrivers.logger.debug "Successfully downloaded #{filename}"
           dcf = decompress_file(filename)
-          Webdrivers.logger.debug "Decompression Complete"
+          Webdrivers.logger.debug 'Decompression Complete'
           if dcf
             Webdrivers.logger.debug "Deleting #{filename}"
             FileUtils.rm_f filename
@@ -76,14 +76,15 @@ module Webdrivers
             extract_file(dcf)
           end
         end
-        raise "Could not decompress #{filename} to get #{binary}" unless File.exists?(binary)
-        FileUtils.chmod "ugo+rx", binary
+        raise "Could not decompress #{filename} to get #{binary}" unless File.exist?(binary)
+
+        FileUtils.chmod 'ugo+rx', binary
         Webdrivers.logger.debug "Completed download and processing of #{binary}"
         binary
       end
 
       def install_dir
-        Webdrivers.install_dir || File.expand_path(File.join(ENV['HOME'], ".webdrivers"))
+        Webdrivers.install_dir || File.expand_path(File.join(ENV['HOME'], '.webdrivers'))
       end
 
       def binary
@@ -93,7 +94,7 @@ module Webdrivers
       protected
 
       def get(url, limit = 10)
-        raise StandardError, 'Too many HTTP redirects' if limit == 0
+        raise StandardError, 'Too many HTTP redirects' if limit.zero?
 
         response = http.get_response(URI(url))
         Webdrivers.logger.debug "Get response: #{response.inspect}"
@@ -113,7 +114,7 @@ module Webdrivers
       def http
         if using_proxy
           Net::HTTP.Proxy(Webdrivers.proxy_addr, Webdrivers.proxy_port,
-                                 Webdrivers.proxy_user, Webdrivers.proxy_pass)
+                          Webdrivers.proxy_user, Webdrivers.proxy_pass)
         else
           Net::HTTP
         end
@@ -153,26 +154,26 @@ module Webdrivers
 
       def decompress_file(filename)
         case filename
-          when /tar\.gz$/
-            Webdrivers.logger.debug "Decompressing tar"
-            untargz_file(filename)
-          when /tar\.bz2$/
-            Webdrivers.logger.debug "Decompressing bz2"
-            system "tar xjf #{filename}"
-            filename.gsub('.tar.bz2', '')
-          when /\.zip$/
-            Webdrivers.logger.debug "Decompressing zip"
-            unzip_file(filename)
-          else
-            Webdrivers.logger.debug "No Decompression needed"
-            nil
+        when /tar\.gz$/
+          Webdrivers.logger.debug 'Decompressing tar'
+          untargz_file(filename)
+        when /tar\.bz2$/
+          Webdrivers.logger.debug 'Decompressing bz2'
+          system "tar xjf #{filename}"
+          filename.gsub('.tar.bz2', '')
+        when /\.zip$/
+          Webdrivers.logger.debug 'Decompressing zip'
+          unzip_file(filename)
+        else
+          Webdrivers.logger.debug 'No Decompression needed'
+          nil
         end
       end
 
       def untargz_file(filename)
         tar_extract = Gem::Package::TarReader.new(Zlib::GzipReader.open(filename))
 
-        File.open(file_name, "w+b") do |ucf|
+        File.open(file_name, 'w+b') do |ucf|
           tar_extract.each { |entry| ucf << entry.read }
           File.basename ucf
         end
@@ -182,7 +183,7 @@ module Webdrivers
         Zip::File.open("#{Dir.pwd}/#{filename}") do |zip_file|
           zip_file.each do |f|
             @top_path ||= f.name
-            f_path    = File.join(Dir.pwd, f.name)
+            f_path = File.join(Dir.pwd, f.name)
             FileUtils.rm_rf(f_path) if File.exist?(f_path)
             FileUtils.mkdir_p(File.dirname(f_path)) unless File.exist?(File.dirname(f_path))
             zip_file.extract(f, f_path)
@@ -193,7 +194,7 @@ module Webdrivers
 
       # Already have latest version downloaded?
       def correct_binary?
-        desired_version == current_version && File.exists?(binary)
+        desired_version == current_version && File.exist?(binary)
       end
 
       def normalize(string)
@@ -201,4 +202,4 @@ module Webdrivers
       end
     end
   end
-end
+end