feat: allow posting of multiple media_ids in twitter plugin

Author: Celeste Ang

plugins/twitter/examples/test_game_twitter.py

@@ -17,29 +17,29 @@
 # Test case 1: Post a Tweet
 print("\nRunning Test Case 1: Post a Tweet")
 post_tweet_fn = game_twitter_plugin.get_function('post_tweet')
-post_tweet_fn("Hello world! This is a test tweet from the GAME Twitter Plugin!")
+post_tweet_fn(tweet="Hello world! This is a test tweet from the GAME Twitter Plugin!", media_ids=[])
 print("Posted tweet!")
 
 # Test case 2: Reply to a Tweet
 print("\nRunning Test Case 2: Reply to a Tweet")
 reply_tweet_fn = game_twitter_plugin.get_function('reply_tweet')
-reply_tweet_fn(tweet_id=1879472470362816626, reply="Hey! This is a test reply!")
+reply_tweet_fn(tweet_id=1879472470362816626, reply="Hey! This is a test reply!", media_ids=[])
 print("Replied to tweet!")
 
-# Test case 3: Quote a Tweet
-print("\nRunning Test Case 3: Quote a Tweet")
-quote_tweet_fn = game_twitter_plugin.get_function('quote_tweet')
-quote_tweet_fn(tweet_id=1879472470362816626, quote="Hey! This is a test quote tweet!")
-print("Quoted tweet!")
+# # Test case 3: Quote a Tweet
+# print("\nRunning Test Case 3: Quote a Tweet")
+# quote_tweet_fn = game_twitter_plugin.get_function('quote_tweet')
+# quote_tweet_fn(tweet_id=1879472470362816626, quote="Hey! This is a test quote tweet!", media_ids=[])
+# print("Quoted tweet!")
 
-# Test case 4: Search Tweets
-print("\nRunning Test Case 4: Search Tweets")
-search_tweets_fn = game_twitter_plugin.get_function('search_tweets')
-response = search_tweets_fn(query="Python")
-print(f"Searched tweets: {response}")
+# # Test case 4: Search Tweets
+# print("\nRunning Test Case 4: Search Tweets")
+# search_tweets_fn = game_twitter_plugin.get_function('search_tweets')
+# response = search_tweets_fn(query="Python")
+# print(f"Searched tweets: {response}")
 
-# Test case 5: Get authenticated user
-print("\nRunning Test Case 5: Get details of authenticated user")
-get_authenticated_user_fn = game_twitter_plugin.get_function('get_authenticated_user')
-response = get_authenticated_user_fn()
-print(f"Got details of authenticated user: {response}")
+# # Test case 5: Get authenticated user
+# print("\nRunning Test Case 5: Get details of authenticated user")
+# get_authenticated_user_fn = game_twitter_plugin.get_function('get_authenticated_user')
+# response = get_authenticated_user_fn()
+# print(f"Got details of authenticated user: {response}")

plugins/twitter/examples/test_twitter.py

@@ -21,13 +21,13 @@
 # Test case 1: Post a Tweet
 print("\nRunning Test Case 1: Post a Tweet")
 post_tweet_fn = twitter_plugin.get_function('post_tweet')
-post_tweet_fn("Hello world! This is a test tweet from the Twitter Plugin!")
+post_tweet_fn("Hello world! This is a test tweet from the Twitter Plugin!", media_ids=[])
 print("Posted tweet!")
 
 # Test case 2: Reply to a Tweet
 print("\nRunning Test Case 2: Reply to a Tweet")
 reply_tweet_fn = twitter_plugin.get_function('reply_tweet')
-reply_tweet_fn(tweet_id=1879472470362816626, reply="Hey! This is a test reply!")
+reply_tweet_fn(tweet_id=1879472470362816626, reply="Hey! This is a test reply!", media_ids=[])
 print("Replied to tweet!")
 
 # Test case 3: Like a Tweet
@@ -39,7 +39,7 @@
 # Test case 4: Quote a Tweet
 print("\nRunning Test Case 4: Quote a Tweet")
 quote_tweet_fn = twitter_plugin.get_function('quote_tweet')
-quote_tweet_fn(tweet_id=1879472470362816626, quote="Hey! This is a test quote tweet!")
+quote_tweet_fn(tweet_id=1879472470362816626, quote="Hey! This is a test quote tweet!", media_ids=[])
 print("Quoted tweet!")
 
 # Test case 5: Get Metrics

plugins/twitter/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "poetry.core.masonry.api"
 
 [tool.poetry]
 name = "twitter_plugin_gamesdk"
-version = "0.2.0"
+version = "0.2.1"
 description = "Twitter Plugin for Python SDK for GAME by Virtuals"
 authors = ["Celeste Ang <[email protected]>"]
 homepage = "https://github.com/game-by-virtuals/game-python"

plugins/twitter/twitter_plugin_gamesdk/game_twitter_plugin.py

