Class: Webrat::Session

Inherits:
Object show all
Extended by:
Forwardable
Includes:
Logging, SaveAndOpenPage
Defined in:
lib/webrat/core/session.rb

Direct Known Subclasses

MechanizeSession

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from SaveAndOpenPage

#open_in_browser, #rewrite_css_and_image_references, #save_and_open_page, #saved_page_dir

Methods included from Logging

#debug_log, #logger

Constructor Details

#initialize(adapter = nil) ⇒ Session

Returns a new instance of Session.



65
66
67
68
69
70
71
72
73
 
# File 'lib/webrat/core/session.rb', line 65

def initialize(adapter=nil)
  @http_method     = :get
  @data            = {}
  @default_headers = {}
  @custom_headers  = {}
  @adapter         = adapter

  reset
end

Instance Attribute Details

#current_url ⇒ Object (readonly)

Returns the value of attribute current_url.



58
59
60
 
# File 'lib/webrat/core/session.rb', line 58

def current_url
  @current_url
end

#elements ⇒ Object (readonly)

Returns the value of attribute elements.



59
60
61
 
# File 'lib/webrat/core/session.rb', line 59

def elements
  @elements
end

Instance Method Details

#automate ⇒ Object 



245
246
247
248
 
# File 'lib/webrat/core/session.rb', line 245

def automate
  return unless Webrat.configuration.mode == :selenium
  yield
end

#basic_auth(user, pass) ⇒ Object 



101
102
103
104
 
# File 'lib/webrat/core/session.rb', line 101

def basic_auth(user, pass)
   = ["#{user}:#{pass}"].pack("m*")
  header('HTTP_AUTHORIZATION', "Basic #{encoded_login}")
end

#check_for_infinite_redirects ⇒ Object 



135
136
137
138
139
140
141
142
143
144
 
# File 'lib/webrat/core/session.rb', line 135

def check_for_infinite_redirects
  if current_url == response_location
    @_identical_redirect_count ||= 0
    @_identical_redirect_count += 1
  end

  if infinite_redirect_limit_exceeded?
    raise InfiniteRedirectError.new("#{Webrat.configuration.infinite_redirect_limit} redirects to the same URL (#{current_url.inspect})")
  end
end

#click_link_within(selector, link_text) ⇒ Object

Works like click_link, but only looks for the link text within a given selector

Example:

click_link_within "#user_12", "Vote"



193
194
195
196
197
 
# File 'lib/webrat/core/session.rb', line 193

def click_link_within(selector, link_text)
  within(selector) do
    click_link(link_text)
  end
end

#current_dom ⇒ Object

:nodoc:



75
76
77
 
# File 'lib/webrat/core/session.rb', line 75

def current_dom #:nodoc:
  current_scope.dom
end

#current_page ⇒ Object

For backwards compatibility – removing in 1.0



80
81
82
83
84
85
86
87
 
# File 'lib/webrat/core/session.rb', line 80

def current_page #:nodoc:
  warn "current_page is deprecated and will be going away in the next release. Use current_url instead."
  page = OpenStruct.new
  page.url = @current_url
  page.http_method = @http_method
  page.data = @data
  page
end

#current_scope ⇒ Object

:nodoc:



176
177
178
 
# File 'lib/webrat/core/session.rb', line 176

def current_scope #:nodoc:
  scopes.last || page_scope
end

#doc_root ⇒ Object

:nodoc:



89
90
91
 
# File 'lib/webrat/core/session.rb', line 89

def doc_root #:nodoc:
  nil
end

#dom ⇒ Object 



232
233
234
 
# File 'lib/webrat/core/session.rb', line 232

def dom
  page_scope.dom
end

#exception_caught? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


172
173
174
 
# File 'lib/webrat/core/session.rb', line 172

def exception_caught? #:nodoc:
  response_body =~ /Exception caught/
end

#formatted_error ⇒ Object

Subclasses can override this to show error messages without html



220
221
222
 
# File 'lib/webrat/core/session.rb', line 220

def formatted_error #:nodoc:
  response_body
end

#header(key, value) ⇒ Object 



93
94
95
 
# File 'lib/webrat/core/session.rb', line 93

def header(key, value)
  @custom_headers[key] = value
end

#headers ⇒ Object

:nodoc:



106
107
108
 
# File 'lib/webrat/core/session.rb', line 106

