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: Zenefits #14809

Merged
merged 14 commits into from
Sep 22, 2022
Merged

🎉New Source: Zenefits #14809

merged 14 commits into from
Sep 22, 2022

Conversation

makyash
Copy link
Contributor

@makyash makyash commented Jul 18, 2022

What

Describe what the change is solving
Hello Team,

We at Pliancy, have created this python custom connector, that interacts with the API and pulls the data from the source. This connector helps in time tracking and is used by many companies like ours. Everything is explained properly on how to work this connector locally as well in the readme.md file.

It helps to add screenshots if it affects the frontend.

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)
  • 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
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.
Screen Shot 2022-07-08 at 3 50 40 PM

Screen Shot 2022-07-08 at 3 51 05 PM
Integration

Put your integration tests output here.
Screen Shot 2022-07-18 at 2 29 48 PM

Acceptance

Put your acceptance tests output here.
Screen Shot 2022-07-15 at 6 18 41 PM

@github-actions github-actions bot added the area/connectors Connector related issues label Jul 18, 2022
@makyash makyash changed the title New Source: Zenefits 🎉New Source: Zenefits Jul 18, 2022
@makyash
Copy link
Contributor Author

makyash commented Jul 19, 2022

here's my email: yash.makwana@pliancy.com, do reach out to me for any questions.

@harshithmullapudi harshithmullapudi self-assigned this Jul 20, 2022
@harshithmullapudi harshithmullapudi added the waiting-for-cred Waiting for CI credentials label Jul 21, 2022
@marcosmarxm
Copy link
Member

@harshithmullapudi could you review this and publish without the credentials for now?

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.

I made a few comments, sorry the long delay to review it.

@makyash
Copy link
Contributor Author

makyash commented Aug 18, 2022

@marcosmarxm I have made the necessary changes you suggested, the only thing with check_connection is I have a Bearer Token and I have to work surround that.
I ran source acceptance test again after making the changes to help speed up the process, you can find the test screenshot below

Screen Shot 2022-08-18 at 10 31 00 AM

@harshithmullapudi
Copy link
Contributor

harshithmullapudi commented Aug 24, 2022

Hey @makyash is it possible to give me access to push a commit over this repo. I have some fixes to make and a documentation to add. If not do you mind doing these

  1. Add a new record in source_definition file just after zendesk
- name: Zenefits
  sourceDefinitionId: 8baba53d-2fe3-4e33-bc85-210d0eb62884
  dockerRepository: airbyte/source-zenefits
  dockerImageTag: 0.1.0
  documentationUrl: https://docs.airbyte.io/integrations/sources/zenefits
  icon: zenefits.svg
  sourceType: api
  releaseStage: alpha
  1. Create a new file in docs/integrations/sources and name it zenefits.md and contents attached below
    zenefits.md

  2. Remove sample_files folder and then remove all TODO.md files

  3. Run ./gradlew format

@github-actions github-actions bot added the area/documentation Improvements or additions to documentation label Aug 24, 2022
@makyash
Copy link
Contributor Author

makyash commented Aug 24, 2022

@harshithmullapudi let me know, if the changes were accurate or else I will give you the access to push a commit into this repo.

@harshithmullapudi
Copy link
Contributor

Sure checking

@harshithmullapudi
Copy link
Contributor

LGTM

@github-actions github-actions bot added area/platform issues related to the platform area/protocol area/scheduler labels Sep 22, 2022
@github-actions github-actions bot removed area/api Related to the api area/platform issues related to the platform area/protocol labels Sep 22, 2022
@harshithmullapudi
Copy link
Contributor

harshithmullapudi commented Sep 22, 2022

/publish connector=connectors/source-zenefits

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


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

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

@harshithmullapudi
Copy link
Contributor

harshithmullapudi commented Sep 22, 2022

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

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


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

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

@harshithmullapudi harshithmullapudi merged commit abed1ce into airbytehq:master Sep 22, 2022
robbinhan pushed a commit to robbinhan/airbyte that referenced this pull request Sep 29, 2022
* New Source: Zenefits

* updated Readme.md

* Update spec.json

* Update request headers

Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com>

* Update source.py

* removed sample_files

* 1. updated source_definition
2. created a new file zenefits.md

* Delete TODO.md

* fix: remove .class files

* fix: added back source_definition

* fix: rebase with origin master

* fix: updated specs

Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com>
Co-authored-by: Harshith Mullapudi <harshithmullapudi@gmail.com>
jhammarstedt pushed a commit to jhammarstedt/airbyte that referenced this pull request Oct 31, 2022
* New Source: Zenefits

* updated Readme.md

* Update spec.json

* Update request headers

Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com>

* Update source.py

* removed sample_files

* 1. updated source_definition
2. created a new file zenefits.md

* Delete TODO.md

* fix: remove .class files

* fix: added back source_definition

* fix: rebase with origin master

* fix: updated specs

Co-authored-by: Marcos Marx <marcosmarxm@users.noreply.github.com>
Co-authored-by: Harshith Mullapudi <harshithmullapudi@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/connectors Connector related issues area/documentation Improvements or additions to documentation bounty community connectors/source/zenefits waiting-for-cred Waiting for CI credentials
Projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants