Скачать ferrum - Скачать исходный код ferrum

Ferrum - API высокого уровня для контроля хрома в Ruby

Столь же просто, как кукольник, хотя даже проще.

Это Ruby Clean и API высокого уровня к хром. По умолчанию запускается без головы, но вы можете настроить его для запуска в головном режиме. Все, что вам нужно, это Ruby и хром или хром. Ferrum подключается к браузеру с помощью протокола CDP, и нет никакой зависимости селена/webdriver/chromedriver. Акцент был сделан на необработанном протоколе CDP, потому что Chrome позволяет вам делать так много вещей, которые едва поддерживаются Webdriver, потому что он должен иметь последовательный дизайн с другими браузерами.

Cuprite - чистый водитель Ruby для капибары на основе Ferrum. Если вы собираетесь ползать на сайтах, вы лучше используете Ferrum или сосуд, потому что вы ползаете, а не тестируете.
Среда ползания высокого уровня суда, основанная на Ferrum и Mechanize.

Индекс

Установить
Примеры
Докер
Настройка
Навигация
Искатели
Скриншоты
Сеть
Загрузки
Прокси
Мышь
Клавиатура
Печенье
Заголовки
JavaScript
Рамы
Рамка
Диалоги
Анимация
Узел
Трассировка
Убирать
Безопасность нити
Разработка
Внося
Лицензия

Установить

Там нет официального хромового или хромового пакета для Linux, не устанавливайте его таким образом, потому что он либо устаревший, либо неофициальный, оба плохие. Загрузите его из официального источника для Chrome или Chromium. Хромированный двоичный файл должен быть на 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 создает и поддерживает для вас страницу по умолчанию, на самом деле все приведенные выше методы отправляются в экземпляр page , который создается в default_context экземпляра browser . Вы можете взаимодействовать со страницей, созданной вручную, и это предпочтительнее:

 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 как root вы должны передать опцию браузера без сандбоков:

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

Также сообщалось, что процесс Chrome неоднократно вылетает при запуске внутри контейнера Docker на MC MAC MAC, предотвращая работу Ferrum. Ferrum должен работать так же, как и ожидалось при развертывании в контейнер Docker на MAC, не являющемся MC.

Настройка

Вы можете настроить параметры со следующим кодом в настройке теста:

 Ferrum :: Browser . new ( options )

