twitter/oauth_dance.py

   1 from __future__ import print_function
   2
   3 import webbrowser
   4 import time
   5
   6 from .api import Twitter, json
   7 from .oauth import OAuth, write_token_file
   8 from .oauth2 import OAuth2, write_bearer_token_file
   9
  10 try:
  11     _input = raw_input
  12 except NameError:
  13     _input = input
  14
  15
  16 def oauth2_dance(consumer_key, consumer_secret, token_filename=None):
  17     """
  18     Perform the OAuth2 dance to transform a consumer key and secret into a
  19     bearer token.
  20
  21     If a token_filename is given, the bearer token will be written to
  22     the file.
  23     """
  24     twitter = Twitter(
  25         auth=OAuth2(consumer_key=consumer_key, consumer_secret=consumer_secret),
  26         format="",
  27         api_version="")
  28     token = json.loads(twitter.oauth2.token(grant_type="client_credentials"))["access_token"]
  29     if token_filename:
  30         write_bearer_token_file(token)
  31     return token
  32
  33 def oauth_dance(app_name, consumer_key, consumer_secret, token_filename=None):
  34     """
  35     Perform the OAuth dance with some command-line prompts. Return the
  36     oauth_token and oauth_token_secret.
  37
  38     Provide the name of your app in `app_name`, your consumer_key, and
  39     consumer_secret. This function will open a web browser to let the
  40     user allow your app to access their Twitter account. PIN
  41     authentication is used.
  42
  43     If a token_filename is given, the oauth tokens will be written to
  44     the file.
  45     """
  46     print("Hi there! We're gonna get you all set up to use %s." % app_name)
  47     twitter = Twitter(
  48         auth=OAuth('', '', consumer_key, consumer_secret),
  49         format='', api_version=None)
  50     oauth_token, oauth_token_secret = parse_oauth_tokens(
  51         twitter.oauth.request_token(oauth_callback="oob"))
  52     print("""
  53 In the web browser window that opens please choose to Allow
  54 access. Copy the PIN number that appears on the next page and paste or
  55 type it here:
  56 """)
  57     oauth_url = ('https://api.twitter.com/oauth/authorize?oauth_token=' +
  58                  oauth_token)
  59     print("Opening: %s\n" % oauth_url)
  60
  61     try:
  62         r = webbrowser.open(oauth_url)
  63         time.sleep(2) # Sometimes the last command can print some
  64                       # crap. Wait a bit so it doesn't mess up the next
  65                       # prompt.
  66         if not r:
  67             raise Exception()
  68     except:
  69         print("""
  70 Uh, I couldn't open a browser on your computer. Please go here to get
  71 your PIN:
  72
  73 """ + oauth_url)
  74     oauth_verifier = _input("Please enter the PIN: ").strip()
  75     twitter = Twitter(
  76         auth=OAuth(
  77             oauth_token, oauth_token_secret, consumer_key, consumer_secret),
  78         format='', api_version=None)
  79     oauth_token, oauth_token_secret = parse_oauth_tokens(
  80         twitter.oauth.access_token(oauth_verifier=oauth_verifier))
  81     if token_filename:
  82         write_token_file(
  83             token_filename, oauth_token, oauth_token_secret)
  84         print()
  85         print("That's it! Your authorization keys have been written to %s." % (
  86             token_filename))
  87     return oauth_token, oauth_token_secret
  88
  89 def parse_oauth_tokens(result):
  90     for r in result.split('&'):
  91         k, v = r.split('=')
  92         if k == 'oauth_token':
  93             oauth_token = v
  94         elif k == 'oauth_token_secret':
  95             oauth_token_secret = v
  96     return oauth_token, oauth_token_secret