tuio-ruby 0.2.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Colin Harris 
+
+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.rdoc

@@ -0,0 +1,23 @@
+= A TUIO client for Ruby
+
+http://www.tuio.org/
+
+== REQUIREMENTS:
+
+You will need the OSC gem
+  
+  [sudo] gem install osc
+
+== INSTALL:
+
+  [sudo] gem install aberant-tuio-ruby
+  
+== EXAMPLE:
+
+  please see tuio_dump.rb in the example folder for basic useage
+
+== COPYRIGHT:
+
+Copyright (c) 2009 Colin Harris. See LICENSE for details.
+
+

data/Rakefile

@@ -0,0 +1,47 @@
+require 'spec/rake/spectask'
+
+
+task :default => :spec
+
+Spec::Rake::SpecTask.new do |t|
+  t.warning = false
+  t.rcov = false
+  t.spec_opts = ["--colour"]#, "--diff"]
+end
+
+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 = "tuio-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tuio-ruby"
+    gem.summary = %Q{library to interface with TUIO protocol}
+    gem.email = "qzzzq1@gmail.com"
+    gem.homepage = "http://github.com/aberant/tuio-ruby"
+    gem.authors = ["aberant"]
+    gem.files = FileList['Rakefile', 'examples/**/*', 'lib/**/*'].to_a
+    gem.test_files = FileList['spec/**/*.rb']
+    gem.add_dependency('osc-ruby', '>= 0.1.6')
+    gem.rubyforge_project = "tuio-ruby"
+    
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  
+  Jeweler::RubyforgeTasks.new do |rubyforge|
+    rubyforge.doc_task = "rdoc"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/examples/tuio_dump.rb

@@ -0,0 +1,32 @@
+require File.join( File.dirname( __FILE__ ), '..', 'lib', 'tuio-ruby' )
+
+
+@tc = TuioClient.new
+
+@tc.on_object_creation do | to |
+  puts "New TUIO Object at x: #{to.x_pos}, y: #{to.y_pos}"
+end
+
+@tc.on_object_update do | to |
+  puts "Updated TUIO Object #{to.fiducial_id} at x: #{to.x_pos}, y: #{to.y_pos}"
+end
+
+@tc.on_object_removal do | to |
+  puts "Removed TUIO Object #{to.fiducial_id}"
+end
+
+
+@tc.on_cursor_creation do | to |
+  puts "New TUIO Cursor at x: #{to.x_pos}, y: #{to.y_pos}"
+end
+
+@tc.on_cursor_update do | to |
+  puts "Updated TUIO Cursor #{to.session_id} at x: #{to.x_pos}, y: #{to.y_pos}"
+end
+
+@tc.on_cursor_removal do | to |
+  puts "Removed TUIO Cursor #{to.session_id}"
+end
+
+@tc.start
+sleep

data/lib/tuio-ruby/core_ext/float.rb

@@ -0,0 +1,5 @@
+class Float 
+  def approx_equal?(other,threshold=0.00000000001) 
+    (self-other).abs < threshold  
+  end 
+end

data/lib/tuio-ruby/core_ext/object.rb

@@ -0,0 +1,30 @@
+# this is a little meta magic to clean up some of the repetition in the client
+# i noticed that i kept making the same similiar methods for each event such as
+#
+# client_events :object_creation
+#
+# which causes these two methods to be created
+
+# def on_object_creation( &object_creation_blk )
+#  @object_creation_callback_blk = object_creation_blk
+# end
+# 
+# def trigger_object_creation_callback( tuio )
+#   @object_creation_callback_blk.call( tuio ) if @object_creation_callback_blk
+# end
+
+class Object
+  def client_events( *args )
+    args.each do | event | 
+     self.class_eval <<-EOF
+        def on_#{event}( &#{event}_blk )
+         @#{event}_callback_blk = #{event}_blk
+        end
+        
+        def trigger_#{event}_callback( tuio )
+          @#{event}_callback_blk.call( tuio ) if @#{event}_callback_blk
+        end
+      EOF
+    end
+  end
+end

data/lib/tuio-ruby/tuio_client.rb

