🎉 New Source - Recruitee [low-code SDK] #18671

delenamalan · 2022-10-30T19:58:01Z

What

Add new source for Recruitee to close airbytehq/connector-contest#203.

API docs: https://docs.recruitee.com/reference/getting-started

Pre-merge Checklist

New Connector

Community member or Airbyter

Airbyter

If this is a community PR, the Airbyte engineer reviewing this PR is responsible for the below items.

Create a non-forked branch based on this PR and test the below items on it
Build is successful
If new credentials are required for use in CI, add them to GSM. Instructions.
/test connector=connectors/<name> command is passing
New Connector version released on Dockerhub by running the /publish command described here
After the connector is published, connector added to connector index as described here
Seed specs have been re-generated by building the platform and committing the changes to the seed spec files, as described here

Tests

Acceptance tests:

marcosmarxm

Hello @delenamalan, Marcos from Airbyte here 👋 . We received more than 25 new contributions along the weekend. One is yours 🎉 thank so much for! Our team is limited and maybe the review process can take longer than expected. As described in the Airbyte's Hacktoberfest your contribution was submitted before November 2nd and it is eligible to win the prize. The review process will validate other requirements. I ask to you patience until someone from the team review it.

Because I reviewed some contributions for Hacktoberfest so far I saw some common patterns you can check in advance:

Make sure you have added connector documentation to /docs/integrations/
Remove the file catalog from /integration_tests
Edit the sample_config.json inside /integration_tests
For the configured_catalog you can use only json_schema: {}
Add title to all properties in the spec.yaml
Make sure the documentationUrl in the spec.yaml redirect to Airbyte's future connector page, eg: connector Airtable the documentationUrl: https://docs.airbyte.com/integrations/sources/airtable
Review now new line at EOF (end-of-file) for all files.

If possible send to me a DM in Slack with the tests credentials, this process will make easier to us run integration tests and publish your connector. If you only has production keys, make sure to create a bootstrap.md explaining how to get the keys.

marcosmarxm

The connector looks solid, just make sure to correct all points from my previous comment.

marcosmarxm · 2022-10-31T22:46:59Z

@delenamalan please request my review after all points are solved.

delenamalan · 2022-11-01T12:50:55Z

Thanks @marcosmarxm, updated now :)

Make sure you have added connector documentation to /docs/integrations/
Remove the file catalog from /integration_tests
Edit the sample_config.json inside /integration_tests
For the configured_catalog you can use only json_schema: {}
Add title to all properties in the spec.yaml
Make sure the documentationUrl in the spec.yaml redirect to Airbyte's future connector page, eg: connector Airtable the documentationUrl: https://docs.airbyte.com/integrations/sources/airtable
Review now new line at EOF (end-of-file) for all files.

marcosmarxm

The connector works! Some commments to improve it.

marcosmarxm · 2022-11-02T13:49:51Z

airbyte-integrations/connectors/source-recruitee/source_recruitee/recruitee.yaml

+    paginator:
+      type: NoPagination


@delenamalan the paginator it is missing.

The offers and departments endpoints don't have any pagination mechanisms available. The candidates one does, but if you don't pass a limit or offset to it, all candidates will get returned.

I think pagination is more important than the incremental because no pagination will lead to bad data to the sync.

What do you mean with bad data? The endpoints return all of the data in a single response.

marcosmarxm · 2022-11-02T13:50:01Z

airbyte-integrations/connectors/source-recruitee/source_recruitee/recruitee.yaml

+  candidates_stream:
+    # Docs: https://docs.recruitee.com/reference/candidates-get
+    $ref: "*ref(definitions.base_stream)"
+    $options:
+      name: "candidates"
+      path: "/candidates"


The candidates allows to use filtering parameters with dates, this allows to create a start_date spec parameter and use icnremental syncs. What do you think about it?

I don't feel like it's a priority to add it since most companies likely won't have tons and tons of candidates? But if it's a requirement from Airbyte, I can work on it.

It would be a nice feature, not a must but a nice one :)

Make sense :) I'll only be able to work on it from 16 November again. Would it be possible to merge this PR without the incremental syncs and then I can add it later?

