lifx 0.4.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 357ce53a9c5e511833c6917f09d72396d203df38
-  data.tar.gz: 135ecdc739e64aaf4615702eedb273f9c3cb570e
+  metadata.gz: e976d2a6d1ab56351ef47fbae89e84a1c08c98ed
+  data.tar.gz: 2f8d52787abf6aee8dd809e3f61ac2395c0c8225
 SHA512:
-  metadata.gz: 7d2ad759de8697cf02de2914782742315be5c545678bae5b848e9dfeb13acc945823b78a1145f82df308e2dec308c31ec01aae6601c67262632cf64f36f56867
-  data.tar.gz: 212a318bab27a3f967971364e8384daa82842334a3b8f9327de66c12e3e01309b9b2d015f9c650dea8e0e91ea1cbf63a7ed3b2e722fc47186889b21f908506a4
+  metadata.gz: 49dd808c6baabd1d07a15e355e6367a272af8ef40c2469b3db1475a648e52ae5a4ef59c17395903825ac4ca42ee247e07c126bddda40804d0c0201d6592200ba
+  data.tar.gz: 2123ea65a1c2f246ab93c0c81532bc774de9669540bb312c7e3ec0a71b34e67dd6bca51b9faeb8fb3cd97575b4b2651248b691628fbac9cd6d716e69333d28d4

data/.yardopts

@@ -1 +1,3 @@
 --markup markdown
+--no-private
+--query "@api.text != 'private'"

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2014 LIFX Labs
+Copyright (c) 2012-2014 LIFX Labs
 
 MIT License
 

data/README.md

@@ -19,7 +19,7 @@ This gem is in an early beta state. Expect breaking API changes.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'lifx', git: "git@github.com:LIFX/lifx-gem.git"
+gem 'lifx'
 ```
 
 And then execute:
@@ -28,6 +28,12 @@ And then execute:
 $ bundle
 ```
 
