ActionDispatch::Request

def self.empty

def self.empty
  new({})
end

def GET

Override Rack's GET method to support indifferent access.

def GET
  fetch_header("action_dispatch.request.query_parameters") do |k|
    encoding_template = Request::Utils::CustomParamEncoder.action_encoding_template(self, path_parameters[:controller], path_parameters[:action])
    rack_query_params = ActionDispatch::ParamBuilder.from_query_string(rack_request.query_string, encoding_template: encoding_template)
    set_header k, rack_query_params
  end
rescue ActionDispatch::ParamError => e
  raise ActionController::BadRequest.new("Invalid query parameters: #{e.message}")
end

def POST

Override Rack's POST method to support indifferent access.

def POST
  fetch_header("action_dispatch.request.request_parameters") do
    encoding_template = Request::Utils::CustomParamEncoder.action_encoding_template(self, path_parameters[:controller], path_parameters[:action])
    param_list = nil
    pr = parse_formatted_parameters(params_parsers) do
      if param_list = request_parameters_list
        ActionDispatch::ParamBuilder.from_pairs(param_list, encoding_template: encoding_template)
      else
        # We're not using a version of Rack that provides raw form
        # pairs; we must use its hash (and thus post-process it below).
        fallback_request_parameters
      end
    end
    # If the request body was parsed by a custom parser like JSON
    # (and thus the above block was not run), we need to
    # post-process the result hash.
    if param_list.nil?
      pr = ActionDispatch::ParamBuilder.from_hash(pr, encoding_template: encoding_template)
    end
    self.request_parameters = pr
  end
rescue ActionDispatch::ParamError, EOFError => e
  raise ActionController::BadRequest.new("Invalid request parameters: #{e.message}")
end

def authorization

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

def authorization
  get_header("HTTP_AUTHORIZATION")   ||
  get_header("X-HTTP_AUTHORIZATION") ||
  get_header("X_HTTP_AUTHORIZATION") ||
  get_header("REDIRECT_X_HTTP_AUTHORIZATION")
end

def body

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

def body
  if raw_post = get_header("RAW_POST_DATA")
    raw_post = (+raw_post).force_encoding(Encoding::BINARY)
    StringIO.new(raw_post)
  else
    body_stream
  end
end

def body_stream # :nodoc:

:nodoc:

def body_stream # :nodoc:
  get_header("rack.input")
end

def check_method(name)

def check_method(name)
  if name
    HTTP_METHOD_LOOKUP[name] || raise(ActionController::UnknownHttpMethod, "#{name}, accepted HTTP methods are #{HTTP_METHODS.to_sentence(locale: false)}")
  end
  name
end

def commit_cookie_jar! # :nodoc:

:nodoc:

def commit_cookie_jar! # :nodoc:
end

def commit_csrf_token

def commit_csrf_token
  controller_instance.commit_csrf_token(self) if controller_instance.respond_to?(:commit_csrf_token)
end

def commit_flash

def commit_flash
end

def content_length

Returns the content length of the request as an integer.

def content_length
  return raw_post.bytesize if has_header?(TRANSFER_ENCODING)
  super.to_i
end

def controller_class

def controller_class
  params = path_parameters
  params[:action] ||= "index"
  controller_class_for(params[:controller])
end

def controller_class_for(name)

def controller_class_for(name)
  if name
    controller_param = name.underscore
    const_name = controller_param.camelize << "Controller"
    begin
      const_name.constantize
    rescue NameError => error
      if error.missing_name == const_name || const_name.start_with?("#{error.missing_name}::")
        raise MissingController.new(error.message, error.name)
      else
        raise
      end
    end
  else
    PASS_NOT_FOUND
  end
end

def controller_instance # :nodoc:

:nodoc:

def controller_instance # :nodoc:
  get_header("action_controller.instance")
end

def controller_instance=(controller) # :nodoc:

:nodoc:

def controller_instance=(controller) # :nodoc:
  set_header("action_controller.instance", controller)
end

def default_session

def default_session
  Session.disabled(self)
end

def engine_script_name(_routes) # :nodoc:

:nodoc:

def engine_script_name(_routes) # :nodoc:
  get_header(_routes.env_key)
end

def engine_script_name=(name) # :nodoc:

:nodoc:

def engine_script_name=(name) # :nodoc:
  set_header(routes.env_key, name.dup)
end

