ruby_hue 0.0.1 → 0.1.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0
+
+* First official version

data/README.md

@@ -1,6 +1,8 @@
 # RubyHue
 
-TODO: Write a gem description
+RubyHue is a library to interact with Hue lights.
+
+http://meethue.com/
 
 ## Installation
 
@@ -18,7 +20,54 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+RubyHue starts mostly at the Bridge class.
+
+```ruby
+bridge = RubyHue::Bridge.new("192.168.1.100", "yourbridgeusername")
+```
+
+To get all lights for the bridge:
+
+```ruby
+bridge = RubyHue::Bridge.new("192.168.1.100", "yourbridgeusername")
+lights = bridge.lights
+
+lights.state.on = true
+lights.state.save # This will turn on all lights on the bridge
+```
+
+### Light Usage
+
+RubyHue comes with a Light class that you initialize with an ID and Bridge instance. Most interactions will happen with an instance of this class.
+
+```ruby
+bridge = RubyHue::Bridge.new("192.168.1.100", "yourbridgeusername")
+light = RubyHue::Light.new("1", bridge)
+```
+
+Now you're ready to ask for the current state of the light (on, brightness, hue, etc...)
+
+```ruby
+light = RubyHue::Light.new("1", bridge)
+light.state.brightness
+# => 50
+
+light.state.brightness = 255
+light.state.save
+#=> [{"success"=>{"/lights/1/state/bri"=>255}}, ....
+```
+
+Here's the list of states you can change:
+
+* `on` (true, false)
+* `brightness` (0..255)
+* `hue` (0..65535)
+* `saturation` (0..255)
+* `xy` See http://developers.meethue.com/coreconcepts.html#color_gets_more_complicated
+* `color_temperature`
+* `alert` ("none", "select", "lselect")
+* `effect` ("none", "colorloop")
+
 
 ## Contributing
 

data/lib/ruby_hue.rb

@@ -1,13 +1,13 @@
 require "ruby_hue/version"
-require "ruby_hue/client"
-require "ruby_hue/configuration"
-require "ruby_hue/model"
-require "ruby_hue/light"
-require "ruby_hue/light/state"
-require "ruby_hue/bridge"
 
 module RubyHue
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
+  autoload :Client, "ruby_hue/client"
+  autoload :Bridge, "ruby_hue/bridge"
+  autoload :Model, "ruby_hue/model"
+  autoload :Light, "ruby_hue/light"
+  autoload :LightsCollection, "ruby_hue/lights_collection"
+  autoload :LightsCollectionState, "ruby_hue/lights_collection_state"
 end
+
+require "ruby_hue/light/basic_state"
+require "ruby_hue/light/state"

data/lib/ruby_hue/bridge.rb

@@ -1,6 +1,7 @@
 module RubyHue
   class Bridge
-    attr_reader :ip_address, :username
+    attr_reader :ip_address
+    attr_accessor :username
 
     class << self
       def all
@@ -20,9 +21,7 @@ module RubyHue
     end
 
     def lights
-      Client.get_and_parse(resource_url_for("lights")).map do |id, light|
-        RubyHue::Light.new(id, self)
-      end
+      @lights ||= LightsCollection.new(self)
     end
   end
 end

data/lib/ruby_hue/light/basic_state.rb

@@ -0,0 +1,45 @@
+module RubyHue
+  class Light
+    module BasicState
+      MAPPING = {
+        on: :on,
+        bri: :brightness,
+        hue: :hue,
+        sat: :saturation,
+        xy: :xy,
+        ct: :color_temperature,
+        alert: :alert,
+        effect: :effect,
+        colormode: :color_mode,
+        reachable: :reachable
+      }
+
+      IMMUTABLE_KEYS = %w(colormode reachable)
+
+      attr_writer :state
+
+      def updateable_state
+        state.reject do |key, value|
+          IMMUTABLE_KEYS.include? key
+        end
+      end
+
+      def state
+        @state ||= {}
+      end
+
+      MAPPING.each do |hue_key, method_name|
+        hue_key = hue_key.to_s
+        define_method method_name do
+          state[hue_key]
+        end
+
+        unless IMMUTABLE_KEYS.include?(hue_key)
+          define_method "#{method_name}=".to_sym do |new_value|
+            state[hue_key] = new_value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ruby_hue/light/state.rb

