nest_away 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd208c0d0466f5eea1e1d966f0ba112b77fbc7ea
+  data.tar.gz: b8da11671f524194931fa537646d6f43aec22ff6
+SHA512:
+  metadata.gz: 1df548910c82d7f8811862c380fe0e7ec057970c1d36ba81f2488a17a642f22761e7b70eddf0893d074b071e91d7145a7c546ba9b1ea2acbe99f21b438ad5e39
+  data.tar.gz: 7bc7982aae185cfd68e0a8c6d11f92068338571af615fcf9c985194e100041f3463383f6f68eb13f6ff65fefa307a581f4b08f091e7b5c4550681a7bbe4a8b57

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Eric Boehs
+
+MIT License
+
+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,28 @@
+# Nest Away
+
+This does one thing. It sets your status to away or home.
+
+## Usage
+
+Create the client:
+```ruby
+require 'nest_away'
+nest = NestAway::Client.new(email: 'joe@example.com', password: 'hunter2')
+```
+
+Change the away status:
+```ruby
+nest.away? # => false
+nest.home? # => true
+
+nest.away! # => {status: 'away'}
+nest.home! # => {status: 'home'}
+```
+
+## Why?
+
+As Nest expands its product line, and since they all tie into the idea of people being away/home, I thought it would be useful to have a small, effective API wrapper that did one thing well.
+
+A possible use-case is to use IFTTT to make a recipe with the Alexa and Maker channels that will send this gem a request on Amazon's Lambda service.
+
+Saying "Alexa, trigger Home" would send an HTTP request to Lambda using Maker which will trigger Lambda to run some code that instantiates a client that runs the `Client#home!` method.

data/lib/nest_away.rb

@@ -0,0 +1,2 @@
+require "nest_away/version"
+require "nest_away/nest"

data/lib/nest_away/nest.rb

@@ -0,0 +1,103 @@
+require 'rubygems'
+require 'httparty'
+require 'json'
+require 'uri'
+
+module NestAway
+  class Client
+    attr_accessor :login_url, :user_agent, :auth, :login, :token, :user_id,
+      :transport_url, :transport_host, :headers
+
+    def initialize(email:,
+                   password:,
+                   login_url: 'https://home.nest.com/user/login',
+                   user_agent: 'Nest/1.1.0.10 CFNetwork/548.0.4')
+
+      @login_url  = login_url
+      @user_agent = user_agent
+
+      # populates @auth variable
+      login(email: email, password: password)
+
+      @token          = auth["access_token"]
+      @user_id        = auth["userid"]
+      @transport_url  = auth["urls"]["transport_url"]
+      @transport_host = URI.parse(transport_url).host
+      @headers = {
+        'Host'                  => transport_host,
+        'User-Agent'            => user_agent,
+        'Authorization'         => 'Basic ' + token,
+        'X-nl-user-id'          => user_id,
+        'X-nl-protocol-version' => '1',
+        'Accept-Language'       => 'en-us',
+        'Connection'            => 'keep-alive',
+        'Accept'                => '*/*'
+      }
+    end
+
+    def status
+      request = get(url: "#{transport_url}/v2/mobile/user.#{user_id}", headers: headers)
+      JSON.parse(request.body) if request
+    end
+
+    def away?
+      status["structure"][structure_id]["away"]
+    end
+
+    def home?
+      !away?
+    end
+
+    def home!
+      self.away = false
+      { status: 'home', timestamp: Time.now }
+    end
+
+    def away!
+      self.away = true
+      { status: 'away', timestamp: Time.now }
+    end
+
+    def structure_id
+      @structure_id ||= status['user'][user_id]['structures'][0].split('.')[1]
+    end
+
+    private
+
+    def away=(state)
+      post(
+        url: "#{transport_url}/v2/put/structure.#{structure_id}",
+        body: %Q({"away_timestamp":#{Time.now.to_i},"away":#{!!state},"away_setter":0}),
+        headers: headers
+      )
+    end
+
+    def login(email:, password:)
+      request = post(
+        url: login_url,
+        body: { username: email, password: password },
+        headers: { 'User-Agent' => user_agent }
+      )
+      @auth = JSON.parse(request.body)
+      raise 'Invalid login credentials' if auth.key?('error') && @auth['error'] == "access_denied"
+    end
+
+    def post(url:, body:, headers:)
+      begin
+        HTTParty.post(url, body: body, headers: headers)
+      rescue => e
+        puts "ERROR: Method #{__METHOD__}, #{e.message}"
+        raise e
+      end
+    end
+
+    def get(url:, headers:)
+      begin
+        HTTParty.get(url, headers: headers)
+      rescue => e
+        puts "ERROR: Method #{__METHOD__}, #{e.message}"
+        raise e
+      end
+    end
+  end
+end

data/lib/nest_away/version.rb

@@ -0,0 +1,3 @@
+module NestAway
+  VERSION = "0.1.0"
+end

data/nest_away.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/nest_away/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Alex Flores"]
+  gem.email         = ["virtualsnyper@gmail.com"]
+  gem.description   = %q{Control your nest away status}
+  gem.summary       = %q{Set away status for your Nest account}
+  gem.homepage      = "http://github.com/audibleblink/nest_away"
+
+  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_away"
+  gem.require_paths = ["lib"]
+  gem.version       = NestAway::VERSION
+  gem.add_dependency "httparty", "~> 0.8.3"
+
+  gem.add_development_dependency "rspec", "~> 3.1"
+  gem.add_development_dependency "dotenv"
+  gem.add_development_dependency "pry"
+end

data/spec/nest_away_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+module NestAway
+  describe Client do
+    let(:nest) { Client.new(email: ENV['NEST_EMAIL'], password: ENV['NEST_PASS']) }
+
+    it "logs in to home.nest.com" do
+      expect(nest.transport_url).to match(/transport\.(home\.)?nest\.com/)
+    end
+
+    it "detects invalid logins" do
+      expect {
+        Client.new(email: 'invalid@example.com', password: 'asdf')
+      }.to raise_error
+    end
+
+    it "detects empty logins" do
+      expect { Client.new() }.to raise_error
+    end
+
+    it "gets the status" do
+      expect(nest.status).to be_truthy
+    end
+
+    it "gets away status" do
+      expect(nest.away?).to_not be_nil
+    end
+
+    it "sets statuses" do
+      if nest.home?
+        expect { nest.away! }.to change { nest.away? }.from(false).to(true)
+      else
+        expect { nest.home! }.to change { nest.home? }.from(false).to(true)
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'nest_away'
+require 'dotenv'
+require 'pry'
+
+Dotenv.load
+
+RSpec.configure do |c|
+  c.filter_run focus: true
+  c.run_all_when_everything_filtered = true
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: nest_away
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Flores
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Control your nest away status
+email:
+- virtualsnyper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE
+- README.md
+- lib/nest_away.rb
+- lib/nest_away/nest.rb
+- lib/nest_away/version.rb
+- nest_away.gemspec
+- spec/nest_away_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/audibleblink/nest_away
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Set away status for your Nest account
+test_files:
+- spec/nest_away_spec.rb
+- spec/spec_helper.rb
+has_rdoc: