lifx 0.4.5 → 0.4.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e413317b0ac40abc57bdf3699b8373451b86614c
-  data.tar.gz: 39852a66321e7352078e56e4b8073c4cb98f067b
+  metadata.gz: a0d7ac636c1a3c658b1859dbf7074fd845cd41e1
+  data.tar.gz: 112e36f614f01183d57d322d83d07807b58fe398
 SHA512:
-  metadata.gz: c75b51ea1267b7605c5bcaf74bc0daf4c298143aed8e7155f9969231fdc7658ed3ec018bcec9cea0a483fc0b327366db72ab7f2fe17a8ac1f45a7f49efc8eef7
-  data.tar.gz: 7b1b3274a505d44b2e793e1a616058bb4feb96054ea39ebbaf320c79e873f3550686c2a6c35ece2ec6cc0d99dd266fd96bf2b01fdf6e94c3b91b21b42dd03706
+  metadata.gz: 3693b61a7c84222e379dd535e6ccdb80f5e5381f4ac4f0893c0821f8c5ef4a269b19e0f76837158e1a4b5b42bff4b22c988e4b0d0ddf62f749b770a15eaacd90
+  data.tar.gz: 48a3b388801194eccccf878097c8f60ae83bab085e2e6dfa3d291baa6fb31780dcc6dacfd1b9f86214d7cda0e7a7e71e25ac66cae89af088e291a8718e727da2

data/CHANGES.md

@@ -1,14 +1,26 @@
-# 0.4.5
+### 0.4.6.1
+
+- Fix `Time.parse` issue
+
+### 0.4.6
+
+- `Color#==` has been renamed to `Color#similar_to?`
+- Broadcast IP configurable through `LIFX::Config.broadcast_ip`
+- Removed Yell gem. Use stdlib Logger instead
+- Uninitialized lights no longer shows up in `Client#lights`
+- Handle Rubies that don't have IPv6 enabled
+
+### 0.4.5
 
 - Now supports Ruby 2.0
 - Light#label can be nil
 - Light#set_power and Light#set_power! now take :on and :off rather than magic number
 - Use timers 1.x so no compilation is required
 
-# 0.4.4
+### 0.4.4
 
 - Fix SO_REUSEPORT issue on older Linux kernels.
 
-# 0.4.3
+### 0.4.3
 
 - Initial public release

data/README.md

@@ -13,8 +13,7 @@ This gem is in an early beta state. Expect breaking API changes.
 
 ## Requirements
 
-* Ruby 2.1.1
-* Bundler
+* Ruby 2.0+
 * Tested on OS X Mavericks, but should work other *nix platforms. Please file an issue if you have any problems.
 
 ## Installation
@@ -34,7 +33,7 @@ $ bundle
 Or install the gem with:
 
 ```shell
-gem install lifx
+gem install lifx        # Add sudo if required.
 ```
 
 ## Usage

data/Rakefile

@@ -10,7 +10,7 @@ task :console do
   require "lifx"
   require "pry"
   if ENV['DEBUG']
-    LIFX::Config.logger = Yell.new(STDERR)
+    LIFX::Config.logger.level = Logger::DEBUG
   end
   LIFX::Client.lan.discover! do |c|
     c.lights.count > 0

data/bin/lifx-snoop

@@ -27,7 +27,7 @@ end
 
 begin
   light_udp = LIFX::Transport::UDP.new('0.0.0.0', 56700)
-  light_udp.add_observer(self) do |message:, ip:, transport:|
+  light_udp.add_observer(self) do |message: nil, ip: nil, transport: nil|
     if matchers.all? { |m| message.to_s =~ m }
       puts "#{Time.now.iso8601(5)} BROADCAST: #{ip} #{message}"
     end
@@ -35,7 +35,7 @@ begin
   light_udp.listen
 
   peer_udp = LIFX::Transport::UDP.new('0.0.0.0', 56750)
-  peer_udp.add_observer(self) do |message:, ip:, transport:|
+  peer_udp.add_observer(self) do |message: nil, ip: nil, transport: nil|
     if matchers.all? { |m| message.to_s =~ m }
       puts "#{Time.now.iso8601(5)} PEER:      #{ip} #{message}"
     end

