def __request(self, method, params=None, key=None, body=None, url=None):
if method != 'GET':
if not self.auth_token:
raise exceptions.AuthException(
'Authentication credentials were not provided')
if self.auth:
raise exceptions.AuthException(
'With basic authentication the API is not writable.')
if url is None:
if key is not None:
url = self.base_url + str(params) + str('{}/'.format(key))
else:
url = self.base_url + str(params)
request = requests.Request(method=method, url=url, json=body)
prepared_request = self.session.prepare_request(request)
try:
response = self.session.send(prepared_request)
except requests.exceptions.ConnectionError:
err_msg = 'Unable to connect to Netbox host: {}'.format(self.host)
raise ConnectionError(err_msg) from None
except requests.exceptions.Timeout:
raise TimeoutError('Connection to Netbox host timed out') from None
except Exception as e:
raise Exception(e)
finally:
self.close()
if not 200 <= response.status_code < 300:
self.__raise_error(response.status_code, response.content)
if response.status_code == 204:
return response.content
try:
response_data = response.json()
except json.JSONDecodeError:
raise exceptions.ServerException(response.content) from None
return response_data
def delete(self, params, del_id):
if self.auth:
raise exceptions.AuthException(
'With basic authentication the API is not writable')
del_str = '{}{}'.format(params, del_id)
resp_ok, resp_status, resp_data = self.__request('DELETE', del_str)
if resp_ok and resp_status == 204:
return True
else:
raise exceptions.DeleteException(resp_data)
def __request(self, method, params=None, key=None, body=None, url=None):
if method is 'post' or 'patch' or 'delete':
if not self.auth_token:
raise exceptions.AuthException(
'Authentication credentials were not provided')
if self.auth:
raise exceptions.AuthException(
'With basic authentication the API is not writable.')
if url is None:
if key is not None:
url = self.base_url + str(params) + str('{}/'.format(key))
else:
url = self.base_url + str(params)
request = requests.Request(method=method, url=url, json=body)
prepared_request = self.session.prepare_request(request)
try:
response = self.session.send(prepared_request)
except socket.gaierror:
err_msg = 'Unable to find address: {}'.format(self.host)
raise socket.gaierror(err_msg)
except requests.exceptions.ConnectionError:
err_msg = 'Unable to connect to Netbox host: {}'.format(self.host)
raise ConnectionError(err_msg)
except requests.exceptions.Timeout:
raise TimeoutError('Connection to Netbox host timed out')
except Exception as e:
raise Exception(e)
finally:
self.close()
try:
response_data = response.json()
except:
response_data = response.content
return response.ok, response.status_code, response_data
def patch(self, params, key, **kwargs):
if self.auth:
raise exceptions.AuthException(
'With basic auth the API is not writable')
body_data = {key: value for (key, value) in kwargs.items()}
resp_ok, resp_status, resp_data = self.__request('PATCH',
params=params,
key=key,
body=body_data)
if resp_ok and resp_status == 200:
return True
else:
raise exceptions.UpdateException(resp_data)
def post(self, params, required_fields, **kwargs):
if self.auth:
raise exceptions.AuthException(
'With basic auth the API is not writable')
body_data = {key: value for (key, value) in required_fields.items()}
if kwargs:
body_data.update({key: value for (key, value) in kwargs.items()})
resp_ok, resp_status, resp_data = self.__request('POST',
params=params,
body=body_data)
if resp_ok and resp_status == 201:
return True
else:
raise exceptions.CreateException(resp_data)
def __init__(self,
ssl_verify=False,
use_ssl=True,
host=None,
auth_token=None,
auth=None,
port=None,
api_prefix=None,
extra_headers=None):
self.use_ssl = use_ssl
self.host = host
self.auth_token = auth_token
self.port = port
self.auth = auth
self.api_prefix = api_prefix
self.base_url = 'http{s}://{host}{p}{prefix}'.format(
s='s' if use_ssl else '',
p=':{}'.format(self.port) if self.port else '',
host=self.host,
prefix='/api' if api_prefix is None else api_prefix)
self.session = requests.Session()
self.session.verify = ssl_verify
if auth:
self.session.auth = auth
if auth_token:
token = 'Token {}'.format(self.auth_token)
self.session.headers.update({'Authorization': token})
self.session.headers.update({'Accept': 'application/json'})
self.session.headers.update({'Content-Type': 'application/json'})
if auth and auth_token:
raise exceptions.AuthException(
'Only one authentication method is possible. Please use auth or auth_token'
)
if extra_headers:
self.session.headers.update(extra_headers)
def put(self, params):
if self.auth:
raise exceptions.AuthException(
'With basic auth the API is not writable')
return self.__request('PUT', params)