lita-hue-lightswitch 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7b3ca14ae52d62142c1a9454e6a2b9b608d238f316ef3502f5c2dba0d79bd571
+  data.tar.gz: b078b50df0c4094da457eb022a60a0eea78d3fd51c4bc2cc6fd0103092d138a1
+SHA512:
+  metadata.gz: e1fdf9d26770667c6f031eb492ddeb1ffb81ee12dc0290036e4e8aafdf376c1a9da001d60587a2b1ab9e20655513d88e75a61ba60bae5af743784dc4ae9694aa
+  data.tar.gz: b65978eed2c4153e5dc4c9d003d5bb15a55a1c96763669baf192fb9768aeef1500c9ab94bcd63f3360825412318c6535117d36ec5a961cb97338997b71e68ced

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/README.md

@@ -0,0 +1,19 @@
+# lita-hue-lightswitch
+
+TODO: Add a description of the plugin.
+
+## Installation
+
+Add lita-hue-lightswitch to your Lita instance's Gemfile:
+
+``` ruby
+gem "lita-hue-lightswitch"
+```
+
+## Configuration
+
+TODO: Describe any configuration attributes the plugin exposes.
+
+## Usage
+
+TODO: Describe the plugin's features and how to use them.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/examples/001-hue-demo.rb

@@ -0,0 +1,62 @@
+# START:setup
+[1] pry(main)> require 'hue'
+=> true
+
+[2] pry(main)> client = Hue::Client.new
+=> #<Hue::Client:0x0000555b194f0b40
+ @bridges=
+  [#<Hue::Bridge:0x0000555b194f0140
+    @client=#<Hue::Client:0x0000555b194f0b40 ...>,
+    @id="001788fffe2c1ba4",
+    @ip="10.0.0.106">],
+ @username="redacted">
+# END:setup
+
+# START:lights
+[3] pry(main)> client.lights.map(&:name)
+=> ["Bottom lamp", "Middle lamp", "Top lamp", "Bloom"]
+
+[4] pry(main)> bloom = client.lights.last
+=> #<Hue::Light:0x0000555b1970a750
+ @alert="none",
+ @bridge=
+  #<Hue::Bridge:0x0000555b194f0140
+   @client=
+    #<Hue::Client:0x0000555b194f0b40
+     @bridges=[#<Hue::Bridge:0x0000555b194f0140 ...>],
+     @username="CSvQNKCBeyLj-FRitKTPUNRD4tEmphZIjUG1VGp1">,
+   @id="001788fffe2c1ba4",
+   @ip="10.0.0.106",
+   @lights=
+   # END:lights
+#	   ... snipped for brevity ...
+
+# START:commands
+[6] pry(main)> ls bloom
+Hue::TranslateKeys#methods: translate_keys  unpack_hash
+Hue::EditableState#methods: 
+  alert=       color_temperature=  hue=  on!  on?          set_xy
+  brightness=  effect=             off!  on=  saturation=
+Hue::Light#methods: 
+  alert       color_mode         hue    name          reachable?
+  bridge      color_temperature  id     name=         refresh   
+  brightness  effect             model  point_symbol  saturation
+instance variables: 
+  @alert       @client      @hue    @name       @saturation       
+  @bridge      @color_mode  @id     @on         @software_ver
+  @brightness  @effect      @model  @reachable  @state            
+# END:commands
+
+# START:action
+# Change my bulb to a blue color
+[7] pry(main)> bloom.hue = 44444
+=> 44444
+
+# Turn off my bulb
+[8] pry(main)> bloom.off!
+=> false
+
+# Turn on my bulb
+[9] pry(main)> bloom.on!
+=> true
+# END:action

data/examples/002-lita-demo.session

@@ -0,0 +1,16 @@
+$ lita
+Type "exit" or "quit" to end the session.
+Lita > lita hue off
+Turning off light!
+
+Lita > lita hue on
+Turning on light!
+
+Lita > lita hue color red
+Setting color to red
+
+Lita > lita hue color green
+Setting color to green
+
+Lita > lita hue demo
+Enjoy the light demo!

data/lib/lita-hue-lightswitch.rb

@@ -0,0 +1,13 @@
+require "lita"
+
+Lita.load_locales Dir[File.expand_path(
+  File.join("..", "..", "locales", "*.yml"), __FILE__
+)]
+
+require "lita/hue_colored_bulb"
+require "lita/handlers/hue_lightswitch"
+
+Lita::Handlers::HueLightswitch.template_root File.expand_path(
+  File.join("..", "..", "templates"),
+ __FILE__
+)

data/lib/lita/handlers/hue_lightswitch.rb

@@ -0,0 +1,96 @@
+# START:header
+module Lita
+  module Handlers
+    class HueLightswitch < Handler
+
+      # Set these in your bot's lita_config.rb
+      config :hue_bulb_name, default: 'Bloom'
+
+      # Create a reusable instance variable handle to a bulb
+      #   named 'Bloom' (or whatever your config value for
+      #   :hue_bulb_name is set to.
+      def light
+	@_light ||= HueColoredBulb.new(config.hue_bulb_name)
+      end
+      # END:header
+
+      # START:handle
+      # Any command of the form 'lita hue ____' should be caught
+      #   and passed to the :handle_hue method
+      route /^hue\s+(.+)/i, :handle_hue, command: true
+
+      # Split the captured hue command into a one-word command name
+      #   and everything after that (if anything) and pass the results
+      #   on to the :hue_execute mapping below.
+      def handle_hue(message)
+	command, *rest = message.matches.last.last.split
+	response = hue_execute(command, rest)
+	message.reply response
+      end
+      # END:handle
+
+      # START:mapping
+      # Given a one-word hue :command and a possibly-empty array of 
+      #   additional parameters :rest, step through this case 
+      #   statement and perform the first matching action.
+      def hue_execute(command, rest=[])
+	case command
+	when 'demo'
+	  demo
+	  'Enjoy the light demo!'
+	when 'list_colors'
+	  list_colors
+	when 'color'
+	  recolor rest
+	  "Setting color to #{rest.join ' '}"
+	when 'off'
+	  off!
+	  "Turning off light!"
+	when 'on'
+	  on!
+	  "Turning on light!"
+	else
+          debug_message = [command, rest].flatten.join ' '
+	  "I don't know how to [#{debug_message}] a hue bulb."
+	end
+      end
+      # END: mapping
+
+      # START:colors
+      # Simple help text in case someone forgets Lita's `hue` commands
+      def list_colors
+	light.colors.join ' '
+      end
+
+      # Set the bulb's color to one of the named colors it recognizes
+      #   e.g. red, green, blue, etc.
+      def recolor(rest)
+	new_color = rest.first
+	light.set_color new_color
+      end
+      # END:colors
+
+      # START:basics
+      ##################
+      #
+      # These three commands are pass-throughs to the HueColoredBulb wrapper.
+      #
+      ##################
+
+      def off!
+	light.off!
+      end
+
+      def on!
+	light.on!
+      end
+
+      def demo
+	light.demo
+      end
+      # END:basics
+
+      Lita.register_handler(self)
+    end
+  end
+end

data/lib/lita/hue_colored_bulb.rb

@@ -0,0 +1,123 @@
+# START:header
+# The hue gem is doing all the heavy lifting here, you're simply
+#   wrapping it in some more beginner-friendly language.
+require 'hue'
+
+# Exposes basic on, off, and recolor commands for a single named Hue bulb 
+#   on the local network.
+class HueColoredBulb
+  # Note that the initializer only cares about a single named bulb 
+  #   and does not look around for other bulbs to care about.
+  def initialize(name='Bloom')
+    @client = Hue::Client.new
+
+    # Your client likely has multiple bulbs attached, but here you're only
+    #   going to want to find a single bulb that matches the supplied name.
+    @light = @client.lights.select do |light|
+      light.name == name
+    end.first
+
+    # No point continuing if the bulb can't be found by name.
+    raise ArgumentError if @light.nil?
+  end
+
+  # The named light itself and the Hue client object are both worth reusing
+  #   as instance variables
+  attr_reader :light, :client
+  # END:header
+
+  # START:basics
+  # on! and off! methods are passed right through this API. They're plenty
+  #   simple for your purposes as is.
+  def on!
+    light.on!
+  end
+
+  def off!
+    light.off!
+  end
+
+  # Fun demo to spin through all named colors, one color every quarter second.
+  def demo(sleep_seconds=0.25)
+    colors.each do |color_name|
+      self.set_color color_name
+      sleep sleep_seconds
+    end
+  end
+  # END:basics
+
+  # START:color_names
+  # Hue's color coordinate system has about 64,000 distinct hues. For Lita
+  #   purposes you're fine starting with these twelve familiar options.
+  #
+  # The colors are listed in ascending order of hue along the color wheel
+  #   starting at red, moving clockwise up through green and blue,
+  #   and looping back around to the starting point to end at the same
+  #   red where they began.	
+
+  # Each color's corresponding hue number is one-twelfth of the circle's 
+  #   circumference higher than the previous color. If red is 0 then orange is
+  #   65535 / 12 * 1, or 5461. Yellow is twice that at 10,922. Rose is 60,073.
+
+  #                      [R]ed
+
+  #             rose           orange
+
+  #       magenta                    yellow
+
+  #    violet                           chartreuse
+
+  #       [B]lue                     [G]reen
+
+  #             azure          aquamarine
+
+  #                      cyan
+
+  #
+  def colors
+    [
+      'red', 'orange', 'yellow',           # red is 0
+      'chartreuse', 'green', 'aquamarine', # green is 21,000
+      'cyan', 'azure', 'blue',             # blue is 44,000
+      'violet', 'magenta', 'rose'          # rose is about 60,000
+    ]
+  end
+
+  # Take a color name like cyan, look up its hue on the 65000 point scale,
+  #   and pass that number to the light's hue= method to recolor the light.
+  def set_color(name)
+    unless colors.include? name.downcase
+      raise ArgumentError.new("I don't know that color!")
+    end
+
+    light.hue = hue_for_color(name)
+  end
+  # END:color_names
+
+  # START:color_backend
+  # RGB color wheel from 0 to 65535:
+  #   red is 0 (and 65535 because the wheel starts over at the end)
+  #   green is ~21000
+  #   blue is ~44000
+  def hue_for_color(name)
+    # green has an index of 4 in the colors array above
+    color_index = colors.find_index(name)
+
+    # each color is 65535 / 12 points "wide",
+    #   which is 5461 points on this RGB color wheel.
+    color_width = (max_color / colors.count).to_i
+
+    # green's hue is thus 4 * 5461 = 21845.
+    color_index * color_width
+  end
+
+  private
+  # The hue gem has a built-in constant range to track the number of distinct
+  #   color hues the system exposes for a given colored bulb, i.e. 2^16 or
+  #   "16-bit" color.
+  def max_color
+    # 0..65535
+    Hue::Light::HUE_RANGE.last
+  end
+  # END:color_backend
+end

data/lita-hue-lightswitch.gemspec

@@ -0,0 +1,27 @@
+Gem::Specification.new do |spec|
+  spec.name          = "lita-hue-lightswitch"
+  spec.version       = "1.0.0"
+  spec.authors       = ["Daniel J. Pritchett"]
+  spec.email         = ["daniel@gremlin.com"]
+  spec.description   = "Control Hue lights with a Lita chatbot"
+  spec.summary       = "Control Hue lights with a Lita chatbot"
+  spec.homepage      = "https://github.com/dpritchett/lita-hue-lightswitch"
+  spec.license       = "MIT"
+  spec.metadata      = { "lita_plugin_type" => "handler" }
+
+  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"]
+
+  # START:runtime
+  spec.add_runtime_dependency "lita", ">= 4.7"
+  spec.add_runtime_dependency "hue", "~> 0.2.0"
+  # END:runtime
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rack-test"
+  spec.add_development_dependency "rspec", ">= 3.0.0"
+end

data/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  lita:
+    handlers:
+      hue_lightswitch:

data/spec/lita/handlers/hue_colored_bulb_spec.rb

@@ -0,0 +1,64 @@
+# START:header
+require "spec_helper"
+
+describe HueColoredBulb do
+  let(:bulb_name) { 'Bloom' }
+  subject { described_class.new(bulb_name) }
+  # END:header
+
+  # START:basics
+  it 'can turn on and off' do
+    subject.on!
+    subject.off!
+  end
+
+  it 'has a list of colors' do
+    actual = subject.colors
+    expect(actual.first).to eq('red')
+    expect(actual).to include('azure')
+  end
+
+  context 'setting a color' do
+    it 'can be colored cyan' do
+      expect{subject.set_color 'cyan'}.to_not raise_error
+    end
+
+    it 'cannot be colored burnt sienna' do
+      expect{subject.set_color 'burnt_sienna'}.to raise_error(ArgumentError)
+    end
+  end
+  # END:basics
+
+  # START:math
+  context 'color hue estimations' do
+    it 'has red at 0 hue' do
+      actual = subject.hue_for_color 'red'
+      expect(actual).to eq(0)
+    end
+
+    it 'has green at approximately 21k hue' do
+      actual = subject.hue_for_color 'green'
+      # absolute value of hue_for_color('green') should be within 1000
+      # of the 21,000 approximation specified here.
+      delta = (actual - 21000).abs
+      expect(delta < 1000).to be_truthy
+    end
+
+    it 'has blue at approximately 44k hue' do
+      actual = subject.hue_for_color 'blue'
+      delta = (actual - 44000).abs
+      expect(delta < 1000).to be_truthy
+    end
+  end
+  # END:math
+
+  # START:demo
+  context 'color wheel demo' do
+    it 'displays each color exactly once' do
+      n = subject.colors.count
+      expect(subject.light).to receive(:hue=).exactly(n).times
+      subject.demo(0.0001)
+    end
+  end
+  # END:demo
+end

data/spec/lita/handlers/hue_lightswitch_spec.rb

@@ -0,0 +1,59 @@
+# START:header
+require "spec_helper"
+
+describe Lita::Handlers::HueLightswitch, lita_handler: true do
+  subject { described_class.new(robot) }
+  # END:header
+
+  # START:routes
+  it { is_expected.to route("Lita hue color green") }
+  it { is_expected.to route("Lita hue list_colors") }
+  it { is_expected.to route("Lita hue off") }
+  it { is_expected.to route("Lita hue on") }
+  # END:routes
+
+  # START:client
+  context 'using a dummy HueColoredBulb client' do
+    let(:bulb) { double(:bulb) }
+    before { subject.stub(:light).and_return bulb }
+    # Intentionally deviating from the color list of the actual
+    #   HueColoredBulb class for two reasons:
+    #   - three colors make for simpler testing than 12
+    #   - violating some of the numeric assumptions of the linked
+    #       class might give us a more robust integration by assuming
+    #       as little as necessary from this calling class.
+    before { bulb.stub(:colors).and_return %w[red orange green] }
+    # END:client
+
+    # START:power
+    it 'can turn off the bulb' do
+      expect(bulb).to receive(:off!)
+      actual = subject.hue_execute 'off'
+      expect(actual).to match /Turning off/
+    end
+
+    it 'can turn off the bulb' do
+      expect(bulb).to receive(:on!)
+      actual = subject.hue_execute 'on'
+      expect(actual).to match /Turning on/
+    end
+    # END:power
+
+    # START:colors
+    it 'can list colors' do
+      actual = subject.list_colors
+      expect(actual).to include 'green'
+      expect(actual).to include 'red'
+      expect(actual).to include 'orange'
+    end
+
+    it 'can recolor the bulb' do
+      new_color = bulb.colors.sample
+
+      expect(bulb).to receive(:set_color)
+      actual = subject.hue_execute "color", [new_color]
+      expect(actual).to match /Setting color to #{new_color}/
+    end
+    # END:colors
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "lita-hue-lightswitch"
+require "lita/rspec"
+
+# A compatibility mode is provided for older plugins upgrading from Lita 3. Since this plugin
+# was generated with Lita 4, the compatibility mode should be left disabled.
+Lita.version_3_compatibility_mode = false

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: lita-hue-lightswitch
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Daniel J. Pritchett
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lita
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: hue
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.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: pry-byebug
+  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: 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: rack-test
+  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: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Control Hue lights with a Lita chatbot
+email:
+- daniel@gremlin.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- examples/001-hue-demo.rb
+- examples/002-lita-demo.session
+- lib/lita-hue-lightswitch.rb
+- lib/lita/handlers/hue_lightswitch.rb
+- lib/lita/hue_colored_bulb.rb
+- lita-hue-lightswitch.gemspec
+- locales/en.yml
+- spec/lita/handlers/hue_colored_bulb_spec.rb
+- spec/lita/handlers/hue_lightswitch_spec.rb
+- spec/spec_helper.rb
+- templates/.gitkeep
+homepage: https://github.com/dpritchett/lita-hue-lightswitch
+licenses:
+- MIT
+metadata:
+  lita_plugin_type: handler
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Control Hue lights with a Lita chatbot
+test_files:
+- spec/lita/handlers/hue_colored_bulb_spec.rb
+- spec/lita/handlers/hue_lightswitch_spec.rb
+- spec/spec_helper.rb