@@ -3,22 +3,7 @@ require "json"
 module RubyHue
   class Light
     class State
-      MAPPING = {
-        on: :on,
-        bri: :brightness,
-        hue: :hue,
-        sat: :saturation,
-        xy: :xy,
-        ct: :color_temperature,
-        alert: :alert,
-        effect: :effect,
-        colormode: :color_mode,
-        reachable: :reachable
-      }
-
-      IMMUTABLE_KEYS = %w(colormode reachable)
-
-      attr_writer :state
+      include BasicState
       attr_reader :light
 
       def initialize(light, state)
@@ -26,10 +11,6 @@ module RubyHue
         @state = state
       end
 
-      def state
-        @state ||= {}
-      end
-
       def save
         url = bridge.resource_url_for("lights/#{light.id}/state")
         body = JSON.generate updateable_state
@@ -39,25 +20,6 @@ module RubyHue
       def bridge
         light.bridge
       end
-
-      def updateable_state
-        @state.reject do |key, value|
-          IMMUTABLE_KEYS.include? key
-        end
-      end
-
-      MAPPING.each do |hue_key, method_name|
-        hue_key = hue_key.to_s
-        define_method method_name do
-          @state[hue_key]
-        end
-
-        unless IMMUTABLE_KEYS.include?(hue_key)
-          define_method "#{method_name}=".to_sym do |new_value|
-            @state[hue_key] = new_value
-          end
-        end
-      end
     end
   end
 end

data/lib/ruby_hue/lights_collection.rb

@@ -0,0 +1,27 @@
+module RubyHue
+  class LightsCollection
+    include Enumerable
+
+    attr_reader :bridge
+
+    def initialize(bridge)
+      @bridge = bridge
+    end
+
+    def lights
+      Client.get_and_parse(bridge.resource_url_for("lights")).map do |id, light|
+        RubyHue::Light.new(id, self)
+      end
+    end
+
+    def state
+      @state ||= LightsCollectionState.new(self)
+    end
+
+    def each(&block)
+      lights.each do |light|
+        yield light
+      end
+    end
+  end
+end

data/lib/ruby_hue/lights_collection_state.rb

@@ -0,0 +1,23 @@
+module RubyHue
+  class LightsCollectionState
+    include Light::BasicState
+
+    attr_reader :collection
+
+    def initialize(collection)
+      @collection = collection
+    end
+
+    def bridge
+      collection.bridge
+    end
+
+    def save
+      collection.each do |light|
+        url = bridge.resource_url_for("lights/#{light.id}/state")
+        body = JSON.generate updateable_state
+        Client.put_and_parse(url, body: body)
+      end
+    end
+  end
+end

data/lib/ruby_hue/version.rb

@@ -1,3 +1,3 @@
 module RubyHue
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/spec/ruby_hue/bridge_spec.rb

@@ -35,13 +35,8 @@ describe RubyHue::Bridge do
   end
 
   describe "#lights" do
-    before do
-      stub_request(:get, subject.resource_url_for("lights")).to_return(body: fixture("lights.json"))
-    end
-
-    it "returns a collection of light objects" do
-      RubyHue::Light.should_receive(:new).with(kind_of(String), kind_of(RubyHue::Bridge)).exactly(3).times
-      bridge.lights
+    it "returns a light collection" do
+      expect(bridge.lights).to be_kind_of RubyHue::LightsCollection
     end
   end
 end

data/spec/ruby_hue/light/state_spec.rb

