hello-sense 0.1.0

data/lib/hello_sense/client.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+
+module Sense
+  class Client
+    API_HOST = 'https://api.hello.is'.freeze
+
+    include Account
+    include Alarms
+    include Alerts
+    include App
+    include Devices
+    include Expansions
+    include Firmware
+    include Insights
+    include Notifications
+    include Questions
+    include Sensors
+    include Session
+    include Sharing
+    include SleepSounds
+    include Speech
+    include Stats
+    include Store
+    include Support
+    include Timeline
+    include Trends
+
+    attr_reader :access_token
+
+    # XXX
+    #
+    # @param options [Hash]
+    # @option options [String] :access_token
+    # @option options [String] :client_id
+    # @option options [String] :client_secret
+    # @option options [String] :password
+    # @option options [String] :username
+    def initialize(options = {})
+      @access_token = options[:access_token]
+      @client_id = options[:client_id]
+      @client_secret = options[:client_secret]
+      @password = options[:password]
+      @username = options[:username]
+
+      @access_token = authorize_with_password! if @access_token.nil?
+      puts "** Using #{@access_token} as Sense access token"
+    end
+
+    # XXX
+    #
+    # @param path [String] relative path to use for the request
+    def delete(path)
+      response = connection.delete(path, headers)
+      data_or_error(response)
+    end
+
+    # XXX
+    #
+    # @param path [String] relative path to use for the request
+    def get(path)
+      response = connection.get(path, headers)
+      data_or_error(response)
+    end
+
+    # XXX
+    #
+    # @param path [String] relative path to use for the request
+    # @param data [Hash] data to send
+    def patch(path, data)
+      # XXX may need +set_form_data+
+      response = connection.patch(path, data, headers)
+      data_or_error(response)
+    end
+
+    # XXX
+    #
+    # @param path [String] relative path to use for the request
+    # @param data [Hash] data to send
+    def post(path, data)
+      request = Net::HTTP::Post.new(path, headers)
+      request.set_form_data(data)
+      response = connection.request(request)
+      data_or_error(response)
+    end
+
+    # @param path [String] relative path to use for the request
+    # @param data [Hash] data to send
+    def put(path, data)
+      request = Net::HTTP::Put.new(path, headers)
+      request.set_form_data(data)
+      response = connection.request(request)
+      data_or_error(response)
+    end
+
+    private
+
+    # XXX
+    #
+    # @return [Net::HTTP]
+    def connection
+      @connection ||= begin
+        require 'openssl'
+        require 'uri'
+
+        uri = URI.parse(API_HOST)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.ssl_version = :TLSv1_2
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+
+        http
+      end
+    end
+
+    # XXX
+    #
+    # @param response [Net::HTTPResponse]
+    # @return [Array, Hash, nil]
+    # @raise [APIError]
+    def data_or_error(response)
+      if response.code.to_i < 300
+        return response.body ? JSON.parse(response.body) : nil
+      end
+
+      raise APIError.new(response)
+    end
+
+    # XXX
+    #
+    # @return [Hash]
+    def headers
+      {
+        Accept: 'application/json',
+        Authorization: "Bearer #{@access_token}",
+        :'User-Agent' => "hello-sense Ruby gem/#{VERSION}",
+      }.freeze
+    end
+  end
+end

data/lib/hello_sense/constants.rb

@@ -0,0 +1,4 @@
+module Sense
+  class InvalidEmailError < StandardError; end
+  class InvalidPasswordError < StandardError; end
+end

