For #20562, implement 'followers' support in python-api.

Neil Brandt · Neil Brandt · commit 016d399c68b4 · 2013-10-04T10:20:59.000-04:00
diff --git a/shotgun_api3/shotgun.py b/shotgun_api3/shotgun.py
@@ -837,6 +837,24 @@ def unfollow(self, user, entity):
         
         return self._call_rpc('unfollow', params)
 
+    def followers(self, entity):
+        """Gets all followers of the entity.
+        
+        :param dict entity: Find all followers of this entity
+        
+        :returns list of dicts for all the users following the entity
+        """
+
+        if not self.server_caps.version or self.server_caps.version < (5, 2, 0):
+            raise ShotgunError("Follow support requires server version 5.2 or "\
+                "higher, server is %s" % (self.server_caps.version,))
+        
+        params = dict(
+            entity=entity
+        )
+        
+        return self._call_rpc('followers', params)
+
     def schema_entity_read(self):
         """Gets all active entities defined in the schema.
 
diff --git a/tests/test_api.py b/tests/test_api.py
@@ -1284,7 +1284,7 @@ def test_unsupported_filters(self):
 
 class TestFollow(base.TestBase):
     def test_follow(self):
-        '''Test methods to follow/unfollow'''
+        '''Test follow method'''
         
         project = self.sg.find_one('Project', [])
         user = self.sg.find_one('HumanUser', [['projects', 'is', project]], ['name'])
@@ -1294,7 +1294,7 @@ def test_follow(self):
         assert(result['followed'])
 
     def test_unfollow(self):
-        '''Test methods to follow/unfollow'''
+        '''Test unfollow method'''
         
         project = self.sg.find_one('Project', [])
         user = self.sg.find_one('HumanUser', [['projects', 'is', project]], ['name'])
@@ -1303,6 +1303,20 @@ def test_unfollow(self):
         result = self.sg.unfollow(user, entity)
         print( result )
         assert(result['unfollowed'])
+    
+    def test_followers(self):
+        '''Test followers method'''
+        
+        project = self.sg.find_one('Project', [])
+        user = self.sg.find_one('HumanUser', [['projects', 'is', project]], ['name'])
+        entity = self.sg.find_one('Shot', [['project', 'is', project]], ['name'])
+        
+        result = self.sg.follow(user, entity)
+        assert(result['followed'])
+        
+        result = self.sg.followers(entity)
+        self.assertEqual( 1, len(result) )
+        self.assertEqual( user['id'], result[0]['id'] )
 
 class TestErrors(base.TestBase):
     def test_bad_auth(self):
