Coverage for fingerprint_pro_server_api_sdk/rest.py: 64%
125 statements
« prev ^ index » next coverage.py v7.4.4, created at 2024-03-27 22:39 +0000
1# coding: utf-8
3"""
4 Fingerprint Pro Server API
6 Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device. # noqa: E501
8 OpenAPI spec version: 3
9 Contact: support@fingerprint.com
10 Generated by: https://github.com/swagger-api/swagger-codegen.git
11"""
13from __future__ import absolute_import
15import io
16import json
17import logging
18import re
19import ssl
21import certifi
22# python 2 and python 3 compatibility library
23import six
24from six.moves.urllib.parse import urlencode
26try:
27 import urllib3
28except ImportError:
29 raise ImportError('Swagger python client requires urllib3.')
32logger = logging.getLogger(__name__)
35class RESTResponse(io.IOBase):
37 def __init__(self, resp):
38 self.urllib3_response = resp
39 self.status = resp.status
40 self.reason = resp.reason
41 self.data = resp.data
43 def getheaders(self):
44 """Returns a dictionary of the response headers."""
45 return self.urllib3_response.getheaders()
47 def getheader(self, name, default=None):
48 """Returns a given response header."""
49 return self.urllib3_response.getheader(name, default)
52class RESTClientObject(object):
54 def __init__(self, configuration, pools_size=4, maxsize=None):
55 # urllib3.PoolManager will pass all kw parameters to connectionpool
56 # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/poolmanager.py#L75 # noqa: E501
57 # https://github.com/shazow/urllib3/blob/f9409436f83aeb79fbaf090181cd81b784f1b8ce/urllib3/connectionpool.py#L680 # noqa: E501
58 # maxsize is the number of requests to host that are allowed in parallel # noqa: E501
59 # Custom SSL certificates and client certificates: http://urllib3.readthedocs.io/en/latest/advanced-usage.html # noqa: E501
61 # cert_reqs
62 if configuration.verify_ssl:
63 cert_reqs = ssl.CERT_REQUIRED
64 else:
65 cert_reqs = ssl.CERT_NONE
67 # ca_certs
68 if configuration.ssl_ca_cert:
69 ca_certs = configuration.ssl_ca_cert
70 else:
71 # if not set certificate file, use Mozilla's root certificates.
72 ca_certs = certifi.where()
74 addition_pool_args = {}
75 if configuration.assert_hostname is not None:
76 addition_pool_args['assert_hostname'] = configuration.assert_hostname # noqa: E501
78 if maxsize is None:
79 if configuration.connection_pool_maxsize is not None:
80 maxsize = configuration.connection_pool_maxsize
81 else:
82 maxsize = 4
84 # https pool manager
85 if configuration.proxy:
86 self.pool_manager = urllib3.ProxyManager(
87 num_pools=pools_size,
88 maxsize=maxsize,
89 cert_reqs=cert_reqs,
90 ca_certs=ca_certs,
91 cert_file=configuration.cert_file,
92 key_file=configuration.key_file,
93 proxy_url=configuration.proxy,
94 **addition_pool_args
95 )
96 else:
97 self.pool_manager = urllib3.PoolManager(
98 num_pools=pools_size,
99 maxsize=maxsize,
100 cert_reqs=cert_reqs,
101 ca_certs=ca_certs,
102 cert_file=configuration.cert_file,
103 key_file=configuration.key_file,
104 **addition_pool_args
105 )
107 def request(self, method, url, query_params=None, headers=None,
108 body=None, post_params=None, _preload_content=True,
109 _request_timeout=None):
110 """Perform requests.
112 :param method: http request method
113 :param url: http request url
114 :param query_params: query parameters in the url
115 :param headers: http request headers
116 :param body: request json body, for `application/json`
117 :param post_params: request post parameters,
118 `application/x-www-form-urlencoded`
119 and `multipart/form-data`
120 :param _preload_content: if False, the urllib3.HTTPResponse object will
121 be returned without reading/decoding response
122 data. Default is True.
123 :param _request_timeout: timeout setting for this request. If one
124 number provided, it will be total request
125 timeout. It can also be a pair (tuple) of
126 (connection, read) timeouts.
127 """
128 method = method.upper()
129 assert method in ['GET', 'HEAD', 'DELETE', 'POST', 'PUT',
130 'PATCH', 'OPTIONS']
132 if post_params and body:
133 raise ValueError(
134 "body parameter cannot be used with post_params parameter."
135 )
137 post_params = post_params or {}
138 headers = headers or {}
140 timeout = None
141 if _request_timeout:
142 if isinstance(_request_timeout, (int, ) if six.PY3 else (int, long)): # noqa: E501,F821
143 timeout = urllib3.Timeout(total=_request_timeout)
144 elif (isinstance(_request_timeout, tuple) and
145 len(_request_timeout) == 2):
146 timeout = urllib3.Timeout(
147 connect=_request_timeout[0], read=_request_timeout[1])
149 if 'Content-Type' not in headers:
150 headers['Content-Type'] = 'application/json'
152 try:
153 # For `POST`, `PUT`, `PATCH`, `OPTIONS`, `DELETE`
154 if method in ['POST', 'PUT', 'PATCH', 'OPTIONS', 'DELETE']:
155 if query_params:
156 url += '?' + urlencode(query_params)
157 if re.search('json', headers['Content-Type'], re.IGNORECASE):
158 request_body = '{}'
159 if body is not None:
160 request_body = json.dumps(body)
161 r = self.pool_manager.request(
162 method, url,
163 body=request_body,
164 preload_content=_preload_content,
165 timeout=timeout,
166 headers=headers)
167 elif headers['Content-Type'] == 'application/x-www-form-urlencoded': # noqa: E501
168 r = self.pool_manager.request(
169 method, url,
170 fields=post_params,
171 encode_multipart=False,
172 preload_content=_preload_content,
173 timeout=timeout,
174 headers=headers)
175 elif headers['Content-Type'] == 'multipart/form-data':
176 # must del headers['Content-Type'], or the correct
177 # Content-Type which generated by urllib3 will be
178 # overwritten.
179 del headers['Content-Type']
180 r = self.pool_manager.request(
181 method, url,
182 fields=post_params,
183 encode_multipart=True,
184 preload_content=_preload_content,
185 timeout=timeout,
186 headers=headers)
187 # Pass a `string` parameter directly in the body to support
188 # other content types than Json when `body` argument is
189 # provided in serialized form
190 elif isinstance(body, str):
191 request_body = body
192 r = self.pool_manager.request(
193 method, url,
194 body=request_body,
195 preload_content=_preload_content,
196 timeout=timeout,
197 headers=headers)
198 else:
199 # Cannot generate the request from given parameters
200 msg = """Cannot prepare a request message for provided
201 arguments. Please check that your arguments match
202 declared content type."""
203 raise ApiException(status=0, reason=msg)
204 # For `GET`, `HEAD`
205 else:
206 r = self.pool_manager.request(method, url,
207 fields=query_params,
208 preload_content=_preload_content,
209 timeout=timeout,
210 headers=headers)
211 except urllib3.exceptions.SSLError as e:
212 msg = "{0}\n{1}".format(type(e).__name__, str(e))
213 raise ApiException(status=0, reason=msg)
215 if _preload_content:
216 r = RESTResponse(r)
218 # log response body
219 logger.debug("response body: %s", r.data)
221 if not 200 <= r.status <= 299:
222 raise ApiException(http_resp=r)
224 return r
226 def GET(self, url, headers=None, query_params=None, _preload_content=True,
227 _request_timeout=None):
228 return self.request("GET", url,
229 headers=headers,
230 _preload_content=_preload_content,
231 _request_timeout=_request_timeout,
232 query_params=query_params)
234 def HEAD(self, url, headers=None, query_params=None, _preload_content=True,
235 _request_timeout=None):
236 return self.request("HEAD", url,
237 headers=headers,
238 _preload_content=_preload_content,
239 _request_timeout=_request_timeout,
240 query_params=query_params)
242 def OPTIONS(self, url, headers=None, query_params=None, post_params=None,
243 body=None, _preload_content=True, _request_timeout=None):
244 return self.request("OPTIONS", url,
245 headers=headers,
246 query_params=query_params,
247 post_params=post_params,
248 _preload_content=_preload_content,
249 _request_timeout=_request_timeout,
250 body=body)
252 def DELETE(self, url, headers=None, query_params=None, body=None,
253 _preload_content=True, _request_timeout=None):
254 return self.request("DELETE", url,
255 headers=headers,
256 query_params=query_params,
257 _preload_content=_preload_content,
258 _request_timeout=_request_timeout,
259 body=body)
261 def POST(self, url, headers=None, query_params=None, post_params=None,
262 body=None, _preload_content=True, _request_timeout=None):
263 return self.request("POST", url,
264 headers=headers,
265 query_params=query_params,
266 post_params=post_params,
267 _preload_content=_preload_content,
268 _request_timeout=_request_timeout,
269 body=body)
271 def PUT(self, url, headers=None, query_params=None, post_params=None,
272 body=None, _preload_content=True, _request_timeout=None):
273 return self.request("PUT", url,
274 headers=headers,
275 query_params=query_params,
276 post_params=post_params,
277 _preload_content=_preload_content,
278 _request_timeout=_request_timeout,
279 body=body)
281 def PATCH(self, url, headers=None, query_params=None, post_params=None,
282 body=None, _preload_content=True, _request_timeout=None):
283 return self.request("PATCH", url,
284 headers=headers,
285 query_params=query_params,
286 post_params=post_params,
287 _preload_content=_preload_content,
288 _request_timeout=_request_timeout,
289 body=body)
292class ApiException(Exception):
294 def __init__(self, status=None, reason=None, http_resp=None):
295 if http_resp:
296 self.status = http_resp.status
297 self.reason = http_resp.reason
298 self.body = http_resp.data
299 self.headers = http_resp.getheaders()
300 else:
301 self.status = status
302 self.reason = reason
303 self.body = None
304 self.headers = None
306 def __str__(self):
307 """Custom error messages for exception"""
308 error_message = "({0})\n"\
309 "Reason: {1}\n".format(self.status, self.reason)
310 if self.headers:
311 error_message += "HTTP response headers: {0}\n".format(
312 self.headers)
314 if self.body:
315 error_message += "HTTP response body: {0}\n".format(self.body)
317 return error_message
320class KnownApiException(ApiException):
322 def __init__(self, original_exception, structured_error):
323 super(KnownApiException, self).__init__(status=original_exception.status, reason=original_exception.reason)
324 self.headers = original_exception.headers
325 self.body = original_exception.body
326 self.structured_error = structured_error