def fallback_request_parameters

def fallback_request_parameters
  rack_request.POST
end

def form_data?

header is provided and the request_method is POST.
A request body is not assumed to contain form-data when no `Content-Type`

through the `FORM_DATA_MEDIA_TYPES` array.
or `multipart/form-data`. The list of form-data media types can be modified
`Content-Type` for one of the media-types: `application/x-www-form-urlencoded`
Determine whether the request body contains form-data by checking the request

def form_data?
  FORM_DATA_MEDIA_TYPES.include?(media_type)
end

def fullpath

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

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

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

def fullpath
  @fullpath ||= super
end

def headers

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

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

def headers
  @headers ||= Http::Headers.new(self)
end

def http_auth_salt

def http_auth_salt
  get_header "action_dispatch.http_auth_salt"
end

def initialize(env)

def initialize(env)
  super
  @rack_request = Rack::Request.new(env)
  @method            = nil
  @request_method    = nil
  @remote_ip         = nil
  @original_fullpath = nil
  @fullpath          = nil
  @ip                = nil
end

def inspect # :nodoc:

:nodoc:

def inspect # :nodoc:
  "#<#{self.class.name} #{method} #{original_url.dump} for #{remote_ip}>"
end

def ip

Returns the IP address of client as a `String`.

def ip
  @ip ||= super
end

def key?(key)

request.key? :ip_spoofing_check # => true

Returns true if the request has a header matching the given key parameter.

def key?(key)
  has_header? key
end

def local?

True if the request came from localhost, 127.0.0.1, or ::1.

def local?
  LOCALHOST.match?(remote_addr) && LOCALHOST.match?(remote_ip)
end

def logger

def logger
  get_header("action_dispatch.logger")
end

def media_type

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

The `String` MIME type of the request.

def media_type
  content_mime_type&.to_s
end

def method(*args)

to Object#method
For debugging purposes, when called with arguments this method will fall back

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

def method(*args)
  if args.empty?
    @method ||= check_method(
      get_header("rack.methodoverride.original_method") ||
      get_header("REQUEST_METHOD")
    )
  else
    super
  end
end

def method_symbol

Returns a symbol form of the #method.

def method_symbol
  HTTP_METHOD_LOOKUP[method]
end

def original_fullpath

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

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

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

def original_fullpath
  @original_fullpath ||= (get_header("ORIGINAL_FULLPATH") || fullpath)
end

def original_url

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

Returns the original request URL as a `String`.

def original_url
  base_url + original_fullpath
end

def raw_post

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

def raw_post
  unless has_header? "RAW_POST_DATA"
    set_header("RAW_POST_DATA", read_body_stream)
  end
  get_header "RAW_POST_DATA"
end

def read_body_stream

def read_body_stream
  if body_stream
    reset_stream(body_stream) do
      if has_header?(TRANSFER_ENCODING)
        body_stream.read # Read body stream until EOF if "Transfer-Encoding" is present
      else
        body_stream.read(content_length)
      end
    end
  end
end

def remote_ip

middleware.
Returns the IP address of client as a `String`, usually set by the RemoteIp

def remote_ip
  @remote_ip ||= (get_header("action_dispatch.remote_ip") || ip).to_s
end

def remote_ip=(remote_ip)

def remote_ip=(remote_ip)
  @remote_ip = nil
  set_header "action_dispatch.remote_ip", remote_ip
end

def request_id

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

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

def request_id
  get_header ACTION_DISPATCH_REQUEST_ID
end

def request_id=(id) # :nodoc:

:nodoc:

def request_id=(id) # :nodoc:
  set_header ACTION_DISPATCH_REQUEST_ID, id
end

def request_method

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

def request_method
  @request_method ||= check_method(super)
end

def request_method=(request_method) # :nodoc:

:nodoc:

def request_method=(request_method) # :nodoc:
  if check_method(request_method)
    @request_method = set_header("REQUEST_METHOD", request_method)
  end
end

def request_method_symbol

Returns a symbol form of the #request_method.

def request_method_symbol
  HTTP_METHOD_LOOKUP[request_method]
end

def request_parameters=(params)

def request_parameters=(params)
  raise if params.nil?
  set_header("action_dispatch.request.request_parameters", params)
end

def request_parameters_list

