Class: Watir::Cookies

Inherits:
Object
  • Object
show all
Defined in:
lib/watir-webdriver/cookies.rb

Instance Method Summary collapse

Constructor Details

#initialize(control) ⇒ Cookies

Returns a new instance of Cookies.



3
4
5
 
# File 'lib/watir-webdriver/cookies.rb', line 3

def initialize(control)
  @control = control
end

Instance Method Details

#add(name, value, opts = {}) ⇒ Object

Adds new cookie.

Examples:

browser.cookies.add 'my_session', 'BAh7B0kiD3Nlc3Npb25faWQGOgZFRkk', :secure => true

Parameters:

  • name (String)
  • value (String)
  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :secure (Boolean)
  • :path (String)
  • [] (Object) —

    :expires TODO what type

  • :domain (String) 


38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/watir-webdriver/cookies.rb', line 38

def add(name, value, opts = {})
  cookie = {
    :name    => name,
    :value   => value,
    :secure  => opts[:secure],
    :path    => opts[:path],
    :expires => opts[:expires],
  }

  if opts[:domain]
    cookie[:domain] = opts[:domain]
  end

  @control.add_cookie cookie
end

#clear ⇒ Object

Deletes all cookies.

Examples:

browser.cookies.clear


74
75
76
 
# File 'lib/watir-webdriver/cookies.rb', line 74

def clear
  @control.delete_all_cookies
end

#delete(name) ⇒ Object

Deletes cookie by given name.

Examples:

browser.cookies.delete 'my_session'

Parameters:

  • name (String) 


63
64
65
 
# File 'lib/watir-webdriver/cookies.rb', line 63

def delete(name)
  @control.delete_cookie(name)
end

#to_a ⇒ Array<Hash>

Returns array of cookies.

Examples:

browser.cookies.to_a
#=> {:name=>"my_session", :value=>"BAh7B0kiD3Nlc3Npb25faWQGOgZFRkk", :domain=>"mysite.com"}

Returns:

  • (Array<Hash>) 


17
18
19
20
21
 
# File 'lib/watir-webdriver/cookies.rb', line 17

def to_a
  @control.all_cookies.each do |e|
    e[:expires] = to_time(e[:expires]) if e[:expires]
  end
end