minibidi 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 607b907a85631222aca0cf29e33cdcc76af704464e8a64ee19b9e2da1b6c3b75
-  data.tar.gz: 527e055f3473a2c08f26157d466f2759a210476e97e63d341f90e91b7053315a
+  metadata.gz: 74c2b07cd5b5a34c85ca23e6127e5c09b23af0814ab91339e8ffc3c18f2aaec4
+  data.tar.gz: 1de813a159df9930ffa27dc69b3c68426faebbe3604dc631b03fb899ea39a7ce
 SHA512:
-  metadata.gz: 2a470c291ead662299187dff8f4cf4b3eaffa7308ad3ad15adee38ce39fa5112d93941ceabd120a7e7d47bd2153a36d449c18935364d90f346b5fac5def8ac3f
-  data.tar.gz: 6ca0eff8038b65628ebf1e66040c5ed7d6b4ffbcd997084e018feeb8911974295e13c61d0d79652b74b20e54dd11ca60df332e992ece59c6231fe3265a4c3030
+  metadata.gz: 2be5e98fd4c177b4b087a3ca8af9efa5110386df709de76c61b477463b44fb6a797c13c002f270fba542a8b548a226dbae8dfa86000d26cc4b93fbd4bd486025
+  data.tar.gz: 185322a8c0ee29af4e7fd1a0663dc89746ab7203163c5a9f27bd17158b17a009d7f7dde2b910163f950c678a4f66e1a18133fdd69f7d40353d69df32c21f2e30

data/Gemfile

@@ -4,3 +4,11 @@ git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in minibidi.gemspec
 gemspec
+
+gem "bundler"
+gem "minitest"
+gem "pry"
+gem "rack-test_server"
+gem "rake"
+gem "sinatra", require: false
+gem 'webrick'

data/lib/minibidi/browser.rb

@@ -1,5 +1,6 @@
 require 'async'
 require 'async/variable'
+require 'json'
 
 module Minibidi
   class Browser
@@ -8,10 +9,8 @@ module Minibidi
       @debug_protocol = %w[1 true].include?(ENV['DEBUG'])
 
       Async do
-        while data = async_websocket_connection.read
-          if message = Protocol::WebSocket::JSONMessage.wrap(data)
-            handle_received_message_from_websocket(message.to_h)
-          end
+        while message = async_websocket_connection.read
+          handle_received_message_from_websocket(message.to_h)
         end
       end
 
@@ -79,7 +78,7 @@ module Minibidi
 
     def send_message_to_websocket(payload)
       debug_print_send(payload)
-      message = Protocol::WebSocket::JSONMessage.generate(payload)
+      message = Protocol::WebSocket::TextMessage.new(JSON.generate(payload))
       message.send(@websocket)
       @websocket.flush
     end
@@ -105,7 +104,7 @@ module Minibidi
         new(
           type: payload[:error],
           message: payload[:message],
-          stacktrace: payload[:stacktrace].split("\n"),
+          stacktrace: (payload[:stacktrace] || '').split("\n"),
         )
       end
 

data/lib/minibidi/browsing_context.rb

@@ -7,19 +7,76 @@ module Minibidi
       @context_id = context_id
     end
 
-    def navigate(url)
-      bidi_call_async('browsingContext.navigate', { url: url, wait: :interactive }).wait
+    def navigate(url, wait: :interactive)
+      bidi_call_async('browsingContext.navigate', {
+        url: url,
+        wait: wait,
+      }.compact).wait
     end
 
-    def capture_screenshot(origin:, format:)
+    def realms
+      result = bidi_call_async('script.getRealms').wait
+      result[:realms].map do |realm|
+        Realm.new(
+          browsing_context: self,
+          id: realm[:realm],
+          origin: realm[:origin],
+          type: realm[:type],
+        )
+      end
+    end
+
+    def default_realm
+      realms.find { |realm| realm.type == 'window' }
+    end
+
+    def input
+      Input.new(self)
+    end
+
+    def activate
+      bidi_call_async('browsingContext.activate').wait
+    end
+
+    def capture_screenshot(origin: nil, format: nil, clip: nil)
       result = bidi_call_async('browsingContext.captureScreenshot', {
         origin: origin,
         format: format,
-      }).wait
+        clip: clip,
+      }.compact).wait
 
       Base64.strict_decode64(result[:data])
     end
 