варианты Hash
- :headless (String | Boolean) - Установите браузер как без головы или нет, по true . Вы можете установить "new" , чтобы поддержать новый режим без головы.
- :xvfb (boolean) - Запустите браузер в виртуальном кадре, по false .
- :flatten (BOOLEAN) - Используйте одно подключение к WebSocket в браузере и все страницы в режиме сглаживания.
- :window_size (массив) - Размеры окна браузера, в котором можно проверить, выраженное как массив с двумя элементами, например [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 (BOOLEAN) - Когда True, ошибки JavaScript повторно разрабатываются в Ruby.
- :pending_connection_errors (boolean) - Когда основной кадр все еще ждет медленных ответов, пока достигается PendingConnectionsError -аут. Лучше выяснить, почему у вас медленные ответы и исправлять или блокировать их, а не выключать эту настройку. По умолчанию верно.
- :browser_name (символ) - :chrome по умолчанию, только экспериментальная поддержка :firefox на данный момент.
- :browser_path (string) - Путь к бинарному хроме, вы также можете установить переменную 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 (String) - адрес удаленной отладки для безголовного Chrome.
- :url (String) - URL для управляемого экземпляра Chrome. Если это установлено, процесс браузера не будет порожден.
- :ws_url (String) - URL -адрес websocket для управления экземпляром Chrome. Если это установлено, процесс браузера не будет порожден. Это более высокий приоритет, чем :url , настройка оба не имеет смысла.
- :process_timeout (Integer) - Как долго ждать, пока процесс Chrome ответит на запуск.
- :ws_max_receive_size (Integer) - Как большие сообщения принять из Chrome через веб -сокет, в байтах. По умолчанию до 64 МБ. Входящие сообщения больше, чем это, вызовут Ferrum::DeadBrowserError .
- :proxy (хэш) - указать настройки прокси, читать дальше
- :save_path (string) - Путь для сохранения вложений с заголовком -дискозией контента.
- :env (hash) - переменные среды, которые вы хотели бы передать в процесс

Искатели

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 (selector, ** опции): `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`

Сохраняет скриншот на диске или возвращает его в качестве Base64.

варианты Hash
- : String пути, чтобы сохранить скриншот на диске. :encoding будет установлено на :binary автоматически
- : Кодирование Symbol :base64 | :binary вы можете настроить его, чтобы вернуть изображение как base64
- : формат String "jpeg" ("jpg") | "Png" | "Webp"
- : Качественное Integer 0-100 работает только для JPEG
- : Полный Boolean
- : String селектор CSS для данного элемента, необязательный
- : Область Hash для экрана, дополнительная
  - : x Integer
  - : y Integer
  - : ширина Integer
  - : Высота Integer
- : масштабировать Float Zoom in in/out
- : founal_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 бумажной ориентации. По умолчанию ложно.
- : масштабировать Float Zoom in in/out
- : symbol формата стандартные размеры бумаги: буква ,: законно ,: таблоид ,: ledger ,: a0 ,: a1 ,: a2 ,: a3 ,: a4 ,: a5 ,: a6
- : paper_width Float Set Set Paper ширина
- : Paper_height Float Set Set Height
- Смотрите другие собственные варианты, которые вы можете пройти

 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
- : Offline Boolean Emulate Emulate Internet Densnection, false по умолчанию
- : Задержка Integer минимальной задержки от запроса, отправленного к полученным заголовкам ответов (MS), 0 по умолчанию
- : Download_throughput Integer Максимумальная агрегированная пропускная способность (байты/сек), -1 по умолчанию, отключает загрузку дроссель
- : upload_throughput Integer максимальная агрегированная пропускная способность загрузки (байты/сек), -1 по умолчанию, отключает загрузку дроссель
- : connection_type String тип соединения, если известно, одно из: none, cellular2g, cellular3g, cellular4g, bluetooth, ethernet, wi -fi, 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 Absolute Path of Whed, где хранить файл
- : Symbol поведения deny | allow | allowAndName | default , allow по умолчанию

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

Прокси

Вы можете установить прокси с помощью :proxy Option:

 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 умолчанию по умолчанию.
- : Symbol кнопки: слева | : справа, по умолчанию: слева
- : Считайте Integer по умолчанию до 1
- : Модификаторы Integer Bitfield для ключевых модификаторов. Смотрите keyboard.modifiers

вниз (** опции): `Mouse`

Мышь внизу для данных координат.

варианты Hash
- : Symbol кнопки: слева | : справа, по умолчанию: слева
- : Считайте Integer по умолчанию до 1
- : Модификаторы Integer Bitfield для ключевых модификаторов. Смотрите keyboard.modifiers

up (** варианты): `Mouse`

Мыши поднимаются для данных координат.

варианты Hash
- : Symbol кнопки: слева | : справа, по умолчанию: слева
- : Считайте Integer по умолчанию до 1
- : Модификаторы Integer Bitfield для ключевых модификаторов. Смотрите keyboard.modifiers

Движение (x: y:, шаги: 1): `Mouse`

Мышь переехала на данный х и y.

варианты Hash
- : x Integer
- : y Integer
- : шаги Integer по умолчанию в 1. Отправляет промежуточные события MouseMove.

Клавиатура

page.keyboard

вниз (ключ): `Keyboard`

Отправляет событие Keydown.

Ключевая String | Имя Symbol ключа, такого как «a»,: enter,: backspace

UP (ключ): `Keyboard`

Отправляет событие Keyup.

Ключевая String | Название Symbol ключа, такого как «B»,: enter,: backspace

Тип (*ключи): `Keyboard`

Отправляет событие Keydown, Keypress/Input и Keyup для каждого символа в тексте.

текстовая String | Array<String> | Array<Symbol> Текст для ввода в целенаправленный элемент, [:Shift, "s"], "tring"

Модификаторы (ключи): `Integer`

Возвращает Битфилд для данных ключей

Ключи 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}>

SET (значение): `Boolean`

Устанавливает печенье

