Added support for Twitter Ads API

.gitignore

@@ -41,3 +41,4 @@ docs/_build
 test.py
 
 .venv
+.idea

tests/config.py

@@ -28,3 +28,7 @@
 
 test_tweet_object = {u'contributors': None, u'truncated': False, u'text': u'http://t.co/FCmXyI6VHd is a #cool site, lol! @mikehelmick shd #checkitout. Love, @__twython__ https://t.co/67pwRvY6z9 http://t.co/N6InAO4B71', u'in_reply_to_status_id': None, u'id': 349683012054683648, u'favorite_count': 0, u'source': u'web', u'retweeted': False, u'coordinates': None, u'entities': {u'symbols': [], u'user_mentions': [{u'id': 29251354, u'indices': [45, 57], u'id_str': u'29251354', u'screen_name': u'mikehelmick', u'name': u'Mike Helmick'}, {u'id': 1431865928, u'indices': [81, 93], u'id_str': u'1431865928', u'screen_name': u'__twython__', u'name': u'Twython'}], u'hashtags': [{u'indices': [28, 33], u'text': u'cool'}, {u'indices': [62, 73], u'text': u'checkitout'}], u'urls': [{u'url': u'http://t.co/FCmXyI6VHd', u'indices': [0, 22], u'expanded_url': u'http://google.com', u'display_url': u'google.com'}, {u'url': u'https://t.co/67pwRvY6z9', u'indices': [94, 117], u'expanded_url': u'https://github.com', u'display_url': u'github.com'}], u'media': [{u'id': 537884378513162240, u'id_str': u'537884378513162240', u'indices': [118, 140], u'media_url': u'http://pbs.twimg.com/media/B3by_g-CQAAhrO5.jpg', u'media_url_https': u'https://pbs.twimg.com/media/B3by_g-CQAAhrO5.jpg', u'url': u'http://t.co/N6InAO4B71', u'display_url': u'pic.twitter.com/N6InAO4B71', u'expanded_url': u'http://twitter.com/pingofglitch/status/537884380060844032/photo/1', u'type': u'photo', u'sizes': {u'large': {u'w': 1024, u'h': 640, u'resize': u'fit'}, u'thumb': {u'w': 150, u'h': 150, u'resize': u'crop'}, u'medium': {u'w': 600, u'h': 375, u'resize': u'fit'}, u'small': {u'w': 340, u'h': 212, u'resize': u'fit'}}}]}, u'in_reply_to_screen_name': None, u'id_str': u'349683012054683648', u'retweet_count': 0, u'in_reply_to_user_id': None, u'favorited': False, u'user': {u'follow_request_sent': False, u'profile_use_background_image': True, u'default_profile_image': True, u'id': 1431865928, u'verified': False, u'profile_text_color': u'333333', u'profile_image_url_https': u'https://si0.twimg.com/sticky/default_profile_images/default_profile_3_normal.png', u'profile_sidebar_fill_color': u'DDEEF6', u'entities': {u'description': {u'urls': []}}, u'followers_count': 1, u'profile_sidebar_border_color': u'C0DEED', u'id_str': u'1431865928', u'profile_background_color': u'3D3D3D', u'listed_count': 0, u'profile_background_image_url_https': u'https://si0.twimg.com/images/themes/theme1/bg.png', u'utc_offset': None, u'statuses_count': 2, u'description': u'', u'friends_count': 1, u'location': u'', u'profile_link_color': u'0084B4', u'profile_image_url': u'http://a0.twimg.com/sticky/default_profile_images/default_profile_3_normal.png', u'following': False, u'geo_enabled': False, u'profile_background_image_url': u'http://a0.twimg.com/images/themes/theme1/bg.png', u'screen_name': u'__twython__', u'lang': u'en', u'profile_background_tile': False, u'favourites_count': 0, u'name': u'Twython', u'notifications': False, u'url': None, u'created_at': u'Thu May 16 01:11:09 +0000 2013', u'contributors_enabled': False, u'time_zone': None, u'protected': False, u'default_profile': False, u'is_translator': False}, u'geo': None, u'in_reply_to_user_id_str': None, u'possibly_sensitive': False, u'lang': u'en', u'created_at': u'Wed Jun 26 00:18:21 +0000 2013', u'in_reply_to_status_id_str': None, u'place': None}
 test_tweet_html = '<a href="http://t.co/FCmXyI6VHd" class="twython-url">google.com</a> is a <a href="https://twitter.com/search?q=%23cool" class="twython-hashtag">#cool</a> site, lol! <a href="https://twitter.com/mikehelmick" class="twython-mention">@mikehelmick</a> shd <a href="https://twitter.com/search?q=%23checkitout" class="twython-hashtag">#checkitout</a>. Love, <a href="https://twitter.com/__twython__" class="twython-mention">@__twython__</a> <a href="https://t.co/67pwRvY6z9" class="twython-url">github.com</a> <a href="http://t.co/N6InAO4B71" class="twython-media">pic.twitter.com/N6InAO4B71</a>'