data/lib/hello_sense/devices.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Sense
+  module Devices
+    # @return [Hash]
+    #
+    # @example
+    #   {
+    #     "senses" => [{
+    #       "id" => "ABCDEF1234567890",
+    #       "firmware_version" => "11a1",
+    #       "state" => "NORMAL",
+    #       "last_updated" => 1483257600000,
+    #       "color" => "UNKNOWN",
+    #       "wifi_info" => {
+    #         "ssid" => "Wifi? Why not!",
+    #         "rssi" => 0,
+    #         "last_updated" => 1420099200000,
+    #         "condition" => "GOOD"
+    #       },
+    #       "hw_version" => "SENSE"
+    #     }],
+    #     "pills" => [{
+    #       "id" => "0987654321FEDCBA",
+    #       "firmware_version" => "2",
+    #       "battery_level" => 0,
+    #       "last_updated" => 1483257600000,
+    #       "state" => "NORMAL",
+    #       "color" => "BLUE",
+    #       "battery_type" => "REMOVABLE"
+    #     }]
+    #   }
+
+    def devices
+      get('/v2/devices')
+    end
+
+    # @return [Hash]
+    #
+    # @example
+    #   {
+    #     "sense_id" => "ABCDEF1234567890",
+    #     "paired_accounts" => 1
+    #   }
+
+    def devices_info
+      get('/v2/devices/info')
+    end
+
+    def remove_device(device_id)
+      delete("/v2/devices/sense/#{device_id}/all")
+    end
+
+    def remove_pill(pill_id)
+      delete("/v2/devices/pill/#{pill_id}")
+    end
+
+    def remove_sense(pill_id)
+      delete("/v2/devices/sense/#{pill_id}")
+    end
+
+    def voice(device_id)
+      get("/v2/devices/sense/#{device_id}/voice")
+    end
+
+    def update_voice(device_id, data)
+      patch("/v2/devices/sense/#{device_id}/voice", data)
+    end
+
+    def swap_device(data)
+      put('/v2/devices/swap', data)
+    end
+  end
+end

data/lib/hello_sense/expansions.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Sense
+  module Expansions
+    # @return [Array<Hash>]
+    #
+    # @example
+    #   [
+    #     {
+    #       "id" => 1,
+    #       "service_name" => "NEST",
+    #       "device_name" => "Nest Thermostat",
+    #       "company_name" => "Nest",
+    #       "description" => "Connecting Sense to your Nest Learning Thermostat allows you to control your thermostat with Voice, or automatically set a specific temperature ahead of your Sense alarm, so you wake up to your ideal temperature every morning.",
+    #       "icon" => {
+    #         "phone_1x" => "https://hello-data.s3.amazonaws.com/expansions/icon-nest@1x.png",
+    #         "phone_2x" => "https://hello-data.s3.amazonaws.com/expansions/icon-nest@2x.png",
+    #         "phone_3x" => "https://hello-data.s3.amazonaws.com/expansions/icon-nest@3x.png"
+    #       },
+    #       "auth_uri" => "https://api.hello.is/v2/expansions/1/auth",
+    #       "token_uri" => nil,
+    #       "refresh_uri" => nil,
+    #       "category" => "TEMPERATURE",
+    #       "created" => 1495381368634,
+    #       "completion_uri" => "https://api.hello.is/v2/expansions/redirect",
+    #       "state" => "NOT_CONNECTED",
+    #       "value_range" => {
+    #         "min" => 9,
+    #         "max" => 32
+    #       }
+    #     }
+    #   ]
+    def expansions
+      get('/v2/expansions')
+    end
+
+    def expansion(expansion_id)
+      get("/v2/expansions/#{expansion_id}")
+    end
+
+    def update_expansion(expansion_id, data)
+      patch("/v2/expansions/#{expansion_id}", data)
+    end
+
+    def expansion_configurations(expansion_id)
+      get("/v2/expansions/#{expansion_id}/configurations")
+    end
+
+    def update_expansion_configurations(expansion_id, data)
+      patch("/v2/expansions/#{expansion_id}/configurations", data)
+    end
+  end
+end

data/lib/hello_sense/firmware.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Sense
+  module Firmware
+    def request_firmware_update
+      post('/v1/ota/request_ota')
+    end
+
+    # @return [Hash]
+    #
+    # @example
+    #   {
+    #     "status" => "NOT_REQUIRED"
+    #   }
+
+    def firmware_update_status
+      get('/v1/ota/status')
+    end
+  end
+end

