forked from geduldig/TwitterAPI
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathTwitterAPI.py
More file actions
168 lines (137 loc) · 5.52 KB
/
TwitterAPI.py
File metadata and controls
168 lines (137 loc) · 5.52 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
__author__ = "Jonas Geduldig"
__date__ = "June 7, 2013"
__license__ = "MIT"
from .BearerAuth import BearerAuth
from .constants import *
import json
import requests
from requests_oauthlib import OAuth1
class TwitterAPI(object):
"""Access REST API or Streaming API resources.
:param consumer_key: Twitter application consumer key
:param consumer_secret: Twitter application consumer secret
:param access_token_key: Twitter application access token key
:param access_token_secret: Twitter application access token secret
:param auth_type: "oAuth1" (default) or "oAuth2"
"""
def __init__(self, consumer_key=None, consumer_secret=None, access_token_key=None, access_token_secret=None, auth_type="oAuth1"):
"""Initialize with your Twitter application credentials"""
if auth_type is "oAuth1":
if not all([consumer_key, consumer_secret, access_token_key, access_token_secret]):
raise Exception("Missing authentication parameter.")
self.auth = OAuth1(consumer_key, consumer_secret, access_token_key, access_token_secret)
elif auth_type is "oAuth2":
if not all([consumer_key, consumer_secret]):
raise Exception("Missing authentication parameter.")
token_url = '%s://%s.%s/%s' % (PROTOCOL, REST_SUBDOMAIN, DOMAIN, OAUTH2_TOKEN_ENDPOINT)
self.auth = BearerAuth(token_url, consumer_key, consumer_secret)
def _prepare_url(self, subdomain, path):
return '%s://%s.%s/%s/%s.json' % (PROTOCOL, subdomain, DOMAIN, VERSION, path)
def _get_endpoint(self, resource):
""" Substitute parameters in the resource path with :PARAM."""
if ':' in resource:
parts = resource.split('/')
# embedded parameters start with ':'
parts = [k if k[0] != ':' else ':PARAM' for k in parts]
endpoint = '/'.join(parts)
resource = resource.replace(':', '')
return (resource, endpoint)
else:
return (resource, resource)
def request(self, resource, params=None, files=None):
"""Request a Twitter REST API or Streaming API resource.
:param resource: A valid Twitter endpoint (ex. "search/tweets")
:param params: Dictionary with endpoint parameters or None (default)
:param files: Dictionary with multipart-encoded file or None (default)
:returns: TwitterAPI.TwitterResponse object
"""
session = requests.Session()
session.auth = self.auth
session.headers = {'User-Agent':USER_AGENT}
resource, endpoint = self._get_endpoint(resource)
if endpoint in STREAMING_ENDPOINTS:
session.stream = True
method = 'GET' if params is None else 'POST'
url = self._prepare_url(STREAMING_ENDPOINTS[endpoint][0], resource)
timeout = STREAMING_SOCKET_TIMEOUT
elif endpoint in REST_ENDPOINTS:
session.stream = False
method = REST_ENDPOINTS[endpoint][0]
url = self._prepare_url(REST_SUBDOMAIN, resource)
timeout = REST_SOCKET_TIMEOUT
else:
raise Exception('"%s" is not valid endpoint' % resource)
r = session.request(method, url, params=params, timeout=timeout, files=files)
return TwitterResponse(r, session.stream)
class TwitterResponse(object):
"""Response from either a REST API or Streaming API resource call.
:param response: The requests.Response object returned by the API call
:param stream: Boolean connection type (True if a streaming connection)
"""
def __init__(self, response, stream):
self.response = response
self.stream = stream
@property
def headers(self):
""":returns: Dictionary of API response header contents."""
return self.response.headers
@property
def status_code(self):
""":returns: HTTP response status code."""
return self.response.status_code
@property
def text(self):
""":returns: Raw API response text."""
return self.response.text
def get_iterator(self):
""":returns: TwitterAPI.StreamingIterator or TwitterAPI.RestIterator."""
if self.stream:
return StreamingIterator(self.response)
else:
return RestIterator(self.response)
def __iter__(self):
for item in self.get_iterator():
yield item
def get_rest_quota(self):
""":returns: Quota information in the response header. Valid only for REST API responses."""
remaining, limit, reset = None, None, None
if self.response:
if 'x-rate-limit-remaining' in self.response.headers:
remaining = int(self.response.headers['x-rate-limit-remaining'])
if remaining == 0:
limit = int(self.response.headers['x-rate-limit-limit'])
reset = int(self.response.headers['x-rate-limit-reset'])
reset = datetime.fromtimestamp(reset)
return {'remaining': remaining, 'limit': limit, 'reset': reset}
class RestIterator(object):
"""Iterate statuses, errors or other iterable objects in a REST API response.
:param response: The request.Response from a Twitter REST API request
"""
def __init__(self, response):
resp = response.json()
if 'errors' in resp:
self.results = resp['errors']
elif 'statuses' in resp:
self.results = resp['statuses']
elif hasattr(resp, '__iter__') and type(resp) is not dict:
if len(resp) > 0 and 'trends' in resp[0]:
self.results = resp[0]['trends']
else:
self.results = resp
else:
self.results = (resp,)
def __iter__(self):
"""Return a tweet status as a JSON object."""
for item in self.results:
yield item
class StreamingIterator(object):
"""Iterate statuses or other objects in a Streaming API response.
:param response: The request.Response from a Twitter Streaming API request
"""
def __init__(self, response):
self.results = response.iter_lines()
def __iter__(self):
"""Return a tweet status as a JSON object."""
for item in self.results:
if item:
yield json.loads(item.decode('utf-8'))