marcosmarxm · 2022-11-04T08:51:45Z

Hello! I'm going to be out of the office this Friday and won't be able to review your contribution again today, I return next Monday. So far, most contributions look solid and are almost done to be approved. As said in Chris' comment all contributions made before 2-November are eligible to receive the prize and have 2 weeks to merge the contributions. But I ensure next week we're going to have your contribution merged. If you have questions about the implementation you can send them in #hacktoberfest-2022 in Airbyte's Slack.

Sorry the inconvenience and see you again next week, thank you so much for your contribution!

marcosmarxm · 2022-11-08T01:10:57Z

/test connector=connectors/source-recruitee

🕑 connectors/source-recruitee https://github.com/airbytehq/airbyte/actions/runs/3415491724
✅ connectors/source-recruitee https://github.com/airbytehq/airbyte/actions/runs/3415491724
Python tests coverage:

	 Name                                                 Stmts   Miss  Cover   Missing
	 ----------------------------------------------------------------------------------
	 source_acceptance_test/base.py                          12      4    67%   16-19
	 source_acceptance_test/config.py                       133      3    98%   87, 93, 230
	 source_acceptance_test/conftest.py                     196     92    53%   35, 41-43, 48, 54, 60, 66, 72-74, 93, 98-100, 106-108, 114-115, 120-121, 126, 132, 141-150, 156-161, 176, 200, 231, 237, 243-248, 256-261, 269-282, 287-293, 300-311, 318-334
	 source_acceptance_test/plugin.py                        69     25    64%   22-23, 31, 36, 120-140, 144-148
	 source_acceptance_test/tests/test_core.py              345    110    68%   53, 64-72, 77-84, 88-89, 93-94, 178, 216-233, 242-250, 254-259, 265, 298-303, 341-348, 391-393, 396, 461-469, 481-484, 489, 545-546, 552, 555, 591-601, 614-639
	 source_acceptance_test/tests/test_incremental.py       145     20    86%   21-23, 29-31, 36-43, 48-61, 224
	 source_acceptance_test/utils/asserts.py                 37      2    95%   57-58
	 source_acceptance_test/utils/common.py                  94     10    89%   16-17, 32-38, 72, 75
	 source_acceptance_test/utils/compare.py                 62     23    63%   21-51, 68, 97-99
	 source_acceptance_test/utils/config_migration.py        23     23     0%   5-37
	 source_acceptance_test/utils/connector_runner.py       112     50    55%   23-26, 32, 36, 39-68, 71-73, 76-78, 81-83, 86-88, 91-93, 96-114, 148-150
	 source_acceptance_test/utils/json_schema_helper.py     105     13    88%   30-31, 38, 41, 65-68, 96, 120, 190-192
	 ----------------------------------------------------------------------------------
	 TOTAL                                                 1512    375    75%

Build Passed

Test summary info:

=========================== short test summary info ============================
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/plugin.py:63: Skipping TestIncremental.test_two_sequential_reads: This connector does not implement incremental sync
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/tests/test_core.py:65: The previous connector image could not be retrieved.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/tests/test_core.py:243: The previous connector image could not be retrieved.
======================== 24 passed, 3 skipped in 22.88s ========================

marcosmarxm · 2022-11-08T01:24:35Z

/publish connector=connectors/source-recruitee

🕑 Publishing the following connectors:
connectors/source-recruitee
https://github.com/airbytehq/airbyte/actions/runs/3415565937

Connector	Did it publish?	Were definitions generated?
connectors/source-recruitee	✅	✅

if you have connectors that successfully published but failed definition generation, follow step 4 here ▶️

marcosmarxm

Thanks @delenamalan

…nent * master: 🪟 🎉 Enable frontend validation for <1hr syncs (cloud) #19028 Stream returns AirbyteMessages (#18572) 🎉 New Source - Recruitee [low-code SDK] (#18671) 🎉 New source: Breezometer [low-code cdk] (#18650) Check disabled connections after protocol update (#18990) Simple default replication worker refactor (#19002) 🎉 New Source: Visma e-conomic (#18595) 🎉 New Source: Fastbill (#18593) Bmoric/extract state api (#18980) 🎉 New Source: Zapier Supported Storage (#18442) 🎉 New source: Klarna (#18385) `AirbyteEstimateTraceMessage` (#18875) Extract source definition api (#18977) [low-code cdk] Allow for spec file to be defined in the yaml manifest instead of an external file (#18411) 🐛 Source HubSpot: fix property scopes (#18624) Ensure that only 6-character hex values are passed to monaco editor (#18943)

