hacky_hal 0.2.0

data/spec/hacky_hal/device_controllers/generic_ssh_spec.rb

@@ -0,0 +1,141 @@
+require "spec_helper"
+require "hacky_hal/device_controllers/generic_ssh"
+
+describe HackyHAL::DeviceControllers::GenericSsh do
+  it "should require host option" do
+    expect { described_class.new({}) }.
+      to raise_error(ArgumentError,
+                     "HackyHAL::DeviceControllers::GenericSsh must set host option.")
+  end
+
+  it "should require user option" do
+    expect { described_class.new(host: "foo") }.
+      to raise_error(ArgumentError,
+                     "HackyHAL::DeviceControllers::GenericSsh must set user option.")
+  end
+
+  describe "with valid options" do
+    before(:each) do
+      @generic_ssh = described_class.new(
+        host: "foo",
+        user: "bar"
+      )
+
+      @ssh = double("ssh connection")
+      @ssh.stub(:exec!).and_yield(nil, nil, "dummy output")
+      @ssh.stub(:close)
+      @ssh.stub(:closed?).and_return(false)
+      Net::SSH.stub(:start).and_return(@ssh)
+    end
+
+    describe "#exec" do
+      it "should pass command to ssh.exec!" do
+        @ssh.should_receive(:exec!).with("dummy_command")
+        @generic_ssh.exec("dummy_command")
+      end
+
+      it "should connect if not connected" do
+        @generic_ssh.should_receive(:connected?).and_return(false)
+        @generic_ssh.should_receive(:connect)
+        @generic_ssh.stub(:ssh_exec)
+        @generic_ssh.stub(:disconnect)
+        @generic_ssh.exec("dummy_command")
+      end
+
+      it "should not connect if already connected" do
+        @generic_ssh.should_receive(:connected?).and_return(true)
+        @generic_ssh.should_not_receive(:connect)
+        @generic_ssh.stub(:ssh_exec)
+        @generic_ssh.stub(:disconnect)
+        @generic_ssh.exec("dummy_command")
+      end
+
+      it "should join output from ssh.exec!" do
+        @ssh.stub(:exec!).and_yield(nil, nil, "foo").and_yield(nil, nil, "bar")
+        @generic_ssh.exec("dummy_command").should == "foobar"
+      end
+
+      it "should log debug message" do
+        @generic_ssh.should_receive(:log).with("Command: \"dummy_command\"", :debug)
+        @generic_ssh.should_receive(:log).with("Output: \"dummy output\"", :debug)
+        @generic_ssh.exec("dummy_command")
+      end
+
+      describe "on command failure" do
+        before(:each) do
+          @generic_ssh.stub(:ssh_exec).and_raise(EOFError.new("foo"))
+        end
+
+        it "should log warn message" do
+          @generic_ssh.should_receive(:log).with("Command: \"dummy_command\"", :debug).twice
+          @generic_ssh.should_receive(:log).with("Command failed: EOFError - foo", :warn).twice
+          @generic_ssh.should_receive(:log).with("Retrying last command", :warn).once
+          @generic_ssh.exec("dummy_command")
+        end
+
+        it "should retry once after reconnecting" do
+          @generic_ssh.should_receive(:disconnect).twice
+          @generic_ssh.should_receive(:connect).twice
+          @generic_ssh.exec("dummy_command")
+        end
+      end
+    end
+
+    describe "#connect" do
+      it "should disconnect if already connected" do
+        @generic_ssh.connect
+        @generic_ssh.should_receive(:disconnect)
+        @generic_ssh.connect
+      end
+
+      it "should open a new Net:SSH connection" do
+        Net::SSH.should_receive(:start)
+        @generic_ssh.connect
+      end
+
+      it "should log warn message on error" do
+        Net::SSH.should_receive(:start).and_raise(SocketError.new("dummy message"))
+        @generic_ssh.should_receive(:log).with("Failed to connect: SocketError - dummy message", :warn)
+        @generic_ssh.connect
+      end
+    end
+
+    describe "disconnect" do
+      it "should close the ssh connection if connected" do
+        @generic_ssh.connect
+        @ssh.should_receive(:close)
+        @generic_ssh.disconnect.should be_nil
+      end
+
+      it "should not close the ssh connection if not connected" do
+        @generic_ssh.should_receive(:connected?).and_return(false)
+        @ssh.should_not_receive(:close)
+        @generic_ssh.disconnect.should be_nil
+      end
+
+      it "should return nil on Net::SSH::Disconnect" do
+        @generic_ssh.connect
+        @ssh.should_receive(:close).and_raise(Net::SSH::Disconnect)
+        @generic_ssh.disconnect.should be_nil
+      end
+
+      it "should still disconnect on Net::SSH::Disconnect" do
+        @generic_ssh.connect
+        @ssh.should_receive(:close).and_raise(Net::SSH::Disconnect)
+        @generic_ssh.disconnect
+        @generic_ssh.connected?.should be_false
+      end
+    end
+
+    describe "connect?" do
+      it "should return true if connected" do
+        @generic_ssh.connect
+        @generic_ssh.connected?.should be_true
+      end
+
+      it "should return false if not connected" do
+        @generic_ssh.connected?.should be_false
+      end
+    end
+  end
+end

