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, #rewrite_css_and_image_references, #save_and_open_page, #saved_page_dir

Methods included from Logging

#debug_log, #logger

Constructor Details

#initialize(context = nil) ⇒ Session

:nodoc:



54
55
56
57
58
59
60
61
62
 
# File 'lib/webrat/core/session.rb', line 54

def initialize(context = nil) #:nodoc:
  @http_method     = :get
  @data            = {}
  @default_headers = {}
  @custom_headers  = {}
  @context         = context

  reset
end

Instance Attribute Details

#current_url ⇒ Object (readonly)

Returns the value of attribute current_url.



51
52
53
 
# File 'lib/webrat/core/session.rb', line 51

def current_url
  @current_url
end

#elements ⇒ Object (readonly)

Returns the value of attribute elements.



52
53
54
 
# File 'lib/webrat/core/session.rb', line 52

def elements
  @elements
end

Instance Method Details

#automate ⇒ Object 



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

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

#basic_auth(user, pass) ⇒ Object 



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

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

#check_for_infinite_redirects ⇒ Object 



126
127
128
129
130
131
132
133
134
135
 
# File 'lib/webrat/core/session.rb', line 126

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"



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

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

#current_dom ⇒ Object

:nodoc:



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

def current_dom #:nodoc:
  current_scope.dom
end

#current_page ⇒ Object

For backwards compatibility – removing in 1.0



69
70
71
72
73
74
75
 
# File 'lib/webrat/core/session.rb', line 69

def current_page #:nodoc:
  page = OpenStruct.new
  page.url = @current_url
  page.http_method = @http_method
  page.data = @data
  page
end

#current_scope ⇒ Object

:nodoc:



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

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

#doc_root ⇒ Object

:nodoc:



77
78
79
 
# File 'lib/webrat/core/session.rb', line 77

def doc_root #:nodoc:
  nil
end

#dom ⇒ Object 



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

def dom
  page_scope.dom
end

#exception_caught? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


163
164
165
 
# File 'lib/webrat/core/session.rb', line 163

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

#formatted_error ⇒ Object

Subclasses can override this to show error messages without html



211
212
213
 
# File 'lib/webrat/core/session.rb', line 211

def formatted_error #:nodoc:
  response_body
end

#header(key, value) ⇒ Object 



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

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

#headers ⇒ Object

:nodoc:



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

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

#http_accept(mime_type) ⇒ Object 



85
86
87
 
# File 'lib/webrat/core/session.rb', line 85

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

#infinite_redirect_limit_exceeded? ⇒ Boolean

Returns:

  • (Boolean) 


137
138
139
140
 
# File 'lib/webrat/core/session.rb', line 137

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) 


150
151
152
153
154
155
156
 
# File 'lib/webrat/core/session.rb', line 150

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:



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

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

#redirect? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


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

def redirect? #:nodoc:
  response_code / 100 == 3
end

#redirected_to ⇒ Object

easy helper to pull out where we were redirected to



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

def redirected_to
  redirect? ? response_location : nil
end

#reload ⇒ Object

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



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

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

#request_page(url, http_method, data) ⇒ Object

:nodoc:

Raises:



98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/webrat/core/session.rb', line 98

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}"
  if h.empty?
    send "#{http_method}", url, data || {}
  else
    send "#{http_method}", url, data || {}, h
  end

  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:



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

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

#simulate ⇒ Object 



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

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

#success_code? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


142
143
144
 
# File 'lib/webrat/core/session.rb', line 142

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



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

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

#within(selector) ⇒ Object 



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

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) 


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

def xml_content_type?
  false
end