data/lib/lifx.rb

@@ -17,5 +17,5 @@ require "lifx/config"
 require "lifx/client"
 
 module LIFX
-
+  NULL_SITE_ID = "000000000000"
 end

data/lib/lifx/client.rb

@@ -1,6 +1,5 @@
 require 'socket'
 require 'timeout'
-require 'yell'
 
 require 'lifx/network_context'
 require 'lifx/light_collection'
@@ -57,8 +56,10 @@ module LIFX
       try_until -> { block.arity == 1 ? block.call(self) : block.call },
         timeout: timeout,
         timeout_exception: DiscoveryTimeout,
-        condition_interval: condition_interval do
+        condition_interval: condition_interval,
+        action_interval: 1 do
         discover
+        refresh
       end
       self
     end

data/lib/lifx/color.rb

@@ -174,16 +174,23 @@ module LIFX
       [hue, saturation, brightness, kelvin]
     end
 
-    EQUALITY_THRESHOLD = 0.001 # 0.1% variance
+    DEFAULT_SIMILAR_THRESHOLD = 0.001 # 0.1% variance
     # Checks if colours are equal to 0.1% variance
     # @param other [Color] Color to compare to
+    # @param threshold: [Float] 0..1. Threshold to consider it similar
     # @return [Boolean]
-    def ==(other)
+    def similar_to?(other, threshold: DEFAULT_SIMILAR_THRESHOLD)
       return false unless other.is_a?(Color)
       conditions = []
-      conditions << ((hue - other.hue).abs < (EQUALITY_THRESHOLD * 360)) 
-      conditions << ((saturation - other.saturation).abs < EQUALITY_THRESHOLD)
-      conditions << ((brightness - other.brightness).abs < EQUALITY_THRESHOLD)
+
+      conditions << (((hue - other.hue).abs < (threshold * 360)) || begin
+        # FIXME: Surely there's a better way. 
+        hues = [hue, other.hue].sort
+        hues[0] += 360
+        (hues[0] - hues[1]).abs < (threshold * 360)
+      end)
+      conditions << ((saturation - other.saturation).abs < threshold)
+      conditions << ((brightness - other.brightness).abs < threshold)
       conditions.all?
     end
   end

data/lib/lifx/config.rb

@@ -1,12 +1,13 @@
 require 'configatron/core'
-require 'yell'
+require 'logger'
 module LIFX
   Config = Configatron::Store.new
 
   Config.default_duration = 1
+  Config.broadcast_ip = '255.255.255.255'
   Config.allowed_transports = [:udp, :tcp]
-  Config.logger = Yell.new do |logger|
-    logger.level = 'gte.warn'
-    logger.adapter STDERR, format: '%d [%5L] %p/%t : %m'
+  Config.log_invalid_messages = false
+  Config.logger = Logger.new(STDERR).tap do |logger|
+    logger.level = Logger::WARN
   end
 end

data/lib/lifx/firmware.rb

@@ -1,3 +1,5 @@
+require 'time'
+
 module LIFX
   # LIFX::Firmware handles decoding firmware payloads
   # @private

data/lib/lifx/light.rb

@@ -46,7 +46,6 @@ module LIFX
         hook.call(payload)
       end
       @message_signal.broadcast
-      seen!
     end
 
     # Adds a block to be run when a payload of class `payload_class` is received
@@ -354,17 +353,19 @@ module LIFX
     # @return [Light] returns self for chaining
     def send_message(payload, acknowledge: true)
       context.send_message(target: Target.new(device_id: id, site_id: @site_id), payload: payload, acknowledge: acknowledge)
-      self
     end
 
+    # An exception for when synchronous messages take too long to receive a response
+    class MessageTimeout < StandardError; end
+
     # Queues a message to be sent to the Light and waits for a response
     # @param payload [Protocol::Payload] the payload to send
     # @param wait_for: [Class] the payload class to wait for
     # @param wait_timeout: [Numeric] wait timeout
     # @param block: [Proc] the block that is executed when the expected `wait_for` payload comes back. If the return value is false or nil, it will try to send the message again.
     # @return [Object] the truthy result of `block` is returned.
