ruby_garmin_connect 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '08c6d390104bc4f19e46f95d0726171890e2c0f3c41e165b1afca94031c0f243'
-  data.tar.gz: 8225469c95d81af76180c1e6e1c4229f3caaa27cef9eb675e1c514ec208b1145
+  metadata.gz: 9e992aa41910f85ae0a2f2b656e09d28c529a82c44a0118a09a53765826d49ce
+  data.tar.gz: ee0d8526867d3f7d85c2742cfaa3ad36a73102d43be6eba2149b687719365885
 SHA512:
-  metadata.gz: e3f740b9dda27508940450bacfe50f7ad74e060f2c9f97100500fcb1b200424cfb425efd0a187d61f5d55e03af04e3ada0b2029284a6542adbefb70f971c0ede
-  data.tar.gz: 2609e8c7e033db637fa8358c409cda7d5d31c8018b6d43a7506a309140febaa90c7ce271a79600cdeea40b0a5f278304f7511ccb045cfe6b7b2ac706ada4e6e1
+  metadata.gz: d20db74f11c8102571dd3c08a3ffeec7e095075de9562035adbb7255d7d75a134d879e075010897557e143a2f28ab6392da82ecbedd2e86ffbebced25ae3e0ca
+  data.tar.gz: 8baf66019a7832c3d1579c9b164f01beef5a3271b91357120572b345cf7da0b71f331b7f295533bfcb8342b641794d6dc6cc63ae4ece8159d8efe9814a34c4b9

data/CHANGELOG.md

@@ -1,5 +1,41 @@
 # Changelog
 
+## 0.2.1 (2026-02-11)
+
+### Fixed
+
+- `training_readiness` raising `TypeError: no implicit conversion of String into Integer` when Garmin returns a response with a UTF-8 BOM or unparseable JSON body
+- `display_name` and `full_name` returning `nil` on login when the profile endpoint nests data under `socialProfile` or uses `userName` instead of `displayName`
+
+### Added
+
+- `ParseError` exception class — raised when a response claims `application/json` content-type but the body can't be parsed (instead of silently returning a raw string)
+- UTF-8 BOM stripping in response parsing
+- Fallback profile extraction: tries `displayName` → `socialProfile.displayName` → `userName`
+
+### Improved
+
+- Test coverage increased to 205 examples (up from 199)
+
+## 0.2.0 (2026-02-11)
+
+### Added
+
+- `add_body_composition` - upload body scale data (body fat %, muscle mass, etc.) as a FIT file
+- `add_weigh_in_with_timestamps` - add a weigh-in with explicit local and GMT timestamps
+- `delete_weigh_ins` - batch delete all weigh-ins for a given date
+- Typed workout creation helpers:
+  - `create_running_workout`
+  - `create_cycling_workout`
+  - `create_swimming_workout`
+  - `create_walking_workout`
+  - `create_hiking_workout`
+
+### Improved
+
+- Comprehensive test coverage for all 9 API modules (199 examples, up from 48)
+  - User, Health, Activities, Body Composition, Metrics, Devices, Badges, Workouts, Wellness
+
 ## 0.1.0 (2026-02-11)
 
 - Initial release

data/README.md

@@ -24,10 +24,12 @@ gem install garmin_connect
 require "garmin_connect"
 
 # Login with credentials (tokens are saved to ~/.garminconnect automatically)
-client = GarminConnect.login(email: "you@example.com", password: "your-password")
+client = GarminConnect::Client.new(email: "you@example.com", password: "your-password")
+client.login
 
 # Subsequent sessions resume from saved tokens (no re-login for ~1 year)
-client = GarminConnect.login
+client = GarminConnect::Client.new
+client.login
 
 # Get today's stats
 puts client.daily_summary

data/lib/garmin_connect/api/body_composition.rb

@@ -54,6 +54,31 @@ module GarminConnect
         )
       end
 
+      # Add a weigh-in with explicit timestamps.
+      # @param value [Float] weight value
+      # @param date_timestamp [String] local timestamp (e.g., "2026-02-11T08:30:00.000")
+      # @param gmt_timestamp [String] GMT timestamp (e.g., "2026-02-11T14:30:00.000")
+      # @param unit_key [String] "kg" or "lbs"
+      def add_weigh_in_with_timestamps(value, date_timestamp:, gmt_timestamp:, unit_key: "kg")
+        connection.post(
+          "/weight-service/user-weight",
+          body: {
+            "dateTimestamp" => date_timestamp,
+            "gmtTimestamp" => gmt_timestamp,
+            "unitKey" => unit_key,
+            "sourceType" => "MANUAL",
+            "value" => value
+          }
+        )
+      end
+
+      # Upload body composition data as a FIT file.
+      # This is used for full body scale data (body fat %, muscle mass, bone mass, etc.).
+      # @param file_path [String] path to the FIT file containing body composition data
+      def add_body_composition(file_path)
+        connection.upload("/upload-service/upload", file_path: file_path)
+      end
+
       # Delete a specific weigh-in.
       # @param date [Date, String]
       # @param weight_pk [String, Integer] the weigh-in version/pk
@@ -61,6 +86,18 @@ module GarminConnect
         connection.delete("/weight-service/weight/#{format_date(date)}/byversion/#{weight_pk}")
       end
 
+      # Delete all weigh-ins for a specific date.
+      # Fetches all weigh-ins for the day, then deletes each one.
+      # @param date [Date, String]
+      def delete_weigh_ins(date)
+        day_data = daily_weigh_ins(date)
+        entries = day_data&.dig("dateWeightList") || []
+        entries.each do |entry|
+          weight_pk = entry["version"] || entry["samplePk"]
+          delete_weigh_in(date, weight_pk) if weight_pk
+        end
+      end
+
       # --- Hydration ---
 
       # Get daily hydration data.

data/lib/garmin_connect/api/metrics.rb

@@ -23,7 +23,7 @@ module GarminConnect
         data = training_readiness(date)
         return data unless data.is_a?(Array)
 
-        data.select { |entry| entry["calendarDate"] == format_date(date) }
+        data.select { |entry| entry.is_a?(Hash) && entry["calendarDate"] == format_date(date) }
       end
 
       # Get aggregated training status.

data/lib/garmin_connect/api/workouts.rb

@@ -39,6 +39,48 @@ module GarminConnect
         connection.get("/workout-service/schedule/#{scheduled_workout_id}")
       end
 
+      # --- Typed Workout Helpers ---
+
+      # Create a running workout.
+      # @param name [String] workout name
+      # @param steps [Array<Hash>] workout step definitions
+      # @param description [String, nil] optional description
+      def create_running_workout(name, steps: [], description: nil)
+        create_typed_workout(name, sport_type: running_sport_type, steps: steps, description: description)
+      end
+
+      # Create a cycling workout.
+      # @param name [String] workout name
+      # @param steps [Array<Hash>] workout step definitions
+      # @param description [String, nil] optional description
+      def create_cycling_workout(name, steps: [], description: nil)
+        create_typed_workout(name, sport_type: cycling_sport_type, steps: steps, description: description)
+      end
+
+      # Create a swimming workout.
+      # @param name [String] workout name
+      # @param steps [Array<Hash>] workout step definitions
+      # @param description [String, nil] optional description
+      def create_swimming_workout(name, steps: [], description: nil)
+        create_typed_workout(name, sport_type: swimming_sport_type, steps: steps, description: description)
+      end
+
+      # Create a walking workout.
+      # @param name [String] workout name
+      # @param steps [Array<Hash>] workout step definitions
+      # @param description [String, nil] optional description
+      def create_walking_workout(name, steps: [], description: nil)
+        create_typed_workout(name, sport_type: walking_sport_type, steps: steps, description: description)
+      end
+
+      # Create a hiking workout.
+      # @param name [String] workout name
+      # @param steps [Array<Hash>] workout step definitions
+      # @param description [String, nil] optional description
+      def create_hiking_workout(name, steps: [], description: nil)
+        create_typed_workout(name, sport_type: hiking_sport_type, steps: steps, description: description)
+      end
+
       # --- Training Plans ---
 
       # Get all available training plans.