data/lib/hello_sense/insights.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Sense
+  module Insights
+    # @return [Array<Hash>]
+    #
+    # @example
+    #   [
+    #     {
+    #       "account_id" => 100000,
+    #       "title" => "Still as the Night",
+    #       "message" => "During the last 13 nights, you moved 23% less than the average person using Sense. About **9% of your sleep** consists of agitated sleep.",
+    #       "category" => "SLEEP_QUALITY",
+    #       "timestamp" => 1483257600000,
+    #       "info_preview" => nil,
+    #       "image" => {
+    #         "phone_1x" => "https://s3.amazonaws.com/hello-data/insights_images/sleep_quality.png",
+    #         "phone_2x" => "https://s3.amazonaws.com/hello-data/insights_images/sleep_quality@2x.png",
+    #         "phone_3x" => "https://s3.amazonaws.com/hello-data/insights_images/sleep_quality@3x.png"
+    #       },
+    #       "category_name" => "Sleep Quality",
+    #       "insight_type" => "DEFAULT",
+    #       "id" => "fded667b-9e91-43f5-91de-258ac1fee9c2"
+    #     }
+    #   ]
+
+    def insights
+      get('/v2/insights')
+    end
+
+    # Known +category+s:
+    # * +AIR_QUALITY+
+    # * +BED_LIGHT_DURATION+
+    # * +HUMIDITY+
+    # * +LIGHT+
+    # * +SLEEP_QUALITY+
+    # * +SLEEP_TIME+
+    # * +TEMPERATURE+
+    # * +WAKE_VARIANCE+
+    #
+    # @param category [String]
+    # @return [Array<Hash>]
+    #
+    # @example
+    #  [{
+    #    "id" => 5,
+    #    "category" => "AIR_QUALITY",
+    #    "title" => "Clean air, better sleep",
+    #    "text" => "Clean air is an important part of a healthy environment. A high concentration of airborne particulates (microscopic fragments of matter that can penetrate deep into your lungs) can irritate your throat and airways, exacerbate asthma symptoms, and disrupt your sleep.\n\nParticulates can come from indoor sources of pollutants like smoke, cooking fumes, and even some household cleaners. You should always take care to minimize your exposure to these types of pollutants, and open a window to help with ventilation if necessary.\n\nParticulate pollution can also come from outdoor sources, both natural and artificial. You can check the AirNow website to see if there’s an air quality advisory for your area at any time. If so, you should follow EPA recommendations, and limit your time spent outdoors.",
+    #    "image_url" => ""
+    #  }]
+
+    def insight(category)
+      get("/v2/insights/info/#{category}")
+    end
+  end
+end

data/lib/hello_sense/notifications.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Sense
+  module Notifications
+    # @return [Array<Hash>]
+    #
+    # @example
+    #   [
+    #     {
+    #       "type" => "SLEEP_SCORE",
+    #       "enabled" => true,
+    #       "name" => Sleep Score"
+    #     }, {
+    #       "type" => "SYSTEM",
+    #       "enabled" => true,
+    #       "name" => System Alerts"
+    #     }, {
+    #       "type" => "SLEEP_REMINDER",
+    #       "enabled" => true,
+    #       "name" => Sleep Reminder"
+    #     }
+    #   ]
+
+    def notifications
+      get('/v1/notifications')
+    end
+
+    def create_notification(data)
+      put('/v1/notifications', data)
+    end
+
+    def update_notifications(data)
+      post('/v1/notifications/registration', data)
+    end
+  end
+end

data/lib/hello_sense/questions.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Sense
+  module Questions
+    # @return [Array<Hash>]
+    #
+    # @example
+    #   [
+    #     {
+    #       "id" => 2,
+    #       "account_question_id" => 100000,
+    #       "text" => "How was your sleep last night?",
+    #       "choices" => {
+    #         "id" => 69,
+    #         "text" => "Great",
+    #         "question_id" => 2
+    #       }, {
+    #         "id" => 70,
+    #         "text" => "Okay",
+    #         "question_id" => 2
+    #       }, {
+    #         "id" => 71,
+    #         "text" => "Poor",
+    #         "question_id" => 2
+    #       }],
+    #       "ask_local_date" => 1483257600000,
+    #       "type" => "CHOICE",
+    #       "ask_time" => "MORNING"
+    #     }
+    #   ]
+
+    def questions
+      get('/v1/questions')
+    end
+
+    def skip_question(data)
+      put('/v1/questions/skip', data)
+    end
+
+    def update_questions(data)
+      post('/v1/questions/save', data)
+    end
+  end
+end

