Class: ActionController::Integration::Session

Inherits:
Object
  • Object
show all
Includes:
TestCase::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. Because 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

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 TestCase::Assertions

#clean_backtrace

Constructor Details

#initialize(app = nil) ⇒ Session

Create and initialize a new Session instance.



68
69
70
71
 
# File 'lib/action_controller/integration.rb', line 68

def initialize(app = nil)
  @application = app || ActionController::Dispatcher.new
  reset!
end

Dynamic Method Handling

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

Instance Attribute Details

#accept ⇒ Object

The Accept header to send.



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

def accept
  @accept
end

#application ⇒ Object

Rack application to use



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

def application
  @application
end

#body ⇒ Object (readonly)

The body of the last request.



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

def body
  @body
end

#controller ⇒ Object (readonly)

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



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

def controller
  @controller
end

#cookies ⇒ Object (readonly)

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



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

def cookies
  @cookies
end

#headers ⇒ Object (readonly)

A map of the headers returned by the last response.



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

def headers
  @headers
end

#host ⇒ Object

The hostname used in the last request.



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

def host
  @host
end

#path ⇒ Object (readonly)

The URI of the last request.



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

def path
  @path
end

#remote_addr ⇒ Object

The remote_addr used in the last request.



40
41
42
 
# File 'lib/action_controller/integration.rb', line 40

def remote_addr
  @remote_addr
end

#request ⇒ Object (readonly)

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



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

def request
  @request
end

#request_count ⇒ Object

A running counter of the number of requests processed.



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

def request_count
  @request_count
end

#response ⇒ Object (readonly)

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



59
60
61
 
# File 'lib/action_controller/integration.rb', line 59

def response
  @response
end

#status ⇒ Object (readonly)

The integer HTTP status code of the last request.



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

def status
  @status
end

#status_message ⇒ Object (readonly)

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



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

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.



214
215
216
 
# File 'lib/action_controller/integration.rb', line 214

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.



167
168
169
 
# File 'lib/action_controller/integration.rb', line 167

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.



131
132
133
134
135
 
# File 'lib/action_controller/integration.rb', line 131

def follow_redirect!
  raise "not a redirect! #{@status} #{@status_message}" unless redirect?
  get(interpret_uri(headers['location']))
  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 Response 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.



196
197
198
 
# File 'lib/action_controller/integration.rb', line 196

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.



149
150
151
 
# File 'lib/action_controller/integration.rb', line 149

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.



220
221
222
 
# File 'lib/action_controller/integration.rb', line 220

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"



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

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)



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

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) 


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

def https?
  @https
end

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

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



202
203
204
 
# File 'lib/action_controller/integration.rb', line 202

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.



155
156
157
 
# File 'lib/action_controller/integration.rb', line 155

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.



208
209
210
 
# File 'lib/action_controller/integration.rb', line 208

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.



161
162
163
 
# File 'lib/action_controller/integration.rb', line 161

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) 


172
173
174
 
# File 'lib/action_controller/integration.rb', line 172

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.



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

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!



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/action_controller/integration.rb', line 78

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.



241
242
243
244
245
 
# File 'lib/action_controller/integration.rb', line 241

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.



231
232
233
234
235
236
 
# File 'lib/action_controller/integration.rb', line 231

def xml_http_request(request_method, path, parameters = nil, headers = nil)
  headers ||= {}
  headers['X-Requested-With'] = 'XMLHttpRequest'
  headers['Accept'] ||= [Mime::JS, Mime::HTML, Mime::XML, 'text/xml', Mime::ALL].join(', ')
  process(request_method, path, parameters, headers)
end