cs2tracker 2.1.8__py3-none-any.whl → 2.1.10__py3-none-any.whl

cs2tracker/scraper.py

@@ -1,9 +1,4 @@
-import csv
-import os
 import time
-from configparser import ConfigParser
-from datetime import datetime
-from subprocess import DEVNULL, call
 from urllib.parse import unquote
 
 from bs4 import BeautifulSoup
@@ -13,22 +8,11 @@ from requests import RequestException, Session
 from requests.adapters import HTTPAdapter, Retry
 from tenacity import RetryError, retry, stop_after_attempt
 
-from cs2tracker.constants import (
-    AUTHOR_STRING,
-    BANNER,
-    BATCH_FILE,
-    CAPSULE_INFO,
-    CASE_HREFS,
-    CASE_PAGES,
-    CONFIG_FILE,
-    OS,
-    OUTPUT_FILE,
-    PROJECT_DIR,
-    PYTHON_EXECUTABLE,
-    RUNNING_IN_EXE,
-    OSType,
-)
+from cs2tracker.constants import AUTHOR_STRING, BANNER, CAPSULE_INFO, CASE_HREFS
+from cs2tracker.discord_notifier import DiscordNotifier
 from cs2tracker.padded_console import PaddedConsole
+from cs2tracker.price_logs import PriceLogs
+from cs2tracker.validated_config import ValidatedConfig
 
 MAX_LINE_LEN = 72
 SEPARATOR = "-"
@@ -37,32 +21,21 @@ PRICE_INFO = "Owned: {:<10}  Steam market price: ${:<10}  Total: ${:<10}\n"
 HTTP_PROXY_URL = "http://{}:@smartproxy.crawlbase.com:8012"
 HTTPS_PROXY_URL = "http://{}:@smartproxy.crawlbase.com:8012"
 
-DC_WEBHOOK_USERNAME = "CS2Tracker"
-DC_WEBHOOK_AVATAR_URL = "https://img.icons8.com/?size=100&id=uWQJp2tLXUH6&format=png&color=000000"
-DC_RECENT_HISTORY_LIMIT = 5
-
-WIN_BACKGROUND_TASK_NAME = "CS2Tracker Daily Calculation"
-WIN_BACKGROUND_TASK_SCHEDULE = "DAILY"
-WIN_BACKGROUND_TASK_TIME = "12:00"
-WIN_BACKGROUND_TASK_CMD = (
-    f"powershell -WindowStyle Hidden -Command \"Start-Process '{BATCH_FILE}' -WindowStyle Hidden\""
-)
+console = PaddedConsole()
 
 
 class Scraper:
     def __init__(self):
         """Initialize the Scraper class."""
-        self.console = PaddedConsole()
-        self.parse_config()
+        self.load_config()
         self._start_session()
 
         self.usd_total = 0
         self.eur_total = 0
 
-    def parse_config(self):
-        """Parse the configuration file to read settings and user-owned items."""
-        self.config = ConfigParser(interpolation=None)
-        self.config.read(CONFIG_FILE)
+    def load_config(self):
+        """Load the configuration file and validate its contents."""
+        self.config = ValidatedConfig()
 
     def _start_session(self):
         """Start a requests session with custom headers and retry logic."""
@@ -80,29 +53,15 @@ class Scraper:
         """Scrape prices for capsules and cases, calculate totals in USD and EUR, and
         print/save the results.
         """
