🎉 New Source: Workable (low-code SDK) (airbytehq#18033)

* Generate initial Workable connector

* Implement jobs route

* Make acceptance tests pass

* Implement pagination

* Try to fix pagination (not yet working)

* Make pagination work

* Add created_after parameter

* Add Workable docs

* Move unused test

* Add candidates stream

* Fix acceptance tests

* Remove unused files

* Add stages stream

* Add recruiters stream

* Remove sample_state file

* Add Workable to docs/integrations/README.md

* Update changelog

* Change Sentry page size back

* Rename created_after_date to start_date

* Remove data type map

* Add start_date to sample_config.json

* Add streams documentation to yaml

* add title to params inspec

* format files

* fix: added source to source_definitions

Co-authored-by: Harshith Mullapudi <[email protected]>
Co-authored-by: marcosmarxm <[email protected]>

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

@@ -1199,6 +1199,13 @@
   icon: woocommerce.svg
   sourceType: api
   releaseStage: alpha
+- name: Workable
+  sourceDefinitionId: ef3c99c6-9e90-43c8-9517-926cfd978517
+  dockerRepository: airbyte/source-workable
+  dockerImageTag: 0.1.0
+  documentationUrl: https://docs.airbyte.com/integrations/sources/workable
+  sourceType: api
+  releaseStage: alpha
 - name: Wrike
   sourceDefinitionId: 9c13f986-a13b-4988-b808-4705badf71c2
   dockerRepository: airbyte/source-wrike

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

@@ -12219,6 +12219,40 @@
     supportsNormalization: false
     supportsDBT: false
     supported_destination_sync_modes: []
+- dockerImage: "airbyte/source-workable:0.1.0"
+  spec:
+    documentationUrl: "https://docs.airbyte.io/integrations/sources/workable"
+    connectionSpecification:
+      $schema: "http://json-schema.org/draft-07/schema#"
+      title: "Workable API Spec"
+      type: "object"
+      required:
+      - "api_key"
+      - "account_subdomain"
+      - "start_date"
+      additionalProperties: true
+      properties:
+        api_key:
+          title: "API Key"
+          type: "string"
+          description: "Your Workable API Key. See <a href=\"https://workable.readme.io/reference/generate-an-access-token\"\
+            >here</a>."
+          airbyte_secret: true
+        account_subdomain:
+          title: "Account Subdomain"
+          type: "string"
+          description: "Your Workable account subdomain, e.g. https://your_account_subdomain.workable.com."
+        start_date:
+          title: "Start Date"
+          type: "string"
+          description: "Get data that was created since this date (format: YYYYMMDDTHHMMSSZ)."
+          pattern: "^[0-9]{8}T[0-9]{6}Z$"
+          examples:
+          - "20150708T115616Z"
+          - "20221115T225616Z"
+    supportsNormalization: false
+    supportsDBT: false
+    supported_destination_sync_modes: []
 - dockerImage: "airbyte/source-wrike:0.1.0"
   spec:
     documentationUrl: "https://docsurl.com"

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

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

airbyte-integrations/connectors/source-workable/.python-version

@@ -0,0 +1 @@
+3.9.11

airbyte-integrations/connectors/source-workable/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_workable ./source_workable
+
+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-workable

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

@@ -0,0 +1,79 @@
+# Workable Source
+
+This is the repository for the Workable configuration based source connector.
+For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/workable).
+
+## 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-workable:build
+```
+
+#### Create credentials
+**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/workable)
+to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_workable/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 workable 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-workable:dev
+```
+
+You can also build the connector image via Gradle:
+```
+./gradlew :airbyte-integrations:connectors:source-workable: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-workable:dev spec
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-workable:dev check --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-workable:dev discover --config /secrets/config.json
+docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-workable: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-workable:unitTest
+```
+To run acceptance and custom integration tests:
+```
+./gradlew :airbyte-integrations:connectors:source-workable: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-workable/__init__.py

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

airbyte-integrations/connectors/source-workable/acceptance-test-config.yml

@@ -0,0 +1,20 @@
+# See [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-acceptance-tests-reference)
+# for more information about how to configure these tests
+connector_image: airbyte/source-workable:dev
+tests:
+  spec:
+    - spec_path: "source_workable/spec.yaml"
+  connection:
+    - config_path: "secrets/config.json"
+      status: "succeed"
+    - config_path: "integration_tests/invalid_config.json"
+      status: "failed"
+  discovery:
+    - config_path: "secrets/config.json"
+  basic_read:
+    - config_path: "secrets/config.json"
+      configured_catalog_path: "integration_tests/configured_catalog.json"
+      empty_streams: []
+  full_refresh:
+    - config_path: "secrets/config.json"
+      configured_catalog_path: "integration_tests/configured_catalog.json"

airbyte-integrations/connectors/source-workable/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
+

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

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

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

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

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

@@ -0,0 +1,5 @@
+{
+  "jobs": {
+    "id": 0
+  }
+}

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

@@ -0,0 +1,14 @@
+#
+# 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."""
+    yield

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

@@ -0,0 +1,22 @@
+{
+  "streams": [
+    {
+      "stream": {
+        "name": "jobs",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
+    },
+    {
+      "stream": {
+        "name": "candidates",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
+    }
+  ]
+}

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

@@ -0,0 +1,5 @@
+{
+  "api_key": "<invalid_key>",
+  "account_subdomain": "invalid_subdomain",
+  "start_date": "00001115T225616Z"
+}

airbyte-integrations/connectors/source-workable/integration_tests/sample_config.json

@@ -0,0 +1,5 @@
+{
+  "api_key": "<api_key>",
+  "account_subdomain": "<account_subdomain>",
+  "start_date": "<YYYYMMDDTHHMMSSZ>"
+}

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

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

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

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

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

@@ -0,0 +1,29 @@
+#
+# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
+#
+
+
+from setuptools import find_packages, setup
+
+MAIN_REQUIREMENTS = [
+    "airbyte-cdk~=0.1",
+]
+
+TEST_REQUIREMENTS = [
+    "pytest~=6.1",
+    "pytest-mock~=3.6.1",
+    "source-acceptance-test",
+]
+
+setup(
+    name="source_workable",
+    description="Source implementation for Workable.",
+    author="Airbyte",
+    author_email="[email protected]",
+    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-workable/source_workable/__init__.py

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

airbyte-integrations/connectors/source-workable/source_workable/schemas/candidates.json

@@ -0,0 +1,21 @@
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": ["null", "string"]
+    },
+    "name": {
+      "type": ["null", "string"]
+    },
+    "headline": {
+      "type": ["null", "string"]
+    },
+    "email": {
+      "type": ["null", "string"]
+    },
+    "role": {
+      "type": ["null", "string"]
+    }
+  }
+}