:tada: New Source: Help Scout

[evwltrs]

What

A new source for help scout created using the Low Code CDK Closes #2973

Pre-merge Checklist

Expand the relevant checklist and delete the others.

New Connector

Community member or Airbyter

• [x] 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
• [x] 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

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

[hantmac]

@evwltrs Hi bro, are u woking on this pr?

[evwltrs]

@evwltrs Hi bro, are u woking on this pr?

yep

[sh4sh]

Very exciting 🎉 tag me if you have any questions and when you're ready for review!

[PeerRich]

will this include ratings?

[evwltrs]

will this include ratings?

yes, we were having issues finding a way to get a rating ID to test the endpoint but we found it so I should be able to finish the connector and push it tonight providing no tech issues

[evwltrs]

waiting for Help Scout support to sort out my trial.... they said they had extended it until the 16th but I attempted to log in today and it's expired apprently. @misteryeo if you could look into getting Airbyte a permanent testing account that would be useful for the future 👍

[misteryeo]

@evwltrs created an issue for the team to get the sandbox: https://github.com/airbytehq/airbyte/issues/22686. @YowanR can help shepherd the creation of the sandbox!

[evwltrs]

TODO: Documentation

[evwltrs]

Hi @sherifnada Thanks for the review (wading through the giant monolithic connector builder outputs must be a pain). Do you have any idea why I'm failing the spec.yml integration test, I can't recall when I was supposed to generate/make this file. Thanks

[sherifnada]

@evwltrs gah, it's an annoyance that we will remove soon. But to unblock you, you just need to put a spec.yaml file in the directory where it's expecting it (the one where it can't find it). The file needs to match the one output by your connector when you run the spec command e.g python main.py spec

For context this made sense for python connectors but not so much for declarative connectors. But since this framework is relatively newer not every tool accounts for it yet

[evwltrs]

@sherifnada Resolved the issues, let me know if anything else needed. My help scout account expired again so can't pass all the integration tests on my end.

[danieliser]

@evwltrs I'd love to test this, have years worth of HelpScout data and a self hosted install on a local Epyc server.

If you can point me in the right direction to installing this and test procedures I'll run it through its paces.

Have full API access though I can't share it currently, would be worth it for me to pay for you to get a temporary account if you can get this done sooner..

feel free to ping me on twitter @daniel_iser or use the email in my github profile to reach out.

[misteryeo]

@evwltrs Please make sure to include documentation as part of this PR :)

[evwltrs]

Anyone for a final review?

[misteryeo]

@evwltrs Did you see my comment about incremental sync support? It looks like several of the endpoints should support this

[evwltrs]

@evwltrs Did you see my comment about incremental sync support? It looks like several of the endpoints should support this

I didn't, no. Where can I find the comment?

[evwltrs]

@sherifnada Could I also be invited to the Help Scout account on Lastpass please 🙏. I am unable to work on the connector as my account expired...

[sherifnada]

@YowanR could you help on that?

[evwltrs]

@YowanR could you help on that?

still waiting on this 😬

[evwltrs]

Anyone?

[marcosmarxm]

@evwltrs sorry the missing reply here. Can you send me a Slack message to solve this issue?

[marcosmarxm]

@evwltrs sorry the long delay here. @sh4sh can you reach out Evans and help finishing this contributor-program contribution?

[evwltrs]

Ok, back on working on this today, apologies for the really long delay, hopefully everything is still valid. Reducing the amount of user settings and adding incremental sync.

[marcosmarxm]

@evwltrs ping me if you need any pending assistance

[jrolom]

hi @evwltrs - are you still planning to work on this?

[evwltrs]

hi @jrolom yes! I am definitely still working on it. I just completely forgot :pensive: I am going to try and figure out incremental syncs tonight.

Thanks

[evwltrs]

Is the bounty still valid or have I left it too long?

[jrolom]

Hi @evwltrs ! yeah, it's still valid, it would be unfair if we changed it half way through your contribution.

[jrolom]

Hey @evwltrs ! Will you be working on this?

[marcosmarxm]

I'm going to close due inactivity. @evwltrs please let us know if you want to continue this work so I can reopen it.