test_api.py 12.7 KB
Newer Older
1
2
import unittest
import random
3
from time import sleep
Josh Roesslein's avatar
Josh Roesslein committed
4
import os
5

Joshua Roesslein's avatar
Joshua Roesslein committed
6
7
from nose import SkipTest

Joshua Roesslein's avatar
Joshua Roesslein committed
8
from tweepy import (API, OAuthHandler, Friendship, Cursor,
9
                    MemoryCache, FileCache)
10

11
from config import *
Josh Roesslein's avatar
Josh Roesslein committed
12

13
14
test_tweet_id = '266367358078169089'

15
16
"""Unit tests"""

17
18
19
20
21
22
23
24
25
26
27
28
class TweepyErrorTests(unittest.TestCase):

    def testpickle(self):
        """Verify exceptions can be pickled and unpickled."""
        import pickle
        from tweepy.error import TweepError

        e = TweepError('no reason', {'status': 200})
        e2 = pickle.loads(pickle.dumps(e))

        self.assertEqual(e.reason, e2.reason)
        self.assertEqual(e.response, e2.response)
Josh Roesslein's avatar
Josh Roesslein committed
29

30
31
class TweepyAPITests(unittest.TestCase):

Josh Roesslein's avatar
Josh Roesslein committed
32
    def setUp(self):
33
34
35
        auth = OAuthHandler(oauth_consumer_key, oauth_consumer_secret)
        auth.set_access_token(oauth_token, oauth_token_secret)
        self.api = API(auth)
Josh Roesslein's avatar
Josh Roesslein committed
36
37
        self.api.retry_count = 2
        self.api.retry_delay = 5
Josh Roesslein's avatar
Josh Roesslein committed
38

Miriam Sexton's avatar
Miriam Sexton committed
39
40
    # TODO: Actually have some sort of better assertion
    def testgetoembed(self):
Miriam Sexton's avatar
Miriam Sexton committed
41
        data = self.api.get_oembed(test_tweet_id)
Miriam Sexton's avatar
Miriam Sexton committed
42
43
44
        self.assertEqual(data['author_name'], "Twitter")


45
46
47
    def testhometimeline(self):
        self.api.home_timeline()

Josh Roesslein's avatar
Josh Roesslein committed
48
    def testusertimeline(self):
49
50
        self.api.user_timeline()
        self.api.user_timeline('twitter')
Josh Roesslein's avatar
Josh Roesslein committed
51

Joshua Roesslein's avatar
Joshua Roesslein committed
52
53
    def testmentionstimeline(self):
        self.api.mentions_timeline()
54
55
56
57
58

    def testretweetsofme(self):
        self.api.retweets_of_me()

    def testretweet(self):
Joshua Roesslein's avatar
Joshua Roesslein committed
59
60
        # TODO(josh): Need a way to get random tweets to retweet.
        raise SkipTest()
61
62

    def testretweets(self):
63
        self.api.retweets(test_tweet_id)
64

Josh Roesslein's avatar
Josh Roesslein committed
65
    def testgetstatus(self):
66
        self.api.get_status(id=test_tweet_id)
Josh Roesslein's avatar
Josh Roesslein committed
67
68
69
70
71
72
73
74
75
76
77
78

    def testupdateanddestroystatus(self):
        # test update
        text = 'testing %i' % random.randint(0, 1000)
        update = self.api.update_status(status=text)
        self.assertEqual(update.text, text)

        # test destroy
        deleted = self.api.destroy_status(id=update.id)
        self.assertEqual(deleted.id, update.id)

    def testgetuser(self):
79
80
81
82
        u = self.api.get_user('twitter')
        self.assertEqual(u.screen_name, 'twitter')

        u = self.api.get_user(783214)
Josh Roesslein's avatar
Josh Roesslein committed
83
84
        self.assertEqual(u.screen_name, 'twitter')

85
86
87
    def testsearchusers(self):
        self.api.search_users('twitter')

88
89
90
    def testsuggestedcategories(self):
        self.api.suggested_categories()

91
92
93
94
95
96
97
98
99
    def testsuggestedusers(self):
        categories = self.api.suggested_categories()
        if len(categories) != 0:
            self.api.suggested_users(categories[0].slug)

    def testsuggesteduserstweets(self):
        categories = self.api.suggested_categories()
        if len(categories) != 0:
            self.api.suggested_users_tweets(categories[0].slug)
100

Josh Roesslein's avatar
Josh Roesslein committed
101
102
103
104
105
    def testme(self):
        me = self.api.me()
        self.assertEqual(me.screen_name, username)

    def testdirectmessages(self):
