airbyte-cdk 0.36.5__py3-none-any.whl → 0.37.0__py3-none-any.whl

airbyte_cdk/sources/declarative/auth/oauth.py

@@ -31,15 +31,15 @@ class DeclarativeOauth2Authenticator(AbstractOauth2Authenticator, DeclarativeAut
         token_expiry_date (Optional[Union[InterpolatedString, str]]): The access token expiration date
         token_expiry_date_format str: format of the datetime; provide it if expires_in is returned in datetime instead of seconds
         refresh_request_body (Optional[Mapping[str, Any]]): The request body to send in the refresh request
-        grant_type: The grant_type to request for access_token
+        grant_type: The grant_type to request for access_token. If set to refresh_token, the refresh_token parameter has to be provided
     """
 
     token_refresh_endpoint: Union[InterpolatedString, str]
     client_id: Union[InterpolatedString, str]
     client_secret: Union[InterpolatedString, str]
-    refresh_token: Union[InterpolatedString, str]
     config: Mapping[str, Any]
     parameters: InitVar[Mapping[str, Any]]
+    refresh_token: Optional[Union[InterpolatedString, str]] = None
     scopes: Optional[List[str]] = None
     token_expiry_date: Optional[Union[InterpolatedString, str]] = None
     _token_expiry_date: pendulum.DateTime = field(init=False, repr=False, default=None)
@@ -53,7 +53,8 @@ class DeclarativeOauth2Authenticator(AbstractOauth2Authenticator, DeclarativeAut
         self.token_refresh_endpoint = InterpolatedString.create(self.token_refresh_endpoint, parameters=parameters)
         self.client_id = InterpolatedString.create(self.client_id, parameters=parameters)
         self.client_secret = InterpolatedString.create(self.client_secret, parameters=parameters)
-        self.refresh_token = InterpolatedString.create(self.refresh_token, parameters=parameters)
+        if self.refresh_token is not None:
+            self.refresh_token = InterpolatedString.create(self.refresh_token, parameters=parameters)
         self.access_token_name = InterpolatedString.create(self.access_token_name, parameters=parameters)
         self.expires_in_name = InterpolatedString.create(self.expires_in_name, parameters=parameters)
         self.grant_type = InterpolatedString.create(self.grant_type, parameters=parameters)
@@ -65,6 +66,9 @@ class DeclarativeOauth2Authenticator(AbstractOauth2Authenticator, DeclarativeAut
         )
         self._access_token = None
 
+        if self.get_grant_type() == "refresh_token" and self.refresh_token is None:
+            raise ValueError("OAuthAuthenticator needs a refresh_token parameter if grant_type is set to `refresh_token`")
+
     def get_token_refresh_endpoint(self) -> str:
         return self.token_refresh_endpoint.eval(self.config)
 
@@ -74,8 +78,8 @@ class DeclarativeOauth2Authenticator(AbstractOauth2Authenticator, DeclarativeAut
     def get_client_secret(self) -> str:
         return self.client_secret.eval(self.config)
 
-    def get_refresh_token(self) -> str:
-        return self.refresh_token.eval(self.config)
+    def get_refresh_token(self) -> Optional[str]:
+        return None if self.refresh_token is None else self.refresh_token.eval(self.config)
 
     def get_scopes(self) -> [str]:
         return self.scopes
@@ -117,7 +121,10 @@ class DeclarativeOauth2Authenticator(AbstractOauth2Authenticator, DeclarativeAut
         if self.token_expiry_date_format:
             self._token_expiry_date = pendulum.from_format(value, self.token_expiry_date_format)
         else:
-            self._token_expiry_date = pendulum.now().add(seconds=value)
+            try:
+                self._token_expiry_date = pendulum.now().add(seconds=int(float(value)))
+            except ValueError:
+                raise ValueError(f"Invalid token expiry value {value}; a number is required.")
 
     @property
     def access_token(self) -> str:

airbyte_cdk/sources/declarative/declarative_component_schema.yaml

@@ -647,7 +647,6 @@ definitions:
       - type
       - client_id
       - client_secret
-      - refresh_token
       - token_refresh_endpoint
     properties:
       type:

airbyte_cdk/sources/declarative/models/declarative_component_schema.py

@@ -277,8 +277,8 @@ class OAuthAuthenticator(BaseModel):
         ],
         title="Client Secret",
     )
-    refresh_token: str = Field(
-        ...,
+    refresh_token: Optional[str] = Field(
+        None,
         description="Credential artifact used to get a new access token.",
         examples=[
             "{{ config['refresh_token'] }}",

airbyte_cdk/sources/streams/http/requests_native_auth/abstract_oauth.py

@@ -4,7 +4,7 @@
 
 import logging
 from abc import abstractmethod
-from typing import Any, List, Mapping, MutableMapping, Tuple, Union
+from typing import Any, List, Mapping, MutableMapping, Optional, Tuple, Union
 
 import backoff
 import pendulum
@@ -111,7 +111,7 @@ class AbstractOauth2Authenticator(AuthBase):
         """The client secret to authenticate"""
 
     @abstractmethod
-    def get_refresh_token(self) -> str:
+    def get_refresh_token(self) -> Optional[str]:
         """The token used to refresh the access token when it expires"""
 
     @abstractmethod

{airbyte_cdk-0.36.5.dist-info → airbyte_cdk-0.37.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: airbyte-cdk
-Version: 0.36.5
+Version: 0.37.0
 Summary: A framework for writing Airbyte Connectors.
 Home-page: https://github.com/airbytehq/airbyte
 Author: Airbyte

{airbyte_cdk-0.36.5.dist-info → airbyte_cdk-0.37.0.dist-info}/RECORD

@@ -22,7 +22,7 @@ airbyte_cdk/sources/connector_state_manager.py,sha256=_R-2QnMGimKL0t5aV4f6P1dgd-
 airbyte_cdk/sources/source.py,sha256=N3vHZzdUsBETFsql-YpO-LcgjolT_jcnAuHBhGD6Hqk,4278
 airbyte_cdk/sources/declarative/__init__.py,sha256=ZnqYNxHsKCgO38IwB34RQyRMXTs4GTvlRi3ImKnIioo,61
 airbyte_cdk/sources/declarative/create_partial.py,sha256=sUJOwD8hBzW4pxw2XhYlSTMgl-WMc5WpP5Oq_jo3fHw,3371
-airbyte_cdk/sources/declarative/declarative_component_schema.yaml,sha256=rOwWCeYWSQi5jz_1hvG48xbv_4kP3bHmVlrLcPfGc7A,75109
+airbyte_cdk/sources/declarative/declarative_component_schema.yaml,sha256=0BMvpifiVZ-IZytuxGlPRJAFMtiVBEFRjYBot9Wl40I,75087
 airbyte_cdk/sources/declarative/declarative_source.py,sha256=U2As9PDKmcWDgbsWUo-RetJ9fxQOBlwntWZ0NOgs5Ac,1453
 airbyte_cdk/sources/declarative/declarative_stream.py,sha256=0iZSpypxt8bhO3Lmf3BpGRTO7Fp0Q2GI8m8xyJJUjeM,6580
 airbyte_cdk/sources/declarative/exceptions.py,sha256=kTPUA4I2NV4J6HDz-mKPGMrfuc592akJnOyYx38l_QM,176
@@ -31,7 +31,7 @@ airbyte_cdk/sources/declarative/types.py,sha256=b_RJpL9TyAgxJIRYZx5BxpC39p-WccHK
 airbyte_cdk/sources/declarative/yaml_declarative_source.py,sha256=I9Bs9RDsFT8JNiJWRDjKYhqwvv4pqzgYZtF5hVuTDqI,1684
 airbyte_cdk/sources/declarative/auth/__init__.py,sha256=DyQdO5mdKGsttWdEUqxb6WVgD7zTcvpJz-Oet_VNeBg,201
 airbyte_cdk/sources/declarative/auth/declarative_authenticator.py,sha256=4nEvMQWGmQ_-KROwcI8dsDbU4NjjxiGz3nsxxfWqBF8,663
-airbyte_cdk/sources/declarative/auth/oauth.py,sha256=Rvnzyq2xmMKICTbcWejLyBJgGO_viKVr0HwIxol_3Xo,6849
+airbyte_cdk/sources/declarative/auth/oauth.py,sha256=pD0KnWA8kECcm1wMHsIrLJzUT9sil0iZu1ZUTn-los0,7403
 airbyte_cdk/sources/declarative/auth/token.py,sha256=8WVZoV02ujk5KuWC6eOsnUSI6zp4Jm7TvWdgxKFiffk,10520
 airbyte_cdk/sources/declarative/checks/__init__.py,sha256=WWXMfvKkndqwAUZdgSr7xVHVXDFTKCUQ9EubqT7H4QE,274
 airbyte_cdk/sources/declarative/checks/check_stream.py,sha256=9fJt1ma31tBiKfuqjTO2SIK_b14NgjqkPJa4om0eJM0,2065
@@ -59,7 +59,7 @@ airbyte_cdk/sources/declarative/interpolation/interpolation.py,sha256=dyIM-bzh54
 airbyte_cdk/sources/declarative/interpolation/jinja.py,sha256=Dc0F87nElWsz_Ikj938eQ9uqZvyqgFhZ8Dqf_-hvndc,4800
 airbyte_cdk/sources/declarative/interpolation/macros.py,sha256=V6WGKJ9cXX1rjuM4bK3Cs9xEryMlkY2U3FMsSBhrgC8,3098
 airbyte_cdk/sources/declarative/models/__init__.py,sha256=EiYnzwCHZV7EYqMJqcy6xKSeHvTKZBsQndjbEwmiTW4,93
-airbyte_cdk/sources/declarative/models/declarative_component_schema.py,sha256=rr7LMOAJhrpdkHHSD2-Mh7-sOjl0q2xCccHiEEkGxnQ,50441
+airbyte_cdk/sources/declarative/models/declarative_component_schema.py,sha256=PghniMTIvEHi-NPIRK7rpPJtYRtYgigR1T0hyKP6fl8,50452
 airbyte_cdk/sources/declarative/parsers/__init__.py,sha256=ZnqYNxHsKCgO38IwB34RQyRMXTs4GTvlRi3ImKnIioo,61
 airbyte_cdk/sources/declarative/parsers/class_types_registry.py,sha256=bK4a74opm6WHyV7HqOVws6GE5Z7cLNc5MaTha69abIQ,6086
 airbyte_cdk/sources/declarative/parsers/custom_exceptions.py,sha256=y7_G5mM07zxT5YG975kdC2PAja-Uc83pYp8WrV3GNdo,522
@@ -139,7 +139,7 @@ airbyte_cdk/sources/streams/http/auth/core.py,sha256=_s9wewvvIcOgYjhHGDj_YHApnF5
 airbyte_cdk/sources/streams/http/auth/oauth.py,sha256=zchPWN1utNg02F93f5b4UFI5OXYo8-QhocbsXhLdG4U,4135
 airbyte_cdk/sources/streams/http/auth/token.py,sha256=oU1ul0LsGsPGN_vOJOKw1xX2y_XWULRxjqXu7Rivcr8,1940
 airbyte_cdk/sources/streams/http/requests_native_auth/__init__.py,sha256=RN0D3nOX1xLgwEwKWu6pkGy3XqBFzKSNZ8Lf6umU2eY,413
-airbyte_cdk/sources/streams/http/requests_native_auth/abstract_oauth.py,sha256=goK6MRBekhosrdOSbWK54eCiciqYlL0jX7euwndM8QU,5319
+airbyte_cdk/sources/streams/http/requests_native_auth/abstract_oauth.py,sha256=dw9mmIOf05NDqKzzvRA3tXKjx1LvVGm1tPt8TQhf5Y8,5339
 airbyte_cdk/sources/streams/http/requests_native_auth/abstract_token.py,sha256=T0hVF2cBXGgIfrCslvTC1uNm9rNbYjENNl2Cb3mXuSY,961
 airbyte_cdk/sources/streams/http/requests_native_auth/oauth.py,sha256=QWTjL6blaEAK457TSJlTDcczITdAu0RqMEhxX-rpAWo,11704
 airbyte_cdk/sources/streams/http/requests_native_auth/token.py,sha256=hDti8DlF_R5YYX95hg9BPogYtG-KUYtOifrFDv_L3Hk,2456
@@ -181,7 +181,7 @@ unit_tests/sources/declarative/test_declarative_stream.py,sha256=3leJnZIYHiFq8XI
 unit_tests/sources/declarative/test_manifest_declarative_source.py,sha256=GckUc3nepzZkD1UM24woHlYCVZb5DP4IAQC3IeMyZF0,58924
 unit_tests/sources/declarative/test_yaml_declarative_source.py,sha256=6HhsUFgB7ueN0yOUHWb4gpPYLng5jasxN_plvz3x37g,5097
 unit_tests/sources/declarative/auth/__init__.py,sha256=4Hw-PX1-VgESLF16cDdvuYCzGJtHntThLF4qIiULWeo,61
-unit_tests/sources/declarative/auth/test_oauth.py,sha256=mqXE_mQBcM78-ZaDX5GCWFOkbXPCvYeCj81aKyPZ3D8,5204
+unit_tests/sources/declarative/auth/test_oauth.py,sha256=j-xEUbRPs5jnRAvKCNLKDpEbAZLmXHEy9tSEkYUrYx0,8442
 unit_tests/sources/declarative/auth/test_session_token_auth.py,sha256=mxWCm_0AyVI6J1Q5CjogXY-EkXFfWkMZjNtBeb0bOow,6135
 unit_tests/sources/declarative/auth/test_token_auth.py,sha256=voeoFiZOp2BUSJ0FvlXdRsan_vwIbteA2tpb1oRb40g,3711
 unit_tests/sources/declarative/checks/__init__.py,sha256=ZnqYNxHsKCgO38IwB34RQyRMXTs4GTvlRi3ImKnIioo,61
@@ -259,8 +259,8 @@ unit_tests/utils/test_schema_inferrer.py,sha256=ckl17GlNOZInqgxni7Z2A0bg_p6JDy0G
 unit_tests/utils/test_secret_utils.py,sha256=XKe0f1RHYii8iwE6ATmBr5JGDI1pzzrnZUGdUSMJQP4,4886
 unit_tests/utils/test_stream_status_utils.py,sha256=NpV155JMXA6CG-2Zvofa14lItobyh3Onttc59X4m5DI,3382
 unit_tests/utils/test_traced_exception.py,sha256=bDFP5zMBizFenz6V2WvEZTRCKGB5ijh3DBezjbfoYIs,4198
-airbyte_cdk-0.36.5.dist-info/LICENSE.txt,sha256=Wfe61S4BaGPj404v8lrAbvhjYR68SHlkzeYrg3_bbuM,1051
-airbyte_cdk-0.36.5.dist-info/METADATA,sha256=e8O2J7ZTOAytqohSQVqndtkg9tkHCf81iwopeM_ntcY,8902
-airbyte_cdk-0.36.5.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
-airbyte_cdk-0.36.5.dist-info/top_level.txt,sha256=edvsDKTnE6sD2wfCUaeTfKf5gQIL6CPVMwVL2sWZzqo,51
-airbyte_cdk-0.36.5.dist-info/RECORD,,
+airbyte_cdk-0.37.0.dist-info/LICENSE.txt,sha256=Wfe61S4BaGPj404v8lrAbvhjYR68SHlkzeYrg3_bbuM,1051
+airbyte_cdk-0.37.0.dist-info/METADATA,sha256=6HRZ3Hyt-WKn2QNme7H6B-s3mCYhi1ur_apLnXMnODU,8902
+airbyte_cdk-0.37.0.dist-info/WHEEL,sha256=pkctZYzUS4AYVn6dJ-7367OJZivF2e8RA9b_ZBjif18,92
+airbyte_cdk-0.37.0.dist-info/top_level.txt,sha256=edvsDKTnE6sD2wfCUaeTfKf5gQIL6CPVMwVL2sWZzqo,51
+airbyte_cdk-0.37.0.dist-info/RECORD,,

unit_tests/sources/declarative/auth/test_oauth.py

@@ -65,6 +65,42 @@ class TestOauth2Authenticator:
         }
         assert body == expected
 
+    def test_refresh_without_refresh_token(self):
+        """
+        Should work fine for grant_type client_credentials.
+        """
+        oauth = DeclarativeOauth2Authenticator(
+            token_refresh_endpoint="{{ config['refresh_endpoint'] }}",
+            client_id="{{ config['client_id'] }}",
+            client_secret="{{ config['client_secret'] }}",
+            config=config,
+            parameters={},
+            grant_type="client_credentials",
+        )
+        body = oauth.build_refresh_request_body()
+        expected = {
+            "grant_type": "client_credentials",
+            "client_id": "some_client_id",
+            "client_secret": "some_client_secret",
+            "refresh_token": None,
+            "scopes": None,
+        }
+        assert body == expected
+
+    def test_error_on_refresh_token_grant_without_refresh_token(self):
+        """
+        Should throw an error if grant_type refresh_token is configured without refresh_token.
+        """
+        with pytest.raises(ValueError):
+            DeclarativeOauth2Authenticator(
+                token_refresh_endpoint="{{ config['refresh_endpoint'] }}",
+                client_id="{{ config['client_id'] }}",
+                client_secret="{{ config['client_secret'] }}",
+                config=config,
+                parameters={},
+                grant_type="refresh_token",
+            )
+
     def test_refresh_access_token(self, mocker):
         oauth = DeclarativeOauth2Authenticator(
             token_refresh_endpoint="{{ config['refresh_endpoint'] }}",
@@ -92,12 +128,11 @@ class TestOauth2Authenticator:
     @pytest.mark.parametrize(
         "expires_in_response, token_expiry_date_format",
         [
-            (86400, None),
             ("2020-01-02T00:00:00Z", "YYYY-MM-DDTHH:mm:ss[Z]"),
             ("2020-01-02T00:00:00.000000+00:00", "YYYY-MM-DDTHH:mm:ss.SSSSSSZ"),
             ("2020-01-02", "YYYY-MM-DD"),
         ],
-        ids=["time_in_seconds", "rfc3339", "iso8601", "simple_date"],
+        ids=["rfc3339", "iso8601", "simple_date"],
     )
     @freezegun.freeze_time("2020-01-01")
     def test_refresh_access_token_expire_format(self, mocker, expires_in_response, token_expiry_date_format):
@@ -127,6 +162,46 @@ class TestOauth2Authenticator:
         assert "access_token" == token
         assert oauth.get_token_expiry_date() == pendulum.parse(next_day)
 
+    @pytest.mark.parametrize(
+        "expires_in_response, next_day, raises",
+        [
+            (86400, "2020-01-02T00:00:00Z", False),
+            (86400.1, "2020-01-02T00:00:00Z", False),
+            ("86400", "2020-01-02T00:00:00Z", False),
+            ("86400.1", "2020-01-02T00:00:00Z", False),
+            ("2020-01-02T00:00:00Z", "2020-01-02T00:00:00Z", True),
+        ],
+        ids=["time_in_seconds", "time_in_seconds_float", "time_in_seconds_str", "time_in_seconds_str_float", "invalid"],
+    )
+    @freezegun.freeze_time("2020-01-01")
+    def test_set_token_expiry_date_no_format(self, mocker, expires_in_response, next_day, raises):
+        config.update({"token_expiry_date": pendulum.parse(next_day).subtract(days=2).to_rfc3339_string()})
+        oauth = DeclarativeOauth2Authenticator(
+            token_refresh_endpoint="{{ config['refresh_endpoint'] }}",
+            client_id="{{ config['client_id'] }}",
+            client_secret="{{ config['client_secret'] }}",
+            refresh_token="{{ config['refresh_token'] }}",
+            config=config,
+            scopes=["scope1", "scope2"],
+            refresh_request_body={
+                "custom_field": "{{ config['custom_field'] }}",
+                "another_field": "{{ config['another_field'] }}",
+                "scopes": ["no_override"],
+            },
+            parameters={},
+        )
+
+        resp.status_code = 200
+        mocker.patch.object(resp, "json", return_value={"access_token": "access_token", "expires_in": expires_in_response})
+        mocker.patch.object(requests, "request", side_effect=mock_request, autospec=True)
+        if raises:
+            with pytest.raises(ValueError):
+                oauth.get_access_token()
+        else:
+            token = oauth.get_access_token()
+            assert "access_token" == token
+            assert oauth.get_token_expiry_date() == pendulum.parse(next_day)
+
 
 def mock_request(method, url, data):
     if url == "refresh_end":