ценностная Hash
- : Название String
- : value 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`

Удаляет данный cookie

варианты Hash
- : Название String
- : доменная String
- : url String

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

Ясно: `Boolean`

Удаляет все файлы cookie для текущей страницы

 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

get: `Hash`

Получите все заголовки

SET (заголовки): `Boolean`

Установка заданных заголовков. В конечном итоге очистите все заголовки и установлены.

Заголовки Hash -клавишные пары, например "User-Agent" => "Browser"

Добавить (заголовки): `Boolean`

Добавляет заданные заголовки, чтобы уже установить.

Заголовки Hash -клавишные пары, например "Referer" => "http://example.com"

Ясно: `Boolean`

Очистить все заголовки.

JavaScript

оценить (выражение, *args)

Оценить и возвращать результаты для данного выражения JS

String выражения должна быть допустимой JavaScript
Object ARGS Вы можете передать аргументы, хотя это должен быть допустимый Node или простое значение.

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

Оценить_азинх (выражение, wait_time, *args)

Оценить асинхронное выражение и результат возврата

String выражения должна быть допустимой JavaScript
wait_time, как долго мы должны ждать обещания разрешить или отклонить
Object ARGS Вы можете передать аргументы, хотя это должен быть допустимый Node или простое значение.

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

выполнить (выражение, *args)

Выполнить выражение. Не возвращает результат

String выражения должна быть допустимой JavaScript
Object ARGS Вы можете передать аргументы, хотя это должен быть допустимый Node или простое значение.

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

Оценка_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 контента
- : type 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

ourpass_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_JAVASCRICT

Отключает Javascripts из загруженного HTML -источника. Вы все еще можете оценить JavaScript с помощью evaluate или execute . Ничего не возвращает.

 page . disable_javascript

set_viewport

Переопределяет размеры экрана устройства и эмулирует 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 - идентификатор уникального кадра, который предоставляет браузер
- : name String - имя кадра, если есть один

 page . frame_by ( id : "C6D104CE454A025FBCF22B98DE612B12" )

Рамка

ID: `String`

Уникальный идентификатор кадры.

parent_id: `String | nil`

Родительский идентификатор кадра, если этот вложен в другой.

execution_id: `Integer`

Идентификатор контекста выполнения, который используется JS, каждый кадр имеет свой собственный контекст, в котором 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>"

Содержание = 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.

PREALBACK_RATE: `Integer`

Возвращает частоту воспроизведения для анимации CSS, по умолчанию до 1 .

PREARBACK_RATE = значение

Устанавливает уровень воспроизведения анимации CSS

Значительное Integer

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

Узел

узел? : `Boolean`

frame_id

Кадр: `Frame`

Возвращает объект 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

xpath

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 или просмотре времени.

 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 вывод кодирования в виде базы64 или простого текста. :binary по умолчанию
- : Тайм -аут Float , пока потоковая передача файла не завершится в указанное время или не поднимает ошибку, по умолчанию nil
- : Скриншоты Boolean снимки снимка в следах, false по умолчанию
- : TRACE_CONFIG Hash<String, Object> Config для трассировки, для категорий см. 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 для интерактивной подсказки, которая позволит вам экспериментировать.

Чтобы установить этот драгоценный камень на локальную машину, запустите bundle exec rake install . Чтобы bundle exec rake release новую версию, обновите .gem версии в version.rb .

Внося

Отчеты об ошибках и запросы на тягу приветствуются на GitHub.

Лицензия

Драгоценный камень доступен в качестве открытого исходного кода в соответствии с условиями лицензии MIT.

Расширять

ferrum

Ferrum - API высокого уровня для контроля хрома в Ruby

Столь же просто, как кукольник, хотя даже проще.

Индекс

Установить

Примеры

Докер

Настройка

Навигация

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 (selector, ** опции): 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

up (** варианты): Mouse

Движение (x: y:, шаги: 1): Mouse

Клавиатура

вниз (ключ): Keyboard

UP (ключ): Keyboard

Тип (*ключи): Keyboard

Модификаторы (ключи): Integer

Печенье

Все: Hash<String, Cookie>

: Cookie

SET (значение): Boolean

Удалить (** варианты): Boolean

Ясно: Boolean

Магазин (путь): Boolean

нагрузка (путь): Boolean

Заголовки

get: Hash

SET (заголовки): Boolean

Добавить (заголовки): Boolean

Ясно: Boolean

JavaScript

оценить (выражение, *args)

Оценить_азинх (выражение, wait_time, *args)

выполнить (выражение, *args)

Оценка_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 (selector, ** опции): `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`

up (** варианты): `Mouse`

Движение (x: y:, шаги: 1): `Mouse`

вниз (ключ): `Keyboard`

UP (ключ): `Keyboard`

Тип (*ключи): `Keyboard`

Модификаторы (ключи): `Integer`

Все: `Hash<String, Cookie>`

: `Cookie`

SET (значение): `Boolean`

Удалить (** варианты): `Boolean`

Ясно: `Boolean`

Магазин (путь): `Boolean`

нагрузка (путь): `Boolean`

get: `Hash`

SET (заголовки): `Boolean`

Добавить (заголовки): `Boolean`

Ясно: `Boolean`

add_script_tag (** параметры): `Boolean`

add_style_tag (** Параметры): `Boolean`

ourpass_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`

PREALBACK_RATE: `Integer`

узел? : `Boolean`

Кадр: `Frame`

движущийся? : `Boolean`

Выбран: `Array<Node>`

in_viewport? (of: `Node | nil` ): `Boolean`

Tracing.Record (** Параметры): `String`