-        capsule_usd_total = 0
-        try:
-            capsule_usd_total = self.scrape_capsule_section_prices()
-        except (RequestException, AttributeError, RetryError, ValueError):
-            self.console.print(
-                "[bold red][!] Failed to scrape capsule prices. (Consider using proxies to prevent rate limiting)\n"
-            )
-
-        case_usd_total = 0
-        try:
-            case_usd_total = self._scrape_case_prices()
-        except (RequestException, AttributeError, RetryError, ValueError):
-            self.console.print(
-                "[bold red][!] Failed to scrape case prices. (Consider using proxies to prevent rate limiting)\n"
+        if not self.config.valid:
+            console.print(
+                "[bold red][!] Invalid configuration. Please fix the config file before running."
             )
+            return
 
-        custom_item_usd_total = 0
-        try:
-            custom_item_usd_total = self._scrape_custom_item_prices()
-        except (RequestException, AttributeError, RetryError, ValueError):
-            self.console.print(
-                "[bold red][!] Failed to scrape custom item prices. (Consider using proxies to prevent rate limiting)\n"
-            )
+        capsule_usd_total = self._scrape_capsule_section_prices()
+        case_usd_total = self._scrape_case_prices()
+        custom_item_usd_total = self._scrape_custom_item_prices()
 
         self.usd_total += capsule_usd_total
         self.usd_total += case_usd_total
@@ -110,7 +69,7 @@ class Scraper:
         self.eur_total = CurrencyConverter().convert(self.usd_total, "USD", "EUR")
 
         self._print_total()
-        self._save_price_log()
+        PriceLogs.save(self.usd_total, self.eur_total)
         self._send_discord_notification()
 
         # Reset totals for next run
@@ -121,125 +80,15 @@ class Scraper:
         separators.
         """
         usd_title = "USD Total".center(MAX_LINE_LEN, SEPARATOR)
-        self.console.print(f"[bold green]{usd_title}")
-        self.console.print(f"${self.usd_total:.2f}")
+        console.print(f"[bold green]{usd_title}")
+        console.print(f"${self.usd_total:.2f}")
 
         eur_title = "EUR Total".center(MAX_LINE_LEN, SEPARATOR)
-        self.console.print(f"[bold green]{eur_title}")
-        self.console.print(f"€{self.eur_total:.2f}")
+        console.print(f"[bold green]{eur_title}")
+        console.print(f"€{self.eur_total:.2f}")
 
         end_string = SEPARATOR * MAX_LINE_LEN
-        self.console.print(f"[bold green]{end_string}\n")
-
-    def _save_price_log(self):
-        """
-        Save the current date and total prices in USD and EUR to a CSV file.
-
-        This will append a new entry to the output file if no entry has been made for
-        today.
-
-        :raises FileNotFoundError: If the output file does not exist.
-        :raises IOError: If there is an error writing to the output file.
-        """
-        with open(OUTPUT_FILE, "r", encoding="utf-8") as price_logs:
-            price_logs_reader = csv.reader(price_logs)
-            rows = list(price_logs_reader)
-            last_log_date, _, _ = rows[-1] if rows else ("", "", "")
-
-        today = datetime.now().strftime("%Y-%m-%d")
-        if last_log_date != today:
-            # Append first price calculation of the day
-            with open(OUTPUT_FILE, "a", newline="", encoding="utf-8") as price_logs:
-                price_logs_writer = csv.writer(price_logs)
-                price_logs_writer.writerow(
-                    [today, f"{self.usd_total:.2f}$", f"{self.eur_total:.2f}€"]
-                )
-        else:
-            # Replace the last calculation of today with the most recent one of today
-            with open(OUTPUT_FILE, "r+", newline="", encoding="utf-8") as price_logs:
-                price_logs_reader = csv.reader(price_logs)
-                rows = list(price_logs_reader)
-                rows_without_today = rows[:-1]
-                price_logs.seek(0)
-                price_logs.truncate()
-
-                price_logs_writer = csv.writer(price_logs)
-                price_logs_writer.writerows(rows_without_today)
-                price_logs_writer.writerow(
-                    [today, f"{self.usd_total:.2f}$", f"{self.eur_total:.2f}€"]
-                )
-
-    def read_price_log(self):
-        """
-        Parse the output file to extract dates, dollar prices, and euro prices. This
-        data is used for drawing the plot of past prices.
-
-        :return: A tuple containing three lists: dates, dollar prices, and euro prices.
-        :raises FileNotFoundError: If the output file does not exist.
-        :raises IOError: If there is an error reading the output file.
-        """
-        dates, dollars, euros = [], [], []
-        with open(OUTPUT_FILE, "r", encoding="utf-8") as price_logs:
-            price_logs_reader = csv.reader(price_logs)
-            for row in price_logs_reader:
-                date, price_usd, price_eur = row
-                date = datetime.strptime(date, "%Y-%m-%d")
-                price_usd = float(price_usd.rstrip("$"))
-                price_eur = float(price_eur.rstrip("€"))
-
-                dates.append(date)
-                dollars.append(price_usd)
-                euros.append(price_eur)
-
-        return dates, dollars, euros
-
-    def _construct_recent_calculations_embeds(self):
-        """
-        Construct the embeds for the Discord message that will be sent after a price
-        calculation has been made.
-
-        :return: A list of embeds for the Discord message.
-        """
-        dates, usd_logs, eur_logs = self.read_price_log()
-        dates, usd_logs, eur_logs = reversed(dates), reversed(usd_logs), reversed(eur_logs)
-
-        date_history, usd_history, eur_history = [], [], []
-        for date, usd_log, eur_log in zip(dates, usd_logs, eur_logs):
-            if len(date_history) >= DC_RECENT_HISTORY_LIMIT:
-                break
-            date_history.append(date.strftime("%Y-%m-%d"))
-            usd_history.append(f"${usd_log:.2f}")
-            eur_history.append(f"€{eur_log:.2f}")
-
-        date_history = "\n".join(date_history)
-        usd_history = "\n".join(usd_history)
-        eur_history = "\n".join(eur_history)
-
-        embeds = [
-            {
-                "title": "📊 Recent Price History",
-                "color": 5814783,
-                "fields": [
-                    {
-                        "name": "Date",
-                        "value": date_history,
-                        "inline": True,
-                    },
-                    {
-                        "name": "USD Total",
-                        "value": usd_history,
-                        "inline": True,
-                    },
-                    {
-                        "name": "EUR Total",
-                        "value": eur_history,
-                        "inline": True,
-                    },
-                ],
-            }
-        ]
-
-        return embeds
+        console.print(f"[bold green]{end_string}\n")
 
     def _send_discord_notification(self):
         """Send a message to a Discord webhook if notifications are enabled in the
@@ -249,25 +98,9 @@ class Scraper:
             "App Settings", "discord_notifications", fallback=False
         )
         webhook_url = self.config.get("User Settings", "discord_webhook_url", fallback=None)