data/spec/hacky_hal/device_controllers/roku_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+require "hacky_hal/device_controllers/roku"
+
+module HackyHAL
+  module DeviceResolvers
+    module Dummy
+    end
+  end
+end
+
+describe HackyHAL::DeviceControllers::Roku do
+  it "should require device_resolver" do
+    expect { described_class.new({}) }.to raise_error(
+      ArgumentError,
+      "HackyHAL::DeviceControllers::Roku must set device_resolver option."
+    )
+  end
+
+  # FIXME: identical in YamahaAvReceiver spec
+  it "should resolve host through device resolver" do
+    resolved_uri = double("resolved URI")
+    resolved_uri.stub(:path=)
+    resolved_uri.stub(:port=)
+    device_resolver = double("device resolver")
+    device_resolver.should_receive(:uri).and_return(resolved_uri)
+    HackyHAL::DeviceResolvers::Dummy.should_receive(:new).with(foo: 1).and_return(device_resolver)
+    controller = described_class.new(device_resolver: {type: 'Dummy', foo: 1})
+    controller.host_uri.should == resolved_uri
+  end
+end

data/spec/hacky_hal/device_controllers/yamaha_av_receiver_spec.rb

@@ -0,0 +1,29 @@
+require "spec_helper"
+require "hacky_hal/device_controllers/yamaha_av_receiver"
+
+module HackyHAL
+  module DeviceResolvers
+    module Dummy
+    end
+  end
+end
+
+describe HackyHAL::DeviceControllers::YamahaAvReceiver do
+  it "should require device_resolver" do
+    expect { described_class.new({}) }.to raise_error(
+      ArgumentError,
+      "HackyHAL::DeviceControllers::YamahaAvReceiver must set device_resolver option."
+    )
+  end
+  
+  it "should resolve host through device resolver" do
+    resolved_uri = double("resolved URI")
+    resolved_uri.stub(:path=)
+    resolved_uri.stub(:port=)
+    device_resolver = double("device resolver")
+    device_resolver.should_receive(:uri).and_return(resolved_uri)
+    HackyHAL::DeviceResolvers::Dummy.should_receive(:new).with(foo: 1).and_return(device_resolver)
+    controller = described_class.new(device_resolver: {type: 'Dummy', foo: 1})
+    controller.host_uri.should == resolved_uri
+  end
+end

data/spec/hacky_hal/device_resolvers/base_spec.rb

@@ -0,0 +1,8 @@
+require "spec_helper"
+require "hacky_hal/device_resolvers/base"
+
+describe HackyHAL::DeviceResolvers::Base do
+  it "should include Options" do
+    described_class.ancestors.should include(HackyHAL::Options)
+  end
+end

