hotglue-singer-sdk 1.0.7__py3-none-any.whl → 1.0.8__py3-none-any.whl

hotglue_singer_sdk/helpers/capabilities.py

@@ -182,6 +182,9 @@ class PluginCapabilities(CapabilitiesEnum):
     # Supports raising hotglue exception classes
     HOTGLUE_EXCEPTIONS_CLASSES = "hotglue-exceptions-classes"
 
+    # Supports updating the access token
+    ALLOWS_FETCH_ACCESS_TOKEN = "allows-fetch-access-token"
+
 
 class TapCapabilities(CapabilitiesEnum):
     """Tap-specific capabilities."""

hotglue_singer_sdk/plugin_base.py

@@ -279,6 +279,19 @@ class PluginBase(metaclass=abc.ABCMeta):
         """
         print_fn(f"{cls.name} v{cls.plugin_version}, Meltano SDK v{cls.sdk_version}")
 
+    @classmethod
+    def confirm_fetch_access_token_support(cls: Type["PluginBase"]) -> bool:
+        """Check if fetch access token support is implemented.
+
+        Returns:
+            True if fetch access token support is implemented, False otherwise.
+        """
+        try:
+            cls.access_token_support()
+        except NotImplementedError:
+            return False
+        return True
+
     @classmethod
     def _get_about_info(cls: Type["PluginBase"]) -> Dict[str, Any]:
         """Returns capabilities and other tap metadata.
@@ -294,6 +307,7 @@ class PluginBase(metaclass=abc.ABCMeta):
         info["capabilities"] = cls.capabilities
         info["alerting_level"] = cls.alerting_level.value
 
+        # add settings to info
         config_jsonschema = cls.config_jsonschema
         cls.append_builtin_config(config_jsonschema)
         info["settings"] = config_jsonschema
@@ -365,7 +379,6 @@ class PluginBase(metaclass=abc.ABCMeta):
                 "Singer Taps and Targets.\n\n"
             )
             for key, value in info.items():
-
                 if key == "capabilities":
                     capabilities = f"## {key.title()}\n\n"
                     capabilities += "\n".join([f"* `{v}`" for v in value])
@@ -400,6 +413,49 @@ class PluginBase(metaclass=abc.ABCMeta):
             formatted = "\n".join([f"{k.title()}: {v}" for k, v in info.items()])
             print(formatted)
 
+    @classmethod
+    def access_token_support(cls: Type["PluginBase"], connector: Any = None) -> None:
+        """Get access token support.
+
+        Returns:
+            A tuple of the authenticator class and the auth endpoint.
+        """
+        raise NotImplementedError()
+
+    @classmethod
+    def fetch_access_token(cls: Type["PluginBase"], connector) -> dict:
+        """Fetch access token.
+
+        Returns:
+            A tuple of the authenticator class and the auth endpoint.
+        """
+        if not cls.confirm_fetch_access_token_support():
+            print(json.dumps({"error": "Fetch access token support is not implemented"}, indent=2))
+            return
+
+        authenticator, auth_endpoint = cls.access_token_support(connector)
+        # Check if a config file path is available for writing updated tokens
+        if connector.config_file is None:
+            print(
+                json.dumps(
+                    {
+                        "error": "The --access-token flag requires a config file path. "
+                        "Please provide a path to a config file instead of "
+                        "using --config ENV or omitting the config."
+                    },
+                    indent=2,
+                )
+            )
+            return
+
+        try:
+            cls.update_access_token(authenticator, auth_endpoint, connector)
+            access_token = {"access_token": connector.config.get("access_token")}
+            print(json.dumps(dict(access_token), indent=2, default=str))
+            return access_token
+        except Exception as ex:
+            print(json.dumps({"error": str(ex)}, indent=2))
+
     @classproperty
     def cli(cls) -> Callable:
         """Handle command line execution.

hotglue_singer_sdk/tap_base.py

@@ -2,6 +2,7 @@
 
 import abc
 import json
+import sys
 from enum import Enum
 from pathlib import Path, PurePath
 from typing import Any, Callable, Dict, List, Optional, Tuple, Type, Union, cast
@@ -78,7 +79,7 @@ class Tap(PluginBase, metaclass=abc.ABCMeta):
         self._catalog: Optional[Catalog] = None  # Tap's working catalog
         self.config_file = config[0] if config else None
 
-        # Process input catalog
+    def register_streams_from_catalog(self, catalog):
         if isinstance(catalog, Catalog):
             self._input_catalog = catalog
         elif isinstance(catalog, dict):
@@ -95,7 +96,8 @@ class Tap(PluginBase, metaclass=abc.ABCMeta):
 
         self.mapper.register_raw_streams_from_catalog(self.catalog)
 
-        # Process state
+
+    def register_state_from_file(self, state):
         state_dict: dict = {}
         if isinstance(state, dict):
             state_dict = state
@@ -103,6 +105,7 @@ class Tap(PluginBase, metaclass=abc.ABCMeta):
             state_dict = read_json_file(state)
         self.load_state(state_dict)
 
+
     # Class properties
 
     @property
@@ -166,7 +169,7 @@ class Tap(PluginBase, metaclass=abc.ABCMeta):
         Returns:
             A list of capabilities supported by this tap.
         """
