app/notify_client/provider_client.py

from app.notify_client import NotifyAdminAPIClient, _attach_current_user


class ProviderClient(NotifyAdminAPIClient):
    def get_all_providers(self):
        return self.get(url="/provider-details")

    def get_provider_by_id(self, provider_id):
        return self.get(url="/provider-details/{}".format(provider_id))

    def get_provider_versions(self, provider_id):
        return self.get(url="/provider-details/{}/versions".format(provider_id))

    def update_provider(self, provider_id, priority):
        data = {"priority": priority}
        data = _attach_current_user(data)
        return self.post(url="/provider-details/{}".format(provider_id), data=data)


provider_client = ProviderClient()
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`
Added provider management pages in. - see priority - change priority 2016-05-11 09:43:55 +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 ProviderClient(NotifyAdminAPIClient):`
Added provider management pages in. - see priority - change priority 2016-05-11 09:43:55 +01:00			`def get_all_providers(self):`
notify-api-412 use black to enforce python coding style 2023-08-25 09:12:23 -07:00			`return self.get(url="/provider-details")`
Added provider management pages in. - see priority - change priority 2016-05-11 09:43:55 +01:00
			`def get_provider_by_id(self, provider_id):`
notify-api-412 use black to enforce python coding style 2023-08-25 09:12:23 -07:00			`return self.get(url="/provider-details/{}".format(provider_id))`
Added provider management pages in. - see priority - change priority 2016-05-11 09:43:55 +01:00
Add provider client method to get provider version history 2017-03-02 22:50:01 +00:00			`def get_provider_versions(self, provider_id):`
notify-api-412 use black to enforce python coding style 2023-08-25 09:12:23 -07:00			`return self.get(url="/provider-details/{}/versions".format(provider_id))`
Add provider client method to get provider version history 2017-03-02 22:50:01 +00:00
Added provider management pages in. - see priority - change priority 2016-05-11 09:43:55 +01:00			`def update_provider(self, provider_id, priority):`
notify-api-412 use black to enforce python coding style 2023-08-25 09:12:23 -07:00			`data = {"priority": priority}`
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			`return self.post(url="/provider-details/{}".format(provider_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

			`provider_client = ProviderClient()`