🎉 New Source: Captain Data [Configuration based CDK]

airbyte-config-oss/init-oss/src/main/resources/seed/oss_catalog.json

@@ -1015,6 +1015,47 @@
         }
       } ]
     }
+    },  {
+      "sourceDefinitionId": "",
+      "name": "Captain Data",
+      "dockerRepository": "airbyte/source-captain-data",
+      "dockerImageTag": "0.1.0",
+      "documentationUrl": "https://docs.airbyte.com/integrations/sources/captain-data",
+      "icon": "captain-data.svg",
+      "sourceType": "api",
+      "spec": {
+        "documentationUrl": "https://docs.airbyte.com/integrations/sources/captain-data",
+        "connectionSpecification": {
+          "$schema": "https://json-schema.org/draft-07/schema#",
+          "title": "Captain Data Source Spec",
+          "type": "object",
+          "additionalProperties": true,
+          "properties": {
+            "api_key": {
+              "title": "API Key",
+              "type": "string",
+              "description": "Your Captain Data project API key.",
+              "airbyte_secret": true
+            },
+            "api_token": {
+              "title": "Project UID",
+              "type": "string",
+              "description": "Your Captain Data project uuid.",
+              "airbyte_secret": true
+            }
+          }
+        },
+        "supportsNormalization": false,
+        "supportsDBT": false,
+        "supported_destination_sync_modes": [ ]
+      },
+      "tombstone": false,
+      "public": true,
+      "custom": false,
+      "releaseStage": "alpha",
+      "allowedHosts": {
+        "hosts": [ "api.captaindata.co" ]
+      }
   }, {
     "destinationDefinitionId": "707456df-6f4f-4ced-b5c6-03f73bcad1c5",
     "name": "Cassandra",

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

@@ -248,6 +248,14 @@
   icon: callrail.svg
   sourceType: api
   releaseStage: alpha
+- name: Captain Data
+  sourceDefinitionId: <To-be-given>
+  dockerRepository: airbyte/source-captain-data
+  dockerImageTag: 0.1.0
+  documentationUrl: https://docs.airbyte.com/integrations/sources/captain-data
+  icon: captain-data.svg
+  sourceType: api
+  releaseStage: alpha
 - name: Cart.com
   sourceDefinitionId: bb1a6d31-6879-4819-a2bd-3eed299ea8e2
   dockerRepository: airbyte/source-cart

airbyte-config-oss/init-oss/src/main/resources/seed/source_specs.yaml

@@ -2218,6 +2218,30 @@
     supportsNormalization: false
     supportsDBT: false
     supported_destination_sync_modes: []
+- dockerImage: "airbyte/source-captain-data:0.1.0"
+  spec:
+    documentationUrl: https://docs.captaindata.co/#1da39f5f-a26f-4a53-9e84-3e4b28077eae
+    connectionSpecification:
+      $schema: "http://json-schema.org/draft-07/schema#"
+      title: Captain Data Spec
+      type: object
+      required:
+        - api_key
+        - project_uid
+      additionalProperties: true
+      properties:
+        api_key:
+          title: API Key
+          type: string
+          description: Your Captain Data project API key.
+          airbyte_secret: true
+        project_uid:
+          title: Project UID
+          type: string
+          description: Your Captain Data project uuid.
+    supportsNormalization: false
+    supportsDBT: false
+    supported_destination_sync_modes: []
 - dockerImage: "airbyte/source-cart:0.2.1"
   spec:
     documentationUrl: "https://docs.airbyte.com/integrations/sources/cart"

airbyte-integrations/connectors/source-captain-data/.dockerignore

@@ -0,0 +1,6 @@
+*
+!Dockerfile
+!main.py
+!source_captain_data
+!setup.py
+!secrets

airbyte-integrations/connectors/source-captain-data/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_captain_data ./source_captain_data
+
+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-captain-data

airbyte-integrations/connectors/source-captain-data/README.md

@@ -0,0 +1,82 @@
+# Captain Data Source
+
+This is the repository for the Captain Data configuration based source connector.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/captain-data).
+
+## 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-captain-data:build
+```
+
+#### Create credentials
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/captain-data)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_captain_data/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 captain-data 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-captain-data:dev
+```
+
+You can also build the connector image via Gradle:
+```
+./gradlew :airbyte-integrations:connectors:source-captain-data: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-captain-data:dev spec
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-captain-data:dev check --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-captain-data:dev discover --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-captain-data: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 [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-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, run:
+```
+./acceptance-test-docker.sh
+```
+
+### Using gradle to run tests
+All commands should be run from airbyte project root.
+To run unit tests:
+```
+./gradlew :airbyte-integrations:connectors:source-captain-data:unitTest
+```
+To run acceptance and custom integration tests:
+```
+./gradlew :airbyte-integrations:connectors:source-captain-data: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.

