Added (smart) translation api

Author: faretek1

scratchattach/other/other_apis.py

@@ -1,72 +1,94 @@
 """Other Scratch API-related functions"""
 
+import json
+import warnings
+
 from ..utils import commons
+from ..utils.exceptions import BadRequest
 from ..utils.requests import Requests as requests
-import json
+from ..utils.supportedlangs import SUPPORTED_CODES, SUPPORTED_NAMES
+
 
 # --- Front page ---
 
 def get_news(*, limit=10, offset=0):
-    return commons.api_iterative("https://api.scratch.mit.edu/news", limit = limit, offset = offset)
+    return commons.api_iterative("https://api.scratch.mit.edu/news", limit=limit, offset=offset)
+
 
 def featured_data():
     return requests.get("https://api.scratch.mit.edu/proxy/featured").json()
 
+
 def featured_projects():
     return featured_data()["community_featured_projects"]
 
+
 def featured_studios():
     return featured_data()["community_featured_studios"]
 
+
 def top_loved():
     return featured_data()["community_most_loved_projects"]
 
+
 def top_remixed():
     return featured_data()["community_most_remixed_projects"]
 
+
 def newest_projects():
     return featured_data()["community_newest_projects"]
 
+
 def curated_projects():
     return featured_data()["curator_top_projects"]
 
+
 def design_studio_projects():
     return featured_data()["scratch_design_studio"]
 
+
 # --- Statistics ---
 
 def total_site_stats():
     data = requests.get("https://scratch.mit.edu/statistics/data/daily/").json()
     data.pop("_TS")
     return data
 
+
 def monthly_site_traffic():
     data = requests.get("https://scratch.mit.edu/statistics/data/monthly-ga/").json()
     data.pop("_TS")
     return data
 
+
 def country_counts():
     return requests.get("https://scratch.mit.edu/statistics/data/monthly/").json()["country_distribution"]
 
+
 def age_distribution():
     data = requests.get("https://scratch.mit.edu/statistics/data/monthly/").json()["age_distribution_data"][0]["values"]
     return_data = {}
     for value in data:
         return_data[value["x"]] = value["y"]
     return return_data
 
+
 def monthly_comment_activity():
     return requests.get("https://scratch.mit.edu/statistics/data/monthly/").json()["comment_data"]
 
+
 def monthly_project_shares():
     return requests.get("https://scratch.mit.edu/statistics/data/monthly/").json()["project_data"]
 
+
 def monthly_active_users():
     return requests.get("https://scratch.mit.edu/statistics/data/monthly/").json()["active_user_data"]
 
+
 def monthly_activity_trends():
     return requests.get("https://scratch.mit.edu/statistics/data/monthly/").json()["activity_data"]
 
+
 # --- CSRF Token Generation API ---
 
 def get_csrf_token():
@@ -80,32 +102,41 @@ def get_csrf_token():
         "https://scratch.mit.edu/csrf_token/"
     ).headers["set-cookie"].split(";")[3][len(" Path=/, scratchcsrftoken="):]
 
+
 # --- Various other api.scratch.mit.edu API endpoints ---
 
 def get_health():
     return requests.get("https://api.scratch.mit.edu/health").json()
 
+
 def get_total_project_count() -> int:
     return requests.get("https://api.scratch.mit.edu/projects/count/all").json()["count"]
 
+
 def check_username(username):
     return requests.get(f"https://api.scratch.mit.edu/accounts/checkusername/{username}").json()["msg"]
 
+
 def check_password(password):
-    return requests.post("https://api.scratch.mit.edu/accounts/checkpassword/", json={"password":password}).json()["msg"]
+    return requests.post("https://api.scratch.mit.edu/accounts/checkpassword/", json={"password": password}).json()[
+        "msg"]
+
 
 # --- April fools endpoints ---
 
 def aprilfools_get_counter() -> int:
     return requests.get("https://api.scratch.mit.edu/surprise").json()["surprise"]
 
+
 def aprilfools_increment_counter() -> int:
     return requests.post("https://api.scratch.mit.edu/surprise").json()["surprise"]
 
