scratchattach 2.1.15b0__py3-none-any.whl → 3.0.0b1__py3-none-any.whl

scratchattach/other/other_apis.py

@@ -1,284 +0,0 @@
-"""Other Scratch API-related functions"""
-from __future__ import annotations
-
-import json
-from dataclasses import dataclass, field
-
-from scratchattach.utils import commons
-from scratchattach.utils.enums import Languages, Language, TTSVoices, TTSVoice
-from scratchattach.utils.exceptions import BadRequest, InvalidLanguage, InvalidTTSGender
-from scratchattach.utils.requests import requests
-from typing import Optional
-
-
-# --- Front page ---
-
-def get_news(*, limit=10, offset=0):
-    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():
-    """
-    Generates a scratchcsrftoken using Scratch's API.
-
-    Returns:
-        str: The generated scratchcsrftoken
-    """
-    return requests.get(
-        "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"]
-
-
-# --- 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()
-
-
-# --- ScratchTools endpoints ---
-def scratchtools_online_status(username: str) -> bool | None:
-    """
-    Get the online status of an account.
-    :return: Boolean whether the account is online; if they do not use scratchtools, return None.
-    """
-    data = requests.get(f"https://data.scratchtools.app/isonline/{username}").json()
-
-    if data["scratchtools"]:
-        return data["online"]
-    else:
-        return None
-
-
-def scratchtools_beta_user(username: str) -> bool:
-    """
-    Get whether a user is a scratchtools beta tester (I think that's what it means)
-    """
-    return requests.get(f"https://data.scratchtools.app/isbeta/{username}").json()["beta"]
-
-
-def scratchtools_display_name(username: str) -> str | None:
-    """
-    Get the display name of a user for scratchtools. Returns none if there is no display name or the username is invalid
-    """
-    return requests.get(f"https://data.scratchtools.app/name/{username}").json().get("displayName")
-
-
-@dataclass(init=True, repr=True)
-class ScratchToolsTutorial:
-    title: str
-    description: str = field(repr=False)
-    id: str
-
-    @classmethod
-    def from_json(cls, data: dict[str, str]) -> ScratchToolsTutorial:
-        return cls(**data)
-
-    @property
-    def yt_link(self):
-        return f"https://www.youtube.com/watch?v={self.id}"
-
-
-def scratchtools_tutorials() -> list[ScratchToolsTutorial]:
-    """
-    Returns a list of scratchtools tutorials (just yt videos)
-    """
-    data_list = requests.get("https://data.scratchtools.app/tutorials/").json()
-    return [ScratchToolsTutorial.from_json(data) for data in data_list]
-
-
-def scratchtools_emoji_status(username: str) -> str | None:
-    return requests.get(f"https://data.scratchtools.app/status/{username}").json().get("status",
-                                                                                       '🍪')  # Cookie is the default status, even if the user does not use ScratchTools
-
-
-def scratchtools_pinned_comment(project_id: int) -> dict[str, str | int]:
-    data = requests.get(f"https://data.scratchtools.app/pinned/{project_id}/").json()
-    # Maybe use this info to instantiate a partial comment object?
-    return data
-
-
-# --- Misc ---
-# I'm not sure what to label this as
-def scratch_team_members() -> dict:
-    # Unfortunately, the only place to find this is a js file, not a json file, which is annoying
-    text = requests.get("https://scratch.mit.edu/js/credits.bundle.js").text
-    text = "[{\"userName\"" + text.split("JSON.parse('[{\"userName\"")[1]
-    text = text.split("\"}]')")[0] + "\"}]"
-
-    return json.loads(text)
-
-
-def send_password_reset_email(username: Optional[str] = None, email: Optional[str] = None):
-    requests.post("https://scratch.mit.edu/accounts/password_reset/", data={
-        "username": username,
-        "email": email,
-    }, headers=commons.headers, cookies={"scratchcsrftoken": 'a'})
-
-
-def translate(language: str | Languages, text: str = "hello"):
-    if isinstance(language, str):
-        lang = Languages.find_by_attrs(language.lower(), ["code", "tts_locale", "name"], str.lower)
-    elif isinstance(language, Languages):
-        lang = language.value
-    else:
-        lang = language
-
-    if not isinstance(lang, Language):
-        raise InvalidLanguage(f"{language} is not a language")
-
-    if lang.code is None:
-        raise InvalidLanguage(f"{lang} is not a valid translate language")
-
-    response_json = requests.get(
-        f"https://translate-service.scratch.mit.edu/translate?language={lang.code}&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}")
-
-
-def text2speech(text: str = "hello", voice_name: str = "female", language: str = "en-US"):
-    """
-    Sends a request to Scratch's TTS synthesis service.
-    Returns:
-        - The TTS audio (mp3) as bytes
-        - The playback rate (e.g. for giant it would be 0.84)
-    """
-    if isinstance(voice_name, str):
-        voice = TTSVoices.find_by_attrs(voice_name.lower(), ["name", "gender"], str.lower)
-    elif isinstance(voice_name, TTSVoices):
-        voice = voice_name.value
-    else:
-        voice = voice_name
-
-    if not isinstance(voice, TTSVoice):
-        raise InvalidTTSGender(f"TTS Gender {voice_name} is not supported.")
-
-    # If it's kitten, make sure to change everything to just meows
-    if voice.name == "kitten":
-        text = ''
-        for word in text.split(' '):
-            if word.strip() != '':
-                text += "meow "
-
-    if isinstance(language, str):
-        lang = Languages.find_by_attrs(language.lower(), ["code", "tts_locale", "name"], str.lower)
-    elif isinstance(language, Languages):
-        lang = language.value
-    else:
-        lang = language
-
-    if not isinstance(lang, Language):
-        raise InvalidLanguage(f"Language '{language}' is not a language")
-
-    if lang.tts_locale is None:
-        raise InvalidLanguage(f"Language '{language}' is not a valid TTS language")
-
-    response = requests.get(f"https://synthesis-service.scratch.mit.edu/synth"
-                            f"?locale={lang.tts_locale}&gender={voice.gender}&text={text}")
-    return response.content, voice.playback_rate

