webdrivers 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e32a6aea7b04e41ab9bc26885196189a0a09abed
-  data.tar.gz: '0493cc2da6b73a8a73ca389ef10e5d5e6748f551'
+  metadata.gz: f3e2cdd947c31a0a97e4679da3b987d008a240c1
+  data.tar.gz: 40cb38781d815e54008e917667ea22de595fc755
 SHA512:
-  metadata.gz: 9d940d9c3ac8af8ae23d1ce6dda7a571a2841d98f854e8b393e6daa2f4c0c6e35728d54d297acb88a32de8085fbb2946ec6bb94a045a458e0d614a9f720bd9f6
-  data.tar.gz: f86a5a08083cc2b955eead1a0c2a3b5b38a106f613b228ef46f2cacf85edde389f4a54fdefa30efe06a34bf438a933d0a125db7643dd8e031888396d34bc5249
+  metadata.gz: d73bd319ce124e487211a5150406c219e2572b2cf6eb9e836492c81e9d7270a7324d0d04b7e6a924499e8610ce87a5476c155df410635749916c916637d92e63
+  data.tar.gz: f83caf1cecc3f29b55c84f20edcc53115327d1e6197d52f5159cd8b3a0bf8eee42f7d897635a382bfff5fdf190669fd49a9c94ad6469c61a8055325beea2d7a0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+### 3.1.0 (2017-08-21)
+
+* Implemented Logging functionality 
+
 ### 3.0.1 (2017-08-18)
 
 * Create ~/.webdrivers directory if doesn't already exist 

data/lib/webdrivers.rb

@@ -1,6 +1,13 @@
 require "webdrivers/selenium"
+require "webdrivers/logger"
 require "webdrivers/common"
 require "webdrivers/chromedriver"
 require "webdrivers/geckodriver"
 require "webdrivers/iedriver"
 require "webdrivers/mswebdriver"
+
+module Webdrivers
+  def self.logger
+    @logger ||= Webdrivers::Logger.new
+  end
+end

data/lib/webdrivers/chromedriver.rb

@@ -7,10 +7,10 @@ module Webdrivers
     class << self
 
       def current
+        Webdrivers.logger.debug "Checking current version"
         return nil unless downloaded?
