Rack::Request provides a convenient interface to a Rack environment. It is stateless, the environment env passed to the constructor will be directly modified.
req = Rack::Request.new(env) req.post? req.params["data"]
The environment hash passed will store a reference to the Request object instantiated so that it will only instantiate if an instance of the Request object doesn’t already exist.
The set of form-data media-types. Requests that do not indicate one of the media types presents in this list will not be eligible for form-data / param parsing.
The set of media-types. Requests that do not indicate one of the media types presents in this list will not be eligible for param parsing like soap attachments or generic multiparts
Returns the data recieved in the query string.
# File lib/rack/request.rb, line 162 def GET if @env["rack.request.query_string"] == query_string @env["rack.request.query_hash"] else @env["rack.request.query_string"] = query_string @env["rack.request.query_hash"] = parse_query(query_string) end end
Returns the data recieved in the request body.
This method support both application/x-www-form-urlencoded and multipart/form-data.
# File lib/rack/request.rb, line 175 def POST if @env["rack.input"].nil? raise "Missing rack.input" elsif @env["rack.request.form_input"].eql? @env["rack.input"] @env["rack.request.form_hash"] elsif form_data? || parseable_data? @env["rack.request.form_input"] = @env["rack.input"] unless @env["rack.request.form_hash"] = parse_multipart(env) form_vars = @env["rack.input"].read # Fix for Safari Ajax postings that always append \0 # form_vars.sub!(/\0\z/, '') # performance replacement: form_vars.slice!(-1) if form_vars[-1] == \00 \ @env["rack.request.form_vars"] = form_vars @env["rack.request.form_hash"] = parse_query(form_vars) @env["rack.input"].rewind end @env["rack.request.form_hash"] else {} end end
shortcut for request.params[key]
# File lib/rack/request.rb, line 208 def [](key) params[key.to_s] end
shortcut for request.params[key] = value
# File lib/rack/request.rb, line 213 def []=(key, value) params[key.to_s] = value end
# File lib/rack/request.rb, line 280 def accept_encoding @env["HTTP_ACCEPT_ENCODING"].to_s.split(/,\s*/).map do |part| m = /^([^\s,]+?)(?:;\s*q=(\d+(?:\.\d+)?))?$/.match(part) # From WEBrick if m [m[1], (m[2] || 1.0).to_f] else raise "Invalid value for Accept-Encoding: #{part.inspect}" end end end
# File lib/rack/request.rb, line 255 def base_url url = scheme + "://" url << host if scheme == "https" && port != 443 || scheme == "http" && port != 80 url << ":#{port}" end url end
The character set of the request body if a “charset” media type parameter was given, or nil if no “charset” was specified. Note that, per RFC2616, text/* media types that specify no explicit charset are to be considered ISO-8859-1.
# File lib/rack/request.rb, line 66 def content_charset media_type_params['charset'] end
# File lib/rack/request.rb, line 29 def content_length; @env['CONTENT_LENGTH'] end
# File lib/rack/request.rb, line 31 def content_type content_type = @env['CONTENT_TYPE'] content_type.nil? || content_type.empty? ? nil : content_type end
# File lib/rack/request.rb, line 116 def delete?; request_method == "DELETE" end
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 also assumed to contain form-data when no Content-Type header is provided and the request_method is POST.
# File lib/rack/request.rb, line 149 def form_data? type = media_type meth = env["rack.methodoverride.original_method"] || env['REQUEST_METHOD'] (meth == 'POST' && type.nil?) || FORM_DATA_MEDIA_TYPES.include?(type) end
# File lib/rack/request.rb, line 276 def fullpath query_string.empty? ? path : "#{path}?#{query_string}" end
# File lib/rack/request.rb, line 117 def get?; request_method == "GET" end
# File lib/rack/request.rb, line 118 def head?; request_method == "HEAD" end
# File lib/rack/request.rb, line 108 def host # Remove port number. host_with_port.to_s.gsub(/:\d+\z/, '') end
# File lib/rack/request.rb, line 86 def host_with_port if forwarded = @env["HTTP_X_FORWARDED_HOST"] forwarded.split(/,\s?/).last else @env['HTTP_HOST'] || "#{@env['SERVER_NAME'] || @env['SERVER_ADDR']}:#{@env['SERVER_PORT']}" end end
# File lib/rack/request.rb, line 292 def ip if addr = @env['HTTP_X_FORWARDED_FOR'] (addr.split(',').grep(/\d\./).first || @env['REMOTE_ADDR']).to_s.strip else @env['REMOTE_ADDR'] end end
# File lib/rack/request.rb, line 38 def logger; @env['rack.logger'] end
The media type (type/subtype) portion of the CONTENT_TYPE header without any media type parameters. e.g., when CONTENT_TYPE is “text/plain;charset=utf-8”, the media-type is “text/plain”.
For more information on the use of media types in HTTP, see: www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7
# File lib/rack/request.rb, line 46 def media_type content_type && content_type.split(/\s*[;,]\s*/, 2).first.downcase end
The media type parameters provided in CONTENT_TYPE as a Hash, or an empty Hash if no CONTENT_TYPE or media-type parameters were provided. e.g., when the CONTENT_TYPE is “text/plain;charset=utf-8”, this method responds with the following Hash:
{ 'charset' => 'utf-8' }
# File lib/rack/request.rb, line 55 def media_type_params return {} if content_type.nil? Hash[*content_type.split(/\s*[;,]\s*/)[1..-1]. collect { |s| s.split('=', 2) }. map { |k,v| [k.downcase, v] }.flatten] end
# File lib/rack/request.rb, line 119 def options?; request_method == "OPTIONS" end
Determine whether the request body contains data by checking the request media_type against registered parse-data media-types
# File lib/rack/request.rb, line 157 def parseable_data? PARSEABLE_DATA_MEDIA_TYPES.include?(media_type) end
# File lib/rack/request.rb, line 120 def patch?; request_method == "PATCH" end
# File lib/rack/request.rb, line 272 def path script_name + path_info end
# File lib/rack/request.rb, line 26 def path_info; @env["PATH_INFO"].to_s end
# File lib/rack/request.rb, line 114 def path_info=(s); @env["PATH_INFO"] = s.to_s end
# File lib/rack/request.rb, line 94 def port if port = host_with_port.split(/:/)[1] port.to_i elsif port = @env['HTTP_X_FORWARDED_PORT'] port.to_i elsif ssl? 443 elsif @env.has_key?("HTTP_X_FORWARDED_HOST") 80 else @env["SERVER_PORT"].to_i end end
# File lib/rack/request.rb, line 121 def post?; request_method == "POST" end
# File lib/rack/request.rb, line 122 def put?; request_method == "PUT" end
# File lib/rack/request.rb, line 28 def query_string; @env["QUERY_STRING"].to_s end
the referer of the client
# File lib/rack/request.rb, line 223 def referer @env['HTTP_REFERER'] end
# File lib/rack/request.rb, line 27 def request_method; @env["REQUEST_METHOD"] end
# File lib/rack/request.rb, line 70 def scheme if @env['HTTPS'] == 'on' 'https' elsif @env['HTTP_X_FORWARDED_SSL'] == 'on' 'https' elsif @env['HTTP_X_FORWARDED_PROTO'] @env['HTTP_X_FORWARDED_PROTO'].split(',')[0] else @env["rack.url_scheme"] end end
# File lib/rack/request.rb, line 25 def script_name; @env["SCRIPT_NAME"].to_s end
# File lib/rack/request.rb, line 113 def script_name=(s); @env["SCRIPT_NAME"] = s.to_s end
# File lib/rack/request.rb, line 36 def session; @env['rack.session'] ||= {} end
# File lib/rack/request.rb, line 37 def session_options; @env['rack.session.options'] ||= {} end
# File lib/rack/request.rb, line 123 def trace?; request_method == "TRACE" end
Tries to return a remake of the original request URL as a string.
# File lib/rack/request.rb, line 268 def url base_url + fullpath end
# File lib/rack/request.rb, line 228 def user_agent @env['HTTP_USER_AGENT'] end
Generated with the Darkfish Rdoc Generator 2.