➕📝Add submit endpoint.

Author: benjhar

README.md

@@ -20,14 +20,23 @@ You can install jokeapi through [pip](https://pypi.org/project/pip/) by using `p
 # get_joke
 
 The wrapper is structured in such a way that the end-user should only ever have to
-interact with one function. This function is `get_joke()`.
+interact with one function to get a joke. This function is `get_joke()`.
 
 Please note that urllib3, the core dependency of this wrapper automatically abides by
 `Retry-After` headers, which means you may have to wait a long time for a joke if you
 have made a lot of requests recently
 
 ---
 
+# submit_joke
+
+The wrapper also provides simple access to the submit endpoint through the `submit_joke()`
+function.
+
+Note that joke submissions are manually checked and you will be ratelimited.
+
+---
+
 ## get_joke
 
 ### Example
@@ -54,7 +63,8 @@ A list of categories that the returned joke should fit in.
 Options are:
 `programming`,
 `miscellaneous`,
-`dark`
+`dark`,
+`pun`
 
 If left blank it will default to use `Any`.
 
@@ -205,12 +215,12 @@ Defaults to False.
 
 ---
 
-## Returns
+### Returns
 
 Depending on what format is chosen different things will be returned.
 
 
-### json
+#### json
 
 A succesful API call will return:
 
@@ -233,7 +243,7 @@ A succesful API call will return:
 ```
 
 
-### xml
+#### xml
 
 A succesful API call will return:
 
@@ -256,7 +266,7 @@ A succesful API call will return:
 ```
 
 
-### yaml
+#### yaml
 
 A succesful API call will return:
 
@@ -275,7 +285,7 @@ error: false
 ```
 
 
-### txt
+#### txt
 
 A succesful API call will return:
 
@@ -287,7 +297,7 @@ He keeps dropping the database.
 
 ---
 
-## Errors
+### Errors
 
 The wrapper can raise multiple different errors depending on what you did wrong.
 
@@ -296,6 +306,73 @@ If not, feel free to ask me through one of the channels provided below.
 
 ---
 
+## submit_joke
+
+### Example
+
+```python
+from jokeapi import Jokes
+
+j = Jokes()
+
+j.submit_joke("Miscellaneous", "funny haha", {
+    "nsfw": False,
+    "religious": False,
+    "political": False,
+    "racist": False,
+    "sexist": False
+}, lang="de")
+```
+
+---
+
+### Parameters
+
+---
+
+#### category
+
+The category the joke is.
+Options are:
+`programming`,
+`miscellaneous`,
+`dark`,
+`pun`
+
+Has no default value.
+
+---
+
+#### joke
+
+The joke itself. Can either be a single string or a list/tuple, for the setup and
+delivery. Setup should be at index 0 in the tuple, delivery at 1.
+
+Has no default value.
+
+---
+
+#### flags
+
+The flags that the joke should have.
+Options are:
+`nsfw`,
+`religious`,
+`political`,
+`racist`,
+`sexist`
+
+Has no default value.
+
+#### lang
+
+The language code for the language the joke it written in. E.g en for english,
+de for german.
+
+Defaults to `en`
+
+---
+
 Developer contact:
 
 ![Discord](https://discord.com/assets/07dca80a102d4149e9736d4b162cff6f.ico)[**Discord**](https://discord.gg/mB989eP)

jokeapi/__pycache__/__init__.cpython-38.pyc

@@ -1,13 +1,31 @@
 import urllib3
 import urllib
+import urllib.request
 import simplejson as json
 import re
 
 
+class CategoryError(Exception):
+    pass
+
+
+class BlacklistError(Exception):
+    pass
+
+
+class ResponseTypeError(Exception):
+    pass
+
+
+class JokeTypeError(Exception):
+    pass
+
+
 class Jokes:
     def __init__(self):
         self.http = urllib3.PoolManager()
-        self.info = self.http.request('GET', "https://sv443.net/jokeapi/v2/info")
+        self.info = self.http.request(
+            'GET', "https://sv443.net/jokeapi/v2/info")
         self.info = data = json.loads(self.info.data.decode('utf-8'))["jokes"]
 
     def build_request(
@@ -26,7 +44,7 @@ def build_request(
         if len(category):
             for c in category:
                 if not c.title() in self.info["categories"]:
-                    raise ValueError(
+                    raise CategoryError(
                         f'''Invalid category selected.
                         You selected {c}.
                         Available categories are:
@@ -39,31 +57,34 @@ def build_request(
         else:
             cats = "Any"
 
-        if len(blacklist) > 0:
-            for b in blacklist:
-                if b not in self.info["flags"]:
-                    raise ValueError(
-                        f'''
+        if type(blacklist) in [list, tuple]:
+            if len(blacklist) > 0:
+                for b in blacklist:
+                    if b not in self.info["flags"]:
+                        raise BlacklistError(
+                            f'''
 
 
-                        You have blacklisted flags which are not available or you have not put the flags in a list.
-                        Available flags are:
-                            {"""
-                            """.join(self.info["flags"])}
-                        '''
-                    )
-                    return
-            blacklistFlags = ",".join(blacklist)
+                            You have blacklisted flags which are not available.
+                            Available flags are:
+                                {"""
+                                """.join(self.info["flags"])}
+                            '''
+                        )
+                        return
+                blacklistFlags = ",".join(blacklist)
+            else:
+                blacklistFlags = None
         else:
-            blacklistFlags = None
+            raise BlacklistError(f'''blacklist must be a list or tuple.''')
 
         if response_format not in ["json", "xml", "yaml", "txt"]:
-            raise Exception(
+            raise ResponseTypeError(
                 "Response format must be either json, xml, txt or yaml."
             )
         if type:
             if type not in ["single", "twopart"]:
-                raise ValueError(
+                raise JokeTypeError(
                     '''Invalid joke type.
                     Available options are "single" or "twopart".'''
                 )
@@ -98,7 +119,6 @@ def build_request(
         if blacklistFlags:
             r += f"&blacklistFlags={blacklistFlags}"
 
-
         r += f"&type={type}"
 
         if search_string:
@@ -107,7 +127,7 @@ def build_request(
             r += f"i&dRange={id_range[0]}-{id_range[1]}"
         if amount > 10:
             raise ValueError(
-            f"amount parameter must be no greater than 10. you passed {amount}."
+                f"amount parameter must be no greater than 10. you passed {amount}."
             )
         r += f"&amount={amount}"
 
@@ -121,19 +141,21 @@ def send_request(self,
                      return_headers,
                      auth_token,
                      user_agent
-    ):
+                     ):
         returns = []
 
         if auth_token:
             r = self.http.request('GET',
                                   request,
                                   headers={'Authorization': str(auth_token),
                                            'user-agent': str(user_agent),
-                                           #'accept-encoding': 'gzip'
-                                          }
+                                           'accept-encoding': 'gzip'
+                                           }
                                   )
         else:
-            r = self.http.request('GET', request, headers={'user-agent': str(user_agent)})
+            r = self.http.request('GET', request, headers={
+                                  'user-agent': str(user_agent),
+                                  'accept-encoding': 'gzip'})
 
         data = r.data.decode('utf-8')
 
@@ -156,7 +178,8 @@ def send_request(self,
             returns.append(headers)
 
         if auth_token:
-            returns.append({"Token-Valid": bool(int(re.split(r"Token-Valid", headers)[1][4]))})
+            returns.append(
+                {"Token-Valid": bool(int(re.split(r"Token-Valid", headers)[1][4]))})
 
         if len(returns) > 1:
             return returns
@@ -180,5 +203,58 @@ def get_joke(
             category, blacklist, response_format, type, search_string, id_range, amount, lang
         )
 
-        response = self.send_request(r, response_format, return_headers, auth_token, user_agent)
+        response = self.send_request(
+            r, response_format, return_headers, auth_token, user_agent)
         return response
+
+    def submit_joke(self, category, joke, flags, lang="en"):
+        request = {"formatVersion": 3}
+
+        if category not in self.info["categories"]:
+            raise CategoryError(
+                f'''Invalid category selected.
+            You selected {category}.
+            Available categories are:
+            {"""
+            """.join(self.info["categories"])}''')
+        request["category"] = category
+
+        if type(joke) in [list, tuple]:
+            if len(joke) > 1:
+                request["type"] = "twopart"
+                request["setup"] = joke[0]
+                request["delivery"] = joke[1]
+            else:
+                request["type"] = "single"
+                request["joke"] = joke[0]
+        else:
+            request["type"] = "single"
+            request["joke"] = joke
+
+        for key in flags.keys():
+            if key not in self.info["flags"]:
+                raise BlacklistError(
+                    f'''
+                You have blacklisted flags which are not available.
+                Available flags are:
+                    {"""
+                    """.join(self.info["flags"])}
+                ''')
+        request["flags"] = flags
+        request["lang"] = lang
+
+        data = str(request).replace("'", '"')
+        data = data.replace(": True", ": true").replace(": False", ": false")
+        data = data.encode('ascii')
+        url = "https://sv443.net/jokeapi/v2/submit"
+
+        try:
+            response = urllib.request.urlopen(url, data=data)
+            data = response.getcode()
+
+            return data
+        except urllib.error.HTTPError as e:
+            body = e.read().decode()  # Read the body of the error response
+
+            _json = json.loads(body)
+            return _json

jokeapi/__pycache__/main.cpython-38.pyc

@@ -3,18 +3,20 @@
 with open("README.md", "r") as fh:
     long_description = fh.read()
 
+version = "0.2.7"
+
 setuptools.setup(
     name="jokeapi",
     packages=["jokeapi"],
-    version="0.2.6",
+    version=version,
     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/thenamesweretakenalready/Sv443s-JokeAPI-Python-Wrapper/archive/v0.2.6.tar.gz",
+    download_url=f"https://github.com/thenamesweretakenalready/Sv443s-JokeAPI-Python-Wrapper/archive/v{version}.tar.gz",
     keywords=["api wrapper", "wrapper", "api", "jokes", "python", "joke api"],
     install_requires=[
         "urllib3==1.25.8",