def request_parameters_list
  # We don't use Rack's parse result, but we must call it so Rack
  # can populate the rack.request.* keys we need.
  rack_post = rack_request.POST
  if form_pairs = get_header("rack.request.form_pairs")
    # Multipart
    form_pairs
  elsif form_vars = get_header("rack.request.form_vars")
    # URL-encoded
    ActionDispatch::QueryParser.each_pair(form_vars)
  elsif rack_post && !rack_post.empty?
    # It was multipart, but Rack did not preserve a pair list
    # (probably too old). Flat parameter list is not available.
    nil
  else
    # No request body, or not a format Rack knows
    []
  end
end

def reset_csrf_token

def reset_csrf_token
  controller_instance.reset_csrf_token(self) if controller_instance.respond_to?(:reset_csrf_token)
end

def reset_session

def reset_session
  session.destroy
  reset_csrf_token
end

def reset_stream(body_stream)

def reset_stream(body_stream)
  if body_stream.respond_to?(:rewind)
    body_stream.rewind
    content = yield
    body_stream.rewind
    content
  else
    yield
  end
end

def route_uri_pattern

request.route_uri_pattern # => "/:controller(/:action(/:id))(.:format)"

format as `bin/rails routes`:
Returns the URI pattern of the matched route for the request, using the same

def route_uri_pattern
  get_header("action_dispatch.route_uri_pattern")
end

def route_uri_pattern=(pattern) # :nodoc:

:nodoc:

def route_uri_pattern=(pattern) # :nodoc:
  set_header("action_dispatch.route_uri_pattern", pattern)
end

def routes # :nodoc:

:nodoc:

def routes # :nodoc:
  get_header("action_dispatch.routes")
end

def routes=(routes) # :nodoc:

:nodoc:

def routes=(routes) # :nodoc:
  set_header("action_dispatch.routes", routes)
end

def send_early_hints(links)

Hints headers are included by default if supported.
If you are using `javascript_include_tag` or `stylesheet_link_tag` the Early

send_early_hints("link" => "; rel=preload; as=style,; rel=preload")

The `send_early_hints` method accepts a hash of links as follows:

link headers.
If the env contains `rack.early_hints` then the server accepts HTTP2 push for

start making preparations for processing the final response.
Early Hints is an HTTP/2 status code that indicates hints to help a client

def send_early_hints(links)
  env["rack.early_hints"]&.call(links)
end

def server_software

Returns the lowercase name of the HTTP server software.

def server_software
  (get_header("SERVER_SOFTWARE") && /^([a-zA-Z]+)/ =~ get_header("SERVER_SOFTWARE")) ? $1.downcase : nil
end

def session=(session) # :nodoc:

:nodoc:

def session=(session) # :nodoc:
  Session.set self, session
end

def session_options=(options)

def session_options=(options)
  Session::Options.set self, options
end

def xml_http_request?

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

def xml_http_request?
  /XMLHttpRequest/i.match?(get_header("HTTP_X_REQUESTED_WITH"))
end

class ActionDispatch::Request

def self.empty

def GET

def POST

def authorization

def body

def body_stream # :nodoc:

def check_method(name)

def commit_cookie_jar! # :nodoc:

def commit_csrf_token

def commit_flash

def content_length

def controller_class

def controller_class_for(name)

def controller_instance # :nodoc:

def controller_instance=(controller) # :nodoc:

def default_session

def engine_script_name(_routes) # :nodoc:

def engine_script_name=(name) # :nodoc:

def fallback_request_parameters

def form_data?

def fullpath

def headers

def http_auth_salt

def initialize(env)

def inspect # :nodoc:

def ip

def key?(key)

def local?

def logger

def media_type

def method(*args)

def method_symbol

def original_fullpath

def original_url

def raw_post

def read_body_stream

def remote_ip

def remote_ip=(remote_ip)

def request_id

def request_id=(id) # :nodoc:

def request_method

def request_method=(request_method) # :nodoc:

def request_method_symbol

def request_parameters=(params)

def request_parameters_list

def reset_csrf_token

def reset_session

def reset_stream(body_stream)

def route_uri_pattern

def route_uri_pattern=(pattern) # :nodoc:

def routes # :nodoc:

def routes=(routes) # :nodoc:

def send_early_hints(links)

def server_software

def session=(session) # :nodoc:

def session_options=(options)

def xml_http_request?

Namespace

Classes in this namespace

Included Modules

Class Methods

Instance Methods

Defined in