hue 0.2.0 → 0.3.1

data/lib/hue/errors.rb

@@ -2,33 +2,47 @@ module Hue
   class Error < StandardError; end
 
   class UnauthorizedUser < Error; end
+
   class InvalidJSON < Error; end
+
   class ResourceNotAvailable < Error; end
+
   class MethodNotAvailable < Error; end
+
   class MissingBody < Error; end
+
   class ParameterNotAvailable < Error; end
+
   class InvalidValueForParameter < Error; end
+
   class ParameterNotModifiable < Error; end
+
   class InternalError < Error; end
+
   class LinkButtonNotPressed < Error; end
+
   class ParameterNotModifiableWhileOff < ParameterNotModifiable; end
+
   class TooManyGroups < Error; end
+
   class GroupTooFull < Error; end
 
   class InvalidUsername < Error; end
+
   class UnknownError < Error; end
+
   class NoBridgeFound < Error; end
 
   # Status code to exception map
   ERROR_MAP = {
-      1 => Hue::UnauthorizedUser,
-      2 => Hue::InvalidJSON,
-      3 => Hue::ResourceNotAvailable,
-      4 => Hue::MethodNotAvailable,
-      5 => Hue::MissingBody,
-      6 => Hue::ParameterNotAvailable,
-      7 => Hue::InvalidValueForParameter,
-      8 => Hue::ParameterNotModifiable,
+    1 => Hue::UnauthorizedUser,
+    2 => Hue::InvalidJSON,
+    3 => Hue::ResourceNotAvailable,
+    4 => Hue::MethodNotAvailable,
+    5 => Hue::MissingBody,
+    6 => Hue::ParameterNotAvailable,
+    7 => Hue::InvalidValueForParameter,
+    8 => Hue::ParameterNotModifiable,
     901 => Hue::InternalError,
     101 => Hue::LinkButtonNotPressed,
     201 => Hue::ParameterNotModifiableWhileOff,

data/lib/hue/group.rb

@@ -11,19 +11,19 @@ module Hue
     attr_reader :bridge
 
     # A unique, editable name given to the group.
-    attr_accessor :name
+    attr_reader :name
 
     # Hue of the group. This is a wrapping value between 0 and 65535.
     # Both 0 and 65535 are red, 25500 is green and 46920 is blue.
     attr_accessor :hue
 
-    # Saturation of the group. 255 is the most saturated (colored)
+    # Saturation of the group. 254 is the most saturated (colored)
     # and 0 is the least saturated (white).
     attr_accessor :saturation
 
     # Brightness of the group. This is a scale from the minimum
     # brightness the group is capable of, 0, to the maximum capable
-    # brightness, 255. Note a brightness of 0 is not off.
+    # brightness, 254. Note a brightness of 0 is not off.
     attr_accessor :brightness
 
     # The x coordinate of a color in CIE color space. Between 0 and 1.
@@ -58,16 +58,14 @@ module Hue
     end
 
     def lights
-      @lights ||= begin
-        @light_ids.map do |light_id|
-          @client.light(light_id)
-        end
+      @lights ||= @light_ids.map do |light_id|
+        @client.light(light_id)
       end
     end
 
     def name=(name)
-      resp = set_group_state({:name => name})
-      @name = new? ? name : resp[0]['success']["/groups/#{id}/name"]
+      resp = set_group_state({name: name})
+      @name = new? ? name : resp[0]["success"]["/groups/#{id}/name"]
     end
 
     def lights=(light_ids)
@@ -78,17 +76,17 @@ module Hue
       @light_ids = light_ids.uniq
       @lights = nil # resets the memoization
 
-      set_group_state({:lights => @light_ids})
+      set_group_state({lights: @light_ids})
     end
 
     def scene=(scene)
       scene_id = scene.is_a?(Scene) ? scene.id : scene
-      set_group_state({:scene => scene_id})
+      set_group_state({scene: scene_id})
     end
 
     def <<(light_id)
       @light_ids << light_id
-      set_group_state({:lights => @light_ids})
+      set_group_state({lights: @light_ids})
     end
     alias_method :add_light, :<<
 
@@ -120,8 +118,8 @@ module Hue
 
     def create!
       body = {
-        :name => @name,
-        :lights => @light_ids,
+        name: @name,
+        lights: @light_ids
       }
 
       uri = URI.parse("http://#{@bridge.ip}/api/#{@client.username}/groups")
@@ -129,7 +127,7 @@ module Hue
       response = http.request_post(uri.path, JSON.dump(body))
       json = JSON(response.body)
 
-      @id = json[0]['success']['id']
+      @id = json[0]["success"]["id"]
     end
 
     def destroy!
@@ -137,7 +135,7 @@ module Hue
       http = Net::HTTP.new(uri.host)
       response = http.delete(uri.path)
       json = JSON(response.body)
-      @id = nil if json[0]['success']
+      @id = nil if json[0]["success"]
     end
 
     def new?
@@ -147,22 +145,22 @@ module Hue
     private
 
     GROUP_KEYS_MAP = {
-      :name => :name,
-      :light_ids => :lights,
-      :type => :type,
-      :state => :action
+      name: :name,
+      light_ids: :lights,
+      type: :type,
+      state: :action
     }
 
     STATE_KEYS_MAP = {
-      :on => :on,
-      :brightness => :bri,
-      :hue => :hue,
-      :saturation => :sat,
-      :xy => :xy,
-      :color_temperature => :ct,
-      :alert => :alert,
-      :effect => :effect,
-      :color_mode => :colormode,
+      on: :on,
+      brightness: :bri,
+      hue: :hue,
+      saturation: :sat,
+      xy: :xy,
+      color_temperature: :ct,
+      alert: :alert,
+      effect: :effect,
+      color_mode: :colormode
     }
 
     def unpack(data)
@@ -170,7 +168,7 @@ module Hue
 
       unless new?
         unpack_hash(@state, STATE_KEYS_MAP)
-        @x, @y = @state['xy']
+        @x, @y = @state["xy"]
       end
     end
 

data/lib/hue/light.rb

@@ -3,9 +3,6 @@ module Hue
     include TranslateKeys
     include EditableState
 
-    HUE_RANGE = 0..65535
-    SATURATION_RANGE = 0..255
-    BRIGHTNESS_RANGE = 0..255
     COLOR_TEMPERATURE_RANGE = 153..500
 
     # Unique identification number.
@@ -15,19 +12,19 @@ module Hue
     attr_reader :bridge
 
     # A unique, editable name given to the light.
-    attr_accessor :name
+    attr_reader :name
 
     # Hue of the light. This is a wrapping value between 0 and 65535.
     # Both 0 and 65535 are red, 25500 is green and 46920 is blue.
     attr_reader :hue
 
-    # Saturation of the light. 255 is the most saturated (colored)
+    # Saturation of the light. 254 is the most saturated (colored)
     # and 0 is the least saturated (white).
     attr_reader :saturation
 
     # Brightness of the light. This is a scale from the minimum
     # brightness the light is capable of, 0, to the maximum capable
-    # brightness, 255. Note a brightness of 0 is not off.
+    # brightness, 254. Note a brightness of 0 is not off.
     attr_reader :brightness
 
     # The x coordinate of a color in CIE color space. Between 0 and 1.
@@ -84,6 +81,15 @@ module Hue
     # Reserved for future functionality.
     attr_reader :point_symbol
 
+    # The unique ID of the light.
+    attr_reader :uid
+
+    # The hash of capabilities of the light
+    attr_reader :capabilities
+
+    # The config hash
+    attr_reader :config
+
     def initialize(client, bridge, id, hash)
       @client = client
       @bridge = bridge
@@ -92,21 +98,21 @@ module Hue
     end
 
     def name=(new_name)
-      unless (1..32).include?(new_name.length)
-        raise InvalidValueForParameter, 'name must be between 1 and 32 characters.'
+      unless (1..32).cover?(new_name.length)
+        raise InvalidValueForParameter, "name must be between 1 and 32 characters."
       end
 
       body = {
-        :name => new_name
+        name: new_name
       }
 
       uri = URI.parse(base_url)
       http = Net::HTTP.new(uri.host)
       response = http.request_put(uri.path, JSON.dump(body))
       response = JSON(response.body).first
-      if response['success']
+      if response["success"]
         @name = new_name
-      # else
+        # else
         # TODO: Error
       end
     end
@@ -115,7 +121,7 @@ module Hue
     # always returns true, functionality will be added in a future
     # patch.
     def reachable?
-      @state['reachable']
+      @state["reachable"]
     end
 
     # @param transition The duration of the transition from the light’s current
@@ -126,7 +132,7 @@ module Hue
       body = translate_keys(attributes, STATE_KEYS_MAP)
 
       # Add transition
-      body.merge!({:transitiontime => transition}) if transition
+      body[:transitiontime] = transition if transition
 
       uri = URI.parse("#{base_url}/state")
       http = Net::HTTP.new(uri.host)
@@ -140,34 +146,37 @@ module Hue
       unpack(json)
     end
 
-  private
+    private
 
     KEYS_MAP = {
-      :state => :state,
-      :type => :type,
-      :name => :name,
-      :model => :modelid,
-      :software_version => :swversion,
-      :point_symbol => :pointsymbol
+      state: :state,
+      type: :type,
+      name: :name,
+      model: :modelid,
+      software_version: :swversion,
+      point_symbol: :pointsymbol,
+      uid: :uniqueid,
+      capabilities: :capabilities,
+      config: :config
     }
 
     STATE_KEYS_MAP = {
-      :on => :on,
-      :brightness => :bri,
-      :hue => :hue,
-      :saturation => :sat,
-      :xy => :xy,
-      :color_temperature => :ct,
-      :alert => :alert,
-      :effect => :effect,
-      :color_mode => :colormode,
-      :reachable => :reachable,
+      on: :on,
+      brightness: :bri,
+      hue: :hue,
+      saturation: :sat,
+      xy: :xy,
+      color_temperature: :ct,
+      alert: :alert,
+      effect: :effect,
+      color_mode: :colormode,
+      reachable: :reachable
     }
 
     def unpack(hash)
       unpack_hash(hash, KEYS_MAP)
       unpack_hash(@state, STATE_KEYS_MAP)
-      @x, @y = @state['xy']
+      @x, @y = @state["xy"]
     end
 
     def base_url

data/lib/hue/scene.rb

@@ -24,19 +24,17 @@ module Hue
     end
 
     def lights
-      @lights ||= begin
-        @light_ids.map do |light_id|
-          @client.light(light_id)
-        end
+      @lights ||= @light_ids.map do |light_id|
+        @client.light(light_id)
       end
     end
 
     private
 
     SCENE_KEYS_MAP = {
-      :name => :name,
-      :light_ids => :lights,
-      :active => :active,
+      name: :name,
+      light_ids: :lights,
+      active: :active
     }
 
     def unpack(data)

data/lib/hue/translate_keys.rb

@@ -14,7 +14,7 @@ module Hue
       map.each do |local_key, remote_key|
         value = hash[remote_key.to_s]
         next unless value
-        instance_variable_set("@#{local_key}", value)
+        instance_variable_set(:"@#{local_key}", value)
       end
     end
   end

data/lib/hue/version.rb

@@ -1,3 +1,3 @@
 module Hue
-  VERSION = '0.2.0'
+  VERSION = "0.3.1"
 end

data/lib/hue.rb

@@ -1,12 +1,12 @@
-require 'hue/version'
-require 'hue/errors'
-require 'hue/client'
-require 'hue/bridge'
-require 'hue/editable_state'
-require 'hue/translate_keys'
-require 'hue/light'
-require 'hue/group'
-require 'hue/scene'
+require "hue/version"
+require "hue/errors"
+require "hue/client"
+require "hue/bridge"
+require "hue/editable_state"
+require "hue/translate_keys"
+require "hue/light"
+require "hue/group"
+require "hue/scene"
 
 module Hue
   USERNAME_RANGE = 10..40

data/test/hue/client_test.rb

@@ -0,0 +1,26 @@
+require "test_helper"
+
+class ClientTest < Minitest::Test
+  def before_setup
+    super
+
+    stub_request(:get, "https://discovery.meethue.com/")
+      .to_return(body: '[{"id":"ffa57b3b257200065704","internalipaddress":"192.168.0.1"},{"id":"63c2fc01391276a319f9","internalipaddress":"192.168.0.2"}]')
+
+    stub_request(:get, %r{http://192.168.0.1/api}).to_return(body: '[{"success":true}]')
+    stub_request(:get, %r{http://192.168.0.1/api/*}).to_return(body: '[{"success":true}]')
+    stub_request(:get, %r{http://192.168.0.2/api/*}).to_return(body: '[{"success":true}]')
+  end
+
+  def test_with_bridge_id
+    client = Hue::Client.new(use_mdns: false)
+    client.stub :find_bridge_id, "63c2fc01391276a319f9" do
+      assert_equal "63c2fc01391276a319f9", client.bridge.id
+    end
+  end
+
+  def test_without_bridge_id
+    client = Hue::Client.new(use_mdns: false)
+    assert_equal "ffa57b3b257200065704", client.bridge.id
+  end
+end

data/test/hue/light_test.rb

@@ -0,0 +1,44 @@
+require "test_helper"
+
+class LightTest < Minitest::Test
+  def before_setup
+    super
+
+    stub_request(:get, "https://discovery.meethue.com/")
+      .to_return(body: '[{"internalipaddress":"localhost"}]')
+
+    stub_request(:get, %r{http://localhost/api/*}).to_return(body: '[{"success":true}]')
+    stub_request(:post, "http://localhost/api").to_return(body: '[{"success":{"username":"ruby"}}]')
+    stub_request(:put, %r{http://localhost/api*}).to_return(body: "[{}]")
+  end
+
+  %w[on hue saturation brightness color_temperature alert effect].each do |attribute|
+    define_method :"test_setting_#{attribute}" do
+      client = Hue::Client.new(use_mdns: false)
+      light = Hue::Light.new(client, client.bridge, 0, {"state" => {}})
+
+      light.send(:"#{attribute}=", 24)
+      assert_requested :put, %r{http://localhost/api/.*/lights/0}
+    end
+  end
+
+  def test_toggle_while_off
+    client = Hue::Client.new(use_mdns: false)
+    light = Hue::Light.new(client, client.bridge, 0, {"state" => {}})
+    assert_equal false, light.on?
+
+    light.toggle!
+    assert_requested :put, %r{http://localhost/api/.*/lights/0}
+    assert_equal true, light.on?
+  end
+
+  def test_toggle_while_on
+    client = Hue::Client.new(use_mdns: false)
+    light = Hue::Light.new(client, client.bridge, 0, {"state" => {"on" => true}})
+    assert_equal true, light.on?
+
+    light.toggle!
+    assert_requested :put, %r{http://localhost/api/.*/lights/0}
+    assert_equal false, light.on?
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+require "hue"
+
+require "minitest"
+require "webmock/minitest"
+require "minitest/autorun"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hue
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Sam Soffes
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-04-05 00:00:00.000000000 Z
+date: 2024-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -39,21 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: log_switch
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 0.4.0
-- !ruby/object:Gem::Dependency
-  name: curb
+  name: color_conversion
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -66,50 +52,23 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.2.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.2.0
-- !ruby/object:Gem::Dependency
-  name: webmock
-  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: Work with Philips Hue light bulbs.
 email:
 - sam@soff.es
 executables:
+- console
 - hue
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".rspec"
-- Contributing.markdown
+- ".ruby-version"
 - Gemfile
 - LICENSE
+- README.md
 - Rakefile
-- Readme.markdown
-- Todo.markdown
+- bin/console
 - bin/hue
 - hue.gemspec
 - lib/hue.rb
@@ -123,13 +82,14 @@ files:
 - lib/hue/scene.rb
 - lib/hue/translate_keys.rb
 - lib/hue/version.rb
-- spec/hue/light_spec.rb
-- spec/spec_helper.rb
+- test/hue/client_test.rb
+- test/hue/light_test.rb
+- test/test_helper.rb
 homepage: https://github.com/soffes/hue
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -137,18 +97,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.4.22
+signing_key:
 specification_version: 4
 summary: Work with Philips Hue light bulbs from Ruby.
-test_files:
-- spec/hue/light_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/Contributing.markdown

@@ -1,19 +0,0 @@
-## Submitting a Pull Request
-
-1. [Fork the repository.][fork]
-2. [Create a topic branch.][branch]
-3. Add tests for your unimplemented feature or bug fix.
-4. Run `bundle exec rake`. If your tests pass, return to step 3.
-5. Implement your feature or bug fix.
-6. Run `bundle exec rake`. If your tests fail, return to step 5.
-7. Run `open coverage/index.html`. If your changes are not completely covered
-   by your tests, return to step 3.
-8. Add documentation for your feature or bug fix.
-9. Run `bundle exec rake doc`. If your changes are not 100% documented, go
-   back to step 8.
-10. Add, commit, and push your changes.
-11. [Submit a pull request.][pr]
-
-[fork]: http://help.github.com/fork-a-repo/
-[branch]: http://learn.github.com/p/branching.html
-[pr]: http://help.github.com/send-pull-requests/

data/Todo.markdown

@@ -1,8 +0,0 @@
-# To Do
-
-* RGB translation
-* Hex translation
-* Scheduling
-* Effects
-* User management
-* Configuration

data/spec/hue/light_spec.rb

@@ -1,24 +0,0 @@
-RSpec.describe Hue::Light do
-  %w{on hue saturation brightness color_temperature alert effect}.each do |attribute|
-    before do
-      stub_request(:get, "https://www.meethue.com/api/nupnp").
-        to_return(:body => '[{"internalipaddress":"localhost"}]')
-
-      stub_request(:get, %r{http://localhost/api/*}).
-        to_return(:body => '[{"success":true}]')
-
-      stub_request(:put, %r{http://localhost/api*}).
-        to_return(:body => '[{}]')
-    end
-
-    describe "##{attribute}=" do
-      it "PUTs the new attribute value" do
-        client = Hue::Client.new
-        light = Hue::Light.new(client, client.bridge, 0, {"state" => {}})
-
-        light.send("#{attribute}=", 24)
-        expect(a_request(:put, %r{http://localhost/api/.*/lights/0})).to have_been_made
-      end
-    end
-  end
-end