@@ -56,7 +56,7 @@ def __init__(self, options: Dict[str, Any]) -> None:
         self._functions: Dict[str, Callable[..., Any]] = {
             "reply_tweet": self._reply_tweet,
             "post_tweet": self._post_tweet,
-            # "like_tweet": self._like_tweet,
+            "like_tweet": self._like_tweet,
             "quote_tweet": self._quote_tweet,
             "search_tweets": self._search_tweets,
             "get_authenticated_user": self._get_authenticated_user,
@@ -112,14 +112,15 @@ def _fetch_api(self, endpoint: str, method: str = "GET", data: Optional[Dict] =
 
         return response.json()
 
-    def _post_tweet(self, tweet: str, media_id: Optional[str] = None) -> Dict[str, Any]:
+    def _post_tweet(self, tweet: str, media_ids: Optional[List[str]] = None) -> Dict[str, Any]:
         """
         Post a tweet with optional media.
         """
+        if media_ids and len(media_ids) > 4:
+            raise ValueError("media_ids cannot contain more than 4 items.")
         payload = {"content": tweet}
-        if media_id:
-            payload["mediaId"] = media_id
-
+        if media_ids:
+            payload["mediaIds"] = media_ids
         return self._fetch_api("/post", "POST", data=payload)
 
     def _search_tweets(self, query: str) -> Dict[str, Any]:
@@ -128,13 +129,15 @@ def _search_tweets(self, query: str) -> Dict[str, Any]:
         """
         return self._fetch_api(f"/search?query={requests.utils.quote(query)}", "GET")
 
-    def _reply_tweet(self, tweet_id: int, reply: str, media_id: Optional[str] = None) -> None:
+    def _reply_tweet(self, tweet_id: int, reply: str, media_ids: Optional[str] = None) -> None:
         """
         Reply to a tweet.
         """
+        if media_ids and len(media_ids) > 4:
+            raise ValueError("media_ids cannot contain more than 4 items.")
         payload = {"content": reply}
-        if media_id:
-            payload["mediaId"] = media_id
+        if media_ids:
+            payload["mediaIds"] = media_ids
         return self._fetch_api(f"/reply/{tweet_id}", "POST", data=payload)
 
     def _like_tweet(self, tweet_id: int) -> None:
@@ -143,11 +146,15 @@ def _like_tweet(self, tweet_id: int) -> None:
         """
         return self._fetch_api(f"/like/{tweet_id}", "POST")
 
-    def _quote_tweet(self, tweet_id: int, quote: str) -> None:
+    def _quote_tweet(self, tweet_id: int, quote: str, media_ids: Optional[str] = None) -> None:
         """
         Quote a tweet.
         """
+        if media_ids and len(media_ids) > 4:
+            raise ValueError("media_ids cannot contain more than 4 items.")
         payload = {"content": quote}
+        if media_ids:
+            payload["mediaIds"] = media_ids
         return self._fetch_api(f"/quote/{tweet_id}", "POST", data=payload)
 
     def _get_authenticated_user(self) -> Dict[str, Any]:

plugins/twitter/twitter_plugin_gamesdk/twitter_plugin.py

@@ -150,7 +150,7 @@ def _get_metrics(self) -> Dict[str, int]:
             self.logger.error(f"Failed to fetch metrics: {e}")
             return {}
 
-    def _reply_tweet(self, tweet_id: int, reply: str) -> None:
+    def _reply_tweet(self, tweet_id: int, reply: str, media_ids: Optional[str] = None) -> None:
         """
         Reply to a specific tweet.
 
@@ -162,12 +162,14 @@ def _reply_tweet(self, tweet_id: int, reply: str) -> None:
             tweepy.TweepyException: If there's an error posting the reply.
         """
         try:
+            if media_ids and len(media_ids) > 4:
+                raise ValueError("media_ids cannot contain more than 4 items.")
             self.twitter_client.create_tweet(in_reply_to_tweet_id=tweet_id, text=reply)
             self.logger.info(f"Successfully replied to tweet {tweet_id}.")
         except tweepy.TweepyException as e:
             self.logger.error(f"Failed to reply to tweet {tweet_id}: {e}")
 
-    def _post_tweet(self, tweet: str) -> Dict[str, Any]:
+    def _post_tweet(self, tweet: str, media_ids: Optional[str] = None) -> Dict[str, Any]:
         """
         Post a new tweet.
 
@@ -181,6 +183,8 @@ def _post_tweet(self, tweet: str) -> Dict[str, Any]:
             tweepy.TweepyException: If there's an error posting the tweet.
         """
         try:
+            if media_ids and len(media_ids) > 4:
+                raise ValueError("media_ids cannot contain more than 4 items.")
             self.twitter_client.create_tweet(text=tweet)
             self.logger.info("Tweet posted successfully.")
         except tweepy.TweepyException as e:
@@ -202,7 +206,7 @@ def _like_tweet(self, tweet_id: int) -> None:
         except tweepy.TweepyException as e:
             self.logger.error(f"Failed to like tweet {tweet_id}: {e}")
 
-    def _quote_tweet(self, tweet_id: int, quote: str) -> None:
+    def _quote_tweet(self, tweet_id: int, quote: str, media_ids: Optional[str] = None) -> None:
         """
         Quote a specific tweet with additional text.
 
@@ -214,7 +218,7 @@ def _quote_tweet(self, tweet_id: int, quote: str) -> None:
             tweepy.TweepyException: If there's an error posting the quote tweet.
         """
         try:
-            self.twitter_client.create_tweet(quote_tweet_id=tweet_id, text=quote)
+            self.twitter_client.create_tweet(quote_tweet_id=tweet_id, text=quote, media_ids=media_ids)
             self.logger.info(f"Successfully quoted tweet {tweet_id}.")
         except tweepy.TweepyException as e:
             self.logger.error(f"Failed to quote tweet {tweet_id}: {e}")