osc-ruby 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b6e50d421b58c68e16b4d82d132f25e15b0338b
+  data.tar.gz: 8875e8b6aa9cf1af663291b248c5708695ed1448
+SHA512:
+  metadata.gz: c814bfa20121cb7a835159546c858b9f6d3370c6158e067c17df7ceeb379608c98242375ef5b776488cd35efe4c7df1a25b3439c2a97c01eed7799be7daf15c8
+  data.tar.gz: 576b0fcabd35b30da9cdfad8477d788ddec610fc455b796a4322483a1b3917a3f26f332e8536cc0b6dd534a3ea2c6b63b75a5cb5f22e1262944e309aed16c091

data/Rakefile

@@ -4,11 +4,11 @@ task :default => :spec
 
 RSpec::Core::RakeTask.new do |t|
   t.rcov = false
-  t.rspec_opts = ["--colour"]
+  t.rspec_opts = ["--colour", "--format", "documentation"]
 end
 
 require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
+RDoc::Task.new do |rdoc|
   if File.exist?('VERSION')
     version = File.read('VERSION')
   else

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/examples/event_machine_server.rb

@@ -10,7 +10,7 @@ require 'osc-ruby/em_server'
 @client = OSC::Client.new( 'localhost', 3333 )
 
 @server.add_method '/greeting' do | message |
-  puts message.to_a
+  puts "#{message.ip_address}:#{message.ip_port} -- #{message.address} -- #{message.to_a}"
 end
 
 Thread.new do

data/lib/osc-ruby/address_pattern.rb

@@ -2,43 +2,48 @@ module OSC
   class AddressPattern
     def initialize( pattern )
       @pattern = pattern
-      
+
       generate_regex_from_pattern
     end
-    
+
     def match?( address )
       !!(@re.nil? || @re.match( address ))
     end
-    
-private 
+
+private
     def generate_regex_from_pattern
       case @pattern
         when NIL; @re = @pattern
         when Regexp; @re = @pattern
         when String
-          
+
           # i'm unsure what this does
           # @pattern.gsub!(/[.^(|)]/, '\\1')
-          
+
           # handles osc single char wildcard matching
           @pattern.gsub!(/\?/, '[^/]')
-          
+
+          # handles ** - used in creating osc routers
+          # TODO: turns out the OSC 1.1 spec says that we shoudl use "//" 
+          # this will be implemented in the next major release of this gem
+          #@pattern.gsub!(/\*\*/, '.*' )
+
           # handles osc * - 0 or more matching
-          @pattern.gsub!(/\*/, '[^/]*')
-          
+          @pattern.gsub!(/\*[^\*]/, '[^/]*')
+
           # handles [!] matching
           @pattern.gsub!(/\[!/, '[^')
-            
+
           # handles {} matching
           @pattern.gsub!(/\{/, '(')
           @pattern.gsub!(/,/, '|')
           @pattern.gsub!(/\}/, ')')
-          
-          
+
+
           # keeps from matching before the begining of the pattern
           @pattern.gsub!(/\A/, '\A')
-          
-          # keeps from matching beyond the end, 
+
+          # keeps from matching beyond the end,
           # eg. pattern /hi does not match /hidden
           @pattern.gsub!(/\z/, '\z')
 

data/lib/osc-ruby/network_packet.rb

@@ -1,7 +1,7 @@
 module OSC
   class NetworkPacket
     def initialize(str)
-      @str, @index = str, 0
+      @str, @index = str.force_encoding("BINARY"), 0
     end
 
     def to_s

data/lib/osc-ruby/osc_packet.rb

@@ -9,15 +9,15 @@ module OSC
       osc = new( string )
 
       if osc.bundle?
-        bundle = osc.get_string
+        osc.get_string #=> bundle
         time = osc.get_timestamp
 
         osc.get_bundle_messages.each do | message |
           msg = decode_simple_message( time, OSCPacket.new( message ) )
           if ip_info
             # Append info for the ip address
-            msg.ip_address = ip_info[1].to_s + "." + ip_info[2].to_s + "." + ip_info[3].to_s + "." + ip_info[4].to_s
-            msg.ip_port = ip_info[0]
+            msg.ip_port = ip_info.shift
+            msg.ip_address = ip_info.join(".")
           end
           messages << msg
         end
@@ -26,8 +26,8 @@ module OSC
         msg = decode_simple_message( time, osc )
         if ip_info
           # Append info for the ip address
-          msg.ip_address = ip_info[1].to_s + "." + ip_info[2].to_s + "." + ip_info[3].to_s + "." + ip_info[4].to_s
-          msg.ip_port = ip_info[0]
+            msg.ip_port = ip_info.shift
+            msg.ip_address = ip_info.join(".")
         end
         messages << msg
       end
@@ -72,6 +72,7 @@ module OSC
     end
 
     def get_timestamp
+      #TODO: refactor this so a mortal can figure it out
       t1 = @packet.getn(4).unpack('N')[0]
       t2 = @packet.getn(4).unpack('N')[0]
       @packet.skip_padding
@@ -123,8 +124,7 @@ module OSC
     end
 
     def string_delemeter
-      # ruby 1.9 has multicharacter support
-      RUBY_VERSION.include?( '1.9' ) ? "\x00" : 0
+     "\x00"
     end
   end
 end

data/lib/osc-ruby/osc_types.rb

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

data/spec/unit/address_pattern_spec.rb

@@ -1,36 +1,47 @@
 require File.join( File.dirname(__FILE__) , '..', 'spec_helper' )
 
 describe OSC::AddressPattern do
+  # it "..." do
+  #   ap = OSC::AddressPattern.new("/bob/test/**")
+
+  #   ap.match?("/bob/test/monkey").should be_true
+  #   ap.match?("/bob/test/monkey/shine/rainy/day").should be_true
+
+  #   ap.match?("/bob/test").should be_false
+  #   ap.match?("/bob").should be_false
+
+  # end
+
   it "should match anything if the pattern is nil" do
     ap = OSC::AddressPattern.new( nil )
-    
+
     ap.match?( "/some/nonsense").should be_true
     ap.match?( "/completely.different").should be_true
   end
-  
+
   it "should match based on a regex" do
     ap = OSC::AddressPattern.new( /hi/ )
-    
+
     ap.match?( '/hi' ).should be_true
     ap.match?( '/hidden' ).should be_true
-    
+
     ap.match?( '/bye' ).should be_false
-  end 
-  
+  end
+
   it "should return a regex if the pattern is a string" do
     ap = OSC::AddressPattern.new( "/hi" )
-    
+
     ap.match?('/hi').should be_true
-    
+
     ap.match?('   /hi').should be_false
     ap.match?('/ahi').should be_false
     ap.match?( '/hidden' ).should be_false
     ap.match?( '/bye' ).should be_false
   end
-  
+
   it "should match with question mark" do
     ap = OSC::AddressPattern.new( "/h?l" )
-    
+
     ap.match?('/hal').should be_true
     ap.match?('/hel').should be_true
     ap.match?('/hil').should be_true
@@ -38,20 +49,20 @@ describe OSC::AddressPattern do
     ap.match?('/hul').should be_true
     ap.match?('/hub').should be_false
   end
-  
+
   it "should match with *" do
     ap = OSC::AddressPattern.new( "/believ*d" )
-    
+
     ap.match?('/believd').should be_true
     ap.match?('/believed').should be_true
     ap.match?('/believeeed').should be_true
     ap.match?('/believaeeeioud').should be_true
     ap.match?('/believaeeeioud').should be_true
   end
-  
+
   it "should match with []" do
     ap = OSC::AddressPattern.new( "/believ[aeiou]d" )
-    
+
     ap.match?('/believad').should be_true
     ap.match?('/believed').should be_true
     ap.match?('/believid').should be_true
@@ -59,10 +70,10 @@ describe OSC::AddressPattern do
     ap.match?('/believud').should be_true
     ap.match?('/believkd').should be_false
   end
-  
+
   it "should match with [!]" do
     ap = OSC::AddressPattern.new( "/believ[!aeiou]d" )
-    
+
     ap.match?('/believad').should be_false
     ap.match?('/believed').should be_false
     ap.match?('/believid').should be_false
@@ -71,13 +82,13 @@ describe OSC::AddressPattern do
     ap.match?('/believkd').should be_true
     ap.match?('/believzd').should be_true
   end
-  
+
   it "should match with {}" do
     ap = OSC::AddressPattern.new( "/{hi,bye}" )
-    
+
     ap.match?('/hi').should be_true
     ap.match?('/bye').should be_true
     ap.match?('/greetings').should be_false
   end
-  
+
 end

data/spec/unit/message_builder_spec.rb

@@ -8,28 +8,28 @@ describe MessageBuilder do
    
   it "encodes just the address" do
     mesg = @builder.with_address("/hi")
-   mesg.build.encode.should == "/hi\000,\000\000\000"
+   mesg.build.encode.should == binary_string("/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!"
+    mesg.build.encode.should == binary_string("/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"
+    mesg.build.encode.should == binary_string("/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"
+    mesg.build.encode.should == binary_string("/hi\000,f\000\000@I\017\320")
   end
   
   it "encodes multiple floats" do
@@ -40,4 +40,7 @@ describe MessageBuilder do
     mesg.build.encode.should == [47, 104, 105, 0, 44, 102, 102, 0, 64, 73, 15, 208, 64, 144, 0, 0].pack("C*")
   end
   
+  def binary_string(string)
+    string.force_encoding("BINARY")
+  end
 end

data/spec/unit/message_spec.rb

@@ -37,6 +37,23 @@ describe OSC::Message do
     end
   end
   
+  describe "message output encoding" do
+    it "integer arguments output binary/ascii string" do
+      m = OSC::Message.new( "/hi", 42 ).encode
+      m.encoding.to_s.should == "ASCII-8BIT"
+    end
+
+    it "string arguments output binary/ascii string" do
+      m = OSC::Message.new( "/hi", "42" ).encode
+      m.encoding.to_s.should == "ASCII-8BIT"
+    end
+
+    it "float arguments output binary/ascii string" do
+      m = OSC::Message.new( "/hi", 3.14159 ).encode
+      m.encoding.to_s.should == "ASCII-8BIT"
+    end
+  end
+
   describe "more interesting traits" do
     before :each do
       @builder = MessageBuilder.new
@@ -46,8 +63,6 @@ describe OSC::Message do
       @message = @builder.build
     end
   
-
-  
     it "should know equality" do
       @message2 = @builder.build
     

data/spec/unit/network_packet_spec.rb

@@ -30,4 +30,8 @@ describe OSC::NetworkPacket do
   it "should be able to get a number of characters from the stream" do
     @simple.getn(3).should == "abc"
   end
+
+  it "outputs characters with ASCII/BINARY encoding" do
+    @simple.getc.encoding.to_s.should == "ASCII-8BIT"
+  end
 end

data/spec/unit/osc_simple_packets_spec.rb

@@ -44,7 +44,7 @@ describe OSC::OSCPacket do
     msg.first.to_a.should == [@first_int, @second_int]
   end
 
-  it "shold decode address with float arg" do
+  it "should decode address with float arg" do
     sent_msg = @builder.with_float( @first_float ).build
 
     msg = OSC::OSCPacket.messages_from_network( sent_msg.encode )
@@ -53,7 +53,7 @@ describe OSC::OSCPacket do
   end
 
 
-  it "shold decode address with two float args" do
+  it "should decode address with two float args" do
     sent_msg = @builder.with_float( @first_float ).with_float( @second_float).build
 
     msg = OSC::OSCPacket.messages_from_network( sent_msg.encode )

metadata

@@ -1,18 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: osc-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
-  prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Colin Harris
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-28 00:00:00.000000000 Z
-dependencies: []
+date: 2013-05-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This OSC gem originally created by Tadayoshi Funaba has been updated
-  for ruby 1.9/JRuby compatibility
+  for ruby 2.0/1.9/JRuby compatibility
 email: qzzzq1@gmail.com
 executables: []
 extensions: []
@@ -21,10 +34,7 @@ files:
 - Rakefile
 - VERSION
 - LICENSE
-- examples/classic_server.rb
-- examples/classic_server_ip_info.rb
 - examples/event_machine_server.rb
-- examples/ip_info.rb
 - lib/osc-ruby/address_pattern.rb
 - lib/osc-ruby/bundle.rb
 - lib/osc-ruby/client.rb
@@ -51,27 +61,26 @@ files:
 - spec/unit/osc_types_spec.rb
 homepage: http://github.com/aberant/osc-ruby
 licenses: []
+metadata: {}
 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
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: a ruby client for the OSC protocol
 test_files:
 - spec/builders/message_builder.rb

data/examples/classic_server.rb

@@ -1,18 +0,0 @@
-# compatible with ruby 1.8
-$:.unshift File.join( File.dirname( __FILE__ ), '..', 'lib')
-require 'osc-ruby'
-
-@server = OSC::Server.new( 3333 )
-@client = OSC::Client.new( 'localhost', 3333 )
-
-@server.add_method '/greeting' do | message |
-  puts message.to_a
-end
-
-Thread.new do
-  @server.run
-end
-
-@client.send( OSC::Message.new( "/greeting", "hullo!" ))
-
-sleep( 3 )

data/examples/classic_server_ip_info.rb

@@ -1,18 +0,0 @@
-# compatible with ruby 1.8
-$:.unshift File.join( File.dirname( __FILE__ ), '..', 'lib')
-require 'osc-ruby'
-
-@server = OSC::Server.new( 3333 )
-@client = OSC::Client.new( 'localhost', 3333 )
-
-@server.add_method '/greeting' do | message |
-  puts message.ip_address + ":" + message.ip_port.to_s + " -- " + message.address + " -- " + message.to_a.to_s
-end
-
-Thread.new do
-  @server.run
-end
-
-@client.send( OSC::Message.new( "/greeting", "hullo!" ))
-
-sleep( 3 )

data/examples/ip_info.rb

@@ -1,22 +0,0 @@
-# compatible with ruby 1.8, 1.9, and jruby
-$:.unshift File.join( File.dirname( __FILE__ ), '..', 'lib')
-require 'osc-ruby'
-
-require 'rubygems'
-require 'eventmachine'
-require 'osc-ruby/em_server'
-
-@server = OSC::EMServer.new( 3333 )
-@client = OSC::Client.new( 'localhost', 3333 )
-
-@server.add_method '/greeting' do | message |
-  puts message.ip_address + ":" + message.ip_port.to_s + " -- " + message.address + " -- " + message.to_a.to_s
-end
-
-Thread.new do
-  @server.run
-end
-
-@client.send( OSC::Message.new( "/greeting" , "hullo!" ))
-
-sleep( 3 )