Merge pull request #77 from yasht01/custom-api-key

Add feature to setup custom API key #77

Author: GouravSardana

README.md

@@ -44,6 +44,7 @@ Options: <br>
 `-v, --version -> Gives the Version of the CLI` <br>
 `-s, --search -> Search a question on Stackoverflow` <br>
 `-d, --debug -> Turn on Debugging mode` <br>
+`-c, --custom -> Setup a custom API key` <br>
 `-h, --help -> Shows this message and exit` <br>
 
 ## License🗄

main.py

@@ -36,6 +36,11 @@
                     help="Save answer to a file",
                     action="store_true")
 
+parser.add_argument("-c",
+                    "--custom",
+                    help="Set a custom API key",
+                    action="store_true")
+
 parser.add_argument("-u",
                     "--update",
                     help="Check updates for the application",

requirements.txt

@@ -5,3 +5,10 @@ requests==2.24.0
 termcolor==1.1.0
 urllib3==1.25.10
 rich==9.9.0
+oauthlib==3.1.0
+requests-oauthlib==1.3.0
+colorama==0.4.4
+configparser==5.0.2
+crayons==0.4.0
+selenium==3.141.0
+webdriver-manager==3.3.0

src/arguments/search.py

@@ -40,6 +40,8 @@ def search_args(self):
                 webbrowser.open(f"{url}?title={self.arguments.new}")
             else:
                 webbrowser.open(url)
+        elif self.arguments.custom:
+            self.utility_object.setCustomKey()
         elif self.arguments.update:
             update = UpdateApplication(version)
             update.check_for_updates()

src/arguments/utility.py

@@ -7,6 +7,22 @@
 from .save import SaveSearchResults
 from .markdown import MarkdownRenderer
 
+# Required for OAuth
+import json
+from oauthlib.oauth2 import MobileApplicationClient
+from requests_oauthlib import OAuth2Session
+
+# Required for Selenium script and for web_driver_manager
+import time
+from selenium import webdriver
+from selenium.webdriver.common.by import By
+from selenium.webdriver.support.ui import WebDriverWait
+from selenium.webdriver.support import expected_conditions as EC
+
+from webdriver_manager.chrome import ChromeDriverManager
+from webdriver_manager.firefox import GeckoDriverManager
+from webdriver_manager.microsoft import EdgeChromiumDriverManager
+
 console = Console()
 
 
@@ -85,4 +101,63 @@ def get_ans(self, questions_list):
 
                     console.print(output_text)
             ans.append(json_ans_data["items"])
-        return ans
+        return ans
+
+    # Get an access token and extract to a JSON file "access_token.json"
+    @classmethod
+    def setCustomKey(self):
+        client_id = 20013
+
+        # scopes possible values:
+        # read_inbox - access a user's global inbox
+        # no_expiry - access_token's with this scope do not expire
+        # write_access - perform write operations as a user
+        # private_info - access full history of a user's private actions on the site
+        scopes = 'read_inbox'
+
+        authorization_url = 'https://stackoverflow.com/oauth/dialog'
+        redirect_uri = 'https://stackexchange.com/oauth/login_success'
+
+        # Create an OAuth session and open the auth_url in a browser for the user to authenticate
+        stackApps = OAuth2Session(client=MobileApplicationClient(client_id=client_id), scope=scopes, redirect_uri=redirect_uri)
+        auth_url, state = stackApps.authorization_url(authorization_url)
+
+        # Try to install web drivers for one of these browsers
+        # Chrome, Firefox, Edge (One of them must be installed)
+        try:
+            driver = webdriver.Chrome(ChromeDriverManager().install())
+        except ValueError:
+            try:
+                driver = webdriver.Firefox(executable_path=GeckoDriverManager().install())
+            except ValueError:
+                try:
+                    driver = webdriver.Edge(EdgeChromiumDriverManager().install())
+                except ValueError:
+                    print("You do not have one of these supported browsers: Chrome, Firefox, Edge")
+
+        # Open auth_url in one of the supported browsers
+        driver.get(auth_url)
+
+        # Close the window after 20s (Assuming that the user logs in within 30 seconds)
+        time.sleep(30)
+        # Close the windows as soon as authorization is done
+        try:
+            WebDriverWait(driver, 1).until(
+                EC.presence_of_element_located((By.TAG_NAME, "h2"))
+            )
+            callback_url = driver.current_url
+        finally:
+            driver.quit()
+
+        # Extract access token data from callback_url
+        accessTokenData = stackApps.token_from_fragment(callback_url)
+
+        # Store the access token data in a dictionary
+        jsonDict = {
+            "access_token": accessTokenData['access_token'],
+            "expires": accessTokenData['expires'],
+            "state": state
+        }
+
+        with open('access_token.json', 'w') as jsonFile:
+            json.dump(jsonDict, jsonFile)