def headers #:nodoc:
  @default_headers.dup.merge(@custom_headers.dup)
end

#http_accept(mime_type) ⇒ Object 



97
98
99
 
# File 'lib/webrat/core/session.rb', line 97

def http_accept(mime_type)
  header('Accept', Webrat::MIME.mime_type(mime_type))
end

#infinite_redirect_limit_exceeded? ⇒ Boolean

Returns:

  • (Boolean) 


146
147
148
149
 
# File 'lib/webrat/core/session.rb', line 146

def infinite_redirect_limit_exceeded?
   Webrat.configuration.infinite_redirect_limit &&
   (@_identical_redirect_count || 0) > Webrat.configuration.infinite_redirect_limit
end

#internal_redirect? ⇒ Boolean

Returns:

  • (Boolean) 


159
160
161
162
163
164
165
 
# File 'lib/webrat/core/session.rb', line 159

def internal_redirect?
  return false unless redirect?
  #should keep internal_redirects if the subdomain changes
  current_host_domain = current_host.split('.')[-2..-1].join('.') rescue current_host
  response_location_host_domain = response_location_host.split('.')[-2..-1].join('.') rescue response_location_host
  current_host_domain == response_location_host_domain
end

#page_scope ⇒ Object

:nodoc:



228
229
230
 
# File 'lib/webrat/core/session.rb', line 228

def page_scope #:nodoc:
  @_page_scope ||= Scope.from_page(self, response, response_body)
end

#redirect? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


155
156
157
 
# File 'lib/webrat/core/session.rb', line 155

def redirect? #:nodoc:
  (response_code / 100).to_i == 3
end

#redirected_to ⇒ Object

easy helper to pull out where we were redirected to



168
169
170
 
# File 'lib/webrat/core/session.rb', line 168

def redirected_to
  redirect? ? response_location : nil
end

#reload ⇒ Object

Reloads the last page requested. Note that this will resubmit forms and their data.



182
183
184
 
# File 'lib/webrat/core/session.rb', line 182

def reload
  request_page(@current_url, @http_method, @data)
end

#request_page(url, http_method, data) ⇒ Object

:nodoc:

Raises:



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/webrat/core/session.rb', line 110

def request_page(url, http_method, data) #:nodoc:
  h = headers
  h['HTTP_REFERER'] = @current_url if @current_url

  debug_log "REQUESTING PAGE: #{http_method.to_s.upcase} #{url} with #{data.inspect} and HTTP headers #{h.inspect}"

  process_request(http_method, url, data, h)

  save_and_open_page if exception_caught? && Webrat.configuration.open_error_files?
  raise PageLoadError.new("Page load was not successful (Code: #{response_code.inspect}):\n#{formatted_error}") unless success_code?

  reset

  @current_url  = url
  @http_method  = http_method
  @data         = data

  if internal_redirect?
    check_for_infinite_redirects
    request_page(response_location, :get, {})
  end

  return response
end

#scopes ⇒ Object

:nodoc:



224
225
226
 
# File 'lib/webrat/core/session.rb', line 224

def scopes #:nodoc:
  @_scopes ||= []
end

#simulate ⇒ Object 



240
241
242
243
 
# File 'lib/webrat/core/session.rb', line 240

def simulate
  return if Webrat.configuration.mode == :selenium
  yield
end

#success_code? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


151
152
153
 
# File 'lib/webrat/core/session.rb', line 151

def success_code? #:nodoc:
  (200..499).include?(response_code)
end

#visit(url = nil, http_method = :get, data = {}) ⇒ Object

Issues a GET request for a page, follows any redirects, and verifies the final page load was successful.

Example:

visit "/"



213
214
215
 
# File 'lib/webrat/core/session.rb', line 213

def visit(url = nil, http_method = :get, data = {})
  request_page(url, http_method, data)
end

#within(selector) ⇒ Object 



201
202
203
204
205
206
 
# File 'lib/webrat/core/session.rb', line 201

def within(selector)
  scopes.push(Scope.from_scope(self, current_scope, selector))
  ret = yield(current_scope)
  scopes.pop
  return ret
end

#xml_content_type? ⇒ Boolean

Returns:

  • (Boolean) 


236
237
238
 
# File 'lib/webrat/core/session.rb', line 236

def xml_content_type?
  false
end