Class: Selenium::WebDriver::Manager

Relationships & Source Files
Inherits:	Object
Defined in:	rb/lib/selenium/webdriver/common/manager.rb

Constant Summary

SECONDS_PER_DAY =
# File 'rb/lib/selenium/webdriver/common/manager.rb', line 113
```
86_400.0
```

Class Method Summary

.new(bridge) ⇒ Manager constructor Internal use only Internal use only

Instance Method Summary

#add_cookie(opts = {})

Add a cookie to the browser.
#all_cookies ⇒ Array<Hash>

Get all cookies.
#cookie_named(name) ⇒ Hash

Get the cookie with the given name.
#delete_all_cookies

Delete all cookies.
#delete_cookie(name)

Delete the cookie with the given name.
#timeouts
#window
#convert_cookie(cookie) private
#datetime_at(int) private
#seconds_from(obj) private
#strip_port(str) private

Constructor Details

.new(bridge) ⇒ `Manager`

This method is for internal use only.

[ GitHub ]

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


def initialize(bridge)
  @bridge = bridge
end

Instance Method Details

#add_cookie(opts = {})

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

[ GitHub ]

# File 'rb/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

[ GitHub ]

# File 'rb/lib/selenium/webdriver/common/manager.rb', line 99


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

#convert_cookie(cookie) (private)

[ GitHub ]

# File 'rb/lib/selenium/webdriver/common/manager.rb', line 136


def convert_cookie(cookie)
  {
    name: cookie['name'],
    value: cookie['value'],
    path: cookie['path'],
    domain: cookie['domain'] && strip_port(cookie['domain']),
    expires: cookie['expiry'] && datetime_at(cookie['expiry']),
    same_site: cookie['sameSite'],
    http_only: cookie['httpOnly'],
    secure: cookie['secure']
  }
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.

[ GitHub ]

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


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

#datetime_at(int) (private)

[ GitHub ]

# File 'rb/lib/selenium/webdriver/common/manager.rb', line 115


def datetime_at(int)
  DateTime.civil(1970) + (int / SECONDS_PER_DAY)
end

#delete_all_cookies

Delete all cookies

[ GitHub ]

# File 'rb/lib/selenium/webdriver/common/manager.rb', line 89


def delete_all_cookies
  @bridge.delete_all_cookies
end

#delete_cookie(name)

Delete the cookie with the given name

Parameters:

name (String) —

the name of the cookie to delete

[ GitHub ]

# File 'rb/lib/selenium/webdriver/common/manager.rb', line 81


def delete_cookie(name)
  @bridge.delete_cookie name
end

#seconds_from(obj) (private)

[ GitHub ]

# File 'rb/lib/selenium/webdriver/common/manager.rb', line 119


def seconds_from(obj)
  case obj
  when Time
    obj.to_f
  when DateTime
    (obj - DateTime.civil(1970)) * SECONDS_PER_DAY
  when Numeric
    obj
  else
    raise ArgumentError, "invalid value for expiration date: #{obj.inspect}"
  end
end

#strip_port(str) (private)

[ GitHub ]

# File 'rb/lib/selenium/webdriver/common/manager.rb', line 132


def strip_port(str)
  str.split(':', 2).first
end

#timeouts

[ GitHub ]

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


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

#window

[ GitHub ]

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


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

Class: Selenium::WebDriver::Manager

Constant Summary

Class Method Summary

Instance Method Summary

Constructor Details

.new(bridge) ⇒ Manager

Instance Method Details

#add_cookie(opts = {})

#all_cookies ⇒ Array<Hash>

#convert_cookie(cookie) (private)

#cookie_named(name) ⇒ Hash

#datetime_at(int) (private)

#delete_all_cookies

#delete_cookie(name)

#seconds_from(obj) (private)

#strip_port(str) (private)

#timeouts

#window

.new(bridge) ⇒ `Manager`

#all_cookies ⇒ `Array`<`Hash`>

#cookie_named(name) ⇒ `Hash`