@@ -0,0 +1,168 @@
+require 'rubygems'
+require 'osc-ruby'
+
+# core exts
+require 'core_ext/object'
+require 'core_ext/float'
+
+class TuioClient
+  include OSC
+  
+  attr_reader :tuio_objects, :tuio_cursors
+  
+  
+  client_events :object_creation, :object_update, :object_removal
+  client_events :cursor_creation, :cursor_update, :cursor_removal
+  
+  def initialize( args = {} )
+    @port = args[:port] || 3333
+
+    @tuio_objects = { }
+    @tuio_cursors = { }
+    
+    @osc = OSC::Server.new(@port)
+    
+    @osc.add_method '/tuio/2Dobj' do |msg|
+      args = msg.to_a
+      
+      case args.shift
+      when "set"
+        track_tuio_object( args ) 
+      when "alive"
+        keep_alive( :tuio_objects, args )
+      when "fseq"
+        # puts args
+      end
+    end
+
+    @osc.add_method '/tuio/2Dcur' do |msg|
+      args = msg.to_a
+
+      case args.shift
+      when "set"
+        track_tuio_cursor args
+      when "alive"
+        keep_alive( :tuio_cursors, args )
+      when "fseq"
+        # puts args
+      end
+    end
+  end
+  
+  def start
+    Thread.new do
+      @osc.run
+    end
+  end
+  
+  ####################################
+  #           getters                #
+  ####################################
+  
+  def tuio_object( id )
+    @tuio_objects[id]
+  end
+  
+  def tuio_cursor( id )
+    @tuio_cursors[id]
+  end
+  
+private
+
+  def track_tuio_object( args )
+    params = TuioObjectParameter.new( *args )
+    
+    if tuio_object_previously_tracked?( params )
+      
+      tuio_object = grab_tuio_object_by( params.session_id )
+      
+      return if tuio_object.params_equal?( params )
+
+      tuio_object.update_from_params( params )  
+
+      trigger_object_update_callback( tuio_object )
+    else # this is a new object
+      tuio_object = track_new_tuio_object_with( params )
+      
+      trigger_object_creation_callback( tuio_object  )
+    end
+  end
+  
+  def track_tuio_cursor( args )
+    params = TuioCursorParameter.new( *args )
+    
+    if tuio_cursor_previously_tracked?( params )
+      
+      tuio_cursor = grab_tuio_cursor_by( params.session_id )
+      
+      return if tuio_cursor.params_equal?( params )
+      tuio_cursor.update_from_params( params )
+      
+      trigger_cursor_update_callback( tuio_cursor )
+      
+    else # this is a new cursor      
+      finger_id = @tuio_cursors.size
+      tuio_cursor = track_new_tuio_cursor_with( params )
+
+      trigger_cursor_creation_callback( tuio_cursor  )
+    end
+  end
+  
+  def tuio_object_previously_tracked?( params )
+    @tuio_objects.has_key?( params.session_id )
+  end
+  
+  def tuio_cursor_previously_tracked?( params )
+    @tuio_cursors.has_key?( params.session_id )
+  end
+  
+  def grab_tuio_object_by( session_id )
+    @tuio_objects[session_id]
+  end
+  
+  def grab_tuio_cursor_by( session_id )
+    @tuio_cursors[session_id]
+  end
+  
+  def track_new_tuio_object_with( tuio_params )
+    @tuio_objects[tuio_params.session_id] = TuioObject.from_params( tuio_params )    
+  end
+
+  def track_new_tuio_cursor_with( params )  
+    new_cursor = TuioCursor.from_params( params )
+    @tuio_cursors[params.session_id] =  new_cursor
+    
+    new_cursor.finger_id = @tuio_cursors.size
+    new_cursor
+  end
+  
+  ####################################
+  #           "alive" msgs           #
+  ####################################
+  
+  def delete_tuio_objects( session_id )
+    tuio_object = grab_tuio_object_by( session_id )
+    
+    trigger_object_removal_callback( tuio_object )
+  end
+  
+  def delete_tuio_cursors( session_id )
+    tuio_cursor = grab_tuio_cursor_by( session_id )
+    
+    trigger_cursor_removal_callback( tuio_cursor )
+  end
+  
+  
+  def keep_alive( type, session_ids )
+    return if session_ids.nil?
+    all_keys = send( type ).keys
+    
+    dead = all_keys.reject { |key|  session_ids.include? key }
+        
+    dead.each do | session_id |
+      send( "delete_#{type}", session_id )
+      
+      send( type ).delete( session_id )
+    end
+  end
+end

data/lib/tuio-ruby/tuio_container.rb

