osc-ruby 0.2.0 → 0.6.0

data/README.rdoc

@@ -10,7 +10,7 @@ Compatible with ruby 1.8, 1.9, and jruby
 
 == Install
 
-  sudo gem install aberant-osc-ruby
+  sudo gem install osc-ruby
   
 for the EMServer, you will need EventMachine
 

data/Rakefile

@@ -1,6 +1,5 @@
 require 'spec/rake/spectask'
 
-
 task :default => :spec
 
 Spec::Rake::SpecTask.new do |t|
@@ -9,10 +8,26 @@ Spec::Rake::SpecTask.new do |t|
   t.spec_opts = ["--colour"]
 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 = "osc-ruby #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "osc-ruby"
+    gem.description = "a ruby client for the OSC protocol"
     gem.summary = %Q{inital gem}
     gem.email = "qzzzq1@gmail.com"
     gem.homepage = "http://github.com/aberant/osc-ruby"
@@ -20,12 +35,10 @@ begin
     gem.files = FileList['Rakefile', 'examples/**/*', 'lib/**/*'].to_a
     gem.test_files = FileList['spec/**/*.rb']
     gem.rubyforge_project = "osc-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
+
+  Jeweler::GemcutterTasks.new
+
 rescue LoadError
   puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
 end

data/lib/osc-ruby/bundle.rb

@@ -1,14 +1,12 @@
-require File.join( File.dirname( __FILE__ ), "packet" )
-
 module OSC
-  class Bundle < Packet
+  class Bundle
     attr_accessor :timetag
-    
+
     def initialize(timetag=nil, *args)
       @timetag = timetag
       @args = args
     end
-    
+
     def encode()
       s = OSCString.new('#bundle').encode
       s << encode_timetag(@timetag)
@@ -17,12 +15,9 @@ module OSC
 	    end.join
     end
 
-
     def to_a() @args.collect{|x| x.to_a} end
 
-
-    
-    private
+  private
 
     def encode_timetag(t)
       case t
@@ -30,16 +25,20 @@ module OSC
 	        t1 = 0
 	        t2 = 1
         when Numeric
-	        t1, fr = t.divmod(1)
-	        t2 = (fr * (2**32)).to_i
+	        t1, t2 = construct_timetag( t )
         when Time
-	        t1, fr = (t.to_f + 2208988800).divmod(1)
-	        t2 = (fr * (2**32)).to_i
+	        t1, t2 = construct_timetag( t.to_ntp )
         else
 	        raise ArgumentError, 'invalid time'
       end
       [t1, t2].pack('N2')
     end
 
+    def construct_timetag( time )
+      t1, fr = time.divmod(1)
+      t2 = (fr * (2**32)).to_i
+
+      [t1, t2]
+    end
   end
 end

data/lib/osc-ruby/client.rb

@@ -9,6 +9,5 @@ module OSC
     def send(mesg)
       @so.send(mesg.encode, 0)
     end
-
   end
 end

data/lib/osc-ruby/em_server.rb

@@ -2,54 +2,51 @@ require 'rubygems'
 require 'eventmachine'
 require File.join( File.dirname( __FILE__), '..', 'osc-ruby')
 
-
 module OSC
   Channel = EM::Channel.new
-  
-  class Connection < EventMachine::Connection 
 
-    def receive_data data    
+  class Connection < EventMachine::Connection
+    def receive_data data
      Channel << OSC::OSCPacket.messages_from_network( data )
     end
   end
 
-
   class EMServer
-  
+
     def initialize( port = 3333 )
       @port = port
       setup_dispatcher
       @tuples = []
     end
-  
+
     def run
       EM::run { EM::open_datagram_socket "localhost",  @port, Connection }
     end
-    
+
     def add_method(address_pattern, &proc)
       matcher = AddressPattern.new( address_pattern )
-    
+
       @tuples << [matcher, proc]
-    end  
-    
+    end
+
   private
     def setup_dispatcher
       Channel.subscribe do  |messages|
-        messages.each do |message|         
-          diff =  ( message.time || 0 ) - Time.now.to_ntp 
+        messages.each do |message|
+          diff =  ( message.time || 0 ) - Time.now.to_ntp
 
-          if diff <=  0 
+          if diff <=  0
             sendmesg( message )
-          else  
-            EM.defer  do   
-              sleep(  diff  )  
+          else
+            EM.defer  do
+              sleep(  diff  )
               sendmesg( message )
-            end  
-          end  
-        end  
+            end
+          end
+        end
       end
     end
-  
+
     def sendmesg(mesg)
       @tuples.each do |matcher, obj|
         if matcher.match?( mesg.address )
@@ -57,7 +54,6 @@ module OSC
         end
       end
     end
