Add available and in-progress badges methods, fix typos and method signature

Author: dpfrakes

example.py

@@ -119,7 +119,7 @@
     "x": f"Get Heart Rate Variability data (HRV) for '{today.isoformat()}'",
     "z": f"Get progress summary from '{startdate.isoformat()}' to '{today.isoformat()}' for all metrics",
     "A": "Get gear, the defaults, activity types and statistics",
-    "B": f"Get weight-ins from '{startdate.isoformat()}' to '{today.isoformat()}'",
+    "B": f"Get weigh-ins from '{startdate.isoformat()}' to '{today.isoformat()}'",
     "C": f"Get daily weigh-ins for '{today.isoformat()}'",
     "D": f"Delete all weigh-ins for '{today.isoformat()}'",
     "E": f"Add a weigh-in of {weight}{weightunit} on '{today.isoformat()}'",
@@ -437,6 +437,8 @@ def switch(api, i):
             elif i == "i":
                 # Get earned badges for user
                 display_json("api.get_earned_badges()", api.get_earned_badges())
+                # display_json("api.get_available_badges()", api.get_available_badges())
+                # display_json("api.get_in_progress_badges()", api.get_in_progress_badges())
             elif i == "j":
                 # Get adhoc challenges data from start and limit
                 display_json(
@@ -708,7 +710,7 @@ def switch(api, i):
                         f"api.get_gear_stats({uuid}) / {name}", api.get_gear_stats(uuid)
                     )
 
-            # WEIGHT-INS
+            # WEIGH-INS
             elif i == "B":
                 # Get weigh-ins data
                 display_json(

garminconnect/__init__.py

@@ -67,8 +67,8 @@ def __init__(
             "/personalrecord-service/personalrecord/prs"
         )
         self.garmin_connect_earned_badges_url = "/badge-service/badge/earned"
-        self.garmin_connect_adhoc_challenges_url = (
-            "/adhocchallenge-service/adHocChallenge/historical"
+        self.garmin_connect_available_badges_url = (
+            "/badge-service/badge/available?showExclusiveBadge=true"
         )
         self.garmin_connect_adhoc_challenges_url = (
             "/adhocchallenge-service/adHocChallenge/historical"
@@ -716,14 +716,56 @@ def get_personal_record(self) -> Dict[str, Any]:
 
         return self.connectapi(url)
 
-    def get_earned_badges(self) -> Dict[str, Any]:
+    def get_earned_badges(self) -> List[Dict[str, Any]]:
         """Return earned badges for current user."""
 
         url = self.garmin_connect_earned_badges_url
         logger.debug("Requesting earned badges for user")
 
         return self.connectapi(url)
 
+    def get_available_badges(self) -> List[Dict[str, Any]]:
+        """Return available badges for current user."""
+
+        url = self.garmin_connect_available_badges_url
+        logger.debug("Requesting available badges for user")
+
+        return self.connectapi(url)
+
+    def get_in_progress_badges(self) -> List[Dict[str, Any]]:
+        """Return in progress badges for current user."""
+
+        logger.debug("Requesting in progress badges for user")
+
+        earned_badges = self.get_earned_badges()
+        available_badges = self.get_available_badges()
+
+        # Filter out badges that are not in progress
+        def badge_in_progress(badge):
+            """Return True if the badge is in progress."""
+            if "badgeProgressValue" not in badge:
+                return False
+            if badge["badgeProgressValue"] is None:
+                return False
+            if badge["badgeProgressValue"] == 0:
+                return False
+            if badge["badgeProgressValue"] == badge["badgeTargetValue"]:
+                if (
+                    "badgeLimitCount" not in badge
+                    or badge["badgeLimitCount"] is None
+                ):
+                    return False
+                return badge["badgeEarnedNumber"] < badge["badgeLimitCount"]
+            return True
+
+        earned_in_progress_badges = list(
+            filter(badge_in_progress, earned_badges)
+        )
+        available_in_progress_badges = list(
+            filter(badge_in_progress, available_badges)
+        )
+        return earned_in_progress_badges + available_in_progress_badges
+
     def get_adhoc_challenges(self, start, limit) -> Dict[str, Any]:
         """Return adhoc challenges for current user."""