ADD: Initial project files

Author: stuartmaynes

Diff for: .gitignore

@@ -0,0 +1 @@
+.pytest_cache/

Diff for: Pipfile

@@ -0,0 +1,14 @@
+[[source]]
+name = "pypi"
+url = "https://pypi.org/simple"
+verify_ssl = true
+
+[dev-packages]
+pytest = "*"
+pylint = "*"
+
+[packages]
+requests = "*"
+
+[requires]
+python_version = "3.8"

Diff for: Pipfile.lock

@@ -0,0 +1,51 @@
+import json, os
+import requests
+
+class Heroku:
+
+    def __init__(self, api_key=None, headers={}):
+        if api_key:
+            self.api_key = api_key
+        else:
+            self.api_key = os.getenv('HEROKU_API_KEY')
+
+        self.session = requests.Session()
+
+        self.session.headers.update({
+            'Accept': 'application/vnd.heroku+json; version=3',
+            'Authorization': f'Bearer {self.api_key}',
+            'Content-Type': 'application/json'
+        })
+
+        self.session.headers.update(headers)
+
+    def delete(self, endpoint):
+        """Return the result of making a DELETE
+        request to the Heroku Platform API"""
+
+        return self.session.delete(endpoint)
+
+    def get(self, endpoint, *args, **kwargs):
+        """Return the result of making a GET
+        request to the Heroku Platform API"""
+
+        return self.session.get(endpoint, *args, **kwargs)
+
+    def patch(self, endpoint, *args, **kwargs):
+        """Return the result of making a PATCH
+        request to the Heroku Platform API"""
+
+        return self.session.patch(endpoint, *args, **kwargs)
+
+    def put(self, endpoint, *args, **kwargs):
+        """Return the result of making a PUT
+        request to the Heroku Platform API"""
+
+        return self.session.put(endpoint, *args, **kwargs)
+
+    def post(self, endpoint, *args, **kwargs):
+        """Return the result of making a POST
+        request to the Heroku Platform API"""
+
+        return self.session.post(endpoint, *args, **kwargs)
+

Diff for: heroku/__init__.py

@@ -0,0 +1,15 @@
+# Heroku Platform Client
+
+A Python client for the Heroku Platfrom API.
+
+## Features
+- Reads `HEROKU_API_KEY` for zero-config use
+- Returns JSON-decoded Heroku API responses
+- Exposes response headers (necessary for some API functionality)
+
+## Requirements
+- Python "3.8"
+- Requests
+**Dev packages**
+- Pytest
+- Pylint

Diff for: heroku/heroku.py

@@ -0,0 +1,73 @@
+import os
+import pytest
+from unittest.mock import MagicMock
+from heroku.heroku import Heroku
+
+class TestHerokuClient:
+
+    def test_api_key_is_taken_from_environment_variable(self):
+        os.environ['HEROKU_API_KEY'] = '123-123-123'
+        heroku = Heroku()
+        assert heroku.api_key == '123-123-123'
+
+    def test_api_key_can_be_explicitly_set(self):
+        heroku = Heroku(api_key='ABC-ABC')
+        assert heroku.api_key == 'ABC-ABC'
+
+    def test_default_headers_are_set(self):
+        os.environ['HEROKU_API_KEY'] = '999-999-999'
+        heroku = Heroku()
+        expected = {
+            'Accept': 'application/vnd.heroku+json; version=3',
+            'Authorization': 'Bearer 999-999-999',
+            'Content-Type': 'application/json'
+        }
+        assert set(expected.items()).issubset(
+            set(heroku.session.headers.items())
+        )
+
+    def test_default_headers_are_set_with_passed_API_key(self):
+        heroku = Heroku(api_key='ABC-ABC-ABC')
+        expected = {
+            'Accept': 'application/vnd.heroku+json; version=3',
+            'Authorization': 'Bearer ABC-ABC-ABC',
+            'Content-Type': 'application/json'
+        }
+        assert set(expected.items()).issubset(
+            set(heroku.session.headers.items())
+        )
+
+    def test_calling_the_get_method_calls_requests_get_method(self):
+        heroku = Heroku()
+        heroku.session.get = MagicMock(return_value={})
+        heroku.get('endpoint/foo', params={})
+
+        heroku.session.get.assert_called_with('endpoint/foo',  params={})
+
+    def test_calling_the_post_method_calls_requests_post_method(self):
+        heroku = Heroku()
+        heroku.session.post = MagicMock(return_value={})
+        heroku.post('endpoint/foo', data={})
+
+        heroku.session.post.assert_called_with('endpoint/foo', data={})
+
+    def test_calling_the_patch_method_calls_requests_patch_method(self):
+        heroku = Heroku()
+        heroku.session.patch = MagicMock(return_value={})
+        heroku.patch('endpoint/foo', data={})
+
+        heroku.session.patch.assert_called_with('endpoint/foo', data={})
+
+    def test_calling_the_put_method_calls_requests_put_method(self):
+        heroku = Heroku()
+        heroku.session.put = MagicMock(return_value={})
+        heroku.put('endpoint/foo', data={})
+
+        heroku.session.put.assert_called_with('endpoint/foo', data={})
+
+    def test_calling_the_delete_method_calls_requests_delete_method(self):
+        heroku = Heroku()
+        heroku.session.delete = MagicMock(return_value={})
+        heroku.delete('endpoint/foo')
+
+        heroku.session.delete.assert_called_with('endpoint/foo')