huey 0.2.0 → 1.0.0

data/Gemfile

@@ -2,4 +2,9 @@ source "http://rubygems.org"
 gemspec
 
 gem 'rake'
-gem 'color-tools'
+gem 'color-tools'
+gem 'chronic'
+
+group :development, :test do
+  gem 'timecop'
+end

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    huey (0.1.0)
+    huey (1.0.0)
+      chronic (>= 0.9.0)
       eventmachine (>= 1.0.0)
       httparty (>= 0.9.0)
 
@@ -9,18 +10,20 @@ GEM
   remote: http://rubygems.org/
   specs:
     addressable (2.3.2)
+    chronic (0.9.0)
     color-tools (1.3.0)
     crack (0.3.1)
     eventmachine (1.0.0)
-    httparty (0.9.0)
+    httparty (0.10.2)
       multi_json (~> 1.0)
-      multi_xml
+      multi_xml (>= 0.5.2)
     metaclass (0.0.1)
     mocha (0.13.1)
       metaclass (~> 0.0.1)
-    multi_json (1.5.0)
-    multi_xml (0.5.1)
+    multi_json (1.6.1)
+    multi_xml (0.5.3)
     rake (0.9.5)
+    timecop (0.5.9.2)
     webmock (1.9.0)
       addressable (>= 2.2.7)
       crack (>= 0.1.7)
@@ -31,9 +34,11 @@ PLATFORMS
 
 DEPENDENCIES
   bundler
+  chronic
   color-tools
   huey!
   mocha (>= 0.13.1)
   rake
+  timecop
   webmock (>= 1.9.0)
   yard (>= 0.8.3)

data/README.markdown

@@ -7,11 +7,9 @@ Easy control of your Phillips Hue lights, in an attractive Gem format!
 Installing Huey is pretty simple. First include the Gem in your Gemfile:
 
 ```ruby
-gem 'huey', git: 'git://github.com/Veraticus/huey.git'
+gem 'huey'
 ```
 
