Class: Webrat::Session

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from SaveAndOpenPage

#open_in_browser, #save_and_open_page

Methods included from Logging

#debug_log, #logger

Constructor Details

#initialize(adapter = nil) ⇒ Session

Returns a new instance of Session.


72
73
74
75
76
77
78
79
80
# File 'lib/webrat/core/session.rb', line 72

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

Instance Attribute Details

#adapterObject

Returns the value of attribute adapter


63
64
65
# File 'lib/webrat/core/session.rb', line 63

def adapter
  @adapter
end

#current_urlObject (readonly)

Returns the value of attribute current_url


65
66
67
# File 'lib/webrat/core/session.rb', line 65

def current_url
  @current_url
end

#elementsObject (readonly)

Returns the value of attribute elements


66
67
68
# File 'lib/webrat/core/session.rb', line 66

def elements
  @elements
end

Instance Method Details

#automateObject


259
260
261
262
# File 'lib/webrat/core/session.rb', line 259

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

#basic_auth(user, pass) ⇒ Object


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

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

#check_for_infinite_redirectsObject


138
139
140
141
142
143
144
145
146
147
# File 'lib/webrat/core/session.rb', line 138

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

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

Example:

click_link_within "#user_12", "Vote"

196
197
198
199
200
# File 'lib/webrat/core/session.rb', line 196

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

#current_domObject

:nodoc:


82
83
84
# File 'lib/webrat/core/session.rb', line 82

def current_dom #:nodoc:
  current_scope.dom
end

#current_pageObject

For backwards compatibility – removing in 1.0


87
88
89
90
91
92
93
94
# File 'lib/webrat/core/session.rb', line 87

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_scopeObject

:nodoc:


179
180
181
# File 'lib/webrat/core/session.rb', line 179

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

#domObject


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

def dom
  page_scope.dom
end

#exception_caught?Boolean

:nodoc:

Returns:

  • (Boolean)

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

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

#follow_redirect!Object

Redirects to the address given at headers.

Example:

click_button "Save"
follow_redirect!

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

def follow_redirect!
  raise "not a redirect! Got #{response_code}" unless redirect?
  visit(response_location)
  response_code
end

#formatted_errorObject

Subclasses can override this to show error messages without html


234
235
236
# File 'lib/webrat/core/session.rb', line 234

def formatted_error #:nodoc:
  response_body
end

#header(key, value) ⇒ Object


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

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

#headersObject

:nodoc:


109
110
111
# File 'lib/webrat/core/session.rb', line 109

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

#http_accept(mime_type) ⇒ Object


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

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

#infinite_redirect_limit_exceeded?Boolean

Returns:

  • (Boolean)

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

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)

162
163
164
165
166
167
168
# File 'lib/webrat/core/session.rb', line 162

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_scopeObject

:nodoc:


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

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

#redirect?Boolean

:nodoc:

Returns:

  • (Boolean)

158
159
160
# File 'lib/webrat/core/session.rb', line 158

def redirect? #:nodoc:
  [301, 302, 303, 307].include?(response_code)
end

#redirected_toObject

easy helper to pull out where we were redirected to


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

def redirected_to
  redirect? ? response_location : nil
end

#reloadObject

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


185
186
187
# File 'lib/webrat/core/session.rb', line 185

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

#request_page(url, http_method, data) ⇒ Object

:nodoc:

Raises:


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

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

#scopesObject

:nodoc:


238
239
240
# File 'lib/webrat/core/session.rb', line 238

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

#simulateObject


254
255
256
257
# File 'lib/webrat/core/session.rb', line 254

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

#success_code?Boolean

:nodoc:

Returns:

  • (Boolean)

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

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 "/"

216
217
218
# File 'lib/webrat/core/session.rb', line 216

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

#within(selector) ⇒ Object


204
205
206
207
208
209
# File 'lib/webrat/core/session.rb', line 204

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)

250
251
252
# File 'lib/webrat/core/session.rb', line 250

def xml_content_type?
  false
end