+
 # --- Resources ---
 def get_resource_urls():
     return requests.get("https://resources.scratch.mit.edu/localized-urls.json").json()
 
+
 # --- Misc ---
 # I'm not sure what to label this as
 def scratch_team_members() -> dict:
@@ -115,3 +146,20 @@ def scratch_team_members() -> dict:
     text = text.split("\"}]')")[0] + "\"}]"
 
     return json.loads(text)
+
+
+def translate(language: str, text: str = "hello"):
+    if language not in SUPPORTED_CODES:
+        if language.lower() in SUPPORTED_CODES:
+            language = language.lower()
+        elif language.title() in SUPPORTED_NAMES:
+            language = SUPPORTED_CODES[SUPPORTED_NAMES.index(language.title())]
+        else:
+            warnings.warn(f"'{language}' is probably not a supported language")
+    response_json = requests.get(
+        f"https://translate-service.scratch.mit.edu/translate?language={language}&text={text}").json()
+
+    if "result" in response_json:
+        return response_json["result"]
+    else:
+        raise BadRequest(f"Language '{language}' does not seem to be valid.\nResponse: {response_json}")

scratchattach/utils/supportedlangs.py

@@ -0,0 +1,29 @@
+"""
+List of supported languages of scratch's translate extension.
+Adapted from https://translate-service.scratch.mit.edu/supported?language=en
+"""
+
+SUPPORTED_LANGS = {'sq': 'Albanian', 'am': 'Amharic', 'ar': 'Arabic', 'hy': 'Armenian', 'az': 'Azerbaijani',
+                   'eu': 'Basque', 'be': 'Belarusian', 'bg': 'Bulgarian', 'ca': 'Catalan',
+                   'zh-tw': 'Chinese (Traditional)', 'hr': 'Croatian', 'cs': 'Czech', 'da': 'Danish', 'nl': 'Dutch',
+                   'en': 'English', 'eo': 'Esperanto', 'et': 'Estonian', 'fi': 'Finnish', 'fr': 'French',
+                   'gl': 'Galician', 'de': 'German', 'el': 'Greek', 'ht': 'Haitian Creole', 'hi': 'Hindi',
+                   'hu': 'Hungarian', 'is': 'Icelandic', 'id': 'Indonesian', 'ga': 'Irish', 'it': 'Italian',
+                   'ja': 'Japanese', 'kn': 'Kannada', 'ko': 'Korean', 'ku': 'Kurdish (Kurmanji)', 'la': 'Latin',
+                   'lv': 'Latvian', 'lt': 'Lithuanian', 'mk': 'Macedonian', 'ms': 'Malay', 'ml': 'Malayalam',
+                   'mt': 'Maltese', 'mi': 'Maori', 'mr': 'Marathi', 'mn': 'Mongolian', 'my': 'Myanmar (Burmese)',
+                   'fa': 'Persian', 'pl': 'Polish', 'pt': 'Portuguese', 'ro': 'Romanian', 'ru': 'Russian',
+                   'gd': 'Scots Gaelic', 'sr': 'Serbian', 'sk': 'Slovak', 'sl': 'Slovenian', 'es': 'Spanish',
+                   'sv': 'Swedish', 'te': 'Telugu', 'th': 'Thai', 'tr': 'Turkish', 'uk': 'Ukrainian', 'uz': 'Uzbek',
+                   'vi': 'Vietnamese', 'cy': 'Welsh', 'zu': 'Zulu', 'he': 'Hebrew', 'zh-cn': 'Chinese (Simplified)'}
+SUPPORTED_CODES = tuple(SUPPORTED_LANGS.keys())
+SUPPORTED_NAMES = tuple(SUPPORTED_LANGS.values())
+
+# Code for generating the dict again:
+# import requests
+#
+# SUPPORTED_LANGS = {}
+# raw = requests.get("https://translate-service.scratch.mit.edu/supported").json()
+# for lang in raw:
+#     SUPPORTED_LANGS[lang["code"]] = lang["name"]
+# print(SUPPORTED_LANGS)