hello-sense 0.1.0

data/lib/hello_sense/session.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Sense
+  module Session
+    def authorize_with_password!
+      data = {
+        grant_type: 'password',
+        client_id: @client_id,
+        client_secret: @client_secret,
+        username: @username,
+        password: @password,
+      }
+      request = Net::HTTP::Post.new('/v1/oauth2/token',
+                                    headers.reject { |key, _| key == :Authorization })
+      request.set_form_data(data)
+      response = connection.request(request)
+      response_data = data_or_error(response)
+
+      response_data['access_token']
+    end
+
+    def destroy_token
+      delete('/v1/oauth2/token')
+    end
+  end
+end

data/lib/hello_sense/sharing.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sense
+  module Sharing
+    def share_insight
+      post('/v2/sharing/insight', {})
+    end
+  end
+end

data/lib/hello_sense/sleep_sounds.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module Sense
+  module SleepSounds
+    # @return [Hash]
+    #
+    # @example
+    #   {
+    #     "availableDurations" => [{
+    #       "durations" => {
+    #         "id" => 2,
+    #         "name" => "30 Minutes"
+    #       }, {
+    #         "id" => 3,
+    #         "name" => "1 Hour"
+    #       }]
+    #     },
+    #     "availableSounds" => [{
+    #       "sounds" => {
+    #         "id" => 18,
+    #         "preview_url" => "https://s3.amazonaws.com/hello-audio/sleep-tones-preview/Aura.mp3",
+    #         "name" => "Aura"
+    #       }, {
+    #         "id" => 20,
+    #         "preview_url" => "https://s3.amazonaws.com/hello-audio/sleep-tones-preview/Nocturne.mp3",
+    #         "name" => "Nocturne"
+    #       }],
+    #       "state" => "OK"
+    #     },
+    #     "status" => {
+    #       "playing" => false,
+    #       "sound" => nil,
+    #       "duration" => nil,
+    #       "volume_percent" => nil
+    #     }
+    #   }
+
+    def sounds_combined_state
+      get('/v2/sleep_sounds/combined_state')
+    end
+
+    # @return [Hash]
+    #
+    # @example
+    #   {
+    #     "durations" => [{
+    #       "id" => 2,
+    #       "name" => "30 Minutes"
+    #     }, {
+    #       "id" => 3,
+    #       "name" => "1 Hour"
+    #     }]
+    #   }
+
+    def sound_durations
+      get('/v2/sleep_sounds/durations')
+    end
+
+    def play_sound
+      post('/v2/sleep_sounds/play')
+    end
+
+    # @return [Hash]
+    #
+    # @example
+    #   {
+    #     "sounds" => [{
+    #       "id" => 18,
+    #       "preview_url" => "https://s3.amazonaws.com/hello-audio/sleep-tones-preview/Aura.mp3",
+    #       "name" => "Aura"
+    #     }, {
+    #       "id" => 20,
+    #       "preview_url" => "https://s3.amazonaws.com/hello-audio/sleep-tones-preview/Nocturne.mp3",
+    #       "name" => "Nocturne"
+    #     }],
+    #     "state" => "OK"
+    #   }
+
+    def sounds
+      get('/v2/sleep_sounds/sounds')
+    end
+
+    # @return [Hash]
+    #
+    # @example
+    #   {
+    #     "playing" => false,
+    #     "sound" => nil,
+    #     "duration" => nil,
+    #     "volume_percent" => nil
+    #   }
+
+    def sounds_status
+      get('/v2/sleep_sounds/status')
+    end
+
+    def stop_sounds(data)
+      post('/v2/sleep_sounds/stop', data)
+    end
+  end
+end

data/lib/hello_sense/speech.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Sense
+  module Speech
+    # @return [Array]
+    #
+    # @example
+    #   []
+
+    def onboarding_speech
+      get('/v1/speech/onboarding')
+    end
+  end
+end

data/lib/hello_sense/stats.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Sense
+  module Stats
+    def update_stats(data)
+      patch('/v1/app/stats', data)
+    end
+
+    # @return [Hash]
+    #
+    # @example
+    #   {
+    #     "has_unread_insights" => true,
+    #     "has_unanswered_questions" => true
+    #   }
+
+    def unread_stats
+      get('/v1/app/stats/unread')
+    end
+  end
+end

data/lib/hello_sense/store.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Sense
+  module Store
+    def send_feedback(data)
+      post('/v2/store/feedback', data)
+    end
+  end
+end

