webdriver_manager 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e4aeaf20ec28b501c430be20216b74c11220a8df
-  data.tar.gz: ae1628a32666ca6b9c2155b53818fdbc73016a67
+  metadata.gz: 3f0a5567c780cf6ec15dea2f8e3be9008bebe93f
+  data.tar.gz: a031045d7ec8bbebc1e569ddcd446187963e3742
 SHA512:
-  metadata.gz: 42bae2ba53f1dd8091247960fbaa27b6251bd924ba71eed039c2ef0c3317a4b59fc6924a14e0127cac5a3332b2d79b18c83b30c0004a571d81acfc5d3aa01cdf
-  data.tar.gz: c4b610941b9aae489bcd407bf13698b7c91b949fad88db68b555bd0219de9ac1513eee29fbaea90784cb129647f85153fea5afa5503935ac74429b4c2e05569c
+  metadata.gz: 3e3e053298e1452ec0abfd6829e8ed463d62257011790dac7e720e4bcb186f6da903eae4818e9f088beb4139fc092a95a6a8e51abeba04a61100145479e993dd
+  data.tar.gz: 9e695c5889e5d398a91a4650ee54e2fc0b9ee803bc2d7f342bf4ca67b71d28beb2d9ec443f32e592d75e4eb92ad077c6add039af9bc021d84847350816a4f3c3

data/.gitignore

@@ -17,6 +17,7 @@
 *.swp
 *.bak
 .rspec_status
+webdriver_manager.log
 
 # IDE-Specific
 

data/.hound.yml

@@ -60,3 +60,8 @@ Metrics/MethodLength:
 # Encourage fewer parameters.
 Metrics/ParameterLists:
   Max: 4
+
+# Additions for WebDriver Manager
+
+Metrics/ModuleLength:
+  Max: 135

data/README.md

@@ -1,5 +1,10 @@
 # WebDriver Manager
 
