ferrum下载ferrum源代码下载

Ferrum-高级API控制Ruby中的Chrome

像木偶一样简单，尽管更简单。

它是红宝石干净的，高级的API到Chrome。默认情况下，无头运行，但是您可以将其配置为以头部模式运行。您只需要Ruby，Chrome或Chromium。 Ferrum通过CDP协议连接到浏览器，并且没有Selenium/Web Driver/Chromedriver依赖性。重点是对RAW CDP协议的重点，因为Chrome允许您做很多Web Driver几乎没有支持的事情，因为它应该与其他浏览器具有一致的设计。

Cuprite是基于Ferrum的Capybara的纯红宝司机。如果您要去爬网站，则最好因为爬行而不是测试，因此最好使用Ferrum或船只。
船只基于Ferrum和机械化的高级网络爬行框架。

指数

安装
例子
Docker
定制
导航
发现者
屏幕截图
网络
下载
代理人
老鼠
键盘
曲奇饼
标题
JavaScript
帧
框架
对话
动画片
节点
跟踪
清理
线程安全
发展
贡献
执照

安装

Linux没有官方的铬或铬套件不会以这种方式安装，因为它已经过时或非正式，都不好。从Chrome或Chromium的官方来源下载它。 Chrome Binary应该在PATH或BROWSER_PATH中，您可以将其作为选项将其传递给浏览器实例，请参见:browser_path在自定义中。

将其添加到您的Gemfile并运行bundle install 。

 gem "ferrum"

例子

导航到网站并保存屏幕截图：

 browser = Ferrum :: Browser . new
browser . go_to ( "https://google.com" )
browser . screenshot ( path : "google.png" )
browser . quit

当您使用浏览器实例Ferrum为您创建并维护一个默认页面时，实际上，上面的所有方法都发送到browser实例的default_context中创建的page实例。您可以与手动创建的页面进行交互，这是首选：

 browser = Ferrum :: Browser . new
page = browser . create_page
page . go_to ( "https://google.com" )
input = page . at_xpath ( "//input[@name='q']" )
input . focus . type ( "Ruby headless driver for Chrome" , :Enter )
page . at_css ( "a > h3" ) . text # => "rubycdp/ferrum: Ruby Chrome/Chromium driver - GitHub"
browser . quit

评估一些JavaScript并获得全宽/高度：

 browser = Ferrum :: Browser . new
page = browser . create_page
page . go_to ( "https://www.google.com/search?q=Ruby+headless+driver+for+Capybara" )
width , height = page . evaluate <<~JS
  [document.documentElement.offsetWidth,
   document.documentElement.offsetHeight]
JS
# => [1024, 1931]
browser . quit

执行您喜欢的任何鼠标动作：

 # Trace a 100x100 square
browser = Ferrum :: Browser . new
page = browser . create_page
page . go_to ( "https://google.com" )
page . mouse
  . move ( x : 0 , y : 0 )
  . down
  . move ( x : 0 , y : 100 )
  . move ( x : 100 , y : 100 )
  . move ( x : 100 , y : 0 )
  . move ( x : 0 , y : 0 )
  . up

browser . quit

Docker

在Docker中，您必须传递No-SandBox浏览器选项：

 Ferrum :: Browser . new ( browser_options : { 'no-sandbox' : nil } )

还报道说，在M1 MAC上跑到Docker容器中时，Chrome过程反复崩溃，以防止Ferrum工作。当在非M1 Mac上部署到Docker容器时，Ferrum应按预期工作。

定制

您可以在测试设置中使用以下代码自定义选项：

 Ferrum :: Browser . new ( options )

