class ActionDispatch::Request - actionpack-4.2.3 Documentation

# class ActionDispatch::Request

### Constants

ENV_METHODS
HTTP_METHODS
HTTP_METHOD_LOOKUP
LOCALHOST
RFC2518
RFC2616

  List of HTTP request methods from the following RFCs: Hypertext Transfer Protocol – HTTP/1.1 (www.ietf.org/rfc/rfc2616.txt) HTTP Extensions for Distributed Authoring – WEBDAV (www.ietf.org/rfc/rfc2518.txt) Versioning Extensions to WebDAV (www.ietf.org/rfc/rfc3253.txt) Ordered Collections Protocol (WebDAV) (www.ietf.org/rfc/rfc3648.txt) Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol (www.ietf.org/rfc/rfc3744.txt) Web Distributed Authoring and Versioning (WebDAV) SEARCH (www.ietf.org/rfc/rfc5323.txt) Calendar Extensions to WebDAV (www.ietf.org/rfc/rfc4791.txt) PATCH Method for HTTP (www.ietf.org/rfc/rfc5789.txt)

RFC3253
RFC3648
RFC3744
RFC4791
RFC5323
RFC5789

### Public Class Methods

new(env) click to toggle source
Calls superclass method ActionDispatch::Http::URL.new

    # File lib/action_dispatch/http/request.rb, line 45
    def initialize(env)
      super
      @method            = nil
      @request_method    = nil
      @remote_ip         = nil
      @original_fullpath = nil
      @fullpath          = nil
      @ip                = nil
      @uuid              = nil
    end

### Public Instance Methods

GET() click to toggle source

Override Rack's #GET method to support indifferent access

Calls superclass method

    # File lib/action_dispatch/http/request.rb, line 299
    def GET
      @env["action_dispatch.request.query_parameters"] ||= Utils.deep_munge(normalize_encode_params(super || {}))
    rescue Rack::Utils::ParameterTypeError, Rack::Utils::InvalidParameterError => e
      raise ActionController::BadRequest.new(:query, e)
    end

Also aliased as: query_parameters
POST() click to toggle source

Override Rack's #POST method to support indifferent access

Calls superclass method

    # File lib/action_dispatch/http/request.rb, line 307
    def POST
      @env["action_dispatch.request.request_parameters"] ||= Utils.deep_munge(normalize_encode_params(super || {}))
    rescue Rack::Utils::ParameterTypeError, Rack::Utils::InvalidParameterError => e
      raise ActionController::BadRequest.new(:request, e)
    end

Also aliased as: request_parameters
authorization() click to toggle source

Returns the authorization header regardless of whether it was specified directly or through one of the proxy alternatives.

    # File lib/action_dispatch/http/request.rb, line 316
    def authorization
      @env['HTTP_AUTHORIZATION']   ||
      @env['X-HTTP_AUTHORIZATION'] ||
      @env['X_HTTP_AUTHORIZATION'] ||
      @env['REDIRECT_X_HTTP_AUTHORIZATION']
    end

body() click to toggle source

The request body is an IO input stream. If the RAW_POST_DATA environment variable is already set, wrap it in a StringIO.

    # File lib/action_dispatch/http/request.rb, line 262
    def body
      if raw_post = @env['RAW_POST_DATA']
        raw_post.force_encoding(Encoding::BINARY)
        StringIO.new(raw_post)
      else
        @env['rack.input']
      end
    end

check_path_parameters!() click to toggle source

    # File lib/action_dispatch/http/request.rb, line 56
    def check_path_parameters!
      # If any of the path parameters has an invalid encoding then
      # raise since it's likely to trigger errors further on.
      path_parameters.each do |key, value|
        next unless value.respond_to?(:valid_encoding?)
        unless value.valid_encoding?
          raise ActionController::BadRequest, "Invalid parameter: #{key} => #{value}"
        end
      end
    end

content_length() click to toggle source

Returns the content length of the request as an integer.

Calls superclass method

    # File lib/action_dispatch/http/request.rb, line 213
    def content_length
      super.to_i
    end

cookie_jar() click to toggle source

    # File lib/action_dispatch/middleware/cookies.rb, line 10
    def cookie_jar
      env['action_dispatch.cookies'] ||= Cookies::CookieJar.build(self)
    end

deep_munge(hash) click to toggle source

