-
Notifications
You must be signed in to change notification settings - Fork 148
/
rest_session.py
473 lines (410 loc) · 18.9 KB
/
rest_session.py
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
from datetime import datetime
import json
import platform
import random
import sys
import time
import urllib.parse
import requests
from .config import *
from .exceptions import *
from .__init__ import __version__
def user_agent_extended(be_geo_id, caller):
# Generate extended portion of the User-Agent
user_agent_extended = be_geo_id
user_agent_extended = {}
# Mimic pip system data collection per https://github.com/pypa/pip/blob/master/src/pip/_internal/network/session.py
user_agent_extended['implementation'] = {
"name": platform.python_implementation(),
}
if user_agent_extended["implementation"]["name"] in ('CPython', 'Jython', 'IronPython'):
user_agent_extended["implementation"]["version"] = platform.python_version()
elif user_agent_extended["implementation"]["name"] == 'PyPy':
if sys.pypy_version_info.releaselevel == 'final':
pypy_version_info = sys.pypy_version_info[:3]
else:
pypy_version_info = sys.pypy_version_info
user_agent_extended["implementation"]["version"] = ".".join(
[str(x) for x in pypy_version_info]
)
if sys.platform.startswith("darwin") and platform.mac_ver()[0]:
user_agent_extended["distro"] = {"name": "macOS", "version": platform.mac_ver()[0]}
if platform.system():
user_agent_extended.setdefault("system", {})["name"] = platform.system()
if platform.release():
user_agent_extended.setdefault("system", {})["release"] = platform.release()
if platform.machine():
user_agent_extended["cpu"] = platform.machine()
if be_geo_id:
user_agent_extended["be_geo_id"] = be_geo_id
if caller:
user_agent_extended["caller"] = caller
return urllib.parse.quote(json.dumps(user_agent_extended))
# Main module interface
class RestSession(object):
def __init__(
self,
logger,
api_key,
base_url=DEFAULT_BASE_URL,
single_request_timeout=SINGLE_REQUEST_TIMEOUT,
certificate_path=CERTIFICATE_PATH,
requests_proxy=REQUESTS_PROXY,
wait_on_rate_limit=WAIT_ON_RATE_LIMIT,
nginx_429_retry_wait_time=NGINX_429_RETRY_WAIT_TIME,
action_batch_retry_wait_time=ACTION_BATCH_RETRY_WAIT_TIME,
retry_4xx_error=RETRY_4XX_ERROR,
retry_4xx_error_wait_time=RETRY_4XX_ERROR_WAIT_TIME,
maximum_retries=MAXIMUM_RETRIES,
simulate=SIMULATE_API_CALLS,
be_geo_id=BE_GEO_ID,
caller=MERAKI_PYTHON_SDK_CALLER,
use_iterator_for_get_pages=False,
):
super(RestSession, self).__init__()
# Initialize attributes and properties
self._version = __version__
self._api_key = str(api_key)
self._base_url = str(base_url)
self._single_request_timeout = single_request_timeout
self._certificate_path = certificate_path
self._requests_proxy = requests_proxy
self._wait_on_rate_limit = wait_on_rate_limit
self._nginx_429_retry_wait_time = nginx_429_retry_wait_time
self._action_batch_retry_wait_time = action_batch_retry_wait_time
self._retry_4xx_error = retry_4xx_error
self._retry_4xx_error_wait_time = retry_4xx_error_wait_time
self._maximum_retries = maximum_retries
self._simulate = simulate
self._be_geo_id = be_geo_id
self._caller = caller
self.use_iterator_for_get_pages = use_iterator_for_get_pages
# Initialize a new `requests` session
self._req_session = requests.session()
self._req_session.encoding = 'utf-8'
# Check base URL
if 'v0' in self._base_url:
sys.exit(f'If you want to use the Python library with v0 paths ({self._base_url} was configured as the base'
f' URL), then install the v0 library. See the "Setup" section @ https://github.com/meraki/dashboard-api-python/')
elif self._base_url[-1] == '/':
self._base_url = self._base_url[:-1]
# Update the headers for the session
self._req_session.headers = {
'Authorization': 'Bearer ' + self._api_key,
'Content-Type': 'application/json',
'User-Agent': f'python-meraki/{self._version} ' + user_agent_extended(self._be_geo_id, self._caller),
}
# Log API calls
self._logger = logger
self._parameters = {'version': self._version}
self._parameters.update(locals())
self._parameters.pop('self')
self._parameters.pop('logger')
self._parameters.pop('__class__')
self._parameters['api_key'] = '*' * 36 + self._api_key[-4:]
if self._logger:
self._logger.info(f'Meraki dashboard API session initialized with these parameters: {self._parameters}')
@property
def use_iterator_for_get_pages(self):
return self._use_iterator_for_get_pages
@use_iterator_for_get_pages.setter
def use_iterator_for_get_pages(self, value):
if value:
self.get_pages = self._get_pages_iterator
else:
self.get_pages = self._get_pages_legacy
self._use_iterator_for_get_pages = value
def request(self, metadata, method, url, **kwargs):
# Metadata on endpoint
tag = metadata['tags'][0]
operation = metadata['operation']
# Update request kwargs with session defaults
if self._certificate_path:
kwargs.setdefault('verify', self._certificate_path)
if self._requests_proxy:
kwargs.setdefault('proxies', {'https': self._requests_proxy})
kwargs.setdefault('timeout', self._single_request_timeout)
# Ensure proper base URL
if 'meraki.com' in url or 'meraki.cn' in url:
abs_url = url
else:
abs_url = self._base_url + url
# Set maximum number of retries
retries = self._maximum_retries
# Option to simulate non-safe API calls without actually sending them
if self._logger:
self._logger.debug(metadata)
if self._simulate and method != 'GET':
if self._logger:
self._logger.info(f'{tag}, {operation} - SIMULATED')
return None
else:
response = None
while retries > 0:
# Make the HTTP request to the API endpoint
try:
if response:
response.close()
if self._logger:
self._logger.info(f'{method} {abs_url}')
response = self._req_session.request(method, abs_url, allow_redirects=False, **kwargs)
reason = response.reason if response.reason else ''
status = response.status_code
except requests.exceptions.RequestException as e:
if self._logger:
self._logger.warning(f'{tag}, {operation} - {e}, retrying in 1 second')
time.sleep(1)
retries -= 1
if retries == 0:
raise APIError(metadata, response)
else:
continue
# Handle 3XX redirects automatically
if str(status)[0] == '3':
abs_url = response.headers['Location']
substring = 'meraki.com/api/v'
if substring not in abs_url:
substring = 'meraki.cn/api/v'
self._base_url = abs_url[:abs_url.find(substring) + len(substring) + 1]
# 2XX success
elif response.ok:
if 'page' in metadata:
counter = metadata['page']
if self._logger:
self._logger.info(f'{tag}, {operation}; page {counter} - {status} {reason}')
else:
if self._logger:
self._logger.info(f'{tag}, {operation} - {status} {reason}')
# For non-empty response to GET, ensure valid JSON
try:
if method == 'GET' and response.content.strip():
response.json()
return response
except json.decoder.JSONDecodeError as e:
if self._logger:
self._logger.warning(f'{tag}, {operation} - {e}, retrying in 1 second')
time.sleep(1)
retries -= 1
if retries == 0:
raise APIError(metadata, response)
else:
continue
# Rate limit 429 errors
elif status == 429:
if 'Retry-After' in response.headers:
wait = int(response.headers['Retry-After'])
else:
wait = random.randint(1, self._nginx_429_retry_wait_time)
if self._logger:
self._logger.warning(f'{tag}, {operation} - {status} {reason}, retrying in {wait} seconds')
time.sleep(wait)
retries -= 1
if retries == 0:
raise APIError(metadata, response)
# 5XX errors
elif status >= 500:
if self._logger:
self._logger.warning(f'{tag}, {operation} - {status} {reason}, retrying in 1 second')
time.sleep(1)
retries -= 1
if retries == 0:
raise APIError(metadata, response)
# 4XX errors
else:
try:
message = response.json()
except ValueError:
message = response.content[:100]
# Check specifically for action batch concurrency error
action_batch_concurrency_error = {'errors': [
'Too many concurrently executing batches. Maximum is 5 confirmed but not yet executed batches.']
}
if message == action_batch_concurrency_error:
wait = self._action_batch_retry_wait_time
if self._logger:
self._logger.warning(f'{tag}, {operation} - {status} {reason}, retrying in {wait} seconds')
time.sleep(wait)
retries -= 1
if retries == 0:
raise APIError(metadata, response)
elif self._retry_4xx_error:
wait = random.randint(1, self._retry_4xx_error_wait_time)
if self._logger:
self._logger.warning(f'{tag}, {operation} - {status} {reason}, retrying in {wait} seconds')
time.sleep(wait)
retries -= 1
if retries == 0:
raise APIError(metadata, response)
# All other client-side errors
else:
if self._logger:
self._logger.error(f'{tag}, {operation} - {status} {reason}, {message}')
raise APIError(metadata, response)
def get(self, metadata, url, params=None):
metadata['method'] = 'GET'
metadata['url'] = url
metadata['params'] = params
response = self.request(metadata, 'GET', url, params=params)
ret = None
if response:
if response.content.strip():
ret = response.json()
response.close()
return ret
def get_pages(self, metadata, url, params=None, total_pages=-1, direction='next', event_log_end_time=None):
pass
def _get_pages_iterator(
self,
metadata,
url,
params=None,
total_pages=-1,
direction="next",
event_log_end_time=None,
):
if type(total_pages) == str and total_pages.lower() == "all":
total_pages = -1
elif type(total_pages) == str and total_pages.isnumeric():
total_pages = int(total_pages)
metadata["page"] = 1
response = self.request(metadata, 'GET', url, params=params)
# Get additional pages if more than one requested
while total_pages != 0:
results = response.json()
links = response.links
# GET the subsequent page
if direction == "next" and "next" in links:
# Prevent getNetworkEvents from infinite loop as time goes forward
if metadata["operation"] == "getNetworkEvents":
starting_after = urllib.parse.unquote(
str(links["next"]["url"]).split("startingAfter=")[1]
)
delta = datetime.utcnow() - datetime.fromisoformat(
starting_after[:-1]
)
# Break out of loop if startingAfter returned from next link is within 5 minutes of current time
if delta.total_seconds() < 300:
break
# Or if next page is past the specified window's end time
elif event_log_end_time and starting_after > event_log_end_time:
break
metadata["page"] += 1
nextlink = links["next"]["url"]
elif direction == "prev" and "prev" in links:
# Prevent getNetworkEvents from infinite loop as time goes backward (to epoch 0)
if metadata["operation"] == "getNetworkEvents":
ending_before = urllib.parse.unquote(
str(links["prev"]["url"]).split("endingBefore=")[1]
)
# Break out of loop if endingBefore returned from prev link is before 2014
if ending_before < "2014-01-01":
break
metadata["page"] += 1
nextlink = links["prev"]["url"]
else:
break
response.close()
return_items = []
# just prepare the list
if type(results) == list:
return_items = results
# For event log endpoint
elif type(results) == dict:
if direction == "next":
return_items = results["events"][::-1]
else:
return_items = results["events"]
for item in return_items:
yield item
total_pages = total_pages - 1
if total_pages != 0:
response = self.request(metadata, 'GET', nextlink)
def _get_pages_legacy(self, metadata, url, params=None, total_pages=-1, direction='next', event_log_end_time=None):
if type(total_pages) == str and total_pages.lower() == 'all':
total_pages = -1
elif type(total_pages) == str and total_pages.isnumeric():
total_pages = int(total_pages)
metadata['page'] = 1
response = self.request(metadata, 'GET', url, params=params)
results = response.json()
# For event log endpoint when using 'next' direction, so results/events are sorted chronologically
if type(results) == dict and metadata['operation'] == 'getNetworkEvents' and direction == 'next':
results['events'] = results['events'][::-1]
# Get additional pages if more than one requested
while total_pages != 1:
links = response.links
response.close()
response = None
# GET the subsequent page
if direction == 'next' and 'next' in links:
# Prevent getNetworkEvents from infinite loop as time goes forward
if metadata['operation'] == 'getNetworkEvents':
starting_after = urllib.parse.unquote(links['next']['url'].split('startingAfter=')[1])
delta = datetime.utcnow() - datetime.fromisoformat(starting_after[:-1])
# Break out of loop if startingAfter returned from next link is within 5 minutes of current time
if delta.total_seconds() < 300:
break
# Or if next page is past the specified window's end time
elif event_log_end_time and starting_after > event_log_end_time:
break
metadata['page'] += 1
response = self.request(metadata, 'GET', links['next']['url'])
elif direction == 'prev' and 'prev' in links:
# Prevent getNetworkEvents from infinite loop as time goes backward (to epoch 0)
if metadata['operation'] == 'getNetworkEvents':
ending_before = urllib.parse.unquote(links['prev']['url'].split('endingBefore=')[1])
# Break out of loop if endingBefore returned from prev link is before 2014
if ending_before < '2014-01-01':
break
metadata['page'] += 1
response = self.request(metadata, 'GET', links['prev']['url'])
else:
break
# Append that page's results, depending on the endpoint
if type(results) == list:
results.extend(response.json())
# For event log endpoint
elif type(results) == dict:
start = response.json()['pageStartAt']
end = response.json()['pageEndAt']
events = response.json()['events']
if direction == 'next':
events = events[::-1]
if start < results['pageStartAt']:
results['pageStartAt'] = start
if end > results['pageEndAt']:
results['pageEndAt'] = end
results['events'].extend(events)
total_pages -= 1
if response:
response.close()
return results
def post(self, metadata, url, json=None):
metadata['method'] = 'POST'
metadata['url'] = url
metadata['json'] = json
response = self.request(metadata, 'POST', url, json=json)
ret = None
if response:
if response.content.strip():
ret = response.json()
response.close()
return ret
def put(self, metadata, url, json=None):
metadata['method'] = 'PUT'
metadata['url'] = url
metadata['json'] = json
response = self.request(metadata, 'PUT', url, json=json)
ret = None
if response:
if response.content.strip():
ret = response.json()
response.close()
return ret
def delete(self, metadata, url):
metadata['method'] = 'DELETE'
metadata['url'] = url
response = self.request(metadata, 'DELETE', url)
if response:
response.close()
return None