@@ -0,0 +1,63 @@
+require File.join( File.dirname( __FILE__ ), 'tuio_point' )
+
+class TuioContainer < TuioPoint
+  attr_accessor :session_id, :x_pos, :y_pos, :x_speed, :y_speed, :motion_accel
+
+  
+  def initialize( session_id, x_pos, y_pos )
+    super( x_pos, y_pos )
+
+    @session_id = session_id
+    @x_speed = 0.0
+    @y_speed = 0.0
+    @motion_accel = 0.0
+    
+    add_point_to_path( TuioPoint.new( x_pos, y_pos ) )
+  end
+  
+  def update( x_pos, y_pos, x_speed, y_speed, motion_accel )  
+    super( x_pos, y_pos )
+    
+    @x_speed = x_speed
+    @y_speed = y_speed
+    @motion_accel = motion_accel
+    
+    new_point = TuioPoint.new( x_pos, y_pos )
+    add_point_to_path( new_point ) unless new_point == @path.last
+  end
+  
+  def update_from_params( params )
+    @x_pos = params.x_pos
+    @y_pos = params.y_pos
+    @x_speed = params.x_speed
+    @y_speed = params.y_speed
+    @motion_accel = params.motion_accel
+  end
+  
+  def path
+    @path 
+  end
+  
+  
+  def params_equal?( params )
+    @session_id == params.session_id &&
+    @x_pos.approx_equal?( params.x_pos ) &&
+    @y_pos.approx_equal?( params.y_pos ) &&
+    @x_speed.approx_equal?( params.x_speed ) &&
+    @y_speed.approx_equal?( params.y_speed ) &&
+    @motion_accel.approx_equal?( params.motion_accel ) && 
+    equal_to_local_params?( params )
+  end
+  
+  def equal_to_local_args?(args)
+    true
+  end
+  
+private
+
+  def add_point_to_path( tuio_point )
+    @path ||= []
+    @path << tuio_point
+  end
+end
+

data/lib/tuio-ruby/tuio_cursor.rb

@@ -0,0 +1,28 @@
+require File.join( File.dirname( __FILE__ ), 'tuio_container' )
+
+class TuioCursor < TuioContainer
+  
+  attr_accessor :finger_id
+  attr_reader  :x_speed, :y_speed, :motion_accel
+  
+  def self.from_params( params )
+    new(  params.session_id,
+          params.x_pos,
+          params.y_pos 
+    )
+  end
+  
+  def initialize( session_id, x_pos, y_pos )
+    super( session_id, x_pos, y_pos )
+    
+    @x_speed = 0.0
+    @y_speed = 0.0
+    @motion_accel = 0.0
+  end
+
+    
+  def equal_to_local_params?( params )
+    true
+  end
+
+end

data/lib/tuio-ruby/tuio_cursor_parameter.rb

@@ -0,0 +1,7 @@
+require File.join( File.dirname( __FILE__ ), 'tuio_parameter' )
+
+# /tuio/2Dcur set s x y X Y m
+
+class TuioCursorParameter < TuioParameter
+
+end

data/lib/tuio-ruby/tuio_object.rb

@@ -0,0 +1,53 @@
+require File.join( File.dirname( __FILE__ ), 'tuio_container' )
+
+class TuioObject < TuioContainer
+  attr_reader :angle, :fiducial_id, :rotation_vector, :rotation_accel
+  
+  def self.from_params( params )
+    new(
+      params.session_id,
+      params.fiducial_id,
+      params.x_pos,
+      params.y_pos,
+      params.angle
+    )
+  end
+  
+  
+  def initialize( session_id, fiducial_id, x_pos,  y_pos, angle )
+    super( session_id, x_pos, y_pos )
+    
+    @fiducial_id = fiducial_id
+    @angle = angle
+    
+    @rotation_vector = 0.0
+    @rotation_accel = 0.0
+  end
+  
+  def update_from_params( tuio_params ) 
+    update(
+      tuio_params.x_pos,
+      tuio_params.y_pos,
+      tuio_params.angle,
+      tuio_params.x_speed,
+      tuio_params.y_speed,
+      tuio_params.rotation_vector,
+      tuio_params.motion_accel,
+      tuio_params.rotation_accel
+    )
+  end
+  
+  def update( x_pos, y_pos, angle, x_speed, y_speed, rotation_vector, motion_accel, rotation_accel )
+    super( x_pos, y_pos, x_speed, y_speed, motion_accel )
+    
+    @angle = angle
+    @rotation_vector = rotation_vector
+    @rotation_accel = rotation_accel
+  end
+  
+  def equal_to_local_params?( params )
+    fiducial_id == params.fiducial_id &&
+    rotation_vector.approx_equal?( params.rotation_vector ) && 
+    rotation_accel.approx_equal?( params.rotation_accel ) 
+  end
+end

data/lib/tuio-ruby/tuio_object_parameter.rb