data/lib/hello_sense/sensors.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Sense
+  module Sensors
+    # Historical sensor data, sampled every five minutes.
+    #
+    # @param hours [Fixnum] how many hours of data to fetch
+    # @return [Hash]
+    #
+    # @note Seems to top out at around 920 hours -- higher numbers result in
+    #   empty data; probably some timeout on the server cancels the lookup and
+    #   falls back to empty data.
+    # @note If +from_utc+ is more than about 11 hours in the past the server
+    #   will give a 400 Bad Request response. You can request far more than
+    #   11 +hours+, so +from_utc+ is always set to the current UTC timestamp.
+    #
+    # @example
+    #   {
+    #     "sound" => [
+    #       {
+    #         "datetime" => 1500001200000,
+    #         "value" => 31.155998,
+    #         "offset_millis" => -25200000
+    #       },
+    #       ...
+    #     ],
+    #     "humidity" => [
+    #       {
+    #         "datetime" => 1500001200000,
+    #         "value" => 42.710575,
+    #         "offset_millis" => -25200000
+    #       },
+    #       ...
+    #     ],
+    #     "light" => [
+    #       {
+    #         "datetime" => 1500001200000,
+    #         "value" => 302.38342,
+    #         "offset_millis" => -25200000
+    #       },
+    #       ...
+    #     ],
+    #     "temperature" => [
+    #       {
+    #         "datetime" => 1500001200000,
+    #         "value" => 16.91,
+    #         "offset_millis" => -25200000
+    #       },
+    #       ...
+    #     ],
+    #     "particulates" => [
+    #       {
+    #         "datetime" => 1500001200000,
+    #         "value" => 7.8401413,
+    #         "offset_millis" => -25200000
+    #       },
+    #       ...
+    #     ]
+    #   }
+
+    def sensors_historical(hours:)
+      require 'active_support/all'
+      timestamp = Time.now.utc.to_i * 1000
+
+      get("/v1/room/all_sensors/hours?quantity=#{hours}&from_utc=#{timestamp}")
+    end
+
+    # Known +type+s:
+    # * +TEMPERATURE+
+    # * +HUMIDITY+
+    # * +LIGHT+
+    # * +PARTICULATES+
+    # * +SOUND+
+    #
+    # @return [Array<Hash>]
+    #
+    # @example
+    #   [
+    #     {
+    #       "name" => "Temperature",
+    #       "type" => "TEMPERATURE",
+    #       "unit" => "CELSIUS",
+    #       "message" => "It's a bit warm.",
+    #       "scale" => [{
+    #         "name" => "Cold",
+    #         "min" => nil,
+    #         "max" => 9.99,
+    #         "condition" => "ALERT"
+    #       }, {
+    #         "name" => "Cool",
+    #         "min" => 10.0,
+    #         "max" => 14.99,
+    #         "condition" => "WARNING"
+    #       }, {
+    #         "name" => "Ideal",
+    #         "min" => 15.0,
+    #         "max" => 19.99,
+    #         "condition" => "IDEAL"
+    #       }, {
+    #         "name" => "Warm",
+    #         "min" => 20.0,
+    #         "max" => 25.99,
+    #         "condition" => "WARNING"
+    #       }, {
+    #         "name" => "Hot",
+    #         "min" => 26.0,
+    #         "max" => nil,
+    #         "condition" => "ALERT"
+    #       }],
+    #       "condition" => "WARNING",
+    #       "value" => 20.32
+    #     }
+    #     ...
+    #   ]
+
+    def sensors
+      data = get('/v2/sensors')
+      data['sensors']
+    end
+
+    def update_sensors(data)
+      post('/v2/sensors', data)
+    end
+  end
+end