1
0
Fork 0
mirror of https://github.com/rest-client/rest-client.git synced 2022-11-09 13:49:40 -05:00

rdocs for RequestFailed

This commit is contained in:
Adam Wiggins 2008-06-20 19:09:57 -07:00
parent 6315a184f5
commit e8d0d84bd9

View file

@ -7,7 +7,15 @@ module RestClient
# Authorization is required to access the resource specified.
class Unauthorized < RuntimeError; end
# Request failed with an unhandled http error code.
# The request failed, meaning the remote HTTP server returned a code other
# than success, unauthorized, or redirect.
#
# The exception message attempts to extract the error from the XML, using
# format returned by Rails: <errors><error>some message</error></errors>
#
# You can get the status code by e.http_code, or see anything about the
# response via e.response. For example, the entire result body (which is
# probably an HTML error page) is e.response.body.
class RequestFailed < RuntimeError
attr_accessor :response
@ -31,7 +39,7 @@ module RestClient
end
end
# for backwards compatibility
# backwards compatibility
RestClient::Resource::Redirect = RestClient::Redirect
RestClient::Resource::Unauthorized = RestClient::Unauthorized
RestClient::Resource::RequestFailed = RestClient::RequestFailed