Class: Capybara::Poltergeist::Browser
- Inherits:
-
Object
- Object
- Capybara::Poltergeist::Browser
- Defined in:
- lib/capybara/poltergeist/browser.rb
Constant Summary collapse
- ERROR_MAPPINGS =
{ 'Poltergeist.JavascriptError' => JavascriptError, 'Poltergeist.FrameNotFound' => FrameNotFound, 'Poltergeist.InvalidSelector' => InvalidSelector, 'Poltergeist.StatusFailError' => StatusFailError, 'Poltergeist.NoSuchWindowError' => NoSuchWindowError, 'Poltergeist.UnsupportedFeature' => UnsupportedFeature }
Instance Attribute Summary collapse
-
#client ⇒ Object
readonly
Returns the value of attribute client.
-
#logger ⇒ Object
readonly
Returns the value of attribute logger.
-
#server ⇒ Object
readonly
Returns the value of attribute server.
Instance Method Summary collapse
- #accept_confirm ⇒ Object
-
#accept_prompt(response) ⇒ Object
press “OK” with text (response) or default value.
- #add_header(header, permanent) ⇒ Object
- #add_headers(headers) ⇒ Object
- #all_text(page_id, id) ⇒ Object
- #attribute(page_id, id, name) ⇒ Object
- #attributes(page_id, id) ⇒ Object
- #body ⇒ Object
- #clear_cookies ⇒ Object
- #clear_memory_cache ⇒ Object
- #clear_network_traffic ⇒ Object
- #click(page_id, id) ⇒ Object
- #click_coordinates(x, y) ⇒ Object
- #close_window(handle) ⇒ Object
- #command(name, *args) ⇒ Object
- #cookies ⇒ Object
- #cookies_enabled=(flag) ⇒ Object
- #current_url ⇒ Object
- #debug=(val) ⇒ Object
- #delete_text(page_id, id) ⇒ Object
- #disabled?(page_id, id) ⇒ Boolean
- #dismiss_confirm ⇒ Object
-
#dismiss_prompt ⇒ Object
press “Cancel”.
- #double_click(page_id, id) ⇒ Object
- #drag(page_id, id, other_id) ⇒ Object
- #drag_by(page_id, id, x, y) ⇒ Object
- #equals(page_id, id, other_id) ⇒ Object
- #evaluate(script) ⇒ Object
- #execute(script) ⇒ Object
- #extensions=(names) ⇒ Object
- #find(method, selector) ⇒ Object
- #find_window_handle(locator) ⇒ Object
- #find_within(page_id, id, method, selector) ⇒ Object
- #get_headers ⇒ Object
- #go_back ⇒ Object
- #go_forward ⇒ Object
- #hover(page_id, id) ⇒ Object
-
#initialize(server, client, logger = nil) ⇒ Browser
constructor
A new instance of Browser.
- #js_errors=(val) ⇒ Object
- #modal_message ⇒ Object
- #network_traffic ⇒ Object
- #open_new_window ⇒ Object
- #parents(page_id, id) ⇒ Object
- #path(page_id, id) ⇒ Object
- #property(page_id, id, name) ⇒ Object
- #remove_cookie(name) ⇒ Object
- #render(path, options = {}) ⇒ Object
- #render_base64(format, options = {}) ⇒ Object
- #reset ⇒ Object
- #resize(width, height) ⇒ Object
- #response_headers ⇒ Object
- #restart ⇒ Object
- #right_click(page_id, id) ⇒ Object
- #scroll_to(left, top) ⇒ Object
- #select(page_id, id, value) ⇒ Object
- #select_file(page_id, id, value) ⇒ Object
- #send_keys(page_id, id, keys) ⇒ Object
- #set(page_id, id, value) ⇒ Object
- #set_cookie(cookie) ⇒ Object
- #set_headers(headers) ⇒ Object
- #set_http_auth(user, password) ⇒ Object
- #set_paper_size(size) ⇒ Object
- #set_proxy(ip, port, type, user, password) ⇒ Object
- #set_zoom_factor(zoom_factor) ⇒ Object
- #source ⇒ Object
- #status_code ⇒ Object
- #switch_to_window(handle) ⇒ Object
- #tag_name(page_id, id) ⇒ Object
- #title ⇒ Object
- #trigger(page_id, id, event) ⇒ Object
- #url_blacklist=(blacklist) ⇒ Object
- #url_whitelist=(whitelist) ⇒ Object
- #value(page_id, id) ⇒ Object
- #visible?(page_id, id) ⇒ Boolean
- #visible_text(page_id, id) ⇒ Object
- #visit(url) ⇒ Object
- #window_handle ⇒ Object
- #window_handles ⇒ Object
- #within_frame(handle, &block) ⇒ Object
- #within_window(locator, &block) ⇒ Object
Constructor Details
#initialize(server, client, logger = nil) ⇒ Browser
Returns a new instance of Browser.
19 20 21 22 23 |
# File 'lib/capybara/poltergeist/browser.rb', line 19 def initialize(server, client, logger = nil) @server = server @client = client @logger = logger end |
Instance Attribute Details
#client ⇒ Object (readonly)
Returns the value of attribute client.
17 18 19 |
# File 'lib/capybara/poltergeist/browser.rb', line 17 def client @client end |
#logger ⇒ Object (readonly)
Returns the value of attribute logger.
17 18 19 |
# File 'lib/capybara/poltergeist/browser.rb', line 17 def logger @logger end |
#server ⇒ Object (readonly)
Returns the value of attribute server.
17 18 19 |
# File 'lib/capybara/poltergeist/browser.rb', line 17 def server @server end |
Instance Method Details
#accept_confirm ⇒ Object
382 383 384 |
# File 'lib/capybara/poltergeist/browser.rb', line 382 def accept_confirm command 'set_confirm_process', true end |
#accept_prompt(response) ⇒ Object
press “OK” with text (response) or default value
393 394 395 |
# File 'lib/capybara/poltergeist/browser.rb', line 393 def accept_prompt(response) command 'set_prompt_response', response || false end |
#add_header(header, permanent) ⇒ Object
289 290 291 |
# File 'lib/capybara/poltergeist/browser.rb', line 289 def add_header(header, permanent) command 'add_header', header, permanent end |
#add_headers(headers) ⇒ Object
285 286 287 |
# File 'lib/capybara/poltergeist/browser.rb', line 285 def add_headers(headers) command 'add_headers', headers end |
#all_text(page_id, id) ⇒ Object
71 72 73 |
# File 'lib/capybara/poltergeist/browser.rb', line 71 def all_text(page_id, id) command 'all_text', page_id, id end |
#attribute(page_id, id, name) ⇒ Object
91 92 93 |
# File 'lib/capybara/poltergeist/browser.rb', line 91 def attribute(page_id, id, name) command 'attribute', page_id, id, name.to_s end |
#attributes(page_id, id) ⇒ Object
87 88 89 |
# File 'lib/capybara/poltergeist/browser.rb', line 87 def attributes(page_id, id) command 'attributes', page_id, id end |
#body ⇒ Object
46 47 48 |
# File 'lib/capybara/poltergeist/browser.rb', line 46 def body command 'body' end |
#clear_cookies ⇒ Object
313 314 315 |
# File 'lib/capybara/poltergeist/browser.rb', line 313 def command 'clear_cookies' end |
#clear_memory_cache ⇒ Object
350 351 352 |
# File 'lib/capybara/poltergeist/browser.rb', line 350 def clear_memory_cache command 'clear_memory_cache' end |
#clear_network_traffic ⇒ Object
262 263 264 |
# File 'lib/capybara/poltergeist/browser.rb', line 262 def clear_network_traffic command('clear_network_traffic') end |
#click(page_id, id) ⇒ Object
180 181 182 |
# File 'lib/capybara/poltergeist/browser.rb', line 180 def click(page_id, id) command 'click', page_id, id end |
#click_coordinates(x, y) ⇒ Object
119 120 121 |
# File 'lib/capybara/poltergeist/browser.rb', line 119 def click_coordinates(x, y) command 'click_coordinates', x, y end |
#close_window(handle) ⇒ Object
159 160 161 |
# File 'lib/capybara/poltergeist/browser.rb', line 159 def close_window(handle) command 'close_window', handle end |
#command(name, *args) ⇒ Object
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 |
# File 'lib/capybara/poltergeist/browser.rb', line 354 def command(name, *args) cmd = Command.new(name, *args) log cmd. response = server.send(cmd) log response json = JSON.load(response) if json['error'] klass = ERROR_MAPPINGS[json['error']['name']] || BrowserError raise klass.new(json['error']) else json['response'] end rescue DeadClient restart raise end |
#cookies ⇒ Object
297 298 299 |
# File 'lib/capybara/poltergeist/browser.rb', line 297 def Hash[command('cookies').map { || [['name'], Cookie.new()] }] end |
#cookies_enabled=(flag) ⇒ Object
317 318 319 |
# File 'lib/capybara/poltergeist/browser.rb', line 317 def (flag) command 'cookies_enabled', !!flag end |
#current_url ⇒ Object
38 39 40 |
# File 'lib/capybara/poltergeist/browser.rb', line 38 def current_url command 'current_url' end |
#debug=(val) ⇒ Object
345 346 347 348 |
# File 'lib/capybara/poltergeist/browser.rb', line 345 def debug=(val) @debug = val command 'set_debug', !!val end |
#delete_text(page_id, id) ⇒ Object
79 80 81 |
# File 'lib/capybara/poltergeist/browser.rb', line 79 def delete_text(page_id, id) command 'delete_text', page_id, id end |
#disabled?(page_id, id) ⇒ Boolean
115 116 117 |
# File 'lib/capybara/poltergeist/browser.rb', line 115 def disabled?(page_id, id) command 'disabled', page_id, id end |
#dismiss_confirm ⇒ Object
386 387 388 |
# File 'lib/capybara/poltergeist/browser.rb', line 386 def dismiss_confirm command 'set_confirm_process', false end |
#dismiss_prompt ⇒ Object
press “Cancel”
400 401 402 |
# File 'lib/capybara/poltergeist/browser.rb', line 400 def dismiss_prompt command 'set_prompt_response', nil end |
#double_click(page_id, id) ⇒ Object
188 189 190 |
# File 'lib/capybara/poltergeist/browser.rb', line 188 def double_click(page_id, id) command 'double_click', page_id, id end |
#drag(page_id, id, other_id) ⇒ Object
196 197 198 |
# File 'lib/capybara/poltergeist/browser.rb', line 196 def drag(page_id, id, other_id) command 'drag', page_id, id, other_id end |
#drag_by(page_id, id, x, y) ⇒ Object
200 201 202 |
# File 'lib/capybara/poltergeist/browser.rb', line 200 def drag_by(page_id, id, x, y) command 'drag_by', page_id, id, x, y end |
#equals(page_id, id, other_id) ⇒ Object
273 274 275 |
# File 'lib/capybara/poltergeist/browser.rb', line 273 def equals(page_id, id, other_id) command('equals', page_id, id, other_id) end |
#evaluate(script) ⇒ Object
123 124 125 |
# File 'lib/capybara/poltergeist/browser.rb', line 123 def evaluate(script) command 'evaluate', script end |
#execute(script) ⇒ Object
127 128 129 |
# File 'lib/capybara/poltergeist/browser.rb', line 127 def execute(script) command 'execute', script end |
#extensions=(names) ⇒ Object
330 331 332 333 334 335 |
# File 'lib/capybara/poltergeist/browser.rb', line 330 def extensions=(names) @extensions = names Array(names).each do |name| command 'add_extension', name end end |
#find(method, selector) ⇒ Object
62 63 64 65 |
# File 'lib/capybara/poltergeist/browser.rb', line 62 def find(method, selector) result = command('find', method, selector) result['ids'].map { |id| [result['page_id'], id] } end |
#find_window_handle(locator) ⇒ Object
163 164 165 166 167 168 169 |
# File 'lib/capybara/poltergeist/browser.rb', line 163 def find_window_handle(locator) return locator if window_handles.include? locator handle = command 'window_handle', locator raise NoSuchWindowError unless handle return handle end |
#find_within(page_id, id, method, selector) ⇒ Object
67 68 69 |
# File 'lib/capybara/poltergeist/browser.rb', line 67 def find_within(page_id, id, method, selector) command 'find_within', page_id, id, method, selector end |
#get_headers ⇒ Object
277 278 279 |
# File 'lib/capybara/poltergeist/browser.rb', line 277 def get_headers command 'get_headers' end |
#go_back ⇒ Object
374 375 376 |
# File 'lib/capybara/poltergeist/browser.rb', line 374 def go_back command 'go_back' end |
#go_forward ⇒ Object
378 379 380 |
# File 'lib/capybara/poltergeist/browser.rb', line 378 def go_forward command 'go_forward' end |
#hover(page_id, id) ⇒ Object
192 193 194 |
# File 'lib/capybara/poltergeist/browser.rb', line 192 def hover(page_id, id) command 'hover', page_id, id end |
#js_errors=(val) ⇒ Object
325 326 327 328 |
# File 'lib/capybara/poltergeist/browser.rb', line 325 def js_errors=(val) @js_errors = val command 'set_js_errors', !!val end |
#modal_message ⇒ Object
404 405 406 |
# File 'lib/capybara/poltergeist/browser.rb', line 404 def command 'modal_message' end |
#network_traffic ⇒ Object
252 253 254 255 256 257 258 259 260 |
# File 'lib/capybara/poltergeist/browser.rb', line 252 def network_traffic command('network_traffic').values.map do |event| NetworkTraffic::Request.new( event['request'], event['responseParts'].map { |response| NetworkTraffic::Response.new(response) }, event['error'] ? NetworkTraffic::Error.new(event['error']) : nil ) end end |
#open_new_window ⇒ Object
155 156 157 |
# File 'lib/capybara/poltergeist/browser.rb', line 155 def open_new_window command 'open_new_window' end |
#parents(page_id, id) ⇒ Object
58 59 60 |
# File 'lib/capybara/poltergeist/browser.rb', line 58 def parents(page_id, id) command 'parents', page_id, id end |
#path(page_id, id) ⇒ Object
248 249 250 |
# File 'lib/capybara/poltergeist/browser.rb', line 248 def path(page_id, id) command 'path', page_id, id end |
#property(page_id, id, name) ⇒ Object
83 84 85 |
# File 'lib/capybara/poltergeist/browser.rb', line 83 def property(page_id, id, name) command 'property', page_id, id, name.to_s end |
#remove_cookie(name) ⇒ Object
309 310 311 |
# File 'lib/capybara/poltergeist/browser.rb', line 309 def (name) command 'remove_cookie', name end |
#render(path, options = {}) ⇒ Object
220 221 222 223 224 |
# File 'lib/capybara/poltergeist/browser.rb', line 220 def render(path, = {}) () [:full] = !![:full] command 'render', path.to_s, end |
#render_base64(format, options = {}) ⇒ Object
226 227 228 229 230 |
# File 'lib/capybara/poltergeist/browser.rb', line 226 def render_base64(format, = {}) () [:full] = !![:full] command 'render_base64', format.to_s, end |
#reset ⇒ Object
212 213 214 |
# File 'lib/capybara/poltergeist/browser.rb', line 212 def reset command 'reset' end |
#resize(width, height) ⇒ Object
240 241 242 |
# File 'lib/capybara/poltergeist/browser.rb', line 240 def resize(width, height) command 'resize', width, height end |
#response_headers ⇒ Object
293 294 295 |
# File 'lib/capybara/poltergeist/browser.rb', line 293 def response_headers command 'response_headers' end |
#restart ⇒ Object
25 26 27 28 29 30 31 32 |
# File 'lib/capybara/poltergeist/browser.rb', line 25 def restart server.restart client.restart self.debug = @debug if defined?(@debug) self.js_errors = @js_errors if defined?(@js_errors) self.extensions = @extensions if @extensions end |
#right_click(page_id, id) ⇒ Object
184 185 186 |
# File 'lib/capybara/poltergeist/browser.rb', line 184 def right_click(page_id, id) command 'right_click', page_id, id end |
#scroll_to(left, top) ⇒ Object
216 217 218 |
# File 'lib/capybara/poltergeist/browser.rb', line 216 def scroll_to(left, top) command 'scroll_to', left, top end |
#select(page_id, id, value) ⇒ Object
204 205 206 |
# File 'lib/capybara/poltergeist/browser.rb', line 204 def select(page_id, id, value) command 'select', page_id, id, value end |
#select_file(page_id, id, value) ⇒ Object
103 104 105 |
# File 'lib/capybara/poltergeist/browser.rb', line 103 def select_file(page_id, id, value) command 'select_file', page_id, id, value end |
#send_keys(page_id, id, keys) ⇒ Object
244 245 246 |
# File 'lib/capybara/poltergeist/browser.rb', line 244 def send_keys(page_id, id, keys) command 'send_keys', page_id, id, normalize_keys(keys) end |
#set(page_id, id, value) ⇒ Object
99 100 101 |
# File 'lib/capybara/poltergeist/browser.rb', line 99 def set(page_id, id, value) command 'set', page_id, id, value end |
#set_cookie(cookie) ⇒ Object
301 302 303 304 305 306 307 |
# File 'lib/capybara/poltergeist/browser.rb', line 301 def () if [:expires] [:expires] = [:expires].to_i * 1000 end command 'set_cookie', end |
#set_headers(headers) ⇒ Object
281 282 283 |
# File 'lib/capybara/poltergeist/browser.rb', line 281 def set_headers(headers) command 'set_headers', headers end |
#set_http_auth(user, password) ⇒ Object
321 322 323 |
# File 'lib/capybara/poltergeist/browser.rb', line 321 def set_http_auth(user, password) command 'set_http_auth', user, password end |
#set_paper_size(size) ⇒ Object
236 237 238 |
# File 'lib/capybara/poltergeist/browser.rb', line 236 def set_paper_size(size) command 'set_paper_size', size end |
#set_proxy(ip, port, type, user, password) ⇒ Object
266 267 268 269 270 271 |
# File 'lib/capybara/poltergeist/browser.rb', line 266 def set_proxy(ip, port, type, user, password) args = [ip, port, type] args << user if user args << password if password command('set_proxy', *args) end |
#set_zoom_factor(zoom_factor) ⇒ Object
232 233 234 |
# File 'lib/capybara/poltergeist/browser.rb', line 232 def set_zoom_factor(zoom_factor) command 'set_zoom_factor', zoom_factor end |
#source ⇒ Object
50 51 52 |
# File 'lib/capybara/poltergeist/browser.rb', line 50 def source command 'source' end |
#status_code ⇒ Object
42 43 44 |
# File 'lib/capybara/poltergeist/browser.rb', line 42 def status_code command 'status_code' end |
#switch_to_window(handle) ⇒ Object
151 152 153 |
# File 'lib/capybara/poltergeist/browser.rb', line 151 def switch_to_window(handle) command 'switch_to_window', handle end |
#tag_name(page_id, id) ⇒ Object
107 108 109 |
# File 'lib/capybara/poltergeist/browser.rb', line 107 def tag_name(page_id, id) command('tag_name', page_id, id).downcase end |
#title ⇒ Object
54 55 56 |
# File 'lib/capybara/poltergeist/browser.rb', line 54 def title command 'title' end |
#trigger(page_id, id, event) ⇒ Object
208 209 210 |
# File 'lib/capybara/poltergeist/browser.rb', line 208 def trigger(page_id, id, event) command 'trigger', page_id, id, event.to_s end |
#url_blacklist=(blacklist) ⇒ Object
341 342 343 |
# File 'lib/capybara/poltergeist/browser.rb', line 341 def url_blacklist=(blacklist) command 'set_url_blacklist', *blacklist end |
#url_whitelist=(whitelist) ⇒ Object
337 338 339 |
# File 'lib/capybara/poltergeist/browser.rb', line 337 def url_whitelist=(whitelist) command 'set_url_whitelist', *whitelist end |
#value(page_id, id) ⇒ Object
95 96 97 |
# File 'lib/capybara/poltergeist/browser.rb', line 95 def value(page_id, id) command 'value', page_id, id end |
#visible?(page_id, id) ⇒ Boolean
111 112 113 |
# File 'lib/capybara/poltergeist/browser.rb', line 111 def visible?(page_id, id) command 'visible', page_id, id end |
#visible_text(page_id, id) ⇒ Object
75 76 77 |
# File 'lib/capybara/poltergeist/browser.rb', line 75 def visible_text(page_id, id) command 'visible_text', page_id, id end |
#visit(url) ⇒ Object
34 35 36 |
# File 'lib/capybara/poltergeist/browser.rb', line 34 def visit(url) command 'visit', url end |
#window_handle ⇒ Object
143 144 145 |
# File 'lib/capybara/poltergeist/browser.rb', line 143 def window_handle command 'window_handle' end |
#window_handles ⇒ Object
147 148 149 |
# File 'lib/capybara/poltergeist/browser.rb', line 147 def window_handles command 'window_handles' end |
#within_frame(handle, &block) ⇒ Object
131 132 133 134 135 136 137 138 139 140 141 |
# File 'lib/capybara/poltergeist/browser.rb', line 131 def within_frame(handle, &block) if handle.is_a?(Capybara::Node::Base) command 'push_frame', [handle.native.page_id, handle.native.id] else command 'push_frame', handle end yield ensure command 'pop_frame' end |
#within_window(locator, &block) ⇒ Object
171 172 173 174 175 176 177 178 |
# File 'lib/capybara/poltergeist/browser.rb', line 171 def within_window(locator, &block) original = window_handle handle = find_window_handle(locator) switch_to_window(handle) yield ensure switch_to_window(original) end |