-
Notifications
You must be signed in to change notification settings - Fork 0
/
request_utils.py
209 lines (165 loc) · 7.03 KB
/
request_utils.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
import requests
import json
import settings
log = settings.log
# if the Plextrac instance is running on https without valid certs, requests will respond with cert error
# change this to false to override verification of certs
verify_ssl = True
# call if the api call fails, generally 500 codes
def err_requests_general(request, type, path, e):
log.error(f'Could not complete {type} \'{request}\' on \'{path}\' endpoint. Exception: {e}')
# call when the api call returns a non success, generally 400 codes
def err_non_200_response(request, status, reason):
log.error(f'\'{request}\' request failed with status: {status} - {reason}')
# call when the api call doesn't return a valid json response, if a json response was expected
def err_invalid_json_response(request, e):
log.error(f'Malformed \'{request}\' API response. Exception: {e}')
# call when the api call is missing a specific field, when that field is expected
def err_missing_required_response_field(request, field):
log.error(f'Received empty \'{field}\' value from server')
# general GET request with error messages inserted
# - assumes GET requests will not have a body
def request_get(base_url, request_root, request_path, request_name, headers):
try:
response = requests.get(
f'{base_url}{request_root}{request_path}',
headers = headers,
verify = verify_ssl
)
try:
response_json = json.loads(response.text)
if response.status_code != 200:
err_non_200_response(request_name, response.status_code, response.reason)
log.warning(f'Plextrac message: {response_json.get("message")}')
except Exception as e:
err_invalid_json_response(request_name, e)
return response
return response_json
except Exception as e:
err_requests_general(request_name, "GET", request_path, e)
exit()
# general POST request with error messages inserted
def request_post(base_url, request_root, request_path, request_name, headers, payload):
try:
response = requests.post(
f'{base_url}{request_root}{request_path}',
headers = headers,
json = payload,
verify = verify_ssl
)
try:
response_json = json.loads(response.text)
if response.status_code != 200:
err_non_200_response(request_name, response.status_code, response.reason)
log.warning(f'Plextrac message: {response_json.get("message")}')
except Exception as e:
err_invalid_json_response(request_name, e)
return response
return response_json
except Exception as e:
err_requests_general(request_name, "POST", request_path, e)
exit()
# POST request for multipart form-data with error messages inserted
def request_post_multipart(base_url, request_root, request_path, request_name, headers, multipart_form_data):
try:
response = requests.post(
f'{base_url}{request_root}{request_path}',
headers = headers,
files = multipart_form_data,
verify = verify_ssl
)
try:
response_json = json.loads(response.text)
if response.status_code != 200:
err_non_200_response(request_name, response.status_code, response.reason)
log.warning(f'Plextrac message: {response_json.get("message")}')
except Exception as e:
err_invalid_json_response(request_name, e)
return response
return response_json
except Exception as e:
err_requests_general(request_name, "POST", request_path, e)
exit()
# general PUT request with error messages inserted
def request_put(base_url, request_root, request_path, request_name, headers, payload):
try:
response = requests.put(
f'{base_url}{request_root}{request_path}',
headers = headers,
json = payload,
verify = verify_ssl
)
try:
response_json = json.loads(response.text)
if response.status_code != 200:
err_non_200_response(request_name, response.status_code, response.reason)
log.warning(f'Plextrac message: {response_json.get("message")}')
except Exception as e:
err_invalid_json_response(request_name, e)
return response
return response_json
except Exception as e:
err_requests_general(request_name, "PUT", request_path, e)
exit()
# general DELETE request with error messages inserted
# - assumes DELETE requests will not have a body
def request_delete(base_url, request_root, request_path, request_name, headers):
try:
response = requests.delete(
f'{base_url}{request_root}{request_path}',
headers = headers,
verify = verify_ssl
)
try:
response_json = json.loads(response.text)
if response.status_code != 200:
err_non_200_response(request_name, response.status_code, response.reason)
log.warning(f'Plextrac message: {response_json.get("message")}')
except Exception as e:
err_invalid_json_response(request_name, e)
return response
return response_json
except Exception as e:
err_requests_general(request_name, "POST", request_path, e)
exit()
# list of endpoints - keeps like data together, static place for root and path info
def request_root(base_url, headers):
name = "Root"
root = "/api/v1"
path = "/"
return request_get(base_url, root, path, name, headers)
def request_authenticate(base_url, headers, payload):
name = "Authenticate"
root = "/api/v1"
path = "/authenticate"
return request_post(base_url, root, path, name, headers, payload)
def request_mfa_authenticate(base_url, headers, payload):
name = "MFA Authenticate"
root = "/api/v1"
path = "/authenticate/mfa"
return request_post(base_url, root, path, name, headers, payload)
#----------Client Endpoints----------
def request_list_clients(base_url, headers):
name = "List Clients"
root = "/api/v1"
path = "/client/list"
return request_get(base_url, root, path, name, headers)
def request_get_client(base_url, headers, client_id):
name = "Get Client"
root = "/api/v1"
path = f'/client/{client_id}'
return request_get(base_url, root, path, name, headers)
def request_create_client(base_url, headers, payload):
name = "Create Client"
root = "/api/v1"
path = f'/client/create'
return request_post(base_url, root, path, name, headers, payload)
#----------Report Endpoints----------
def request_import_report_from_ptrac(base_url, headers, client_id, file):
name = "Import Ptrac Report"
root = "/api/v1"
path = f'/client/{client_id}/report/import'
multipart_form_data = {
'file': file
}
return request_post_multipart(base_url, root, path, name, headers, multipart_form_data)