-        return [
+        capabilities = [
             TapCapabilities.CATALOG,
             TapCapabilities.STATE,
             TapCapabilities.DISCOVER,
@@ -175,6 +178,10 @@ class Tap(PluginBase, metaclass=abc.ABCMeta):
             PluginCapabilities.FLATTENING,
         ]
 
+        if self.confirm_fetch_access_token_support():
+            capabilities.append(PluginCapabilities.ALLOWS_FETCH_ACCESS_TOKEN)
+        return capabilities
+
     # Connection test:
 
     @final
@@ -265,6 +272,34 @@ class Tap(PluginBase, metaclass=abc.ABCMeta):
             "Please set the '--catalog' command line argument and try again."
         )
 
+    @classmethod
+    def update_access_token(cls, authenticator, auth_endpoint, tap) -> None:
+        """Update the access token.
+
+        Returns:
+            None
+        """
+
+        # If the tap has a use_auth_dummy_stream method, use it to create a dummy stream
+        # normally used for taps with dynamic catalogs
+        class DummyStream:
+            def __init__(self, tap):
+                self._tap = tap
+                self.logger = tap.logger
+                self.tap_name = tap.name
+                self.config = tap.config
+
+        stream = DummyStream(tap)
+        auth = authenticator(
+            stream=stream,
+            config_file=tap.config_file,
+            auth_endpoint=auth_endpoint,
+        )
+
+        # Update the access token
+        if not auth.is_token_valid():
+            auth.update_access_token()
+
     @final
     def load_streams(self) -> List[Stream]:
         """Load streams from discovery and initialize DAG.
@@ -385,8 +420,6 @@ class Tap(PluginBase, metaclass=abc.ABCMeta):
         for stream in self.streams.values():
             stream.log_sync_costs()
 
-    # Command Line Execution
-
     @classproperty
     def cli(cls) -> Callable:
         """Execute standard CLI handler for taps.
@@ -425,6 +458,12 @@ class Tap(PluginBase, metaclass=abc.ABCMeta):
             help="Use a bookmarks file for incremental replication.",
             type=click.Path(),
         )
+        @click.option(
+            "--access-token",
+            "access_token",
+            is_flag=True,
+            help="Refresh the OAuth access token and update the config file.",
+        )
         @click.command(
             help="Execute the Singer tap.",
             context_settings={"help_option_names": ["--help"]},
@@ -438,6 +477,7 @@ class Tap(PluginBase, metaclass=abc.ABCMeta):
             state: str = None,
             catalog: str = None,
             format: str = None,
+            access_token: bool = False,
         ) -> None:
             """Handle command line execution.
 
@@ -451,6 +491,7 @@ class Tap(PluginBase, metaclass=abc.ABCMeta):
                     variables. Accepts multiple inputs as a tuple.
                 catalog: Use a Singer catalog file with the tap.",
                 state: Use a bookmarks file for incremental replication.
+                access_token: Refresh the OAuth access token and update the config.
 
             Raises:
                 FileNotFoundError: If the config file does not exist.
@@ -495,7 +536,12 @@ class Tap(PluginBase, metaclass=abc.ABCMeta):
                 validate_config=validate_config,
             )
 
+            if access_token:
+                return cls.fetch_access_token(connector=tap)
+
             if discover:
+                tap.register_streams_from_catalog(catalog)
+                tap.register_state_from_file(state)
                 tap.run_discovery()
                 if test == CliTestOptionValue.All.value:
                     tap.run_connection_test()
@@ -504,6 +550,8 @@ class Tap(PluginBase, metaclass=abc.ABCMeta):
             elif test == CliTestOptionValue.Schema.value:
                 tap.write_schemas()
             else:
+                tap.register_streams_from_catalog(catalog)
+                tap.register_state_from_file(state)
                 tap.sync_all()
 
         return cli

{hotglue_singer_sdk-1.0.7.dist-info → hotglue_singer_sdk-1.0.8.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: hotglue-singer-sdk
-Version: 1.0.7
+Version: 1.0.8
 Summary: A framework for building Singer taps and targets
 License: Apache 2.0
 License-File: LICENSE
@@ -51,3 +51,62 @@ This is a fork of Melanto's SingerSDK for special use in [hotglue](https://hotgl
 Taps and targets built on the SDK are automatically compliant with the
 [Singer Spec](https://hub.meltano.com/singer/spec), the
 de-facto open source standard for extract and load pipelines.
+
+## OAuth Access Token Support
+
+Taps can implement the `--access-token` CLI flag to refresh OAuth access tokens without running the tap directly.
+
+### Implementing Access Token Support
+
+To enable this feature in your tap, override the `access_token_support` class method to return a tuple of `(authenticator_class, auth_endpoint)`:
+
+```python
+from hotglue_singer_sdk import Tap
+from my_tap.auth import MyOAuthAuthenticator
+
+class MyTap(Tap):
+    name = "tap-myservice"
+
+    @classmethod
+    def access_token_support(cls, connector=None):
+        """Return the authenticator class and auth endpoint for token refresh.
+
+        Returns:
+            A tuple of (authenticator_class, auth_endpoint).
+        """
+        default_url = "https://api.myservice.com/oauth/token"
+        # ommit if token url is not dynamic
+        dynamic_url = connector.config.get("auth_url")
+        url = dynamic_url or default_url
+        return (MyOAuthAuthenticator, url)
+```
+
+### Authenticator Requirements
+
+The authenticator class must implement the following methods:
+
+- `is_token_valid()` - Returns `True` if the current access token is still valid
+- `update_access_token()` - Refreshes the access token and updates the config file
+
+The authenticator will be instantiated with these parameters:
+- `stream` - A dummy stream object with `logger`, `tap_name`, and `config` attributes
+- `config_file` - Path to the config file for writing updated tokens
+- `auth_endpoint` - The OAuth token endpoint URL
+
+### Usage
+
+Once implemented, users can refresh the access token using:
+
+```bash
+tap-myservice --config config.json --access-token
+```
+
+This will output the new access token as JSON:
+
+```json
+{
+  "access_token": "new_token_value"
+}
+```
+
+**Note:** The `--access-token` flag requires a config file path. It will not work with `--config ENV` or when omitting the config.

{hotglue_singer_sdk-1.0.7.dist-info → hotglue_singer_sdk-1.0.8.dist-info}/RECORD

@@ -17,12 +17,12 @@ hotglue_singer_sdk/helpers/_singer.py,sha256=UgSQW4cGX43a7uxCRp76bdI2C0Zbhd8mfVH
 hotglue_singer_sdk/helpers/_state.py,sha256=ptPeelu0BO-myScjhFXW0QEIqKhLB1fELWHEOte-HM4,9668
 hotglue_singer_sdk/helpers/_typing.py,sha256=vKYNXqiie6niSeSQQPkNSv4dxjud4LGYR-SccvZC8dg,8418
 hotglue_singer_sdk/helpers/_util.py,sha256=jGQABMvaKuxFVet4b9FQcWQZnOIRADVXFFzVg311B3A,846
-hotglue_singer_sdk/helpers/capabilities.py,sha256=b3hwA6liuEwY3CbOalvjdOP9cxkCO6_r2CqO95EapHA,6631
+hotglue_singer_sdk/helpers/capabilities.py,sha256=p2m2FjBlyXM_Zbhxfbu9OWQeqNjcWA8vGpn1UL2S9sU,6733
 hotglue_singer_sdk/helpers/jsonpath.py,sha256=oe15S0tE8Pk67Wocg1QdrHmTfDvf1Ay9rOjulqqSU8I,995
 hotglue_singer_sdk/io_base.py,sha256=tWRaB_IlZuI8gnO1xSLuT4Cd0KKj34Ii2TXm2I6TdA4,4018
 hotglue_singer_sdk/mapper.py,sha256=wrk-MoAS0kcF24z29zR4PD_ryRb0MRyxYTCXHNf61SA,23874
 hotglue_singer_sdk/mapper_base.py,sha256=7kPC6yu8c0XXp46bPiP6FX8I2n5Nx-kOoUKCsbREsog,4968
-hotglue_singer_sdk/plugin_base.py,sha256=bBy8jF3c1XU3RWsYI_eTwIl-jJJnzNk_5_8E-6mbiuA,14258
+hotglue_singer_sdk/plugin_base.py,sha256=CLpSsTy4t_VZdnHJ4kj-CEGjTVkx9CztaY-Zw9XvqUY,16337
 hotglue_singer_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hotglue_singer_sdk/sinks/__init__.py,sha256=UtX5EbfE1PKzAW9jptfytGkzpLlTr3a9SgrSCnm_SMs,348
 hotglue_singer_sdk/sinks/batch.py,sha256=a19tgNDMb85c3Bo7bcrcOzPRy1VYKRYuVWZEg9fBUJU,3005
@@ -34,7 +34,7 @@ hotglue_singer_sdk/streams/core.py,sha256=q1P6ecJ7-Lix1BltLNSvnGlKvUlsnhAW9ReeB1
 hotglue_singer_sdk/streams/graphql.py,sha256=HGzJhogpja37pupMsqiXZd6YxV_aZw6LckBjk1R68k8,2615
 hotglue_singer_sdk/streams/rest.py,sha256=FpbPK90-hCCMh1BY0xKvnAg5vpiav3Ls1f2QREUb55k,21420
 hotglue_singer_sdk/streams/sql.py,sha256=UZSpXTRZNIH3C_D5R7-NO3z__QizgJtIHxg1iL8o5wE,34994
-hotglue_singer_sdk/tap_base.py,sha256=7lRZt40GzsMOeMlpoivxaG1Jjs5yB8JeR66JZhrLqeU,19644
+hotglue_singer_sdk/tap_base.py,sha256=DCqNZT5d24HgZHrk89aFG035zNg8trOB4751aPliZDE,21312
 hotglue_singer_sdk/target_base.py,sha256=QbBVXr6x5G3bgbPwpMG80ttL0TMOK8bjJCbJsa4AOFw,19130
 hotglue_singer_sdk/target_sdk/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 hotglue_singer_sdk/target_sdk/auth.py,sha256=jU3yL5mtlf8p2VWsfoR_TaMjp8_APpQNPtPgHRIUIBc,3925
@@ -47,7 +47,7 @@ hotglue_singer_sdk/target_sdk/target.py,sha256=uVqmXmyIO-h3M8VCiZ1McPXczZj7EU0PO
 hotglue_singer_sdk/target_sdk/target_base.py,sha256=LyQQndYGlzu5LcIj-MMcmcjdGAmAYVgvdNAxvCgFpvk,22022
 hotglue_singer_sdk/testing.py,sha256=BifsP9X83pgKdfynI5CComchoRWEHpe81h-UfOwK_G0,5860
 hotglue_singer_sdk/typing.py,sha256=jTGFhON9uBZe9e0vHH6-6rjeD2YrpzolPiYigIuo7zU,16186
-hotglue_singer_sdk-1.0.7.dist-info/METADATA,sha256=qOmHWsMv3_4SEfAftosgA6zIyOLiI1Ki22EQx_4emuU,2376
-hotglue_singer_sdk-1.0.7.dist-info/WHEEL,sha256=3ny-bZhpXrU6vSQ1UPG34FoxZBp3lVcvK0LkgUz6VLk,88
-hotglue_singer_sdk-1.0.7.dist-info/licenses/LICENSE,sha256=BGsDEGu628ZSlSfJzr3RshF0_KTW-E1Z--XnqjioYWg,11337
-hotglue_singer_sdk-1.0.7.dist-info/RECORD,,
+hotglue_singer_sdk-1.0.8.dist-info/METADATA,sha256=SMmNAlvVRyElWcR-3bHBGYauQCZXJ-EaPG6CnjiJbGA,4228
+hotglue_singer_sdk-1.0.8.dist-info/WHEEL,sha256=kJCRJT_g0adfAJzTx2GUMmS80rTJIVHRCfG0DQgLq3o,88
+hotglue_singer_sdk-1.0.8.dist-info/licenses/LICENSE,sha256=BGsDEGu628ZSlSfJzr3RshF0_KTW-E1Z--XnqjioYWg,11337
+hotglue_singer_sdk-1.0.8.dist-info/RECORD,,

{hotglue_singer_sdk-1.0.7.dist-info → hotglue_singer_sdk-1.0.8.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.3.0
+Generator: poetry-core 2.3.1
 Root-Is-Purelib: true
 Tag: py3-none-any