blinky 0.0.5 → 0.0.6

data/Gemfile.lock

@@ -1,17 +1,21 @@
 PATH
   remote: .
   specs:
-    blinky (0.0.4)
+    blinky (0.0.5)
+      chicanery (~> 0.0.7)
       libusb (~> 0.2.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    chicanery (0.0.7)
+      nokogiri (~> 1)
     diff-lcs (1.1.3)
     ffi (1.2.0)
     libusb (0.2.2)
       ffi (>= 1.0)
-    rake (10.0.2)
+    nokogiri (1.5.5)
+    rake (10.0.3)
     rspec (2.11.0)
       rspec-core (~> 2.11.0)
       rspec-expectations (~> 2.11.0)

data/README.rdoc

@@ -1,6 +1,9 @@
 = blinky
 
-blinky helps you see the light - plug and play set up for build lights - get a build light up and running in a few minutes.
+blinky helps you see the light
+
+* plug and play set up for build lights 
+* get a build light up and running in a few minutes.
 
 == Why blinky?
 
@@ -11,6 +14,7 @@ blinky is an attempt to fix that.
 blinky aims to supply plug and play support for all combinations of
 * USB Light Model (or any other USB Device used to indicate build status)
 * Operating System
+* CI Server
 
 == How do I use blinky?
 
@@ -19,13 +23,21 @@ Plug in your USB light, and then do something like this
   require 'rubygems'
   require 'blinky'
 
-  blinky = Blinky.new.light  
+  blinky = Blinky.new.light 
+  light.watch_cctray_server http://your.ci.server/cctray.xml 
+  
+Or, with basic authentication
+
+  light.watch_cctray_server http://your.ci.server/cctray.xml, {:user => 'user', :password => 'password'}  
+  
+Or, you can just control the light directly
+  
   light.success!
   light.failure!
   light.building!
   light.warning!
   light.off!
-
+  
 == What if I have more than one light? 
 
 Want to plug in more than one light on the same machine? 
@@ -53,6 +65,14 @@ Not sure which light is which?
 * Linux
 * Windows 
 
+=== CI Servers
+Any server that supports the {cctray}[http://confluence.public.thoughtworks.org/display/CI/Multiple+Project+Summary+Reporting+Standard]  xml format, including among others:
+
+* Go - watch https://go-server:8154/go/cctray.xml
+* Jenkins/Hudson - watch http://jenkins-server:8080/cc.xml
+* travis - watch https://api.travis-ci.org/repositories/owner/project/cc.xml
+* tddium - watch 'Configure with CCMenu' (something like https://api.tddium.com/cc/long_uuid_string/cctray.xml)
+
 == How Do I install blinky?
 
 === 1) Install support for lib-usb-1.0 (http://www.libusb.org)
@@ -98,11 +118,21 @@ Plug in your light and then do this:
   blinky.light.watch_test_server
       
 Watch the pretty lights!
-  
-== How do I contribute support for more lights 
 
-COMING SOON
+== Blinky doesn't quite do what I want
+
+The watch_cctray_server method is a very simple approach, but its easy to do something more sophisticated by writing your own plugin - see "How do I contribute support for more ci servers?" below.
+
+Or if you want to get really fancy, take a look at {Chicanery}[http://github.com/markryall/chicanery] and use it to control blinky any way you want.
+   
+== How do I contribute support for more lights? 
+
+Take a look at the classes in device_recipes then write your own!
+
+== How do I contribute support for more ci servers? 
 
+Take a look at the classes in ci_server plugins then write your own!
+You will probably find {Chicanery}[http://github.com/markryall/chicanery] very useful when doing this.
 
 == Copyright
 

data/blinky.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   
   gem.add_dependency "libusb", "~> 0.2.2"
+  gem.add_dependency "chicanery", "~>0.0.7"
   
   gem.add_development_dependency "rspec", "~> 2.11.0"
   gem.add_development_dependency "rake",  "~> 10.0.2"

data/lib/blinky/version.rb

@@ -1,3 +1,3 @@
 module Blinky
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/ci_server_plugins/cctray_server_plugin.rb

@@ -0,0 +1,22 @@
+require 'chicanery/cctray'
+require 'chicanery'
+module Blinky
+  module CCTrayServer
+    include Chicanery
+     
+    def watch_cctray_server url, options = {}    
+      server Chicanery::Cctray.new 'blinky build', url, options
+
+      when_run do |current_state|
+        current_state.has_failure? ? failure! : success!
+      end
+      
+      begin
+        run_every 15
+      rescue => e
+        warning!
+        raise e
+      end
+    end
+  end
+end

data/lib/plugins.rb

@@ -1 +1,2 @@
-plugin TestCiServer
+plugin TestCiServer
+plugin CCTrayServer

data/spec/acceptance_spec.rb

@@ -6,7 +6,8 @@ module Blinky
     describe "that has a supported device connected" do
 
       before(:each) do
-        @supported_device = double("supported device",:idVendor => 0x2000, :idProduct => 0x2222)       
+        @supported_device = double("supported device",:idVendor => 0x2000, :idProduct => 0x2222)
+        @supported_device.stub(:open).and_return(@supported_device)       
         self.connected_devices = [
           double("unsupported device A",:idVendor => 0x1234, :idProduct => 0x5678),
           @supported_device,
@@ -46,7 +47,8 @@ module Blinky
     describe "that supports two devices from the same vendor" do
 
       it "can provide a light that can control the first device" do
-        supported_device_one = double("supported device one", :idVendor => 0x1000, :idProduct => 0x1111)       
+        supported_device_one = double("supported device one", :idVendor => 0x1000, :idProduct => 0x1111) 
+        supported_device_one.stub(:open).and_return(supported_device_one)       
         self.connected_devices = [supported_device_one]
         @blinky = Blinky.new("#{File.dirname(__FILE__)}/fixtures")
         supported_device_one.should_receive(:indicate_success)
@@ -54,7 +56,8 @@ module Blinky
       end
 
       it "can provide a light that can control the second device" do
-        supported_device_two = double("supported device two", :idVendor => 0x1000, :idProduct => 0x2222)       
+        supported_device_two = double("supported device two", :idVendor => 0x1000, :idProduct => 0x2222) 
+        supported_device_two.stub(:open).and_return(supported_device_two)      
         self.connected_devices = [supported_device_two]
         @blinky = Blinky.new("#{File.dirname(__FILE__)}/fixtures")
         supported_device_two.should_receive(:indicate_success)
@@ -101,9 +104,11 @@ module Blinky
     describe "that has two supported devices connected" do
 
       before(:each) do
-        @supported_device_one = double("supported device A",:idVendor => 0x1000, :idProduct => 0x1111)  
+        @supported_device_one = double("supported device A",:idVendor => 0x1000, :idProduct => 0x1111)
+        @supported_device_one.stub(:open).and_return(@supported_device_one)   
         @supported_device_two = double("supported device B",:idVendor => 0x2000, :idProduct => 0x2222)      
-
+        @supported_device_two.stub(:open).and_return(@supported_device_two) 
+         
         self.connected_devices = [
           double("unsupported device", :idVendor => 0x1234, :idProduct => 0x5678),
           @supported_device_one,
@@ -127,8 +132,10 @@ module Blinky
 
     describe "that provides a light that is asked to watch a supported CI server" do
 
-      before(:each) do      
-        self.connected_devices = [double("device",:idVendor => 0x1000, :idProduct => 0x1111)]
+      before(:each) do   
+        device = double("device",:idVendor => 0x1000, :idProduct => 0x1111) 
+        device.stub(:open).and_return(device)
+        self.connected_devices = [device]
         @light = Blinky.new("#{File.dirname(__FILE__)}/fixtures").light
       end
 

data/spec/ci_server_plugins/cctray_server_plugin_spec.rb

@@ -0,0 +1,59 @@
+require File.join(File.dirname(__FILE__), '..', '/spec_helper')
+require 'ci_server_plugins/cctray_server_plugin'
+module Blinky
+
+  class StubBlinky
+  end
+
+  describe "CCTrayServer" do
+
+    before(:each) do
+      @blinky = StubBlinky.new
+      @blinky.extend(CCTrayServer)
+      @blinky.stub(:run_every)
+
+      @stub_cctray = double("CCTRay ")
+      Chicanery::Cctray.stub(:new).and_return(@stub_cctray)
+    end
+
+    it "watches a Chicanery Cctray server at the provided url" do    
+      Chicanery::Cctray.should_receive(:new).with("blinky build", "SOME_URL", {}).and_return(@stub_cctray)
+      @blinky.watch_cctray_server "SOME_URL"
+    end
+    
+    it "watches a Chicanery Cctray server at the provided url and options" do    
+       Chicanery::Cctray.should_receive(:new).with("blinky build", "SOME_URL", {:foo => :bar}).and_return(@stub_cctray)
+       @blinky.watch_cctray_server "SOME_URL", {:foo => :bar}
+     end
+
+    it "polls every 15 seconds" do
+      @blinky.should_receive(:run_every).with(15)
+      @blinky.watch_cctray_server "SOME_URL"
+    end
+    
+    it "warns if something goes wrong" do
+      @blinky.should_receive(:run_every).and_raise "oh no!"
+      @blinky.should_receive(:warning!)
+      expect{@blinky.watch_cctray_server "SOME_URL"}.to raise_error("oh no!")
+    end
+
+    it "registers a chinanery run halder that indicates failure when current status has failures" do
+      run_handler = nil
+      @blinky.should_receive(:when_run) { |&block| run_handler = block }
+      @blinky.watch_cctray_server "SOME_URL"
+
+      @blinky.should_receive(:failure!)
+      run_handler.call double("status", :has_failure? => true)
+    end
+
+    it "registers a chinanery run halder that indicates success when current status has no failures" do
+      run_handler = nil
+      @blinky.should_receive(:when_run) { |&block| run_handler = block }
+      @blinky.watch_cctray_server "SOME_URL"
+
+      @blinky.should_receive(:success!)
+      run_handler.call double("status", :has_failure? => false)
+    end
+
+  end  
+end

data/spec/light_factory_spec.rb

@@ -13,7 +13,9 @@ module Blinky
     before do
 
       @device_one =  double("device one", :idVendor => 0x1234, :idProduct => 0x5678)
+      @device_one.stub(:open).and_return(@device_one) 
       @device_two =  double("device two",:idVendor => 0x5678, :idProduct => 0x1234) 
+      @device_two.stub(:open).and_return(@device_two) 
       @connected_devices = [@device_one, @device_two]
       self.connected_devices = @connected_devices
 

data/spec/light_spec.rb

@@ -28,7 +28,7 @@ module Blinky
     describe "that has been constructed with a device, a device recipe, and some CI plugins" do
 
       before(:each) do
-        @supported_device = double("supported device",:idVendor => 0x2000, :idProduct => 0x2222)       
+        @supported_device = double("supported device",:idVendor => 0x2000, :idProduct => 0x2222)      
         @light = Light.new(@supported_device, TestEngineering::TestModel, [MockCiPlugin, AnotherMockCiPlugin ] )
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blinky
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-12 00:00:00.000000000 Z
+date: 2012-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libusb
@@ -27,6 +27,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.2.2
+- !ruby/object:Gem::Dependency
+  name: chicanery
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.7
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -79,6 +95,7 @@ files:
 - lib/blinky/light_factory.rb
 - lib/blinky/no_supported_devices_found.rb
 - lib/blinky/version.rb
+- lib/ci_server_plugins/cctray_server_plugin.rb
 - lib/ci_server_plugins/test_server_plugin.rb
 - lib/device_recipes/delcom_engineering/visual_indicator_gen_one.rb
 - lib/device_recipes/delcom_engineering/visual_indicator_gen_two.rb
@@ -87,6 +104,7 @@ files:
 - notes.txt
 - spec/acceptance_spec.rb
 - spec/blinky_spec.rb
+- spec/ci_server_plugins/cctray_server_plugin_spec.rb
 - spec/ci_server_plugins/test_server_plugin_spec.rb
 - spec/fixtures/ci_server_plugins/mock_ci_server.rb
 - spec/fixtures/device_recipes/aenima_engineering/model_462.rb
@@ -124,6 +142,7 @@ summary: helps you see the light
 test_files:
 - spec/acceptance_spec.rb
 - spec/blinky_spec.rb
+- spec/ci_server_plugins/cctray_server_plugin_spec.rb
 - spec/ci_server_plugins/test_server_plugin_spec.rb
 - spec/fixtures/ci_server_plugins/mock_ci_server.rb
 - spec/fixtures/device_recipes/aenima_engineering/model_462.rb