选项Hash
- :headless true情况下，将浏览器设置为无头或无头。您可以设置"new"以支持新的无头模式。
- :xvfb （boolean） - 在虚拟框架器中运行浏览器，默认情况下为false 。
- :flatten （Boolean） - 使用一个Websocket连接到浏览器和所有页面以平坦模式。
- :window_size （array） - 浏览器窗口的尺寸在其中测试，以2个元素数组表示，例如[1024，768]。默认值：[1024，768]
- :extensions （array [string | hash]） - 文件或js源代码的一系列路径，要预加载到浏览器中： ["/path/to/script.js", { source: "window.secret = 'top'" }]
- :logger （对象响应puts ） - 当存在时，将调试输出写入此对象。
- :slowmo （integer | float） - 在发送命令之前将延迟设置为几秒钟。无头选项的有用伴侣，因此您有时间看到更改。
- :timeout （数字） - 与浏览器通信时，我们将等待响应的秒数。默认值为5。
- :js_errors （布尔值） - 当Ruby中，JavaScript错误会重新升高。
- :pending_connection_errors （boolean） - 当主帧仍在等待缓慢的响应时，请及时提高PendingConnectionsError 。最好弄清楚为什么您的响应缓慢，修复或阻止它们，而不是关闭此设置。默认是正确的。
- :browser_name （符号） - :chrome ，仅实验支持:firefox 。
- :browser_path （string） - 通往Chrome二进制的路径，您还可以将ENV变量设置为BROWSER_PATH=some/path/chrome bundle exec rspec 。
- :browser_options （hash） - 附加命令行选项，请参阅所有内容，例如{ "ignore-certificate-errors" => nil }
- :ignore_default_browser_options （boolean） - Ferrum具有将其传递给浏览器的许多默认选项，如果将其设置为true ，则只有您放入的选项:browser_options将传递给浏览器，除了必需的选项。
- :port （整数） - 无头铬的远程调试端口。
- :host （字符串） - 无头铬的远程调试地址。
- :url （string） - Chrome运行实例的URL。如果设置此设置，则不会产生浏览器过程。
- :ws_url （String） - Chrome运行实例的WebSocket URL。如果设置此设置，则不会产生浏览器过程。优先级高于:url ，设置两者都没有意义。
- :process_timeout （integer） - 等待铬流程在启动时响应多长时间。
- :ws_max_receive_size （INTEGER） - 在字节中从Web插座上接受Chrome的大消息。默认为64MB。传入的消息大于此会导致Ferrum::DeadBrowserError 。
- :proxy （哈希） - 指定代理设置，阅读更多
- :save_path （string） - 用内容分配标头保存附件的路径。
- :env （哈希） - 您想通过的环境变量

发现者

AT_CSS（选择器，**选项）： `Node` | `nil`

通过选择器查找节点。在文档中运行document.querySelector或提供节点。

选择器String
选项Hash
- ：在Node |中nil

 page . go_to ( "https://github.com/" )
page . at_css ( "a[aria-label='Issues you created']" ) # => Node

CSS（选择器，**选项）： `Array<Node>` | `[]`

通过选择器查找节点。该方法在文档中运行document.querySelectorAll或提供的节点。

选择器String
选项Hash
- ：在Node |中nil

 page . go_to ( "https://github.com/" )
page . css ( "a[aria-label='Issues you created']" ) # => [Node]

at_xpath（选择器，**选项）： `Node` | `nil`

通过XPath查找节点。

选择器String
选项Hash
- ：在Node |中nil

 page . go_to ( "https://github.com/" )
page . at_xpath ( "//a[@aria-label='Issues you created']" ) # => Node

XPATH（选择器，**选项）： `Array<Node>` | `[]`

通过XPath查找节点。

选择器String
选项Hash
- ：在Node |中nil

 page . go_to ( "https://github.com/" )
page . xpath ( "//a[@aria-label='Issues you created']" ) # => [Node]

current_url： `String`

返回当前顶部窗口位置HREF。

 page . go_to ( "https://google.com/" )
page . current_url # => "https://www.google.com/"

current_title： `String`

返回当前顶部窗口标题

 page . go_to ( "https://google.com/" )
page . current_title # => "Google"

身体： `String`

返回当前页面的HTML。

 page . go_to ( "https://google.com/" )
page . body # => '<html itemscope="" itemtype="http://schema.org/WebPage" lang="ru"><head>...

屏幕截图

屏幕截图（**选项）： `String` | `Integer`

将屏幕截图保存在磁盘上或将其返回为基本64。

选项Hash
- ：路径String以在磁盘上保存屏幕快照。 :encoding将设置为:binary
- ：编码Symbol :base64 | :binary您可以将其设置为返回图像为base64
- ：格式String “ jpeg”（“ jpg”）| “ PNG” | “ WebP”
- ：质量Integer 0-100仅适用于JPEG
- ：Full Boolean无论您需要全页屏幕截图还是视图
- ：选择器String CSS选择器给定元素，可选
- ：屏幕截图的区域Hash区域可选
  - ：X Integer
  - ：Y Integer
  - ：宽度Integer
  - ：高度Integer
- ：秤Float缩放进出
- :: Color Ferrum::RGBA.new(0, 0, 0, 0.0)具有特定的背景颜色

 page . go_to ( "https://google.com/" )
# Save on the disk in PNG
page . screenshot ( path : "google.png" ) # => 134660
# Save on the disk in JPG
page . screenshot ( path : "google.jpg" ) # => 30902
# Save to Base64 the whole page not only viewport and reduce quality
page . screenshot ( full : true , quality : 60 , encoding : :base64 ) # "iVBORw0KGgoAAAANSUhEUgAABAAAAAMACAYAAAC6uhUNAAAAAXNSR0IArs4c6Q...
# Save on the disk with the selected element in PNG
page . screenshot ( path : "google.png" , selector : 'textarea' ) # => 11340
# Save to Base64 with an area of the page in PNG
page . screenshot ( path : "google.png" , area : { x : 0 , y : 0 , width : 400 , height : 300 } ) # => 54239
# Save with specific background color
page . screenshot ( background_color : Ferrum :: RGBA . new ( 0 , 0 , 0 , 0.0 ) )

