hue-lib 0.5.0

data/lib/hue/config.rb

@@ -0,0 +1,94 @@
+module Hue
+  class Config
+    STRING_DEFAULT = 'default'
+    STRING_BASE_URI = 'base_uri'
+    STRING_IDENTIFIER = 'identifier'
+
+    require 'yaml'
+    require 'fileutils'
+
+    def self.bridges_config_path
+      File.join(ENV['HOME'], ".#{APP_NAME}", 'bridges.yml')
+    end
+
+    def self.default
+      named(STRING_DEFAULT)
+    end
+
+    def self.named(name)
+      yaml = read_file
+      if named_yaml = yaml[name]
+        Config.new(named_yaml[STRING_BASE_URI], named_yaml[STRING_IDENTIFIER], name)
+      else
+        raise Error.new("Config named '#{name}' not found.")
+      end
+    end
+
+    public
+
+    attr_reader :base_uri, :identifier, :name
+
+    def initialize(base_uri, identifier, name = STRING_DEFAULT)
+      @base_uri = base_uri
+      @identifier = identifier
+      @name = name
+    end
+
+    def write(config_file = self.class.bridges_config_path)
+      yaml = YAML.load_file(self.class.bridges_config_path) rescue Hash::New
+      if yaml.key?(name)
+        raise "Configuration named '#{name}' already exists in #{config_file}\nPlease de-register before creating a new one with the same name."
+      else
+        yaml[name] = {
+          STRING_BASE_URI => self.base_uri,
+          STRING_IDENTIFIER => identifier.force_encoding('ASCII') # Avoid binary encoded YAML
+        }
+        self.class.setup_config_path(config_file)
+        File.open(config_file, 'w+' ) do |out|
+          YAML.dump(yaml, out)
+        end
+      end
+    end
+
+    def delete
+      config_file = self.class.bridges_config_path
+      yaml = YAML.load_file(config_file) rescue Hash::New
+
+      if yaml.key?(name)
+        yaml.delete(name)
+      end
+
+      if yaml.size > 0
+        self.class.setup_config_path(config_file)
+        File.open(config_file, 'w+' ) do |out|
+          YAML.dump(yaml, out)
+        end
+      end
+    end
+
+    def ==(rhs)
+      lhs = self
+
+      lhs.class == rhs.class &&
+        lhs.name == rhs.name &&
+        lhs.base_uri == rhs.base_uri &&
+        lhs.identifier == rhs.identifier
+    end
+
+    private
+
+    def self.setup_config_path(path)
+      dir = File.dirname(path)
+      FileUtils.mkdir_p(dir) unless Dir.exists?(dir)
+    end
+
+    def self.read_file(config_file = bridges_config_path)
+      begin
+        yaml = YAML.load_file(config_file)
+      rescue => err
+        raise Error.new("Failed to read configuration file", err)
+      end
+    end
+
+  end
+end

data/spec/config/bridges.yml

@@ -0,0 +1,4 @@
+---
+default:
+  base_uri: http://localhost/api
+  identifier: test_identifier

data/spec/hue/bridge_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper.rb'
+
+describe Hue::Bridge do
+
+  def self.klass
+    Hue::Bridge
+  end
+
+  def klass
+    self.class.klass
+  end
+
+  # it 'should acts as a singleton and give access to the instance' do
+  #   klass.instance.should be_a_kind_of(Hue::Bridge)
+  # end
+
+  it 'should allow registering a new bridge' do
+    pending
+  end
+
+  it 'should allow un-registering a bridge' do
+    pending
+  end
+
+  context 'when instantiated with a given config' do
+    bridge = klass.new
+
+    # before(:each) do
+    #   with_fake_index_request
+    # end
+
+    it 'should report the bridge status' do
+      with_fake_request_base
+      bridge.status.should == api_reply(:base)
+    end
+
+    it 'should report errors' do
+      with_fake_request(:lights, :unauthorized)
+      lambda do
+        bridge.lights
+      end.should raise_error(Hue::API::Error, 'unauthorized user')
+    end
+
+    it 'should report the bridge lights' do
+      with_fake_request(:lights)
+      bridge.lights.should == api_reply(:lights)
+    end
+
+    it 'should report a simple string of light names' do
+      with_fake_request(:lights)
+      bridge.light_names.should == "1. Dining\n2. Bedroom Far\n3. Bedroom Near"
+    end
+
+    it 'should report the bridge config' do
+      with_fake_request(:config)
+      bridge.config.should == api_reply(:config)
+    end
+
+    it 'should report the light schedules' do
+      with_fake_request(:schedules)
+      bridge.schedules.should == api_reply(:schedules)
+    end
+
+    it 'should return instance of all the bulbs' do
+      with_fake_request(:lights)
+      bulbs = bridge.bulbs
+      bulbs.size.should == 3
+      bulbs.each do |bulb|
+        bulb.should be_a(Hue::Bulb)
+      end
+    end
+
+  end
+
+end

