Merge pull request game-by-virtuals#79 from game-by-virtuals/twitter-game-auth

Twitter game auth

Author: celesteanglm

plugins/twitter/README.md

@@ -5,39 +5,86 @@ The Twitter plugin is a lightweight wrapper over commonly-used twitter API calls
 ## Installation
 From this directory (`twitter`), run the installation:
 ```bash
-pip install -e .
+poetry install
 ```
 
 ## Usage
-1. If you don't already have one, create a X (twitter) account and navigate to the [developer portal](https://developer.x.com/en/portal/dashboard).
-2. Create a project app, generate the following credentials and set the following environment variables (e.g. using a `.bashrc` or a `.zshrc` file):
-  - `TWITTER_API_KEY`
-  - `TWITTER_API_SECRET_KEY`
-  - `TWITTER_ACCESS_TOKEN`
-  - `TWITTER_ACCESS_TOKEN_SECRET`
-
-3. Import and initialize the plugin to use in your worker:
-```python
-import os
-from twitter_plugin_gamesdk.twitter_plugin import TwitterPlugin
-
-# Define your options with the necessary credentials
-options = {
-    "id": "test_twitter_worker",
-    "name": "Test Twitter Worker",
-    "description": "An example Twitter Plugin for testing.",
-    "credentials": {
-        "apiKey": os.environ.get("TWITTER_API_KEY"),
-        "apiSecretKey": os.environ.get("TWITTER_API_SECRET_KEY"),
-        "accessToken": os.environ.get("TWITTER_ACCESS_TOKEN"),
-        "accessTokenSecret": os.environ.get("TWITTER_ACCESS_TOKEN_SECRET"),
-    },
-}
-# Initialize the TwitterPlugin with your options
-twitter_plugin = TwitterPlugin(options)
-
-# Post a tweet
-post_tweet_fn = twitter_plugin.get_function('post_tweet')
-post_tweet_fn("Hello world!")
-```
-You can refer to `test_twitter.py` for more examples on how to call the twitter functions.
+1. Choose one of the 2 options to initialise the Twitter plugin
+   - `GameTwitterPlugin` 
+     - This allows one to leverage GAME's X enterprise API credentials (i.e. higher rate limits)
+   - `TwitterPlugin`
+     - This allows one to use their own X API credentials
+2. Initialise plugin objects, run set-up scripts and use plugin functions
+   - `GameTwitterPlugin` 
+     - To get the access token to us this plugin, run the following command
+        ```bash
+        poetry run twitter-plugin-gamesdk auth -k <GAME_API_KEY>
+        ```
+        You will see the following output:
+        ```bash
+        Waiting for authentication...
+
+        Visit the following URL to authenticate:
+        https://x.com/i/oauth2/authorize?response_type=code&client_id=VVdyZ0t4WFFRMjBlMzVaczZyMzU6MTpjaQ&redirect_uri=http%3A%2F%2Flocalhost%3A8714%2Fcallback&state=866c82c0-e3f6-444e-a2de-e58bcc95f08b&code_challenge=K47t-0Mcl8B99ufyqmwJYZFB56fiXiZf7f3euQ4H2_0&code_challenge_method=s256&scope=tweet.read%20tweet.write%20users.read%20offline.access
+        ```
+        After authenticating, you will receive the following message:
+        ```bash
+        Authenticated! Here's your access token:
+        apx-<xxx>
+        ```
+     - Set the access token as an environment variable called `GAME_TWITTER_ACCESS_TOKEN` (e.g. using a `.bashrc` or a `.zshrc` file):
+     - Import and initialize the plugin to use in your worker:
+        ```python
+        import os
+        from twitter_plugin_gamesdk.game_twitter_plugin import GameTwitterPlugin
+
+        # Define your options with the necessary credentials
+        options = {
+            "id": "test_game_twitter_plugin",
+            "name": "Test GAME Twitter Plugin",
+            "description": "An example GAME Twitter Plugin for testing.",
+            "credentials": {
+                "gameTwitterAccessToken": os.environ.get("GAME_TWITTER_ACCESS_TOKEN")
+            },
+        }
+        # Initialize the TwitterPlugin with your options
+        game_twitter_plugin = GameTwitterPlugin(options)
+
+        # Post a tweet
+        post_tweet_fn = game_twitter_plugin.get_function('post_tweet')
+        post_tweet_fn("Hello world!")
+        ```
+        You can refer to `examples/test_game_twitter.py` for more examples on how to call the twitter functions. Note that there is a limited number of functions available. If you require more, please submit a feature requests via Github Issues.
+      
+   - `TwitterPlugin`
+     - If you don't already have one, create a X (twitter) account and navigate to the [developer portal](https://developer.x.com/en/portal/dashboard).
+     - Create a project app, generate the following credentials and set the following environment variables (e.g. using a `.bashrc` or a `.zshrc` file):
+       - `TWITTER_API_KEY`
+       - `TWITTER_API_SECRET_KEY`
+       - `TWITTER_ACCESS_TOKEN`
+       - `TWITTER_ACCESS_TOKEN_SECRET`
+     - Import and initialize the plugin to use in your worker:
+        ```python
+        import os
+        from twitter_plugin_gamesdk.twitter_plugin import TwitterPlugin
+
+        # Define your options with the necessary credentials
+        options = {
+            "id": "test_twitter_worker",
+            "name": "Test Twitter Worker",
+            "description": "An example Twitter Plugin for testing.",
+            "credentials": {
+                "apiKey": os.environ.get("TWITTER_API_KEY"),
+                "apiSecretKey": os.environ.get("TWITTER_API_SECRET_KEY"),
+                "accessToken": os.environ.get("TWITTER_ACCESS_TOKEN"),
+                "accessTokenSecret": os.environ.get("TWITTER_ACCESS_TOKEN_SECRET"),
+            },
+        }
+        # Initialize the TwitterPlugin with your options
+        twitter_plugin = TwitterPlugin(options)
+
+        # Post a tweet
+        post_tweet_fn = twitter_plugin.get_function('post_tweet')
+        post_tweet_fn("Hello world!")
+        ```
+        You can refer to `examples/test_twitter.py` for more examples on how to call the twitter functions.

