test_api.py 11.8 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 *
12
13
14
from httreplay import start_replay, stop_replay
from httreplay.utils import filter_headers_key
import os
Josh Roesslein's avatar
Josh Roesslein committed
15

16
17
test_tweet_id = '266367358078169089'

18
19
"""Unit tests"""

20
21
22
23
24
25
26
27
28
29
30
31
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
32

33
34
class TweepyAPITests(unittest.TestCase):

Josh Roesslein's avatar
Josh Roesslein committed
35
    def setUp(self):
36
37
        if os.environ['TRAVIS_SECURE_ENV_VARS'] == 'false':
            start_replay('records/test.json', headers_key=filter_headers_key(['Authorization']))
38
39
40
        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
41
42
        self.api.retry_count = 2
        self.api.retry_delay = 5
Josh Roesslein's avatar
Josh Roesslein committed
43

44
45
46
    def tearDown(self):
        stop_replay()

Miriam Sexton's avatar
Miriam Sexton committed
47
48
    # TODO: Actually have some sort of better assertion
    def testgetoembed(self):
Miriam Sexton's avatar
Miriam Sexton committed
49
        data = self.api.get_oembed(test_tweet_id)
Miriam Sexton's avatar
Miriam Sexton committed
50
51
52
        self.assertEqual(data['author_name'], "Twitter")


53
54
55
    def testhometimeline(self):
        self.api.home_timeline()

Josh Roesslein's avatar
Josh Roesslein committed
56
    def testusertimeline(self):
57
58
        self.api.user_timeline()
        self.api.user_timeline('twitter')
Josh Roesslein's avatar
Josh Roesslein committed
59

Joshua Roesslein's avatar
Joshua Roesslein committed
60
61
    def testmentionstimeline(self):
        self.api.mentions_timeline()
62
63
64
65
66

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

    def testretweet(self):
Joshua Roesslein's avatar
Joshua Roesslein committed
67
68
        # TODO(josh): Need a way to get random tweets to retweet.
        raise SkipTest()
69
70

    def testretweets(self):
71
        self.api.retweets(test_tweet_id)
72

Josh Roesslein's avatar
Josh Roesslein committed
73
    def testgetstatus(self):
74
        self.api.get_status(id=test_tweet_id)
Josh Roesslein's avatar
Josh Roesslein committed
75
76
77
78
79
80
81
82
83
84
85
86

    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):
87
88
89
90
        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
91
92
        self.assertEqual(u.screen_name, 'twitter')

93
94
95
    def testsearchusers(self):
        self.api.search_users('twitter')

96
97
98
    def testsuggestedcategories(self):
        self.api.suggested_categories()

99
100
101
102
103
104
105
106
107
    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)
108

Josh Roesslein's avatar
Josh Roesslein committed
109
110
111
112
113
    def testme(self):
        me = self.api.me()
        self.assertEqual(me.screen_name, username)

    def testdirectmessages(self):
114
115
116
117
        self.api.direct_messages()

    def testsentdirectmessages(self):
        self.api.sent_direct_messages()
Josh Roesslein's avatar
Josh Roesslein committed
118
119
120

    def testsendanddestroydirectmessage(self):
        # send
Joshua Roesslein's avatar
Joshua Roesslein committed
121
        sent_dm = self.api.send_direct_message(username, text='test message')
Josh Roesslein's avatar
Josh Roesslein committed
122
123
124
125
126
127
128
129
130
131
132
        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)

133
    def testcreatedestroyfriendship(self):
Josh Roesslein's avatar
Josh Roesslein committed
134
135
136
        enemy = self.api.destroy_friendship('twitter')
        self.assertEqual(enemy.screen_name, 'twitter')

137
138
139
140
        # Wait 5 seconds to allow Twitter time
        # to process the friendship destroy request.
        sleep(5)

141
142
143
        friend = self.api.create_friendship('twitter')
        self.assertEqual(friend.screen_name, 'twitter')

Josh Roesslein's avatar
Josh Roesslein committed
144
145
146
147
148
    def testshowfriendship(self):
        source, target = self.api.show_friendship(target_screen_name='twtiter')
        self.assert_(isinstance(source, Friendship))
        self.assert_(isinstance(target, Friendship))

149
150
151
152
153
154
    def testfriendsids(self):
        self.api.friends_ids(username)

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

155
156
157
158
159
160
    def testfriends(self):
        self.api.friends(username)

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

161
    def testverifycredentials(self):
162
        self.assertNotEqual(self.api.verify_credentials(), False)
163

164
165
166
167
168
169
170
171
        # 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'))

172
173
174
    def testratelimitstatus(self):
        self.api.rate_limit_status()