Extracted into ActionDispatch::Request::Utils.deep_munge, but kept here for backwards compatibility.

    # File lib/action_dispatch/http/request.rb, line 329
    def deep_munge(hash)
      ActiveSupport::Deprecation.warn(
        'This method has been extracted into `ActionDispatch::Request::Utils.deep_munge`. Please start using that instead.'
      )

      Utils.deep_munge(hash)
    end

delete?() click to toggle source

Is this a DELETE request? Equivalent to `request.request_method_symbol == :delete`.

    # File lib/action_dispatch/http/request.rb, line 157
    def delete?
      HTTP_METHOD_LOOKUP[request_method] == :delete
    end

flash() click to toggle source

Access the contents of the flash. Use `flash["notice"]` to read a notice you put there or `flash["notice"] = "hello"` to put a new one.

    # File lib/action_dispatch/middleware/flash.rb, line 8
    def flash
      @env[Flash::KEY] ||= Flash::FlashHash.from_session_value(session["flash"])
    end

form_data?() click to toggle source

    # File lib/action_dispatch/http/request.rb, line 271
    def form_data?
      FORM_DATA_MEDIA_TYPES.include?(content_mime_type.to_s)
    end

fullpath() click to toggle source

Returns the `String` full path including params of the last URL requested.

    # get "/articles"
    request.fullpath # => "/articles"

    # get "/articles?page=2"
    request.fullpath # => "/articles?page=2"

Calls superclass method

    # File lib/action_dispatch/http/request.rb, line 192
    def fullpath
      @fullpath ||= super
    end

get?() click to toggle source

Is this a #GET (or HEAD) request? Equivalent to `request.request_method_symbol == :get`.

    # File lib/action_dispatch/http/request.rb, line 133
    def get?
      HTTP_METHOD_LOOKUP[request_method] == :get
    end

head?() click to toggle source

Is this a HEAD request? Equivalent to `request.request_method_symbol == :head`.

    # File lib/action_dispatch/http/request.rb, line 163
    def head?
      HTTP_METHOD_LOOKUP[request_method] == :head
    end

headers() click to toggle source

Provides access to the request's HTTP headers, for example:

    request.headers["Content-Type"] # => "text/plain"

    # File lib/action_dispatch/http/request.rb, line 170
    def headers
      Http::Headers.new(@env)
    end

ip() click to toggle source
Calls superclass method

    # File lib/action_dispatch/http/request.rb, line 225
    def ip
      @ip ||= super
    end

key?(key) click to toggle source

    # File lib/action_dispatch/http/request.rb, line 67
    def key?(key)
      @env.key?(key)
    end

local?() click to toggle source

True if the request came from localhost, 127.0.0.1.

    # File lib/action_dispatch/http/request.rb, line 324
    def local?
      LOCALHOST =~ remote_addr && LOCALHOST =~ remote_ip
    end

media_type() click to toggle source

The `String` MIME type of the request.

    # get "/articles"
    request.media_type # => "application/x-www-form-urlencoded"

    # File lib/action_dispatch/http/request.rb, line 208
    def media_type
      content_mime_type.to_s
    end

method() click to toggle source

Returns the original value of the environment's REQUEST_METHOD, even if it was overridden by middleware. See request_method for more information.

    # File lib/action_dispatch/http/request.rb, line 122
    def method
      @method ||= check_method(env["rack.methodoverride.original_method"] || env['REQUEST_METHOD'])
    end

method_symbol() click to toggle source

Returns a symbol form of the method

    # File lib/action_dispatch/http/request.rb, line 127
    def method_symbol
      HTTP_METHOD_LOOKUP[method]
    end

original_fullpath() click to toggle source

Returns a `String` with the last requested path including their params.

    # get '/foo'
    request.original_fullpath # => '/foo'

    # get '/foo?bar'
    request.original_fullpath # => '/foo?bar'

    # File lib/action_dispatch/http/request.rb, line 181
    def original_fullpath
      @original_fullpath ||= (env["ORIGINAL_FULLPATH"] || fullpath)
    end

original_url() click to toggle source

Returns the original request URL as a `String`.

    # get "/articles?page=2"
    request.original_url # => "http://www.example.com/articles?page=2"

    # File lib/action_dispatch/http/request.rb, line 200
    def original_url
      base_url + original_fullpath
    end

patch?() click to toggle source

Is this a PATCH request? Equivalent to `request.request_method == :patch`.

    # File lib/action_dispatch/http/request.rb, line 145
    def patch?
      HTTP_METHOD_LOOKUP[request_method] == :patch
    end