+    def close(prompt_unload: nil)
+      bidi_call_async('browsingContext.close', {
+        promptUnload: prompt_unload,
+      }.compact).wait
+    end
+
+    def reload(ignore_cache: nil, wait: nil)
+      bidi_call_async('browsingContext.reload', {
+        ignoreCache: ignore_cache,
+        wait: wait,
+      }.compact).wait
+    end
+
+    def set_viewport(width:, height:, device_pixel_ratio: nil)
+      bidi_call_async('browsingContext.setViewport', {
+        viewport: {
+          width: width,
+          height: height,
+        },
+        devicePixelRatio: device_pixel_ratio,
+      }.compact).wait
+    end
+
+    def traverse_history(delta)
+      bidi_call_async('browsingContext.traverseHistory', {
+        delta: delta,
+      }).wait
+    end
+
     private
 
     def bidi_call_async(method_, params = {})

data/lib/minibidi/firefox_launcher.rb

@@ -2,41 +2,72 @@ require 'async'
 require 'async/http/endpoint'
 require 'async/websocket'
 require 'open3'
-require 'protocol/websocket/json_message'
 require 'timeout'
 require 'tmpdir'
 
 module Minibidi
+  class Firefox
+    def self.launch(&block)
+      FirefoxLauncher.new.launch(&block)
+    end
+
+    def self.discover_binary
+      # check if macOS
+      if RUBY_PLATFORM =~ /darwin/
+        if File.exist?("/Applications/Firefox Developer Edition.app/Contents/MacOS/firefox")
+          return "/Applications/Firefox Developer Edition.app/Contents/MacOS/firefox"
+        end
+      elsif RUBY_PLATFORM =~ /linux/
+        if File.exist?("/usr/bin/firefox-devedition")
+          return "/usr/bin/firefox-devedition"
+        end
+      end
+
+      raise LaunchError, 'Firefox Developer Edition is not found. Please install it from https://www.mozilla.org/firefox/developer/'
+    end
+  end
+
   class FirefoxLauncher
     def launch(&block)
       raise ArgumentError, "block is required" unless block
 
-      Dir.mktmpdir('minibidi') do |tmp|
-        create_user_profile(tmp)
+      tmp = Dir.mktmpdir('minibidi')
+      create_user_profile(tmp)
+      args = [
+        "--remote-debugging-port=0",
+        "--profile",
+        tmp,
+        "--no-remote",
+      ]
+      if RUBY_PLATFORM =~ /darwin/
+        args << "--foreground"
+      end
+      if %w[true 1].include?(ENV['HEADLESS'])
+        args << "--headless"
+      end
 
-        proc = BrowserProcess.new(
-          "/Applications/Firefox Developer Edition.app/Contents/MacOS/firefox",
-          "--remote-debugging-port=0",
-          "--profile #{tmp}",
-          "--no-remote",
-          "--foreground",
-          "about:blank",
-        )
-        at_exit { proc.kill }
-        trap(:INT) { proc.kill ; exit 130 }
-        trap(:TERM) { proc.kill ; proc.dispose }
-        trap(:HUP) { proc.kill ; proc.dispose }
+      proc = BrowserProcess.new(
+        Firefox.discover_binary,
+        *args,
+        "about:blank",
+      )
+      at_exit do
+        proc.kill
+        FileUtils.remove_entry(tmp)
+      end
+      trap(:INT) { proc.kill ; exit 130 }
+      trap(:TERM) { proc.kill ; proc.dispose }
+      trap(:HUP) { proc.kill ; proc.dispose }
 
-        endpoint = wait_for_ws_endpoint(proc)
+      endpoint = wait_for_ws_endpoint(proc)
 
-        Async::Reactor.run do
-          Async::WebSocket::Client.connect(Async::HTTP::Endpoint.parse("#{endpoint}/session")) do |async_websocket_connection|
-            browser = Browser.new(async_websocket_connection)
-            begin
-              block.call(browser)
-            ensure
-              browser.close
-            end
+      Async::Reactor.run do
+        Async::WebSocket::Client.connect(Async::HTTP::Endpoint.parse("#{endpoint}/session")) do |async_websocket_connection|
+          browser = Browser.new(async_websocket_connection)
+          begin
+            block.call(browser)
+          ensure
+            browser.close
           end
         end
       end

data/lib/minibidi/input.rb

