chauffeur 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 42cda14add9e38bfb16fa01dd90d7375880f4d294f93087efa6a918da5e08c24
+  data.tar.gz: 127de41984c2a30e3ab044d4d1a283d63e1f8f7e0d90df866f56121b1f4b1f15
+SHA512:
+  metadata.gz: 02a9aec896b3fc05fc53b70c4508f8bc8d51f0c504c2b2110836b2a9376e90589bfd7c9009f660fc1421623d886b93a040c4117aa63eb9f1b91ebdc53f814b42
+  data.tar.gz: f2cbb732bcee843e24d76c7d062aeedb0adb46ac1286d82744b905e679c6c0f319756c9b3dfb471d138037cfff6e51d81db3399f43731c4c731386c69d766243

data/.gitignore

@@ -0,0 +1,5 @@
+drivers
+chauffeur*.gem
+coverage
+Gemfile.lock
+.idea/*

data/.overcommit.yml

@@ -0,0 +1,33 @@
+# Use this file to configure the Overcommit hooks you wish to use. This will
+# extend the default configuration defined in:
+# https://github.com/brigade/overcommit/blob/master/config/default.yml
+#
+# At the topmost level of this YAML file is a key representing type of hook
+# being run (e.g. pre-commit, commit-msg, etc.). Within each type you can
+# customize each hook, such as whether to only run it on certain files (via
+# `include`), whether to only display output if it fails (via `quiet`), etc.
+#
+# For a complete list of hooks, see:
+# https://github.com/brigade/overcommit/tree/master/lib/overcommit/hook
+#
+# For a complete list of options that you can use to customize hooks, see:
+# https://github.com/brigade/overcommit#configuration
+#
+# Uncomment the following lines to make the configuration take effect.
+
+#PreCommit:
+#  RuboCop:
+#    enabled: true
+#    on_warn: fail # Treat all warnings as failures
+#
+#  TrailingWhitespace:
+#    enabled: true
+#    exclude:
+#      - '**/db/structure.sql' # Ignore trailing whitespace in generated files
+#
+#PostCheckout:
+#  ALL: # Special hook name that customizes all hooks of this type
+#    quiet: true # Change all post-checkout hooks to only display output on failure
+#
+#  IndexTags:
+#    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  Include:
+    - Gemfile
+    - Rakefile
+  Exclude:
+    - lib/pry_playground.rb
+    - .rubocop.yml
+
+Layout/EndOfLine:
+  EnforcedStyle: lf
+
+LineLength:
+  Max: 100

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org' do
+  gem 'archive-zip', '~> 0.10'
+  gem 'httparty', '~> 0.15'
+  gem 'nokogiri', '~> 1.8'
+  gem 'pry', '~> 0.11'
+  gem 'rspec', '~> 3.7'
+  gem 'simplecov', '~> 0.15'
+end

data/Readme.md

