edge badge
Methods
G
P
A
B
C
E
F
H
I
K
L
M
N
O
Q
R
S
U
X
Included Modules
Constants
LOCALHOST = Regexp.union [/^127\.\d{1,3}\.\d{1,3}\.\d{1,3}$/, /^::1$/, /^0:0:0:0:0:0:0:1(%.*)?$/]
 
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 SERVER_ADDR ].freeze
 
PASS_NOT_FOUND = Class.new { # :nodoc: def self.action(_); self; end def self.call(_); [404, { "X-Cascade" => "pass" }, []]; end def self.encoding_for_param(action, param); ::Encoding::UTF_8; end }
 
RFC2616 = %w(OPTIONS GET HEAD POST PUT DELETE TRACE CONNECT)
 

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)

RFC2518 = %w(PROPFIND PROPPATCH MKCOL COPY MOVE LOCK UNLOCK)
 
RFC3253 = %w(VERSION-CONTROL REPORT CHECKOUT CHECKIN UNCHECKOUT MKWORKSPACE UPDATE LABEL MERGE BASELINE-CONTROL MKACTIVITY)
 
RFC3648 = %w(ORDERPATCH)
 
RFC3744 = %w(ACL)
 
RFC5323 = %w(SEARCH)
 
RFC4791 = %w(MKCALENDAR)
 
RFC5789 = %w(PATCH)
 
HTTP_METHODS = RFC2616 + RFC2518 + RFC3253 + RFC3648 + RFC3744 + RFC5323 + RFC4791 + RFC5789
 
HTTP_METHOD_LOOKUP = {}
 
ACTION_DISPATCH_REQUEST_ID = "action_dispatch.request_id".freeze # :nodoc:
 
Class Public methods
empty()
# File actionpack/lib/action_dispatch/http/request.rb, line 52
def self.empty
  new({})
end
new(env)
# File actionpack/lib/action_dispatch/http/request.rb, line 56
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
# File actionpack/lib/action_dispatch/http/request.rb, line 340
def GET
  fetch_header("action_dispatch.request.query_parameters") do |k|
    rack_query_params = super || {}
    # 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 => 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
# File actionpack/lib/action_dispatch/http/request.rb, line 353
def POST
  fetch_header("action_dispatch.request.request_parameters") do
    pr = parse_formatted_parameters(params_parsers) do |params|
      super || {}
    end
    self.request_parameters = Request::Utils.normalize_encode_params(pr)
  end
rescue ParamsParser::ParseError # one of the parse strategies blew up
  self.request_parameters = Request::Utils.normalize_encode_params(super || {})
  raise
rescue Rack::Utils::ParameterTypeError, Rack::Utils::InvalidParameterError => 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.

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

# File actionpack/lib/action_dispatch/http/request.rb, line 296
def body
  if raw_post = get_header("RAW_POST_DATA")
    raw_post.force_encoding(Encoding::BINARY)
    StringIO.new(raw_post)
  else
    body_stream
  end
end
commit_flash()
# File actionpack/lib/action_dispatch/http/request.rb, line 391
def commit_flash
end
content_length()

Returns the content length of the request as an integer.

# File actionpack/lib/action_dispatch/http/request.rb, line 233
def content_length
  super.to_i
end
controller_class()
# File actionpack/lib/action_dispatch/http/request.rb, line 75
def controller_class
  params = path_parameters

  if params.key?(:controller)
    controller_param = params[:controller].underscore
    params[:action] ||= "index"
    const_name = "#{controller_param.camelize}Controller"
    ActiveSupport::Dependencies.constantize(const_name)
  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.

# File actionpack/lib/action_dispatch/http/request.rb, line 313
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"
# File actionpack/lib/action_dispatch/http/request.rb, line 212
def fullpath
  @fullpath ||= super
end
headers()

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

request.headers["Content-Type"] # => "text/plain"
# File actionpack/lib/action_dispatch/http/request.rb, line 190
def headers
  @headers ||= Http::Headers.new(self)