@@ -0,0 +1,298 @@
+module Minibidi
+  class Input
+    def initialize(browser_context)
+      @browser_context = browser_context
+    end
+
+    def click(x:, y:, delay: 50)
+      perform_mouse_actions do |q|
+        q.pointer_move(x: x.to_i, y: y.to_i)
+        q.pointer_down(button: 0)
+        q.pause(delay)
+        q.pointer_up(button: 0)
+      end
+    end
+
+    def while_pressing_key(key, &block)
+      value = convert_key(key)
+      perform_keyboard_actions do |q|
+        q.key_down(value)
+      end
+
+      begin
+        block.call
+      ensure
+        perform_keyboard_actions do |q|
+          q.key_up(value)
+        end
+      end
+    end
+
+    def press_key(key, delay: 50)
+      value = convert_key(key)
+      perform_keyboard_actions do |q|
+        q.key_down(value)
+        q.pause(delay)
+        q.key_up(value)
+      end
+    end
+
+    def type_text(text, delay: 50)
+      text.each_char do |char|
+        perform_keyboard_actions do |q|
+          q.key_down(char)
+          q.pause(delay / 2)
+          q.key_up(char)
+          q.pause(delay / 2)
+        end
+      end
+    end
+
+    private
+
+    def perform_actions(actions)
+      @browser_context.send(:bidi_call_async, 'input.performActions', {
+        actions: actions,
+      }).wait
+    end
+
+    def perform_keyboard_actions(&block)
+      q = KeyboardActionQueue.new
+      block.call(q)
+      perform_actions([{
+        type: 'key',
+        id: '__minibidi_keyboard',
+        actions: q.to_a,
+      }])
+    end
+
+    def perform_mouse_actions(&block)
+      q = MouseActionQueue.new
+      block.call(q)
+      perform_actions([{
+        type: 'pointer',
+        id: '__minibidi_mouse',
+        actions: q.to_a,
+      }])
+    end
+
+    def macos?
+      RUBY_PLATFORM =~ /darwin/
+    end
+
+    # ref: https://github.com/puppeteer/puppeteer/blob/puppeteer-v23.5.3/packages/puppeteer-core/src/bidi/Input.ts#L52
+    # Converted using ChatGPT 4o
+    def convert_key(key)
+      return key if key.length == 1
+
+      case key
+      when 'Cancel'
+        "\uE001"
+      when 'Help'
+        "\uE002"
+      when 'Backspace'
+        "\uE003"
+      when 'Tab'
+        "\uE004"
+      when 'Clear'
+        "\uE005"
+      when 'Enter'
+        "\uE007"
+      when 'Shift', 'ShiftLeft'
+        "\uE008"
+      when 'Control', 'ControlLeft', 'Ctrl'
+        "\uE009"
+      when 'ControlOrMeta', 'CtrlOrMeta'
+        macos? ? "\uE03D" : "\uE009"
+      when 'Alt', 'AltLeft'
+        "\uE00A"
+      when 'Pause'
+        "\uE00B"
+      when 'Escape'
+        "\uE00C"
+      when 'PageUp'
+        "\uE00E"
+      when 'PageDown'
+        "\uE00F"
+      when 'End'
+        "\uE010"
+      when 'Home'
+        "\uE011"
+      when 'ArrowLeft'
+        "\uE012"
+      when 'ArrowUp'
+        "\uE013"
+      when 'ArrowRight'
+        "\uE014"
+      when 'ArrowDown'
+        "\uE015"
+      when 'Insert'
+        "\uE016"
+      when 'Delete'
+        "\uE017"
+      when 'NumpadEqual'
+        "\uE019"
+      when 'Numpad0'
+        "\uE01A"
+      when 'Numpad1'
+        "\uE01B"
+      when 'Numpad2'
+        "\uE01C"
+      when 'Numpad3'
+        "\uE01D"
+      when 'Numpad4'
+        "\uE01E"
+      when 'Numpad5'
+        "\uE01F"
+      when 'Numpad6'
+        "\uE020"
+      when 'Numpad7'
+        "\uE021"
+      when 'Numpad8'
+        "\uE022"
+      when 'Numpad9'
+        "\uE023"
+      when 'NumpadMultiply'
+        "\uE024"
+      when 'NumpadAdd'
+        "\uE025"
+      when 'NumpadSubtract'
+        "\uE027"
+      when 'NumpadDecimal'
+        "\uE028"
+      when 'NumpadDivide'
+        "\uE029"
+      when 'F1'
+        "\uE031"
+      when 'F2'
+        "\uE032"
+      when 'F3'
+        "\uE033"
+      when 'F4'
+        "\uE034"
+      when 'F5'
+        "\uE035"
+      when 'F6'
+        "\uE036"
+      when 'F7'
+        "\uE037"
+      when 'F8'
+        "\uE038"
+      when 'F9'
+        "\uE039"
+      when 'F10'
+        "\uE03A"
+      when 'F11'
+        "\uE03B"
+      when 'F12'
+        "\uE03C"
+      when 'Meta', 'MetaLeft'
+        "\uE03D"
+      when 'ShiftRight'
+        "\uE050"
+      when 'ControlRight'
+        "\uE051"
+      when 'AltRight'
+        "\uE052"
+      when 'MetaRight'
+        "\uE053"
+      when 'Digit0'
+        '0'
+      when 'Digit1'
+        '1'
+      when 'Digit2'
+        '2'
+      when 'Digit3'
+        '3'
+      when 'Digit4'
+        '4'
+      when 'Digit5'
+        '5'
+      when 'Digit6'
+        '6'
+      when 'Digit7'
+        '7'
+      when 'Digit8'
+        '8'
+      when 'Digit9'
+        '9'
+      when 'KeyA'
+        'a'
+      when 'KeyB'
+        'b'
+      when 'KeyC'
+        'c'
+      when 'KeyD'
+        'd'
+      when 'KeyE'
+        'e'
+      when 'KeyF'
+        'f'
+      when 'KeyG'
+        'g'
+      when 'KeyH'
+        'h'
+      when 'KeyI'
+        'i'
+      when 'KeyJ'
+        'j'
+      when 'KeyK'
+        'k'
+      when 'KeyL'
+        'l'
+      when 'KeyM'
+        'm'
+      when 'KeyN'
+        'n'
+      when 'KeyO'
+        'o'
+      when 'KeyP'
+        'p'
+      when 'KeyQ'
+        'q'
+      when 'KeyR'
+        'r'
+      when 'KeyS'
+        's'
+      when 'KeyT'
+        't'
+      when 'KeyU'
+        'u'
+      when 'KeyV'
+        'v'
+      when 'KeyW'
+        'w'
+      when 'KeyX'
+        'x'
+      when 'KeyY'
+        'y'
+      when 'KeyZ'
+        'z'
+      when 'Semicolon'
+        ';'
+      when 'Equal'
+        '='
+      when 'Comma'
+        ','
+      when 'Minus'
+        '-'
+      when 'Period'
+        '.'
+      when 'Slash'
+        '/'
+      when 'Backquote'
+        '`'
+      when 'BracketLeft'
+        '['
+      when 'Backslash'
+        '\\'
+      when 'BracketRight'
+        ']'
+      when 'Quote'
+        '"'
+      else
+        raise ArgumentError, "Unknown key: \"#{key}\""
+      end
+    end
+  end
+end

