rspec-hue 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db7485876728c2deada251978bbb3ccd5eebc587
+  data.tar.gz: dbae4d22680eba2060bfd454f64541991ec07236
+SHA512:
+  metadata.gz: a4787aa3ad6a2006088fe3d364aef5ffee0df78a0bf11b82e0709de9debcd1784c6f4bcdcb1df8cdb699ed41debf9321fd1b7fb08cc5f8f31c246890783cc277
+  data.tar.gz: ca764b3797ac88c79e9a3eb85b774f4e5349357a98479de4c7ebf2a532f31701d53e20d25e0db902b47d41dce2e2564ef626eece6ca4045c7bcd8c74c0723936

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format d

data/.ruby-gemset

@@ -0,0 +1 @@
+rspec_hue

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rspec-hue.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Lars Krantz
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# RspecHue
+
+RspecHue is a formatter for RSpec that will show the status of your tests to the entire office using [Philips Hue][].
+
+## Installation
+
+Note: Early version..
+
+```bash
+gem 'rspec-hue'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+## Usage
+
+RspecHue depends on the [Huey](https://github.com/Veraticus/huey) gem that will auto-discover your [Philips Hue][] using [SSDP](http://en.wikipedia.org/wiki/Simple_Service_Discovery_Protocol). 
+Or if you want, you can configure it to use a static ip-address.
+
+On first usage, you will have to press the link button on your Hue when prompted, or right before running your first test with the Hue formatter.
+
+### Configuration
+You'll have to configure the formatter using RSpec.configure, usually in your spec_helper.rb.
+This is the minimal required configuration for RspecHue (not really, Huey will find a bulb, but I wouldn't count on it):
+
+```ruby
+RSpec.configure do |config|
+    config.rspec_hue_light_id = 1 
+end
+```
+
+Available settings are:
+
+```ruby
+RSpec.configure do |config|
+    config.rspec_hue_light_id = "light name" # could be name or an id, depending on how you named your lights
+    # optional settings: 
+    config.rspec_hue_ip = "10.0.1.92" # Will disable auto-discover and use this static ip
+    config.rspec_hue_api_user = "29b6dc6100397272a74dd2a1f6f545b" # if you want to use another api user in your Hue 
+    # The default colors, could be overridden. 
+    # See mention below for color syntax.
+    config.rspec_hue_failed_color = { bri: 183, ct: 500, xy: [ 0.6731, 0.3215 ] } # red, default for failing specs
+    config.rspec_hue_passed_color =  { bri: 57, ct: 500, xy: [ 0.408, 0.517 ] } # green, default for passing specs
+end
+```
+### Enabling in RSpec
+In your .rspec add:
+
+```ruby
+    --format RspecHue
+```
+### Light ids explained
+The config.rspec\_hue\_light_id refers either to an light id or a light name. See the [Hue dev docs](http://developers.meethue.com/1_lightsapi.html#11_get_all_lights).
+Name can be easily be changed from the iPhone App or the Mac [Colors for Hue](https://itunes.apple.com/se/app/colors-for-hue/id581915465?mt=12).
+
+
+### Colors
+See [Hue dev docs](http://developers.meethue.com/1_lightsapi.html#16_set_light_state) or [Huey#bulbs](https://github.com/Veraticus/huey#bulbs).
+You could also set the color, using your iPhone Hue-app or the Mac [Colors for Hue](https://itunes.apple.com/se/app/colors-for-hue/id581915465?mt=12), and then check the parameters using the Hue [REST-interface](http://developers.meethue.com/1_lightsapi.html#14_get_light_attributes_and_state) (there seems to be a 100s cache for this call, so if it doesn't change, wait and refresh).
+
+## Office configuration
+In our office, we have one lamp per developer and we named them after the developer's name. Then, we configure as:
+
+```ruby
+RSpec.configure do |config|
+    config.rspec_hue_light_id = `git config user.name`.strip
+end
+```
+
+This will pull the name from the developer's git config and use it to find hers/his light.
+
+RSpecHue will not break tests if the Hue isn't found, or if the rspec\_hue\_light\_id isn't accessible, but will output an one-liner error message.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+[Philips Hue]: http://www.meethue.com/

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'rspec_hue'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+desc "Find and print the ip of Hue"
+task :hue_ip do
+    Huey::Config.logger = ::Logger.new(nil)
+    puts Huey::SSDP.hue_ip
+end

data/lib/null_bulb.rb

@@ -0,0 +1,4 @@
+class NullBulb
+	attr_accessor :on, :transitiontime
+	def update options; end
+end

data/lib/philips_hue_controller.rb

@@ -0,0 +1,94 @@
+require 'huey'
+require 'null_bulb'
+
+class PhilipsHueController
+	def initialize options = {}
+		@configuration = default_options.merge options
+		if configuration.has_key? :bulb_id_to_use
+			init_philips_hue
+		else
+			@bulb = passed_bulb_or_null_bulb
+		end
+	end
+	def failed
+		bulb.update(configuration[:failed_color])		
+	end
+	def passed
+		bulb.update(configuration[:passed_color])		
+	end
+	private
+	def configuration
+		@configuration
+	end
+	def default_options
+		{ 
+			hue_ip: nil,
+			ssdp_ip: '239.255.255.250',
+			ssdp_port: 1900,
+			ssdp_ttl: 3,
+			api_user: '29b6dc6100397272a74dd2a1f6f545b',
+			bulb_transition_time: 1,
+			output: StringIO.new,
+			failed_color: { bri: 183, ct: 500, xy: [ 0.6731, 0.3215 ] },
+			passed_color: { bri: 57, ct: 500, xy: [ 0.408, 0.517 ] }
+		}
+	end
+	def output
+		configuration[:output]
+	end
+	def bulb
+		@bulb
+	end
+	def passed_bulb_or_null_bulb
+		configuration.fetch(:bulb, NullBulb.new )
+	end
+	def init_bulb
+		@bulb = Huey::Bulb.find(configuration[:bulb_id_to_use]) if configuration.has_key? :bulb_id_to_use
+		@bulb = passed_bulb_or_null_bulb if @bulb.nil? #Huey return nil if not found
+		@bulb.on = true
+		@bulb.transitiontime = configuration[:bulb_transition_time]
+	end
+	def init_philips_hue
+	 	# Must do this, othwerwise Huey starts pushing out debug messages
+	 	Huey::Config.logger = ::Logger.new(nil)
+		begin		
+			Huey.configure do |config|
+				if configuration[:hue_ip].nil?
+					config.ssdp = true
+					# For discovering the Hue hub, usually you won't have to change this.
+				 	config.ssdp_ip = configuration[:ssdp_ip]
+				  	# Also for discovering the Hue hub.
+				  	config.ssdp_port = configuration[:ssdp_port]
+
+					# If you get constant errors about not being able to find the Hue hub and you're sure
+					# it's connected, increase this.
+					config.ssdp_ttl = configuration[:ssdp_ttl]
+				else
+					config.hue_ip = configuration[:hue_ip]
+				end
+				# Change this if you don't like the included uuid.
+				config.uuid = configuration[:api_user]
+				init_bulb
+			end
+		rescue Huey::Errors::Error, Huey::Errors::InternalBridgeError, Huey::Errors::HueResponseError
+			output.puts "RspecHue: Generic, unknown, Hue error, skipping"
+			@bulb = passed_bulb_or_null_bulb
+		rescue Huey::Errors::CouldNotFindHue
+			output.puts "RspecHue: No Philips Hue found, skipping"
+			@bulb = passed_bulb_or_null_bulb
+		rescue Huey::Errors::PressLinkButton
+			if STDIN.tty?
+				output.puts "RspecHue: Not authorized, press linkbutton on Philips Hue, then press enter here to continue, or q and enter to skip."
+				input = gets.strip 
+				unless input.downcase == "q"
+					init_philips_hue
+				else
+					@bulb = passed_bulb_or_null_bulb
+				end
+			else
+				output.puts "RspecHue: Not authorized, press linkbutton on Philips Hue and try again"
+				@bulb = passed_bulb_or_null_bulb
+			end
+		end
+	end
+end

data/lib/rspec_hue.rb

@@ -0,0 +1,65 @@
+require 'rspec'
+require 'philips_hue_controller'
+
+class RspecHue 
+	def initialize output, additional_args = {}
+		@output = output || StringIO.new
+		@additional_args = additional_args
+		@failure_count = 0
+	end
+	#called by rspec
+	def dump_summary duration, example_count, failure_count, pending_count
+		@bulb_controller = @additional_args.fetch(:controller) { setup_philips_hue_controller }
+		@failure_count = failure_count
+	end
+	# Catch everything else rspec throws at us, and swallow it.
+	def method_missing m, *args, █ end
+
+	def self.configure_rspec_for_settings
+		RSpec.configure do |c|
+			c.add_setting :rspec_hue_light_id
+			c.add_setting :rspec_hue_ip
+			c.add_setting :rspec_hue_failed_color
+			c.add_setting :rspec_hue_passed_color
+			c.add_setting :rspec_hue_api_user
+		end
+	end
+
+	# called by rspec when finished
+	def close()
+		init_bulb_controller
+		if failed 
+			bulb_controller.failed 
+		else 
+			bulb_controller.passed
+		end
+	end
+
+	private
+	def init_bulb_controller
+		@bulb_controller = @additional_args.fetch(:controller) { setup_philips_hue_controller }
+	end
+	def failed
+		@failure_count > 0
+	end
+	def setup_philips_hue_controller
+		options = { bulb_id_to_use: RSpec.configuration.rspec_hue_light_id, output: output }
+		failed_color = RSpec.configuration.rspec_hue_failed_color
+		passed_color = RSpec.configuration.rspec_hue_passed_color
+		hue_ip = RSpec.configuration.rspec_hue_ip
+		api_user = RSpec.configuration.rspec_hue_api_user
+		options[:failed_color] = failed_color unless failed_color.nil?
+		options[:passed_color] = passed_color unless passed_color.nil?
+		options[:hue_ip] = hue_ip unless hue_ip.nil?
+		options[:api_user] = api_user unless api_user.nil?
+		PhilipsHueController.new options
+	end
+	def output
+		@output
+	end
+	def bulb_controller
+		@bulb_controller
+	end
+end	
+# Must call to add setting-possibilty to RSpec
+RspecHue.configure_rspec_for_settings

data/rspec-hue.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-hue"
+  spec.version       = '0.1.3' 
+  spec.authors       = ["larskrantz"]
+  spec.email         = ["lars.krantz@alaz.se"]
+  spec.description   = %q{Light up Philips Hue when testing}
+  spec.summary       = %q{Let your Philips Hue indicate if tests are passing or not}
+  spec.homepage      = "https://github.com/larskrantz/rspec-hue"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = Gem::Requirement.new(">=1.9.3")
+  spec.extra_rdoc_files = %w(LICENSE.txt README.md)
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "yard"
+  spec.add_runtime_dependency     "rspec"
+  spec.add_runtime_dependency     "huey", "~> 2.0"
+end

data/spec/philips_hue_controller_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe PhilipsHueController do
+	let(:bulb) { double("Bulb") }
+	let(:failed_color) { { bri: 183, ct: 500, xy: [ 0.6731, 0.3215 ] } }
+	let(:passed_color) { { bri: 57, ct: 500, xy: [ 0.408, 0.517 ] } }
+	let(:controller) { PhilipsHueController.new bulb: bulb, failed_color: failed_color, passed_color: passed_color }
+
+	context "when telling controller to light bulb for failing test" do
+		it "the bulb should receive update with failcolor" do
+			bulb.should_receive(:update).with(failed_color)
+			controller.failed
+		end
+	end
+	context "when telling controller to light bulb for passing test" do
+		it "the bulb should receive update with passcolor" do
+			bulb.should_receive(:update).with(passed_color)
+			controller.passed
+		end
+	end
+	context "Integration", integration: true do
+		context "when no Hue is found" do
+			let(:output) { StringIO.new }
+			let(:controller_no_hue) { PhilipsHueController.new ssdp_port: 2000, bulb_id_to_use: 1, output: output }
+
+			it "should not raise an error on initialization" do
+				expect { controller_no_hue }.to_not raise_error
+			end
+			it "should not raise an error on failed" do
+				expect { controller_no_hue.failed }.to_not raise_error
+			end
+			it "should not raise an error on passed" do
+				expect { controller_no_hue.passed }.to_not raise_error
+			end
+
+			it "should output an error text starting with RspecHue" do
+				controller_no_hue
+				output.string.should start_with "RspecHue:"
+			end
+		end
+	end
+end

data/spec/rspec_hue_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe RspecHue do
+	context "when configuring rspec settings" do
+		def set_rspec_setting setting
+			RSpec.configure do |config|
+				config.send (setting.to_s + "=").to_sym, RSpec.configuration.send(setting)
+			end
+		end
+		it "should be able to set :rspec_hue_light_id" do
+			expect { set_rspec_setting :rspec_hue_light_id }.to_not raise_exception
+		end
+		it "should be able to set :rspec_hue_ip" do
+			expect { set_rspec_setting :rspec_hue_ip }.to_not raise_exception
+		end
+		it "should be able to set :rspec_hue_failed_color" do
+			expect { set_rspec_setting :rspec_hue_failed_color }.to_not raise_exception
+		end
+		it "should be able to set :rspec_hue_passed_color" do
+			expect { set_rspec_setting :rspec_hue_passed_color }.to_not raise_exception
+		end
+		it "should be able to set :rspec_hue_api_user" do
+			expect { set_rspec_setting :rspec_hue_api_user }.to_not raise_exception
+		end
+	end
+	context "when corresponding to the formatter interface" do
+		let(:controller) do
+			c = double("controller")
+			c.stub(:failed)
+			c.stub(:passed)
+			c
+		end
+		let(:formatter) { RspecHue.new StringIO.new, controller: controller }
+		it "should respond dump_summary" do
+			expect { formatter.dump_summary 123,2,1,1 }.to_not raise_exception
+		end
+		it "should not raise error if calling close() before dump_summary" do
+			expect { formatter.close() }.to_not raise_exception
+		end
+	end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+require 'rspec_hue'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.filter_run_excluding :integration
+  # config.rspec_hue_lamp_id = `git config user.name`.strip
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: rspec-hue
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- larskrantz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-20 00:00:00.000000000 Z
+dependencies:
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: huey
+  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'
+description: Light up Philips Hue when testing
+email:
+- lars.krantz@alaz.se
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/null_bulb.rb
+- lib/philips_hue_controller.rb
+- lib/rspec_hue.rb
+- rspec-hue.gemspec
+- spec/philips_hue_controller_spec.rb
+- spec/rspec_hue_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/larskrantz/rspec-hue
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Let your Philips Hue indicate if tests are passing or not
+test_files:
+- spec/philips_hue_controller_spec.rb
+- spec/rspec_hue_spec.rb
+- spec/spec_helper.rb
+has_rdoc: