Rack::Request
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)
Which IP addresses are “trusted proxies” that can be stripped from the right-hand-side of X-Forwarded-For.
en.wikipedia.org/wiki/Private_network#Private_IPv4_address_spaces.
Override Rack’s GET method to support indifferent access
# File lib/action_dispatch/http/request.rb, line 236 def GET @env["action_dispatch.request.query_parameters"] ||= (normalize_parameters(super) || {}) end
Override Rack’s POST method to support indifferent access
# File lib/action_dispatch/http/request.rb, line 242 def POST @env["action_dispatch.request.request_parameters"] ||= (normalize_parameters(super) || {}) end
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 202 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
Returns the content length of the request as an integer.
# File lib/action_dispatch/http/request.rb, line 147 def content_length super.to_i end
Is this a DELETE request? Equivalent to request.request_method == :delete.
# File lib/action_dispatch/http/request.rb, line 116 def delete? HTTP_METHOD_LOOKUP[request_method] == :delete end
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 6 def flash @env[Flash::KEY] ||= (session["flash"] || Flash::FlashHash.new) end
# File lib/action_dispatch/http/request.rb, line 137 def forgery_whitelisted? get? end
# File lib/action_dispatch/http/request.rb, line 211 def form_data? FORM_DATA_MEDIA_TYPES.include?(content_mime_type.to_s) end
# File lib/action_dispatch/http/request.rb, line 133 def fullpath @fullpath ||= super end
Is this a GET (or HEAD) request? Equivalent to request.request_method == :get.
# File lib/action_dispatch/http/request.rb, line 98 def get? HTTP_METHOD_LOOKUP[request_method] == :get end
Is this a HEAD request? Equivalent to request.method == :head.
# File lib/action_dispatch/http/request.rb, line 122 def head? HTTP_METHOD_LOOKUP[method] == :head end
Provides access to the request’s HTTP headers, for example:
request.headers["Content-Type"] # => "text/plain"
# File lib/action_dispatch/http/request.rb, line 129 def headers Http::Headers.new(@env) end
# File lib/action_dispatch/http/request.rb, line 159 def ip @ip ||= super end
# File lib/action_dispatch/http/request.rb, line 46 def key?(key) @env.key?(key) end
True if the request came from localhost, 127.0.0.1.
# File lib/action_dispatch/http/request.rb, line 258 def local? LOCALHOST.any? { |local_ip| local_ip === remote_addr && local_ip === remote_ip } end
# File lib/action_dispatch/http/request.rb, line 142 def media_type content_mime_type.to_s end
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 87 def method @method ||= check_method(env["rack.methodoverride.original_method"] || env['REQUEST_METHOD']) end
Returns a symbol form of the method
# File lib/action_dispatch/http/request.rb, line 92 def method_symbol HTTP_METHOD_LOOKUP[method] end
Is this a POST request? Equivalent to request.request_method == :post.
# File lib/action_dispatch/http/request.rb, line 104 def post? HTTP_METHOD_LOOKUP[request_method] == :post end
Is this a PUT request? Equivalent to request.request_method == :put.
# File lib/action_dispatch/http/request.rb, line 110 def put? HTTP_METHOD_LOOKUP[request_method] == :put end
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 192 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
Determines originating IP address. REMOTE_ADDR is the standard but will fail if the user is behind a proxy. HTTP_CLIENT_IP and/or HTTP_X_FORWARDED_FOR are set by proxies so check for these if REMOTE_ADDR is a proxy. HTTP_X_FORWARDED_FOR may be a comma- delimited list in the case of multiple chained proxies; the last address which is not trusted is the originating IP.
# File lib/action_dispatch/http/request.rb, line 181 def remote_ip @remote_ip ||= (@env["action_dispatch.remote_ip"] || ip).to_s end
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 75 def request_method @request_method ||= check_method(env["REQUEST_METHOD"]) end
Returns a symbol form of the request_method
# File lib/action_dispatch/http/request.rb, line 80 def request_method_symbol HTTP_METHOD_LOOKUP[request_method] end
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 221 def reset_session session.destroy if session && session.respond_to?(:destroy) self.session = {} @env['action_dispatch.request.flash_hash'] = nil end
Returns the lowercase name of the HTTP server software.
# File lib/action_dispatch/http/request.rb, line 186 def server_software (@env['SERVER_SOFTWARE'] && /^([a-zA-Z]+)/ =~ @env['SERVER_SOFTWARE']) ? $1.downcase : nil end
# File lib/action_dispatch/http/request.rb, line 231 def session_options=(options) @env['rack.session.options'] = options end
Returns true if the “X-Requested-With” header contains “XMLHttpRequest” (case-insensitive). All major JavaScript libraries send this header with every Ajax request.
# File lib/action_dispatch/http/request.rb, line 154 def xml_http_request? @env['HTTP_X_REQUESTED_WITH'] =~ /XMLHttpRequest/ end
Generated with the Darkfish Rdoc Generator 2.