Module: ActionDispatch::Integration::RequestHelpers

Included in:
Session
Defined in:
actionpack/lib/action_dispatch/testing/integration.rb

Instance Method Summary (collapse)

Instance Method Details

- (Object) delete(path, parameters = nil, headers_or_env = nil)

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



55
56
57
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 55

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

- (Object) delete_via_redirect(path, parameters = nil, headers_or_env = nil)

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



124
125
126
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 124

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

- (Object) follow_redirect!

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.



82
83
84
85
86
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 82

def follow_redirect!
  raise "not a redirect! #{status} #{status_message}" unless redirect?
  get(response.location)
  status
end

- (Object) get(path, parameters = nil, headers_or_env = nil)

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_or_env: Additional headers to pass, as a Hash. The headers will be merged into the Rack env hash.

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

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



31
32
33
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 31

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

- (Object) get_via_redirect(path, parameters = nil, headers_or_env = nil)

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



100
101
102
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 100

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

- (Object) head(path, parameters = nil, headers_or_env = nil)

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



61
62
63
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 61

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

- (Object) patch(path, parameters = nil, headers_or_env = nil)

Performs a PATCH request with the given parameters. See #get for more details.



43
44
45
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 43

def patch(path, parameters = nil, headers_or_env = nil)
  process :patch, path, parameters, headers_or_env
end

- (Object) patch_via_redirect(path, parameters = nil, headers_or_env = nil)

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



112
113
114
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 112

def patch_via_redirect(path, parameters = nil, headers_or_env = nil)
  request_via_redirect(:patch, path, parameters, headers_or_env)
end

- (Object) post(path, parameters = nil, headers_or_env = nil)

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



37
38
39
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 37

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

- (Object) post_via_redirect(path, parameters = nil, headers_or_env = nil)

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



106
107
108
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 106

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

- (Object) put(path, parameters = nil, headers_or_env = nil)

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



49
50
51
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 49

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

- (Object) put_via_redirect(path, parameters = nil, headers_or_env = nil)

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



118
119
120
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 118

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

- (Object) request_via_redirect(http_method, path, parameters = nil, headers_or_env = nil)

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.



92
93
94
95
96
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 92

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

- (Object) xml_http_request(request_method, path, parameters = nil, headers_or_env = nil) 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, :patch, :put, :delete or :head; the parameters are nil, a hash, or a url-encoded or multipart string; the headers are a hash.



71
72
73
74
75
76
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 71

def xml_http_request(request_method, path, parameters = nil, headers_or_env = nil)
  headers_or_env ||= {}
  headers_or_env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest'
  headers_or_env['HTTP_ACCEPT'] ||= [Mime::JS, Mime::HTML, Mime::XML, 'text/xml', Mime::ALL].join(', ')
  process(request_method, path, parameters, headers_or_env)
end