airbyte-cdk 0.36.5__tar.gz → 0.37.0__tar.gz

{airbyte-cdk-0.36.5 → airbyte-cdk-0.37.0}/PKG-INFO

@@ -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 → airbyte-cdk-0.37.0}/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-0.36.5 → airbyte-cdk-0.37.0}/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-0.36.5 → airbyte-cdk-0.37.0}/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-0.36.5 → airbyte-cdk-0.37.0}/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 → airbyte-cdk-0.37.0}/airbyte_cdk.egg-info/PKG-INFO

@@ -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 → airbyte-cdk-0.37.0}/setup.py

@@ -17,7 +17,7 @@ setup(
     name="airbyte-cdk",
     # The version of the airbyte-cdk package is used at runtime to validate manifests. That validation must be
     # updated if our semver format changes such as using release candidate versions.
-    version="0.36.5",
+    version="0.37.0",
     description="A framework for writing Airbyte Connectors.",
     long_description=README,
     long_description_content_type="text/markdown",

{airbyte-cdk-0.36.5 → airbyte-cdk-0.37.0}/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":