Permalink
Browse files

Update API documentation.

  • Loading branch information...
1 parent c6c17e4 commit 1468db5e7d3754d2c44ffc22af057f86417c4d22 @FooBarWidget committed Sep 4, 2008
Showing with 15 additions and 8 deletions.
  1. +15 −8 lib/auto_redirection/testing.rb
@@ -45,7 +45,9 @@ module Testing
protected
# Performs a GET request, just like the normal +get+ method in integration
# tests (ActionController::Integration::Session#get). The last request's
- # URI will be automatically passed as the "Referer" HTTP header.
+ # URI will be automatically passed as the "Referer" HTTP header, and any
+ # redirection information that the last controller action tried to pass,
+ # will be automatically passed on.
#
# get "/books/show/1"
# # "/books/show/1" is now recorded as the referer.
@@ -62,7 +64,9 @@ def get(path, parameters = nil, headers = nil)
# Performs a POST request, just like the normal +post+ method in integration
# tests (ActionController::Integration::Session#post). The last request's
- # URI will be automatically passed as the "Referer" HTTP header.
+ # URI will be automatically passed as the "Referer" HTTP header, and any
+ # redirection information that the last controller action tried to pass,
+ # will be automatically passed on.
#
# See +get_with_referer+ for an example.
def post(path, parameters = nil, headers = nil)
@@ -72,9 +76,11 @@ def post(path, parameters = nil, headers = nil)
return result
end
- # Performs a PUT request, just like the normal +get+ method in integration
- # tests (ActionController::Integration::Session#get). The last request's
- # URI will be automatically passed as the "Referer" HTTP header.
+ # Performs a PUT request, just like the normal +put+ method in integration
+ # tests (ActionController::Integration::Session#put). The last request's
+ # URI will be automatically passed as the "Referer" HTTP header, and any
+ # redirection information that the last controller action tried to pass,
+ # will be automatically passed on.
#
# See +get_with_referer+ for an example.
def put(path, parameters = nil, headers = nil)
@@ -85,9 +91,10 @@ def put(path, parameters = nil, headers = nil)
end
# Performs a DELETE request, just like the normal +delete+ method in integration
- # tests (ActionController::Integration::Session#delete). The last recorded
- # referer will be passed as the "Referer" HTTP header. After the request,
- # the current path will be recorded as the new referer.
+ # tests (ActionController::Integration::Session#delete). The last request's
+ # URI will be automatically passed as the "Referer" HTTP header, and any
+ # redirection information that the last controller action tried to pass,
+ # will be automatically passed on.
#
# See +get_with_referer+ for an example.
def delete(path, parameters = nil, headers = nil)

0 comments on commit 1468db5

Please sign in to comment.