-
Notifications
You must be signed in to change notification settings - Fork 46
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Remove support for API v3 and v4 (#79)
* python: move v5 to src and delete v3 * python: remove v5 prefix from imports * python: move v5 test files to src and remove v3 * python: remove version import handling from scripts and fix lint issues * python: fix lint issues * python: v5 unit tests and one integration test working * fix analytics integration test and remove get_businesses * python: test_refresh_example working for v5 * python: remove v3-specific code * python: remove ApiConfig.version * python: merge access_token_common into access_token * python: delete ad_metrics_async_report * python: move ad_metrics_async_report_common to src/ad_metrics_async_report * python: ad_metrics_async_report working again * python: remove user_me * python: remove v3 raw option from unpack * lint fixes for python, no more e2e tests for v3 * nodejs: move v5 to src and delete v3 * nodejs: adjust imports and jest mocks for v5 only code * nodejs: alphabetize imports * nodejs: remove get_businesses * remove v3-specific code * remove ApiConfig.version * nodejs: merge access_token_common into access_token * nodejs: remove ad_metrics_async_report * nodejs: move ad_metrics_async_report_common to ad_metrics_async_report * ad_metrics_async_report working again * nodejs: remove user_me * nodejs: lint fixes * scripts: lint fixes * bash: remove v3 and version-independent scripts * bash: move v5 script into scripts directory * remove more instances of v3 and v4 from README and other files * update link to delivery metrics doc * fix comment in help doc generator * README: refer to v1.1 of this repo for v3/v4 code Co-authored-by: David Chaiken <[email protected]>
- Loading branch information
1 parent
7b35b29
commit 60b6a2a
Showing
150 changed files
with
1,017 additions
and
5,044 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| SCRIPTS=scripts/*.sh scripts/*/*.sh | ||
| SCRIPTS=scripts/*.sh | ||
| lint: | ||
| shellcheck $(SCRIPTS) | ||
|
|
||
|
|
||
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 |
|---|---|---|
| @@ -1,17 +1,89 @@ | ||
| #!/usr/bin/env bash | ||
|
|
||
| # | ||
| # This script uses curl, openssl, and some helper utilities to demonstrate how to | ||
| # use OAuth authentication with the Pinterest API. | ||
| # | ||
| # OAuth is version specific, so this script just calls the appropriate | ||
| # version-specific script, based on the PINTEREST_API_VERSION environment | ||
| # variable. More documentation is available in each version-specific script. | ||
| # To see the communications at any stage of this script, use echo to show the | ||
| # relevant variable. For example, echo "$REDIRECT_SESSION" to see the complete | ||
| # web browser session for the redirect. | ||
| # | ||
| : "${PINTEREST_API_VERSION:=v5}" | ||
| # Prerequisites: curl, openssl, base64, jq, grep, cut | ||
| # | ||
|
|
||
| # Get configuration from environment or defaults. | ||
| : "${REDIRECT_PORT:=8085}" | ||
| : "${PINTEREST_API_URI:=https://api.pinterest.com}" | ||
| : "${PINTEREST_OAUTH_URI:=https://www.pinterest.com}" | ||
| : "${REDIRECT_LANDING_URI:=https://developers.pinterest.com/apps/${PINTEREST_APP_ID}}" | ||
| REDIRECT_URI="http://localhost:${REDIRECT_PORT}/" | ||
|
|
||
| # Note that the application id and secrect have no defaults, | ||
| # because it is best practice not to store credentials in code. | ||
| B64AUTH=$(echo -n "${PINTEREST_APP_ID}:${PINTEREST_APP_SECRET}" | base64) | ||
|
|
||
| # Get the authorization code by starting a browser session and handling the redirect. | ||
| echo 'getting auth_code...' | ||
|
|
||
| # Specify the scopes for the user to authorize via OAuth. | ||
| # This example requests typical read-only authorization. | ||
| # For more information, see: https://developers.pinterest.com/docs/getting-started/authentication/ | ||
| SCOPE="user_accounts:read" | ||
|
|
||
| # This call opens the browser with the oauth information in the URI. | ||
| open "${PINTEREST_OAUTH_URI}/oauth/?consumer_id=${PINTEREST_APP_ID}&redirect_uri=${REDIRECT_URI}&scope=${SCOPE}&response_type=code" & | ||
|
|
||
| # 1. Use netcat (nc) to run the web browser to handle the redirect from the oauth call. | ||
| # 2. Wait for the response. | ||
| # 3. Redirect using a HTTP 301 response to the landing URI. | ||
| REDIRECT_SESSION=$(nc -l localhost ${REDIRECT_PORT} 2>&1 <<EOF | ||
| HTTP/1.1 301 Moved Permanently | ||
| Location: ${REDIRECT_LANDING_URI} | ||
| EOF | ||
| ) | ||
|
|
||
| # Cut the authorization code from the output of the web server, which includes | ||
| # the redirect URI with the authorization code. | ||
| AUTH_CODE=$(echo "${REDIRECT_SESSION}" | grep GET | cut -d ' ' -f 2 | cut -d '=' -f 2) | ||
|
|
||
| # Exchange the authorization code for the access token. | ||
| echo 'exchanging auth_code for access_token...' | ||
|
|
||
| # Execute the curl PUT command to exchange the authorization code for the access token. | ||
| # 1. Use basic authorization (constructed above) with the application id and secret. | ||
| # 2. Note that it is necessary to send x-www-form-urlencoded data. | ||
| OAUTH_RESPONSE=$(curl --silent -X POST --header "Authorization:Basic ${B64AUTH}" --header 'Content-Type: application/x-www-form-urlencoded' --data-urlencode 'grant_type=authorization_code' --data-urlencode "code=${AUTH_CODE}" --data-urlencode "redirect_uri=${REDIRECT_URI}" "${PINTEREST_API_URI}/v5/oauth/token") | ||
|
|
||
| RESPONSE_TYPE=$(echo "$OAUTH_RESPONSE" | jq -r '.["response_type"]') | ||
| echo response_type: "$RESPONSE_TYPE" | ||
|
|
||
| # Parse the JSON returned by the exchange call and retrieve the access token. | ||
| ACCESS_TOKEN=$(echo "$OAUTH_RESPONSE" | jq -r '.["access_token"]') | ||
|
|
||
| # The scope returned in the response includes all of the scopes that | ||
| # have been approved now or in the past by the user. | ||
| SCOPE=$(echo "$OAUTH_RESPONSE" | jq -r '.["scope"]') | ||
| echo scope: "$SCOPE" | ||
|
|
||
| SCRIPT_NAME="${BASH_SOURCE[0]}" | ||
| # Demonstrate how to use the access token to get information about the associated user. | ||
| echo 'getting user data using the access token' | ||
| USER_RESPONSE=$(curl --silent -X GET --header "Authorization:Bearer ${ACCESS_TOKEN}" "${PINTEREST_API_URI}/v5/user_account") | ||
|
|
||
| # get the location of this script | ||
| # shellcheck disable=SC2164 # because the directory definitely exists | ||
| SCRIPT_DIR=$(cd "$(dirname "${SCRIPT_NAME}")"; pwd) | ||
| # An alternative for the above command is to use the OAuth2 bearer authentication | ||
| # that is built into curl. Replace these arguments: | ||
| # --header "Authorization:Bearer ${ACCESS_TOKEN}" | ||
| # with these arguments: | ||
| # --oauth2-bearer "${ACCESS_TOKEN}" | ||
|
|
||
| VERSION_SPECIFIC_SCRIPT="${SCRIPT_DIR}/${PINTEREST_API_VERSION}/get_access_token.sh" | ||
| echo running version specific script: "${VERSION_SPECIFIC_SCRIPT}" | ||
| exec "${VERSION_SPECIFIC_SCRIPT}" | ||
| # Parse the JSON response and print the data associated with the user. | ||
| ACCOUNT_TYPE=$(echo "${USER_RESPONSE}" | jq -r '.["account_type"]') | ||
| USERNAME=$(echo "${USER_RESPONSE}" | jq -r '.["username"]') | ||
| PROFILE_IMAGE=$(echo "${USER_RESPONSE}" | jq -r '.["profile_image"]') | ||
| WEBSITE_URL=$(echo "${USER_RESPONSE}" | jq -r '.["website_url"]') | ||
| echo '--- User Summary ---' | ||
| echo Account Type: "$ACCOUNT_TYPE" | ||
| echo Username: "$USERNAME" | ||
| echo Profile Image: "$PROFILE_IMAGE" | ||
| echo Website URL: "$WEBSITE_URL" | ||
| echo '--------------------' |
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.