ferrum 0.14 → 0.16

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ferrum
 version: !ruby/object:Gem::Version
-  version: '0.14'
+  version: '0.16'
 platform: ruby
 authors:
 - Dmitry Vorotilin
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-14 00:00:00.000000000 Z
+date: 2024-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
@@ -56,22 +70,16 @@ dependencies:
   name: websocket-driver
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.6'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0.6'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.7'
 description: Ferrum allows you to control headless Chrome browser
 email:
 - d.vorotilin@gmail.com
@@ -84,22 +92,23 @@ files:
 - lib/ferrum.rb
 - lib/ferrum/browser.rb
 - lib/ferrum/browser/binary.rb
-- lib/ferrum/browser/client.rb
 - lib/ferrum/browser/command.rb
 - lib/ferrum/browser/options.rb
 - lib/ferrum/browser/options/base.rb
 - lib/ferrum/browser/options/chrome.rb
 - lib/ferrum/browser/options/firefox.rb
 - lib/ferrum/browser/process.rb
-- lib/ferrum/browser/subscriber.rb
 - lib/ferrum/browser/version_info.rb
-- lib/ferrum/browser/web_socket.rb
 - lib/ferrum/browser/xvfb.rb
+- lib/ferrum/client.rb
+- lib/ferrum/client/subscriber.rb
+- lib/ferrum/client/web_socket.rb
 - lib/ferrum/context.rb
 - lib/ferrum/contexts.rb
 - lib/ferrum/cookies.rb
 - lib/ferrum/cookies/cookie.rb
 - lib/ferrum/dialog.rb
+- lib/ferrum/downloads.rb
 - lib/ferrum/errors.rb
 - lib/ferrum/frame.rb
 - lib/ferrum/frame/dom.rb
@@ -128,7 +137,9 @@ files:
 - lib/ferrum/target.rb
 - lib/ferrum/utils/attempt.rb
 - lib/ferrum/utils/elapsed_time.rb
+- lib/ferrum/utils/event.rb
 - lib/ferrum/utils/platform.rb
+- lib/ferrum/utils/thread.rb
 - lib/ferrum/version.rb
 homepage: https://github.com/rubycdp/ferrum
 licenses:
@@ -148,14 +159,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: Ruby headless Chrome driver

data/lib/ferrum/browser/client.rb

@@ -1,103 +0,0 @@
-# frozen_string_literal: true
-
-require "ferrum/browser/subscriber"
-require "ferrum/browser/web_socket"
-
-module Ferrum
-  class Browser
-    class Client
-      INTERRUPTIONS = %w[Fetch.requestPaused Fetch.authRequired].freeze
-
-      def initialize(ws_url, connectable, logger: nil, ws_max_receive_size: nil, id_starts_with: 0)
-        @connectable = connectable
-        @command_id = id_starts_with
-        @pendings = Concurrent::Hash.new
-        @ws = WebSocket.new(ws_url, ws_max_receive_size, logger)
-        @subscriber, @interrupter = Subscriber.build(2)
-
-        @thread = Thread.new do
-          Thread.current.abort_on_exception = true
-          Thread.current.report_on_exception = true if Thread.current.respond_to?(:report_on_exception=)
-
-          loop do
-            message = @ws.messages.pop
-            break unless message
-
-            if INTERRUPTIONS.include?(message["method"])
-              @interrupter.async.call(message)
-            elsif message.key?("method")
-              @subscriber.async.call(message)
-            else
-              @pendings[message["id"]]&.set(message)
-            end
-          end
-        end
-      end
-
-      def command(method, params = {})
-        pending = Concurrent::IVar.new
-        message = build_message(method, params)
-        @pendings[message[:id]] = pending
-        @ws.send_message(message)
-        data = pending.value!(@connectable.timeout)
-        @pendings.delete(message[:id])
-
-        raise DeadBrowserError if data.nil? && @ws.messages.closed?
-        raise TimeoutError unless data
-
-        error, response = data.values_at("error", "result")
-        raise_browser_error(error) if error
-        response
-      end
-
-      def on(event, &block)
-        case event
-        when *INTERRUPTIONS
-          @interrupter.on(event, &block)
-        else
-          @subscriber.on(event, &block)
-        end
-      end
-
-      def subscribed?(event)
-        [@interrupter, @subscriber].any? { |s| s.subscribed?(event) }
-      end
-
-      def close
-        @ws.close
-        # Give a thread some time to handle a tail of messages
-        @pendings.clear
-        @thread.kill unless @thread.join(1)
-      end
-
-      private
-
-      def build_message(method, params)
-        { method: method, params: params }.merge(id: next_command_id)
-      end
-
-      def next_command_id
-        @command_id += 1
-      end
-
-      def raise_browser_error(error)
-        case error["message"]
-        # Node has disappeared while we were trying to get it
-        when "No node with given id found",
-             "Could not find node with given id",
-             "Inspected target navigated or closed"
-          raise NodeNotFoundError, error
-        # Context is lost, page is reloading
-        when "Cannot find context with specified id"
-          raise NoExecutionContextError, error
-        when "No target with given id found"
-          raise NoSuchPageError
-        when /Could not compute content quads/
-          raise CoordinatesNotFoundError
-        else
-          raise BrowserError, error
-        end
-      end
-    end
-  end
-end

