Merge pull request #6 from Web-Power/futureproofing

Futureproofing: api framework

Author: lomignet

Makefile

@@ -104,7 +104,7 @@ testtestinstall:
 # -m venv is always there, conda maybe not.
 	python3 -m venv $(TESTENV)
 # Note: cd first to prevent the current directory to be found as valid module.
-	cd $(TESTENV) && $(TESTENV)/bin/python3 -m pip install --upgrade --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple pydundas
+	cd $(TESTENV) && $(TESTENV)/bin/python3 -m pip install --no-cache-dir --upgrade --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple pydundas
 	@echo Module version: $(shell $(PY3) -c 'from pydundas import __version__ as v; print(v)').
 	@echo Version on test Pypi: $(shell curl -s 'https://test.pypi.org/pypi/pydundas/json' | jq -r '.info.version').
 	@echo Version in test env: $(shell cd $(TESTENV) && $(TESTENV)/bin/pip3 freeze | grep -i pydundas).
@@ -124,7 +124,7 @@ testinstall:
 # -m venv is always there, conda maybe not.
 	python3 -m venv $(TESTENV)
 # Note: cd first to prevent the current directory to be found as valid module.
-	cd $(TESTENV) && $(TESTENV)/bin/python3 -m pip install --upgrade pydundas
+	cd $(TESTENV) && $(TESTENV)/bin/python3 -m pip install --no-cache-dir --upgrade pydundas
 	@echo Module version: $(shell $(PY3) -c 'from pydundas import __version__ as v; print(v)').
 	@echo Version on Pypi: $(shell curl -s 'https://test.pypi.org/pypi/pydundas/json' | jq -r '.info.version').
 	@echo Version in test env: $(shell cd $(TESTENV) && $(TESTENV)/bin/pip3 freeze | grep -i pydundas).

README.md

@@ -16,7 +16,7 @@ out, it will be done for you, in all cases if you so wish.
 
 # Why this module is useful
 
-It currently does 2 things for you.
+It currently does 3 things for you.
 
 If you use `dundas.Session` within a [context manager](https://docs.python.org/3/reference/datamodel.html#context-managers),
 the context manager wil log you in and out automagically, no matter what happens. You can
@@ -27,6 +27,9 @@ Each and every call to the API needs to have the same `sessionId` parameter. Thi
 shortcuts for you for `get`, `post` and `delete`, to make your life easier. You do not need
 to repeat the host, api path prefix or sessionId every single time.
 
+Some API calls are ported and might have helper methods. I am updating the module based on what I 
+need and use, so I do not expect to have everything ported on my own.
+
 # Installation
 
 Simply with pip:
@@ -174,6 +177,18 @@ The same would happen if you reuse an object after logging out.
 
 I'm not that mean and I won't burn through your elastic hours, but be careful and that's why context the manager is awesome.
 
+# API calls
+
+For example, to find the ID of a project:
+```python
+from pydundas import Api, Session, creds_from_yaml
+
+with Session(**creds_from_yaml('credentials.yaml')) as d:
+    a=Api(d)
+    project = a.project()
+    print(project.getProjectIDByName('DP'))
+```
+
 # Develop
 
 You can either use `conda` or `virtualenv`. Most relevant commands are in the Makefile.

pydundas/__init__.py

@@ -1,4 +1,5 @@
-__version__ = '1.2'
+__version__ = '1.3.1'
 
 # Nicer namespace for the caller
 from .dundas import Session, creds_from_yaml
+from .rest.api import Api as Api

pydundas/dundas.py

@@ -38,7 +38,7 @@ def __init__(self, *, user, pwd, url, loglevel=None):
 
         self.user, self.pwd = user, pwd
         self.url = url if url.startswith('http') else 'https://{}'.format(url)
-        self.api = self.url + '/api/'
+        self.endpoint = self.url + '/api/'
 
         # Will be setup within login()
         self.session_id = None
@@ -93,7 +93,7 @@ def login(self):
         }
         self.logger.info('Logging in.')
         # We can't use self.post() yet as session_id is not set.
-        r = self.s.post(self.api + 'logon/', json=login_data)
+        r = self.s.post(self.endpoint + 'logon/', json=login_data)
         # The following line exceptions out on not 200 return code.
         r.raise_for_status()
 
@@ -122,17 +122,28 @@ def is_loggedin(self):
 
     # All get/post/delete will have the same url base, and will all require the same
     # params parameter. Let's make everybody's life easy.
+    # A query could legitimately need to extend the 'params' parameter, hence the merge of kwargs
+    # with the hardcoded dict with sessionId.
+
+    def extend_with_sessionid(self, kwargs):
+        if 'params' in kwargs:
+            kwargs['params']['sessionId'] = self.session_id
+        else:
+            kwargs['params'] = {'sessionId': self.session_id}
+        return kwargs
+
+
     def get(self, url, **kwargs):
-        r = self.s.get(self.api + url, params={'sessionId': self.session_id}, **kwargs)
+        r = self.s.get(self.endpoint + url, **self.extend_with_sessionid(kwargs))
         r.raise_for_status()
         return r
 
     def post(self, url, **kwargs):
-        r = self.s.post(self.api + url, params={'sessionId': self.session_id}, **kwargs)
+        r = self.s.post(self.endpoint + url, **self.extend_with_sessionid(kwargs))
         r.raise_for_status()
         return r
 
     def delete(self, url, **kwargs):
-        r = self.s.delete(self.api + url, params={'sessionId': self.session_id}, **kwargs)
+        r = self.s.delete(self.endpoint + url, **self.extend_with_sessionid(kwargs))
         r.raise_for_status()
         return r

pydundas/rest/__init__.py

@@ -0,0 +1,12 @@
+class Api:
+
+    def __init__(self, session):
+        self.session = session
+        self._project = None
+
+    def project(self):
+        if not self._project:
+            from .project import Project
+            self._project = Project(self.session)
+
+        return self._project

pydundas/rest/api.py

@@ -0,0 +1,19 @@
+class ProjectNotFound(Exception):
+    pass
+
+
+class Project:
+
+    def __init__(self, session):
+        self.session = session
+
+    def getProjectIDByName(self, name):
+        ll = list(filter(lambda x: x['objectType'] == 'Project' and x['name'] == name, self.getAll()))
+        if len(ll):
+            return ll[0]['projectId']
+        else:
+            raise ProjectNotFound("No project named '{}'.".format(name))
+
+    def getAll(self):
+        """"Returns json representation of all projects."""
+        return self.session.get('Project', **{'params': {'options': 'None'}}).json()