Class ActionController::Integration::Session
In: vendor/rails/actionpack/lib/action_controller/integration.rb
Parent: Object

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.

Methods

Included Modules

Test::Unit::Assertions ActionController::Assertions ActionController::TestProcess ControllerCapture

Classes and Modules

Class ActionController::Integration::Session::MultiPartNeededException

Attributes

accept  [RW]  The Accept header to send.
controller  [R]  A reference to the controller instance used by the last request.
cookies  [R]  A map of the cookies returned by the last response, and which will be sent with the next request.
headers  [R]  A map of the headers returned by the last response.
host  [RW]  The hostname used in the last request.
path  [R]  The URI of the last request.
remote_addr  [RW]  The remote_addr used in the last request.
request  [R]  A reference to the request instance used by the last request.
request_count  [RW]  A running counter of the number of requests processed.
response  [R]  A reference to the response instance used by the last request.
status  [R]  The integer HTTP status code of the last request.
status_message  [R]  The status message that accompanied the status code of the last request.

Public Class methods

Create and initialize a new Session instance.

[Source]

    # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 62
62:       def initialize
63:         reset!
64:       end

Public Instance methods

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

[Source]

     # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 190
190:       def delete(path, parameters = nil, headers = nil)
191:         process :delete, path, parameters, headers
192:       end

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

[Source]

     # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 158
158:       def delete_via_redirect(path, parameters = nil, headers = nil)
159:         request_via_redirect(:delete, path, parameters, headers)
160:       end

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.

[Source]

     # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 122
122:       def follow_redirect!
123:         raise "not a redirect! #{@status} #{@status_message}" unless redirect?
124:         get(interpret_uri(headers['location'].first))
125:         status
126:       end

Performs a GET request with the given parameters. The parameters may be nil, a Hash, or a string that is appropriately encoded (application/x-www-form-urlencoded or multipart/form-data). The headers should be a hash. The keys will automatically be upcased, with the prefix ‘HTTP_’ added if needed.

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

[Source]

     # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 175
175:       def get(path, parameters = nil, headers = nil)
176:         process :get, path, parameters, headers
177:       end

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

[Source]

     # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 140
140:       def get_via_redirect(path, parameters = nil, headers = nil)
141:         request_via_redirect(:get, path, parameters, headers)
142:       end

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

[Source]

     # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 195
195:       def head(path, parameters = nil, headers = nil)
196:         process :head, path, parameters, headers
197:       end

Set the host name to use in the next request.

  session.host! "www.example.com"

[Source]

     # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 115
115:       def host!(name)
116:         @host = name
117:       end

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

  session.https!
  session.https!(false)

[Source]

     # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 99
 99:       def https!(flag=true)
100:         @https = flag
101:       end

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

  if session.https?
    ...
  end

[Source]

     # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 108
108:       def https?
109:         @https
110:       end

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

[Source]

     # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 180
180:       def post(path, parameters = nil, headers = nil)
181:         process :post, path, parameters, headers
182:       end

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

[Source]

     # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 146
146:       def post_via_redirect(path, parameters = nil, headers = nil)
147:         request_via_redirect(:post, path, parameters, headers)
148:       end

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

[Source]

     # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 185
185:       def put(path, parameters = nil, headers = nil)
186:         process :put, path, parameters, headers
187:       end

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

[Source]

     # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 152
152:       def put_via_redirect(path, parameters = nil, headers = nil)
153:         request_via_redirect(:put, path, parameters, headers)
154:       end

Returns true if the last response was a redirect.

[Source]

     # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 163
163:       def redirect?
164:         status/100 == 3
165:       end

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.

[Source]

     # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 132
132:       def request_via_redirect(http_method, path, parameters = nil, headers = nil)
133:         send(http_method, path, parameters, headers)
134:         follow_redirect! while redirect?
135:         status
136:       end

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!

[Source]

    # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 71
71:       def reset!
72:         @status = @path = @headers = nil
73:         @result = @status_message = nil
74:         @https = false
75:         @cookies = {}
76:         @controller = @request = @response = nil
77:         @request_count = 0
78: 
79:         self.host        = "www.example.com"
80:         self.remote_addr = "127.0.0.1"
81:         self.accept      = "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5"
82: 
83:         unless defined? @named_routes_configured
84:           # install the named routes in this session instance.
85:           klass = class<<self; self; end
86:           Routing::Routes.install_helpers(klass)
87: 
88:           # the helpers are made protected by default--we make them public for
89:           # easier access during testing and troubleshooting.
90:           klass.module_eval { public *Routing::Routes.named_routes.helpers }
91:           @named_routes_configured = true
92:         end
93:       end

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

[Source]

     # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 217
217:       def url_for(options)
218:         controller ? controller.url_for(options) : generic_url_rewriter.rewrite(options)
219:       end
xhr(request_method, path, parameters = nil, headers = nil)

Alias for xml_http_request

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.

[Source]

     # File vendor/rails/actionpack/lib/action_controller/integration.rb, line 206
206:       def xml_http_request(request_method, path, parameters = nil, headers = nil)
207:         headers ||= {}
208:         headers['X-Requested-With'] = 'XMLHttpRequest'
209:         headers['Accept'] ||= 'text/javascript, text/html, application/xml, text/xml, */*'
210: 
211:         process(request_method, path, parameters, headers)
212:       end

[Validate]