Source mixpanel (airbytehq#1195)

* mixpanel integration

* add gcc to build signer tap

* fix source

* update catalogs

* fix registration name

* use base classes for source and tests

+ fix issues with creds and incremental in configured_catalog.json

* restore json config file

* set default start_date to 1 year ago

* format

* fix logging of errors in BaseSingerSource

.github/workflows/test-command.yml

@@ -59,6 +59,7 @@ jobs:
           HUBSPOT_INTEGRATION_TESTS_CREDS: ${{ secrets.HUBSPOT_INTEGRATION_TESTS_CREDS }}
           INTERCOM_INTEGRATION_TEST_CREDS: ${{ secrets.INTERCOM_INTEGRATION_TEST_CREDS }}
           MAILCHIMP_TEST_CREDS: ${{ secrets.MAILCHIMP_TEST_CREDS }}
+          MIXPANEL_INTEGRATION_TEST_CREDS: ${{ secrets.MIXPANEL_INTEGRATION_TEST_CREDS }}
           SALESFORCE_INTEGRATION_TESTS_CREDS: ${{ secrets.SALESFORCE_INTEGRATION_TESTS_CREDS }}
           SENDGRID_INTEGRATION_TEST_CREDS: ${{ secrets.SENDGRID_INTEGRATION_TEST_CREDS }}
           SHOPIFY_INTEGRATION_TEST_CREDS: ${{ secrets.SHOPIFY_INTEGRATION_TEST_CREDS }}

airbyte-config/init/src/main/resources/config/STANDARD_SOURCE_DEFINITION/859e501d-2b67-471f-91bb-1c801414d28f.json

@@ -0,0 +1,7 @@
+{
+  "sourceDefinitionId": "859e501d-2b67-471f-91bb-1c801414d28f",
+  "name": "Mixpanel",
+  "dockerRepository": "airbyte/source-mixpanel-singer",
+  "dockerImageTag": "0.1.0",
+  "documentationUrl": "https://hub.docker.com/r/airbyte/source-mixpanel-singer"
+}

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

@@ -133,3 +133,8 @@
   dockerRepository: airbyte/source-intercom-singer
   dockerImageTag: 0.1.0
   documentationUrl: https://hub.docker.com/r/airbyte/source-intercom-singer
+- sourceDefinitionId: 859e501d-2b67-471f-91bb-1c801414d28f
+  name: Mixpanel
+  dockerRepository: airbyte/source-mixpanel-singer
+  dockerImageTag: 0.1.0
+  documentationUrl: https://hub.docker.com/r/airbyte/source-mixpanel-singer

airbyte-integrations/bases/base-singer/base_singer/source.py

@@ -88,7 +88,7 @@ def check(self, logger: AirbyteLogger, config_container: ConfigContainer) -> Air
             json_config = config_container.rendered_config
             self.try_connect(logger, json_config)
         except self.api_error as err:
-            logger.error("Exception while connecting to the %s: %s", self.tap_name, str(err))
+            logger.error(f"Exception while connecting to {self.tap_name}: {err}")
             # this should be in UI
             error_msg = f"Unable to connect to {self.tap_name} with the provided credentials. Error: {err}"
             return AirbyteConnectionStatus(status=Status.FAILED, message=error_msg)

airbyte-integrations/connectors/source-mixpanel-singer/.dockerignore

@@ -0,0 +1,2 @@
+build
+.venv

airbyte-integrations/connectors/source-mixpanel-singer/.gitignore

@@ -0,0 +1 @@
+NEW_SOURCE_CHECKLIST.md

airbyte-integrations/connectors/source-mixpanel-singer/Dockerfile

@@ -0,0 +1,21 @@
+FROM airbyte/integration-base-singer:dev
+
+# Bash is installed for more convenient debugging.
+ENV DEBIAN_FRONTEND noninteractive
+RUN apt-get update \
+    && apt-get install -y bash \
+    && apt-get install -y gcc \
+    && rm -rf /var/lib/apt/lists/*
+
+ENV CODE_PATH="source_mixpanel_singer"
+ENV AIRBYTE_IMPL_MODULE="source_mixpanel_singer"
+ENV AIRBYTE_IMPL_PATH="SourceMixpanelSinger"
+
+WORKDIR /airbyte/integration_code
+COPY $CODE_PATH ./$CODE_PATH
+COPY setup.py ./
+
+RUN pip install .
+
+LABEL io.airbyte.version=0.1.0
+LABEL io.airbyte.name=airbyte/source-mixpanel-singer

airbyte-integrations/connectors/source-mixpanel-singer/Dockerfile.test

@@ -0,0 +1,28 @@
+FROM airbyte/base-python-test:dev
+
+# Bash is installed for convenient debugging.
+ENV DEBIAN_FRONTEND noninteractive
+RUN apt-get update \
+    && apt-get install -y bash \
+    && apt-get install -y gcc \
+    && rm -rf /var/lib/apt/lists/*
+
+ENV MODULE_NAME="source_mixpanel_singer"
+ENV CODE_PATH="integration_tests"
+ENV AIRBYTE_TEST_MODULE="integration_tests"
+ENV AIRBYTE_TEST_PATH="SourceMixpanelSingerStandardTest"
+
+LABEL io.airbyte.version=0.1.0
+LABEL io.airbyte.name=airbyte/source-mixpanel-singer-standard-test
+
+WORKDIR /airbyte/integration_code
+COPY $MODULE_NAME $MODULE_NAME
+COPY $CODE_PATH $CODE_PATH
+COPY secrets/* $CODE_PATH/
+COPY $MODULE_NAME/*.json $CODE_PATH/
+COPY sample_files/*.json $CODE_PATH/
+COPY setup.py ./
+
+RUN pip install ".[tests]"
+
+WORKDIR /airbyte

airbyte-integrations/connectors/source-mixpanel-singer/README.md

@@ -0,0 +1,62 @@
+# Source Mixpanel Singer
+
+This is the repository for the Mixpanel source connector, based on a Singer tap.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/mixpanel).
+
+## Local development
+### Prerequisites
+**To iterate on this connector, make sure to complete this prerequisites section.**
+
+#### Build & Activate Virtual Environment
+First, build the module by running the following from the `airbyte` project root directory: 
+```
+./gradlew :airbyte-integrations:connectors:source-mixpanel-singer:build
+```
+
+This will generate a virtualenv for this module in `source-mixpanel-singer/.venv`. Make sure this venv is active in your
+development environment of choice. To activate the venv from the terminal, run:
+```
+cd airbyte-integrations/connectors/source-mixpanel # cd into the connector directory
+source .venv/bin/activate
+```
+If you are in an IDE, follow your IDE's instructions to activate the virtualenv.
+
+#### Create credentials
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/mixpanel)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_mixpanel_singer/spec.json` file.
+See `sample_files/sample_config.json` for a sample config file.
+
+**If you are an Airbyte core member**, copy the credentials in RPass under the secret name `source-mixpanel-singer-integration-test-config`
+and place them into `secrets/config.json`.
+
+### Locally running the connector
+```
+python main_dev.py spec
+python main_dev.py check --config secrets/config.json
+python main_dev.py discover --config secrets/config.json
+python main_dev.py read --config secrets/config.json --catalog sample_files/configured_catalog.json
+```
+
+### Unit Tests
+To run unit tests locally, from the connector directory run:
+```
+pytest unit_tests
+```
+
+### Locally running the connector docker image
+```
+# in airbyte root directory
+./gradlew :airbyte-integrations:connectors:source-mixpanel-singer:airbyteDocker
+docker run --rm airbyte/source-mixpanel-singer:dev spec
+docker run --rm -v $(pwd)/airbyte-integrations/connectors/source-mixpanel-singer/secrets:/secrets airbyte/source-mixpanel-singer:dev check --config /secrets/config.json
+docker run --rm -v $(pwd)/airbyte-integrations/connectors/source-mixpanel-singer/secrets:/secrets airbyte/source-mixpanel-singer:dev discover --config /secrets/config.json
+docker run --rm -v $(pwd)/airbyte-integrations/connectors/source-mixpanel-singer/secrets:/secrets -v $(pwd)/airbyte-integrations/connectors/source-mixpanel-singer/sample_files:/sample_files airbyte/source-mixpanel-singer:dev read --config /secrets/config.json --catalog /sample_files/configured_catalog.json
+```
+
+### Integration Tests
+1. From the airbyte project root, run `./gradlew :airbyte-integrations:connectors:source-mixpanel-singer:standardSourceTestPython` to run the standard integration test suite.
+1. To run additional integration tests, place your integration tests in the `integration_tests` directory and run them with `pytest integration_tests`.
+   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.
+
+## 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.

airbyte-integrations/connectors/source-mixpanel-singer/build.gradle

@@ -0,0 +1,13 @@
+plugins {
+    id 'airbyte-python'
+    id 'airbyte-docker'
+    id 'airbyte-source-test'
+}
+
+airbytePython {
+    moduleDirectory 'source_mixpanel_singer'
+}
+
+dependencies {
+    implementation files(project(':airbyte-integrations:bases:base-singer').airbyteDocker.outputs)
+}

airbyte-integrations/connectors/source-mixpanel-singer/integration_tests/__init__.py

@@ -0,0 +1,27 @@
+"""
+MIT License
+
+Copyright (c) 2020 Airbyte
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+from .standard_source_test import SourceMixpanelSingerStandardTest
+
+__all__ = ["SourceMixpanelSingerStandardTest"]

airbyte-integrations/connectors/source-mixpanel-singer/integration_tests/standard_source_test.py

@@ -0,0 +1,29 @@
+"""
+MIT License
+
+Copyright (c) 2020 Airbyte
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+from base_python_test import DefaultStandardSourceTest
+
+
+class SourceMixpanelSingerStandardTest(DefaultStandardSourceTest):
+    pass

airbyte-integrations/connectors/source-mixpanel-singer/main_dev.py

@@ -0,0 +1,32 @@
+"""
+MIT License
+
+Copyright (c) 2020 Airbyte
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+"""
+
+import sys
+
+from base_python.entrypoint import launch
+from source_mixpanel_singer import SourceMixpanelSinger
+
+if __name__ == "__main__":
+    source = SourceMixpanelSinger()
+    launch(source, sys.argv[1:])

airbyte-integrations/connectors/source-mixpanel-singer/requirements.txt

@@ -0,0 +1,5 @@
+-e ../../bases/airbyte-protocol
+-e ../../bases/base-singer
+-e ../../bases/base-python
+-e ../../bases/base-python-test
+-e .

airbyte-integrations/connectors/source-mixpanel-singer/sample_files/catalog.json

@@ -0,0 +1,80 @@
+{
+  "streams": [
+    {
+      "name": "revenue",
+      "json_schema": {
+        "properties": {
+          "date": {
+            "format": "date",
+            "type": [
+              "null",
+              "string"
+            ]
+          },
+          "datetime": {
+            "format": "date-time",
+            "type": [
+              "null",
+              "string"
+            ]
+          },
+          "count": {
+            "type": [
+              "null",
+              "integer"
+            ]
+          },
+          "paid_count": {
+            "type": [
+              "null",
+              "integer"
+            ]
+          },
+          "amount": {
+            "multipleOf": 1e-20,
+            "type": [
+              "null",
+              "number"
+            ]
+          }
+        },
+        "type": "object",
+        "additionalProperties": false
+      },
+    },
+    {
+      "name": "annotations",
+      "json_schema": {
+        "properties": {
+          "date": {
+            "format": "date-time",
+            "type": [
+              "null",
+              "string"
+            ]
+          },
+          "project_id": {
+            "type": [
+              "null",
+              "integer"
+            ]
+          },
+          "id": {
+            "type": [
+              "null",
+              "integer"
+            ]
+          },
+          "description": {
+            "type": [
+              "null",
+              "string"
+            ]
+          }
+        },
+        "type": "object",
+        "additionalProperties": false
+      }
+    }
+  ]
+}