add actions (#1)

* Add GitHub actions
* Add tox to execute pytest
* Update to use paths instead of full url

Author: jaschultz

.github/workflows/pythonapp.yml

@@ -0,0 +1,22 @@
+name: Tox
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Python 3.7
+      uses: actions/setup-python@v1
+      with:
+        python-version: 3.7
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox
+    - name: Test with pytest
+      run: |
+        tox

.gitignore

@@ -102,3 +102,7 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+# IDE
+.idea/
+.vscode/

requirements.testing.txt

@@ -0,0 +1,3 @@
+pytest
+pytest-mock
+requests-mock

requirements.txt

@@ -0,0 +1 @@
+requests

setup.py

@@ -0,0 +1,15 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='testspace-python',
+    version='',
+    packages=find_packages(include=['testspace', 'testspace.*']),
+    url='',
+    license="MIT license",
+    author="Jeffrey Schultz",
+    author_email='[email protected]',
+    description="Module for interacting with Testspace Server",
+    install_requires=[
+        'requests',
+    ]
+)

tests/test_testspace_api.py

@@ -8,7 +8,7 @@
 
 @pytest.fixture(scope="function")
 def load_json(request):
-    with open(os.path.join("mock_requests", request.param)) as file_handle:
+    with open(os.path.join("tests", "mock_requests", request.param)) as file_handle:
         return json.load(file_handle)
 
 
@@ -399,7 +399,7 @@ def test_get_result_contents_nested(load_json, testspace_api, requests_mock):
         ),
         json=load_json,
     )
-    response_json = testspace_api.get_result_contents(result, path="tests")
+    response_json = testspace_api.get_result_contents(result, contents_path="tests")
 
     assert response_json == load_json
 

testspace/testspace.py

@@ -74,127 +74,110 @@ def get_api_endpoints(self):
         return self.get_request_json()
 
     def get_projects(self, limit=30):
-        return self.get_request_json(request_url=self.get_projects_url(), limit=limit)
+        return self.get_request_json(path=self.get_projects_path(), limit=limit)
 
     def get_project(self, project=None):
-        return self.get_request_json(request_url=self.get_project_url(project))
+        return self.get_request_json(path=self.get_project_path(project))
 
     def get_spaces(self, project=None, limit=30):
-        return self.get_request_json(
-            request_url=self.get_spaces_url(project), limit=limit
-        )
+        return self.get_request_json(path=self.get_spaces_path(project), limit=limit)
 
     def get_space(self, project=None, space=None):
-        return self.get_request_json(request_url=self.get_space_url(project, space))
+        return self.get_request_json(path=self.get_space_path(project, space))
 
     def get_results(self, project=None, space=None, limit=30):
         return self.get_request_json(
-            request_url=self.get_results_url(project, space), limit=limit
+            path=self.get_results_path(project, space), limit=limit
         )
 
     def get_result(self, result, project=None, space=None):
-        return self.get_request_json(
-            request_url=self.get_result_url(result, project, space)
-        )
+        return self.get_request_json(path=self.get_result_path(result, project, space))
 
     def get_result_failures(self, result, project=None, space=None, limit=30):
         return self.get_request_json(
-            self.get_result_url(result, project, space), path="failures", limit=limit
+            path="/".join([self.get_result_path(result, project, space), "failures"]),
+            limit=limit,
         )
 
     def get_result_contents(
-        self, result, path=None, project=None, space=None, limit=30
+        self, result, contents_path=None, project=None, space=None, limit=30
     ):
-        if path is None:
-            path = "contents"
-        elif "contents" not in path:
-            path = "/".join(["contents", path])
+        if contents_path is None:
+            contents_path = "contents"
+        elif contents_path.startswith("contents") is not True:
+            contents_path = "/".join(["contents", contents_path])
         return self.get_request_json(
-            self.get_result_url(result, project, space), path=path, limit=limit
+            path="/".join(
+                [self.get_result_path(result, project, space), contents_path]
+            ),
+            limit=limit,
         )
 
     def get_metrics(self, project=None, space=None, limit=30):