PDF（**选项）： `String` | `Boolean`

将PDF保存在磁盘上或将其返回为base64。

选项Hash
- ：路径String以将PDF保存在磁盘上。 :encoding将设置为:binary
- ：编码Symbol :base64 | :binary您可以将其设置为返回pdf为base64
- ：景观Boolean纸取向。默认为false。
- ：秤Float缩放进出
- ：格式symbol标准纸尺寸：字母，：法律，：小报，：分类帐，：a0，：a1，：a2，：a3，：a3，：a4，：a4，：a5，：a6
- ：paper_width Float设置纸张宽度
- ：paper_height Float设置纸张高度
- 查看您可以通过的其他本地选项

 page . go_to ( "https://google.com/" )
# Save to disk as a PDF
page . pdf ( path : "google.pdf" , paper_width : 1.0 , paper_height : 1.0 ) # => true

MHTML（**选项）： `String` | `Integer`

将MHTML保存在磁盘上或将其返回为字符串。

选项Hash
- ：路径String以将文件保存在磁盘上。

 page . go_to ( "https://google.com/" )
page . mhtml ( path : "google.mhtml" ) # => 87742

网络

page.network

流量`Array<Network::Exchange>`

将有关网络流量的所有信息返回Network::Exchange实例，通常是围绕request ， response和error包装器。

 page . go_to ( "https://github.com/" )
page . network . traffic # => [#<Ferrum::Network::Exchange, ...]

请求： `Network::Request`

主帧的页面请求。

 page . go_to ( "https://github.com/" )
page . network . request # => #<Ferrum::Network::Request...

响应： `Network::Response`

主帧的页面响应。

 page . go_to ( "https://github.com/" )
page . network . response # => #<Ferrum::Network::Response...

状态： `Integer`

包含主页响应的状态代码（例如，成功的200）。这只是response.status的快捷方式。

 page . go_to ( "https://github.com/" )
page . network . status # => 200

wait_for_idle（**选项）： `Boolean`

等待网络空闲，在成功的情况下返回true ，如果仍然存在连接，则false 。

选项Hash
- ：连接Integer允许网络闲置多少个连接，默认为0
- ：持续时间Float睡眠时间给定时间和再次检查，默认情况下为0.05
- ：timeout Float在我们什么时候尝试检查idle， browser.timeout默认情况下

 page . go_to ( "https://example.com/" )
page . at_xpath ( "//a[text() = 'No UI changes button']" ) . click
page . network . wait_for_idle # => true

wait_for_idle！（**选项）

等待网络空闲或增加Ferrum::TimeoutError错误。接受与wait_for_idle相同的参数。

 page . go_to ( "https://example.com/" )
page . at_xpath ( "//a[text() = 'No UI changes button']" ) . click
page . network . wait_for_idle! # might raise an error

清除（类型）

清除页面的缓存或收集的流量。

键入Symbol是:traffic或:cache

 traffic = page . network . traffic # => []
page . go_to ( "https://github.com/" )
traffic . size # => 51
page . network . clear ( :traffic )
traffic . size # => 0

拦截（**选项）

设置给定选项的请求拦截。此方法仅设置请求拦截，您应on回调上使用来捕获请求并流产或继续。

选项Hash
- ：默认情况下模式String *
- ：resource_type Symbol其中一种资源类型之一

 browser = Ferrum :: Browser . new
page = browser . create_page
page . network . intercept
page . on ( :request ) do | request |
  if request . match? ( /bla-bla/ )
    request . abort
  elsif request . match? ( /lorem/ )
    request . respond ( body : "Lorem ipsum" )
  else
    request . continue
  end
end
page . go_to ( "https://google.com" )

授权（**选项，＆块）

如果网站或代理使用授权，则可以使用此方法提供凭据。

选项Hash
- ：类型Symbol :server | :proxy网站或代理授权
- ：用户String
- ：密码String
＆Block接受已验证的请求，如果您不关心不需要的请求，则必须随后允许或拒绝，只需致电request.continue 。

 page . network . authorize ( user : "login" , password : "pass" ) { | req | req . continue }
page . go_to ( "http://example.com/authenticated" )
puts page . network . status # => 200
puts page . body # => Welcome, authenticated client

由于Chrome使用请求拦截实施授权，因此您必须继续或中止授权请求。如果您已经有使用拦截的代码，则可以在没有块的情况下使用authorize ，但是如果不是，则您必须通过块，因此这是版本不会通过块，并且可以正常工作：

 browser = Ferrum :: Browser . new
page = browser . create_page
page . network . intercept
page . on ( :request ) do | request |
  if request . resource_type == "Image"
    request . abort
  else
    request . continue
  end
end

page . network . authorize ( user : "login" , password : "pass" , type : :proxy )

