ruby_garmin_connect 0.1.0

data/lib/garmin_connect/api/body_composition.rb

@@ -0,0 +1,127 @@
+# frozen_string_literal: true
+
+module GarminConnect
+  module API
+    # Body composition, weight, hydration, and blood pressure endpoints.
+    module BodyComposition
+      # Get body composition data for a date range.
+      # @param start_date [Date, String]
+      # @param end_date [Date, String]
+      def body_composition(start_date = today, end_date = start_date)
+        connection.get(
+          "/weight-service/weight/dateRange",
+          params: {
+            "startDate" => format_date(start_date),
+            "endDate" => format_date(end_date)
+          }
+        )
+      end
+
+      # Get weigh-ins for a date range.
+      # @param start_date [Date, String]
+      # @param end_date [Date, String]
+      def weigh_ins(start_date, end_date)
+        connection.get(
+          "/weight-service/weight/range/#{format_date(start_date)}/#{format_date(end_date)}",
+          params: { "includeAll" => true }
+        )
+      end
+
+      # Get weigh-ins for a specific day.
+      # @param date [Date, String]
+      def daily_weigh_ins(date = today)
+        connection.get(
+          "/weight-service/weight/dayview/#{format_date(date)}",
+          params: { "includeAll" => true }
+        )
+      end
+
+      # Add a weigh-in.
+      # @param value [Float] weight value
+      # @param date [Date, String] date of the weigh-in
+      # @param unit_key [String] "kg" or "lbs"
+      def add_weigh_in(value, date: today, unit_key: "kg")
+        timestamp = "#{format_date(date)}T12:00:00.000"
+        connection.post(
+          "/weight-service/user-weight",
+          body: {
+            "dateTimestamp" => timestamp,
+            "gmtTimestamp" => timestamp,
+            "unitKey" => unit_key,
+            "sourceType" => "MANUAL",
+            "value" => value
+          }
+        )
+      end
+
+      # Delete a specific weigh-in.
+      # @param date [Date, String]
+      # @param weight_pk [String, Integer] the weigh-in version/pk
+      def delete_weigh_in(date, weight_pk)
+        connection.delete("/weight-service/weight/#{format_date(date)}/byversion/#{weight_pk}")
+      end
+
+      # --- Hydration ---
+
+      # Get daily hydration data.
+      # @param date [Date, String]
+      def hydration(date = today)
+        connection.get("/usersummary-service/usersummary/hydration/daily/#{format_date(date)}")
+      end
+
+      # Log hydration intake.
+      # @param value_in_ml [Float] amount in milliliters (negative to subtract)
+      # @param date [Date, String]
+      def log_hydration(value_in_ml, date: today)
+        connection.put(
+          "/usersummary-service/usersummary/hydration/log",
+          body: {
+            "calendarDate" => format_date(date),
+            "timestampLocal" => "#{format_date(date)}T#{Time.now.strftime("%H:%M:%S")}.000",
+            "valueInML" => value_in_ml
+          }
+        )
+      end
+
+      # --- Blood Pressure ---
+
+      # Get blood pressure data for a date range.
+      # @param start_date [Date, String]
+      # @param end_date [Date, String]
+      def blood_pressure(start_date, end_date)
+        connection.get(
+          "/bloodpressure-service/bloodpressure/range/#{format_date(start_date)}/#{format_date(end_date)}",
+          params: { "includeAll" => true }
+        )
+      end
+
+      # Log a blood pressure measurement.
+      # @param systolic [Integer]
+      # @param diastolic [Integer]
+      # @param pulse [Integer]
+      # @param notes [String, nil]
+      # @param date [Date, String]
+      def log_blood_pressure(systolic:, diastolic:, pulse:, notes: nil, date: today)
+        timestamp = "#{format_date(date)}T#{Time.now.strftime("%H:%M:%S")}.000"
+        body = {
+          "measurementTimestampLocal" => timestamp,
+          "measurementTimestampGMT" => timestamp,
+          "systolic" => systolic,
+          "diastolic" => diastolic,
+          "pulse" => pulse,
+          "sourceType" => "MANUAL"
+        }
+        body["notes"] = notes if notes
+
+        connection.post("/bloodpressure-service/bloodpressure", body: body)
+      end
+
+      # Delete a blood pressure measurement.
+      # @param date [Date, String]
+      # @param version [String, Integer]
+      def delete_blood_pressure(date, version)
+        connection.delete("/bloodpressure-service/bloodpressure/#{format_date(date)}/#{version}")
+      end
+    end
+  end
+end

