module ActionDispatch::Integration::RequestHelpers - actionpack-4.2.4 Documentation

# module ActionDispatch::Integration::RequestHelpers

### Public Instance Methods

delete(path, parameters = nil, headers_or_env = nil) click to toggle source

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

    # File 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

delete_via_redirect(path, parameters = nil, headers_or_env = nil) click to toggle source

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

    # File 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

follow_redirect!() click to toggle source

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 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

get(path, parameters = nil, headers_or_env = nil) click to toggle source

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`.

    # File 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

get_via_redirect(path, parameters = nil, headers_or_env = nil) click to toggle source

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

    # File 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

head(path, parameters = nil, headers_or_env = nil) click to toggle source

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

    # File 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

patch(path, parameters = nil, headers_or_env = nil) click to toggle source

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

    # File 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

patch_via_redirect(path, parameters = nil, headers_or_env = nil) click to toggle source

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

    # File 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

post(path, parameters = nil, headers_or_env = nil) click to toggle source

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

    # File 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

post_via_redirect(path, parameters = nil, headers_or_env = nil) click to toggle source

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

    # File 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

put(path, parameters = nil, headers_or_env = nil) click to toggle source

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

    # File 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

put_via_redirect(path, parameters = nil, headers_or_env = nil) click to toggle source

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

    # File 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

request_via_redirect(http_method, path, parameters = nil, headers_or_env = nil) click to toggle source

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.

    # File 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

xhr(request_method, path, parameters = nil, headers_or_env = nil)
Alias for: xml_http_request
xml_http_request(request_method, path, parameters = nil, headers_or_env = nil) click to toggle source

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.

    # File 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

Also aliased as: xhr