page . go_to ( "https://google.com" )

您曾经调用authorize方法无块，但是由于使用请求拦截实现了它，因此代码的另一部分也可能会发生碰撞，该代码也使用请求拦截，因此授权允许请求，而您的代码拒绝，但为时已晚。现在是强制性的。

emulate_network_conditions（**选项）

激活网络条件的仿真。

选项Hash
- ：离线Boolean模仿互联网断开，默认为false
- ：延迟Integer最小延迟，从发送到收到的响应标头（MS），默认为0
- ：download_throughtup Integer最大汇总下载吞吐量（bytes/sec）， -1默认情况下，禁用下载throttling
- ：upload_throughput Integer最大汇总上传吞吐量（bytes/sec）， -1默认情况下，禁用下载throttling
- ：Connection_Type String连接类型如果已知，则是：无：cellular2g，cellular3g，cellular4g，蓝牙，以太网，wifi，wimax，其他。默认情况nil

 page . network . emulate_network_conditions ( connection_type : "cellular2g" )
page . go_to ( "https://github.com/" )

OFFLINE_MODE

激活页面的离线模式。

 page . network . offline_mode
page . go_to ( "https://github.com/" ) # => Ferrum::StatusError (Request to https://github.com/ failed(net::ERR_INTERNET_DISCONNECTED))

缓存（禁用： `Boolean` ）

为每个请求切换忽略缓存。如果是真的，将不会使用缓存。

 page . network . cache ( disable : true )

下载

page.downloads

文件`Array<Hash>`

返回有关下载文件作为Hash所有信息。

 page . go_to ( "http://localhost/attachment.pdf" )
page . downloads . files # => [{"frameId"=>"E3316DF1B5383D38F8ADF7485005FDE3", "guid"=>"11a68745-98ac-4d54-9b57-9f9016c268b3", "url"=>"http://localhost/attachment.pdf", "suggestedFilename"=>"attachment.pdf", "totalBytes"=>4911, "receivedBytes"=>4911, "state"=>"completed"}]

等待（超时）

等到下载完成。

 page . go_to ( "http://localhost/attachment.pdf" )
page . downloads . wait

或者

 page . go_to ( "http://localhost/page" )
page . downloads . wait { page . at_css ( "#download" ) . click }

set_behavior（**选项）

在要下载文件的情况下设置行为。

选项Hash
- ：save_path String绝对路径在哪里存储文件
- ：行为Symbol deny | allow | allowAndName | default ，默认情况下allow

 page . go_to ( "https://example.com/" )
page . downloads . set_behavior ( save_path : "/tmp" , behavior : :allow )

代理人

您可以设置一个具有:proxy选项的代理：

 Ferrum :: Browser . new ( proxy : { host : "x.x.x.x" , port : "8800" , user : "user" , password : "pa$$" } )

:bypass可以指定不应使用代理的主机的半彩色分隔列表：

 Ferrum :: Browser . new ( proxy : { host : "x.x.x.x" , port : "8800" , bypass : "*.google.com;*foo.com" } )

通常，在实例化浏览器时传递代理选项会导致具有代理命令行标志运行的浏览器，从而影响所有页面和上下文。您可以在新上下文中创建一个页面，该页面可以使用自己的代理设置：

 browser = Ferrum :: Browser . new

browser . create_page ( proxy : { host : "x.x.x.x" , port : 31337 , user : "user" , password : "password" } ) do | page |
  page . go_to ( "https://api.ipify.org?format=json" )
  page . body # => "x.x.x.x"
end

browser . create_page ( proxy : { host : "y.y.y.y" , port : 31337 , user : "user" , password : "password" } ) do | page |
  page . go_to ( "https://api.ipify.org?format=json" )
  page . body # => "y.y.y.y"
end

老鼠

page.mouse

scroll_to（x，y）

滚动页到给定的x，y

x Integer沿着您想要显示在左上方显示的文档的水平轴的像素
y Integer沿着您想要显示在左上方的文档的垂直轴的像素

 page . go_to ( "https://www.google.com/search?q=Ruby+headless+driver+for+Capybara" )
page . mouse . scroll_to ( 0 , 400 )

单击（**选项）： `Mouse`

单击给定的坐标，启动鼠标移动，向下和向上事件。

选项Hash
- ：X Integer
- ：Y Integer
- ：延迟Float默认值为0。鼠标向下和鼠标UP事件之间的延迟
- ：按钮Symbol ：左| ：对，默认为：左
- ：计数Integer默认为1
- ：修改器Integer BITFIELD，用于关键修饰符。请参阅keyboard.modifiers

下（**选项）： `Mouse`

鼠标降低给定坐标。

选项Hash
- ：按钮Symbol ：左| ：对，默认为：左
- ：计数Integer默认为1
- ：修改器Integer BITFIELD，用于关键修饰符。请参阅keyboard.modifiers

向上（**选项）： `Mouse`