data/lib/garmin_connect/api/devices.rb

@@ -0,0 +1,118 @@
+# frozen_string_literal: true
+
+module GarminConnect
+  module API
+    # Device and gear management endpoints.
+    module Devices
+      # List all registered devices.
+      def devices
+        connection.get("/device-service/deviceregistration/devices")
+      end
+
+      # Get settings for a specific device (includes alarms).
+      # @param device_id [String, Integer]
+      def device_settings(device_id)
+        connection.get("/device-service/deviceservice/device-info/settings/#{device_id}")
+      end
+
+      # Get the last used device.
+      def last_used_device
+        connection.get("/device-service/deviceservice/mylastused")
+      end
+
+      # Get primary training device info.
+      def primary_training_device
+        connection.get("/web-gateway/device-info/primary-training-device")
+      end
+
+      # Get solar charging data for a device.
+      # @param device_id [String, Integer]
+      # @param start_date [Date, String]
+      # @param end_date [Date, String]
+      # @param single_day [Boolean]
+      def device_solar_data(device_id, start_date, end_date, single_day: false)
+        connection.get(
+          "/web-gateway/solar/#{device_id}/#{format_date(start_date)}/#{format_date(end_date)}",
+          params: { "singleDayView" => single_day }
+        )
+      end
+
+      # Get alarms for all devices.
+      def device_alarms
+        all_devices = devices
+        return [] unless all_devices.is_a?(Array)
+
+        all_devices.filter_map do |device|
+          device_id = device["deviceId"]
+          next unless device_id
+
+          settings = device_settings(device_id)
+          alarms = settings&.dig("alarms")
+          { "device" => device, "alarms" => alarms } if alarms
+        end
+      end
+
+      # --- Gear ---
+
+      # Get all gear for the current user.
+      def gear
+        connection.get(
+          "/gear-service/gear/filterGear",
+          params: { "userProfilePk" => user_profile_pk }
+        )
+      end
+
+      # Get gear linked to an activity.
+      # @param activity_id [String, Integer]
+      def activity_gear(activity_id)
+        connection.get(
+          "/gear-service/gear/filterGear",
+          params: { "activityId" => activity_id }
+        )
+      end
+
+      # Get statistics for a gear item.
+      # @param gear_uuid [String]
+      def gear_stats(gear_uuid)
+        connection.get("/gear-service/gear/stats/#{gear_uuid}")
+      end
+
+      # Get default gear assignments per activity type.
+      def gear_defaults
+        connection.get("/gear-service/gear/user/#{user_profile_pk}/activityTypes")
+      end
+
+      # Set or remove a gear item as default for an activity type.
+      # @param gear_uuid [String]
+      # @param activity_type [String]
+      # @param default [Boolean]
+      def set_gear_default(gear_uuid, activity_type, default: true)
+        if default
+          connection.put("/gear-service/gear/#{gear_uuid}/activityType/#{activity_type}/default/true")
+        else
+          connection.delete("/gear-service/gear/#{gear_uuid}/activityType/#{activity_type}")
+        end
+      end
+
+      # Link gear to an activity.
+      def link_gear(gear_uuid, activity_id)
+        connection.put("/gear-service/gear/link/#{gear_uuid}/activity/#{activity_id}")
+      end
+
+      # Unlink gear from an activity.
+      def unlink_gear(gear_uuid, activity_id)
+        connection.put("/gear-service/gear/unlink/#{gear_uuid}/activity/#{activity_id}")
+      end
+
+      # Get activities associated with a gear item.
+      # @param gear_uuid [String]
+      # @param limit [Integer]
+      def gear_activities(gear_uuid, limit: 20)
+        connection.get(
+          "/activitylist-service/activities/#{gear_uuid}/gear",
+          params: { "start" => 0, "limit" => limit }
+        )
+      end
+    end
+  end
+end

