Skip to content

Commit

Permalink
New Connector Polygon (#19504)
Browse files Browse the repository at this point in the history
* Weather API CDK Added

* Polygon-Stocks-API CDK Added

Polygon-Stocks-API is the API provided by https://polygon.io/ to get details about the stock

* spec.yaml updated

* Files Changes Resolved

* Review Changes Are Performed

* Some Requested Changes Are Done

Add title to your parameters is done
Change from to start_date and to to end_date is done

* correct schema

* add polygon to source def

* run format

* correct primary key

* auto-bump connector version

Co-authored-by: Harshil Khamar <harshilkhamar1@gmail.com>
Co-authored-by: Harshil Khamar <73790584+Harshil0512@users.noreply.github.com>
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
  • Loading branch information
4 people authored and akashkulk committed Nov 17, 2022
1 parent e14b08a commit 5a74345
Show file tree
Hide file tree
Showing 25 changed files with 635 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1167,6 +1167,13 @@
icon: pokeapi.svg
sourceType: api
releaseStage: alpha
- name: Polygon Stock API
sourceDefinitionId: 5807d72f-0abc-49f9-8fa5-ae820007032b
dockerRepository: airbyte/source-polygon-stock-api
dockerImageTag: 0.1.0
documentationUrl: https://docs.airbyte.com/integrations/sources/polygon-stock-api
sourceType: api
releaseStage: alpha
- name: PostHog
sourceDefinitionId: af6d50ee-dddf-4126-a8ee-7faee990774f
dockerRepository: airbyte/source-posthog
Expand Down
83 changes: 83 additions & 0 deletions airbyte-config/init/src/main/resources/seed/source_specs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10838,6 +10838,89 @@
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
- dockerImage: "airbyte/source-polygon-stock-api:0.1.0"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/sources/airtable"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "Weather API Spec"
type: "object"
required:
- "apiKey"
- "stocksTicker"
- "multiplier"
- "timespan"
- "start_date"
- "end_date"
additionalProperties: true
properties:
apiKey:
title: "API Key"
type: "string"
description: "Your API ACCESS Key"
airbyte_secret: true
stocksTicker:
title: "Stock Ticker"
type: "string"
description: "The exchange symbol that this item is traded under."
examples:
- "IBM"
- "MSFT"
multiplier:
title: "Multiplier"
type: "integer"
description: "The size of the timespan multiplier."
examples:
- 1
- 2
timespan:
title: "Timespan"
type: "string"
description: "The size of the time window."
examples:
- "day"
start_date:
title: "Start Date"
type: "string"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
description: "The beginning date for the aggregate window."
examples:
- "2020-10-14"
end_date:
title: "End Date"
type: "string"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
description: "The target date for the aggregate window."
examples:
- "2020-10-14"
adjusted:
title: "Adjusted"
type: "string"
description: "Determines whether or not the results are adjusted for splits.\
\ By default, results are adjusted and set to true. Set this to false\
\ to get results that are NOT adjusted for splits."
examples:
- "true"
- "false"
sort:
title: "Sort"
type: "string"
description: "Sort the results by timestamp. asc will return results in\
\ ascending order (oldest at the top), desc will return results in descending\
\ order (newest at the top)."
examples:
- "asc"
- "desc"
limit:
title: "Limit"
type: "integer"
description: "The target date for the aggregate window."
examples:
- 100
- 120
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
- dockerImage: "airbyte/source-posthog:0.1.7"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/sources/posthog"
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
*
!Dockerfile
!main.py
!source_polygon_stock_api
!setup.py
!secrets
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_polygon_stock_api ./source_polygon_stock_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-polygon-stock-api
79 changes: 79 additions & 0 deletions airbyte-integrations/connectors/source-polygon-stock-api/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# Polygon Stock Api Source

This is the repository for the Polygon Stock Api configuration based source connector.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/polygon-stock-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-polygon-stock-api:build
```

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

You can also build the connector image via Gradle:
```
./gradlew :airbyte-integrations:connectors:source-polygon-stock-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-polygon-stock-api:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-polygon-stock-api:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-polygon-stock-api:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-polygon-stock-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-polygon-stock-api:unitTest
```
To run acceptance and custom integration tests:
```
./gradlew :airbyte-integrations:connectors:source-polygon-stock-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.
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,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-polygon-stock-api:dev
acceptance_tests:
spec:
tests:
- spec_path: "source_polygon_stock_api/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"
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_polygon_stock_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,8 @@
{
"ticker": "microsoft",
"queryCount": 0,
"resultsCount": 0,
"adjusted": true,
"status": "OK",
"request_id": "2c243c1c9bc396cad059cd18253f3ab2"
}
Original file line number Diff line number Diff line change
@@ -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
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
{
"streams": [
{
"stream": {
"name": "stock_api",
"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,11 @@
{
"apiKey": "INVALID_API_KEY",
"limit": "120",
"sort": "asc",
"adjusted": "true",
"stocksTicker": "MSFT",
"multiplier": "1",
"timespan": "day",
"start_date": "2021-07-22",
"end_date": "2021-07-22"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"apiKey": "YOUR API KEY",
"limit": "120",
"sort": "asc",
"adjusted": "true",
"stocksTicker": "AAPL",
"multiplier": "1",
"timespan": "day",
"start_date": "2021-07-22",
"end_date": "2021-07-22"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"ticker": "AAPL",
"queryCount": 1,
"resultsCount": 1,
"adjusted": true,
"results": [
{
"v": 77287356,
"vw": 146.991,
"o": 145.935,
"c": 146.8,
"h": 148.195,
"l": 145.81,
"t": 1626926400000,
"n": 480209
}
],
"status": "OK",
"request_id": "6aae8b7d3d4d2cd896085a840d2e3ed1",
"count": 1
}
Loading

0 comments on commit 5a74345

Please sign in to comment.