lockss-pyclient 0.1.0.dev1__py3-none-any.whl

lockss/pyclient/md/rest.py

@@ -0,0 +1,317 @@
+# coding: utf-8
+
+"""
+    LOCKSS Metadata Service REST API
+
+    REST API of the LOCKSS Metadata Service  # noqa: E501
+
+    OpenAPI spec version: 2.0.0
+    Contact: lockss-support@lockss.org
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+import io
+import json
+import logging
+import re
+import ssl
+
+import certifi
+# python 2 and python 3 compatibility library
+import six
+from six.moves.urllib.parse import urlencode
+
+try:
+    import urllib3
+except ImportError:
+    raise ImportError('Swagger python client requires urllib3.')
+
+
+logger = logging.getLogger(__name__)
+
+
+class RESTResponse(io.IOBase):
+
+    def __init__(self, resp):
+        self.urllib3_response = resp
+        self.status = resp.status
+        self.reason = resp.reason
+        self.data = resp.data
+
+    def getheaders(self):
+        """Returns a dictionary of the response headers."""
+        return self.urllib3_response.headers
+
+    def getheader(self, name, default=None):
+        """Returns a given response header."""
+        return self.urllib3_response.headers.get(name, default)
+
+
+class RESTClientObject(object):
+
+    def __init__(self, configuration, pools_size=4, maxsize=None):
+        # urllib3.PoolManager will pass all kw parameters to connectionpool
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75  # noqa: E501
+        # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680  # noqa: E501
+        # maxsize is the number of requests to host that are allowed in parallel  # noqa: E501
+        # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html  # noqa: E501
+
+        # cert_reqs
+        if configuration.verify_ssl:
+            cert_reqs = ssl.CERT_REQUIRED
+        else:
+            cert_reqs = ssl.CERT_NONE
+
+        # ca_certs
+        if configuration.ssl_ca_cert:
+            ca_certs = configuration.ssl_ca_cert
+        else:
+            # if not set certificate file, use Mozilla's root certificates.
+            ca_certs = certifi.where()
+
+        addition_pool_args = {}
+        if configuration.assert_hostname is not None:
+            addition_pool_args['assert_hostname'] = configuration.assert_hostname  # noqa: E501
+
+        if maxsize is None:
+            if configuration.connection_pool_maxsize is not None:
+                maxsize = configuration.connection_pool_maxsize
+            else:
+                maxsize = 4
+
+        # https pool manager
+        if configuration.proxy:
+            self.pool_manager = urllib3.ProxyManager(
+                num_pools=pools_size,
+                maxsize=maxsize,
+                cert_reqs=cert_reqs,
+                ca_certs=ca_certs,
+                cert_file=configuration.cert_file,
+                key_file=configuration.key_file,
+                proxy_url=configuration.proxy,
+                **addition_pool_args
+            )
+        else:
+            self.pool_manager = urllib3.PoolManager(
+                num_pools=pools_size,
+                maxsize=maxsize,
+                cert_reqs=cert_reqs,
+                ca_certs=ca_certs,
+                cert_file=configuration.cert_file,
+                key_file=configuration.key_file,
+                **addition_pool_args
+            )
+
+    def request(self, method, url, query_params=None, headers=None,
+                body=None, post_params=None, _preload_content=True,
+                _request_timeout=None):
+        """Perform requests.
+
+        :param method: http request method
+        :param url: http request url
+        :param query_params: query parameters in the url
+        :param headers: http request headers
+        :param body: request json body, for `application/json`
+        :param post_params: request post parameters,
+                            `application/x-www-form-urlencoded`
+                            and `multipart/form-data`
+        :param _preload_content: if False, the urllib3.HTTPResponse object will
+                                 be returned without reading/decoding response
+                                 data. Default is True.
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        """
+        method = method.upper()
+        assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT',
+                          'PATCH', 'OPTIONS']
+
+        if post_params and body:
+            raise ValueError(
+                "body parameter cannot be used with post_params parameter."
+            )
+
+        post_params = post_params or {}
+        headers = headers or {}
+
+        timeout = None
+        if _request_timeout:
+            if isinstance(_request_timeout, (int, ) if six.PY3 else (int, long)):  # noqa: E501,F821
+                timeout = urllib3.Timeout(total=_request_timeout)
+            elif (isinstance(_request_timeout, tuple) and
+                  len(_request_timeout) == 2):
+                timeout = urllib3.Timeout(
+                    connect=_request_timeout[0], read=_request_timeout[1])
+
+        if 'Content-Type' not in headers:
+            headers['Content-Type'] = 'application/json'
+
+        try:
+            # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
+            if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
+                if query_params:
+                    url += '?' + urlencode(query_params)
+                if re.search('json', headers['Content-Type'], re.IGNORECASE):
+                    request_body = '{}'
+                    if body is not None:
+                        request_body = json.dumps(body)
+                    r = self.pool_manager.request(
+                        method, url,
+                        body=request_body,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                elif headers['Content-Type'] == 'application/x-www-form-urlencoded':  # noqa: E501
+                    r = self.pool_manager.request(
+                        method, url,
+                        fields=post_params,
+                        encode_multipart=False,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                elif headers['Content-Type'] == 'multipart/form-data':
+                    # must del headers['Content-Type'], or the correct
+                    # Content-Type which generated by urllib3 will be
+                    # overwritten.
+                    del headers['Content-Type']
+                    r = self.pool_manager.request(
+                        method, url,
+                        fields=post_params,
+                        encode_multipart=True,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                # Pass a `string` parameter directly in the body to support
+                # other content types than Json when `body` argument is
+                # provided in serialized form
+                elif isinstance(body, str):
+                    request_body = body
+                    r = self.pool_manager.request(
+                        method, url,
+                        body=request_body,
+                        preload_content=_preload_content,
+                        timeout=timeout,
+                        headers=headers)
+                else:
+                    # Cannot generate the request from given parameters
+                    msg = """Cannot prepare a request message for provided
+                             arguments. Please check that your arguments match
+                             declared content type."""
+                    raise ApiException(status=0, reason=msg)
+            # For `GET`, `HEAD`
+            else:
+                r = self.pool_manager.request(method, url,
+                                              fields=query_params,
+                                              preload_content=_preload_content,
+                                              timeout=timeout,
+                                              headers=headers)
+        except urllib3.exceptions.SSLError as e:
+            msg = "{0}\n{1}".format(type(e).__name__, str(e))
+            raise ApiException(status=0, reason=msg)
+
+        if _preload_content:
+            r = RESTResponse(r)
+
+            # log response body
+            logger.debug("response body: %s", r.data)
+
+        if not 200 <= r.status <= 299:
+            raise ApiException(http_resp=r)
+
+        return r
+
+    def GET(self, url, headers=None, query_params=None, _preload_content=True,
+            _request_timeout=None):
+        return self.request("GET", url,
+                            headers=headers,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            query_params=query_params)
+
+    def HEAD(self, url, headers=None, query_params=None, _preload_content=True,
+             _request_timeout=None):
+        return self.request("HEAD", url,
+                            headers=headers,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            query_params=query_params)
+
+    def OPTIONS(self, url, headers=None, query_params=None, post_params=None,
+                body=None, _preload_content=True, _request_timeout=None):
+        return self.request("OPTIONS", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def DELETE(self, url, headers=None, query_params=None, body=None,
+               _preload_content=True, _request_timeout=None):
+        return self.request("DELETE", url,
+                            headers=headers,
+                            query_params=query_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def POST(self, url, headers=None, query_params=None, post_params=None,
+             body=None, _preload_content=True, _request_timeout=None):
+        return self.request("POST", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def PUT(self, url, headers=None, query_params=None, post_params=None,
+            body=None, _preload_content=True, _request_timeout=None):
+        return self.request("PUT", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+    def PATCH(self, url, headers=None, query_params=None, post_params=None,
+              body=None, _preload_content=True, _request_timeout=None):
+        return self.request("PATCH", url,
+                            headers=headers,
+                            query_params=query_params,
+                            post_params=post_params,
+                            _preload_content=_preload_content,
+                            _request_timeout=_request_timeout,
+                            body=body)
+
+
+class ApiException(Exception):
+
+    def __init__(self, status=None, reason=None, http_resp=None):
+        if http_resp:
+            self.status = http_resp.status
+            self.reason = http_resp.reason
+            self.body = http_resp.data
+            self.headers = http_resp.getheaders()
+        else:
+            self.status = status
+            self.reason = reason
+            self.body = None
+            self.headers = None
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = "({0})\n"\
+                        "Reason: {1}\n".format(self.status, self.reason)
+        if self.headers:
+            error_message += "HTTP response headers: {0}\n".format(
+                self.headers)
+
+        if self.body:
+            error_message += "HTTP response body: {0}\n".format(self.body)
+
+        return error_message

lockss/pyclient/poller/__init__.py

@@ -0,0 +1,54 @@
+# coding: utf-8
+
+# flake8: noqa
+
+"""
+    LOCKSS Poller Service REST API
+
+    REST API of the LOCKSS Poller Service  # noqa: E501
+
+    OpenAPI spec version: 2.0.0
+    Contact: lockss-support@lockss.org
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+# import apis into sdk package
+from lockss.pyclient.poller.api.export_api import ExportApi
+from lockss.pyclient.poller.api.hash_api import HashApi
+from lockss.pyclient.poller.api.import_api import ImportApi
+from lockss.pyclient.poller.api.poll_detail_api import PollDetailApi
+from lockss.pyclient.poller.api.poller_polls_api import PollerPollsApi
+from lockss.pyclient.poller.api.repo_api import RepoApi
+from lockss.pyclient.poller.api.service_api import ServiceApi
+from lockss.pyclient.poller.api.voter_polls_api import VoterPollsApi
+# import ApiClient
+from lockss.pyclient.poller.api_client import ApiClient
+from lockss.pyclient.poller.configuration import Configuration
+# import models into sdk package
+from lockss.pyclient.poller.models.api_status import ApiStatus
+from lockss.pyclient.poller.models.aus_import_body import AusImportBody
+from lockss.pyclient.poller.models.cached_uri_set_spec import CachedUriSetSpec
+from lockss.pyclient.poller.models.error_result import ErrorResult
+from lockss.pyclient.poller.models.hasher_ws_params import HasherWsParams
+from lockss.pyclient.poller.models.link_desc import LinkDesc
+from lockss.pyclient.poller.models.page_desc import PageDesc
+from lockss.pyclient.poller.models.peer_data import PeerData
+from lockss.pyclient.poller.models.peer_ws_result import PeerWsResult
+from lockss.pyclient.poller.models.poll_desc import PollDesc
+from lockss.pyclient.poller.models.poll_ws_result import PollWsResult
+from lockss.pyclient.poller.models.poller_detail import PollerDetail
+from lockss.pyclient.poller.models.poller_pager import PollerPager
+from lockss.pyclient.poller.models.poller_summary import PollerSummary
+from lockss.pyclient.poller.models.repair_data import RepairData
+from lockss.pyclient.poller.models.repair_pager import RepairPager
+from lockss.pyclient.poller.models.repair_queue import RepairQueue
+from lockss.pyclient.poller.models.repository_space_ws_result import RepositorySpaceWsResult
+from lockss.pyclient.poller.models.repository_ws_result import RepositoryWsResult
+from lockss.pyclient.poller.models.tally_data import TallyData
+from lockss.pyclient.poller.models.url_pager import UrlPager
+from lockss.pyclient.poller.models.vote_ws_result import VoteWsResult
+from lockss.pyclient.poller.models.voter_detail import VoterDetail
+from lockss.pyclient.poller.models.voter_pager import VoterPager
+from lockss.pyclient.poller.models.voter_summary import VoterSummary