@@ -0,0 +1,17 @@
+require File.join( File.dirname( __FILE__ ), 'tuio_parameter' )
+
+# /tuio/2Dobj set s i x y a X Y A m r
+
+
+class TuioObjectParameter < TuioParameter
+  attr_reader :angle, :fiducial_id, :rotation_vector, :rotation_accel
+  
+  def initialize( session_id, fiducial_id, x_pos, y_pos, angle, x_speed, y_speed, rotation_vector, motion_accel, rotation_accel )
+    super( session_id, x_pos, y_pos, x_speed, y_speed, motion_accel )
+    
+    @fiducial_id = fiducial_id
+    @angle = angle
+    @rotation_vector = rotation_vector
+    @rotation_accel = rotation_accel
+  end
+end

data/lib/tuio-ruby/tuio_parameter.rb

@@ -0,0 +1,16 @@
+class TuioParameter
+  attr_accessor :session_id, :x_pos, :y_pos, :x_speed, :y_speed, :motion_accel
+  
+  def self.new_from_initial_params( session_id, x_pos, y_pos )
+    new session_id, x_pos, y_pos, 0.0, 0.0, 00
+  end
+  
+  def initialize( session_id, x_pos, y_pos, x_speed, y_speed, motion_accel )
+    @session_id = session_id
+    @x_pos = x_pos
+    @y_pos = y_pos
+    @x_speed = x_speed
+    @y_speed = y_speed
+    @motion_accel = motion_accel
+  end
+end

data/lib/tuio-ruby/tuio_point.rb

@@ -0,0 +1,45 @@
+class TuioPoint
+  attr_accessor :x_pos, :y_pos, :updated_at
+  
+  def initialize( x_pos, y_pos )
+    @x_pos, @y_pos = x_pos, y_pos
+  end
+  
+  def update( x_pos, y_pos )
+    @x_pos, @y_pos = x_pos, y_pos
+  
+    clear_update_time
+  end
+  
+  def distance_to( another_point )
+    dx = @x_pos - another_point.x_pos
+    dy = @y_pos - another_point.y_pos
+    
+    Math.sqrt( dx*dx + dy*dy )
+  end
+  
+  def radians_to( another_point )
+    side =   another_point.x_pos - @x_pos
+    height = another_point.y_pos - @y_pos
+    distance = distance_to( another_point )
+    
+    angle = Math.asin( side / distance ) + Math::PI / 2 
+    angle = 2.0 * Math.PI - angle if height < 0 
+    angle
+  end
+  
+  def degrees_to( another_point )
+    ( radians_to( another_point ) / Math::PI ) * 180.0
+  end
+  
+  def eql?( another_point )
+    @x_pos == another_point.x_pos &&
+    @y_pos == another_point.y_pos
+  end
+  
+private
+
+  def clear_update_time
+    @updated_at = nil
+  end
+end

data/lib/tuio-ruby.rb

@@ -0,0 +1,12 @@
+$: << File.dirname( __FILE__ )
+
+require 'tuio-ruby/tuio_cursor_parameter'
+require 'tuio-ruby/tuio_object_parameter'
+
+require 'tuio-ruby/tuio_container'
+require 'tuio-ruby/tuio_cursor'
+require 'tuio-ruby/tuio_object'
+
+require 'tuio-ruby/tuio_client'
+
+

data/spec/integration/tuio_event_spec.rb