106
107
108
109
        self.api.direct_messages()

    def testsentdirectmessages(self):
        self.api.sent_direct_messages()
Josh Roesslein's avatar
Josh Roesslein committed
110
111
112

    def testsendanddestroydirectmessage(self):
        # send
Joshua Roesslein's avatar
Joshua Roesslein committed
113
        sent_dm = self.api.send_direct_message(username, text='test message')
Josh Roesslein's avatar
Josh Roesslein committed
114
115
116
117
118
119
120
121
122
123
124
        self.assertEqual(sent_dm.text, 'test message')
        self.assertEqual(sent_dm.sender.screen_name, username)
        self.assertEqual(sent_dm.recipient.screen_name, username)

        # destroy
        destroyed_dm = self.api.destroy_direct_message(sent_dm.id)
        self.assertEqual(destroyed_dm.text, sent_dm.text)
        self.assertEqual(destroyed_dm.id, sent_dm.id)
        self.assertEqual(destroyed_dm.sender.screen_name, username)
        self.assertEqual(destroyed_dm.recipient.screen_name, username)

125
    def testcreatedestroyfriendship(self):
Josh Roesslein's avatar
Josh Roesslein committed
126
127
128
        enemy = self.api.destroy_friendship('twitter')
        self.assertEqual(enemy.screen_name, 'twitter')

129
130
131
132
        # Wait 5 seconds to allow Twitter time
        # to process the friendship destroy request.
        sleep(5)

133
134
135
        friend = self.api.create_friendship('twitter')
        self.assertEqual(friend.screen_name, 'twitter')

Josh Roesslein's avatar
Josh Roesslein committed
136
137
138
139
140
    def testshowfriendship(self):
        source, target = self.api.show_friendship(target_screen_name='twtiter')
        self.assert_(isinstance(source, Friendship))
        self.assert_(isinstance(target, Friendship))

141
142
143
144
145
146
    def testfriendsids(self):
        self.api.friends_ids(username)

    def testfollowersids(self):
        self.api.followers_ids(username)

147
148
149
150
151
152
    def testfriends(self):
        self.api.friends(username)

    def testfollowers(self):
        self.api.followers(username)

153
    def testverifycredentials(self):
154
        self.assertNotEqual(self.api.verify_credentials(), False)
155

156
157
158
159
160
161
162
163
        # make sure that `me.status.entities` is not an empty dict
        me = self.api.verify_credentials(include_entities=True)
        self.assertTrue(me.status.entities)

        # `status` shouldn't be included
        me = self.api.verify_credentials(skip_status=True)
        self.assertFalse(hasattr(me, 'status'))

164
165
166
    def testratelimitstatus(self):
        self.api.rate_limit_status()

167
    """ TODO(josh): Remove once this deprecated API is gone.
168
169
170
    def testsetdeliverydevice(self):
        self.api.set_delivery_device('im')
        self.api.set_delivery_device('none')
171
    """
172
173
174

    def testupdateprofilecolors(self):
        original = self.api.me()
Josh Roesslein's avatar
Josh Roesslein committed
175
        updated = self.api.update_profile_colors('000', '000', '000', '000', '000')
176
177
178
179
180
181
182
183
184
185

        # restore colors
        self.api.update_profile_colors(
            original.profile_background_color,
            original.profile_text_color,
            original.profile_link_color,
            original.profile_sidebar_fill_color,
            original.profile_sidebar_border_color
        )

Joshua Roesslein's avatar
Joshua Roesslein committed
186
187
188
189
190
        self.assertEqual(updated.profile_background_color, '000000')
        self.assertEqual(updated.profile_text_color, '000000')
        self.assertEqual(updated.profile_link_color, '000000')
        self.assertEqual(updated.profile_sidebar_fill_color, '000000')
        self.assertEqual(updated.profile_sidebar_border_color, '000000')
191

192
    """
193
194
195
196
197
    def testupateprofileimage(self):
        self.api.update_profile_image('examples/profile.png')

    def testupdateprofilebg(self):
        self.api.update_profile_background_image('examples/bg.png')
198
    """
199
200
201
202
203
204
205
206
207
208

    def testupdateprofile(self):
        original = self.api.me()
        profile = {
            'name': 'Tweepy test 123',
            'location': 'pytopia',
            'description': 'just testing things out'
        }
        updated = self.api.update_profile(**profile)
        self.api.update_profile(
209
            name = original.name, url = original.url,
210
211
212
213
            location = original.location, description = original.description
        )

        for k,v in profile.items():
Josh Roesslein's avatar
Josh Roesslein committed
214
            if k == 'email': continue
