Merge pull request #2 from researchnow/feature/add-authentication

Adds Authentication methods.

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

.env-example

@@ -0,0 +1,3 @@
+DYNATA_DEMAND_CLIENT_ID=
+DYNATA_DEMAND_USERNAME=
+DYNATA_DEMAND_PASSWORD=

CONTRIBUTING.md

@@ -0,0 +1,27 @@
+### Contributing to python-demandapi-client
+
+This is an InnerSource python project. It is the work of someone who thought it might benefit someone else in the company as well.
+
+### Maintainers
+
+This repository is maintained by
+
+1. [Ridley Larsen](@RidleyLarsen)
+
+## Contributing Code
+
+The best place to start is by looking at the [Samplify Integration board](https://app.asana.com/0/1143497512179452/board), which is for the initial build. If you decide to take on a task make sure to assign it to yourself so we don't duplicate work. A good PR completely resolves the associated Asana issue, passes or python linting, and includes test coverage for your new code. This Github repository is integrated with CircleCI, so a PR cannot be accepted that has merge conflicts, fails to pass linting or tests, or lowers the repository's test coverage. Additionally your PR should include a high level description of your or reviewers will be peppering you with questions, if this is something someone might have a question about in the future then go ahead and add this information to the [docs](docs). Approval of the maintainer is required merge a PR into `dev`, which is where all PRs go. 
+
+## Linting
+
+Linting software is strongly recommended to improve code quality and maintain readability in Python projects. Python's official linting package is called pycodestyle, but another useful linting package is called flake8. Flake8 runs three different linters on your code, including pycodestyle, and a package called PyFlakes that checks for things like unused imports.
+
+Read more [here](http://flake8.pycqa.org/en/latest/)
+
+## Testing
+
+## Filing Issues
+
+Please use the [GitHub Issues](https://github.com/researchnow/python-demandapi-client/issues/new) to file an issue.
+
+Thats it.

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 Research Now
+Copyright (c) 2019 Dynata
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,2 +1,27 @@
 # python-demandapi-client
-A Python client library for the Dynata Demand API
+A Python client library for the [Dynata Demand API](https://developers.dynata.com/)
+## Setup
+
+The client requires environment variables to be set for the Dynata Demand API credentials. These can be found in `.env-example`.
+
+## Example Usage
+
+    demandapi = DemandAPIClient()
+    demandapi.authenticate()
+    demandapi.logout()
+
+## Contributing
+
+Information on [contributing](CONTRIBUTING.md).
+
+## Testing
+
+To run the tests,
+
+    virtualenv venv
+    . venv/bin/activate
+    pip install -r requirements.txt
+    pytest tests
+    deactivate
+
+to run the tests for this project.

demandapi/api.py

@@ -0,0 +1,2 @@
+from .api import DemandAPIClient  # noqa
+from .errors import DemandAPIError  # noqa

dynatademand/__init__.py

@@ -0,0 +1,81 @@
+import os
+import requests
+from .errors import DemandAPIError
+
+
+class DemandAPIClient(object):
+    def __init__(self):
+        self.client_id = os.getenv('DYNATA_DEMAND_CLIENT_ID', None)
+        self.username = os.getenv('DYNATA_DEMAND_USERNAME', None)
+        self.password = os.getenv('DYNATA_DEMAND_PASSWORD', None)
+        if None in [self.client_id, self.username, self.password]:
+            raise DemandAPIError("All authentication data is required.")
+        self._access_token = None
+        self._refresh_token = None
+        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)
+
+    def _check_authentication(self):
+        if self._access_token is None:
+            raise DemandAPIError('The API instance must be authenticated before calling this method.')
+
+    def _api_post(self, uri, payload):
+        # Send an authenticated POST request to an API endpoint.
+        self._check_authentication()
+        url = '{}{}'.format(self.base_url, uri)
+        request_headers = {
+            'oauth_access_token': self._access_token,
+            'Content-Type': "application/json",
+        }
+        response = requests.post(url=url, json=payload, headers=request_headers)
+        if response.status_code > 399:
+            raise DemandAPIError('Demand API request to {} failed with status {}. Response: {}'.format(
+                url, response.status_code, response.content
+            ))
+        return response.json()
+
+    def authenticate(self):
+        url = '{}/token/password'.format(self.auth_base_url)
+        auth_response = requests.post(url, json={
+            'clientId': self.client_id,
+            'password': self.password,
+            'username': self.username,
+        })
+        if auth_response.status_code > 399:
+            raise DemandAPIError('Authentication failed with status {} and error: {}'.format(
+                auth_response.status_code,
+                auth_response.json())
+            )
+        response_data = auth_response.json()
+        self._access_token = response_data.get('accessToken')
+        self._refresh_token = response_data.get('refreshToken')
+        return response_data
+
+    def refresh_access_token(self):
+        url = '{}/token/refresh'.format(self.auth_base_url)
+        refresh_response = requests.post(url, json={
+            'clientId': self.client_id,
+            'refreshToken': self._refresh_token
+        })
+        if refresh_response.status_code != 200:
+            raise DemandAPIError("Refreshing Access Token failed with status {} and error: {}".format(
+                refresh_response.status_code, refresh_response.content
+            ))
+        response_data = refresh_response.json()
+        self._access_token = response_data.get('accessToken')
+        self._refresh_token = response_data.get('refreshToken')
+        return response_data
+
+    def logout(self):
+        url = '{}/logout'.format(self.auth_base_url)
+        logout_response = requests.post(url, json={
+            'clientId': self.client_id,
+            'refreshToken': self._refresh_token,
+            'accessToken': self._access_token
+        })
+        if logout_response.status_code != 204:
+            raise DemandAPIError("Log out failed with status {} and error: {}".format(
+                logout_response.status_code, logout_response.content
+            ))
+        return logout_response.json()

dynatademand/api.py

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