-    # @raise [Timeout::Error]
-    def send_message!(payload, wait_for: wait_for, wait_timeout: 3, timeout_exception: Timeout::Error, &block)
+    # @raise [MessageTimeout] if the device doesn't respond in time
+    def send_message!(payload, wait_for: wait_for, wait_timeout: 3, &block)
       if Thread.current[:sync_enabled]
         raise "Cannot use synchronous methods inside a sync block"
       end
@@ -376,10 +377,16 @@ module LIFX
           result = block.call(payload)
         }
         add_hook(wait_for, proc)
-        try_until -> { result }, signal: @message_signal, timeout_exception: timeout_exception do
+        try_until -> { result }, signal: @message_signal do
           send_message(payload)
         end
         result
+      rescue Timeout::Error
+        backtrace = caller_locations(2).map { |c| c.to_s }
+        caller_method = caller_locations(2, 1).first.label
+        ex = MessageTimeout.new("#{caller_method}: Timeout exceeded waiting for response from #{self}")
+        ex.set_backtrace(backtrace)
+        raise ex
       ensure
         remove_hook(wait_for, proc)
       end
@@ -390,6 +397,7 @@ module LIFX
     def add_hooks
       add_hook(Protocol::Device::StateLabel) do |payload|
         @label = payload.label.to_s
+        seen!
       end
 
       add_hook(Protocol::Light::State) do |payload|
@@ -397,22 +405,27 @@ module LIFX
         @color      = Color.from_struct(payload.color.snapshot)
         @power      = payload.power.to_i
         @tags_field = payload.tags
+        seen!
       end
 
       add_hook(Protocol::Device::StateTags) do |payload|
         @tags_field = payload.tags
+        seen!
       end
 
       add_hook(Protocol::Device::StatePower) do |payload|
         @power = payload.level.to_i
+        seen!
       end
 
       add_hook(Protocol::Device::StateMeshFirmware) do |payload|
         @mesh_firmware = Firmware.new(payload)
+        seen!
       end
 
       add_hook(Protocol::Device::StateWifiFirmware) do |payload|
         @wifi_firmware = Firmware.new(payload)
+        seen!
       end
     end
   end

data/lib/lifx/message.rb

@@ -22,8 +22,6 @@ module LIFX
     PROTOCOL_VERSION = 1024
 
     class << self
-      attr_accessor :log_invalid_messages
-
       def unpack(data)
         raise InvalidFrame if data.length < 2
 
@@ -35,7 +33,7 @@ module LIFX
         path = ProtocolPath.new(raw_site: message.raw_site, raw_target: message.raw_target, tagged: message.tagged)
         payload_class = message_type_for_id(message.type.snapshot)
         if payload_class.nil?
-          if self.log_invalid_messages
+          if Config.log_invalid_messages
             logger.error("Message.unpack: Unrecognised payload ID: #{message.type}")
             logger.error("Message.unpack: Message: #{message}")
           end
@@ -48,7 +46,7 @@ module LIFX
           if message.raw_site == "\x00" * 6
             logger.info("Message.unpack: Ignoring malformed message from virgin bulb")
           else
-            if self.log_invalid_messages
+            if Config.log_invalid_messages
               logger.error("Message.unpack: Exception while unpacking payload of type #{payload_class}: #{ex}")
               logger.error("Message.unpack: Data: #{data.inspect}")
             end
@@ -56,7 +54,7 @@ module LIFX
         end
         new(path, message, payload)
       rescue => ex
-        if self.log_invalid_messages
+        if Config.log_invalid_messages
           logger.debug("Message.unpack: Exception while unpacking #{data.inspect}")
           logger.debug("Message.unpack: #{ex} - #{ex.backtrace.join("\n")}")
         end

data/lib/lifx/network_context.rb

@@ -121,6 +121,7 @@ module LIFX
     end
 
     def register_device(device)
+      return if device.site_id == NULL_SITE_ID
       device_id = device.id
       @devices[device_id] = device # What happens when there's already one registered?
     end
