Skip to Content Skip to Search
Methods
G
P
A
B
C
E
F
H
I
K
L
M
N
O
Q
R
S
U
X
Included Modules

Constants

ENV_METHODS = %w[ AUTH_TYPE GATEWAY_INTERFACE PATH_TRANSLATED REMOTE_HOST REMOTE_IDENT REMOTE_USER REMOTE_ADDR SERVER_NAME SERVER_PROTOCOL ORIGINAL_SCRIPT_NAME HTTP_ACCEPT HTTP_ACCEPT_CHARSET HTTP_ACCEPT_ENCODING HTTP_ACCEPT_LANGUAGE HTTP_CACHE_CONTROL HTTP_FROM HTTP_NEGOTIATE HTTP_PRAGMA HTTP_CLIENT_IP HTTP_X_FORWARDED_FOR HTTP_ORIGIN HTTP_VERSION HTTP_X_CSRF_TOKEN HTTP_X_REQUEST_ID HTTP_X_FORWARDED_HOST ].freeze
 
HTTP_METHODS = RFC2616 + RFC2518 + RFC3253 + RFC3648 + RFC3744 + RFC5323 + RFC4791 + RFC5789
 
HTTP_METHOD_LOOKUP = {}
 
LOCALHOST = Regexp.union [/^127\.\d{1,3}\.\d{1,3}\.\d{1,3}$/, /^::1$/, /^0:0:0:0:0:0:0:1(%.*)?$/]
 
RFC2518 = %w(PROPFIND PROPPATCH MKCOL COPY MOVE LOCK UNLOCK)
 

HTTP methods from RFC 2518: HTTP Extensions for Distributed Authoring – WEBDAV
RFC2616 = %w(OPTIONS GET HEAD POST PUT DELETE TRACE CONNECT)
 

HTTP methods from RFC 2616: Hypertext Transfer Protocol – HTTP/1.1
RFC3253 = %w(VERSION-CONTROL REPORT CHECKOUT CHECKIN UNCHECKOUT MKWORKSPACE UPDATE LABEL MERGE BASELINE-CONTROL MKACTIVITY)
 

HTTP methods from RFC 3253: Versioning Extensions to WebDAV
RFC3648 = %w(ORDERPATCH)
 

HTTP methods from RFC 3648: WebDAV Ordered Collections Protocol
RFC3744 = %w(ACL)
 

HTTP methods from RFC 3744: WebDAV Access Control Protocol
RFC4791 = %w(MKCALENDAR)
 

HTTP methods from RFC 4791: Calendaring Extensions to WebDAV
RFC5323 = %w(SEARCH)
 

HTTP methods from RFC 5323: WebDAV SEARCH
RFC5789 = %w(PATCH)
 

HTTP methods from RFC 5789: PATCH Method for HTTP

Class Public methods

empty()

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 56
def self.empty
  new({})
end

new(env)

Source: show 

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

Instance Public methods

GET()

Override Rack’s GET method to support indifferent access.

Also aliased as: query_parameters

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 388
def GET
  fetch_header("action_dispatch.request.query_parameters") do |k|
    rack_query_params = super || {}
    controller = path_parameters[:controller]
    action = path_parameters[:action]
    rack_query_params = Request::Utils.set_binary_encoding(self, rack_query_params, controller, action)
    # Check for non UTF-8 parameter values, which would cause errors later
    Request::Utils.check_param_encoding(rack_query_params)
    set_header k, Request::Utils.normalize_encode_params(rack_query_params)
  end
rescue Rack::Utils::ParameterTypeError, Rack::Utils::InvalidParameterError, Rack::QueryParser::ParamsTooDeepError => e
  raise ActionController::BadRequest.new("Invalid query parameters: #{e.message}")
end

POST()

Override Rack’s POST method to support indifferent access.

Also aliased as: request_parameters

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 404
def POST
  fetch_header("action_dispatch.request.request_parameters") do
    pr = parse_formatted_parameters(params_parsers) do |params|
      super || {}
    end
    pr = Request::Utils.set_binary_encoding(self, pr, path_parameters[:controller], path_parameters[:action])
    Request::Utils.check_param_encoding(pr)
    self.request_parameters = Request::Utils.normalize_encode_params(pr)
  end
rescue Rack::Utils::ParameterTypeError, Rack::Utils::InvalidParameterError, Rack::QueryParser::ParamsTooDeepError, EOFError => e
  raise ActionController::BadRequest.new("Invalid request parameters: #{e.message}")
end

