🎉 New Source: Punk API [low-code cdk] #18724

btkcodedev · 2022-10-31T17:32:13Z

What

Developing new connector for the source: Punk API
New data source will be definitely useful for destinations seeking training data

Resolves:
🎉 New Source: Punk API

How

Developed using low-code cdk

🚨 User Impact 🚨

No breaking changes, Just addition of new source

New Connector: Source Punk API

Community member or Airbyter

Tests

Integration & Acceptance

Full Test Results

marcosmarxm · 2022-10-31T19:55:53Z

Hello @btkcodedev, 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 · 2022-11-02T19:23:14Z

@btkcodedev please request my review when you solved all points I commented in my previous comment.

marcosmarxm · 2022-11-04T08:50:24Z

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!

btkcodedev · 2022-11-04T15:07:33Z

@sh4sh @marcosmarxm All comments resolved.
Community Review Required :)

btkcodedev · 2022-11-05T05:07:29Z

@sh4sh Also please let me know whether any further changes are required.

marcosmarxm

Some comments.

airbyte-integrations/connectors/source-punk-api/source_punk_api/punk_api.yaml

marcosmarxm · 2022-11-08T00:30:04Z

airbyte-integrations/connectors/source-punk-api/source_punk_api/punk_api.yaml

+  base_stream:
+    schema_loader:
+      type: JsonSchema
+      file_path: "./source_punk_api/schemas/{{ options['name'] }}.json"
+    retriever:
+      $ref: "*ref(definitions.retriever)"


The API allows using before and after parameters, this allow to implement incremental syncs. Please check the DateStreamSlicer component.

marcosmarxm · 2022-11-14T13:47:44Z

@btkcodedev I'll review your PR today.

marcosmarxm

Thanks @btkcodedev

CLAassistant · 2022-11-16T16:46:52Z

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you all sign our Contributor License Agreement before we can accept your contribution.
1 out of 2 committers have signed the CLA.

✅ marcosmarxm
❌ bthecoderdev
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

marcosmarxm · 2022-11-16T17:07:17Z

/test connector=connectors/source-punk-api

🕑 connectors/source-punk-api https://github.com/airbytehq/airbyte/actions/runs/3481500676
✅ connectors/source-punk-api https://github.com/airbytehq/airbyte/actions/runs/3481500676
Python tests coverage:

	 Name                                                 Stmts   Miss  Cover   Missing
	 ----------------------------------------------------------------------------------
	 source_acceptance_test/base.py                          12      4    67%   16-19
	 source_acceptance_test/config.py                       139      5    96%   87, 93, 235, 239-240
	 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              398    111    72%   53, 58, 87-95, 100-107, 111-112, 116-117, 299, 337-354, 363-371, 375-380, 386, 419-424, 462-469, 512-514, 517, 582-590, 602-605, 610, 666-667, 673, 676, 712-722, 735-760
	 source_acceptance_test/tests/test_incremental.py       158     14    91%   52-59, 64-77, 240
	 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/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     107     13    88%   30-31, 38, 41, 65-68, 96, 120, 192-194
	 ----------------------------------------------------------------------------------
	 TOTAL                                                 1563    349    78%

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: not found in the config.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/tests/test_core.py:88: The previous connector image could not be retrieved.
SKIPPED [1] ../usr/local/lib/python3.9/site-packages/source_acceptance_test/tests/test_core.py:364: The previous connector image could not be retrieved.
======================== 26 passed, 3 skipped in 41.86s ========================

marcosmarxm · 2022-11-16T17:29:32Z

/publish connector=connectors/source-punk-api

🕑 Publishing the following connectors:
connectors/source-punk-api
https://github.com/airbytehq/airbyte/actions/runs/3481665338

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

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

btkcodedev · 2022-11-17T05:56:06Z

Oh man! Thank you so much @marcosmarxm