-(It's not in RubyGems yet because I'm not totally sure it's actually stable enough for release.)
-
 You shouldn't need to initialize anything to make Huey work correctly, but if you want to specify some configuration options go nuts:
 
 ```ruby
@@ -106,6 +104,49 @@ group.save # All changes you've made are committed to all the bulbs in a group
 group.update(bri: 200, ct: 500) # Set and save in one step
 ```
 
+### Events
+
+You probably want to always do the same actions over and over again to a group of bulbs. To help encapsulate that idea, we have events.
+
+```ruby
+all = Huey::Group.new(bulbs: Huey::Bulb.all)
+event = Huey::Event.new(name: 'All Lights Off', group: all, actions: {on: false})
+
+event.execute # All lights turn off
+```
+
+If you like, you can schedule an event to execute only at a particular time if you have a really gimpy scheduling system.
+
+```ruby
+event = Huey::Event.new(name: 'All Lights Off', group: all, actions: {on: false}, at: '9PM')
+
+event.execute # nothing happens unless it's 9PM
+Huey::Event.execute # run all events that should be run this second
+```
+
+It's probably easier for you to just directly invoke events from your scheduling system (cron or the like). To aid with that you can load events from a YAML file:
+
+```ruby
+Huey::Group.import('groups.yml') # So that we can find groups
+Huey::Event.import('events.yml')
+# The file should look like this:
+# Wakeup Call:
+#   group: Bedroom
+#   at: 9AM
+#   actions:
+#     bri: 100
+#     "on": true # Note the quotes, `on` is a reserved word for Yaml parsers
+#
+# Goodnight Time:
+#   group: Living Room
+#   at: 12AM
+#   actions:
+#     bri: 10
+#     "on": false # Note the quotes, `on` is a reserved word for Yaml parsers
+
+Huey::Event.find('Wakeup Call').execute
+```
+
 ## Attribution
 
 The structure of the configuration files and the modules are taken from [Mongoid](https://github.com/mongoid/mongoid), which had some really great ideas.

data/huey.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
 
   s.add_dependency('eventmachine', '>=1.0.0')
   s.add_dependency('httparty', '>=0.9.0')
+  s.add_dependency('chronic', '>=0.9.0')
 
   s.add_development_dependency('bundler', '>=0')
   s.add_development_dependency('yard', '>=0.8.3')

data/lib/huey/event.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+module Huey
+
+  # An event encapsulates logic to send to a group, either at a certain time or arbitrarily
+  class Event
+    attr_accessor :group, :at, :actions, :name
+
+    def self.import(file)
+      hash = YAML.load_file(file)
+
+      hash.each do |key, value|
+        options = {name: key}
+        value.each do |k, v|
+          options[k.to_sym] = v
+        end
+        
+        Huey::Event.new(options)
+      end
+      Huey::Event.all
+    end
+
+    def self.all
+      @all ||= []
+    end
+
+    def self.find(name)
+      Huey::Event.all.find {|s| s.name == name}
+    end
+
+    def self.execute(force = false)
+      Huey::Event.all.collect {|s| s.execute(force)}
+    end
+
+    def initialize(options)
+      [:group, :actions].each do |key|
+        raise ArgumentError, "You must supply #{key} to create an event" unless options.keys.include?(key)
+
+        self.instance_variable_set("@#{key}".to_sym, options[key])
+      end
+
+      self.at = options[:at]
+      self.name = options[:name]
+      self.group = Huey::Group.find(self.group) unless self.group.is_a?(Huey::Group)
+
+      Huey::Event.all << self
+    end
+
+    def should_run?
+      ((Chronic.parse(self.at) - 0.5)..(Chronic.parse(self.at) + 0.5)).cover?(Time.now)
+    end
+
+    def execute(force = false)
+      self.group.send(:update, actions) if force || at.nil? || should_run?
+    end
+
+  end
+
+end

data/lib/huey/version.rb

@@ -1,3 +1,3 @@
 module Huey
-  VERSION = "0.2.0"
-end
+  VERSION = "1.0.0"
+end

data/lib/huey.rb

@@ -5,6 +5,7 @@ require 'logger'
 require 'httparty'
 require 'color'
 require 'yaml'
+require 'chronic'
 
 require 'huey/version'
 
@@ -14,6 +15,7 @@ require 'huey/ssdp'
 require 'huey/request'
 require 'huey/bulb'
 require 'huey/group'
+require 'huey/event'
 
 module Huey
   extend self

data/test/fixtures/events.yml

@@ -0,0 +1,13 @@
+Wakeup Call:
+  group: Bedroom
+  at: 9AM
+  actions:
+    bri: 100
+    "on": true
+
+Goodnight Time:
+  group: Living Room
+  at: 12AM
+  actions:
+    bri: 10
+    "on": false

data/test/fixtures/groups.yml

@@ -0,0 +1,3 @@
+Living Room: [TV, Living Room - Fireplace]
+Foyer: [Foyer]
+Bedroom: [Bedroom]

data/test/test_helper.rb

@@ -1,9 +1,9 @@
 require 'test/unit'
 require 'webmock/test_unit'
 require "mocha/setup"
+require 'timecop'
 require 'huey'
 
-
 class Test::Unit::TestCase
   def setup
     super

data/test/unit/event_test.rb

@@ -0,0 +1,99 @@
+require 'test_helper'
+
+class EventTest < Test::Unit::TestCase
+
+  def setup
+    super
+    Huey::Event.stubs(:all).returns([])
+
+    @bulb1 = init_bulb('1', 'Living Room - TV')
+    @bulb2 = init_bulb('2', 'Living Room - Fireplace')
+    @bulb3 = init_bulb('3', 'Foyer')
+    @bulb4 = init_bulb('4', 'Bedroom')
+    Huey::Bulb.stubs(:all).returns([@bulb1, @bulb2, @bulb3, @bulb4])
+
+    @group1 = Huey::Group.new(@bulb1, @bulb2)
+    @group1.name = 'Living Room'
+    @group2 = Huey::Group.new(@bulb1, @bulb2, @bulb3)
+    @group3 = Huey::Group.new(@bulb3)
+    @group4 = Huey::Group.new(@bulb4)
+    Huey::Group.stubs(:all).returns([@group1, @group2, @group3, @group4])
+  end
+
+  def test_initializes_event
+    @event = Huey::Event.new(group: @group1, at: '8PM', actions: {bri: 100, on: true})
+
+    assert_equal @group1, @event.group
+    assert_equal '8PM', @event.at
+    assert_equal @event.actions, {bri: 100, on: true}
+  end
+
+  def test_initializes_event_with_name
+    @event = Huey::Event.new(group: 'Living Room', at: '8PM', actions: {bri: 100, on: true})
+
+    assert_equal @group1, @event.group
+  end
+
+  def test_executes_event
+    @event = Huey::Event.new(group: @group1, at: '8PM', actions: {bri: 100, on: true})
+
+    @group1.expects(:update).once.returns(true)
+
+    Timecop.freeze(Chronic.parse('8PM')) do
+      assert @event.should_run?
+      Huey::Event.execute
+    end
+
+    Timecop.freeze(Chronic.parse('10PM')) do
+      assert !@event.should_run?
+      Huey::Event.execute
+    end
+  end
+
+  def test_executes_event_with_some_leeway
+    @event = Huey::Event.new(group: @group1, at: '8PM', actions: {bri: 100, on: true})
+
+    @group1.expects(:update).once.returns(true)
+
+    Timecop.freeze(Chronic.parse('8PM') - 0.3) do
+      assert @event.should_run?
+      Huey::Event.execute
+    end
+
+    Timecop.freeze(Chronic.parse('8PM') + 0.8) do
+      assert !@event.should_run?
+      Huey::Event.execute
+    end
+  end
+
+  def test_force_execution
+    @event = Huey::Event.new(group: @group1, at: '8PM', actions: {bri: 100, on: true})
+
+    @group1.expects(:update).twice.returns(true)
+
+    Timecop.freeze(Chronic.parse('10PM')) do
+      assert !@event.should_run?
+      @event.execute(true)
+      Huey::Event.execute(true)
+    end
+  end
+
+  def test_execute_event_without_schedule
+    @event = Huey::Event.new(group: @group1, actions: {bri: 100, on: true})
+
+    @group1.expects(:update).once.returns(true)
+
+    @event.execute
+  end
+
+  def test_import_schedule_from_yaml
+    Huey::Event.import('test/fixtures/events.yml')
+
+    assert_equal 2, Huey::Event.all.count
+    assert_equal 'Wakeup Call', Huey::Event.all[0].name
+    assert_equal Huey::Group.find('Bedroom'), Huey::Event.all[0].group
+    assert_equal '9AM', Huey::Event.all[0].at
+    assert_equal Huey::Event.all[0].actions, {'bri' => 100, 'on' => true}
+  end
+
+end

data/test/unit/group_test.rb

@@ -4,6 +4,8 @@ class GroupTest < Test::Unit::TestCase
 
   def setup
     super
+    Huey::Group.stubs(:all).returns([])
+
     @bulb1 = init_bulb('1', 'Living Room - TV')
     @bulb2 = init_bulb('2', 'Living Room - Fireplace')
     @bulb3 = init_bulb('3', 'Foyer')
@@ -31,9 +33,7 @@ class GroupTest < Test::Unit::TestCase
   end
 
   def test_initializes_groups_from_yml
-    Huey::Group.instance_variable_set(:@all, [])
-
-    Huey::Group.import('test/fixtures/group.yml')
+    Huey::Group.import('test/fixtures/groups.yml')
 
     assert_equal 3, Huey::Group.all.count
     assert_equal [@bulb1, @bulb2], Huey::Group.all[0].bulbs

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: huey
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-20 00:00:00.000000000 Z
+date: 2013-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.9.0
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +144,17 @@ files:
 - lib/huey/config.rb
 - lib/huey/config/options.rb
 - lib/huey/errors.rb
+- lib/huey/event.rb
 - lib/huey/group.rb
 - lib/huey/request.rb
 - lib/huey/ssdp.rb
 - lib/huey/ssdp/searcher.rb
 - lib/huey/version.rb
-- test/fixtures/group.yml
+- test/fixtures/events.yml
+- test/fixtures/groups.yml
 - test/test_helper.rb
 - test/unit/bulb_test.rb
+- test/unit/event_test.rb
 - test/unit/group_test.rb
 - test/unit/request_test.rb
 - test/unit/ssdp_test.rb

data/test/fixtures/group.yml

@@ -1,3 +0,0 @@
-living_room: [TV, Living Room - Fireplace]
-foyer: [Foyer]
-bedroom: [Bedroom]