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

lockss/pyclient/crawler/configuration.py

@@ -0,0 +1,254 @@
+# coding: utf-8
+
+"""
+    LOCKSS Crawler Service REST API
+
+    REST API of the LOCKSS Crawler 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 copy
+import logging
+import multiprocessing
+import sys
+import urllib3
+
+import six
+from six.moves import http_client as httplib
+
+
+class TypeWithDefault(type):
+    def __init__(cls, name, bases, dct):
+        super(TypeWithDefault, cls).__init__(name, bases, dct)
+        cls._default = None
+
+    def __call__(cls):
+        if cls._default is None:
+            cls._default = type.__call__(cls)
+        return copy.copy(cls._default)
+
+    def set_default(cls, default):
+        cls._default = copy.copy(default)
+
+
+class Configuration(six.with_metaclass(TypeWithDefault, object)):
+    """NOTE: This class is auto generated by the swagger code generator program.
+
+    Ref: https://github.com/swagger-api/swagger-codegen
+    Do not edit the class manually.
+    """
+
+    def __init__(self):
+        """Constructor"""
+        # Default Base url
+        self.host = "https://laaws.lockss.org:443/"
+        # Temp file folder for downloading files
+        self.temp_folder_path = None
+
+        # Authentication Settings
+        # dict to store API key(s)
+        self.api_key = {}
+        # dict to store API prefix (e.g. Bearer)
+        self.api_key_prefix = {}
+        # function to refresh API key if expired
+        self.refresh_api_key_hook = None
+        # Username for HTTP basic authentication
+        self.username = ""
+        # Password for HTTP basic authentication
+        self.password = ""
+        # Logging Settings
+        self.logger = {}
+        self.logger["package_logger"] = logging.getLogger("lockss.pyclient.crawler")
+        self.logger["urllib3_logger"] = logging.getLogger("urllib3")
+        # Log format
+        self.logger_format = '%(asctime)s %(levelname)s %(message)s'
+        # Log stream handler
+        self.logger_stream_handler = None
+        # Log file handler
+        self.logger_file_handler = None
+        # Debug file location
+        self.logger_file = None
+        # Debug switch
+        self.debug = False
+
+        # SSL/TLS verification
+        # Set this to false to skip verifying SSL certificate when calling API
+        # from https server.
+        self.verify_ssl = True
+        # Set this to customize the certificate file to verify the peer.
+        self.ssl_ca_cert = None
+        # client certificate file
+        self.cert_file = None
+        # client key file
+        self.key_file = None
+        # Set this to True/False to enable/disable SSL hostname verification.
+        self.assert_hostname = None
+
+        # urllib3 connection pool's maximum number of connections saved
+        # per pool. urllib3 uses 1 connection as default value, but this is
+        # not the best value when you are making a lot of possibly parallel
+        # requests to the same host, which is often the case here.
+        # cpu_count * 5 is used as default value to increase performance.
+        self.connection_pool_maxsize = multiprocessing.cpu_count() * 5
+
+        # Proxy URL
+        self.proxy = None
+        # Safe chars for path_param
+        self.safe_chars_for_path_param = ''
+
+    @property
+    def logger_file(self):
+        """The logger file.
+
+        If the logger_file is None, then add stream handler and remove file
+        handler. Otherwise, add file handler and remove stream handler.
+
+        :param value: The logger_file path.
+        :type: str
+        """
+        return self.__logger_file
+
+    @logger_file.setter
+    def logger_file(self, value):
+        """The logger file.
+
+        If the logger_file is None, then add stream handler and remove file
+        handler. Otherwise, add file handler and remove stream handler.
+
+        :param value: The logger_file path.
+        :type: str
+        """
+        self.__logger_file = value
+        if self.__logger_file:
+            # If set logging file,
+            # then add file handler and remove stream handler.
+            self.logger_file_handler = logging.FileHandler(self.__logger_file)
+            self.logger_file_handler.setFormatter(self.logger_formatter)
+            for _, logger in six.iteritems(self.logger):
+                logger.addHandler(self.logger_file_handler)
+                if self.logger_stream_handler:
+                    logger.removeHandler(self.logger_stream_handler)
+        else:
+            # If not set logging file,
+            # then add stream handler and remove file handler.
+            self.logger_stream_handler = logging.StreamHandler()
+            self.logger_stream_handler.setFormatter(self.logger_formatter)
+            for _, logger in six.iteritems(self.logger):
+                logger.addHandler(self.logger_stream_handler)
+                if self.logger_file_handler:
+                    logger.removeHandler(self.logger_file_handler)
+
+    @property
+    def debug(self):
+        """Debug status
+
+        :param value: The debug status, True or False.
+        :type: bool
+        """
+        return self.__debug
+
+    @debug.setter
+    def debug(self, value):
+        """Debug status
+
+        :param value: The debug status, True or False.
+        :type: bool
+        """
+        self.__debug = value
+        if self.__debug:
+            # if debug status is True, turn on debug logging
+            for _, logger in six.iteritems(self.logger):
+                logger.setLevel(logging.DEBUG)
+            # turn on httplib debug
+            httplib.HTTPConnection.debuglevel = 1
+        else:
+            # if debug status is False, turn off debug logging,
+            # setting log level to default `logging.WARNING`
+            for _, logger in six.iteritems(self.logger):
+                logger.setLevel(logging.WARNING)
+            # turn off httplib debug
+            httplib.HTTPConnection.debuglevel = 0
+
+    @property
+    def logger_format(self):
+        """The logger format.
+
+        The logger_formatter will be updated when sets logger_format.
+
+        :param value: The format string.
+        :type: str
+        """
+        return self.__logger_format
+
+    @logger_format.setter
+    def logger_format(self, value):
+        """The logger format.
+
+        The logger_formatter will be updated when sets logger_format.
+
+        :param value: The format string.
+        :type: str
+        """
+        self.__logger_format = value
+        self.logger_formatter = logging.Formatter(self.__logger_format)
+
+    def get_api_key_with_prefix(self, identifier):
+        """Gets API key (with prefix if set).
+
+        :param identifier: The identifier of apiKey.
+        :return: The token for api key authentication.
+        """
+        if self.refresh_api_key_hook:
+            self.refresh_api_key_hook(self)
+
+        key = self.api_key.get(identifier)
+        if key:
+            prefix = self.api_key_prefix.get(identifier)
+            if prefix:
+                return "%s %s" % (prefix, key)
+            else:
+                return key
+
+    def get_basic_auth_token(self):
+        """Gets HTTP basic authentication header (string).
+
+        :return: The token for basic HTTP authentication.
+        """
+        token = ""
+        if self.username or self.password:
+            token = urllib3.util.make_headers(
+                basic_auth=self.username + ':' + self.password
+            ).get('authorization')
+        return token
+
+    def auth_settings(self):
+        """Gets Auth Settings dict for api client.
+
+        :return: The Auth Settings information dict.
+        """
+        return {
+            'basicAuth':
+                {
+                    'type': 'basic',
+                    'in': 'header',
+                    'key': 'Authorization',
+                    'value': self.get_basic_auth_token()
+                },
+        }
+
+    def to_debug_report(self):
+        """Gets the essential information for debugging.
+
+        :return: The report for debugging.
+        """
+        return "Python SDK Debug Report:\n"\
+               "OS: {env}\n"\
+               "Python Version: {pyversion}\n"\
+               "Version of the API: 2.0.0\n"\
+               "SDK Package Version: 1.0.0".\
+               format(env=sys.platform, pyversion=sys.version)

lockss/pyclient/crawler/models/__init__.py

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+    LOCKSS Crawler Service REST API
+
+    REST API of the LOCKSS Crawler 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 models into model package
+from lockss.pyclient.crawler.models.api_status import ApiStatus
+from lockss.pyclient.crawler.models.counter import Counter
+from lockss.pyclient.crawler.models.crawl_desc import CrawlDesc
+from lockss.pyclient.crawler.models.crawl_job import CrawlJob
+from lockss.pyclient.crawler.models.crawl_pager import CrawlPager
+from lockss.pyclient.crawler.models.crawl_status import CrawlStatus
+from lockss.pyclient.crawler.models.crawl_ws_result import CrawlWsResult
+from lockss.pyclient.crawler.models.crawl_ws_result_pages_with_errors import CrawlWsResultPagesWithErrors
+from lockss.pyclient.crawler.models.crawler_config import CrawlerConfig
+from lockss.pyclient.crawler.models.crawler_status import CrawlerStatus
+from lockss.pyclient.crawler.models.crawler_statuses import CrawlerStatuses
+from lockss.pyclient.crawler.models.error_result import ErrorResult
+from lockss.pyclient.crawler.models.job_pager import JobPager
+from lockss.pyclient.crawler.models.job_status import JobStatus
+from lockss.pyclient.crawler.models.mime_counter import MimeCounter
+from lockss.pyclient.crawler.models.page_info import PageInfo
+from lockss.pyclient.crawler.models.url_error import UrlError
+from lockss.pyclient.crawler.models.url_info import UrlInfo
+from lockss.pyclient.crawler.models.url_pager import UrlPager

lockss/pyclient/crawler/models/api_status.py

@@ -0,0 +1,344 @@
+# coding: utf-8
+
+"""
+    LOCKSS Crawler Service REST API
+
+    REST API of the LOCKSS Crawler 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 ApiStatus(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 = {
+        'api_version': 'str',
+        'component_name': 'str',
+        'component_version': 'str',
+        'lockss_version': 'str',
+        'ready': 'bool',
+        'service_name': 'str',
+        'ready_time': 'int',
+        'reason': 'str',
+        'startup_status': 'str'
+    }
+
+    attribute_map = {
+        'api_version': 'apiVersion',
+        'component_name': 'componentName',
+        'component_version': 'componentVersion',
+        'lockss_version': 'lockssVersion',
+        'ready': 'ready',
+        'service_name': 'serviceName',
+        'ready_time': 'readyTime',
+        'reason': 'reason',
+        'startup_status': 'startupStatus'
+    }
+
+    def __init__(self, api_version=None, component_name=None, component_version=None, lockss_version=None, ready=None, service_name=None, ready_time=None, reason=None, startup_status=None):  # noqa: E501
+        """ApiStatus - a model defined in Swagger"""  # noqa: E501
+        self._api_version = None
+        self._component_name = None
+        self._component_version = None
+        self._lockss_version = None
+        self._ready = None
+        self._service_name = None
+        self._ready_time = None
+        self._reason = None
+        self._startup_status = None
+        self.discriminator = None
+        self.api_version = api_version
+        if component_name is not None:
+            self.component_name = component_name
+        if component_version is not None:
+            self.component_version = component_version
+        if lockss_version is not None:
+            self.lockss_version = lockss_version
+        self.ready = ready
+        if service_name is not None:
+            self.service_name = service_name
+        if ready_time is not None:
+            self.ready_time = ready_time
+        if reason is not None:
+            self.reason = reason
+        if startup_status is not None:
+            self.startup_status = startup_status
+
+    @property
+    def api_version(self):
+        """Gets the api_version of this ApiStatus.  # noqa: E501
+
+        The version of the API  # noqa: E501
+
+        :return: The api_version of this ApiStatus.  # noqa: E501
+        :rtype: str
+        """
+        return self._api_version
+
+    @api_version.setter
+    def api_version(self, api_version):
+        """Sets the api_version of this ApiStatus.
+
+        The version of the API  # noqa: E501
+
+        :param api_version: The api_version of this ApiStatus.  # noqa: E501
+        :type: str
+        """
+        if api_version is None:
+            raise ValueError("Invalid value for `api_version`, must not be `None`")  # noqa: E501
+
+        self._api_version = api_version
+
+    @property
+    def component_name(self):
+        """Gets the component_name of this ApiStatus.  # noqa: E501
+
+        The name of the component  # noqa: E501
+
+        :return: The component_name of this ApiStatus.  # noqa: E501
+        :rtype: str
+        """
+        return self._component_name
+
+    @component_name.setter
+    def component_name(self, component_name):
+        """Sets the component_name of this ApiStatus.
+
+        The name of the component  # noqa: E501
+
+        :param component_name: The component_name of this ApiStatus.  # noqa: E501
+        :type: str
+        """
+
+        self._component_name = component_name
+
+    @property
+    def component_version(self):
+        """Gets the component_version of this ApiStatus.  # noqa: E501
+
+        The version of the component software  # noqa: E501
+
+        :return: The component_version of this ApiStatus.  # noqa: E501
+        :rtype: str
+        """
+        return self._component_version
+
+    @component_version.setter
+    def component_version(self, component_version):
+        """Sets the component_version of this ApiStatus.
+
+        The version of the component software  # noqa: E501
+
+        :param component_version: The component_version of this ApiStatus.  # noqa: E501
+        :type: str
+        """
+
+        self._component_version = component_version
+
+    @property
+    def lockss_version(self):
+        """Gets the lockss_version of this ApiStatus.  # noqa: E501
+
+        The version of the LOCKSS system  # noqa: E501
+
+        :return: The lockss_version of this ApiStatus.  # noqa: E501
+        :rtype: str
+        """
+        return self._lockss_version
+
+    @lockss_version.setter
+    def lockss_version(self, lockss_version):
+        """Sets the lockss_version of this ApiStatus.
+
+        The version of the LOCKSS system  # noqa: E501
+
+        :param lockss_version: The lockss_version of this ApiStatus.  # noqa: E501
+        :type: str
+        """
+
+        self._lockss_version = lockss_version
+
+    @property
+    def ready(self):
+        """Gets the ready of this ApiStatus.  # noqa: E501
+
+        The indication of whether the service is available  # noqa: E501
+
+        :return: The ready of this ApiStatus.  # noqa: E501
+        :rtype: bool
+        """
+        return self._ready
+
+    @ready.setter
+    def ready(self, ready):
+        """Sets the ready of this ApiStatus.
+
+        The indication of whether the service is available  # noqa: E501
+
+        :param ready: The ready of this ApiStatus.  # noqa: E501
+        :type: bool
+        """
+        if ready is None:
+            raise ValueError("Invalid value for `ready`, must not be `None`")  # noqa: E501
+
+        self._ready = ready
+
+    @property
+    def service_name(self):
+        """Gets the service_name of this ApiStatus.  # noqa: E501
+
+        The name of the service  # noqa: E501
+
+        :return: The service_name of this ApiStatus.  # noqa: E501
+        :rtype: str
+        """
+        return self._service_name
+
+    @service_name.setter
+    def service_name(self, service_name):
+        """Sets the service_name of this ApiStatus.
+
+        The name of the service  # noqa: E501
+
+        :param service_name: The service_name of this ApiStatus.  # noqa: E501
+        :type: str
+        """
+
+        self._service_name = service_name
+
+    @property
+    def ready_time(self):
+        """Gets the ready_time of this ApiStatus.  # noqa: E501
+
+        The time the service last became ready.  # noqa: E501
+
+        :return: The ready_time of this ApiStatus.  # noqa: E501
+        :rtype: int
+        """
+        return self._ready_time
+
+    @ready_time.setter
+    def ready_time(self, ready_time):
+        """Sets the ready_time of this ApiStatus.
+
+        The time the service last became ready.  # noqa: E501
+
+        :param ready_time: The ready_time of this ApiStatus.  # noqa: E501
+        :type: int
+        """
+
+        self._ready_time = ready_time
+
+    @property
+    def reason(self):
+        """Gets the reason of this ApiStatus.  # noqa: E501
+
+        The reason the service isn't ready.  # noqa: E501
+
+        :return: The reason of this ApiStatus.  # noqa: E501
+        :rtype: str
+        """
+        return self._reason
+
+    @reason.setter
+    def reason(self, reason):
+        """Sets the reason of this ApiStatus.
+
+        The reason the service isn't ready.  # noqa: E501
+
+        :param reason: The reason of this ApiStatus.  # noqa: E501
+        :type: str
+        """
+
+        self._reason = reason
+
+    @property
+    def startup_status(self):
+        """Gets the startup_status of this ApiStatus.  # noqa: E501
+
+        Enum indicating progress of plugin/AU processing at startup.  # noqa: E501
+
+        :return: The startup_status of this ApiStatus.  # noqa: E501
+        :rtype: str
+        """
+        return self._startup_status
+
+    @startup_status.setter
+    def startup_status(self, startup_status):
+        """Sets the startup_status of this ApiStatus.
+
+        Enum indicating progress of plugin/AU processing at startup.  # noqa: E501
+
+        :param startup_status: The startup_status of this ApiStatus.  # noqa: E501
+        :type: str
+        """
+        allowed_values = ["NONE", "PLUGINS_CRAWLING", "PLUGINS_COLLECTED", "PLUGINS_LOADING", "PLUGINS_LOADED", "AUS_STARTING", "AUS_STARTED"]  # noqa: E501
+        if startup_status not in allowed_values:
+            raise ValueError(
+                "Invalid value for `startup_status` ({0}), must be one of {1}"  # noqa: E501
+                .format(startup_status, allowed_values)
+            )
+
+        self._startup_status = startup_status
+
+    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(ApiStatus, 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, ApiStatus):
+            return False
+
+        return self.__dict__ == other.__dict__
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        return not self == other