Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🎉 New Source: Coin API #18302

Merged
merged 17 commits into from
Oct 27, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -204,6 +204,13 @@
icon: cockroachdb.svg
sourceType: database
releaseStage: alpha
- name: Coin API
sourceDefinitionId: 919984ef-53a2-479b-8ffe-9c1ddb9fc3f3
dockerRepository: airbyte/source-coin-api
dockerImageTag: 0.1.0
documentationUrl: https://docs.airbyte.com/integrations/sources/coin-api
sourceType: api
releaseStage: alpha
- name: Commercetools
sourceDefinitionId: 008b2e26-11a3-11ec-82a8-0242ac130003
dockerRepository: airbyte/source-commercetools
63 changes: 63 additions & 0 deletions airbyte-config/init/src/main/resources/seed/source_specs.yaml
Original file line number Diff line number Diff line change
@@ -2172,6 +2172,69 @@
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
- dockerImage: "airbyte/source-coin-api:0.1.0"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/sources/coin-api"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "Coin API Spec"
type: "object"
required:
- "api_key"
- "environment"
- "symbol_id"
- "period"
- "start_date"
properties:
api_key:
type: "string"
description: "API Key"
airbyte_secret: true
order: 0
environment:
type: "string"
description: "The environment to use. Either sandbox or production.\n"
enum:
- "sandbox"
- "production"
default: "sandbox"
order: 1
symbol_id:
type: "string"
description: "The symbol ID to use. See the documentation for a list.\n\
https://docs.coinapi.io/#list-all-symbols-get\n"
order: 2
period:
type: "string"
description: "The period to use. See the documentation for a list. https://docs.coinapi.io/#list-all-periods-get"
examples:
- "5SEC"
- "2MTH"
start_date:
type: "string"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$"
description: "The start date in ISO 8601 format."
examples:
- "2019-01-01T00:00:00"
end_date:
type: "string"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}$"
description: "The end date in ISO 8601 format. If not supplied, data will\
\ be returned\nfrom the start date to the current time, or when the count\
\ of result\nelements reaches its limit.\n"
examples:
- "2019-01-01T00:00:00"
limit:
type: "integer"
description: "The maximum number of elements to return. If not supplied,\
\ the default\nis 100. For numbers larger than 100, each 100 items is\
\ counted as one\nrequest for pricing purposes. Maximum value is 100000.\n"
minimum: 1
maximum: 100000
default: 100
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
- dockerImage: "airbyte/source-commercetools:0.1.0"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/sources/commercetools"
6 changes: 6 additions & 0 deletions airbyte-integrations/connectors/source-coin-api/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
*
!Dockerfile
!main.py
!source_coin_api
!setup.py
!secrets
38 changes: 38 additions & 0 deletions airbyte-integrations/connectors/source-coin-api/Dockerfile
Original file line number Diff line number Diff line change
@@ -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_coin_api ./source_coin_api

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-coin-api
79 changes: 79 additions & 0 deletions airbyte-integrations/connectors/source-coin-api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Coin Api Source

This is the repository for the Coin Api configuration based source connector.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/coin-api).

## 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-coin-api:build
```

#### Create credentials
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/coin-api)
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_coin_api/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 coin-api 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-coin-api:dev
```

You can also build the connector image via Gradle:
```
./gradlew :airbyte-integrations:connectors:source-coin-api: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-coin-api:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-coin-api:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-coin-api:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-coin-api: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-coin-api:unitTest
```
To run acceptance and custom integration tests:
```
./gradlew :airbyte-integrations:connectors:source-coin-api: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.
3 changes: 3 additions & 0 deletions airbyte-integrations/connectors/source-coin-api/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 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-coin-api:dev
tests:
spec:
- spec_path: "source_coin_api/spec.yaml"
connection:
- config_path: "secrets/config.json"
status: "succeed"
- config_path: "integration_tests/invalid_config.json"
status: "failed"
discovery:
- config_path: "secrets/config.json"
basic_read:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
empty_streams: []
full_refresh:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
Original file line number Diff line number Diff line change
@@ -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

Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
plugins {
id 'airbyte-python'
id 'airbyte-docker'
id 'airbyte-source-acceptance-test'
}

airbytePython {
moduleDirectory 'source_coin_api'
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"ohlcv_historical_data": {
"time_start": "2023-01-01T00:00:00",
"time_end": "2024-01-01T00:00:00"
},
"trades_historical_data": {
"time_start": "2023-01-01T00:00:00",
"time_end": "2024-01-01T00:00:00"
}
}
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
{
"streams": [
{
"stream": {
"name": "ohlcv_historical_data",
marcosmarxm marked this conversation as resolved.
Show resolved Hide resolved
"json_schema": {},
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite"
},
{
"stream": {
"name": "trades_historical_data",
"json_schema": {},
"supported_sync_modes": ["full_refresh"]
},
"sync_mode": "full_refresh",
"destination_sync_mode": "overwrite"
}
]
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"api_key": "YOUR_API_KEY",
"environment": "production",
"symbol_id": "KRAKENFTS_PERP_BTC_USD",
"period": "SOME_PERIOD",
"start_date": "2025-01-01T00:00:00",
"limit": 100000
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"api_key": "YOUR_API_KEY",
"environment": "production",
"symbol_id": "KRAKENFTS_PERP_BTC_USD",
"period": "1DAY",
"start_date": "2021-01-01T00:00:00",
"limit": 1000
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
{
"ohlcv_historical_data": {
"time_start": "2021-01-01T00:00:00",
"time_end": "2023-01-01T00:00:00"
},
"trades_historical_data": {
"time_start": "2021-01-01T00:00:00",
"time_end": "2023-01-01T00:00:00"
}
}
13 changes: 13 additions & 0 deletions airbyte-integrations/connectors/source-coin-api/main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#


import sys

from airbyte_cdk.entrypoint import launch
from source_coin_api import SourceCoinApi

if __name__ == "__main__":
source = SourceCoinApi()
launch(source, sys.argv[1:])
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
-e ../../bases/source-acceptance-test
-e .
29 changes: 29 additions & 0 deletions airbyte-integrations/connectors/source-coin-api/setup.py
Original file line number Diff line number Diff line change
@@ -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_coin_api",
description="Source implementation for Coin Api.",
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,
},
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
#
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
#


from .source import SourceCoinApi

__all__ = ["SourceCoinApi"]
Loading