airbyte-integrations/connectors/source-captain-data/__init__.py

@@ -0,0 +1,3 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#

airbyte-integrations/connectors/source-captain-data/acceptance-test-config.yml

@@ -0,0 +1,27 @@
+# See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference)
+# for more information about how to configure these tests
+connector_image: airbyte/source-captain-data:dev
+acceptance_tests:
+  spec:
+    tests:
+      - spec_path: "source_captain_data/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: []
+  incremental:
+    bypass_reason: "This connector does not implement incremental sync"
+  full_refresh:
+    tests:
+      - config_path: "secrets/config.json"
+        configured_catalog_path: "integration_tests/configured_catalog.json"

airbyte-integrations/connectors/source-captain-data/acceptance-test-docker.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env sh
+
+source "$(git rev-parse --show-toplevel)/airbyte-integrations/bases/connector-acceptance-test/acceptance-test-docker.sh"

airbyte-integrations/connectors/source-captain-data/build.gradle

@@ -0,0 +1,9 @@
+plugins {
+    id 'airbyte-python'
+    id 'airbyte-docker'
+    id 'airbyte-connector-acceptance-test'
+}
+
+airbytePython {
+    moduleDirectory 'source_captain_data'
+}

airbyte-integrations/connectors/source-captain-data/integration_tests/__init__.py

@@ -0,0 +1,3 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#

airbyte-integrations/connectors/source-captain-data/integration_tests/acceptance.py

@@ -0,0 +1,14 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+
+import pytest
+
+pytest_plugins = ("connector_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."""
+    yield

airbyte-integrations/connectors/source-captain-data/integration_tests/configured_catalog.json

@@ -0,0 +1,31 @@
+{
+  "streams": [
+    {
+      "stream": {
+        "name": "workspace",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "append"
+    },
+    {
+      "stream": {
+        "name": "workflows",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "append"
+    },
+    {
+      "stream": {
+        "name": "jobs",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "append"
+    }
+  ]
+}

airbyte-integrations/connectors/source-captain-data/integration_tests/invalid_config.json

@@ -0,0 +1,4 @@
+{
+  "api_key": "bad-api-key",
+  "project_uid": "bad-project-uid"
+}

airbyte-integrations/connectors/source-captain-data/integration_tests/sample_config.json

@@ -0,0 +1,4 @@
+{
+  "api_key": "api-key",
+  "project_uid": "project-uid"
+}

airbyte-integrations/connectors/source-captain-data/main.py

@@ -0,0 +1,13 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+
+import sys
+
+from airbyte_cdk.entrypoint import launch
+from source_captain_data import SourceCaptainData
+
+if __name__ == "__main__":
+    source = SourceCaptainData()
+    launch(source, sys.argv[1:])

airbyte-integrations/connectors/source-captain-data/requirements.txt

@@ -0,0 +1,2 @@
+-e ../../bases/connector-acceptance-test
+-e .

airbyte-integrations/connectors/source-captain-data/setup.py

@@ -0,0 +1,29 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+
+from setuptools import find_packages, setup
+
+MAIN_REQUIREMENTS = [
+    "airbyte-cdk~=0.1",
+]
+
+TEST_REQUIREMENTS = [
+    "pytest~=6.2",
+    "pytest-mock~=3.6.1",
+    "connector-acceptance-test",
+]
+
+setup(
+    name="source_captain_data",
+    description="Source implementation for Captain Data.",
+    author="Elliot Trabac",
+    author_email="elliot.trabac1@gmail.com",
+    packages=find_packages(),
+    install_requires=MAIN_REQUIREMENTS,
+    package_data={"": ["*.json", "*.yaml", "schemas/*.json", "schemas/shared/*.json"]},
+    extras_require={
+        "tests": TEST_REQUIREMENTS,
+    },
+)

airbyte-integrations/connectors/source-captain-data/source_captain_data/__init__.py

@@ -0,0 +1,8 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+
+from .source import SourceCaptainData
+
+__all__ = ["SourceCaptainData"]