watir-screenshot-stitch 0.6.8 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 939a86622f8de5e560e22d3d49efa5b460cc56bb3670190931c96e06ee52a50a
-  data.tar.gz: d10c0145635f1f300209af7bd749ed36ee1965f1a266e4b847cf5ea8739b114d
+  metadata.gz: 4f561aad110b6d5ec14d10ffb7081ca534c491a8f9e3ed1132a5df881da81413
+  data.tar.gz: 42501bd6aef6ebcb9f9330b7bf5aafbb1127caac314cbe51768f70231578b9f3
 SHA512:
-  metadata.gz: 90b97d55213c381c6b14357e915d4bbace39f7af1d44f7cfad528b6bc0a3ac3494b06ff562ae3ec5007a45ccdf0b354979634fbd2fcb2da2721b7f38bf9bf2cd
-  data.tar.gz: 47404aab8732ce6e6c1c1a8d27831b8aecdc202befdfd203304c0910d723c872037a406e374621e6a9ae362b4ca6811e46ad47130ecb80bc9cbff9ce85c38e79
+  metadata.gz: 174aa90233570368a21bd85a6711eb173097f2d0368dbabd07bb7f408fc765e114ee83a982ddc42dd9e8e71363d13e12975643120634f4fa82d5dae9da21941a
+  data.tar.gz: c6a6765576e3c307076c7c5056efb11e26e187165cbe9507db7d1e541a3f394b636d92874e7958639c16b2242bbf62b3fba2aff4fdbdd31b77185d6c0b79c51e

data/.gitignore

@@ -1,3 +1,4 @@
+/.idea/
 /.bundle/
 /.yardoc
 /_yardoc/
@@ -15,3 +16,7 @@
 
 # development
 watir-screenshot-stitch-*.gem
+
+# Gem best practice
+# https://stackoverflow.com/a/4151540/1651458
+Gemfile.lock

data/Gemfile

@@ -1,6 +1,6 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in watir-screenshot-stitch.gemspec
 gemspec

data/README.md

@@ -1,10 +1,19 @@
 # watir-screenshot-stitch
 
