Merge pull request #52 from dynata/dev

Release 1.0.3

Author: DynataRidley

.flake8

@@ -1,2 +1,2 @@
 [flake8]
-exclude=.git,.pytest_cache,venv
+exclude=.git,.pytest_cache,.venv,venv

.github/workflows/pythonpackage.yml

@@ -20,15 +20,19 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -r requirements.txt
+        curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py > get-poetry.py
+        python get-poetry.py --version 1.0.2 -y
+        $HOME/.poetry/bin/poetry install
+        rm get-poetry.py
     - name: Lint with flake8
       run: |
-        pip install flake8
+        # activate the virtualenv created by poetry
+        source .venv/bin/activate
         # stop the build if there are Python syntax errors or undefined names
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # the GitHub editor is 127 chars wide
         flake8 . --count --max-complexity=10 --max-line-length=127 --statistics
     - name: Test with pytest
       run: |
-        pip install pytest
+        source .venv/bin/activate
         pytest

.github/workflows/release.yml

@@ -20,15 +20,17 @@ jobs:
     - name: Install Poetry
       run: |
         python -m pip install --upgrade pip
-        pip install poetry
-        poetry install
+        curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py > get-poetry.py
+        python get-poetry.py --version 1.0.2 -y
+        $HOME/.poetry/bin/poetry install
+        rm get-poetry.py
     - name: Poetry - Set Version & Build
       run: |
-        poetry version ${{ steps.get_version.outputs.VERSION }}
-        poetry build
+        $HOME/.poetry/bin/poetry version ${{ steps.get_version.outputs.VERSION }}
+        $HOME/.poetry/bin/poetry build
     - name: Push to PyPI
       run: |
-        poetry publish --build --username "${{ secrets.PYPI_USERNAME }}" --password "${{ secrets.PYPI_PASSWORD }}" --no-interaction
+        $HOME/.poetry/bin/poetry publish --build --username "${{ secrets.PYPI_USERNAME }}" --password "${{ secrets.PYPI_PASSWORD }}" --no-interaction
     - name: Create Release
       id: create_release
       uses: actions/create-release@v1

dynatademand/api.py

@@ -424,3 +424,33 @@ def get_sources(self):
             'get_sources',
         )
         return self._api_get('/sources')
+
+    def reconcile_project(self, project_id, file, message):
+        '''
+            Sends a reconciliation request
+        '''
+        """
+            # Awaiting valid body & path schemas
+            self.validator.validate_request(
+                'update_line_item',
+                path_data={
+                    'extProjectId': '{}'.format(project_id),
+                },
+                request_body={
+                    'file': file,
+                    'message': message,
+                },
+            )
+        """
+        self._check_authentication()
+        url = '{}{}'.format(self.base_url, '/projects/{}/reconcile'.format(project_id))
+        request_headers = {
+            'Authorization': 'Bearer {}'.format(self._access_token),
+            'Content-Type': "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+        }
+        response = requests.post(url=url, data=file, 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()

dynatademand/schemas/request/body/reconcile_project.json

@@ -0,0 +1,11 @@
+{
+  "type": "object",
+  "properties": {
+    "file": {
+      "type": "file"
+    },
+    "message": {
+      "type": "string"
+    }
+  }
+}

dynatademand/schemas/request/path/reconcile_project.json

@@ -0,0 +1,12 @@
+{
+  "type": "object",
+  "properties": {
+    "extProjectId": {
+      "type": "string",
+      "required": true
+    }
+  },
+  "required": [
+    "extProjectId"
+  ]
+}

dynatademand/validator.py

@@ -16,6 +16,7 @@
     'update_project': ['path', 'body', ],
     'buy_project': ['path', 'body', ],
     'get_project_detailed_report': ['path', ],
+    'reconcile_project': ['path', ],
 
     # Invoices
     'get_invoice': ['path', ],

poetry.toml

@@ -0,0 +1,3 @@
+[virtualenvs]
+create = true
+in-project = true

pyproject.toml

@@ -3,16 +3,21 @@ name = "dynatademand"
 version = "1.0.2"
 description = "A Python client library for the Dynata Demand API"
 authors = ["Ridley Larsen <Ridley.Larsen@dynata.com>", "Bradley Wogsland <Bradley.Wogsland@dynata.com>", "Nathan Workman <Nathan.Workman@dynata.com>"]
+readme = "README.md"
+repository = "https://github.com/dynata/python-demandapi-client"
 
 [tool.poetry.dependencies]
 python = "^2.7 || ^3.5 || ^3.6 || ^3.7"
+requests = "2.22.0"
+jsonschema = "3.2.0"
+
+[tool.poetry.dev-dependencies]
 responses = "0.10.6"
 requests = "2.22.0"
 pytest = "4.6.6"
 jsonschema = "3.2.0"
 pytest-runner = "5.2"
-
-[tool.poetry.dev-dependencies]
+flake8 = "^3.7.9"
 
 [build-system]
 requires = ["poetry>=0.12"]

requirements.txt

@@ -108,7 +108,7 @@ def test_close_project(self):
 
     @responses.activate
     def test_update_project(self):
-        # Tests creating a project. This also tests validating the project data as part of `api.create_project`.
+        # Tests updating a project.
         with open('./tests/test_files/update_project.json', 'r') as update_project_file:
             update_project_data = json.load(update_project_file)
 
@@ -133,3 +133,30 @@ def test_update_project(self):
         with self.assertRaises(DemandAPIError):
             self.api.update_project(24, update_project_data)
         self.assertEqual(len(responses.calls), 2)
+
+    @responses.activate
+    def test_reconcile_project(self):
+        # Tests reconciling a project.
+        message = 'testing reconciliation'
+        with open('./tests/test_files/Data+Quality+Request+Template.xlsx', 'rb') as file:
+            # Success response
+            responses.add(
+                responses.POST,
+                '{}/sample/v1/projects/24/reconcile'.format(BASE_HOST),
+                json={'status': {'message': 'success'}},
+                status=200)
+            # Error message included
+            responses.add(
+                responses.POST,
+                '{}/sample/v1/projects/24/reconcile'.format(BASE_HOST),
+                json={'status': {'message': 'error'}},
+                status=400)
+
+            # Test successful response.
+            self.api.reconcile_project(24, file, message)
+            self.assertEqual(len(responses.calls), 1)
+
+            # Test response with error included.
+            with self.assertRaises(DemandAPIError):
+                self.api.reconcile_project(24, file, message)
+            self.assertEqual(len(responses.calls), 2)