@@ -170,6 +171,7 @@ module LIFX
           register_device(device)
         end
         device = @devices[message.device_id]
+        return if !device # Virgin bulb
         device.handle_message(message, ip, transport)
       end
     end

data/lib/lifx/protocol/payload.rb

@@ -2,6 +2,9 @@ module LIFX
   # @api private
   module Protocol
     class Payload < BinData::Record
+      def to_s
+        "#<#{self.class} #{super}>"
+      end
     end
   end
 end

data/lib/lifx/routing_manager.rb

@@ -54,6 +54,7 @@ module LIFX
     end
 
     def update_from_message(message)
+      return if message.site_id == NULL_SITE_ID
       if message.tagged?
         case message.payload
         when Protocol::Light::Get

data/lib/lifx/transport/tcp.rb

@@ -52,8 +52,9 @@ module LIFX
               
               notify_observers(message: message, ip: host, transport: self)
             rescue Message::UnpackError
-              if !@ignore_unpackable_messages
-                logger.warn("#{self}: Exception occured - #{ex}")
+              if Config.log_invalid_messages
+                logger.info("#{self}: Exception occured while decoding message - #{ex}")
+                logger.info("Data: #{data.inspect}")
               end
             rescue => ex
               logger.warn("#{self}: Exception occured in #listen - #{ex}")

data/lib/lifx/transport/udp.rb

@@ -41,7 +41,7 @@ module LIFX
               message = Message.unpack(bytes)
               notify_observers(message: message, ip: ip, transport: self)
             rescue Message::UnpackError
-              if !@ignore_unpackable_messages
+              if Config.log_invalid_messages
                 logger.warn("#{self}: Unrecognised bytes: #{bytes.bytes.map { |b| '%02x ' % b }.join}")
               end
             end

data/lib/lifx/transport_manager/lan.rb

@@ -3,7 +3,7 @@ require 'lifx/site'
 module LIFX
   module TransportManager
     class LAN < Base
-      def initialize(bind_ip: '0.0.0.0', send_ip: '255.255.255.255', port: 56700, peer_port: 56750)
+      def initialize(bind_ip: '0.0.0.0', send_ip: Config.broadcast_ip, port: 56700, peer_port: 56750)
         super
         @bind_ip   = bind_ip
         @send_ip   = send_ip
@@ -76,7 +76,7 @@ module LIFX
         else # Ruby 2.0
           Socket.ip_address_list.any? do |addrinfo|
             # Not entirely sure how to check if on a LAN with IPv6
-            addrinfo.ipv4_private? || addrinfo.ipv6_unique_local?
+            addrinfo.ipv4_private? || (addrinfo.respond_to?(:ipv6_unique_local?) && addrinfo.ipv6_unique_local?)
           end
         end
       end
@@ -128,6 +128,7 @@ module LIFX
       end
 
       def handle_broadcast_message(message, ip, transport)
+        return if message.nil?
         payload = message.payload
         case payload
         when Protocol::Device::StatePanGateway

data/lib/lifx/version.rb

@@ -1,3 +1,3 @@
 module LIFX
-  VERSION = "0.4.5"
+  VERSION = "0.4.6.1"
 end

data/lifx.gemspec

@@ -20,7 +20,6 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.0"
 
   spec.add_dependency "bindata", "~> 2.0"
-  spec.add_dependency "yell", "~> 2.0"
   spec.add_dependency "timers", "~> 1.0"
   spec.add_dependency "configatron", "~> 3.0"
   spec.add_development_dependency "bundler", "~> 1.3"

data/spec/color_spec.rb

@@ -22,5 +22,20 @@ module LIFX
         it_behaves_like 'translating color', 'black',  [0, 0, 0],       [0, 0, 0]
       end
     end