data/lib/ferrum/browser/subscriber.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-module Ferrum
-  class Browser
-    class Subscriber
-      include Concurrent::Async
-
-      def self.build(size)
-        (0..size).map { new }
-      end
-
-      def initialize
-        super
-        @on = Concurrent::Hash.new { |h, k| h[k] = Concurrent::Array.new }
-      end
-
-      def on(event, &block)
-        @on[event] << block
-        true
-      end
-
-      def subscribed?(event)
-        @on.key?(event)
-      end
-
-      def call(message)
-        method, params = message.values_at("method", "params")
-        total = @on[method].size
-        @on[method].each_with_index do |block, index|
-          # In case of multiple callbacks we provide current index and total
-          block.call(params, index, total)
-        end
-      end
-    end
-  end
-end

data/lib/ferrum/browser/web_socket.rb

@@ -1,91 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-require "socket"
-require "websocket/driver"
-
-module Ferrum
-  class Browser
-    class WebSocket
-      WEBSOCKET_BUG_SLEEP = 0.05
-      SKIP_LOGGING_SCREENSHOTS = !ENV["FERRUM_LOGGING_SCREENSHOTS"]
-
-      attr_reader :url, :messages
-
-      def initialize(url, max_receive_size, logger)
-        @url      = url
-        @logger   = logger
-        uri       = URI.parse(@url)
-        @sock     = TCPSocket.new(uri.host, uri.port)
-        max_receive_size ||= ::WebSocket::Driver::MAX_LENGTH
-        @driver   = ::WebSocket::Driver.client(self, max_length: max_receive_size)
-        @messages = Queue.new
-
-        @screenshot_commands = Concurrent::Hash.new if SKIP_LOGGING_SCREENSHOTS
-
-        @driver.on(:open,    &method(:on_open))
-        @driver.on(:message, &method(:on_message))
-        @driver.on(:close,   &method(:on_close))
-
-        @thread = Thread.new do
-          Thread.current.abort_on_exception = true
-          Thread.current.report_on_exception = true if Thread.current.respond_to?(:report_on_exception=)
-
-          begin
-            loop do
-              data = @sock.readpartial(512)
-              break unless data
-
-              @driver.parse(data)
-            end
-          rescue EOFError, Errno::ECONNRESET, Errno::EPIPE
-            @messages.close
-          end
-        end
-
-        @driver.start
-      end
-
-      def on_open(_event)
-        # https://github.com/faye/websocket-driver-ruby/issues/46
-        sleep(WEBSOCKET_BUG_SLEEP)
-      end
-
-      def on_message(event)
-        data = JSON.parse(event.data)
-        @messages.push(data)
-
-        output = event.data
-        if SKIP_LOGGING_SCREENSHOTS && @screenshot_commands[data["id"]]
-          @screenshot_commands.delete(data["id"])
-          output.sub!(/{"data":"(.*)"}/, %("Set FERRUM_LOGGING_SCREENSHOTS=true to see screenshots in Base64"))
-        end
-
-        @logger&.puts("    ◀ #{Utils::ElapsedTime.elapsed_time} #{output}\n")
-      end
-
-      def on_close(_event)
-        @messages.close
-        @thread.kill
-      end
-
-      def send_message(data)
-        @screenshot_commands[data[:id]] = true if SKIP_LOGGING_SCREENSHOTS
-
-        json = data.to_json
-        @driver.text(json)
-        @logger&.puts("\n\n▶ #{Utils::ElapsedTime.elapsed_time} #{json}")
-      end
-
-      def write(data)
-        @sock.write(data)
-      rescue EOFError, Errno::ECONNRESET, Errno::EPIPE
-        @messages.close
-      end
-
-      def close
-        @driver.close
-      end
-    end
-  end
-end