🎉 Sendgrind add single send stats (#5910)

* Sendgrind source: add single send stream
airbytehq · Sep 9, 2021 · 2ecc7a6 · 2ecc7a6
1 parent 6041f3d
commit 2ecc7a6
Show file tree

Hide file tree

Showing 9 changed files with 331 additions and 1 deletion.
diff --git a/airbyte-integrations/connectors/source-sendgrid/Dockerfile b/airbyte-integrations/connectors/source-sendgrid/Dockerfile
@@ -12,5 +12,5 @@ RUN pip install .
 ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
 ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
 
-LABEL io.airbyte.version=0.2.6
+LABEL io.airbyte.version=0.2.7
 LABEL io.airbyte.name=airbyte/source-sendgrid
diff --git a/airbyte-integrations/connectors/source-sendgrid/acceptance-test-config.yml b/airbyte-integrations/connectors/source-sendgrid/acceptance-test-config.yml
@@ -12,6 +12,11 @@ tests:
   basic_read:
     - config_path: "secrets/config.json"
       configured_catalog_path: "sample_files/no_spam_reports_configured_catalog.json"
+      expect_records:
+        path: "integration_tests/expected_records.txt"
+        extra_fields: no
+        exact_order: no
+        extra_records: yes
   incremental:
     - config_path: "secrets/config.json"
       configured_catalog_path: "sample_files/no_spam_reports_configured_catalog.json"

diff --git a/airbyte-integrations/connectors/source-sendgrid/integration_tests/configured_catalog.json b/airbyte-integrations/connectors/source-sendgrid/integration_tests/configured_catalog.json
@@ -45,6 +45,15 @@
       "sync_mode": "full_refresh",
       "destination_sync_mode": "overwrite"
     },
+    {
+      "stream": {
+        "name": "single_sends",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
+    },
     {
       "stream": {
         "name": "templates",

diff --git a/airbyte-integrations/connectors/source-sendgrid/integration_tests/expected_records.txt b/airbyte-integrations/connectors/source-sendgrid/integration_tests/expected_records.txt
diff --git a/...egrations/connectors/source-sendgrid/sample_files/no_spam_reports_configured_catalog.json b/...egrations/connectors/source-sendgrid/sample_files/no_spam_reports_configured_catalog.json
@@ -45,6 +45,15 @@
       "sync_mode": "full_refresh",
       "destination_sync_mode": "overwrite"
     },
+    {
+      "stream": {
+        "name": "single_sends",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
+    },
     {
       "stream": {
         "name": "templates",

diff --git a/airbyte-integrations/connectors/source-sendgrid/source_sendgrid/schemas/single_sends.json b/airbyte-integrations/connectors/source-sendgrid/source_sendgrid/schemas/single_sends.json
@@ -0,0 +1,60 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string",
+      "format": "uuid"
+    },
+    "ab_phase": {
+      "type": "string"
+    },
+    "ab_variation": {
+      "type": "string"
+    },
+    "aggregation": {
+      "type": "string"
+    },
+    "stats": {
+      "type": "object",
+      "properties": {
+        "bounce_drops": {
+          "type": "integer"
+        },
+        "bounces": {
+          "type": "integer"
+        },
+        "clicks": {
+          "type": "integer"
+        },
+        "unique_clicks": {
+          "type": "integer"
+        },
+        "delivered": {
+          "type": "integer"
+        },
+        "invalid_emails": {
+          "type": "integer"
+        },
+        "opens": {
+          "type": "integer"
+        },
+        "unique_opens": {
+          "type": "integer"
+        },
+        "requests": {
+          "type": "integer"
+        },
+        "spam_report_drops": {
+          "type": "integer"
+        },
+        "spam_reports": {
+          "type": "integer"
+        },
+        "unsubscribes": {
+          "type": "integer"
+        }
+      }
+    }
+  }
+}
diff --git a/airbyte-integrations/connectors/source-sendgrid/source_sendgrid/source.py b/airbyte-integrations/connectors/source-sendgrid/source_sendgrid/source.py
@@ -39,6 +39,7 @@
     Lists,
     Scopes,
     Segments,
+    SingleSends,
     SpamReports,
     StatsAutomations,
     SuppressionGroupMembers,
@@ -66,6 +67,7 @@ def streams(self, config: Mapping[str, Any]) -> List[Stream]:
             Contacts(authenticator=authenticator),
             StatsAutomations(authenticator=authenticator),
             Segments(authenticator=authenticator),
+            SingleSends(authenticator=authenticator),
             Templates(authenticator=authenticator),
             GlobalSuppressions(authenticator=authenticator, start_time=config["start_time"]),
             SuppressionGroups(authenticator=authenticator),

diff --git a/airbyte-integrations/connectors/source-sendgrid/source_sendgrid/streams.py b/airbyte-integrations/connectors/source-sendgrid/source_sendgrid/streams.py
@@ -191,6 +191,18 @@ def path(self, **kwargs) -> str:
         return "marketing/segments"
 
 
+class SingleSends(SendgridStreamMetadataPagination):
+    """
+    https://docs.sendgrid.com/api-reference/marketing-campaign-stats/get-all-single-sends-stats
+    """
+
+    data_field = "results"
+
+    @staticmethod
+    def initial_path() -> str:
+        return "marketing/stats/singlesends"
+
+
 class Templates(SendgridStreamMetadataPagination):
     data_field = "result"
 
@@ -217,6 +229,8 @@ def path(self, **kwargs) -> str:
 
 
 class SuppressionGroupMembers(SendgridStreamOffsetPagination):
+    primary_key = "group_id"
+
     def path(self, **kwargs) -> str:
         return "asm/suppressions"
 

diff --git a/docs/integrations/sources/sendgrid.md b/docs/integrations/sources/sendgrid.md
@@ -45,4 +45,5 @@ We recommend creating a key specifically for Airbyte access. This will allow you
 
 | Version | Date       | Pull Request | Subject |
 | :------ | :--------  | :-----       | :------ |
+| 0.2.7   | 2021-09-08 | [5910](https://github.com/airbytehq/airbyte/pull/5910) | Add Single Sends Stats stream |
 | 0.2.6   | 2021-07-19 | [4839](https://github.com/airbytehq/airbyte/pull/4839) | Gracefully handle malformed responses from the API |