215
216
217
218
219
220
            self.assertEqual(getattr(updated, k), v)

    def testfavorites(self):
        self.api.favorites()

    def testcreatedestroyfavorite(self):
Josh Roesslein's avatar
Josh Roesslein committed
221
222
        self.api.create_favorite(4901062372)
        self.api.destroy_favorite(4901062372)
223
224
225
226

    def testcreatedestroyblock(self):
        self.api.create_block('twitter')
        self.api.destroy_block('twitter')
Josh Roesslein's avatar
Josh Roesslein committed
227
        self.api.create_friendship('twitter') # restore
228
229
230
231
232
233
234

    def testblocks(self):
        self.api.blocks()

    def testblocksids(self):
        self.api.blocks_ids()

Josh Roesslein's avatar
Josh Roesslein committed
235
    def testcreateupdatedestroylist(self):
236
237
238
239
        params = {
            'owner_screen_name': username,
            'slug': 'tweeps'
        }
Joshua Roesslein's avatar
Joshua Roesslein committed
240
241
        l = self.api.create_list(name=params['slug'], **params)
        l = self.api.update_list(list_id=l.id, description='updated!')
242
        self.assertEqual(l.description, 'updated!')
Joshua Roesslein's avatar
Joshua Roesslein committed
243
        self.api.destroy_list(list_id=l.id)
Josh Roesslein's avatar
Josh Roesslein committed
244

Joshua Roesslein's avatar
Joshua Roesslein committed
245
246
    def testlistsall(self):
        self.api.lists_all()
Josh Roesslein's avatar
Josh Roesslein committed
247
248
249
250
251
252
253
254

    def testlistsmemberships(self):
        self.api.lists_memberships()

    def testlistssubscriptions(self):
        self.api.lists_subscriptions()

    def testlisttimeline(self):
Joshua's avatar
Joshua committed
255
        self.api.list_timeline('applepie', 'stars')
Josh Roesslein's avatar
Josh Roesslein committed
256
257

    def testgetlist(self):
Joshua Roesslein's avatar
Joshua Roesslein committed
258
        self.api.get_list(owner_screen_name='applepie', slug='stars')
Josh Roesslein's avatar
Josh Roesslein committed
259
260

    def testaddremovelistmember(self):
261
262
263
264
265
266
267
268
269
270
271
        params = {
            'slug': 'test',
            'owner_screen_name': username,
            'screen_name': 'twitter'
        }

        def assert_list(l):
            self.assertEqual(l.name, params['slug'])

        assert_list(self.api.add_list_member(**params))
        assert_list(self.api.remove_list_member(**params))
Josh Roesslein's avatar
Josh Roesslein committed
272
273

    def testlistmembers(self):
Joshua's avatar
Joshua committed
274
        self.api.list_members('applepie', 'stars')
Josh Roesslein's avatar
Josh Roesslein committed
275

Joshua Roesslein's avatar
Joshua Roesslein committed
276
277
    def testshowlistmember(self):
        self.assertTrue(self.api.show_list_member(owner_screen_name='applepie', slug='stars', screen_name='NathanFillion'))
Josh Roesslein's avatar
Josh Roesslein committed
278
279

    def testsubscribeunsubscribelist(self):
Joshua Roesslein's avatar
Joshua Roesslein committed
280
281
282
283
284
285
        params = {
            'owner_screen_name': 'applepie',
            'slug': 'stars'
        }
        self.api.subscribe_list(**params)
        self.api.unsubscribe_list(**params)
Josh Roesslein's avatar
Josh Roesslein committed
286
287

    def testlistsubscribers(self):
Joshua's avatar
Joshua committed
288
        self.api.list_subscribers('applepie', 'stars')
Josh Roesslein's avatar
Josh Roesslein committed
289

Joshua Roesslein's avatar
Joshua Roesslein committed
290
    def testshowlistsubscriber(self):
Joshua Roesslein's avatar
Joshua Roesslein committed
291
        self.assertTrue(self.api.show_list_subscriber('twitter', 'team', username))
Josh Roesslein's avatar
Josh Roesslein committed
292

293
294
295
    def testsavedsearches(self):
        s = self.api.create_saved_search('test')
        self.api.saved_searches()
Josh Roesslein's avatar
Josh Roesslein committed
296
        self.assertEqual(self.api.get_saved_search(s.id).query, 'test')
297
298
299
        self.api.destroy_saved_search(s.id)

    def testsearch(self):
Josh Roesslein's avatar
Josh Roesslein committed
300
        self.api.search('tweepy')
301

302
    def testgeoapis(self):
