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: TMDb [low-code cdk] #18561

Merged
merged 23 commits into from
Nov 16, 2022
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
b9d6c7a
Init: New Source: TMDb
btkcodedev Oct 27, 2022
5198a0e
chore: Added documentation
btkcodedev Oct 27, 2022
766e762
Merge branch 'master' into tmdb
btkcodedev Oct 27, 2022
c3dba4b
Merge branch 'master' into tmdb
btkcodedev Oct 28, 2022
98745fc
Merge branch 'master' into tmdb
btkcodedev Oct 29, 2022
ff394db
Chore: All Comments Resolved
btkcodedev Nov 5, 2022
47f2187
Merge branch 'tmdb' of https://github.com/btkcodedev/airbyte into tmdb
btkcodedev Nov 5, 2022
a642870
Merge branch 'master' into tmdb
btkcodedev Nov 5, 2022
d96646a
Added language config for filtering, All comomments resolved
btkcodedev Nov 5, 2022
e8f0fd3
Merge branch 'tmdb' of https://github.com/btkcodedev/airbyte into tmdb
btkcodedev Nov 5, 2022
7f72f10
Update Doc URL
btkcodedev Nov 5, 2022
972678c
add tmdb to source def and format files
marcosmarxm Nov 7, 2022
40e2435
Removed unwanted authenticator, Added request params and configs
btkcodedev Nov 8, 2022
608e5a8
Resolve merge conflict
btkcodedev Nov 8, 2022
5a3ed5a
cleansed lint
btkcodedev Nov 8, 2022
e5714ab
Merge branch 'master' into tmdb
btkcodedev Nov 8, 2022
a113f10
feat: Added pagination, refactor: moved example to spec.yaml and mino…
btkcodedev Nov 9, 2022
46eec09
Merge branch 'tmdb' of https://github.com/btkcodedev/airbyte into tmdb
btkcodedev Nov 9, 2022
c2e2301
fix: change required in spec.yaml, corrections to docs
btkcodedev Nov 10, 2022
9052b6c
removed unwanted file change
btkcodedev Nov 10, 2022
2e61946
remove movies_changes
marcosmarxm Nov 16, 2022
c763c6c
Merge branch 'master' into tmdb
marcosmarxm Nov 16, 2022
f136a34
auto-bump connector version
octavia-squidington-iii Nov 16, 2022
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
6 changes: 6 additions & 0 deletions airbyte-integrations/connectors/source-tmdb/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
*
!Dockerfile
!main.py
!source_tmdb
!setup.py
!secrets
38 changes: 38 additions & 0 deletions airbyte-integrations/connectors/source-tmdb/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_tmdb ./source_tmdb

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

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

## Local development

### Prerequisites
**To iterate on this connector, make sure to complete this prerequisites section.**

#### Minimum Python version required `= 3.9.0`

#### Build & Activate Virtual Environment and install dependencies
From this connector directory, create a virtual environment:
```
python -m venv .venv
```

This will generate a virtualenv for this module in `.venv/`. Make sure this venv is active in your
development environment of choice. To activate it from the terminal, run:
```
source .venv/bin/activate
pip install -r requirements.txt
```
If you are in an IDE, follow your IDE's instructions to activate the virtualenv.

Note that while we are installing dependencies from `requirements.txt`, you should only edit `setup.py` for your dependencies. `requirements.txt` is
used for editable installs (`pip install -e`) to pull in Python dependencies from the monorepo and will call `setup.py`.
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
should work as you expect.
#### 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-tmdb:build
```

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

You can also build the connector image via Gradle:
```
./gradlew :airbyte-integrations:connectors:source-tmdb: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-tmdb:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-tmdb:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-tmdb:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-tmdb: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-tmdb:unitTest
```
To run acceptance and custom integration tests:
```
./gradlew :airbyte-integrations:connectors:source-tmdb: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-tmdb/__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,25 @@
# 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-tmdb:dev
acceptance_tests:
spec:
tests:
- spec_path: "source_tmdb/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: []
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

40 changes: 40 additions & 0 deletions airbyte-integrations/connectors/source-tmdb/bootstrap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# TMDb

The connector uses the v3 API documented here: https://developers.themoviedb.org/3/getting-started/introduction. It is
straightforward HTTP REST API with API Authentication.

## API key

Api key is mandate for this connector to work. It could be generated using a free account at TMDb. Visit: https://www.themoviedb.org/settings/api

## Implementation details

## Setup guide

### Step 1: Set up TMDb connection

- Have an API key by generating personal API key (Example: 12345)
- A movie ID (Mandate to target a movie for generating info)
- Streams doesn't require movie_id to work is listed. Just pass 550 as movie_id to connect
- movies_latest
- movies_now_playing
- movies_popular
- movies_top_rated
- movies_upcoming

## Step 2: Generate schema for the endpoint

### Custom schema is generated and tested with different IDs

## Step 3: Spec, Secrets, and connector yaml files are configured with reference to the Airbyte documentation.

## In a nutshell:

1. Navigate to the Airbyte Open Source dashboard.
2. Set the name for your source.
3. Enter your `api_key`.
5. Enter your `movie_id`.
6. Click **Set up source**.

* We use only GET methods, all streams are straightforward.

9 changes: 9 additions & 0 deletions airbyte-integrations/connectors/source-tmdb/build.gradle
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_tmdb'
}
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,5 @@
{
"todo-stream-name": {
"todo-field-name": "todo-abnormal-value"
}
}
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,39 @@
{
"streams": [
{
"name": "TODO fix this file",
"supported_sync_modes": ["full_refresh", "incremental"],
"source_defined_cursor": true,
"default_cursor_field": "column1",
"json_schema": {
"$schema": "http://json-schema.org/draft-07/schema#",
btkcodedev marked this conversation as resolved.
Show resolved Hide resolved
"type": "object",
"properties": {
"column1": {
"type": "string"
},
"column2": {
"type": "number"
}
}
}
},
{
"name": "table1",
"supported_sync_modes": ["full_refresh", "incremental"],
"source_defined_cursor": false,
"json_schema": {
"$schema": "http://json-schema.org/draft-07/schema#",
"type": "object",
"properties": {
"column1": {
"type": "string"
},
"column2": {
"type": "number"
}
}
}
}
]
}
Loading