Pipedrive oAuth support #7968
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| /* | ||
| * Copyright (c) 2021 Airbyte, Inc., all rights reserved. | ||
| */ | ||
|
|
||
| package io.airbyte.oauth.flows; | ||
|
|
||
| import com.google.common.annotations.VisibleForTesting; | ||
| import com.google.common.collect.ImmutableMap; | ||
| import io.airbyte.config.persistence.ConfigRepository; | ||
| import io.airbyte.oauth.BaseOAuth2Flow; | ||
| import java.io.IOException; | ||
| import java.net.URISyntaxException; | ||
| import java.net.http.HttpClient; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.UUID; | ||
| import java.util.function.Supplier; | ||
| import org.apache.http.client.utils.URIBuilder; | ||
|
|
||
| /** | ||
| * Following docs from https://pipedrive.readme.io/docs/marketplace-oauth-authorization | ||
| */ | ||
| public class PipeDriveOAuthFlow extends BaseOAuth2Flow { | ||
|
|
||
| final String AUTHORIZE_URL = "https://oauth.pipedrive.com/oauth/authorize"; | ||
| final String ACCESS_TOKEN_URL = "https://oauth.pipedrive.com/oauth/token"; | ||
|
|
||
| public PipeDriveOAuthFlow(final ConfigRepository configRepository, final HttpClient httpClient) { | ||
| super(configRepository, httpClient); | ||
| } | ||
|
|
||
| @VisibleForTesting | ||
| public PipeDriveOAuthFlow(final ConfigRepository configRepository, final HttpClient httpClient, final Supplier<String> stateSupplier) { | ||
| super(configRepository, httpClient, stateSupplier); | ||
| } | ||
|
|
||
| @Override | ||
| protected String formatConsentUrl(final UUID definitionId, final String clientId, final String redirectUrl) throws IOException { | ||
| try { | ||
| return new URIBuilder(AUTHORIZE_URL) | ||
| .addParameter("client_id", clientId) | ||
| .addParameter("redirect_uri", redirectUrl) | ||
| .addParameter("state", getState()) | ||
| .build().toString(); | ||
| } catch (final URISyntaxException e) { | ||
| throw new IOException("Failed to format Consent URL for OAuth flow", e); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected Map<String, String> getAccessTokenQueryParameters(final String clientId, | ||
| final String clientSecret, | ||
| final String authCode, | ||
| final String redirectUrl) { | ||
| return ImmutableMap.<String, String>builder() | ||
| .putAll(super.getAccessTokenQueryParameters(clientId, clientSecret, authCode, redirectUrl)) | ||
| .put("grant_type", "authorization_code") | ||
| .build(); | ||
| } | ||
|
|
||
| @Override | ||
| protected String getAccessTokenUrl() { | ||
| return ACCESS_TOKEN_URL; | ||
| } | ||
|
|
||
| @Override | ||
| protected List<String> getDefaultOAuthOutputPath() { | ||
| return List.of("authorization"); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| /* | ||
| * Copyright (c) 2021 Airbyte, Inc., all rights reserved. | ||
| */ | ||
|
|
||
| package io.airbyte.oauth.flows; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import com.google.common.collect.ImmutableMap; | ||
| import io.airbyte.commons.json.Jsons; | ||
| import io.airbyte.config.SourceOAuthParameter; | ||
| import io.airbyte.config.persistence.ConfigNotFoundException; | ||
| import io.airbyte.config.persistence.ConfigRepository; | ||
| import io.airbyte.oauth.OAuthFlowImplementation; | ||
| import io.airbyte.validation.json.JsonValidationException; | ||
| import java.io.IOException; | ||
| import java.net.http.HttpClient; | ||
| import java.nio.file.Files; | ||
| import java.nio.file.Path; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.UUID; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| public class PipeDriveOAuthFlowIntegrationTest extends OAuthFlowIntegrationTest { | ||
|
|
||
| @Override | ||
| protected Path getCredentialsPath() { | ||
| return Path.of("secrets/pipedrive.json"); | ||
| } | ||
|
|
||
| @Override | ||
| protected String getRedirectUrl() { | ||
| return "http://localhost:3000/auth_flow"; | ||
| } | ||
|
|
||
| protected int getServerListeningPort() { | ||
| return 3000; | ||
| } | ||
|
|
||
| @Override | ||
| protected OAuthFlowImplementation getFlowImplementation(ConfigRepository configRepository, HttpClient httpClient) { | ||
| return new PipeDriveOAuthFlow(configRepository, httpClient); | ||
| } | ||
|
|
||
| @Test | ||
| public void testFullPipeDriveOAuthFlow() throws InterruptedException, ConfigNotFoundException, IOException, JsonValidationException { | ||
| final UUID workspaceId = UUID.randomUUID(); | ||
| final UUID definitionId = UUID.randomUUID(); | ||
| final String fullConfigAsString = new String(Files.readAllBytes(getCredentialsPath())); | ||
| final JsonNode credentialsJson = Jsons.deserialize(fullConfigAsString); | ||
| when(configRepository.listSourceOAuthParam()).thenReturn(List.of(new SourceOAuthParameter() | ||
| .withOauthParameterId(UUID.randomUUID()) | ||
| .withSourceDefinitionId(definitionId) | ||
| .withWorkspaceId(workspaceId) | ||
| .withConfiguration(Jsons.jsonNode(Map.of("authorization", ImmutableMap.builder() | ||
| .put("client_id", credentialsJson.get("client_id").asText()) | ||
| .put("client_secret", credentialsJson.get("client_secret").asText()) | ||
| .build()))))); | ||
| final String url = getFlowImplementation(configRepository, httpClient).getSourceConsentUrl(workspaceId, definitionId, getRedirectUrl()); | ||
| LOGGER.info("Waiting for user consent at: {}", url); | ||
| waitForResponse(20); | ||
| assertTrue(serverHandler.isSucceeded(), "Failed to get User consent on time"); | ||
| final Map<String, Object> params = flow.completeSourceOAuth(workspaceId, definitionId, | ||
| Map.of("code", serverHandler.getParamValue()), getRedirectUrl()); | ||
| LOGGER.info("Response from completing OAuth Flow is: {}", params.toString()); | ||
| assertTrue(params.containsKey("authorization")); | ||
| final var creds = (Map<String, String>) params.get("authorization"); | ||
| assertTrue(creds.get("refresh_token").toString().length() > 0); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| /* | ||
| * Copyright (c) 2021 Airbyte, Inc., all rights reserved. | ||
| */ | ||
|
|
||
| package io.airbyte.oauth.flows; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.mockito.ArgumentMatchers.any; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.when; | ||
|
|
||
| import com.google.common.collect.ImmutableMap; | ||
| import io.airbyte.commons.json.Jsons; | ||
| import io.airbyte.config.SourceOAuthParameter; | ||
| import io.airbyte.config.persistence.ConfigNotFoundException; | ||
| import io.airbyte.config.persistence.ConfigRepository; | ||
| import io.airbyte.validation.json.JsonValidationException; | ||
| import java.io.IOException; | ||
| import java.net.http.HttpClient; | ||
| import java.net.http.HttpResponse; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
| import java.util.UUID; | ||
| import org.junit.jupiter.api.BeforeEach; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| public class PipeDriveOAuthFlowTest { | ||
|
There was a problem hiding this comment. Sorry, could you update your branch and make the unit test extends from There was a problem hiding this comment. Wow, nice refactoring, I love it |
||
|
|
||
| private UUID workspaceId; | ||
| private UUID definitionId; | ||
| private ConfigRepository configRepository; | ||
| private PipeDriveOAuthFlow pipedriveOAuthFlow; | ||
| private HttpClient httpClient; | ||
|
|
||
| private static final String REDIRECT_URL = "https://airbyte.io"; | ||
|
|
||
| private static String getConstantState() { | ||
| return "state"; | ||
| } | ||
|
|
||
| @BeforeEach | ||
| public void setup() throws IOException, JsonValidationException { | ||
| workspaceId = UUID.randomUUID(); | ||
| definitionId = UUID.randomUUID(); | ||
| configRepository = mock(ConfigRepository.class); | ||
| httpClient = mock(HttpClient.class); | ||
| when(configRepository.listSourceOAuthParam()).thenReturn(List.of(new SourceOAuthParameter() | ||
| .withOauthParameterId(UUID.randomUUID()) | ||
| .withSourceDefinitionId(definitionId) | ||
| .withWorkspaceId(workspaceId) | ||
| .withConfiguration(Jsons.jsonNode(Map.of("authorization", ImmutableMap.builder() | ||
| .put("client_id", "test_client_id") | ||
| .put("client_secret", "test_client_secret") | ||
| .build()))))); | ||
| pipedriveOAuthFlow = new PipeDriveOAuthFlow(configRepository, httpClient, PipeDriveOAuthFlowTest::getConstantState); | ||
|
|
||
| } | ||
|
|
||
| @Test | ||
| public void testGetSourceConsentUrl() throws IOException, InterruptedException, ConfigNotFoundException { | ||
| final String consentUrl = pipedriveOAuthFlow.getSourceConsentUrl(workspaceId, definitionId, REDIRECT_URL); | ||
| assertEquals( | ||
| "https://oauth.pipedrive.com/oauth/authorize?client_id=test_client_id&redirect_uri=https%3A%2F%2Fairbyte.io&state=state", | ||
| consentUrl); | ||
| } | ||
|
|
||
| @Test | ||
| public void testCompleteSourceOAuth() throws IOException, JsonValidationException, InterruptedException, ConfigNotFoundException { | ||
|
|
||
| final Map<String, String> returnedCredentials = Map.of("refresh_token", "refresh_token_response"); | ||
| final HttpResponse response = mock(HttpResponse.class); | ||
| when(response.body()).thenReturn(Jsons.serialize(returnedCredentials)); | ||
| when(httpClient.send(any(), any())).thenReturn(response); | ||
| final Map<String, Object> queryParams = Map.of("code", "test_code"); | ||
| final Map<String, Object> actualQueryParams = | ||
| pipedriveOAuthFlow.completeSourceOAuth(workspaceId, definitionId, queryParams, REDIRECT_URL); | ||
| assertEquals(Map.of("authorization", returnedCredentials), actualQueryParams); | ||
| } | ||
|
|
||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
since this is a source, is that normal to set destination modes?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oops, missed that, will remove