Merge pull request #35 from jhurl3y/master

New APIs + cleanup

Author: cyberjunky

garminconnect/__init__.py

@@ -13,25 +13,31 @@
 MODERN_URL = 'https://connect.garmin.com/modern'
 SIGNIN_URL = 'https://sso.garmin.com/sso/signin'
 
+
 class Garmin(object):
     """
     Object using Garmin Connect 's API-method.
     See https://connect.garmin.com/
     """
     url_user_summary = MODERN_URL + '/proxy/usersummary-service/usersummary/daily/'
-    url_user_summary_chart = MODERN_URL + '/proxy/wellness-service/wellness/dailySummaryChart/'
+    url_user_summary_chart = MODERN_URL + \
+        '/proxy/wellness-service/wellness/dailySummaryChart/'
     url_heartrates = MODERN_URL + '/proxy/wellness-service/wellness/dailyHeartRate/'
     url_sleepdata = MODERN_URL + '/proxy/wellness-service/wellness/dailySleepData/'
-    url_body_composition = MODERN_URL + '/proxy/weight-service/weight/daterangesnapshot'
-    url_activities = MODERN_URL + '/proxy/activitylist-service/activities/search/activities'
-    url_exercise_sets = MODERN_URL + '/proxy/activity-service/activity/'
+    url_body_composition = MODERN_URL + \
+        '/proxy/weight-service/weight/daterangesnapshot'
+    url_activities = MODERN_URL + \
+        '/proxy/activitylist-service/activities/search/activities'
+    url_activity = MODERN_URL + '/proxy/activity-service/activity/'
+    url_personal_record = MODERN_URL + '/proxy/personalrecord-service/personalrecord/'
     url_tcx_download = MODERN_URL + "/proxy/download-service/export/tcx/activity/"
     url_gpx_download = MODERN_URL + "/proxy/download-service/export/gpx/activity/"
     url_kml_download = MODERN_URL + "/proxy/download-service/export/kml/activity/"
     url_fit_download = MODERN_URL + "/proxy/download-service/files/activity/"
     url_csv_download = MODERN_URL + "/proxy/download-service/export/csv/activity/"
     url_device_list = MODERN_URL + '/proxy/device-service/deviceregistration/devices'
