🎉 New Source: EmailOctopus [low-code cdk]

[scottleechua]

What

This PR adds a source connector for EmailOctopus. Please see this issue for more context.

How

This PR uses the low-code CDK to create a source connector for the critical streams:

• Get all lists
• Get all campaigns

Recommended reading order

1. docs/integrations/sources/emailoctopus.md
2. spec.yaml
3. emailoctopus.yaml
4. schemas/campaigns.json and schemas/lists.json

🚨 User Impact 🚨

No changes to base code.

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

• Community member? Grant edit access to maintainers (instructions)
• Secrets in the connector's spec are annotated with airbyte_secret
• Unit & integration tests added and passing. Community members, please provide proof of success locally e.g: screenshot or copy-paste unit, integration, and acceptance test output. To run acceptance tests for a Python connector, follow instructions in the README. For java connectors run ./gradlew :airbyte-integrations:connectors:<name>:integrationTest.
• Code reviews completed
• Documentation updated
  • Connector's README.md
  • Connector's bootstrap.md. See description and examples
  • docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • docs/integrations/README.md
  • airbyte-integrations/builds.md
• PR name follows PR naming conventions

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

[CLAassistant]

All committers have signed the CLA.

[marcosmarxm]

Hello @scottleechua, 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]

@scottleechua please ask my review when you solve all points I have made in my previous comment.

[marcosmarxm]

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!

[scottleechua]

Hello @marcosmarxm , @sajarin !

• Make sure you have added connector documentation to /docs/integrations/
  -- Added emailoctopus.md and linked to it in the integration README.
• 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
  -- Updated.
• Make sure the documentationUrl in the spec.yaml redirect to Airbyte's future connector page
  -- Updated top-level domain from airbyte.io to airbyte.com
• Review no new line at EOF (end-of-file) for all files.
• Added BOOTSTRAP.md with instructions on generating an API key.
  -- My production account contain subscriber personal information so I unfortunately can't share it...

Also am not sure why the acceptance tests run by @koconder failed as test_core and test_full_refresh both run successfully on my local -- let me know if I can do anything about this!

Thank you! 😄

[vincentkoc]

@scottleechua ignore the earlier test results from my side. They did have test credentials setup. Appologies for the confusion caused.

[scottleechua]

Ah, got it! All good @koconder 😄

[marcosmarxm]

Thanks @scottleechua I'm waiting EmailOctopus approve my account to test your connector. I'll return the review tomorrow.

[marcosmarxm]

Thanks @scottleechua for the contribution

[marcosmarxm]

/test connector=connectors/source-emailoctopus

🕑 connectors/source-emailoctopus https://github.com/airbytehq/airbyte/actions/runs/3422575227
✅ connectors/source-emailoctopus https://github.com/airbytehq/airbyte/actions/runs/3422575227
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 25.56s ========================

[marcosmarxm]

/publish connector=connectors/source-emailoctopus

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

Connector	Did it publish?	Were definitions generated?
connectors/source-emailoctopus	❌	❌

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

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

[marcosmarxm]

/publish connector=connectors/source-emailoctopus

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

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

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