def authorize_redirect(self,
callback_uri=None,
extra_params=None,
http_client=None):
"""Redirects the user to obtain OAuth authorization for this service.
Twitter and FriendFeed both require that you register a Callback
URL with your application. You should call this method to log the
user in, and then call get_authenticated_user() in the handler
you registered as your Callback URL to complete the authorization
process.
This method sets a cookie called _oauth_request_token which is
subsequently used (and cleared) in get_authenticated_user for
security purposes.
"""
if callback_uri and getattr(self, "_OAUTH_NO_CALLBACKS", False):
raise Exception("This service does not support oauth_callback")
if getattr(self, "_OAUTH_VERSION", "1.0a") == "1.0a":
response = content_remote.get_url(
self._oauth_request_token_url(callback_uri=callback_uri,
extra_params=extra_params))
self._on_request_token(self._OAUTH_AUTHORIZE_URL, callback_uri,
response)
else:
response = content_remote.get_url(self._oauth_request_token_url())
self._on_request_token(self._OAUTH_AUTHORIZE_URL, callback_uri,
response)
def get_sync_authenticated_user(self, callback, http_client=None):
"""Gets the OAuth authorized user and access token on callback.
This method should be called from the handler for your registered
OAuth Callback URL to complete the registration process. We call
callback with the authenticated user, which in addition to standard
attributes like 'name' includes the 'access_key' attribute, which
contains the OAuth access you can use to make authorized requests
to this service on behalf of the user.
"""
request_key = tornado.escape.utf8(self.get_argument("oauth_token"))
oauth_verifier = self.get_argument("oauth_verifier", None)
request_cookie = self.get_cookie("_oauth_request_token")
if not request_cookie:
logging.warning("Missing OAuth request token cookie")
callback(None)
return
self.clear_cookie("_oauth_request_token")
cookie_key, cookie_secret = [
base64.b64decode(tornado.escape.utf8(i))
for i in request_cookie.split("|")
]
if cookie_key != request_key:
logging.info((cookie_key, request_key, request_cookie))
logging.warning("Request token does not match cookie")
callback(None)
return
token = dict(key=cookie_key, secret=cookie_secret)
if oauth_verifier:
token["verifier"] = oauth_verifier
response = content_remote.get_url(self._oauth_access_token_url(token))
self._on_access_token(callback, response)
def tumblr_request(self,
path,
callback,
access_token=None,
post_args=None,
**args):
#http://www.tumblr.com/docs/en/api/v2
url = path
# Add the OAuth resource request signature if we have credentials
if access_token:
all_args = {}
all_args.update(args)
all_args.update(post_args or {})
method = "POST" if post_args is not None else "GET"
oauth = self._oauth_request_parameters(url,
access_token,
all_args,
method=method)
args.update(oauth)
if post_args:
args.update(post_args)
if args:
url += "?" + urllib.urlencode(args)
response = content_remote.get_url(url, post=(post_args is not None))
self._on_tumblr_request(callback, response)
def get_sync_authenticated_user(self, callback, http_client=None):
"""Gets the OAuth authorized user and access token on callback.
This method should be called from the handler for your registered
OAuth Callback URL to complete the registration process. We call
callback with the authenticated user, which in addition to standard
attributes like 'name' includes the 'access_key' attribute, which
contains the OAuth access you can use to make authorized requests
to this service on behalf of the user.
"""
request_key = tornado.escape.utf8(self.get_argument("oauth_token"))
oauth_verifier = self.get_argument("oauth_verifier", None)
request_cookie = self.get_cookie("_oauth_request_token")
if not request_cookie:
logging.warning("Missing OAuth request token cookie")
callback(None)
return
self.clear_cookie("_oauth_request_token")
cookie_key, cookie_secret = [base64.b64decode(tornado.escape.utf8(i))
for i in request_cookie.split("|")]
if cookie_key != request_key:
logging.info((cookie_key, request_key, request_cookie))
logging.warning("Request token does not match cookie")
callback(None)
return
token = dict(key=cookie_key, secret=cookie_secret)
if oauth_verifier:
token["verifier"] = oauth_verifier
response = content_remote.get_url(self._oauth_access_token_url(token))
self._on_access_token(callback, response)
def get_sync_authenticated_user(self, redirect_uri, client_id, client_secret,
code, callback, extra_fields=None):
args = {
"client_id": client_id,
"client_secret": client_secret,
"code": code,
"redirect_uri": redirect_uri,
}
response = content_remote.get_url(self._oauth_request_token_url(**args),
post=True)
self._on_access_token(callback, response)
def facebook_request(self,
path,
callback,
access_token=None,
post_args=None,
**args):
"""Fetches the given relative API path, e.g., "/btaylor/picture"
If the request is a POST, post_args should be provided. Query
string arguments should be given as keyword arguments.
An introduction to the Facebook Graph API can be found at
http://developers.facebook.com/docs/api
Many methods require an OAuth access token which you can obtain
through authorize_redirect() and get_authenticated_user(). The
user returned through that process includes an 'access_token'
attribute that can be used to make authenticated requests via
this method. Example usage::
class MainHandler(tornado.web.RequestHandler,
tornado.auth.FacebookGraphMixin):
@tornado.web.authenticated
@tornado.web.asynchronous
def get(self):
self.facebook_request(
"/me/feed",
post_args={"message": "I am posting from my Tornado application!"},
access_token=self.current_user["access_token"],
callback=self.async_callback(self._on_post))
def _on_post(self, new_entry):
if not new_entry:
# Call failed; perhaps missing permission?
self.authorize_redirect()
return
self.finish("Posted a message!")
"""
url = "https://graph.facebook.com" + path
all_args = {}
if access_token:
all_args["access_token"] = access_token
all_args.update(args)
all_args.update(post_args or {})
if all_args:
url += "?" + urllib.urlencode(all_args)
response = content_remote.get_url(url, post=(post_args is not None))
self._on_facebook_request(callback, response)
def get_sync_authenticated_user(self, redirect_uri, client_id, client_secret,
code, callback, extra_fields=None):
args = {
"client_id": client_id,
"client_secret": client_secret,
"code": code,
"redirect_uri": redirect_uri,
"extra_params": {"scope": self._OAUTH_SCOPE_URL,
"grant_type": 'authorization_code', }
}
response = content_remote.get_url(self._oauth_request_token_url(**args),
post=True)
self._on_access_token(callback, response)
def authorize_redirect(self, callback_uri=None, extra_params=None,
http_client=None):
"""Redirects the user to obtain OAuth authorization for this service.
Twitter and FriendFeed both require that you register a Callback
URL with your application. You should call this method to log the
user in, and then call get_authenticated_user() in the handler
you registered as your Callback URL to complete the authorization
process.
This method sets a cookie called _oauth_request_token which is
subsequently used (and cleared) in get_authenticated_user for
security purposes.
"""
if callback_uri and getattr(self, "_OAUTH_NO_CALLBACKS", False):
raise Exception("This service does not support oauth_callback")
if getattr(self, "_OAUTH_VERSION", "1.0a") == "1.0a":
response = content_remote.get_url(self._oauth_request_token_url(
callback_uri=callback_uri, extra_params=extra_params))
self._on_request_token(self._OAUTH_AUTHORIZE_URL, callback_uri, self.noop, response)
else:
response = content_remote.get_url(self._oauth_request_token_url())
self._on_request_token(self._OAUTH_AUTHORIZE_URL, callback_uri, self.noop, response)
def google_request(self, path, callback, access_token=None,
post_args=None, **args):
url = "https://www.googleapis.com/plus/v1" + path
if access_token:
all_args = {}
all_args.update(args)
all_args.update(post_args or {})
method = "POST" if post_args is not None else "GET"
oauth = self._oauth_request_parameters(
url, access_token, all_args, method=method)
args.update(oauth)
if args:
url += "?" + urllib.urlencode(args)
response = content_remote.get_url(url, post=(post_args is not None))
self._on_google_request(callback, response)
def facebook_request(self, path, callback, access_token=None,
post_args=None, **args):
"""Fetches the given relative API path, e.g., "/btaylor/picture"
If the request is a POST, post_args should be provided. Query
string arguments should be given as keyword arguments.
An introduction to the Facebook Graph API can be found at
http://developers.facebook.com/docs/api
Many methods require an OAuth access token which you can obtain
through authorize_redirect() and get_authenticated_user(). The
user returned through that process includes an 'access_token'
attribute that can be used to make authenticated requests via
this method. Example usage::
class MainHandler(tornado.web.RequestHandler,
tornado.auth.FacebookGraphMixin):
@tornado.web.authenticated
@tornado.web.asynchronous
def get(self):
self.facebook_request(
"/me/feed",
post_args={"message": "I am posting from my Tornado application!"},
access_token=self.current_user["access_token"],
callback=self.async_callback(self._on_post))
def _on_post(self, new_entry):
if not new_entry:
# Call failed; perhaps missing permission?
self.authorize_redirect()
return
self.finish("Posted a message!")
"""
url = "https://graph.facebook.com" + path
all_args = {}
if access_token:
all_args["access_token"] = access_token
all_args.update(args)
all_args.update(post_args or {})
if all_args:
url += "?" + urllib.urlencode(all_args)
response = content_remote.get_url(url, post=(post_args is not None))
self._on_facebook_request(callback, response)
def get_sync_authenticated_user(self,
redirect_uri,
client_id,
client_secret,
code,
callback,
extra_fields=None):
args = {
"client_id": client_id,
"client_secret": client_secret,
"code": code,
"redirect_uri": redirect_uri,
}
response = content_remote.get_url(
self._oauth_request_token_url(**args), post=True)
self._on_access_token(callback, response)
def get_sync_authenticated_user(self,
redirect_uri,
client_id,
client_secret,
code,
callback,
extra_fields=None):
args = {
"client_id": client_id,
"client_secret": client_secret,
"code": code,
"redirect_uri": redirect_uri,
"extra_params": {
"scope": self._OAUTH_SCOPE_URL,
"grant_type": 'authorization_code',
}
}
response = content_remote.get_url(
self._oauth_request_token_url(**args), post=True)
self._on_access_token(callback, response)
def tumblr_request(self, path, callback, access_token=None,
post_args=None, **args):
#http://www.tumblr.com/docs/en/api/v2
url = path
# Add the OAuth resource request signature if we have credentials
if access_token:
all_args = {}
all_args.update(args)
all_args.update(post_args or {})
method = "POST" if post_args is not None else "GET"
oauth = self._oauth_request_parameters(
url, access_token, all_args, method=method)
args.update(oauth)
if post_args:
args.update(post_args)
if args:
url += "?" + urllib.urlencode(args)
response = content_remote.get_url(url, post=(post_args is not None))
self._on_tumblr_request(callback, response)
def google_request(self,
path,
callback,
access_token=None,
post_args=None,
**args):
url = "https://www.googleapis.com/plus/v1" + path
if access_token:
all_args = {}
all_args.update(args)
all_args.update(post_args or {})
method = "POST" if post_args is not None else "GET"
oauth = self._oauth_request_parameters(url,
access_token,
all_args,
method=method)
args.update(oauth)
if args:
url += "?" + urllib.urlencode(args)
response = content_remote.get_url(url, post=(post_args is not None))
self._on_google_request(callback, response)
def twitter_request(self,
path,
callback,
access_token=None,
post_args=None,
**args):
"""Fetches the given API path, e.g., "/statuses/user_timeline/btaylor"
The path should not include the format (we automatically append
".json" and parse the JSON output).
If the request is a POST, post_args should be provided. Query
string arguments should be given as keyword arguments.
All the Twitter methods are documented at
http://apiwiki.twitter.com/Twitter-API-Documentation.
Many methods require an OAuth access token which you can obtain
through authorize_redirect() and get_authenticated_user(). The
user returned through that process includes an 'access_token'
attribute that can be used to make authenticated requests via
this method. Example usage::
class MainHandler(tornado.web.RequestHandler,
tornado.auth.TwitterMixin):
@tornado.web.authenticated
@tornado.web.asynchronous
def get(self):
self.twitter_request(
"/statuses/update",
post_args={"status": "Testing Tornado Web Server"},
access_token=user["access_token"],
callback=self.async_callback(self._on_post))
def _on_post(self, new_entry):
if not new_entry:
# Call failed; perhaps missing permission?
self.authorize_redirect()
return
self.finish("Posted a message!")
"""
if path.startswith('http:') or path.startswith('https:'):
# Raw urls are useful for e.g. search which doesn't follow the
# usual pattern: http://search.twitter.com/search.json
url = path
else:
url = "http://api.twitter.com/1" + path + ".json"
# Add the OAuth resource request signature if we have credentials
if access_token:
all_args = {}
all_args.update(args)
if path != self.UPDATE_WITH_MEDIA_URL:
all_args.update(post_args or {})
method = "POST" if post_args is not None else "GET"
oauth = self._oauth_request_parameters(url,
access_token,
all_args,
method=method)
args.update(oauth)
if post_args and path != self.UPDATE_WITH_MEDIA_URL:
args.update(post_args)
if args:
url += "?" + urllib.urlencode(args)
body = None
if path == self.UPDATE_WITH_MEDIA_URL:
msg = MIMEMultipart("form-data")
for arg in post_args:
if arg == 'media[]':
mime_image = MIMEImage(post_args[arg],
_encoder=email.encoders.encode_noop)
mime_image.add_header("Content-Disposition",
"form-data",
name="media[]",
filename="media[]")
mime_image.add_header("Content-Length",
str(len(post_args[arg])))
msg.attach(mime_image)
else:
mime_text = MIMEText(post_args[arg])
mime_text.add_header("Content-Disposition",
"form-data",
name=arg)
mime_text.set_charset("utf-8")
msg.attach(mime_text)
body = msg.as_string()
response = content_remote.get_url(url,
post=(post_args is not None),
body=body)
self._on_twitter_request(callback, response)
def twitter_request(self, path, callback, access_token=None,
post_args=None, **args):
"""Fetches the given API path, e.g., "/statuses/user_timeline/btaylor"
The path should not include the format (we automatically append
".json" and parse the JSON output).
If the request is a POST, post_args should be provided. Query
string arguments should be given as keyword arguments.
All the Twitter methods are documented at
http://apiwiki.twitter.com/Twitter-API-Documentation.
Many methods require an OAuth access token which you can obtain
through authorize_redirect() and get_authenticated_user(). The
user returned through that process includes an 'access_token'
attribute that can be used to make authenticated requests via
this method. Example usage::
class MainHandler(tornado.web.RequestHandler,
tornado.auth.TwitterMixin):
@tornado.web.authenticated
@tornado.web.asynchronous
def get(self):
self.twitter_request(
"/statuses/update",
post_args={"status": "Testing Tornado Web Server"},
access_token=user["access_token"],
callback=self.async_callback(self._on_post))
def _on_post(self, new_entry):
if not new_entry:
# Call failed; perhaps missing permission?
self.authorize_redirect()
return
self.finish("Posted a message!")
"""
if path.startswith('http:') or path.startswith('https:'):
# Raw urls are useful for e.g. search which doesn't follow the
# usual pattern: http://search.twitter.com/search.json
url = path
else:
url = "http://api.twitter.com/1" + path + ".json"
# Add the OAuth resource request signature if we have credentials
if access_token:
all_args = {}
all_args.update(args)
if path != self.UPDATE_WITH_MEDIA_URL:
all_args.update(post_args or {})
method = "POST" if post_args is not None else "GET"
oauth = self._oauth_request_parameters(
url, access_token, all_args, method=method)
args.update(oauth)
if post_args and path != self.UPDATE_WITH_MEDIA_URL:
args.update(post_args)
if args:
url += "?" + urllib.urlencode(args)
body = None
if path == self.UPDATE_WITH_MEDIA_URL:
msg = MIMEMultipart("form-data")
for arg in post_args:
if arg == 'media[]':
mime_image = MIMEImage(post_args[arg],
_encoder = email.encoders.encode_noop)
mime_image.add_header("Content-Disposition", "form-data",
name="media[]", filename="media[]")
mime_image.add_header("Content-Length", str(len(post_args[arg])))
msg.attach(mime_image)
else:
mime_text = MIMEText(post_args[arg])
mime_text.add_header("Content-Disposition", "form-data", name=arg)
mime_text.set_charset("utf-8")
msg.attach(mime_text)
body = msg.as_string()
response = content_remote.get_url(url, post=(post_args is not None),
body=body)
self._on_twitter_request(callback, response)