-        puts binary
         string = %x(#{binary} --version)
-        puts string
+        Webdrivers.logger.debug "Current version of #{binary} is #{string}"
         normalize string.match(/ChromeDriver (\d\.\d+)/)[1]
       end
 
@@ -29,16 +29,19 @@ module Webdrivers
       end
 
       def downloads
-        raise StandardError, "Can not reach site" unless site_available?
+        raise StandardError, "Can not download from website" unless site_available?
+        Webdrivers.logger.debug "Versions previously located on downloads site: #{@downloads.keys}" if @downloads
 
         @downloads ||= begin
           doc = Nokogiri::XML.parse(OpenURI.open_uri(base_url))
           items = doc.css("Contents Key").collect(&:text)
           items.select! {|item| item.include?(platform)}
-          items.each_with_object({}) do |item, hash|
+          ds = items.each_with_object({}) do |item, hash|
             key = normalize item[/^[^\/]+/]
             hash[key] = "#{base_url}/#{item}"
           end
+          Webdrivers.logger.debug "Versions now located on downloads site: #{ds.keys}"
+          ds
         end
       end
 

data/lib/webdrivers/common.rb

@@ -19,6 +19,7 @@ module Webdrivers
       end
 
       def remove
+        Webdrivers.logger.debug "Deleting #{binary}"
         FileUtils.rm_f binary
       end
 
@@ -35,12 +36,21 @@ module Webdrivers
             end
           end
           raise "Could not download #{url}" unless File.exists? filename
+          Webdrivers.logger.debug "Successfully downloaded #{filename}"
           dcf = decompress_file(filename)
-          FileUtils.rm_f filename if dcf
-          extract_file(dcf) if respond_to? :extract_file
+          Webdrivers.logger.debug "Decompression Complete"
+          if dcf
+            Webdrivers.logger.debug "Deleting #{filename}"
+            FileUtils.rm_f filename
+          end
+          if respond_to? :extract_file
+            Webdrivers.logger.debug "Extracting #{dcf}"
+            extract_file(dcf)
+          end
         end
-        raise "Could not unzip #{filename} to get #{binary}" unless File.exists?(binary)
+        raise "Could not decompress #{filename} to get #{binary}" unless File.exists?(binary)
         FileUtils.chmod "ugo+rx", binary
+        Webdrivers.logger.debug "Completed download and processing of #{binary}"
         binary
       end
 
@@ -51,17 +61,22 @@ module Webdrivers
       end
 
       def downloaded?
-        File.exist? binary
+        result = File.exist? binary
+        Webdrivers.logger.debug "File is already downloaded: #{result}"
+        result
       end
 
       def binary
         File.join install_dir, file_name
       end
 
+      # TODO - specify what gets rescued
       def site_available?
-        true if open(base_url)
+        open(base_url)
+        Webdrivers.logger.debug "Found Site: #{base_url}"
+        true
       rescue
-        Webdrivers.logger.info "Site Not Available: #{base_url}"
+        Webdrivers.logger.debug "Site Not Available: #{base_url}"
         false
       end
 
@@ -80,12 +95,18 @@ 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
         end
       end
 

data/lib/webdrivers/geckodriver.rb

@@ -6,29 +6,34 @@ module Webdrivers
     class << self
 
       def current
+        Webdrivers.logger.debug "Checking current version"
         return nil unless downloaded?
-        puts binary
         string = %x(#{binary} --version)
-        puts string
+        Webdrivers.logger.debug "Current version of #{binary} is #{string}"
         normalize string.match(/geckodriver (\d+\.\d+\.\d+)/)[1]
       end
 
       private
 
       def normalize(string)
-        string.match(/(\d+)\.(\d+\.\d+)/).to_a.map {|v| v.tr('.', '') }[1..-1].join('.').to_f
+        string.match(/(\d+)\.(\d+\.\d+)/).to_a.map {|v| v.tr('.', '')}[1..-1].join('.').to_f
       end
 
       def downloads
         raise StandardError, "Can not reach site" unless site_available?
-
-        doc = Nokogiri::XML.parse(OpenURI.open_uri(base_url))
-        items = doc.css(".release-downloads a").collect {|item| item["href"]}
-        items.reject! {|item| item.include?('archive')}
-        items.select! {|item| item.include?(platform)}
-        items.each_with_object({}) do |item, hash|
-          key = normalize item[/v(\d+\.\d+\.\d+)/, 1]
-          hash[key] = "https://github.com#{item}"
+        Webdrivers.logger.debug "Versions previously located on downloads site: #{@downloads.keys}" if @downloads
+
+        @downloads ||= begin
+          doc = Nokogiri::XML.parse(OpenURI.open_uri(base_url))
+          items = doc.css(".release-downloads a").collect {|item| item["href"]}
+          items.reject! {|item| item.include?('archive')}
+          items.select! {|item| item.include?(platform)}
+          ds = items.each_with_object({}) do |item, hash|
+            key = normalize item[/v(\d+\.\d+\.\d+)/, 1]
+            hash[key] = "https://github.com#{item}"
+          end
+          Webdrivers.logger.debug "Versions now located on downloads site: #{ds.keys}"
+          ds
         end
       end
 

data/lib/webdrivers/iedriver.rb

@@ -6,10 +6,10 @@ module Webdrivers
     class << self
 
       def current
+        Webdrivers.logger.debug "Checking current version"
         return nil unless downloaded?
-        puts binary
         string = %x(#{binary} --version)
-        puts string
+        Webdrivers.logger.debug "Current version of #{binary} is #{string}"
         normalize string.match(/IEDriverServer.exe (\d\.\d+\.\d*\.\d*)/)[1]
       end
 
@@ -29,15 +29,18 @@ module Webdrivers
 
       def downloads
         raise StandardError, "Can not reach site" unless site_available?
+        Webdrivers.logger.debug "Versions previously located on downloads site: #{@downloads.keys}" if @downloads
 
         @downloads ||= begin
           doc = Nokogiri::XML.parse(OpenURI.open_uri(base_url))
           items = doc.css("Key").collect(&:text)
           items.select! { |item| item.include?('IEDriverServer_Win32') }
-          items.each_with_object({}) do |item, hash|
+          ds = items.each_with_object({}) do |item, hash|
             key = normalize item[/^[^\/]+/]
             hash[key] = "#{base_url}#{item}"
           end
+          Webdrivers.logger.debug "Versions now located on downloads site: #{ds.keys}"
+          ds
         end
       end
 

data/lib/webdrivers/logger.rb

@@ -0,0 +1,109 @@
+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
+  #   Webdrivers.logger.level = :debug
+  #
+  # @example Log to file
+  #   Webdrivers.logger.output = 'webdrivers.log'
+  #
+  # @example Use logger manually
+  #   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
+
+    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'.freeze
+          @logger.level = DEBUG
+        when 'info'.freeze
+          @logger.level = INFO
+        when 'warn'.freeze
+          @logger.level = WARN
+        when 'error'.freeze
+          @logger.level = ERROR
+        when 'fatal'.freeze
+          @logger.level = FATAL
+        when 'unknown'.freeze
+          @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
+    end
+  end
+end

data/lib/webdrivers/mswebdriver.rb

@@ -6,7 +6,9 @@ module Webdrivers
     class << self
 
       def current
+        Webdrivers.logger.debug "Checking current version"
         version = %x(ver)
+        Webdrivers.logger.debug "Current version of Windows Build is #{version}"
         version[/\d+\.\d+\.\d+/][/[^\.]\d+$/]
       end
 
@@ -17,7 +19,7 @@ module Webdrivers
       private
 
       def normalize(string)
-        string.match(/(\d+)\.(\d+\.\d+)/).to_a.map {|v| v.tr('.', '') }[1..-1].join('.').to_f
+        string.match(/(\d+)\.(\d+\.\d+)/).to_a.map {|v| v.tr('.', '')}[1..-1].join('.').to_f
       end
 
       def file_name
@@ -27,10 +29,22 @@ module Webdrivers
       def download_url(_version = nil)
         raise StandardError, "Can not reach site" unless site_available?
 
-        if current.to_i >= 16257
-          'https://download.microsoft.com/download/1/4/1/14156DA0-D40F-460A-B14D-1B264CA081A5/MicrosoftWebDriver.exe'
+        case current.to_i
+        when 10240
+          Webdrivers.logger.debug "Attempting to Download Build for 10240"
+          "https://download.microsoft.com/download/8/D/0/8D0D08CF-790D-4586-B726-C6469A9ED49C/MicrosoftWebDriver.msi"
+        when 10586
+          Webdrivers.logger.debug "Attempting to Download Build for 10586"
+          "https://download.microsoft.com/download/C/0/7/C07EBF21-5305-4EC8-83B1-A6FCC8F93F45/MicrosoftWebDriver.msi"
+        when 14393
+          Webdrivers.logger.debug "Attempting to Download Build for 14393"
+          "https://download.microsoft.com/download/3/2/D/32D3E464-F2EF-490F-841B-05D53C848D15/MicrosoftWebDriver.exe"
+        when 15063
+          Webdrivers.logger.debug "Attempting to Download Build for 15063"
+          "https://download.microsoft.com/download/3/4/2/342316D7-EBE0-4F10-ABA2-AE8E0CDF36DD/MicrosoftWebDriver.exe"
         else
-          'https://download.microsoft.com/download/3/2/D/32D3E464-F2EF-490F-841B-05D53C848D15/MicrosoftWebDriver.exe'
+          Webdrivers.logger.debug "Attempting to Download Latest Insider's Version"
+          "https://download.microsoft.com/download/1/4/1/14156DA0-D40F-460A-B14D-1B264CA081A5/MicrosoftWebDriver.exe"
         end
       end
 

data/spec/chromedriver_spec.rb

@@ -34,11 +34,11 @@ describe Webdrivers::Chromedriver do
     before { allow(chromedriver).to receive(:site_available?).and_return(false) }
 
     it 'raises exception finding latest version' do
-      expect {chromedriver.latest}.to raise_error(StandardError, "Can not reach site")
+      expect {chromedriver.latest}.to raise_error(StandardError, "Can not download from website")
     end
 
     it 'raises exception downloading' do
-      expect {chromedriver.download}.to raise_error(StandardError, "Can not reach site")
+      expect {chromedriver.download}.to raise_error(StandardError, "Can not download from website")
     end
   end
 

data/webdrivers.gemspec

@@ -3,7 +3,7 @@ $:.push File.expand_path("../lib", __FILE__)
 
 Gem::Specification.new do |s|
   s.name        = "webdrivers"
-  s.version     = "3.0.1"
+  s.version     = "3.1.0"
   s.authors     = ["Titus Fortner"]
   s.email       = ["titusfortner@gmail.com"]
   s.homepage    = "https://github.com/titusfortner/webdrivers"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webdrivers
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Titus Fortner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-19 00:00:00.000000000 Z
+date: 2017-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -100,6 +100,7 @@ files:
 - lib/webdrivers/common.rb
 - lib/webdrivers/geckodriver.rb
 - lib/webdrivers/iedriver.rb
+- lib/webdrivers/logger.rb
 - lib/webdrivers/mswebdriver.rb
 - lib/webdrivers/selenium.rb
 - spec/chromedriver_spec.rb
@@ -128,7 +129,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Easy download and use of browser drivers.