watir-screenshot-stitch 0.6.11 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 1bf1235cd25a0f41d381177c93ca6a0668d5c116
-  data.tar.gz: f69d3d620262a96e78f268a3a614f4b8c86f024f
+SHA256:
+  metadata.gz: 77d9d165765e9f0bd0e189c7af282d535be07a5b24630ff5642ae07440e66654
+  data.tar.gz: 197c0b0f5df9211f2f1f8f0e8423bf8d7fa774a963c138957837bc82df5b52a5
 SHA512:
-  metadata.gz: 8aad381a4e89008008aa6275961db9831c2960cea03fbf1efbd52631271505f3c9af67d8e8e7b8f7c15cf0b153b00b3921842f53ba446494be493547d588f6f7
-  data.tar.gz: e6f0ffbea07ae0e507fb29a428f86951c48666224d43c92ab3658f9394ff15c1570fa268d3832cfbf75e10212664d5b17d4e5b647dd024c91797f4f8f2f0be15
+  metadata.gz: 55a78fe53008cb3e464d5fb947e66c3fd208ad0bee3545007450195a7158e6bc6f079feb02263263ddf7d7b256818145fa1ada4e3334ff3e5f6d7b86199b4472
+  data.tar.gz: 67bea36811afe3044532f31f58b2750e5c06f03685bfdd2d8effa18d8ff7080b5a27be6546b3643b23f1ef80e79e4072ce1f8d16b902813e6c7193d755f4a5ac

data/README.md

@@ -1,10 +1,21 @@
 # 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
+[Mozilla's decision not to (yet?) expose Firefox's full page screenshot
+functionality](https://github.com/mozilla/geckodriver/issues/570)
+via geckodriver.
+
+The canonical screenshot stitching is done by paging down a given URL
+by the size of the viewport, capturing the entire page in the process,
+up to the maximum height — see below.
+
+Alternatively, it also bundles the
+[html2canvas](https://github.com/niklasvh/html2canvas)
+script and applies it to the page. 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.
 
 ## Installation
 
@@ -34,18 +45,84 @@ 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
 
-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.
+```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_canvas
+path = "/my/path/image.png"
+File.open(path, 'wb') { |f| f.write(Base64.decode64(png)) }
+```
 
-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.
+This is the option with the fewest complications, and should be used
+if possible.
+
+#### 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
 
@@ -58,7 +135,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,
@@ -68,21 +145,21 @@ 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(b)
+png = b.screenshot.base64_canvas
 path = "/my/path/image.png"
 File.open(path, 'wb') { |f| f.write(Base64.decode64(png)) }
 ```
@@ -97,14 +174,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.
@@ -119,11 +188,13 @@ 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,11 +54,10 @@ module Watir
     # @param [Hash] opts
     #
 
-    def save_stitch(path, browser = @browser, opts = {})
-      return browser.screenshot.save(path) if base64_capable?
+    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?)
@@ -57,9 +83,8 @@ module Watir
     # @return [String]
     #
 
-    def base64_canvas(browser = @browser)
+    def base64_canvas
       return self.base64 if base64_capable?
-      deprecate_browser(browser, (__LINE__-1))
       output = nil
 
       return self.base64 if one_shot? || bug_shot?
@@ -77,10 +102,56 @@ module Watir
     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?
+        'Webdrivers'.constantize
+      rescue
+        nil
       end
 
       # in IE & Safari a regular screenshot is a full page screenshot only

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

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

data/watir-screenshot-stitch.gemspec

@@ -37,7 +37,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.3.0'
 
   spec.add_dependency "rubyzip", "~> 1.2"
-  spec.add_dependency "watir", "~> 6.4"
+  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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: watir-screenshot-stitch
 version: !ruby/object:Gem::Version
-  version: 0.6.11
+  version: 0.7.1
 platform: ruby
 authors:
 - Sam Nissen
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
+date: 2019-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,14 +87,14 @@ dependencies:
     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
@@ -181,7 +181,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Extends Watir to take stitched-together screenshots of full web pages.