qcmd 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 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,131 @@
+# Qcmd
+
+`qcmd` is intended to be a simple command line client for QLab utilizing
+QLab 3's new OSC interface. `qcmd` should be useable from any machine on
+the same local network as the QLab workspace you intend to work with.
+
+**This project should be considered experimental. DO NOT RUN SHOWS WITH
+IT.**
+
+
+## Installation
+
+Install this gem to your machine by running the following command:
+
+    $ gem install qcmd
+
+That should do ya.
+
+## Starting the `qcmd` console.
+
+Run the following command in a terminal window:
+
+    $ qcmd
+
+From there, you can connect to a machine, connect to a workspace, and then
+send commands to cues and the workspace.
+
+`qcmd` supports tab completion for commands in case you get stuck or are
+wondering what you can do from the console.
+
+Run `qcmd` with the -v option to get full debugging output. Use the main
+project repository (https://github.com/abachman/qcmd) to report any issues.
+
+An example session might look like this:
+
+    $ qcmd
+                         .::::    .::                .::
+                       .::    .:: .::                .::
+                     .::       .::.::         .::    .::
+                     .::       .::.::       .::  .:: .:: .::
+                     .::       .::.::      .::   .:: .::   .::
+                       .:: .: .:: .::      .::   .:: .::   .::
+                         .:: ::   .::::::::  .:: .:::.:: .::
+                              .:
+
+                   qcmd 0.1.0 (c) 2012 Figure 53, Baltimore, MD.
+
+    Found 2 QLab machines
+
+    1. adam-retina
+    2. f53zwimac
+
+    type `connect MACHINE` to connect to a machine
+
+    > connect adam-retina
+    connecting to machine: adam-retina
+    -------------------------------- Workspaces --------------------------------
+
+    1. Untitled Workspace
+
+    Type `use "WORKSPACE_NAME" PASSCODE` to load a workspace. Only enter a
+    passcode if your workspace uses one
+
+    adam-retina> use "Untitled Workspace"
+    connecting to workspace: Untitled Workspace
+    connected to workspace
+    loaded 2 cues
+    adam-retina:Untitled Workspace> cues
+
+    ----------------------------------- Cues -----------------------------------
+
+      Number          Id      Name    Type
+
+           1           2      Nope    Wait
+           2           3      Nipe   Audio
+
+
+    adam-retina:Untitled Workspace> cue 2 start
+    adam-retina:Untitled Workspace> cue 2 isRunning
+    true
+    adam-retina:Untitled Workspace> workspace runningCues
+
+    ------------------------------- Running Cues -------------------------------
+
+     Number  Id      Name     Type
+
+          2   3      Nipe    Audio
+
+
+    adam-retina:Untitled Workspace> cue 2
+    1                       2                       actionElapsed
+    allowsEditingDuration   armed                   basics
+    children                colorName               connect
+    continueMode            cue                     cueLists
+    cueTargetId             cueTargetNumber         disconnect
+    duration                exit                    flagged
+    hasCueTargets           hasFileTargets          isBroken
+    isLoaded                isPaused                isRunning
+    load                    loadAt                  name
+    notes                   number                  panic
+    pause                   percentActionElapsed    percentPostWaitElapsed
+    percentPreWaitElapsed   postWait                postWaitElapsed
+    preview                 preWait                 preWaitElapsed
+    reset                   resume                  runningCues
+    runningOrPausedCues     selectedCues            stop
+    thump                   type                    uniqueID
+    workspace               workspaces
+    adam-retina:Untitled Workspace> cue 2 pause
+    adam-retina:Untitled Workspace> cue 2 isRunning
+    false
+    adam-retina:Untitled Workspace> cue 2 percentActionElapsed
+    0.109189204871655
+    adam-retina:Untitled Workspace> disconnect
+
+    Found 2 QLab machines
+
+    1. adam-retina
+    2. f53zwimac
+
+    type `connect MACHINE` to connect to a machine
+
+    > exit
+    exiting...
+
+## 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,14 @@
+require "bundler/gem_tasks"
+
+require 'cucumber'
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => [:spec, :features]

data/TODO.md

@@ -0,0 +1,3 @@
+* make sure we can connect to workspaces
+* parse arguments with more finesse than String#split
+* make sure we can disconnect from workspaces / machines

data/bin/qcmd

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+
+require 'qcmd'
+require 'trollop'
+
+VERSION_STRING =  "qcmd #{ Qcmd::VERSION } (c) 2012 Figure 53, Baltimore, MD."
+
+opts = Trollop::options do
+  version VERSION_STRING
+  opt :verbose, 'Use verbose mode', :default => false
+  opt :debug, "Show full debug output, don't make changes to workspaces", :default => false
+end
+
+if opts[:verbose]
+  Qcmd.log_level = :debug
+end
+
+if opts[:debug]
+  Qcmd.log_level = :debug
+  Qcmd.debug_mode = true
+end
+
+# browse local network and check for qlab + qlab workspaces
+
+Qcmd.ascii_qlab
+Qcmd.print
+Qcmd.print Qcmd.centered_text(VERSION_STRING)
+
+Qcmd::Network.browse_and_display
+
+Qcmd::CLI.launch opts

data/features/hello.feature

@@ -0,0 +1,13 @@
+Feature: Hello
+  In order to render hello
+  As a CLI
+  I want to do the right thing
+
+  # Scenario: Phrase is default
+  #   When I run `qcmd`
+  #   Then the output should contain "hello world"
+
+  # Scenario: Phrase is given
+  #   When I run `qcmd Tomato`
+  #   Then the output should contain "Tomato"
+

data/features/support/setup.rb

@@ -0,0 +1,2 @@
+require 'aruba/cucumber'
+

data/lib/qcmd.rb

@@ -0,0 +1,48 @@
+require 'qcmd/version'
+require 'qcmd/input_completer'
+
+require 'qcmd/core_ext/array'
+require 'qcmd/core_ext/osc/message'
+
+module Qcmd
+  # Your code goes here...
+  autoload :Handler, 'qcmd/handler'
+  autoload :Server, 'qcmd/server'
+  autoload :Context, 'qcmd/context'
+  autoload :Parser, 'qcmd/parser'
+  autoload :CLI, 'qcmd/cli'
+  autoload :Machine, 'qcmd/machine'
+  autoload :Network, 'qcmd/network'
+  autoload :QLab, 'qcmd/qlab'
+  autoload :Plaintext, 'qcmd/plaintext'
+  autoload :Commands, 'qcmd/commands'
+  autoload :VERSION, 'qcmd/version'
+
+  class << self
+    include Qcmd::Plaintext
+
+    attr_accessor :log_level
+    attr_accessor :debug_mode
+    attr_accessor :context
+
+    def verbose!
+      self.log_level = :debug
+    end
+
+    def quiet!
+      self.log_level = :warning
+    end
+
+    def debug?
+      !!debug_mode
+    end
+
+    def debug message
+      log(message) if log_level == :debug
+    end
+
+    def connected?
+      !!context && !!context.machine && !context.machine.nil?
+    end
+  end
+end

data/lib/qcmd/cli.rb

@@ -0,0 +1,167 @@
+require 'qcmd/server'
+
+require 'readline'
+
+require 'osc-ruby'
+require 'osc-ruby/em_server'
+
+module Qcmd
+  class CLI
+    include Qcmd::Plaintext
+
+    attr_accessor :server, :prompt
+
+    def self.launch options={}
+      new options
+    end
+
+    def initialize options={}
+      # start local listening port
+      Qcmd.context = Qcmd::Context.new
+
+      self.prompt = '> '
+
+      start
+
+      # if local machines have already been detected and only one is available,
+      # use it.
+      if Qcmd::Network.machines
+        if Qcmd::Network.machines.size == 1 && !Qcmd::Network.machines.first.passcode?
+          puts "AUTOCONNECT"
+          connect Qcmd::Network.machines.first, nil
+        end
+      end
+    end
+
+    def connect machine, passcode
+      if machine.nil?
+        print "A valid machine is needed to connect!"
+        return
+      end
+
+      Qcmd.context.machine = machine
+      Qcmd.context.workspace = nil
+
+      if server.nil?
+        # set client connection and start listening port
+        self.server = Qcmd::Server.new :receive => 53001
+      else
+        # change client connection
+        server.connect_to_client
+      end
+      server.run
+
+      server.load_workspaces
+
+      self.prompt = "#{ machine.name }> "
+    end
+
+    def use_workspace workspace
+      Qcmd.debug %[(connecting to workspace: "#{workspace.name}")]
+      # set workspace in context. Will unset later if there's a problem.
+      Qcmd.context.workspace = workspace
+      self.prompt = "#{ Qcmd.context.machine.name }:#{ workspace.name }> "
+
+      server.connect_to_workspace workspace
+    end
+
+    def reset
+      Qcmd.context.reset
+      server.stop
+      self.prompt = "> "
+    end
+
+    def start
+      loop do
+        # blocks the whole Ruby VM
+        message = Readline.readline(prompt, true)
+
+        if message.nil? || message.size == 0
+          Qcmd.debug "(got: #{ message.inspect })"
+          next
+        end
+
+        handle_message(message)
+      end
+    end
+
+    def handle_message message
+      args    = Qcmd::Parser.parse(message)
+      command = args.shift
+
+      case command
+      when 'exit'
+        print 'exiting...'
+        exit 0
+      when 'connect'
+        Qcmd.debug "(connect command received args: #{ args.inspect })"
+
+        machine_name = args.shift
+        passcode     = args.shift
+
+        if machine = Qcmd::Network.find(machine_name)
+          print "connecting to machine: #{machine_name}"
+          connect machine, passcode
+        else
+          print 'sorry, that machine could not be found'
+        end
+      when 'disconnect'
+        reset
+        Qcmd::Network.browse_and_display
+      when 'use'
+        Qcmd.debug "(use command received args: #{ args.inspect })"
+
+        workspace_name = args.shift.gsub(/['"]/, '')
+        passcode       = args.shift
+
+        Qcmd.debug "(using workspace: #{ workspace_name.inspect })"
+
+        if workspace = Qcmd.context.machine.find_workspace(workspace_name)
+          workspace.passcode = passcode
+          print "connecting to workspace: #{workspace_name}"
+          use_workspace workspace
+        end
+      when 'cues'
+        if !Qcmd.context.workspace_connected?
+          print "You must be connected to a workspace before you can view a cue list."
+        elsif Qcmd.context.workspace.cues
+          print
+          print centered_text(" Cues ", '-')
+          table ['Number', 'Id', 'Name', 'Type'], Qcmd.context.workspace.cues.map {|cue|
+            [cue.number, cue.id, cue.name, cue.type]
+          }
+          print
+        end
+      when 'cue'
+        # pull off cue number
+        cue_number = args.shift
+        cue_action = args.shift
+        args = args.map {|a| a.gsub(/^"/, '').gsub(/"$/, '')}
+
+        if cue_number.nil?
+          print "no cue command given. cue commands should be in the form:"
+          print
+          print "  > cue NUMBER COMMAND ARGUMENTS"
+          print
+          print wrapped_text("available cue commands are: #{Qcmd::InputCompleter::ReservedCueWords.inspect}")
+        elsif cue_action.nil?
+          server.send_workspace_command(cue_number)
+        else
+          server.send_cue_command(cue_number, cue_action, *args)
+        end
+      when 'workspace'
+        workspace_command = args.shift
+
+        if workspace_command.nil?
+          print wrapped_text("no workspace command given. available workspace commands are: #{Qcmd::InputCompleter::ReservedWorkspaceWords.inspect}")
+        else
+          server.send_workspace_command(workspace_command, *args)
+        end
+
+      else
+        server.send_command(command, *args)
+      end
+    end
+
+  end
+end