ActionDispatch::Request

LOCALHOST	=	[/^127\.0\.0\.\d{1,3}$/, "::1", /^0:0:0:0:0:0:0:1(%.*)?$/].freeze

ENV_METHODS	=	%w[ AUTH_TYPE GATEWAY_INTERFACE PATH_TRANSLATED REMOTE_HOST REMOTE_IDENT REMOTE_USER REMOTE_ADDR SERVER_NAME SERVER_PROTOCOL HTTP_ACCEPT HTTP_ACCEPT_CHARSET HTTP_ACCEPT_ENCODING HTTP_ACCEPT_LANGUAGE HTTP_CACHE_CONTROL HTTP_FROM HTTP_NEGOTIATE HTTP_PRAGMA ].freeze

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

RFC5789	=	%w(PATCH)

HTTP_METHODS	=	RFC2616 + RFC2518 + RFC3253 + RFC3648 + RFC3744 + RFC5323 + RFC5789

HTTP_METHOD_LOOKUP	=	Hash.new { \|h, m\| h[m] = m.underscore.to_sym if HTTP_METHODS.include?(m) }

Instance Public methods

GET()

Override Rack’s #GET method to support indifferent access

Also aliased as: query_parameters

Source: show | on GitHub

# File actionpack/lib/action_dispatch/http/request.rb, line 224
def GET
  @env["action_dispatch.request.query_parameters"] ||= (normalize_parameters(super) || {})
end

POST()

Override Rack’s #POST method to support indifferent access

Also aliased as: request_parameters

Source: show | on GitHub

# File actionpack/lib/action_dispatch/http/request.rb, line 230
def POST
  @env["action_dispatch.request.request_parameters"] ||= (normalize_parameters(super) || {})
end

authorization()

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

Source: show | on GitHub

# File actionpack/lib/action_dispatch/http/request.rb, line 238
def authorization
  @env['HTTP_AUTHORIZATION']   ||
  @env['X-HTTP_AUTHORIZATION'] ||
  @env['X_HTTP_AUTHORIZATION'] ||
  @env['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 | on GitHub

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

content_length()

Returns the content length of the request as an integer.

Source: show | on GitHub

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

cookie_jar()

Source: show | on GitHub

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

delete?()

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

Source: show | on GitHub

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

flash()

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.

Source: show | on GitHub

# File actionpack/lib/action_dispatch/middleware/flash.rb, line 6
def flash
  @env[Flash::KEY] ||= (session["flash"] || Flash::FlashHash.new).tap(&:sweep)
end

form_data?()

Source: show | on GitHub

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

fullpath()

Source: show | on GitHub

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

get?()

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

Source: show | on GitHub

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

head?()

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

Source: show | on GitHub

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

headers()

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

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

Source: show | on GitHub

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

ip()

Source: show | on GitHub

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

key?(key)

Source: show | on GitHub

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

local?()

True if the request came from localhost, 127.0.0.1.

Source: show | on GitHub

# File actionpack/lib/action_dispatch/http/request.rb, line 246
def local?
  LOCALHOST.any? { |local_ip| local_ip === remote_addr && local_ip === remote_ip }
end

media_type()

Source: show | on GitHub

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

Source: show | on GitHub

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

method_symbol()

Returns a symbol form of the method

Source: show | on GitHub

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

original_fullpath()

Source: show | on GitHub

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

original_url()

Source: show | on GitHub

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

post?()

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

Source: show | on GitHub

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

put?()

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

Source: show | on GitHub

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

query_parameters()

raw_post()

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

Source: show | on GitHub

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

remote_ip()

Originating IP address, usually set by the RemoteIp middleware.

Source: show | on GitHub

# File actionpack/lib/action_dispatch/http/request.rb, line 159
def remote_ip
  @remote_ip ||= (@env["action_dispatch.remote_ip"] || ip).to_s
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.

Source: show | on GitHub

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

request_method_symbol()

Returns a symbol form of the request_method

Source: show | on GitHub

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

request_parameters()

reset_session()

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

Source: show | on GitHub

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

server_software()

Returns the lowercase name of the HTTP server software.

Source: show | on GitHub

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

session_options=(options)

Source: show | on GitHub

# File actionpack/lib/action_dispatch/http/request.rb, line 219
def session_options=(options)
  @env['rack.session.options'] = options
end

uuid()

Returns the unique request id, which is based off 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.

Source: show | on GitHub

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

xhr?()

xml_http_request?()

Returns true if the “X-Requested-With” header contains “XMLHttpRequest” (case-insensitive). All major JavaScript libraries send this header with every Ajax request.

Also aliased as: xhr?

Source: show | on GitHub

# File actionpack/lib/action_dispatch/http/request.rb, line 149
def xml_http_request?
  @env['HTTP_X_REQUESTED_WITH'] =~ %rXMLHttpRequest/
end

Instance Protected methods

deep_munge(hash)

Remove nils from the params hash

Source: show | on GitHub

# File actionpack/lib/action_dispatch/http/request.rb, line 253
def deep_munge(hash)
  hash.each_value do |v|
    case v
    when Array
      v.grep(Hash) { |x| deep_munge(x) }
    when Hash
      deep_munge(v)
    end
  end

  keys = hash.keys.find_all { |k| hash[k] == [nil] }
  keys.each { |k| hash[k] = nil }
  hash
end

parse_query(qs)

Source: show | on GitHub

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

Class ActionDispatch::Request < Rack::Request