hello-sense 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a8e647726f67f5252d0c42deacd02db75b199fbb
+  data.tar.gz: 8aafd391d5d2ab33ce704bc64850ad9be5b431f4
+SHA512:
+  metadata.gz: 815cb57782f3aa897b984a809c3f4f1eeb4368bbac81b18b39777df479db2480cc5e0d7b46d0fbafeb721eda0c52ef87e4a12c9e1e369212c5500c4fa84f6e4d
+  data.tar.gz: ae0e965c4fb843128eec6066e681ee619fc889f727eb8985c03ddae2fe02a01f5ac14b4787bfcb4932cb0cfb1b299f1a8172aeda220176b853894ec694780227

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## Unreleased
+### Added
+- Initial release

data/CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# Contributing to `hello-sense`
+
+Thank you for your interest in contributing to the `hello-sense` gem! We welcome any contributions: code, bug reports, documentation, and more.
+
+## Bug reports
+
+There’s a number of reasons to file a bug report:
+
+* incorrect or unexpected results
+* bugs
+* misleading or incorrect documentation
+
+Opening an issue is as easy as following [this link](https://github.com/stilist/hello-sense/issues/new) and filling out the fields. You can reference the [template](.github/ISSUE_TEMPLATE.md) to see what information will be the most helpful.
+
+## Development environment
+
+To install the development dependencies, run these commands:
+
+```bash
+$ gem install bundler
+$ bundle install
+```
+
+## Making changes
+
+When you make changes to the code, make sure you’re keeping the [test suite](http://rspec.info) and [inline documentation](http://yardoc.org) updated.
+
+When you’re done making your changes, run `rake build`. This automatically generates documentation (`rake doc`), [lints the code](https://github.com/bbatsov/rubocop) (`rake lint`), and runs the test suite (`rake spec`) before building the `.gem` file. If `rake build` finishes without any errors and builds the `.gem`, your changes are ready for a pull request.
+
+## Pull requests
+
+We use pull requests as a simple, consistent way to make updates to the project. GitHub has some [great documentation][pull-requests] on using the Pull Request feature. We use the ‘fork and pull’ model described there.
+
+[pull-requests]: https://help.github.com/articles/using-pull-requests/
+
+Please make pull requests against the `master` branch. We have a [pull request template](PULL_REQUEST_TEMPLATE.md) to help guide you.
+
+## Coding conventions
+
+Hello doesn't publicly document the Sense API, so this gem's documentation includes request and response data to demonstrate each API endpoint. To keep personal information out of the example data, use these values whenever you add or change documentation:
+
+* email address: `drisha.wabudeya@example.org`
+* name: [Drisha](http://www.bachpan.com/Meaning-Of-Drisha.aspx) [Wabudeya](http://www.americanlastnames.us/last-names/Ugandan/W/W-0.html)
+* password: `'My super secure password!'`
+* device id: `ABCDEF1234567890` or `0987654321FEDCBA`
+* create timestamp: `1420099200000` (`2015-01-01T00:00:00-0800`)
+* update timestamp: `1483257600000` (`2017-01-01T00:00:00-0800`)
+* [UUID](https://en.wikipedia.org/wiki/Universally_unique_identifier): `FDED667B-9E91-43F5-91DE-258AC1FEE9C2` (generated with [an online tool](https://guidgenerator.com/online-guid-generator.aspx))
+
+
+
+
+
+
+* https://apkpure.com/sense/is.hello.sense
+* https://github.com/skylot/jadx

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Jordan Cole
+
+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,55 @@
+# `hello-sense`
+
+## Installation
+
+```shell
+gem install hello-sense
+```
+
+## Usage
+
+### Authentication
+
+The Sense API relies on an [OAuth 2](https://oauth.net/2/) [access token](https://www.oauth.com/oauth2-servers/access-tokens/).
+
+(Note: the `client_id` and `client_secret` shown here are taken from the official Sense app's source code.)
+
+```ruby
+# Create a session using email and password.
+client = Sense::Client.new(client_id: '8d3c1664-05ae-47e4-bcdb-477489590aa4',
+                           client_secret: '4f771f6f-5c10-4104-bbc6-3333f5b11bf9',
+                           username: 'drisha.wabudeya@example.org',
+                           password: 'My super secure password!')
+```
+
+```ruby
+# Create a session using an existing access token.
+client = Sense::Client.new(access_token: '2.fded667b9e9143f591de258ac1fee9c2')
+```
+
+```ruby
+# Get the timeline for the sleep session from the night of 31 December 2016.
+client.timeline('2017-01-01')
+
+# Get the current conditions reported by the device's sensors.
+client.sensors
+```
+
+```ruby
+# Invalidate the session's access token.
+client.destroy_token
+```
+
+```ruby
+# Pull in ~38 days of sensor data, sampled at 5 minute intervals.
+data = client.sensors_historical(hours: 920)
+File.open('sense_sensor_data.json', 'w') { |f| f.write(JSON.dump(data) }
+```
+
+## Contributing
+
+To contribute to the `hello-sense` gem, please see [`CONTRIBUTING`](CONTRIBUTING.md).
+
+## References
+
+* http://jeffhuang.com/extracting_my_data_from_the_hello_sense.html

data/hello_sense.gemspec

@@ -0,0 +1,24 @@
+require_relative 'lib/hello_sense/version'
+
+Gem::Specification.new do |s|
+  s.date = Time.now.strftime('%Y-%m-%d')
+  s.description = "Ruby implementation of Sense's private API"
+  s.name = 'hello-sense'
+  s.required_ruby_version = ['>= 2.3.0', '< 2.5.0']
+  s.summary = 'TK'
+  s.version = Sense::VERSION
+
+  s.authors = ['Jordan Cole']
+  s.email = ['stilist@ratafia.info']
+  s.homepage = 'https://github.com/stilist/hello-sense'
+
+  s.files = Dir[__FILE__, 'LICENSE', '*.md', 'lib/**/*']
+  s.metadata['yard.run'] = 'yri'
+
+  s.add_development_dependency('byebug', '~> 9.0', '>= 9.0.0')
+  s.add_development_dependency('rake', '~> 11.0', '>= 11.0.0')
+  s.add_development_dependency('rspec-core', '~> 3.6', '>= 3.6.0')
+  s.add_development_dependency('rspec-expectations', '~> 3.6', '>= 3.6.0')
+  s.add_development_dependency('rubocop', '~> 0.48', '>= 0.48.0')
+  s.add_development_dependency('yard', '~> 0.9', '>= 0.9.0')
+end

data/lib/hello_sense.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+# Defines the namespace for the +hello-sense+ gem.
+module Sense
+  require_relative 'hello_sense/account'
+  require_relative 'hello_sense/alarms'
+  require_relative 'hello_sense/alerts'
+  require_relative 'hello_sense/app'
+  require_relative 'hello_sense/devices'
+  require_relative 'hello_sense/expansions'
+  require_relative 'hello_sense/firmware'
+  require_relative 'hello_sense/insights'
+  require_relative 'hello_sense/notifications'
+  require_relative 'hello_sense/questions'
+  require_relative 'hello_sense/sensors'
+  require_relative 'hello_sense/sharing'
+  require_relative 'hello_sense/sleep_sounds'
+  require_relative 'hello_sense/speech'
+  require_relative 'hello_sense/stats'
+  require_relative 'hello_sense/store'
+  require_relative 'hello_sense/support'
+  require_relative 'hello_sense/timeline'
+  require_relative 'hello_sense/trends'
+
+  require_relative 'hello_sense/api_error'
+  require_relative 'hello_sense/constants'
+  require_relative 'hello_sense/session'
+  require_relative 'hello_sense/version'
+  require_relative 'hello_sense/client'
+end

data/lib/hello_sense/account.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+module Sense
+  module Account
+    EMAIL_PATTERN = /^.+@.+\\..+$/
+    MIN_PASSWORD_LENGTH = 6
+
+    # Get the current
+    #
+    # @return [Hash]
+    #
+    # @example
+    #   {
+    #     "email" => "drisha.wabudeya@example.org",
+    #     "tz" => -28800000,
+    #     "name" => "Drisha",
+    #     "firstname" => "Drisha",
+    #     "lastname" => "Wabudeya",
+    #     "gender" => "FEMALE",
+    #     "gender_other" => "",
+    #     "height" => 160,
+    #     "weight" => 68000,
+    #     "created" => 1420099200000,
+    #     "last_modified" => 1420099200000,
+    #     "email_verified" => true,
+    #     "profile_photo" => nil,
+    #     "ext_id" => "fded667b-9e91-43f5-91de-258ac1fee9c2",
+    #     "dob" => "1990-01-01",
+    #     "id" => "fded667b-9e91-43f5-91de-258ac1fee9c2"
+    #   }
+
+    def account
+      get('/v1/account')
+    end
+
+    # @param data [Hash]
+    #
+    # @see #account for fields
+
+    def create_account(data)
+      put('/v1/account', data)
+    end
+
+    # @param data [Hash]
+    #
+    # @see #account for fields
+
+    def update_account(data)
+      post('/v1/account', data)
+    end
+
+    # @return [Hash]
+    #
+    # @example
+    #   {
+    #     "TIME_TWENTY_FOUR_HOUR" => true,
+    #     "PUSH_SCORE" => true,
+    #     "WEIGHT_METRIC" => false,
+    #     "TEMP_CELSIUS" => true,
+    #     "HEIGHT_METRIC" => false,
+    #     "ENHANCED_AUDIO" => true,
+    #     "PUSH_ALERT_CONDITIONS" => true
+    #   }
+
+    def preferences
+      get('/v2/account/preferences')
+    end
+
+    def update_preferences(data)
+      put('/v2/account/preferences', data)
+    end
+
+    def update_photo(data)
+      post('/v1/photo/profile', data)
+    end
+
+    def delete_profile_picture
+      delete('/v1/photo/profile')
+    end
+
+    # @param email [String] the new email address for the account
+    # @return XXX
+
+    def update_email(email)
+      raise InvalidEmailError if !normalize(email).match(EMAIL_PATTERN)
+
+      data = account.merge('email' => email)
+
+      post('/v1/account/email', data)
+    end
+
+    # @param current_password [String] the user's current password
+    # @param new_password [String] the new password to use
+    #
+    # @note
+    #
+    # @example
+    #   client.update_password('My super secure password!',
+    #                          'My even better new password (my second)!')
+
+    def update_password(current_password, new_password)
+      raise InvalidPasswordError if normalize(new_password).length < MIN_PASSWORD_LENGTH
+
+      post('/v1/account/password', currentPassword: current_password,
+                                   newPassword: new_password)
+    end
+
+    # @return [Hash]
+    #
+    # @example
+    #   {
+    #     "timezone_offset" => -25200000,
+    #     "timezone_id" => "America/Los_Angeles"
+    #   }
+
+    def current_timezone
+      get('/v1/timezone')
+    end
+
+    def update_timezone(data)
+      post('/v1/timezone', data)
+    end
+
+    private
+
+    def normalize(str = '')
+      str.trim
+    end
+  end
+end

data/lib/hello_sense/alarms.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Sense
+  module Alarms
+    # @return [Hash]
+    #
+    # @example
+    #   {
+    #     "expansions" => [],
+    #     "voice" => [],
+    #     "classic" => [{
+    #       "year" => 0,
+    #       "month" => 0,
+    #       "day_of_month" => 0,
+    #       "hour" => 7,
+    #       "minute" => 30,
+    #       "day_of_week" => [1, 2, 3, 4, 5],
+    #       "repeated" => true,
+    #       "enabled" => true,
+    #       "editable" => true,
+    #       "smart" => true,
+    #       "sound" => {
+    #         "id" => 5,
+    #         "name" => "Dusk",
+    #         "url" => ""
+    #       },
+    #       "id" => "FDED667B-9E91-43F5-91DE-258AC1FEE9C2",
+    #       "source" => "MOBILE_APP",
+    #       "expansions" => []
+    #     }]
+    #   }
+
+    def alarms
+      get('/v2/alarms')
+    end
+
+    # @return [Array<Hash>]
+    #
+    # @example
+    #   [
+    #     {
+    #       "id" => 5,
+    #       "name" => "Dusk",
+    #       "url" => "https://hello-audio.s3.amazonaws.com/ringtones/Dusk.mp3?x-amz-security-token=XXX"
+    #     },
+    #   ]
+
+    def alarm_sounds
+      get('/v1/alarms/sounds')
+    end
+
+    def update_alarm(data)
+      timestamp = DateTime.now
+        .new_offset(0)
+        .iso8601
+      post("/v2/alarms/#{timestamp}", data)
+    end
+  end
+end

data/lib/hello_sense/alerts.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Sense
+  module Alerts
+    # @return [Array]
+    #
+    # @example
+    #   []
+
+    def alerts
+      get('/v2/alerts')
+    end
+  end
+end

data/lib/hello_sense/api_error.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Sense
+  class APIError < StandardError
+    attr_reader :code, :description, :response, :type
+
+    # @todo Document param
+    def initialize(response)
+      @code = response.code
+      @description = response.code_type
+      @response = response
+      @type = response.error_type
+    end
+
+    def message
+      "#{@type}: #{@description} (#{@code})"
+    end
+    alias to_s message
+  end
+end

data/lib/hello_sense/app.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Sense
+  module App
+    # Check if a new version of the app has been released.
+    #
+    # @param app_version [String]
+    # @param language [String]
+    # @param platform [String]
+    # @return [Hash]
+    #
+    # @example
+    #   client.check_for_update('10000000', 'en', 'android')
+
+    def check_for_update(app_version, language, platform)
+      post('/v1/app/checkin', app_version: app_version,
+                              lang_code: language,
+                              platform: platform)
+    end
+  end
+end