🎉 New Source: Yotpo [Low code CDK]

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

@@ -2549,6 +2549,14 @@
   allowedHosts:
     hosts:
       - api-metrica.yandex.net
+- name: Yotpo
+  sourceDefinitionId: <To-be-given>
+  dockerRepository: airbyte/source-yotpo
+  dockerImageTag: 0.1.0
+  documentationUrl: https://docs.airbyte.com/integrations/sources/yotpo
+  icon: yotpo.svg
+  sourceType: api
+  releaseStage: alpha
 - name: Younium
   sourceDefinitionId: 9c74c2d7-531a-4ebf-b6d8-6181f805ecdc
   dockerRepository: airbyte/source-younium

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

@@ -18619,6 +18619,45 @@
     supportsNormalization: false
     supportsDBT: false
     supported_destination_sync_modes: []
+- dockerImage: "airbyte/source-yotpo:0.1.0"
+  spec:
+    documentationUrl: "https://docs.airbyte.com/integrations/sources/yotpo"
+    connectionSpecification:
+      $schema: "http://json-schema.org/draft-07/schema#"
+      title: Yotpo Spec
+      type: object
+      required:
+        - access_token
+        - app_key
+        - start_date
+        - email
+      additionalProperties: true
+      properties:
+        access_token:
+          title: Access Token
+          type: string
+          description: Access token recieved as a result of API call to https://api.yotpo.com/oauth/token (Ref- https://apidocs.yotpo.com/reference/yotpo-authentication)
+          airbyte_secret: true
+        app_key:
+          title: App Key
+          type: string
+          description: App key found at settings (Ref- https://settings.yotpo.com/#/general_settings)
+        start_date:
+          title: Date-From Filter
+          type: string
+          description: Date time filter for incremental filter, Specify which date to extract from.
+          pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}.[0-9]{3}Z$"
+          examples:
+            - "2022-03-01T00:00:00.000Z"
+          format: "date-time"
+        email:
+          title: Registered email address
+          type: string
+          description: Email address registered with yotpo.
+          default: example@gmail.com
+    supportsNormalization: false
+    supportsDBT: false
+    supported_destination_sync_modes: []
 - dockerImage: "airbyte/source-younium:0.1.0"
   spec:
     documentationUrl: "https://docs.airbyte.com/integrations/sources/younium"

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

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

airbyte-integrations/connectors/source-yotpo/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_yotpo ./source_yotpo
+
+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-yotpo

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

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

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

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

@@ -0,0 +1,44 @@
+# 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-yotpo:dev
+acceptance_tests:
+  spec:
+    tests:
+      - spec_path: "source_yotpo/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: 
+          - name: "raw_data"
+            bypass_reason: "Sandbox account cannot seed the endpoint"
+          - name: "unsubscribers"
+            bypass_reason: "Sandbox account cannot seed the endpoint"
+          - name: "webhooks"
+            bypass_reason: "Sandbox account cannot seed the endpoint"
+          - name: "webhook_events"
+            bypass_reason: "Sandbox account cannot seed the endpoint"
+        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-yotpo/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-yotpo/build.gradle

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

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

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

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

@@ -0,0 +1,9 @@
+[
+  {
+    "type": "STREAM",
+    "stream": {
+      "stream_state": { "created_at": "2099-04-12T18:13:36.000Z" },
+      "stream_descriptor": { "name": "reviews" }
+    }
+  }
+]

airbyte-integrations/connectors/source-yotpo/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 if needed. otherwise remove the TODO comments
+    yield
+    # TODO: clean up test dependencies

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

@@ -0,0 +1,58 @@
+{
+  "streams": [
+    {
+      "stream": {
+        "name": "email_analytics",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
+    },
+    {
+      "stream": {
+        "name": "raw_data",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
+    },
+    {
+      "stream": {
+        "name": "reviews",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh", "incremental"]
+      },
+      "sync_mode": "incremental",
+      "destination_sync_mode": "append"
+    },
+    {
+      "stream": {
+        "name": "unsubscribers",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
+    },
+    {
+      "stream": {
+        "name": "webhooks",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
+    },
+    {
+      "stream": {
+        "name": "webhook_events",
+        "json_schema": {},
+        "supported_sync_modes": ["full_refresh"]
+      },
+      "sync_mode": "full_refresh",
+      "destination_sync_mode": "overwrite"
+    }
+  ]
+}

airbyte-integrations/connectors/source-yotpo/integration_tests/expected_records.jsonl

@@ -0,0 +1 @@
+{"stream": "reviews", "data":{"id":465001595,"title":"Great Phone","content":"It’s really good","score":5,"votes_up":0,"votes_down":0,"created_at":"2023-04-26T21:46:31.000Z","updated_at":"2023-04-26T21:46:42.000Z","sentiment":null,"sku":"100","name":"John S.","email":"moles57397@snowlash.com","reviewer_type":"verified_reviewer","deleted":false,"archived":false,"escalated":false,"is_incentivized":false}, "emitted_at": 1679051186823}

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

@@ -0,0 +1,6 @@
+{
+  "app_key": "<invalid>",
+  "access_token": "<invalid>",
+  "start_date": "2099-04-12T18:42:50.000Z",
+  "email": "<invalid>"
+}

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

@@ -0,0 +1,6 @@
+{
+  "app_key": "XXXXXXXXXXXXXXXXXXX",
+  "access_token": "YYYYYYYYYYYYYYYY",
+  "start_date": "2020-04-12T18:42:50.000Z",
+  "email": "example@gmail.com"
+}

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

@@ -0,0 +1,9 @@
+[
+  {
+    "type": "STREAM",
+    "stream": {
+      "stream_state": { "created_at": "2023-04-12T18:13:36.000Z" },
+      "stream_descriptor": { "name": "reviews" }
+    }
+  }
+]

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

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

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

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