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

lockss/pyclient/config/models/tdb_title_ws_result.py

@@ -0,0 +1,390 @@
+# coding: utf-8
+
+"""
+    LOCKSS Configuration Service REST API
+
+    REST API of the LOCKSS Configuration Service  # noqa: E501
+
+    OpenAPI spec version: 2.0.0
+    Contact: lockss-support@lockss.org
+    Generated by: https://github.com/swagger-api/swagger-codegen.git
+"""
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+class TdbTitleWsResult(object):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Do not edit the class manually.
+    """
+    """
+    Attributes:
+      swagger_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    swagger_types = {
+        'name': 'str',
+        'tdb_publisher': 'TdbPublisherWsResult',
+        'id': 'str',
+        'proprietaryid': 'str',
+        'proprietaryids': 'list[str]',
+        'publicationtype': 'str',
+        'issn': 'str',
+        'issnl': 'str',
+        'eissn': 'str',
+        'printissn': 'str',
+        'issns': 'list[str]'
+    }
+
+    attribute_map = {
+        'name': 'name',
+        'tdb_publisher': 'tdbPublisher',
+        'id': 'id',
+        'proprietaryid': 'proprietaryid',
+        'proprietaryids': 'proprietaryids',
+        'publicationtype': 'publicationtype',
+        'issn': 'issn',
+        'issnl': 'issnl',
+        'eissn': 'eissn',
+        'printissn': 'printissn',
+        'issns': 'issns'
+    }
+
+    def __init__(self, name=None, tdb_publisher=None, id=None, proprietaryid=None, proprietaryids=None, publicationtype=None, issn=None, issnl=None, eissn=None, printissn=None, issns=None):  # noqa: E501
+        """TdbTitleWsResult - a model defined in Swagger"""  # noqa: E501
+        self._name = None
+        self._tdb_publisher = None
+        self._id = None
+        self._proprietaryid = None
+        self._proprietaryids = None
+        self._publicationtype = None
+        self._issn = None
+        self._issnl = None
+        self._eissn = None
+        self._printissn = None
+        self._issns = None
+        self.discriminator = None
+        if name is not None:
+            self.name = name
+        if tdb_publisher is not None:
+            self.tdb_publisher = tdb_publisher
+        if id is not None:
+            self.id = id
+        if proprietaryid is not None:
+            self.proprietaryid = proprietaryid
+        if proprietaryids is not None:
+            self.proprietaryids = proprietaryids
+        if publicationtype is not None:
+            self.publicationtype = publicationtype
+        if issn is not None:
+            self.issn = issn
+        if issnl is not None:
+            self.issnl = issnl
+        if eissn is not None:
+            self.eissn = eissn
+        if printissn is not None:
+            self.printissn = printissn
+        if issns is not None:
+            self.issns = issns
+
+    @property
+    def name(self):
+        """Gets the name of this TdbTitleWsResult.  # noqa: E501
+
+        The name of the TDB Title  # noqa: E501
+
+        :return: The name of this TdbTitleWsResult.  # noqa: E501
+        :rtype: str
+        """
+        return self._name
+
+    @name.setter
+    def name(self, name):
+        """Sets the name of this TdbTitleWsResult.
+
+        The name of the TDB Title  # noqa: E501
+
+        :param name: The name of this TdbTitleWsResult.  # noqa: E501
+        :type: str
+        """
+
+        self._name = name
+
+    @property
+    def tdb_publisher(self):
+        """Gets the tdb_publisher of this TdbTitleWsResult.  # noqa: E501
+
+
+        :return: The tdb_publisher of this TdbTitleWsResult.  # noqa: E501
+        :rtype: TdbPublisherWsResult
+        """
+        return self._tdb_publisher
+
+    @tdb_publisher.setter
+    def tdb_publisher(self, tdb_publisher):
+        """Sets the tdb_publisher of this TdbTitleWsResult.
+
+
+        :param tdb_publisher: The tdb_publisher of this TdbTitleWsResult.  # noqa: E501
+        :type: TdbPublisherWsResult
+        """
+
+        self._tdb_publisher = tdb_publisher
+
+    @property
+    def id(self):
+        """Gets the id of this TdbTitleWsResult.  # noqa: E501
+
+        The identifier of the TDB Title  # noqa: E501
+
+        :return: The id of this TdbTitleWsResult.  # noqa: E501
+        :rtype: str
+        """
+        return self._id
+
+    @id.setter
+    def id(self, id):
+        """Sets the id of this TdbTitleWsResult.
+
+        The identifier of the TDB Title  # noqa: E501
+
+        :param id: The id of this TdbTitleWsResult.  # noqa: E501
+        :type: str
+        """
+
+        self._id = id
+
+    @property
+    def proprietaryid(self):
+        """Gets the proprietaryid of this TdbTitleWsResult.  # noqa: E501
+
+        The proprietary identifier of the TDB Title  # noqa: E501
+
+        :return: The proprietaryid of this TdbTitleWsResult.  # noqa: E501
+        :rtype: str
+        """
+        return self._proprietaryid
+
+    @proprietaryid.setter
+    def proprietaryid(self, proprietaryid):
+        """Sets the proprietaryid of this TdbTitleWsResult.
+
+        The proprietary identifier of the TDB Title  # noqa: E501
+
+        :param proprietaryid: The proprietaryid of this TdbTitleWsResult.  # noqa: E501
+        :type: str
+        """
+
+        self._proprietaryid = proprietaryid
+
+    @property
+    def proprietaryids(self):
+        """Gets the proprietaryids of this TdbTitleWsResult.  # noqa: E501
+
+        The proprietary identifiers of the TDB Title  # noqa: E501
+
+        :return: The proprietaryids of this TdbTitleWsResult.  # noqa: E501
+        :rtype: list[str]
+        """
+        return self._proprietaryids
+
+    @proprietaryids.setter
+    def proprietaryids(self, proprietaryids):
+        """Sets the proprietaryids of this TdbTitleWsResult.
+
+        The proprietary identifiers of the TDB Title  # noqa: E501
+
+        :param proprietaryids: The proprietaryids of this TdbTitleWsResult.  # noqa: E501
+        :type: list[str]
+        """
+
+        self._proprietaryids = proprietaryids
+
+    @property
+    def publicationtype(self):
+        """Gets the publicationtype of this TdbTitleWsResult.  # noqa: E501
+
+        The publication type of the TDB Title  # noqa: E501
+
+        :return: The publicationtype of this TdbTitleWsResult.  # noqa: E501
+        :rtype: str
+        """
+        return self._publicationtype
+
+    @publicationtype.setter
+    def publicationtype(self, publicationtype):
+        """Sets the publicationtype of this TdbTitleWsResult.
+
+        The publication type of the TDB Title  # noqa: E501
+
+        :param publicationtype: The publicationtype of this TdbTitleWsResult.  # noqa: E501
+        :type: str
+        """
+
+        self._publicationtype = publicationtype
+
+    @property
+    def issn(self):
+        """Gets the issn of this TdbTitleWsResult.  # noqa: E501
+
+        The ISSN of the TDB Title  # noqa: E501
+
+        :return: The issn of this TdbTitleWsResult.  # noqa: E501
+        :rtype: str
+        """
+        return self._issn
+
+    @issn.setter
+    def issn(self, issn):
+        """Sets the issn of this TdbTitleWsResult.
+
+        The ISSN of the TDB Title  # noqa: E501
+
+        :param issn: The issn of this TdbTitleWsResult.  # noqa: E501
+        :type: str
+        """
+
+        self._issn = issn
+
+    @property
+    def issnl(self):
+        """Gets the issnl of this TdbTitleWsResult.  # noqa: E501
+
+        The ISSNL of the TDB Title  # noqa: E501
+
+        :return: The issnl of this TdbTitleWsResult.  # noqa: E501
+        :rtype: str
+        """
+        return self._issnl
+
+    @issnl.setter
+    def issnl(self, issnl):
+        """Sets the issnl of this TdbTitleWsResult.
+
+        The ISSNL of the TDB Title  # noqa: E501
+
+        :param issnl: The issnl of this TdbTitleWsResult.  # noqa: E501
+        :type: str
+        """
+
+        self._issnl = issnl
+
+    @property
+    def eissn(self):
+        """Gets the eissn of this TdbTitleWsResult.  # noqa: E501
+
+        The eISSN of the TDB Title  # noqa: E501
+
+        :return: The eissn of this TdbTitleWsResult.  # noqa: E501
+        :rtype: str
+        """
+        return self._eissn
+
+    @eissn.setter
+    def eissn(self, eissn):
+        """Sets the eissn of this TdbTitleWsResult.
+
+        The eISSN of the TDB Title  # noqa: E501
+
+        :param eissn: The eissn of this TdbTitleWsResult.  # noqa: E501
+        :type: str
+        """
+
+        self._eissn = eissn
+
+    @property
+    def printissn(self):
+        """Gets the printissn of this TdbTitleWsResult.  # noqa: E501
+
+        The print ISSN of the TDB Title  # noqa: E501
+
+        :return: The printissn of this TdbTitleWsResult.  # noqa: E501
+        :rtype: str
+        """
+        return self._printissn
+
+    @printissn.setter
+    def printissn(self, printissn):
+        """Sets the printissn of this TdbTitleWsResult.
+
+        The print ISSN of the TDB Title  # noqa: E501
+
+        :param printissn: The printissn of this TdbTitleWsResult.  # noqa: E501
+        :type: str
+        """
+
+        self._printissn = printissn
+
+    @property
+    def issns(self):
+        """Gets the issns of this TdbTitleWsResult.  # noqa: E501
+
+        The ISSNs of the TDB Title  # noqa: E501
+
+        :return: The issns of this TdbTitleWsResult.  # noqa: E501
+        :rtype: list[str]
+        """
+        return self._issns
+
+    @issns.setter
+    def issns(self, issns):
+        """Sets the issns of this TdbTitleWsResult.
+
+        The ISSNs of the TDB Title  # noqa: E501
+
+        :param issns: The issns of this TdbTitleWsResult.  # noqa: E501
+        :type: list[str]
+        """
+
+        self._issns = issns
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.swagger_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+        if issubclass(TdbTitleWsResult, dict):
+            for key, value in self.items():
+                result[key] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, TdbTitleWsResult):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other

lockss/pyclient/config/rest.py

@@ -0,0 +1,317 @@
+# coding: utf-8
+
+"""
+    LOCKSS Configuration Service REST API
+
+    REST API of the LOCKSS Configuration 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