-
Notifications
You must be signed in to change notification settings - Fork 4.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🎉 New Source: LinkedIn Pages (#13098)
* added linkedin pages source connector * fixed last source acceptance test issue and passed all * requested changes completed * fixed last source acceptance test issue and passed all * requested changes completed * added nulls to share_statistics schema * added linkedin pages source connector * solve conflict in readme * requested changes completed * fixed last source acceptance test issue and passed all * requested changes completed * added nulls to share_statistics schema * remove utg posts, page stats and other stream * remove gh file * make org_id secret * change org_id to string * rollback org_id * return org_id to integer * rollback to integrr after correct ci * correct docs * auto-bump connector version [ci skip] Co-authored-by: Jordan Scott <jscottpolevault@gmail.com> Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com> Co-authored-by: marcosmarxm <marcosmarxm@gmail.com> Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
- Loading branch information
5 people
authored
Aug 11, 2022
1 parent
6b59236
commit c6ed310
Showing
31 changed files
with
1,720 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
airbyte-integrations/connectors/source-linkedin-pages/.dockerignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| * | ||
| !Dockerfile | ||
| !main.py | ||
| !source_linkedin_pages | ||
| !setup.py | ||
| !secrets |
38 changes: 38 additions & 0 deletions
38
airbyte-integrations/connectors/source-linkedin-pages/Dockerfile
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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_linkedin_pages ./source_linkedin_pages | ||
|
|
||
| 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-linkedin-pages |
132 changes: 132 additions & 0 deletions
132
airbyte-integrations/connectors/source-linkedin-pages/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,132 @@ | ||
| # Linkedin Pages Source | ||
|
|
||
| This is the repository for the Linkedin Pages source connector, written in Python. | ||
| For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/linkedin-pages). | ||
|
|
||
| ## Local development | ||
|
|
||
| ### Prerequisites | ||
| **To iterate on this connector, make sure to complete this prerequisites section.** | ||
|
|
||
| #### Minimum Python version required `= 3.7.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-linkedin-pages:build | ||
| ``` | ||
|
|
||
| #### Create credentials | ||
| **If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.io/integrations/sources/linkedin-pages) | ||
| to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `source_linkedin_pages/spec.json` 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 linkedin-pages 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-linkedin-pages:dev | ||
| ``` | ||
|
|
||
| You can also build the connector image via Gradle: | ||
| ``` | ||
| ./gradlew :airbyte-integrations:connectors:source-linkedin-pages: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-linkedin-pages:dev spec | ||
| docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-linkedin-pages:dev check --config /secrets/config.json | ||
| docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-linkedin-pages:dev discover --config /secrets/config.json | ||
| docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-linkedin-pages: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-linkedin-pages:unitTest | ||
| ``` | ||
| To run acceptance and custom integration tests: | ||
| ``` | ||
| ./gradlew :airbyte-integrations:connectors:source-linkedin-pages: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. |
19 changes: 19 additions & 0 deletions
19
airbyte-integrations/connectors/source-linkedin-pages/acceptance-test-config.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # 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-linkedin-pages:dev | ||
| tests: | ||
| spec: | ||
| - spec_path: "source_linkedin_pages/spec.json" | ||
| 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" | ||
| full_refresh: | ||
| - config_path: "secrets/config.json" | ||
| configured_catalog_path: "integration_tests/configured_catalog.json" |
16 changes: 16 additions & 0 deletions
16
airbyte-integrations/connectors/source-linkedin-pages/acceptance-test-docker.sh
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
|
|
7 changes: 7 additions & 0 deletions
7
airbyte-integrations/connectors/source-linkedin-pages/bootstrap.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| The LinkedIn Marketing Developer Platform API can be used to pull data from LinkedIn Organizations such as company page details, follower counts, follower statistics, and all sorts of organic content data. | ||
|
|
||
| You must have a LinkedIn Developers' App created in order to request access to the <a href="https://docs.microsoft.com/en-us/linkedin/marketing/">Marketing Developer Platform API</a>. API Access approval takes up to 72 hours after submitting a ~15-question form. | ||
|
|
||
| The app also must be verified by an admin of the LinkedIn organization your app is created for. Once the app is "verified" and granted access to the Marketing Developer Platform API, you can use their easy-peasy <a href="https://www.linkedin.com/developers/tools/oauth">OAuth Token Tools</a> to generate access tokens **and** refresh tokens. | ||
|
|
||
| You can access the `client id` and `client secret` in the **Auth** tab of the app dashboard to round out all of the authorization needs you may have. |
9 changes: 9 additions & 0 deletions
9
airbyte-integrations/connectors/source-linkedin-pages/build.gradle
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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_linkedin_pages' | ||
| } |
3 changes: 3 additions & 0 deletions
3
airbyte-integrations/connectors/source-linkedin-pages/integration_tests/__init__.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # | ||
| # Copyright (c) 2021 Airbyte, Inc., all rights reserved. | ||
| # |
23 changes: 23 additions & 0 deletions
23
airbyte-integrations/connectors/source-linkedin-pages/integration_tests/abnormal_state.json
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| { | ||
| "organization_lookup": { | ||
| "lastModified": "2050-01-01" | ||
| }, | ||
| "follower_statistics": { | ||
| "lastModified": "2050-01-01" | ||
| }, | ||
| "page_statistics": { | ||
| "lastModified": "2050-01-01" | ||
| }, | ||
| "share_statistics": { | ||
| "lastModified": "2050-01-01" | ||
| }, | ||
| "shares": { | ||
| "lastModified": "2050-01-01" | ||
| }, | ||
| "total_follower_count": { | ||
| "end_date": "2050-01-01" | ||
| }, | ||
| "ugc_posts": { | ||
| "end_date": "2050-01-01" | ||
| } | ||
| } |
13 changes: 13 additions & 0 deletions
13
airbyte-integrations/connectors/source-linkedin-pages/integration_tests/acceptance.py
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| # | ||
| # 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(): | ||
| yield |
Oops, something went wrong.