data/lib/garmin_connect/api/health.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module GarminConnect
+  module API
+    # Daily health and wellness data endpoints.
+    module Health
+      # Get daily activity summary (steps, calories, distance, etc.).
+      # @param date [Date, String] the date (YYYY-MM-DD)
+      def daily_summary(date = today)
+        connection.get(
+          "/usersummary-service/usersummary/daily/#{display_name}",
+          params: { "calendarDate" => format_date(date) }
+        )
+      end
+
+      alias_method :stats, :daily_summary
+
+      # Get combined daily stats and body composition.
+      # @param date [Date, String]
+      def stats_and_body(date = today)
+        {
+          "stats" => daily_summary(date),
+          "body_composition" => body_composition(date, date)
+        }
+      end
+
+      # Get heart rate data for a day.
+      # @param date [Date, String]
+      def heart_rates(date = today)
+        connection.get(
+          "/wellness-service/wellness/dailyHeartRate/#{display_name}",
+          params: { "date" => format_date(date) }
+        )
+      end
+
+      # Get resting heart rate for a date range.
+      # @param start_date [Date, String]
+      # @param end_date [Date, String]
+      def resting_heart_rate(start_date, end_date = start_date)
+        connection.get(
+          "/userstats-service/wellness/daily/#{display_name}",
+          params: {
+            "fromDate" => format_date(start_date),
+            "untilDate" => format_date(end_date),
+            "metricId" => 60
+          }
+        )
+      end
+
+      # Get Heart Rate Variability data.
+      # @param date [Date, String]
+      def hrv(date = today)
+        connection.get("/hrv-service/hrv/#{format_date(date)}")
+      end
+
+      # Get sleep data for a day.
+      # @param date [Date, String]
+      def sleep_data(date = today)
+        connection.get(
+          "/wellness-service/wellness/dailySleepData/#{display_name}",
+          params: { "date" => format_date(date), "nonSleepBufferMinutes" => 60 }
+        )
+      end
+
+      # Get all-day stress data.
+      # @param date [Date, String]
+      def stress(date = today)
+        connection.get("/wellness-service/wellness/dailyStress/#{format_date(date)}")
+      end
+
+      # Get body battery daily report.
+      # @param start_date [Date, String]
+      # @param end_date [Date, String]
+      def body_battery(start_date = today, end_date = start_date)
+        connection.get(
+          "/wellness-service/wellness/bodyBattery/reports/daily",
+          params: {
+            "startDate" => format_date(start_date),
+            "endDate" => format_date(end_date)
+          }
+        )
+      end
+
+      # Get body battery events (sleep, activities, naps).
+      # @param date [Date, String]
+      def body_battery_events(date = today)
+        connection.get("/wellness-service/wellness/bodyBattery/events/#{format_date(date)}")
+      end
+
+      # Get steps chart data for a day.
+      # @param date [Date, String]
+      def steps_data(date = today)
+        connection.get(
+          "/wellness-service/wellness/dailySummaryChart/#{display_name}",
+          params: { "date" => format_date(date) }
+        )
+      end
+
+      # Get floors climbed data for a day.
+      # @param date [Date, String]
+      def floors(date = today)
+        connection.get("/wellness-service/wellness/floorsChartData/daily/#{format_date(date)}")
+      end
+
+      # Get daily respiration data.
+      # @param date [Date, String]
+      def respiration(date = today)
+        connection.get("/wellness-service/wellness/daily/respiration/#{format_date(date)}")
+      end
+
+      # Get daily SpO2 (blood oxygen) data.
+      # @param date [Date, String]
+      def spo2(date = today)
+        connection.get("/wellness-service/wellness/daily/spo2/#{format_date(date)}")
+      end
+
+      # Get daily intensity minutes.
+      # @param date [Date, String]
+      def intensity_minutes(date = today)
+        connection.get("/wellness-service/wellness/daily/im/#{format_date(date)}")
+      end
+
+      # Get all-day events (auto-detected activities, etc.).
+      # @param date [Date, String]
+      def daily_events(date = today)
+        connection.get(
+          "/wellness-service/wellness/dailyEvents",
+          params: { "calendarDate" => format_date(date) }
+        )
+      end
+
+      # Request reload of offloaded data for a date.
+      # @param date [Date, String]
+      def request_reload(date = today)
+        connection.post("/wellness-service/wellness/epoch/request/#{format_date(date)}")
+      end
+    end
+  end
+end

