ruku 0.1

data/test/test_remotes.rb

@@ -0,0 +1,144 @@
+require File.expand_path(File.dirname(__FILE__) + '/helper')
+
+class TestRemotes < Test::Unit::TestCase
+  TEST_NAME_1 = 'Remote 1'
+  TEST_NAME_2 = 'Remote 2'
+  TEST_NAME_3 = 'Remote 3'
+  TEST_HOST_1 = '192.168.1.5'
+  TEST_HOST_2 = '192.168.1.6'
+  TEST_HOST_3 = '192.168.1.7'
+
+  def setup
+    @test_storage_path = File.join(File.dirname(__FILE__), 'tmp', '.ruku')
+    cleanup
+    @remote1 = Remote.new(TEST_HOST_1, TEST_NAME_1)
+    @remote2 = Remote.new(TEST_HOST_2, TEST_NAME_2)
+    @remote3 = Remote.new(TEST_HOST_3, TEST_NAME_3)
+  end
+
+  def teardown
+    cleanup
+  end
+
+  def test_initialize_adds_boxes
+    assert Remotes.new.empty?
+
+    m = Remotes.new([@remote1])
+    assert_equal 1, m.boxes.size
+    assert m.boxes.include?(@remote1)
+
+    m = Remotes.new([@remote1, @remote2])
+    assert_equal 2, m.boxes.size
+    assert m.boxes.include?(@remote1)
+    assert m.boxes.include?(@remote2)
+  end
+
+  def test_active_box_defaults_to_first
+    assert_equal @remote1, Remotes.new([@remote1]).active
+    assert_equal @remote1, Remotes.new([@remote1, @remote2]).active
+  end
+
+  def test_active_box_is_nil_if_no_boxes
+    assert_nil Remotes.new.active
+  end
+
+  def test_set_active
+    m = Remotes.new([@remote1, @remote2])
+    assert_equal @remote1, m.active
+    m.set_active(@remote2)
+    assert_equal @remote2, m.active
+  end
+
+  def test_add
+    m = Remotes.new([@remote1, @remote2])
+    assert_equal 2, m.boxes.size
+    m.add(@remote3)
+    assert_equal 3, m.boxes.size
+    m.boxes.include?(@remote3)
+  end
+
+  def test_add_does_not_add_duplicates
+    m = Remotes.new([@remote1, @remote2])
+    assert_equal 2, m.boxes.size
+    m.add(@remote2)
+    assert_equal 2, m.boxes.size
+  end
+
+  def test_remove
+    m = Remotes.new([@remote1, @remote2])
+    assert_equal 2, m.boxes.size
+
+    m.remove(@remote2)
+    assert_equal 1, m.boxes.size
+    assert !m.boxes.include?(@remote2)
+
+    m.remove(@remote1)
+    assert m.boxes.empty?
+    assert !m.boxes.include?(@remote2)
+  end
+
+  def test_remove_adjusts_active
+    m = Remotes.new([@remote1, @remote2])
+    m.set_active(@remote2)
+    assert_equal @remote2, m.active
+    m.remove(@remote2)
+    assert_equal @remote1, m.active
+
+    m = Remotes.new([@remote1, @remote2])
+    assert_equal @remote1, m.active
+    m.remove(@remote1)
+    assert_equal @remote2, m.active
+  end
+
+  def test_remove_non_existent
+    m = Remotes.new([@remote1, @remote2])
+    assert_equal 2, m.boxes.size
+
+    m.remove(@remote3)
+    assert_equal 2, m.boxes.size
+  end
+
+  def test_store_and_load
+    storage = YAMLStorage.new(@test_storage_path)
+    Remotes.new([@remote1, @remote2], storage).store
+    m = Remotes.new
+    m.storage = storage
+    m.load
+
+    assert_equal 2, m.boxes.size
+    assert_equal @remote1, m.boxes[0]
+    assert_equal @remote2, m.boxes[1]
+    assert_equal @remote1, m.active
+  end
+
+  def test_each
+    m = Remotes.new([@remote1, @remote2])
+    hosts = []
+    m.each {|b| hosts << b.host}
+    assert_equal 2, hosts.size
+    assert hosts.include?(TEST_HOST_1)
+    assert hosts.include?(TEST_HOST_2)
+  end
+
+  def test_subscript_reader
+    m = Remotes.new([@remote1, @remote2])
+    assert_equal TEST_HOST_1, m[0].host
+    assert_equal TEST_HOST_2, m[1].host
+  end
+
+  def test_subscript_writer
+    m = Remotes.new
+    m[0] = @remote1
+    assert_equal TEST_HOST_1, m[0].host
+    m[0] = @remote2
+    assert_equal TEST_HOST_2, m[0].host
+    m[1] = @remote3
+    assert_equal TEST_HOST_3, m[1].host
+  end
+
+  protected
+
+  def cleanup
+    File.delete(@test_storage_path) if File.exist?(@test_storage_path)
+  end
+end

