Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

As a Developer, I can rely on a standardized APIClient class to authenticate requests on any reader #69

Open
gabrielleberanger opened this issue Dec 16, 2020 · 0 comments
Labels
enhancement Refactoring, factorizing, adding tests, etc. P2 2nd priority

Comments

@gabrielleberanger
Copy link
Contributor

gabrielleberanger commented Dec 16, 2020

WHY
Today, each reader uses its own authentication method: either a client class or a helper method.
Available client classes are available under the nck/clients directory (after the refacto, clients shared by several sources will appear under nck/clients/, and source-level clients will appear under nck/readers/<source>/client.py).

HOW

Long term goal
Create a unique APIClient class, that could handle the authentication process for all readers.
Today, a standardization effort has been undertaken with the creation of the APIClient class ; however, this class is only used by Yandex readers today. As we might not be able to standardize all authentification methods into a single one (some APIs are quite specific), we suggest to pursue the below preliminary goal as a start.

Intermediary goal
Group sources sharing a similar authentication process (e.g. Google sources) into a single client class.

@gabrielleberanger gabrielleberanger added new feature Creating a new feature enhancement Refactoring, factorizing, adding tests, etc. and removed new feature Creating a new feature labels Dec 16, 2020
@gabrielleberanger gabrielleberanger added the P2 2nd priority label Dec 16, 2020
@gabrielleberanger gabrielleberanger changed the title As a Developer, I can rely on a standardized API client to authenticate requests on any reader As a Developer, I can rely on a standardized APIClient class to authenticate requests on any reader Dec 16, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Refactoring, factorizing, adding tests, etc. P2 2nd priority
Projects
None yet
Development

No branches or pull requests

1 participant