end
http_auth_salt()
# File actionpack/lib/action_dispatch/http/request.rb, line 159
def http_auth_salt
  get_header "action_dispatch.http_auth_salt"
end
ip()

Returns the IP address of client as a String.

# File actionpack/lib/action_dispatch/http/request.rb, line 246
def ip
  @ip ||= super
end
key?(key)
# File actionpack/lib/action_dispatch/http/request.rb, line 88
def key?(key)
  has_header? key
end
local?()

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

# File actionpack/lib/action_dispatch/http/request.rb, line 378
def local?
  LOCALHOST =~ remote_addr && LOCALHOST =~ remote_ip
end
logger()
# File actionpack/lib/action_dispatch/http/request.rb, line 387
def logger
  get_header("action_dispatch.logger".freeze)
end
media_type()

The String MIME type of the request.

# get "/articles"
request.media_type # => "application/x-www-form-urlencoded"
# File actionpack/lib/action_dispatch/http/request.rb, line 228
def media_type
  content_mime_type.to_s
end
method()

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

# File actionpack/lib/action_dispatch/http/request.rb, line 178
def method
  @method ||= check_method(get_header("rack.methodoverride.original_method") || get_header("REQUEST_METHOD"))
end
method_symbol()

Returns a symbol form of the method

# File actionpack/lib/action_dispatch/http/request.rb, line 183
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'
# File actionpack/lib/action_dispatch/http/request.rb, line 201
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"
# File actionpack/lib/action_dispatch/http/request.rb, line 220
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.

# File actionpack/lib/action_dispatch/http/request.rb, line 285
def raw_post
  unless has_header? "RAW_POST_DATA"
    raw_post_body = body
    set_header("RAW_POST_DATA", raw_post_body.read(content_length))
    raw_post_body.rewind if raw_post_body.respond_to?(:rewind)
  end
  get_header "RAW_POST_DATA"
end
remote_ip()

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

# File actionpack/lib/action_dispatch/http/request.rb, line 252
def remote_ip
  @remote_ip ||= (get_header("action_dispatch.remote_ip") || ip).to_s
end
remote_ip=(remote_ip)
# File actionpack/lib/action_dispatch/http/request.rb, line 256
def remote_ip=(remote_ip)
  set_header "action_dispatch.remote_ip".freeze, 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
# File actionpack/lib/action_dispatch/http/request.rb, line 268
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.

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

Returns a symbol form of the request_method

# File actionpack/lib/action_dispatch/http/request.rb, line 171
def request_method_symbol
  HTTP_METHOD_LOOKUP[request_method]
end
request_parameters()
Alias for: POST
request_parameters=(params)
# File actionpack/lib/action_dispatch/http/request.rb, line 382
def request_parameters=(params)
  raise if params.nil?
  set_header("action_dispatch.request.request_parameters".freeze, params)
end
reset_session()

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

# File actionpack/lib/action_dispatch/http/request.rb, line 323
def reset_session
  if session && session.respond_to?(:destroy)
    session.destroy
  else
    self.session = {}
  end
end
server_software()

Returns the lowercase name of the HTTP server software.

# File actionpack/lib/action_dispatch/http/request.rb, line 279
def server_software
  (get_header("SERVER_SOFTWARE") && /^([a-zA-Z]+)/ =~ get_header("SERVER_SOFTWARE")) ? $1.downcase : nil
end
session_options=(options)
# File actionpack/lib/action_dispatch/http/request.rb, line 335
def session_options=(options)
  Session::Options.set self, options
end
ssl?()
# File actionpack/lib/action_dispatch/http/request.rb, line 394
def ssl?
  super || scheme == "wss".freeze
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?
# File actionpack/lib/action_dispatch/http/request.rb, line 240
def xml_http_request?
  get_header("HTTP_X_REQUESTED_WITH") =~ /XMLHttpRequest/i
end