data/spec/hue/bulb_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper.rb'
+
+describe Hue::Bulb do
+
+  def self.klass
+    Hue::Bulb
+  end
+
+  def klass
+    self.class.klass
+  end
+
+  context 'when instantiated with a given bridge and id' do
+    bulb = klass.new(Hue::Bridge.new, 1)
+
+    before(:all) do
+      with_fake_request('lights/1')
+      @test_status = api_reply('lights/1')
+    end
+
+    it 'should report the bulb state' do
+      bulb.state.should == @test_status['state']
+    end
+
+    it 'should report the bulb info' do
+      info = api_reply('lights/1')
+      info.delete('state')
+      info.delete('pointsymbol')
+      bulb.info.should == info
+    end
+
+    it "should report it's name" do
+      bulb.name.should == @test_status['name']
+    end
+
+    it "should report if it's on" do
+      bulb.on?.should be_false
+    end
+
+    it "should report if it's off" do
+      bulb.off?.should be_true
+    end
+
+    it "should report the hue, brightness and saturation" do
+      bulb.hue.should == 13234
+      bulb.brightness.should == 146
+      bulb.bri.should == 146
+      bulb.saturation.should == 208
+      bulb.sat.should == bulb.saturation
+    end
+
+    it "should report the color temperature and color mode" do
+      bulb.color_temperature.should == 459
+      bulb.ct.should == bulb.color_temperature
+      bulb.color_mode.should == 'ct'
+      bulb.color_mode.should == bulb.colormode
+    end
+
+    it "should report the alert state" do
+      bulb.blinking?.should be_false
+      bulb.solid?.should be_true
+    end
+
+    context 'by changing state' do
+
+      it 'should allow turning bulps on and off' do
+        with_fake_update('lights/1/state', on: true)
+        bulb.on.should be_true
+
+        with_fake_update('lights/1/state', on: false)
+        bulb.off.should be_true
+      end
+
+      it 'should allow setting hue, saturation and brightness' do
+        with_fake_update('lights/1/state', hue: 21845)
+        bulb.hue = 120
+        bulb.hue.should == 21845
+
+        with_fake_update('lights/1/state', sat: 1293)
+        bulb.saturation = 1293
+        bulb.saturation.should == 1293
+
+        with_fake_update('lights/1/state', bri: 233)
+        bulb.brightness = 233
+        bulb.brightness.should == 233
+      end
+
+      it 'should allow setting blink, solid and flash alerts' do
+        with_fake_update('lights/1/state', alert: 'lselect')
+        bulb.blink
+        bulb.blinking?.should be_true
+
+        with_fake_update('lights/1/state', alert: 'none')
+        bulb.solid
+        bulb.solid?.should be_true
+
+        with_fake_update('lights/1/state', alert: 'select') do
+          with_fake_update('lights/1/state', alert: 'none')
+          bulb.flash
+          bulb.solid?.should be_true
+        end
+      end
+
+    end
+
+  end
+end

data/spec/hue/config_spec.rb

@@ -0,0 +1,65 @@
+require 'spec_helper.rb'
+
+describe Hue::Config do
+
+  TEST_IDENTIFIER = 'test_identifier'
+
+  def self.klass
+    Hue::Config
+  end
+
+  def klass
+    self.class.klass
+  end
+
+  after(:all) do
+    File.open(TEST_BRIDGE_CONFIG_PATH, 'w' ) do |out|
+      YAML.dump(TEST_BRIDGE_CONFIG, out)
+    end
+  end
+
+  it 'should report the bridge config file location' do
+    klass.bridges_config_path.should == TEST_BRIDGE_CONFIG_PATH
+  end
+
+  it "should throw and error if a named config doesn't exist" do
+    lambda do
+      klass.named('not_default')
+    end.should raise_error(Hue::Error, /Config named (.*) not found/)
+  end
+
+  context 'with a bridge config file, containing the default bridge' do
+    it "should give the default config and report it's values" do
+      config = klass.default
+      config.name == klass::STRING_DEFAULT
+      config.base_uri == TEST_BRIDGE_CONFIG[config.name][klass::STRING_BASE_URI]
+      config.identifier == TEST_BRIDGE_CONFIG[config.name][klass::STRING_IDENTIFIER]
+    end
+  end
+
+  context 'given an new config' do
+    config = klass.new('http://someip/api', 'some_id', 'not_default')
+
+    it 'should report the values' do
+      config.name == 'not_default'
+      config.base_uri == 'http://someip/api'
+      config.identifier == 'not_default'
+    end
+
+    it 'should allow writing the new config to file' do
+      config.write
+      YAML.load_file(klass.bridges_config_path)['not_default'].should be_a(Hash)
+    end
+
+    it 'should allow fetching that name config' do
+      named_config = klass.named('not_default')
+      named_config.should == config
+    end
+
+    it 'should allow deleting that named config from the file' do
+      config.delete
+      YAML.load_file(klass.bridges_config_path)['not_default'].should be_nil
+    end
+  end
+
+end

