diff options
Diffstat (limited to 'pygerrit/rest')
| -rw-r--r-- | pygerrit/rest/__init__.py | 149 | ||||
| -rw-r--r-- | pygerrit/rest/auth.py | 56 |
2 files changed, 0 insertions, 205 deletions
diff --git a/pygerrit/rest/__init__.py b/pygerrit/rest/__init__.py deleted file mode 100644 index cccfa94..0000000 --- a/pygerrit/rest/__init__.py +++ /dev/null @@ -1,149 +0,0 @@ -# The MIT License -# -# Copyright 2013 Sony Mobile Communications. All rights reserved. -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. - -""" Interface to the Gerrit REST API. """ - -import json -import logging -import requests - -GERRIT_MAGIC_JSON_PREFIX = ")]}\'\n" -GERRIT_AUTH_SUFFIX = "/a" - - -def _decode_response(response): - """ Decode the `response` received from a REST API call. - - Strip off Gerrit's magic prefix if it is there, and return decoded - JSON content or raw text if it cannot be decoded as JSON. - - Raise requests.HTTPError if the response contains an HTTP error status - code. - - """ - response.raise_for_status() - content = response.content - if content.startswith(GERRIT_MAGIC_JSON_PREFIX): - content = content[len(GERRIT_MAGIC_JSON_PREFIX):] - try: - return json.loads(content) - except ValueError: - return content.strip() - - -class GerritRestAPI(object): - - """ Interface to the Gerrit REST API. """ - - def __init__(self, url, auth=None, verify=True): - """ Constructor. - - `url` is assumed to be the full URL to the server, including the - 'http(s)://' prefix. - - If `auth` is specified, it must be a derivation of the `AuthBase` - class from the `requests` module. The `url` will be adjusted if - necessary to make sure it includes Gerrit's authentication suffix. - - If `verify` is False, the underlying requests library will be - configured to not attempt to verify SSL certificates. - - """ - self.kwargs = {'auth': auth, - 'verify': verify} - self.url = url.rstrip('/') - self.session = requests.session() - - if auth: - if not isinstance(auth, requests.auth.AuthBase): - raise ValueError('Invalid auth type; must be derived ' - 'from requests.auth.AuthBase') - - if not self.url.endswith(GERRIT_AUTH_SUFFIX): - self.url += GERRIT_AUTH_SUFFIX - else: - if self.url.endswith(GERRIT_AUTH_SUFFIX): - self.url = self.url[: - len(GERRIT_AUTH_SUFFIX)] - - if not self.url.endswith('/'): - self.url += '/' - logging.debug("url %s", self.url) - - def make_url(self, endpoint): - """ Make the necessary url from `endpoint`. - - Strip leading slashes off the endpoint, and return the full - url. - - Raise requests.RequestException on timeout or connection error. - - """ - endpoint = endpoint.lstrip('/') - return self.url + endpoint - - def get(self, endpoint, **kwargs): - """ Send HTTP GET to `endpoint`. - - Return JSON decoded result. - - Raise requests.RequestException on timeout or connection error. - - """ - kwargs.update(self.kwargs.copy()) - response = self.session.get(self.make_url(endpoint), **kwargs) - return _decode_response(response) - - def put(self, endpoint, **kwargs): - """ Send HTTP PUT to `endpoint`. - - Return JSON decoded result. - - Raise requests.RequestException on timeout or connection error. - - """ - kwargs.update(self.kwargs.copy()) - response = self.session.put(self.make_url(endpoint), **kwargs) - return _decode_response(response) - - def post(self, endpoint, **kwargs): - """ Send HTTP POST to `endpoint`. - - Return JSON decoded result. - - Raise requests.RequestException on timeout or connection error. - - """ - kwargs.update(self.kwargs.copy()) - response = self.session.post(self.make_url(endpoint), **kwargs) - return _decode_response(response) - - def delete(self, endpoint, **kwargs): - """ Send HTTP DELETE to `endpoint`. - - Return JSON decoded result. - - Raise requests.RequestException on timeout or connection error. - - """ - kwargs.update(self.kwargs.copy()) - response = self.session.delete(self.make_url(endpoint), **kwargs) - return _decode_response(response) diff --git a/pygerrit/rest/auth.py b/pygerrit/rest/auth.py deleted file mode 100644 index c43c3fa..0000000 --- a/pygerrit/rest/auth.py +++ /dev/null @@ -1,56 +0,0 @@ -# The MIT License -# -# Copyright 2013 Sony Mobile Communications. All rights reserved. -# -# Permission is hereby granted, free of charge, to any person obtaining a copy -# of this software and associated documentation files (the "Software"), to deal -# in the Software without restriction, including without limitation the rights -# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -# copies of the Software, and to permit persons to whom the Software is -# furnished to do so, subject to the following conditions: -# -# The above copyright notice and this permission notice shall be included in -# all copies or substantial portions of the Software. -# -# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN -# THE SOFTWARE. - -""" Authentication classes. """ - -from requests.auth import HTTPDigestAuth, HTTPBasicAuth -from requests.utils import get_netrc_auth - - -class HTTPDigestAuthFromNetrc(HTTPDigestAuth): - - """ HTTP Digest Auth with netrc credentials. """ - - def __init__(self, url): - auth = get_netrc_auth(url) - if not auth: - raise ValueError("netrc missing or no credentials found in netrc") - username, password = auth - super(HTTPDigestAuthFromNetrc, self).__init__(username, password) - - def __call__(self, req): - return super(HTTPDigestAuthFromNetrc, self).__call__(req) - - -class HTTPBasicAuthFromNetrc(HTTPBasicAuth): - - """ HTTP Basic Auth with netrc credentials. """ - - def __init__(self, url): - auth = get_netrc_auth(url) - if not auth: - raise ValueError("netrc missing or no credentials found in netrc") - username, password = auth - super(HTTPBasicAuthFromNetrc, self).__init__(username, password) - - def __call__(self, req): - return super(HTTPBasicAuthFromNetrc, self).__call__(req) |