Class: ActionController::Integration::Session

Inherits:
Object
  • Object
show all
Includes:
Assertions, TestProcess, Test::Unit::Assertions
Defined in:
lib/action_controller/integration.rb

Overview

An integration Session instance represents a set of requests and responses performed sequentially by some virtual user. Becase you can instantiate multiple sessions and run them side-by-side, you can also mimic (to some limited extent) multiple simultaneous users interacting with your system.

Typically, you will instantiate a new session using IntegrationTest#open_session, rather than instantiating Integration::Session directly.

Defined Under Namespace

Classes: MultiPartNeededException

Constant Summary

Constants included from Assertions

Assertions::NO_STRIP

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from TestProcess

#assigns, #build_request_uri, #find_all_tag, #find_tag, #fixture_file_upload, #flash, #html_document, included, #method_missing, #redirect_to_url, #session, #with_routing

Methods included from Assertions

#clean_backtrace, included

Constructor Details

#initializeSession

Create and initialize a new Session instance.


63
64
65
# File 'lib/action_controller/integration.rb', line 63

def initialize
  reset!
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ActionController::TestProcess

Instance Attribute Details

#acceptObject

The Accept header to send.


38
39
40
# File 'lib/action_controller/integration.rb', line 38

def accept
  @accept
end

#controllerObject (readonly)

A reference to the controller instance used by the last request.


48
49
50
# File 'lib/action_controller/integration.rb', line 48

def controller
  @controller
end

#cookiesObject (readonly)

A map of the cookies returned by the last response, and which will be sent with the next request.


42
43
44
# File 'lib/action_controller/integration.rb', line 42

def cookies
  @cookies
end

#headersObject (readonly)

A map of the headers returned by the last response.


45
46
47
# File 'lib/action_controller/integration.rb', line 45

def headers
  @headers
end

#hostObject

The hostname used in the last request.


32
33
34
# File 'lib/action_controller/integration.rb', line 32

def host
  @host
end

#pathObject (readonly)

The URI of the last request.


29
30
31
# File 'lib/action_controller/integration.rb', line 29

def path
  @path
end

#remote_addrObject

The remote_addr used in the last request.


35
36
37
# File 'lib/action_controller/integration.rb', line 35

def remote_addr
  @remote_addr
end

#requestObject (readonly)

A reference to the request instance used by the last request.


51
52
53
# File 'lib/action_controller/integration.rb', line 51

def request
  @request
end

#request_countObject

A running counter of the number of requests processed.


57
58
59
# File 'lib/action_controller/integration.rb', line 57

def request_count
  @request_count
end

#responseObject (readonly)

A reference to the response instance used by the last request.


54
55
56
# File 'lib/action_controller/integration.rb', line 54

def response
  @response
end

#statusObject (readonly)

The integer HTTP status code of the last request.


23
24
25
# File 'lib/action_controller/integration.rb', line 23

def status
  @status
end

#status_messageObject (readonly)

The status message that accompanied the status code of the last request.


26
27
28
# File 'lib/action_controller/integration.rb', line 26

def status_message
  @status_message
end

Instance Method Details

#delete(path, parameters = nil, headers = nil) ⇒ Object

Performs a DELETE request with the given parameters. See get() for more details.


199
200
201
# File 'lib/action_controller/integration.rb', line 199

def delete(path, parameters = nil, headers = nil)
  process :delete, path, parameters, headers
end

#delete_via_redirect(path, parameters = nil, headers = nil) ⇒ Object

Performs a DELETE request, following any subsequent redirect. See request_via_redirect for more information.


159
160
161
# File 'lib/action_controller/integration.rb', line 159

def delete_via_redirect(path, parameters = nil, headers = nil)
  request_via_redirect(:delete, path, parameters, headers)
end

#follow_redirect!Object

Follow a single redirect response. If the last response was not a redirect, an exception will be raised. Otherwise, the redirect is performed on the location header.


123
124
125
126
127
# File 'lib/action_controller/integration.rb', line 123

def follow_redirect!
  raise "not a redirect! #{@status} #{@status_message}" unless redirect?
  get(interpret_uri(headers['location'].first))
  status
end

#get(path, parameters = nil, headers = nil) ⇒ Object

Performs a GET request with the given parameters.

  • path: The URI (as a String) on which you want to perform a GET request.

  • parameters: The HTTP parameters that you want to pass. This may be nil, a Hash, or a String that is appropriately encoded (application/x-www-form-urlencoded or multipart/form-data).

  • headers: Additional HTTP headers to pass, as a Hash. The keys will automatically be upcased, with the prefix 'HTTP_' added if needed.

This method returns an AbstractResponse object, which one can use to inspect the details of the response. Furthermore, if this method was called from an ActionController::IntegrationTest object, then that object's @response instance variable will point to the same response object.

You can also perform POST, PUT, DELETE, and HEAD requests with post, put, delete, and head.


184
185
186
# File 'lib/action_controller/integration.rb', line 184

def get(path, parameters = nil, headers = nil)
  process :get, path, parameters, headers
end

#get_via_redirect(path, parameters = nil, headers = nil) ⇒ Object

Performs a GET request, following any subsequent redirect. See request_via_redirect for more information.


141
142
143
# File 'lib/action_controller/integration.rb', line 141

def get_via_redirect(path, parameters = nil, headers = nil)
  request_via_redirect(:get, path, parameters, headers)
end

#head(path, parameters = nil, headers = nil) ⇒ Object

Performs a HEAD request with the given parameters. See get() for more details.


204
205
206
# File 'lib/action_controller/integration.rb', line 204

def head(path, parameters = nil, headers = nil)
  process :head, path, parameters, headers
end

#host!(name) ⇒ Object

Set the host name to use in the next request.

session.host! "www.example.com"

116
117
118
# File 'lib/action_controller/integration.rb', line 116

def host!(name)
  @host = name
end

#https!(flag = true) ⇒ Object

Specify whether or not the session should mimic a secure HTTPS request.

session.https!
session.https!(false)

100
101
102
# File 'lib/action_controller/integration.rb', line 100

def https!(flag=true)
  @https = flag
end

#https?Boolean

Return true if the session is mimicking a secure HTTPS request.

if session.https?
  ...
end

Returns:

  • (Boolean)

109
110
111
# File 'lib/action_controller/integration.rb', line 109

def https?
  @https
end

#post(path, parameters = nil, headers = nil) ⇒ Object

Performs a POST request with the given parameters. See get() for more details.


189
190
191
# File 'lib/action_controller/integration.rb', line 189

def post(path, parameters = nil, headers = nil)
  process :post, path, parameters, headers
end

#post_via_redirect(path, parameters = nil, headers = nil) ⇒ Object

Performs a POST request, following any subsequent redirect. See request_via_redirect for more information.


147
148
149
# File 'lib/action_controller/integration.rb', line 147

def post_via_redirect(path, parameters = nil, headers = nil)
  request_via_redirect(:post, path, parameters, headers)
end

#put(path, parameters = nil, headers = nil) ⇒ Object

Performs a PUT request with the given parameters. See get() for more details.


194
195
196
# File 'lib/action_controller/integration.rb', line 194

def put(path, parameters = nil, headers = nil)
  process :put, path, parameters, headers
end

#put_via_redirect(path, parameters = nil, headers = nil) ⇒ Object

Performs a PUT request, following any subsequent redirect. See request_via_redirect for more information.


153
154
155
# File 'lib/action_controller/integration.rb', line 153

def put_via_redirect(path, parameters = nil, headers = nil)
  request_via_redirect(:put, path, parameters, headers)
end

#redirect?Boolean

Returns true if the last response was a redirect.

Returns:

  • (Boolean)

164
165
166
# File 'lib/action_controller/integration.rb', line 164

def redirect?
  status/100 == 3
end

#request_via_redirect(http_method, path, parameters = nil, headers = nil) ⇒ Object

Performs a request using the specified method, following any subsequent redirect. Note that the redirects are followed until the response is not a redirect–this means you may run into an infinite loop if your redirect loops back to itself.


133
134
135
136
137
# File 'lib/action_controller/integration.rb', line 133

def request_via_redirect(http_method, path, parameters = nil, headers = nil)
  send(http_method, path, parameters, headers)
  follow_redirect! while redirect?
  status
end

#reset!Object

Resets the instance. This can be used to reset the state information in an existing session instance, so it can be used from a clean-slate condition.

session.reset!

72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/action_controller/integration.rb', line 72

def reset!
  @status = @path = @headers = nil
  @result = @status_message = nil
  @https = false
  @cookies = {}
  @controller = @request = @response = nil
  @request_count = 0

  self.host        = "www.example.com"
  self.remote_addr = "127.0.0.1"
  self.accept      = "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"

  unless defined? @named_routes_configured
    # install the named routes in this session instance.
    klass = class<<self; self; end
    Routing::Routes.install_helpers(klass)

    # the helpers are made protected by default--we make them public for
    # easier access during testing and troubleshooting.
    klass.module_eval { public *Routing::Routes.named_routes.helpers }
    @named_routes_configured = true
  end
end

#url_for(options) ⇒ Object

Returns the URL for the given options, according to the rules specified in the application's routes.


226
227
228
# File 'lib/action_controller/integration.rb', line 226

def url_for(options)
  controller ? controller.url_for(options) : generic_url_rewriter.rewrite(options)
end

#xml_http_request(request_method, path, parameters = nil, headers = nil) ⇒ Object Also known as: xhr

Performs an XMLHttpRequest request with the given parameters, mirroring a request from the Prototype library.

The request_method is :get, :post, :put, :delete or :head; the parameters are nil, a hash, or a url-encoded or multipart string; the headers are a hash. Keys are automatically upcased and prefixed with 'HTTP_' if not already.


215
216
217
218
219
220
221
# File 'lib/action_controller/integration.rb', line 215

def xml_http_request(request_method, path, parameters = nil, headers = nil)
  headers ||= {}
  headers['X-Requested-With'] = 'XMLHttpRequest'
  headers['Accept'] ||= 'text/javascript, text/html, application/xml, text/xml, */*'

  process(request_method, path, parameters, headers)
end