lockss/pyclient/poller/api/__init__.py

@@ -0,0 +1,13 @@
+from __future__ import absolute_import
+
+# flake8: noqa
+
+# import apis into api package
+from lockss.pyclient.poller.api.export_api import ExportApi
+from lockss.pyclient.poller.api.hash_api import HashApi
+from lockss.pyclient.poller.api.import_api import ImportApi
+from lockss.pyclient.poller.api.poll_detail_api import PollDetailApi
+from lockss.pyclient.poller.api.poller_polls_api import PollerPollsApi
+from lockss.pyclient.poller.api.repo_api import RepoApi
+from lockss.pyclient.poller.api.service_api import ServiceApi
+from lockss.pyclient.poller.api.voter_polls_api import VoterPollsApi

lockss/pyclient/poller/api/export_api.py

@@ -0,0 +1,156 @@
+# coding: utf-8
+
+"""
+    LOCKSS Poller Service REST API
+
+    REST API of the LOCKSS Poller Service  # noqa: E501
+
+    OpenAPI spec version: 2.0.0
+    Contact: lockss-support@lockss.org
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+from __future__ import absolute_import
+
+import re  # noqa: F401
+
+# python 2 and python 3 compatibility library
+import six
+
+from lockss.pyclient.poller.api_client import ApiClient
+
+
+class ExportApi(object):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Do not edit the class manually.
+    Ref: https://github.com/swagger-api/swagger-codegen
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.api_client = api_client
+
+    def get_export_files(self, auid, **kwargs):  # noqa: E501
+        """Export artifacts in an Archival Unit  # noqa: E501
+
+        Export artifacts in an Archival Unit as a group of archives  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_export_files(auid, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str auid: Identifier of the Archival Unit containing the artifacts (required)
+        :param str file_type: The type of archive to create
+        :param bool is_compress: Indication of whether contents should be compressed
+        :param bool is_exclude_dir_nodes: Indication of whether directories should be excluded
+        :param str xlate_filenames: Type of filename translation to be done
+        :param str file_prefix: The prefix to be used to name the exported file
+        :param int max_size: The maximum size of the exported file
+        :param int max_versions: The maximum number of versions of an artifact to be exported
+        :return: str
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+        kwargs['_return_http_data_only'] = True
+        if kwargs.get('async_req'):
+            return self.get_export_files_with_http_info(auid, **kwargs)  # noqa: E501
+        else:
+            (data) = self.get_export_files_with_http_info(auid, **kwargs)  # noqa: E501
+            return data
+
+    def get_export_files_with_http_info(self, auid, **kwargs):  # noqa: E501
+        """Export artifacts in an Archival Unit  # noqa: E501
+
+        Export artifacts in an Archival Unit as a group of archives  # noqa: E501
+        This method makes a synchronous HTTP request by default. To make an
+        asynchronous HTTP request, please pass async_req=True
+        >>> thread = api.get_export_files_with_http_info(auid, async_req=True)
+        >>> result = thread.get()
+
+        :param async_req bool
+        :param str auid: Identifier of the Archival Unit containing the artifacts (required)
+        :param str file_type: The type of archive to create
+        :param bool is_compress: Indication of whether contents should be compressed
+        :param bool is_exclude_dir_nodes: Indication of whether directories should be excluded
+        :param str xlate_filenames: Type of filename translation to be done
+        :param str file_prefix: The prefix to be used to name the exported file
+        :param int max_size: The maximum size of the exported file
+        :param int max_versions: The maximum number of versions of an artifact to be exported
+        :return: str
+                 If the method is called asynchronously,
+                 returns the request thread.
+        """
+
+        all_params = ['auid', 'file_type', 'is_compress', 'is_exclude_dir_nodes', 'xlate_filenames', 'file_prefix', 'max_size', 'max_versions']  # noqa: E501
+        all_params.append('async_req')
+        all_params.append('_return_http_data_only')
+        all_params.append('_preload_content')
+        all_params.append('_request_timeout')
+
+        params = locals()
+        for key, val in six.iteritems(params['kwargs']):
+            if key not in all_params:
+                raise TypeError(
+                    "Got an unexpected keyword argument '%s'"
+                    " to method get_export_files" % key
+                )
+            params[key] = val
+        del params['kwargs']
+        # verify the required parameter 'auid' is set
+        if ('auid' not in params or
+                params['auid'] is None):
+            raise ValueError("Missing the required parameter `auid` when calling `get_export_files`")  # noqa: E501
+
+        collection_formats = {}
+
+        path_params = {}
+        if 'auid' in params:
+            path_params['auid'] = params['auid']  # noqa: E501
+
+        query_params = []
+        if 'file_type' in params:
+            query_params.append(('fileType', params['file_type']))  # noqa: E501
+        if 'is_compress' in params:
+            query_params.append(('isCompress', params['is_compress']))  # noqa: E501
+        if 'is_exclude_dir_nodes' in params:
+            query_params.append(('isExcludeDirNodes', params['is_exclude_dir_nodes']))  # noqa: E501
+        if 'xlate_filenames' in params:
+            query_params.append(('xlateFilenames', params['xlate_filenames']))  # noqa: E501
+        if 'file_prefix' in params:
+            query_params.append(('filePrefix', params['file_prefix']))  # noqa: E501
+        if 'max_size' in params:
+            query_params.append(('maxSize', params['max_size']))  # noqa: E501
+        if 'max_versions' in params:
+            query_params.append(('maxVersions', params['max_versions']))  # noqa: E501
+
+        header_params = {}
+
+        form_params = []
+        local_var_files = {}
+
+        body_params = None
+        # HTTP header `Accept`
+        header_params['Accept'] = self.api_client.select_header_accept(
+            ['multipart/form-data', 'application/json'])  # noqa: E501
+
+        # Authentication setting
+        auth_settings = ['basicAuth']  # noqa: E501
+
+        return self.api_client.call_api(
+            '/aus/{auid}/export', 'GET',
+            path_params,
+            query_params,
+            header_params,
+            body=body_params,
+            post_params=form_params,
+            files=local_var_files,
+            response_type='str',  # noqa: E501
+            auth_settings=auth_settings,
+            async_req=params.get('async_req'),
+            _return_http_data_only=params.get('_return_http_data_only'),
+            _preload_content=params.get('_preload_content', True),
+            _request_timeout=params.get('_request_timeout'),
+            collection_formats=collection_formats)