-        webhook_url = None if webhook_url in ("None", "") else webhook_url
 
         if discord_notifications and webhook_url:
-            embeds = self._construct_recent_calculations_embeds()
-            try:
-                response = self.session.post(
-                    url=webhook_url,
-                    json={
-                        "embeds": embeds,
-                        "username": DC_WEBHOOK_USERNAME,
-                        "avatar_url": DC_WEBHOOK_AVATAR_URL,
-                    },
-                )
-                response.raise_for_status()
-                self.console.print("[bold steel_blue3][+] Discord notification sent.\n")
-            except RequestException as error:
-                self.console.print(f"[bold red][!] Failed to send Discord notification: {error}\n")
-            except Exception as error:
-                self.console.print(f"[bold red][!] An unexpected error occurred: {error}\n")
+            DiscordNotifier.notify(webhook_url)
 
     @retry(stop=stop_after_attempt(10))
     def _get_page(self, url):
@@ -281,14 +114,14 @@ class Scraper:
         :raises RetryError: If the retry limit is reached.
         """
         use_proxy = self.config.getboolean("App Settings", "use_proxy", fallback=False)
-        api_key = self.config.get("User Settings", "api_key", fallback=None)
-        api_key = None if api_key in ("None", "") else api_key
-        if use_proxy and api_key:
+        proxy_api_key = self.config.get("User Settings", "proxy_api_key", fallback=None)
+
+        if use_proxy and proxy_api_key:
             page = self.session.get(
                 url=url,
                 proxies={
-                    "http": HTTP_PROXY_URL.format(api_key),
-                    "https": HTTPS_PROXY_URL.format(api_key),
+                    "http": HTTP_PROXY_URL.format(proxy_api_key),
+                    "https": HTTPS_PROXY_URL.format(proxy_api_key),
                 },
                 verify=False,
             )
@@ -296,8 +129,7 @@ class Scraper:
             page = self.session.get(url)
 
         if not page.ok or not page.content:
-            status = page.status_code
-            self.console.print(f"[bold red][!] Failed to load page ({status}). Retrying...\n")
+            console.print(f"[bold red][!] Failed to load page ({page.status_code}). Retrying...\n")
             raise RequestException(f"Failed to load page: {url}")
 
         return page
@@ -340,26 +172,33 @@ class Scraper:
             hrefs, and names.
         """
         capsule_title = capsule_section.center(MAX_LINE_LEN, SEPARATOR)
