Skip to content

Commit 1403c1b

Browse files
scottleechuamarcosmarxmoctavia-squidington-iii
authored
🎉 New Source: EmailOctopus [low-code cdk] (#18647)
* Initial commit - emailoctopus * Add API key parameter * Update schemas * Annotate schemas * Update integration tests * Acceptance test bug fixes * Change full refresh append to overwrite; delete abnormal state * Add documentation * Update documentation * Update documentation * Update DocumentationUrl, add titles to spec properties, remove schemas/TODO, remove EOF newlines * Add BOOTSTRAP.md * Remove todos * run format * add emailloctopus to source def * run format * auto-bump connector version Co-authored-by: marcosmarxm <[email protected]> Co-authored-by: Octavia Squidington III <[email protected]>
1 parent 444e6f9 commit 1403c1b

File tree

25 files changed

+597
-0
lines changed

25 files changed

+597
-0
lines changed

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -354,6 +354,13 @@
354354
icon: airbyte.svg
355355
sourceType: api
356356
releaseStage: alpha
357+
- name: EmailOctopus
358+
sourceDefinitionId: 46b25e70-c980-4590-a811-8deaf50ee09f
359+
dockerRepository: airbyte/source-emailoctopus
360+
dockerImageTag: 0.1.0
361+
documentationUrl: https://docs.airbyte.com/integrations/sources/emailoctopus
362+
sourceType: api
363+
releaseStage: alpha
357364
- name: Exchange Rates Api
358365
sourceDefinitionId: e2b40e36-aa0e-4bed-b41b-bcea6fa348b1
359366
dockerRepository: airbyte/source-exchange-rates

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3021,6 +3021,26 @@
30213021
supportsDBT: false
30223022
supported_destination_sync_modes: []
30233023
protocol_version: "0.2.1"
3024+
- dockerImage: "airbyte/source-emailoctopus:0.1.0"
3025+
spec:
3026+
documentationUrl: "https://docs.airbyte.com/integrations/sources/emailoctopus"
3027+
connectionSpecification:
3028+
$schema: "http://json-schema.org/draft-07/schema#"
3029+
title: "EmailOctopus Spec"
3030+
type: "object"
3031+
required:
3032+
- "api_key"
3033+
additionalProperties: true
3034+
properties:
3035+
api_key:
3036+
type: "string"
3037+
title: "EmailOctopus API key"
3038+
description: "EmailOctopus API Key. See the <a href=\"https://help.emailoctopus.com/article/165-how-to-create-and-delete-api-keys\"\
3039+
>docs</a> for information on how to generate this key."
3040+
airbyte_secret: true
3041+
supportsNormalization: false
3042+
supportsDBT: false
3043+
supported_destination_sync_modes: []
30243044
- dockerImage: "airbyte/source-exchange-rates:1.2.7"
30253045
spec:
30263046
documentationUrl: "https://docs.airbyte.com/integrations/sources/exchangeratesapi"

‎airbyte-integrations/connectors/source-emailoctopus/.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_emailoctopus
5+
!setup.py
6+
!secrets

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# EmailOctopus
2+
3+
EmailOctopus is an email marketing tool. Link to API [here](https://emailoctopus.com/api-documentation).
4+
5+
## How to get an API key
6+
- [Sign up for EmailOctopus](https://emailoctopus.com/account/sign-up). I recall there is a verification process that involves speaking with support staff.
7+
- Pricing is volume-based, so a sandbox account should be free: see [Pricing](https://emailoctopus.com/pricing).
8+
- Once signed in, generate an API key from the [API documentation page](https://emailoctopus.com/api-documentation).

‎airbyte-integrations/connectors/source-emailoctopus/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_emailoctopus ./source_emailoctopus
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-emailoctopus

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

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
# EmailOctopus Source
2+
3+
This is the repository for the EmailOctopus configuration based source connector.
4+
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/emailoctopus).
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-emailoctopus: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/emailoctopus)
18+
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_emailoctopus/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 emailoctopus 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-emailoctopus:dev
31+
```
32+
33+
You can also build the connector image via Gradle:
34+
```
35+
./gradlew :airbyte-integrations:connectors:source-emailoctopus: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-emailoctopus:dev spec
44+
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-emailoctopus:dev check --config /secrets/config.json
45+
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-emailoctopus:dev discover --config /secrets/config.json
46+
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-emailoctopus: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-emailoctopus:unitTest
61+
```
62+
To run acceptance and custom integration tests:
63+
```
64+
./gradlew :airbyte-integrations:connectors:source-emailoctopus: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-emailoctopus/__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-emailoctopus/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-emailoctopus:dev
4+
acceptance_tests:
5+
spec:
6+
tests:
7+
- spec_path: "source_emailoctopus/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-emailoctopus/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-emailoctopus/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_emailoctopus'
9+
}

‎airbyte-integrations/connectors/source-emailoctopus/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-emailoctopus/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-emailoctopus/integration_tests/configured_catalog.json

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
{
2+
"streams": [
3+
{
4+
"cursor_field": null,
5+
"destination_sync_mode": "overwrite",
6+
"primary_key": null,
7+
"stream": {
8+
"default_cursor_field": null,
9+
"json_schema": {},
10+
"name": "campaigns",
11+
"namespace": null,
12+
"source_defined_cursor": null,
13+
"source_defined_primary_key": [["id"]],
14+
"supported_sync_modes": ["full_refresh"]
15+
},
16+
"sync_mode": "full_refresh"
17+
},
18+
{
19+
"cursor_field": null,
20+
"destination_sync_mode": "overwrite",
21+
"primary_key": null,
22+
"stream": {
23+
"default_cursor_field": null,
24+
"json_schema": {},
25+
"name": "lists",
26+
"namespace": null,
27+
"source_defined_cursor": null,
28+
"source_defined_primary_key": [["id"]],
29+
"supported_sync_modes": ["full_refresh"]
30+
},
31+
"sync_mode": "full_refresh"
32+
}
33+
]
34+
}

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"api_key": "<invalid_key>"
3+
}

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"api_key": "your_api_key"
3+
}

‎airbyte-integrations/connectors/source-emailoctopus/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_emailoctopus import SourceEmailoctopus
10+
11+
if __name__ == "__main__":
12+
source = SourceEmailoctopus()
13+
launch(source, sys.argv[1:])

‎airbyte-integrations/connectors/source-emailoctopus/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-emailoctopus/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_emailoctopus",
20+
description="Source implementation for Emailoctopus.",
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-emailoctopus/source_emailoctopus/__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 SourceEmailoctopus
7+
8+
__all__ = ["SourceEmailoctopus"]

0 commit comments

Comments
 (0)