🎉 New Source: Senseforce (#18775)

* feat: initial commit source senseforce

This commit is the initial commit to the senseforce.io source.
It contains the auto-generated lowcode CDK source connector files
as well as the spec definition of the connector.

Not working yet.

* feat: stream slicing and incremental sync [pass]

This commit adds the stream slicing and incremental sync feature.

This commit passes all configured acceptance tests.

* docs: Update documentation

* change: remove unused schema readme

* change: remove catalog.json from integration_tests

* add senseforce to source def

* run format

* correct tests

* auto-bump connector version

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

Author: 3 people

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

@@ -1214,6 +1214,13 @@
   icon: sendgrid.svg
   sourceType: api
   releaseStage: beta
+- name: Senseforce
+  sourceDefinitionId: 39de93cb-1511-473e-a673-5cbedb9436af
+  dockerRepository: airbyte/source-senseforce
+  dockerImageTag: 0.1.0
+  documentationUrl: https://docs.airbyte.com/integrations/sources/senseforce
+  sourceType: api
+  releaseStage: alpha
 - name: Shopify
   sourceDefinitionId: 9da77001-af33-4bcd-be46-6252bf9342b9
   dockerRepository: airbyte/source-shopify

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

@@ -11684,6 +11684,82 @@
     supportsNormalization: false
     supportsDBT: false
     supported_destination_sync_modes: []
+- dockerImage: "airbyte/source-senseforce:0.1.0"
+  spec:
+    documentationUrl: "https://docs.airbyte.io/integrations/sources/senseforce"
+    connectionSpecification:
+      $schema: "http://json-schema.org/draft-07/schema#"
+      title: "Senseforce Source Spec"
+      type: "object"
+      required:
+      - "access_token"
+      - "backend_url"
+      - "dataset_id"
+      - "start_date"
+      additionalProperties: true
+      properties:
+        access_token:
+          type: "string"
+          title: "API Access Token"
+          description: "Your API access token. See <a href=\"https://manual.senseforce.io/manual/sf-platform/public-api/get-your-access-token/\"\
+            >here</a>. The toke is case sensitive."
+          airbyte_secret: true
+        backend_url:
+          type: "string"
+          title: "Senseforce backend URL"
+          examples:
+          - "https://galaxyapi.senseforce.io"
+          description: "Your Senseforce API backend URL. This is the URL shown during\
+            \ the Login screen. See <a href=\"https://manual.senseforce.io/manual/sf-platform/public-api/get-your-access-token/\"\
+            >here</a> for more details. (Note: Most Senseforce backend APIs have the\
+            \ term 'galaxy' in their ULR)"
+        dataset_id:
+          type: "string"
+          title: "Dataset ID"
+          examples:
+          - "8f418098-ca28-4df5-9498-0df9fe78eda7"
+          description: "The ID of the dataset you want to synchronize. The ID can\
+            \ be found in the URL when opening the dataset. See <a href=\"https://manual.senseforce.io/manual/sf-platform/public-api/get-your-access-token/\"\
+            >here</a> for more details. (Note: As the Senseforce API only allows to\
+            \ synchronize a specific dataset, each dataset you  want to synchronize\
+            \ needs to be implemented as a separate airbyte source)."
+        start_date:
+          type: "string"
+          title: "The first day (in UTC) when to read data from."
+          pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
+          description: "UTC date and time in the format 2017-01-25. Only data with\
+            \ \"Timestamp\" after this date will be replicated. Important note: This\
+            \ start date must be set to the first day of where your dataset provides\
+            \ data.  If your dataset has data from 2020-10-10 10:21:10, set the start_date\
+            \ to 2020-10-10 or later"
+          examples:
+          - "2017-01-25"
+        slice_range:
+          type: "integer"
+          title: "Data request time increment in days"
+          default: 10
+          minimum: 1
+          maximum: 365
+          examples:
+          - 1
+          - 3
+          - 10
+          - 30
+          - 180
+          - 360
+          airbyte_hidden: true
+          description: "The time increment used by the connector when requesting data\
+            \ from the Senseforce API. The bigger the value is, the less requests\
+            \ will be made and faster the sync will be. On the other hand, the more\
+            \ seldom the state is persisted and the more likely one could run into\
+            \ rate limites.  Furthermore, consider that large chunks of time might\
+            \ take a long time for the Senseforce query to return data - meaning it\
+            \ could take in effect longer than with more smaller time slices. If there\
+            \ are a lot of data per day, set this setting to 1. If there is only very\
+            \ little data per day, you might change the setting to 10 or more."
+    supportsNormalization: false
+    supportsDBT: false
+    supported_destination_sync_modes: []
 - dockerImage: "airbyte/source-shopify:0.2.0"
   spec:
     documentationUrl: "https://docs.airbyte.com/integrations/sources/shopify"

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

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

airbyte-integrations/connectors/source-senseforce/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_senseforce ./source_senseforce
+
+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-senseforce

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

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

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

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

@@ -0,0 +1,35 @@
+# See [Source Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/source-acceptance-tests-reference)
+# for more information about how to configure these tests
+connector_image: airbyte/source-senseforce:dev
+acceptance_tests:
+  spec:
+    tests:
+      - spec_path: "source_senseforce/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.txt"
+#          extra_fields: no
+#          exact_order: no
+#          extra_records: yes
+  incremental: 
+    tests:
+    - config_path: "secrets/config.json"
+      configured_catalog_path: "integration_tests/configured_catalog.json"
+  full_refresh:
+    tests:
+      - config_path: "secrets/config.json"
+        configured_catalog_path: "integration_tests/configured_catalog.json"

airbyte-integrations/connectors/source-senseforce/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-senseforce/build.gradle

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

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

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

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

@@ -0,0 +1,5 @@
+{
+  "dataset": {
+    "airbyte_cursor": "5595570341.224"
+  }
+}

airbyte-integrations/connectors/source-senseforce/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-senseforce/integration_tests/configured_catalog.json

@@ -0,0 +1,15 @@
+{
+  "streams": [
+    {
+      "stream": {
+        "name": "dataset",
+        "json_schema": {},
+        "supported_defined_cursor": true,
+        "supported_sync_modes": ["full_refresh", "incremental"]
+      },
+      "sync_mode": "incremental",
+      "destination_sync_mode": "append",
+      "cursor_field": ["airbyte_cursor"]
+    }
+  ]
+}

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

@@ -0,0 +1,7 @@
+{
+  "access_token": "somekey",
+  "backend_url": "https://galaxyapi.senseforce.io",
+  "dataset_id": "8f418098-ca28-4df5-9498-0df9fe78eda7",
+  "start_date": "2020-07-22",
+  "slice_range": 1
+}

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

@@ -0,0 +1,7 @@
+{
+  "access_token": "somekey",
+  "backend_url": "https://galaxyapi.senseforce.io",
+  "dataset_id": "8f418098-ca28-4df5-9498-0df9fe78eda7",
+  "start_date": "2020-07-22",
+  "slice_range": 1
+}

airbyte-integrations/connectors/source-senseforce/integration_tests/sample_state.json

@@ -0,0 +1,5 @@
+{
+  "dataset": {
+    "airbyte_cursor": "1595570341.224"
+  }
+}

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

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

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

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