class Capybara::Poltergeist::Driver

Constants

DEFAULT_TIMEOUT

Attributes

app[R]
options[R]

Public Class Methods

new(app, options = {}) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 9
def initialize(app, options = {})
  @app       = app
  @options   = options
  @browser   = nil
  @inspector = nil
  @server    = nil
  @client    = nil
  @started   = false
end

Public Instance Methods

accept_modal(type, options = {}) { || ... } click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 364
def accept_modal(type, options = {})
  case type
  when :confirm
    browser.accept_confirm
  when :prompt
    browser.accept_prompt options[:with]
  end

  yield if block_given?

  find_modal(options)
end
add_header(name, value, options = {}) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 255
def add_header(name, value, options = {})
  permanent = options.fetch(:permanent, true)
  browser.add_header({ name => value }, permanent)
end
add_headers(headers) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 251
def add_headers(headers)
  browser.add_headers(headers)
end
basic_authorize(user, password) click to toggle source
  • PhantomJS with set settings doesn't send `Authorize` on POST request

  • With manually set header PhantomJS makes next request with

`Authorization: Basic Og==` header when settings are empty and the response was `401 Unauthorized` (which means Base64.encode64(':')). Combining both methods to reach proper behavior.

# File lib/capybara/poltergeist/driver.rb, line 303
def basic_authorize(user, password)
  browser.set_http_auth(user, password)
  credentials = ["#{user}:#{password}"].pack('m*').strip
  add_header('Authorization', "Basic #{credentials}")
end
body()
Alias for: html
browser() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 23
def browser
  @browser ||= begin
    browser = Browser.new(server, client, logger)
    browser.js_errors  = options[:js_errors] if options.key?(:js_errors)
    browser.extensions = options.fetch(:extensions, [])
    browser.debug      = true if options[:debug]
    browser.url_blacklist = options[:url_blacklist] if options.key?(:url_blacklist)
    browser.url_whitelist = options[:url_whitelist] if options.key?(:url_whitelist)
    browser
  end
end
clear_cookies() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 286
def clear_cookies
  browser.clear_cookies
end
clear_memory_cache() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 294
def clear_memory_cache
  browser.clear_memory_cache
end
clear_network_traffic() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 235
def clear_network_traffic
  browser.clear_network_traffic
end
click(x, y) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 133
def click(x, y)
  browser.click_coordinates(x, y)
end
client() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 43
def client
  @client ||= Client.start(server,
    :path              => options[:phantomjs],
    :window_size       => options[:window_size],
    :phantomjs_options => phantomjs_options,
    :phantomjs_logger  => phantomjs_logger
  )
end
client_pid() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 64
def client_pid
  client.pid
end
close_window(handle) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 162
def close_window(handle)
  browser.close_window(handle)
end
cookies() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 264
def cookies
  browser.cookies
end
cookies_enabled=(flag) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 290
def cookies_enabled=(flag)
  browser.cookies_enabled = flag
end
current_url() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 100
def current_url
  browser.current_url
end
current_window_handle() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 154
def current_window_handle
  browser.window_handle
end
debug() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 309
def debug
  if @options[:inspector]
    # Fall back to default scheme
    scheme = URI.parse(browser.current_url).scheme rescue nil
    scheme = 'http' if scheme != 'https'
    inspector.open(scheme)
    pause
  else
    raise Error, "To use the remote debugging, you have to launch the driver " \
                 "with `:inspector => true` configuration option"
  end
end
dismiss_modal(type, options = {}) { || ... } click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 377
def dismiss_modal(type, options = {})
  case type
  when :confirm
    browser.dismiss_confirm
  when :prompt
    browser.dismiss_prompt
  end

  yield if block_given?
  find_modal(options)
end
evaluate_script(script, *args) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 137
def evaluate_script(script, *args)
  browser.evaluate(script, *args.map { |arg| arg.is_a?(Capybara::Poltergeist::Node) ?  arg.native : arg})
end
execute_script(script, *args) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 141
def execute_script(script, *args)
  browser.execute(script, *args.map { |arg| arg.is_a?(Capybara::Poltergeist::Node) ?  arg.native : arg})
  nil
end
find(method, selector) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 121
def find(method, selector)
  browser.find(method, selector).map { |page_id, id| Capybara::Poltergeist::Node.new(self, page_id, id) }
end
find_css(selector) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 129
def find_css(selector)
  find :css, selector
end
find_xpath(selector) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 125
def find_xpath(selector)
  find :xpath, selector
end
go_back() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 356
def go_back
  browser.go_back
end
go_forward() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 360
def go_forward
  browser.go_forward
end
headers() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 243
def headers
  browser.get_headers
end
headers=(headers) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 247
def headers=(headers)
  browser.set_headers(headers)
end
html() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 108
def html
  browser.body
end
Also aliased as: body
inspector() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 35
def inspector
  @inspector ||= options[:inspector] && Inspector.new(options[:inspector])
end
invalid_element_errors() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 352
def invalid_element_errors
  [Capybara::Poltergeist::ObsoleteNode, Capybara::Poltergeist::MouseEventFailed]
end
logger() click to toggle source

logger should be an object that responds to puts, or nil

# File lib/capybara/poltergeist/driver.rb, line 86
def logger
  options[:logger] || (options[:debug] && STDERR)
end
maximize_window(handle) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 217
def maximize_window(handle)
  resize_window_to(handle, *screen_size)
end
needs_server?() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 19
def needs_server?
  true
end
network_traffic() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 231
def network_traffic
  browser.network_traffic
end
no_such_window_error() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 178
def no_such_window_error
  NoSuchWindowError
end
open_new_window() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 166
def open_new_window
  browser.open_new_window
