def post_request(path, payload, json=True):
"""Post payload to a path at the SFA api.
Parameters
----------
path: str
The api endpoint to post to including leading slash.
payload: str or dict
Payload to send to the api either a string or JSON dict.
json: boolean
A flag for setting the content type of the request, if
True, posts json to the api, otherwise sends the payload
as text/csv.
Returns
-------
requests.Response
The api response.
"""
if json:
kwargs = {'json': payload}
else:
kwargs = {'headers': {'Content-type': 'text/csv'}, 'data': payload}
return handle_response(
oauth_request_session.post(f'{app.config["SFA_API_URL"]}{path}',
**kwargs))
def delete_request(path, **kwargs):
"""Make a delete request.
Parameters
----------
path: str
The api endpoint to post to including leading slash.
Returns
-------
requests.Response
The api response.
"""
return handle_response(
oauth_request_session.delete(f'{app.config["SFA_API_URL"]}{path}',
**kwargs))
def get_request(path, **kwargs):
"""Make a get request to a path at SFA api.
Parameters
----------
path: str
The api endpoint to query including leading slash.
Returns
-------
requests.Response
The api response.
"""
# may need to handle errors if oauth_request_session does not exist somehow
# definitely need to handle errors here
retries = kwargs.pop('failure_retries', 2)
errors = None
try:
req = oauth_request_session.get(f'{app.config["SFA_API_URL"]}{path}',
**kwargs)
except ChunkedEncodingError as e:
errors = e
except ConnectionError as e:
errors = e
if errors is not None:
if retries > 0:
kwargs['failure_retries'] = retries - 1
time.sleep((3 - retries) * 0.1)
return get_request(path, **kwargs)
else:
# API timed out or dropped the connection, send the error to
# sentry for tracking and return a message to the user.
capture_exception(errors)
raise DataRequestException(
503, {'Error': 'API connection failed. Please try again.'})
else:
return handle_response(req)
def test_handle_response_requesterror_500(mock_response, code, mock_request):
with pytest.raises(HTTPError):
handle_response(mock_response(code))
def test_handle_response_requesterror(mock_response, code, mock_request):
with pytest.raises(DataRequestException):
handle_response(mock_response(code))