+
+test_account_id = os.environ.get('TEST_ACCOUNT_ID')
+test_funding_instrument_id = os.environ.get('TEST_FUNDING_INSTRUMENT_ID')
+test_campaign_id = os.environ.get('TEST_CAMPAIGN_ID')

tests/test_endpoints.py

@@ -1,15 +1,17 @@
+import base64
+import datetime
+import urllib
+import time
 from twython import Twython, TwythonError, TwythonAuthError
 
 from .config import (
     app_key, app_secret, oauth_token, oauth_token_secret,
     protected_twitter_1, protected_twitter_2, screen_name,
     test_tweet_id, test_list_slug, test_list_owner_screen_name,
-    access_token, test_tweet_object, test_tweet_html, unittest
+    access_token, test_tweet_object, test_tweet_html, unittest,
+    test_account_id, test_funding_instrument_id, test_campaign_id
 )
 
-import time
-
-
 class TwythonEndpointsTestCase(unittest.TestCase):
     def setUp(self):
 
@@ -531,3 +533,261 @@ def test_get_tos(self):
     def test_get_application_rate_limit_status(self):
         """Test getting application rate limit status succeeds"""
         self.oauth2_api.get_application_rate_limit_status()
+
+
+class TwythonEndpointsAdsTestCase(unittest.TestCase):
+    TEST_CAMPAIGN = {
+        'name': 'Test Twitter campaign - Twython',
+        'funding_instrument_id': test_funding_instrument_id,
+        'start_time': datetime.datetime.utcnow().strftime('%Y-%m-%dT%H:%M:%SZ'),
+        'daily_budget_amount_local_micro': 10 * 1000000,
+        'paused': True
+    }
+
+    TEST_WEBSITE_CLICKS_LINE_ITEM = {
+        'bid_type': 'MAX',
+        'bid_amount_local_micro': 2000000,
+        'product_type': 'PROMOTED_TWEETS',
+        'placements': 'ALL_ON_TWITTER',
+        'objective': 'WEBSITE_CLICKS',
+        'paused': True
+    }
+
+    def setUp(self):
+        client_args = {
+            'headers': {
+                'User-Agent': '__twython__ Test'
+            },
+            'allow_redirects': False
+        }
+
+        # This is so we can hit coverage that Twython sets
+        # User-Agent for us if none is supplied
+        oauth2_client_args = {
+            'headers': {}
+        }
+
+        self.api = Twython(app_key, app_secret,
+                           oauth_token, oauth_token_secret,
+                           client_args=client_args)
+
+        self.oauth2_api = Twython(app_key, access_token=access_token,
+                                  client_args=oauth2_client_args)
+
+    @unittest.skip('skipping non-updated test')
+    def test_get_accounts(self):
+        accounts = self.api.get_accounts()
+        self.assertTrue(len(accounts) >= 0)
+
+    @unittest.skip('skipping non-updated test')
+    def test_get_account(self):
+        account = self.api.get_account(test_account_id)
+        self.assertEqual(account['id'], test_account_id)
+        with self.assertRaises(TwythonError):
+            self.api.get_account('1234')
+
+    @unittest.skip('skipping non-updated test')
+    def test_get_account_features(self):
+        account_features = self.api.get_account_features(test_account_id)
+        self.assertTrue(len(account_features) >= 0)
+
+    @unittest.skip('skipping non-updated test')
+    def test_get_funding_instruments(self):
+        funding_instruments = self.api.get_funding_instruments(test_account_id)
+        self.assertTrue(len(funding_instruments) >= 0)
+
+    @unittest.skip('skipping non-updated test')
+    def test_get_funding_instrument(self):
+        funding_instrument = self.api.get_funding_instrument(test_account_id, test_funding_instrument_id)
+        self.assertEqual(funding_instrument['id'], test_funding_instrument_id)
+        self.assertEqual(funding_instrument['account_id'], test_account_id)
+        with self.assertRaises(TwythonError):
+            self.api.get_funding_instrument('1234', '1234')
+
+    @unittest.skip('skipping non-updated test')
+    def test_get_iab_categories(self):
+        iab_categories = self.api.get_iab_categories()
+        self.assertTrue(len(iab_categories) >= 0)
+
+    @unittest.skip('skipping non-updated test')
+    def test_get_available_platforms(self):
+        available_platforms = self.api.get_available_platforms()
+        self.assertTrue(len(available_platforms) >= 0)
+
+    @unittest.skip('skipping non-updated test')
+    def test_get_available_locations(self):
+        params = {
+            'location_type': 'CITY',
+            'country_code': 'US'
+        }
+        available_locations = self.api.get_available_locations(**params)
+        self.assertTrue(len(available_locations) > 0)
+
+    @unittest.skip('skipping non-updated test')
+    def test_get_campaigns(self):
+        campaigns = self.api.get_campaigns(test_account_id)
+        self.assertTrue(len(campaigns) >= 0)
+
+    @unittest.skip('skipping non-updated test')
+    def test_create_and_delete_campaign(self):
+        campaign_id = self._create_test_campaign()
+        campaign_check = self.api.get_campaign(test_account_id, campaign_id)
+        self.assertEqual(campaign_check['id'], campaign_id)
+        self._delete_test_campaign(campaign_id)
+
+    def _create_test_campaign(self):
+        campaign = self.api.create_campaign(test_account_id, **self.TEST_CAMPAIGN)
+        campaign_id = campaign['id']
+        self.assertEqual(campaign['account_id'], test_account_id)
+        self.assertIsNotNone(campaign_id)
+        return campaign_id
+
+    def _delete_test_campaign(self, campaign_id):
+        is_deleted = self.api.delete_campaign(test_account_id, campaign_id)
+        self.assertTrue(is_deleted)
+
+    @unittest.skip('skipping non-updated test')
+    def test_create_and_delete_line_item(self):
+        campaign_id = self._create_test_campaign()
+        line_item_id = self._create_test_line_item(campaign_id)
+        line_items = self.api.get_line_items(test_account_id, campaign_id)
+        self.assertTrue(len(line_items) > 0)
+        self._delete_test_line_item(line_item_id)
+        self._delete_test_campaign(campaign_id)
+
+    def _create_test_line_item(self, campaign_id):
+        response = self.api.create_line_item(test_account_id, campaign_id, **self.TEST_WEBSITE_CLICKS_LINE_ITEM)
+        line_item_id = response['id']
+        self.assertEqual(response['account_id'], test_account_id)
+        self.assertEqual(response['campaign_id'], campaign_id)
+        self.assertIsNotNone(line_item_id)
+        return line_item_id
+
+    def _delete_test_line_item(self, line_item_id):
+        is_deleted = self.api.delete_line_item(test_account_id, line_item_id)
+        self.assertTrue(is_deleted)
+
+    @unittest.skip('skipping non-updated test')
+    def test_upload_image(self):
+        response = self._upload_test_image()
+        self.assertIsNotNone(response['media_id'])
+
+    def _upload_test_image(self):
+        image_file = urllib.urlopen('https://openclipart.org/image/800px/svg_to_png/190042/1389527622.png').read()
+        image_file_encoded = base64.b64encode(image_file)
+        upload_data = {
+            'media_data': image_file_encoded
+            # the line below will have to be provided once we start uploading photos on behalf of advertisers
+            # 'additional_owners': ''
+        }
+        response = self.api.upload_image(**upload_data)
+        return response
+
+    @unittest.skip('skipping non-updated test')
+    def test_get_website_cards(self):
+        response = self.api.get_website_cards(test_account_id)
+        self.assertTrue(len(response) >= 0)
+
+    @unittest.skip('skipping non-updated test')
+    def test_create_and_delete_website_card(self):
+        card_id = self._create_test_website_card()
+        card = self.api.get_website_card(test_account_id, card_id)
+        self.assertEqual(card['id'], card_id)
+        self._delete_test_website_card(card_id)
+
+    def _create_test_website_card(self):
+        uploaded_image = self._upload_test_image()
+        test_website_card = {
+            'name': 'Zemanta Partnered with AdsNative for Programmatic Native Supply',
+            'website_title': 'Zemanta Partnered with AdsNative for Programmatic Native Supply',
+            'website_url': 'http://r1.zemanta.com/r/u1tllsoizjls/facebook/1009/92325/',
+            'website_cta': 'READ_MORE',
+            'image_media_id': uploaded_image['media_id_string']
+        }
+        response_create = self.api.create_website_card(test_account_id, **test_website_card)
+        card_id = response_create['id']
+        self.assertEqual(response_create['account_id'], test_account_id)
+        self.assertIsNotNone(card_id)
+        return card_id
+
+    def _delete_test_website_card(self, card_id):
+        response_delete = self.api.delete_website_card(test_account_id, card_id)
+        self.assertEqual(response_delete['id'], card_id)
+
+    @unittest.skip('skipping non-updated test')
+    def test_create_promoted_only_tweet(self):
+        card_id, tweet_id = self._create_test_promoted_only_tweet()
+        self._delete_test_website_card(card_id)
+
+    def _create_test_promoted_only_tweet(self):
+        card_id = self._create_test_website_card()
+        card = self.api.get_website_card(test_account_id, card_id)
+        test_promoted_only_tweet = {
+            'status': 'This is test tweet for website card: %s' % card['preview_url'],
+            # 'as_user_id': '',
+        }
+        response = self.api.create_promoted_only_tweet(test_account_id, **test_promoted_only_tweet)
+        tweet_id = response['id']
+        self.assertIsNotNone(tweet_id)
+        return card_id, tweet_id
+
+    @unittest.skip('skipping non-updated test')
+    def test_promote_and_unpromote_tweet(self):
+        campaign_id = self._create_test_campaign()
+        line_item_id = self._create_test_line_item(campaign_id)
+        card_id, tweet_id = self._create_test_promoted_only_tweet()
+        test_tweet_promotion = {
+            'line_item_id': line_item_id,
+            'tweet_ids': [tweet_id]
+        }
+        result_promote = self.api.promote_tweet(test_account_id, **test_tweet_promotion)
+        self.assertTrue(len(result_promote) > 0)
+        self.assertEqual(int(result_promote[0]['tweet_id']), tweet_id)
+        promotion_id = result_promote[0]['id']
+        self.assertIsNotNone(promotion_id)
+        promoted_tweets = self.api.get_promoted_tweets(test_account_id, line_item_id)
+        self.assertTrue(len(promoted_tweets) == 1)
+        result_unpromotion = self.api.unpromote_tweet(test_account_id, promotion_id)
+        self.assertTrue(result_unpromotion['deleted'])
+        self.assertEqual(result_unpromotion['id'], promotion_id)
+        self._delete_test_campaign(campaign_id)
+        self._delete_test_website_card(card_id)
+
+    @unittest.skip('skipping non-updated test')
+    def test_add_targeting_criteria(self):
+        campaign_id = self._create_test_campaign()
+        line_item_id = self._create_test_line_item(campaign_id)
+        criteria_ios_id = self._create_test_targeting_criteria(line_item_id, 'PLATFORM', '0')
+        criteria_android_id = self._create_test_targeting_criteria(line_item_id, 'PLATFORM', '1')
+        criteria_desktop_id = self._create_test_targeting_criteria(line_item_id, 'PLATFORM', '4')
+        criteria_new_york_id = self._create_test_targeting_criteria(line_item_id, 'LOCATION', 'b6c2e04f1673337f')
+        # since all the targeting criteria share the same id, we only have to do the removal once.
+        self.api.remove_targeting_criteria(test_account_id, criteria_ios_id)
+        self.api.remove_targeting_criteria(test_account_id, criteria_android_id)
+        self.api.remove_targeting_criteria(test_account_id, criteria_desktop_id)
+        self.api.remove_targeting_criteria(test_account_id, criteria_new_york_id)
+        self._delete_test_line_item(line_item_id)
+        self._delete_test_campaign(campaign_id)
+
+    def _create_test_targeting_criteria(self, line_item_id, targeting_type, targeting_value):
+        test_targeting_criteria_ios = {
+            'targeting_type': targeting_type,
+            'targeting_value': targeting_value
+        }
+        response_add = self.api.add_targeting_criteria(test_account_id, line_item_id, **test_targeting_criteria_ios)
+        self.assertEqual(response_add['account_id'], test_account_id)
+        self.assertEquals(response_add['line_item_id'], line_item_id)
+        return response_add['id']
+
+    @unittest.skip('skipping non-updated test')
+    def test_get_stats_promoted_tweets(self):
+        line_items = self.api.get_line_items(test_account_id, test_campaign_id)
+        promoted_tweets = self.api.get_promoted_tweets(test_account_id, line_items[0]['id'])
+        promoted_ids = [tweet['id'] for tweet in promoted_tweets]
+        stats_query = {
+            'start_time': '2015-10-29T00:00:00Z',
+            'end_time': '2015-10-29T23:59:59Z',
+            'granularity': 'TOTAL'
+        }
+        stats = self.api.get_stats_promoted_tweets(test_account_id, promoted_ids, **stats_query)
+        self.assertTrue(len(stats) >= 0)