175
    """ TODO(josh): Remove once this deprecated API is gone.
176
177
178
    def testsetdeliverydevice(self):
        self.api.set_delivery_device('im')
        self.api.set_delivery_device('none')
179
    """
180
181
182

    def testupdateprofilecolors(self):
        original = self.api.me()
Josh Roesslein's avatar
Josh Roesslein committed
183
        updated = self.api.update_profile_colors('000', '000', '000', '000', '000')
184
185
186
187
188
189
190
191
192
193

        # 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
194
195
196
197
198
        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')
199

200
    """
201
202
203
204
205
    def testupateprofileimage(self):
        self.api.update_profile_image('examples/profile.png')

    def testupdateprofilebg(self):
        self.api.update_profile_background_image('examples/bg.png')
206
    """
207
208
209
210
211
212
213
214
215
216

    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(
217
            name = original.name, url = original.url,
218
219
220
221
            location = original.location, description = original.description
        )

        for k,v in profile.items():
Josh Roesslein's avatar
Josh Roesslein committed
222
            if k == 'email': continue
223
224
225
226
227
228
            self.assertEqual(getattr(updated, k), v)

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

    def testcreatedestroyfavorite(self):
Josh Roesslein's avatar
Josh Roesslein committed
229
230
        self.api.create_favorite(4901062372)
        self.api.destroy_favorite(4901062372)
231
232
233
234

    def testcreatedestroyblock(self):
        self.api.create_block('twitter')
        self.api.destroy_block('twitter')
Josh Roesslein's avatar
Josh Roesslein committed
235
        self.api.create_friendship('twitter') # restore
236
237
238
239
240
241
242

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

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

Josh Roesslein's avatar
Josh Roesslein committed
243
    def testcreateupdatedestroylist(self):
244
245
246
247
        params = {
            'owner_screen_name': username,
            'slug': 'tweeps'
        }
Joshua Roesslein's avatar
Joshua Roesslein committed
248
249
        l = self.api.create_list(name=params['slug'], **params)
        l = self.api.update_list(list_id=l.id, description='updated!')
250
        self.assertEqual(l.description, 'updated!')
Joshua Roesslein's avatar
Joshua Roesslein committed
251
        self.api.destroy_list(list_id=l.id)
Josh Roesslein's avatar
Josh Roesslein committed
252

Joshua Roesslein's avatar
Joshua Roesslein committed
253
254
    def testlistsall(self):
        self.api.lists_all()
Josh Roesslein's avatar
Josh Roesslein committed
255
256
257
258
259
260
261
262

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

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

    def testlisttimeline(self):
Joshua's avatar
Joshua committed
263
        self.api.list_timeline('applepie', 'stars')
Josh Roesslein's avatar
Josh Roesslein committed
264
265

    def testgetlist(self):
Joshua Roesslein's avatar
Joshua Roesslein committed
266
        self.api.get_list(owner_screen_name='applepie', slug='stars')
Josh Roesslein's avatar
Josh Roesslein committed
267
268

    def testaddremovelistmember(self):
269
270
271
272
273
274
275
276
277
278
        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))
279
        sleep(3)
280
        assert_list(self.api.remove_list_member(**params))
Josh Roesslein's avatar
Josh Roesslein committed
281
282

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

Joshua Roesslein's avatar
Joshua Roesslein committed
285
286
    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
287
288

    def testsubscribeunsubscribelist(self):
Joshua Roesslein's avatar
Joshua Roesslein committed
289
290
291
292
293
294
        params = {
            'owner_screen_name': 'applepie',
            'slug': 'stars'
        }
        self.api.subscribe_list(**params)
        self.api.unsubscribe_list(**params)
Josh Roesslein's avatar
Josh Roesslein committed
295
296

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

Joshua Roesslein's avatar
Joshua Roesslein committed
299
    def testshowlistsubscriber(self):
Joshua Roesslein's avatar
Joshua Roesslein committed
300
        self.assertTrue(self.api.show_list_subscriber('tweepytest', 'test', 'applepie'))
Josh Roesslein's avatar
Josh Roesslein committed
301

302
303
304
    def testsavedsearches(self):
        s = self.api.create_saved_search('test')
        self.api.saved_searches()
Josh Roesslein's avatar
Josh Roesslein committed
305
        self.assertEqual(self.api.get_saved_search(s.id).query, 'test')
306
307
308
        self.api.destroy_saved_search(s.id)

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

311
    def testgeoapis(self):
312
313
314
315
316
317
318
319
320
321
322
        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
323

324
325
class TweepyCacheTests(unittest.TestCase):

Josh Roesslein's avatar
Josh Roesslein committed
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
353
354
355
356
357
358
359
360
361
362
363
364
365
    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')
366

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