Skip to content

Commit 92aeac3

Browse files
dtt101harshithmullapudioctavia-squidington-iii
authored
🎉 New Source: AppFollow Service (#14418)
* Generated template Using https://docs.airbyte.com/connector-development/tutorials/cdk-speedrun * Added spec.yaml Ref https://appfollow.docs.apiary.io/ Does not currently include authentication * Schema and working discover for ratings API * Add catalog * Add cid as required parameter * Working ratings call BASIC AUTH REALLY * Use basic auth in check connection * Updated comment for request params * Update README for local run * Moved with common params to stream superclass * Add support for country parameter * WIP: acceptance 90% pass * Passing acceptance tests for ratings in docker * Remove incremental unit tests We have no incremental streams * Match number of streams to test * Passing streams unit tests * Connection check test * Update unit test type check * Remove TODO * fix: tests are failing * docs: added documentation for appfollow and logo * docs: added documentation for appfollow and logo * Bump io.airbyte.version * fix: tests are failing * auto-bump connector version [ci skip] Co-authored-by: Harshith Mullapudi <[email protected]> Co-authored-by: Octavia Squidington III <[email protected]>
1 parent f281f8f commit 92aeac3

File tree

28 files changed

+773
-0
lines changed

28 files changed

+773
-0
lines changed

‎airbyte-config/init/src/main/resources/icons/appfollow.svg

Lines changed: 18 additions & 0 deletions
Loading

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

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,14 @@
5353
icon: apify.svg
5454
sourceType: api
5555
releaseStage: alpha
56+
- name: Appfollow
57+
sourceDefinitionId: b4375641-e270-41d3-9c20-4f9cecad87a8
58+
dockerRepository: airbyte/source-appfollow
59+
dockerImageTag: 0.1.1
60+
documentationUrl: https://docs.airbyte.io/integrations/sources/appfollow
61+
icon: appfollow.svg
62+
sourceType: api
63+
releaseStage: alpha
5664
- name: Appstore
5765
sourceDefinitionId: 2af123bf-0aaf-4e0d-9784-cb497f23741a
5866
dockerRepository: airbyte/source-appstore-singer

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

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -605,6 +605,41 @@
605605
supportsNormalization: false
606606
supportsDBT: false
607607
supported_destination_sync_modes: []
608+
- dockerImage: "airbyte/source-appfollow:0.1.1"
609+
spec:
610+
documentationUrl: "https://docs.airbyte.io/integrations/sources/appfollow"
611+
connectionSpecification:
612+
$schema: "http://json-schema.org/draft-07/schema#"
613+
title: "Appfollow Spec"
614+
type: "object"
615+
required:
616+
- "ext_id"
617+
- "country"
618+
- "cid"
619+
- "api_secret"
620+
additionalProperties: true
621+
properties:
622+
ext_id:
623+
type: "string"
624+
title: "app external id"
625+
description: "for App Store — this is 9-10 digits identification number;\
626+
\ for Google Play — this is bundle name;"
627+
cid:
628+
type: "string"
629+
title: "client id"
630+
description: "client id provided by Appfollow"
631+
api_secret:
632+
type: "string"
633+
title: "api secret"
634+
description: "api secret provided by Appfollow"
635+
airbyte_secret: true
636+
country:
637+
type: "string"
638+
title: "country"
639+
description: "getting data by Country"
640+
supportsNormalization: false
641+
supportsDBT: false
642+
supported_destination_sync_modes: []
608643
- dockerImage: "airbyte/source-appstore-singer:0.2.6"
609644
spec:
610645
documentationUrl: "https://docs.airbyte.io/integrations/sources/appstore"

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

‎airbyte-integrations/connectors/source-appfollow/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_appfollow ./source_appfollow
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.1
38+
LABEL io.airbyte.name=airbyte/source-appfollow

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

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Appfollow Source
2+
3+
This is the repository for the Appfollow source connector, written in Python.
4+
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/appfollow).
5+
6+
## Local development
7+
8+
### Prerequisites
9+
**To iterate on this connector, make sure to complete this prerequisites section.**
10+
11+
#### Minimum Python version required `= 3.9.0`
12+
13+
#### Build & Activate Virtual Environment and install dependencies
14+
From this connector directory, create a virtual environment:
15+
```
16+
python -m venv .venv
17+
```
18+
19+
This will generate a virtualenv for this module in `.venv/`. Make sure this venv is active in your
20+
development environment of choice. To activate it from the terminal, run:
21+
```
22+
source .venv/bin/activate
23+
pip install -r requirements.txt
24+
pip install '.[tests]'
25+
```
26+
If you are in an IDE, follow your IDE's instructions to activate the virtualenv.
27+
28+
Note that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is
29+
used for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.
30+
If this is mumbo jumbo to you, don't worry about it, just put your deps in `setup.py` but install using `pip install -r requirements.txt` and everything
31+
should work as you expect.
32+
33+
#### Building via Gradle
34+
You can also build the connector in Gradle. This is typically used in CI and not needed for your development workflow.
35+
36+
To build using Gradle, from the Airbyte repository root, run:
37+
```
38+
./gradlew :airbyte-integrations:connectors:source-appfollow:build
39+
```
40+
41+
#### Create credentials
42+
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/appfollow)
43+
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_appfollow/spec.yaml` file.
44+
Note that any directory named `secrets` is gitignored across the entire Airbyte repo, so there is no danger of accidentally checking in sensitive information.
45+
See `integration_tests/sample_config.json` for a sample config file.
46+
47+
**If you are an Airbyte core member**, copy the credentials in Lastpass under the secret name `source appfollow test creds`
48+
and place them into `secrets/config.json`.
49+
50+
### Locally running the connector
51+
```
52+
python main.py spec
53+
python main.py check --config secrets/config.json
54+
python main.py discover --config secrets/config.json
55+
python3 main.py read --config secrets/config.json --catalog sample_files/configured_catalog.json
56+
```
57+
58+
### Locally running the connector docker image
59+
60+
#### Build
61+
First, make sure you build the latest Docker image:
62+
```
63+
docker build . -t airbyte/source-appfollow:dev
64+
```
65+
66+
You can also build the connector image via Gradle:
67+
```
68+
./gradlew :airbyte-integrations:connectors:source-appfollow:airbyteDocker
69+
```
70+
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
71+
the Dockerfile.
72+
73+
#### Run
74+
Then run any of the connector commands as follows:
75+
```
76+
docker run --rm airbyte/source-appfollow:dev spec
77+
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-appfollow:dev check --config /secrets/config.json
78+
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-appfollow:dev discover --config /secrets/config.json
79+
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-appfollow:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
80+
```
81+
## Testing
82+
Make sure to familiarize yourself with [pytest test discovery](https://docs.pytest.org/en/latest/goodpractices.html#test-discovery) to know how your test files and methods should be named.
83+
First install test dependencies into your virtual environment:
84+
```
85+
pip install .[tests]
86+
```
87+
### Unit Tests
88+
To run unit tests locally, from the connector directory run:
89+
```
90+
python -m pytest unit_tests
91+
```
92+
93+
### Integration Tests
94+
There are two types of integration tests: Acceptance Tests (Airbyte's test suite for all source connectors) and custom integration tests (which are specific to this connector).
95+
#### Custom Integration tests
96+
Place custom tests inside `integration_tests/` folder, then, from the connector root, run
97+
```
98+
python -m pytest integration_tests
99+
```
100+
#### Acceptance Tests
101+
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.
102+
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.
103+
To run your integration tests with acceptance tests, from the connector root, run
104+
```
105+
python -m pytest integration_tests -p integration_tests.acceptance
106+
```
107+
To run your integration tests with docker
108+
109+
### Using gradle to run tests
110+
All commands should be run from airbyte project root.
111+
To run unit tests:
112+
```
113+
./gradlew :airbyte-integrations:connectors:source-appfollow:unitTest
114+
```
115+
To run acceptance and custom integration tests:
116+
```
117+
./gradlew :airbyte-integrations:connectors:source-appfollow:integrationTest
118+
```
119+
120+
## Dependency Management
121+
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.
122+
We split dependencies between two groups, dependencies that are:
123+
* required for your connector to work need to go to `MAIN_REQUIREMENTS` list.
124+
* required for the testing need to go to `TEST_REQUIREMENTS` list
125+
126+
### Publishing a new version of the connector
127+
You've checked out the repo, implemented a million dollar feature, and you're ready to share your changes with the world. Now what?
128+
1. Make sure your changes are passing unit and integration tests.
129+
1. Bump the connector version in `Dockerfile` -- just increment the value of the `LABEL io.airbyte.version` appropriately (we use [SemVer](https://semver.org/)).
130+
1. Create a Pull Request.
131+
1. Pat yourself on the back for being an awesome contributor.
132+
1. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master.

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

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# # See [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-acceptance-tests-reference)
2+
# # for more information about how to configure these tests
3+
4+
connector_image: airbyte/source-appfollow:dev
5+
tests:
6+
spec:
7+
- spec_path: "source_appfollow/spec.yaml"
8+
# Enable these once we get appfollow credentials
9+
# connection:
10+
# - config_path: "secrets/config.json"
11+
# status: "succeed"
12+
# - config_path: "integration_tests/invalid_config.json"
13+
# status: "failed"
14+
# discovery:
15+
# - config_path: "secrets/config.json"
16+
# basic_read:
17+
# - config_path: "secrets/config.json"
18+
# configured_catalog_path: "integration_tests/configured_catalog.json"
19+
# empty_streams: []
20+
# full_refresh:
21+
# - config_path: "secrets/config.json"
22+
# configured_catalog_path: "integration_tests/configured_catalog.json"

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

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
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
16+

‎airbyte-integrations/connectors/source-appfollow/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_appfollow'
9+
}

‎airbyte-integrations/connectors/source-appfollow/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-appfollow/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+
yield

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

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
{
2+
"streams": [
3+
{
4+
"stream": {
5+
"name": "ratings",
6+
"json_schema": {
7+
"$schema": "http://json-schema.org/draft-04/schema#",
8+
"type": "object",
9+
"properties": {
10+
"ext_id": {
11+
"type": "string"
12+
},
13+
"cid": {
14+
"type": "string"
15+
},
16+
"country": {
17+
"type": "string"
18+
}
19+
}
20+
},
21+
"supported_sync_modes": [
22+
"full_refresh"
23+
]
24+
},
25+
"sync_mode": "full_refresh",
26+
"destination_sync_mode": "overwrite"
27+
}
28+
]
29+
}

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"ext_id": "FIXME",
3+
"cid": "FIXME",
4+
"api_secret": "FIXME",
5+
"country": "FIXME"
6+
}

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"ext_id": "FIXME",
3+
"cid": "FIXME",
4+
"api_secret": "FIXME",
5+
"country": "FIXME"
6+
}

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

‎airbyte-integrations/connectors/source-appfollow/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-appfollow/sample_files/config.json

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"ext_id": "FIXME",
3+
"cid": "FIXME",
4+
"api_secret": "FIXME",
5+
"country": "FIXME"
6+
}
7+

0 commit comments

Comments
 (0)