-  
   end
 end
 

data/lib/osc-ruby/message.rb

@@ -1,22 +1,19 @@
-require File.join( File.dirname( __FILE__ ), "packet" )
-
 module OSC
-  class Message < Packet
+  class Message
     attr_accessor :address
-    attr_accessor :time 
+    attr_accessor :time
 
-    
     def self.new_with_time( address, time, tags=nil, *args )
       message = new( address, tags, *args )
       message.time = time
       message
     end
-    
-    def initialize(address, *args)
+
+    def initialize( address, *args )
       @address = address
       @args = []
-      
-      args.each_with_index do |arg, i|
+
+      args.each do |arg|
         case arg
           when Integer;     @args << OSCInt32.new(arg)
           when Float;       @args << OSCFloat32.new(arg)
@@ -26,7 +23,6 @@ module OSC
       end
     end
 
-
     def tags() @args.collect{|x| x.tag}.join end
 
     def encode
@@ -36,8 +32,8 @@ module OSC
     end
 
     def to_a() @args.collect{|x| x.val} end
-      
-    def eql?( other )
+
+    def ==( other )
       @address == other.address &&
       to_a == other.to_a
     end

data/lib/osc-ruby/network_packet.rb

@@ -1,29 +1,29 @@
 module OSC
   class NetworkPacket
-    def initialize(str)       
-      @str, @index = str, 0 
+    def initialize(str)
+      @str, @index = str, 0
     end
-    
+
     def to_s
       @str
     end
-    
-    def rem() 
-      @str.length - @index 
+
+    def rem()
+      @str.length - @index
     end
-    
-    def eof? () 
-      rem <= 0 
+
+    def eof? ()
+      rem <= 0
     end
-    
-    def skip(n) 
-      @index += n 
+
+    def skip(n)
+      @index += n
     end
-    
-    def skip_padding() 
-      skip((4 - (@index % 4)) % 4) 
+
+    def skip_padding()
+      skip((4 - (@index % 4)) % 4)
     end
- 
+
     def getn(n)
     	raise EOFError if rem < n
     	s = @str[@index, n]
@@ -37,6 +37,5 @@ module OSC
     	skip(1)
     	c
     end
-    
   end
 end

data/lib/osc-ruby/osc_argument.rb

@@ -1,6 +1,5 @@
 module OSC
   class OSCArgument
-
     def initialize(val) @val = val end
 
     attr_accessor :val
@@ -9,7 +8,6 @@ module OSC
     def to_f() @val.to_f end
     def to_s() @val.to_s end
 
-
   private
     def padding(s)
       s + ("\000" * ((4 - (s.size % 4)) % 4))

data/lib/osc-ruby/osc_packet.rb

@@ -3,53 +3,53 @@ require 'ostruct'
 
 module OSC
   class OSCPacket
-        
+
     def self.messages_from_network( string )
       messages = []
       osc = new( string )
-      
+
       if osc.bundle?
         bundle = osc.get_string
         time = osc.get_timestamp
-        
+
         osc.get_bundle_messages.each do | message |
           messages << decode_simple_message( time, OSCPacket.new( message ) )
         end
-        
+
       else
         messages << decode_simple_message( time, osc )
       end
-      
+
       return messages
     end
-    
+
     def self.decode_simple_message( time, osc_packet )
       address = osc_packet.get_string
-      args = osc_packet.get_arguments 
+      args = osc_packet.get_arguments
 
       Message.new_with_time(address, time, nil, *args )
     end
-    
+
     def initialize( string )
       @packet = NetworkPacket.new( string )
