ferrum 0.9 → 0.10

data/lib/ferrum/network/error.rb

@@ -3,24 +3,17 @@
 module Ferrum
   class Network
     class Error
-      def initialize(data)
-        @data = data
-      end
-
-      def id
-        @data["networkRequestId"]
-      end
-
-      def url
-        @data["url"]
-      end
+      attr_writer :canceled
+      attr_reader :time, :timestamp
+      attr_accessor :id, :url, :type, :error_text, :monotonic_time, :description
 
-      def description
-        @data["text"]
+      def canceled?
+        @canceled
       end
 
-      def time
-        @time ||= Time.strptime(@data["timestamp"].to_s, "%s")
+      def timestamp=(value)
+        @timestamp = value
+        @time = Time.strptime((value / 1000).to_s, "%s")
       end
     end
   end

data/lib/ferrum/node.rb

@@ -141,10 +141,21 @@ module Ferrum
       end.map { |q| to_points(q) }.first
 
       get_position(points, x, y, position)
+    rescue Ferrum::BrowserError => e
+      return raise unless e.message&.include?("Could not compute content quads")
+
+      find_position_via_js
     end
 
     private
 
+    def find_position_via_js
+      [
+        evaluate("this.getBoundingClientRect().left + window.pageXOffset + (this.offsetWidth / 2)"), # x
+        evaluate("this.getBoundingClientRect().top + window.pageYOffset + (this.offsetHeight / 2)") # y
+      ]
+    end
+
     def get_content_quads
       quads = page.command("DOM.getContentQuads", nodeId: node_id)["quads"]
       raise "Node is either not visible or not an HTMLElement" if quads.size == 0

data/lib/ferrum/page.rb

@@ -32,7 +32,7 @@ module Ferrum
     extend Forwardable
     delegate %i[at_css at_xpath css xpath
                 current_url current_title url title body doctype set_content
-                execution_id evaluate evaluate_on evaluate_async execute
+                execution_id evaluate evaluate_on evaluate_async execute evaluate_func
                 add_script_tag add_style_tag] => :main_frame
 
     include Frames, Screenshot
@@ -65,7 +65,7 @@ module Ferrum
       @browser.timeout
     end
 
-    def goto(url = nil)
+    def go_to(url = nil)
       options = { url: combine_url!(url) }
       options.merge!(referrer: referrer) if referrer
       response = command("Page.navigate", wait: GOTO_WAIT, **options)
@@ -78,9 +78,12 @@ module Ferrum
       end
       response["frameId"]
     rescue TimeoutError
-      pendings = network.traffic.select(&:pending?).map { |e| e.request.url }
-      raise StatusError.new(options[:url], pendings) unless pendings.empty?
+      if @browser.pending_connection_errors
+        pendings = network.traffic.select(&:pending?).map { |e| e.request.url }
+        raise PendingConnectionsError.new(options[:url], pendings) unless pendings.empty?
+      end
     end
+    alias goto go_to
 
     def close
       @headers.clear
@@ -89,15 +92,12 @@ module Ferrum
     end
 
     def resize(width: nil, height: nil, fullscreen: false)
-      result = @browser.command("Browser.getWindowForTarget", targetId: @target_id)
-      @window_id, @bounds = result.values_at("windowId", "bounds")
-
       if fullscreen
         width, height = document_size
-        @browser.command("Browser.setWindowBounds", windowId: @window_id, bounds: { windowState: "fullscreen" })
+        set_window_bounds(windowState: "fullscreen")
       else
-        @browser.command("Browser.setWindowBounds", windowId: @window_id, bounds: { windowState: "normal" })
-        @browser.command("Browser.setWindowBounds", windowId: @window_id, bounds: { width: width, height: height, windowState: "normal" })
+        set_window_bounds(windowState: "normal")
+        set_window_bounds(width: width, height: height)
       end
 
       command("Emulation.setDeviceMetricsOverride", slowmoable: true,
@@ -137,6 +137,14 @@ module Ferrum
       enabled
     end
 
+    def window_id
+      @browser.command("Browser.getWindowForTarget", targetId: @target_id)["windowId"]
+    end
+
+    def set_window_bounds(bounds = {})
+      @browser.command("Browser.setWindowBounds", windowId: window_id, bounds: bounds)
+    end
+
     def command(method, wait: 0, slowmoable: false, **params)
       iteration = @event.reset if wait > 0
       sleep(@browser.slowmo) if slowmoable && @browser.slowmo > 0
@@ -179,6 +187,10 @@ module Ferrum
       end
     end
 
+    def subscribed?(event)
+      @client.subscribed?(event)
+    end
+
     private
 
     def subscribe
@@ -261,7 +273,7 @@ module Ferrum
       nil_or_relative = url.nil? || url.relative?
 
       if nil_or_relative && !@browser.base_url
-        raise "Set :base_url browser's option or use absolute url in `goto`, you passed: #{url_or_path}"
+        raise "Set :base_url browser's option or use absolute url in `go_to`, you passed: #{url_or_path}"
       end
 
       (nil_or_relative ? @browser.base_url.join(url.to_s) : url).to_s

data/lib/ferrum/page/frames.rb

@@ -75,8 +75,11 @@ module Ferrum
           frame_id = params.dig("context", "auxData", "frameId")
 
           unless @main_frame.id
-            @main_frame.id = frame_id
-            @frames[frame_id] = @main_frame
+            root_frame = command("Page.getFrameTree").dig("frameTree", "frame", "id")
+            if frame_id == root_frame
+              @main_frame.id = frame_id
+              @frames[frame_id] = @main_frame
+            end
           end
 
           frame = @frames[frame_id] || Frame.new(frame_id, self)

data/lib/ferrum/page/screenshot.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "ferrum/rbga"
+
 module Ferrum
   class Page
     module Screenshot
@@ -24,19 +26,33 @@ module Ferrum
         A6:       { width:  4.13, height:  5.83 },
       }.freeze
 
