qlab-ruby 0.1.2

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# local concerns
+.DS_Store
+.rake_tasks~

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in qlab-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adam Bachman
+
+MIT License
+
+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.md

@@ -0,0 +1,59 @@
+# QLab
+
+Interact with QLab from Ruby.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'qlab-ruby'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install qlab-ruby
+
+## Usage
+
+    > require 'qlab-ruby'
+    > machine = QLab.connect # defaults to ('localhost', 53000)
+    > machine.workspaces.first.go
+
+And you're off.
+
+A `machine` has one or more `workspaces`. A `workspace` has one or more
+`cue_lists`. A `cue` can respond to any of the QLab OSC commands.
+
+    > cue.start
+    > cue.stop
+
+etc.
+
+Most OSC commands that accept a single value can be called by their `=`
+versions. For example:
+
+    > cue.rate(0.5)
+
+and
+
+    > cue.rate = 0.5
+
+do the same thing.
+
+OSC commands that require multiple arguments will still have to be called
+as methods.
+
+    > cue.sliderLevel(1, -5)
+
+To set slider 1 to the value -5.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,21 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+gem 'rdoc'
+require 'rdoc/task'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.libs << 'qlab-ruby'
+  t.test_files = FileList['test/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test
+
+RDoc::Task.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "qlab-ruby #{QLab::VERSION}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/qlab-ruby.rb

@@ -0,0 +1,34 @@
+require "qlab-ruby/version"
+require "qlab-ruby/core-ext/osc-ruby"
+
+module QLab
+  autoload :Commands, 'qlab-ruby/commands'
+  autoload :Communicator, 'qlab-ruby/communicator'
+  autoload :Cue, 'qlab-ruby/cue'
+  autoload :CueList, 'qlab-ruby/cue_list'
+  autoload :Machine, 'qlab-ruby/machine'
+  autoload :Reply, 'qlab-ruby/reply'
+  autoload :Workspace, 'qlab-ruby/workspace'
+
+  class << self
+    def connect machine_address='localhost', port=53000
+      begin
+        # global QLab connection
+        new_machine = Machine.new(machine_address, port)
+      rescue Errno::ECONNREFUSED
+        puts "Failed to connect to QLab machine at #{machine_address}:#{port}, please make sure your values are correct and QLab is running."
+        raise
+      end
+
+      if new_machine.connected?
+        new_machine.alwaysReply = 1
+      end
+
+      new_machine
+    end
+
+    def debug msg
+      # puts msg
+    end
+  end
+end

data/lib/qlab-ruby/commands.rb

@@ -0,0 +1,223 @@
+module QLab
+  # All commands QLab accepts
+  module Commands
+    MACHINE = %w(
+      alwaysReply
+      connect
+      version
+      workingDirectory
+      workspaces
+    )
+
+    WORKSPACE = %w(
+      cueLists
+      go
+      hardStop
+      new
+      panic
+      pause
+      reset
+      resume
+      runningCues
+      runningOrPausedCues
+      select
+      selectedCues
+      stop
+      thump
+      toggleFullScreen
+      updates
+    )
+
+    CUE = %w(
+      actionElapsed
+      allowsEditingDuration
+      armed
+      children
+      colorName
+      continueMode
+      cueTargetId
+      cueTargetNumber
+      defaultName
+      displayName
+      duration
+      fileTarget
+      flagged
+      hardStop
+      hasCueTargets
+      hasFileTargets
+      isBroken
+      isLoaded
+      isPaused
+      isRunning
+      listName
+      load
+      loadAt
+      name
+      notes
+      number
+      panic
+      pause
+      percentActionElapsed
+      percentPostWaitElapsed
+      percentPreWaitElapsed
+      postWait
+      postWaitElapsed
+      preWait
+      preWaitElapsed
+      preview
+      reset
+      resume
+      sliderLevel
+      sliderLevels
+      start
+      stop
+      togglePause
+      type
+      uniqueID
+      valuesForKeys
+    )
+
+    GROUP_CUE = %w(
+      playbackPositionId
+    )
+
+    AUDIO_CUE = %w(
+      doFade
+      doPitchShift
+      endTime
+      infiniteLoop
+      level
+      patch
+      playCount
+      rate
+      sliderLevel
+      sliderLevels
+      startTime
+    )
+
+    FADE_CUE = %w(
+      level
+      sliderLevel
+      sliderLevels
+    )
+
+    MIC_CUE = %w(
+      level
+      sliderLevel
+      sliderLevels
+    )
+
+    VIDEO_CUE = %w(
+      cueSize
+      doEffect
+      doFade
+      doPitchShift
+      effect
+      effectSet
+      endTime
+      fullScreen
+      infiniteLoop
+      layer
+      level
+      opacity
+      patch
+      playCount
+      preserveAspectRatio
+      quaternion
+      rate
+      scaleX
+      scaleY
+      sliderLevel
+      sliderLevels
+      startTime
+      surfaceID
+      surfaceList
+      surfaceSize
+      translationX
+      translationY
+    )
+
+    # in blocks of: all, group, audio, video, osc, midi, devamp, script
+    SET_CUES = %w(
+      number
+      name
+      notes
+      fileTarget
+      cueTargetNumber
+      cueTargetId
+      preWait
+      duration
+      postWait
+      continueMode
+      flagged
+      autoLoad
+      armed
+      colorName
+
+      playbackPositionId
+
+      patch
+      startTime
+      endTime
+      playCount
+      infiniteLoop
+      rate
+      doPitchShift
+      doFade
+
+      surfaceID
+      patch
+      fullScreen
+      layer
+      opacity
+      preserveAspectRatio
+      translationX
+      translationY
+      scaleX
+      scaleY
+      doEffect
+      effectSet
+
+      messageType
+      qlabCommand
+      qlabCueNumber
+      qlabCueParameters
+      rawString
+
+      duration
+      messageType
+      status
+      channel
+      byte1
+      byte2
+      byteCombo
+      doFade
+      endValue
+      deviceID
+      commandFormat
+      command
+      qNumber
+      qList
+      qPath
+      macro
+      controlNumber
+      controlValue
+      timecodeString
+      hours
+      minutes
+      seconds
+      frames
+      subframes
+      timecodeFormat
+      rawString
+
+      startNextCueWhenSliceEnds
+      stopTargetWhenSliceEnds
+
+      scriptSource
+    )
+
+    ALL_CUES = (CUE + GROUP_CUE + AUDIO_CUE + FADE_CUE + MIC_CUE + VIDEO_CUE).uniq.sort
+  end
+end
+

data/lib/qlab-ruby/communicator.rb

@@ -0,0 +1,51 @@
+module QLab
+  # An abstract class providing communication behavior for objects that need to
+  # interact with QLab.
+  class Communicator
+
+    def send_message osc_address, *osc_arguments
+      osc_address = format_osc_address(osc_address)
+
+      if osc_arguments.size > 0
+        osc_message = OSC::Message.new osc_address, *osc_arguments
+      else
+        osc_message = OSC::Message.new osc_address
+      end
+      responses = []
+
+      QLab.debug "[Action send_message] send #{ osc_message.encode }"
+      connection.send(osc_message) do |response|
+        responses << QLab::Reply.new(response)
+      end
+
+      if responses.size == 1
+        q_reply = responses[0]
+        QLab.debug "[Action send_message] got one response: #{q_reply.inspect}"
+
+        if q_reply.has_data?
+          QLab.debug "[Action send_message] single response has data: #{q_reply.data.inspect}"
+          q_reply.data
+        elsif q_reply.has_status?
+          QLab.debug "[Action send_message] single response has status: #{q_reply.status.inspect}"
+          q_reply.status
+        else
+          QLab.debug "[Action send_message] single response has no data or status: #{q_reply.inspect}"
+          q_reply
+        end
+      else
+        responses
+      end
+    end
+
+    private
+
+    def format_osc_address address
+      if %r[^/] !~ address.to_s
+        "/#{ address }"
+      else
+        address
+      end
+    end
+
+  end
+end

data/lib/qlab-ruby/core-ext/osc-ruby.rb

@@ -0,0 +1,6 @@
+require 'osc-ruby'
+
+require 'qlab-ruby/core-ext/osc-ruby/message'
+require 'qlab-ruby/core-ext/osc-ruby/tcp'
+require 'qlab-ruby/core-ext/osc-ruby/sending_socket'
+require 'qlab-ruby/core-ext/osc-ruby/tcp_client'

data/lib/qlab-ruby/core-ext/osc-ruby/message.rb

@@ -0,0 +1,25 @@
+module OSC
+  # Reopen the osc-ruby Message class to provide additional methods to support
+  # QLab's use of OSC.
+  class Message
+    def has_arguments?
+      to_a.size > 0
+    end
+
+    # attachable responder, for use with TCP::Server
+    def responder
+      @responder
+    end
+
+    def responder=(val)
+      @responder = val
+    end
+
+    def debug
+      types = to_a.map(&:class).map(&:to_s).join(', ')
+      args  = to_a
+
+      "#{ip_address}:#{ip_port} -- #{address} -- [#{ types }] -- #{ args.inspect }"
+    end
+  end
+end

data/lib/qlab-ruby/core-ext/osc-ruby/sending_socket.rb

@@ -0,0 +1,47 @@
+module OSC
+  module TCP
+    # A wrapper around an open TCP socket providing SLIP encoding for outbound
+    # messages.
+    class SendingSocket
+      def initialize socket
+        @socket = socket
+      end
+
+      # send SLIP encoded OSC messages
+      def send msg
+        @socket_buffer = []
+
+        enc_msg = msg.encode
+
+        send_char CHAR_END
+
+        enc_msg.bytes.each do |b|
+          case b
+          when CHAR_END
+            send_char CHAR_ESC
+            send_char CHAR_ESC_END
+          when CHAR_ESC
+            send_char CHAR_ESC
+            send_char CHAR_ESC_ESC
+          else
+            send_char b
+          end
+        end
+
+        send_char CHAR_END
+
+        flush
+      end
+
+      private
+
+      def flush
+        @socket.send @socket_buffer.join, 0
+      end
+
+      def send_char c
+        @socket_buffer << [c].pack('C')
+      end
+    end
+  end
+end

data/lib/qlab-ruby/core-ext/osc-ruby/tcp.rb

@@ -0,0 +1,15 @@
+module OSC
+  # SLIP encoding constants.
+  module TCP
+    CHAR_END     = 0300 # indicates end of packet
+    CHAR_ESC     = 0333 # indicates byte stuffing
+    CHAR_ESC_END = 0334 # ESC ESC_END means END data byte
+    CHAR_ESC_ESC = 0335 # ESC ESC_ESC means ESC data byte
+
+    CHAR_END_ENC     = [0300].pack('C') # indicates end of packet
+    CHAR_ESC_ENC     = [0333].pack('C') # indicates byte stuffing
+    CHAR_ESC_END_ENC = [0334].pack('C') # ESC ESC_END means END data byte
+    CHAR_ESC_ESC_ENC = [0335].pack('C') # ESC ESC_ESC means ESC data byte
+  end
+end
+

data/lib/qlab-ruby/core-ext/osc-ruby/tcp_client.rb

@@ -0,0 +1,125 @@
+# A responsive OSC TCP client that sends and receives OSC messages on a single socket using the SLIP protocol.
+#
+# http://www.ietf.org/rfc/rfc1055.txt
+require 'socket'
+
+module OSC
+  module TCP
+    class Client
+      def initialize host, port, handler=nil
+        @host = host
+        @port = port
+        @handler = handler
+        @socket = TCPSocket.new host, port
+        @sending_socket = OSC::TCP::SendingSocket.new @socket
+      end
+
+      def close
+        @socket.close unless closed?
+      end
+
+      def closed?
+        @socket.closed?
+      end
+
+      # Send an OSC::Message and handle the response if one is given.
+      def send msg
+        @sending_socket.send(msg)
+
+        if block_given? || @handler
+          messages = response
+          if !messages.nil?
+            messages.each do |message|
+              if block_given?
+                yield message
+              else
+                @handler.handle message
+              end
+            end
+          end
+        end
+      end
+
+      def response
+        if received_messages = receive_raw
+          received_messages.map do |message|
+            OSCPacket.messages_from_network(message)
+          end.flatten
+        else
+          nil
+        end
+      end
+
+      def to_s
+        "#<OSC::TCP::Client:#{ object_id } @host:#{ @host.inspect }, @port:#{ @port.inspect }, @handler:#{ @handler.to_s }>"
+      end
+
+      private
+
+      def receive_raw
+        received = 0
+        messages = []
+        buffer   = []
+        failed   = false
+        received_any = false
+
+        loop do
+          begin
+            # get a character from the socket, fail if nothing is available
+            c = @socket.recv_nonblock(1)
+
+            received_any = true
+
+            case c
+            when CHAR_END_ENC
+              if received > 0
+                # add SLIP encoded message to list
+                messages << buffer.join
+
+                # reset state and keep reading from the port until there's nothing left
+                buffer.clear
+                received = 0
+                failed = false
+              end
+            when CHAR_ESC_ENC
+              # get next character, blocking is okay
+              c = @socket.recv(1)
+              case c
+              when CHAR_ESC_END_ENC
+                c = CHAR_END_ENC
+              when CHAR_ESC_ESC_ENC
+                c = CHAR_ESC_ENC
+              else
+                received += 1
+                buffer << c
+              end
+            else
+              received += 1
+              buffer << c
+            end
+          rescue Errno::EAGAIN, Errno::EWOULDBLOCK
+            # If any messages have been received, assume sender is done sending.
+            if failed || received_any
+              break
+            end
+
+            # wait one second to see if the socket might become readable (and a
+            # response forthcoming). normal usage is send + receive response, but
+            # if app doesn't intend to respond we should eventually ignore it.
+
+            IO.select([@socket], [], [], 0.2)
+            failed = true
+            retry
+          end
+        end
+
+        if messages.size > 0
+          messages
+        else
+          nil
+        end
+      end
+    end
+  end
+end
+

data/lib/qlab-ruby/cue.rb

@@ -0,0 +1,87 @@
+module QLab
+  class Cue < Communicator
+    attr_accessor :data
+
+    # Load a cue with the attributes given in `data`
+    def initialize data, cue_list
+      self.data = data
+      @cue_list = cue_list
+    end
+
+    # All cue commands for all cue types as listed in Figure53 QLab OSC Reference
+    Commands::ALL_CUES.each do |command|
+      define_method(command.to_sym) do |*args|
+        if args.size > 0
+          send_message cue_command(command), *args
+        else
+          send_message cue_command(command)
+        end
+      end
+    end
+
+    # Define commands with single settable values as command= methods
+    # for convenience. All command-as-method commands will act as setters
+    # if given an argument.
+    #
+    # For exmaple:
+    #
+    #   cue.name = "A Name"
+    #
+    # is functionally equivalent to
+    #
+    #   cue.name("A Name")
+    #
+    # as far as QLab is concerned
+    #
+    Commands::SET_CUES.each do |command|
+      define_method("#{ command }=".to_sym) do |value|
+        send_message cue_command(command), value
+      end
+    end
+
+    # The cue's `uniqueID`.
+    def id
+      data['uniqueID']
+    end
+
+    # Check whether this cue has nested cues.
+    def has_cues?
+      cues.size > 0
+    end
+
+    # Get the list of nested cues.
+    def cues
+      if data['cues'].nil?
+        []
+      else
+        data['cues'].map {|c| Cue.new(c, @cue_list)}
+      end
+    end
+
+    # Compare with another Cue.
+    def ==(other)
+      if other.is_a?(Cue)
+        self.data = other.data
+      else
+        false
+      end
+    end
+
+    # A reference to the cue's workspace.
+    def workspace
+      @cue_list.workspace
+    end
+
+    protected
+
+    def connection
+      workspace.connection
+    end
+
+    private
+
+    def cue_command command
+      "/workspace/#{ workspace.id }/cue_id/#{ id }/#{ command }"
+    end
+  end
+end

data/lib/qlab-ruby/cue_list.rb

@@ -0,0 +1,72 @@
+module QLab
+  #  An array of cue objects:
+  #
+  #  [
+  #      {
+  #          "uniqueID": string,
+  #          "number": string
+  #          "name": string
+  #          "type": string
+  #          "colorName": string
+  #          "flagged": number
+  #          "armed": number
+  #      }
+  #  ]
+  #
+  #  If a given cue is a group, it will include the nested cues:
+  #
+  #  [
+  #      {
+  #          "uniqueID": string,
+  #          "number": string
+  #          "name": string
+  #          "type": string
+  #          "colorName": string
+  #          "flagged": number
+  #          "armed": number
+  #          "cues": [ { }, { }, { } ]
+  #      }
+  #  ]
+
+  class CueList
+    attr_accessor :data
+
+    # Load a cue list with the attributes given in `data`
+    def initialize data, workspace
+      self.data = data
+      @workspace = workspace
+    end
+
+    def workspace
+      @workspace
+    end
+
+    def id
+      data['uniqueID']
+    end
+
+    def name
+      data['listName']
+    end
+
+    def number
+      data['number']
+    end
+
+    def type
+      data['type']
+    end
+
+    def cues
+      if data['cues'].nil?
+        []
+      else
+        data['cues'].map {|c| QLab::Cue.new(c, self)}
+      end
+    end
+
+    def has_cues?
+      cues.size > 0
+    end
+  end
+end

data/lib/qlab-ruby/machine.rb

@@ -0,0 +1,94 @@
+module QLab
+  class Machine < Communicator
+    attr_accessor :name, :address, :port
+
+    # Connect to a running QLab instance. `address` can be a domain name or an
+    # IP Address.
+    def initialize(_address, _port)
+      self.name = _address
+      self.address = _address
+      self.port = _port
+      connect
+    end
+
+    # auto-generate methods first so that manually defined methods will
+    # override
+    Commands::MACHINE.each do |command|
+      define_method(command.to_sym) do |*args|
+        if args.size > 0
+          send_message command, *args
+        else
+          send_message command
+        end
+      end
+    end
+
+    # Open and return a connection to the running QLab instance
+    def connect
+      if !connected?
+        @connection = OSC::TCP::Client.new(@address, @port)
+      else
+        connection
+      end
+    end
+
+    # Reference to the running QLab instance
+    def connection
+      @connection || connect
+    end
+
+    # The workspaces provided by the connected QLab instance
+    def workspaces
+      @workspaces || load_workspaces
+    end
+
+
+    # Find a workspace according to the given params.
+    def find_workspace params={}
+      workspaces.find do |ws|
+        matches = true
+
+        # match each key to the given workspace
+        params.keys.each do |key|
+          matches = matches && (ws.send(key.to_sym) == params[key])
+        end
+
+        matches
+      end
+    end
+
+    def connected?
+      !(@connection.nil? || send_message('/version').nil?)
+    end
+
+    def close
+      @connection.close
+      @connection = nil
+    end
+
+    def refresh
+      close
+      connect
+      load_workspaces
+    end
+
+    def alwaysReply=(value)
+      # send set command
+      alwaysReply(value)
+    end
+
+    private
+
+    def load_workspaces
+      @workspaces = []
+
+      data = send_message('/workspaces')
+
+      data.map do |ws|
+        @workspaces << QLab::Workspace.new(ws, self)
+      end
+
+      @workspaces
+    end
+  end
+end

data/lib/qlab-ruby/reply.rb

@@ -0,0 +1,51 @@
+require 'json'
+
+module QLab
+  # QLab OSC reply unpacker.
+  class Reply < Struct.new(:osc_message)
+    def address
+      @address ||= json['address']
+    end
+
+    def data
+      @data ||= json['data']
+    end
+
+    def status
+      @status ||= json['status']
+    end
+
+    def has_data?
+      !data.nil?
+    end
+
+    def has_status?
+      !status.nil?
+    end
+
+    def ok?
+      status == 'ok'
+    end
+
+    def empty?
+      false
+    end
+
+    def to_s
+      "<QLab::Reply address:'#{address}' status:'#{status}' data:#{data.inspect}>"
+    end
+
+    protected
+
+    # Actually perform the message unpacking
+    def json
+      @json ||= begin
+                  JSON.parse(osc_message.to_a.first)
+                rescue => ex
+                  puts ex.message
+                  {}
+                end
+    end
+
+  end
+end

data/lib/qlab-ruby/version.rb

@@ -0,0 +1,3 @@
+module QLab
+  VERSION = "0.1.2"
+end

data/lib/qlab-ruby/workspace.rb

@@ -0,0 +1,110 @@
+module QLab
+  #
+  #   "uniqueID": string,
+  #   "displayName": string
+  #   "hasPasscode": number
+  #
+  class Workspace < Communicator
+    attr_accessor :data, :passcode
+
+    # Load a workspace with the attributes given in `data`
+    def initialize data, machine
+      @machine = machine
+      self.data = data
+    end
+
+    Commands::WORKSPACE.each do |command|
+      define_method(command.to_sym) do |*args|
+        if args.size > 0
+          send_message workspace_command(command), *args
+        else
+          send_message workspace_command(command)
+        end
+      end
+    end
+
+    def connection
+      @machine.connection
+    end
+
+    def name
+      data['displayName']
+    end
+
+    def passcode?
+      !!data['hasPasscode']
+    end
+
+    def id
+      data['uniqueID']
+    end
+
+    # all cues in this workspace in a flat list
+    def cues
+      cue_lists.map do |cl|
+        load_cues(cl, [])
+      end.flatten.compact
+    end
+
+    def has_cues?
+      cues.size > 0
+    end
+
+    def cue_lists
+      refresh
+      @cue_lists
+    end
+
+    def refresh
+      if passcode?
+        if passcode.nil?
+          raise WorkspaceConnectionError.new("Workspace '#{ name }' requires a passcode.")
+        end
+
+        args = [workspace_command('connect'), ('%04i' % passcode)]
+      else
+        args = [workspace_command('connect')]
+      end
+      connect_response = send_message(*args)
+
+      if connect_response == 'ok'
+        @cue_lists = []
+
+        cues_response = send_message workspace_command('cueLists')
+        cues_response.each do |cuelist|
+          @cue_lists << QLab::CueList.new(cuelist, self)
+        end
+      end
+    end
+
+    def find_cue params={}
+      cues.find do |cue|
+        matches = true
+
+        # match each key to the given cue
+        params.keys.each do |key|
+          matches = matches && (cue.send(key.to_sym) == params[key])
+        end
+
+        matches
+      end
+    end
+
+    private
+
+    def workspace_command command
+      "/workspace/#{id}/#{ command }"
+    end
+
+    def load_cues parent_cue, cues
+      parent_cue.cues.each {|child_cue|
+        cues << child_cue
+        load_cues child_cue, cues
+      }
+
+      cues
+    end
+  end
+
+  class WorkspaceConnectionError < Exception; end
+end

data/qlab-ruby.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'qlab-ruby/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "qlab-ruby"
+  gem.version       = QLab::VERSION
+  gem.authors       = ["Adam Bachman"]
+  gem.email         = ["adam@figure53.com"]
+  gem.description   = %q{Interact with QLab in Ruby.}
+  gem.summary       = %q{Interact with QLab in Ruby.}
+  gem.homepage      = "https://github.com/Figure53/qlab-ruby"
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'osc-ruby'
+
+  gem.add_development_dependency 'rdoc'
+end

data/test/cue_test.rb

@@ -0,0 +1,41 @@
+require 'test_helper'
+
+class CueTest < Minitest::Test
+  def setup
+    @machine = QLab.connect 'localhost', 53000
+  end
+
+  def teardown
+    @machine.close
+  end
+
+  def test_a_cue_is_reachable
+    workspace = @machine.workspaces.first
+
+    refute_nil workspace.cue_lists
+    refute_nil workspace.cue_lists.first
+    refute_nil workspace.cue_lists.first.cues
+    refute_nil workspace.cue_lists.first.cues.first
+  end
+
+  def test_a_cue_has_a_name
+    workspace = @machine.workspaces.first
+    cue = workspace.cue_lists.first.cues.first
+    assert cue.name
+  end
+
+  def test_changes_are_picked_up_immediately
+    original_name = "Name 1"
+    new_name = "Name 2"
+
+    workspace = @machine.workspaces.first
+    cue = workspace.cue_lists.first.cues.first
+
+    cue.name = original_name
+    assert_equal original_name, cue.name
+
+    cue.name = new_name
+    assert_equal new_name, cue.name
+  end
+end
+

data/test/machine_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class MachineTest < Minitest::Test
+  def test_can_connect
+    machine = QLab.connect 'localhost', 53000
+    assert machine.connected?
+  end
+
+  def test_can_load_workspaces
+    machine = QLab.connect 'localhost', 53000
+    assert machine.workspaces.size > 0
+  end
+
+  def test_can_find_workspaces
+    machine = QLab.connect 'localhost', 53000
+    assert machine.workspaces.size > 0
+
+    ws = machine.workspaces.first
+
+    assert_equal ws, machine.find_workspace(id: ws.id)
+    assert_equal ws, machine.find_workspace(name: ws.name)
+
+    refute machine.find_workspace(id: 'nonsense')
+    refute machine.find_workspace(name: 'nonsense')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'qlab-ruby'
+
+gem 'minitest'
+require 'minitest/autorun'

data/test/workspace_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+class WorkspaceTest < Minitest::Test
+  def setup
+    @machine = QLab.connect 'localhost', 53000
+  end
+
+  def teardown
+    @machine.close
+  end
+
+  def test_refresh_loads_cues
+    workspace = @machine.workspaces.first
+
+    refute_nil workspace.connection
+    refute_nil workspace.name
+    refute_nil workspace.id
+
+    refute_nil workspace.cues
+    assert workspace.cues.size > 0
+  end
+
+  def test_finds_cues
+    workspace = @machine.workspaces.first
+    cue = workspace.cues.first
+
+    assert_equal cue, workspace.find_cue(id: cue.id)
+    assert_equal cue, workspace.find_cue(number: cue.number)
+    assert_equal cue, workspace.find_cue(name: cue.name)
+
+    refute workspace.find_cue(id: 'asdf asdf asdf asdf asdf')
+    refute workspace.find_cue(number: 'asdf asdf asdf asdf asdf')
+    refute workspace.find_cue(name: 'asdf asdf asdf asdf asdf')
+  end
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: qlab-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+  prerelease: 
+platform: ruby
+authors:
+- Adam Bachman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: osc-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Interact with QLab in Ruby.
+email:
+- adam@figure53.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/qlab-ruby.rb
+- lib/qlab-ruby/commands.rb
+- lib/qlab-ruby/communicator.rb
+- lib/qlab-ruby/core-ext/osc-ruby.rb
+- lib/qlab-ruby/core-ext/osc-ruby/message.rb
+- lib/qlab-ruby/core-ext/osc-ruby/sending_socket.rb
+- lib/qlab-ruby/core-ext/osc-ruby/tcp.rb
+- lib/qlab-ruby/core-ext/osc-ruby/tcp_client.rb
+- lib/qlab-ruby/cue.rb
+- lib/qlab-ruby/cue_list.rb
+- lib/qlab-ruby/machine.rb
+- lib/qlab-ruby/reply.rb
+- lib/qlab-ruby/version.rb
+- lib/qlab-ruby/workspace.rb
+- qlab-ruby.gemspec
+- test/cue_test.rb
+- test/machine_test.rb
+- test/test_helper.rb
+- test/workspace_test.rb
+homepage: https://github.com/Figure53/qlab-ruby
+licenses:
+- MIT
+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.25
+signing_key: 
+specification_version: 3
+summary: Interact with QLab in Ruby.
+test_files:
+- test/cue_test.rb
+- test/machine_test.rb
+- test/test_helper.rb
+- test/workspace_test.rb