* New source: punkapi * chore: Added docs, fix: Streams, Test: Pass * chore: Add doc URL * All comments resolved * Resolve Merge conflicts * Resolve Merge conflicts * feat: Added paginator, Introduced request params * feat: fixed paginator * add punk api to source def * update sample file * rebase * auto-bump connector version Co-authored-by: btkcodedev <btk.codedev@gmail.com> Co-authored-by: marcosmarxm <marcosmarxm@gmail.com> Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>

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

octavia-squidington-iv added bounty community connectors/source/punk-api labels Oct 31, 2022

marcosmarxm added the hacktober label Oct 31, 2022

marcosmarxm assigned sh4sh Nov 4, 2022

marcosmarxm requested changes Nov 8, 2022

View reviewed changes

btkcodedev requested a review from marcosmarxm November 10, 2022 16:47

marcosmarxm approved these changes Nov 16, 2022

View reviewed changes

btkcodedev and others added 11 commits November 16, 2022 13:47

New source: punkapi

3e0d6d5

chore: Added docs, fix: Streams, Test: Pass

26284d2

chore: Add doc URL

db842fb

All comments resolved

d2a73e6

Resolve Merge conflicts

72cf07b

Resolve Merge conflicts

0b0dd83

feat: Added paginator, Introduced request params

890bc1b

feat: fixed paginator

75a659e

add punk api to source def

23a3af4

update sample file

3fb41c8

rebase

030c39a

marcosmarxm force-pushed the punkapi branch from 636cab0 to 030c39a Compare November 16, 2022 16:48

marcosmarxm approved these changes Nov 16, 2022

View reviewed changes

auto-bump connector version

ee5bf36

marcosmarxm merged commit 8e9eaa8 into airbytehq:master Nov 16, 2022

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

Bump helm chart version reference to 0.40.44 #19546

Merged

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

Bump Airbyte version from 0.40.18 to 0.40.19 #19579

Merged

sajarin added internal and removed bounty labels Dec 5, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

🎉 New Source: Punk API [low-code cdk] #18724

🎉 New Source: Punk API [low-code cdk] #18724

btkcodedev commented Oct 31, 2022 •

edited

Loading

marcosmarxm commented Oct 31, 2022

marcosmarxm commented Nov 2, 2022

marcosmarxm commented Nov 4, 2022

btkcodedev commented Nov 4, 2022

btkcodedev commented Nov 5, 2022

marcosmarxm left a comment

marcosmarxm Nov 8, 2022

marcosmarxm commented Nov 14, 2022

marcosmarxm left a comment

CLAassistant commented Nov 16, 2022

marcosmarxm commented Nov 16, 2022 •

edited by github-actions bot

Loading

marcosmarxm commented Nov 16, 2022 •

edited by github-actions bot

Loading

btkcodedev commented Nov 17, 2022

🎉 New Source: Punk API [low-code cdk] #18724

🎉 New Source: Punk API [low-code cdk] #18724

Conversation

btkcodedev commented Oct 31, 2022 • edited Loading

What

How

Recommended reading order

🚨 User Impact 🚨

Community member or Airbyter

Tests

marcosmarxm commented Oct 31, 2022

marcosmarxm commented Nov 2, 2022

marcosmarxm commented Nov 4, 2022

btkcodedev commented Nov 4, 2022

btkcodedev commented Nov 5, 2022

marcosmarxm left a comment

Choose a reason for hiding this comment

marcosmarxm Nov 8, 2022

Choose a reason for hiding this comment

marcosmarxm commented Nov 14, 2022

marcosmarxm left a comment

Choose a reason for hiding this comment

CLAassistant commented Nov 16, 2022

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

Build Passed

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

btkcodedev commented Nov 17, 2022

btkcodedev commented Oct 31, 2022 •

edited

Loading

marcosmarxm commented Nov 16, 2022 •

edited by github-actions bot

Loading

marcosmarxm commented Nov 16, 2022 •

edited by github-actions bot

Loading