data/lib/hello_sense/support.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Sense
+  module Support
+    # @return [Array<Hash>]
+    #
+    # @example
+    #   [
+    #     {
+    #       "topic" => "pairing_sense",
+    #       "display_name" => Pairing your Sense"
+    #     },
+    #     {
+    #       "topic" => "pairing_a_sleep_pill",
+    #       "display_name" => Pairing your Sleep Pill"
+    #     }
+    #   ]
+
+    def support_topics
+      get('/v1/support/topics')
+    end
+  end
+end

data/lib/hello_sense/timeline.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module Sense
+  module Timeline
+    # Known +event_type+s:
+    # * +FELL_ASLEEP+
+    # * +GENERIC_MOTION+
+    # * +GENERIC_SOUND+
+    # * +GOT_IN_BED+
+    # * +GOT_OUT_OF_BED+
+    # * +IN_BED+
+    # * +WOKE_UP+
+    #
+    # Known +sleep_state+s:
+    # * +AWAKE+
+    # * +LIGHT+
+    # * +MEDIUM+
+    # * +SOUND+
+    #
+    # Known +metrics+ +name+s:
+    # * +fell_asleep+
+    # * +sound_sleep+
+    # * +time_to_sleep+
+    # * +times_awake+
+    # * +total_sleep+
+    # * +woke_up+
+    # * +humidity+
+    # * +light+
+    # * +particulates+
+    # * +sound+
+    # * +temperature+
+    #
+    # @param date [String] a date in 'yyyy-MM-dd' format
+    # @return [Hash]
+    #
+    # @example
+    #   {
+    #     "score" => 69,
+    #     "score_condition" => "WARNING",
+    #     "message" => "You were asleep for **9.0 hours**, and sleeping soundly for 6.5 hours.",
+    #     "date" => "2017-01-01",
+    #     "sleep_periods" => [
+    #       "NIGHT"
+    #     ],
+    #     "events" => [{
+    #       "timestamp" => 1483340220000,
+    #       "timezone_offset" => -28800000,
+    #       "duration_millis" => 60000,
+    #       "message" => "You went to bed.",
+    #       "sleep_depth" => 0,
+    #       "sleep_state" => "AWAKE",
+    #       "event_type" => "GOT_IN_BED",
+    #       "sleep_period" => "NIGHT",
+    #       "valid_actions" => [
+    #         "ADJUST_TIME",
+    #         "VERIFY",
+    #         "INCORRECT"
+    #       ]
+    #     }],
+    #     "metrics" => [{
+    #       "name" => "total_sleep",
+    #       "value" => 537,
+    #       "unit" => "MINUTES",
+    #       "condition" => "IDEAL"
+    #     }],
+    #     "locked_down" => false
+    #   }
+
+    def timeline(date)
+      get("/v2/timeline/#{date}")
+    end
+
+    def create_timeline_event(date, type, timestamp, data)
+      put("/v2/timeline/#{date}/events/#{type}/#{timestamp}", data)
+    end
+
+    def update_timeline_event(date, type, timestamp, data)
+      patch("/v2/timeline/#{date}/events/#{type}/#{timestamp}", data)
+    end
+
+    def remove_timeline_event(date, type, timestamp)
+      delete("/v2/timeline/#{date}/events/#{type}/#{timestamp}")
+    end
+  end
+end

