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
232 lines (193 loc) · 7.94 KB
/
TwitterAPI.py
File metadata and controls
232 lines (193 loc) · 7.94 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
__author__ = "Jonas Geduldig"
__date__ = "June 7, 2013"
__license__ = "MIT"
from .constants import *
import json
from requests_oauthlib import OAuth1
from .BearerAuth import BearerAuth as OAuth2
from datetime import datetime
import requests
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 (ex. "https://USER:PASSWORD@SERVER:PORT")
"""
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"""
self.proxies = {'https': proxy_url} if proxy_url else None
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.")
self.auth = OAuth2(
consumer_key,
consumer_secret,
proxies=self.proxies)
def _prepare_url(self, subdomain, path):
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):
"""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)
if method is 'POST':
data = params
params = None
else:
data = None
r = session.request(
method,
url,
data=data,
params=params,
timeout=timeout,
files=files,
proxies=self.proxies)
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):
return self.get_iterator()
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):
self._generator = self._get_next_result()
resp = response.json()
if 'errors' in resp:
self.results = resp['errors']
elif 'statuses' in resp:
self.results = resp['statuses']
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 self
def next(self):
"""Return a tweet status as a JSON object. Python 2 compatibility"""
return self.__next__()
def __next__(self):
"""Return a tweet status as a JSON object."""
if hasattr(self._generator, "next"):
return self._generator.next() #Python 2 compatibility
else:
return next(self._generator)
def _get_next_result(self):
"""Internal generator to support iteration over results"""
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._generator = self._get_next_result()
self.results = response.iter_lines(1)
def __iter__(self):
return self
def next(self):
"""Return a tweet status as a JSON object. Python 2 compatibility"""
return self.__next__()
def __next__(self):
"""Return a tweet status as a JSON object."""
if hasattr(self._generator, "next"):
return self._generator.next() #Python 2 compatibility
else:
return next(self._generator)
def _get_next_result(self):
"""Internal generator to support iteration over results"""
for item in self.results:
if item:
yield json.loads(item.decode('utf-8'))