@@ -0,0 +1,94 @@
+# Chauffeur
+Chauffeur is a tool to help manage drivers for automating browsers.
+
+It has two primary behaviors: installing drivers and adding them to your path.
+
+_!!Note: Microsoft WebDriver will only work for version 14393 and greater. Before that it used an installer._
+
+## Usage
+This is very important! Chauffeur must be run from the working directory of the project or it will not function.
+
+Add it to Gemfile or use `gem install chauffeur`
+
+Initialize drivers in your project with
+```
+cmd > chauffeur init
+```
+This will create a directory in your project with a file config.yml and the folders to hold drivers.
+
+####driver_versions:
+takes no arguments and prints the installed versions for each browser.
+```
+cmd > chauffeur driver_versions
+    {"chromedriver"=>
+      {"linux32"=>"nil", "linux64"=>"nil", "mac32"=>"nil", "win32"=>"nil"},
+     "geckodriver"=>
+      {"linux32"=>"nil",
+       "linux64"=>"nil",
+       "macos"=>"nil",
+       "win32"=>"nil",
+       "win64"=>"nil"},
+     "iedriver"=>{"Win32"=>"nil", "x64"=>"nil"},
+     "microsoft_webdriver"=>{}}
+```
+###upgrade_driver:
+takes the browser name and system platform as arguments and installs the driver.
+        browser: chrome, firefox, ie, edge
+        platform:   chrome: [linux32, linux64, mac32, win32]
+                    firefox: [linux32, linux64, macos, win32, win64]
+                    ie: [Win32, x64]
+                    edge: build version number
+```
+cmd > chauffeur upgrade_driver ie Win32
+     installing 'http://selenium-release.storage.googleapis.com/3.8/IEDriverServer_Win32_3.8.0.zip' into 'C:/path/to/project/drivers/iedriver/Win32/'
+```
+###upgrade_driver_all_platforms:
+takes the browser name and installs most current driver for each platform
+        browser: chrome, firefox, ie, edge
+
+```
+cmd > chauffeur upgrade_driver_all_platforms chrome
+    installing 'http://chromedriver.storage.googleapis.com/2.33/chromedriver_linux32.zip' into 'C:/path/to/project/drivers/chromedriver/linux32/'
+    installing 'http://chromedriver.storage.googleapis.com/2.34/chromedriver_linux64.zip' into 'C:/path/to/project/drivers/chromedriver/linux64/'
+    installing 'http://chromedriver.storage.googleapis.com/2.22/chromedriver_mac32.zip' into 'C:/path/to/project/drivers/chromedriver/mac32/'
+    installing 'http://chromedriver.storage.googleapis.com/2.34/chromedriver_win32.zip' into 'C:/path/to/project/drivers/chromedriver/win32/'
+```
+
+###install_driver:
+takes browser, platform, and version and installs that driver.
+        browser: chrome, firefox, ie, edge
+        platform:   chrome: [linux32, linux64, mac32, win32]
+                    firefox: [linux32, linux64, macos, win32, win64]
+                    ie: [Win32, x64]
+                    edge: build version number
+        version: must match exactly the download version
+
+```
+cmd > chauffeur install_driver firefox linux64 0.18.0
+      installing 'https://github.com/mozilla/geckodriver/releases//download/v0.18.0/geckodriver-v0.18.0-linux64.tar.gz' into 'C:/path/to/project/drivers/geckodriver/linux64/'
+```
+
+###install_driver_all_platforms:
+takes browser name and version number and installs that version for all platforms.
+        browser: chrome, firefox, ie, edge
+        version: must match exactly the download version
+
+```
+cmd > chauffeur install_driver_all_platforms chrome 2.22
+    installing 'http://chromedriver.storage.googleapis.com/2.22/chromedriver_linux32.zip' into 'C:/path/to/project/drivers/chromedriver/linux32/'
+    installing 'http://chromedriver.storage.googleapis.com/2.22/chromedriver_linux64.zip' into 'C:/path/to/project/drivers/chromedriver/linux64/'
+    installing 'http://chromedriver.storage.googleapis.com/2.22/chromedriver_mac32.zip' into 'C:/path/to/project/drivers/chromedriver/mac32/'
+    installing 'http://chromedriver.storage.googleapis.com/2.22/chromedriver_win32.zip' into 'C:/path/to/project/drivers/chromedriver/win32/'
+```
+
+
+### Add drivers to path:
+
+In your project code use
+
+```
+require 'chauffeur'
+Chauffeur.add_drivers_to_path
+```
+
+

data/bin/chauffeur