data/lib/minibidi/keyboard_action_queue.rb

@@ -0,0 +1,23 @@
+module Minibidi
+  class KeyboardActionQueue
+    def initialize
+      @actions = []
+    end
+
+    def to_a
+      @actions
+    end
+
+    def pause(duration)
+      @actions << { type: 'pause', duration: duration }
+    end
+
+    def key_down(value)
+      @actions << { type: 'keyDown', value: value }
+    end
+
+    def key_up(value)
+      @actions << { type: 'keyUp', value: value }
+    end
+  end
+end

data/lib/minibidi/mouse_action_queue.rb

@@ -0,0 +1,29 @@
+module Minibidi
+  class MouseActionQueue
+    def initialize
+      @actions = []
+    end
+
+    def to_a
+      @actions
+    end
+
+    def pause(duration)
+      @actions << { type: 'pause', duration: duration }
+    end
+
+    # button: 0 for left, 1 for middle, 2 for right
+    def pointer_down(button:)
+      @actions << { type: 'pointerDown', button: button }
+    end
+
+    def pointer_move(x:, y:, duration: nil)
+      @actions << { type: 'pointerMove', x: x, y: y, duration: duration }.compact
+    end
+
+    # button: 0 for left, 1 for middle, 2 for right
+    def pointer_up(button:)
+      @actions << { type: 'pointerUp', button: button }
+    end
+  end
+end

