-
Notifications
You must be signed in to change notification settings - Fork 4.6k
🎉 New Source: Hibob #43336
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
Merged
Merged
🎉 New Source: Hibob #43336
Changes from all commits
Commits
Show all changes
14 commits
Select commit
Hold shift + click to select a range
b09ff6e
feat: new source Hibob
sajarin 571c397
docs: update changelog with PR number
sajarin 1f25ea9
Merge branch 'master' into hibob-low-code
sajarin 80c75a4
chore: address review comments
sajarin 0927014
Merge branch 'master' into hibob-low-code
sajarin 3e378cf
Merge branch 'hibob-low-code' of https://github.com/sajarin/airbyte i…
sajarin 5c7417a
format: python files and remove init.py
sajarin 76b09ab
fix: correct connector base image string for metadata.yaml
sajarin ae4cba2
format: run prettier and isort on files
sajarin fcad522
Update airbyte-integrations/connectors/source-hibob/README.md
natikgadzhi af3a4f2
Update airbyte-integrations/connectors/source-hibob/metadata.yaml
natikgadzhi 8919209
Merge branch 'master' into hibob-low-code
natikgadzhi a28fc83
Update airbyte-integrations/connectors/source-hibob/metadata.yaml
natikgadzhi cd80ad6
Update airbyte-integrations/connectors/source-hibob/metadata.yaml
natikgadzhi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,97 @@ | ||
# Hibob Source | ||
|
||
This is the repository for the Hibob configuration based source connector. | ||
For information about how to use this connector within Airbyte, see [the documentation](https://docs.airbyte.com/integrations/sources/hibob). | ||
|
||
## Local development | ||
|
||
### Prerequisites | ||
|
||
- Python (`^3.10`) | ||
- Poetry (`^1.7`) - installation instructions [here](https://python-poetry.org/docs/#installation) | ||
|
||
### Installing the connector | ||
|
||
From this connector directory, run: | ||
|
||
```bash | ||
poetry install --with dev | ||
``` | ||
|
||
### Create credentials | ||
|
||
**If you are a community contributor**, follow the instructions in the [documentation](https://docs.airbyte.com/integrations/sources/hibob) | ||
to generate the necessary credentials. Then create a file `secrets/config.json` conforming to the `src/source_hibob/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 `sample_files/sample_config.json` for a sample config file. | ||
|
||
### Locally running the connector | ||
|
||
``` | ||
poetry run source-hibob spec | ||
poetry run source-hibob check --config secrets/config.json | ||
poetry run source-hibob discover --config secrets/config.json | ||
poetry run source-hibob read --config secrets/config.json --catalog sample_files/configured_catalog.json | ||
``` | ||
|
||
|
||
### Building the docker image | ||
|
||
1. Install [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md) | ||
2. Run the following command to build the docker image: | ||
|
||
```bash | ||
airbyte-ci connectors --name=source-hibob build | ||
``` | ||
|
||
An image will be available on your host with the tag `airbyte/source-hibob:dev`. | ||
|
||
### Running as a docker container | ||
|
||
Then run any of the connector commands as follows: | ||
|
||
``` | ||
docker run --rm airbyte/source-hibob:dev spec | ||
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-hibob:dev check --config /secrets/config.json | ||
docker run --rm -v $(pwd)/secrets:/secrets airbyte/source-hibob:dev discover --config /secrets/config.json | ||
docker run --rm -v $(pwd)/secrets:/secrets -v $(pwd)/integration_tests:/integration_tests airbyte/source-hibob:dev read --config /secrets/config.json --catalog /integration_tests/configured_catalog.json | ||
``` | ||
|
||
### Running our CI test suite | ||
|
||
You can run our full test suite locally using [`airbyte-ci`](https://github.com/airbytehq/airbyte/blob/master/airbyte-ci/connectors/pipelines/README.md): | ||
|
||
```bash | ||
airbyte-ci connectors --name=source-hibob test | ||
``` | ||
|
||
### Customizing acceptance Tests | ||
|
||
Customize `acceptance-test-config.yml` file to configure acceptance tests. See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-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. | ||
|
||
### Dependency Management | ||
|
||
All of your dependencies should be managed via Poetry. | ||
To add a new dependency, run: | ||
|
||
```bash | ||
poetry add <package-name> | ||
``` | ||
|
||
Please commit the changes to `pyproject.toml` and `poetry.lock` files. | ||
|
||
## 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 our test suite: `airbyte-ci connectors --name=source-hibob test` | ||
2. Bump the connector version (please follow [semantic versioning for connectors](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#semantic-versioning-for-connectors)): | ||
- bump the `dockerImageTag` value in in `metadata.yaml` | ||
- bump the `version` value in `pyproject.toml` | ||
3. Make sure the `metadata.yaml` content is up to date. | ||
4. Make sure the connector documentation and its changelog is up to date (`docs/integrations/sources/hibob.md`). | ||
5. Create a Pull Request: use [our PR naming conventions](https://docs.airbyte.com/contributing-to-airbyte/resources/pull-requests-handbook/#pull-request-title-convention). | ||
6. Pat yourself on the back for being an awesome contributor. | ||
7. Someone from Airbyte will take a look at your PR and iterate with you to merge it into master. | ||
8. Once your PR is merged, the new version of the connector will be automatically published to Docker Hub and our connector registry. |
27 changes: 27 additions & 0 deletions
27
airbyte-integrations/connectors/source-hibob/acceptance-test-config.yml
This file contains hidden or 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,27 @@ | ||
# See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference) | ||
# for more information about how to configure these tests | ||
connector_image: airbyte/source-hibob:dev | ||
acceptance_tests: | ||
spec: | ||
tests: | ||
- spec_path: "source_hibob/manifest.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: [] | ||
incremental: | ||
bypass_reason: "This connector does not implement incremental sync" | ||
full_refresh: | ||
tests: | ||
- config_path: "secrets/config.json" | ||
configured_catalog_path: "integration_tests/configured_catalog.json" |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions
22
airbyte-integrations/connectors/source-hibob/integration_tests/configured_catalog.json
This file contains hidden or 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,22 @@ | ||
{ | ||
"streams": [ | ||
{ | ||
"stream": { | ||
"name": "profiles", | ||
"json_schema": {}, | ||
"supported_sync_modes": ["full_refresh"] | ||
}, | ||
"sync_mode": "full_refresh", | ||
"destination_sync_mode": "overwrite" | ||
}, | ||
{ | ||
"stream": { | ||
"name": "payroll", | ||
"json_schema": {}, | ||
"supported_sync_modes": ["full_refresh"] | ||
}, | ||
"sync_mode": "full_refresh", | ||
"destination_sync_mode": "overwrite" | ||
} | ||
] | ||
} |
5 changes: 5 additions & 0 deletions
5
airbyte-integrations/connectors/source-hibob/integration_tests/invalid_config.json
This file contains hidden or 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,5 @@ | ||
{ | ||
"username": "this should not work", | ||
"password": "this shouldn't work either", | ||
"is_sandbox": true | ||
} |
5 changes: 5 additions & 0 deletions
5
airbyte-integrations/connectors/source-hibob/integration_tests/sample_config.json
This file contains hidden or 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,5 @@ | ||
{ | ||
"username": "SERVICE-xxxxx", | ||
"password": "token", | ||
"is_sandbox": true | ||
} |
This file contains hidden or 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 @@ | ||
# | ||
# Copyright (c) 2024 Airbyte, Inc., all rights reserved. | ||
# | ||
|
||
|
||
from source_hibob.run import run | ||
|
||
if __name__ == "__main__": | ||
run() |
36 changes: 36 additions & 0 deletions
36
airbyte-integrations/connectors/source-hibob/metadata.yaml
This file contains hidden or 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,36 @@ | ||
data: | ||
allowedHosts: | ||
hosts: | ||
- app.sandbox.hibob.com | ||
- app.hibob.com | ||
registries: | ||
oss: | ||
enabled: true | ||
cloud: | ||
enabled: true | ||
remoteRegistries: | ||
pypi: | ||
enabled: true | ||
packageName: airbyte-source-hibob | ||
connectorBuildOptions: | ||
# Please update to the latest version of the connector base image. | ||
# https://hub.docker.com/r/airbyte/python-connector-base | ||
# Please use the full address with sha256 hash to guarantee build reproducibility. | ||
baseImage: docker.io/airbyte/python-connector-base:2.0.0@sha256:c44839ba84406116e8ba68722a0f30e8f6e7056c726f447681bb9e9ece8bd916 | ||
connectorSubtype: api | ||
connectorType: source | ||
definitionId: 4dc991ed-3dcc-4c40-ac28-9402836709f1 | ||
dockerImageTag: 0.1.0 | ||
dockerRepository: airbyte/source-hibob | ||
githubIssueLabel: source-hibob | ||
icon: icon.svg | ||
license: MIT | ||
name: Hibob | ||
releaseDate: 2024-08-06 | ||
releaseStage: alpha | ||
supportLevel: community | ||
documentationUrl: https://docs.airbyte.com/integrations/sources/hibob | ||
tags: | ||
- language:python | ||
- cdk:low-code | ||
metadataSpecVersion: "1.0" |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.