app/notify_client/api_key_api_client.py

from app.notify_client import NotifyAdminAPIClient, _attach_current_user

# must match key types in notifications-api/app/models.py
KEY_TYPE_NORMAL = "normal"
KEY_TYPE_TEAM = "team"
KEY_TYPE_TEST = "test"


class ApiKeyApiClient(NotifyAdminAPIClient):
    def get_api_keys(self, service_id):
        return self.get(url="/service/{}/api-keys".format(service_id))

    def create_api_key(self, service_id, key_name, key_type):
        data = {"name": key_name, "key_type": key_type}
        data = _attach_current_user(data)
        key = self.post(url="/service/{}/api-key".format(service_id), data=data)
        return key["data"]

    def revoke_api_key(self, service_id, key_id):
        data = _attach_current_user({})
        return self.post(
            url="/service/{0}/api-key/revoke/{1}".format(service_id, key_id), data=data
        )


api_key_api_client = ApiKeyApiClient()
Enforce order and style of imports Done using isort[1], with the following command: ``` isort -rc ./app ./tests ``` Adds linting to the `run_tests.sh` script to stop badly-sorted imports getting re-introduced. Chosen style is ‘Vertical Hanging Indent’ with trailing commas, because I think it gives the cleanest diffs, eg: ``` from third_party import ( lib1, lib2, lib3, lib4, ) ``` 1. https://pypi.python.org/pypi/isort 2018-02-20 11:22:17 +00:00			`from app.notify_client import NotifyAdminAPIClient, _attach_current_user`
Created api_key_api_client. Implementation of create, revoke and show api keys for service. These calls work, however we still need to fix the tests. 2016-01-20 17:32:55 +00:00
send key_type = normal when creating api keys 2016-06-27 12:02:16 +01:00			`# must match key types in notifications-api/app/models.py`
notify-api-412 use black to enforce python coding style 2023-08-25 09:12:23 -07:00			`KEY_TYPE_NORMAL = "normal"`
			`KEY_TYPE_TEAM = "team"`
			`KEY_TYPE_TEST = "test"`
send key_type = normal when creating api keys 2016-06-27 12:02:16 +01:00

Use the local APIClient rather than the one from the python-api-client - ensures that all API calls set the request ID when talking to the API. 2016-11-30 17:01:44 +00:00			`class ApiKeyApiClient(NotifyAdminAPIClient):`
Don’t do multiple get API calls when revoking It’s redundant to make two API calls here, one to get all keys and one to get a single key. Since the API calls are sequential we can speed things up by getting the one key from the list of all keys. 2018-11-07 11:53:29 +00:00			`def get_api_keys(self, service_id):`
notify-api-412 use black to enforce python coding style 2023-08-25 09:12:23 -07:00			`return self.get(url="/service/{}/api-keys".format(service_id))`
Created api_key_api_client. Implementation of create, revoke and show api keys for service. These calls work, however we still need to fix the tests. 2016-01-20 17:32:55 +00:00
Save api_key.key_type from radio buttons 2016-07-06 15:10:36 +01:00			`def create_api_key(self, service_id, key_name, key_type):`
notify-api-412 use black to enforce python coding style 2023-08-25 09:12:23 -07:00			`data = {"name": key_name, "key_type": key_type}`
Make `_attach_current_user` a pure function Mutating dictionaries is gross and doesn’t work as you’d expect. Better to have the function return a new dictionary instead. Means we can be explicit that `created_by` is one of the allowed params when updating a service. 2016-08-11 14:20:43 +01:00			`data = _attach_current_user(data)`
notify-api-412 use black to enforce python coding style 2023-08-25 09:12:23 -07:00			`key = self.post(url="/service/{}/api-key".format(service_id), data=data)`
			`return key["data"]`
Created api_key_api_client. Implementation of create, revoke and show api keys for service. These calls work, however we still need to fix the tests. 2016-01-20 17:32:55 +00:00
send key_type = normal when creating api keys 2016-06-27 12:02:16 +01:00			`def revoke_api_key(self, service_id, key_id):`
Add created_by to all appropriate requests. 2016-04-15 11:08:19 +01:00			`data = _attach_current_user({})`
			`return self.post(`
notify-api-412 use black to enforce python coding style 2023-08-25 09:12:23 -07:00			`url="/service/{0}/api-key/revoke/{1}".format(service_id, key_id), data=data`
			`)`
Initialise clients outside the app This avoids the annoying problem where you can’t import a client unless the app has already been initialised. 2018-10-26 15:39:32 +01:00

			`api_key_api_client = ApiKeyApiClient()`