1.2.0

.github/workflows/build_push_docker_image.yml

@@ -0,0 +1,37 @@
+name: Build and Push Docker Image
+
+on:
+  push:
+    tags:
+      - "*"
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v4
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ secrets.DOCKERHUB_USERNAME }}/ms-rewards
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      - name: Login to DockerHub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      - name: Build and push
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}

.template-config-private.yaml

@@ -1,5 +1,4 @@
-# config-private.yaml
-# Copy this file to config-private.yaml to use
-apprise:
-  urls:
-    - 'discord://WebhookID/WebhookToken'  # Replace with your actual Apprise service URLs
+# config-private.yaml
+apprise:
+  urls:
+    - "discord://{WebhookID}/{WebhookToken}" # Replace with your actual Apprise service URLs

Dockerfile

@@ -0,0 +1,9 @@
+FROM python:slim
+COPY . /app
+WORKDIR /app
+RUN apt-get update && apt-get install -y cron chromium chromium-driver \
+   && apt-get clean \
+   && rm -rf /var/lib/apt/lists/*
+RUN pip install --no-cache-dir -r requirements.txt 
+ENV DOCKER=1
+CMD ["sh", "docker.sh"]

README.md

@@ -9,7 +9,8 @@
 
 
 > [!IMPORTANT]
-> If you are multi-accounting and abusing the service for which this is intended - **_DO NOT COMPLAIN ABOUT BANS!!!_**
+> If you are multi-accounting and abusing the service for which this is intended - *
+*_DO NOT COMPLAIN ABOUT BANS!!!_**
 
 
 
@@ -42,18 +43,21 @@
 3. (Windows Only) Make sure Visual C++ redistributable DLLs are installed
 
    If they're not, install the current "vc_redist.exe" from
-   this [link](https://learn.microsoft.com/en-GB/cpp/windows/latest-supported-vc-redist?view=msvc-170) and reboot your
-   computer
+   this [link](https://learn.microsoft.com/en-GB/cpp/windows/latest-supported-vc-redist?view=msvc-170)
+   and reboot your computer
 
-4. Edit the `accounts.json.sample` with your accounts credentials and rename it by removing `.sample` at the end.
+4. Edit the `.template-config-private.yaml` accordingly and rename it to `config-private.yaml`.
 
-   The "totp" field is not mandatory, only enter your TOTP key if you use it for 2FA (if ommitting, don't keep
-   it as an empty string, remove the line completely).
+5. Edit the `accounts.json.sample` with your accounts credentials and rename it by removing
+   `.sample` at the end.
 
-   The "proxy" field is not mandatory, you can omit it if you don't want to use proxy (don't keep it as an empty string,
-   remove the line completely).
+   The "totp" field is not mandatory, only enter your TOTP key if you use it for 2FA (if
+   ommitting, don't keep it as an empty string, remove the line completely).
 
-    - If you want to add more than one account, the syntax is the following:
+   The "proxy" field is not mandatory, you can omit it if you don't want to use proxy (don't
+   keep it as an empty string, remove the line completely).
+
+     - If you want to add more than one account, the syntax is the following:
 
    ```json
    [
@@ -72,29 +76,34 @@
    ]
    ```
 
-5. Run the script:
+6. Run the script:
 
    `python main.py`
 
-6. (Windows Only) You can set up automatic execution by generating a Task Scheduler XML file.
-
-   If you are a Windows user, run the `generate_task_xml.py` script to create a `.xml` file. After generating the file, import it into Task Scheduler to schedule automatic execution of the script. This will allow the script to run at the specified time without manual intervention. 
+7. (Windows Only) You can set up automatic execution by generating a Task Scheduler XML file.
 
-   To import the XML file into Task Scheduler, see [this guide](https://superuser.com/a/485565/709704).
+   If you are a Windows user, run the `generate_task_xml.py` script to create a `.xml` file.
+   After generating the file, import it into Task Scheduler to schedule automatic execution of
+   the script. This will allow the script to run at the specified time without manual
+   intervention.
 
+   To import the XML file into Task Scheduler,
+   see [this guide](https://superuser.com/a/485565/709704).
 
 ## Launch arguments
 
 - `-v/--visible` to disable headless
-- `-l/--lang` to force a language (ex: en)
+- `-l/--lang` to force a language (ex: en) see https://serpapi.com/google-languages for options
 - `-g/--geo` to force a searching geolocation (ex: US)
+  see https://serpapi.com/google-trends-locations for options
   `https://trends.google.com/trends/ for proper geolocation abbreviation for your choice. These MUST be uppercase!!!`
-- `-p/--proxy` to add a proxy to the whole program, supports http/https/socks4/socks5 (overrides per-account proxy in
-  accounts.json)
+- `-p/--proxy` to add a proxy to the whole program, supports http/https/socks4/socks5 (
+  overrides per-account proxy in accounts.json)
   `(ex: http://user:pass@host:port)`
 - `-cv/--chromeversion` to use a specific version of chrome
   `(ex: 118)`
-- `-da/--disable-apprise` disables Apprise notifications for the session, overriding [config.yaml](config.yaml).
+- `-da/--disable-apprise` disables Apprise notifications for the session,
+  overriding [config.yaml](config.yaml).
   Useful when running manually as opposed to on a schedule.
 - `-t/--searchtype` to only do `desktop` or `mobile` searches, `(ex: --searchtype=mobile)`
 
@@ -108,7 +117,8 @@
 - Multi-Account Management
 - Session storing
 - 2FA Support
-- Notifications via [Apprise](https://github.com/caronc/apprise) - no longer limited to Telegram or Discord
+- Notifications via [Apprise](https://github.com/caronc/apprise) - no longer limited to
+  Telegram or Discord
 - Proxy Support (3.0) - they need to be **high quality** proxies
 - Logs to CSV file for point tracking
 
@@ -117,8 +127,8 @@
 Fork this repo and:
 
 * if providing a bugfix, create a pull request into master.
-* if providing a new feature, please create a pull request into develop. Extra points if you update
-  the [CHANGELOG.md](CHANGELOG.md).
+* if providing a new feature, please create a pull request into develop. Extra points if you
+  update the [CHANGELOG.md](CHANGELOG.md).
 
 ## To Do List (When time permits or someone makes a PR)
 

config.yaml

@@ -1,7 +1,14 @@
 # config.yaml
 apprise:
+  notify:
+    incomplete-promotions: True # True or False
+    uncaught-exceptions: True # True or False
   summary: ON_ERROR
+default:
+  geolocation: US # Replace with your country code https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
+logging:
+  level: INFO # See https://docs.python.org/3/library/logging.html#logging-levels
 retries:
   base_delay_in_seconds: 14.0625 # base_delay_in_seconds * 2^max = 14.0625 * 2^6 = 900 = 15 minutes
-  max: 8
+  max: 4
   strategy: EXPONENTIAL

docker.sh

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+# Check if RUN_ONCE environment variable is set. In case, running the script now and exiting.
+if [ "$RUN_ONCE" = "true" ]
+then
+    echo "RUN_ONCE environment variable is set. Running the script now and exiting."
+    python main.py
+    exit 0
+fi
+# Check if CRON_SCHEDULE environment variable is set
+if [ -z "$CRON_SCHEDULE" ]
+then
+    echo "CRON_SCHEDULE environment variable is not set. Setting it to 4 AM everyday by default"
+    CRON_SCHEDULE="0 4 * * *"
+fi
+
+# Setting up cron job
+echo "$CRON_SCHEDULE root python /app/main.py >> /var/log/cron.log 2>&1" > /etc/cron.d/rewards-cron-job
+
+# Give execution rights on the cron job
+chmod 0644 /etc/cron.d/rewards-cron-job
+
+# Apply cron job
+crontab /etc/cron.d/rewards-cron-job
+
+# Create the log file to be able to run tail
+touch /var/log/cron.log
+
+echo "Cron job is set to run at $CRON_SCHEDULE. Waiting for the cron to run..."
+
+# Run the cron
+cron && tail -f /var/log/cron.log

main.py

@@ -23,7 +23,7 @@
 )
 from src.browser import RemainingSearches
 from src.loggingColoredFormatter import ColoredFormatter
-from src.utils import Utils
+from src.utils import Utils, CONFIG
 
 
 def main():
@@ -40,10 +40,8 @@ def main():
             earned_points = executeBot(currentAccount, args)
         except Exception as e1:
             logging.error("", exc_info=True)
-            Utils.sendNotification(
-                f"⚠️ Error executing {currentAccount.username}, please check the log",
-                traceback.format_exc(),
-            )
+            Utils.sendNotification(f"⚠️ Error executing {currentAccount.username}, please check the log",
+                                   traceback.format_exc(), e1)
             continue
         previous_points = previous_points_data.get(currentAccount.username, 0)
 
@@ -98,15 +96,14 @@ def setupLogging():
     logs_directory.mkdir(parents=True, exist_ok=True)
 
     # so only our code is logged if level=logging.DEBUG or finer
-    # if not working see https://stackoverflow.com/a/48891485/4164390
     logging.config.dictConfig(
         {
             "version": 1,
             "disable_existing_loggers": True,
         }
     )
     logging.basicConfig(
-        level=logging.DEBUG,
+        level=logging.getLevelName(CONFIG.get("logging").get("level").upper()),
         format=_format,
         handlers=[
             handlers.TimedRotatingFileHandler(
@@ -281,7 +278,7 @@ def executeBot(currentAccount: Account, args: argparse.Namespace):
         f"[POINTS] You are now at {Utils.formatNumber(accountPoints)} points !"
     )
     appriseSummary = AppriseSummary[
-        Utils.loadConfig().get("apprise", {}).get("summary", AppriseSummary.ALWAYS.name)
+        CONFIG.get("apprise").get("summary")
     ]
     if appriseSummary == AppriseSummary.ALWAYS:
         goalStatus = ""
@@ -357,5 +354,5 @@ def save_previous_points_data(data):
     except Exception as e:
         logging.exception("")
         Utils.sendNotification(
-            "⚠️ Error occurred, please check the log", traceback.format_exc()
+            "⚠️ Error occurred, please check the log", traceback.format_exc(), e
         )

requirements.txt

@@ -1,15 +1,16 @@
-requests~=2.32.3
-selenium>=4.15.2 # not directly required, pinned by Snyk to avoid a vulnerability
-ipapi~=1.0.4
-undetected-chromedriver==3.5.5
-selenium-wire~=5.1.0
+apprise~=1.9.0
+blinker==1.7.0 # prevents issues on newer versions
 numpy>=1.22.2 # not directly required, pinned by Snyk to avoid a vulnerability
-setuptools
+ipapi~=1.0.4
 psutil
-blinker==1.7.0 # prevents issues on newer versions
-apprise~=1.8.1
+pycountry~=24.6.1
+pyotp~=2.9.0
 pyyaml~=6.0.2
-urllib3>=2.2.2 # not directly required, pinned by Snyk to avoid a vulnerability
 requests-oauthlib~=2.0.0
-zipp>=3.19.1 # not directly required, pinned by Snyk to avoid a vulnerability
-pyotp~=2.9.0
+requests~=2.32.3
+selenium-wire~=5.1.0
+selenium>=4.15.2 # not directly required, pinned by Snyk to avoid a vulnerability
+setuptools
+undetected-chromedriver==3.5.5
+urllib3>=2.2.2 # not directly required, pinned by Snyk to avoid a vulnerability
+zipp>=3.19.1 # not directly required, pinned by Snyk to avoid a vulnerability

src/activities.py

@@ -1,8 +1,10 @@
 import contextlib
+import logging
 import random
 import time
 
 from selenium.common import TimeoutException
+from selenium.common.exceptions import NoSuchElementException, ElementNotInteractableException
 from selenium.webdriver.common.by import By
 from selenium.webdriver.remote.webelement import WebElement
 
@@ -14,6 +16,29 @@ def __init__(self, browser: Browser):
         self.browser = browser
         self.webdriver = browser.webdriver
 
+    def click_element_if_visible(self, element):
+        try:
+            if element.is_displayed() and element.is_enabled():
+                element.click()
+                logging.info("Dashboard pop-up registered and closed, needs to be done once on new accounts")
+            else:
+                pass
+        except (ElementNotInteractableException, NoSuchElementException):
+            pass
+
+    def dashboardPopUpModalCloseCross(self):
+        try:
+
+            element = self.webdriver.find_element(By.CSS_SELECTOR, ".dashboardPopUpPopUpSelectButton")
+            self.click_element_if_visible(element)
+            time.sleep(0.25)
+        except NoSuchElementException:
+            return
+
+
+
+
+
     def openDailySetActivity(self, cardId: int):
         # Open the Daily Set activity for the given cardId
         element = self.webdriver.find_element(By.XPATH,
@@ -26,7 +51,7 @@ def openMorePromotionsActivity(self, cardId: int):
         element = self.webdriver.find_element(By.CSS_SELECTOR,
                                               f"#more-activities > .m-card-group > .ng-scope:nth-child({cardId + 1}) .ds-card-sec")
         self.browser.utils.click(element)
-        self.browser.utils.switchToNewTab(timeToWait=5)
+        self.browser.utils.switchToNewTab(timeToWait=8)
 
     def completeSearch(self):
         # Simulate completing a search activity
@@ -45,6 +70,7 @@ def completeQuiz(self):
         with contextlib.suppress(TimeoutException):
             startQuiz = self.browser.utils.waitUntilQuizLoads()
             self.browser.utils.click(startQuiz)
+        # this is bugged on Chrome for some reason
         self.browser.utils.waitUntilVisible(
             By.ID, "overlayPanel", 5
         )