鼠标以给定坐标。

选项Hash
- ：按钮Symbol ：左| ：对，默认为：左
- ：计数Integer默认为1
- ：修改器Integer BITFIELD，用于关键修饰符。请参阅keyboard.modifiers

移动（x：,, y：，步骤：1）： `Mouse`

鼠标移动给定X和Y。

选项Hash
- ：X Integer
- ：Y Integer
- ：步骤Integer默认为1。发送中间的Mousemove事件。

键盘

page.keyboard

向下（键）： `Keyboard`

调度键盘事件。

键String |键的Symbol名称，例如“ a”，：enter，：backpace

向上（键）： `Keyboard`

派遣关键事件。

键String |键的Symbol名称，例如“ B”，：Enter，：Backspace

类型（*键）： `Keyboard`

为文本中的每个字符发送一个键down，按键/输入和键盘事件。

文本String | Array<String> | Array<Symbol>一个要输入重点元素的文本， [:Shift, "s"], "tring"

修饰符（键）： `Integer`

返回给定键的Bitfield

钥匙Array<Symbol> ：alt | ：ctrl | ：命令| ：转移

曲奇饼

page.cookies

全部： `Hash<String, Cookie>`

返回饼干哈希

 page . cookies . all # => {"NID"=>#<Ferrum::Cookies::Cookie:0x0000558624b37a40 @attributes={"name"=>"NID", "value"=>"...", "domain"=>".google.com", "path"=>"/", "expires"=>1583211046.575681, "size"=>178, "httpOnly"=>true, "secure"=>false, "session"=>false}>}

： `Cookie`

返回cookie

值String

 page . cookies [ "NID" ] # => <Ferrum::Cookies::Cookie:0x0000558624b67a88 @attributes={"name"=>"NID", "value"=>"...", "domain"=>".google.com", "path"=>"/", "expires"=>1583211046.575681, "size"=>178, "httpOnly"=>true, "secure"=>false, "session"=>false}>

设置（值）： `Boolean`

设置一个cookie

值Hash
- ：名称String
- ：值String
- ：域String
- ：到期Integer
- ：samesite String
- ：httponly Boolean

 page . cookies . set ( name : "stealth" , value : "omg" , domain : "google.com" ) # => true

价值Cookie

 nid_cookie = page . cookies [ "NID" ] # => <Ferrum::Cookies::Cookie:0x0000558624b67a88>
page . cookies . set ( nid_cookie ) # => true

删除（**选项）： `Boolean`

去除给定饼干

选项Hash
- ：名称String
- ：域String
- ：URL String

 page . cookies . remove ( name : "stealth" , domain : "google.com" ) # => true

透明： `Boolean`

删除当前页面的所有饼干

 page . cookies . clear # => true

商店（路径）： `Boolean`

将当前页面的所有cookie存储在文件中。

 # Cookies are saved into cookies.yml
page . cookies . store # => 15657

负载（路径）： `Boolean`

从文件中加载所有cookie，并将其设置为当前页面。

 # Cookies are loaded from cookies.yml
page . cookies . load # => true

标题

page.headers

得到： `Hash`

获取所有标题

设置（标题）： `Boolean`

设置给定标题。最终清除所有标题并设置给定标题。

标题Hash键值对例如"User-Agent" => "Browser"

添加（标题）： `Boolean`

将标题添加到已经设置的标题。

标题Hash键值对例如"Referer" => "http://example.com"

透明： `Boolean`

清除所有标题。

JavaScript

评估（表达， *args）

评估和返回结果给定的JS表达

表达式String应有效JavaScript
ARGS Object您可以通过参数，尽管它应该是有效的Node或一个简单的值。

 page . evaluate ( "[window.scrollX, window.scrollY]" )

evaluate_async（expression，wait_time， *args）

评估异步表达和返回结果

表达式String应有效JavaScript
WAIT_TIME我们应该等待多长时间才能承诺解决或拒绝
ARGS Object您可以通过参数，尽管它应该是有效的Node或一个简单的值。

 page . evaluate_async ( %(arguments[0]({foo: "bar"})) , 5 ) # => { "foo" => "bar" }

执行（表达式， *args）

执行表达式。不返回结果

表达式String应有效JavaScript
ARGS Object您可以通过参数，尽管它应该是有效的Node或一个简单的值。

 page . execute ( %(1 + 1) ) # => true

estuatue_on_new_document（表达式）

评估JavaScript以在页面加载之前修改事物

表达式String应有效JavaScript

 browser . evaluate_on_new_document <<~JS
  Object.defineProperty(navigator, "languages", {
    get: function() { return ["tlh"]; }
  });
JS

add_script_tag（**选项）： `Boolean`

选项Hash
- ：URL String
- ：路径String
- ：内容String
- ：键入String - 默认情况下text/javascript

 page . add_script_tag ( url : "http://example.com/stylesheet.css" ) # => true

add_style_tag（**选项）： `Boolean`

选项Hash
- ：URL String
- ：路径String
- ：内容String

 page . add_style_tag ( content : "h1 { font-size: 40px; }" ) # => true

Bypass_csp（**选项）： `Boolean`

选项Hash
- ：启用Boolean ，默认情况下为true

 page . bypass_csp # => true
page . go_to ( "https://github.com/ruby-concurrency/concurrent-ruby/blob/master/docs-source/promises.in.md" )
page . refresh
page . add_script_tag ( content : "window.__injected = 42" )
page . evaluate ( "window.__injected" ) # => 42

仿真

disable_javascript

从已加载的HTML源禁用JavaScript。您仍然可以通过evaluate或execute评估JavaScript。什么都没有返回。

 page . disable_javascript

set_viewport

覆盖设备屏幕尺寸并模拟视口。

选项Hash
- ：宽度Integer ，视口宽度。 0默认情况下
- ：高度Integer ，视口高。 0默认情况下
- ：scale_factor Float ，设备尺度因子。 0默认情况下
- ：移动Boolean ，是否模拟移动设备。默认情况下为false

 page . set_viewport ( width : 1000 , height : 600 , scale_factor : 3 )

帧

帧： `Array[Frame] | []`

返回所有帧当前页面。

 page . go_to ( "https://www.w3schools.com/tags/tag_frame.asp" )
page . frames # =>
# [
#   #<Ferrum::Frame @id="C6D104CE454A025FBCF22B98DE612B12" @parent_id=nil @name=nil @state=:stopped_loading @execution_id=1>,
#   #<Ferrum::Frame @id="C09C4E4404314AAEAE85928EAC109A93" @parent_id="C6D104CE454A025FBCF22B98DE612B12" @state=:stopped_loading @execution_id=2>,
#   #<Ferrum::Frame @id="2E9C7F476ED09D87A42F2FEE3C6FBC3C" @parent_id="C6D104CE454A025FBCF22B98DE612B12" @state=:stopped_loading @execution_id=3>,
#   ...
# ]

main_frame： `Frame`

返回页面的主框架，树的顶部和所有框架的父。

frame_by（**选项）： `Frame | nil`

通过给定选项查找框架。

选项Hash
- ：ID String - 浏览器提供的唯一帧的ID
- ：名称String - 帧的名称如果有一个

 page . frame_by ( id : "C6D104CE454A025FBCF22B98DE612B12" )

框架

ID： `String`

框架的独特ID。

parent_id： `String | nil`

父框架ID如果该ID嵌套在另一个中。

execution_id： `Integer`

JS使用的执行上下文ID具有JS评估的其自身上下文。

名称： `String | nil`

如果给出一个名称，则应该在这里。

状态： `Symbol | nil`

州框架之一：

:started_loading
:navigated
:stopped_loading

URL： `String`

返回当前框架的位置HREF。

 page . go_to ( "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe" )
frame = page . frames [ 1 ]
frame . url # => https://interactive-examples.mdn.mozilla.net/pages/tabbed/iframe.html

标题

返回当前帧的标题。

 page . go_to ( "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe" )
frame = page . frames [ 1 ]
frame . title # => HTML Demo: <iframe>

主要的？： `Boolean`

如果当前框架是页面的主框架（树的顶部）。

 page . go_to ( "https://www.w3schools.com/tags/tag_frame.asp" )
frame = page . frame_by ( id : "C09C4E4404314AAEAE85928EAC109A93" )
frame . main? # => false

current_url： `String`

返回当前帧的顶部窗口位置HREF。

 page . go_to ( "https://www.w3schools.com/tags/tag_frame.asp" )
frame = page . frame_by ( id : "C09C4E4404314AAEAE85928EAC109A93" )
frame . current_url # => "https://www.w3schools.com/tags/tag_frame.asp"

current_title： `String`

返回当前帧的顶部窗口标题。

 page . go_to ( "https://www.w3schools.com/tags/tag_frame.asp" )
frame = page . frame_by ( id : "C09C4E4404314AAEAE85928EAC109A93" )
frame . current_title # => "HTML frame tag"

身体： `String`

返回当前帧的HTML。

 page . go_to ( "https://www.w3schools.com/tags/tag_frame.asp" )
frame = page . frame_by ( id : "C09C4E4404314AAEAE85928EAC109A93" )
frame . body # => "<html><head></head><body></body></html>"

Doctype

返回当前框架的医生。

 page . go_to ( "https://www.w3schools.com/tags/tag_frame.asp" )
page . main_frame . doctype # => "<!DOCTYPE html>"

content = html

设置给定帧的内容。

HTML String

 page . go_to ( "https://developer.mozilla.org/en-US/docs/Web/HTML/Element/iframe" )