plugins/twitter/examples/test_game_twitter.py

@@ -0,0 +1,45 @@
+import os
+from twitter_plugin_gamesdk.game_twitter_plugin import GameTwitterPlugin
+
+# Define your options with the necessary credentials
+options = {
+    "id": "test_game_twitter_plugin",
+    "name": "Test GAME Twitter Plugin",
+    "description": "An example GAME Twitter Plugin for testing.",
+    "credentials": {
+        "gameTwitterAccessToken": os.environ.get("GAME_TWITTER_ACCESS_TOKEN")
+    },
+}
+
+# Initialize the TwitterPlugin with your options
+game_twitter_plugin = GameTwitterPlugin(options)
+
+# 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!")
+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!")
+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 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}")

plugins/twitter/test_twitter.py plugins/twitter/examples/test_twitter.pyplugins/twitter/test_twitter.py renamed to plugins/twitter/examples/test_twitter.py

@@ -3,8 +3,8 @@
 
 # Define your options with the necessary credentials
 options = {
-    "id": "test_twitter_worker",
-    "name": "Test Twitter Worker",
+    "id": "test_twitter_plugin",
+    "name": "Test Twitter Plugin",
     "description": "An example Twitter Plugin for testing.",
     "credentials": {
         "bearerToken": os.environ.get("TWITTER_BEARER_TOKEN"),
@@ -19,16 +19,16 @@
 twitter_plugin = TwitterPlugin(options)
 
 # Test case 1: Post a Tweet
-print("Running 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("Hi! 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!")
 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!")
-print("Liked tweet!")
+print("Replied to tweet!")
 
 # Test case 3: Like a Tweet
 print("\nRunning Test Case 3: Like a Tweet")

plugins/twitter/pyproject.toml

@@ -1,34 +1,18 @@
 [build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
+requires = ["poetry-core>=1.0.0"]
+build-backend = "poetry.core.masonry.api"
 
-[project]
+[tool.poetry]
 name = "twitter_plugin_gamesdk"
-version = "0.1.0"
-authors = [
-  { name = "Celeste Ang", email = "[email protected]" },
-]
+version = "0.2.0"
 description = "Twitter Plugin for Python SDK for GAME by Virtuals"
-requires-python = ">=3.8"
-classifiers = [
-    "Programming Language :: Python :: 3",
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9",
-    "Programming Language :: Python :: 3.10",
-    "Programming Language :: Python :: 3.11",
-    "License :: OSI Approved :: MIT License",
-    "Operating System :: OS Independent",
-    "Development Status :: 3 - Alpha",
-    "Intended Audience :: Developers",
-    "Topic :: Software Development :: Libraries :: Python Modules",
-]
-dependencies = [
-    "tweepy>=4.15.0"
-]
+authors = ["Celeste Ang <[email protected]>"]
+homepage = "https://github.com/game-by-virtuals/game-python"
+repository = "https://github.com/game-by-virtuals/game-python"
 
-[tool.hatch.build.targets.wheel]
-packages = ["twitter_plugin_gamesdk"]
+[tool.poetry.dependencies]
+python = ">=3.9"
+tweepy = ">=4.15.0"
 
-[project.urls]
-"Homepage" = "https://github.com/game-by-virtuals/game-python"
-"Bug Tracker" = "https://github.com/game-by-virtuals/game-python"
+[tool.poetry.scripts]
+twitter-plugin-gamesdk = "twitter_plugin_gamesdk.game_twitter_auth:start"

plugins/twitter/twitter_plugin_gamesdk/game_twitter_auth.py

@@ -0,0 +1,101 @@
+import argparse
+import requests
+import webbrowser
+from http.server import BaseHTTPRequestHandler, HTTPServer
+from urllib.parse import urlparse, parse_qs
+from typing import Optional
+from dataclasses import dataclass
+
+BASE_URL = "https://twitter.game.virtuals.io/accounts"
+
+
+@dataclass
+class AuthCredentials:
+    """
+    Data class to hold authentication credentials.
+    """
+    api_key: str
+    access_token: Optional[str] = None
+
+
+class AuthHandler(BaseHTTPRequestHandler):
+    """
+    Handles OAuth authentication callback from Twitter.
+    """
+
+    def do_GET(self) -> None:
+        parsed_url = urlparse(self.path)
+        if parsed_url.path == "/callback":
+            query_params = parse_qs(parsed_url.query)
+            code: Optional[str] = query_params.get("code", [None])[0]
+            state: Optional[str] = query_params.get("state", [None])[0]
+
+            if code and state:
+                access_token = AuthManager.verify_auth(code, state)
+                self.send_response(200)
+                self.send_header("Content-type", "text/plain")
+                self.end_headers()
+                self.wfile.write("Authentication successful! You may close this window and return to the terminal.")
+                print("Authentication successful!")
+                print(f"Access Token: {access_token}")
+                self.server.shutdown()  # Stop the server after successful auth
+            else:
+                self.send_response(400)
+                self.end_headers()
+                self.wfile.write("Invalid request")
+        else:
+            self.send_response(404)
+            self.end_headers()
+            self.wfile.write("Not Found")
+
+
+class AuthManager:
+    """
+    Manages OAuth authentication flow.
+    """
+
+    @staticmethod
+    def get_login_url(api_key: str) -> str:
+        """
+        Fetches the login URL from the authentication server.
+        """
+        response = requests.get(f"{BASE_URL}/auth", headers={"x-api-key": api_key})
+        response.raise_for_status()
+        return response.json().get("url")
+
+    @staticmethod
+    def verify_auth(code: str, state: str) -> str:
+        """
+        Verifies authentication and retrieves an access token.
+        """
+        response = requests.get(f"{BASE_URL}/verify", params={"code": code, "state": state})
+        response.raise_for_status()
+        return response.json().get("token")
+
+    @staticmethod
+    def start_authentication(api_key: str, port: int = 8714) -> None:
+        """
+        Starts a temporary web server to handle authentication.
+        """
+        SERVER_ADDRESS = ("", port)
+        HANDLER_CLASS = AuthHandler
+        with HTTPServer(SERVER_ADDRESS, HANDLER_CLASS) as server:
+            login_url = AuthManager.get_login_url(api_key)
+            print("Waiting for authentication...")
+            print("Visit the following URL to authenticate:")
+            print(login_url)
+            webbrowser.open(login_url)
+            server.serve_forever()
+
+def start() -> None:
+    """
+    Entry point for the game twitter auth process.
+    """
+    parser = argparse.ArgumentParser(prog="game-twitter-plugin", description="CLI to authenticate and interact with GAME's Twitter API")
+    parser.add_argument("auth", help="Authenticate with Twitter API", nargs='?')
+    parser.add_argument("-k", "--key", help="Project's API key", required=True, type=str)
+    args = parser.parse_args()
+    AuthManager.start_authentication(args.key)
+
+if __name__ == "__main__":
+    start()