unofficial_sense_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d213928a8c1d4fd351ca47e6a43e32caeb2fb01348b1bfb708ca7ef0ef2bcce2
+  data.tar.gz: 0dd6fdc5a66b58ee5ce0230d51db8ba36a0c0cc46eb6b949d62190f932fc6057
+SHA512:
+  metadata.gz: a1f0aaf7adffa2d42c0f62e54f87d84f1de1296d7e67874f69b991e10b4aef1c3f78b1f5df85caba6079d16d714902976a62b1deeca4c002869452e8f54492a7
+  data.tar.gz: 974bb20d06cc9c659446ff3bd524eb87f51708ce90bb96d3ed828dae7ee470ec94f615ae95ec62c4fbcf2929898060aa4a87f54fc0b48b439a95fdb9020a2139

data/.gitignore

@@ -0,0 +1,3 @@
+/.bundle
+Gemfile.lock
+.ruby-gemset

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Making Sense
+
+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,94 @@
+# Unofficial Sense Api
+
+Access your Sense data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'unofficial_sense_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install unofficial_sense_api
+
+## Usage
+
+Getting Realtime Data (starts a websocket to `wss://clientrt.sense.com/monitors/#{api.first_monitor_id}/realtimefeed`)
+
+```ruby
+require 'sense_api'
+require 'pp'
+
+api = SenseApi.new("USERNAME", "PASSWORD")
+
+count = 0
+api.realtime do |json|
+  pp json
+
+  # Be sure to return :exit to terminate the connection and shut down EventMachine!
+  count += 1
+  count > 5 ? :exit : nil
+end
+```
+
+Use `fetch` to pull from REST endpoints of your choice. None have been added to this gem yet.
+
+```ruby
+require 'sense_api'
+api = SenseApi.new("USERNAME", "PASSWORD")
+
+timeline = api.fetch("https://api.sense.com/apiservice/api/v1/users/#{api.user_id}/timeline?n_item=30")
+
+trends = api.fetch("https://api.sense.com/apiservice/api/v1/app/history/trends?monitor_id=#{api.first_monitor_id}&scale=WEEK&start=2017-10-23T04:00:00.000Z")
+
+devices = api.fetch("https://api.sense.com/apiservice/api/v1/app/monitors/#{api.first_monitor_id}/devices?include_merged=true")
+
+first_device_id = devices.first["id"]
+
+first_device_details = api.fetch("https://api.sense.com/apiservice/api/v1/app/monitors/#{api.first_monitor_id}/devices/#{first_device_id}")
+first_device_hostory = api.fetch("https://api.sense.com/apiservice/api/v1/app/history/usage?monitor_id=#{api.first_monitor_id}&granularity=MINUTE&start=2017-10-21T11:00:00.000Z&frames=5400&device_id=#{first_device_id}")
+```
+
+Here are the endpoints we know about so far:
+
+* `"https://api.sense.com/apiservice/api/v1/users/#{api.user_id}/timeline?n_item=30"`
+* `"https://api.sense.com/apiservice/api/v1/app/history/trends?monitor_id=#{api.first_monitor_id}&scale=WEEK&start=2017-10-23T04:00:00.000Z"`
+* `"https://api.sense.com/apiservice/api/v1/app/history/usage?monitor_id=#{api.first_monitor_id}&granularity=SECOND&start=2017-10-25T03:54:00.000Z&frames=5400"` (`granularity` seems to accept `SECOND` or `MINUTE`)
+
+List devices:
+* `"https://api.sense.com/apiservice/api/v1/app/monitors/#{api.first_monitor_id}/devices?include_merged=true"`
+
+You can add a `device_id` to the history request:
+* `"https://api.sense.com/apiservice/api/v1/app/history/usage?monitor_id=#{api.first_monitor_id}&granularity=MINUTE&start=2017-10-21T11:00:00.000Z&frames=5400&device_id=SOME_DEVICE_ID"`
+
+And get the data for devices:
+* `"https://api.sense.com/apiservice/api/v1/app/monitors/#{api.first_monitor_id}/devices/always_on"`
+* `"https://api.sense.com/apiservice/api/v1/app/monitors/#{api.first_monitor_id}/devices/unknown"`
+* `"https://api.sense.com/apiservice/api/v1/app/monitors/#{api.first_monitor_id}/devices/SOME_DEVICE_ID"`
+
+### Accessing the API with Curl
+
+If you'd like, you can skip Ruby entirely and talk to the Sense API with curl:
+
+`curl -k --data "email=email@example.com" --data "password=URL_ENCODED_PASSWORD" -H "Sense-Client-Version: 1.17.1-20c25f9" -H "X-Sense-Protocol: 3" -H "User-Agent: okhttp/3.8.0" "https://api.sense.com/apiservice/api/v1/authenticate"`
+
+The response will have an `access_token`, as well as a `user_id` and a `monitors` array that you can use to access the Sense APIs. For example:
+
+`curl -k -H "Authorization: bearer ACCESS_TOKEN" -H "Sense-Client-Version: 1.17.1-20c25f9" -H "X-Sense-Protocol: 3" -H "User-Agent: okhttp/3.8.0" "https://api.sense.com/apiservice/api/v1/app/history/usage?monitor_id=A_MONITOR_ID&granularity=SECOND&start=2017-10-24T05:36:00.000Z&frames=5400"`
+
+## Development
+
+You can run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sense_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/lib/sense_api.rb

