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.
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. |
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. |
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.
# File vendor/rails/actionpack/lib/action_controller/integration.rb, line 112 112: def follow_redirect! 113: raise "not a redirect! #{@status} #{@status_message}" unless redirect? 114: get(interpret_uri(headers["location"].first)) 115: status 116: 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.
# File vendor/rails/actionpack/lib/action_controller/integration.rb, line 146 146: def get(path, parameters=nil, headers=nil) 147: process :get, path, parameters, headers 148: end
Performs a GET request, 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.
# File vendor/rails/actionpack/lib/action_controller/integration.rb, line 122 122: def get_via_redirect(path, args={}) 123: get path, args 124: follow_redirect! while redirect? 125: status 126: end
Set the host name to use in the next request.
session.host! "www.example.com"
# File vendor/rails/actionpack/lib/action_controller/integration.rb, line 105 105: def host!(name) 106: @host = name 107: end
Specify whether or not the session should mimic a secure HTTPS request.
session.https! session.https!(false)
# File vendor/rails/actionpack/lib/action_controller/integration.rb, line 89 89: def https!(flag=true) 90: @https = flag 91: end
Return true if the session is mimicing a secure HTTPS request.
if session.https? ... end
# File vendor/rails/actionpack/lib/action_controller/integration.rb, line 98 98: def https? 99: @https 100: end
Performs a POST 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.
# File vendor/rails/actionpack/lib/action_controller/integration.rb, line 155 155: def post(path, parameters=nil, headers=nil) 156: process :post, path, parameters, headers 157: end
Performs a POST request, following any subsequent redirect. This is vulnerable to infinite loops, the same as get_via_redirect.
# File vendor/rails/actionpack/lib/action_controller/integration.rb, line 130 130: def post_via_redirect(path, args={}) 131: post path, args 132: follow_redirect! while redirect? 133: status 134: end
Returns true if the last response was a redirect.
# File vendor/rails/actionpack/lib/action_controller/integration.rb, line 137 137: def redirect? 138: status/100 == 3 139: 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!
# File vendor/rails/actionpack/lib/action_controller/integration.rb, line 62 62: def reset! 63: @status = @path = @headers = nil 64: @result = @status_message = nil 65: @https = false 66: @cookies = {} 67: @controller = @request = @response = nil 68: 69: self.host = "www.example.com" 70: self.remote_addr = "127.0.0.1" 71: self.accept = "text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5" 72: 73: unless @named_routes_configured 74: # install the named routes in this session instance. 75: klass = class<<self; self; end 76: Routing::NamedRoutes.install(klass) 77: 78: # the helpers are made protected by default--we make them public for 79: # easier access during testing and troubleshooting. 80: klass.send(:public, *Routing::NamedRoutes::Helpers) 81: @named_routes_configured = true 82: end 83: end
Returns the URL for the given options, according to the rules specified in the application’s routes.
# File vendor/rails/actionpack/lib/action_controller/integration.rb, line 172 172: def url_for(options) 173: controller ? controller.url_for(options) : generic_url_rewriter.rewrite(options) 174: end
Performs an XMLHttpRequest request with the given parameters, mimicing the request environment created by the Prototype library. 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.
# File vendor/rails/actionpack/lib/action_controller/integration.rb, line 165 165: def xml_http_request(path, parameters=nil, headers=nil) 166: headers = (headers || {}).merge("X-Requested-With" => "XMLHttpRequest") 167: post(path, parameters, headers) 168: end