data/test/test_simple_client.rb

@@ -0,0 +1,166 @@
+require File.expand_path(File.dirname(__FILE__) + '/helper')
+require 'ruku/clients/simple'
+require 'stringio'
+
+# Tests for Ruku::Clients::Simple; most of these are more integration tests
+# since the client is just a UI wrapper around the important stuff
+class TestSimpleClient < Test::Unit::TestCase
+  TEST_NAME_1 = 'Remote 1'
+  TEST_NAME_2 = 'Remote 2'
+  TEST_NAME_3 = 'Remote 3'
+  TEST_HOST_1 = '192.168.1.5'
+  TEST_HOST_2 = '192.168.1.6'
+  TEST_HOST_3 = '192.168.1.7'
+
+  def setup
+    @output = ''
+    @output_stream = StringIO.new(@output, 'w')
+  end
+
+  def teardown
+    @output_stream.close
+  end
+
+  # Tests output of 'list' command line operation, trying to ignore slight
+  # changes in UI like the header and making sure things like the names
+  # and hosts of the remotes are displayed
+  def test_cmd_line_list
+    sc, out = get_test_client_and_output
+    sc.list
+
+    lines_method = ''.respond_to?(:lines) ? :lines : :to_s
+    active1 = out.send(lines_method).find {|l| l.include? TEST_HOST_1}
+    inactive2 = out.send(lines_method).find {|l| l.include? TEST_HOST_2}
+    inactive3 = out.send(lines_method).find {|l| l.include? TEST_HOST_3}
+
+    assert active1, 'Active box host found in output'
+    assert active1.include?(TEST_NAME_1), 'Active box name on same line as host'
+    assert active1.include?('active'), 'Active box marked as such in output'
+
+    assert inactive2, 'First inactive box host found in output'
+    assert inactive2.include?(TEST_NAME_2), 'First inactive box name on same line as host'
+    assert !inactive2.include?('active'), 'First inactive box not marked as active'
+
+    assert inactive3, 'Second inactive box host found in output'
+    assert inactive3.include?(TEST_NAME_3), 'Second inactive box name on same line as host'
+    assert !inactive3.include?('active'), 'Second inactive box not marked as active'
+  end
+
+  def test_add
+    sc, out = get_test_client_and_output
+    storage_mock = mock()
+    sc.remotes = Remotes.new([], storage_mock)
+    storage_mock.expects(:store).with(sc.remotes).once
+
+    sc.add(TEST_HOST_1)
+
+    assert sc.remotes.find {|b| b.host == TEST_HOST_1}, 'Box has been added'
+
+    assert out.include?('Added'), 'Output indicates addition'
+    assert out.include?(TEST_HOST_1), 'Output includes correct host'
+    assert out.include?('My Roku Box'), 'Output shows (default) box name'
+  end
+
+  def test_add_with_name
+    sc, out = get_test_client_and_output
+    storage_mock = mock()
+    sc.remotes = Remotes.new([], storage_mock)
+    storage_mock.expects(:store).with(sc.remotes).once
+
+    sc.add(TEST_HOST_1, TEST_NAME_1)
+
+    assert sc.remotes.find {|b| b.host == TEST_HOST_1}, 'Box has been added'
+
+    assert out.include?('Added'), 'Output indicates addition'
+    assert out.include?(TEST_HOST_1), 'Output includes correct host'
+    assert out.include?(TEST_NAME_1), 'Output shows correct box name'
+  end
+
+  def test_add_changes_existing_box_name
+    sc, out = get_test_client_and_output
+    storage_mock = mock()
+    sc.remotes = Remotes.new([Remote.new(TEST_HOST_1, TEST_NAME_1)], storage_mock)
+    storage_mock.expects(:store).with(sc.remotes).once
+
+    new_name = 'Brand New Name'
+    sc.add(TEST_HOST_1, new_name)
+
+    assert sc.remotes.find {|b| b.host == TEST_HOST_1}, 'Box is still there'
+    assert_equal new_name, sc.remotes.find {|b| b.host == TEST_HOST_1}.name, 'Name changed correctly'
+
+    assert out.include?('Added'), 'Output indicates addition (even though it is not, really)'
+    assert out.include?(TEST_HOST_1), 'Output includes correct host'
+    assert out.include?(new_name), 'Output shows changed box name'
+  end
+
+  def test_remove_by_host
+    sc, out = get_test_client_and_output
+    storage_mock = mock()
+    sc.remotes.storage = storage_mock
+    storage_mock.expects(:store).with(sc.remotes).once
+
+    sc.remove(TEST_HOST_2)
+
+    assert_equal 2, sc.remotes.size, 'There is one less remote'
+    assert sc.remotes.find {|b| b.host == TEST_HOST_1}, 'Did not remove the wrong remote'
+    assert sc.remotes.find {|b| b.host == TEST_HOST_3}, 'Did not remove the wrong remote'
+
+    assert out.include?('removed'), 'Output indicates removal'
+    assert out.include?(TEST_HOST_2), 'Output includes correct host'
+  end
+
+  def test_name_with_host
+    sc, out = get_test_client_and_output
+    storage_mock = mock()
+    sc.remotes.storage = storage_mock
+    storage_mock.expects(:store).with(sc.remotes).once
+
+    new_name = 'Renamed!'
+    sc.name(TEST_HOST_3, new_name)
+
+    assert_equal 3, sc.remotes.size, 'Did not add or remove any remotes'
+    assert_equal new_name, sc.remotes.find {|r| r.host == TEST_HOST_3}.name, 'The name is changed'
+  end
+
+  def test_activate_with_host
+    sc, out = get_test_client_and_output
+    storage_mock = mock()
+    sc.remotes.storage = storage_mock
+    storage_mock.expects(:store).with(sc.remotes).once
+
+    assert_equal TEST_HOST_1, sc.remotes.active.host
+
+    sc.activate(TEST_HOST_3)
+
+    assert_equal TEST_HOST_3, sc.remotes.active.host
+    assert out.include?('activated'), 'Activation indicated'
+    assert out.include?(TEST_HOST_3), 'Output includes correct host'
+  end
+
+  private
+
+  def get_test_remotes
+    @remote1 = Remote.new(TEST_HOST_1, TEST_NAME_1)
+    @remote2 = Remote.new(TEST_HOST_2, TEST_NAME_2)
+    @remote3 = Remote.new(TEST_HOST_3, TEST_NAME_3)
+    Remotes.new([@remote1, @remote2, @remote3])
+  end
+
+  def get_test_client_and_output
+    sc = Clients::Simple.new(get_test_remotes)
+    sc.output_stream = @output_stream
+    [sc, @output]
+  end
+end
+
+class Ruku::Clients::Simple
+  attr_accessor :output_stream
+
+  def puts(str)
+    @output_stream.puts str
+  end
+
+  def print(str)
+    @output_stream.print str
+  end
+end

