Adding the ability to get the suggested user categories

d2dcrc-wdp · d2dcrc-wdp · commit 83167b460bd9 · 2015-11-09T15:30:49.000+10:30
diff --git a/setup.py b/setup.py
@@ -29,7 +29,7 @@ def read(*paths):
 
 setup(
     name='python-twitter',
-    version='2.3',
+    version='2.3.1',
     author='The Python-Twitter Developers',
     author_email='python-twitter@googlegroups.com',
     license='Apache License 2.0',
diff --git a/twitter/__init__.py b/twitter/__init__.py
@@ -19,7 +19,7 @@
 """A library that provides a Python interface to the Twitter API"""
 
 __author__ = 'python-twitter@googlegroups.com'
-__version__ = '2.3'
+__version__ = '2.3.1'
 
 import json
 
@@ -37,5 +37,6 @@
 from .url import Url
 from .status import Status
 from .user import User, UserStatus
+from .category import Category
 from .list import List
 from .api import Api
diff --git a/twitter/api.py b/twitter/api.py
@@ -36,6 +36,7 @@
 
 from twitter import (__version__, _FileCache, json, DirectMessage, List,
                      Status, Trend, TwitterError, User, UserStatus)
+from twitter.category import Category
 
 CHARACTER_LIMIT = 140
 
@@ -341,7 +342,7 @@ def GetSearch(self,
 
         if until:
             parameters['until'] = until
-            
+
         if since:
             parameters['since'] = since
 
@@ -474,6 +475,22 @@ def GetTrendsWoeid(self, id, exclude=None):
             trends.append(Trend.NewFromJsonDict(trend, timestamp=timestamp))
         return trends
 
+    def GetUserSuggestionCategories(self):
+        """ Return the list of suggested user categories, this can be used in
+            GetUserSuggestion function
+        Returns:
+            A list of categories
+        """
+        url = '%s/users/suggestions.json' % (self.base_url)
+        json_data = self._RequestUrl(url, verb='GET')
+        data = self._ParseAndCheckTwitter(json_data.content)
+
+        categories = []
+
+        for category in data:
+            categories.append(Category.NewFromJsonDict(category))
+        return categories
+
     def GetHomeTimeline(self,
                         count=None,
                         since_id=None,
@@ -1579,12 +1596,12 @@ def GetFollowerIDsPaged(self,
         if count is not None:
             parameters['count'] = count
         result = []
-    
+
         parameters['cursor'] = cursor
-    
+
         json = self._RequestUrl(url, 'GET', data=parameters)
         data = self._ParseAndCheckTwitter(json.content)
-    
+
         if 'next_cursor' in data:
             next_cursor = data['next_cursor']
         else:
@@ -1593,7 +1610,7 @@ def GetFollowerIDsPaged(self,
             previous_cursor = data['previous_cursor']
         else:
             previous_cursor = 0
-    
+
         return next_cursor, previous_cursor, data
 
     def GetFollowerIDs(self,
@@ -1632,13 +1649,14 @@ def GetFollowerIDs(self,
         url = '%s/followers/ids.json' % self.base_url
         if not self.__auth:
             raise TwitterError({'message': "twitter.Api instance must be authenticated"})
-  
+
         result = []
         if total_count and total_count < count:
             count = total_count
-  
+
         while True:
-            next_cursor, previous_cursor, data = self.GetFollowerIDsPaged(user_id, screen_name, cursor, stringify_ids, count)
+            next_cursor, previous_cursor, data = self.GetFollowerIDsPaged(user_id, screen_name, cursor, stringify_ids,
+                                                                          count)
             result += [x for x in data['ids']]
             if next_cursor == 0 or next_cursor == previous_cursor:
                 break
@@ -1650,7 +1668,7 @@ def GetFollowerIDs(self,
                     break
             sec = self.GetSleepTime('/followers/ids')
             time.sleep(sec)
-  
+
         return result
 
     def GetFollowersPaged(self,
@@ -2063,7 +2081,7 @@ def CreateFriendship(self, user_id=None, screen_name=None, follow=True):
           A twitter.User instance representing the befriended user.
         """
         return self._AddOrEditFriendship(user_id=user_id, screen_name=screen_name, follow=follow)
-    
+
     def _AddOrEditFriendship(self, user_id=None, screen_name=None, uri_end='create', follow_key='follow', follow=True):
         """
         Shared method for Create/Update Friendship.
@@ -2104,7 +2122,8 @@ def UpdateFriendship(self, user_id=None, screen_name=None, follow=True, **kwargs
           A twitter.User instance representing the befriended user.
         """
         follow = kwargs.get('device', follow)
-        return self._AddOrEditFriendship(user_id=user_id, screen_name=screen_name, follow=follow, follow_key='device', uri_end='update')
+        return self._AddOrEditFriendship(user_id=user_id, screen_name=screen_name, follow=follow, follow_key='device',
+                                         uri_end='update')
 
     def DestroyFriendship(self, user_id=None, screen_name=None):
         """Discontinues friendship with a user_id or screen_name.
@@ -2883,7 +2902,7 @@ def GetListTimeline(self,
         """
         parameters = {'slug': slug,
                       'list_id': list_id,
-        }
+                      }
         url = '%s/lists/statuses.json' % (self.base_url)
         parameters['slug'] = slug
         parameters['list_id'] = list_id
@@ -2892,7 +2911,7 @@ def GetListTimeline(self,
                 raise TwitterError({'message': "list_id or slug required"})
             if owner_id is None and not owner_screen_name:
                 raise TwitterError({
-                'message': "if list_id is not given you have to include an owner to help identify the proper list"})
+                    'message': "if list_id is not given you have to include an owner to help identify the proper list"})
         if owner_id:
             parameters['owner_id'] = owner_id
         if owner_screen_name:
@@ -2966,7 +2985,7 @@ def GetListMembers(self,
         """
         parameters = {'slug': slug,
                       'list_id': list_id,
-        }
+                      }
         url = '%s/lists/members.json' % (self.base_url)
         parameters['slug'] = slug
         parameters['list_id'] = list_id
@@ -2975,7 +2994,7 @@ def GetListMembers(self,
                 raise TwitterError({'message': "list_id or slug required"})
             if owner_id is None and not owner_screen_name:
                 raise TwitterError({
-                'message': "if list_id is not given you have to include an owner to help identify the proper list"})
+                    'message': "if list_id is not given you have to include an owner to help identify the proper list"})
         if owner_id:
             parameters['owner_id'] = owner_id
         if owner_screen_name:
@@ -3287,22 +3306,22 @@ def UpdateImage(self,
 
         url = '%s/account/update_profile_image.json' % (self.base_url)
         with open(image, 'rb') as image_file:
-          encoded_image = base64.b64encode(image_file.read())
+            encoded_image = base64.b64encode(image_file.read())
         data = {
-          'image':encoded_image
+            'image': encoded_image
         }
         if include_entities:
-          data['include_entities'] = 1
+            data['include_entities'] = 1
         if skip_status:
-          data['skip_status'] = 1
+            data['skip_status'] = 1
 
         json = self._RequestUrl(url, 'POST', data=data)
         if json.status_code in [200, 201, 202]:
-          return True
+            return True
         if json.status_code == 400:
-          raise TwitterError({'message': "Image data could not be processed"})
+            raise TwitterError({'message': "Image data could not be processed"})
         if json.status_code == 422:
-          raise TwitterError({'message': "The image could not be resized or is too large."})
+            raise TwitterError({'message': "The image could not be resized or is too large."})
 
     def UpdateBanner(self,
                      image,
@@ -3832,15 +3851,15 @@ def _RequestStream(self, url, verb, data=None):
                 return requests.post(url, data=data, stream=True,
                                      auth=self.__auth,
                                      timeout=self._timeout
-                )
+                                     )
             except requests.RequestException as e:
                 raise TwitterError(str(e))
         if verb == 'GET':
             url = self._BuildUrl(url, extra_params=data)
             try:
                 return requests.get(url, stream=True, auth=self.__auth,
                                     timeout=self._timeout
-                )
+                                    )
             except requests.RequestException as e:
                 raise TwitterError(str(e))
         return 0  # if not a POST or GET request
diff --git a/twitter/category.py b/twitter/category.py
@@ -0,0 +1,59 @@
+#!/usr/bin/env python
+
+
+class Category(object):
+    """A class representing the suggested user category structure used by the twitter API.
+
+    The UserStatus structure exposes the following properties:
+
+      category.name
+      category.slug
+      category.size
+    """
+
+    def __init__(self, **kwargs):
+        """An object to hold a Twitter suggested  user category .
+        This class is normally instantiated by the twitter.Api class and
+        returned in a sequence.
+
+        Args:
+          name:
+            name of the category
+          slug:
+
+          size:
+        """
+        param_defaults = {
+            'name': None,
+            'slug': None,
+            'size': None,
+        }
+
+        for (param, default) in param_defaults.iteritems():
+            setattr(self, param, kwargs.get(param, default))
+
+    @property
+    def Name(self):
+        return self.name or False
+
+    @property
+    def Slug(self):
+        return self.slug or False
+
+    @property
+    def Size(self):
+        return self.size or False
+
+    @staticmethod
+    def NewFromJsonDict(data):
+        """Create a new instance based on a JSON dict.
+
+        Args:
+          data: A JSON dict, as converted from the JSON in the twitter API
+        Returns:
+          A twitter.Category instance
+        """
+
+        return Category(name=data.get('name', None),
+                        slug=data.get('slug', None),
+                        size=data.get('size', None))
