|
| 1 | +# -*- coding: utf-8 -*- |
| 2 | +"""Main class for pull data from Devo API (Client).""" |
| 3 | +import time |
| 4 | +import socket |
| 5 | +import ssl |
| 6 | +import sys |
| 7 | + |
| 8 | +PY3 = sys.version_info[0] > 2 |
| 9 | +CLIENT_DEFAULT_APP_NAME = 'python-sdk-app' |
| 10 | +CLIENT_DEFAULT_USER = 'python-sdk-user' |
| 11 | +URL_AWS_EU = 'https://api-eu.logtrust.com' |
| 12 | +URL_VDC = 'https://spainapi.logtrust.com' |
| 13 | +URL_AWS_USA = 'https://api-us.logtrust.com' |
| 14 | +URL_QUERY_COMPLEMENT = 'search/query' |
| 15 | +URL_JOB = '/search/job/' |
| 16 | +URL_JOBS = '/search/jobs' |
| 17 | +URL_JOB_START = 'start/' |
| 18 | +URL_JOB_STOP = 'stop/' |
| 19 | +URL_JOB_REMOVE = 'remove/' |
| 20 | + |
| 21 | + |
| 22 | +class DevoClientException(Exception): |
| 23 | + """ Default Devo Client Exception """ |
| 24 | + |
| 25 | + |
| 26 | +if not PY3: |
| 27 | + class ConnectionError(OSError): |
| 28 | + """ Connection error. """ |
| 29 | + def __init__(self, *args, **kwargs): # real signature unknown |
| 30 | + pass |
| 31 | + |
| 32 | + |
| 33 | +class Base: |
| 34 | + """ |
| 35 | + The Devo SERach REst Api main class |
| 36 | + """ |
| 37 | + |
| 38 | + def __init__(self, *args, **kwargs): |
| 39 | + """ |
| 40 | + Initialize the API with this params, all optionals |
| 41 | + :param key: Key string |
| 42 | + :param secret: Secret string |
| 43 | + :param token: Auth Token |
| 44 | + :param url: URL for the service |
| 45 | + :param buffer: Buffer object, if want another diferent queue |
| 46 | + """ |
| 47 | + self.time_start = int(round(time.time() * 1000)) |
| 48 | + if len(args) == 3: |
| 49 | + self.key = args[0] |
| 50 | + self.secret = args[1] |
| 51 | + self.url = args[2] |
| 52 | + elif not args: |
| 53 | + self.key = kwargs.get("key", |
| 54 | + kwargs.get("api_key", |
| 55 | + kwargs.get("apiKey", None))) |
| 56 | + |
| 57 | + self.secret = kwargs.get("secret", |
| 58 | + kwargs.get("api_secret", |
| 59 | + kwargs.get("apiSecret", None))) |
| 60 | + |
| 61 | + self.url = kwargs.get("url", None) |
| 62 | + else: |
| 63 | + raise DevoClientException("Devo-Client|Position arguments are " |
| 64 | + "deprecated, It is only enabled as " |
| 65 | + "compatibility, being able to pass only " |
| 66 | + "3 arguments: key, secret and url, " |
| 67 | + "in that order. ") |
| 68 | + |
| 69 | + self.url, self.query_url = self.__set_url_query() |
| 70 | + self.socket = None |
| 71 | + self.socket_timeout = 30 |
| 72 | + self.retries = 3 |
| 73 | + self.timeout = 30 |
| 74 | + self.sleep = 5 |
| 75 | + |
| 76 | + def __set_url_query(self): |
| 77 | + """ |
| 78 | + Set URL to ask |
| 79 | + :param url: string, full or only one part |
| 80 | + :return: Complete url for call api |
| 81 | + """ |
| 82 | + if self.url is None: |
| 83 | + return URL_AWS_EU, URL_QUERY_COMPLEMENT |
| 84 | + return self.__get_url_parts() |
| 85 | + |
| 86 | + def __get_url_parts(self): |
| 87 | + """ |
| 88 | + Split the two parts of the api url |
| 89 | + :param url: Url of the api |
| 90 | + """ |
| 91 | + return self.__verify_url_complement( |
| 92 | + self.url.split("//")[-1].split("/", maxsplit=1) if PY3 |
| 93 | + else self.url.split("//")[-1].split("/", 1)) |
| 94 | + |
| 95 | + def __verify_url_complement(self, url_list): |
| 96 | + """ |
| 97 | + Verify if only has main domain or full url |
| 98 | + :param url_list: One or two part of the url |
| 99 | + """ |
| 100 | + return url_list if len(url_list) == 2 \ |
| 101 | + else [url_list[0], URL_QUERY_COMPLEMENT] |
| 102 | + |
| 103 | + def _generate_pragmas(self, comment=None): |
| 104 | + """ |
| 105 | + Generate pragmas to add to query |
| 106 | + :comment: Pragma comment free |
| 107 | + :user: Pragma comment user |
| 108 | + :app_name: Pragma comment id. App name. |
| 109 | + """ |
| 110 | + str_pragmas = ' pragma comment.id:"{}" ' \ |
| 111 | + 'pragma comment.user:"{}"'\ |
| 112 | + .format(self.app_name, self.user) |
| 113 | + |
| 114 | + if comment: |
| 115 | + return str_pragmas + ' pragma comment.free:"{}"'.format(comment) |
| 116 | + |
| 117 | + return str_pragmas |
| 118 | + |
| 119 | + @staticmethod |
| 120 | + def _generate_dates(dates): |
| 121 | + """ |
| 122 | + Generate and merge dates object |
| 123 | + :param dates: object with optios for query, see doc |
| 124 | + :return: updated opts |
| 125 | + """ |
| 126 | + default = {'from': 'yesterday()', 'to': None} |
| 127 | + |
| 128 | + if not dates: |
| 129 | + return default |
| 130 | + |
| 131 | + default.update(dates) |
| 132 | + return default |
| 133 | + |
| 134 | + def status(self): |
| 135 | + """ |
| 136 | + View Socket status, check if it's open |
| 137 | + """ |
| 138 | + timeit = int(round(time.time() * 1000)) - self.time_start |
| 139 | + if self.socket is None: |
| 140 | + return False |
| 141 | + |
| 142 | + if self.timeout < timeit: |
| 143 | + self.close() |
| 144 | + return False |
| 145 | + |
| 146 | + return True |
| 147 | + |
| 148 | + @staticmethod |
| 149 | + def _stream_available(resp): |
| 150 | + """ |
| 151 | + Verify if can stream resp from API by type of resp in opts |
| 152 | + :param resp: str |
| 153 | + :return: bool |
| 154 | + """ |
| 155 | + return resp not in ["json", "json/compact"] |
| 156 | + |
| 157 | + def connect(self): |
| 158 | + """ |
| 159 | + Connect to SSL socket. |
| 160 | + """ |
| 161 | + self.socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM) |
| 162 | + self.socket.settimeout(self.socket_timeout) |
| 163 | + self.socket.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1) |
| 164 | + |
| 165 | + try: |
| 166 | + try: |
| 167 | + self.socket = ssl.wrap_socket(self.socket, |
| 168 | + cert_reqs=ssl.CERT_NONE) |
| 169 | + except ssl.SSLError: |
| 170 | + raise ssl.SSLError |
| 171 | + self.socket.connect((self.url, 443)) |
| 172 | + self.time_start = int(round(time.time() * 1000)) |
| 173 | + |
| 174 | + except socket.error as error: |
| 175 | + self.close() |
| 176 | + raise DevoClientException("Devo-Client| %s" % str(error)) |
| 177 | + |
| 178 | + def close(self): |
| 179 | + """ |
| 180 | + Forces socket closure |
| 181 | + """ |
| 182 | + if self.buffer is not None: |
| 183 | + self.buffer.close = True |
| 184 | + self.buffer.thread.join() |
| 185 | + |
| 186 | + if self.socket is not None: |
| 187 | + self.socket.close() |
| 188 | + self.socket = None |
| 189 | + |
| 190 | + def _get_job_url_part(self): |
| 191 | + URL_JOB = '/search/job' |
| 192 | + URL_JOBS = '/search/jobs' |
| 193 | + URL_JOB_START = '/start/' |
| 194 | + URL_JOB_STOP = '/start/' |
| 195 | + URL_JOB_REMOVE = '/start/' |
0 commit comments