-        self.console.print(f"[bold magenta]{capsule_title}\n")
+        console.print(f"[bold magenta]{capsule_title}\n")
 
         capsule_usd_total = 0
-        capsule_page = self._get_page(capsule_info["page"])
-        for capsule_name, capsule_href in zip(capsule_info["names"], capsule_info["items"]):
-            config_capsule_name = capsule_name.replace(" ", "_")
-            owned = self.config.getint(capsule_section, config_capsule_name, fallback=0)
-            if owned == 0:
-                continue
-
-            price_usd = self._parse_item_price(capsule_page, capsule_href)
-            price_usd_owned = round(float(owned * price_usd), 2)
-
-            self.console.print(f"[bold deep_sky_blue4]{capsule_name}")
-            self.console.print(PRICE_INFO.format(owned, price_usd, price_usd_owned))
-            capsule_usd_total += price_usd_owned
+        try:
+            capsule_page = self._get_page(capsule_info["page"])
+            for capsule_name, capsule_href in zip(capsule_info["names"], capsule_info["items"]):
+                config_capsule_name = capsule_name.replace(" ", "_")
+                owned = self.config.getint(capsule_section, config_capsule_name, fallback=0)
+                if owned == 0:
+                    continue
+
+                price_usd = self._parse_item_price(capsule_page, capsule_href)
+                price_usd_owned = round(float(owned * price_usd), 2)
+
+                console.print(f"[bold deep_sky_blue4]{capsule_name}")
+                console.print(PRICE_INFO.format(owned, price_usd, price_usd_owned))
+                capsule_usd_total += price_usd_owned
+        except (RetryError, ValueError):
+            console.print(
+                "[bold red][!] Too many requests. (Consider using proxies to prevent rate limiting)\n"
+            )
+        except Exception as error:
+            console.print(f"[bold red][!] An unexpected error occurred: {error}\n")
 
         return capsule_usd_total
 
-    def scrape_capsule_section_prices(self):
+    def _scrape_capsule_section_prices(self):
         """Scrape prices for all capsule sections defined in the configuration."""
         capsule_usd_total = 0
         for capsule_section, capsule_info in CAPSULE_INFO.items():
@@ -369,6 +208,19 @@ class Scraper:
 
         return capsule_usd_total
 
+    def _market_page_from_href(self, item_href):
+        """
+        Convert an href of a Steam Community Market item to a market page URL.
+
+        :param item_href: The href of the item listing, typically ending with the item's
+            name.
+        :return: A URL string for the Steam Community Market page of the item.
+        """
+        url_encoded_name = item_href.split("/")[-1]
+        page_url = f"https://steamcommunity.com/market/search?q={url_encoded_name}"
+
+        return page_url
+
     def _scrape_case_prices(self):
         """
         Scrape prices for all cases defined in the configuration.
@@ -383,36 +235,28 @@ class Scraper:
 
             case_name = config_case_name.replace("_", " ").title()
             case_title = case_name.center(MAX_LINE_LEN, SEPARATOR)
-            self.console.print(f"[bold magenta]{case_title}\n")
+            console.print(f"[bold magenta]{case_title}\n")
 
-            case_page = self._get_page(CASE_PAGES[case_index])
-            price_usd = self._parse_item_price(case_page, CASE_HREFS[case_index])
-            price_usd_owned = round(float(int(owned) * price_usd), 2)
-
-            self.console.print(PRICE_INFO.format(owned, price_usd, price_usd_owned))
-            case_usd_total += price_usd_owned
-
-            if not self.config.getboolean("App Settings", "use_proxy", fallback=False):
-                time.sleep(1)
+            try:
+                case_page_url = self._market_page_from_href(CASE_HREFS[case_index])
+                case_page = self._get_page(case_page_url)
+                price_usd = self._parse_item_price(case_page, CASE_HREFS[case_index])
+                price_usd_owned = round(float(int(owned) * price_usd), 2)
+
+                console.print(PRICE_INFO.format(owned, price_usd, price_usd_owned))
+                case_usd_total += price_usd_owned
+
+                if not self.config.getboolean("App Settings", "use_proxy", fallback=False):
+                    time.sleep(1)
+            except (RetryError, ValueError):
+                console.print(
+                    "[bold red][!] Too many requests. (Consider using proxies to prevent rate limiting)\n"
+                )
+            except Exception as error:
+                console.print(f"[bold red][!] An unexpected error occurred: {error}\n")
 
         return case_usd_total
 
-    def _market_page_from_href(self, item_href):
-        """
-        Convert an href of a Steam Community Market item to a market page URL. This is
-        done by decoding the URL-encoded item name and formatting it into a search URL.
-
-        :param item_href: The href of the item listing, typically ending with the item's
-            name.
-        :return: A URL string for the Steam Community Market page of the item.
-        """
-        url_encoded_name = item_href.split("/")[-1]
-        decoded_name = unquote(url_encoded_name)
-        decoded_name_query = decoded_name.lower().replace(" ", "+")
-        page_url = f"https://steamcommunity.com/market/search?q={decoded_name_query}"
-
-        return page_url
-
     def _scrape_custom_item_prices(self):
         """
         Scrape prices for custom items defined in the configuration.