@@ -0,0 +1,115 @@
+require "sense_api/version"
+require 'net/http'
+require 'openssl'
+require 'json'
+require 'eventmachine'
+require 'websocket/eventmachine/client'
+
+class SenseApi
+  attr_accessor :email, :password, :token, :monitors, :user_id, :account_id
+
+  class SenseApiError < StandardError; end
+
+  def initialize(email, password, token: nil, monitors: nil)
+    self.email = email
+    self.password = password
+    self.token = token
+    self.monitors = monitors
+
+    login! unless token
+  end
+
+  def fetch(url, depth = 0)
+    uri = URI(url)
+    req = Net::HTTP::Get.new(uri)
+
+    req['Authorization'] = "bearer #{token}"
+    req['Sense-Client-Version'] = '1.17.1-20c25f9'
+    req['X-Sense-Protocol'] = '3'
+    req['User-Agent'] = 'okhttp/3.8.0'
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE  
+    res = http.request(req)
+
+    case res
+    when Net::HTTPRedirection
+      if depth < 2
+        fetch(res['Location'], depth + 1)
+      else
+        raise SenseApiError, "Too many redirects"
+      end
+    when Net::HTTPSuccess
+      JSON.parse(res.body)
+    else
+      raise SenseApiError, "Error: #{res.value}" 
+    end
+  end
+
+  def first_monitor_id
+    monitors.first["id"]
+  end
+
+  def realtime(monitor_id = first_monitor_id)
+    raise ArgumentError, "block required" unless block_given?
+
+    exiting = false
+    EM.run do
+      ws = WebSocket::EventMachine::Client.connect(
+        uri: "wss://clientrt.sense.com/monitors/#{monitor_id}/realtimefeed",
+        headers: {
+          'Authorization' => "bearer #{token}",
+          'Sense-Client-Version' => '1.17.1-20c25f9',
+          'X-Sense-Protocol' => '3',
+          'User-Agent' => 'okhttp/3.8.0'
+        },
+        tls_options: { fail_if_no_peer_cert: false, verify_peer: false }
+      )
+
+      ws.onmessage do |msg, type|
+        if yield(JSON.parse(msg)) == :exit
+          exiting = true
+          ws.close
+        end
+      end
+
+      ws.onclose do |code, reason|
+        raise SenseApiError, "Connection closed: #{code} #{reason}" unless exiting
+        EM.stop_event_loop
+      end
+    end
+  end
+
+  private
+
+  def login!
+    uri = URI('https://api.sense.com/apiservice/api/v1/authenticate')
+    req = Net::HTTP::Post.new(uri)
+
+    req.set_form_data(email: email, password: password)
+    req['Sense-Client-Version'] = '1.17.1-20c25f9'
+    req['X-Sense-Protocol'] = '3'
+    req['User-Agent'] = 'okhttp/3.8.0'
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.verify_mode = OpenSSL::SSL::VERIFY_NONE  
+    res = http.request(req)
+
+    case res
+    when Net::HTTPSuccess, Net::HTTPRedirection
+      json = JSON.parse(res.body)
+      if json["authorized"]
+        self.token = json["access_token"]
+        self.monitors = json["monitors"]
+        self.account_id = json["account_id"]
+        self.user_id = json["user_id"]
+      else
+        raise SenseApiError, "Login failed"
+      end
+    else
+      raise SenseApiError, "Error: #{res.value}" 
+    end
+  end
+end

data/lib/sense_api/version.rb

@@ -0,0 +1,3 @@
+class SenseApi
+  VERSION = "0.1.0"
+end

data/lib/unofficial_sense_api.rb

@@ -0,0 +1 @@
+require "sense_api"

data/unofficial_sense_api.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sense_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "unofficial_sense_api"
+  spec.version       = SenseApi::VERSION
+  spec.authors       = ["Making Sense"]
+
+  spec.summary       = %q{Get access to your home's power data from Sense}
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency "json"
+  spec.add_dependency "eventmachine"
+  spec.add_dependency "websocket-eventmachine-client"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: unofficial_sense_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Making Sense
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: websocket-eventmachine-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/sense_api.rb
+- lib/sense_api/version.rb
+- lib/unofficial_sense_api.rb
+- unofficial_sense_api.gemspec
+homepage: 
+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: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Get access to your home's power data from Sense
+test_files: []