diff options
author | Tyler Jones <tyler@gumstix.com> | 2013-08-01 11:11:10 -0700 |
---|---|---|
committer | Tyler Jones <tyler@gumstix.com> | 2013-08-01 11:11:10 -0700 |
commit | c4a6c31ba9748947462e8e31e106215cca1d3cc9 (patch) | |
tree | 71fb95b2f9758527bc1ee17e66efd17f98780c30 /oauthlib/oauth1 | |
parent | 6efc8c04e46d5a731962e2fae9b9599097c5a2d4 (diff) | |
download | oauthlib-c4a6c31ba9748947462e8e31e106215cca1d3cc9.tar.gz |
#199 Proposed API changes for endpoints.
Diffstat (limited to 'oauthlib/oauth1')
-rw-r--r-- | oauthlib/oauth1/rfc5849/endpoints/access_token.py | 17 | ||||
-rw-r--r-- | oauthlib/oauth1/rfc5849/endpoints/authorization.py | 17 | ||||
-rw-r--r-- | oauthlib/oauth1/rfc5849/endpoints/request_token.py | 17 |
3 files changed, 21 insertions, 30 deletions
diff --git a/oauthlib/oauth1/rfc5849/endpoints/access_token.py b/oauthlib/oauth1/rfc5849/endpoints/access_token.py index 9950d5b..e5f43fa 100644 --- a/oauthlib/oauth1/rfc5849/endpoints/access_token.py +++ b/oauthlib/oauth1/rfc5849/endpoints/access_token.py @@ -58,17 +58,16 @@ class AccessTokenEndpoint(BaseEndpoint): :param headers: The request headers as a dict. :param credentials: A list of extra credentials to include in the token. :returns: A tuple of 4 elements. - 1. None (uri but n/a for this endpoint, here for consistency. - 2. A dict of headers to set on the response. - 3. The response body as a string. - 4. The response status code as an integer. + 1. A dict of headers to set on the response. + 2. The response body as a string. + 3. The response status code as an integer. An example of a valid request:: >>> from your_validator import your_validator >>> from oauthlib.oauth1 import AccessTokenEndpoint >>> endpoint = AccessTokenEndpoint(your_validator) - >>> u, h, b, s = endpoint.create_access_token_response( + >>> h, b, s = endpoint.create_access_token_response( ... 'https://your.provider/access_token?foo=bar', ... headers={ ... 'Authorization': 'OAuth oauth_token=234lsdkf....' @@ -76,8 +75,6 @@ class AccessTokenEndpoint(BaseEndpoint): ... credentials={ ... 'my_specific': 'argument', ... }) - >>> u - None >>> h {'Content-Type': 'application/x-www-form-urlencoded'} >>> b @@ -106,11 +103,11 @@ class AccessTokenEndpoint(BaseEndpoint): request) if valid: token = self.create_access_token(request, credentials or {}) - return None, resp_headers, token, 200 + return resp_headers, token, 200 else: - return None, {}, None, 401 + return {}, None, 401 except errors.OAuth1Error as e: - return None, resp_headers, e.urlencoded, e.status_code + return resp_headers, e.urlencoded, e.status_code def validate_access_token_request(self, request): """Validate an access token request. diff --git a/oauthlib/oauth1/rfc5849/endpoints/authorization.py b/oauthlib/oauth1/rfc5849/endpoints/authorization.py index cb3d173..7880711 100644 --- a/oauthlib/oauth1/rfc5849/endpoints/authorization.py +++ b/oauthlib/oauth1/rfc5849/endpoints/authorization.py @@ -63,17 +63,16 @@ class AuthorizationEndpoint(BaseEndpoint): :param headers: The request headers as a dict. :param credentials: A list of credentials to include in the verifier. :returns: A tuple of 4 elements. - 1. The URI to be used to redirect the user back to client. - 2. A dict of headers to set on the response. - 3. The response body as a string. - 4. The response status code as an integer. + 1. A dict of headers to set on the response. + 2. The response body as a string. + 3. The response status code as an integer. An example of a valid request:: >>> from your_validator import your_validator >>> from oauthlib.oauth1 import RequestTokenEndpoint >>> endpoint = RequestTokenEndpoint(your_validator) - >>> u, h, b, s = endpoint.create_request_token_response( + >>> h, b, s = endpoint.create_request_token_response( ... 'https://your.provider/request_token?foo=bar', ... headers={ ... 'Authorization': 'OAuth realm=movies user, oauth_....' @@ -81,10 +80,8 @@ class AuthorizationEndpoint(BaseEndpoint): ... credentials={ ... 'extra': 'argument', ... }) - >>> u - 'https://the.client/callback?oauth_verifier=...&mextra=argument' >>> h - {} + {'Location': 'https://the.client/callback?oauth_verifier=...&mextra=argument'} >>> b '' >>> s @@ -113,10 +110,10 @@ class AuthorizationEndpoint(BaseEndpoint): if redirect_uri == 'oob': response_headers = {'Content-Type': 'application/x-www-form-urlencoded'} response_body = urlencode(verifier) - return None, response_headers, response_body, 200 + return response_headers, response_body, 200 else: populated_redirect = add_params_to_uri(redirect_uri, verifier.items()) - return populated_redirect, {}, None, 302 + return {'Location': populated_redirect}, None, 302 def get_realms_and_credentials(self, uri, http_method='GET', body=None, headers=None): diff --git a/oauthlib/oauth1/rfc5849/endpoints/request_token.py b/oauthlib/oauth1/rfc5849/endpoints/request_token.py index 2956bcc..dcffd8e 100644 --- a/oauthlib/oauth1/rfc5849/endpoints/request_token.py +++ b/oauthlib/oauth1/rfc5849/endpoints/request_token.py @@ -52,17 +52,16 @@ class RequestTokenEndpoint(BaseEndpoint): :param headers: The request headers as a dict. :param credentials: A list of extra credentials to include in the token. :returns: A tuple of 4 elements. - 1. None (uri but n/a for this endpoint, here for consistency. - 2. A dict of headers to set on the response. - 3. The response body as a string. - 4. The response status code as an integer. + 1. A dict of headers to set on the response. + 2. The response body as a string. + 3. The response status code as an integer. An example of a valid request:: >>> from your_validator import your_validator >>> from oauthlib.oauth1 import RequestTokenEndpoint >>> endpoint = RequestTokenEndpoint(your_validator) - >>> u, h, b, s = endpoint.create_request_token_response( + >>> h, b, s = endpoint.create_request_token_response( ... 'https://your.provider/request_token?foo=bar', ... headers={ ... 'Authorization': 'OAuth realm=movies user, oauth_....' @@ -70,8 +69,6 @@ class RequestTokenEndpoint(BaseEndpoint): ... credentials={ ... 'my_specific': 'argument', ... }) - >>> u - None >>> h {'Content-Type': 'application/x-www-form-urlencoded'} >>> b @@ -100,11 +97,11 @@ class RequestTokenEndpoint(BaseEndpoint): request) if valid: token = self.create_request_token(request, credentials or {}) - return None, resp_headers, token, 200 + return resp_headers, token, 200 else: - return None, {}, None, 401 + return {}, None, 401 except errors.OAuth1Error as e: - return None, resp_headers, e.urlencoded, e.status_code + return resp_headers, e.urlencoded, e.status_code def validate_request_token_request(self, request): """Validate a request token request. |