add TagDetailsStream

Author: malexmad

tap_github/repository_streams.py

@@ -2673,6 +2673,71 @@ class GetTagShasStream(GitHubRestStream):
         ),
     ).to_dict()
 
+    def get_child_context(self, record: dict, context: dict | None) -> dict:
+        """Return a child context object from the record and optional provided context.
+        By default, will return context if provided and otherwise the record dict.
+        Developers may override this behavior to send specific information to child
+        streams for context.
+        """
+        return {
+            "org": context["org"] if context else None,
+            "repo": context["repo"] if context else None,
+            "tag_sha": record["object"]["sha"] if record.get("object") else None,
+            "repo_id": context["repo_id"] if context else None,
+        }
+
+
+class TagDetailsStream(GitHubRestStream):
+    """A stream dedicated to fetching details of a tag in a repository."""
+
+    name = "tag_details"
+    path = "/repos/{org}/{repo}/git/tags/{tag_sha}"
+    primary_keys: ClassVar[list[str]] = ["node_id"]
+    parent_stream_type = GetTagShasStream
+    ignore_parent_replication_key = True
+    state_partitioning_keys: ClassVar[list[str]] = ["repo", "org", "tag_sha"]
+    tolerated_http_errors: ClassVar[list[int]] = [404]
+
+    schema = th.PropertiesList(
+        # Parent Keys
+        th.Property("repo", th.StringType),
+        th.Property("org", th.StringType),
+        th.Property("repo_id", th.IntegerType),
+        th.Property("tag_sha", th.StringType),
+        # Tag Details
+        th.Property("node_id", th.StringType),
+        th.Property("tag", th.StringType),
+        th.Property("sha", th.StringType),
+        th.Property("url", th.StringType),
+        th.Property("message", th.StringType),
+        th.Property(
+            "tagger",
+            th.ObjectType(
+                th.Property("name", th.StringType),
+                th.Property("email", th.StringType),
+                th.Property("date", th.DateTimeType),
+            ),
+        ),
+        th.Property(
+            "object",
+            th.ObjectType(
+                th.Property("type", th.StringType),
+                th.Property("sha", th.StringType),
+                th.Property("url", th.StringType),
+            ),
+        ),
+        th.Property(
+            "verification",
+            th.ObjectType(
+                th.Property("verified", th.BooleanType),
+                th.Property("reason", th.StringType),
+                th.Property("signature", th.StringType),
+                th.Property("payload", th.StringType),
+                th.Property("verified_at", th.StringType),
+            ),
+        ),
+    ).to_dict()
+
 
 class DeploymentsStream(GitHubRestStream):
     """A stream dedicated to fetching deployments in a repository."""

tap_github/streams.py

@@ -47,6 +47,7 @@
     StargazersStream,
     StatsContributorsStream,
     TagsStream,
+    TagDetailsStream,
     TrafficClonesStream,
     TrafficPageViewsStream,
     TrafficReferralPathsStream,
@@ -113,6 +114,7 @@ def __init__(self, valid_queries: set[str], streams: list[type[Stream]]) -> None
             StargazersStream,
             StatsContributorsStream,
             TagsStream,
+            TagDetailsStream,
             TrafficClonesStream,
             TrafficPageViewsStream,
             TrafficReferralPathsStream,