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
352 lines (304 loc) · 13 KB
/
TwitterAPI.py
File metadata and controls
352 lines (304 loc) · 13 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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
__author__ = "geduldig"
__date__ = "June 7, 2013"
__license__ = "MIT"
from .BearerAuth import BearerAuth as OAuth2
from .constants import *
from datetime import datetime
from requests.exceptions import ConnectionError, ReadTimeout, SSLError
from requests.packages.urllib3.exceptions import ReadTimeoutError, ProtocolError
from requests_oauthlib import OAuth1
from .TwitterError import *
import json
import requests
import socket
import ssl
import time
import os
DEFAULT_USER_AGENT = os.getenv('DEFAULT_USER_AGENT', 'python-TwitterAPI')
DEFAULT_CONNECTION_TIMEOUT = os.getenv('DEFAULT_CONNECTION_TIMEOUT', 5)
DEFAULT_STREAMING_TIMEOUT = os.getenv('DEFAULT_STREAMING_TIMEOUT', 90)
DEFAULT_REST_TIMEOUT = os.getenv('DEFAULT_REST_TIMEOUT', 5)
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"
:param proxy_url: HTTPS proxy URL string (ex. "https://USER:PASSWORD@SERVER:PORT"),
or dict of URLs (ex. {'http':'http://SERVER', 'https':'https://SERVER'})
"""
# static properties to be overridden if desired
USER_AGENT = DEFAULT_USER_AGENT
CONNECTION_TIMEOUT = DEFAULT_CONNECTION_TIMEOUT
STREAMING_TIMEOUT = DEFAULT_STREAMING_TIMEOUT
REST_TIMEOUT = DEFAULT_REST_TIMEOUT
def __init__(
self,
consumer_key=None,
consumer_secret=None,
access_token_key=None,
access_token_secret=None,
auth_type='oAuth1',
proxy_url=None):
"""Initialize with your Twitter application credentials"""
if isinstance(proxy_url, dict):
self.proxies = proxy_url
elif proxy_url is not None:
self.proxies = {'https': proxy_url}
else:
self.proxies = None
if auth_type == '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 == 'oAuth2':
if not all([consumer_key, consumer_secret]):
raise Exception('Missing authentication parameter')
self.auth = OAuth2(
consumer_key,
consumer_secret,
proxies=self.proxies,
user_agent=self.USER_AGENT)
else:
raise Exception('Unknown oAuth version')
def _prepare_url(self, subdomain, path):
if subdomain == 'curator':
return '%s://%s.%s/%s/%s.json' % (PROTOCOL,
subdomain,
DOMAIN,
CURATOR_VERSION,
path)
elif subdomain == 'ads-api':
return '%s://%s.%s/%s/%s' % (PROTOCOL,
subdomain,
DOMAIN,
ADS_VERSION,
path)
elif subdomain == 'api' and 'labs/' in path:
return '%s://%s.%s/%s' % (PROTOCOL,
subdomain,
DOMAIN,
path)
else:
return '%s://%s.%s/%s/%s.json' % (PROTOCOL,
subdomain,
DOMAIN,
VERSION,
path)
def _get_endpoint(self, resource):
"""Substitute any 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, method_override=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)
:param method_override: Request method to override or None (default)
:returns: TwitterResponse
:raises: TwitterConnectionError
"""
resource, endpoint = self._get_endpoint(resource)
if endpoint not in ENDPOINTS:
raise Exception('Endpoint "%s" unsupported' % endpoint)
with requests.Session() as session:
session.auth = self.auth
session.headers = {'User-Agent': self.USER_AGENT}
method, subdomain = ENDPOINTS[endpoint]
if method_override:
method = method_override
url = self._prepare_url(subdomain, resource)
if 'stream' in subdomain:
session.stream = True
timeout = self.STREAMING_TIMEOUT
# always use 'delimited' for efficient stream parsing
if not params:
params = {}
params['delimited'] = 'length'
params['stall_warning'] = 'true'
else:
session.stream = False
timeout = self.REST_TIMEOUT
if method == 'POST':
data = params
params = None
else:
data = None
try:
if method == 'PUT':
session.headers['Content-type'] = 'application/json'
data = params
r = session.request(
method,
url,
json=data)
else:
r = session.request(
method,
url,
data=data,
params=params,
timeout=(self.CONNECTION_TIMEOUT, timeout),
files=files,
proxies=self.proxies)
except (ConnectionError, ProtocolError, ReadTimeout, ReadTimeoutError,
SSLError, ssl.SSLError, socket.error) as e:
raise TwitterConnectionError(e)
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 json(self, **kwargs):
"""Get the response as a JSON object.
:param \*\*kwargs: Optional arguments that ``json.loads`` takes.
:returns: response as JSON object.
:raises: ValueError
"""
return self.response.json(**kwargs)
def get_iterator(self):
"""Get API dependent iterator.
:returns: Iterator for tweets or other message objects in response.
:raises: TwitterConnectionError, TwitterRequestError
"""
if self.response.status_code != 200:
raise TwitterRequestError(self.response.status_code)
if self.stream:
return iter(_StreamingIterable(self.response))
else:
return iter(_RestIterable(self.response))
def __iter__(self):
"""Get API dependent iterator.
:returns: Iterator for tweets or other message objects in response.
:raises: TwitterConnectionError, TwitterRequestError
"""
return self.get_iterator()
def get_quota(self):
"""Quota information in the REST-only response header.
:returns: Dictionary of 'remaining' (count), 'limit' (count), 'reset' (time)
"""
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}
def close(self):
"""Disconnect stream (blocks with Python 3)."""
self.response.raw.close()
class _RestIterable(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()
# convert json response into something iterable
if 'errors' in resp:
self.results = resp['errors']
elif 'statuses' in resp:
self.results = resp['statuses']
elif 'users' in resp:
self.results = resp['users']
elif 'ids' in resp:
self.results = resp['ids']
elif 'results' in resp:
self.results = resp['results']
elif 'data' in resp and not isinstance(resp['data'], dict):
self.results = resp['data']
elif hasattr(resp, '__iter__') and not isinstance(resp, 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 _StreamingIterable(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.stream = response.raw
def _iter_stream(self):
"""Stream parser.
:returns: Next item in the stream (may or may not be 'delimited').
:raises: TwitterConnectionError, StopIteration
"""
while True:
item = None
buf = bytearray()
stall_timer = None
try:
while True:
# read bytes until item boundary reached
buf += self.stream.read(1)
if not buf:
# check for stall (i.e. no data for 90 seconds)
if not stall_timer:
stall_timer = time.time()
elif time.time() - stall_timer > TwitterAPI.STREAMING_TIMEOUT:
raise TwitterConnectionError('Twitter stream stalled')
elif stall_timer:
stall_timer = None
if buf[-2:] == b'\r\n':
item = buf[0:-2]
if item.isdigit():
# use byte size to read next item
nbytes = int(item)
item = None
item = self.stream.read(nbytes)
break
yield item
except (ConnectionError, ProtocolError, ReadTimeout, ReadTimeoutError,
SSLError, ssl.SSLError, socket.error) as e:
raise TwitterConnectionError(e)
except AttributeError:
# inform iterator to exit when client closes connection
raise StopIteration
def __iter__(self):
"""Iterator.
:returns: Tweet status as a JSON object.
:raises: TwitterConnectionError
"""
for item in self._iter_stream():
if item:
try:
yield json.loads(item.decode('utf8'))
except ValueError as e:
# invalid JSON string (possibly an unformatted error message)
raise TwitterConnectionError(e)