authorize.py

#
# Script to getauthorization code from Digi-key by providing
# client-id and client-secret
# See https://developer.digikey.com/documentation/oauth for more info
#
# import argparse
import os
from pprint import pprint
import requests
import sys
import time
import webbrowser
import yaml


DEFAULT_REDIRECT_URI = "https://alvarop.com/dkbc/dk_oauth.html"
DEFAULT_API_URL = "https://api.digikey.com"


def authorize(
    DK_CLIENT_ID,
    DK_CLIENT_SECRET,
    config_path,
    api_url=DEFAULT_API_URL,
    redirect_uri=DEFAULT_REDIRECT_URI,
    no_browser=False,
    debug=False,
):
    """
    Authorize the application to access the Digi-Key API.

    :param DK_CLIENT_ID: The client ID assigned to the application that you generated within the API Portal.
    :type DK_CLIENT_ID: str
    :param DK_CLIENT_SECRET: The client secret assigned to the application that you generated within the API Portal.
    :type DK_CLIENT_SECRET: str
    :param config_path: The path to the configuration file.
    :type config_path: str
    :param api_url: The Digi-Key API URL (sandbox or prod).
    :type api_url: str
    :param redirect_uri: The URI that the user will be redirected to after logging in.
    :type redirect_uri: str
    :param no_browser: If True, the user will not be prompted to open a browser window to log in.
    :type no_browser: bool
    :param debug: If True, the response JSON will be printed to the console.
    :type debug: bool
    """
    cfg = {}
    if os.path.isfile(config_path):
        with open(config_path, "r") as ymlfile:
            cfg = yaml.safe_load(ymlfile)
    else:
        print('"{}" not found!'.format(config_path))
        cfg["client-id"] = DK_CLIENT_ID
        cfg["client-secret"] = DK_CLIENT_SECRET

    url = (
        api_url
        + "/v1/oauth2/authorize?response_type=code&client_id={}&redirect_uri={}".format(
            cfg["client-id"], redirect_uri
        )
    )

    print("Go to {} and get code from URL after logging in".format(url))
    if no_browser is False:
        webbrowser.open(url)

    code = input("Enter code here:")

    post_request = {
        "code": code,
        "client_id": cfg["client-id"],
        "client_secret": cfg["client-secret"],
        "redirect_uri": redirect_uri,
        "grant_type": "authorization_code",
    }

    # code  The authorization code returned from the initial request (See above example).
    # client_id This is the client id assigned to the application that you generated within the API Portal.
    # client_secret This is the client secret assigned to the application that you generated within the API Portal.
    # redirect_uri  This URI must match the redirect URI that you defined while creating your application within the API Portal.
    # grant_type    As defined in the OAuth 2.0 specification, this field must contain a value of authorization_code.

    request_url = api_url + "/v1/oauth2/token"

    response = requests.post(request_url, data=post_request)
    response_json = response.json()
    if debug:
        pprint(response_json)

    if response.status_code == 200:
        # Save backup copy of config file
        with open(config_path + ".old", "w") as outfile:
            yaml.dump(cfg, outfile, default_flow_style=False)

        cfg["refresh-token"] = response_json["refresh_token"]
        cfg["access-token"] = response_json["access_token"]
        cfg["token-expiration"] = int(time.time()) + int(response_json["expires_in"])

        with open(config_path, "w") as outfile:
            yaml.dump(cfg, outfile, default_flow_style=False)

        print("Autorized successfully")
    else:
        if "ErrorMessage" in response_json:
            print("ERROR:", response_json["ErrorMessage"])
        print("Error authorizing ({})".format(response.status_code))
        sys.exit(-1)


# if __name__ == "__main__":
#     parser = argparse.ArgumentParser(
#         formatter_class=argparse.ArgumentDefaultsHelpFormatter
#     )
#     parser.add_argument(
#         "--config_path", help="Configuration filename", default="config.yml"
#     )
#     parser.add_argument(
#         "--api_url", help="Digi-key API url (sandbox or prod)", default=DEFAULT_API_URL
#     )
#     parser.add_argument(
#         "--redirect_uri", help="OAuth Redirect URI", default=DEFAULT_REDIRECT_URI
#     )

#     parser.add_argument(
#         "--no_browser", help="Don't open web browser automatically", action="store_true"
#     )
#     parser.add_argument("--debug", action="store_true")
#     args = parser.parse_args()

#     authorize(
#         config_path=args.config_path,
#         api_url=args.api_url,
#         redirect_uri=args.redirect_uri,
#         no_browser=args.no_browser,
#         debug=args.debug,
#     )