kobotoolbox connector

airbyte-integrations/connectors/source-kobotoolbox/.dockerignore

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

airbyte-integrations/connectors/source-kobotoolbox/Dockerfile

@@ -0,0 +1,35 @@
+FROM python:3.10.8-slim-bullseye as base
+
+# build and load all requirements
+FROM base as builder
+WORKDIR /airbyte/integration_code
+
+# upgrade pip to the latest version
+RUN apt-get update && apt-get install -y && rm -rf /var/lib/apt/lists/* \
+    # apk --no-cache upgrade \
+    && pip install --upgrade pip \
+    && python3 -m pip install --upgrade setuptools
+
+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
+
+# copy payload code only
+COPY main.py ./
+COPY source_kobotoolbox ./source_kobotoolbox
+
+ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
+ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
+
+LABEL io.airbyte.version=0.2.0
+LABEL io.airbyte.name=tech4dev/source-kobotoolbox

airbyte-integrations/connectors/source-kobotoolbox/README.md

@@ -0,0 +1,129 @@
+# Kobotoolbox Source
+
+This is the repository for the Kobotoolbox source connector, written in Python.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/kobotoolbox).
+
+## Local development
+
+### Prerequisites
+**To iterate on this connector, make sure to complete this prerequisites section.**
+
+#### Minimum Python version required `= 3.9.0`
+
+#### Build & Activate Virtual Environment and install dependencies
+From this connector directory, create a virtual environment:
+```
+python -m venv .venv
+```
+
+This will generate a virtualenv 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:source-kobotoolbox:build
+```
+
+#### Create credentials
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/kobotoolbox)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_kobotoolbox/spec.yaml` 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 credentials in Lastpass under the secret name `source kobotoolbox test creds`
+and place them into `secrets/config.json`.
+
+### Locally running the connector
+```
+python main.py spec
+python main.py check --config secrets/config.json
+python main.py discover --config secrets/config.json
+python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json
+```
+
+### Locally running the connector docker image
+
+#### Build
+First, make sure you build the latest Docker image:
+```
+docker build . -t airbyte/source-kobotoolbox:dev
+```
+
+You can also build the connector image via Gradle:
+```
+./gradlew :airbyte-integrations:connectors:source-kobotoolbox: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-kobotoolbox:dev spec
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-kobotoolbox:dev check --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-kobotoolbox:dev discover --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-kobotoolbox:dev read --config /secrets/config.json --catalog /integration_tests/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 source 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
+```
+python -m pytest integration_tests
+```
+#### 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 acceptance tests, from the connector root, run
+```
+python -m pytest integration_tests -p integration_tests.acceptance
+```
+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-kobotoolbox:unitTest
+```
+To run acceptance and custom integration tests:
+```
+./gradlew :airbyte-integrations:connectors:source-kobotoolbox: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-kobotoolbox/acceptance-test-config.yml

@@ -0,0 +1,37 @@
+# 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-kobotoolbox:dev
+acceptance_tests:
+    spec:
+        tests:
+            - spec_path: "source_kobotoolbox/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: []
+    # TODO uncomment this block to specify that the tests should assert the connector outputs the records provided in the input file a file
+    #        expect_records:
+    #          path: "integration_tests/expected_records.jsonl"
+    #          extra_fields: no
+    #          exact_order: no
+    #          extra_records: yes
+    incremental:
+        tests:
+            - config_path: "secrets/config.json"
+              configured_catalog_path: "integration_tests/configured_catalog.json"
+              future_state:
+                  future_state_path: "integration_tests/abnormal_state.json"
+    full_refresh:
+        tests:
+            - config_path: "secrets/config.json"
+              configured_catalog_path: "integration_tests/configured_catalog.json"

airbyte-integrations/connectors/source-kobotoolbox/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/connector-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/connector-acceptance-test \
+    --acceptance-test-config /test_input
+

airbyte-integrations/connectors/source-kobotoolbox/build.gradle

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

airbyte-integrations/connectors/source-kobotoolbox/integration_tests/__init__.py

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

airbyte-integrations/connectors/source-kobotoolbox/integration_tests/abnormal_state.json

@@ -0,0 +1,5 @@
+{
+    "Daily Issue Form": {
+        "endtime": "2024-01-01T00:00:00"
+    }
+}

airbyte-integrations/connectors/source-kobotoolbox/integration_tests/acceptance.py

@@ -0,0 +1,16 @@
+#
+# 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."""
+    # TODO: setup test dependencies
+    yield
+    # TODO: clean up test dependencies

airbyte-integrations/connectors/source-kobotoolbox/integration_tests/configured_catalog.json

@@ -0,0 +1,20 @@
+{
+    "streams": [
+        {
+            "stream": {
+                "name": "Employability Skill Assessment Registration",
+                "json_schema": {
+                    "$schema": "http://json-schema.org/draft-07/schema#",
+                    "type": "object",
+                    "properties": {}
+                  },
+                "supported_sync_modes": ["full_refresh", "incremental"],
+                "source_defined_cursor": false,
+                "default_cursor_field": ["_submission_time"]
+            },
+            "sync_mode": "incremental",
+            "cursor_field": ["_submission_time"],
+            "destination_sync_mode": "append_dedup"
+        }
+    ]
+}

airbyte-integrations/connectors/source-kobotoolbox/integration_tests/invalid_config.json

@@ -0,0 +1,4 @@
+{
+    "username": "thisisarandomusername",
+    "password": "thisisarandompassword"
+}

airbyte-integrations/connectors/source-kobotoolbox/main.py

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

airbyte-integrations/connectors/source-kobotoolbox/requirements.txt

@@ -0,0 +1,3 @@
+# This file is autogenerated -- only edit if you know what you are doing. Use setup.py for declaring dependencies.
+-e ../../bases/connector-acceptance-test
+-e .

airbyte-integrations/connectors/source-kobotoolbox/sample_files/configured_catalog.json

@@ -0,0 +1,16 @@
+{
+    "streams": [
+        {
+            "stream": {
+                "name": "kobo_tool_stream",
+                "json_schema": {},
+                "supported_sync_modes": ["full_refresh", "incremental"],
+                "source_defined_cursor": true,
+                "default_cursor_field": ["_submission_time"]
+            },
+            "sync_mode": "incremental",
+            "cursor_field": ["_submission_time"],
+            "destination_sync_mode": "append"
+        }
+    ]
+}

airbyte-integrations/connectors/source-kobotoolbox/setup.py

@@ -0,0 +1,23 @@
+#
+# Copyright (c) 2023 Airbyte, Inc., all rights reserved.
+#
+
+
+from setuptools import find_packages, setup
+
+MAIN_REQUIREMENTS = ["airbyte-cdk~=0.2"]
+
+TEST_REQUIREMENTS = ["pytest~=6.2", "connector-acceptance-test", "requests_mock"]
+
+setup(
+    name="source_kobotoolbox",
+    description="Source implementation for Kobotoolbox.",
+    author="Airbyte",
+    author_email="[email protected]",
+    packages=find_packages(),
+    install_requires=MAIN_REQUIREMENTS,
+    package_data={"": ["*.json", "*.yaml"]},
+    extras_require={
+        "tests": TEST_REQUIREMENTS,
+    },
+)

airbyte-integrations/connectors/source-kobotoolbox/source_kobotoolbox/__init__.py

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