@@ -0,0 +1,52 @@
+#!/usr/bin/env ruby
+
+require 'chauffeur'
+require 'pp'
+
+# puts "THE ARGUMENTS ARE: '#{ARGV}'"
+
+def all_options
+  %w[
+    driver_versions
+    init
+    upgrade_driver
+    upgrade_driver_all_platforms
+    install_driver
+    install_driver_all_platforms
+    help
+  ]
+end
+
+def browsers
+  %w[chrome firefox edge ie]
+end
+
+def browser_error(text)
+  Exception.new("Unknown browser'#{text}'. must be one of #{browsers}")
+end
+
+case ARGV[0]
+when 'driver_versions'
+  pp Chauffeur.driver_versions
+when 'init'
+  Chauffeur.initialize_chauffeur
+when 'upgrade_driver'
+  raise browser_error(ARGV[1]) unless browsers.include?(ARGV[1])
+  Chauffeur.upgrade_driver(ARGV[1], ARGV[2])
+when 'upgrade_driver_all_platforms'
+  raise browser_error(ARGV[1]) unless browsers.include?(ARGV[1])
+  Chauffeur.upgrade_driver_all_platforms(ARGV[1])
+when 'install_driver'
+  raise browser_error(ARGV[1]) unless browsers.include?(ARGV[1])
+  Chauffeur.install_driver(ARGV[1], ARGV[2], ARGV[3])
+when 'install_driver_all_platforms'
+  raise browser_error(ARGV[1]) unless browsers.include?(ARGV[1])
+  Chauffeur.install_driver_all_platforms(ARGV[1], ARGV[2])
+when 'help'
+  help_contents = File.read("#{File.dirname(__FILE__)}/../lib/chauffeur/help.txt")
+  puts help_contents
+else
+  help_contents = File.read("#{File.dirname(__FILE__)}/../lib/chauffeur/help.txt")
+  puts help_contents
+  raise "Unknown option '#{ARGV[0]}' must be one of #{all_options}."
+end

data/chauffeur.gemspec

@@ -0,0 +1,24 @@
+# Gemspec file for Chauffeur Gem
+require 'English'
+
+Gem::Specification.new do |s|
+  s.name = 'chauffeur'
+  s.version = '0.0.2'
+  s.date = '2017-10-23'
+  s.summary = 'summary'
+  s.description = 'Chauffeur is a tool to help manage drivers for automating browsers.'
+  s.authors = ['Jeremy Gardner']
+  s.email = 'jerrygar96@gmail.com'
+  s.files = `git ls-files`.split($ORS)
+  s.homepage = 'http://rubygems.org/gems/chauffeur'
+  s.license = 'MIT'
+  s.executables = %w[chauffeur]
+
+  s.add_development_dependency('pry', ['~> 0.11'])
+  s.add_development_dependency('rspec', ['~> 3.7'])
+  s.add_development_dependency('simplecov', ['~> 0.15'])
+
+  s.add_runtime_dependency('archive-zip', ['~> 0.10'])
+  s.add_runtime_dependency('httparty', ['~> 0.15'])
+  s.add_runtime_dependency('nokogiri', '~> 1.8')
+end

data/lib/chauffeur/config.yml

@@ -0,0 +1,30 @@
+---
+folders:
+- drivers/chromedriver/linux32
+- drivers/chromedriver/linux64
+- drivers/chromedriver/mac32
+- drivers/chromedriver/win32
+- drivers/edgedriver
+- drivers/geckodriver/linux32
+- drivers/geckodriver/linux64
+- drivers/geckodriver/macos
+- drivers/geckodriver/win32
+- drivers/geckodriver/win64
+- drivers/iedriver/Win32
+- drivers/iedriver/x64
+installed_versions:
+  chromedriver:
+    linux32: nil
+    linux64: nil
+    mac32: nil
+    win32: nil
+  geckodriver:
+    linux32: nil
+    linux64: nil
+    macos: nil
+    win32: nil
+    win64: nil
+  iedriver:
+    Win32: nil
+    x64: nil
+  microsoft_webdriver: {}

data/lib/chauffeur/downloaders/chromedriver_downloader.rb

@@ -0,0 +1,43 @@
+# ChromeDriver specific functions for driver downloading.
+class ChromedriverDownloader < DriverDownloader
+  CHROMEDRIVER_URL = 'http://chromedriver.storage.googleapis.com/'.freeze
+
+  def browser_name
+    'chromedriver'
+  end
+
+  def driver_url
+    CHROMEDRIVER_URL
+  end
+
+  def all_platforms
+    %w[linux32 linux64 mac32 win32]
+  end
+
+  # Returns the most recent version of chromedriver for the
+  # desired platform.
+  # platform must be one of: linux32, linux64, mac32, win32
+  def latest_driver_version(platform)
+    raise unknown_platform_error(platform) unless valid_platform?(platform)
+    platform_drivers = all_driver_versions.select { |v| v.include?(platform) }
+    platform_drivers.map { |v| version_of(v.split('/')[0]) }.max
+  end
+
+  # Returns all available versions of Chromedriver
+  def all_driver_versions
+    resp = HTTParty.get(CHROMEDRIVER_URL).parsed_response
+    resp['ListBucketResult']['Contents'].map { |c| c['Key'] }
+  end
+
+  # Returns the url for the desired version of chromedriver
+  # version: string - must match exactly the version in the download URL
+  # platform: string - must be one of: linux32, linux64, mac32, win32
+  def driver_download_url(version, platform)
+    raise unknown_platform_error(platform) unless valid_platform?(platform)
+    rel_path = all_driver_versions.find do |v|
+      v.eql?("#{version}/chromedriver_#{platform}.zip")
+    end
+    raise unknown_version_error(version) unless rel_path
+    "#{CHROMEDRIVER_URL}#{rel_path}"
+  end
+end

