nest_wrapper 0.0.1 → 0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: f56eae8b23e437dbd960007dc08d80bf33da206c
4
- data.tar.gz: 9308a37150281ed46adb713a5a3c6b761a1086f7
3
+ metadata.gz: e2080b6b21e705199c1988097d4d0226dea1e628
4
+ data.tar.gz: 3fb1f4cc7f19b28192e133a512056a5653ecf9c1
5
5
  SHA512:
6
- metadata.gz: b13cec18e4ad74073c2898898e1bdca6835492bba5175ca7bcfeeedacdd4d1b5bf9be12ca5d7994d0554f6488c557020772a02b4f937ede629bc3929e5841987
7
- data.tar.gz: c992864a2477e3f70acbf51a81c93454a35181695d1f131ca7ce134bcdb44051bba44b8b27e5dd9e33f3a8e824062344ea15d7ea2aa64dc7bee3fb68caae8462
6
+ metadata.gz: 73b22e9a38200e508c150ee4385a0d177c5a8986674dc12dec087666853e23b37f0b11c7321b25973407260dabd3cb1780d14e048dea66a70f85d414d8162bc7
7
+ data.tar.gz: ef88c6d4cb2c7228db7d62d35434568531cc87e81491f8bd4d173ac86af37d93c6c79928b49961ae6036accc411f208c74d04e301c4c55ac374e82ac1c1cacd1
data/README.md CHANGED
@@ -1,24 +1,59 @@
1
1
  # NestWrapper
2
2
 
3
+ _This is currently under development._
4
+
3
5
  A wrapper for the `nest_thermostat` gem. So, a wrapper that wraps a wrapper.
4
6
 
5
7
  ## Installation
6
8
 
7
9
  Add this line to your application's Gemfile:
8
10
 
9
- gem 'nest_wrapper'
11
+ ```ruby
12
+ gem 'nest_wrapper'
13
+ ```
10
14
 
11
15
  And then execute:
12
16
 
13
- $ bundle
17
+ ```bash
18
+ $ bundle
19
+ ```
14
20
 
15
21
  Or install it yourself as:
16
22
 
17
- $ gem install nest_wrapper
23
+ ```bash
24
+ $ gem install nest_wrapper
25
+ ```
18
26
 
19
27
  ## Usage
20
28
 
21
- TODO: Write usage instructions here
29
+ ### Login to the API with your credentials:
30
+
31
+ ```ruby
32
+ NestWrapper.login ENV['NEST_EMAIL'], ENV['NEST_PASSWORD']
33
+ ```
34
+
35
+ ### Get status information:
36
+
37
+ ```ruby
38
+ state = NestWrapper.device.state
39
+ state.temp # => 'Set Temperature'
40
+ state.curr_temp # => 'Current Temperature'
41
+ state.away # => true || false
42
+ state.leaf # => true || false
43
+ state.humidity # => 'Humidity'
44
+
45
+ # etc.
46
+ ```
47
+
48
+ ### Get device information:
49
+
50
+ ```ruby
51
+ device = NestWrapper.device
52
+ device.name # => 'Name of nest device'
53
+ device.zip # => 'ZIP'
54
+ device.country # => 'COUNTRY'
55
+ device.config_data # => { blob: :of_data }
56
+ ```
22
57
 
23
58
  ## Contributing
24
59
 
@@ -1,3 +1,3 @@
1
1
  module NestWrapper
2
- VERSION = "0.0.1"
2
+ VERSION = "0.0.2"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: nest_wrapper
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.1
4
+ version: 0.0.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - John Otander
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2014-04-19 00:00:00.000000000 Z
11
+ date: 2014-05-19 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: nest_thermostat
@@ -111,3 +111,4 @@ specification_version: 4
111
111
  summary: A wrapper to a wrapper for the nest thermostat API.
112
112
  test_files:
113
113
  - spec/spec_helper.rb
114
+ has_rdoc: