Make backwards compatible and update cookiecutter

meltano · Aug 6, 2024 · dc7dcc7 · dc7dcc7
1 parent d232fae
commit dc7dcc7
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 1 deletion.
diff --git a/cookiecutter/tap-template/{{cookiecutter.tap_id}}/{{cookiecutter.library_name}}/tap.py b/cookiecutter/tap-template/{{cookiecutter.tap_id}}/{{cookiecutter.library_name}}/tap.py
@@ -50,6 +50,16 @@ class Tap{{ cookiecutter.source_name }}({{ 'SQL' if cookiecutter.stream_type ==
             default="https://api.mysample.com",
             description="The url for the API service",
         ),
+        {%- if cookiecutter.stream_type in ("GraphQL", "REST") %}
+        th.Property(
+            "user_agent",
+            th.StringType,
+            description=(
+                "A custom User-Agent header to send with each request. Default is "
+                "'<tap_name>/<tap_version>'"
+            ),
+        ),
+        {%- endif %}
     ).to_dict()
 {%- if cookiecutter.stream_type in ("GraphQL", "REST", "Other") %}
 

diff --git a/singer_sdk/streams/rest.py b/singer_sdk/streams/rest.py
@@ -158,7 +158,10 @@ def user_agent(self) -> str:
         Returns:
             The user agent string.
         """
-        return f"{self.tap_name}/{self._tap.plugin_version}"
+        return self.config.get(
+            "user_agent",
+            f"{self.tap_name}/{self._tap.plugin_version}",
+        )
 
     def validate_response(self, response: requests.Response) -> None:
         """Validate HTTP response.