data/spec/hacky_hal/device_resolvers/ssdp_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+require "hacky_hal/device_resolvers/ssdp"
+
+describe HackyHAL::DeviceResolvers::SSDP do
+  it "should require usn option" do
+    expect { described_class.new({}) }.to raise_error(
+      ArgumentError,
+      "#{described_class.name} must set usn option."
+    )
+  end
+
+  it "should default to search for root devices" do
+    resolver = described_class.new(usn: "dummy-usn")
+    resolver.options[:search].should == "upnp:rootdevice"
+  end
+
+  describe "instance" do
+    before(:each) do
+      @resolver = described_class.new(search: "dummy-device-search", usn: "dummy-usn")
+    end
+
+    it "should return uri resolved via SSDP" do
+      UPnP::SSDP.stub(:search).and_return([
+        {location: "http://resolved-host/path", usn: "dummy-usn"}
+      ])
+      @resolver.uri.host.should == "resolved-host"
+    end
+
+    it "should raise SsdpUnresolvedDevice if no device found" do
+      UPnP::SSDP.stub(:search).and_return([])
+      expect { @resolver.uri }.to raise_error(HackyHAL::DeviceResolvers::SsdpUnresolvedDevice)
+    end
+
+    it "should return the host of device with given USN" do
+      UPnP::SSDP.stub(:search).and_return([
+        {location: "http://other-resolved-host/path", usn: "other-usn"},
+        {location: "http://resolved-host/path", usn: "dummy-usn"}
+      ])
+      @resolver.uri.host.should == "resolved-host"
+    end
+
+    it "should raise SsdpUnresolvedDevice if device with request USN not found" do
+      UPnP::SSDP.stub(:search).and_return([
+        {location: "http://other-resolved-host/path", usn: "other-usn"}
+      ])
+      expect { @resolver.uri }.to raise_error(HackyHAL::DeviceResolvers::SsdpUnresolvedDevice)
+    end
+  end
+end

data/spec/hacky_hal/device_resolvers/static_uri_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+require "hacky_hal/device_resolvers/static_uri"
+
+describe HackyHAL::DeviceResolvers::StaticURI do
+  it "should require uri option" do
+    expect { described_class.new({}) }.to raise_error(
+      ArgumentError,
+      "#{described_class.name} must set uri option."
+    )
+  end
+
+  it "should return static host" do
+    resolver = described_class.new(uri: "http://device-host.local")
+    resolver.uri.host.should == "device-host.local"
+  end
+end

data/spec/hacky_hal/log_spec.rb

@@ -0,0 +1,26 @@
+require "spec_helper"
+require "hacky_hal/log"
+
+describe HackyHAL::Log do
+  before(:all) do
+    @old_logger_state = HackyHAL::Log.instance.enabled
+    HackyHAL::Log.instance.enabled = true
+  end
+
+  after(:all) do
+    HackyHAL::Log.instance.enabled = @old_logger_state
+  end
+
+  it "should use custom formatter" do
+    described_class.instance.formatter.should be_a(described_class::Formatter)
+    described_class.instance.formatter.should_receive(:call)
+    described_class.instance.info("foo")
+  end
+
+  describe "#write" do
+    it "should alias to self.<<" do
+      described_class.instance.should_receive(:<<).with("foo")
+      described_class.instance.write("foo")
+    end
+  end
+end

data/spec/hacky_hal/options_spec.rb

@@ -0,0 +1,22 @@
+require "spec_helper"
+require "hacky_hal/options"
+
+class DummyClass
+  include HackyHAL::Options
+end
+
+describe HackyHAL::Options do
+  describe "#initialize" do
+    it "should set options" do
+      object = DummyClass.new(dummy_argument: "dummy value")
+      object.options.should == {dummy_argument: "dummy value"}
+    end
+  end
+
+  describe "#[]" do
+    it "should return option values" do
+      object = DummyClass.new(dummy_argument: "dummy value")
+      object[:dummy_argument].should == "dummy value"
+    end
+  end
+end

data/spec/hacky_hal/registry_spec.rb

@@ -0,0 +1,30 @@
+require "spec_helper"
+require "hacky_hal/registry"
+
+describe HackyHAL::Registry do
+  describe "#load_yaml_file" do
+    before(:each) do
+      @device_config = {
+        "foo_device" => {
+          "type" => "Base",
+          "foo" => "bar"
+        }
+      }
+      File.stub(:read)
+      YAML.stub(:load).and_return(@device_config)
+    end
+
+    it "should load and initialize device controllers into registry" do
+      described_class.instance.load_yaml_file("foo.yml")
+      devices = described_class.instance.devices
+      devices.length.should == 1
+      devices[:foo_device].should be_instance_of(HackyHAL::DeviceControllers::Base)
+    end
+
+    it "should convert keys to symbols" do
+      described_class.instance.load_yaml_file("foo.yml")
+      devices = described_class.instance.devices
+      devices[:foo_device][:foo].should == "bar"
+    end
+  end
+end