data/test/test_simple_storage.rb

@@ -0,0 +1,70 @@
+require File.expand_path(File.dirname(__FILE__) + '/helper')
+
+class TestSimpleStorage < Test::Unit::TestCase
+  TMP_DIR = File.join(File.dirname(__FILE__), 'tmp')
+  BOXES_FILE = File.join(TMP_DIR, 'boxes.txt')
+
+  TEST_NAME_1 = 'Living Room'
+  TEST_NAME_2 = 'Upstairs'
+  TEST_NAME_3 = nil
+  TEST_HOST_1 = '192.168.1.5'
+  TEST_HOST_2 = 'NP-20F8A0003472'
+  TEST_HOST_3 = '192.168.1.7'
+
+  def setup
+    cleanup
+    @remote1 = Remote.new(TEST_HOST_1, TEST_NAME_1)
+    @remote2 = Remote.new(TEST_HOST_2, TEST_NAME_2)
+    @remote3 = Remote.new(TEST_HOST_3, TEST_NAME_3)
+    @test_remotes = [@remote1, @remote2, @remote3]
+    @remotes = Remotes.new(@test_remotes)
+  end
+
+  def teardown; cleanup; end
+
+  def test_initialize_and_read_storage_path
+    assert_equal BOXES_FILE, SimpleStorage.new(BOXES_FILE).storage_path
+  end
+
+  def test_store_and_load_box_manager
+    SimpleStorage.new(BOXES_FILE).store(@remotes)
+    boxes = SimpleStorage.new(BOXES_FILE).load
+    assert_equal @remotes.boxes.size, boxes.boxes.size
+    assert_equal @remotes.active, boxes.active
+
+    box1, box2, box3 = boxes.boxes[0], boxes.boxes[1], boxes.boxes[2]
+    assert_equal TEST_NAME_1, box1.name
+    assert_equal TEST_HOST_1, box1.host
+    assert_equal TEST_NAME_2, box2.name
+    assert_equal TEST_HOST_2, box2.host
+    assert_equal TEST_NAME_3, box3.name
+    assert_equal TEST_HOST_3, box3.host
+  end
+
+  def test_store_no_boxes
+    SimpleStorage.new(BOXES_FILE).store(Remotes.new)
+    boxes = SimpleStorage.new(BOXES_FILE).load
+    assert boxes.boxes.empty?
+  end
+
+  def test_load_from_non_existent_file
+    boxes = SimpleStorage.new(BOXES_FILE).load
+    assert boxes.boxes.empty?
+  end
+
+  def test_box_config_format_is_correct
+    SimpleStorage.new(BOXES_FILE).store(@remotes)
+    lines = IO.read(BOXES_FILE).split("\n")
+    assert_equal 3, lines.size
+
+    assert_equal '192.168.1.5:Living Room', lines[0]
+    assert_equal 'NP-20F8A0003472:Upstairs', lines[1]
+    assert_equal '192.168.1.7', lines[2]
+  end
+
+  protected
+
+  def cleanup
+    File.delete(BOXES_FILE) if File.exist?(BOXES_FILE)
+  end
+end

data/test/test_web_client.rb

@@ -0,0 +1,46 @@
+require File.expand_path(File.dirname(__FILE__) + '/helper')
+require 'ruku/clients/web'
+require 'json'
+
+class TestWebClient < Test::Unit::TestCase
+  TEST_HOST_1 = "192.168.1.5"
+  TEST_NAME_1 = "Living room"
+  TEST_HOST_2 = "192.168.1.17"
+  TEST_NAME_2 = "Basement"
+  TEST_PORT_2 = 9090
+
+  def test_remote_to_json
+    parsed = JSON.parse(test_remotes.first.to_json)
+    assert_equal TEST_HOST_1, parsed['host']
+    assert_equal TEST_NAME_1, parsed['name']
+    assert_equal 8080, parsed['port']
+
+    parsed = JSON.parse(test_remotes.last.to_json)
+    assert_equal TEST_HOST_2, parsed['host']
+    assert_equal TEST_NAME_2, parsed['name']
+    assert_equal TEST_PORT_2, parsed['port']
+  end
+
+  def test_remote_manager_remotes_from_json
+    json = "{\"remotes\":[" +
+      "{\"host\":\"#{TEST_HOST_1}\",\"name\":\"#{TEST_NAME_1}\"}," +
+      "{\"host\":\"#{TEST_HOST_2}\",\"name\":\"#{TEST_NAME_2}\", \"port\":#{TEST_PORT_2}}" +
+    "],\"active\":1}"
+    rm = Remotes.new
+    rm.remotes_from_json(json)
+    assert_equal 2, rm.boxes.size
+    assert_equal TEST_HOST_1, rm.boxes.first.host
+    assert_equal TEST_NAME_1, rm.boxes.first.name
+    assert_equal 8080, rm.boxes.first.port
+    assert_equal TEST_HOST_2, rm.boxes.last.host
+    assert_equal TEST_NAME_2, rm.boxes.last.name
+    assert_equal TEST_PORT_2, rm.boxes.last.port
+    assert_equal TEST_HOST_2, rm.active.host
+  end
+
+  protected
+
+  def test_remotes
+    [Remote.new(TEST_HOST_1, TEST_NAME_1), Remote.new(TEST_HOST_2, TEST_NAME_2, TEST_PORT_2)]
+  end
+end

data/test/test_yaml_storage.rb