+      STREAM_CHUNK = 128 * 1024
+
       def screenshot(**opts)
         path, encoding = common_options(**opts)
         options = screenshot_options(path, **opts)
-        data = capture_screenshot(options, opts[:full])
+        data = capture_screenshot(options, opts[:full], opts[:background_color])
         return data if encoding == :base64
-        save_file(path, data)
+
+        bin = Base64.decode64(data)
+        save_file(path, bin)
       end
 
       def pdf(**opts)
         path, encoding = common_options(**opts)
-        options = pdf_options(**opts)
-        data = command("Page.printToPDF", **options).fetch("data")
-        return data if encoding == :base64
+        options = pdf_options(**opts).merge(transferMode: "ReturnAsStream")
+        handle = command("Page.printToPDF", **options).fetch("stream")
+
+        if path
+          stream_to_file(handle, path: path)
+        else
+          stream_to_memory(handle, encoding: encoding)
+        end
+      end
+
+      def mhtml(path: nil)
+        data = command("Page.captureSnapshot", format: :mhtml).fetch("data")
+        return data if path.nil?
         save_file(path, data)
       end
 
@@ -56,9 +72,31 @@ module Ferrum
       private
 
       def save_file(path, data)
-        bin = Base64.decode64(data)
-        return bin unless path
-        File.open(path.to_s, "wb") { |f| f.write(bin) }
+        return data unless path
+        File.open(path.to_s, "wb") { |f| f.write(data) }
+      end
+
+      def stream_to_file(handle, path:)
+        File.open(path, "wb") { |f| stream_to(handle, f) }
+        true
+      end
+
+      def stream_to_memory(handle, encoding:)
+        data = String.new("") # Mutable string has << and compatible to File
+        stream_to(handle, data)
+        encoding == :base64 ? Base64.encode64(data) : data
+      end
+
+      def stream_to(handle, output)
+        loop do
+          result = command("IO.read", handle: handle, size: STREAM_CHUNK)
+
+          data_chunk = result["data"]
+          data_chunk = Base64.decode64(data_chunk) if result["base64Encoded"]
+          output << data_chunk
+
+          break if result["eof"]
+        end
       end
 
       def common_options(encoding: :base64, path: nil, **_)
@@ -134,9 +172,11 @@ module Ferrum
         option.to_s.gsub(/(?:_|(\/))([a-z\d]*)/) { "#{$1}#{$2.capitalize}" }.to_sym
       end
 
-      def capture_screenshot(options, full)
+      def capture_screenshot(options, full, background_color)
         maybe_resize_fullscreen(full) do
-          command("Page.captureScreenshot", **options)
+          with_background_color(background_color) do
+            command("Page.captureScreenshot", **options)
+          end
         end.fetch("data")
       end
 
@@ -150,6 +190,18 @@ module Ferrum
       ensure
         resize(width: width, height: height) if full
       end
+
+      def with_background_color(color)
+        if color
+          raise ArgumentError, "Accept Ferrum::RGBA class only" unless color.is_a?(RGBA)
+
+          command("Emulation.setDefaultBackgroundColorOverride", color: color.to_h)
+        end
+
+        yield
+      ensure
+        command("Emulation.setDefaultBackgroundColorOverride") if color
+      end
     end
   end
 end

data/lib/ferrum/rbga.rb

@@ -0,0 +1,38 @@
+module Ferrum
+  class RGBA
+    def initialize(red, green, blue, alpha)
+      self.red = red
+      self.green = green
+      self.blue = blue
+      self.alpha = alpha
+
+      validate
+    end
+
+    def to_h
+      { r: red, g: green, b: blue, a: alpha }
+    end
+
+    private
+
+    attr_accessor :red, :green, :blue, :alpha
+
+    def validate
+      [red, green, blue].each(&method(:validate_color))
+      validate_alpha
+    end
+
+    def validate_color(value)
+      return if value && value.is_a?(Integer) && Range.new(0, 255).include?(value)
+
+      raise ArgumentError, "Wrong value of #{value} should be Integer from 0 to 255"
+    end
+
+    def validate_alpha
+      return if alpha && alpha.is_a?(Float) && Range.new(0.0, 1.0).include?(alpha)
+
+      raise ArgumentError,
+            "Wrong alpha value #{alpha} should be Float between 0.0 (fully transparent) and 1.0 (fully opaque)"
+    end
+  end
+end

data/lib/ferrum/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Ferrum
-  VERSION = "0.9"
+  VERSION = "0.10"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ferrum
 version: !ruby/object:Gem::Version
-  version: '0.9'
+  version: '0.10'
 platform: ruby
 authors:
 - Dmitry Vorotilin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-24 00:00:00.000000000 Z
+date: 2021-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: websocket-driver
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.3'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -212,6 +212,7 @@ files:
 - lib/ferrum/page.rb
 - lib/ferrum/page/frames.rb
 - lib/ferrum/page/screenshot.rb
+- lib/ferrum/rbga.rb
 - lib/ferrum/target.rb
 - lib/ferrum/version.rb
 homepage: https://github.com/route/ferrum
@@ -233,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Ruby headless Chrome driver