303
304
305
306
307
308
309
310
311
312
313
        def place_name_in_list(place_name, place_list):
            """Return True if a given place_name is in place_list."""
            return any([x.full_name.lower() == place_name.lower() for x in place_list])

        twitter_hq = self.api.geo_similar_places(lat=37, long= -122, name='Twitter HQ')
        # Assumes that twitter_hq is first Place returned...
        self.assertEqual(twitter_hq[0].id, '3bdf30ed8b201f31')
        # Test various API functions using Austin, TX, USA
        self.assertEqual(self.api.geo_id(id='c3f37afa9efcf94b').full_name, 'Austin, TX')
        self.assertTrue(place_name_in_list('Austin, TX',
            self.api.reverse_geocode(lat=30.267370168467806, long= -97.74261474609375))) # Austin, TX, USA
314

Josh Roesslein's avatar
Josh Roesslein committed
315
316
317
class TweepyCursorTests(unittest.TestCase):

    def setUp(self):
318
319
320
        auth = OAuthHandler(oauth_consumer_key, oauth_consumer_secret)
        auth.set_access_token(oauth_token, oauth_token_secret)
        self.api = API(auth)
Josh Roesslein's avatar
Josh Roesslein committed
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
        self.api.retry_count = 2
        self.api.retry_delay = 5

    def testpagecursoritems(self):
        items = list(Cursor(self.api.user_timeline).items())
        self.assert_(len(items) > 0)

        items = list(Cursor(self.api.user_timeline, 'twitter').items(30))
        self.assert_(len(items) == 30)

    def testpagecursorpages(self):
        pages = list(Cursor(self.api.user_timeline).pages())
        self.assert_(len(pages) > 0)

        pages = list(Cursor(self.api.user_timeline, 'twitter').pages(5))
        self.assert_(len(pages) == 5)

    def testcursorcursoritems(self):
Joshua Roesslein's avatar
Joshua Roesslein committed
339
        items = list(Cursor(self.api.friends_ids).items())
Josh Roesslein's avatar
Josh Roesslein committed
340
341
        self.assert_(len(items) > 0)

Joshua Roesslein's avatar
Joshua Roesslein committed
342
        items = list(Cursor(self.api.followers_ids, 'twitter').items(30))
Josh Roesslein's avatar
Josh Roesslein committed
343
344
345
        self.assert_(len(items) == 30)

    def testcursorcursorpages(self):
Joshua Roesslein's avatar
Joshua Roesslein committed
346
        pages = list(Cursor(self.api.friends_ids).pages())
Josh Roesslein's avatar
Josh Roesslein committed
347
348
        self.assert_(len(pages) > 0)

Joshua Roesslein's avatar
Joshua Roesslein committed
349
        pages = list(Cursor(self.api.followers_ids, 'twitter').pages(5))
Josh Roesslein's avatar
Josh Roesslein committed
350
        self.assert_(len(pages) == 5)
Josh Roesslein's avatar
Josh Roesslein committed
351

352
353
class TweepyCacheTests(unittest.TestCase):

Josh Roesslein's avatar
Josh Roesslein committed
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
    timeout = 2.0
    memcache_servers = ['127.0.0.1:11211']  # must be running for test to pass

    def _run_tests(self, do_cleanup=True):
        # test store and get
        self.cache.store('testkey', 'testvalue')
        self.assertEqual(self.cache.get('testkey'), 'testvalue',
            'Stored value does not match retrieved value')

        # test timeout
        sleep(self.timeout)
        self.assertEqual(self.cache.get('testkey'), None,
            'Cache entry should have expired')

        # test cleanup
        if do_cleanup:
            self.cache.store('testkey', 'testvalue')
            sleep(self.timeout)
            self.cache.cleanup()
            self.assertEqual(self.cache.count(), 0, 'Cache cleanup failed')

        # test count
        for i in range(0, 20):
            self.cache.store('testkey%i' % i, 'testvalue')
        self.assertEqual(self.cache.count(), 20, 'Count is wrong')

        # test flush
        self.cache.flush()
        self.assertEqual(self.cache.count(), 0, 'Cache failed to flush')

    def testmemorycache(self):
        self.cache = MemoryCache(timeout=self.timeout)
        self._run_tests()

    def testfilecache(self):
        os.mkdir('cache_test_dir')
        self.cache = FileCache('cache_test_dir', self.timeout)
        self._run_tests()
        self.cache.flush()
        os.rmdir('cache_test_dir')
394

395
if __name__ == '__main__':
Josh Roesslein's avatar
Josh Roesslein committed
396
    unittest.main()