@@ -0,0 +1,165 @@
+require File.join( File.dirname(__FILE__) , '..', 'spec_helper' )
+
+describe "tuio object" do
+  before :each do
+    setup_server
+  end 
+  
+  describe "in general" do
+    it "should call the creation hook" do
+      @server.on_object_creation do | object |
+        raise "creation hook called!" if object.session_id == 49
+      end
+    
+      lambda {
+        send_message( '/tuio/2Dobj', "set", 49, 25, 0.38, 0.35, 3.14, 0.0, 0.0, 0.0, 0.0, 0.0 )
+      }.should raise_error
+      
+      lambda {
+        send_message( '/tuio/2Dobj', "set", 49, 25, 0.38, 0.35, 3.14, 0.0, 0.0, 0.0, 0.0, 0.0 )
+      }.should_not raise_error
+    end
+    
+    it "should call the update hook when session_id is set again with different location" do
+      @server.on_object_update do | object |
+        raise "update hook called!" if object.session_id == 49
+      end
+
+      lambda {
+        # this one calls the create hook
+        send_message( '/tuio/2Dobj', "set", 49, 25, 0.38, 0.35, 3.14, 0.0, 0.0, 0.0, 0.0, 0.0 )
+        send_message( '/tuio/2Dobj', "alive", 49)
+        
+        #this one is the same as before, so nothing to update
+        send_message( '/tuio/2Dobj', "set", 49, 25, 0.38, 0.35, 3.14, 0.0, 0.0, 0.0, 0.0, 0.0 )
+        send_message( '/tuio/2Dobj', "alive", 49)
+      }.should_not raise_error
+      
+      
+      lambda {
+        #this one calls the update hook
+        send_message( '/tuio/2Dobj', "set", 49, 25, 0.12, 0.12, 3.14, 0.0, 0.0, 0.0, 0.0, 0.0 )
+        send_message( '/tuio/2Dobj', "alive", 49)
+        
+      }.should raise_error
+    end
+    
+    it "should call the removal hook when an object is not on the alive list" do
+      @server.on_object_removal do | object |
+        raise "removal hook called!" if object.session_id == 51
+      end
+      
+      send_message( '/tuio/2Dobj', "set", 49, 25, 0.38, 0.35, 3.14, 0.0, 0.0, 0.0, 0.0, 0.0 )
+      send_message( '/tuio/2Dobj', "set", 51, 26, 0.12, 0.50, 3.14, 0.0, 0.0, 0.0, 0.0, 0.0 )
+
+      lambda {
+        send_message( '/tuio/2Dobj', "alive", 49)
+      }.should raise_error
+      
+    end
+  end
+  
+  describe "receiving message" do
+    before :each do
+      send_message( '/tuio/2Dobj', "set", 49, 25, 0.38, 0.35, 3.14, 0.0, 0.0, 0.0, 0.0, 0.0 )
+    end
+    
+    describe "set" do
+      it 'should update tracking' do
+        @server.tuio_objects.size.should eql( 1 )
+        @server.tuio_objects[49].fiducial_id.should == 25
+      end
+    end
+  
+    describe "alive" do
+      it 'should only keep alive the objects the client says are alive' do    
+        send_message( '/tuio/2Dobj', "set", 51, 26, 0.12, 0.50, 3.14, 0.0, 0.0, 0.0, 0.0, 0.0 )
+        send_message( '/tuio/2Dobj', "alive", 49)
+
+        @server.tuio_objects.size.should == 1
+      end
+    end
+    
+    describe "fseq" do
+      it "should probably have a test!"
+    end
+  end
+end
+
+describe "tuio_cursors" do
+  before :each do
+    setup_server
+  end
+  
+  it 'should update tracking' do
+    send_message( '/tuio/2Dcur', "set", 22, 0.38, 0.35, 0.0, 0.0, 0.0 )
+    
+    @server.tuio_cursors.size.should == 1
+  end
+  
+  it 'should update tracking for multiples' do
+    send_message( '/tuio/2Dcur', "set", 22, 0.38, 0.35, 0.0, 0.0, 0.0 )
+    send_message( '/tuio/2Dcur', "set", 27, 0.12, 0.50, 0.0, 0.0, 0.0 )
+    
+    
+    @server.tuio_cursors.size.should == 2
+  end
+  
+  it 'should only keep alive the cursors the client says are alive' do
+    send_message( '/tuio/2Dcur', "set", 22, 0.38, 0.35, 0.0, 0.0, 0.0 )
+    send_message( '/tuio/2Dcur', "set", 27, 0.12, 0.50, 0.0, 0.0, 0.0 )
+    
+    send_message( '/tuio/2Dcur', "alive", 22)
+    
+    @server.tuio_cursors.size.should == 1
+    @server.tuio_cursors[22].session_id.should == 22
+  end
+  
+  it "should call the creation hooks" do
+    @server.on_cursor_creation do | objects |
+      raise "create! hook called!"
+    end
+    
+    lambda {
+      send_message( '/tuio/2Dcur', "set", 27, 0.12, 0.50, 0.0, 0.0, 0.0 )
+    }.should raise_error
+  end
+  
+  it "should call the update hooks" do
+    @server.on_cursor_update do | objects |
+      raise "update hook called!"
+    end
+
+    lambda {
+      send_message( '/tuio/2Dcur', "set", 27, 0.12, 0.50, 0.0, 0.0, 0.0 )
+      send_message( '/tuio/2Dcur', "alive", 27)
+      
+      send_message( '/tuio/2Dcur', "set", 27, 0.12, 0.50, 0.0, 0.0, 0.0 )
+      send_message( '/tuio/2Dcur', "alive", 27)
+      
+    }.should_not raise_error
+    
+    lambda {
+      send_message( '/tuio/2Dcur', "set", 27, 0.12, 0.32, 0.0, 0.0, 0.0 )
+      send_message( '/tuio/2Dcur', "alive", 27)
+      
+    }.should raise_error
+    
+  end
+  
+  it "should call the removal hooks" do
+    @server.on_cursor_removal do | objects |
+      raise "removal hook called!"
+    end
+    
+    lambda {
+      send_message( '/tuio/2Dcur', "set", 27, 0.12, 0.50, 0.0, 0.0, 0.0 )
+      send_message( '/tuio/2Dcur', "set", 32, 0.18, 0.98, 0.0, 0.0, 0.0 )
+    }.should_not raise_error
+
+    lambda {
+      send_message( '/tuio/2Dcur', "alive", 27)
+      
+    }.should raise_error
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'spec'
+require 'rr'
+require 'osc'
+
+$: << File.join( File.dirname( __FILE__ ), '..', 'lib' )
+
+require 'tuio-ruby' 
+
+Spec::Runner.configure do |config|
+    config.mock_with RR::Adapters::Rspec
+end
+
+# monkey patch to get at osc core to send messages
+class TuioClient
+  def osc
+    @osc
+  end
+end
+
+# helper method for integration tests
+def send_message( pattern, *msg )
+  osc_msg = OSC::Message.new( pattern, nil, *msg)
+  
+  @server.osc.send( :sendmesg, osc_msg )
+end
+
+def setup_server
+  mock( socket = Object.new )
+
+  # stub out networking
+  stub(socket).bind("", 3333)
+  stub(UDPSocket).new { socket }
+
+  @server = TuioClient.new
+end