data/spec/hue_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper.rb'
+
+describe Hue do
+
+  it 'should report the device type as itself' do
+    Hue.device_type.should == Hue::DEVICE_TYPE
+  end
+
+  it 'should return the default config' do
+    Hue.config.should be_a(Hue::Config)
+  end
+
+end

data/spec/json/base.json

@@ -0,0 +1,117 @@
+{ 
+  "lights" : { 
+    "1" : { 
+      "state" : { 
+        "on" : false,
+        "bri" : 146,
+        "hue" : 13234,
+        "sat" : 208,
+        "xy" : [ "0.5090", "0.4149" ],
+        "ct" : 459,
+        "alert" : "none",
+        "effect" : "none",
+        "colormode" : "ct",
+        "reachable" : true
+      },
+      "type" : "Extended color light",
+      "name" : "Living",
+      "modelid" : "LCT001",
+      "swversion" : "65003148",
+      "pointsymbol" : { 
+        "1" : "none",
+        "2" : "none",
+        "3" : "none",
+        "4" : "none",
+        "5" : "none",
+        "6" : "none",
+        "7" : "none",
+        "8" : "none"
+      }
+    },
+    "2" : { 
+      "state" : { 
+        "on" : false,
+        "bri" : 162,
+        "hue" : 2213,
+        "sat" : 238,
+        "xy" : [ "0.6349", "0.3413" ],
+        "ct" : 500,
+        "alert" : "none",
+        "effect" : "none",
+        "colormode" : "xy",
+        "reachable" : true
+      },
+      "type" : "Extended color light",
+      "name" : "Bedroom Far",
+      "modelid" : "LCT001",
+      "swversion" : "65003148",
+      "pointsymbol" : { 
+        "1" : "none",
+        "2" : "none",
+        "3" : "none",
+        "4" : "none",
+        "5" : "none",
+        "6" : "none",
+        "7" : "none",
+        "8" : "none"
+      }
+    },
+    "3" : { 
+      "state" : { 
+        "on" : false,
+        "bri" : 146,
+        "hue" : 13122,
+        "sat" : 211,
+        "xy" : [ "0.3565", "0.1775" ],
+        "ct" : 462,
+        "alert" : "none",
+        "effect" : "none",
+        "colormode" : "ct",
+        "reachable" : true
+      },
+      "type" : "Extended color light",
+      "name" : "Bedroom Near",
+      "modelid" : "LCT001",
+      "swversion" : "65003148",
+      "pointsymbol" : { 
+        "1" : "none",
+        "2" : "none",
+        "3" : "none",
+        "4" : "none",
+        "5" : "none",
+        "6" : "none",
+        "7" : "none",
+        "8" : "none"
+      }
+    }
+  },
+  "groups" : { },
+  "config" : { 
+    "name" : "Philips hue",
+    "mac" : "00:17:88:09:26:9d",
+    "dhcp" : true,
+    "ipaddress" : "10.255.255.44",
+    "netmask" : "255.255.255.0",
+    "gateway" : "10.255.255.254",
+    "proxyaddress" : "",
+    "proxyport" : 0,
+    "UTC" : "2012-11-02T18:34:38",
+    "whitelist" : { 
+      "0123456789abdcef0123456789abcdef" : { 
+        "last use date" : "2012-11-02T18:34:38",
+        "create date" : "2012-11-01T21:04:48",
+        "name" : "iPhone 5"
+      }
+    },
+    "swversion" : "01003542",
+    "swupdate" : { 
+      "updatestate" : 0,
+      "url" : "",
+      "text" : "",
+      "notify" : false
+    },
+    "linkbutton" : false,
+    "portalservices" : false
+  },
+  "schedules" : { }
+}