webdrivers 4.6.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c31a9a9bcdbe92bc18be8e3175ca852ee58445a442647c0f6f1386b35edacb05
-  data.tar.gz: c7f331a4cf2c67e8849e53185228189d11f41d5116b6e0743d09cfedbbefaa3a
+  metadata.gz: f4c9d9a6544732e58eb7a88d34e39b188b5ff658caaa14fbdff15931a69d1e2d
+  data.tar.gz: 92a4997e99508bb79374838461cd2fee48591185b271dd6ce170628c51a02c2c
 SHA512:
-  metadata.gz: 82321bb84a03c26f595bb85a5907742ce4116cbe44b608a2ac27ea5c344452311151271b5eaa3bb7be4f6773fd1882d55e365531638aeed236c497557717a467
-  data.tar.gz: 4d65d4764fd7655fce7a040abd3e6b1232c2ca54a8405c9f17ed9bb8005b9ebaf0e979a783da55a32516648fff6cb882eaea79cfc4113dddced022530de43531
+  metadata.gz: fb469a584a66b14097ec87b6a8f2ad30e2cbefdaeef91efd2a50f16ff0451c8a748f8607d53d06ceed3506d61e54ef31b9997e068f9e55dfe9136f8012570234
+  data.tar.gz: ed61ff78edd17f205673242eeba0fa76dcb2df9675a7d8dc4c813e8dd056799a44b13c1a10b238eeb36bae96cc188ca20c4edd71aebf9ec48e9a78e613136f17

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# 5.0.0 (2021-10-19)
+* Require Selenium 4+
+* Remove custom Logger and use the one in Selenium 4
+
+# 4.7.0 (2021-10-14)
+* Add support for Selenium 4.x #218 (thanks yahonda )
+* Allow Edge on Linux
+* Update required Selenium > 3.141 because of a change in 4.6
+* Require Ruby 2.6+
+* Fix IE downloads with the change in location of assets
+
+# 4.6.1 (2021-08-19)
+* Fix bug in IEdriver caused by bad formatting in recent release
+
 # 4.6.0 (2021-02-26)
 * Update `Edgedriver` naming to support Selenium 4 beta (([#206](https://github.com/titusfortner/webdrivers/pull/206))
 

data/README.md

@@ -22,7 +22,7 @@ notes at the bottom.
 In your Gemfile:
 
 ```ruby
-gem 'webdrivers', '~> 4.0', require: false
+gem 'webdrivers', '~> 5.0', require: false
 ```
 
 In your project:

data/lib/webdrivers/chromedriver.rb

@@ -97,18 +97,8 @@ module Webdrivers
         false
       end
 
-      def download_url
-        return @download_url if @download_url
-
-        driver_version = if required_version == EMPTY_VERSION
-                           latest_version
-                         else
-                           normalize_version(required_version)
-                         end
-        filename = driver_filename(driver_version)
-        url = "#{base_url}/#{driver_version}/chromedriver_#{filename}.zip"
-        Webdrivers.logger.debug "chromedriver URL: #{url}"
-        @download_url = url
+      def direct_url(driver_version)
+        "#{base_url}/#{driver_version}/chromedriver_#{driver_filename(driver_version)}.zip"
       end
 
       def driver_filename(driver_version)
@@ -156,17 +146,4 @@ module Webdrivers
   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
+::Selenium::WebDriver::Chrome::Service.driver_path = proc { ::Webdrivers::Chromedriver.update }

data/lib/webdrivers/common.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require 'rubygems/package'
-require 'webdrivers/logger'
 require 'webdrivers/network'
 require 'webdrivers/system'
 require 'selenium-webdriver'
+require 'webdrivers/logger'
 require 'webdrivers/version'
 
 module Webdrivers
@@ -118,12 +118,12 @@ module Webdrivers
 
       private
 
+      def download_version
+        required_version == EMPTY_VERSION ? latest_version : required_version
+      end
+
       def download_url
-        @download_url ||= if required_version == EMPTY_VERSION
-                            downloads[downloads.keys.max]
-                          else
-                            downloads[normalize_version(required_version)]
-                          end
+        @download_url ||= direct_url(download_version).tap { |url| Webdrivers.logger.debug "#{file_name} URL: #{url}" }
       end
 
       def exists?
@@ -131,11 +131,7 @@ module Webdrivers
       end
 
       def correct_binary?
-        current_version == if required_version == EMPTY_VERSION
-                             latest_version
-                           else
-                             normalize_version(required_version)
-                           end
+        current_version == download_version
       rescue ConnectionError, VersionError
         driver_path if sufficient_binary?
       end

data/lib/webdrivers/edgedriver.rb

@@ -76,15 +76,15 @@ module Webdrivers
         false
       end
 
-      # def linux_compatible?(driver_version)
-      #   System.platform == 'linux' && driver_version >= normalize_version('89.0.731.0')
-      # end
+      def linux_compatible?(driver_version)
+        System.platform == 'linux' && driver_version >= normalize_version('89.0.731.0')
+      end
 
       def driver_filename(driver_version)
         if System.platform == 'win' || System.wsl_v1?
           "win#{System.bitsize}" # 32 or 64-bit
-        # elsif linux_compatible?(driver_version)
-        #   'linux64'
+        elsif linux_compatible?(driver_version)
+          'linux64'
         elsif System.platform == 'mac'
           # Determine M1 or Intel architecture
           apple_arch = apple_m1_compatible?(driver_version) ? 'arm' : 'mac'
@@ -94,18 +94,8 @@ module Webdrivers
         end
       end
 
-      def download_url
-        return @download_url if @download_url
-
-        driver_version = if required_version == EMPTY_VERSION
-                           latest_version
-                         else
-                           normalize_version(required_version)
-                         end
-        filename = driver_filename(driver_version)
-        url = "#{base_url}/#{driver_version}/edgedriver_#{filename}.zip"
-        Webdrivers.logger.debug "msedgedriver URL: #{url}"
-        @download_url = url
+      def direct_url(driver_version)
+        "#{base_url}/#{driver_version}/edgedriver_#{driver_filename(driver_version)}.zip"
       end
     end
   end

data/lib/webdrivers/geckodriver.rb

@@ -42,14 +42,6 @@ module Webdrivers
         System.platform == 'win' ? 'geckodriver.exe' : 'geckodriver'
       end
 
-      def download_url
-        @download_url ||= if required_version == EMPTY_VERSION
-                            direct_url(latest_version)
-                          else
-                            direct_url(required_version)
-                          end
-      end
-
       def direct_url(version)
         "#{base_url}/download/v#{version}/geckodriver-v#{version}-#{platform_ext}"
       end
@@ -68,17 +60,4 @@ module Webdrivers
   end
 end
 
-if ::Selenium::WebDriver::Service.respond_to? :driver_path=
-  ::Selenium::WebDriver::Firefox::Service.driver_path = proc { ::Webdrivers::Geckodriver.update }
-else
-  # v3.141.0 and lower
-  module Selenium
-    module WebDriver
-      module Firefox
-        def self.driver_path
-          @driver_path ||= Webdrivers::Geckodriver.update
-        end
-      end
-    end
-  end
-end
+::Selenium::WebDriver::Firefox::Service.driver_path = proc { ::Webdrivers::Geckodriver.update }

data/lib/webdrivers/iedriver.rb

@@ -34,7 +34,7 @@ module Webdrivers
       #
       # @return [String]
       def base_url
-        'https://selenium-release.storage.googleapis.com/'
+        'https://api.github.com/repos/seleniumhq/selenium/releases'
       end
 
       private
@@ -43,35 +43,26 @@ module Webdrivers
         'IEDriverServer.exe'
       end
 
+      def direct_url(version)
+        downloads[version]
+      end
+
       def downloads
         ds = download_manifest.each_with_object({}) do |item, hash|
-          version = normalize_version item[/([^_]+)\.zip/, 1]
-          hash[version] = "#{base_url}#{item}"
+          version = normalize_version item['name'][/\.?([^_]+)\.zip/, 1]
+          hash[version] = item['browser_download_url']
         end
         Webdrivers.logger.debug "Versions now located on downloads site: #{ds.keys}"
         ds
       end
 
       def download_manifest
-        doc = Nokogiri::XML.parse(Network.get(base_url))
-        items = doc.css('Key').collect(&:text)
-        items.select { |item| item.include?('IEDriverServer_Win32') }
+        json = Network.get(base_url)
+        all_assets = JSON.parse(json).map { |release| release['assets'] }.flatten
+        all_assets.select { |asset| asset['name'].include?('IEDriverServer_Win32') }
       end
     end
   end
 end
 
-if ::Selenium::WebDriver::Service.respond_to? :driver_path=
-  ::Selenium::WebDriver::IE::Service.driver_path = proc { ::Webdrivers::IEdriver.update }
-else
-  # v3.141.0 and lower
-  module Selenium
-    module WebDriver
-      module IE
-        def self.driver_path
-          @driver_path ||= Webdrivers::IEdriver.update
-        end
-      end
-    end
-  end
-end
+::Selenium::WebDriver::IE::Service.driver_path = proc { ::Webdrivers::IEdriver.update }

data/lib/webdrivers/logger.rb

@@ -1,11 +1,5 @@
 # frozen_string_literal: true
 
-require 'forwardable'
-require 'logger'
-
-# Code adapted from Selenium Implementation
-# https://github.com/SeleniumHQ/selenium/blob/master/rb/lib/selenium/webdriver/common/logger.rb
-
 module Webdrivers
   #
   # @example Enable full logging
@@ -18,94 +12,9 @@ module Webdrivers
   #   Webdrivers.logger.info('This is info message')
   #   Webdrivers.logger.warn('This is warning message')
   #
-  class Logger
-    extend Forwardable
-    include ::Logger::Severity
-
-    def_delegators :@logger, :debug, :debug?,
-                   :info, :info?,
-                   :warn, :warn?,
-                   :error, :error?,
-                   :fatal, :fatal?,
-                   :level
-
+  class Logger < Selenium::WebDriver::Logger
     def initialize
-      @logger = create_logger($stdout)
-    end
-
-    def output=(io)
-      # `Logger#reopen` was added in Ruby 2.3
-      if @logger.respond_to?(:reopen)
-        @logger.reopen(io)
-      else
-        @logger = create_logger(io)
-      end
-    end
-
-    #
-    # For Ruby < 2.3 compatibility
-    # Based on https://github.com/ruby/ruby/blob/ruby_2_3/lib/logger.rb#L250
-    #
-
-    def level=(severity)
-      if severity.is_a?(Integer)
-        @logger.level = severity
-      else
-        case severity.to_s.downcase
-        when 'debug'
-          @logger.level = DEBUG
-        when 'info'
-          @logger.level = INFO
-        when 'warn'
-          @logger.level = WARN
-        when 'error'
-          @logger.level = ERROR
-        when 'fatal'
-          @logger.level = FATAL
-        when 'unknown'
-          @logger.level = UNKNOWN
-        else
-          raise ArgumentError, "invalid log level: #{severity}"
-        end
-      end
-    end
-
-    #
-    # Returns IO object used by logger internally.
-    #
-    # Normally, we would have never needed it, but we want to
-    # use it as IO object for all child processes to ensure their
-    # output is redirected there.
-    #
-    # It is only used in debug level, in other cases output is suppressed.
-    #
-    # @api private
-    #
-    def io
-      @logger.instance_variable_get(:@logdev).instance_variable_get(:@dev)
-    end
-
-    #
-    # Marks code as deprecated with replacement.
-    #
-    # @param [String] old
-    # @param [String] new
-    #
-    def deprecate(old, new)
-      warn "[DEPRECATION] #{old} is deprecated. Use #{new} instead."
-    end
-
-    private
-
-    def create_logger(output)
-      logger = ::Logger.new(output)
-      logger.progname = 'Webdrivers'
-      logger.level = ($DEBUG ? DEBUG : WARN)
-      logger.formatter = proc do |severity, time, progname, msg|
-        "#{time.strftime('%F %T')} #{severity} #{progname} #{msg}\n"
-      end
-
-      logger
+      super('Webdrivers')
     end
   end
 end

data/lib/webdrivers/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Webdrivers
-  VERSION = '4.6.0'
+  VERSION = '5.0.0'
 end

data/spec/webdrivers/edge_finder_spec.rb

@@ -5,11 +5,7 @@ require 'spec_helper'
 describe Webdrivers::EdgeFinder do
   let(:edge_finder) { described_class }
 
-  before(:all) do # rubocop:disable RSpec/BeforeAfterAll
-    if Selenium::WebDriver::VERSION[0].to_i < 4
-      skip "The current selenium-webdriver doesn't include Chromium based Edge support"
-    end
-  end
+  before { skip 'Edge is not yet supported on Linux' if Webdrivers::System.platform == 'linux' }
 
   context 'when the user relies on the gem to figure out the location of Edge' do
     it 'determines the location correctly based on the current OS' do

data/spec/webdrivers/edgedriver_spec.rb

@@ -5,14 +5,11 @@ require 'spec_helper'
 describe Webdrivers::Edgedriver do
   let(:edgedriver) { described_class }
 
-  before(:all) do # rubocop:disable RSpec/BeforeAfterAll
-    if Selenium::WebDriver::VERSION[0].to_i < 4
-      skip "The current selenium-webdriver doesn't include Chromium based Edge support"
-    end
+  before do
+    skip 'Edge is not yet supported on Linux' if Webdrivers::System.platform == 'linux'
+    edgedriver.remove
   end
 
-  before { edgedriver.remove }
-
   describe '#update' do
     context 'when evaluating #correct_binary?' do
       it 'does not download when latest version and current version match' do
@@ -178,8 +175,7 @@ describe Webdrivers::Edgedriver do
     end
 
     it 'raises VersionError for unknown version' do
-      skip "MS doesn't yet support point release latest versioning."
-      allow(edgedriver).to receive(:browser_version).and_return('77.0.9999.0000')
+      allow(edgedriver).to receive(:browser_version).and_return Gem::Version.new('77.0.9999')
       msg = 'Unable to find latest point release version for 77.0.9999. '\
 'Please set `Webdrivers::Edgedriver.required_version = <desired driver version>` '\
 'to a known edgedriver version: Can not reach https://msedgedriver.azureedge.net/'

data/spec/webdrivers/geckodriver_spec.rb

@@ -192,14 +192,12 @@ You can obtain a copy of the license at https://mozilla.org/MPL/2.0/"
     end
 
     it 'uses provided value' do
-      begin
-        install_dir = File.expand_path(File.join(ENV['HOME'], '.webdrivers2'))
-        Webdrivers.install_dir = install_dir
+      install_dir = File.expand_path(File.join(ENV['HOME'], '.webdrivers2'))
+      Webdrivers.install_dir = install_dir
 
-        expect(Webdrivers::System.install_dir).to eq install_dir
-      ensure
-        Webdrivers.install_dir = nil
-      end
+      expect(Webdrivers::System.install_dir).to eq install_dir
+    ensure
+      Webdrivers.install_dir = nil
     end
   end
 

data/spec/webdrivers/i_edriver_spec.rb

@@ -6,6 +6,10 @@ describe Webdrivers::IEdriver do
   let(:iedriver) { described_class }
 
   before do
+    if ENV['CI'] && !Selenium::WebDriver::Platform.windows?
+      skip('Only run IE tests on Windows on CI because rate limiting')
+    end
+
     iedriver.remove
     iedriver.required_version = nil
   end
@@ -69,7 +73,7 @@ describe Webdrivers::IEdriver do
       it 'raises ConnectionError if offline' do
         allow(Net::HTTP).to receive(:get_response).and_raise(SocketError)
 
-        msg = %r{Can not reach https://selenium-release.storage.googleapis.com/}
+        msg = %r{Can not reach https://api.github.com/repos/seleniumhq/selenium/releases}
         expect { iedriver.update }.to raise_error(Webdrivers::ConnectionError, msg)
       end
     end
@@ -109,7 +113,8 @@ describe Webdrivers::IEdriver do
     end
 
     it 'creates cached file' do
-      allow(Webdrivers::Network).to receive(:get).and_return('3.4.0')
+      json = '[{"assets": [{"name":"IEDriverServer_Win32_3.150.0.zip"}]}]'
+      allow(Webdrivers::Network).to receive(:get).and_return(json)
 
       iedriver.latest_version
       expect(File.exist?("#{Webdrivers::System.install_dir}/IEDriverServer.version")).to eq true
@@ -174,14 +179,12 @@ describe Webdrivers::IEdriver do
     end
 
     it 'uses provided value' do
-      begin
-        install_dir = File.expand_path(File.join(ENV['HOME'], '.webdrivers2'))
-        Webdrivers.install_dir = install_dir
+      install_dir = File.expand_path(File.join(ENV['HOME'], '.webdrivers2'))
+      Webdrivers.install_dir = install_dir
 
-        expect(Webdrivers::System.install_dir).to eq install_dir
-      ensure
-        Webdrivers.install_dir = nil
-      end
+      expect(Webdrivers::System.install_dir).to eq install_dir
+    ensure
+      Webdrivers.install_dir = nil
     end
   end
 

data/spec/webdrivers/webdrivers_spec.rb

@@ -49,37 +49,31 @@ describe Webdrivers do
     end
 
     it 'uses provided value' do
-      begin
-        install_dir                 = File.expand_path(File.join(ENV['HOME'], '.webdrivers2'))
-        described_class.install_dir = install_dir
+      install_dir                 = File.expand_path(File.join(ENV['HOME'], '.webdrivers2'))
+      described_class.install_dir = install_dir
 
-        expect(described_class.install_dir).to eq install_dir
-      ensure
-        described_class.install_dir = nil
-      end
+      expect(described_class.install_dir).to eq install_dir
+    ensure
+      described_class.install_dir = nil
     end
 
     context 'when ENV variable WD_INSTALL_DIR is set and Webdrivers.install_dir is not' do
       it 'uses path from the ENV variable' do
-        begin
-          described_class.install_dir = nil
-          allow(ENV).to receive(:[]).with('WD_INSTALL_DIR').and_return('custom_dir')
-          expect(described_class.install_dir).to be('custom_dir')
-        ensure
-          described_class.install_dir = nil
-        end
+        described_class.install_dir = nil
+        allow(ENV).to receive(:[]).with('WD_INSTALL_DIR').and_return('custom_dir')
+        expect(described_class.install_dir).to be('custom_dir')
+      ensure
+        described_class.install_dir = nil
       end
     end
 
     context 'when both ENV variable WD_INSTALL_DIR and Webdrivers.install_dir are set' do
       it 'uses path from Webdrivers.install_dir' do
-        begin
-          described_class.install_dir = 'my_install_dir_path'
-          allow(ENV).to receive(:[]).with('WD_INSTALL_DIR').and_return('my_env_path')
-          expect(described_class.install_dir).to be('my_install_dir_path')
-        ensure
-          described_class.install_dir = nil
-        end
+        described_class.install_dir = 'my_install_dir_path'
+        allow(ENV).to receive(:[]).with('WD_INSTALL_DIR').and_return('my_env_path')
+        expect(described_class.install_dir).to be('my_install_dir_path')
+      ensure
+        described_class.install_dir = nil
       end
     end
   end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: webdrivers
 version: !ruby/object:Gem::Version
-  version: 4.6.0
+  version: 5.0.0
 platform: ruby
 authors:
 - Titus Fortner
 - Lakshya Kapoor
 - Thomas Walpole
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-02-26 00:00:00.000000000 Z
+date: 2021-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -156,20 +156,14 @@ dependencies:
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
 description: Run Selenium tests more easily with install and updates for all supported
@@ -218,9 +212,9 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/titusfortner/webdrivers/issues
   changelog_uri: https://github.com/titusfortner/webdrivers/blob/master/CHANGELOG.md
-  documentation_uri: https://www.rubydoc.info/gems/webdrivers/4.6.0
-  source_code_uri: https://github.com/titusfortner/webdrivers/tree/v4.6.0
-post_install_message: 
+  documentation_uri: https://www.rubydoc.info/gems/webdrivers/5.0.0
+  source_code_uri: https://github.com/titusfortner/webdrivers/tree/v5.0.0
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -228,25 +222,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.4.0
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Easy download and use of browser drivers.
 test_files:
 - spec/spec_helper.rb
 - spec/webdrivers/chrome_finder_spec.rb
+- spec/webdrivers/chromedriver_spec.rb
 - spec/webdrivers/edge_finder_spec.rb
-- spec/webdrivers/webdrivers_spec.rb
-- spec/webdrivers/system_spec.rb
 - spec/webdrivers/edgedriver_spec.rb
-- spec/webdrivers/i_edriver_spec.rb
 - spec/webdrivers/geckodriver_spec.rb
-- spec/webdrivers/chromedriver_spec.rb
+- spec/webdrivers/i_edriver_spec.rb
+- spec/webdrivers/system_spec.rb
+- spec/webdrivers/webdrivers_spec.rb
 - spec/webdrivers_proxy_support_spec.rb