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.

Sign up for GitHub

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

feat: Support requests.auth authenticators #1109

Merged
merged 9 commits into from
Feb 3, 2023
Merged

feat: Support requests.auth authenticators #1109

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
861c21e
feat: Support `requests.auth` authenticators
edgarrmondragon Oct 25, 2022
b228634
Merge branch 'main' into feat/requests-auth
edgarrmondragon Dec 15, 2022
5ca9e0d
Merge branch 'main' into feat/requests-auth
edgarrmondragon Dec 17, 2022
67f682d
Merge branch 'main' into feat/requests-auth
edgarrmondragon Dec 21, 2022
daaedcc
Merge branch 'main' into feat/requests-auth
edgarrmondragon Jan 26, 2023
00f0cde
Merge branch 'main' into feat/requests-auth
edgarrmondragon Feb 2, 2023
e09077c
Merge branch 'main' into feat/requests-auth
edgarrmondragon Feb 2, 2023
b20750e
Merge branch 'main' into feat/requests-auth
edgarrmondragon Feb 3, 2023
c6caacc
docs: Add `requests.auth` code sample
edgarrmondragon Feb 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/_templates/class.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: {{ name }}
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.BatchSink.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: BatchSink
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.GraphQLStream.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: GraphQLStream
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.InlineMapper.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
:members:
:show-inheritance:
:inherited-members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.RESTStream.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: RESTStream
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.RecordSink.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: RecordSink
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.SQLConnector.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: SQLConnector
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.SQLSink.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: SQLSink
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.SQLStream.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: SQLStream
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.SQLTap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
:members:
:show-inheritance:
:inherited-members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.SQLTarget.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
:members:
:show-inheritance:
:inherited-members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.Sink.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: Sink
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.Stream.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: Stream
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.Tap.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
:members:
:show-inheritance:
:inherited-members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.Target.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@
:members:
:show-inheritance:
:inherited-members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.authenticators.APIAuthenticatorBase.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: APIAuthenticatorBase
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.authenticators.APIKeyAuthenticator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: APIKeyAuthenticator
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.authenticators.BasicAuthenticator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: BasicAuthenticator
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.authenticators.BearerTokenAuthenticator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: BearerTokenAuthenticator
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.authenticators.OAuthAuthenticator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: OAuthAuthenticator
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.authenticators.OAuthJWTAuthenticator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: OAuthJWTAuthenticator
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.authenticators.SimpleAuthenticator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: SimpleAuthenticator
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.exceptions.ConfigValidationError.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: ConfigValidationError
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.exceptions.FatalAPIError.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: FatalAPIError
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.exceptions.InvalidStreamSortException.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: InvalidStreamSortException
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.exceptions.MapExpressionError.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: MapExpressionError
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.exceptions.MaxRecordsLimitException.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: MaxRecordsLimitException
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.exceptions.RecordsWithoutSchemaException.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: RecordsWithoutSchemaException
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.exceptions.RetriableAPIError.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: RetriableAPIError
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.exceptions.StreamMapConfigError.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: StreamMapConfigError
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.exceptions.TapStreamConnectionFailure.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: TapStreamConnectionFailure
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.exceptions.TooManyRecordsException.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: TooManyRecordsException
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.pagination.BaseAPIPaginator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: BaseAPIPaginator
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.pagination.BaseHATEOASPaginator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: BaseHATEOASPaginator
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.pagination.BaseOffsetPaginator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: BaseOffsetPaginator
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.pagination.BasePageNumberPaginator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: BasePageNumberPaginator
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.pagination.HeaderLinkPaginator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: HeaderLinkPaginator
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.pagination.JSONPathPaginator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: JSONPathPaginator
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.pagination.LegacyPaginatedStreamProtocol.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: LegacyPaginatedStreamProtocol
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.pagination.LegacyStreamPaginator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: LegacyStreamPaginator
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.pagination.SimpleHeaderPaginator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: SimpleHeaderPaginator
:members:
:special-members: __init__
:special-members: __init__, __call__
2 changes: 1 addition & 1 deletion docs/classes/singer_sdk.pagination.SinglePagePaginator.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@

.. autoclass:: SinglePagePaginator
:members:
:special-members: __init__
:special-members: __init__, __call__
28 changes: 28 additions & 0 deletions docs/code_samples.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,34 @@ class CachedAuthStream(RESTStream):
return APIAuthenticatorBase(stream=self)
```

### Use one of `requests`'s built-in authenticators

```python
from requests.auth import HTTPDigestAuth
from singer_sdk.streams import RESTStream

class DigestAuthStream(RESTStream):
"""A stream with digest authentication."""

@property
def authenticator(self) -> HTTPDigestAuth:
"""Stream authenticator."""
return HTTPDigestAuth(
username=self.config["username"],
password=self.config["password"],
)
```

[`HTTPBasicAuth`](https://requests.readthedocs.io/en/latest/api/#requests.auth.HTTPBasicAuth) and
[`HTTPProxyAuth`](https://requests.readthedocs.io/en/latest/api/#requests.auth.HTTPProxyAuth)
are also available in `requests.auth`. In addition to `requests.auth` classes, the community
has published a few packages with custom authenticator classes, which are compatible with the SDK.
For example:

- [`requests-aws4auth`](https://github.com/tedder/requests-aws4auth): AWS v4 authentication
- [`requests_auth`](https://github.com/Colin-b/requests_auth): A collection of authenticators
for various services and protocols including Azure, Okta and NTLM.

### Custom response validation

Some APIs deviate from HTTP status codes to report failures. For those cases,
Expand Down
Loading