-watir-screenshot-stitch attempts to compensate for Mozilla's decision
-not to (yet?) expose Firefox's full page screenshot functionality
-via geckodriver, [as indicated here](https://github.com/mozilla/geckodriver/issues/570),
-by paging down a given URL by the size of the viewport, capturing
-the entire page in the process.
+watir-screenshot-stitch attempts to compensate for
+the lack of full page screenshot functionality
+in Selenium Webdriver.
+
+It does so in three ways:
+
+* Directly employing geckodriver's new full page screenshot
+functionality (only on Firefox).
+* Screenshot stitching, paging down a given URL by the size 
+of the viewport, capturing screenshots and adjoining them.
+* Employing a bundled
+[html2canvas](https://github.com/niklasvh/html2canvas)
+script against the page to generate a png from a `canvas`
+element. 
 
 ## Installation
 
@@ -20,27 +29,98 @@ watir-screenshot-stitch relies on [MiniMagick](https://github.com/minimagick/min
 (and thus ImageMagick). You might need to review that gem's requirements and
 installation before proceeding.
 
-### Firefox
+### Browser Support
+
+watir-screenshot-stitch is optimized for and tested on following browsers:
+* Chrome 65+
+* Firefox 58+
+* Safari 11.1
+* IE 11/10/9/8
 
-watir-screenshot-stitch is optimized for and tested on Firefox. Your
-Watir / Selenium-Webdriver / geckodriver / Firefox stack must be correctly
+Your Watir / Selenium-Webdriver / webdriver / Browser stack must be correctly
 configured. If you can find a good guide for installing and maintaining all
 parts of this stack, you're a better Googler than me.
 
 ## Usage
 
-### WARNING: Browser passing will soon no longer be required
+### Special note: Upgrading from <= 0.6.11
+
+As warned in version 0.6.6 and beyond, the Watir::Screenshot
+class will have access to the browser in watir-screenshot-stitch
+version 0.7.0 and beyond, and it will not need to be
+passed to the public methods. Previous implementations will break.
+
+To adapt, change your function calls like so:
+
+<table>
+  <thead>
+    <tr>
+    <th>
+      <= 0.6.5
+    </th>
+    <th>
+      >= 0.6.6 && <= 0.6.11
+    </th>
+    <th>
+      >= 0.7.0
+    </th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>
+        `save_stitch(path, browser, opts)`
+      </td>
+      <td>
+        `save_stitch(path, nil, opts)` or
+        `save_stitch(path, browser, opts)`
+      </td>
+      <td>
+        `save_stitch(path, opts)`
+      </td>
+    </tr>
+    <tr>
+      <td>
+        `base64_canvas(browser)`
+      </td>
+      <td>
+        `base64_canvas(browser)` or `base64_canvas`
+      </td>
+      <td>
+        `base64_canvas`
+      </td>
+    </tr>
+  </tbody>
+</table>
+
+### Using geckodriver
+
+watir-screenshot-stitch can employ a special function of geckodriver >= 0.24.0
+while driving Firefox. This
+
+```ruby
+require 'watir-screenshot-stitch'
+b = Watir::Browser.new :firefox
+b.goto "https://github.com/mozilla/geckodriver/issues/570"
+b.base64_geckodriver
+```
+will return a base64 encoded image blob of the given site.
+
+In can be saved as a PNG by doing:
+```ruby
+png = b.screenshot.base64_geckodriver
+path = "/my/path/image.png"
+File.open(path, 'wb') { |f| f.write(Base64.decode64(png)) }
+```
 
-As of watir-screenshot-stitch version 0.7.0, the Watir::Screenshot
-class will have access to the browser, and it will not need to be
-passed to the public methods. `save_stitch(path, browser, opts)`
-will become `save_stitch(path, opts)`, and `base64_canvas(browser)`
-will become `base64_canvas` and existing implementations will
-break.
+This is the option with the fewest complications, and should be used
+if possible.
 
-To suppress warnings in the meantime, upgrade to Watir 6.12
-and pass `nil` in place of the `browser` for #save_stitch and
-use `base64_canvas` with no parameters.
+#### User geckodriver vs. webdrivers geckodriver
+
+If using the webdrivers gem, watir-screenshot-stitch will attempt to
+use the geckodriver included there, since that's likely to be
+the driver employed by watir. If not, it falls back to the the system user's geckodriver.
 
 ### Stitching
 
@@ -53,7 +133,7 @@ opts = { :page_height_limit => 5000 }
 
 b = Watir::Browser.new :firefox
 b.goto "https://github.com/mozilla/geckodriver/issues/570"
-b.screenshot.save_stitch(path, b, opts)
+b.screenshot.save_stitch(path, opts)
 ```
 
 will stitch together and save a full-page screenshot, up to 5000 pixels tall,
@@ -63,18 +143,31 @@ to `/my/path/image.png`.
 
 html2canvas is a JavaScript library watir-screenshot-stitch can employ to
 try to create a canvas element of the entire page and covert it to a blob.
-For instance,
+For instance, this
 
 ```ruby
 require 'watir-screenshot-stitch'
 
 b = Watir::Browser.new :firefox
 b.goto "https://github.com/watir/watir/issues/702"
-b.screenshot.base64_canvas(b)
+b.screenshot.base64_canvas
 ```
 
 will return a base64 encoded image blob of the given site.
 
+In can be saved as a PNG by doing:
+```ruby
+png = b.screenshot.base64_canvas
+path = "/my/path/image.png"
+File.open(path, 'wb') { |f| f.write(Base64.decode64(png)) }
+```
+
+This method of screenshotting
+is less likely to have issues with stitching the images together,
+and running out of memory but has limitations with certain element
+types not being properly displayed. See their documentation for
+more information.
+
 ### Doubling resolution calculations, including macOS Retina
 
 watir-screenshot-stitch uses CSS selectors to determine whether a
@@ -85,14 +178,6 @@ logic to determine how to stitch together images.
 This means that moving the browser window while it is be driven by
 Watir can cause unpredictable results.
 
-### Passing the browser?
-
-This is obviously awkward and obtuse. Because watir-screenshot-stitch
-patches Watir, it does not change the way Watir calls the Screenshot class,
-which does not know about the Browser instance (it instead knows
-about the driver). And watir-screenshot-stitch needs the browser to execute
-JavaScript on the page.
-
 ### Options
 
 A hash of key value pairs.
@@ -101,17 +186,19 @@ A hash of key value pairs.
 Should refer to a positive Integer greater than the viewport height.
 
 ### Maximum height
-ImageMagick has a maximum pixel dimension of 65500, and all screenshots
-will be capped to a maximum height of 65500 regardless of any options
-to avoid errors.
+ImageMagick has a maximum pixel dimension of 65500, and all stitched
+screenshots will be capped to a maximum height of 65500 regardless 
+of any options to avoid errors.
 
 ## Development
 
-TODO: This.
+Use `rspec` to run the tests, and see the
+(contributing)[#Contributing] section below &mdash;
+all are welcome.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/watir-screenshot-stitch. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/samnissen/watir-screenshot-stitch. 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.
 
 ## License
 

data/lib/watir-screenshot-stitch.rb

@@ -14,6 +14,33 @@ RANGE_MOD = 0.02
 module Watir
   class Screenshot
 
+    #
+    # Employs a cutting edge feature in geckodriver version 0.24.0
+    # to produce a Base64 encoded string of a full page screenshot.
+    #
+    # @warning
+    #   This will fail if geckodriver is less than version 0.24.0.
+    #
+    # @info
+    #   This is only a patch until this is baked into Selenium/Watir.
+    #
+    # @example
+    #   browser.screenshot.base64_geckodriver
+    #   #=> '7HWJ43tZDscPleeUuPW6HhN3x+z7vU/lufmH0qNTtTum94IBWMT46evImci1vnFGT'
+    #
+    # @return [String]
+    #
+
+    def base64_geckodriver
+      ensure_geckodriver
+
+      resource_url = build_driver_url
+
+      raw = request_payload(resource_url)
+
+      parse_gecko(raw)
+    end
+
     #
     # Represents stitched together screenshot and writes to file.
     #
@@ -27,10 +54,10 @@ module Watir
     # @param [Hash] opts
     #
 
-    def save_stitch(path, browser = @browser, opts = {})
+    def save_stitch(path, opts = {})
+      return @browser.screenshot.save(path) if base64_capable?
       @options = opts
       @path = path
-      deprecate_browser(browser, (__LINE__-3))
       calculate_dimensions
 
       return self.save(@path) if (one_shot? || bug_shot?)
@@ -56,8 +83,8 @@ module Watir
     # @return [String]
     #
 
-    def base64_canvas(browser = @browser)
-      deprecate_browser(browser, (__LINE__-1))
+    def base64_canvas
+      return self.base64 if base64_capable?
       output = nil
 
       return self.base64 if one_shot? || bug_shot?
@@ -71,14 +98,65 @@ module Watir
 
       raise "Could not generate screenshot blob within #{MAXIMUM_SCREENSHOT_GENERATION_WAIT_TIME} seconds" unless output
 
-      return output.sub!(/^data\:image\/png\;base64,/, '')
+      output.sub!(/^data\:image\/png\;base64,/, '')
     end
 
     private
-      def deprecate_browser(browser, line)
-        return unless browser
-        warn "#{DateTime.now.strftime("%F %T")} WARN Watir Screenshot Stitch [DEPRECATION] Passing the browser is deprecated and will no longer work in version 0.7.0 /lib/watir-screenshot-stitch.rb:#{line}"
-        @browser = browser
+      def parse_gecko(raw = '')
+        JSON.parse(raw, symbolize_names: true)[:value]
+      rescue JSON::ParserError => e
+        raise "geckodriver response '#{raw}' was malformed"
+      end
+
+      def request_payload(request_url)
+        url = URI.parse(request_url)
+        req = Net::HTTP::Get.new(request_url)
+        Net::HTTP.start(url.host, url.port) {|http| http.request(req) }.body
+      rescue Errno::ECONNREFUSED => e
+        raise "geckodriver could not be accessed at '#{request_url}'"
+      end
+
+      def build_driver_path
+        bridge = @browser.driver.session_storage.instance_variable_get(:@bridge)
+        sid = bridge.instance_variable_get(:@session_id)
+
+        raise "Unable to get geckodriver session ID." unless sid
+
+        "session/#{sid}/moz/screenshot/full"
+      end
+
+      def build_driver_url
+        bridge = @browser.driver.session_storage.instance_variable_get(:@bridge)
+        server_uri = bridge.instance_variable_get(:@http).instance_variable_get(:@server_url)
+
+        raise "Unable to get geckodriver server URI." unless server_uri
+
+        request_url = server_uri.to_s + build_driver_path
+      end
+
+      def ensure_geckodriver
+        raise "base64_geckodriver only works on Firefox" unless @browser.name == :firefox
+
+        if webdrivers_defined?
+          current_version = Webdrivers::Geckodriver.current_version
+        else
+          current_version = Gem::Version.new(%x{geckodriver --version}.match(/geckodriver (\d+\.\d+\.\d+)/)[1])
+        end
+
+        correct_version = (current_version >= Gem::Version.new("0.24.0"))
+
+        raise "base64_geckodriver requires version 0.24.x or greater" unless correct_version
+      end
+
+      def webdrivers_defined?
+        Object.const_get("Webdrivers")
+      rescue NameError
+        nil
+      end
+
+      # in IE & Safari a regular screenshot is a full page screenshot only
+      def base64_capable?
+        [:internet_explorer, :safari].include? @browser&.name
       end
 
       def one_shot?
@@ -99,7 +177,7 @@ module Watir
       end # https://github.com/mozilla/geckodriver/issues/1129
 
       def h2c_activator
-        return case @browser.driver.browser
+        case @browser.driver.browser
         when :firefox
           %<
             function genScreenshot () {
@@ -125,7 +203,7 @@ module Watir
       end
 
       def html2canvas_payload
-        return case @browser.driver.browser
+        case @browser.driver.browser
         when :firefox
           path = File.join(WatirScreenshotStitch::Utilities.directory, "vendor/html2canvas-0.4.1.js")
           File.read(path)
@@ -204,8 +282,12 @@ module Watir
       end
 
       def retina?
-        payload = %{var mq = window.matchMedia("only screen and (min--moz-device-pixel-ratio: 1.3), only screen and (-o-min-device-pixel-ratio: 2.6/2), only screen and (-webkit-min-device-pixel-ratio: 1.3), only screen  and (min-device-pixel-ratio: 1.3), only screen and (min-resolution: 1.3dppx)"); return (mq && mq.matches || (window.devicePixelRatio > 1));}
-
+        payload = %{ var mq = window.matchMedia("only screen and (min--moz-device-pixel-ratio: 1.3), \
+                                                  only screen and (-o-min-device-pixel-ratio: 2.6/2), \
+                                                  only screen and (-webkit-min-device-pixel-ratio: 1.3), \
+                                                  only screen  and (min-device-pixel-ratio: 1.3), \
+                                                  only screen and (min-resolution: 1.3dppx)");
+                      return (mq && mq.matches || (window.devicePixelRatio > 1)); }
         @browser.execute_script payload
       end
   end

data/lib/watir-screenshot-stitch/version.rb

@@ -1,4 +1,4 @@
 module WatirScreenshotStitch
   NAME = 'watir-screenshot-stitch'
-  VERSION = "0.6.8"
+  VERSION = "0.7.3"
 end

data/watir-screenshot-stitch.gemspec

@@ -1,4 +1,3 @@
-
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "watir-screenshot-stitch/version"
@@ -6,8 +5,8 @@ require "watir-screenshot-stitch/version"
 Gem::Specification.new do |spec|
   spec.name          = "watir-screenshot-stitch"
   spec.version       = WatirScreenshotStitch::VERSION
-  spec.authors       = ["Sam Nissen"]
-  spec.email         = ["scnissen@gmail.com"]
+  spec.authors       = ["Sam Nissen", "Sandeep Singh"]
+  spec.email         = ["scnissen@gmail.com", "sandeepnagra@gmail.com"]
 
   spec.summary       = %q{Extends Watir to take stitched-together screenshots of full web pages.}
   # spec.description   = %q{TODO: Write a longer description or delete this line.}
@@ -31,11 +30,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "chunky_png", "~> 1.3"
 
-  spec.add_dependency "watir", "~> 6.4"
+  spec.required_ruby_version = '>= 2.3.0'
+
+  spec.add_dependency "rubyzip", "~> 1.2"
+  spec.add_dependency "watir", "~> 6.12"
   spec.add_dependency "mini_magick", "~> 4.0"
   spec.add_dependency "os", "~> 1.0"
   spec.add_dependency "binding_of_caller", "~> 0.7"

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: watir-screenshot-stitch
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.7.3
 platform: ruby
 authors:
 - Sam Nissen
+- Sandeep Singh
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-20 00:00:00.000000000 Z
+date: 2020-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -28,16 +29,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +67,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rubyzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: watir
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.4'
+        version: '6.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.4'
+        version: '6.12'
 - !ruby/object:Gem::Dependency
   name: mini_magick
   requirement: !ruby/object:Gem::Requirement
@@ -125,6 +140,7 @@ dependencies:
 description: 
 email:
 - scnissen@gmail.com
+- sandeepnagra@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -134,7 +150,6 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -158,15 +173,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Extends Watir to take stitched-together screenshots of full web pages.

data/Gemfile.lock

@@ -1,55 +0,0 @@
-PATH
-  remote: .
-  specs:
-    watir-screenshot-stitch (0.6.7)
-      binding_of_caller (~> 0.7)
-      mini_magick (~> 4.0)
-      os (~> 1.0)
-      watir (~> 6.4)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    binding_of_caller (0.8.0)
-      debug_inspector (>= 0.0.1)
-    childprocess (0.9.0)
-      ffi (~> 1.0, >= 1.0.11)
-    chunky_png (1.3.10)
-    debug_inspector (0.0.3)
-    diff-lcs (1.3)
-    ffi (1.9.25)
-    mini_magick (4.8.0)
-    os (1.0.0)
-    rake (10.5.0)
-    rspec (3.7.0)
-      rspec-core (~> 3.7.0)
-      rspec-expectations (~> 3.7.0)
-      rspec-mocks (~> 3.7.0)
-    rspec-core (3.7.1)
-      rspec-support (~> 3.7.0)
-    rspec-expectations (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-mocks (3.7.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.7.0)
-    rspec-support (3.7.0)
-    rubyzip (1.2.1)
-    selenium-webdriver (3.14.0)
-      childprocess (~> 0.5)
-      rubyzip (~> 1.2)
-    watir (6.12.0)
-      selenium-webdriver (~> 3.4, >= 3.4.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 1.16)
-  chunky_png (~> 1.3)
-  rake (~> 10.0)
-  rspec (~> 3.0)
-  watir-screenshot-stitch!
-
-BUNDLED WITH
-   1.16.2