Merge pull request #80 from yasht01/get-request

Implement GET in dynamic to get the response from an API #80

Author: GouravSardana

.gitignore

@@ -28,3 +28,7 @@ dmypy.json
 
 # Cython debug symbols
 cython_debug/
+
+# User files related to API testing and authentication
+access_token.json
+response_data.json

README.md

@@ -46,6 +46,7 @@ Options: <br>
 `-d, --debug -> Turn on Debugging mode` <br>
 `-c, --custom -> Setup a custom API key` <br>
 `-h, --help -> Shows this message and exit` <br>
+`-GET -> Make a GET request to an API` <br>
 
 ## License🗄
 

main.py

@@ -46,6 +46,10 @@
                     help="Check updates for the application",
                     action="store_true")
 
+parser.add_argument("-GET",
+                    help="Make a GET request to an API",
+                    action='store_true')
+
 ARGV = parser.parse_args()
 
 search_flag = Search(ARGV)

src/arguments/api_test.py

@@ -0,0 +1,66 @@
+import requests, json
+from pygments import highlight, lexers, formatters
+
+class ApiTesting():
+    default_url = "https://127.0.0.1:8000"
+
+    # Make GET request
+    @classmethod
+    def get_request(cls):
+        request_url = cls.default_url
+        input_url = input('Enter URL: ')
+        if input_url != '':
+            request_url = input_url
+
+        # Check whether the request_url has an endpoint or not
+        has_endpoint = cls.__check_endpoint(request_url)
+
+        # Check if http:// or https:// is present in request_url
+        has_protocol = cls.__check_protocol(request_url)
+
+        if not(has_protocol):
+            request_url = "https://" + request_url
+
+        # Ask the user for endpoint if not present in request_url
+        if not(has_endpoint):
+            if(request_url[-1] == '/'):
+                endpoint = input("Input endpoint (Without the starting slash): ")
+            else:
+                endpoint = input("Input endpoint (With the starting slash): ")
+            request_url += endpoint
+
+        print("Trying ...\u26A1")
+
+        # Make GET request and store the response in response_data.json
+        try:
+            response = requests.get(request_url)
+            print(f"Reponse Status Code: {response.status_code}")
+            response_data = json.loads(response.content)
+            parsed_json = json.dumps(response_data, indent=4)
+            output_json = highlight(parsed_json, lexers.JsonLexer(), formatters.TerminalFormatter())
+            print(output_json)
+
+            store_data = input('Store response data? (Y/N): ')
+            if(store_data == 'Y' or store_data == 'y'):
+                with open('response_data.json', 'w') as jsonFile:
+                    json.dump(response_data, jsonFile, indent=4)
+                print("Response data stored in response_data.json")
+
+        except requests.exceptions.InvalidSchema:
+            print("Check whether the URL is valid or check if the localhost server is active or not")
+        except Exception as e:
+            print(e)
+
+    @classmethod
+    def __check_endpoint(cls, request_url):
+        if(request_url == cls.default_url):
+            return False
+        else:
+            return True
+
+    @classmethod
+    def __check_protocol(cls, request_url):
+        if(request_url[:4] == 'http'):
+            return True
+        else:
+            return False

src/arguments/search.py

@@ -8,6 +8,7 @@
 from .utility import Utility
 from .save import SaveSearchResults
 from .update import UpdateApplication
+from .api_test import ApiTesting
 
 version = "0.1.0"
 class Prompt():
@@ -28,6 +29,7 @@ class Search():
     def __init__(self, arguments):
         self.arguments = arguments
         self.utility_object = Utility()
+        self.api_test_object = ApiTesting()
 
     def search_args(self):
         if self.arguments.search:
@@ -45,6 +47,8 @@ def search_args(self):
         elif self.arguments.update:
             update = UpdateApplication(version)
             update.check_for_updates()
+        elif self.arguments.GET:
+            self.api_test_object.get_request()
 
     def search_for_results(self, save=False):
         queries = ["What do you want to search", "Tags"]
@@ -83,4 +87,4 @@ def search_for_results(self, save=False):
                 filename = SaveSearchResults(data)
                 print(
                     colored(f"\U0001F604 Answers successfully saved into {filename}",
-                            "green"))
+                            "green"))