-    url_device_settings = MODERN_URL + '/proxy/device-service/deviceservice/device-info/settings/'
+    url_device_service = MODERN_URL + \
+        '/proxy/device-service/deviceservice/'
 
     headers = {
         'User-Agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.88 Safari/537.36',
@@ -50,7 +56,6 @@ def __init__(self, email, password):
         self.full_name = ""
         self.unit_system = ""
 
-
     def login(self):
         """
         Login to portal
@@ -87,9 +92,11 @@ def login(self):
             'displayNameRequired': 'false'
         }
 
-        self.logger.debug("Login to Garmin Connect using POST url %s", SIGNIN_URL)
+        self.logger.debug(
+            "Login to Garmin Connect using POST url %s", SIGNIN_URL)
         try:
-            response = self.req.post(SIGNIN_URL, headers=self.headers, params=params, data=data)
+            response = self.req.post(
+                SIGNIN_URL, headers=self.headers, params=params, data=data)
             if response.status_code == 429:
                 raise GarminConnectTooManyRequestsError("Too many requests")
 
@@ -99,7 +106,8 @@ def login(self):
             raise GarminConnectConnectionError("Error connecting") from err
 
         self.logger.debug("Response is %s", response.text)
-        response_url = re.search(r'"(https:[^"]+?ticket=[^"]+)"', response.text)
+        response_url = re.search(
+            r'"(https:[^"]+?ticket=[^"]+)"', response.text)
 
         if not response_url:
             raise GarminConnectAuthenticationError("Authentication error")
@@ -117,17 +125,18 @@ def login(self):
 
         self.logger.debug("Profile info is %s", response.text)
 
-        self.user_prefs = self.parse_json(response.text, 'VIEWER_USERPREFERENCES')
+        self.user_prefs = self.parse_json(
+            response.text, 'VIEWER_USERPREFERENCES')
         self.unit_system = self.user_prefs['measurementSystem']
         self.logger.debug("Unit system is %s", self.unit_system)
 
-        self.social_profile = self.parse_json(response.text, 'VIEWER_SOCIAL_PROFILE')
+        self.social_profile = self.parse_json(
+            response.text, 'VIEWER_SOCIAL_PROFILE')
         self.display_name = self.social_profile['displayName']
         self.full_name = self.social_profile['fullName']
         self.logger.debug("Display name is %s", self.display_name)
         self.logger.debug("Fullname is %s", self.full_name)
 
-
     def parse_json(self, html, key):
         """
         Find and return json data
@@ -137,7 +146,6 @@ def parse_json(self, html, key):
             text = found.group(1).replace('\\"', '"')
             return json.loads(text)
 
-
     def fetch_data(self, url):
         """
         Fetch and return data
@@ -150,57 +158,59 @@ def fetch_data(self, url):
             self.logger.debug("Fetch response code %s", response.status_code)
             response.raise_for_status()
         except requests.exceptions.HTTPError as err:
-            self.logger.debug("Exception occurred during data retrieval - perhaps session expired - trying relogin: %s" % err)
+            self.logger.debug(
+                "Exception occurred during data retrieval - perhaps session expired - trying relogin: %s" % err)
             self.login()
             try:
                 response = self.req.get(url, headers=self.headers)
                 if response.status_code == 429:
-                    raise GarminConnectTooManyRequestsError("Too many requests")
+                    raise GarminConnectTooManyRequestsError(
+                        "Too many requests")
 
-                self.logger.debug("Fetch response code %s", response.status_code)
+                self.logger.debug("Fetch response code %s",
+                                  response.status_code)
                 response.raise_for_status()
             except requests.exceptions.HTTPError as err:
-                self.logger.debug("Exception occurred during data retrieval, relogin without effect: %s" % err)
+                self.logger.debug(
+                    "Exception occurred during data retrieval, relogin without effect: %s" % err)
                 raise GarminConnectConnectionError("Error connecting") from err
 
         resp_json = response.json()
         self.logger.debug("Fetch response json %s", resp_json)
         return resp_json
 
-
     def get_full_name(self):
         """
         Return full name
         """
         return self.full_name
 
-
     def get_unit_system(self):
         """
         Return unit system
         """
         return self.unit_system
 
-
     def get_stats_and_body(self, cdate):
         """
         Return activity data and body composition
         """
         return ({**self.get_stats(cdate), **self.get_body_composition(cdate)['totalAverage']})
 
-
     def get_stats(self, cdate):   # cDate = 'YYY-mm-dd'
         """
         Fetch available activity data
         """
-        summaryurl = self.url_user_summary + self.display_name + '?' + 'calendarDate=' + cdate
+        summaryurl = self.url_user_summary + \
+            self.display_name + '?' + 'calendarDate=' + cdate
         self.logger.debug("Fetching statistics %s", summaryurl)
         try:
             response = self.req.get(summaryurl, headers=self.headers)
             if response.status_code == 429:
                 raise GarminConnectTooManyRequestsError("Too many requests")
 
-            self.logger.debug("Statistics response code %s", response.status_code)
+            self.logger.debug("Statistics response code %s",
+                              response.status_code)
             response.raise_for_status()
         except requests.exceptions.HTTPError as err:
             raise GarminConnectConnectionError("Error connecting") from err
@@ -212,20 +222,22 @@ def get_stats(self, cdate):   # cDate = 'YYY-mm-dd'
             try:
                 response = self.req.get(summaryurl, headers=self.headers)
                 if response.status_code == 429:
-                    raise GarminConnectTooManyRequestsError("Too many requests")
+                    raise GarminConnectTooManyRequestsError(
+                        "Too many requests")
 
-                self.logger.debug("Statistics response code %s", response.status_code)
+                self.logger.debug(
+                    "Statistics response code %s", response.status_code)
                 response.raise_for_status()
             except requests.exceptions.HTTPError as err:
-                self.logger.debug("Exception occurred during statistics retrieval, relogin without effect: %s" % err)
+                self.logger.debug(
+                    "Exception occurred during statistics retrieval, relogin without effect: %s" % err)
                 raise GarminConnectConnectionError("Error connecting") from err
             else:
                 resp_json = response.json()
 
         self.logger.debug("Statistics response json %s", resp_json)
         return resp_json
 
-
     def get_heart_rates(self, cdate):   # cDate = 'YYYY-mm-dd'
         """
         Fetch available heart rates data
@@ -235,7 +247,6 @@ def get_heart_rates(self, cdate):   # cDate = 'YYYY-mm-dd'
 
         return self.fetch_data(hearturl)
 
-
     def get_sleep_data(self, cdate):   # cDate = 'YYYY-mm-dd'
         """
         Fetch available sleep data
@@ -254,26 +265,28 @@ def get_steps_data(self, cdate):   # cDate = 'YYYY-mm-dd'
 
         return self.fetch_data(steps_url)
 
-
     def get_body_composition(self, cdate):   # cDate = 'YYYY-mm-dd'
         """
         Fetch available body composition data (only for cDate)
         """
-        bodycompositionurl = self.url_body_composition + '?startDate=' + cdate + '&endDate=' + cdate
-        self.logger.debug("Fetching body composition with url %s", bodycompositionurl)
+        bodycompositionurl = self.url_body_composition + \
+            '?startDate=' + cdate + '&endDate=' + cdate
+        self.logger.debug(
+            "Fetching body composition with url %s", bodycompositionurl)
 
         return self.fetch_data(bodycompositionurl)
 
     def get_activities(self, start, limit):
         """
         Fetch available activities
         """
-        activitiesurl = self.url_activities + '?start=' + str(start) + '&limit=' + str(limit)
+        activitiesurl = self.url_activities + '?start=' + \
+            str(start) + '&limit=' + str(limit)
         self.logger.debug("Fetching activities with url %s", activitiesurl)
 
         return self.fetch_data(activitiesurl)
 
-    def get_activities_by_date(self, startdate: str, enddate: str, activitytype = "" ) -> list[json]:
+    def get_activities_by_date(self, startdate, enddate, activitytype):
         """
         Fetch available activities between specific dates
 
@@ -297,7 +310,7 @@ def get_activities_by_date(self, startdate: str, enddate: str, activitytype = ""
             activityslug = ""
         while returndata:
             activitiesurl = self.url_activities + '?startDate=' + str(startdate) + '&endDate=' + str(
-                            enddate) + '&start=' + str(start) + '&limit=' + str(limit) + activityslug
+                enddate) + '&start=' + str(start) + '&limit=' + str(limit) + activityslug
             self.logger.debug("Fetching activities with url %s", activitiesurl)
             act = self.fetch_data(activitiesurl)
             if act:
@@ -310,28 +323,86 @@ def get_activities_by_date(self, startdate: str, enddate: str, activitytype = ""
 
     def get_excercise_sets(self, activity_id):
         activity_id = str(activity_id)
-        exercisesetsurl = f"{self.url_exercise_sets}{activity_id}/exerciseSets"
-        self.logger.debug(f"Fetching exercise sets for activity_id {activity_id}")
+        exercisesetsurl = f"{self.url_activity}{activity_id}/exerciseSets"
+        self.logger.debug(
+            f"Fetching exercise sets for activity_id {activity_id}")
 
         return self.fetch_data(exercisesetsurl)
 
+    def get_activity_splits(self, activity_id):
+        activity_id = str(activity_id)
+        splits_url = f"{self.url_activity}{activity_id}/splits"
+        self.logger.debug(
+            f"Fetching splits for activity_id {activity_id}")
+
+        return self.fetch_data(splits_url)
+
+    def get_activity_split_summaries(self, activity_id):
+        activity_id = str(activity_id)
+        split_summaries_url = f"{self.url_activity}{activity_id}/split_summaries"
+        self.logger.debug(
+            f"Fetching split summaries for activity_id {activity_id}")
+
+        return self.fetch_data(split_summaries_url)
+
+    def get_activity_weather(self, activity_id):
+        activity_id = str(activity_id)
+        activity_weather_url = f"{self.url_activity}{activity_id}/weather"
+        self.logger.debug(
+            f"Fetching weather for activity_id {activity_id}")
+
+        return self.fetch_data(activity_weather_url)
+
+    def get_activity_hr_in_timezones(self, activity_id):
+        activity_id = str(activity_id)
+        activity_hr_timezone_url = f"{self.url_activity}{activity_id}/hrTimeInZones"
+        self.logger.debug(
+            f"Fetching split summaries for activity_id {activity_id}")
+
+        return self.fetch_data(activity_hr_timezone_url)
+
+    def get_activity_details(self, activity_id, maxChartSize=2000, maxPolylineSize=4000):
+        activity_id = str(activity_id)
+        params = f"maxChartSize={maxChartSize}&maxPolylineSize={maxPolylineSize}"
+        details_url = f"{self.url_activity}{activity_id}/details?{params}"
+        self.logger.debug(
+            f"Fetching details for activity_id {activity_id}")
+
+        return self.fetch_data(details_url)
+
+    def get_personal_record(self, owner_display_name):
+        personal_records_url = f"{self.url_personal_record}prs/{owner_display_name}"
+        self.logger.debug(
+            f"Fetching prs for owner {owner_display_name}")
+
+        return self.fetch_data(personal_records_url)
+
     def get_devices(self):
         """
         Fetch available devices for the current account
         """
         devicesurl = self.url_device_list
-        self.logger.debug("Fetching available devices for the current account with url %s", devicesurl)
+        self.logger.debug(
+            "Fetching available devices for the current account with url %s", devicesurl)
 
         return self.fetch_data(devicesurl)
 
     def get_device_settings(self, device_id):
         """
         Fetch device settings for current device
         """
-        devicesurl = f"{self.url_device_settings}{device_id}"
+        devicesurl = f"{self.url_device_service}device-info/settings/{device_id}"
         self.logger.debug("Fetching device settings with url %s", devicesurl)
         return self.fetch_data(devicesurl)
 
+    def get_device_last_used(self):
+        """
+        Fetch device last used
+        """
+        device_last_used_url = f"{self.url_device_service}mylastused"
+        self.logger.debug(
+            "Fetching device last used with url %s", device_last_used_url)
+        return self.fetch_data(device_last_used_url)
 
     class ActivityDownloadFormat(Enum):
         ORIGINAL = auto()