Class: Capybara::Poltergeist::Driver
- Inherits:
-
Driver::Base
- Object
- Driver::Base
- Capybara::Poltergeist::Driver
- Defined in:
- lib/capybara/poltergeist/driver.rb
Constant Summary collapse
- DEFAULT_TIMEOUT =
30
Instance Attribute Summary collapse
-
#app ⇒ Object
readonly
Returns the value of attribute app.
-
#options ⇒ Object
readonly
Returns the value of attribute options.
Instance Method Summary collapse
- #accept_modal(type, options = {}) ⇒ Object
- #add_header(name, value, options = {}) ⇒ Object
- #add_headers(headers) ⇒ Object
-
#basic_authorize(user, password) ⇒ Object
-
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(’:‘)).
-
- #browser ⇒ Object
- #clear_cookies ⇒ Object
- #clear_memory_cache ⇒ Object
- #clear_network_traffic ⇒ Object
- #click(x, y) ⇒ Object
- #client ⇒ Object
- #client_pid ⇒ Object
- #close_window(handle) ⇒ Object
- #cookies ⇒ Object
- #cookies_enabled=(flag) ⇒ Object
- #current_url ⇒ Object
- #current_window_handle ⇒ Object
- #debug ⇒ Object
- #dismiss_modal(type, options = {}) ⇒ Object
- #evaluate_script(script) ⇒ Object
- #execute_script(script) ⇒ Object
- #find(method, selector) ⇒ Object
- #find_css(selector) ⇒ Object
- #find_xpath(selector) ⇒ Object
- #go_back ⇒ Object
- #go_forward ⇒ Object
- #headers ⇒ Object
- #headers=(headers) ⇒ Object
- #html ⇒ Object (also: #body)
-
#initialize(app, options = {}) ⇒ Driver
constructor
A new instance of Driver.
- #inspector ⇒ Object
- #invalid_element_errors ⇒ Object
-
#logger ⇒ Object
logger should be an object that responds to puts, or nil.
- #needs_server? ⇒ Boolean
- #network_traffic ⇒ Object
- #no_such_window_error ⇒ Object
- #open_new_window ⇒ Object
- #paper_size=(size = {}) ⇒ Object
- #pause ⇒ Object
-
#phantomjs_logger ⇒ Object
logger should be an object that behaves like IO or nil.
- #phantomjs_options ⇒ Object
- #quit ⇒ Object
- #remove_cookie(name) ⇒ Object
- #render_base64(format = :png, options = {}) ⇒ Object
- #reset! ⇒ Object
- #resize(width, height) ⇒ Object (also: #resize_window)
- #resize_window_to(handle, width, height) ⇒ Object
- #response_headers ⇒ Object
- #restart ⇒ Object
- #save_screenshot(path, options = {}) ⇒ Object (also: #render)
- #scroll_to(left, top) ⇒ Object
- #server ⇒ Object
- #set_cookie(name, value, options = {}) ⇒ Object
- #set_proxy(ip, port, type = "http", user = nil, password = nil) ⇒ Object
- #source ⇒ Object
- #status_code ⇒ Object
- #switch_to_window(handle) ⇒ Object
- #timeout ⇒ Object
- #timeout=(sec) ⇒ Object
- #title ⇒ Object
- #visit(url) ⇒ Object
- #wait? ⇒ Boolean
- #window_handles ⇒ Object
- #window_size(handle) ⇒ Object
- #within_frame(name, &block) ⇒ Object
- #within_window(name, &block) ⇒ Object
- #zoom_factor=(zoom_factor) ⇒ Object
Constructor Details
#initialize(app, options = {}) ⇒ Driver
Returns a new instance of Driver.
9 10 11 12 13 14 15 16 17 |
# File 'lib/capybara/poltergeist/driver.rb', line 9 def initialize(app, = {}) @app = app @options = @browser = nil @inspector = nil @server = nil @client = nil @started = false end |
Instance Attribute Details
#app ⇒ Object (readonly)
Returns the value of attribute app.
7 8 9 |
# File 'lib/capybara/poltergeist/driver.rb', line 7 def app @app end |
#options ⇒ Object (readonly)
Returns the value of attribute options.
7 8 9 |
# File 'lib/capybara/poltergeist/driver.rb', line 7 def @options end |
Instance Method Details
#accept_modal(type, options = {}) ⇒ Object
356 357 358 359 360 361 362 363 364 365 366 367 |
# File 'lib/capybara/poltergeist/driver.rb', line 356 def accept_modal(type, = {}) case type when :confirm browser.accept_confirm when :prompt browser.accept_prompt [:with] end yield if block_given? find_modal() end |
#add_header(name, value, options = {}) ⇒ Object
247 248 249 250 |
# File 'lib/capybara/poltergeist/driver.rb', line 247 def add_header(name, value, = {}) permanent = .fetch(:permanent, true) browser.add_header({ name => value }, permanent) end |
#add_headers(headers) ⇒ Object
243 244 245 |
# File 'lib/capybara/poltergeist/driver.rb', line 243 def add_headers(headers) browser.add_headers(headers) end |
#basic_authorize(user, password) ⇒ Object
-
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.
295 296 297 298 299 |
# File 'lib/capybara/poltergeist/driver.rb', line 295 def (user, password) browser.set_http_auth(user, password) credentials = ["#{user}:#{password}"].pack('m*').strip add_header('Authorization', "Basic #{credentials}") end |
#browser ⇒ Object
23 24 25 26 27 28 29 30 31 32 33 |
# File 'lib/capybara/poltergeist/driver.rb', line 23 def browser @browser ||= begin browser = Browser.new(server, client, logger) browser.js_errors = [:js_errors] if .key?(:js_errors) browser.extensions = .fetch(:extensions, []) browser.debug = true if [:debug] browser.url_blacklist = [:url_blacklist] if .key?(:url_blacklist) browser.url_whitelist = [:url_whitelist] if .key?(:url_whitelist) browser end end |
#clear_cookies ⇒ Object
278 279 280 |
# File 'lib/capybara/poltergeist/driver.rb', line 278 def browser. end |
#clear_memory_cache ⇒ Object
286 287 288 |
# File 'lib/capybara/poltergeist/driver.rb', line 286 def clear_memory_cache browser.clear_memory_cache end |
#clear_network_traffic ⇒ Object
227 228 229 |
# File 'lib/capybara/poltergeist/driver.rb', line 227 def clear_network_traffic browser.clear_network_traffic end |
#click(x, y) ⇒ Object
133 134 135 |
# File 'lib/capybara/poltergeist/driver.rb', line 133 def click(x, y) browser.click_coordinates(x, y) end |
#client ⇒ Object
43 44 45 46 47 48 49 50 |
# File 'lib/capybara/poltergeist/driver.rb', line 43 def client @client ||= Client.start(server, :path => [:phantomjs], :window_size => [:window_size], :phantomjs_options => , :phantomjs_logger => phantomjs_logger ) end |
#client_pid ⇒ Object
64 65 66 |
# File 'lib/capybara/poltergeist/driver.rb', line 64 def client_pid client.pid end |
#close_window(handle) ⇒ Object
158 159 160 |
# File 'lib/capybara/poltergeist/driver.rb', line 158 def close_window(handle) browser.close_window(handle) end |
#cookies ⇒ Object
256 257 258 |
# File 'lib/capybara/poltergeist/driver.rb', line 256 def browser. end |
#cookies_enabled=(flag) ⇒ Object
282 283 284 |
# File 'lib/capybara/poltergeist/driver.rb', line 282 def (flag) browser. = flag end |
#current_url ⇒ Object
100 101 102 |
# File 'lib/capybara/poltergeist/driver.rb', line 100 def current_url browser.current_url end |
#current_window_handle ⇒ Object
150 151 152 |
# File 'lib/capybara/poltergeist/driver.rb', line 150 def current_window_handle browser.window_handle end |
#debug ⇒ Object
301 302 303 304 305 306 307 308 309 310 311 312 |
# File 'lib/capybara/poltergeist/driver.rb', line 301 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 = {}) ⇒ Object
369 370 371 372 373 374 375 376 377 378 379 |
# File 'lib/capybara/poltergeist/driver.rb', line 369 def dismiss_modal(type, = {}) case type when :confirm browser.dismiss_confirm when :prompt browser.dismiss_prompt end yield if block_given? find_modal() end |
#evaluate_script(script) ⇒ Object
137 138 139 |
# File 'lib/capybara/poltergeist/driver.rb', line 137 def evaluate_script(script) browser.evaluate(script) end |
#execute_script(script) ⇒ Object
141 142 143 144 |
# File 'lib/capybara/poltergeist/driver.rb', line 141 def execute_script(script) browser.execute(script) nil end |
#find(method, selector) ⇒ Object
121 122 123 |
# 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) ⇒ Object
129 130 131 |
# File 'lib/capybara/poltergeist/driver.rb', line 129 def find_css(selector) find :css, selector end |
#find_xpath(selector) ⇒ Object
125 126 127 |
# File 'lib/capybara/poltergeist/driver.rb', line 125 def find_xpath(selector) find :xpath, selector end |
#go_back ⇒ Object
348 349 350 |
# File 'lib/capybara/poltergeist/driver.rb', line 348 def go_back browser.go_back end |
#go_forward ⇒ Object
352 353 354 |
# File 'lib/capybara/poltergeist/driver.rb', line 352 def go_forward browser.go_forward end |
#headers ⇒ Object
235 236 237 |
# File 'lib/capybara/poltergeist/driver.rb', line 235 def headers browser.get_headers end |
#headers=(headers) ⇒ Object
239 240 241 |
# File 'lib/capybara/poltergeist/driver.rb', line 239 def headers=(headers) browser.set_headers(headers) end |
#html ⇒ Object Also known as: body
108 109 110 |
# File 'lib/capybara/poltergeist/driver.rb', line 108 def html browser.body end |
#inspector ⇒ Object
35 36 37 |
# File 'lib/capybara/poltergeist/driver.rb', line 35 def inspector @inspector ||= [:inspector] && Inspector.new([:inspector]) end |
#invalid_element_errors ⇒ Object
344 345 346 |
# File 'lib/capybara/poltergeist/driver.rb', line 344 def invalid_element_errors [Capybara::Poltergeist::ObsoleteNode, Capybara::Poltergeist::MouseEventFailed] end |
#logger ⇒ Object
logger should be an object that responds to puts, or nil
86 87 88 |
# File 'lib/capybara/poltergeist/driver.rb', line 86 def logger [:logger] || ([:debug] && STDERR) end |
#needs_server? ⇒ Boolean
19 20 21 |
# File 'lib/capybara/poltergeist/driver.rb', line 19 def needs_server? true end |
#network_traffic ⇒ Object
223 224 225 |
# File 'lib/capybara/poltergeist/driver.rb', line 223 def network_traffic browser.network_traffic end |
#no_such_window_error ⇒ Object
174 175 176 |
# File 'lib/capybara/poltergeist/driver.rb', line 174 def no_such_window_error NoSuchWindowError end |
#open_new_window ⇒ Object
162 163 164 |
# File 'lib/capybara/poltergeist/driver.rb', line 162 def open_new_window browser.open_new_window end |
#paper_size=(size = {}) ⇒ Object
194 195 196 |
# File 'lib/capybara/poltergeist/driver.rb', line 194 def paper_size=(size = {}) browser.set_paper_size(size) end |
#pause ⇒ Object
314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 |
# File 'lib/capybara/poltergeist/driver.rb', line 314 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 ⇒ Object
logger should be an object that behaves like IO or nil
91 92 93 |
# File 'lib/capybara/poltergeist/driver.rb', line 91 def phantomjs_logger .fetch(:phantomjs_logger, nil) end |
#phantomjs_options ⇒ Object
52 53 54 55 56 57 58 59 60 61 62 |
# File 'lib/capybara/poltergeist/driver.rb', line 52 def list = [: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 ⇒ Object
80 81 82 83 |
# File 'lib/capybara/poltergeist/driver.rb', line 80 def quit server.stop client.stop end |
#remove_cookie(name) ⇒ Object
274 275 276 |
# File 'lib/capybara/poltergeist/driver.rb', line 274 def (name) browser.(name) end |
#render_base64(format = :png, options = {}) ⇒ Object
190 191 192 |
# File 'lib/capybara/poltergeist/driver.rb', line 190 def render_base64(format = :png, = {}) browser.render_base64(format, ) end |
#reset! ⇒ Object
178 179 180 181 182 183 |
# File 'lib/capybara/poltergeist/driver.rb', line 178 def reset! browser.reset browser.url_blacklist = [:url_blacklist] if .key?(:url_blacklist) browser.url_whitelist = [:url_whitelist] if .key?(:url_whitelist) @started = false end |
#resize(width, height) ⇒ Object Also known as: resize_window
202 203 204 |
# File 'lib/capybara/poltergeist/driver.rb', line 202 def resize(width, height) browser.resize(width, height) end |
#resize_window_to(handle, width, height) ⇒ Object
207 208 209 210 211 |
# File 'lib/capybara/poltergeist/driver.rb', line 207 def resize_window_to(handle, width, height) within_window(handle) do resize(width, height) end end |
#response_headers ⇒ Object
252 253 254 |
# File 'lib/capybara/poltergeist/driver.rb', line 252 def response_headers browser.response_headers end |
#restart ⇒ Object
76 77 78 |
# File 'lib/capybara/poltergeist/driver.rb', line 76 def restart browser.restart end |
#save_screenshot(path, options = {}) ⇒ Object Also known as: render
185 186 187 |
# File 'lib/capybara/poltergeist/driver.rb', line 185 def save_screenshot(path, = {}) browser.render(path, ) end |
#scroll_to(left, top) ⇒ Object
219 220 221 |
# File 'lib/capybara/poltergeist/driver.rb', line 219 def scroll_to(left, top) browser.scroll_to(left, top) end |
#server ⇒ Object
39 40 41 |
# File 'lib/capybara/poltergeist/driver.rb', line 39 def server @server ||= Server.new([:port], .fetch(:timeout) { DEFAULT_TIMEOUT }) end |
#set_cookie(name, value, options = {}) ⇒ Object
260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'lib/capybara/poltergeist/driver.rb', line 260 def (name, value, = {}) [:name] ||= name [:value] ||= value [:domain] ||= begin if @started URI.parse(browser.current_url).host else URI.parse(Capybara.app_host || '').host || "127.0.0.1" end end browser.() end |
#set_proxy(ip, port, type = "http", user = nil, password = nil) ⇒ Object
231 232 233 |
# File 'lib/capybara/poltergeist/driver.rb', line 231 def set_proxy(ip, port, type = "http", user = nil, password = nil) browser.set_proxy(ip, port, type, user, password) end |
#source ⇒ Object
113 114 115 |
# File 'lib/capybara/poltergeist/driver.rb', line 113 def source browser.source.to_s end |
#status_code ⇒ Object
104 105 106 |
# File 'lib/capybara/poltergeist/driver.rb', line 104 def status_code browser.status_code end |
#switch_to_window(handle) ⇒ Object
166 167 168 |
# File 'lib/capybara/poltergeist/driver.rb', line 166 def switch_to_window(handle) browser.switch_to_window(handle) end |
#timeout ⇒ Object
68 69 70 |
# File 'lib/capybara/poltergeist/driver.rb', line 68 def timeout server.timeout end |
#timeout=(sec) ⇒ Object
72 73 74 |
# File 'lib/capybara/poltergeist/driver.rb', line 72 def timeout=(sec) server.timeout = sec end |
#title ⇒ Object
117 118 119 |
# File 'lib/capybara/poltergeist/driver.rb', line 117 def title browser.title end |
#visit(url) ⇒ Object
95 96 97 98 |
# File 'lib/capybara/poltergeist/driver.rb', line 95 def visit(url) @started = true browser.visit(url) end |
#wait? ⇒ Boolean
340 341 342 |
# File 'lib/capybara/poltergeist/driver.rb', line 340 def wait? true end |
#window_handles ⇒ Object
154 155 156 |
# File 'lib/capybara/poltergeist/driver.rb', line 154 def window_handles browser.window_handles end |
#window_size(handle) ⇒ Object
213 214 215 216 217 |
# File 'lib/capybara/poltergeist/driver.rb', line 213 def window_size(handle) within_window(handle) do evaluate_script('[window.innerWidth, window.innerHeight]') end end |
#within_frame(name, &block) ⇒ Object
146 147 148 |
# File 'lib/capybara/poltergeist/driver.rb', line 146 def within_frame(name, &block) browser.within_frame(name, &block) end |
#within_window(name, &block) ⇒ Object
170 171 172 |
# File 'lib/capybara/poltergeist/driver.rb', line 170 def within_window(name, &block) browser.within_window(name, &block) end |
#zoom_factor=(zoom_factor) ⇒ Object
198 199 200 |
# File 'lib/capybara/poltergeist/driver.rb', line 198 def zoom_factor=(zoom_factor) browser.set_zoom_factor(zoom_factor) end |