Skip to content
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

🎉 New Source: Vitally [low-code cdk] #18545

Merged

Conversation

elliottrabac
Copy link
Contributor

@elliottrabac elliottrabac commented Oct 27, 2022

What

Describe what the change is solving
It helps to add screenshots if it affects the frontend.

Hacktoberfest: airbytehq/connector-contest#194

How

Describe the solution

Recommended reading order

  1. x.java
  2. y.python

🚨 User Impact 🚨

Are there any breaking changes? What is the end result perceived by the user? If yes, please merge this PR with the 🚨🚨 emoji so changelog authors can further highlight this if needed.

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
Updating a connector

Community member or Airbyter

  • 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
    • Changelog updated in docs/integrations/<source or destination>/<name>.md including changelog. See changelog example
  • 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 and connector version bumped by running the /publish command described here
Connector Generator
  • Issue acceptance criteria met
  • PR name follows PR naming conventions
  • If adding a new generator, add it to the list of scaffold modules being tested
  • The generator test modules (all connectors with -scaffold in their name) have been updated with the latest scaffold by running ./gradlew :airbyte-integrations:connector-templates:generator:testScaffoldTemplates then checking in your changes
  • Documentation which references the generator is updated as needed

Tests

Unit

Put your unit tests output here.

Integration

Put your integration tests output here.

Acceptance

Put your acceptance tests output here.

@github-actions github-actions bot added area/connectors Connector related issues area/documentation Improvements or additions to documentation labels Oct 27, 2022
@harshithmullapudi
Copy link
Contributor

Hey hi thanks a lot for the contribution. Do let us know when you are ready with the PR we can review it.

@elliottrabac
Copy link
Contributor Author

Hey hi thanks a lot for the contribution. Do let us know when you are ready with the PR we can review it.

Sure, should be good soon.

@elliottrabac elliottrabac marked this pull request as ready for review October 31, 2022 00:59
@elliottrabac
Copy link
Contributor Author

@harshithmullapudi

@marcosmarxm
Copy link
Member

@elliottrabac would be possible to share with me a test account credentials in Slack?

Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the contribution, a small comment and it is ready to go 🚢

Comment on lines +39 to +51
accounts_stream:
$ref: "*ref(definitions.base_stream)"
$options:
name: "accounts"
primary_key: "id"
path: "/accounts"
retriever:
$ref: "*ref(definitions.base_stream.retriever)"
requester:
$ref: "*ref(definitions.requester)"
request_options_provider:
request_parameters:
status: "{{ config['status'] }}"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a stream needs a special request parameter and the only one not tested. Can you try to add data to this stream?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My bad, I already have data in this stream.

Unfortunately, I don't have any test account here as well and no free trial is available :/

Let me record a video to showcase the output.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Acceptance test:
Screenshot 2022-11-01 at 19 06 33

Check:
Screenshot 2022-11-01 at 19 07 10

Read w/ status = churned:
Screenshot 2022-11-01 at 19 16 09

Read w/ status = active:
Screenshot 2022-11-01 at 19 18 34

Read w/ status = activeOrChurned:
Screenshot 2022-11-01 at 19 26 40

Copy link
Member

@marcosmarxm marcosmarxm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @elliottrabac I'll publish later this week.

@marcosmarxm
Copy link
Member

marcosmarxm commented Nov 4, 2022

Hello! Your PR is approved but didn't have the time to publish and merge it this week. As you can check in Chris' comment all PRs submitted before 2-nov are eligible to win the prize. I'll be out of the office on Friday and return Monday to start publishing your contribution. Any question you can send a message in #hacktoberfest-2022 channel in Airbyte's Slack.

Have a good weekend and thank you for this amazing contribution for Hacktoberfest 🎉

@marcosmarxm
Copy link
Member

marcosmarxm commented Nov 13, 2022

/publish connector=connectors/source-vitally run-tests=false

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


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

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

@marcosmarxm marcosmarxm merged commit b5fd338 into airbytehq:master Nov 14, 2022
@marcosmarxm marcosmarxm changed the title 🎉 New Source: Vitally 🎉 New Source: Vitally [low-code cdk] Nov 18, 2022
akashkulk pushed a commit that referenced this pull request Dec 2, 2022
* create source boilerplate

* add account filter

* add enum list

* add documentation

* edit doc url

* add organizations stream

* update PR number

* update tests

* add vitally to source def

* auto-bump connector version

Co-authored-by: marcosmarxm <marcosmarxm@gmail.com>
Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com>
Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
@sajarin sajarin added internal and removed bounty labels Dec 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants