Feature/request parameters (#16)

* Make tests more detailed on task to test

We need more detailed tests for different tasks so we split
`api_connection` from `ensure_section` to test both tasks separatly.

* Support request parameters

In former versions we don't support request parameters, so we add these
feature now.
It's now possible to add a dictionary with parameters to each method
(`get_entity`, `create_entity`, `update_entity` and `delete_entity`).

Author: cmeissner

phpypam/core/api.py

@@ -71,6 +71,9 @@ def _query(self, **kwargs):
 
         _url = '{}/api/{}/{}'.format(self._api_url, self._api_appid, _api_path)
 
+        if _params and not _url.endswith('/'):
+            _url = _url + '/'
+
         resp = _method(
             _url,
             params=_params,
@@ -101,34 +104,38 @@ def get_token(self):
     def get_entity(self, controller, **kwargs):
         _path = controller
         _controller_path = kwargs.pop('controller_path', None)
+        _params = kwargs.pop('params', None)
 
         if _controller_path:
             _path = '{}/{}'.format(_path, _controller_path)
 
-        return self._query(token=self._api_token, method=GET, path=_path)
+        return self._query(token=self._api_token, method=GET, path=_path, params=_params)
 
     def create_entity(self, controller, data, **kwargs):
         _path = controller
         _controller_path = kwargs.pop('controller_path', None)
+        _params = kwargs.pop('params', None)
 
         if _controller_path:
             _path = '{}/{}'.format(_path, _controller_path)
 
-        return self._query(token=self._api_token, method=POST, path=_path, data=data)
+        return self._query(token=self._api_token, method=POST, path=_path, data=data, params=_params)
 
     def delete_entity(self, controller, controller_path, **kwargs):
         _path = '{}/{}'.format(controller, controller_path)
+        _params = kwargs.pop('params', None)
 
-        return self._query(token=self._api_token, method=DELETE, path=_path)
+        return self._query(token=self._api_token, method=DELETE, path=_path, params=_params)
 
     def update_entity(self, controller, data, **kwargs):
         _path = controller
         _controller_path = kwargs.pop('controller_path', None)
+        _params = kwargs.pop('params', None)
 
         if _controller_path:
             _path = '{}/{}'.format(_path, _controller_path)
 
-        return self._query(token=self._api_token, method=PATCH, path=_path, data=data)
+        return self._query(token=self._api_token, method=PATCH, path=_path, data=data, params=_params)
 
     def controllers(self):
         result = self._query(token=self._api_token, method=OPTIONS, path='/')

tests/api_connection.py

@@ -19,28 +19,4 @@
         ssl_verify=True
     )
 
-    my_section = dict(
-        name='foobar',
-        description='new section',
-        permissions='{"3":"1","2":"2"}'
-    )
-    try:
-        entity = pi.get_entity(controller='sections', controller_path=my_section['name'])
-    except PHPyPAMEntityNotFoundException:
-        print('create entity')
-        entity = pi.create_entity(controller='sections', data=my_section)
-        entity = pi.get_entity(controller='sections', controller_path=my_section['name'])
-
-    entity = pi.get_entity(controller='sections', controller_path=my_section['name'])
-    print(json.dumps(entity, indent=4, sort_keys=True))
-
-    my_section['description'] = 'new description'
-
-    print('update entity')
-    pi.update_entity(controller='sections', controller_path=entity['id'], data=my_section)
-
-    entity = pi.get_entity(controller='sections', controller_path=my_section['name'])
-    print(json.dumps(entity, indent=4, sort_keys=True))
-
-    print('delete entity')
-    pi.delete_entity(controller='sections', controller_path=entity['id'])
+    print(pi.get_token())

tests/ensure_section.py

@@ -0,0 +1,46 @@
+#!/usr/bin/env python
+
+import phpypam
+import json
+import yaml
+
+with open('tests/vars/server.yml') as c:
+    server = yaml.safe_load(c)
+
+from phpypam import PHPyPAMEntityNotFoundException
+
+
+if __name__ == '__main__':
+    pi = phpypam.api(
+        url=server['url'],
+        app_id=server['app_id'],
+        username=server['username'],
+        password=server['password'],
+        ssl_verify=True
+    )
+
+    my_section = dict(
+        name='foobar',
+        description='new section',
+        permissions='{"3":"1","2":"2"}'
+    )
+    try:
+        entity = pi.get_entity(controller='sections', controller_path=my_section['name'])
+    except PHPyPAMEntityNotFoundException:
+        print('create entity')
+        entity = pi.create_entity(controller='sections', data=my_section)
+        entity = pi.get_entity(controller='sections', controller_path=my_section['name'])
+
+    entity = pi.get_entity(controller='sections', controller_path=my_section['name'])
+    print(json.dumps(entity, indent=4, sort_keys=True))
+
+    my_section['description'] = 'new description'
+
+    print('update entity')
+    pi.update_entity(controller='sections', controller_path=entity['id'], data=my_section)
+
+    entity = pi.get_entity(controller='sections', controller_path=my_section['name'])
+    print(json.dumps(entity, indent=4, sort_keys=True))
+
+    print('delete entity')
+    pi.delete_entity(controller='sections', controller_path=entity['id'])

tests/search_section_by_name.py

@@ -0,0 +1,32 @@
+#!/usr/bin/env python
+
+import phpypam
+import json
+import yaml
+
+with open('tests/vars/server.yml') as c:
+    server = yaml.safe_load(c)
+
+from phpypam import PHPyPAMEntityNotFoundException
+
+
+if __name__ == '__main__':
+    pi = phpypam.api(
+        url=server['url'],
+        app_id=server['app_id'],
+        username=server['username'],
+        password=server['password'],
+        ssl_verify=True
+    )
+
+    search_params = [
+        {'filter_by': 'name', 'filter_value': 'non_existing_section'},
+        {'filter_by': 'name', 'filter_value': 'IPv6', 'filter_match': 'full'},
+    ]
+
+    for search in search_params:
+        try:
+            entity = pi.get_entity(controller='sections', params=search)
+            print("""Entity with name '{0}' found:\nResult:\n{1}""".format(search['filter_value'], json.dumps(entity, indent=2, sort_keys=True)))
+        except PHPyPAMEntityNotFoundException:
+            print("Entity with name '{0}' not found.".format(search['filter_value']))