end
paper_size=(size = {}) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 198
def paper_size=(size = {})
  browser.set_paper_size(size)
end
pause() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 322
def pause
  # STDIN is not necessarily connected to a keyboard. It might even be closed.
  # So we need a method other than keypress to continue.

  # In jRuby - STDIN returns immediately from select
  # see https://github.com/jruby/jruby/issues/1783
  read, write = IO.pipe
  Thread.new { IO.copy_stream(STDIN, write); write.close }

  STDERR.puts "Poltergeist execution paused. Press enter (or run 'kill -CONT #{Process.pid}') to continue."

  signal = false
  old_trap = trap('SIGCONT') { signal = true; STDERR.puts "\nSignal SIGCONT received" }
  keyboard = IO.select([read], nil, nil, 1) until keyboard || signal # wait for data on STDIN or signal SIGCONT received

  begin
    input = read.read_nonblock(80) # clear out the read buffer
    puts unless input && input =~ /\n\z/
  rescue EOFError, IO::WaitReadable # Ignore problems reading from STDIN.
  end unless signal

  trap('SIGCONT', old_trap) # Restore the previuos signal handler, if there was one.

  STDERR.puts 'Continuing'
end
phantomjs_logger() click to toggle source

logger should be an object that behaves like IO or nil

# File lib/capybara/poltergeist/driver.rb, line 91
def phantomjs_logger
  options.fetch(:phantomjs_logger, nil)
end
phantomjs_options() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 52
def phantomjs_options
  list = options[:phantomjs_options] || []

  # PhantomJS defaults to only using SSLv3, which since POODLE (Oct 2014)
  # many sites have dropped from their supported protocols (eg PayPal,
  # Braintree).
  list += ["--ignore-ssl-errors=yes"] unless list.grep(/ignore-ssl-errors/).any?
  list += ["--ssl-protocol=TLSv1"] unless list.grep(/ssl-protocol/).any?
  list += ["--remote-debugger-port=#{inspector.port}", "--remote-debugger-autorun=yes"] if inspector
  list
end
quit() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 80
def quit
  server.stop
  client.stop
end
render(path, options = {})
Alias for: save_screenshot
render_base64(format = :png, options = {}) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 194
def render_base64(format = :png, options = {})
  browser.render_base64(format, options)
end
reset!() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 182
def reset!
  browser.reset
  browser.url_blacklist = options[:url_blacklist] if options.key?(:url_blacklist)
  browser.url_whitelist = options[:url_whitelist] if options.key?(:url_whitelist)
  @started = false
end
resize(width, height) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 206
def resize(width, height)
  browser.resize(width, height)
end
Also aliased as: resize_window
resize_window(width, height)
Alias for: resize
resize_window_to(handle, width, height) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 211
def resize_window_to(handle, width, height)
  within_window(handle) do
    resize(width, height)
  end
end
response_headers() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 260
def response_headers
  browser.response_headers
end
restart() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 76
def restart
  browser.restart
end
save_screenshot(path, options = {}) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 189
def save_screenshot(path, options = {})
  browser.render(path, options)
end
Also aliased as: render
scroll_to(left, top) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 227
def scroll_to(left, top)
  browser.scroll_to(left, top)
end
server() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 39
def server
  @server ||= Server.new(options[:port], options.fetch(:timeout) { DEFAULT_TIMEOUT })
end
set_proxy(ip, port, type = "http", user = nil, password = nil) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 239
def set_proxy(ip, port, type = "http", user = nil, password = nil)
  browser.set_proxy(ip, port, type, user, password)
end
source() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 113
def source
  browser.source.to_s
end
status_code() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 104
def status_code
  browser.status_code
end
switch_to_frame(locator, &block) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 150
def switch_to_frame(locator, &block)
  browser.switch_to_frame(locator, &block)
end
switch_to_window(handle) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 170
def switch_to_window(handle)
  browser.switch_to_window(handle)
end
timeout() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 68
def timeout
  server.timeout
end
timeout=(sec) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 72
def timeout=(sec)
  server.timeout = sec
end
title() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 117
def title
  browser.title
end
visit(url) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 95
def visit(url)
  @started = true
  browser.visit(url)
end
wait?() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 348
def wait?
  true
end
window_handles() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 158
def window_handles
  browser.window_handles
end
window_size(handle) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 221
def window_size(handle)
  within_window(handle) do
    evaluate_script('[window.innerWidth, window.innerHeight]')
  end
end
within_frame(name, &block) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 146
def within_frame(name, &block)
  browser.within_frame(name, &block)
end
within_window(name, &block) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 174
def within_window(name, &block)
  browser.within_window(name, &block)
end
zoom_factor=(zoom_factor) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 202
def zoom_factor=(zoom_factor)
  browser.set_zoom_factor(zoom_factor)
end

Private Instance Methods

find_modal(options) click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 395
  def find_modal(options)
    start_time    = Time.now
    timeout_sec   = options[:wait] || begin Capybara.default_max_wait_time rescue Capybara.default_wait_time end
    expect_text   = options[:text]
    expect_regexp = expect_text.is_a?(Regexp) ? expect_text : Regexp.escape(expect_text.to_s)
    not_found_msg = 'Unable to find modal dialog'
    not_found_msg += " with #{expect_text}" if expect_text

    begin
      modal_text = browser.modal_message
      raise Capybara::ModalNotFound if modal_text.nil? || (expect_text && !modal_text.match(expect_regexp))
    rescue Capybara::ModalNotFound => e
      raise e, not_found_msg if (Time.now - start_time) >= timeout_sec
      sleep(0.05)
      retry
    end
    modal_text
  end
end
screen_size() click to toggle source
# File lib/capybara/poltergeist/driver.rb, line 391
def screen_size
  options[:screen_size] || [1366,768]
end