github-actions bot added area/connectors Connector related issues area/documentation Improvements or additions to documentation labels Oct 30, 2022

octavia-squidington-iv added bounty community connectors/source/recruitee labels Oct 30, 2022

marcosmarxm added the hacktober label Oct 30, 2022

marcosmarxm requested changes Oct 31, 2022

View reviewed changes

marcosmarxm reviewed Oct 31, 2022

View reviewed changes

marcosmarxm requested changes Nov 2, 2022

View reviewed changes

marcosmarxm assigned natalyjazzviolin Nov 4, 2022

delenamalan and others added 15 commits November 7, 2022 22:11

Generate source

4b093c2

Add candidates stream

8d6a5d1

Fix docs

32c5a8b

Add offers stream

e1dc5e4

Fix schema

eed6139

Use a single primary_key field

3832ce5

Add departments stream

d6dcda9

Add sample state

25a7a58

Fix company ID number

a15a707

Update PR number

480793d

Update configured catalog

12cff32

Fix schema

a3b65f3

Add newlines

1d0da02

Add title to properties in spec.yaml

0bff05e

run format and add recruitee to source def

1fc1592

marcosmarxm force-pushed the add-recruitee branch from 24aabad to 1fc1592 Compare November 8, 2022 01:11

marcosmarxm approved these changes Nov 8, 2022

View reviewed changes

auto-bump connector version

427958b

marcosmarxm merged commit 92c0f6f into airbytehq:master Nov 8, 2022

RealChrisSean added the low-code label Nov 15, 2022

github-actions bot mentioned this pull request Nov 15, 2022

Bump helm chart version reference to 0.40.43 #19453

Closed

octavia-squidington-iii mentioned this pull request Nov 18, 2022

Bump Airbyte version from 0.40.18 to 0.40.19 #19579

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🎉 New Source - Recruitee [low-code SDK] #18671

🎉 New Source - Recruitee [low-code SDK] #18671

delenamalan commented Oct 30, 2022

marcosmarxm left a comment

marcosmarxm left a comment

marcosmarxm commented Oct 31, 2022

delenamalan commented Nov 1, 2022

marcosmarxm left a comment

marcosmarxm Nov 2, 2022

delenamalan Nov 2, 2022

marcosmarxm Nov 2, 2022

delenamalan Nov 3, 2022

marcosmarxm Nov 2, 2022

delenamalan Nov 2, 2022

marcosmarxm Nov 2, 2022

delenamalan Nov 7, 2022

marcosmarxm commented Nov 4, 2022

marcosmarxm commented Nov 8, 2022 •

edited by github-actions bot

Loading

marcosmarxm commented Nov 8, 2022 •

edited by github-actions bot

Loading

marcosmarxm left a comment

🎉 New Source - Recruitee [low-code SDK] #18671

🎉 New Source - Recruitee [low-code SDK] #18671

Conversation

delenamalan commented Oct 30, 2022

What

Pre-merge Checklist

Community member or Airbyter

Airbyter

Tests

marcosmarxm left a comment

Choose a reason for hiding this comment

marcosmarxm left a comment

Choose a reason for hiding this comment

marcosmarxm commented Oct 31, 2022

delenamalan commented Nov 1, 2022

marcosmarxm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

marcosmarxm commented Nov 4, 2022

marcosmarxm commented Nov 8, 2022 • edited by github-actions bot Loading

Build Passed

marcosmarxm commented Nov 8, 2022 • edited by github-actions bot Loading

marcosmarxm left a comment

Choose a reason for hiding this comment

marcosmarxm commented Nov 8, 2022 •

edited by github-actions bot

Loading

marcosmarxm commented Nov 8, 2022 •

edited by github-actions bot

Loading