-      
-      @types = { "i" => lambda{  OSCInt32.new(   get_int32 ) }, 
+
+      @types = { "i" => lambda{  OSCInt32.new(   get_int32 ) },
                  "f" => lambda{  OSCFloat32.new( get_float32 ) },
                  "s" => lambda{  OSCString.new(  get_string ) },
                  "b" => lambda{  OSCBlob.new(    get_blob )}
                 }
     end
-    
+
     def get_bundle_messages
       bundle_messages = []
-      
+
       until @packet.eof?
         l = @packet.getn(4).unpack('N')[0]
         bundle_messages << @packet.getn(l)
       end
       bundle_messages
     end
-    
+
     def get_string
       result = ''
       until (c = @packet.getc) == string_delemeter
@@ -58,58 +58,58 @@ module OSC
       @packet.skip_padding
       result
     end
-    
+
     def get_timestamp
       t1 = @packet.getn(4).unpack('N')[0]
       t2 = @packet.getn(4).unpack('N')[0]
       @packet.skip_padding
-      
+
       if t1 == 0 && t2 == 1
         time = nil
       else
         time = t1 + t2.to_f / (2**32)
       end
-      
+
       time
     end
-    
+
     def get_arguments
       if @packet.getc == ?,
-        
+
         tags = get_string
         args = []
-        
+
         tags.scan(/./) do | tag |
           args << @types[tag].call
         end
         args
       end
     end
-    
+
     def get_int32
       i = @packet.getn(4).unpack('N')[0]
       i -= 2**32 if i > (2**31-1)
       @packet.skip_padding
       i
     end
-    
+
     def get_float32
       f = @packet.getn(4).unpack('g')[0]
       @packet.skip_padding
       f
     end
-    
+
     def get_blob
       l = @packet.getn(4).unpack('N')[0]
       b = @packet.getn(l)
       @packet.skip_padding
       b
     end
-    
+
     def bundle?
       !(@packet.to_s =~ /\A\#bundle/).nil?
     end
-    
+
     def string_delemeter
       # ruby 1.9 has multicharacter support
       RUBY_VERSION.include?( '1.9' ) ? "\x00" : 0

data/lib/osc-ruby/osc_types.rb

@@ -2,30 +2,22 @@ require File.join( File.dirname( __FILE__ ), "osc_argument" )
 
  module OSC
   class OSCInt32 < OSCArgument
-
     def tag() 'i' end
     def encode() [@val].pack('N') end
-
   end
 
   class OSCFloat32 < OSCArgument
-
     def tag() 'f' end
     def encode() [@val].pack('g') end # fake - why fake?
-
   end
 
   class OSCString < OSCArgument
-
     def tag() 's' end
     def encode() padding(@val.sub(/\000.*\z/, '') + "\000") end
-
   end
 
   class OSCBlob < OSCArgument
-
     def tag() 'b' end
     def encode() padding([@val.size].pack('N') + @val) end
-
   end
 end

data/spec/unit/message_builder_spec.rb

@@ -0,0 +1,43 @@
+# sanity checks
+require File.join( File.dirname(__FILE__) , '..', 'spec_helper' )
+
+describe MessageBuilder do
+  before :each do
+    @builder = MessageBuilder.new
+  end
+   
+  it "encodes just the address" do
+    mesg = @builder.with_address("/hi")
+   mesg.build.encode.should == "/hi\000,\000\000\000"
+  end
+  
+  it "encodes single int values" do
+    mesg = @builder.with_address("/hi").
+                    with_int(33)
+                    
+    mesg.build.encode.should == "/hi\000,i\000\000\000\000\000!"
+  end
+  
+  it "encodes single string values" do
+    mesg = @builder.with_address("/hi").
+                    with_string("hello")
+                    
+    mesg.build.encode.should == "/hi\000,s\000\000hello\000\000\000"
+  end
+  
+  it "encodes single float values" do
+    mesg = @builder.with_address("/hi").
+                    with_float(3.14159)
+                    
+    mesg.build.encode.should == "/hi\000,f\000\000@I\017\320"
+  end
+  
+  it "encodes multiple floats" do
+    mesg = @builder.with_address("/hi").
+                    with_float(3.14159).
+                    with_float(4.5)
+                    
+    mesg.build.encode.should == [47, 104, 105, 0, 44, 102, 102, 0, 64, 73, 15, 208, 64, 144, 0, 0].pack("C*")
+  end
+  
+end

data/spec/unit/message_spec.rb

@@ -12,23 +12,47 @@ require File.join( File.dirname(__FILE__) , '..', 'spec_helper' )
 
 
 describe OSC::Message do
-  before :each do
-    @builder = MessageBuilder.new
-    @builder.with_int( 42 ).
-             with_int( 33 )
-             
-    @message = @builder.build
+  describe "basic traits" do
+    it "should have no arguments if you define none" do
+      m = OSC::Message.new( "/hi" )
+      m.to_a.should == []
+    end
+
+    it "should accept int arguments" do
+      m = OSC::Message.new( "/hi", 42 )
+      m.to_a.should == [42]
+      m.tags.should == "i"
+    end
+
+    it "should accept string arguments" do
+      m = OSC::Message.new( "/hi", "42" )
+      m.to_a.should == ["42"]
+      m.tags.should == "s"
+    end
+    
+    it "should accept float arguments" do
+      m = OSC::Message.new( "/hi", 42.001 )
+      m.to_a.should == [42.001]
+      m.tags.should == "f"
+    end
   end
   
-  it "should have no arguments if you define none" do
-    m = OSC::Message.new( "/hi" )
-    m.to_a.should == []
-  end
+  describe "more interesting traits" do
+    before :each do
+      @builder = MessageBuilder.new
+      @builder.with_int( 42 ).
+               with_int( 33 )
+             
+      @message = @builder.build
+    end
   
-  it "should have accept int arguments" do
-    m = OSC::Message.new( "/hi", 42 )
-    m.to_a.should == [42]
-    m.tags.should == "i"
-  end
+
   
+    it "should know equality" do
+      @message2 = @builder.build
+    
+      @message.object_id.should_not == @message2.object_id
+      @message.should == @message2
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: osc-ruby
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - aberant
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-16 00:00:00 -05:00
+date: 2009-12-03 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
-description: 
+description: a ruby client for the OSC protocol
 email: qzzzq1@gmail.com
 executables: []
 
@@ -38,11 +38,12 @@ files:
 - lib/osc-ruby/osc_argument.rb
 - lib/osc-ruby/osc_packet.rb
 - lib/osc-ruby/osc_types.rb
-- lib/osc-ruby/packet.rb
 - lib/osc-ruby/server.rb
 - README.rdoc
 has_rdoc: true
 homepage: http://github.com/aberant/osc-ruby
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --charset=UTF-8
@@ -63,14 +64,15 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: osc-ruby
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: inital gem
 test_files: 
 - spec/builders/message_builder.rb
 - spec/spec_helper.rb
 - spec/unit/address_pattern_spec.rb
+- spec/unit/message_builder_spec.rb
 - spec/unit/message_bundle_spec.rb
 - spec/unit/message_spec.rb
 - spec/unit/network_packet_spec.rb

data/lib/osc-ruby/packet.rb

@@ -1,134 +0,0 @@
-module OSC
-  class Packet
-
-    class PO
-      def initialize(str) 
-        @str, @index = str, 0 
-      end
-      
-      def rem() 
-        @str.length - @index 
-      end
-      
-      def eof? () 
-        rem <= 0 
-      end
-      
-      def skip(n) 
-        @index += n 
-      end
-      
-      def skip_padding() 
-        skip((4 - (@index % 4)) % 4) 
-      end
-
-      def getn(n)
-      	raise EOFError if rem < n
-      	s = @str[@index, n]
-      	skip(n)
-      	s
-      end
-
-      def getc
-      	raise EOFError if rem < 1
-      	c = @str[@index]
-      	skip(1)
-      	c
-      end
-    end
-
-    def self.decode_int32(io)
-      i = io.getn(4).unpack('N')[0]
-      i -= 2**32 if i > (2**31-1)
-      i
-    end
-
-    def self.decode_float32(io)
-      f = io.getn(4).unpack('g')[0]
-      f
-    end
-
-    def self.decode_string(io)
-      s = ''
-      until (c = io.getc) == 0
-	      s << c
-      end
-      io.skip_padding
-      s
-    end
-
-    def self.decode_blob(io)
-      l = io.getn(4).unpack('N')[0]
-      b = io.getn(l)
-      io.skip_padding
-      b
-    end
-
-    def self.decode_timetag(io)
-      t1 = io.getn(4).unpack('N')[0]
-      t2 = io.getn(4).unpack('N')[0]
-      [t1, t2]
-    end
-
-    def self.decode2(time, packet, list)
-      io = PO.new(packet)
-      id = decode_string(io)
-      if id =~ /\A\#/
-	      if id == '#bundle'
-	        t1, t2 = decode_timetag(io)
-	        if t1 == 0 && t2 == 1
-	          time = nil
-	        else
-	          time = t1 + t2.to_f / (2**32)
-	        end
-	        until io.eof?
-	          l = io.getn(4).unpack('N')[0]
-	          s = io.getn(l)
-	          decode2(time, s, list)
-	        end
-	      end
-      elsif id =~ /\//
-        address = id
-        if io.getc == ?,
-          tags = decode_string(io)
-          args = []
-          tags.scan(/./) do |t|
-            case t
-             when 'i'
-               i = decode_int32(io)
-               args << OSCInt32.new(i)
-             when 'f'
-               f = decode_float32(io)
-               args << OSCFloat32.new(f)
-             when 's'
-               s = decode_string(io)
-               args << OSCString.new(s)
-             when 'b'
-               b = decode_blob(io)
-               args << OSCBlob.new(b)
-             when /[htd]/; io.read(8)
-             when 'S'; decode_string(io)
-             when /[crm]/; io.read(4)
-             when /[TFNI\[\]]/;
-            end
-	        end
-	        list << [time, Message.new(address, nil, *args)]
-        end
-      end
-    end
-    
-    private_class_method  :decode_int32, 
-                          :decode_float32, 
-                          :decode_string, 
-                          :decode_blob, 
-                          :decode_timetag, 
-                          :decode2
-
-    def self.decode(packet)
-      list = []
-      decode2(nil, packet, list)
-      list
-    end
-
-  end
-end