Adding auth headers and user-agent. Auth headers are currently broken.

Author: benjhar

jokeapi/main.py

@@ -37,12 +37,12 @@ def build_request(
         if len(blacklist) > 0:
             for b in blacklist:
                 if b not in [
-                            "nsfw",
-                            "religious",
-                            "political",
-                            "racist",
-                            "sexist"
-                            ]:
+                    "nsfw",
+                    "religious",
+                    "political",
+                    "racist",
+                    "sexist"
+                ]:
                     raise ValueError(
                         '''\n\n
                         You have blacklisted flags which are not available.
@@ -82,21 +82,21 @@ def build_request(
         if id_range:
 
             response = self.http.request(
-                                        'GET',
-                                        "https://sv443.net/jokeapi/v2/info"
-                                        )
+                'GET',
+                "https://sv443.net/jokeapi/v2/info"
+            )
             dict = json.loads(response.data)
             range_limit = dict["jokes"]["totalCount"]
 
             if len(id_range) > 2:
                 raise ValueError("id_range must be no longer than 2 items.")
             elif id_range[0] < 0:
                 raise ValueError(
-                             "id_range[0] must be greater than or equal to 0."
-                               )
+                    "id_range[0] must be greater than or equal to 0."
+                )
             elif id_range[1] > range_limit:
                 raise ValueError(
-                 f"id_range[1] must be less than or equal to {range_limit-1}."
+                    f"id_range[1] must be less than or equal to {range_limit-1}."
                 )
 
         r += cats
@@ -130,15 +130,27 @@ def build_request(
 
         return r
 
-    def send_request(self, request, response_format):
-        r = self.http.request('GET', request)
+    def send_request(self, request, response_format, return_headers, auth_token, user_agent):
+        if auth_token:
+            r = self.http.request('GET', request, headers={'Authorization': str(
+                auth_token), 'user-agent': str(user_agent)})
+        else:
+            r = self.http.request('GET', request, headers={'user-agent': str(user_agent)})
 
-        if response_format == "json":
-            return json.loads(r.data)
-        elif response_format == "xml":
-            return r.data
+        if return_headers:
+            if response_format == "json":
+                return r.data, r.headers
+            elif response_format == "xml":
+                return r.data, r.headers
+            else:
+                return r.data, r.headers
         else:
-            return r.data
+            if response_format == "json":
+                return r.data
+            elif response_format == "xml":
+                return r.data
+            else:
+                return r.data
 
     def get_joke(
         self,
@@ -148,9 +160,13 @@ def get_joke(
         type=None,
         search_string=None,
         id_range=None,
+        auth_token=None,
+        user_agent="Mozilla/5.0 (Windows NT 10.0; Win64; x64; rv:77.0) Gecko/20100101 Firefox/77.0",
+        return_headers=False
     ):
         r = self.build_request(
             category, blacklist, response_format, type, search_string, id_range
         )
-        response = self.send_request(r, response_format)
+
+        response = self.send_request(r, response_format, return_headers, auth_token, user_agent)
         return response

setup.py

@@ -6,16 +6,16 @@
 setuptools.setup(
     name="jokeapi",
     packages=["jokeapi"],
-    version="0.1.4",
+    version="0.2.1",
     license="GNU General Public License v3 (GPLv3)",
     description="An API Wrapper for Sv443's JokeAPI",
     long_description=long_description,
     long_description_content_type="text/markdown",
     author="thenamesweretakenalready",
     author_email="[email protected]",
     url="""https://github.com/thenamesweretakenalready/Sv443s-JokeAPI-Python-Wrapper""",
-    download_url="https://github.com/user/Sv443s-JokeAPI-Python-Wrapper/archive/v0.1.4.tar.gz",
-    keywords=["api wrapper", "wrapper", "api", "jokes"],
+    download_url="https://github.com/user/Sv443s-JokeAPI-Python-Wrapper/archive/v0.1.5.tar.gz",
+    keywords=["api wrapper", "wrapper", "api", "jokes", "python", "joke api"],
     install_requires=setuptools.find_packages(),
     classifiers=[
         "Development Status :: 3 - Alpha",

test_main.py

@@ -1,84 +1,99 @@
+from os import getenv
 from jokeapi import Jokes
+from dotenv import load_dotenv
+load_dotenv()
 
 j = Jokes()
 errors = []
+token = getenv("token")
+
 
 try:
     j.get_joke()
 except Exception as e:
     errors.append({'Error in':  'blank joke get',  'Error': e})
 
+"""Testing auth tokens"""
+try:
+    j.get_joke(auth_token=token)
+except Exception as e:
+    auth_token = None
+    errors.append({'Error in':  'auth usage',  'Error': e})
+
 """Testing for errors in categories"""
 try:
-    j.get_joke(category=["programming"])
+    j.get_joke(category=["programming"], auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'category programming', 'Error': e})
 try:
-    j.get_joke(category=["miscellaneous"])
+    j.get_joke(category=["miscellaneous"], auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'category miscellaneous', 'Error': e})
 try:
-    j.get_joke(category=["dark"])
+    j.get_joke(category=["dark"], auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'category dark', 'Error': e})
 
 """Testing for errors in blacklist"""
 try:
-    j.get_joke(blacklist=["nsfw"])
+    j.get_joke(blacklist=["nsfw"], auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'blacklist nsfw', 'Error': e})
 try:
-    j.get_joke(blacklist=["religious"])
+    j.get_joke(blacklist=["religious"], auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'blacklist religious', 'Error': e})
 try:
-    j.get_joke(blacklist=["political"])
+    j.get_joke(blacklist=["political"], auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'blacklist political', 'Error': e})
 try:
-    j.get_joke(blacklist=["racist"])
+    j.get_joke(blacklist=["racist"], auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'blacklist political', 'Error': e})
 try:
-    j.get_joke(blacklist=["sexist"])
+    j.get_joke(blacklist=["sexist"], auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'blacklist sexist',  'Error': e})
 
 """Testing for errors in response_format"""
 try:
-    j.get_joke(response_format="xml")
+    j.get_joke(response_format="xml", auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'response_format xml', 'Error': e})
 try:
-    j.get_joke(response_format="yaml")
+    j.get_joke(response_format="yaml", auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'response_format yaml', 'Error': e})
 
 """Testing for errors in type"""
 try:
-    j.get_joke(type="single")
+    j.get_joke(type="single", auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'type single', 'Error': e})
 try:
-    j.get_joke(type="twopart")
+    j.get_joke(type="twopart", auth_token=token)
 except Exception as e:
     errors.append({'Error in':  'type double', 'Error': e})
 
 """Testing for errors in search_string"""
 try:
-    j.get_joke(search_string="search")
+    j.get_joke(search_string="search", auth_token=token)
     # as long as this gets a response, the api wrapper is fine;
     # it probably doesn't exist in a joke.
 except Exception as e:
     errors.append({'Error in': 'search_string', 'Error': e})
 
 """Testing for errors in id_range"""
 try:
-    j.get_joke(id_range=[30, 151])
+    j.get_joke(id_range=[30, 151], auth_token=token)
 except Exception as e:
     errors.append({'Error in': 'id_range', 'Error': e})
 
 if len(errors):
     for e in errors:
         print(f"Error in:  {e['Error in']}\nError: {e['Error']}")
-    raise Exception("Errors boii")
+    if len(errors) == 1:
+        raise Exception("1 error occured")
+
+    raise Exception(f"{len(errors)} errors occurred")