@@ -57,6 +99,45 @@ module GarminConnect
       def adaptive_training_plan(plan_id)
         connection.get("/trainingplan-service/trainingplan/fbt-adaptive/#{plan_id}")
       end
+
+      private
+
+      def create_typed_workout(name, sport_type:, steps: [], description: nil)
+        payload = {
+          "workoutName" => name,
+          "sportType" => sport_type,
+          "workoutSegments" => [
+            {
+              "segmentOrder" => 1,
+              "sportType" => sport_type,
+              "workoutSteps" => steps
+            }
+          ]
+        }
+        payload["description"] = description if description
+
+        create_workout(payload)
+      end
+
+      def running_sport_type
+        { "sportTypeId" => 1, "sportTypeKey" => "running" }
+      end
+
+      def cycling_sport_type
+        { "sportTypeId" => 2, "sportTypeKey" => "cycling" }
+      end
+
+      def swimming_sport_type
+        { "sportTypeId" => 5, "sportTypeKey" => "swimming" }
+      end
+
+      def walking_sport_type
+        { "sportTypeId" => 9, "sportTypeKey" => "walking" }
+      end
+
+      def hiking_sport_type
+        { "sportTypeId" => 3, "sportTypeKey" => "hiking" }
+      end
     end
   end
 end

data/lib/garmin_connect/client.rb

@@ -162,13 +162,32 @@ module GarminConnect
       @unit_system = settings&.dig("userData", "measurementSystem")
 
       profile = connection.get("/userprofile-service/userprofile/profile")
-      @display_name = profile&.dig("displayName")
-      @full_name = profile&.dig("fullName")
-      @user_profile_pk = profile&.dig("profileId") || settings&.dig("id")
+      extract_profile_info(profile)
+
+      @user_profile_pk = extract_profile_pk(profile, settings)
     rescue HTTPError
       # Non-fatal: display_name may not be available
     end
 
+    def extract_profile_info(profile)
+      return unless profile.is_a?(Hash)
+
+      @display_name = profile.dig("displayName") ||
+                      profile.dig("socialProfile", "displayName") ||
+                      profile.dig("userName")
+
+      @full_name = profile.dig("fullName") ||
+                   profile.dig("socialProfile", "fullName")
+    end
+
+    def extract_profile_pk(profile, settings)
+      return nil unless profile.is_a?(Hash) || settings.is_a?(Hash)
+
+      profile&.dig("profileId") ||
+        profile&.dig("socialProfile", "profileId") ||
+        settings&.dig("id")
+    end
+
     # Exposed for API modules that need it.
     def user_profile_pk
       @user_profile_pk

data/lib/garmin_connect/connection.rb

@@ -124,11 +124,23 @@ module GarminConnect
 
     def parse_response(resp)
       return nil if resp.status == 204
-      return resp.body if resp.body.nil? || resp.body.empty?
 
-      JSON.parse(resp.body)
+      body = resp.body
+      return body if body.nil? || body.empty?
+
+      # Strip UTF-8 BOM if present (some Garmin endpoints include it)
+      body = body.b.sub(/\A\xEF\xBB\xBF/n, "").force_encoding("UTF-8")
+
+      JSON.parse(body)
     rescue JSON::ParserError
-      resp.body
+      content_type = resp.headers["content-type"].to_s
+      # If the server said it was JSON but we can't parse it, raise rather than
+      # returning a raw string that callers will misuse.
+      if content_type.include?("application/json")
+        raise ParseError, "Failed to parse JSON response: #{body[0..200]}"
+      end
+
+      body
     end
 
     def handle_errors!(resp)

data/lib/garmin_connect/errors.rb

@@ -35,6 +35,9 @@ module GarminConnect
   class TooManyRequestsError < HTTPError; end
   class ServerError < HTTPError; end
 
+  # Response parsing errors
+  class ParseError < Error; end
+
   # Maps HTTP status codes to error classes
   HTTP_ERRORS = {
     400 => BadRequestError,

data/lib/garmin_connect/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GarminConnect
-  VERSION = "0.1.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_garmin_connect
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors:
 - DRBragg