data/spec/unit/tuio_container_spec.rb

@@ -0,0 +1,74 @@
+# require File.join( File.dirname(__FILE__) , '..', 'spec_helper' )
+# 
+# class TuioContainer
+#   # we want to be able to instantiate this class for testing
+#   def self.abstract?
+#     false
+#   end
+# end
+# 
+# describe TuioContainer do
+#   before :each do
+#     @session_id = 42
+#     @x_pos = 0.8
+#     @y_pos = 0.3
+#     @tc = TuioContainer.new( @session_id, @x_pos, @y_pos )
+#   end
+#   
+#   describe "in general" do
+#     it "should know it's session id" do
+#       @tc.session_id.should == @session_id
+#     end
+#   
+#     it "should know it's x position" do
+#       @tc.x_pos.should == @x_pos
+#     end
+#   
+#     it "should know its y position" do
+#       @tc.y_pos.should == @y_pos
+#     end
+#   end
+#   
+#   describe "updates" do
+#     before :each do
+#       @x_pos2 = 0.7
+#       @y_pos2 = 0.4
+#       @x_speed = 0.1
+#       @y_speed = 0.1
+#       @motion_accel = 0.1
+#       
+#       @tc.update( @x_pos2, @y_pos2, @x_speed, @y_speed, @motion_accel )
+#     end
+# 
+#     it "should know it's new x position" do
+#       @tc.x_pos.should == @x_pos2
+#     end
+#     
+#     it "should know it's new y position" do
+#       @tc.y_pos.should == @y_pos2
+#     end
+#     
+#     it "should know it's x speed" do
+#       @tc.x_speed.should == @x_speed
+#     end
+#     
+#     it "should know it's y speed" do
+#       @tc.y_speed.should == @y_speed
+#     end
+#     
+#     it "should know it's motion acceleration" do
+#       @tc.motion_accel.should == @motion_accel
+#     end
+#     
+#     it "should know the path it's traveled" do
+#       first = @tc.path.first
+#       second = @tc.path.last
+#       
+#       first.x_pos.should == 0.8
+#       first.y_pos.should == 0.3
+#       
+#       second.x_pos.should == 0.7
+#       second.y_pos.should == 0.4
+#     end
+#   end
+# end

data/spec/unit/tuio_cursor_parameter_spec.rb

@@ -0,0 +1,39 @@
+require File.join( File.dirname(__FILE__) , '..', 'spec_helper' )
+require File.join( File.dirname(__FILE__) , 'tuio_parameter_spec' )
+
+# /tuio/2Dcur set s x y X Y m
+
+describe TuioObjectParameter do
+  describe "cursor creation" do
+    before :each  do
+      args = [  @session_id = 12,
+                @x_pos = 0.1,
+                @y_pos = 0.2]
+
+      @tuio_param = TuioCursorParameter.new_from_initial_params( *args )
+    end
+    it "should have propper values set" do
+      @tuio_param.session_id == @session_id
+      @tuio_param.x_pos == @x_pos
+      @tuio_param.y_pos == @y_pos
+    end
+  end
+  
+  describe "in general" do
+    before :each  do
+      args = [
+        @session_id = 12,
+        @x_pos = 0.1,
+        @y_pos = 0.2,
+        @x_speed = 0.01,
+        @y_speed = 0.02,
+        @motion_accel = 0.03,
+      ]
+    
+      @tuio_param = TuioCursorParameter.new( *args )
+    end
+    
+    it_should_behave_like "TuioParameter"
+  end
+  
+end