+Or install the gem with:
+
+```shell
+gem install lifx
+```
+
 ## Usage
 
 ```ruby

data/lib/bindata_ext/bool.rb

@@ -1,3 +1,4 @@
+# @private
 module BinData
   class Bool < Primitive
     uint8 :_value

data/lib/lifx/firmware.rb

@@ -1,5 +1,6 @@
 module LIFX
   # LIFX::Firmware handles decoding firmware payloads
+  # @private
   class Firmware < Struct.new(:build_time, :major, :minor)
     include Comparable
 

data/lib/lifx/gateway_connection.rb

@@ -3,6 +3,7 @@ require 'lifx/timers'
 
 module LIFX
   # @api private
+  # @private
   class GatewayConnection
     # GatewayConnection handles the UDP and TCP connections to the gateway
     # A GatewayConnection is created when a new device sends a StatePanGateway

data/lib/lifx/light.rb

@@ -51,6 +51,7 @@ module LIFX
     # Adds a block to be run when a payload of class `payload_class` is received
     # @param payload_class [Class] Payload type to execute block on
     # @param &hook [Proc] Hook to run
+    # @api private
     # @return [void]
     def add_hook(payload_class, hook_arg = nil, &hook_block)
       hook = block_given? ? hook_block : hook_arg
@@ -63,6 +64,7 @@ module LIFX
     # Removes a hook added by {#add_hook}
     # @param payload_class [Class] Payload type to delete hook from
     # @param hook [Proc] The original hook passed into {#add_hook}
+    # @api private
     # @return [void]
     def remove_hook(payload_class, hook)
       @message_hooks[payload_class].delete(hook)
@@ -132,14 +134,16 @@ module LIFX
       set_power!(0)
     end
 
+    # @see #power
     # @return [Boolean] Returns true if device is on
-    def on?(**kwargs)
-      power(**kwargs) == :on
+    def on?(refresh: false, fetch: true)
+      power(refresh: refresh, fetch: fetch) == :on
     end
 
+    # @see #power
     # @return [Boolean] Returns true if device is off
-    def off?(**kwargs)
-      power(**kwargs) == :off
+    def off?(refresh: false, fetch: true)
+      power(refresh: refresh, fetch: fetch) == :off
     end
 
     # @param refresh: see #label
@@ -322,6 +326,7 @@ module LIFX
     end
     
     # Returns a nice string representation of the Light
+    # @return [String]
     def to_s
       %Q{#<LIFX::Light id=#{id} label=#{label(fetch: false)} power=#{power(fetch: false)}>}.force_encoding(Encoding.default_external)
     end

data/lib/lifx/light_collection.rb

@@ -83,12 +83,14 @@ module LIFX
     DEFAULT_ALIVE_THRESHOLD = 30 # seconds
     # Returns an Array of {Light}s considered alive
     # @param threshold: The maximum number of seconds a {Light} was last seen to be considered alive
+    # @return [Array<Light>] Lights considered alive
     def alive(threshold: DEFAULT_ALIVE_THRESHOLD)
       lights.select { |l| l.seconds_since_seen <= threshold }
     end
 
     # Returns an Array of {Light}s considered stale
     # @param threshold: The minimum number of seconds since a {Light} was last seen to be considered stale
+    # @return [Array<Light>] Lights considered stale
     def stale(threshold: DEFAULT_ALIVE_THRESHOLD)
       lights.select { |l| l.seconds_since_seen > threshold }
     end

data/lib/lifx/logging.rb

@@ -1,4 +1,5 @@
 module LIFX
+  # @private
   module Logging
     def self.included(mod)
       mod.extend(self)
@@ -8,4 +9,4 @@ module LIFX
       LIFX::Config.logger
     end
   end
-end
+end

data/lib/lifx/message.rb

@@ -3,7 +3,6 @@ require 'lifx/protocol_path'
 
 module LIFX
   # @api private
-
   class Message
     include Logging
     extend Forwardable

data/lib/lifx/network_context.rb

@@ -151,6 +151,11 @@ module LIFX
       transport_manager.gateways.map(&:values).flatten
     end
 
+    def to_s
+      %Q{#<LIFX::NetworkContext connections=#{gateway_connections}>}
+    end
+    alias_method :inspect, :to_s
+
     protected
 
     def handle_message(message, ip, transport)

data/lib/lifx/observable.rb

@@ -1,4 +1,5 @@
 module LIFX
+  # @private
   module Observable
     class ObserverCallbackMismatch < ArgumentError; end
     def add_observer(obj, &callback)

data/lib/lifx/protocol/device.rb

@@ -1,6 +1,6 @@
-# Generated code ahoy!
 module LIFX
   module Protocol
+    # @api private
     module Device
       module Service
         UDP = 1

data/lib/lifx/protocol/light.rb

@@ -1,6 +1,6 @@
-# Generated code ahoy!
 module LIFX
   module Protocol
+    # @api private
     module Light
       module Waveform
         SAW = 0

data/lib/lifx/protocol/payload.rb

@@ -1,6 +1,6 @@
 module LIFX
+  # @api private
   module Protocol
-    # @api private
     class Payload < BinData::Record
     end
   end

data/lib/lifx/protocol/sensor.rb

@@ -1,6 +1,6 @@
-# Generated code ahoy!
 module LIFX
   module Protocol
+    # @api private
     module Sensor
       class GetAmbientLight < Payload
         endian :little

data/lib/lifx/protocol/wan.rb

@@ -1,6 +1,6 @@
-# Generated code ahoy!
 module LIFX
   module Protocol
+    # @api private
     module Wan
       class ConnectPlain < Payload
         endian :little

data/lib/lifx/protocol/wifi.rb

@@ -1,6 +1,6 @@
-# Generated code ahoy!
 module LIFX
   module Protocol
+    # @api private
     module Wifi
       module Interface
         SOFT_AP = 1

data/lib/lifx/protocol_path.rb

@@ -1,6 +1,7 @@
 require 'lifx/utilities'
 
 module LIFX
+  # @private
   class ProtocolPath
     # ProtocolPath contains all the addressable information that is required
     # for the protocol.

data/lib/lifx/routing_manager.rb

@@ -3,6 +3,7 @@ require 'lifx/tag_table'
 require 'lifx/utilities'
 
 module LIFX
+  # @private
   class RoutingManager
     include Utilities
     # RoutingManager manages a routing table of site <-> device

data/lib/lifx/routing_table.rb

@@ -1,4 +1,5 @@
 module LIFX
+  # @private
   class RoutingTable
     class Entry < Struct.new(:site_id, :device_id, :tag_ids, :last_seen); end
     # RoutingTable stores the device <-> site mapping

data/lib/lifx/seen.rb

@@ -1,13 +1,21 @@
 module LIFX
   module Seen
+    # Returns the time when the device was last seen.
+    # @return [Time]
     def last_seen
       @last_seen
     end
 
+    # Returns the number of seconds since the device was last seen.
+    # If the device hasn't been seen yet, it will use Unix epoch as
+    # the time it was seen.
+    # @return [Float]
     def seconds_since_seen
       Time.now - (last_seen || Time.at(0))
     end
 
+    # Marks the device as being seen.
+    # @private
     def seen!
       @last_seen = Time.now
     end

data/lib/lifx/tag_manager.rb

@@ -1,5 +1,6 @@
 module LIFX
   # @api private
+  # @private
   class TagManager
     # TagManager handles discovery of tags, resolving tags to [site_id, tags_field] pairs,
     # creating, setting and removing tags.

data/lib/lifx/target.rb

@@ -1,8 +1,7 @@
 module LIFX
+  # Target is a high-level abstraction for the target of a Message
   # @api private
-
   class Target
-    # Target is a high-level abstraction for the target of a Message
 
     attr_reader :site_id, :device_id, :tag, :broadcast
     def initialize(device_id: nil, site_id: nil, tag: nil, broadcast: nil)

data/lib/lifx/timers.rb

@@ -1,5 +1,6 @@
 require 'timers'
 module LIFX
+  # @private
   module Timers
     protected
     def initialize_timer_thread

data/lib/lifx/transport/tcp.rb

@@ -3,6 +3,7 @@ require 'socket'
 module LIFX
   class Transport
     # @api private
+    # @private
     class TCP < Transport
       include Logging
 

data/lib/lifx/transport/udp.rb

@@ -2,6 +2,7 @@ require 'socket'
 module LIFX
   class Transport
     # @api private
+    # @private
     class UDP < Transport
       def initialize(*args)
         super

data/lib/lifx/utilities.rb

@@ -1,4 +1,5 @@
 module LIFX
+  # @private
   module Utilities
     def try_until(condition_proc, timeout_exception: Timeout::Error,
                                             timeout: 3,

data/lib/lifx/version.rb

@@ -1,3 +1,3 @@
 module LIFX
-  VERSION = "0.4.0"
+  VERSION = "0.4.1"
 end

data/spec/integration/client_spec.rb

@@ -4,15 +4,15 @@ module LIFX
   describe Client, integration: true do
     describe '#sync' do
       it 'schedules sending all messages to be executed at the same time' do
+        if lights.count < 3
+          pending "This test requires 3 or more lights tagged under Test"
+          return
+        end
 
         lifx.discover! do
           lights.count >= 3
         end
 
-        if lights.count < 3
-          fail "This test requires 3 or more lights tagged under Test"
-        end
-
         white = LIFX::Color.white(brightness: 0.5)
         lights.set_color(white, duration: 0)
         sleep 1
@@ -37,4 +37,4 @@ module LIFX
       end
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifx
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Jack Chen (chendo)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-23 00:00:00.000000000 Z
+date: 2014-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bindata