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`

wait_for_idle！（**選項）

緩存（禁用： `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`