🎉New Source: Postmarkapp (#18820)

* added WIP connector Postmarkapp * pagination fix * fixing tests * fixing records * fixing tests * correct source def * correct build.md * run format * update doc * auto-bump connector version Co-authored-by: marcosmarxm <[email protected]> Co-authored-by: Octavia Squidington III <[email protected]> Co-authored-by: Marcos Marx <[email protected]>
airbytehq · Nov 9, 2022 · f050abc · f050abc
1 parent b3db914
commit f050abc
Show file tree

Hide file tree

Showing 35 changed files with 1,086 additions and 1 deletion.
diff --git a/airbyte-config/init/src/main/resources/seed/source_definitions.yaml b/airbyte-config/init/src/main/resources/seed/source_definitions.yaml
@@ -1075,6 +1075,13 @@
   icon: postgresql.svg
   sourceType: database
   releaseStage: generally_available
+- name: Postmark App
+  sourceDefinitionId: cde75ca1-1e28-4a0f-85bb-90c546de9f1f
+  dockerRepository: airbyte/source-postmarkapp
+  dockerImageTag: 0.1.0
+  documentationUrl: https://docs.airbyte.com/integrations/sources/postmarkapp
+  sourceType: api
+  releaseStage: alpha
 - name: Prestashop
   sourceDefinitionId: d60a46d4-709f-4092-a6b7-2457f7d455f5
   dockerRepository: airbyte/source-prestashop

diff --git a/airbyte-config/init/src/main/resources/seed/source_specs.yaml b/airbyte-config/init/src/main/resources/seed/source_specs.yaml
@@ -10557,6 +10557,31 @@
     supportsNormalization: false
     supportsDBT: false
     supported_destination_sync_modes: []
+- dockerImage: "airbyte/source-postmarkapp:0.1.0"
+  spec:
+    documentationUrl: "https://docsurl.com"
+    connectionSpecification:
+      $schema: "http://json-schema.org/draft-07/schema#"
+      title: "Postmarkapp Spec"
+      type: "object"
+      required:
+      - "X-Postmark-Server-Token"
+      - "X-Postmark-Account-Token"
+      additionalProperties: true
+      properties:
+        X-Postmark-Server-Token:
+          title: "X-Postmark-Server-Token"
+          type: "string"
+          description: "API Key for server"
+          airbyte_secret: true
+        X-Postmark-Account-Token:
+          title: "X-Postmark-Account-Token"
+          type: "string"
+          description: "API Key for account"
+          airbyte_secret: true
+    supportsNormalization: false
+    supportsDBT: false
+    supported_destination_sync_modes: []
 - dockerImage: "airbyte/source-prestashop:0.2.0"
   spec:
     documentationUrl: "https://docsurl.com"

diff --git a/airbyte-integrations/builds.md b/airbyte-integrations/builds.md
@@ -174,4 +174,4 @@
 | S3                         | [![destination-s3](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fdestination-s3%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/destination-s3)                                                    |
 | Scylla                     | [![destination-scylla](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fdestination-s3%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/destination-scylla)                                            |
 | SFTP-JSON                  | [![destination-sftp-json](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fdestination-sftp-json%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/destination-sftp-json)                               |
-| Snowflake                  | [![destination-snowflake](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fdestination-snowflake%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/destination-snowflake)                               |\
+| Snowflake                  | [![destination-snowflake](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fdestination-snowflake%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/destination-snowflake)                               |\
diff --git a/airbyte-integrations/connectors/source-postmarkapp/.dockerignore b/airbyte-integrations/connectors/source-postmarkapp/.dockerignore
@@ -0,0 +1,6 @@
+*
+!Dockerfile
+!main.py
+!source_postmarkapp
+!setup.py
+!secrets
diff --git a/airbyte-integrations/connectors/source-postmarkapp/Dockerfile b/airbyte-integrations/connectors/source-postmarkapp/Dockerfile
@@ -0,0 +1,38 @@
+FROM python:3.9.11-alpine3.15 as base
+
+# build and load all requirements
+FROM base as builder
+WORKDIR /airbyte/integration_code
+
+# upgrade pip to the latest version
+RUN apk --no-cache upgrade \
+    && pip install --upgrade pip \
+    && apk --no-cache add tzdata build-base
+
+
+COPY setup.py ./
+# install necessary packages to a temporary folder
+RUN pip install --prefix=/install .
+
+# build a clean environment
+FROM base
+WORKDIR /airbyte/integration_code
+
+# copy all loaded and built libraries to a pure basic image
+COPY --from=builder /install /usr/local
+# add default timezone settings
+COPY --from=builder /usr/share/zoneinfo/Etc/UTC /etc/localtime
+RUN echo "Etc/UTC" > /etc/timezone
+
+# bash is installed for more convenient debugging.
+RUN apk --no-cache add bash
+
+# copy payload code only
+COPY main.py ./
+COPY source_postmarkapp ./source_postmarkapp
+
+ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
+ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
+
+LABEL io.airbyte.version=0.1.0
+LABEL io.airbyte.name=airbyte/source-postmarkapp
diff --git a/airbyte-integrations/connectors/source-postmarkapp/README.md b/airbyte-integrations/connectors/source-postmarkapp/README.md
@@ -0,0 +1,79 @@
+# Postmarkapp Source
+
+This is the repository for the Postmarkapp configuration based source connector.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/postmarkapp).
+
+## Local development
+
+#### Building via Gradle
+You can also build the connector in Gradle. This is typically used in CI and not needed for your development workflow.
+
+To build using Gradle, from the Airbyte repository root, run:
+```
+./gradlew :airbyte-integrations:connectors:source-postmarkapp:build
+```
+
+#### Create credentials
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/postmarkapp)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_postmarkapp/spec.yaml` file.
+Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
+See `integration_tests/sample_config.json` for a sample config file.
+
+**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source postmarkapp test creds`
+and place them into `secrets/config.json`.
+
+### Locally running the connector docker image
+
+#### Build
+First, make sure you build the latest Docker image:
+```
+docker build . -t airbyte/source-postmarkapp:dev
+```
+
+You can also build the connector image via Gradle:
+```
+./gradlew :airbyte-integrations:connectors:source-postmarkapp:airbyteDocker
+```
+When building via Gradle, the docker image name and tag, respectively, are the values of the `io.airbyte.name` and `io.airbyte.version` `LABEL`s in
+the Dockerfile.
+
+#### Run
+Then run any of the connector commands as follows:
+```
+docker run --rm airbyte/source-postmarkapp:dev spec
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-postmarkapp:dev check --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-postmarkapp:dev discover --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-postmarkapp:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
+```
+## Testing
+
+#### Acceptance Tests
+Customize `acceptance-test-config.yml` file to configure tests. See [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-acceptance-tests-reference) for more information.
+If your connector requires to create or destroy resources for use during acceptance tests create fixtures for it and place them inside integration_tests/acceptance.py.
+
+To run your integration tests with docker
+
+### Using gradle to run tests
+All commands should be run from airbyte project root.
+To run unit tests:
+```
+./gradlew :airbyte-integrations:connectors:source-postmarkapp:unitTest
+```
+To run acceptance and custom integration tests:
+```
+./gradlew :airbyte-integrations:connectors:source-postmarkapp:integrationTest
+```
+
+## Dependency Management
+All of your dependencies should go in `setup.py`, NOT `requirements.txt`. The requirements file is only used to connect internal Airbyte dependencies in the monorepo for local development.
+We split dependencies between two groups, dependencies that are:
+* required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
+* required for the testing need to go to `TEST_REQUIREMENTS` list
+
+### Publishing a new version of the connector
+You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
+1. Make sure your changes are passing unit and integration tests.
+1. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use [SemVer](https://semver.org/)).
+1. Create a Pull Request.
+1. Pat yourself on the back for being an awesome contributor.
+1. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.
diff --git a/airbyte-integrations/connectors/source-postmarkapp/__init__.py b/airbyte-integrations/connectors/source-postmarkapp/__init__.py
@@ -0,0 +1,3 @@
+#
+# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
+#
diff --git a/airbyte-integrations/connectors/source-postmarkapp/acceptance-test-config.yml b/airbyte-integrations/connectors/source-postmarkapp/acceptance-test-config.yml
@@ -0,0 +1,40 @@
+# See [Source Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/source-acceptance-tests-reference)
+# for more information about how to configure these tests
+connector_image: airbyte/source-postmarkapp:dev
+acceptance_tests:
+  spec:
+    tests:
+      - spec_path: "source_postmarkapp/spec.yaml"
+  connection:
+    tests:
+      - config_path: "secrets/config.json"
+        status: "succeed"
+      - config_path: "integration_tests/invalid_config.json"
+        status: "failed"
+  discovery:
+    tests:
+      - config_path: "secrets/config.json"
+  basic_read:
+    tests:
+      - config_path: "secrets/config.json"
+        configured_catalog_path: "integration_tests/configured_catalog.json"
+        empty_streams:
+          - name: bounces
+            bypass_reason: "Is empty in test data"
+          - name: messages
+            bypass_reason: "Is empty in test data"
+          - name: deliverystats
+            bypass_reason: "Is empty in test data"
+          - name: servers
+            bypass_reason: "Is empty in test data"
+          - name: domains
+            bypass_reason: "Is empty in test data"
+        expect_records:
+          path: "integration_tests/expected_records.txt"
+          extra_fields: no
+          exact_order: no
+          extra_records: yes
+  full_refresh:
+    tests:
+      - config_path: "secrets/config.json"
+        configured_catalog_path: "integration_tests/configured_catalog.json"
diff --git a/airbyte-integrations/connectors/source-postmarkapp/acceptance-test-docker.sh b/airbyte-integrations/connectors/source-postmarkapp/acceptance-test-docker.sh
@@ -0,0 +1,16 @@
+#!/usr/bin/env sh
+
+# Build latest connector image
+docker build . -t $(cat acceptance-test-config.yml | grep "connector_image" | head -n 1 | cut -d: -f2-)
+
+# Pull latest acctest image
+docker pull airbyte/source-acceptance-test:latest
+
+# Run
+docker run --rm -it \
+    -v /var/run/docker.sock:/var/run/docker.sock \
+    -v /tmp:/tmp \
+    -v $(pwd):/test_input \
+    airbyte/source-acceptance-test \
+    --acceptance-test-config /test_input
+
diff --git a/airbyte-integrations/connectors/source-postmarkapp/build.gradle b/airbyte-integrations/connectors/source-postmarkapp/build.gradle
@@ -0,0 +1,9 @@
+plugins {
+    id 'airbyte-python'
+    id 'airbyte-docker'
+    id 'airbyte-source-acceptance-test'
+}
+
+airbytePython {
+    moduleDirectory 'source_postmarkapp'
+}
diff --git a/airbyte-integrations/connectors/source-postmarkapp/integration_tests/__init__.py b/airbyte-integrations/connectors/source-postmarkapp/integration_tests/__init__.py
@@ -0,0 +1,3 @@
+#
+# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
+#
diff --git a/airbyte-integrations/connectors/source-postmarkapp/integration_tests/abnormal_state.json b/airbyte-integrations/connectors/source-postmarkapp/integration_tests/abnormal_state.json
@@ -0,0 +1,5 @@
+{
+  "todo-stream-name": {
+    "todo-field-name": "todo-abnormal-value"
+  }
+}
diff --git a/airbyte-integrations/connectors/source-postmarkapp/integration_tests/acceptance.py b/airbyte-integrations/connectors/source-postmarkapp/integration_tests/acceptance.py
@@ -0,0 +1,16 @@
+#
+# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
+#
+
+
+import pytest
+
+pytest_plugins = ("source_acceptance_test.plugin",)
+
+
+@pytest.fixture(scope="session", autouse=True)
+def connector_setup():
+    """This fixture is a placeholder for external resources that acceptance test might require."""
+    # TODO: setup test dependencies if needed. otherwise remove the TODO comments
+    yield
+    # TODO: clean up test dependencies
diff --git a/airbyte-integrations/connectors/source-postmarkapp/integration_tests/configured_catalog.json b/airbyte-integrations/connectors/source-postmarkapp/integration_tests/configured_catalog.json
@@ -0,0 +1,64 @@
+{
+  "streams": [
+    {
+      "stream": {
+        "name": "deliverystats",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"],
+        "source_defined_primary_key": [["Name"]]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
+    },
+    {
+      "stream": {
+        "name": "message-streams",
+        "json_schema": {},
+        "source_defined_primary_key": [["ID"]],
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
+    },
+    {
+      "stream": {
+        "name": "servers",
+        "json_schema": {},
+        "source_defined_primary_key": [["ID"]],
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
+    },
+    {
+      "stream": {
+        "name": "messages",
+        "json_schema": {},
+        "source_defined_primary_key": [["MessageID"]],
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
+    },
+    {
+      "stream": {
+        "name": "domains",
+        "json_schema": {},
+        "source_defined_primary_key": [["ID"]],
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
+    },
+    {
+      "stream": {
+        "name": "bounces",
+        "json_schema": {},
+        "source_defined_primary_key": [["ID"]],
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
+    }
+  ]
+}
diff --git a/airbyte-integrations/connectors/source-postmarkapp/integration_tests/expected_records.txt b/airbyte-integrations/connectors/source-postmarkapp/integration_tests/expected_records.txt
@@ -0,0 +1,4 @@
+{"stream": "deliverystats", "data": {"Name": "All", "Count": 0}, "emitted_at": 1668012739230}
+{"stream": "message-streams", "data": {"ID": "broadcast", "ServerID": 9708911, "Name": "Default Broadcast Stream", "Description": "Default stream used for sending broadcast messages", "MessageStreamType": "Broadcasts", "CreatedAt": "2022-11-01T12:48:26-04:00", "UpdatedAt": null, "ArchivedAt": null, "ExpectedPurgeDate": null, "SubscriptionManagementConfiguration": {"UnsubscribeHandlingType": "Postmark"}}, "emitted_at": 1668012739882}
+{"stream": "message-streams", "data": {"ID": "inbound", "ServerID": 9708911, "Name": "Default Inbound Stream", "Description": "Default stream used for receiving inbound messages", "MessageStreamType": "Inbound", "CreatedAt": "2022-11-01T12:48:26-04:00", "UpdatedAt": null, "ArchivedAt": null, "ExpectedPurgeDate": null, "SubscriptionManagementConfiguration": {"UnsubscribeHandlingType": "None"}}, "emitted_at": 1668012739885}
+{"stream": "message-streams", "data": {"ID": "outbound", "ServerID": 9708911, "Name": "Default Transactional Stream", "Description": "Default stream used for sending transactional messages", "MessageStreamType": "Transactional", "CreatedAt": "2022-11-01T12:48:26-04:00", "UpdatedAt": null, "ArchivedAt": null, "ExpectedPurgeDate": null, "SubscriptionManagementConfiguration": {"UnsubscribeHandlingType": "None"}}, "emitted_at": 1668012739886}
diff --git a/airbyte-integrations/connectors/source-postmarkapp/integration_tests/invalid_config.json b/airbyte-integrations/connectors/source-postmarkapp/integration_tests/invalid_config.json
@@ -0,0 +1,3 @@
+{
+  "X-Postmark-Server-Token": "wrong_value"
+}
diff --git a/airbyte-integrations/connectors/source-postmarkapp/integration_tests/sample_config.json b/airbyte-integrations/connectors/source-postmarkapp/integration_tests/sample_config.json
@@ -0,0 +1,3 @@
+{
+  "X-Postmark-Server-Token": "test8616-1337-44ee-te33-235467d79901b"
+}
diff --git a/airbyte-integrations/connectors/source-postmarkapp/integration_tests/sample_state.json b/airbyte-integrations/connectors/source-postmarkapp/integration_tests/sample_state.json
@@ -0,0 +1,5 @@
+{
+  "message-streams": {
+    "ServerID": 12
+  }
+}
diff --git a/airbyte-integrations/connectors/source-postmarkapp/main.py b/airbyte-integrations/connectors/source-postmarkapp/main.py
@@ -0,0 +1,13 @@
+#
+# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
+#
+
+
+import sys
+
+from airbyte_cdk.entrypoint import launch
+from source_postmarkapp import SourcePostmarkapp
+
+if __name__ == "__main__":
+    source = SourcePostmarkapp()
+    launch(source, sys.argv[1:])
diff --git a/airbyte-integrations/connectors/source-postmarkapp/requirements.txt b/airbyte-integrations/connectors/source-postmarkapp/requirements.txt
@@ -0,0 +1,2 @@
+-e ../../bases/source-acceptance-test
+-e .