@@ -421,129 +265,41 @@ class Scraper:
         total price for owned items.
         """
         custom_item_usd_total = 0
-        for config_custom_item_name, owned_and_href in self.config.items("Custom Items"):
-            if " " not in owned_and_href:
-                self.console.print(
-                    "[bold red][!] Invalid custom item format (<item_name> = <owned_count> <item_url>)\n"
-                )
-                continue
-
-            owned, custom_item_href = owned_and_href.split(" ", 1)
+        for custom_item_href, owned in self.config.items("Custom Items"):
             if int(owned) == 0:
                 continue
 
-            custom_item_name = config_custom_item_name.replace("_", " ").title()
+            custom_item_name = unquote(custom_item_href.split("/")[-1])
             custom_item_title = custom_item_name.center(MAX_LINE_LEN, SEPARATOR)
-            self.console.print(f"[bold magenta]{custom_item_title}\n")
-
-            custom_item_page_url = self._market_page_from_href(custom_item_href)
-            custom_item_page = self._get_page(custom_item_page_url)
-            price_usd = self._parse_item_price(custom_item_page, custom_item_href)
-            price_usd_owned = round(float(int(owned) * price_usd), 2)
-
-            self.console.print(PRICE_INFO.format(owned, price_usd, price_usd_owned))
-            custom_item_usd_total += price_usd_owned
+            console.print(f"[bold magenta]{custom_item_title}\n")
 
-            if not self.config.getboolean("App Settings", "use_proxy", fallback=False):
-                time.sleep(1)
+            try:
+                custom_item_page_url = self._market_page_from_href(custom_item_href)
+                custom_item_page = self._get_page(custom_item_page_url)
+                price_usd = self._parse_item_price(custom_item_page, custom_item_href)
+                price_usd_owned = round(float(int(owned) * price_usd), 2)
+
+                console.print(PRICE_INFO.format(owned, price_usd, price_usd_owned))
+                custom_item_usd_total += price_usd_owned
+
+                if not self.config.getboolean("App Settings", "use_proxy", fallback=False):
+                    time.sleep(1)
+            except (RetryError, ValueError):
+                console.print(
+                    "[bold red][!] Too many requests. (Consider using proxies to prevent rate limiting)\n"
+                )
+            except Exception as error:
+                console.print(f"[bold red][!] An unexpected error occurred: {error}\n")
 
         return custom_item_usd_total
 
-    def identify_background_task(self):
-        """
-        Search the OS for a daily background task that runs the scraper.
-
-        :return: True if a background task is found, False otherwise.
-        """
-        if OS == OSType.WINDOWS:
-            cmd = ["schtasks", "/query", "/tn", WIN_BACKGROUND_TASK_NAME]
-            return_code = call(cmd, stdout=DEVNULL, stderr=DEVNULL)
-            found = return_code == 0
-            return found
-        else:
-            # TODO: implement finder for cron jobs
-            return False
-
-    def _toggle_task_batch_file(self, enabled: bool):
-        """
-        Create or delete a batch file that runs the scraper.
-
-        :param enabled: If True, the batch file will be created; if False, the batch
-            file will be deleted.
-        """
-        if enabled:
-            with open(BATCH_FILE, "w", encoding="utf-8") as batch_file:
-                if RUNNING_IN_EXE:
-                    # The python executable is set to the executable itself
-                    # for executables created with PyInstaller
-                    batch_file.write(f"{PYTHON_EXECUTABLE} --only-scrape\n")
-                else:
-                    batch_file.write(f"cd {PROJECT_DIR}\n")
-                    batch_file.write(f"{PYTHON_EXECUTABLE} -m cs2tracker --only-scrape\n")
-        else:
-            if os.path.exists(BATCH_FILE):
-                os.remove(BATCH_FILE)
-
-    def _toggle_background_task_windows(self, enabled: bool):
-        """
-        Create or delete a daily background task that runs the scraper on Windows.
-
-        :param enabled: If True, the task will be created; if False, the task will be
-            deleted.
-        """
-        self._toggle_task_batch_file(enabled)
-        if enabled:
-            cmd = [
-                "schtasks",
-                "/create",
-                "/tn",
-                WIN_BACKGROUND_TASK_NAME,
-                "/tr",
-                WIN_BACKGROUND_TASK_CMD,
-                "/sc",
-                WIN_BACKGROUND_TASK_SCHEDULE,
-                "/st",
-                WIN_BACKGROUND_TASK_TIME,
-            ]
-            return_code = call(cmd, stdout=DEVNULL, stderr=DEVNULL)
-            if return_code == 0:
-                self.console.print("[bold green][+] Background task enabled.")
-            else:
-                self.console.print("[bold red][!] Failed to enable background task.")
-        else:
-            cmd = ["schtasks", "/delete", "/tn", WIN_BACKGROUND_TASK_NAME, "/f"]
-            return_code = call(cmd, stdout=DEVNULL, stderr=DEVNULL)
-            if return_code == 0:
-                self.console.print("[bold green][-] Background task disabled.")
-            else:
-                self.console.print("[bold red][!] Failed to disable background task.")
-
-    def toggle_background_task(self, enabled: bool):
-        """
-        Create or delete a daily background task that runs the scraper.
-
-        :param enabled: If True, the task will be created; if False, the task will be
-            deleted.
-        """
-        if OS == OSType.WINDOWS:
-            self._toggle_background_task_windows(enabled)
-        else:
-            # TODO: implement toggle for cron jobs
-            pass
-
     def toggle_use_proxy(self, enabled: bool):
         """
         Toggle the use of proxies for requests. This will update the configuration file.
 
         :param enabled: If True, proxies will be used; if False, they will not be used.
         """
-        self.config.set("App Settings", "use_proxy", str(enabled))
-        with open(CONFIG_FILE, "w", encoding="utf-8") as config_file:
-            self.config.write(config_file)
-
-        self.console.print(
-            f"[bold green]{'[+] Enabled' if enabled else '[-] Disabled'} proxy usage for requests."
-        )
+        self.config.toggle_use_proxy(enabled)
 
     def toggle_discord_webhook(self, enabled: bool):
         """
@@ -552,16 +308,10 @@ class Scraper:
         :param enabled: If True, the webhook will be used; if False, it will not be
             used.
         """
-        self.config.set("App Settings", "discord_notifications", str(enabled))
-        with open(CONFIG_FILE, "w", encoding="utf-8") as config_file:
-            self.config.write(config_file)
-
-        self.console.print(
-            f"[bold green]{'[+] Enabled' if enabled else '[-] Disabled'} Discord webhook notifications."
-        )
+        self.config.toggle_discord_webhook(enabled)
 
 
 if __name__ == "__main__":
     scraper = Scraper()
-    scraper.console.print(f"[bold yellow]{BANNER}\n{AUTHOR_STRING}\n")
+    console.print(f"[bold yellow]{BANNER}\n{AUTHOR_STRING}\n")
     scraper.scrape_prices()