scratchattach/site/activity.py

@@ -1,382 +0,0 @@
-"""Activity and CloudActivity class"""
-from __future__ import annotations
-
-from bs4 import PageElement
-
-from . import user, project, studio
-from ._base import BaseSiteComponent
-from scratchattach.utils import exceptions
-
-
-class Activity(BaseSiteComponent):
-    """
-    Represents a Scratch activity (message or other user page activity)
-    """
-
-    def __repr__(self):
-        return f"Activity({repr(self.raw)})"
-
-    def __str__(self):
-        return str(self.raw)
-
-    def __init__(self, **entries):
-        # Set attributes every Activity object needs to have:
-        self._session = None
-        self.raw = None
-
-        # Possible attributes
-        self.project_id = None
-        self.gallery_id = None
-
-        self.username = None
-        self.followed_username = None
-        self.recipient_username = None
-
-        self.comment_type = None
-        self.comment_obj_id = None
-        self.comment_obj_title = None
-        self.comment_id = None
-
-        self.datetime_created = None
-        self.time = None
-        self.type = None
-
-        # Update attributes from entries dict:
-        self.__dict__.update(entries)
-
-    def update(self):
-        print("Warning: Activity objects can't be updated")
-        return False  # Objects of this type cannot be updated
-
-    def _update_from_dict(self, data):
-        self.raw = data
-        self.__dict__.update(data)
-        return True
-
-    def _update_from_json(self, data: dict):
-        """
-        Update using JSON, used in the classroom API.
-        """
-        activity_type = data["type"]
-
-        _time = data["datetime_created"] if "datetime_created" in data else None
-
-        if "actor" in data:
-            username = data["actor"]["username"]
-        elif "actor_username" in data:
-            username = data["actor_username"]
-        else:
-            username = None
-
-        if data.get("recipient") is not None:
-            recipient_username = data["recipient"]["username"]
-
-        elif data.get("recipient_username") is not None:
-            recipient_username = data["recipient_username"]
-
-        elif data.get("project_creator") is not None:
-            recipient_username = data["project_creator"]["username"]
-        else:
-            recipient_username = None
-
-        default_case = False
-        # Even if `activity_type` is an invalid value; it will default to 'user performed an action'
-
-        if activity_type == 0:
-            # follow
-            followed_username = data["followed_username"]
-
-            self.raw = f"{username} followed user {followed_username}"
-
-            self.datetime_created = _time
-            self.type = "followuser"
-            self.username = username
-            self.followed_username = followed_username
-
-        elif activity_type == 1:
-            # follow studio
-            studio_id = data["gallery"]
-
-            raw = f"{username} followed studio https://scratch.mit.edu/studios/{studio_id}"
-
-            self.raw = raw
-            self.datetime_created = _time
-            self.type = "followstudio"
-
-            self.username = username
-            self.gallery_id = studio_id
-
-        elif activity_type == 2:
-            # love project
-            project_id = data["project"]
-
-            raw = f"{username} loved project https://scratch.mit.edu/projects/{project_id}"
-
-            self.raw = raw
-            self.datetime_created = _time,
-            self.type = "loveproject"
-
-            self.username = username
-            self.project_id = project_id
-            self.recipient_username = recipient_username
-
-        elif activity_type == 3:
-            # Favorite project
-            project_id = data["project"]
-
-            raw = f"{username} favorited project https://scratch.mit.edu/projects/{project_id}"
-
-            self.raw = raw
-            self.datetime_created = _time
-            self.type = "favoriteproject"
-
-            self.username = username
-            self.project_id = project_id
-            self.recipient_username = recipient_username
-
-        elif activity_type == 7:
-            # Add project to studio
-
-            project_id = data["project"]
-            studio_id = data["gallery"]
-
-            raw = f"{username} added the project https://scratch.mit.edu/projects/{project_id} to studio https://scratch.mit.edu/studios/{studio_id}"
-
-            self.raw = raw
-            self.datetime_created = _time
-            self.type = "addprojecttostudio"
-
-            self.username = username
-            self.project_id = project_id
-            self.recipient_username = recipient_username
-
-        elif activity_type in (8, 9, 10):
-            # Share/Reshare project
-            project_id = data["project"]
-            is_reshare = data["is_reshare"]
-
-            raw_reshare = "reshared" if is_reshare else "shared"
-
-            raw = f"{username} {raw_reshare} the project https://scratch.mit.edu/projects/{project_id}"
-
-            self.raw = raw
-            self.datetime_created = _time
-            self.type = "shareproject"
-
-            self.username = username
-            self.project_id = project_id
-            self.recipient_username = recipient_username
-
-        elif activity_type == 11:
-            # Remix
-            parent_id = data["parent"]
-
-            raw = f"{username} remixed the project https://scratch.mit.edu/projects/{parent_id}"
-
-            self.raw = raw
-            self.datetime_created = _time
-            self.type = "remixproject"
-
-            self.username = username
-            self.project_id = parent_id
-            self.recipient_username = recipient_username
-
-        # type 12 does not exist in the HTML. That's why it was removed, not merged with type 13.
-        
-        elif activity_type == 13:
-            # Create ('add') studio
-            studio_id = data["gallery"]
-
-            raw = f"{username} created the studio https://scratch.mit.edu/studios/{studio_id}"
-
-            self.raw = raw
-            self.datetime_created = _time
-            self.type = "createstudio"
-
-            self.username = username
-            self.gallery_id = studio_id
-
-        elif activity_type == 15:
-            # Update studio
-            studio_id = data["gallery"]
-
-            raw = f"{username} updated the studio https://scratch.mit.edu/studios/{studio_id}"
-
-            self.raw = raw
-            self.datetime_created = _time
-            self.type = "updatestudio"
-
-            self.username = username
-            self.gallery_id = studio_id
-
-        elif activity_type in (16, 17, 18, 19):
-            # Remove project from studio
-
-            project_id = data["project"]
-            studio_id = data["gallery"]
-
-            raw = f"{username} removed the project https://scratch.mit.edu/projects/{project_id} from studio https://scratch.mit.edu/studios/{studio_id}"
-
-            self.raw = raw
-            self.datetime_created = _time
-            self.type = "removeprojectfromstudio"
-
-            self.username = username
-            self.project_id = project_id
-
-        elif activity_type in (20, 21, 22):
-            # Was promoted to manager for studio
-            studio_id = data["gallery"]
-
-            raw = f"{recipient_username} was promoted to manager by {username} for studio https://scratch.mit.edu/studios/{studio_id}"
-
-            self.raw = raw
-            self.datetime_created = _time
-            self.type = "promotetomanager"
-
-            self.username = username
-            self.recipient_username = recipient_username
-            self.gallery_id = studio_id
-
-        elif activity_type in (23, 24, 25):
-            # Update profile
-            raw = f"{username} made a profile update"
-
-            self.raw = raw
-            self.datetime_created = _time
-            self.type = "updateprofile"
-
-            self.username = username
-
-        elif activity_type in (26, 27):
-            # Comment (quite complicated)
-            comment_type: int = data["comment_type"]
-            fragment = data["comment_fragment"]
-            comment_id = data["comment_id"]
-            comment_obj_id = data["comment_obj_id"]
-            comment_obj_title = data["comment_obj_title"]
-
-            if comment_type == 0:
-                # Project comment
-                raw = f"{username} commented on project https://scratch.mit.edu/projects/{comment_obj_id}/#comments-{comment_id} {fragment!r}"
-
-            elif comment_type == 1:
-                # Profile comment
-                raw = f"{username} commented on user https://scratch.mit.edu/users/{comment_obj_title}/#comments-{comment_id} {fragment!r}"
-
-            elif comment_type == 2:
-                # Studio comment
-                # Scratch actually provides an incorrect link, but it is fixed here:
-                raw = f"{username} commented on studio https://scratch.mit.edu/studios/{comment_obj_id}/comments/#comments-{comment_id} {fragment!r}"
-
-            else:
-                raw = f"{username} commented {fragment!r}"  # This should never happen
-
-            self.raw = raw
-            self.datetime_created = _time
-            self.type = "addcomment"
-
-            self.username = username
-
-            self.comment_type = comment_type
-            self.comment_obj_id = comment_obj_id
-            self.comment_obj_title = comment_obj_title
-            self.comment_id = comment_id
-        else:
-            default_case = True
-
-        if default_case:
-            # This is coded in the scratch HTML, haven't found an example of it though
-            raw = f"{username} performed an action."
-
-            self.raw = raw
-            self.datetime_created = _time
-            self.type = "performaction"
-
-            self.username = username
-
-    def _update_from_html(self, data: PageElement):
-
-        self.raw = data
-
-        _time = data.find('div').find('span').findNext().findNext().text.strip()
-
-        if '\xa0' in _time:
-            while '\xa0' in _time:
-                _time = _time.replace('\xa0', ' ')
-
-        self.datetime_created = _time
-        self.actor_username = data.find('div').find('span').text
-
-        self.target_name = data.find('div').find('span').findNext().text
-        self.target_link = data.find('div').find('span').findNext()["href"]
-        self.target_id = data.find('div').find('span').findNext()["href"].split("/")[-2]
-
-        self.type = data.find('div').find_all('span')[0].next_sibling.strip()
-        if self.type == "loved":
-            self.type = "loveproject"
-
-        elif self.type == "favorited":
-            self.type = "favoriteproject"
-
-        elif "curator" in self.type:
-            self.type = "becomecurator"
-
-        elif "shared" in self.type:
-            self.type = "shareproject"
-
-        elif "is now following" in self.type:
-            if "users" in self.target_link:
-                self.type = "followuser"
-            else:
-                self.type = "followstudio"
-
-        return True
-
-    def actor(self):
-        """
-        Returns the user that performed the activity as User object
-        """
-        return self._make_linked_object("username", self.actor_username, user.User, exceptions.UserNotFound)
-
-    def target(self):
-        """
-        Returns the activity's target (depending on the activity, this is either a User, Project, Studio or Comment object).
-        May also return None if the activity type is unknown.
-        """
-
-        if "project" in self.type:  # target is a project
-            if "target_id" in self.__dict__:
-                return self._make_linked_object("id", self.target_id, project.Project, exceptions.ProjectNotFound)
-            if "project_id" in self.__dict__:
-                return self._make_linked_object("id", self.project_id, project.Project, exceptions.ProjectNotFound)
-
-        if self.type == "becomecurator" or self.type == "followstudio":  # target is a studio
-            if "target_id" in self.__dict__:
-                return self._make_linked_object("id", self.target_id, studio.Studio, exceptions.StudioNotFound)
-            if "gallery_id" in self.__dict__:
-                return self._make_linked_object("id", self.gallery_id, studio.Studio, exceptions.StudioNotFound)
-            # NOTE: the "becomecurator" type is ambigous - if it is inside the studio activity tab, the target is the user who joined
-            if "username" in self.__dict__:
-                return self._make_linked_object("username", self.username, user.User, exceptions.UserNotFound)
-
-        if self.type == "followuser" or "curator" in self.type:  # target is a user
-            if "target_name" in self.__dict__:
-                return self._make_linked_object("username", self.target_name, user.User, exceptions.UserNotFound)
-            if "followed_username" in self.__dict__:
-                return self._make_linked_object("username", self.followed_username, user.User, exceptions.UserNotFound)
-        if "recipient_username" in self.__dict__:  # the recipient_username field always indicates the target is a user
-            return self._make_linked_object("username", self.recipient_username, user.User, exceptions.UserNotFound)
-
-        if self.type == "addcomment":  # target is a comment
-            if self.comment_type == 0:
-                _c = project.Project(id=self.comment_obj_id, author_name=self._session.username,
-                                     _session=self._session).comment_by_id(self.comment_id)
-            if self.comment_type == 1:
-                _c = user.User(username=self.comment_obj_title, _session=self._session).comment_by_id(self.comment_id)
-            if self.comment_type == 2:
-                _c = user.User(id=self.comment_obj_id, _session=self._session).comment_by_id(self.comment_id)
-            else:
-                raise ValueError(f"{self.comment_type} is an invalid comment type")
-
-            return _c