Skip to content

Commit

Permalink
🎉 New Source: Wrike (#15638)
Browse files Browse the repository at this point in the history
* Connector skeleton

* Implement the first two endpoints with incomplete schema

* Add more fields to download from tasks

* Add more fields to download from tasks

* Add new entities plus refector a few stuff

* Complete all schema jsons

* Add slice management for comments

* complete schema definition for folders

* remove incremental tests

* Removing as no incremental support yet

* Format as pep8

* sample config files

* add newer version of the catalog

* remove unused import

* use wrike cataglog

* remove additional properties

* remove incremental tests

* reformat everything with Prettifier

* Add developer notes

* Add source-wrike badge

* Add Wrike source as alpha

* Document Wrike connector usage

* Add title fields for input parameters

* fix typo

* handle empty start date string

* add unit tests for wrike source

* remove unnecessary comments

* duplicated file

* document how to get permanent tokens

* Add link to API documentation

* Apply gradlew format

* Add workflow endpoint

* Change youtube back to Beta

* Remove unnecesary TODO comment

* Add null constraints

* Code cleanup in check_connection and streams

* Improved null constraints in schema

* Convert arrays with one element to string

* chore: update source_definitions.yaml

* chore: generate/update source_specs.yaml

Co-authored-by: sajarin <sajarindider@gmail.com>
  • Loading branch information
tfoldi and sajarin authored Sep 15, 2022
1 parent dd4b7be commit a61ac9f
Show file tree
Hide file tree
Showing 33 changed files with 1,580 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1097,6 +1097,14 @@
icon: woocommerce.svg
sourceType: api
releaseStage: alpha
- name: Wrike
sourceDefinitionId: 9c13f986-a13b-4988-b808-4705badf71c2
dockerRepository: airbyte/source-wrike
dockerImageTag: 0.1.0
documentationUrl: https://docs.airbyte.io/integrations/sources/wrike
icon: wrike.svg
sourceType: api
releaseStage: alpha
- name: Zendesk Chat
sourceDefinitionId: 40d24d0f-b8f9-4fe0-9e6c-b06c0f3f45e4
dockerRepository: airbyte/source-zendesk-chat
Expand Down
37 changes: 37 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 @@ -11136,6 +11136,43 @@
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
- dockerImage: "airbyte/source-wrike:0.1.0"
spec:
documentationUrl: "https://docsurl.com"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "Wrike Spec"
type: "object"
required:
- "access_token"
- "wrike_instance"
properties:
access_token:
type: "string"
title: "Permanent Access Token"
description: "Permanent access token. You can find documentation on how\
\ to acquire a permanent access token <a href=\"https://developers.wrike.com/oauth-20-authorization/\"\
>here</a>"
airbyte_secret: true
order: 0
wrike_instance:
type: "string"
title: "Wrike Instance (hostname)"
description: "Wrike's instance such as `app-us2.wrike.com`"
default: "app-us2.wrike.com"
order: 1
start_date:
type: "string"
title: "Start date for comments"
pattern: "^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}Z$"
description: "UTC date and time in the format 2017-01-25T00:00:00Z. Only\
\ comments after this date will be replicated."
examples:
- "2017-01-25T00:00:00Z"
order: 2
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
- dockerImage: "airbyte/source-zendesk-chat:0.1.9"
spec:
documentationUrl: "https://docs.airbyte.io/integrations/sources/zendesk-chat"
Expand Down
1 change: 1 addition & 0 deletions airbyte-integrations/builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,7 @@
| Twilio | [![source-twilio](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-twilio%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-twilio) |
| Typeform | [![source-typeform](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-typeform%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-typeform) |
| US Census | [![source-us-census](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-us-census%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-us-census) |
| Wrike | [![source-wrike](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-wrike%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-wrike) |
| YouTube Analytics | [![source-youtube-analytics](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-youtube-analytics%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-youtube-analytics) |
| Zendesk Chat | [![source-zendesk-chat](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-zendesk-chat%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-zendesk-chat) |
| Zendesk Support | [![source-zendesk-support](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-zendesk-support%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-zendesk-support) |
Expand Down
6 changes: 6 additions & 0 deletions airbyte-integrations/connectors/source-wrike/.dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
*
!Dockerfile
!main.py
!source_wrike
!setup.py
!secrets
38 changes: 38 additions & 0 deletions airbyte-integrations/connectors/source-wrike/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_wrike ./source_wrike

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

This is the repository for the Wrike source connector, written in Python.
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.io/integrations/sources/wrike).

## 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
pip install '.[tests]'
```
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-wrike:build
```

### Create credentials

#### Generating access token

First get a Wrike account, you can get a trial here: Register for trial: https://www.wrike.com/free-trial/

To generate a token:

1. Navigate to the ‘API apps’ section.
2. Select the required application from the list.
3. Click ‘Configure’.
4. Click ‘Obtain token’ in the “Permanent access token” section.
5. You will see a pop-up with a warning about using the permanent token, and after confirming, you will be able to copy and paste it into a secure storage (Wrike will not display it again). If your permanent token gets lost, you should generate a new one.


### Configuration files

Then create a file `secrets/config.json` conforming to the `source_wrike/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 wrike test creds`
and place them into `secrets/config.json`.

### Locally running the connector
```
python main.py spec
python main.py check --config secrets/config.json
python main.py discover --config secrets/config.json
python main.py read --config secrets/config.json --catalog integration_tests/configured_catalog.json
```

### Locally running the connector docker image

#### Build
First, make sure you build the latest Docker image:
```
docker build . -t airbyte/source-wrike:dev
```

You can also build the connector image via Gradle:
```
./gradlew :airbyte-integrations:connectors:source-wrike: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-wrike:dev spec
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-wrike:dev check --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-wrike:dev discover --config /secrets/config.json
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-wrike:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json
```
## Testing
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.
First install test dependencies into your virtual environment:
```
pip install .[tests]
```
### Unit Tests
To run unit tests locally, from the connector directory run:
```
python -m pytest unit_tests
```

### Integration Tests
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).
#### Custom Integration tests
Place custom tests inside `integration_tests/` folder, then, from the connector root, run
```
python -m pytest integration_tests
```
#### 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 acceptance tests, from the connector root, run
```
python -m pytest integration_tests -p integration_tests.acceptance
```
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-wrike:unitTest
```
To run acceptance and custom integration tests:
```
./gradlew :airbyte-integrations:connectors:source-wrike: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,20 @@
# See [Source Acceptance Tests](https://docs.airbyte.io/connector-development/testing-connectors/source-acceptance-tests-reference)
# for more information about how to configure these tests
connector_image: airbyte/source-wrike:dev
tests:
spec:
- spec_path: "source_wrike/spec.yaml"
connection:
- config_path: "secrets/config.json"
status: "succeed"
- config_path: "integration_tests/invalid_config.json"
status: "failed"
discovery:
- config_path: "secrets/config.json"
basic_read:
- config_path: "secrets/config.json"
configured_catalog_path: "integration_tests/configured_catalog.json"
empty_streams: []
full_refresh:
- 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

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

The connector uses the v4 API documented here: https://developers.wrike.com/overview/ . It is
straightforward HTTP REST API with Bearer token authentication.

## Generating access token

First get a Wrike account, you can get a trial here: Register for trial: https://www.wrike.com/free-trial/

To generate a token:

1. Navigate to the ‘API apps’ section.
2. Select the required application from the list.
3. Click ‘Configure’.
4. Click ‘Obtain token’ in the “Permanent access token” section.
5. You will see a pop-up with a warning about using the permanent token, and after confirming, you will be able to copy and paste it into a secure storage (Wrike will not display it again). If your permanent token gets lost, you should generate a new one.

Auth is done by TokenAuthenticator.

## Implementation details

I wrote a longer blog post on the implementation details: https://medium.com/starschema-blog/extending-airbyte-creating-a-source-connector-for-wrike-8e6c1337365a

In a nutshell:
* We use only GET methods, all endpoints are straightforward. We emit what we receive as HTTP response.
* The `comments` endpoint is the only trick one: it allows only 7 days data to be retrieved once. Thus, the codes creates 7 days slices, starting from start replication date.
* It uses cursor based pagination. If you provide the next_page_token then no other parameters needed, the API will assume all parameters from the first page.

9 changes: 9 additions & 0 deletions airbyte-integrations/connectors/source-wrike/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_wrike'
}
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,14 @@
#
# 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."""
yield
Loading

0 comments on commit a61ac9f

Please sign in to comment.