2.0.0 (#208)

Author: cal4

.dockerignore

@@ -0,0 +1,16 @@
+# Ignore everything
+*
+
+# Allow files and directories
+!/localized_activities
+!/src
+!/main.py
+!/docker.sh
+!/requirements.txt
+
+# Ignore unnecessary files inside allowed directories
+# This should go after the allowed directories
+**/*~
+**/*.log
+**/.DS_Store
+**/Thumbs.db

.github/CODEOWNERS

@@ -0,0 +1,2 @@
+*                   @cal4
+src/readToEarn.py   @jdeath

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -13,7 +13,7 @@ body:
             (I have checked every bug report on GitHub)
           required: true
         - label: |
-            I've cleared the sessions folder.
+            I've ran the program with the -r argument.
           required: true
   - type: dropdown
     id: branch
@@ -44,9 +44,10 @@ body:
   - type: textarea
     id: logs
     attributes:
-      label: Copy and paste your error
+      label: Import the logs
       description: |
-        From the terminal that was running the farmer, copy and paste the error/bug here.
+        Paste the `logs/activity.log` file, or the `logs/activity-*.log` file containing the error.
+      placeholder: Don't write the logs here, just drag and drop the file here
     validations:
       required: true
   - type: textarea

.github/dependabot.yml

@@ -9,3 +9,4 @@ updates:
     directory: "/" # Location of package manifests
     schedule:
       interval: "weekly"
+    target-branch: "develop"

.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 }}

.gitignore

@@ -176,14 +176,17 @@ pyrightconfig.json
 
 # End of https://www.toptal.com/developers/gitignore/api/python
 
+# MacOS
+.DS_Store
+.AppleDouble
+.LSOverride
+Icon
+._*
+
 # Custom rules (everything added below won't be overridden by 'Generate .gitignore File' if you use 'Update' option)
 
-accounts.json
-sessions
-logs
-runbot.bat
-.DS_Store
-/google_trends.dat
-/google_trends.dir
-/google_trends.bak
-/config-private.yaml
+sessions/
+logs/
+/google_trends.*
+config.yaml
+MsReward.xml

.pylintrc

@@ -439,7 +439,15 @@ disable=raw-checker-failed,
         fixme,
         invalid-name,
         missing-function-docstring,
-        missing-module-docstring
+        missing-module-docstring,
+        broad-exception-caught, # As we catch any error to avoid stopping tasks and sending correct apprise notifications
+        attribute-defined-outside-init, # As we set attributes outside __init__ in many cases
+        logging-fstring-interpolation, # As we always log at the DEBUG level, so lazy interpolation doesn't change anything
+        logging-not-lazy,
+        too-many-branches,
+        too-many-instance-attributes,
+        too-many-statements,
+        too-few-public-methods
 
 # Enable the message, report, category or checker with the given id(s). You can
 # either give multiple identifier separated by comma (,) or put this option

.template-config-private.yaml

@@ -5,6 +5,59 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.0.0] - 2025-04-08
+
+### Added
+
+- Consolidated all language-specific data into a single dictionary for `localized_activities`, simplifying management and improving performance.
+- New activity handling.
+- Added country and language code validation functions and updated browser geolocation handling.
+- Added configuration options in `config.yaml` for activity handling and error notifications:
+  - `apprise.notify.incomplete-activity` for incomplete activity notifications.
+  - `apprise.notify.login-code` for login with phone code notifications.
+- Added reset functionality to delete session files and terminate Chrome processes.
+- Added CODEOWNERS file for repository management.
+- Added Docker build for easier deployment and execution.
+- Added `run.ps1` script with the following features:
+  - Automatic detection of Python installations or virtual environments.
+  - Retry logic for running the main script with configurable maximum attempts.
+  - Automatic cleanup of Chrome processes and session files on failure.
+  - Support for updating the script via Git if in a Git repository.
+  - Command-line options for customization, including Python path, script directory, and session folder.
+
+### Changed
+
+- Improved retry logic in `getBingInfo` and updated backoff factor configuration.
+- Updated `config.yaml` to enhance logging and error reporting configurations.
+- Refactored activity handling to use localized titles and queries.
+- Improved logging for activity completion, error reporting, and localization warnings.
+- Enhanced JSON response handling in `utils.py` and updated parameters in `run.ps1`.
+- Replaced `accounts.json` with account information now stored in `config.yaml` for better configuration management.
+- Adjusted cooldowns and wait times for better performance.
+
+### Fixed
+
+- Fixed issues with quiz completion logic for "This or That" and "ABC" activities.
+- Addressed edge cases where activities were incorrectly marked as incomplete.
+- Fixed activities containing non-breakable spaces in their names.
+- Fixed Google Trends API integration and improved trend keyword handling.
+- Fixed click handling in `activities.py` to use the correct answer element.
+- Fixed issue related to mobile search for level 1 users.
+- Fixed Apprise notification error.
+- Fixed exit code to return `exit 1` on errors instead of `exit 0`.
+
+### Removed
+
+- Removed unused imports and deprecated classes for cleaner codebase.
+- Removed `MS_reward.bat` in favor of the more robust `run.ps1` script.
+- Removed `config-private.yaml` in favor of consolidating configurations into `config.yaml`.
+- Removed password logging.
+
+### Other
+
+- Added locked/banned user detection.
+- Skipped un-doable activities.
+
 ## [1.1.0] - 2024-08-30
 
 ### Added
@@ -87,11 +140,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - New [config.yaml](config.yaml) options
   - `retries`
-    - `base_delay_in_seconds`: how many seconds to delay
+    - `base-delay-in-seconds`: how many seconds to delay
     - `max`: the max amount of retries to attempt
     - `strategy`: method to use when retrying, can be either:
-      - `CONSTANT`: the default; a constant `base_delay_in_seconds` between attempts
-      - `EXPONENTIAL`: an exponentially increasing `base_delay_in_seconds` between attempts
+      - `CONSTANT`: the default; a constant `base-delay-in-seconds` between attempts
+      - `EXPONENTIAL`: an exponentially increasing `base-delay-in-seconds` between attempts
   - `apprise.summary`: configures how results are summarized via Apprise, can be either:
     - `ALWAYS`: the default, as it was before, how many points were gained and goal percentage if set
     - `ON_ERROR`: only sends email if for some reason there's remaining searches

CHANGELOG.md

@@ -0,0 +1,20 @@
+FROM python:3.11-slim
+
+COPY . /app
+
+WORKDIR /app
+
+ENV LANG=en_US.UTF-8
+ENV LANGUAGE=en_US:en
+ENV LC_ALL=en_US.UTF-8
+
+RUN apt-get update && \
+    DEBIAN_FRONTEND=noninteractive apt-get install -y chromium chromium-driver cron locales && \
+    sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen && \
+    locale-gen en_US.UTF-8 && \
+    chmod +x /app/docker.sh && \
+    rm -rf /var/lib/apt/lists/* && \
+    rm -rf /etc/cron.*/* && \
+    pip install --no-cache-dir -r requirements.txt
+
+CMD ["/app/docker.sh"]