data/lib/chauffeur/downloaders/edgedriver_downloader.rb

@@ -0,0 +1,44 @@
+# FireFoxDriver specific functions for driver downloading.
+class EdgedriverDownloader < DriverDownloader
+  EDGEDRIVER_URL = 'https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/'.freeze
+
+  def browser_name
+    'microsoft_webdriver'
+  end
+
+  def driver_url
+    EDGEDRIVER_URL
+  end
+
+  def all_platforms
+    %w[win]
+  end
+
+  # Returns the most recent version of edgedriver for the
+  # desired platform.
+  # platform must be one of: win
+  def latest_driver_version(platform)
+    raise unknown_platform_error(platform) unless valid_platform?(platform)
+    versions = all_driver_versions
+    versions.keys.sort.reverse.find { |k| k =~ /^\d+$/ }
+  end
+
+  # Returns all available versions of geckodriver
+  def all_driver_versions
+    resp = HTTParty.get(driver_url, verify: false).parsed_response
+    doc = Nokogiri::XML.parse(resp)
+    output = {}
+    doc.css('li.driver-download a.subtitle').each do |a|
+      output[a.text.gsub('Release ', '')] = a[:href]
+    end
+    output
+  end
+
+  # Returns the url for the desired version of geckodriver
+  # version: string - must match exactly the version in the download URL
+  # platform: string - must be win
+  def driver_download_url(version, platform)
+    raise unknown_platform_error(platform) unless valid_platform?(platform)
+    all_driver_versions[version] || raise(unknown_version_error(version))
+  end
+end

data/lib/chauffeur/downloaders/firefoxdriver_downloader.rb

@@ -0,0 +1,42 @@
+# FireFoxDriver specific functions for driver downloading.
+class FirefoxdriverDownloader < DriverDownloader
+  GECKODRIVER_URL = 'https://github.com/mozilla/geckodriver/releases/'.freeze
+
+  def browser_name
+    'geckodriver'
+  end
+
+  def driver_url
+    GECKODRIVER_URL
+  end
+
+  def all_platforms
+    %w[linux32 linux64 macos win32 win64]
+  end
+
+  # Returns the most recent version of geckodriver for the
+  # desired platform.
+  # platform must be one of: linux32, linux64, mac32, win32
+  def latest_driver_version(platform)
+    raise unknown_platform_error(platform) unless valid_platform?(platform)
+    all_driver_versions.map { |v| Gem::Version.new(v.delete('v')) }.max
+  end
+
+  # Returns all available versions of geckodriver
+  def all_driver_versions
+    resp = HTTParty.get(GECKODRIVER_URL, verify: false).parsed_response
+    doc = Nokogiri::XML.parse(resp)
+    doc.css('div.release h1.release-title a').map(&:text)
+  end
+
+  # Returns the url for the desired version of geckodriver
+  # version: string - must match exactly the version in the download URL
+  # platform: string - must be one of: linux32, linux64, mac32, win32
+  def driver_download_url(version, platform)
+    raise unknown_platform_error(platform) unless valid_platform?(platform)
+    raise unknown_version_error(version) unless all_driver_versions.include?("v#{version}")
+    extension = platform.start_with?('win') ? 'zip' : 'tar.gz'
+    rel_path = "/download/v#{version}/geckodriver-v#{version}-#{platform}.#{extension}"
+    "#{GECKODRIVER_URL}#{rel_path}"
+  end
+end

data/lib/chauffeur/downloaders/iedriver_downloader.rb

@@ -0,0 +1,44 @@
+# IEDriver specific functions for driver downloading.
+class IedriverDownloader < DriverDownloader
+  IEDRIVER_URL = 'http://selenium-release.storage.googleapis.com/'.freeze
+
+  def browser_name
+    'iedriver'
+  end
+
+  def driver_url
+    IEDRIVER_URL
+  end
+
+  def all_platforms
+    %w[Win32 x64]
+  end
+
+  # Returns the most recent version of iedriver for the
+  # desired platform.
+  # platform must be one of: linux32, linux64, mac32, win32
+  def latest_driver_version(platform)
+    raise unknown_platform_error(platform) unless valid_platform?(platform)
+    platform_drivers = all_driver_versions.select { |v| v.include?(platform) }
+    platform_drivers.map { |v| version_of(v.split('/')[0]) }.max
+  end
+
+  # Returns all available versions of iedriver
+  def all_driver_versions
+    resp = HTTParty.get(IEDRIVER_URL).parsed_response
+    contents = resp['ListBucketResult']['Contents']
+    contents.map { |c| c['Key'] }.select { |url| url.include?('IEDriverServer') }
+  end
+
+  # Returns the url for the desired version of iedriver
+  # version: string - must match exactly the version in the download URL
+  # platform: string - must be one of: linux32, linux64, mac32, win32
+  def driver_download_url(version, platform)
+    raise unknown_platform_error(platform) unless valid_platform?(platform)
+    rel_path = all_driver_versions.find do |v|
+      v =~ %r{#{version}/IEDriverServer_#{platform}_#{version}\.\d+\.zip}
+    end
+    raise unknown_version_error(version) unless rel_path
+    "#{IEDRIVER_URL}#{rel_path}"
+  end
+end

data/lib/chauffeur/driver_downloader.rb

@@ -0,0 +1,177 @@
+# Downloads and installs browser drivers.
+class DriverDownloader
+  require 'zlib'
+
+  def initialize
+    config_file_path = "#{Dir.pwd}/drivers/config.yml"
+    @data = File.open(config_file_path) { |f| YAML.safe_load(f) }
+    @installed_versions = @data['installed_versions']
+  end
+
+  # This must be implemented in all child classes!
+  #
+  # Returns a string for the driver name in file structure.
+  def browser_name
+    raise 'This class should not be initialized! Please use subclass.'
+  end
+
+  # This must be implemented in all child classes!
+  #
+  # returns the string url where all downloads can be located.
+  def driver_url
+    raise 'This class should not be initialized! Please use subclass.'
+  end
+
+  # This must be implemented in all child classes!
+  #
+  # returns an array of all available platforms for the driver.
+  def all_platforms
+    raise 'This class should not be initialized! Please use subclass.'
+  end
+
+  # This must be implemented in all child classes!
+  #
+  # Returns the most recent version of chromedriver for the
+  # desired platform.
+  # platform must be one of: linux32, linux64, mac32, win32
+  def latest_driver_version(_platform)
+    raise 'This class should not be initialized! Please use subclass.'
+  end
+
+  # Returns all available versions of Chromedriver
+  def all_driver_versions
+    raise 'This class should not be initialized! Please use subclass.'
+  end
+
+  # This must be implemented in all child classes!
+  #
+  # Returns the url for the desired version of driver
+  # version: string - must match exactly the version in the download URL
+  # platform: string - must be in all_platforms
+  def driver_download_url(_version, _platform)
+    raise 'This class should not be initialized! Please use subclass.'
+  end
+
+  # Returns the destination folder for the browser driver for the
+  # desired platform.
+  #   platform: string  - must match the appropriate platform for
+  #                       the particular driver
+  def path_for(platform, version)
+    raise unknown_platform_error(platform) unless valid_platform?(platform)
+    last_part = instance_of?(EdgedriverDownloader) ? version : platform
+    "#{Dir.pwd}/drivers/#{browser_name}/#{last_part}/"
+  end
+
+  # Downloads and installs driver
+  #   version: string   - the exact version number for the download
+  #   platform: string  - must match the appropriate platform for
+  #                       the particular driver
+  def install_driver(version, platform)
+    raise unknown_platform_error(platform) unless valid_platform?(platform)
+    if @installed_versions[browser_name][platform].eql?(version.to_s)
+      puts "Driver version #{version} already installed for #{platform}"
+      return
+    end
+    driver_path = path_for(platform, version)
+    download_url = driver_download_url(version, platform)
+
+    puts "installing '#{download_url}' into '#{driver_path}'"
+
+    download_and_unzip(driver_path, download_url)
+    update_browser_version(platform, version)
+  end
+
+  # Installs the latest version of chromedriver for the specified platform.
+  #   platform: string  - must match the appropriate platform for
+  #                       the particular driver
+  def upgrade_driver(platform)
+    raise unknown_platform_error(platform) unless valid_platform?(platform)
+    latest_version = latest_driver_version(platform)
+    install_driver(latest_version, platform)
+  end
+
+  # Installs the latest version of chromedriver for all platforms.
+  def upgrade_driver_all_platforms
+    all_platforms.each do |platform|
+      upgrade_driver(platform)
+    end
+  end
+
+  # Installs the specified version of specified driver for all platforms.
+  def install_driver_all_platforms(version)
+    all_platforms.each do |platform|
+      install_driver(version, platform)
+    end
+  end
+
+  # Downloads and installs driver to appropriate path
+  #   driver_path: string - path to install driver (must end with '/')
+  #   download_url: string - URL of the driver desired
+  def download_and_unzip(driver_path, download_url)
+    FileUtils.mkdir_p(driver_path)
+    destination_file_name = "#{driver_path}#{File.basename(download_url)}"
+    FileUtils.rm_f destination_file_name
+    File.open(destination_file_name, 'wb') do |saved_file|
+      saved_file.write(HTTParty.get(download_url, verify: false).parsed_response)
+    end
+    raise "Could not download #{download_url}" unless File.exist?(destination_file_name)
+    extract_and_delete(destination_file_name, driver_path) unless instance_of?(EdgedriverDownloader)
+    FileUtils.rm_f "#{destination_file_name}.zip"
+  end
+
+  private
+
+  # Gem::Version lets versions get compared in a way that makes sense for
+  # semantic versions. For example it makes 2.38 greater than 2.5
+  def version_of(num_str)
+    Gem::Version.new(num_str)
+  end
+
+  # Updates the hash of the installed versions and then saves the Yaml file
+  def update_browser_version(platform, version)
+    @installed_versions[browser_name][platform] = version.to_s
+    save_data
+  end
+
+  # Saves @data to config.yml file
+  def save_data
+    File.open("#{Dir.pwd}/drivers/config.yml", 'w') { |f| f.write(@data.to_yaml) }
+  end
+
+  # Checks to see if the passed in platform is valid for the particular browser
+  #
+  # Requires all_platforms to be defined in the instantiated class.
+  def valid_platform?(platform)
+    all_platforms.include?(platform)
+  end
+
+  # Returns instance of an UnknownPlatform Error to be thrown
+  #
+  # Requires all_platforms to be defined in the instantiated class.
+  def unknown_platform_error(platform)
+    msg = "Unknown platform #{platform}, valid options: #{all_platforms}."
+    raise UnknownPlatformError.new(platform, msg)
+  end
+
+  def unknown_version_error(version)
+    msg = "Unknown version '#{version}', valid options: #{all_driver_versions}."
+    raise UnknownVersionError.new(version, msg)
+  end
+
+  # Extracts a file and deletes the compressed file
+  #
+  # destination_file_name: string - full file path to the compressed file.
+  # driver_path: string - the full path to the destination folder.
+  def extract_and_delete(destination_file_name, driver_path)
+    if destination_file_name.end_with?('.tar.gz')
+      File.open(destination_file_name, 'rb') do |f|
+        gz = Zlib::GzipReader.new(f)
+        File.open("#{driver_path}geckodriver", 'wb', 0o0755) { |new_file| new_file.puts(gz.read) }
+      end
+    else
+      Archive::Zip.extract(destination_file_name, driver_path, overwrite: :all)
+    end
+    files_to_delete = Dir.glob("#{driver_path}*.{zip,gz}")
+    FileUtils.rm_rf(files_to_delete) if files_to_delete.size.eql?(1)
+  end
+end