frame = page . frames [ 1 ]
frame . body # <html lang="en"><head><style>body {transition: opacity ease-in 0.2s; }...
frame . content = "<html><head></head><body><p>lol</p></body></html>"
frame . body # => <html><head></head><body><p>lol</p></body></html>

对话

接受（文字）

接受给定文本或默认提示的对话框（如果适用）

文本String

解雇

解散对话

 page . on ( :dialog ) do | dialog |
  if dialog . match? ( /bla-bla/ )
    dialog . accept
  else
    dialog . dismiss
  end
end
page . go_to ( "https://google.com" )

动画片

您可以减慢或加快CSS动画的速度。

Playback_rate： `Integer`

返回CSS动画的播放率，默认为1 。

plokback_rate = value

设置CSS动画的播放率

价值Integer

 page . playback_rate = 2000
page . go_to ( "https://google.com" )
page . playback_rate # => 2000

节点

节点？： `Boolean`

frame_id

框架： `Frame`

返回当前节点的帧对象，您可以继续使用该对象的发现器：

 frame =  page . at_xpath ( "//iframe" ) . frame # => Frame
frame . at_css ( "//a[text() = 'Log in']" ) # => Node

重点

可集中？

移动？： `Boolean`

wait_for_stop_moving

模糊

类型

点击

徘徊

select_file

at_xpath

AT_CSS

X Path

CSS

文本

Inner_Text

价值

财产

属性

评价

选择： `Array<Node>`

选择

scroll_into_view

in_viewport？（of： `Node | nil` ）： `Boolean`

消除

存在？

（可链）通过传递属性选择选项。

 page . at_xpath ( "//*[select]" ) . select ( [ "1" ] ) # => Node (select)
page . at_xpath ( "//*[select]" ) . select ( [ "text" ] , by : :text ) # => Node (select)

接受字符串，数组或字符串：

 page . at_xpath ( "//*[select]" ) . select ( "1" )
page . at_xpath ( "//*[select]" ) . select ( "1" , "2" )
page . at_xpath ( "//*[select]" ) . select ( [ "1" , "2" ] )

跟踪

您可以使用tracing.record创建一个可以在Chrome DevTools或Timeline Viewer中打开的跟踪文件。

 page . tracing . record ( path : "trace.json" ) do
  page . go_to ( "https://www.google.com" )
end

tracing.record（**选项）： `String`

接受块，记录跟踪和默认情况下返回从Tracing.tracingComplete事件作为输出的跟踪数据。指定path时，将返回true ，并将跟踪数据存储到文件中。

选项Hash
- ：路径String在磁盘上保存数据，默认nil
- ：编码Symbol :base64 | :binary编码输出为base64或纯文本。 :binary
- ：timeout Float等到在指定的时间中文件流完成或增加错误，默认为nil
- ：屏幕截图Boolean捕获屏幕截图，默认为false
- ：trace_config Hash<String, Object> for trace，对于类别，请参见getCategories，每个浏览器一次只能有一个跟踪配置。

清理

重置

关闭浏览器实例打开的Browser选项卡。

 # connect to a long-running Chrome process
browser = Ferrum :: Browser . new ( url : 'http://localhost:9222' )

browser . go_to ( "https://github.com/" )

# clean up, lest the tab stays there hanging forever
browser . reset

browser . quit

线程安全

Ferrum是完全螺纹安全的。您可以根据需要创建一个浏览器或一些浏览器，然后开始使用线程进行播放。下面显示了如何创建一些共享相同上下文的页面。上下文类似于隐身配置文件，但是您可以拥有多个，可以将其视为独立浏览器会话：

 browser = Ferrum :: Browser . new
context = browser . contexts . create

t1 = Thread . new ( context ) do | c |
  page = c . create_page
  page . go_to ( "https://www.google.com/search?q=Ruby+headless+driver+for+Capybara" )
  page . screenshot ( path : "t1.png" )
end

t2 = Thread . new ( context ) do | c |
  page = c . create_page
  page . go_to ( "https://www.google.com/search?q=Ruby+static+typing" )
  page . screenshot ( path : "t2.png" )
end

t1 . join
t2 . join

context . dispose
browser . quit

或者您可以创建两个独立的上下文：

 browser = Ferrum :: Browser . new

t1 = Thread . new ( browser ) do | b |
  context = b . contexts . create
  page = context . create_page
  page . go_to ( "https://www.google.com/search?q=Ruby+headless+driver+for+Capybara" )
  page . screenshot ( path : "t1.png" )
  context . dispose
end

t2 = Thread . new ( browser ) do | b |
  context = b . contexts . create
  page = context . create_page
  page . go_to ( "https://www.google.com/search?q=Ruby+static+typing" )
  page . screenshot ( path : "t2.png" )
  context . dispose
end

t1 . join
t2 . join

browser . quit

发展

查看回购后，运行bundle install以安装依赖项。