data/spec/unit/tuio_cursor_spec.rb

@@ -0,0 +1,35 @@
+require File.join( File.dirname(__FILE__) , '..', 'spec_helper' )
+
+describe TuioCursor do
+  before :each do
+    @args1 = [
+      @session_id = 42,
+      @x_pos = 0.8,
+      @y_pos = 0.4,
+      @x_speed = 0.01,
+      @y_speed = 0.03,
+      @motion_accel = 0.02
+    ]
+    @params = TuioCursorParameter.new( *@args1 )
+    @tc = TuioCursor.from_params( @params )
+  end
+  
+  describe "update" do
+    before :each do
+      @args2 = [
+        @session_id = 42,
+        @x_pos2 = 0.23,
+        @y_pos2 = 0.54,
+        @x_speed = 0.01,
+        @y_speed = 0.03,
+        @motion_accel = 0.02
+      ]
+      @update_params = TuioCursorParameter.new( *@args2 )
+      @tc.update_from_params( @update_params )
+    end
+    
+    it "should it is equal to some arguments" do
+      @tc.params_equal?( @update_params )
+    end
+  end
+end

data/spec/unit/tuio_object_parameter_spec.rb

@@ -0,0 +1,41 @@
+require File.join( File.dirname(__FILE__) , '..', 'spec_helper' )
+require File.join( File.dirname(__FILE__) , 'tuio_parameter_spec' )
+
+# /tuio/2Dobj set s i x y a X Y A m r
+# /tuio/2Dcur set s x y X Y m
+#def initialize( session_id, fiducial_id, x_pos, y_pos, angle, 
+#  x_speed, y_speed, rotation_vector, motion_accel, rotation_accel )
+
+describe TuioObjectParameter do
+  
+  before :each  do
+    args = [
+      @session_id = 12,
+      @fiducial_id = 41,
+      @x_pos = 0.1,
+      @y_pos = 0.2,
+      @angle = 3,
+      @x_speed = 0.01,
+      @y_speed = 0.02,
+      @rotation_vector = 0.4,
+      @motion_accel = 0.03,
+      @rotation_accel = 0.02
+    ]
+    
+    @tuio_param = TuioObjectParameter.new( *args )
+  end
+  
+  it_should_behave_like "TuioParameter"
+  
+  it "should fetch angle" do
+    @tuio_param.angle.should == @angle
+  end
+
+  it "should fetch rotation vector" do
+    @tuio_param.rotation_vector.should == @rotation_vector
+  end
+  
+  it "should fetch rotation acceleration" do
+    @tuio_param.rotation_accel.should == @rotation_accel
+  end
+end

data/spec/unit/tuio_object_spec.rb

@@ -0,0 +1,94 @@
+require File.join( File.dirname(__FILE__) , '..', 'spec_helper' )
+
+describe TuioObject do
+  before :each do
+    @args1 = [
+      @session_id = 42,
+      @fiducial_id = 1,
+      @x_pos = 0.8,
+      @y_pos = 0.4,
+      @angle = 1,
+      @x_speed = 0.1,
+      @y_speed = 0.2,
+      @rotation_vector = 0.11,
+      @motion_accel = 0.12,
+      @rotation_accel = 0.13
+    ]
+    @params = TuioObjectParameter.new( *@args1 )
+    @to = TuioObject.from_params( @params )
+  end
+  
+  describe "in general" do
+    it "should know it's session id" do
+      @to.session_id.should == @session_id
+    end
+    
+    it "should know it's fiducial id" do
+      @to.fiducial_id.should == @fiducial_id
+    end
+    
+    it "should know it's x position" do
+      @to.x_pos.should == @x_pos
+    end
+    
+    it "should know it's y postion" do
+      @to.y_pos.should == @y_pos
+    end
+    
+    it "should know it's angle" do
+      @to.angle.should == @angle
+    end
+  end
+  
+  describe "on update" do
+    
+    before :each do
+      @args2 = [
+        @sesssion_id = 42,
+        @fiducial_id = 1,
+        @x_pos2 = 0.7,
+        @y_pos2 = 0.4,
+        @angle2 = 1.1,
+        @x_speed = 0.1,
+        @y_speed = 0.2,
+        @rotation_vector = 0.11,
+        @motion_accel = 0.12,
+        @rotation_accel = 0.13
+      ]
+      @update_params = TuioObjectParameter.new( *@args2 )
+      @to.update_from_params( @update_params )
+    end
+    
+    it "should be able to compare it's args" do
+      @to.params_equal?( @update_params ).should be_true
+    end
+    
+    it "should know it's new x position" do
+      @to.x_pos.should == @x_pos2
+    end
+    
+    it "should know it's new y position" do
+      @to.y_pos.should == @y_pos2
+    end
+    
+    it "should know it's new angle" do
+      @to.angle.should == @angle2
+    end
+    
+    it "should know it's x speed" do
+      @to.x_speed.should == @x_speed
+    end
+    
+    it "should know it's y speed" do
+      @to.y_speed.should == @y_speed
+    end
+    
+    it "should know it's rotation vector" do
+      @to.rotation_vector.should == @rotation_vector
+    end
+    
+    it "should know it's rotation accel" do
+      @to.rotation_accel.should == @rotation_accel
+    end
+  end
+end