data/lib/minibidi/realm.rb

@@ -0,0 +1,76 @@
+module Minibidi
+  class Realm
+    def initialize(browsing_context:, id:, origin:, type: nil)
+      @browsing_context = browsing_context
+      @id = id
+      @origin = origin
+      @type = type
+    end
+
+    class ScriptEvaluationError < StandardError ; end
+
+    def script_evaluate(expression)
+      result = @browsing_context.send(:bidi_call_async, 'script.evaluate', {
+        expression: expression,
+        target: { realm: @id },
+        awaitPromise: true,
+      }).wait
+
+      if result[:type] == 'exception'
+        raise ScriptEvaluationError.new(result[:exceptionDetails][:text])
+      end
+
+      deserialize(result[:result])
+    end
+
+    attr_reader :type
+
+    private
+
+    def deserialize(result)
+      # ref: https://github.com/puppeteer/puppeteer/blob/puppeteer-v23.5.3/packages/puppeteer-core/src/bidi/Deserializer.ts#L21
+      # Converted using ChatGPT 4o
+      case result[:type]
+      when 'array'
+        result[:value]&.map { |value| deserialize(value) }
+      when 'set'
+        result[:value]&.each_with_object(Set.new) do |value, acc|
+          acc.add(deserialize(value))
+        end
+      when 'object'
+        result[:value]&.each_with_object({}) do |tuple, acc|
+          key, value = tuple
+          acc[key] = deserialize(value)
+        end
+      when 'map'
+        result[:value]&.each_with_object({}) do |tuple, acc|
+          key, value = tuple
+          acc[key] = deserialize(value)
+        end
+      when 'promise'
+        {}
+      when 'regexp'
+        flags = 0
+        result[:value][:flags]&.each_char do |flag|
+          case flag
+          when 'm'
+            flags |= Regexp::MULTILINE
+          when 'i'
+            flags |= Regexp::IGNORECASE
+          end
+        end
+        Regexp.new(result[:value][:pattern], flags)
+      when 'date'
+        Date.parse(result[:value])
+      when 'undefined'
+        nil
+      when 'null'
+        nil
+      when 'number', 'bigint', 'boolean', 'string'
+        result[:value]
+      else
+        raise ArgumentError, "Unknown type: #{result[:type]}"
+      end
+    end
+  end
+end

data/lib/minibidi/version.rb

@@ -1,3 +1,3 @@
 module Minibidi
-  VERSION = '0.0.0'
+  VERSION = '0.1.0'
 end

data/lib/minibidi.rb

@@ -3,8 +3,11 @@ require "minibidi/version"
 require 'minibidi/browser'
 require 'minibidi/browsing_context'
 require 'minibidi/browser_process'
-require 'minibidi/firefox'
 require 'minibidi/firefox_launcher'
+require 'minibidi/input'
+require 'minibidi/keyboard_action_queue'
+require 'minibidi/mouse_action_queue'
+require 'minibidi/realm'
 
 module Minibidi
   class LaunchError < StandardError ; end

data/minibidi.gemspec

@@ -25,8 +25,4 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 3.2" # Dependency for socketry/async and Data.define
   spec.add_dependency "async"
   spec.add_dependency "async-websocket"
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "minitest"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: minibidi
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - YusukeIwaki
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-08 00:00:00.000000000 Z
+date: 2024-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -38,62 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 
 email:
 - q7w8e9w8q7w8e9@yahoo.co.jp
@@ -110,8 +54,11 @@ files:
 - lib/minibidi/browser.rb
 - lib/minibidi/browser_process.rb
 - lib/minibidi/browsing_context.rb
-- lib/minibidi/firefox.rb
 - lib/minibidi/firefox_launcher.rb
+- lib/minibidi/input.rb
+- lib/minibidi/keyboard_action_queue.rb
+- lib/minibidi/mouse_action_queue.rb
+- lib/minibidi/realm.rb
 - lib/minibidi/version.rb
 - minibidi.gemspec
 homepage: https://github.com/YusukeIwaki/minibidi
@@ -133,7 +80,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: Mini WebDriver BiDi binding for Ruby

data/lib/minibidi/firefox.rb

@@ -1,7 +0,0 @@
-module Minibidi
-  class Firefox
-    def self.launch(&block)
-      FirefoxLauncher.new.launch(&block)
-    end
-  end
-end