data/lib/hello_sense/trends.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Sense
+  module Trends
+    # @param timescale [String] one of +'LAST_WEEK'+, +'LAST_MONTH'+, +'LAST_3_MONTHS'+
+    # @return [Hash]
+    #
+    # @example
+    #   {
+    #     "available_time_scales" => [
+    #       "LAST_WEEK",
+    #       "LAST_MONTH",
+    #       "LAST_3_MONTHS"
+    #     ],
+    #     "graphs" => [{
+    #       "time_scale" => "LAST_WEEK",
+    #       "title" => "Sleep Score",
+    #       "data_type" => "SCORES",
+    #       "graph_type" => "GRID",
+    #       "min_value" => 71.0,
+    #       "max_value" => 86.0,
+    #       "sections" => [{
+    #         "values" => [81.0, 80.0, 78.0, 71.0, 79.0, 86.0, 77.0],
+    #         "titles" => ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"],
+    #         "highlighted_values" => [6],
+    #         "highlighted_title" => 6
+    #       }],
+    #       "condition_ranges" => [{
+    #         "min_value" => 80.0,
+    #         "max_value" => 100.0,
+    #         "condition" => "IDEAL"
+    #       }, {
+    #         "min_value" => 60.0,
+    #         "max_value" => 79.0,
+    #         "condition" => "WARNING"
+    #       }, {
+    #         "min_value" => 0.0,
+    #         "max_value" => 59.0,
+    #         "condition" => "ALERT"
+    #       }],
+    #       "annotations" => [{
+    #         "title" => "Avg. Weekdays",
+    #         "value" => 78.8,
+    #         "data_type" => "SCORES",
+    #         "condition" => "WARNING"
+    #       }, {
+    #         "title" => "Avg. Weekends",
+    #         "value" => 79.0,
+    #         "data_type" => "SCORES",
+    #         "condition" => "WARNING"
+    #       }, {
+    #         "title" => "Avg. Overall",
+    #         "value" => 78.9,
+    #         "data_type" => "SCORES",
+    #         "condition" => "WARNING"
+    #       }]
+    #     }, {
+    #       "time_scale" => "LAST_WEEK",
+    #       "title" => "Sleep Duration",
+    #       "data_type" => "HOURS",
+    #       "graph_type" => "BAR",
+    #       "min_value" => 7.483333,
+    #       "max_value" => 9.083333,
+    #       "sections" => [{
+    #         "values" => [7.85, 8.383333, 7.483333, 7.7, 7.8, 9.083333, 7.6833334],
+    #         "titles" => ["SUN", "MON", "TUE", "WED", "THU", "FRI", "SAT"],
+    #         "highlighted_values" => [2, 5],
+    #         "highlighted_title" => 6
+    #       }],
+    #       "condition_ranges" => [],
+    #       "annotations" => [{
+    #         "title" => "Avg. Weekdays",
+    #         "value" => 8.1,
+    #         "data_type" => "HOURS",
+    #         "condition" => nil
+    #       }, {
+    #         "title" => "Avg. Weekends",
+    #         "value" => 7.8,
+    #         "data_type" => "HOURS",
+    #         "condition" => nil
+    #       }, {
+    #         "title" => "Avg. Overall",
+    #         "value" => 8.0,
+    #         "data_type" => "HOURS",
+    #         "condition" => nil
+    #       }]
+    #     }, {
+    #       "time_scale" => "LAST_WEEK",
+    #       "title" => "Sleep Depth",
+    #       "data_type" => "PERCENTS",
+    #       "graph_type" => "BUBBLES",
+    #       "min_value" => 0.0,
+    #       "max_value" => 1.0,
+    #       "sections" => [{
+    #         "values" => [0.068022884, 0.5591227, 0.3728544],
+    #         "titles" => ["LIGHT", "MEDIUM", "DEEP"],
+    #         "highlighted_values" => [],
+    #         "highlighted_title" => nil
+    #       }],
+    #       "condition_ranges" => [],
+    #       "annotations" => []
+    #     }]
+    #   }
+
+    def trends(timescale)
+      get("/v2/trends/#{timescale}")
+    end
+  end
+end

data/lib/hello_sense/version.rb

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

metadata

@@ -0,0 +1,197 @@
+--- !ruby/object:Gem::Specification
+name: hello-sense
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jordan Cole
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 9.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 11.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.6.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.48.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.48'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.48.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+description: Ruby implementation of Sense's private API
+email:
+- stilist@ratafia.info
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- CONTRIBUTING.md
+- LICENSE
+- README.md
+- hello_sense.gemspec
+- lib/hello_sense.rb
+- lib/hello_sense/account.rb
+- lib/hello_sense/alarms.rb
+- lib/hello_sense/alerts.rb
+- lib/hello_sense/api_error.rb
+- lib/hello_sense/app.rb
+- lib/hello_sense/client.rb
+- lib/hello_sense/constants.rb
+- lib/hello_sense/devices.rb
+- lib/hello_sense/expansions.rb
+- lib/hello_sense/firmware.rb
+- lib/hello_sense/insights.rb
+- lib/hello_sense/notifications.rb
+- lib/hello_sense/questions.rb
+- lib/hello_sense/sensors.rb
+- lib/hello_sense/session.rb
+- lib/hello_sense/sharing.rb
+- lib/hello_sense/sleep_sounds.rb
+- lib/hello_sense/speech.rb
+- lib/hello_sense/stats.rb
+- lib/hello_sense/store.rb
+- lib/hello_sense/support.rb
+- lib/hello_sense/timeline.rb
+- lib/hello_sense/trends.rb
+- lib/hello_sense/version.rb
+homepage: https://github.com/stilist/hello-sense
+licenses: []
+metadata:
+  yard.run: yri
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: TK
+test_files: []