Skip to content

Fix #57 - add headers parameter to methods create, update and delete #58

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Fix #57 - add headers parameter to methods create, update and delete #58

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
f0eea8d
add 'hearders' arg to methods create, update and delete
positiveEV Aug 3, 2022
90f1528
add changelog entry
cmeissner Aug 13, 2022
b41fcf9
Merge branch 'codeaffen:develop' into develop
positiveEV Aug 16, 2022
f7a8e3f
add 'hearders' arg to get_entity
positiveEV Aug 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
* Add ability to use ```podman``` if available on your system to spin up local test environment.

### Fixes
* \#57 - add headers parameter to methods create, update and delete
* to modify the the output format header `Content-Type: application/xml` is needed
* requests to `/addresses` endpoint needs sometimes `Content-Type: application/x-www-form-urlencoded` to work

* \#51 - Subnet address search with zero results raises incorrect exception

Expand Down
28 changes: 20 additions & 8 deletions phpypam/core/api.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ def get_token(self):
"""
return self._api_token

def get_entity(self, controller, controller_path=None, params=None):
def get_entity(self, controller, controller_path=None, params=None, headers=None):
"""Get existing entity from phpIPAM server.

This method query for existing entity. It there a result it will be returned otherwise
Expand All @@ -153,20 +153,23 @@ def get_entity(self, controller, controller_path=None, params=None):
:type controller_path: str, optional
:param params: Request parameters which have to be append to the request URI, defaults to None
:type params: dict, optional
:param headers: Optional request headers, defaults to None
:type headers: dict, optional

:return: Result of the query. It can be either a 'list' or 'dict'.
:rtype: Union[dict, list]
"""
_path = controller
_controller_path = controller_path
_params = params
_headers = headers

if _controller_path:
_path = '{}/{}'.format(_path, _controller_path)

return self._query(token=self._api_token, method=GET, path=_path, params=_params)
return self._query(token=self._api_token, method=GET, path=_path, params=_params, headers=None)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an error, you need to pass _headers here.


def create_entity(self, controller, controller_path=None, data=None, params=None):
def create_entity(self, controller, controller_path=None, data=None, params=None, headers=None):
"""Create an entity.

:param controller: Name of the controller to use.
Expand All @@ -177,20 +180,23 @@ def create_entity(self, controller, controller_path=None, data=None, params=None
:type data: dict
:param params: Dictionary list of tuples or bytes to send in the query string for the :class:`Request`., defaults to None
:type params: dict, optional
:param headers: Optional request headers, defaults to None
:type headers: dict, optional

:return: Returns the newly created entity.
:rtype: Union[dict, list]
"""
_path = controller
_controller_path = controller_path
_params = params
_headers = headers

if _controller_path:
_path = '{}/{}'.format(_path, _controller_path)

return self._query(token=self._api_token, method=POST, path=_path, data=data, params=_params)
return self._query(token=self._api_token, method=POST, path=_path, data=data, params=_params, headers=_headers)

def delete_entity(self, controller, controller_path, params=None):
def delete_entity(self, controller, controller_path, params=None, headers=None):
"""Delete an entity.

:param controller: Name of the controller to use.
Expand All @@ -199,16 +205,19 @@ def delete_entity(self, controller, controller_path, params=None):
:type controller_path: str
:param params: Dictionary, list of tuples or bytes to send in the query string for the :class:`Request`., defaults to None
:type params: dict, optional
:param headers: Optional request headers, defaults to None
:type headers: dict, optional

:return: Returns True if entity was deleted successfully or either 'dict' or 'list' of entities to work on.
:rtype: Union[book, dict, list]
"""
_path = '{}/{}'.format(controller, controller_path)
_params = params
_headers = headers

return self._query(token=self._api_token, method=DELETE, path=_path, params=_params)
return self._query(token=self._api_token, method=DELETE, path=_path, params=_params, headers=_headers)

def update_entity(self, controller, controller_path=None, data=None, params=None):
def update_entity(self, controller, controller_path=None, data=None, params=None, headers=None):
"""Update an entity.

:param controller: Name of the controller to use.
Expand All @@ -219,18 +228,21 @@ def update_entity(self, controller, controller_path=None, data=None, params=None
:type data: dict, optional
:param params: Dictionary list of tuples or bytes to send in the query string for the :class:`Request`., defaults to None
:type params: dict, optional
:param headers: Optional request headers, defaults to None
:type headers: dict, optional

:return: Returns either a 'dict' or 'list' of the changed entity
:rtype: Union[dict, list]
"""
_path = controller
_controller_path = controller_path
_params = params
_headers = headers

if _controller_path:
_path = '{}/{}'.format(_path, _controller_path)

return self._query(token=self._api_token, method=PATCH, path=_path, data=data, params=_params)
return self._query(token=self._api_token, method=PATCH, path=_path, data=data, params=_params, headers=_headers)

def controllers(self):
"""Report all controllers from phpIPAM API.
Expand Down