authorization()

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

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 420
def authorization
  get_header("HTTP_AUTHORIZATION")   ||
  get_header("X-HTTP_AUTHORIZATION") ||
  get_header("X_HTTP_AUTHORIZATION") ||
  get_header("REDIRECT_X_HTTP_AUTHORIZATION")
end

body()

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

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 349
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

commit_csrf_token()

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 452
def commit_csrf_token
  controller_instance.commit_csrf_token(self) if controller_instance.respond_to?(:commit_csrf_token)
end

commit_flash()

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 441
def commit_flash
end

content_length()

Returns the content length of the request as an integer.

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 285
def content_length
  return raw_post.bytesize if headers.key?("Transfer-Encoding")
  super.to_i
end

controller_class()

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 79
def controller_class
  params = path_parameters
  params[:action] ||= "index"
  controller_class_for(params[:controller])
end

controller_class_for(name)

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 85
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

form_data?()

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

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

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 366
def form_data?
  FORM_DATA_MEDIA_TYPES.include?(media_type)
end

fullpath()

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"

Source: show 

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

headers()

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

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

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 225
def headers
  @headers ||= Http::Headers.new(self)
end

http_auth_salt()

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 190
def http_auth_salt
  get_header "action_dispatch.http_auth_salt"
end

ip()

Returns the IP address of client as a String.

Source: show 

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

key?(key)

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

request.key? :ip_spoofing_check # => true

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 106
def key?(key)
  has_header? key
end

local?()

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

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 428
def local?
  LOCALHOST.match?(remote_addr) && LOCALHOST.match?(remote_ip)
end

logger()

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 437
def logger
  get_header("action_dispatch.logger")
end

media_type()

The String MIME type of the request.

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

Source: show 

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

method(*args)

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

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

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 205
def method(*args)
  if args.empty?
    @method ||= check_method(
      get_header("rack.methodoverride.original_method") ||
      get_header("REQUEST_METHOD")
    )
  else
    super
  end
end

method_symbol()

Returns a symbol form of the method.

Source: show 

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

original_fullpath()

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'

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 253
def original_fullpath
  @original_fullpath ||= (get_header("ORIGINAL_FULLPATH") || fullpath)
end

original_url()

Returns the original request URL as a String.

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

Source: show 

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

query_parameters()

Alias for: GET

raw_post()

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

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 339
def raw_post
  unless has_header? "RAW_POST_DATA"
    set_header("RAW_POST_DATA", read_body_stream)
    body_stream.rewind if body_stream.respond_to?(:rewind)
  end
  get_header "RAW_POST_DATA"
end

raw_request_method()

Alias for: request_method

remote_ip()

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

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 305
def remote_ip
  @remote_ip ||= (get_header("action_dispatch.remote_ip") || ip).to_s
end

remote_ip=(remote_ip)

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 309
def remote_ip=(remote_ip)
  @remote_ip = nil
  set_header "action_dispatch.remote_ip", remote_ip
end

request_id()

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.

Also aliased as: uuid

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 322
def request_id
  get_header ACTION_DISPATCH_REQUEST_ID
end

request_method()

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.

Also aliased as: raw_request_method

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 144
def request_method
  @request_method ||= check_method(super)
end

request_method_symbol()

Returns a symbol form of the request_method.

Source: show 

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

request_parameters()

Alias for: POST

request_parameters=(params)

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 432
def request_parameters=(params)
  raise if params.nil?
  set_header("action_dispatch.request.request_parameters", params)
end

reset_csrf_token()

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 448
def reset_csrf_token
  controller_instance.reset_csrf_token(self) if controller_instance.respond_to?(:reset_csrf_token)
end

reset_session()

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 374
def reset_session
  session.destroy
  reset_csrf_token
end

route_uri_pattern()

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

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

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 152
def route_uri_pattern
  get_header("action_dispatch.route_uri_pattern")
end

send_early_hints(links)

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

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

The send_early_hints method accepts a hash of links as follows:

send_early_hints("Link" => "</style.css>; rel=preload; as=style\n</script.js>; rel=preload")

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

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 240
def send_early_hints(links)
  return unless env["rack.early_hints"]

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

server_software()

Returns the lowercase name of the HTTP server software.

Source: show 

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

session_options=(options)

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 383
def session_options=(options)
  Session::Options.set self, options
end

uuid()

Alias for: request_id

xhr?()

Alias for: xml_http_request?

xml_http_request?()

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.

Also aliased as: xhr?

Source: show 

# File actionpack/lib/action_dispatch/http/request.rb, line 293
def xml_http_request?
  /XMLHttpRequest/i.match?(get_header("HTTP_X_REQUESTED_WITH"))
end