Skip to content

Commit 5ed632a

Browse files
scottleechuasajarinoctavia-squidington-iii
authored
🎉 New Source: Plausible [low-code cdk] (#18657)
* initial commit * Add authentication * Add stats stream and schema * Change overwrite to append, add primary key * Make acceptance test executable * Revert to overwrite * Add documentation * Update documentation * Add titles to spec properties, update documentationUrl, remove EOF newlines * Add bootstrap.md * Update BOOTSTRAP.md * Remove incremental sync to-dos * fix: add source definition for plausible * fix: format python files with flake8 * auto-bump connector version Co-authored-by: Sajarin <[email protected]> Co-authored-by: Octavia Squidington III <[email protected]>
1 parent b1dfeed commit 5ed632a

File tree

25 files changed

+498
-0
lines changed

25 files changed

+498
-0
lines changed

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1158,6 +1158,14 @@
11581158
icon: plaid.svg
11591159
sourceType: api
11601160
releaseStage: alpha
1161+
- name: Plausible
1162+
sourceDefinitionId: 603ba446-3d75-41d7-92f3-aba901f8b897
1163+
dockerRepository: airbyte/source-plausible
1164+
dockerImageTag: 0.1.0
1165+
documentationUrl: https://docs.airbyte.com/integrations/sources/plausible
1166+
icon: plausible.svg
1167+
sourceType: api
1168+
releaseStage: alpha
11611169
- name: Pocket
11621170
sourceDefinitionId: b0dd65f1-081f-4731-9c51-38e9e6aa0ebf
11631171
dockerRepository: airbyte/source-pocket

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

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10741,6 +10741,45 @@
1074110741
supportsNormalization: false
1074210742
supportsDBT: false
1074310743
supported_destination_sync_modes: []
10744+
- dockerImage: "airbyte/source-plausible:0.1.0"
10745+
spec:
10746+
documentationUrl: "https://docs.airbyte.com/integrations/sources/plausible"
10747+
connectionSpecification:
10748+
$schema: "http://json-schema.org/draft-07/schema#"
10749+
title: "Plausible Spec"
10750+
type: "object"
10751+
required:
10752+
- "api_key"
10753+
- "site_id"
10754+
additionalProperties: true
10755+
properties:
10756+
api_key:
10757+
type: "string"
10758+
title: "Plausible API key"
10759+
description: "Plausible API Key. See the <a href=\"https://plausible.io/docs/stats-api\"\
10760+
>docs</a> for information on how to generate this key."
10761+
airbyte_secret: true
10762+
site_id:
10763+
type: "string"
10764+
title: "Target website domain"
10765+
description: "The domain of the site you want to retrieve data for. Enter\
10766+
\ the name of your site as configured on Plausible, i.e., excluding \"\
10767+
https://\" and \"www\". Can be retrieved from the 'domain' field in your\
10768+
\ Plausible site settings."
10769+
pattern: "^[A-Za-z0-9-.]+\\.[A-Z-a-z0-9-.]+"
10770+
examples:
10771+
- "airbyte.com"
10772+
- "docs.airbyte.com"
10773+
start_date:
10774+
type: "string"
10775+
title: "Data start date"
10776+
description: "Start date for data to retrieve, in ISO-8601 format."
10777+
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
10778+
examples:
10779+
- "YYYY-MM-DD"
10780+
supportsNormalization: false
10781+
supportsDBT: false
10782+
supported_destination_sync_modes: []
1074410783
- dockerImage: "airbyte/source-pocket:0.1.0"
1074510784
spec:
1074610785
documentationUrl: "https://docs.airbyte.com/integrations/sources/pocket"

‎airbyte-integrations/connectors/source-plausible/.dockerignore

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
*
2+
!Dockerfile
3+
!main.py
4+
!source_plausible
5+
!setup.py
6+
!secrets

‎airbyte-integrations/connectors/source-plausible/BOOTSTRAP.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Plausible
2+
3+
Plausible is a privacy-first, subscription-only website analytics service. Link to their stats API is [here](https://plausible.io/docs/stats-api).
4+
5+
## How to get an API key
6+
- [Sign up for Plausible](https://plausible.io/register). There is a 30-day free trial but beyond that it is a paid subscription.
7+
- [Add a website](https://plausible.io/docs/plausible-script).
8+
- Generate an API key from the [Settings page](https://plausible.io/settings).

‎airbyte-integrations/connectors/source-plausible/Dockerfile

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
FROM python:3.9.11-alpine3.15 as base
2+
3+
# build and load all requirements
4+
FROM base as builder
5+
WORKDIR /airbyte/integration_code
6+
7+
# upgrade pip to the latest version
8+
RUN apk --no-cache upgrade \
9+
&& pip install --upgrade pip \
10+
&& apk --no-cache add tzdata build-base
11+
12+
13+
COPY setup.py ./
14+
# install necessary packages to a temporary folder
15+
RUN pip install --prefix=/install .
16+
17+
# build a clean environment
18+
FROM base
19+
WORKDIR /airbyte/integration_code
20+
21+
# copy all loaded and built libraries to a pure basic image
22+
COPY --from=builder /install /usr/local
23+
# add default timezone settings
24+
COPY --from=builder /usr/share/zoneinfo/Etc/UTC /etc/localtime
25+
RUN echo "Etc/UTC" > /etc/timezone
26+
27+
# bash is installed for more convenient debugging.
28+
RUN apk --no-cache add bash
29+
30+
# copy payload code only
31+
COPY main.py ./
32+
COPY source_plausible ./source_plausible
33+
34+
ENV AIRBYTE_ENTRYPOINT "python /airbyte/integration_code/main.py"
35+
ENTRYPOINT ["python", "/airbyte/integration_code/main.py"]
36+
37+
LABEL io.airbyte.version=0.1.0
38+
LABEL io.airbyte.name=airbyte/source-plausible

‎airbyte-integrations/connectors/source-plausible/README.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# Plausible Source
2+
3+
This is the repository for the Plausible configuration based source connector.
4+
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/plausible).
5+
6+
## Local development
7+
8+
#### Building via Gradle
9+
You can also build the connector in Gradle. This is typically used in CI and not needed for your development workflow.
10+
11+
To build using Gradle, from the Airbyte repository root, run:
12+
```
13+
./gradlew :airbyte-integrations:connectors:source-plausible:build
14+
```
15+
16+
#### Create credentials
17+
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/plausible)
18+
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_plausible/spec.yaml` file.
19+
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
20+
See `integration_tests/sample_config.json` for a sample config file.
21+
22+
**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source plausible test creds`
23+
and place them into `secrets/config.json`.
24+
25+
### Locally running the connector docker image
26+
27+
#### Build
28+
First, make sure you build the latest Docker image:
29+
```
30+
docker build . -t airbyte/source-plausible:dev
31+
```
32+
33+
You can also build the connector image via Gradle:
34+
```
35+
./gradlew :airbyte-integrations:connectors:source-plausible:airbyteDocker
36+
```
37+
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
38+
the Dockerfile.
39+
40+
#### Run
41+
Then run any of the connector commands as follows:
42+
```
43+
docker run --rm airbyte/source-plausible:dev spec
44+
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-plausible:dev check --config /secrets/config.json
45+
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-plausible:dev discover --config /secrets/config.json
46+
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-plausible:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
47+
```
48+
## Testing
49+
50+
#### Acceptance Tests
51+
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.
52+
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.
53+
54+
To run your integration tests with docker
55+
56+
### Using gradle to run tests
57+
All commands should be run from airbyte project root.
58+
To run unit tests:
59+
```
60+
./gradlew :airbyte-integrations:connectors:source-plausible:unitTest
61+
```
62+
To run acceptance and custom integration tests:
63+
```
64+
./gradlew :airbyte-integrations:connectors:source-plausible:integrationTest
65+
```
66+
67+
## Dependency Management
68+
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.
69+
We split dependencies between two groups, dependencies that are:
70+
* required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
71+
* required for the testing need to go to `TEST_REQUIREMENTS` list
72+
73+
### Publishing a new version of the connector
74+
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
75+
1. Make sure your changes are passing unit and integration tests.
76+
1. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use [SemVer](https://semver.org/)).
77+
1. Create a Pull Request.
78+
1. Pat yourself on the back for being an awesome contributor.
79+
1. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.

‎airbyte-integrations/connectors/source-plausible/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#
2+
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
3+
#

‎airbyte-integrations/connectors/source-plausible/acceptance-test-config.yml

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
# See [Source Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/source-acceptance-tests-reference)
2+
# for more information about how to configure these tests
3+
connector_image: airbyte/source-plausible:dev
4+
acceptance_tests:
5+
spec:
6+
tests:
7+
- spec_path: "source_plausible/spec.yaml"
8+
connection:
9+
tests:
10+
- config_path: "secrets/config.json"
11+
status: "succeed"
12+
- config_path: "integration_tests/invalid_config.json"
13+
status: "failed"
14+
discovery:
15+
tests:
16+
- config_path: "secrets/config.json"
17+
basic_read:
18+
tests:
19+
- config_path: "secrets/config.json"
20+
configured_catalog_path: "integration_tests/configured_catalog.json"
21+
empty_streams: []
22+
incremental:
23+
bypass_reason: "This connector does not implement incremental sync"
24+
full_refresh:
25+
tests:
26+
- config_path: "secrets/config.json"
27+
configured_catalog_path: "integration_tests/configured_catalog.json"

‎airbyte-integrations/connectors/source-plausible/acceptance-test-docker.sh

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
#!/usr/bin/env sh
2+
3+
# Build latest connector image
4+
docker build . -t $(cat acceptance-test-config.yml | grep "connector_image" | head -n 1 | cut -d: -f2-)
5+
6+
# Pull latest acctest image
7+
docker pull airbyte/source-acceptance-test:latest
8+
9+
# Run
10+
docker run --rm -it \
11+
-v /var/run/docker.sock:/var/run/docker.sock \
12+
-v /tmp:/tmp \
13+
-v $(pwd):/test_input \
14+
airbyte/source-acceptance-test \
15+
--acceptance-test-config /test_input

‎airbyte-integrations/connectors/source-plausible/build.gradle

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
plugins {
2+
id 'airbyte-python'
3+
id 'airbyte-docker'
4+
id 'airbyte-source-acceptance-test'
5+
}
6+
7+
airbytePython {
8+
moduleDirectory 'source_plausible'
9+
}

‎airbyte-integrations/connectors/source-plausible/integration_tests/__init__.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
#
2+
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
3+
#

‎airbyte-integrations/connectors/source-plausible/integration_tests/acceptance.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
#
2+
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
3+
#
4+
5+
6+
import pytest
7+
8+
pytest_plugins = ("source_acceptance_test.plugin",)
9+
10+
11+
@pytest.fixture(scope="session", autouse=True)
12+
def connector_setup():
13+
"""This fixture is a placeholder for external resources that acceptance test might require."""
14+
pass

‎airbyte-integrations/connectors/source-plausible/integration_tests/configured_catalog.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
{
2+
"streams": [
3+
{
4+
"stream": {
5+
"name": "stats",
6+
"json_schema": {},
7+
"supported_sync_modes": ["full_refresh"]
8+
},
9+
"sync_mode": "full_refresh",
10+
"destination_sync_mode": "overwrite"
11+
}
12+
]
13+
}

‎airbyte-integrations/connectors/source-plausible/integration_tests/invalid_config.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"api_key": "<invalid_key>",
3+
"site_id": "https://airbyte.com",
4+
"start_date": "20220101"
5+
}

‎airbyte-integrations/connectors/source-plausible/integration_tests/sample_config.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"api_key": "your_api_key",
3+
"site_id": "airbyte.com",
4+
"start_date": "2022-01-01"
5+
}

‎airbyte-integrations/connectors/source-plausible/main.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
#
2+
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
3+
#
4+
5+
6+
import sys
7+
8+
from airbyte_cdk.entrypoint import launch
9+
from source_plausible import SourcePlausible
10+
11+
if __name__ == "__main__":
12+
source = SourcePlausible()
13+
launch(source, sys.argv[1:])

‎airbyte-integrations/connectors/source-plausible/requirements.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
-e ../../bases/source-acceptance-test
2+
-e .

‎airbyte-integrations/connectors/source-plausible/setup.py

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
#
2+
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
3+
#
4+
5+
6+
from setuptools import find_packages, setup
7+
8+
MAIN_REQUIREMENTS = [
9+
"airbyte-cdk~=0.1",
10+
]
11+
12+
TEST_REQUIREMENTS = [
13+
"pytest~=6.1",
14+
"pytest-mock~=3.6.1",
15+
"source-acceptance-test",
16+
]
17+
18+
setup(
19+
name="source_plausible",
20+
description="Source implementation for Plausible.",
21+
author="Airbyte",
22+
author_email="[email protected]",
23+
packages=find_packages(),
24+
install_requires=MAIN_REQUIREMENTS,
25+
package_data={"": ["*.json", "*.yaml", "schemas/*.json", "schemas/shared/*.json"]},
26+
extras_require={
27+
"tests": TEST_REQUIREMENTS,
28+
},
29+
)

‎airbyte-integrations/connectors/source-plausible/source_plausible/__init__.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#
2+
# Copyright (c) 2022 Airbyte, Inc., all rights reserved.
3+
#
4+
5+
6+
from .source import SourcePlausible
7+
8+
__all__ = ["SourcePlausible"]

0 commit comments

Comments
 (0)