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
|
# encoding: utf-8
import time
import re
import sys
import unittest
import warnings
import twitter
import responses
from responses import GET, POST
warnings.filterwarnings('ignore', category=DeprecationWarning)
DEFAULT_URL = re.compile(r'https?://.*\.twitter.com/1\.1/.*')
HEADERS = {'x-rate-limit-limit': '63',
'x-rate-limit-remaining': '63',
'x-rate-limit-reset': '626672700'}
class ErrNull(object):
""" Suppress output of tests while writing to stdout or stderr. This just
takes in data and does nothing with it.
"""
def write(self, data):
pass
class RateLimitTests(unittest.TestCase):
""" Tests for RateLimit object """
def setUp(self):
self.api = twitter.Api(
consumer_key='test',
consumer_secret='test',
access_token_key='test',
access_token_secret='test',
sleep_on_rate_limit=False)
self.base_url = 'https://api.twitter.com/1.1'
self._stderr = sys.stderr
sys.stderr = ErrNull()
def tearDown(self):
sys.stderr = self._stderr
pass
@responses.activate
def testInitializeRateLimit(self):
with open('testdata/ratelimit.json') as f:
resp_data = f.read()
responses.add(GET, DEFAULT_URL, body=resp_data)
self.api.InitializeRateLimit()
self.assertTrue(self.api.rate_limit)
self.rate_limit = None
self.api.sleep_on_rate_limit = True
self.api.InitializeRateLimit()
self.assertTrue(self.api.rate_limit)
self.assertTrue(self.api.sleep_on_rate_limit)
responses.add(responses.GET, url=DEFAULT_URL, body=b'{}', status=200)
try:
self.api.GetStatus(status_id=1234)
self.api.GetUser(screen_name='test')
except Exception as e:
self.fail(e)
@responses.activate
def testCheckRateLimit(self):
with open('testdata/ratelimit.json') as f:
resp_data = f.read()
responses.add(GET, DEFAULT_URL, body=resp_data)
rt = self.api.CheckRateLimit('https://api.twitter.com/1.1/help/privacy.json')
self.assertEqual(rt.limit, 15)
self.assertEqual(rt.remaining, 15)
self.assertEqual(rt.reset, 1452254278)
class RateLimitMethodsTests(unittest.TestCase):
""" Tests for RateLimit object """
@responses.activate
def setUp(self):
self.api = twitter.Api(
consumer_key='test',
consumer_secret='test',
access_token_key='test',
access_token_secret='test',
sleep_on_rate_limit=False)
self.base_url = 'https://api.twitter.com/1.1'
self._stderr = sys.stderr
sys.stderr = ErrNull()
with open('testdata/ratelimit.json') as f:
resp_data = f.read()
url = '%s/application/rate_limit_status.json?tweet_mode=compat' % self.api.base_url
responses.add(
responses.GET,
url,
body=resp_data,
match_querystring=True,
status=200)
self.api.InitializeRateLimit()
self.assertTrue(self.api.rate_limit)
def tearDown(self):
sys.stderr = self._stderr
pass
def testGetRateLimit(self):
lim = self.api.rate_limit.get_limit('/lists/members')
self.assertEqual(lim.limit, 180)
self.assertEqual(lim.remaining, 180)
self.assertEqual(lim.reset, 1452254278)
def testNonStandardEndpointRateLimit(self):
lim = self.api.rate_limit.get_limit(
'https://api.twitter.com/1.1/geo/id/312.json?skip_status=True')
self.assertEqual(lim.limit, 47)
lim = self.api.rate_limit.get_limit(
'https://api.twitter.com/1.1/saved_searches/destroy/312.json')
self.assertEqual(lim.limit, 15)
lim = self.api.rate_limit.get_limit(
'https://api.twitter.com/1.1/statuses/retweets/312.json?skip_status=True')
self.assertEqual(lim.limit, 23)
def testSetRateLimit(self):
previous_limit = self.api.rate_limit.get_limit('/lists/members')
self.assertEqual(previous_limit.remaining, 180)
self.api.rate_limit.set_limit(
url='https://api.twitter.com/1.1/lists/members.json?skip_status=True',
limit=previous_limit.limit,
remaining=previous_limit.remaining - 1,
reset=previous_limit.reset)
new_limit = self.api.rate_limit.get_limit('/lists/members')
self.assertEqual(new_limit.remaining, previous_limit.remaining - 1)
self.assertEqual(new_limit.limit, previous_limit.limit)
self.assertEqual(new_limit.reset, previous_limit.reset)
def testFamilyNotFound(self):
limit = self.api.rate_limit.get_limit('/tests/test')
self.assertEqual(limit.limit, 15)
self.assertEqual(limit.remaining, 15)
self.assertEqual(limit.reset, 0)
def testSetUnknownRateLimit(self):
self.api.rate_limit.set_limit(
url='https://api.twitter.com/1.1/not/a/real/endpoint.json',
limit=15,
remaining=14,
reset=100)
limit = self.api.rate_limit.get_limit(
url='https://api.twitter.com/1.1/not/a/real/endpoint.json')
self.assertEqual(limit.remaining, 14)
def testSetUnknownRateLimit(self):
self.api.rate_limit.set_unknown_limit(
url='https://api.twitter.com/1.1/not/a/real/endpoint.json',
limit=15,
remaining=14,
reset=100)
limit = self.api.rate_limit.get_limit(
url='https://api.twitter.com/1.1/not/a/real/endpoint.json')
self.assertEqual(limit.remaining, 14)
@responses.activate
def testLimitsViaHeadersNoSleep(self):
api = twitter.Api(
consumer_key='test',
consumer_secret='test',
access_token_key='test',
access_token_secret='test',
sleep_on_rate_limit=False)
# Get initial rate limit data to populate api.rate_limit object
with open('testdata/ratelimit.json') as f:
resp_data = f.read()
url = '%s/application/rate_limit_status.json' % self.api.base_url
responses.add(responses.GET, url, body=resp_data, match_querystring=True)
# Add a test URL just to have headers present
responses.add(
method=responses.GET, url=DEFAULT_URL, body='{}', adding_headers=HEADERS)
resp = api.GetSearch(term='test')
self.assertTrue(api.rate_limit.__dict__)
self.assertEqual(api.rate_limit.get_limit('/search/tweets').limit, 63)
self.assertEqual(api.rate_limit.get_limit('/search/tweets').remaining, 63)
self.assertEqual(api.rate_limit.get_limit('/search/tweets').reset, 626672700)
# No other resource families should be set during above operation.
test_url = '/lists/subscribers/show.json'
self.assertEqual(
api.rate_limit.__dict__.get('resources').get(test_url), None
)
# But if we check them, it should go to default 15/15
self.assertEqual(api.rate_limit.get_limit(test_url).remaining, 15)
self.assertEqual(api.rate_limit.get_limit(test_url).limit, 15)
@responses.activate
def testLimitsViaHeadersWithSleep(self):
api = twitter.Api(
consumer_key='test',
consumer_secret='test',
access_token_key='test',
access_token_secret='test',
sleep_on_rate_limit=True)
# Add handler for ratelimit check
url = '%s/application/rate_limit_status.json?tweet_mode=compat' % api.base_url
responses.add(
method=responses.GET, url=url, body='{}', match_querystring=True)
# Get initial rate limit data to populate api.rate_limit object
url = "https://api.twitter.com/1.1/search/tweets.json?tweet_mode=compat&q=test&count=15&result_type=mixed"
responses.add(
method=responses.GET,
url=url,
body='{}',
match_querystring=True,
adding_headers=HEADERS)
resp = api.GetSearch(term='test')
self.assertTrue(api.rate_limit)
self.assertEqual(api.rate_limit.get_limit('/search/tweets').limit, 63)
self.assertEqual(api.rate_limit.get_limit('/search/tweets').remaining, 63)
self.assertEqual(api.rate_limit.get_limit('/search/tweets').reset, 626672700)
|