data/spec/unit/tuio_parameter_spec.rb

@@ -0,0 +1,32 @@
+require File.join( File.dirname(__FILE__) , '..', 'spec_helper' )
+
+# /tuio/2Dobj set s i x y a X Y A m r
+# /tuio/2Dcur set s x y X Y m
+
+# session_id, x, y, X, Y, m
+shared_examples_for "TuioParameter" do
+  
+  it "should fetch session id" do
+    @tuio_param.session_id.should == @session_id
+  end
+  
+  it "should fetch x position" do
+    @tuio_param.x_pos.should == @x_pos
+  end
+  
+  it "should fetch y position" do
+    @tuio_param.y_pos.should == @y_pos
+  end
+  
+  it "should fetch x speed" do
+    @tuio_param.x_speed.should == @x_speed
+  end
+  
+  it "should fetch y speed" do
+    @tuio_param.y_speed.should == @y_speed
+  end
+  
+  it "should fetch motion acceleration" do
+    @tuio_param.motion_accel.should == @motion_accel
+  end
+end

data/spec/unit/tuio_point_spec.rb

@@ -0,0 +1,46 @@
+require File.join( File.dirname(__FILE__) , '..', 'spec_helper' )
+
+describe TuioPoint do
+  before :each do
+    @location1 = [0.1, 0.1]
+    @location2 = [0.1, 0.21]
+    
+    @point1 = TuioPoint.new( *@location1 )
+    @point2 = TuioPoint.new( *@location2 )
+  end
+  
+  describe "in general" do
+    it "should know the distance to another point" do
+      # not a wonderful test, but a sanity check
+      @point1.distance_to( @point2 ).should be_close( 0.11, 0.00001 )
+    end
+  
+    it "should know the angle to another point" do
+      # not a wonderful test, but a sanity check
+      @point1.radians_to( @point2 ).should be_close( 1.5707963, 0.00001 )
+    end
+  
+    it "should know when it was last updated" do
+      @point1.should respond_to(:updated_at)
+    end
+    
+    it "should know if it is equal to another point" do
+      @other_point = TuioPoint.new( *@location1 )
+      
+      @point1.should be_eql( @other_point )
+    end
+  end
+  
+  describe "updates" do
+    before :each do
+      @point1.updated_at = Time.now
+      
+      @point1.update( *@location2 )
+    end
+    
+    it "should clear the updated at time" do
+      @point1.updated_at.should == nil
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification 
+name: tuio-ruby
+version: !ruby/object:Gem::Version 
+  version: 0.2.2
+platform: ruby
+authors: 
+- aberant
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-16 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: osc-ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.6
+    version: 
+description: 
+email: qzzzq1@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- Rakefile
+- examples/tuio_dump.rb
+- lib/tuio-ruby.rb
+- lib/tuio-ruby/core_ext/float.rb
+- lib/tuio-ruby/core_ext/object.rb
+- lib/tuio-ruby/tuio_client.rb
+- lib/tuio-ruby/tuio_container.rb
+- lib/tuio-ruby/tuio_cursor.rb
+- lib/tuio-ruby/tuio_cursor_parameter.rb
+- lib/tuio-ruby/tuio_object.rb
+- lib/tuio-ruby/tuio_object_parameter.rb
+- lib/tuio-ruby/tuio_parameter.rb
+- lib/tuio-ruby/tuio_point.rb
+- LICENSE
+- README.rdoc
+has_rdoc: true
+homepage: http://github.com/aberant/tuio-ruby
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: tuio-ruby
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: library to interface with TUIO protocol
+test_files: 
+- spec/integration/tuio_event_spec.rb
+- spec/spec_helper.rb
+- spec/unit/tuio_container_spec.rb
+- spec/unit/tuio_cursor_parameter_spec.rb
+- spec/unit/tuio_cursor_spec.rb
+- spec/unit/tuio_object_parameter_spec.rb
+- spec/unit/tuio_object_spec.rb
+- spec/unit/tuio_parameter_spec.rb
+- spec/unit/tuio_point_spec.rb