micro-osc 0.0.1

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2011-2012 Ari Russo
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.rdoc

@@ -0,0 +1,74 @@
+= MicroOSC
+
+A Ruby DSL for OSC
+
+== Features
+
+* Works with MRI and JRuby
+* Network resources are invisible to the user even when shared or multiplexed
+* Includes shortcuts for common tasks associated with OSC such as translating numeric values from one range to another
+* Network discoverable using {Zeroconf}[http://en.wikipedia.org/wiki/Zero_configuration_networking]
+
+== Requirements
+
+Ruby (MRI) 1.9.2+ or JRuby (in 1.9 mode)
+
+{eventmachine}[http://github.com/eventmachine/eventmachine] (version 0.12.8 recommended for MRI)
+
+{osc-access}[http://github.com/arirusso/osc-access]
+
+{osc-ruby}[http://github.com/aberant/osc-ruby]  
+
+(These should install automatically with the gem)
+
+For Zeroconf support, {dnssd}[http://github.com/tenderlove/dnssd] is required.
+
+== Installation
+
+  gem install micro-osc
+  
+== Usage
+
+The following are two MicroOSC programs; the first will receive OSC messages and the second will send one.  Run them in two separate windows and they will talk to each other.
+
+Here's the receiver...
+
+  require "osc"
+
+  OSC.using(:input_port => 8000) do
+  
+    receive("/greeting") { |val| p "received #{val}" }
+    
+    p "Ready to receive OSC messages on port(s) #{input_ports.join(', ')}..."
+    
+    wait_for_input
+
+  end
+  
+When you run this, You should see confirmation that the program is running "Ready to receive OSC..." in your Ruby console.
+  
+Next, in another window run this the client program:
+
+  require "osc"
+
+  OSC.using(:output => { :host => "localhost", :port => 8000 }) do
+  
+    out "/greeting", "hullo!"
+
+  end
+
+After running it, flip back to the first receiver program and see "received hullo!", confirming that these two programs could reach each other.
+
+Note that a single MicroOSC block can act as a client and receiver, both sending and receiving OSC ({see here...}[http://github.com/arirusso/micro-osc/blob/master/examples/duplex.rb])
+
+These examples and more are available {here}[http://github.com/arirusso/micro-osc/tree/master/examples]
+
+== Other Documentation
+
+* {rdoc}[http://rubydoc.info/github/arirusso/micro-osc] 
+
+== License
+
+Licensed under Apache 2.0, See the file LICENSE
+
+Copyright © 2011-2012 Ari Russo

data/lib/micro-osc.rb

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+#
+# MicroOSC
+# A Ruby DSL for OSC
+# (c)2011 Ari Russo and licensed under the Apache 2.0 License
+# 
+
+# libs
+require "forwardable"
+require "osc-access"
+
+# modules
+
+# classes
+require "micro-osc/context"
+require "micro-osc/state"
+
+module MicroOSC
+  
+  VERSION = "0.0.1"
+  
+  def self.message(options = {}, &block)
+    MicroOSC::Context.new(options, &block)
+  end
+  
+  class << self
+    alias_method :using, :message
+  end
+  
+end
+
+# define this module again to avoid overwriting another OSC module
+module OSC
+  
+  def self.message(*a, &block)
+    MicroOSC.using(*a, &block)
+  end
+  
+  class << self
+    alias_method :using, :message
+  end
+ 
+end
+
+require "micro-osc/shorthand"

data/lib/micro-osc/context.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+#
+
+module MicroOSC
+  
+  class Context
+    
+    include OSCAccessible
+    
+    extend Forwardable
+    
+    attr_reader :state
+    
+    def_delegator :state, :output_cache, :cache
+    
+    alias_method :output, :osc_send
+    alias_method :receive, :osc_receive
+            
+    def initialize(options = {}, &block)
+      @state = State.new
+      osc_start(options.merge({}))
+      edit(&block) if block_given?
+    end
+    
+    # open a block for editing/live coding in this Context
+    def edit(&block)
+      self.instance_eval(&block)
+    end
+    
+    def receive(pattern, options = {}, &block)
+      osc_receive(pattern, options) { |target_obj, val| yield(val) }
+      sleep(0.01)
+    end
+    
+    # repeat the last command
+    def repeat
+      self.send(@state.last_command[:method], *@state.last_command[:args]) unless @state.last_command.nil?
+    end
+    
+    # shortcut to an array of port numbers
+    def input_ports
+      @osc_receiver.servers.keys
+    end
+    
+    def method_missing(m, *a, &b)
+      outp = nil
+      options = a.last.kind_of?(Hash) ? a.last : {}
+      do_output = options[:output] || true
+      outp = super
+      @state.record(m, a, b, outp)
+    end
+    
+    def join(options = {})
+      osc_join(options)
+    end
+    alias_method :wait_for_input, :join
+        
+  end
+end

data/lib/micro-osc/shorthand.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+#
+
+module MicroOSC
+  
+  alias l loop
+ 
+  class << self
+    alias_method :m, :message
+  end
+  
+  class Context
+    alias_method :o, :output
+    alias_method :out, :output
+    alias_method :r, :repeat
+  end
+  
+end
+
+def O(*a, &block)
+  OSC.message(*a, &block)  
+end

data/lib/micro-osc/state.rb

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+#
+module MicroOSC
+
+  class State
+    
+    Default = {
+      :channel => 0,
+      :octave => 2,
+      :velocity => 100
+    }
+    
+    attr_accessor :auto_output,
+                  :pattern,
+                  :super_sticky
+    
+    attr_reader :last_command,
+                :output_cache
+        
+    def initialize(options = {})
+      @auto_output = true
+      @last_command = nil    
+      @super_sticky = false
+
+      @channel = options[:channel] || Default[:channel]
+      @velocity = options[:velocity] || Default[:velocity]
+      @octave = options[:octave] || Default[:octave]  
+      
+    end
+    
+    def record(m, a, b, outp)
+      ts = now
+      @output_cache << { :message => outp, :timestamp => ts }
+      @last_command = { :method => m, :args => a, :block => b, :timestamp => ts }
+    end
+    
+    def toggle_super_sticky
+      @super_sticky = !@super_sticky
+    end
+    
+    def toggle_auto_output
+      @auto_output = !@auto_output
+    end
+
+    def message_properties(opts, *props)
+      output = {}
+      props.each do |prop|
+        output[prop] = opts[prop]
+        self.send("#{prop.to_s}=", output[prop]) if !output[prop].nil? && (self.send(prop).nil? || @super_sticky)
+        output[prop] ||= self.send(prop.to_s)
+      end
+      output
+    end
+   
+
+  end
+
+end

data/lib/osc.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+#
+# micromidi
+# A Ruby DSL for OSC
+#
+# (c)2011 Ari Russo 
+# licensed under the Apache 2.0 License
+#
+
+# the purpose of this file is just to allow both 
+# <em>require "micro-osc"</em>
+# and 
+# <em>require "osc"</em>
+
+require 'micro-osc'

data/test/helper.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+dir = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift dir + '/../lib'
+
+require 'test/unit'
+require 'micro-osc'
+
+module TestHelper
+  
+  $port_counter = 8000
+  
+  def self.next_port
+    $port_counter += 1
+  end
+     
+end

data/test/test_context.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/env ruby
+
+require 'helper'
+
+class ContextTest < Test::Unit::TestCase
+
+  include MicroOSC
+  include TestHelper
+  
+  def test_output
+    sleep(0.5)
+    received = nil
+    port = TestHelper.next_port
+    
+    server = OSC::EMServer.new(port)
+    server.add_method("/test_output") do |message|
+      received = message.args[0]
+    end 
+    Thread.new { server.run }
+    
+    sleep(0.5)
+    
+    OSC.using(:output => { :port => port, :host => "localhost" }) do
+      output("/test_output", "hi friend")
+    end
+    
+    sleep(0.5)
+    
+    assert_equal("hi friend", received)
+  end
+  
+  def test_input
+    sleep(0.5)
+    received = nil
+    port = TestHelper.next_port
+
+    OSC.using(:input_port => port) do
+      receive("/test_input") do |val|
+        received = val
+      end
+    end    
+    sleep(0.5)
+    
+    client = OSC::Client.new("localhost", port)
+    client.send( OSC::Message.new( "/test_input", "hullo from test_input!"))      
+    sleep(0.5)
+    
+    assert_equal("hullo from test_input!", received)  
+  end
+  
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: micro-osc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ari Russo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-17 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: &70257285738520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70257285738520
+- !ruby/object:Gem::Dependency
+  name: osc-access
+  requirement: &70257285769300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70257285769300
+- !ruby/object:Gem::Dependency
+  name: osc-ruby
+  requirement: &70257285768880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70257285768880
+description: A Ruby DSL for OSC
+email:
+- ari.russo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/micro-osc/context.rb
+- lib/micro-osc/shorthand.rb
+- lib/micro-osc/state.rb
+- lib/micro-osc.rb
+- lib/osc.rb
+- test/helper.rb
+- test/test_context.rb
+- LICENSE
+- README.rdoc
+homepage: http://github.com/arirusso/micro-osc
+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: 1.3.6
+requirements: []
+rubyforge_project: osc-access
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: A Ruby DSL for OSC
+test_files: []