Merge branch 'feature/add-authentication' into feature/add-authentication

Author: DynataRidley

.circleci/config.yml

@@ -0,0 +1,58 @@
+# Python CircleCI 2.0 configuration file
+#
+# Check https://circleci.com/docs/2.0/language-python/ for more details
+#
+version: 2
+jobs:
+  build:
+    docker:
+      # specify the version you desire here
+      # use `-browsers` prefix for selenium tests, e.g. `3.6.1-browsers`
+      - image: circleci/python:2.7.17
+
+      # Specify service dependencies here if necessary
+      # CircleCI maintains a library of pre-built images
+      # documented at https://circleci.com/docs/2.0/circleci-images/
+      # - image: circleci/postgres:9.4
+
+    working_directory: ~/repo
+
+    steps:
+      - checkout
+
+      # Download and cache dependencies
+      - restore_cache:
+          keys:
+            - v1-dependencies-{{ checksum "requirements.txt" }}
+            # fallback to using the latest cache if no exact match is found
+            - v1-dependencies-
+
+      - run:
+          name: install dependencies
+          command: |
+            virtualenv venv
+            . venv/bin/activate
+            pip install -r requirements.txt
+
+      - save_cache:
+          paths:
+            - ./venv
+          key: v1-dependencies-{{ checksum "requirements.txt" }}
+
+      # run tests!
+      # this example uses Django's built-in test-runner
+      # other common Python testing frameworks include pytest and nose
+      # https://pytest.org
+      # https://nose.readthedocs.io
+      - run:
+          name: run tests
+          command: |
+            . venv/bin/activate
+            pytest tests
+
+      - store_artifacts:
+          path: test-reports
+          destination: test-reports
+
+      - store_test_results:
+          path: test-reports

README.md

@@ -17,4 +17,4 @@ Information on [contributing](CONTRIBUTING.md).
 
 ## Testing
 
-<need some>
+Use the command `pytest tests` to run the tests for this project.

dynatademand/api.py

@@ -12,7 +12,7 @@ def __init__(self):
             raise DemandAPIError("All authentication data is required.")
         self._access_token = None
         self._refresh_token = None
-        self.base_host = os.getenv('DYNATA_DEMAND_BASE_URL', 'https://api.researchnow.com')
+        self.base_host = os.getenv('DYNATA_DEMAND_BASE_URL', default='https://api.researchnow.com')
         self.auth_base_url = '{}/auth/v1'.format(self.base_host)
         self.base_url = '{}/sample/v1'.format(self.base_host)
 

pycodestyle

@@ -0,0 +1,3 @@
+[pycodestyle]
+ignore = E501,E722
+statistics = True

pytest.ini

@@ -0,0 +1,5 @@
+[pytest]
+env=
+    DYNATA_DEMAND_CLIENT_ID="test_client_id"
+    DYNATA_DEMAND_USERNAME="test_username"
+    DYNATA_DEMAND_PASSWORD="test_password"

requirements.txt

@@ -0,0 +1,4 @@
+pytest==4.6.6
+pytest-runner==5.2
+requests==2.22.0
+responses==0.10.6

tests/__init__.py

@@ -0,0 +1,82 @@
+# encoding: utf-8
+from __future__ import unicode_literals, print_function
+
+import unittest
+import responses
+
+try:
+    from unittest.mock import patch
+except ImportError:
+    from mock import patch
+
+from dynatademand.api import DemandAPIClient
+from dynatademand.errors import DemandAPIError
+
+BASE_URL = "http://test-url.example"
+
+
+class AuthenticationTestMissingCredentials(unittest.TestCase):
+    @patch('os.getenv')
+    def test_missing_client_id(self, mock_getenv):
+        mock_getenv.side_effect = [
+            None,
+            "test_username",
+            "test_password",
+            BASE_URL
+        ]
+        with self.assertRaises(DemandAPIError):
+            DemandAPIClient()
+
+    @patch('os.getenv')
+    def test_missing_username(self, mock_getenv):
+        mock_getenv.side_effect = [
+            "test_client_id",
+            None,
+            "test_password",
+            BASE_URL
+        ]
+        with self.assertRaises(DemandAPIError):
+            DemandAPIClient()
+
+    @patch('os.getenv')
+    def test_missing_password(self, mock_getenv):
+        mock_getenv.side_effect = [
+            "test_client_id",
+            "test_username",
+            None,
+            BASE_URL
+        ]
+        with self.assertRaises(DemandAPIError):
+            DemandAPIClient()
+
+
+def api_test_url(endpoint):
+    return "{}{}".format(BASE_URL, endpoint)
+
+
+class AuthenticationTests(unittest.TestCase):
+    @patch('os.getenv')
+    def setUp(self, mock_getenv):
+        mock_getenv.side_effect = [
+            "test_client_id",
+            "test_username",
+            "test_password",
+            BASE_URL
+        ]
+        self.client = DemandAPIClient()
+        self.assertEqual(self.client.client_id, "test_client_id")
+
+    @responses.activate
+    def test_authenticate(self):
+        responses.add(
+            responses.POST,
+            "{}{}".format(self.client.auth_base_url, "/token/password"),
+            json={
+                "accessToken": "access_token",
+                "refreshToken": "refresh_token"
+            }
+        )
+        self.client.authenticate()
+        self.assertEqual(self.client._access_token, "access_token")
+        self.assertEqual(self.client._refresh_token, "refresh_token")
+        self.assertIsNone(self.client._check_authentication())