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 57a863430fe0..8005d32f48f3 100644 --- a/airbyte-config/init/src/main/resources/seed/source_definitions.yaml +++ b/airbyte-config/init/src/main/resources/seed/source_definitions.yaml @@ -314,6 +314,13 @@ documentationUrl: https://docs.airbyte.com/integrations/sources/datadog sourceType: api releaseStage: alpha +- name: Datascope + sourceDefinitionId: 8e1ae2d2-4790-44d3-9d83-75b3fc3940ff + dockerRepository: airbyte/source-datascope + dockerImageTag: 0.1.0 + documentationUrl: https://docs.airbyte.com/integrations/sources/datascope + sourceType: api + releaseStage: alpha - name: Delighted sourceDefinitionId: cc88c43f-6f53-4e8a-8c4d-b284baaf9635 dockerRepository: airbyte/source-delighted 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 9c8b900d1487..d3cec32bc48a 100644 --- a/airbyte-config/init/src/main/resources/seed/source_specs.yaml +++ b/airbyte-config/init/src/main/resources/seed/source_specs.yaml @@ -2697,6 +2697,33 @@ supportsNormalization: false supportsDBT: false supported_destination_sync_modes: [] +- dockerImage: "airbyte/source-datascope:0.1.0" + spec: + documentationUrl: "https://docs.airbyte.com/integrations/sources/datascope" + connectionSpecification: + $schema: "http://json-schema.org/draft-07/schema#" + title: "Datascope Spec" + type: "object" + required: + - "api_key" + - "start_date" + additionalProperties: true + properties: + start_date: + title: "Start Date" + type: "string" + description: "Start date for the data to be replicated" + examples: + - "dd/mm/YYYY HH:MM" + pattern: "^[0-9]{2}/[0-9]{2}/[0-9]{4} [0-9]{2}:[0-9]{2}$" + api_key: + title: "Authorization" + type: "string" + description: "API Key" + airbyte_secret: true + supportsNormalization: false + supportsDBT: false + supported_destination_sync_modes: [] - dockerImage: "airbyte/source-delighted:0.1.4" spec: documentationUrl: "https://docsurl.com" diff --git a/airbyte-integrations/connectors/source-datascope/.dockerignore b/airbyte-integrations/connectors/source-datascope/.dockerignore new file mode 100644 index 000000000000..a4655d572bd7 --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/.dockerignore @@ -0,0 +1,6 @@ +* +!Dockerfile +!main.py +!source_datascope +!setup.py +!secrets diff --git a/airbyte-integrations/connectors/source-datascope/BOOTSTRAP.md b/airbyte-integrations/connectors/source-datascope/BOOTSTRAP.md new file mode 100644 index 000000000000..68a89e9425a7 --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/BOOTSTRAP.md @@ -0,0 +1,10 @@ +# DataScope +DataScope is a mobile solution that helps you collect data offline, manage field teams, and share business insights. Use the intuitive Form Builder to create your forms, and then analyze the data you've collected via powerful and personalized dashboards. + +The streams implemented allows you to pull data from the following DataScope objects: +- Locations +- Answers +- Lists +- Notifications + +For more information about the DataScope API, see the [DataScope API documentation](https://dscope.github.io/docs/). \ No newline at end of file diff --git a/airbyte-integrations/connectors/source-datascope/Dockerfile b/airbyte-integrations/connectors/source-datascope/Dockerfile new file mode 100644 index 000000000000..49a9f0b7178f --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/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_datascope ./source_datascope + +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-datascope diff --git a/airbyte-integrations/connectors/source-datascope/README.md b/airbyte-integrations/connectors/source-datascope/README.md new file mode 100644 index 000000000000..425473f9f645 --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/README.md @@ -0,0 +1,79 @@ +# Datascope Source + +This is the repository for the Datascope configuration based source connector. +For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/datascope). + +## 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-datascope:build +``` + +#### Create credentials +**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/datascope) +to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_datascope/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 datascope 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-datascope:dev +``` + +You can also build the connector image via Gradle: +``` +./gradlew :airbyte-integrations:connectors:source-datascope: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-datascope:dev spec +docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-datascope:dev check --config /secrets/config.json +docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-datascope:dev discover --config /secrets/config.json +docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-datascope: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-datascope:unitTest +``` +To run acceptance and custom integration tests: +``` +./gradlew :airbyte-integrations:connectors:source-datascope: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-datascope/__init__.py b/airbyte-integrations/connectors/source-datascope/__init__.py new file mode 100644 index 000000000000..1100c1c58cf5 --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/__init__.py @@ -0,0 +1,3 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# diff --git a/airbyte-integrations/connectors/source-datascope/acceptance-test-config.yml b/airbyte-integrations/connectors/source-datascope/acceptance-test-config.yml new file mode 100644 index 000000000000..5879b9065fcb --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/acceptance-test-config.yml @@ -0,0 +1,24 @@ +# 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-datascope:dev +tests: + spec: + - spec_path: "source_datascope/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: ["notifications", "lists"] + incremental: + - config_path: "secrets/config.json" + configured_catalog_path: "integration_tests/configured_catalog.json" + future_state_path: "integration_tests/abnormal_state.json" + full_refresh: + - config_path: "secrets/config.json" + configured_catalog_path: "integration_tests/configured_catalog.json" diff --git a/airbyte-integrations/connectors/source-datascope/acceptance-test-docker.sh b/airbyte-integrations/connectors/source-datascope/acceptance-test-docker.sh new file mode 100755 index 000000000000..c51577d10690 --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/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-datascope/build.gradle b/airbyte-integrations/connectors/source-datascope/build.gradle new file mode 100644 index 000000000000..effe7c6fe23e --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/build.gradle @@ -0,0 +1,9 @@ +plugins { + id 'airbyte-python' + id 'airbyte-docker' + id 'airbyte-source-acceptance-test' +} + +airbytePython { + moduleDirectory 'source_datascope' +} diff --git a/airbyte-integrations/connectors/source-datascope/integration_tests/__init__.py b/airbyte-integrations/connectors/source-datascope/integration_tests/__init__.py new file mode 100644 index 000000000000..1100c1c58cf5 --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/integration_tests/__init__.py @@ -0,0 +1,3 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# diff --git a/airbyte-integrations/connectors/source-datascope/integration_tests/abnormal_state.json b/airbyte-integrations/connectors/source-datascope/integration_tests/abnormal_state.json new file mode 100644 index 000000000000..62350b41e2cd --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/integration_tests/abnormal_state.json @@ -0,0 +1,5 @@ +{ + "answers": { + "created_at": "01/01/9999 00:00" + } +} diff --git a/airbyte-integrations/connectors/source-datascope/integration_tests/acceptance.py b/airbyte-integrations/connectors/source-datascope/integration_tests/acceptance.py new file mode 100644 index 000000000000..950b53b59d41 --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/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 diff --git a/airbyte-integrations/connectors/source-datascope/integration_tests/configured_catalog.json b/airbyte-integrations/connectors/source-datascope/integration_tests/configured_catalog.json new file mode 100644 index 000000000000..a0f14d7670a7 --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/integration_tests/configured_catalog.json @@ -0,0 +1,43 @@ +{ + "streams": [ + { + "stream": { + "name": "locations", + "json_schema": {}, + "source_defined_cursor": true, + "source_defined_primary_key": [["id"]], + "supported_sync_modes": ["full_refresh"] + }, + "sync_mode": "incremental", + "destination_sync_mode": "append" + }, + { + "stream": { + "name": "answers", + "json_schema": {}, + "supported_sync_modes": [ + "full_refresh", + "incremental"]}, + "sync_mode": "incremental", + "destination_sync_mode": "overwrite" + }, + { + "stream": { + "name": "lists", + "json_schema": {}, + "supported_sync_modes": ["full_refresh"] + }, + "sync_mode": "full_refresh", + "destination_sync_mode": "overwrite" + }, + { + "stream": { + "name": "notifications", + "json_schema": {}, + "supported_sync_modes": ["full_refresh"] + }, + "sync_mode": "full_refresh", + "destination_sync_mode": "overwrite" + } + ] +} diff --git a/airbyte-integrations/connectors/source-datascope/integration_tests/invalid_config.json b/airbyte-integrations/connectors/source-datascope/integration_tests/invalid_config.json new file mode 100644 index 000000000000..4f40c8d766e6 --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/integration_tests/invalid_config.json @@ -0,0 +1,4 @@ +{ + "api_key": "abctestconfig", + "start_date": "2019-01-01T00:00:00Z" +} diff --git a/airbyte-integrations/connectors/source-datascope/integration_tests/sample_config.json b/airbyte-integrations/connectors/source-datascope/integration_tests/sample_config.json new file mode 100644 index 000000000000..5b5c2eeef90a --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/integration_tests/sample_config.json @@ -0,0 +1,4 @@ +{ + "api_key": "test_key", + "start_date": "2022-10-30 00:00" +} diff --git a/airbyte-integrations/connectors/source-datascope/integration_tests/sample_state.json b/airbyte-integrations/connectors/source-datascope/integration_tests/sample_state.json new file mode 100644 index 000000000000..a2a2b17dacad --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/integration_tests/sample_state.json @@ -0,0 +1,5 @@ +{ + "answers": { + "created_at": "01/01/2000 00:00" + } +} diff --git a/airbyte-integrations/connectors/source-datascope/main.py b/airbyte-integrations/connectors/source-datascope/main.py new file mode 100644 index 000000000000..8d7ff4df304f --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/main.py @@ -0,0 +1,13 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# + + +import sys + +from airbyte_cdk.entrypoint import launch +from source_datascope import SourceDatascope + +if __name__ == "__main__": + source = SourceDatascope() + launch(source, sys.argv[1:]) diff --git a/airbyte-integrations/connectors/source-datascope/requirements.txt b/airbyte-integrations/connectors/source-datascope/requirements.txt new file mode 100644 index 000000000000..0411042aa091 --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/requirements.txt @@ -0,0 +1,2 @@ +-e ../../bases/source-acceptance-test +-e . diff --git a/airbyte-integrations/connectors/source-datascope/setup.py b/airbyte-integrations/connectors/source-datascope/setup.py new file mode 100644 index 000000000000..bf5f11481f35 --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/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_datascope", + description="Source implementation for Datascope.", + 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-datascope/source_datascope/__init__.py b/airbyte-integrations/connectors/source-datascope/source_datascope/__init__.py new file mode 100644 index 000000000000..1b6e441cb5d4 --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/source_datascope/__init__.py @@ -0,0 +1,8 @@ +# +# Copyright (c) 2022 Airbyte, Inc., all rights reserved. +# + + +from .source import SourceDatascope + +__all__ = ["SourceDatascope"] diff --git a/airbyte-integrations/connectors/source-datascope/source_datascope/datascope.yaml b/airbyte-integrations/connectors/source-datascope/source_datascope/datascope.yaml new file mode 100644 index 000000000000..34b40137e2a1 --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/source_datascope/datascope.yaml @@ -0,0 +1,112 @@ +version: "0.1.0" + +definitions: + selector: + extractor: + field_pointer: [] + requester: + url_base: "https://www.mydatascope.com/api/external/" + http_method: "GET" + authenticator: + type: ApiKeyAuthenticator + header: "Authorization" + api_token: "{{ config['api_key'] }}" + stream_slicer: + type: "DatetimeStreamSlicer" + start_datetime: + datetime: "{{ config['start_date'] }}" + datetime_format: "%d/%m/%Y %H:%M" + end_datetime: + datetime: "{{ now_utc().strftime('%d/%m/%Y %H:%M') }}" + datetime_format: "%d/%m/%Y %H:%M" + step: "1d" + datetime_format: "%d/%m/%Y %H:%M" + cursor_field: "{{ options['stream_cursor_field'] }}" + start_time_option: + field_name: "start" + inject_into: "request_parameter" + end_time_option: + field_name: "end" + inject_into: "request_parameter" + + retriever: + record_selector: + $ref: "*ref(definitions.selector)" + request_options_provider: + request_parameters: + start: "{{stream_slice['start_time'] or 'latest'}}" + paginator: + type: DefaultPaginator + url_base: "*ref(definitions.requester.url_base)" + page_size_option: + inject_into: "request_parameter" + field_name: "limit" + pagination_strategy: + type: "OffsetIncrement" + page_size: 200 + page_token_option: + inject_into: "request_parameter" + field_name: "offset" + requester: + $ref: "*ref(definitions.requester)" + stream_slicer: + $ref: "*ref(definitions.stream_slicer)" + + retriever_non_incremental: + record_selector: + $ref: "*ref(definitions.selector)" + paginator: + type: DefaultPaginator + url_base: "*ref(definitions.requester.url_base)" + page_size_option: + inject_into: "request_parameter" + field_name: "limit" + pagination_strategy: + type: "OffsetIncrement" + page_size: 200 + page_token_option: + inject_into: "request_parameter" + field_name: "offset" + requester: + $ref: "*ref(definitions.requester)" + base_stream: + retriever: + $ref: "*ref(definitions.retriever)" + location_stream: + retriever: + $ref: "*ref(definitions.retriever_non_incremental)" + $options: + name: "locations" + primary_key: "id" + path: "/locations" + answers_stream: + $ref: "*ref(definitions.base_stream)" + $options: + name: "answers" + primary_key: "form_answer_id" + path: "/v2/answers" + stream_cursor_field: "created_at" + lists_stream: + retriever: + $ref: "*ref(definitions.retriever_non_incremental)" + $options: + name: "lists" + primary_key: "id" + path: "/metadata_objects" + notifications_stream: + $ref: "*ref(definitions.base_stream)" + $options: + name: "notifications" + primary_key: "id" + path: "/notifications" + stream_cursor_field: "created_at" +streams: + - "*ref(definitions.location_stream)" + - "*ref(definitions.answers_stream)" + - "*ref(definitions.lists_stream)" + - "*ref(definitions.notifications_stream)" + + +check: + stream_names: + - "locations" \ No newline at end of file diff --git a/airbyte-integrations/connectors/source-datascope/source_datascope/schemas/answers.json b/airbyte-integrations/connectors/source-datascope/source_datascope/schemas/answers.json new file mode 100644 index 000000000000..99bd91cded8e --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/source_datascope/schemas/answers.json @@ -0,0 +1,45 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "form_name": { + "type": "string" + }, + "form_state": { + "type": ["string", "null"] + }, + "user_name": { + "type": "string" + }, + "user_identifier": { + "type": "string" + }, + "code": { + "type": "string" + }, + "form_id": { + "type": "integer" + }, + "created_at": { + "type": "string" + }, + "form_answer_id": { + "type": "integer" + }, + "latitude": { + "type": ["number", "null"] + }, + "longitude": { + "type": ["number", "null"] + }, + "[question_name1]": { + "type": "string" + }, + "[question_name2]": { + "type": "string" + }, + "[question_name3]": { + "type": "string" + } + } +} \ No newline at end of file diff --git a/airbyte-integrations/connectors/source-datascope/source_datascope/schemas/lists.json b/airbyte-integrations/connectors/source-datascope/source_datascope/schemas/lists.json new file mode 100644 index 000000000000..db2d9bced225 --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/source_datascope/schemas/lists.json @@ -0,0 +1,36 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string" + }, + "attribute1": { + "type": "string" + }, + "attribute2": { + "type": "string" + }, + "list_id": { + "type": "integer" + }, + "account_id": { + "type": "integer" + }, + "code": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + } + } +} \ No newline at end of file diff --git a/airbyte-integrations/connectors/source-datascope/source_datascope/schemas/locations.json b/airbyte-integrations/connectors/source-datascope/source_datascope/schemas/locations.json new file mode 100644 index 000000000000..2ad9d4059081 --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/source_datascope/schemas/locations.json @@ -0,0 +1,45 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "description": { + "type": ["string", "null"] + }, + "code": { + "type": ["string", "null"] + }, + "address": { + "type": ["string", "null"] + }, + "city": { + "type": ["string", "null"] + }, + "country": { + "type": ["string", "null"] + }, + "latitude": { + "type": ["number", "null"] + }, + "longitude": { + "type": ["number", "null"] + }, + "region": { + "type": ["string", "null"] + }, + "phone": { + "type": ["string", "null"] + }, + "company_code": { + "type": ["string", "null"] + }, + "company_name": { + "type": ["string", "null"] + } + } +} \ No newline at end of file diff --git a/airbyte-integrations/connectors/source-datascope/source_datascope/schemas/notifications.json b/airbyte-integrations/connectors/source-datascope/source_datascope/schemas/notifications.json new file mode 100644 index 000000000000..083dd48a8dce --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/source_datascope/schemas/notifications.json @@ -0,0 +1,27 @@ +{ + "$schema": "http://json-schema.org/draft-04/schema#", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "type": { + "type": "string" + }, + "url": { + "type": "string" + }, + "form_name": { + "type": "string" + }, + "form_code": { + "type": "string" + }, + "user": { + "type": "string" + }, + "created_at": { + "type": "string" + } + } +} \ No newline at end of file diff --git a/airbyte-integrations/connectors/source-datascope/source_datascope/source.py b/airbyte-integrations/connectors/source-datascope/source_datascope/source.py new file mode 100644 index 000000000000..44a433d09553 --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/source_datascope/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 SourceDatascope(YamlDeclarativeSource): + def __init__(self): + super().__init__(**{"path_to_yaml": "datascope.yaml"}) diff --git a/airbyte-integrations/connectors/source-datascope/source_datascope/spec.yaml b/airbyte-integrations/connectors/source-datascope/source_datascope/spec.yaml new file mode 100644 index 000000000000..18358d23ce35 --- /dev/null +++ b/airbyte-integrations/connectors/source-datascope/source_datascope/spec.yaml @@ -0,0 +1,22 @@ +documentationUrl: "https://docs.airbyte.com/integrations/sources/datascope" +connectionSpecification: + $schema: "http://json-schema.org/draft-07/schema#" + title: Datascope Spec + type: object + required: + - api_key + - start_date + additionalProperties: true + properties: + start_date: + title: Start Date + type: string + description: Start date for the data to be replicated + examples: + - "dd/mm/YYYY HH:MM" + pattern: "^[0-9]{2}/[0-9]{2}/[0-9]{4} [0-9]{2}:[0-9]{2}$" + api_key: + title: Authorization + type: string + description: API Key + airbyte_secret: true diff --git a/docs/integrations/sources/datascope.md b/docs/integrations/sources/datascope.md new file mode 100644 index 000000000000..6daa5b66c0e3 --- /dev/null +++ b/docs/integrations/sources/datascope.md @@ -0,0 +1,64 @@ +# DataScope + +This page contains the setup guide and reference information for the [DataScope](https://dscope.github.io/docs/) source connector. + +## Prerequisites + +A DataScope account with access to the API. You can create a free account [here](https://www.mydatascope.com/webhooks). + + +## Setup guide + +### Step 1: Set up DataScope connection + +- Create a DataScope account +- Create an API key and copy it to Airbyte + +## Step 2: Set up the DataScope connector in Airbyte + +### For Airbyte Cloud: + +1. [Log into your Airbyte Cloud](https://cloud.airbyte.io/workspaces) account. +2. In the left navigation bar, click **Sources**. In the top-right corner, click **+new source**. +3. On the Set up the source page, enter the name for the DataScope connector and select **DataScope** from the Source type dropdown. +4. Enter your `api_key`. +5. Enter the params configuration if needed. Supported params are: sort, alt, prettyPrint (Optional) +6. Click **Set up source**. + +### For Airbyte OSS: + +1. Navigate to the Airbyte Open Source dashboard. +2. Set the name for your source. +3. Enter your `api_key` which will be flagged with Authorization header. +6. Click **Set up source**. + +## Supported sync modes + +The DataScope source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes): + +| Feature | Supported? | +| :---------------------------- | :--------- | +| Full Refresh Sync | Yes | +| Incremental Sync | No | +| Replicate Incremental Deletes | No | +| SSL connection | Yes | +| Namespaces | No | + +## Supported Streams + +- Locations +- answers + +Implemented but not added streams: +- Lists +- Notifications + +## API method example + +GET https://www.mydatascope.com/api/external/locations + +## Changelog + +| Version | Date | Pull Request | Subject | +| :------ |:-----------|:----------------------------------------------------------| :------------- | +| 0.1.0 | 2022-10-31 | [#18725](https://github.com/airbytehq/airbyte/pull/18725) | Initial commit | \ No newline at end of file