Module: Obxcura

Defined in:

lib/obxcura.rb,
lib/obxcura/node.rb,
lib/obxcura/page.rb,
lib/obxcura/frame.rb,
lib/obxcura/client.rb,
lib/obxcura/browser.rb,
lib/obxcura/version.rb,
lib/obxcura/frame/dom.rb,
lib/obxcura/frame/runtime.rb

Overview

Top-level namespace for the gem: a small Ruby client that drives an Obscura headless browser over the Chrome DevTools Protocol. See the file header above for the big picture; start from Obxcura.start or Browser.

Defined Under Namespace

Classes: Browser, Client, ConnectionError, Error, Frame, Node, Page, ProtocolError, TimeoutError

Constant Summary

VERSION =

The gem's semantic version string.

Returns:

• (String)

"0.1.1"

Class Method Summary

• .start(**options) ⇒ Obxcura::Browser

  Connect to a running obscura serve and return a Browser.

Class Method Details

.start(**options) ⇒ Obxcura::Browser

Connect to a running obscura serve and return a Browser.

Examples:

browser = Obxcura.start(port: 9222)
page    = browser.go_to("https://example.com")
browser.quit

Parameters:

• options (Hash) —

  forwarded to Obxcura::Browser#initialize (:host, :port, :timeout).

Returns:

• (Obxcura::Browser) —

  a connected browser.

Raises:

• (Obxcura::ConnectionError) —

  if no browser is listening.

# File 'lib/obxcura.rb', line 57

def self.start(**options)
  Browser.new(**options)
end