chromedriver_update 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8e2e0ec3f35a8a73dedd156304e33e590f2c702793f29577722ae78668a95de5
+  data.tar.gz: 2d68c3ee0e614d3f3ffc5f986942753713dcf299d743000c34ee74ed9ba8a5fc
+SHA512:
+  metadata.gz: f9fcfe6da61c09122a7b721a9492ef27a1d1062489c7dda6c6756f952208e1cead6e76f8c5af56494cb6b03ce6d23d530c196d5f4b19d42c73baf74b5f0962b6
+  data.tar.gz: 90ff77b0f9adb67e2fc74fe5e25142a7fbc75a39b2dd8a66574a9f63c801b5ec2532fd9a66e8a8eb179fc427aedb3a4b14be74940ee8d379cfa60c3d2868c64c

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.vscode/
+/.idea/
+*.gem
+playground.rb
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.14.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at chromedriver_update.gemspec@mail.magynhard.de. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017-2021 Matthäus J. N. Beyrle
+
+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

@@ -0,0 +1,80 @@
+# chromedriver_update
+[![Gem](https://img.shields.io/gem/v/chromedriver_update?color=default&style=plastic&logo=ruby&logoColor=red)](https://rubygems.org/gems/chromedriver_update)
+![downloads](https://img.shields.io/gem/dt/chromedriver_update?color=blue&style=plastic)
+[![License: MIT](https://img.shields.io/badge/License-MIT-gold.svg?style=plastic&logo=mit)](LICENSE)
+
+> Update an existing installation of chromedriver fitting to the current installed version of chrome. Available for Ruby and as CLI command as well.
+
+Very basic tool, to ensure, that the current chromedriver is updat to date to the current installed Chrome. Automatically fetches the same driver version or the latest version below, to ensure it will work with the current installed chrome version.
+
+The installed chromedriver is replaced with the new version. So it must have been setup initially and added to the PATH environment variable to use this script from then.
+
+Implemented for Linux, Windows and Mac.
+
+### Contents
+* [Installation](#installation)
+* [Usage](#usage)
+* [Command line](#command-line-usage)
+* [Documentation](#documentation)
+* [Contributing](#contributing)
+
+
+<a name="installation"></a>
+## Installation
+### Ruby
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'chromedriver_update'
+```
+
+And then execute:
+
+    bundle install
+
+### Command line
+If you just want to use the command line then run
+
+    gem install chromedriver_update
+
+Of course you need to have installed Ruby on your system and set the PATH variable, to have access to Ruby commands like `ruby` or `gem`.
+
+
+
+<a name="usage"></a>
+## Usage
+
+### Example
+
+```ruby
+require 'chromedriver_update'
+
+ChromedriverUpdate.auto_update_chromedriver
+```
+
+
+<a name="command-line-usage"></a>
+## Command line
+
+`chromedriver_update` is also available on the command line after installation.
+
+### Example
+
+Run on the command line
+
+```ruby
+chromedriver_update
+# => Updated Chromedriver from '123.0.0' to '124.0.0'! Chrome is '124.0.1'.
+```
+
+<a name="documentation"></a>
+## Documentation
+
+For more details have a look at the rubydoc at [https://www.rubydoc.info/gems/chromedriver_update](https://www.rubydoc.info/gems/chromedriver_update)
+
+
+
+<a name="documentation"></a>
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/magynhard/chromedriver_update. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+#
+# run default task to see tasks to build and publish gem
+#
+task :default do
+  system 'rake --tasks'
+end
+
+RSpec::Core::RakeTask.new(:spec)

data/bin/chromedriver_update

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/chromedriver_update'
+
+arg = ARGV[0]
+
+if %w[version -v --version].include?(arg)
+  puts "#{ChromedriverUpdate::VERSION}"
+elsif arg.nil? || arg == ''
+  ChromedriverUpdate.auto_update_chromedriver
+else
+  puts <<-TEXT
+    
+    chromedriver_update #{ChromedriverUpdate::VERSION}
+    https://github.com/magynhard/chromedriver_update
+
+    chromedriver_update -h --help     # show this info
+    chromedriver_update -v --version  # show the libraries current version
+    chromedriver_update               # automatically update the current chromedriver version fitting to the currently installed chrome
+
+  TEXT
+end

data/bin/chromedriver_update.bat

@@ -0,0 +1,2 @@
+@ECHO OFF
+@"%~dp0ruby.exe" "%~dpn0" %*

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "chromedriver_update"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/chromedriver_update.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'chromedriver_update/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "chromedriver_update"
+  spec.version       = ChromedriverUpdate::VERSION
+  spec.executables   = %w[chromedriver_update]
+  spec.authors       = ["Matthäus Beyrle"]
+  spec.email         = ["chromedriver_update.gemspec@mail.magynhard.de"]
+
+  spec.summary       = %q{Update an existing installation of chromedriver fitting to the current installed version of chrome}
+  spec.homepage      = "https://github.com/magynhard/chromedriver_update"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'os', '~> 1.1.4'
+  spec.add_dependency 'rubyzip', '~> 2.3.2'
+  spec.add_dependency 'httparty', '~> 0.22.0'
+
+  spec.add_development_dependency 'bundler',  '>= 1.14'
+  spec.add_development_dependency 'rake',     '>= 10.0'
+  spec.add_development_dependency 'rspec',    '>= 3.0'
+end

data/lib/chromedriver_update/version.rb

@@ -0,0 +1,3 @@
+class ChromedriverUpdate
+  VERSION = '0.1.0'.freeze
+end

data/lib/chromedriver_update.rb

@@ -0,0 +1,126 @@
+require 'chromedriver_update/version'
+
+require 'os'
+require 'open-uri'
+require 'zip'
+require 'httparty'
+require 'fileutils'
+require 'json'
+
+require_relative 'custom_errors/chromedriver_not_found_error'
+require_relative 'custom_errors/chrome_not_found_error'
+
+class ChromedriverUpdate
+
+  CHROME_DOWNLOADS_LIST_URL = 'https://googlechromelabs.github.io/chrome-for-testing/known-good-versions-with-downloads.json'
+
+  #
+  # Update the installed version of chromedriver automatically fitting to the currently installed version of chrome
+  #
+  def self.auto_update_chromedriver
+    if installed_chrome_version.split(".").first != installed_chromedriver_version.split(".").first
+      original_chromedriver_version = installed_chromedriver_version
+      chromedriver_zip = HTTParty.get(chromedriver_link_for_version(installed_chrome_version))
+      if chromedriver_zip.code == 404 # fallback to latest lower version
+        chromedriver_zip = HTTParty.get(chromedriver_closest_link_for_version(installed_chrome_version))
+      end
+      destination_dir = File.expand_path(File.dirname(__FILE__) + "/../tmp")
+      Zip::File.open_buffer(chromedriver_zip.body) do |zip_files|
+        zip_files.each do |entry|
+          if (entry.name.end_with?("/chromedriver") || entry.name.end_with?("/chromedriver.exe"))
+            download_path = File.join(destination_dir, File.basename(entry.name))
+            FileUtils.rm_f(download_path)
+            entry.extract(download_path)
+            FileUtils.mv(download_path, chromedriver_path, force: true)
+          end
+        end
+      end
+      puts "Updated Chromedriver from '#{original_chromedriver_version}' to '#{installed_chromedriver_version}'! Chrome is '#{installed_chrome_version}'."
+    else
+      puts "Chromedriver is already up to date at major version! Chromedriver: '#{installed_chromedriver_version}' Chrome: '#{installed_chrome_version}'"
+    end
+  end
+
+  #
+  # Get the currently installed version of chrome
+  #
+  # @return [String] current installed chrome version
+  #
+  def self.installed_chrome_version
+    begin
+      if OS.windows?
+        version = `reg query "HKEY_CURRENT_USER\\Software\\Google\\Chrome\\BLBeacon" /v version`
+        version.scan(/version[^0-9]*([0-9\.]+)/).flatten.first
+      elsif OS.mac?
+        version = `/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome --version`
+        version.scan(/([0-9\.]+)/).flatten.first
+      else
+        version = ""
+        begin
+          version = `google-chrome --version`
+        rescue Errno::ENOENT => e
+          version = `google-chrome-stable --version`
+        end
+        version.scan(/([0-9\.]+)/).flatten.first
+      end
+    rescue => e
+      raise ChromeNotFoundError.new "Could not detect a installed chrome version!"
+    end
+  end
+
+  #
+  # Get the currently installed version of chromedriver
+  #
+  # @return [String] current installed chromedriver version
+  #
+  def self.installed_chromedriver_version
+    `#{chromedriver_path} --version`.scan(/([0-9\.]+)/).flatten.first
+  end
+
+  def self.chromedriver_link_for_version(version)
+    if OS.windows?
+      "https://storage.googleapis.com/chrome-for-testing-public/#{version}/win64/chromedriver-win64.zip"
+    elsif OS.mac?
+      "https://storage.googleapis.com/chrome-for-testing-public/#{version}/mac-arm64/chromedriver-mac-arm64.zip"
+    else
+      "https://storage.googleapis.com/chrome-for-testing-public/#{version}/linux64/chromedriver-linux64.zip"
+    end
+  end
+
+  #
+  # Get the download URL of the closest chromedriver version fitting the given chrome version
+  #
+  # @param [String] version of chrome to find the best chromedriver version for
+  # @return [String] link to the matching chromedriver download for the local platform
+  #
+  def self.chromedriver_closest_link_for_version(version)
+    platform = if OS.windows?
+                 "win64"
+               elsif OS.mac?
+                 "mac-arm64"
+               else
+                 "linux64"
+               end
+    list = JSON.parse(HTTParty.get(CHROME_DOWNLOADS_LIST_URL).body)
+    latest_match = list['versions'].filter { |el| el['version'].start_with?(version.split(".")[0...1].join(".")) && el['version'].split(".")[2].to_i < version.split(".")[2].to_i && el['downloads']['chromedriver'] }.last
+    latest_match['downloads']['chromedriver'].filter { |el| el['platform'] == platform }.first['url']
+  end
+
+  #
+  # Get the path of the installed chromedriver
+  #
+  # @return [String] path to the installed chromedriver
+  # @raise [ChromedriverNotFoundError] if no chromedriver could be found
+  def self.chromedriver_path
+    version = if OS.windows?
+                `where chromedriver`.strip
+              else
+                `which chromedriver`.strip
+              end
+    if version == ""
+      raise ChromedriverNotFoundError.new "Could not detect installed chromedriver!"
+    else
+      version
+    end
+  end
+end

data/lib/custom_errors/chrome_not_found_error.rb

@@ -0,0 +1,2 @@
+class ChromeNotFoundError < StandardError
+end

data/lib/custom_errors/chromedriver_not_found_error.rb

@@ -0,0 +1,2 @@
+class ChromedriverNotFoundError < StandardError
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: chromedriver_update
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthäus Beyrle
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: os
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.4
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.2
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.22.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description:
+email:
+- chromedriver_update.gemspec@mail.magynhard.de
+executables:
+- chromedriver_update
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/chromedriver_update
+- bin/chromedriver_update.bat
+- bin/console
+- bin/setup
+- chromedriver_update.gemspec
+- lib/chromedriver_update.rb
+- lib/chromedriver_update/version.rb
+- lib/custom_errors/chrome_not_found_error.rb
+- lib/custom_errors/chromedriver_not_found_error.rb
+homepage: https://github.com/magynhard/chromedriver_update
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: Update an existing installation of chromedriver fitting to the current installed
+  version of chrome
+test_files: []