Class: Selenium::WebDriver::Manager

Inherits:
Object
  • Object
show all
Defined in:
lib/selenium/webdriver/common/manager.rb

Instance Method Summary collapse

Constructor Details

#initialize(bridge) ⇒ Manager

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Manager.



27
28
29
 
# File 'lib/selenium/webdriver/common/manager.rb', line 27

def initialize(bridge)
  @bridge = bridge
end

Instance Method Details

Add a cookie to the browser

Parameters:

  • opts (Hash) (defaults to: {}) —

    the options to create a cookie with.

Options Hash (opts):

  • :name (String) —

    A name

  • :value (String) —

    A value

  • :path (String) — default: '/' —

    A path

  • :secure (String) — default: false —

    A boolean

  • :same_site (String) — default: Strict or Lax —

    currently supported only in chrome 80+ versions

  • :expires (Time, DateTime, Numeric, nil) — default: nil —

    Expiry date, either as a Time, DateTime, or seconds since epoch.

Raises:

  • (ArgumentError) —

    if :name or :value is not specified



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/selenium/webdriver/common/manager.rb', line 45

def add_cookie(opts = {})
  raise ArgumentError, 'name is required' unless opts[:name]
  raise ArgumentError, 'value is required' unless opts[:value]

  # NOTE: This is required because of https://bugs.chromium.org/p/chromedriver/issues/detail?id=3732
  opts[:secure] ||= false

  same_site = opts.delete(:same_site)
  opts[:sameSite] = same_site if same_site

  http_only = opts.delete(:http_only)
  opts[:httpOnly] = http_only if http_only

  obj = opts.delete(:expires)
  opts[:expiry] = seconds_from(obj).to_int if obj

  @bridge.add_cookie opts
end

#all_cookies ⇒ Array<Hash>

Get all cookies

Returns:

  • (Array<Hash>) —

    list of cookies



101
102
103
 
# File 'lib/selenium/webdriver/common/manager.rb', line 101

def all_cookies
  @bridge.cookies.map { |cookie| convert_cookie(cookie) }
end

#cookie_named(name) ⇒ Hash

Get the cookie with the given name

Parameters:

  • name (String) —

    the name of the cookie

Returns:

  • (Hash) —

    the cookie, or throws a NoSuchCookieError if it wasn’t found.



71
72
73
 
# File 'lib/selenium/webdriver/common/manager.rb', line 71

def cookie_named(name)
  convert_cookie(@bridge.cookie(name))
end

#delete_all_cookies ⇒ Object

Delete all cookies



91
92
93
 
# File 'lib/selenium/webdriver/common/manager.rb', line 91

def delete_all_cookies
  @bridge.delete_all_cookies
end

#delete_cookie(name) ⇒ Object

Delete the cookie with the given name

Parameters:

  • name (String) —

    the name of the cookie to delete

Raises:

  • (ArgumentError) 


81
82
83
84
85
 
# File 'lib/selenium/webdriver/common/manager.rb', line 81

def delete_cookie(name)
  raise ArgumentError, 'Cookie name cannot be null or empty' if name.nil? || name.to_s.strip.empty?

  @bridge.delete_cookie name
end

#timeouts ⇒ Object 



105
106
107
 
# File 'lib/selenium/webdriver/common/manager.rb', line 105

def timeouts
  @timeouts ||= Timeouts.new(@bridge)
end

#window ⇒ Object 



109
110
111
 
# File 'lib/selenium/webdriver/common/manager.rb', line 109

def window
  @window ||= Window.new(@bridge)
end