post?() click to toggle source

Is this a #POST request? Equivalent to `request.request_method_symbol == :post`.

    # File lib/action_dispatch/http/request.rb, line 139
    def post?
      HTTP_METHOD_LOOKUP[request_method] == :post
    end

put?() click to toggle source

Is this a PUT request? Equivalent to `request.request_method_symbol == :put`.

    # File lib/action_dispatch/http/request.rb, line 151
    def put?
      HTTP_METHOD_LOOKUP[request_method] == :put
    end

query_parameters()
Alias for: GET
raw_post() click to toggle source

Read the request body. This is useful for web services that need to work with raw requests directly.

    # File lib/action_dispatch/http/request.rb, line 251
    def raw_post
      unless @env.include? 'RAW_POST_DATA'
        raw_post_body = body
        @env['RAW_POST_DATA'] = raw_post_body.read(content_length)
        raw_post_body.rewind if raw_post_body.respond_to?(:rewind)
      end
      @env['RAW_POST_DATA']
    end

remote_ip() click to toggle source

Originating IP address, usually set by the RemoteIp middleware.

    # File lib/action_dispatch/http/request.rb, line 230
    def remote_ip
      @remote_ip ||= (@env["action_dispatch.remote_ip"] || ip).to_s
    end

request_method() click to toggle source

Returns the HTTP method that the application should see. In the case where the method was overridden by a middleware (for instance, if a HEAD request was converted to a #GET, or if a _method parameter was used to determine the method the application should use), this method returns the overridden value, not the original.

    # File lib/action_dispatch/http/request.rb, line 104
    def request_method
      @request_method ||= check_method(env["REQUEST_METHOD"])
    end

request_method_symbol() click to toggle source

Returns a symbol form of the request_method

    # File lib/action_dispatch/http/request.rb, line 115
    def request_method_symbol
      HTTP_METHOD_LOOKUP[request_method]
    end

request_parameters()
Alias for: POST
reset_session() click to toggle source

TODO This should be broken apart into AD::Request::Session and probably be included by the session middleware.

    # File lib/action_dispatch/http/request.rb, line 281
    def reset_session
      if session && session.respond_to?(:destroy)
        session.destroy
      else
        self.session = {}
      end
      @env['action_dispatch.request.flash_hash'] = nil
    end

server_software() click to toggle source

Returns the lowercase name of the HTTP server software.

    # File lib/action_dispatch/http/request.rb, line 245
    def server_software
      (@env['SERVER_SOFTWARE'] && /^([a-zA-Z]+)/ =~ @env['SERVER_SOFTWARE']) ? $1.downcase : nil
    end

session_options=(options) click to toggle source

    # File lib/action_dispatch/http/request.rb, line 294
    def session_options=(options)
      Session::Options.set @env, options
    end

uuid() click to toggle source

Returns the unique request id, which is based on either the X-Request-Id header that can be generated by a firewall, load balancer, or web server or by the RequestId middleware (which sets the action_dispatch.request_id environment variable).

This unique ID is useful for tracing a request from end-to-end as part of logging or debugging. This relies on the rack variable set by the ActionDispatch::RequestId middleware.

    # File lib/action_dispatch/http/request.rb, line 240
    def uuid
      @uuid ||= env["action_dispatch.request_id"]
    end

xhr?()
Alias for: xml_http_request?
xml_http_request?() click to toggle source

Returns true if the “X-Requested-With” header contains “XMLHttpRequest” (case-insensitive), which may need to be manually added depending on the choice of JavaScript libraries and frameworks.

    # File lib/action_dispatch/http/request.rb, line 220
    def xml_http_request?
      @env['HTTP_X_REQUESTED_WITH'] =~ /XMLHttpRequest/i
    end

Also aliased as: xhr?

### Protected Instance Methods

parse_query(qs) click to toggle source
Calls superclass method

    # File lib/action_dispatch/http/request.rb, line 338
    def parse_query(qs)
      Utils.deep_munge(super)
    end

### Private Instance Methods

check_method(name) click to toggle source

    # File lib/action_dispatch/http/request.rb, line 343
    def check_method(name)
      HTTP_METHOD_LOOKUP[name] || raise(ActionController::UnknownHttpMethod, "#{name}, accepted HTTP methods are #{HTTP_METHODS[0...-1].join(', ')}, and #{HTTP_METHODS[-1]}")
      name
    end