@@ -0,0 +1,54 @@
+require File.expand_path(File.dirname(__FILE__) + '/helper')
+
+class TestYAMLStorage < Test::Unit::TestCase
+  TMP_DIR = File.join(File.dirname(__FILE__), 'tmp', '.ruku')
+
+  TEST_NAME_1 = 'Remote 1'
+  TEST_NAME_2 = 'Remote 2'
+  TEST_HOST_1 = '192.168.1.5'
+  TEST_HOST_2 = '192.168.1.6'
+
+  def setup
+    cleanup
+    @remote1 = Remote.new(TEST_HOST_1, TEST_NAME_1)
+    @remote2 = Remote.new(TEST_HOST_2, TEST_NAME_2)
+    @test_remotes = [@remote1, @remote2]
+    @box_manager = Remotes.new(@test_remotes)
+  end
+
+  def teardown; cleanup; end
+
+  def test_initialize_and_read_storage_path
+    assert_equal TMP_DIR, YAMLStorage.new(TMP_DIR).storage_path
+  end
+
+  def test_store_and_load_box_manager
+    YAMLStorage.new(TMP_DIR).store(@box_manager)
+    m = YAMLStorage.new(TMP_DIR).load
+    assert_equal @box_manager.boxes.size, m.boxes.size
+    assert_equal @box_manager.active, m.active
+
+    box1, box2 = m.boxes[0], m.boxes[1]
+    assert_equal TEST_NAME_1, box1.name
+    assert_equal TEST_HOST_1, box1.host
+    assert_equal TEST_NAME_2, box2.name
+    assert_equal TEST_HOST_2, box2.host
+  end
+
+  def test_store_no_boxes
+    YAMLStorage.new(TMP_DIR).store(Remotes.new)
+    m = YAMLStorage.new(TMP_DIR).load
+    assert_equal 0, m.boxes.size
+  end
+
+  def test_load_from_non_existent_file
+    m = YAMLStorage.new(TMP_DIR).load
+    assert m.boxes.empty?
+  end
+
+  protected
+
+  def cleanup
+    File.delete(TMP_DIR) if File.exist?(TMP_DIR)
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification 
+name: ruku
+version: !ruby/object:Gem::Version 
+  hash: 9
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  version: "0.1"
+platform: ruby
+authors: 
+- Aaron Royer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-01 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 41
+        segments: 
+        - 0
+        - 9
+        - 9
+        version: 0.9.9
+  type: :development
+  version_requirements: *id002
+description: "Roku\xE2\x84\xA2 set-top box remote control, command line and web interfaces"
+email: aaronroyer@gmail.com
+executables: 
+- ruku
+extensions: []
+
+extra_rdoc_files: 
+- MIT-LICENSE
+files: 
+- bin/ruku
+- lib/ruku/clients/simple.rb
+- lib/ruku/clients/tk.rb
+- lib/ruku/clients/web.rb
+- lib/ruku/clients/web_static/css/ruku.css
+- lib/ruku/clients/web_static/images/box-medium.png
+- lib/ruku/clients/web_static/images/box-small.png
+- lib/ruku/clients/web_static/images/remote/back-over.png
+- lib/ruku/clients/web_static/images/remote/back.png
+- lib/ruku/clients/web_static/images/remote/down-over.png
+- lib/ruku/clients/web_static/images/remote/down.png
+- lib/ruku/clients/web_static/images/remote/fwd-over.png
+- lib/ruku/clients/web_static/images/remote/fwd.png
+- lib/ruku/clients/web_static/images/remote/home-over.png
+- lib/ruku/clients/web_static/images/remote/home.png
+- lib/ruku/clients/web_static/images/remote/left-over.png
+- lib/ruku/clients/web_static/images/remote/left.png
+- lib/ruku/clients/web_static/images/remote/pause-over.png
+- lib/ruku/clients/web_static/images/remote/pause.png
+- lib/ruku/clients/web_static/images/remote/right-over.png
+- lib/ruku/clients/web_static/images/remote/right.png
+- lib/ruku/clients/web_static/images/remote/select-over.png
+- lib/ruku/clients/web_static/images/remote/select.png
+- lib/ruku/clients/web_static/images/remote/space1.png
+- lib/ruku/clients/web_static/images/remote/space2.png
+- lib/ruku/clients/web_static/images/remote/space3.png
+- lib/ruku/clients/web_static/images/remote/up-over.png
+- lib/ruku/clients/web_static/images/remote/up.png
+- lib/ruku/clients/web_static/images/spacer.gif
+- lib/ruku/clients/web_static/index.html
+- lib/ruku/clients/web_static/js/jquery-1.4.2.js
+- lib/ruku/clients/web_static/js/ruku.js
+- lib/ruku/remote.rb
+- lib/ruku/remotes.rb
+- lib/ruku/storage.rb
+- lib/ruku.rb
+- test/helper.rb
+- test/js/qunit.css
+- test/js/qunit.js
+- test/js/runner.html
+- test/js/test_remote.js
+- test/js/test_remote_manager.js
+- test/js/test_remote_menu.js
+- test/js/test_util.js
+- test/test_remote.rb
+- test/test_remotes.rb
+- test/test_simple_client.rb
+- test/test_simple_storage.rb
+- test/test_web_client.rb
+- test/test_yaml_storage.rb
+- README.rdoc
+- MIT-LICENSE
+- ruku.gemspec
+- Rakefile
+has_rdoc: true
+homepage: http://github.com/aaronroyer/ruku
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: "Ruku provides command line and web remote control interfaces for controlling all your Roku\xE2\x84\xA2 set-top boxes over a network."
+test_files: 
+- test/test_remote.rb
+- test/test_remotes.rb
+- test/test_simple_client.rb
+- test/test_simple_storage.rb
+- test/test_web_client.rb
+- test/test_yaml_storage.rb