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: LinkedIn Pages #13098

Merged
merged 28 commits into from
Aug 11, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
2f402fc
added linkedin pages source connector
jscottpolevault May 19, 2022
3661d7d
fixed last source acceptance test issue and passed all
jscottpolevault May 23, 2022
df6dc8b
requested changes completed
jscottpolevault May 31, 2022
7636c45
fixed last source acceptance test issue and passed all
jscottpolevault May 23, 2022
c8c1d74
requested changes completed
jscottpolevault May 31, 2022
2dfe6b1
added nulls to share_statistics schema
Jun 1, 2022
6c58038
Merge branch 'airbytehq:master' into master
jscottpolevault Jun 3, 2022
48f3776
Merge branch 'master' into master
marcosmarxm Jul 13, 2022
de46265
added linkedin pages source connector
jscottpolevault May 19, 2022
1371632
solve conflict in readme
marcosmarxm Aug 10, 2022
22250ad
requested changes completed
jscottpolevault May 31, 2022
58dba36
fixed last source acceptance test issue and passed all
jscottpolevault May 23, 2022
16a97e9
requested changes completed
jscottpolevault May 31, 2022
79f39c2
added nulls to share_statistics schema
Jun 1, 2022
98d907a
remove utg posts, page stats and other stream
marcosmarxm Aug 11, 2022
407c73a
fix schemas
marcosmarxm Aug 11, 2022
f2ef517
Merge branch 'master' into jscottpolevault/master
marcosmarxm Aug 11, 2022
7343c3e
Merge branch 'master' into master
marcosmarxm Aug 11, 2022
e953f23
remove gh file
marcosmarxm Aug 11, 2022
8043f57
make org_id secret
marcosmarxm Aug 11, 2022
3e0ea7a
change org_id to string
marcosmarxm Aug 11, 2022
6776bae
rollback org_id
marcosmarxm Aug 11, 2022
9cce626
return org_id to integer
marcosmarxm Aug 11, 2022
5707560
rollback to integrr after correct ci
marcosmarxm Aug 11, 2022
4917bd7
Merge branch 'master' into master
marcosmarxm Aug 11, 2022
f22a28f
Merge branch 'master' into master
marcosmarxm Aug 11, 2022
0f94d7c
correct docs
marcosmarxm Aug 11, 2022
f0aa68b
auto-bump connector version [ci skip]
octavia-squidington-iii Aug 11, 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
Original file line number Diff line number Diff line change
Expand Up @@ -520,6 +520,14 @@
icon: linkedin.svg
sourceType: api
releaseStage: generally_available
- name: LinkedIn Pages
sourceDefinitionId: af54297c-e8f8-4d63-a00d-a94695acc9d3
dockerRepository: airbyte/source-linkedin-pages
dockerImageTag: 0.1.0
documentationUrl: https://docs.airbyte.io/integrations/sources/linkedin-pages
icon: linkedin.svg
sourceType: api
releaseStage: alpha
- name: Linnworks
sourceDefinitionId: 7b86879e-26c5-4ef6-a5ce-2be5c7b46d1e
dockerRepository: airbyte/source-linnworks
Expand Down
78 changes: 78 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 @@ -4718,6 +4718,84 @@
- - "client_secret"
oauthFlowOutputParameters:
- - "refresh_token"
- dockerImage: "airbyte/source-linkedin-pages:0.1.0"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/sources/linkedin-pages/"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "Linkedin Pages Spec"
type: "object"
required:
- "org_id"
additionalProperties: true
properties:
org_id:
title: "Organization ID"
type: "integer"
airbyte_secret: true
description: "Specify the Organization ID"
examples:
- "123456789"
credentials:
title: "Authentication *"
type: "object"
oneOf:
- type: "object"
title: "OAuth2.0"
required:
- "client_id"
- "client_secret"
- "refresh_token"
properties:
auth_method:
type: "string"
const: "oAuth2.0"
client_id:
type: "string"
title: "Client ID"
description: "The client ID of the LinkedIn developer application."
airbyte_secret: true
client_secret:
type: "string"
title: "Client secret"
description: "The client secret of the LinkedIn developer application."
airbyte_secret: true
refresh_token:
type: "string"
title: "Refresh token"
description: "The token value generated using the LinkedIn Developers\
\ OAuth Token Tools. See the <a href=\"https://docs.airbyte.com/integrations/sources/linkedin-pages/\"\
>docs</a> to obtain yours."
airbyte_secret: true
- title: "Access token"
type: "object"
required:
- "access_token"
properties:
auth_method:
type: "string"
const: "access_token"
access_token:
type: "string"
title: "Access token"
description: "The token value generated using the LinkedIn Developers\
\ OAuth Token Tools. See the <a href=\"https://docs.airbyte.com/integrations/sources/linkedin-pages/\"\
>docs</a> to obtain yours."
airbyte_secret: true
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes: []
authSpecification:
auth_type: "oauth2.0"
oauth2Specification:
rootObject:
- "credentials"
- "0"
oauthFlowInitParameters:
- - "client_id"
- - "client_secret"
oauthFlowOutputParameters:
- - "refresh_token"
- dockerImage: "airbyte/source-linnworks:0.1.5"
spec:
documentationUrl: "https://docs.airbyte.io/integrations/sources/linnworks"
Expand Down
1 change: 1 addition & 0 deletions airbyte-integrations/builds.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@
| Iterable | [![source-iterable](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-iterable%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-iterable) |
| Jira | [![source-jira](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-jira%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-jira) |
| LinkedIn Ads | [![source-linkedin-ads](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-linkedin-ads%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-linkedin-ads) |
| LinkedIn Pages | [![source-linkedin-ads](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-linkedin-ads%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-linkedin-pages) |
| Linnworks | [![source-linnworks](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-linnworks%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-linnworks) |
| Lever Hiring | [![source-lever-hiring](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-lever-hiring%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-lever-hiring) |
| Looker | [![source-looker](https://img.shields.io/endpoint?url=https%3A%2F%2Fdnsgjos7lj2fu.cloudfront.net%2Ftests%2Fsummary%2Fsource-looker%2Fbadge.json)](https://dnsgjos7lj2fu.cloudfront.net/tests/summary/source-looker) |
Expand Down
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 airbyte-integrations/connectors/source-linkedin-pages/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_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 airbyte-integrations/connectors/source-linkedin-pages/README.md
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.
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"
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

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.
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'
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
#
# Copyright (c) 2021 Airbyte, Inc., all rights reserved.
#
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"
}
}
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
Loading