nest-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ba1e9ac59a9cced62288368ab77f8304d77746e9
+  data.tar.gz: f233c6b21e8cb42a86f1e8638c918e142ffc2801
+SHA512:
+  metadata.gz: 2b289d311b00248ef4d944dd74d0d8efd15589442ff544c57f48cbefadb72af2e880568f3071346a87858ffe1ac8a86b5ae32085140f77738e899d61a0e29e49
+  data.tar.gz: dd68b94c86dea9143184b3f7e58c8310fb7805ebed8e25c3a617bff5d700629cf3df76c9f4c518cd963a8795e15c6030a5f4f7ace71459320928d60b12ca3145

data/.gitignore

@@ -0,0 +1,2 @@
+.env
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,58 @@
+PATH
+  remote: .
+  specs:
+    nest-api (0.0.1)
+      awesome_print
+      cistern (~> 2.8.2)
+      excon (~> 0.45.5)
+      faraday (~> 0.15.4)
+      faraday_middleware
+      oj
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    awesome_print (1.8.0)
+    byebug (11.0.1)
+    cistern (2.8.2)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    excon (0.45.5)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.13.1)
+      faraday (>= 0.7.4, < 1.0)
+    method_source (0.9.2)
+    multipart-post (2.0.0)
+    oj (3.6.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  nest-api!
+  pry-byebug
+  rspec
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,19 @@
+# Nest API Client
+
+Nest API client using Cistern. Currently this client can only read thermostat params
+
+## Usage
+
+### Installation
+`gem install nest-api`
+
+`require 'nest'`
+
+###
+1. Initialize the client
+
+`client = Nest.new(access_token: API_KEY)`
+
+2. Get a device
+
+`thermostat = client.thermostats.first`

data/lib/nest.rb

@@ -0,0 +1,17 @@
+require "awesome_print"
+require "cistern"
+require "excon"
+require "faraday"
+require "faraday_middleware"
+require "oj"
+
+class Nest
+  include Cistern::Client.with(interface: :module)
+
+  recognizes :url, :access_token
+
+  require_relative "nest/real"
+  require_relative "nest/requests/get_metadata"
+  require_relative "nest/models/thermostat"
+  require_relative "nest/models/thermostats"
+end

data/lib/nest/models/thermostat.rb

@@ -0,0 +1,56 @@
+class Nest::Thermostat
+  include Nest::Model
+
+  identity :id, aliases: [:device_id]
+
+  attribute :ambient_temperature_c,       type: :float
+  attribute :ambient_temperature_f,       type: :float
+  attribute :away_temperature_high_c,     type: :float
+  attribute :away_temperature_high_f,     type: :float
+  attribute :away_temperature_low_c,      type: :float
+  attribute :away_temperature_low_f,      type: :float
+  attribute :can_cool,                    type: :boolean
+  attribute :can_heat,                    type: :boolean
+  attribute :device_id
+  attribute :eco_temperature_high_c,      type: :float
+  attribute :eco_temperature_high_f,      type: :float
+  attribute :eco_temperature_low_c,       type: :float
+  attribute :eco_temperature_low_f,       type: :float
+  attribute :fan_timer_active,            type: :boolean
+  attribute :fan_timer_duration,          type: :float
+  attribute :fan_timer_timeout
+  attribute :has_fan,                     type: :boolean
+  attribute :has_leaf,                    type: :boolean
+  attribute :humidity,                    type: :float
+  attribute :hvac_mode
+  attribute :hvac_state
+  attribute :is_locked,                   type: :boolean
+  attribute :is_online,                   type: :boolean
+  attribute :is_using_emergency_heat,     type: :boolean
+  attribute :label
+  attribute :last_connection
+  attribute :locale
+  attribute :locked_temp_max_c,           type: :float
+  attribute :locked_temp_max_f,           type: :float
+  attribute :locked_temp_min_c,           type: :float
+  attribute :locked_temp_min_f,           type: :float
+  attribute :name
+  attribute :name_long
+  attribute :previous_hvac_mode
+  attribute :software_version
+  attribute :structure_id
+  attribute :sunlight_correction_active,  type: :boolean
+  attribute :sunlight_correction_enabled, type: :boolean
+  attribute :target_temperature_c,        type: :float
+  attribute :target_temperature_f,        type: :float
+  attribute :target_temperature_high_c,   type: :float
+  attribute :target_temperature_high_f,   type: :float
+  attribute :target_temperature_low_c,    type: :float
+  attribute :target_temperature_low_f,    type: :float
+  attribute :temperature_scale
+  attribute :time_to_target
+  attribute :time_to_target_training
+  attribute :where_id
+  attribute :where_name
+end
+

data/lib/nest/models/thermostats.rb

@@ -0,0 +1,10 @@
+class Nest::Thermostats
+  include Nest::Collection
+
+  model Nest::Thermostat
+
+  def all
+    data = cistern.get_metadata["devices"]["thermostats"].map { |k,v| v }
+    load(data)
+  end
+end

data/lib/nest/real.rb

@@ -0,0 +1,29 @@
+class Nest::Real
+  attr_reader :url, :connection, :access_token
+
+  def initialize(attributes={})
+    @url          = attributes[:url]          || 'https://developer-api.nest.com/'
+    @access_token = attributes[:access_token] || ENV["ACCESS_TOKEN"]
+    @connection   = Faraday.new(url: @url, headers: { "Content-Type" => "application/json" }) do |b|
+      b.adapter :excon
+      b.authorization :Bearer, @access_token
+    end
+  end
+
+  def request(method, path, args={})
+    res = connection.send(method) do |req|
+      req.url path
+    end
+
+    while res.status == 307
+      redirect_client = Faraday.new(res.headers["Location"]) do |b|
+        b.adapter :excon
+        b.authorization :Bearer, @access_token
+      end
+
+      res = redirect_client.send(method, "/")
+    end
+
+    Oj.load(res.body)
+  end
+end

data/lib/nest/requests/get_metadata.rb

@@ -0,0 +1,7 @@
+class Nest::GetMetadata
+  include Nest::Request
+
+  def real
+    cistern.request(:get, "/")
+  end
+end

data/lib/nest/version.rb

@@ -0,0 +1,3 @@
+class Nest
+  VERSION = "0.0.1"
+end

data/nest-api.gemspec

@@ -0,0 +1,28 @@
+require_relative "./lib/nest/version"
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Eugene Howe"]
+  gem.email         = ["eugene@xtreme-computers.net"]
+  gem.description   = %q{}
+  gem.summary       = %q{}
+  gem.homepage      = "https://github.com/ehowe/nest-api.git"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "nest-api"
+  gem.require_paths = ["lib"]
+  gem.version       = Nest::VERSION
+
+  gem.add_dependency "awesome_print",      "~> 1.8"
+  gem.add_dependency "cistern",            "~> 2.8"
+  gem.add_dependency "excon",              "~> 0.45"
+  gem.add_dependency "faraday",            "~> 0.15"
+  gem.add_dependency "faraday_middleware", "~> 0.13"
+  gem.add_dependency "oj",                 "~> 3.6"
+
+  gem.add_development_dependency "byebug",     "~> 11.0"
+  gem.add_development_dependency "dotenv",     "~> 2.7"
+  gem.add_development_dependency "pry-byebug", "~> 3.7"
+  gem.add_development_dependency "rspec",      "~> 3.8"
+end

data/spec/test_helper.rb

@@ -0,0 +1 @@
+require_relative "../lib/nest"

data/spec/thermostat_spec.rb

@@ -0,0 +1,9 @@
+require "test_helper"
+
+describe "Thermostats" do
+  let(:client) { Nest.new }
+
+  it "has a collection of thermostats" do
+    expect(client.thermostats.all).to be_a(Nest::Thermostats)
+  end
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: nest-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eugene Howe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: cistern
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.8'
+- !ruby/object:Gem::Dependency
+  name: excon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.45'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: ''
+email:
+- eugene@xtreme-computers.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/nest.rb
+- lib/nest/models/thermostat.rb
+- lib/nest/models/thermostats.rb
+- lib/nest/real.rb
+- lib/nest/requests/get_metadata.rb
+- lib/nest/version.rb
+- nest-api.gemspec
+- spec/test_helper.rb
+- spec/thermostat_spec.rb
+homepage: https://github.com/ehowe/nest-api.git
+licenses: []
+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.6.14
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/test_helper.rb
+- spec/thermostat_spec.rb