-        return self.get_request_json(self.get_metrics_url(project, space), limit=limit)
+        return self.get_request_json(self.get_metrics_path(project, space), limit=limit)
 
     def get_metric(self, metric, project=None, space=None):
         if type(metric) is not int:
             raise ValueError
-        return self.get_request_json(self.get_metric_url(metric, project, space))
+        return self.get_request_json(self.get_metric_path(metric, project, space))
 
     def get_metric_datasets(self, metric, project=None, space=None, limit=30):
         return self.get_request_json(
-            self.get_metric_url(metric, project, space), path="datasets", limit=limit
+            "/".join([self.get_metric_path(metric, project, space), "datasets"]),
+            limit=limit,
         )
 
     def post_projects(self, payload):
-        return self.post_request_json(
-            request_url=self.get_projects_url(), payload=payload
-        )
+        return self.post_request_json(path=self.get_projects_path(), payload=payload)
 
     def post_spaces(self, payload):
-        return self.post_request_json(
-            request_url=self.get_spaces_url(), payload=payload
-        )
+        return self.post_request_json(path=self.get_spaces_path(), payload=payload)
 
     def post_results(self, payload):
-        return self.post_request_json(
-            request_url=self.get_results_url(), payload=payload
-        )
+        return self.post_request_json(path=self.get_results_path(), payload=payload)
 
     def post_metrics(self, payload):
-        return self.post_request_json(
-            request_url=self.get_metrics_url(), payload=payload
-        )
+        return self.post_request_json(path=self.get_metrics_path(), payload=payload)
 
     def patch_project(self, payload, project=None):
         return self.patch_request(
-            request_url=self.get_project_url(project=project), payload=payload
+            path=self.get_project_path(project=project), payload=payload
         )
 
     def patch_space(self, payload, project=None, space=None):
         return self.patch_request(
-            request_url=self.get_space_url(project=project, space=space),
-            payload=payload,
+            path=self.get_space_path(project=project, space=space), payload=payload
         )
 
     def patch_metric(self, payload, metric):
-        return self.patch_request(
-            request_url=self.get_metric_url(metric), payload=payload
-        )
+        return self.patch_request(path=self.get_metric_path(metric), payload=payload)
 
     def patch_result(self, payload, result):
-        return self.patch_request(
-            request_url=self.get_result_url(result), payload=payload
-        )
+        return self.patch_request(path=self.get_result_path(result), payload=payload)
 
     def delete_project(self, project=None):
-        return self.delete_request(request_url=self.get_project_url(project=project))
+        return self.delete_request(path=self.get_project_path(project=project))
 
     def delete_space(self, project=None, space=None):
         return self.delete_request(
-            request_url=self.get_space_url(project=project, space=space)
+            path=self.get_space_path(project=project, space=space)
         )
 
     def delete_result(self, result):
-        return self.delete_request(request_url=self.get_result_url(result))
+        return self.delete_request(path=self.get_result_path(result))
 
     def delete_metric(self, metric):
-        return self.delete_request(request_url=self.get_metric_url(metric))
+        return self.delete_request(path=self.get_metric_path(metric))
 
-    def get_request(self, request_url=None, path=None):
-        if request_url is None:
-            request_url = self.get_api_url()
-        if path is not None:
-            request_url = "/".join([request_url, path])
-
-        response = self._api_request("GET", request_url)
+    def get_request(self, path=None):
+        response = self._api_request("GET", path=path)
         return response
 
-    def get_request_json(self, request_url=None, path=None, limit=30):
+    def get_request_json(self, path=None, limit=30):
         if type(limit) is not int or limit <= 0:
             raise ValueError
-        response = self.get_request(request_url, path)
-        if len(response.links) is 0:
+        response = self.get_request(path)
+        if len(response.links) == 0:
             return response.json()
         else:
             next_url = response.links.get("next", None)
