philips_hue 0.1.3 → 0.1.4

data/README.md

@@ -4,7 +4,7 @@ This is a library for accessing and controlling your [Philips Hue](http://www.me
 
 #### TL;DR:
 
-Check out [bin/example_script.rb](https://github.com/dmerrick/lights_app/blob/master/bin/example_script.rb) for an example of how to use this project and what kind of things you can do.
+[Check out the bin/ directory for examples](https://github.com/dmerrick/lights_app/tree/master/bin) of how to use this project and what kind of things you can do.
 
 
 ### Registering with the Bridge
@@ -60,6 +60,7 @@ Some helper methods, including default color options, are provided. For example:
 
 
 ### See Also
+* [RubyGems homepage for this project](https://rubygems.org/gems/philips_hue)
 * [Official Philips Hue site](https://www.meethue.com/en-US)
 * [My original gist](https://gist.github.com/dmerrick/5000839)
 * [rsmck's hacking guide](http://rsmck.co.uk/hue)

data/bin/all_off.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+require 'rubygems'
 require 'philips_hue'
 
 hue = PhilipsHue::Bridge.new("lightsapp", "192.168.1.14")

data/bin/all_on.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+require 'rubygems'
 require 'philips_hue'
 
 hue = PhilipsHue::Bridge.new("lightsapp", "192.168.1.14")

data/bin/flash.rb

@@ -1,6 +1,7 @@
 #!/usr/bin/env ruby
 # example: flash.rb -l 3 -t 5 -c red -n 3
 
+require 'rubygems'
 require 'ostruct'
 require 'optparse'
 require 'philips_hue'

data/bin/{example_script.rb → light_show.rb}

@@ -1,11 +1,8 @@
 #!/usr/bin/env ruby
-# this is a basic example of what you can do with this library
+require 'rubygems'
 require 'philips_hue'
 
-# set up your hue app here
 hue = PhilipsHue::Bridge.new("lightsapp", "192.168.1.14")
-
-# assign each light to a variable
 light1, light2, light3 = hue.lights
 
 # print status of light1

data/bin/sandbox.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+require 'rubygems'
 require 'pp'
 require 'awesome_print'
 require 'pry'

data/bin/{test_script.rb → test.rb}

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-
 require 'rubygems'
 require 'philips_hue'
 

data/lib/philips_hue/bridge.rb

@@ -1,18 +1,19 @@
 module PhilipsHue
   class Bridge
 
-    # creates a new app to talk to a Philips Hue
+    # creates an app through which to talk to a Philips Hue
+    # (new app names must be registered with the bridge)
     #   app_name is used to register with the Hue
-    #   api_url is the hostname/IP address of the Hue hockeypuck
+    #   api_url is the hostname/IP address of the bridge
     def initialize(app_name, api_url)
-      @name = app_name
-      @key = Digest::MD5.hexdigest(@name)
+      @app_name = app_name
+      @key = Digest::MD5.hexdigest(@app_name)
       @api_endpoint = "http://#{api_url}/api"
       @lights = add_all_lights
     end
 
     # provide getter methods for these variables
-    attr_reader :name, :key, :api_endpoint, :lights
+    attr_reader :app_name, :key, :api_endpoint, :lights
 
     # returns overall system status as JSON
     def overview
@@ -36,7 +37,7 @@ module PhilipsHue
     def register!
       puts "Press the link button on the Hue..."
       sleep 10
-      json_body = {:username => @key, :devicetype => @name}.to_json
+      json_body = {:username => @key, :devicetype => @app_name}.to_json
       response = HTTParty.post(@api_endpoint, :body => json_body)
 
       if response.first["error"] # should be response.code

data/lib/philips_hue/light.rb

@@ -3,14 +3,17 @@ module PhilipsHue
 
     def initialize(light_name, light_id, api_endpoint, key)
       @name = light_name
-      @id = light_id
-      @api_endpoint = api_endpoint
+      @light_id = light_id
       @key = key
+      @api_endpoint = api_endpoint
     end
 
+    # provide getter methods for these variables
+    attr_reader :name, :light_id
+
     # query full status for single light
     def status
-      request_uri = "#{@api_endpoint}/#{@key}/lights/#{@id}"
+      request_uri = "#{@api_endpoint}/#{@key}/lights/#{@light_id}"
       HTTParty.get(request_uri)
     end
 
@@ -18,7 +21,7 @@ module PhilipsHue
     # note that colormode will automagically update
     def set(options)
       json_body = options.to_json
-      request_uri = "#{@api_endpoint}/#{@key}/lights/#{@id}/state"
+      request_uri = "#{@api_endpoint}/#{@key}/lights/#{@light_id}/state"
       HTTParty.put(request_uri, :body => json_body)
     end
 

data/lib/philips_hue/version.rb

@@ -1,3 +1,3 @@
 module PhilipsHue
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: philips_hue
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -40,10 +40,10 @@ files:
 - lib/philips_hue.rb
 - bin/all_off.rb
 - bin/all_on.rb
-- bin/example_script.rb
 - bin/flash.rb
+- bin/light_show.rb
 - bin/sandbox.rb
-- bin/test_script.rb
+- bin/test.rb
 - README.md
 homepage: https://github.com/dmerrick/lights_app
 licenses: []