data/lib/garmin_connect/api/metrics.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+module GarminConnect
+  module API
+    # Advanced health metrics, scores, and biometric endpoints.
+    module Metrics
+      # Get VO2 Max data.
+      # @param date [Date, String]
+      def max_metrics(date = today)
+        d = format_date(date)
+        connection.get("/metrics-service/metrics/maxmet/daily/#{d}/#{d}")
+      end
+
+      # Get training readiness score.
+      # @param date [Date, String]
+      def training_readiness(date = today)
+        connection.get("/metrics-service/metrics/trainingreadiness/#{format_date(date)}")
+      end
+
+      # Get morning-only training readiness (filters training_readiness result).
+      # @param date [Date, String]
+      def morning_training_readiness(date = today)
+        data = training_readiness(date)
+        return data unless data.is_a?(Array)
+
+        data.select { |entry| entry["calendarDate"] == format_date(date) }
+      end
+
+      # Get aggregated training status.
+      # @param date [Date, String]
+      def training_status(date = today)
+        connection.get("/metrics-service/metrics/trainingstatus/aggregated/#{format_date(date)}")
+      end
+
+      # Get endurance score.
+      # @param date [Date, String] single day, OR
+      # @param start_date [Date, String, nil] range start
+      # @param end_date [Date, String, nil] range end
+      # @param aggregation [String] "weekly" or "daily"
+      def endurance_score(date = nil, start_date: nil, end_date: nil, aggregation: "weekly")
+        if start_date && end_date
+          connection.get(
+            "/metrics-service/metrics/endurancescore/stats",
+            params: {
+              "startDate" => format_date(start_date),
+              "endDate" => format_date(end_date),
+              "aggregation" => aggregation
+            }
+          )
+        else
+          connection.get(
+            "/metrics-service/metrics/endurancescore",
+            params: { "calendarDate" => format_date(date || today) }
+          )
+        end
+      end
+
+      # Get hill score.
+      # @param date [Date, String] single day, OR
+      # @param start_date [Date, String, nil] range start
+      # @param end_date [Date, String, nil] range end
+      # @param aggregation [String] "daily" or "weekly"
+      def hill_score(date = nil, start_date: nil, end_date: nil, aggregation: "daily")
+        if start_date && end_date
+          connection.get(
+            "/metrics-service/metrics/hillscore/stats",
+            params: {
+              "startDate" => format_date(start_date),
+              "endDate" => format_date(end_date),
+              "aggregation" => aggregation
+            }
+          )
+        else
+          connection.get(
+            "/metrics-service/metrics/hillscore",
+            params: { "calendarDate" => format_date(date || today) }
+          )
+        end
+      end
+
+      # Get race predictions (5k, 10k, half, full marathon).
+      # @param type [String, nil] nil for latest, or "daily"/"monthly" for range
+      # @param start_date [Date, String, nil]
+      # @param end_date [Date, String, nil]
+      def race_predictions(type: nil, start_date: nil, end_date: nil)
+        if type && start_date && end_date
+          connection.get(
+            "/metrics-service/metrics/racepredictions/#{type}/#{display_name}",
+            params: {
+              "fromCalendarDate" => format_date(start_date),
+              "toCalendarDate" => format_date(end_date)
+            }
+          )
+        else
+          connection.get("/metrics-service/metrics/racepredictions/latest/#{display_name}")
+        end
+      end
+
+      # Get fitness age.
+      # @param date [Date, String]
+      def fitness_age(date = today)
+        connection.get("/fitnessage-service/fitnessage/#{format_date(date)}")
+      end
+
+      # --- Biometrics ---
+
+      # Get latest lactate threshold data.
+      def lactate_threshold
+        connection.get("/biometric-service/biometric/latestLactateThreshold")
+      end
+
+      # Get lactate threshold history over a date range.
+      # @param start_date [Date, String]
+      # @param end_date [Date, String]
+      # @param aggregation [String] "daily", "weekly", "monthly", or "yearly"
+      def lactate_threshold_history(start_date, end_date, aggregation: "daily")
+        params = {
+          "sport" => "RUNNING",
+          "aggregation" => aggregation,
+          "aggregationStrategy" => "LATEST"
+        }
+
+        {
+          "speed" => connection.get(
+            "/biometric-service/stats/lactateThresholdSpeed/range/#{format_date(start_date)}/#{format_date(end_date)}",
+            params: params
+          ),
+          "heart_rate" => connection.get(
+            "/biometric-service/stats/lactateThresholdHeartRate/range/#{format_date(start_date)}/#{format_date(end_date)}",
+            params: params
+          ),
+          "power" => connection.get(
+            "/biometric-service/stats/functionalThresholdPower/range/#{format_date(start_date)}/#{format_date(end_date)}",
+            params: params
+          )
+        }
+      end
+
+      # Get latest cycling FTP (Functional Threshold Power).
+      def cycling_ftp
+        connection.get("/biometric-service/biometric/latestFunctionalThresholdPower/CYCLING")
+      end
+
+      # --- Historical / Trends ---
+
+      # Get daily steps over a date range (auto-chunks at 28 days).
+      # @param start_date [Date, String]
+      # @param end_date [Date, String]
+      def daily_steps(start_date, end_date)
+        chunked_request(start_date, end_date, 28) do |chunk_start, chunk_end|
+          connection.get("/usersummary-service/stats/steps/daily/#{format_date(chunk_start)}/#{format_date(chunk_end)}")
+        end
+      end
+
+      # Get weekly steps.
+      # @param end_date [Date, String]
+      # @param weeks [Integer]
+      def weekly_steps(end_date = today, weeks: 52)
+        connection.get("/usersummary-service/stats/steps/weekly/#{format_date(end_date)}/#{weeks}")
+      end
+
+      # Get weekly stress.
+      # @param end_date [Date, String]
+      # @param weeks [Integer]
+      def weekly_stress(end_date = today, weeks: 52)
+        connection.get("/usersummary-service/stats/stress/weekly/#{format_date(end_date)}/#{weeks}")
+      end
+
+      # Get weekly intensity minutes.
+      # @param start_date [Date, String]
+      # @param end_date [Date, String]
+      def weekly_intensity_minutes(start_date, end_date = today)
+        connection.get("/usersummary-service/stats/im/weekly/#{format_date(start_date)}/#{format_date(end_date)}")
+      end
+    end
+  end
+end

data/lib/garmin_connect/api/user.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module GarminConnect
+  module API
+    # User profile and settings endpoints.
+    module User
+      # Get the current user's profile settings (measurement system, sleep, etc.).
+      def user_settings
+        connection.get("/userprofile-service/userprofile/user-settings")
+      end
+
+      # Get the current user's profile configuration.
+      def user_profile
+        connection.get("/userprofile-service/userprofile/settings")
+      end
+
+      # Get personal information for a display name.
+      # @param display_name [String] defaults to the logged-in user
+      def personal_information(display_name = self.display_name)
+        connection.get("/userprofile-service/userprofile/personal-information/#{display_name}")
+      end
+
+      # Get the full name of the logged-in user.
+      def full_name
+        @full_name
+      end
+
+      # Get the display name of the logged-in user.
+      def display_name
+        @display_name
+      end
+
+      # Get the measurement system (statute_us, metric, etc.).
+      def unit_system
+        @unit_system
+      end
+    end
+  end
+end

data/lib/garmin_connect/api/wellness.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module GarminConnect
+  module API
+    # Menstrual cycle, pregnancy, lifestyle logging, and GraphQL endpoints.
+    module Wellness
+      # Get menstrual cycle data for a specific date.
+      # @param date [Date, String]
+      def menstrual_data(date = today)
+        connection.get("/periodichealth-service/menstrualcycle/dayview/#{format_date(date)}")
+      end
+
+      # Get menstrual cycle calendar for a date range.
+      # @param start_date [Date, String]
+      # @param end_date [Date, String]
+      def menstrual_calendar(start_date, end_date)
+        connection.get(
+          "/periodichealth-service/menstrualcycle/calendar/#{format_date(start_date)}/#{format_date(end_date)}"
+        )
+      end
+
+      # Get pregnancy summary snapshot.
+      def pregnancy_summary
+        connection.get("/periodichealth-service/menstrualcycle/pregnancysnapshot")
+      end
+
+      # Get daily lifestyle logging data.
+      # @param date [Date, String]
+      def lifestyle_logging(date = today)
+        connection.get("/lifestylelogging-service/dailyLog/#{format_date(date)}")
+      end
+
+      # Execute a GraphQL query against Garmin's gateway.
+      # @param query [String] the GraphQL query string
+      # @param variables [Hash] query variables
+      # @param operation_name [String, nil]
+      def graphql(query, variables: {}, operation_name: nil)
+        body = { "query" => query, "variables" => variables }
+        body["operationName"] = operation_name if operation_name
+
+        connection.post("/graphql-gateway/graphql", body: body)
+      end
+    end
+  end
+end