@@ -205,63 +188,69 @@ def get_request_json(self, request_url=None, path=None, limit=30):
                 response_json.extend(response.json())
         return response_json[:limit]
 
-    def post_request(self, payload, request_url):
-        response = self._api_request("POST", request_url, payload)
+    def post_request(self, payload, path=None):
+        response = self._api_request("POST", path=path, payload=payload)
         return response
 
-    def post_request_json(self, payload, request_url):
-        response = self.post_request(payload, request_url)
+    def post_request_json(self, payload, path=None):
+        response = self.post_request(payload, path=path)
         return response.json()
 
-    def patch_request(self, payload, request_url=None):
-        response = self._api_request("PATCH", request_url, payload)
+    def patch_request(self, payload, path=None):
+        response = self._api_request("PATCH", path=path, payload=payload)
         return response
 
-    def delete_request(self, request_url):
-        response = self._api_request("DELETE", request_url)
+    def delete_request(self, path=None):
+        response = self._api_request("DELETE", path=path)
         return response
 
     def get_api_url(self):
         return self.api_url
 
-    def get_projects_url(self):
-        return "/".join([self.get_api_url(), "projects"])
+    def get_projects_path(self):
+        return "projects"
 
-    def get_project_url(self, project=None):
+    def get_project_path(self, project=None):
         if project is None:
             if self.project is not None:
                 project = self.project
             else:
                 raise ValueError
-        return "/".join([self.get_projects_url(), str(project)])
+        return "/".join([self.get_projects_path(), str(project)])
 
-    def get_spaces_url(self, project=None):
-        return "/".join([self.get_project_url(project), "spaces"])
+    def get_spaces_path(self, project=None):
+        return "/".join([self.get_project_path(project), "spaces"])
 
-    def get_space_url(self, project=None, space=None):
+    def get_space_path(self, project=None, space=None):
         if project is None and type(space) is int:
-            return "/".join([self.get_api_url(), "spaces", str(space)])
+            return "/".join(["spaces", str(space)])
         elif space is None:
             if self.space is not None:
                 space = self.space
             else:
                 raise ValueError
 
-        return "/".join([self.get_spaces_url(project), str(space)])
+        return "/".join([self.get_spaces_path(project), str(space)])
 
-    def get_results_url(self, project=None, space=None):
-        return "/".join([self.get_space_url(project, space), "results"])
+    def get_results_path(self, project=None, space=None):
+        return "/".join([self.get_space_path(project, space), "results"])
 
-    def get_result_url(self, result, project=None, space=None):
-        return "/".join([self.get_results_url(project, space), str(result)])
+    def get_result_path(self, result, project=None, space=None):
+        return "/".join([self.get_results_path(project, space), str(result)])
 
-    def get_metrics_url(self, project=None, space=None):
-        return "/".join([self.get_space_url(project, space), "metrics"])
+    def get_metrics_path(self, project=None, space=None):
+        return "/".join([self.get_space_path(project, space), "metrics"])
 
-    def get_metric_url(self, metric, project=None, space=None):
-        return "/".join([self.get_metrics_url(project, space), str(metric)])
+    def get_metric_path(self, metric, project=None, space=None):
+        return "/".join([self.get_metrics_path(project, space), str(metric)])
 
-    def _api_request(self, method, request_url, payload=None):
+    def _api_request(self, method, path, payload=None):
+        if path is None:
+            request_url = self.get_api_url()
+        elif self.get_api_url() in path:
+            request_url = path
+        else:
+            request_url = "/".join([self.get_api_url(), path])
         response = requests.request(
             method=method,
             url=request_url,

tox.ini

@@ -0,0 +1,8 @@
+[testenv]
+deps =
+    -r{toxinidir}/requirements.txt
+    -r{toxinidir}/requirements.testing.txt
+
+setenv = PYTHONPATH = {toxinidir}
+
+commands=pytest tests