usb-detection-sensor 0.2.2

data/.gitignore

@@ -0,0 +1,7 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg
+*.gemspec
+log/*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 art+com AG/dirk luesebrink
+
+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.markdown

@@ -0,0 +1,23 @@
+# USB device detection 
+
+Detect USB devices when being connected and update a GOM sensor node
+accordingly. This allows to automagically avtivate the device mirror overlay
+on the horizon in home for example.
+
+# DroidEx
+
+http://github.com/commonsguy/droidex
+
+## Note on Patches/Pull Requests
+ - Fork the project.
+ - Make your feature addition or bug fix.
+ - Add tests for it. This is important so I don't break it in a future version
+   unintentionally.
+ - Commit, do not mess with rakefile, version, or history.  (if you want to
+   have your own version, that is fine but bump version in a commit by itself
+   I can ignore when I pull)
+ - Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 art+com/dirk luesebrink. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "usb-detection-sensor"
+    gem.summary = %Q{usb device connect/disconnect detection as GOM sensor}
+    gem.description = %Q{
+      Detect USB devices when being connected and update a GOM sensor node
+      accordingly. This allows to automagically avtivate the device mirror
+      overlay on the horizon in home for example.
+    }
+    gem.email = "dirk.luesebrink@gmail.com"
+    gem.homepage = "http://github.com/crux/usb-detection-sensor"
+    gem.authors = ["art+com/dirk luesebrink"]
+
+    gem.add_development_dependency "rspec"
+    gem.add_development_dependency "fakeweb"
+
+    gem.add_runtime_dependency "json_pure"
+    gem.add_runtime_dependency "applix"
+    gem.add_runtime_dependency "gom-script"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:rcov) do |t|
+  t.rcov_opts =  %q[--exclude "spec"]
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "usb-detection-sensor #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.2

data/bin/usb-udev-rules-handler

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'applix'
+
+$:.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+require 'usb-detection-sensor'
+
+class Usage < ArgumentError; end
+
+# TODO: refactoring this into gom-core logger
+def redirect_log path
+  unless path == '-' # '-' means stdout means nothing
+    puts " -- redirecting stdout/stderr to: #{path}"
+    out = File.open(path, File::WRONLY|File::APPEND|File::CREAT)
+    out.sync = true
+    $stderr = $stdout = out
+    # first line after redirect
+    puts " -- logile redirect at #{Time.now}"
+  end
+end
+
+def main argv
+  options = Hash.from_argv argv
+  args = (options.delete :args)
+
+  handler = UsbDetectionSensor::CommandLineHandler.new options
+  redirect_log handler.logfile
+
+  if op = args.shift
+    handler.send op, *args
+  else
+    # TODO: process could become part of the udev rule script and this special
+    # case would went extinct
+    handler.process ENV
+  end
+
+rescue Usage => e
+  puts <<-TXT
+
+usage: #{__FILE__} [ <connect> | <disconnect> ]
+
+ ## #{e}
+  TXT
+rescue => e
+  puts " ## #{e}\n -> #{e.backtrace.join "\n    "}"
+end
+
+main ARGV
+# vim: syntax=ruby

data/etc/android-udev-rules

@@ -0,0 +1,2 @@
+SUBSYSTEM=="usb", SYSFS{idVendor}=="0bb4", MODE="0666", RUN+="usb-udev-rules-handler --config=${CONFIG_FILE}"
+SUBSYSTEM=="usb", ACTION=="remove", RUN+="usb-udev-rules-handler --config=${CONFIG_FILE}"

data/etc/defaults.yml

@@ -0,0 +1,8 @@
+--- 
+:logfile: "-"
+:java_exe: /usr/bin/java
+:scale: 1
+:android_root: 
+:gom_url: http://gom/sensors/usb-detect/home
+:droid_pid_file: /tmp/droid.pid
+:overlay_path: # nil default, e.g.: /areas/home/horizon:overlay-1

data/etc/udev/rules.d/51-android.rules

@@ -0,0 +1,3 @@
+SUBSYSTEM=="usb", SYSFS{idVendor}=="0bb4", MODE="0666", RUN+="/home/sonic/artcom/usb-detect/android_udev.sh"
+SUBSYSTEM=="usb", ACTION=="remove", RUN+="/home/sonic/artcom/usb-detect/android_udev_remove.sh"
+

data/lib/usb-detection-sensor.rb

@@ -0,0 +1,6 @@
+require 'applix/oattr'
+require 'tempfile'
+require 'json'
+require 'gom-script'
+
+require 'usb-detection-sensor/command-line-handler'

data/lib/usb-detection-sensor/command-line-handler.rb

@@ -0,0 +1,172 @@
+module UsbDetectionSensor
+  class CommandLineHandler
+
+    include OAttr
+    oattr :logfile, :gom_url, :gom_path, :java_exe, :droid_pid_file, 
+      :overlay_path, :scale
+
+    # configuration precedence:  Defaults -> --config=file -> commandline
+    def initialize options = {}
+      defaults = (YAML.load_file defaults_path)
+      @options = (YAML.load_file options[:config]) rescue {}
+      @options = defaults.merge(@options.merge options)
+    end
+
+    def process env
+      @env = env
+      #puts " -- ENV: #{@env.inspect}"
+      op = @env["ACTION"].downcase
+      self.send op
+    end
+
+    def info
+      puts " -- runtime env:\n#{@options.inspect}"
+    end
+
+    def ginfo 
+      puts(gom.read "#{@gom_path}.json")
+    end
+
+    # 'add' gets called as udev rules action
+    def add
+      puts " -- connect: #{id_serial}"
+
+      wait_for_device
+      push_device_path # device_path
+      start_droid_exe
+      switch_horizon_overlay :grabber
+    end
+
+    # 'remove' gets called as udev rules action
+    def remove
+      switch_horizon_overlay :off
+      dev_type = @env["DEVTYPE"]
+      unless dev_type == "usb_device"
+        puts " .. ignoring remove for dev_type: #{dev_type}"
+        return
+      end
+      puts " -- disconnect: #{id_serial}"
+
+      stop_droid_exe
+      remove_device_path_attr
+    end
+
+    def switch_horizon_overlay mode
+      if overlay_path.nil?
+        puts " !! :overlay_path not defined"
+        return
+      end
+      gom.write overlay_path, mode.to_s
+    end
+
+    def id_serial
+      @id_serial ||= @env["ID_SERIAL"] 
+    end
+
+    def dump_udev_rules
+      puts(File.read rules_path)
+    end
+
+    def dump_defaults
+      puts(File.read defaults_path)
+    end
+
+    # lazy load the GOM connection
+    def gom
+      return @gom unless @gom.nil?
+      @gom, @gom_path = Gom::Remote::Connection.init gom_url
+      @gom
+    end
+
+    def wait_for_device
+      puts = open("|#{adb} wait-for-device 2>&1").read
+    end
+
+    #def device_path
+    #  @device_path ||= dev_config["device-path"]
+    #end
+    # write GOM specific device path for mobile: /areas/mobile/Generic-MD-I18
+    def push_device_path # device_path
+      device_path ||= dev_config["device-path"]
+      puts " .. push device-path: #{device_path}"
+      # http://gom/sensors/usb-detect/home:device_path &>/dev/null
+      (gom.write "#{@gom_path}:device_path", device_path)
+    rescue => e
+      puts " !! failed: #{e}"
+    end
+
+    def start_droid_exe
+      puts " .. start_droid_exe"
+      # java -cp DroidEx.jar:ddmlib.jar com.commonsware.droidex.DroidEx
+      clazz = "com.commonsware.droidex.DroidEx"
+      cmd = "#{java_exe} #{classpath} #{clazz}"
+      cmd = "DISPLAY=:0.0 #{cmd} -s #{scale} #{droid_log_redirect}"
+      puts "    executing: #{cmd}"
+      pid = fork do 
+        sid = Process.setsid
+        puts "    session id: #{sid}"
+        system cmd
+      end
+      puts "    droid pid: #{pid}"
+      File.open(droid_pid_file, "w") {|fd| fd.write pid; fd.flush}
+      Process.detach pid
+    end
+
+    def stop_droid_exe
+      puts " .. kill droid"
+      pid = Integer(File.read droid_pid_file)
+      Process.kill -15, pid
+    rescue => e
+      puts " !! stopping droid: #{e}"
+    end
+
+    def remove_device_path_attr
+      puts " .. remove device_path attribute"
+      gom.destroy "#{@gom_path}:device_path"
+    end
+
+    private
+
+    def overlay_path
+      #@overlay_path ||= (gom.read "#{@gom_path}:overlay_path.json")
+      @overlay_path ||= @options[:overlay_path]
+    end
+
+    def droid_log_redirect
+      (logfile == '-') && nil || (">> #{logfile} 2>&1")
+    end
+
+    # lazy loading device config file from well known sdcard location
+    def dev_config
+      @dev_config ||= begin
+                         cmd = "#{adb} shell cat /sdcard/device_config.json"
+                         puts "    executing: #{cmd}"
+                         json = open("|#{cmd} 2>&1").read
+                         parsed = (JSON.parse json)
+                         puts "    dev config: #{parsed.inspect}"
+                         parsed
+                       end
+    end
+
+    def defaults_path
+      File.join(basedir, %w{etc  defaults.yml})
+    end
+
+    def rules_path
+      File.join(basedir, %w{etc  android-udev-rules})
+    end
+
+    def adb
+      @adb ||= "#{@options[:android_root]}/tools/adb"
+    end
+
+    def classpath
+      jars = Dir["#{basedir}/etc/*.jar"]
+      "-cp #{jars.join ':'}"
+    end
+
+    def basedir
+      File.expand_path(File.join(File.dirname(__FILE__), '..', '..'))
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--backtrace --debugger

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'rubygems'
+require 'usb-detection-sensor'
+require 'spec'
+require 'spec/autorun'
+
+require 'fakeweb'
+FakeWeb.allow_net_connect = false
+
+Spec::Runner.configure do |config|
+  config.before :each do
+  end
+
+  config.after :each do
+  end
+end

data/spec/usb-connect-gom-sensor_spec.rb

@@ -0,0 +1,7 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "UsbConnectGomSensor" do
+  it "should find class & module" do
+    UsbDetectionSensor.should_not == nil
+  end
+end

data/spec/usb-detection-sensor/command-line-handler_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+include UsbDetectionSensor
+
+describe "UsbConnectGomSensor::CommandLineHandler" do
+  it "should find class & module" do
+    CommandLineHandler.should_not == nil
+  end
+
+  describe "with a fake connection" do
+    before :each do
+      $gom = Gom::Remote.connection = Object.new
+      (Gom::Remote::Connection.stub! :init).and_return($gom, '/')
+    end
+
+    it "should should switch on overlays" do
+      @clh = CommandLineHandler.new :overlay_path => '/some:overlay-2'
+      $gom.should_receive(:write).with("/some:overlay-2", "grabber")
+      (@clh.switch_horizon_overlay :grabber)
+    end
+
+    it "should should switch off overlays" do
+      @clh = CommandLineHandler.new :overlay_path => '/some:overlay-1'
+      $gom.should_receive(:write).with("/some:overlay-1", "off")
+      (@clh.switch_horizon_overlay :off)
+    end
+
+    describe "with a default handler" do
+      before :each do
+        @clh = CommandLineHandler.new
+      end
+
+      it "should respond to remove requests" do
+        (@clh.respond_to? :info).should == true
+      end
+
+      it "should should not switch overlays" do
+        $gom.should_not_receive(:write)
+        (@clh.switch_horizon_overlay :grabber)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification 
+name: usb-detection-sensor
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 2
+  version: 0.2.2
+platform: ruby
+authors: 
+- art+com/dirk luesebrink
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-20 00:00:00 +01:00
+default_executable: usb-udev-rules-handler
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json_pure
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: applix
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: gom-script
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+description: "\n      Detect USB devices when being connected and update a GOM sensor node\n      accordingly. This allows to automagically avtivate the device mirror\n      overlay on the horizon in home for example.\n    "
+email: dirk.luesebrink@gmail.com
+executables: 
+- usb-udev-rules-handler
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.markdown
+files: 
+- .gitignore
+- LICENSE
+- README.markdown
+- Rakefile
+- VERSION
+- bin/usb-udev-rules-handler
+- etc/DroidEx.jar
+- etc/android-udev-rules
+- etc/args4j-2.0.16.jar
+- etc/ddmlib.jar
+- etc/defaults.yml
+- etc/udev/rules.d/51-android.rules
+- lib/usb-detection-sensor.rb
+- lib/usb-detection-sensor/command-line-handler.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/usb-connect-gom-sensor_spec.rb
+- spec/usb-detection-sensor/command-line-handler_spec.rb
+has_rdoc: true
+homepage: http://github.com/crux/usb-detection-sensor
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: usb device connect/disconnect detection as GOM sensor
+test_files: 
+- spec/spec_helper.rb
+- spec/usb-connect-gom-sensor_spec.rb
+- spec/usb-detection-sensor/command-line-handler_spec.rb