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

🎉 square: added oauth support #6842

Merged
merged 27 commits into from
Jan 18, 2022

Conversation

midavadim
Copy link
Contributor

@midavadim midavadim commented Oct 6, 2021

What

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

How

Describe the solution

Selection_161
Selection_162
Selection_163

Recommended reading order

  1. x.java
  2. y.python

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/SUMMARY.md
    • 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
  • Connector added to connector index like described here

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
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub by running the /publish command 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
  • Connector version bumped like described here

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
  • Credentials added to Github CI. Instructions.
  • /test connector=connectors/<name> command is passing.
  • New Connector version released on Dockerhub 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.


This change is Reviewable

@midavadim midavadim temporarily deployed to more-secrets October 6, 2021 16:25 Inactive
@CLAassistant
Copy link

CLAassistant commented Oct 6, 2021

CLA assistant check
All committers have signed the CLA.

@midavadim midavadim requested a review from antixar October 6, 2021 16:25
@github-actions github-actions bot added the area/connectors Connector related issues label Oct 6, 2021
@midavadim midavadim temporarily deployed to more-secrets October 6, 2021 16:37 Inactive
@midavadim midavadim linked an issue Oct 6, 2021 that may be closed by this pull request
1 task
@midavadim
Copy link
Contributor Author

midavadim commented Oct 6, 2021

/test connector=connectors/square

🕑 connectors/square https://github.com/airbytehq/airbyte/actions/runs/1312818892
❌ connectors/square https://github.com/airbytehq/airbyte/actions/runs/1312818892
🐛

@jrhizor jrhizor temporarily deployed to more-secrets October 6, 2021 16:45 Inactive
@midavadim
Copy link
Contributor Author

midavadim commented Oct 6, 2021

/test connector=connectors/source-square

🕑 connectors/source-square https://github.com/airbytehq/airbyte/actions/runs/1313596201
❌ connectors/source-square https://github.com/airbytehq/airbyte/actions/runs/1313596201
🐛 https://gradle.com/s/q3vhv2x37fdcg

@jrhizor jrhizor temporarily deployed to more-secrets October 6, 2021 20:47 Inactive
@antixar antixar requested a review from bazarnov October 7, 2021 15:59
@midavadim
Copy link
Contributor Author

midavadim commented Oct 7, 2021

/test connector=connectors/source-square

🕑 connectors/source-square https://github.com/airbytehq/airbyte/actions/runs/1317639508
❌ connectors/source-square https://github.com/airbytehq/airbyte/actions/runs/1317639508
🐛

@jrhizor jrhizor temporarily deployed to more-secrets October 7, 2021 19:35 Inactive
@midavadim midavadim temporarily deployed to more-secrets October 7, 2021 19:43 Inactive
@midavadim
Copy link
Contributor Author

midavadim commented Oct 7, 2021

/test connector=connectors/source-square

🕑 connectors/source-square https://github.com/airbytehq/airbyte/actions/runs/1317703454
✅ connectors/source-square https://github.com/airbytehq/airbyte/actions/runs/1317703454
Python tests coverage:

	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                                 Stmts   Miss  Cover
	 ------------------------------------------------------------------------
	 source_acceptance_test/__init__.py                       2      0   100%
	 source_acceptance_test/base.py                          10      4    60%
	 source_acceptance_test/config.py                        74      8    89%
	 source_acceptance_test/conftest.py                     108    108     0%
	 source_acceptance_test/plugin.py                        47     47     0%
	 source_acceptance_test/tests/__init__.py                 4      0   100%
	 source_acceptance_test/tests/test_core.py              200     94    53%
	 source_acceptance_test/tests/test_full_refresh.py       18     11    39%
	 source_acceptance_test/tests/test_incremental.py        69     38    45%
	 source_acceptance_test/utils/__init__.py                 6      0   100%
	 source_acceptance_test/utils/asserts.py                 37      2    95%
	 source_acceptance_test/utils/common.py                  41     24    41%
	 source_acceptance_test/utils/compare.py                 47     20    57%
	 source_acceptance_test/utils/connector_runner.py        82     49    40%
	 source_acceptance_test/utils/json_schema_helper.py     111     11    90%
	 ------------------------------------------------------------------------
	 TOTAL                                                  856    416    51%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                       Stmts   Miss  Cover
	 --------------------------------------------------------------
	 base_python/__init__.py                       13      0   100%
	 base_python/catalog_helpers.py                10      6    40%
	 base_python/cdk/__init__.py                    0      0   100%
	 base_python/cdk/abstract_source.py            83     59    29%
	 base_python/cdk/streams/__init__.py            0      0   100%
	 base_python/cdk/streams/auth/__init__.py       0      0   100%
	 base_python/cdk/streams/auth/core.py           8      1    88%
	 base_python/cdk/streams/auth/jwt.py            5      5     0%
	 base_python/cdk/streams/auth/oauth.py         37     26    30%
	 base_python/cdk/streams/auth/token.py          9      4    56%
	 base_python/cdk/streams/core.py               63     32    49%
	 base_python/cdk/streams/exceptions.py         10      2    80%
	 base_python/cdk/streams/http.py               67     33    51%
	 base_python/cdk/streams/rate_limiting.py      30     14    53%
	 base_python/cdk/utils/__init__.py              0      0   100%
	 base_python/cdk/utils/casing.py                4      0   100%
	 base_python/client.py                         56     33    41%
	 base_python/entrypoint.py                     70     56    20%
	 base_python/integration.py                    52     25    52%
	 base_python/logger.py                         33     19    42%
	 base_python/schema_helpers.py                 56     41    27%
	 base_python/source.py                         51     34    33%
	 main_dev.py                                    3      3     0%
	 --------------------------------------------------------------
	 TOTAL                                        660    393    40%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                        Stmts   Miss  Cover
	 -----------------------------------------------
	 source_square/__init__.py       2      0   100%
	 source_square/source.py       228     97    57%
	 source_square/utils.py         15      0   100%
	 -----------------------------------------------
	 TOTAL                         245     97    60%

@jrhizor jrhizor temporarily deployed to more-secrets October 7, 2021 19:56 Inactive
Copy link
Contributor

@antixar antixar left a comment

Choose a reason for hiding this comment

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

could you rename the secret value?
SOURCE_SQUARE_CREDS_OAUTH => SOURCE_SQUARE_OAUTH_CREDS

@midavadim midavadim requested review from antixar and bazarnov October 15, 2021 11:46
Copy link
Collaborator

@bazarnov bazarnov left a comment

Choose a reason for hiding this comment

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

Please check the TypeHints in Oauth2AuthenticatorSquare(Oauth2Authenticator) and spec.json for OAuth Flow specifications

@midavadim midavadim temporarily deployed to more-secrets October 15, 2021 12:57 Inactive
@midavadim midavadim requested a review from bazarnov October 15, 2021 13:03
@midavadim
Copy link
Contributor Author

/test connector=connectors/source-square

@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets January 14, 2022 17:17 Inactive
@midavadim
Copy link
Contributor Author

/test connector=connectors/source-square

@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets January 17, 2022 09:45 Inactive
@midavadim
Copy link
Contributor Author

/test connector=connectors/source-square

@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets January 17, 2022 19:33 Inactive
@midavadim
Copy link
Contributor Author

midavadim commented Jan 17, 2022

/test connector=connectors/source-square

🕑 connectors/source-square https://github.com/airbytehq/airbyte/actions/runs/1709659517
❌ connectors/source-square https://github.com/airbytehq/airbyte/actions/runs/1709659517
🐛 https://scans.gradle.com/s/u2txu7m35b5hi
Python short test summary info:

=========================== short test summary info ============================
ERROR test_core.py::TestConnection::test_check[inputs1] - FileNotFoundError: ...
ERROR test_core.py::TestDiscovery::test_discover[inputs1] - FileNotFoundError...
ERROR test_core.py::TestDiscovery::test_defined_cursors_exist_in_schema[inputs1]
ERROR test_core.py::TestDiscovery::test_defined_refs_exist_in_schema[inputs1]
ERROR test_core.py::TestBasicRead::test_read[inputs1] - FileNotFoundError: [E...
======================== 16 passed, 5 errors in 33.05s =========================

@midavadim midavadim temporarily deployed to more-secrets January 17, 2022 19:55 Inactive
@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets January 17, 2022 19:56 Inactive
@midavadim
Copy link
Contributor Author

midavadim commented Jan 17, 2022

/test connector=connectors/source-square

🕑 connectors/source-square https://github.com/airbytehq/airbyte/actions/runs/1709768838
❌ connectors/source-square https://github.com/airbytehq/airbyte/actions/runs/1709768838
🐛 https://scans.gradle.com/s/o4n3pd75qgvai
Python short test summary info:

=========================== short test summary info ============================
ERROR test_core.py::TestConnection::test_check[inputs1] - FileNotFoundError: ...
ERROR test_core.py::TestDiscovery::test_discover[inputs1] - FileNotFoundError...
ERROR test_core.py::TestDiscovery::test_defined_cursors_exist_in_schema[inputs1]
ERROR test_core.py::TestDiscovery::test_defined_refs_exist_in_schema[inputs1]
ERROR test_core.py::TestBasicRead::test_read[inputs1] - FileNotFoundError: [E...
======================== 16 passed, 5 errors in 32.87s =========================

@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets January 17, 2022 20:31 Inactive
@midavadim
Copy link
Contributor Author

midavadim commented Jan 17, 2022

/test connector=connectors/source-square

🕑 connectors/source-square https://github.com/airbytehq/airbyte/actions/runs/1709813658
❌ connectors/source-square https://github.com/airbytehq/airbyte/actions/runs/1709813658
🐛 https://scans.gradle.com/s/qj72dim7nstze
Python short test summary info:

=========================== short test summary info ============================
ERROR test_core.py::TestConnection::test_check[inputs1] - FileNotFoundError: ...
ERROR test_core.py::TestDiscovery::test_discover[inputs1] - FileNotFoundError...
ERROR test_core.py::TestDiscovery::test_defined_cursors_exist_in_schema[inputs1]
ERROR test_core.py::TestDiscovery::test_defined_refs_exist_in_schema[inputs1]
ERROR test_core.py::TestBasicRead::test_read[inputs1] - FileNotFoundError: [E...
======================== 16 passed, 5 errors in 33.15s =========================

@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets January 17, 2022 20:46 Inactive
@midavadim
Copy link
Contributor Author

midavadim commented Jan 17, 2022

/test connector=connectors/source-square

🕑 connectors/source-square https://github.com/airbytehq/airbyte/actions/runs/1709855680
❌ connectors/source-square https://github.com/airbytehq/airbyte/actions/runs/1709855680
🐛 https://scans.gradle.com/s/bft3nloj7agz4

@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets January 17, 2022 21:01 Inactive
@midavadim
Copy link
Contributor Author

midavadim commented Jan 18, 2022

/test connector=connectors/source-square

🕑 connectors/source-square https://github.com/airbytehq/airbyte/actions/runs/1711324262
✅ connectors/source-square https://github.com/airbytehq/airbyte/actions/runs/1711324262
Python tests coverage:

	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                                                 Stmts   Miss  Cover
	 ------------------------------------------------------------------------
	 source_acceptance_test/__init__.py                       2      0   100%
	 source_acceptance_test/base.py                          10      4    60%
	 source_acceptance_test/config.py                        74      6    92%
	 source_acceptance_test/conftest.py                     109    109     0%
	 source_acceptance_test/plugin.py                        47     47     0%
	 source_acceptance_test/tests/__init__.py                 4      0   100%
	 source_acceptance_test/tests/test_core.py              242     96    60%
	 source_acceptance_test/tests/test_full_refresh.py       38      0   100%
	 source_acceptance_test/tests/test_incremental.py        69     38    45%
	 source_acceptance_test/utils/__init__.py                 6      0   100%
	 source_acceptance_test/utils/asserts.py                 37      2    95%
	 source_acceptance_test/utils/common.py                  54     17    69%
	 source_acceptance_test/utils/compare.py                 62     23    63%
	 source_acceptance_test/utils/connector_runner.py       110     48    56%
	 source_acceptance_test/utils/json_schema_helper.py     115     14    88%
	 ------------------------------------------------------------------------
	 TOTAL                                                  979    404    59%
	 ---------- coverage: platform linux, python 3.8.10-final-0 -----------
	 Name                        Stmts   Miss  Cover
	 -----------------------------------------------
	 source_square/__init__.py       2      0   100%
	 source_square/source.py       234    100    57%
	 source_square/utils.py         15      0   100%
	 -----------------------------------------------
	 TOTAL                         251    100    60%

@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets January 18, 2022 06:22 Inactive
@midavadim midavadim temporarily deployed to more-secrets January 18, 2022 06:48 Inactive
@midavadim
Copy link
Contributor Author

midavadim commented Jan 18, 2022

/publish connector=connectors/source-square

🕑 connectors/source-square https://github.com/airbytehq/airbyte/actions/runs/1711405457
✅ connectors/source-square https://github.com/airbytehq/airbyte/actions/runs/1711405457

@octavia-squidington-iii octavia-squidington-iii temporarily deployed to more-secrets January 18, 2022 06:52 Inactive
@midavadim midavadim merged commit 6b502d8 into master Jan 18, 2022
@midavadim midavadim deleted the midavadim/source-square-oauth-support branch January 18, 2022 07:11
@midavadim midavadim temporarily deployed to more-secrets January 18, 2022 07:12 Inactive
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Source Square: support oauth
9 participants