+[![Gem Version](https://badge.fury.io/rb/webdriver_manager.svg)](http://badge.fury.io/rb/webdriver_manager)
+[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jeffnyman/webdriver_manager/blob/master/LICENSE.txt)
+
+[![Dependency Status](https://gemnasium.com/jeffnyman/webdriver_manager.png)](https://gemnasium.com/jeffnyman/webdriver_manager)
+
 The goal of WebDriver Manager is to allow automated testing solutions an ability to have WebDriver binary drivers downloaded automatically.
 
 ## Installation
@@ -20,7 +25,51 @@ You can also install WebDriver Manager just as you would any other gem:
 
 ## Usage
 
-Instructions coming soon.
+### Basic Usage
+
+Here is an example script:
+
+```ruby
+require "webdriver_manager"
+require "watir"
+
+browser = Watir::Browser.new :firefox
+
+browser.quit()
+```
+
+All you have to do is include `webdriver_manager`. Once it's included, the gem provides hooks into the operation of Selenium WebDriver. When Watir, in this case, is used to instantiate a new Firefox browser, this gem kicks in and makes sure that `geckodriver` (or `geckodriver.exe` on Windows) is available. If the driver binary is not available, it will be downloaded for you.
+
+All driver binaries are placed in a `.webdrivers` directory within the relevant directory referred to by the `HOME` environment variable for your operating system.
+
+### Browser Drivers Supported
+
+Currently WebDriver Manager supports only Chrome (chromedriver) and Firefox (geckodriver). I will be adding support for other browsers, such as Internet Explorer and Microsoft Edge, once I'm certain I have a fully reliable means of getting the drivers.
+
+### Logging
+
+You can enable logging with WebDriver Manager with a command like this:
+
+```ruby
+WebDriverManager.logger.level = :debug
+```
+
+There are debug statements in the code base that will show you what's happening as WebDriver Manager operates. But you are free to add your own messages as well. For example, you could set the logging level to `info` and then add your own messages:
+
+```ruby
+WebDriverManager.logger.level = :info
+WebDriverManager.logger.info("Some Information")
+```
+
+You can also set the logging output to a file:
+
+```ruby
+WebDriverManager.logger.output = 'webdriver_manager.log'
+```
+
+### How It Works
+
+WebDriver Manager works by providing an additional implementation to the `@driver_path` variable that Selenium uses when establishing an instance of a driver. For example, the [Chrome](https://github.com/SeleniumHQ/selenium/blob/master/rb/lib/selenium/webdriver/chrome.rb) implementation simply takes in a path for the driver. This gem overrides that with its own specific functionality for providing a standard path and making sure the relevant binaries are on that path and downloading them if not.
 
 ## Development
 

data/lib/webdriver_manager.rb

@@ -1,4 +1,11 @@
 require "webdriver_manager/version"
+require "webdriver_manager/logger"
+require "webdriver_manager/selenium"
 
 module WebDriverManager
+  class << self
+    def logger
+      @logger ||= WebDriverManager::Logger.new
+    end
+  end
 end

data/lib/webdriver_manager/drivers/driver_chrome.rb

@@ -0,0 +1,64 @@
+require "nokogiri"
+
+module WebDriverManager
+  class ChromeDriver
+    extend Support
+
+    class << self
+      def current_binary
+        WebDriverManager.logger.debug("Checking Current Driver Version")
+        return nil unless driver_is_downloaded?
+        binary_version = `#{driver_binary} --version`
+        WebDriverManager.logger.debug(
+          "Current version of #{driver_binary} is #{binary_version}"
+        )
+        normalize(binary_version.match(/ChromeDriver (\d\.\d+)/)[1])
+      end
+
+      def driver_name
+        os_platform == "win" ? "chromedriver.exe" : "chromedriver"
+      end
+
+      def driver_base_url
+        "http://chromedriver.storage.googleapis.com"
+      end
+
+      def driver_binary_list
+        unless driver_url_is_reachable?
+          raise StandardError, "Unable to Access the Driver URL"
+        end
+
+        @binaries ||= begin
+          files = process_binary_files
+          process_binary_versions(files)
+        end
+      end
+
+      def process_binary_files
+        resource = Nokogiri::XML.parse(get(driver_base_url))
+        files = resource.css("Contents Key").collect(&:text)
+        files.select! { |file| file.include?(os_platform) }
+      end
+
+      def process_binary_versions(files)
+        binary_list = files.each_with_object({}) do |file, binary|
+          version = normalize(file[%r{^[^\/]+}])
+          binary[version] = "#{driver_base_url}/#{file}"
+        end
+
+        WebDriverManager.logger.debug(
+          "Versions Located at Driver URL: #{binary_list.keys}"
+        )
+
+        binary_list
+      end
+
+      # This method makes sure that versions are stored with the same
+      # style. For example, 2.10 will be stored exactly as that. But 2.9
+      # will be stored as 2.09.
+      def normalize(string)
+        string.size == 3 ? string.gsub('.', '.0').to_f : string.to_f
+      end
+    end
+  end
+end

data/lib/webdriver_manager/drivers/driver_gecko.rb

@@ -0,0 +1,65 @@
+require "nokogiri"
+
+module WebDriverManager
+  class GeckoDriver
+    extend Support
+
+    class << self
+      def current_binary
+        WebDriverManager.logger.debug("Checking Current Driver Version")
+        return nil unless driver_is_downloaded?
+        binary_version = `#{driver_binary} --version`
+        WebDriverManager.logger.debug(
+          "Current version of #{driver_binary} is #{binary_version}"
+        )
+        normalize(binary_version.match(/geckodriver (\d+\.\d+\.\d+)/)[1])
+      end
+
+      def driver_name
+        os_platform == "win" ? "geckodriver.exe" : "geckodriver"
+      end
+
+      def driver_base_url
+        "https://github.com/mozilla/geckodriver/releases"
+      end
+
+      def driver_binary_list
+        unless driver_url_is_reachable?
+          raise StandardError, "Unable to Access the Driver URL"
+        end
+
+        @binaries ||= begin
+          files = process_binary_files
+          process_binary_versions(files)
+        end
+      end
+
+      def process_binary_files
+        resource = Nokogiri::XML.parse(get(driver_base_url))
+        files = resource.css(".release-downloads a")
+                        .collect { |file| file["href"] }
+        files.reject! { |file| file.include?('archive') }
+        files.select! { |file| file.include?(os_platform) }
+      end
+
+      def process_binary_versions(files)
+        binary_list = files.each_with_object({}) do |file, binary|
+          version = normalize(file[/v(\d+\.\d+\.\d+)/, 1])
+          binary[version] = "https://github.com#{file}"
+        end
+
+        WebDriverManager.logger.debug(
+          "Versions Located at Driver URL: #{binary_list.keys}"
+        )
+
+        binary_list
+      end
+
+      def normalize(string)
+        string.match(/(\d+)\.(\d+\.\d+)/)
+              .to_a
+              .map { |v| v.tr('.', '') }[1..-1].join('.').to_f
+      end
+    end
+  end
+end

data/lib/webdriver_manager/logger.rb

@@ -0,0 +1,54 @@
+require "forwardable"
+require "logger"
+
+module WebDriverManager
+  class Logger
+    extend Forwardable
+    include ::Logger::Severity
+
+    def_delegators :@logger,
+      :debug, :debug?,
+      :info, :info?,
+      :warn, :warn?,
+      :error, :error?,
+      :fatal, :fatal?,
+      :level
+
+    def initialize
+      @logger = create_logger($stdout)
+    end
+
+    def level=(severity)
+      case severity.to_s.downcase
+        when 'debug'.freeze then @logger.level = DEBUG
+        when 'info'.freeze then @logger.level = INFO
+        when 'warn'.freeze then @logger.level = WARN
+        when 'error'.freeze then @logger.level = ERROR
+        else
+          raise ArgumentError, "invalid log level: #{severity}"
+      end
+    end
+
+    def output=(io)
+      if @logger.respond_to?(:reopen)
+        @logger.reopen(io)
+      else
+        @logger = create_logger(io)
+      end
+    end
+
+    private
+
+    def create_logger(output)
+      logger = ::Logger.new(output)
+      logger.progname = 'WebDriver Manager'
+      logger.level = ($DEBUG ? DEBUG : WARN)
+
+      logger.formatter = proc do |severity, time, progname, msg|
+        "#{time.strftime('%F %T')} #{severity} #{progname} #{msg}\n"
+      end
+
+      logger
+    end
+  end
+end

data/lib/webdriver_manager/selenium.rb

@@ -0,0 +1,21 @@
+require "selenium-webdriver"
+
+require "webdriver_manager/support"
+require "webdriver_manager/drivers/driver_chrome"
+require "webdriver_manager/drivers/driver_gecko"
+
+module Selenium
+  module WebDriver
+    module Chrome
+      def self.driver_path
+        @driver_path ||= WebDriverManager::ChromeDriver.provision
+      end
+    end
+
+    module Firefox
+      def self.driver_path
+        @driver_path ||= WebDriverManager::GeckoDriver.provision
+      end
+    end
+  end
+end

data/lib/webdriver_manager/support.rb

@@ -0,0 +1,166 @@
+module WebDriverManager
+  module Support
+    def provision
+      unless driver_url_is_reachable?
+        return current_binary.nil? ? nil : driver_binary
+      end
+
+      return driver_binary if current_binary == latest_binary
+
+      remove_binary && provision_driver
+    end
+
+    def provision_driver(version = nil)
+      url, filename = driver_filename(version)
+      Dir.mkdir(driver_repo) unless File.exist?(driver_repo)
+
+      Dir.chdir(driver_repo) do
+        download_driver(filename, url)
+        decompress_driver(filename)
+      end
+
+      set_driver_permissions
+      driver_binary
+    end
+
+    def remove_binary
+      WebDriverManager.logger.debug("Deleting #{driver_binary}")
+      FileUtils.rm_f(driver_binary)
+    end
+
+    def latest_binary
+      driver_binary_list.keys.sort.last
+    end
+
+    protected
+
+    def get(url)
+      response = Net::HTTP.get_response(URI(url))
+
+      case response
+        when Net::HTTPSuccess then response.body
+        when Net::HTTPRedirection
+          location = response['location']
+          WebDriverManager.logger.debug("Redirected to #{location}")
+          get(location)
+      end
+    end
+
+    private
+
+    def download_driver(filename, url)
+      FileUtils.rm_f(filename)
+
+      open(filename, "wb") do |file|
+        file.print(get(url))
+      end
+
+      raise "Unable to download #{url}" unless File.exist?(filename)
+      WebDriverManager.logger.debug("Successfully downloaded #{filename}")
+    end
+
+    def decompress_driver(filename)
+      dcf = decompress_file(filename)
+      WebDriverManager.logger.debug("Decompression Complete")
+
+      if dcf
+        WebDriverManager.logger.debug("Deleting #{filename}")
+        FileUtils.rm_f(filename)
+      end
+
+      return if File.exist?(driver_binary)
+      raise "Unable to decompress #{filename} to get #{driver_binary}"
+    end
+
+    def decompress_file(filename)
+      case filename
+        when /tar\.gz$/
+          WebDriverManager.logger.debug("Decompressing tar")
+          untargz_file(filename)
+        when /\.zip$/
+          WebDriverManager.logger.debug("Decompressing zip")
+          unzip_file(filename)
+      end
+    end
+
+    def unzip_file(filename)
+      require "zip"
+      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)
+
+          remove_binary
+
+          zip_file.extract(f, f_path)
+        end
+      end
+      @top_path
+    end
+
+    def untargz_file(filename)
+      require "rubygems/package"
+      tar_extract = Gem::Package::TarReader.new(Zlib::GzipReader.open(filename))
+      file = File.open(driver_name, "w+b")
+      tar_extract.each { |entry| file << entry.read }
+      file.close
+      File.basename(file)
+    end
+
+    def set_driver_permissions
+      FileUtils.chmod("ugo+rx", driver_binary)
+      WebDriverManager.logger.debug(
+        "Completed download and processing of #{driver_binary}"
+      )
+    end
+
+    def driver_filename(version)
+      url = driver_download_url(version)
+      filename = File.basename(url)
+      [url, filename]
+    end
+
+    def driver_url_is_reachable?
+      get(driver_base_url)
+      WebDriverManager.logger.debug("Driver URL Available: #{driver_base_url}")
+      true
+    rescue StandardError
+      WebDriverManager.logger.debug(
+        "Driver URL Not Available: #{driver_base_url}"
+      )
+      false
+    end
+
+    def driver_is_downloaded?
+      result = File.exist?(driver_binary)
+      WebDriverManager.logger.debug("Driver Already Downloaded: #{result}")
+      result
+    end
+
+    def driver_download_url(version)
+      driver_binary_list[version || latest_binary]
+    end
+
+    def driver_binary
+      File.join(driver_repo, driver_name)
+    end
+
+    def driver_repo
+      File.expand_path(File.join(ENV['HOME'], ".webdrivers")).tap do |dir|
+        FileUtils.mkdir_p(dir)
+      end
+    end
+
+    def os_platform
+      cfg = RbConfig::CONFIG
+      case cfg['host_os']
+        when /linux/
+          cfg['host_cpu'] =~ /x86_64|amd64/ ? "linux64" : "linux32"
+        when /darwin/
+          "mac"
+        else
+          "win"
+      end
+    end
+  end
+end

data/lib/webdriver_manager/version.rb

@@ -1,3 +1,3 @@
 module WebDriverManager
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
 end

data/webdriver_manager.gemspec

@@ -27,6 +27,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "pry"
 
+  spec.add_runtime_dependency "selenium-webdriver", "~> 3.0"
+  spec.add_runtime_dependency "nokogiri", "~> 1.8"
+
   spec.post_install_message = %{
 (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)
   WebDriver Manager #{WebDriverManager::VERSION} has been installed.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webdriver_manager
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jeff Nyman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-06 00:00:00.000000000 Z
+date: 2017-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
 description: Provides a method of automatically downloading WebDriver binaries.
 email:
 - jeffnyman@gmail.com
@@ -100,6 +128,11 @@ files:
 - bin/console
 - bin/setup
 - lib/webdriver_manager.rb
+- lib/webdriver_manager/drivers/driver_chrome.rb
+- lib/webdriver_manager/drivers/driver_gecko.rb
+- lib/webdriver_manager/logger.rb
+- lib/webdriver_manager/selenium.rb
+- lib/webdriver_manager/support.rb
 - lib/webdriver_manager/version.rb
 - webdriver_manager.gemspec
 homepage: https://github.com/jeffnyman/webdriver_manager
@@ -107,7 +140,7 @@ licenses:
 - MIT
 metadata: {}
 post_install_message: "\n(::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::) (::)\n
-  \ WebDriver Manager 0.1.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::)
+  \ WebDriver Manager 0.2.0 has been installed.\n(::) (::) (::) (::) (::) (::) (::)
   (::) (::) (::) (::) (::)\n  "
 rdoc_options: []
 require_paths:
@@ -124,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Provides a method of automatically downloading WebDriver binaries.