From 81ba75a7d358ba60f7f15c58da5bde47ca58596e Mon Sep 17 00:00:00 2001 From: Dainius Salkauskas Date: Mon, 31 Oct 2022 01:22:21 +0200 Subject: [PATCH 1/9] Init source smartengage --- .../source-smartengage/.dockerignore | 6 ++ .../connectors/source-smartengage/Dockerfile | 38 +++++++++ .../connectors/source-smartengage/README.md | 79 +++++++++++++++++++ .../connectors/source-smartengage/__init__.py | 3 + .../acceptance-test-config.yml | 38 +++++++++ .../acceptance-test-docker.sh | 16 ++++ .../source-smartengage/build.gradle | 9 +++ .../integration_tests/__init__.py | 3 + .../integration_tests/acceptance.py | 16 ++++ .../integration_tests/configured_catalog.json | 48 +++++++++++ .../integration_tests/invalid_config.json | 4 + .../integration_tests/sample_config.json | 4 + .../integration_tests/sample_state.json | 5 ++ .../connectors/source-smartengage/main.py | 13 +++ .../source-smartengage/requirements.txt | 2 + .../connectors/source-smartengage/setup.py | 29 +++++++ .../source_smartengage/__init__.py | 8 ++ .../source_smartengage/schemas/avatars.json | 23 ++++++ .../schemas/custom_fields.json | 14 ++++ .../source_smartengage/schemas/sequences.json | 14 ++++ .../source_smartengage/schemas/tags.json | 14 ++++ .../source_smartengage/smartengage.yaml | 67 ++++++++++++++++ .../source_smartengage/source.py | 18 +++++ .../source_smartengage/spec.yaml | 18 +++++ docs/integrations/sources/smartengage.md | 33 ++++++++ 25 files changed, 522 insertions(+) create mode 100644 airbyte-integrations/connectors/source-smartengage/.dockerignore create mode 100644 airbyte-integrations/connectors/source-smartengage/Dockerfile create mode 100644 airbyte-integrations/connectors/source-smartengage/README.md create mode 100644 airbyte-integrations/connectors/source-smartengage/__init__.py create mode 100644 airbyte-integrations/connectors/source-smartengage/acceptance-test-config.yml create mode 100644 airbyte-integrations/connectors/source-smartengage/acceptance-test-docker.sh create mode 100644 airbyte-integrations/connectors/source-smartengage/build.gradle create mode 100644 airbyte-integrations/connectors/source-smartengage/integration_tests/__init__.py create mode 100644 airbyte-integrations/connectors/source-smartengage/integration_tests/acceptance.py create mode 100644 airbyte-integrations/connectors/source-smartengage/integration_tests/configured_catalog.json create mode 100644 airbyte-integrations/connectors/source-smartengage/integration_tests/invalid_config.json create mode 100644 airbyte-integrations/connectors/source-smartengage/integration_tests/sample_config.json create mode 100644 airbyte-integrations/connectors/source-smartengage/integration_tests/sample_state.json create mode 100644 airbyte-integrations/connectors/source-smartengage/main.py create mode 100644 airbyte-integrations/connectors/source-smartengage/requirements.txt create mode 100644 airbyte-integrations/connectors/source-smartengage/setup.py create mode 100644 airbyte-integrations/connectors/source-smartengage/source_smartengage/__init__.py create mode 100644 airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/avatars.json create mode 100644 airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/custom_fields.json create mode 100644 airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/sequences.json create mode 100644 airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/tags.json create mode 100644 airbyte-integrations/connectors/source-smartengage/source_smartengage/smartengage.yaml create mode 100644 airbyte-integrations/connectors/source-smartengage/source_smartengage/source.py create mode 100644 airbyte-integrations/connectors/source-smartengage/source_smartengage/spec.yaml create mode 100644 docs/integrations/sources/smartengage.md diff --git a/airbyte-integrations/connectors/source-smartengage/.dockerignore b/airbyte-integrations/connectors/source-smartengage/.dockerignore new file mode 100644 index 0000000000000..4dafb44b3d8db --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/.dockerignore @@ -0,0 +1,6 @@ +* +!Dockerfile +!main.py +!source_smartengage +!setup.py +!secrets diff --git a/airbyte-integrations/connectors/source-smartengage/Dockerfile b/airbyte-integrations/connectors/source-smartengage/Dockerfile new file mode 100644 index 0000000000000..4e42844d9de15 --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/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_smartengage ./source_smartengage + +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-smartengage diff --git a/airbyte-integrations/connectors/source-smartengage/README.md b/airbyte-integrations/connectors/source-smartengage/README.md new file mode 100644 index 0000000000000..c44708f3ea164 --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/README.md @@ -0,0 +1,79 @@ +# Smartengage Source + +This is the repository for the Smartengage configuration based source connector. +For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/smartengage). + +## 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-smartengage:build +``` + +#### Create credentials +**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/smartengage) +to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_smartengage/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 smartengage 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-smartengage:dev +``` + +You can also build the connector image via Gradle: +``` +./gradlew :airbyte-integrations:connectors:source-smartengage: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-smartengage:dev spec +docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-smartengage:dev check --config /secrets/config.json +docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-smartengage:dev discover --config /secrets/config.json +docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-smartengage: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-smartengage:unitTest +``` +To run acceptance and custom integration tests: +``` +./gradlew :airbyte-integrations:connectors:source-smartengage: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. diff --git a/airbyte-integrations/connectors/source-smartengage/__init__.py b/airbyte-integrations/connectors/source-smartengage/__init__.py new file mode 100644 index 0000000000000..1100c1c58cf51 --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/__init__.py @@ -0,0 +1,3 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# diff --git a/airbyte-integrations/connectors/source-smartengage/acceptance-test-config.yml b/airbyte-integrations/connectors/source-smartengage/acceptance-test-config.yml new file mode 100644 index 0000000000000..b9ea1506feece --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/acceptance-test-config.yml @@ -0,0 +1,38 @@ +# 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-smartengage:dev +acceptance_tests: + spec: + tests: + - spec_path: "source_smartengage/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: + bypass_reason: "This connector does not implement incremental sync" +# TODO uncomment this block this block if your connector implements incremental sync: +# tests: +# - config_path: "secrets/config.json" +# configured_catalog_path: "integration_tests/configured_catalog.json" +# future_state_path: "integration_tests/abnormal_state.json" + full_refresh: + tests: + - config_path: "secrets/config.json" + configured_catalog_path: "integration_tests/configured_catalog.json" diff --git a/airbyte-integrations/connectors/source-smartengage/acceptance-test-docker.sh b/airbyte-integrations/connectors/source-smartengage/acceptance-test-docker.sh new file mode 100644 index 0000000000000..c51577d10690c --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/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 + diff --git a/airbyte-integrations/connectors/source-smartengage/build.gradle b/airbyte-integrations/connectors/source-smartengage/build.gradle new file mode 100644 index 0000000000000..d8b668f76f858 --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/build.gradle @@ -0,0 +1,9 @@ +plugins { + id 'airbyte-python' + id 'airbyte-docker' + id 'airbyte-source-acceptance-test' +} + +airbytePython { + moduleDirectory 'source_smartengage' +} diff --git a/airbyte-integrations/connectors/source-smartengage/integration_tests/__init__.py b/airbyte-integrations/connectors/source-smartengage/integration_tests/__init__.py new file mode 100644 index 0000000000000..1100c1c58cf51 --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/integration_tests/__init__.py @@ -0,0 +1,3 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# diff --git a/airbyte-integrations/connectors/source-smartengage/integration_tests/acceptance.py b/airbyte-integrations/connectors/source-smartengage/integration_tests/acceptance.py new file mode 100644 index 0000000000000..1302b2f57e10e --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/integration_tests/acceptance.py @@ -0,0 +1,16 @@ +# +# 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.""" + # TODO: setup test dependencies if needed. otherwise remove the TODO comments + yield + # TODO: clean up test dependencies diff --git a/airbyte-integrations/connectors/source-smartengage/integration_tests/configured_catalog.json b/airbyte-integrations/connectors/source-smartengage/integration_tests/configured_catalog.json new file mode 100644 index 0000000000000..dbefcef4f61ca --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/integration_tests/configured_catalog.json @@ -0,0 +1,48 @@ +{ + "streams": [ + { + "stream": { + "name": "avatars", + "json_schema": {}, + "supported_sync_modes": [ + "full_refresh" + ] + }, + "sync_mode": "full_refresh", + "destination_sync_mode": "overwrite" + }, + { + "stream": { + "name": "tags", + "json_schema": {}, + "supported_sync_modes": [ + "full_refresh" + ] + }, + "sync_mode": "full_refresh", + "destination_sync_mode": "overwrite" + }, + { + "stream": { + "name": "custom_fields", + "json_schema": {}, + "supported_sync_modes": [ + "full_refresh" + ] + }, + "sync_mode": "full_refresh", + "destination_sync_mode": "overwrite" + }, + { + "stream": { + "name": "sequences", + "json_schema": {}, + "supported_sync_modes": [ + "full_refresh" + ] + }, + "sync_mode": "full_refresh", + "destination_sync_mode": "overwrite" + } + ] +} \ No newline at end of file diff --git a/airbyte-integrations/connectors/source-smartengage/integration_tests/invalid_config.json b/airbyte-integrations/connectors/source-smartengage/integration_tests/invalid_config.json new file mode 100644 index 0000000000000..3fb09b1d065cb --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/integration_tests/invalid_config.json @@ -0,0 +1,4 @@ +{ + "api_key": "invalid_key", + "avatar_id": "invalid_id" +} diff --git a/airbyte-integrations/connectors/source-smartengage/integration_tests/sample_config.json b/airbyte-integrations/connectors/source-smartengage/integration_tests/sample_config.json new file mode 100644 index 0000000000000..ddc74ed437bc9 --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/integration_tests/sample_config.json @@ -0,0 +1,4 @@ +{ + "api_key": "", + "avatar_id": "2166" +} diff --git a/airbyte-integrations/connectors/source-smartengage/integration_tests/sample_state.json b/airbyte-integrations/connectors/source-smartengage/integration_tests/sample_state.json new file mode 100644 index 0000000000000..3587e579822d0 --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/integration_tests/sample_state.json @@ -0,0 +1,5 @@ +{ + "todo-stream-name": { + "todo-field-name": "value" + } +} diff --git a/airbyte-integrations/connectors/source-smartengage/main.py b/airbyte-integrations/connectors/source-smartengage/main.py new file mode 100644 index 0000000000000..555c0bd4d9acb --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/main.py @@ -0,0 +1,13 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# + + +import sys + +from airbyte_cdk.entrypoint import launch +from source_smartengage import SourceSmartengage + +if __name__ == "__main__": + source = SourceSmartengage() + launch(source, sys.argv[1:]) diff --git a/airbyte-integrations/connectors/source-smartengage/requirements.txt b/airbyte-integrations/connectors/source-smartengage/requirements.txt new file mode 100644 index 0000000000000..0411042aa0911 --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/requirements.txt @@ -0,0 +1,2 @@ +-e ../../bases/source-acceptance-test +-e . diff --git a/airbyte-integrations/connectors/source-smartengage/setup.py b/airbyte-integrations/connectors/source-smartengage/setup.py new file mode 100644 index 0000000000000..35e2c31efbd9e --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/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_smartengage", + description="Source implementation for Smartengage.", + author="Airbyte", + author_email="contact@airbyte.io", + packages=find_packages(), + install_requires=MAIN_REQUIREMENTS, + package_data={"": ["*.json", "*.yaml", "schemas/*.json", "schemas/shared/*.json"]}, + extras_require={ + "tests": TEST_REQUIREMENTS, + }, +) diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/__init__.py b/airbyte-integrations/connectors/source-smartengage/source_smartengage/__init__.py new file mode 100644 index 0000000000000..7c5a3451ec084 --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/__init__.py @@ -0,0 +1,8 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# + + +from .source import SourceSmartengage + +__all__ = ["SourceSmartengage"] diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/avatars.json b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/avatars.json new file mode 100644 index 0000000000000..61b214c773293 --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/avatars.json @@ -0,0 +1,23 @@ +{ + "type": "object", + "properties": { + "brand_name": { + "type": ["string", "null"] + }, + "avatar_id": { + "type": "string" + }, + "brand_image": { + "type": ["string", "null"] + }, + "user_role": { + "type": ["string", "null"] + }, + "facebook_page_id": { + "type": ["string", "null"] + } + }, + "required": [ + "avatar_id" + ] +} \ No newline at end of file diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/custom_fields.json b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/custom_fields.json new file mode 100644 index 0000000000000..55a2a44040da7 --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/custom_fields.json @@ -0,0 +1,14 @@ +{ + "type": "object", + "properties": { + "custom_field_id": { + "type": "string" + }, + "custom_field_name": { + "type": ["string", "null"] + } + }, + "required": [ + "custom_field_id" + ] +} \ No newline at end of file diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/sequences.json b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/sequences.json new file mode 100644 index 0000000000000..ae70347a411b7 --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/sequences.json @@ -0,0 +1,14 @@ +{ + "type": "object", + "properties": { + "sequence_id": { + "type": "string" + }, + "sequence_name": { + "type": ["string", "null"] + } + }, + "required": [ + "sequence_id" + ] +} \ No newline at end of file diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/tags.json b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/tags.json new file mode 100644 index 0000000000000..ffa6053a4b560 --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/tags.json @@ -0,0 +1,14 @@ +{ + "type": "object", + "properties": { + "tag_id": { + "type": "string" + }, + "tag_name": { + "type": ["string", "null"] + } + }, + "required": [ + "tag_id" + ] +} \ No newline at end of file diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/smartengage.yaml b/airbyte-integrations/connectors/source-smartengage/source_smartengage/smartengage.yaml new file mode 100644 index 0000000000000..8e73798cf3620 --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/smartengage.yaml @@ -0,0 +1,67 @@ +version: "0.1.0" + +definitions: + selector: + extractor: + field_pointer: [] + requester: + url_base: "https://api.smartengage.com" + http_method: "GET" + # API Docs: https://smartengage.com/docs/#authentication + authenticator: + type: BearerAuthenticator + api_token: "{{ config['api_key'] }}" + request_options_provider: + request_parameters: + avatar_id: "{{ config['avatar_id'] }}" + retriever: + record_selector: + $ref: "*ref(definitions.selector)" + paginator: + type: NoPagination + requester: + $ref: "*ref(definitions.requester)" + base_stream: + retriever: + $ref: "*ref(definitions.retriever)" + # API Docs: https://smartengage.com/docs/#list-all-avatars + avatars_stream: + $ref: "*ref(definitions.base_stream)" + $options: + name: "avatars" + primary_key: "avatar_id" + path: "/avatars/list" + requester: + url_base: "*ref(definitions.requester.url_base)" + http_method: "*ref(definitions.requester.http_method)" + authenticator: "*ref(definitions.requester.authenticator)" + # API Docs: https://smartengage.com/docs/#list-all-tags + tags_stream: + $ref: "*ref(definitions.base_stream)" + $options: + name: "tags" + primary_key: "tag_id" + path: "/tags/list" + # API Docs: https://smartengage.com/docs/#list-all-custom-fields + custom_fields_stream: + $ref: "*ref(definitions.base_stream)" + $options: + name: "custom_fields" + primary_key: "custom_field_id" + path: "/customfields/list" + # API Docs: https://smartengage.com/docs/#list-all-sequences + sequences_stream: + $ref: "*ref(definitions.base_stream)" + $options: + name: "sequences" + primary_key: "sequence_id" + path: "/sequences/list" + +streams: + - "*ref(definitions.avatars_stream)" + - "*ref(definitions.tags_stream)" + - "*ref(definitions.custom_fields_stream)" + - "*ref(definitions.sequences_stream)" + +check: + stream_names: ["tags"] diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/source.py b/airbyte-integrations/connectors/source-smartengage/source_smartengage/source.py new file mode 100644 index 0000000000000..7ba8a096b2a45 --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/source.py @@ -0,0 +1,18 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# + +from airbyte_cdk.sources.declarative.yaml_declarative_source import YamlDeclarativeSource + +""" +This file provides the necessary constructs to interpret a provided declarative YAML configuration file into +source connector. + +WARNING: Do not modify this file. +""" + + +# Declarative Source +class SourceSmartengage(YamlDeclarativeSource): + def __init__(self): + super().__init__(**{"path_to_yaml": "smartengage.yaml"}) diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/spec.yaml b/airbyte-integrations/connectors/source-smartengage/source_smartengage/spec.yaml new file mode 100644 index 0000000000000..d53cbceab903f --- /dev/null +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/spec.yaml @@ -0,0 +1,18 @@ +documentationUrl: https://docs.airbyte.com/integrations/sources/smartengage +connectionSpecification: + $schema: http://json-schema.org/draft-07/schema# + title: SmartEngage Spec + type: object + required: + - api_key + - avatar_id + additionalProperties: true + properties: + api_key: + title: API Key + type: string + description: API Key + airbyte_secret: true + avatar_id: + type: string + description: Avatar ID. See here. diff --git a/docs/integrations/sources/smartengage.md b/docs/integrations/sources/smartengage.md new file mode 100644 index 0000000000000..68c496e96857f --- /dev/null +++ b/docs/integrations/sources/smartengage.md @@ -0,0 +1,33 @@ +# SmartEngage + +## Sync overview + +This source can sync data from the [SmartEngage API](https://smartengage.com/docs/#smartengage-api). At present this connector only supports full refresh syncs meaning that each time you use the connector it will sync all available records from scratch. Please use cautiously if you expect your API to have a lot of records. + +## This Source Supports the Following Streams + +* avatars +* tags +* custom_fields +* sequences + +### Features + +| Feature | Supported?\(Yes/No\) | Notes | +| :--- | :--- | :--- | +| Full Refresh Sync | Yes | | +| Incremental Sync | No | | + + +## Getting started + +### Requirements + +* SmartEngage API Key +* SmartEngage [Avatar ID](https://smartengage.com/docs/#avatars) + +## Changelog + +| Version | Date | Pull Request | Subject | +|:--------|:-----------| :----------- |:-----------------------------------------------------------| +| 0.1.0 | 2022-10-25 | [TODO](TODO) | Initial commit | \ No newline at end of file From a5e5e93a0bed190339d4d85aad3d873dbf29cafc Mon Sep 17 00:00:00 2001 From: Dainius Salkauskas Date: Mon, 31 Oct 2022 16:35:45 +0200 Subject: [PATCH 2/9] Added titles in spec.yaml --- .../connectors/source-smartengage/source_smartengage/spec.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/spec.yaml b/airbyte-integrations/connectors/source-smartengage/source_smartengage/spec.yaml index d53cbceab903f..6255b2fab202b 100644 --- a/airbyte-integrations/connectors/source-smartengage/source_smartengage/spec.yaml +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/spec.yaml @@ -14,5 +14,6 @@ connectionSpecification: description: API Key airbyte_secret: true avatar_id: + title: Avatar ID type: string description: Avatar ID. See here. From 6816b1cad87e1ef4d87ea150ef1f6ffd5abd54a5 Mon Sep 17 00:00:00 2001 From: Dainius Salkauskas Date: Mon, 31 Oct 2022 16:37:28 +0200 Subject: [PATCH 3/9] Formatting --- .../integration_tests/configured_catalog.json | 2 +- .../source-smartengage/source_smartengage/schemas/avatars.json | 2 +- .../source_smartengage/schemas/custom_fields.json | 2 +- .../source_smartengage/schemas/sequences.json | 2 +- .../source-smartengage/source_smartengage/schemas/tags.json | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/airbyte-integrations/connectors/source-smartengage/integration_tests/configured_catalog.json b/airbyte-integrations/connectors/source-smartengage/integration_tests/configured_catalog.json index dbefcef4f61ca..db8c721da4bbd 100644 --- a/airbyte-integrations/connectors/source-smartengage/integration_tests/configured_catalog.json +++ b/airbyte-integrations/connectors/source-smartengage/integration_tests/configured_catalog.json @@ -45,4 +45,4 @@ "destination_sync_mode": "overwrite" } ] -} \ No newline at end of file +} diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/avatars.json b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/avatars.json index 61b214c773293..ae085886daabe 100644 --- a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/avatars.json +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/avatars.json @@ -20,4 +20,4 @@ "required": [ "avatar_id" ] -} \ No newline at end of file +} diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/custom_fields.json b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/custom_fields.json index 55a2a44040da7..e2dfc3f41cbcc 100644 --- a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/custom_fields.json +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/custom_fields.json @@ -11,4 +11,4 @@ "required": [ "custom_field_id" ] -} \ No newline at end of file +} diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/sequences.json b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/sequences.json index ae70347a411b7..b5ef3731302fa 100644 --- a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/sequences.json +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/sequences.json @@ -11,4 +11,4 @@ "required": [ "sequence_id" ] -} \ No newline at end of file +} diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/tags.json b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/tags.json index ffa6053a4b560..65391503344ec 100644 --- a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/tags.json +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/tags.json @@ -11,4 +11,4 @@ "required": [ "tag_id" ] -} \ No newline at end of file +} From d79b06f0b6efd321af309795de672ee1c09156f6 Mon Sep 17 00:00:00 2001 From: Dainius Salkauskas Date: Mon, 31 Oct 2022 17:05:02 +0200 Subject: [PATCH 4/9] Updated PR information --- docs/integrations/sources/smartengage.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/integrations/sources/smartengage.md b/docs/integrations/sources/smartengage.md index 68c496e96857f..17b4066d47326 100644 --- a/docs/integrations/sources/smartengage.md +++ b/docs/integrations/sources/smartengage.md @@ -30,4 +30,4 @@ This source can sync data from the [SmartEngage API](https://smartengage.com/doc | Version | Date | Pull Request | Subject | |:--------|:-----------| :----------- |:-----------------------------------------------------------| -| 0.1.0 | 2022-10-25 | [TODO](TODO) | Initial commit | \ No newline at end of file +| 0.1.0 | 2022-10-25 | [18701](https://github.com/airbytehq/airbyte/pull/18701) | Initial commit | \ No newline at end of file From 73775be9c68d4609f335843f416288a726fc534d Mon Sep 17 00:00:00 2001 From: Dainius Salkauskas Date: Tue, 1 Nov 2022 23:04:06 +0200 Subject: [PATCH 5/9] Added stream slicing --- .../integration_tests/invalid_config.json | 3 +- .../integration_tests/sample_config.json | 3 +- .../source_smartengage/smartengage.yaml | 36 +++++++++++++++++-- .../source_smartengage/spec.yaml | 5 --- docs/integrations/sources/smartengage.md | 1 - 5 files changed, 35 insertions(+), 13 deletions(-) diff --git a/airbyte-integrations/connectors/source-smartengage/integration_tests/invalid_config.json b/airbyte-integrations/connectors/source-smartengage/integration_tests/invalid_config.json index 3fb09b1d065cb..efc25166ade22 100644 --- a/airbyte-integrations/connectors/source-smartengage/integration_tests/invalid_config.json +++ b/airbyte-integrations/connectors/source-smartengage/integration_tests/invalid_config.json @@ -1,4 +1,3 @@ { - "api_key": "invalid_key", - "avatar_id": "invalid_id" + "api_key": "invalid_key" } diff --git a/airbyte-integrations/connectors/source-smartengage/integration_tests/sample_config.json b/airbyte-integrations/connectors/source-smartengage/integration_tests/sample_config.json index ddc74ed437bc9..73112f5a25a73 100644 --- a/airbyte-integrations/connectors/source-smartengage/integration_tests/sample_config.json +++ b/airbyte-integrations/connectors/source-smartengage/integration_tests/sample_config.json @@ -1,4 +1,3 @@ { - "api_key": "", - "avatar_id": "2166" + "api_key": "" } diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/smartengage.yaml b/airbyte-integrations/connectors/source-smartengage/source_smartengage/smartengage.yaml index 8e73798cf3620..bf8c43fb30857 100644 --- a/airbyte-integrations/connectors/source-smartengage/source_smartengage/smartengage.yaml +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/smartengage.yaml @@ -11,9 +11,6 @@ definitions: authenticator: type: BearerAuthenticator api_token: "{{ config['api_key'] }}" - request_options_provider: - request_parameters: - avatar_id: "{{ config['avatar_id'] }}" retriever: record_selector: $ref: "*ref(definitions.selector)" @@ -35,6 +32,12 @@ definitions: url_base: "*ref(definitions.requester.url_base)" http_method: "*ref(definitions.requester.http_method)" authenticator: "*ref(definitions.requester.authenticator)" + avatars_stream_slicer: + type: SubstreamSlicer + parent_stream_configs: + - stream: "*ref(definitions.avatars_stream)" + parent_key: "avatar_id" + stream_slice_field: "avatar_id" # API Docs: https://smartengage.com/docs/#list-all-tags tags_stream: $ref: "*ref(definitions.base_stream)" @@ -42,6 +45,15 @@ definitions: name: "tags" primary_key: "tag_id" path: "/tags/list" + retriever: + $ref: "*ref(definitions.retriever)" + requester: + $ref: "*ref(definitions.requester)" + request_options_provider: + request_parameters: + avatar_id: "{{ stream_slice.avatar_id }}" + stream_slicer: + $ref: "*ref(definitions.avatars_stream_slicer)" # API Docs: https://smartengage.com/docs/#list-all-custom-fields custom_fields_stream: $ref: "*ref(definitions.base_stream)" @@ -49,6 +61,15 @@ definitions: name: "custom_fields" primary_key: "custom_field_id" path: "/customfields/list" + retriever: + $ref: "*ref(definitions.retriever)" + requester: + $ref: "*ref(definitions.requester)" + request_options_provider: + request_parameters: + avatar_id: "{{ stream_slice.avatar_id }}" + stream_slicer: + $ref: "*ref(definitions.avatars_stream_slicer)" # API Docs: https://smartengage.com/docs/#list-all-sequences sequences_stream: $ref: "*ref(definitions.base_stream)" @@ -56,6 +77,15 @@ definitions: name: "sequences" primary_key: "sequence_id" path: "/sequences/list" + retriever: + $ref: "*ref(definitions.retriever)" + requester: + $ref: "*ref(definitions.requester)" + request_options_provider: + request_parameters: + avatar_id: "{{ stream_slice.avatar_id }}" + stream_slicer: + $ref: "*ref(definitions.avatars_stream_slicer)" streams: - "*ref(definitions.avatars_stream)" diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/spec.yaml b/airbyte-integrations/connectors/source-smartengage/source_smartengage/spec.yaml index 6255b2fab202b..575720a20349e 100644 --- a/airbyte-integrations/connectors/source-smartengage/source_smartengage/spec.yaml +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/spec.yaml @@ -5,7 +5,6 @@ connectionSpecification: type: object required: - api_key - - avatar_id additionalProperties: true properties: api_key: @@ -13,7 +12,3 @@ connectionSpecification: type: string description: API Key airbyte_secret: true - avatar_id: - title: Avatar ID - type: string - description: Avatar ID. See here. diff --git a/docs/integrations/sources/smartengage.md b/docs/integrations/sources/smartengage.md index 17b4066d47326..e00f4e61abc80 100644 --- a/docs/integrations/sources/smartengage.md +++ b/docs/integrations/sources/smartengage.md @@ -24,7 +24,6 @@ This source can sync data from the [SmartEngage API](https://smartengage.com/doc ### Requirements * SmartEngage API Key -* SmartEngage [Avatar ID](https://smartengage.com/docs/#avatars) ## Changelog From beec8a5853612e8cfd3729897fd4d4fa6f7dca34 Mon Sep 17 00:00:00 2001 From: Dainius Salkauskas Date: Tue, 1 Nov 2022 23:11:20 +0200 Subject: [PATCH 6/9] Removed unnecessary requester definition --- .../source-smartengage/source_smartengage/smartengage.yaml | 4 ---- 1 file changed, 4 deletions(-) diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/smartengage.yaml b/airbyte-integrations/connectors/source-smartengage/source_smartengage/smartengage.yaml index bf8c43fb30857..03f4f6332436b 100644 --- a/airbyte-integrations/connectors/source-smartengage/source_smartengage/smartengage.yaml +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/smartengage.yaml @@ -28,10 +28,6 @@ definitions: name: "avatars" primary_key: "avatar_id" path: "/avatars/list" - requester: - url_base: "*ref(definitions.requester.url_base)" - http_method: "*ref(definitions.requester.http_method)" - authenticator: "*ref(definitions.requester.authenticator)" avatars_stream_slicer: type: SubstreamSlicer parent_stream_configs: From dc38969e1c441512b8a578742419b069c99d57a1 Mon Sep 17 00:00:00 2001 From: marcosmarxm Date: Sun, 13 Nov 2022 18:55:14 -0300 Subject: [PATCH 7/9] add smartengage to source def --- .../init/src/main/resources/seed/source_definitions.yaml | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/airbyte-config/init/src/main/resources/seed/source_definitions.yaml b/airbyte-config/init/src/main/resources/seed/source_definitions.yaml index 81258e724d81c..ebf73337f5b00 100644 --- a/airbyte-config/init/src/main/resources/seed/source_definitions.yaml +++ b/airbyte-config/init/src/main/resources/seed/source_definitions.yaml @@ -1345,6 +1345,13 @@ documentationUrl: https://docs.airbyte.com/integrations/sources/smaily sourceType: api releaseStage: alpha +- name: SmartEngage + sourceDefinitionId: 21cc4a17-a011-4485-8a3e-e2341a91ab9f + dockerRepository: airbyte/source-smartengage + dockerImageTag: 0.1.0 + documentationUrl: https://docs.airbyte.com/integrations/sources/smartengage + sourceType: api + releaseStage: alpha - name: Smartsheets sourceDefinitionId: 374ebc65-6636-4ea0-925c-7d35999a8ffc dockerRepository: airbyte/source-smartsheets From 4338e1b307c5ba90081f3b7d524b98dd2818f4ca Mon Sep 17 00:00:00 2001 From: marcosmarxm Date: Sun, 13 Nov 2022 19:05:05 -0300 Subject: [PATCH 8/9] run format --- .../integration_tests/configured_catalog.json | 16 ++++------------ .../source_smartengage/schemas/avatars.json | 4 +--- .../schemas/custom_fields.json | 4 +--- .../source_smartengage/schemas/sequences.json | 4 +--- .../source_smartengage/schemas/tags.json | 4 +--- 5 files changed, 8 insertions(+), 24 deletions(-) diff --git a/airbyte-integrations/connectors/source-smartengage/integration_tests/configured_catalog.json b/airbyte-integrations/connectors/source-smartengage/integration_tests/configured_catalog.json index db8c721da4bbd..05b05c2b9689c 100644 --- a/airbyte-integrations/connectors/source-smartengage/integration_tests/configured_catalog.json +++ b/airbyte-integrations/connectors/source-smartengage/integration_tests/configured_catalog.json @@ -4,9 +4,7 @@ "stream": { "name": "avatars", "json_schema": {}, - "supported_sync_modes": [ - "full_refresh" - ] + "supported_sync_modes": ["full_refresh"] }, "sync_mode": "full_refresh", "destination_sync_mode": "overwrite" @@ -15,9 +13,7 @@ "stream": { "name": "tags", "json_schema": {}, - "supported_sync_modes": [ - "full_refresh" - ] + "supported_sync_modes": ["full_refresh"] }, "sync_mode": "full_refresh", "destination_sync_mode": "overwrite" @@ -26,9 +22,7 @@ "stream": { "name": "custom_fields", "json_schema": {}, - "supported_sync_modes": [ - "full_refresh" - ] + "supported_sync_modes": ["full_refresh"] }, "sync_mode": "full_refresh", "destination_sync_mode": "overwrite" @@ -37,9 +31,7 @@ "stream": { "name": "sequences", "json_schema": {}, - "supported_sync_modes": [ - "full_refresh" - ] + "supported_sync_modes": ["full_refresh"] }, "sync_mode": "full_refresh", "destination_sync_mode": "overwrite" diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/avatars.json b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/avatars.json index ae085886daabe..f2b5f2292f4d4 100644 --- a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/avatars.json +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/avatars.json @@ -17,7 +17,5 @@ "type": ["string", "null"] } }, - "required": [ - "avatar_id" - ] + "required": ["avatar_id"] } diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/custom_fields.json b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/custom_fields.json index e2dfc3f41cbcc..1da4bf627c04d 100644 --- a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/custom_fields.json +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/custom_fields.json @@ -8,7 +8,5 @@ "type": ["string", "null"] } }, - "required": [ - "custom_field_id" - ] + "required": ["custom_field_id"] } diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/sequences.json b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/sequences.json index b5ef3731302fa..1eb621766dd9b 100644 --- a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/sequences.json +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/sequences.json @@ -8,7 +8,5 @@ "type": ["string", "null"] } }, - "required": [ - "sequence_id" - ] + "required": ["sequence_id"] } diff --git a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/tags.json b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/tags.json index 65391503344ec..8cf7a13b4c72b 100644 --- a/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/tags.json +++ b/airbyte-integrations/connectors/source-smartengage/source_smartengage/schemas/tags.json @@ -8,7 +8,5 @@ "type": ["string", "null"] } }, - "required": [ - "tag_id" - ] + "required": ["tag_id"] } From f89ad03fee85437939e56e1669166e660ef0c196 Mon Sep 17 00:00:00 2001 From: Octavia Squidington III Date: Sun, 13 Nov 2022 22:16:37 +0000 Subject: [PATCH 9/9] auto-bump connector version --- .../src/main/resources/seed/source_specs.yaml | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/airbyte-config/init/src/main/resources/seed/source_specs.yaml b/airbyte-config/init/src/main/resources/seed/source_specs.yaml index f4e0c194aa893..ff281c56e9bc4 100644 --- a/airbyte-config/init/src/main/resources/seed/source_specs.yaml +++ b/airbyte-config/init/src/main/resources/seed/source_specs.yaml @@ -12683,6 +12683,25 @@ supportsNormalization: false supportsDBT: false supported_destination_sync_modes: [] +- dockerImage: "airbyte/source-smartengage:0.1.0" + spec: + documentationUrl: "https://docs.airbyte.com/integrations/sources/smartengage" + connectionSpecification: + $schema: "http://json-schema.org/draft-07/schema#" + title: "SmartEngage Spec" + type: "object" + required: + - "api_key" + additionalProperties: true + properties: + api_key: + title: "API Key" + type: "string" + description: "API Key" + airbyte_secret: true + supportsNormalization: false + supportsDBT: false + supported_destination_sync_modes: [] - dockerImage: "airbyte/source-smartsheets:0.1.12" spec: documentationUrl: "https://docs.airbyte.com/integrations/sources/smartsheets"