class Rack::Test::Session
This class represents a series of requests issued to a Rack app, sharing a single cookie jar
Rack::Test::Session's methods are most often called through Rack::Test::Methods, which will automatically build a session when it's first used.
Public Class Methods
Creates a Rack::Test::Session for a given Rack app or Rack::MockSession.
Note: Generally, you won't need to initialize a Rack::Test::Session directly. Instead, you should include Rack::Test::Methods into your testing context. (See README.rdoc for an example)
# File lib/rack/test.rb, line 36 def initialize(mock_session) @headers = {} @env = {} if mock_session.is_a?(MockSession) @rack_mock_session = mock_session else @rack_mock_session = MockSession.new(mock_session) end @default_host = @rack_mock_session.default_host end
Public Instance Methods
Issue a DELETE request for the given URI. See get
Example:
delete "/"
# File lib/rack/test.rb, line 92 def delete(uri, params = {}, env = {}, &block) env = env_for(uri, env.merge(:method => "DELETE", :params => params)) process_request(uri, env, &block) end
Set an env var to be included on all subsequent requests through the session. Use a value of nil to remove a previously configured env.
Example:
env "rack.session", {:csrf => 'token'}
# File lib/rack/test.rb, line 148 def env(name, value) if value.nil? @env.delete(name) else @env[name] = value end end
Rack::Test will not follow any redirects automatically. This method will follow the redirect returned (including setting the Referer header on the new request) in the last response. If the last response was not a redirect, an error will be raised.
# File lib/rack/test.rb, line 182 def follow_redirect! unless last_response.redirect? raise Error.new("Last response was not a redirect. Cannot follow_redirect!") end get(last_response["Location"], {}, { "HTTP_REFERER" => last_request.url }) end
Issue a GET request for the given URI with the given params and Rack environment. Stores the issues request object in last_request and the app's response in last_response. Yield last_response to a block if given.
Example:
get "/"
# File lib/rack/test.rb, line 56 def get(uri, params = {}, env = {}, &block) env = env_for(uri, env.merge(:method => "GET", :params => params)) process_request(uri, env, &block) end
Issue a HEAD request for the given URI. See get
Example:
head "/"
# File lib/rack/test.rb, line 110 def head(uri, params = {}, env = {}, &block) env = env_for(uri, env.merge(:method => "HEAD", :params => params)) process_request(uri, env, &block) end
Set a header to be included on all subsequent requests through the session. Use a value of nil to remove a previously configured header.
In accordance with the Rack spec, headers will be included in the Rack environment hash in HTTP_USER_AGENT form.
Example:
header "User-Agent", "Firefox"
# File lib/rack/test.rb, line 135 def header(name, value) if value.nil? @headers.delete(name) else @headers[name] = value end end
Issue an OPTIONS request for the given URI. See get
Example:
options "/"
# File lib/rack/test.rb, line 101 def options(uri, params = {}, env = {}, &block) env = env_for(uri, env.merge(:method => "OPTIONS", :params => params)) process_request(uri, env, &block) end
Issue a PATCH request for the given URI. See get
Example:
patch "/"
# File lib/rack/test.rb, line 83 def patch(uri, params = {}, env = {}, &block) env = env_for(uri, env.merge(:method => "PATCH", :params => params)) process_request(uri, env, &block) end
Issue a POST request for the given URI. See get
Example:
post "/signup", "name" => "Bryan"
# File lib/rack/test.rb, line 65 def post(uri, params = {}, env = {}, &block) env = env_for(uri, env.merge(:method => "POST", :params => params)) process_request(uri, env, &block) end
Issue a PUT request for the given URI. See get
Example:
put "/"
# File lib/rack/test.rb, line 74 def put(uri, params = {}, env = {}, &block) env = env_for(uri, env.merge(:method => "PUT", :params => params)) process_request(uri, env, &block) end
Issue a request to the Rack app for the given URI and optional Rack environment. Stores the issues request object in last_request and the app's response in last_response. Yield last_response to a block if given.
Example:
request "/"
# File lib/rack/test.rb, line 122 def request(uri, env = {}, &block) env = env_for(uri, env) process_request(uri, env, &block) end
Private Instance Methods
# File lib/rack/test.rb, line 287 def default_env { "rack.test" => true, "REMOTE_ADDR" => "127.0.0.1" }.merge(@env).merge(headers_for_env) end
# File lib/rack/test.rb, line 283 def digest_auth_configured? @digest_username end
# File lib/rack/test.rb, line 260 def digest_auth_header challenge = last_response["WWW-Authenticate"].split(" ", 2).last params = Rack::Auth::Digest::Params.parse(challenge) params.merge!({ "username" => @digest_username, "nc" => "00000001", "cnonce" => "nonsensenonce", "uri" => last_request.fullpath, "method" => last_request.env["REQUEST_METHOD"], }) params["response"] = MockDigestRequest.new(params).response(@digest_password) "Digest #{params}" end
# File lib/rack/test.rb, line 192 def env_for(path, env) uri = URI.parse(path) uri.path = "/#{uri.path}" unless uri.path[0] == ?/ uri.host ||= @default_host env = default_env.merge(env) env["HTTP_HOST"] ||= [uri.host, (uri.port if uri.port != uri.default_port)].compact.join(":") env.update("HTTPS" => "on") if URI::HTTPS === uri env["HTTP_X_REQUESTED_WITH"] = "XMLHttpRequest" if env[:xhr] # TODO: Remove this after Rack 1.1 has been released. # Stringifying and upcasing methods has be commit upstream env["REQUEST_METHOD"] ||= env[:method] ? env[:method].to_s.upcase : "GET" if env["REQUEST_METHOD"] == "GET" # merge :params with the query string if params = env[:params] params = parse_nested_query(params) if params.is_a?(String) params.update(parse_nested_query(uri.query)) uri.query = build_nested_query(params) end elsif !env.has_key?(:input) env["CONTENT_TYPE"] ||= "application/x-www-form-urlencoded" if env[:params].is_a?(Hash) if data = build_multipart(env[:params]) env[:input] = data env["CONTENT_LENGTH"] ||= data.length.to_s env["CONTENT_TYPE"] = "multipart/form-data; boundary=#{MULTIPART_BOUNDARY}" else env[:input] = params_to_string(env[:params]) end else env[:input] = env[:params] end end env.delete(:params) if env.has_key?(:cookie) set_cookie(env.delete(:cookie), uri) end Rack::MockRequest.env_for(uri.to_s, env) end
# File lib/rack/test.rb, line 291 def headers_for_env converted_headers = {} @headers.each do |name, value| env_key = name.upcase.gsub("-", "_") env_key = "HTTP_" + env_key unless "CONTENT_TYPE" == env_key converted_headers[env_key] = value end converted_headers end
# File lib/rack/test.rb, line 303 def params_to_string(params) case params when Hash then build_nested_query(params) when nil then "" else params end end
# File lib/rack/test.rb, line 240 def process_request(uri, env) uri = URI.parse(uri) uri.host ||= @default_host @rack_mock_session.request(uri, env) if retry_with_digest_auth?(env) auth_env = env.merge({ "HTTP_AUTHORIZATION" => digest_auth_header, "rack-test.digest_auth_retry" => true }) auth_env.delete('rack.request') process_request(uri.path, auth_env) else yield last_response if block_given? last_response end end
# File lib/rack/test.rb, line 277 def retry_with_digest_auth?(env) last_response.status == 401 && digest_auth_configured? && !env["rack-test.digest_auth_retry"] end