@@ -10,6 +10,8 @@ describe RubyHue::Light::State do
       to_return(body: fixture("light_1.json"))
   end
 
+  it_behaves_like "basic state"
+
   describe "#initialize" do
     let(:instance) { described_class.new(light, state_hash) }
 
@@ -28,23 +30,6 @@ describe RubyHue::Light::State do
     end
   end
 
-  describe "getter methods" do
-    let(:method_mapping) { method_mapping = described_class::MAPPING }
-
-    it "responds to all keys available for a state" do
-      method_mapping.each do |hue_key, ruby_hue_method|
-        expect(subject.state).to have_key hue_key.to_s
-        expect(subject).to respond_to ruby_hue_method
-      end
-    end
-
-    it "returns the value for a state" do
-      method_mapping.each do |hue_key, ruby_hue_method|
-        expect(subject.send(ruby_hue_method)).to eq(subject.state[hue_key.to_s])
-      end
-    end
-  end
-
   describe "#save" do
     let!(:state_request_stub) do
       stub_request(:put, bridge.resource_url_for("lights/#{light.id}/state")).to_return(body: "{}")
@@ -55,12 +40,4 @@ describe RubyHue::Light::State do
       expect(state_request_stub).to have_been_requested
     end
   end
-
-  describe "#updateable_state" do
-    it "does not include immutable values" do
-      described_class::IMMUTABLE_KEYS.each do |key|
-        expect(subject.updateable_state.keys).not_to include key
-      end
-    end
-  end
 end

data/spec/ruby_hue/lights_collection_spec.rb

@@ -0,0 +1,36 @@
+require "spec_helper"
+
+describe RubyHue::LightsCollection do
+  let(:bridge) { RubyHue::Bridge.new("127.0.0.1", "username") }
+  subject { described_class.new(bridge) }
+
+  describe "#initialize" do
+    it "accepts a bridge" do
+      expect { described_class.new(bridge) }.to_not raise_error
+    end
+  end
+
+  describe "#lights" do
+    before do
+      stub_request(:get, bridge.resource_url_for("lights")).to_return(body: fixture("lights.json"))
+    end
+
+    it "returns 3 light objects" do
+      expect(subject).to have(3).lights
+    end
+  end
+
+  describe "#state" do
+    it "returns a collection state object" do
+      expect(subject.state).to be_kind_of RubyHue::LightsCollectionState
+    end
+  end
+
+  describe "#each" do
+    before { subject.stub(lights: [RubyHue::Light.new(1, bridge)]) }
+
+    it "yields a light object" do
+      expect {|b| subject.each(&b) }.to yield_with_args(kind_of(RubyHue::Light))
+    end
+  end
+end

data/spec/ruby_hue/lights_collection_state_spec.rb

@@ -0,0 +1,23 @@
+require "spec_helper"
+
+describe RubyHue::LightsCollectionState do
+  let(:bridge) { RubyHue::Bridge.new("127.0.0.1", "username") }
+  let(:light_collection) { RubyHue::LightsCollection.new(bridge) }
+  subject { described_class.new(light_collection) }
+
+  it_behaves_like "basic state"
+
+  describe "#save" do
+    let(:light) { double("light", id: 1) }
+    let!(:state_request_stub) do
+      stub_request(:put, bridge.resource_url_for("lights/#{light.id}/state")).to_return(body: "{}")
+    end
+
+    it "changes the state for all of the lights" do
+      light_collection.stub(lights: [light])
+      subject.on = true
+      subject.save
+      expect(state_request_stub).to have_been_requested
+    end
+  end
+end

data/spec/support/behavior/state_examples.rb