+
+    describe '#similar_to?' do
+      it 'matches reds on on either end of hue spectrums' do
+        expect(Color.hsb(359.9, 1, 1)).to be_similar_to(Color.hsb(0, 1, 1))
+        expect(Color.hsb(0, 1, 1)).to be_similar_to(Color.hsb(359.9, 1, 1))
+      end
+
+      it 'does not match different colours' do
+        expect(Color.hsb(120, 1, 1)).to_not be_similar_to(Color.hsb(0, 1, 1))
+      end
+
+      it 'matches similar colours' do
+        expect(Color.hsb(120, 1, 1)).to be_similar_to(Color.hsb(120.3, 1, 1))
+      end
+    end
   end
 end

data/spec/integration/light_spec.rb

@@ -27,7 +27,7 @@ module LIFX
         light.set_color(color, duration: 0)
         sleep 1
         light.refresh
-        wait { expect(light.color).to eq color }
+        wait { expect(light.color).to be_similar_to(color) }
       end
     end
 

data/spec/integration/tags_spec.rb

@@ -16,7 +16,7 @@ module LIFX
               # It also returns the current light state rather than the
               # final state
       light.refresh
-      wait { expect(light.color).to eq color }
+      wait { expect(light.color).to be_similar_to(color) }
 
       light.remove_tag('Foo')
       wait { expect(light.tags).not_to include('Foo') }

data/spec/transport/udp_spec.rb

@@ -1,39 +1,42 @@
 require 'spec_helper'
 
-describe LIFX::Transport::UDP, integration: true do
-  subject(:udp) { LIFX::Transport::UDP.new(host, port) }
+module LIFX
+  describe Transport::UDP, integration: true do
+    subject(:udp) { Transport::UDP.new(host, port) }
 
-  let(:host) { 'localhost' }
-  let(:message) { double }
-  let(:port) { 45_828 }
+    let(:host) { 'localhost' }
+    let(:message) { double }
+    let(:port) { 45_828 }
 
-  describe '#write' do
-    let(:payload) { double }
+    describe '#write' do
+      let(:payload) { double }
 
-    it 'writes a Message to specified host' do
-      expect(message).to receive(:pack).and_return(payload)
-      expect_any_instance_of(UDPSocket).to receive(:send)
-                                           .with(payload, 0, host, port)
-      udp.write(message)
+      it 'writes a Message to specified host' do
+        expect(message).to receive(:pack).and_return(payload)
+        expect_any_instance_of(UDPSocket).to receive(:send)
+                                             .with(payload, 0, host, port)
+        udp.write(message)
+      end
     end
-  end
 
-  describe '#listen' do
-    let(:raw_message) { 'some binary data' }
-    let(:socket) { UDPSocket.new }
-
-    it 'listens to the specified socket data, unpacks it and notifies observers' do
-      messages = []
-      udp.add_observer(self) do |message: nil, ip: nil, transport: nil|
-        messages << message
+    describe '#listen' do
+      let(:raw_message) { 'some binary data' }
+      let(:socket) { UDPSocket.new }
+      let(:messages) { [] }
+      before do
+        udp.add_observer(self) do |message: nil, ip: nil, transport: nil|
+          messages << message
+        end
+        udp.listen
       end
-      udp.listen
 
-      expect(LIFX::Message).to receive(:unpack)
-                               .with(raw_message)
-                               .and_return(message)
-      socket.send(raw_message, 0, host, port)
-      wait { expect(messages).to include(message) }
+      it 'listens to the specified socket data, unpacks it and notifies observers' do
+        expect(Message).to receive(:unpack)
+                                 .with(raw_message)
+                                 .and_return(message)
+        socket.send(raw_message, 0, host, port)
+        wait { expect(messages).to include(message) }
+      end
     end
   end
 end

metadata

@@ -1,111 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: lifx
 version: !ruby/object:Gem::Version
-  version: 0.4.5
+  version: 0.4.6.1
 platform: ruby
 authors:
 - Jack Chen (chendo)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-28 00:00:00.000000000 Z
+date: 2014-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: yell
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: timers
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: configatron
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.1'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.14'
 description: A Ruby gem that allows easy interaction with LIFX devices.
@@ -116,9 +102,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
-- .yardopts
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
 - CHANGES.md
 - Gemfile
 - LICENSE.txt
@@ -197,17 +183,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A Ruby gem that allows easy interaction with LIFX devices. Handles discovery,