🎉 New Destination: Heap Analytics [python cdk] (#18530)

* 🎉 New Desination: Heap Analytics [python cdk]

- implement a heap client to load data via the server-side API: https://developers.heap.io/reference/server-side-apis-overview
- the connector supports a generic data source, and the api_type determines the output schema. The output schema is dynamic.
- users pick the columns that will be loaded to the destination
- Consequently, each configured catalog only includes one stream

* add a bootstrap to illustrate the connector

* add destination dest def

* run format all files

* correct unit test

* auto-bump connector version

Co-authored-by: Vincent Koc <[email protected]>
Co-authored-by: marcosmarxm <[email protected]>
Co-authored-by: Octavia Squidington III <[email protected]>

airbyte-config/init/src/main/resources/seed/destination_definitions.yaml

@@ -137,6 +137,12 @@
   documentationUrl: https://docs.airbyte.com/integrations/destinations/pubsub
   icon: googlepubsub.svg
   releaseStage: alpha
+- name: Heap Analytics
+  destinationDefinitionId: f8e68742-407a-4a3c-99ad-dfd42ae2cba8
+  dockerRepository: airbyte/destination-heap-analytics
+  dockerImageTag: 0.1.0
+  documentationUrl: https://docs.airbyte.com/integrations/destinations/heap-analytics
+  releaseStage: alpha
 - name: Kafka
   destinationDefinitionId: 9f760101-60ae-462f-9ee6-b7a9dafd454d
   dockerRepository: airbyte/destination-kafka

airbyte-config/init/src/main/resources/seed/destination_specs.yaml

@@ -2431,6 +2431,148 @@
     supportsDBT: false
     supported_destination_sync_modes:
     - "append"
+- dockerImage: "airbyte/destination-heap-analytics:0.1.0"
+  spec:
+    documentationUrl: "https://docs.airbyte.com/integrations/destinations/heap-analytics"
+    connectionSpecification:
+      $schema: "http://json-schema.org/draft-07/schema#"
+      title: "Heap Analytics Destination Spec"
+      type: "object"
+      required:
+      - "base_url"
+      - "app_id"
+      - "api"
+      additionalProperties: true
+      properties:
+        app_id:
+          order: 0
+          type: "string"
+          title: "App Id"
+          description: "The Environment Id of your Main Profudction project, read\
+            \ <a href=\"https://help.heap.io/data-management/data-management-features/projects-environments/\"\
+            >the doc</a> to learn more."
+          default: "11"
+        base_url:
+          order: 1
+          type: "string"
+          title: "Base URL"
+          description: "The Base URL for Heap Analytics"
+          default: "https://heapanalytics.com"
+          examples:
+          - "https://heapanalytics.com"
+        api:
+          order: 2
+          type: "object"
+          title: "API Type"
+          additionalProperties: true
+          oneOf:
+          - order: 0
+            type: "object"
+            title: "Track Events"
+            required:
+            - "api_type"
+            - "property_columns"
+            - "event_column"
+            - "identity_column"
+            properties:
+              api_type:
+                order: 0
+                type: "string"
+                const: "track"
+              property_columns:
+                order: 1
+                type: "string"
+                title: "Property Columns"
+                default: "*"
+                description: "Please list all columns populated to the properties\
+                  \ attribute, split by comma(,). It's case sensitive."
+                examples:
+                - "subject,variation"
+              event_column:
+                order: 2
+                type: "string"
+                title: "Event Column"
+                description: "Please pick the column populated to the event attribute.\
+                  \ It's case sensitive."
+                examples:
+                - "order_name"
+              identity_column:
+                order: 3
+                type: "string"
+                title: "Identity Column"
+                description: "Please pick the column populated to the identity attribute."
+                examples:
+                - "email"
+              timestamp_column:
+                order: 4
+                type: "string"
+                title: "Identity Column"
+                description: "Please pick the column populated to the (optional) timestamp\
+                  \ attribute. time_now() will be used if missing."
+                examples:
+                - "updated_at"
+          - order: 1
+            type: "object"
+            title: "Add User Properties"
+            required:
+            - "api_type"
+            - "property_columns"
+            - "identity_column"
+            properties:
+              api_type:
+                order: 0
+                type: "string"
+                const: "add_user_properties"
+              property_columns:
+                order: 1
+                type: "string"
+                title: "Property Columns"
+                default: "*"
+                description: "Please list all columns populated to the properties\
+                  \ attribute, split by comma(,). It's case sensitive."
+                examples:
+                - "age,language,profession"
+              identity_column:
+                order: 3
+                type: "string"
+                title: "Identity Column"
+                description: "Please pick the column populated to the identity attribute."
+                examples:
+                - "user_id"
+          - order: 2
+            type: "object"
+            title: "Add Account Properties"
+            required:
+            - "api_type"
+            - "property_columns"
+            - "account_id_column"
+            properties:
+              api_type:
+                order: 0
+                type: "string"
+                const: "add_account_properties"
+              property_columns:
+                order: 1
+                type: "string"
+                title: "Property Columns"
+                default: "*"
+                description: "Please list all columns populated to the properties\
+                  \ attribute, split by comma(,). It's case sensitive."
+                examples:
+                - "is_in_good_standing,revenue_potential,account_hq,subscription"
+              account_id_column:
+                order: 3
+                type: "string"
+                title: "Account ID Column"
+                description: "Please pick the column populated to the account_id attribute."
+                examples:
+                - "company_name"
+    supportsIncremental: true
+    supportsNormalization: false
+    supportsDBT: false
+    supported_destination_sync_modes:
+    - "append"
+    - "append_dedup"
 - dockerImage: "airbyte/destination-kafka:0.1.10"
   spec:
     documentationUrl: "https://docs.airbyte.com/integrations/destinations/kafka"

airbyte-integrations/connectors/destination-heap-analytics/.dockerignore

@@ -0,0 +1,5 @@
+*
+!Dockerfile
+!main.py
+!destination_heap_analytics
+!setup.py

airbyte-integrations/connectors/destination-heap-analytics/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 destination_heap_analytics ./destination_heap_analytics
+
+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/destination-heap-analytics

airbyte-integrations/connectors/destination-heap-analytics/README.md

@@ -0,0 +1,180 @@
+# Heap Analytics Destination
+
+This is the repository for the Heap Analytics destination connector, written in Python.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/destinations/heap-analytics).
+
+## Local development
+
+### Prerequisites
+**To iterate on this connector, make sure to complete this prerequisites section.**
+
+#### Minimum Python version required `= 3.7.0`
+
+#### Build & Activate Virtual Environment and install dependencies
+
+From this connector directory, create a virtualenv:
+```
+python -m venv .venv
+```
+
+This will generate a virtual environment for this module in `.venv/`. Make sure this venv is active in your
+development environment of choice. To activate it from the terminal, run:
+```
+source .venv/bin/activate
+pip install -r requirements.txt
+```
+If you are in an IDE, follow your IDE's instructions to activate the virtualenv.
+
+Note that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is
+used for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.
+If this is mumbo jumbo to you, don't worry about it, just put your deps in `setup.py` but install using `pip install -r requirements.txt` and everything
+should work as you expect.
+
+#### Building via Gradle
+From the Airbyte repository root, run:
+```
+./gradlew :airbyte-integrations:connectors:destination-heap-analytics:build
+```
+
+#### Create credentials
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/destinations/heap-analytics)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `destination_heap_analytics/spec.json` file.
+Note that the `secrets` directory is gitignored by default, 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 app id in Lastpass under the secret name `destination heap-analytics app id` and replace the app_id under the `sample_files/config-*.json`
+
+### Locally running the connector
+
+#### Server-Side API - Track
+
+Use [this API](https://developers.heap.io/reference/track-1) to send custom events to Heap server-side.
+
+```bash
+python main.py spec
+python main.py check --config sample_files/config-events.json
+cat sample_files/messages.jsonl | python main.py write --config sample_files/config-events.json --catalog sample_files/configured_catalog.json
+```
+
+#### Server-Side API - Add User Properties
+
+[This API](https://developers.heap.io/reference/add-user-properties) allows you to attach custom properties to any identified users from your servers, such as Sign Up Date (in ISO8601 format), Total # Transactions Completed, or Total Dollars Spent.
+
+```bash
+python main.py spec
+python main.py check --config sample_files/config-aup.json
+cat sample_files/messages.jsonl | python main.py write --config sample_files/config-aup.json --catalog sample_files/configured_catalog.json
+```
+
+#### Server-Side API - Add Account Properties
+
+[This API](https://developers.heap.io/reference/add-account-properties) allows you to attach custom account properties to users. An account ID or use of our Salesforce integration is required for this to work.
+
+```bash
+python main.py spec
+python main.py check --config sample_files/config-aap.json
+cat sample_files/messages.jsonl | python main.py write --config sample_files/config-aap.json --catalog sample_files/configured_catalog.json
+```
+
+### Locally running the connector docker image
+
+#### Build
+
+First, make sure you build the latest Docker image:
+
+```bash
+docker build . -t airbyte/destination-heap-analytics:dev
+```
+
+You can also build the connector image via Gradle:
+
+```bash
+./gradlew :airbyte-integrations:connectors:destination-heap-analytics: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:
+Spec command
+
+```bash
+docker run --rm airbyte/destination-heap-analytics:dev spec
+```
+
+Check command
+
+```bash
+docker run --rm -v $(pwd)/sample_files:/sample_files airbyte/destination-heap-analytics:dev check --config /sample_files/config-events.json
+docker run --rm -v $(pwd)/sample_files:/sample_files airbyte/destination-heap-analytics:dev check --config /sample_files/config-aap.json
+docker run --rm -v $(pwd)/sample_files:/sample_files airbyte/destination-heap-analytics:dev check --config /sample_files/config-aup.json
+```
+
+Write command
+```bash
+# messages.jsonl is a file containing line-separated JSON representing AirbyteMessages
+cat sample_files/messages.jsonl | docker run --rm -v $(pwd)/sample_files:/sample_files airbyte/destination-heap-analytics:dev write --config /sample_files/config-events.json --catalog /sample_files/configured_catalog.json
+cat sample_files/messages.jsonl | docker run --rm -v $(pwd)/sample_files:/sample_files airbyte/destination-heap-analytics:dev write --config /sample_files/config-aup.json --catalog /sample_files/configured_catalog.json
+cat sample_files/messages.jsonl | docker run --rm -v $(pwd)/sample_files:/sample_files airbyte/destination-heap-analytics:dev write --config /sample_files/config-aap.json --catalog /sample_files/configured_catalog.json
+```
+
+## Testing
+
+Make sure to familiarize yourself with [pytest test discovery](https://docs.pytest.org/en/latest/goodpractices.html#test-discovery) to know how your test files and methods should be named.
+First install test dependencies into your virtual environment:
+
+```
+pip install .[tests]
+```
+
+### Unit Tests
+To run unit tests locally, from the connector directory run:
+
+```
+python -m pytest unit_tests
+```
+
+### Integration Tests
+
+There are two types of integration tests: Acceptance Tests (Airbyte's test suite for all destination connectors) and custom integration tests (which are specific to this connector).
+
+#### Custom Integration tests
+
+Place custom tests inside `integration_tests/` folder, then, from the connector root, run
+
+```bash
+python -m pytest integration_tests
+```
+
+### Using gradle to run tests
+
+All commands should be run from airbyte project root.
+To run unit tests:
+
+```bash
+./gradlew :airbyte-integrations:connectors:destination-heap-analytics:unitTest
+```
+
+To run acceptance and custom integration tests:
+```bash
+./gradlew :airbyte-integrations:connectors:destination-heap-analytics: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.
+2. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use [SemVer](https://semver.org/)).
+3. Create a Pull Request.
+4. Pat yourself on the back for being an awesome contributor.
+5. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.