@@ -0,0 +1,25 @@
+shared_examples_for "basic state" do
+  describe "getter methods" do
+    let(:method_mapping) { method_mapping = RubyHue::Light::BasicState::MAPPING }
+
+    it "responds to all keys available for a state" do
+      method_mapping.each do |hue_key, ruby_hue_method|
+        expect(subject).to respond_to ruby_hue_method
+      end
+    end
+
+    it "returns the value for a state" do
+      method_mapping.each do |hue_key, ruby_hue_method|
+        expect(subject.send(ruby_hue_method)).to eq(subject.state[hue_key.to_s])
+      end
+    end
+  end
+
+  describe "#updateable_state" do
+    it "does not include immutable values" do
+      RubyHue::Light::BasicState::IMMUTABLE_KEYS.each do |key|
+        expect(subject.updateable_state.keys).not_to include key
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_hue
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-31 00:00:00.000000000 Z
+date: 2013-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -132,6 +132,7 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -140,9 +141,11 @@ files:
 - lib/ruby_hue.rb
 - lib/ruby_hue/bridge.rb
 - lib/ruby_hue/client.rb
-- lib/ruby_hue/configuration.rb
 - lib/ruby_hue/light.rb
+- lib/ruby_hue/light/basic_state.rb
 - lib/ruby_hue/light/state.rb
+- lib/ruby_hue/lights_collection.rb
+- lib/ruby_hue/lights_collection_state.rb
 - lib/ruby_hue/model.rb
 - lib/ruby_hue/version.rb
 - ruby_hue.gemspec
@@ -152,12 +155,13 @@ files:
 - spec/fixtures/responses/lights.json
 - spec/ruby_hue/bridge_spec.rb
 - spec/ruby_hue/client_spec.rb
-- spec/ruby_hue/configuration_spec.rb
 - spec/ruby_hue/light/state_spec.rb
 - spec/ruby_hue/light_spec.rb
+- spec/ruby_hue/lights_collection_spec.rb
+- spec/ruby_hue/lights_collection_state_spec.rb
 - spec/ruby_hue/model_spec.rb
-- spec/ruby_hue/ruby_hue_spec.rb
 - spec/spec_helper.rb
+- spec/support/behavior/state_examples.rb
 - spec/support/complete_hue_model.rb
 - spec/support/fixture_helpers.rb
 - spec/support/light_bridge_helpers.rb
@@ -192,12 +196,13 @@ test_files:
 - spec/fixtures/responses/lights.json
 - spec/ruby_hue/bridge_spec.rb
 - spec/ruby_hue/client_spec.rb
-- spec/ruby_hue/configuration_spec.rb
 - spec/ruby_hue/light/state_spec.rb
 - spec/ruby_hue/light_spec.rb
+- spec/ruby_hue/lights_collection_spec.rb
+- spec/ruby_hue/lights_collection_state_spec.rb
 - spec/ruby_hue/model_spec.rb
-- spec/ruby_hue/ruby_hue_spec.rb
 - spec/spec_helper.rb
+- spec/support/behavior/state_examples.rb
 - spec/support/complete_hue_model.rb
 - spec/support/fixture_helpers.rb
 - spec/support/light_bridge_helpers.rb

data/lib/ruby_hue/configuration.rb

@@ -1,5 +0,0 @@
-module RubyHue
-  class Configuration
-    attr_accessor :bridge_ip, :api_username
-  end
-end

data/spec/ruby_hue/configuration_spec.rb

@@ -1,13 +0,0 @@
-require "spec_helper"
-
-describe RubyHue::Configuration do
-  it "has a bridge_ip" do
-    expect(subject).to respond_to :bridge_ip
-    expect(subject).to respond_to :bridge_ip=
-  end
-
-  it "has a api_username" do
-    expect(subject).to respond_to :api_username
-    expect(subject).to respond_to :api_username=
-  end
-end

data/spec/ruby_hue/ruby_hue_spec.rb

@@ -1,9 +0,0 @@
-require "spec_helper"
-
-describe RubyHue do
-  describe ".configure" do
-    it "returns a configuration object" do
-      expect(RubyHue.configuration).to be_kind_of RubyHue::Configuration
-    end
-  end
-end