然后，运行bundle exec rake test以运行测试。您还可以运行bin/console以获得交互提示，该提示可以让您进行实验。

要将此GEM安装到本地计算机上，请运行bundle exec rake install 。要发布新版本，请在version.rb中更新版本编号，然后运行bundle exec rake release ，该版本将为版本创建一个git标签，推送git consits和创建标签，然后将.gem文件推到rubygems.org。

贡献

欢迎在GitHub上进行错误报告和拉动请求。

执照

根据MIT许可证的条款，该宝石可作为开源。

展开

ferrum

Ferrum-高级API控制Ruby中的Chrome

像木偶一样简单，尽管更简单。

指数

安装

例子

Docker

定制

导航

go_to（url）： String

后退

向前

刷新

停止

位置= **选项

位置： Array<Integer>

window_bounds = **选项

window_bounds： Hash<String, Integer | String>

Window_ID： Integer

发现者

AT_CSS（选择器，**选项）： Node | nil

CSS（选择器，**选项）： Array<Node> | []

at_xpath（选择器，**选项）： Node | nil

XPATH（选择器，**选项）： Array<Node> | []

current_url： String

current_title： String

身体： String

屏幕截图

屏幕截图（**选项）： String | Integer

PDF（**选项）： String | Boolean

MHTML（**选项）： String | Integer

网络

流量Array<Network::Exchange>

请求： Network::Request

响应： Network::Response

状态： Integer

wait_for_idle（**选项）： Boolean

wait_for_idle！（**选项）

清除（类型）

拦截（**选项）

授权（**选项，＆块）

emulate_network_conditions（**选项）

OFFLINE_MODE

缓存（禁用： Boolean ）

下载

文件Array<Hash>

等待（超时）

set_behavior（**选项）

代理人

老鼠

scroll_to（x，y）

单击（**选项）： Mouse

下（**选项）： Mouse

向上（**选项）： Mouse

移动（x：,, y：，步骤：1）： Mouse

键盘

向下（键）： Keyboard

向上（键）： Keyboard

类型（*键）： Keyboard

修饰符（键）： Integer

曲奇饼

全部： Hash<String, Cookie>

： Cookie

设置（值）： Boolean

删除（**选项）： Boolean

透明： Boolean

商店（路径）： Boolean

负载（路径）： Boolean

标题

得到： Hash

设置（标题）： Boolean

添加（标题）： Boolean

透明： Boolean

JavaScript

评估（表达， *args）

evaluate_async（expression，wait_time， *args）

执行（表达式， *args）

estuatue_on_new_document（表达式）

add_script_tag（**选项）： Boolean

add_style_tag（**选项）： Boolean

go_to（url）： `String`

位置： `Array<Integer>`

window_bounds： `Hash<String, Integer | String>`

Window_ID： `Integer`

AT_CSS（选择器，**选项）： `Node` | `nil`

CSS（选择器，**选项）： `Array<Node>` | `[]`

at_xpath（选择器，**选项）： `Node` | `nil`

XPATH（选择器，**选项）： `Array<Node>` | `[]`

current_url： `String`

current_title： `String`

身体： `String`

屏幕截图（**选项）： `String` | `Integer`

PDF（**选项）： `String` | `Boolean`

MHTML（**选项）： `String` | `Integer`

流量`Array<Network::Exchange>`

请求： `Network::Request`

响应： `Network::Response`

状态： `Integer`

wait_for_idle（**选项）： `Boolean`

缓存（禁用： `Boolean` ）

文件`Array<Hash>`

单击（**选项）： `Mouse`

下（**选项）： `Mouse`

向上（**选项）： `Mouse`

移动（x：,, y：，步骤：1）： `Mouse`

向下（键）： `Keyboard`

向上（键）： `Keyboard`

类型（*键）： `Keyboard`

修饰符（键）： `Integer`

全部： `Hash<String, Cookie>`

： `Cookie`

设置（值）： `Boolean`

删除（**选项）： `Boolean`

透明： `Boolean`

商店（路径）： `Boolean`

负载（路径）： `Boolean`

得到： `Hash`

设置（标题）： `Boolean`

添加（标题）： `Boolean`

透明： `Boolean`

add_script_tag（**选项）： `Boolean`

add_style_tag（**选项）： `Boolean`

Bypass_csp（**选项）： `Boolean`

帧： `Array[Frame] | []`

main_frame： `Frame`

frame_by（**选项）： `Frame | nil`

ID： `String`

parent_id： `String | nil`

execution_id： `Integer`

名称： `String | nil`

状态： `Symbol | nil`

URL： `String`

主要的？： `Boolean`

current_url： `String`

current_title： `String`

身体： `String`

Playback_rate： `Integer`

节点？： `Boolean`

框架： `Frame`

移动？： `Boolean`

选择： `Array<Node>`

in_viewport？（of： `Node | nil` ）： `Boolean`

tracing.record（**选项）： `String`