dexcom_share_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 40943264dd61ec2ce957a1617899581d73f2a66f2d088a601aae0a0dd1180b52
+  data.tar.gz: aa10acce28d4aab248794f10f686b1e70ea6c1d852b941c370fb50d36302bd08
+SHA512:
+  metadata.gz: 02ecbe4de4148b9bbd39706f861fa17847bb35c7ca3c3fc2e2ef35834dd97701c59f4683b343ec14466e4536fddac8472bce05c1f0435b461ca3dfb6d4644daa
+  data.tar.gz: b9c8f474f03ea7c342da6193475567ebbbd81d5e2928743bf148c1c4104ee9db84b0c941e1b2bc694d2774b8be6adc4b58908da8a7f0afcb0c868f6dfef092a9

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dexcom_share_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    dexcom_share_api (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.6)
+      public_suffix (>= 2.0.2, < 6.0)
+    bigdecimal (3.1.6)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    hashdiff (1.1.0)
+    method_source (1.0.0)
+    minitest (5.22.2)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    public_suffix (5.0.4)
+    rake (10.5.0)
+    rexml (3.2.6)
+    vcr (6.2.0)
+    webmock (3.23.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-23
+
+DEPENDENCIES
+  bundler
+  dexcom_share_api!
+  minitest (~> 5.0)
+  pry-byebug
+  rake (~> 10.0)
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.4.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Elliot Dohm
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,52 @@
+TLDR; This is a tiny gem to interact with the Dexcom Share API. The API is
+(unfortunately) private, so _any_ implementation can't really have stability
+guarantees. However, it hasn't changed for the past few years so it should be
+fairly stable. Feel free to report any bugs and I'll fix them!
+
+## Usage
+```ruby
+require "dexcom_share_api"
+
+# Create a client with your username and password from Dexcom Share.
+# If you get authentication issues, try to confirm your username/password by
+# logging into Dexcom Share directly.
+client = DexcomShareApi.create_client(
+  username: "Dexcom share username",
+  password: "Dexcom share password",
+  # If your account is registered in the US, otherwise `outside-us`.
+  server: "us",
+)
+
+# Defaults to outputting the last 10 entries
+# Optionally can pass in the _last_ parameter.
+# ```
+#   client.estimated_glucose(last: 5)
+# ```
+glucose = client.estimated_glucose
+glucose.each do |entry|
+  puts entry.mmol # => 5.39
+  puts entry.mgdl # => 151.0
+  puts entry.trend # => "flat"
+  # Timestamp is an iso8601
+  puts entry.timestamp # => "2024-03-06T04:14:53+00:00"
+end
+
+# Alternatively, to grab the last entry:
+glucose = client.last_estimated_glucose
+puts glucose.to_h # => {:trend=>"flat", :timestamp=>"2024-03-06T04:14:53+00:00", :mmol=>8.39, :mgdl=>151.0}
+```
+
+## History
+I originally made this library in
+[JavaScript](https://github.com/aud/dexcom-share-api) many years ago to enable
+some watch-face development. Recently I had a use-case where I wanted to store
+a bunch of Dexcom data in a database for some offline analysis, and decided I'd
+port it to Ruby to make that process more enjoyable.
+
+## Development
+
+To test:
+* `bin/test`
+
+To build:
+* `gem build && gem install dexcom_share_api`

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "dexcom_share_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/test

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+set -x
+bundle exec rake test TEST="test/dexcom_share_api_test.rb"

data/dexcom_share_api.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dexcom_share_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dexcom_share_api"
+  spec.version       = DexcomShareApi::VERSION
+  spec.authors       = ["Elliot Dohm"]
+  spec.email         = ["elliotdohm+rubygems@gmail.com"]
+
+  spec.summary       = "Tiny API layer for interacting with Dexcom Share API"
+  spec.description   = "Tiny API layer for interacting with Dexcom Share API"
+  spec.homepage      = "https://github.com/aud/dexcom_share_ruby"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/dexcom_share_api/client.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "dexcom_share_api/http_api"
+require "dexcom_share_api/glucose"
+
+module DexcomShareApi
+  class Client
+    attr_reader(:dexcom_api)
+
+    def initialize(username:, password:, server:)
+      @dexcom_api ||= HttpApi.new(username:, password:, server:)
+    end
+
+    def estimated_glucose(last: 10)
+      result = dexcom_api.fetch_estimated_glucose!(last:)
+
+      result
+        .map { |entry| Glucose.new(entry) }
+        .reverse
+    end
+
+    def last_estimated_glucose
+      result = dexcom_api.fetch_estimated_glucose!(last: 1)
+
+      Glucose.new(result[0])
+    end
+  end
+end

data/lib/dexcom_share_api/glucose.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "date"
+
+module DexcomShareApi
+  class Glucose
+    # {
+    #   "WT"=>"Date(1709620791000)",
+    #   "ST"=>"Date(1709620791000)",
+    #   "DT"=>"Date(1709620791000-0500)",
+    #   "Value"=>164,
+    #   "Trend"=>"Flat",
+    # }
+    def initialize(raw_glucose_data)
+      @raw_glucose_data = raw_glucose_data
+    end
+
+    def to_h
+      {
+        trend:,
+        timestamp:,
+        mmol:,
+        mgdl:,
+      }
+    end
+
+    def inspect
+      out = "#<#{self.class}:#{object_id}"
+      to_h.each do |key, value|
+        out << " @#{key}=#{value}"
+      end
+      out << ">"
+      out
+    end
+
+    def trend
+      @raw_glucose_data["Trend"].split(/(?=[A-Z])/).join("-").downcase
+    end
+
+    # This is parsing out an epoch time from "Date(1709620791000)". It's messy.
+    def timestamp
+      raw_timestamp = @raw_glucose_data["ST"].match(/\d+/)[0]
+      DateTime.strptime(raw_timestamp, '%Q').iso8601
+    end
+
+    def mmol
+      mgdl_to_mmol(mgdl)
+    end
+
+    def mgdl
+      @raw_glucose_data["Value"].to_f
+    end
+
+    private
+
+    # http://www.bcchildrens.ca/endocrinology-diabetes-site/documents/glucoseunits.pdf
+    # [BG (mmol/L) * 18] = BG (mg/dL)
+    #
+    # Return the normalized mmol/L
+    def mgdl_to_mmol(mgdl)
+      (mgdl.to_f / 18).round(2)
+    end
+  end
+end

data/lib/dexcom_share_api/http_api.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+require "dexcom_share_api/glucose"
+
+module DexcomShareApi
+  class HttpApi
+    InvalidServerError = Class.new(ArgumentError)
+    ApiError = Class.new(StandardError)
+
+    # This server needs to be either "us" or "eu. If you're in the US, the server
+    # should be "us". Any other country outside of the US (eg. Canada) is
+    # classified as "eu" by Dexcom.
+    VALID_SERVERS = ["us", "outside-us"]
+
+    # This seems to be a blessed ID the Dexcom Share app uses. This is in no way
+    # special to this library, is it used in several (nightscout, dexcomedy,
+    # etc).
+    APPLICATION_ID = "d8665ade-9673-4e27-9ff6-92db4ce13d13"
+
+    def initialize(username:, password:, server:)
+      validate_server!(server)
+
+      @username = username
+      @password = password
+      @server = server
+    end
+
+    def fetch_estimated_glucose!(last:, minutes: 24 * 60)
+      session_id = fetch_session_id!
+
+      uri = URI::HTTPS.build(
+        host: base_host,
+        path: "/ShareWebServices/Services/Publisher/ReadPublisherLatestGlucoseValues",
+      )
+
+      data = {
+        maxCount: last,
+        sessionId: session_id,
+        minutes: minutes,
+      }
+
+      dexcom_request!(uri, data)
+    end
+
+    def fetch_session_id!
+      account_id = fetch_account_id!
+
+      uri = URI::HTTPS.build(
+        host: base_host,
+        path: "/ShareWebServices/Services/General/LoginPublisherAccountById",
+      )
+
+      data = {
+        applicationId: APPLICATION_ID,
+        accountId: account_id,
+        password: @password,
+      }
+
+      dexcom_request!(uri, data)
+    end
+
+    def fetch_account_id!
+      uri = URI::HTTPS.build(
+        host: base_host,
+        path: "/ShareWebServices/Services/General/AuthenticatePublisherAccount",
+      )
+
+      data = {
+        applicationId: APPLICATION_ID,
+        accountName: @username,
+        password: @password,
+      }
+
+      dexcom_request!(uri, data)
+    end
+
+    private
+
+    def dexcom_request!(uri, data)
+      request = Net::HTTP::Post.new(
+        uri.request_uri,
+        {
+          "Content-Type" => "application/json",
+        }
+      )
+
+      request.body = data.to_json
+
+      response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+        http.request(request)
+      end
+
+      body = JSON.parse(response.body)
+
+      if response.code.to_i != 200
+        err_msg = <<~MSG
+          Error! Dexcom request to "#{uri}" failed.
+
+          Response code: #{response.code}
+          Raw request body:
+            `Code=#{body["Code"]}`
+            `Message=#{body["Message"]}`
+        MSG
+
+        raise(ApiError, err_msg)
+      end
+
+      body
+    rescue ApiError => err
+      raise
+    rescue => err
+      raise(ApiError, err)
+    end
+
+    def base_host
+      case @server
+      when "us"
+        "share2.dexcom.com"
+      when "outside-us"
+        "shareous1.dexcom.com"
+      end
+    end
+
+    def validate_server!(server)
+      return if VALID_SERVERS.include?(server)
+
+      err_msg = <<~MSG
+        Server must either be `us` or `outside-us`.
+
+        If you're in the US, the server should be "us". Any other country
+        outside of the US (eg. Canada) should be "outside-us".
+      MSG
+
+      raise(InvalidServerError, err_msg)
+    end
+  end
+end

data/lib/dexcom_share_api/version.rb

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

data/lib/dexcom_share_api.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "dexcom_share_api/version"
+require "dexcom_share_api/client"
+
+module DexcomShareApi
+  def self.create_client(...)
+    DexcomShareApi::Client.new(...)
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: dexcom_share_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Elliot Dohm
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Tiny API layer for interacting with Dexcom Share API
+email:
+- elliotdohm+rubygems@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/test
+- dexcom_share_api.gemspec
+- lib/dexcom_share_api.rb
+- lib/dexcom_share_api/client.rb
+- lib/dexcom_share_api/glucose.rb
+- lib/dexcom_share_api/http_api.rb
+- lib/dexcom_share_api/version.rb
+homepage: https://github.com/aud/dexcom_share_ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Tiny API layer for interacting with Dexcom Share API
+test_files: []