data/spec/hacky_hal/util_spec.rb

@@ -0,0 +1,27 @@
+require "spec_helper"
+require "hacky_hal/util"
+
+module DummyModule
+  class DummyClass
+  end
+end
+
+describe HackyHAL::Util do
+  describe ".object_from_hash" do
+    it "should require type" do
+      expect { described_class.object_from_hash({foo: 1}, DummyModule) }.to raise_error(ArgumentError)
+    end
+
+    it "should return instance of built class" do
+      dummy_instance = double("dummy instance")
+      DummyModule::DummyClass.should_receive(:new).with(foo: 1).and_return(dummy_instance)
+      described_class.object_from_hash({type: 'DummyClass', foo: 1}, DummyModule).should == dummy_instance
+    end
+  end
+
+  describe ".symbolize_keys_deep" do
+    it "should symbolize hash keys" do
+      described_class.symbolize_keys_deep("a" => 1, :b => {"c" => 2}).should == {a: 1, b: {c: 2}}
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require "bundler"
+Bundler.require
+require_relative "../lib/hacky_hal/log"
+
+require "rspec/core"
+
+RSpec.configure do |c|
+  c.before(:suite) do
+    HackyHAL::Log.instance.enabled = false
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: hacky_hal
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Nick Ewing
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: upnp-nickewing
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: serialport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+description: HackyHAL - Hacky Home Automation Library
+email:
+- nick@nickewing.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.markdown
+- hacky_hal.gemspec
+- lib/hacky_hal.rb
+- lib/hacky_hal/device_controllers/base.rb
+- lib/hacky_hal/device_controllers/epson_projector.rb
+- lib/hacky_hal/device_controllers/generic_serial_port.rb
+- lib/hacky_hal/device_controllers/generic_ssh.rb
+- lib/hacky_hal/device_controllers/io_gear_avior_hdmi_switch.rb
+- lib/hacky_hal/device_controllers/linux_computer.rb
+- lib/hacky_hal/device_controllers/osx_computer.rb
+- lib/hacky_hal/device_controllers/roku.rb
+- lib/hacky_hal/device_controllers/yamaha_av_receiver.rb
+- lib/hacky_hal/device_resolvers/base.rb
+- lib/hacky_hal/device_resolvers/ssdp.rb
+- lib/hacky_hal/device_resolvers/static_uri.rb
+- lib/hacky_hal/log.rb
+- lib/hacky_hal/options.rb
+- lib/hacky_hal/registry.rb
+- lib/hacky_hal/util.rb
+- spec/hacky_hal/device_controllers/base_spec.rb
+- spec/hacky_hal/device_controllers/generic_serial_port_spec.rb
+- spec/hacky_hal/device_controllers/generic_ssh_spec.rb
+- spec/hacky_hal/device_controllers/roku_spec.rb
+- spec/hacky_hal/device_controllers/yamaha_av_receiver_spec.rb
+- spec/hacky_hal/device_resolvers/base_spec.rb
+- spec/hacky_hal/device_resolvers/ssdp_spec.rb
+- spec/hacky_hal/device_resolvers/static_uri_spec.rb
+- spec/hacky_hal/log_spec.rb
+- spec/hacky_hal/options_spec.rb
+- spec/hacky_hal/registry_spec.rb
+- spec/hacky_hal/util_spec.rb
+- spec/spec_helper.rb
+- support/hal-9000-small.png
+- support/hal-9000.png
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: HackyHAL - Hacky Home Automation Library
+test_files:
+- spec/hacky_hal/device_controllers/base_spec.rb
+- spec/hacky_hal/device_controllers/generic_serial_port_spec.rb
+- spec/hacky_hal/device_controllers/generic_ssh_spec.rb
+- spec/hacky_hal/device_controllers/roku_spec.rb
+- spec/hacky_hal/device_controllers/yamaha_av_receiver_spec.rb
+- spec/hacky_hal/device_resolvers/base_spec.rb
+- spec/hacky_hal/device_resolvers/ssdp_spec.rb
+- spec/hacky_hal/device_resolvers/static_uri_spec.rb
+- spec/hacky_hal/log_spec.rb
+- spec/hacky_hal/options_spec.rb
+- spec/hacky_hal/registry_spec.rb
+- spec/hacky_hal/util_spec.rb
+- spec/spec_helper.rb
+has_rdoc: