telos_lwcp 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a4509b29db056c922920b686dafdd6aeb89162b
+  data.tar.gz: 776463f2ef27b16ff8a1020fb40044abf7ca6f54
+SHA512:
+  metadata.gz: eb305f4fbad7fa6adcc364dc965a990664e36772ac5124284222ccea039892d1309780a6dd4dfd3e0f3e4e57b764d80679ef2cff70b7809905e96e55a0e45dc1
+  data.tar.gz: 3d16436e23cec85f25b368b3c81031944ddec5124c0be3891e9bd767e6f7190ab4e782aa2747de34e6878e221cee3baeaeef8a2b588fdc504a9674b12838710e

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem 'autotest'
+  gem 'rspec'
+  gem 'rspec-autotest'
+end
+
+group :development do
+  gem 'pry'
+end

data/Gemfile.lock

@@ -0,0 +1,50 @@
+PATH
+  remote: .
+  specs:
+    telos_lwcp (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.1)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    coderay (1.1.1)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rake (10.5.0)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-autotest (1.0.0)
+      rspec-core (>= 2.99.0.beta1, < 4.0.0)
+    rspec-core (3.5.4)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest
+  bundler (~> 1.7)
+  pry
+  rake (~> 10.0)
+  rspec
+  rspec-autotest
+  telos_lwcp!
+
+BUNDLED WITH
+   1.10.2

data/README.rdoc

@@ -0,0 +1,51 @@
+= Telos LWCP gem
+
+== Description
+
+The telos_lwcp gem was written to communicate with Telos VX systems. Basic commands for control are implemented, and some low-level functions to implement the ones missing. Full documentation of the VX lwcp protocol extensions can be found here: http://magnetic.beep.pl/VX/vx_lwcp_reference.pdf
+
+== Example
+
+  engine = TelosLWCP::Engine.new(host: '192.168.0.5')
+  engine.connect do |conn|
+    conn.login("user", "")
+    conn.select_studio(2)
+    conn.call(3, "09123456789")
+  end
+
+== Implemented basic commands
+=== connect
+=== login(user, password)
+=== select_studio(studio_nr)
+=== seize(line_nr)
+=== call(line_nr, number)
+
+== Low-level functions
+=== write(command, object, arguments={})
+
+Sends a command to the server. This is always in the format of command, object & arguments. For example the call command is implemented as:
+
+  conn.write(:call, "studio.line#1", number: "09123456")
+
+=== wait(callbacks, &block)
+
+Pauses the main thread to wait for specific callbacks from the reading thread. This is mostly used in collaboration with the write command. Full example of how the seize command is implemented:
+
+  conn.wait(
+    [:event, "studio.line#1"] => proc { true }, # Line is seized
+    [:ack, "studio.line#1"] => proc {|obj| TelosLWCP::Error.new(obj.system_items[:msg]) } # Line isn't seized, throw error
+  ) do
+    conn.write(:seize, "studio.line#1")
+  end
+
+=== subscribe(command:"", object:"", matcher:"", &block)
+
+Subscribe to specific or general messages sent from the system. When passed with no parameters, every message is yielded to the block. command & object can both be strings or regexp's. matcher is a block that gets yielded the received message.
+
+  conn.subscribe(command: "event", object: /studio.line#\d+/) do |mess|
+    puts "Someone did smth: #{mess.arguments[:state]}"
+  end
+
+== Contributing
+
+Contributions are welcomed. Feel free to submit a pull request to fix bugs or add additional functionality to this script.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+RSpec::Core::RakeTask.new('spec')
+
+task default: :spec

data/lib/telos_lwcp/command.rb

@@ -0,0 +1,122 @@
+module TelosLWCP
+  class Command
+    class Outgoing
+      def initialize(command, object, arguments)
+        @command = command
+        @object = object
+        @arguments = arguments
+      end
+
+      def to_s
+        "#{@command} #{@object} #{arguments_str}\n"
+      end
+
+      def arguments_str
+        @arguments.map do |argument, value|
+          rv = case value
+               when TrueClass
+                 'TRUE'
+               when FalseClass
+                 'FALSE'
+               when Integer
+                 value
+               when String
+                 "\"#{value}\""
+               end
+          "#{argument}=#{rv}"
+        end.join(', ')
+      end
+    end
+    
+    class Incoming
+      attr_accessor :command, :object, :arguments, :system_items
+
+      def initialize(string)
+        parts = string.match(/\A(?<command>\S+) (?<object>\S+) (?<arguments>.*)\Z/)
+        self.command = parts[:command]
+        self.object = parts[:object]
+        self.arguments = {}
+        self.system_items = {}
+
+        parse_extra_arguments parts[:arguments]
+      end
+
+      private
+      def parse_extra_arguments(raw_string)
+        buffer = ""
+        in_string = false
+        key = nil
+        array = nil
+        array_stack = []
+
+        # Translate stuff like
+        (raw_string + ' ').each_char do |char|
+          case char
+          when '='              # Assigning something, so everything before this is the key
+            key = buffer
+            buffer = ""
+          when '"'              # Toggle in-string status
+            in_string = !in_string
+            buffer << char
+          when /\[/
+            arr = []
+            array_stack.any? ? array_stack.last << arr : array = arr
+            array_stack << arr
+          when /\]/
+            if !buffer.empty?
+              array_stack.last << raw_string_to_type(buffer)
+              buffer = ""
+            end
+            array_stack.pop
+            arguments[key.intern] = array if array_stack.empty?
+          when /[, ]/
+            if in_string
+              buffer << char
+            else
+              if key.nil? || buffer == ""
+                next
+              elsif array_stack.any?
+                array_stack.last << raw_string_to_type(buffer)
+                buffer = ""
+                next
+              elsif key =~ /^\$/
+                system_items[key.tr('$', '').intern] = raw_string_to_type(buffer)
+              else
+                arguments[key.intern] = raw_string_to_type(buffer)
+              end
+              buffer = ""
+              key = nil
+            end
+          else
+            buffer << char
+          end
+        end
+      end
+
+      def raw_string_to_type(raw)
+        case raw
+        when /^"(.*)"$/
+          $1
+        when /^\d+$/
+          raw.to_i
+        when /^TRUE$/
+          true
+        when /^FALSE$/
+          false
+        else
+          raw.intern
+        end
+      end
+    end
+
+    class << self
+      def outgoing(command, object, arguments)
+        Outgoing.new(command, object, arguments)
+      end
+
+      def incoming(string)
+        Incoming.new(string)
+      end
+    end
+  end
+end

data/lib/telos_lwcp/engine.rb

@@ -0,0 +1,108 @@
+require 'socket'
+
+module TelosLWCP
+  class Error < StandardError; end
+
+  class Engine
+    attr_accessor :host, :port
+
+    def initialize host:, port: 20518
+      self.host = host
+      self.port = port
+
+      @listeners = Hash.new {|h, k| h[k] = {}}
+      @subscriptions = []
+    end
+
+    def connect
+      @server = TCPSocket.new host, port
+      start_reader_thread
+      if block_given?
+        yield self
+        disconnect
+      end
+    end
+
+    def disconnect
+      @reader_thread.terminate if @reader_thread
+      @server.close
+    end
+
+    def login(user, password)
+      wait(
+        [:ack, :cc] => proc {|r| r.arguments[:logged] }
+      ) do
+        write :login, :cc, user: user, password: password
+      end
+    end
+
+    def select_studio(id)
+      wait(
+          [:event, :studio] => proc {|r| r },
+          [:ack, :studio] => proc {|r| Error.new(r.system_items[:msg]) }
+      ) do
+        write :select, :studio, id: id
+      end
+    end
+
+    def seize(line_nr)
+      wait(
+          [:event, "studio.line##{line_nr}"] => proc { true },
+          [:ack, "studio.line##{line_nr}"] => proc {|r| Error.new(r.system_items[:msg]) }
+      ) do
+        write :seize, "studio.line##{line_nr}"
+      end
+    end
+
+    def call_number(line_nr, number)
+      wait(
+          [:event, "studio.line##{line_nr}"] => proc { true }
+      ) do
+        write :call, "studio.line##{line_nr}", number: number
+      end
+    end
+
+    def subscribe(command: nil, object: nil, matcher: nil, &block)
+      @subscriptions << Subscription.new(command: command, object: object, matcher: matcher, block: block)
+    end
+    
+    # Low level
+    def write(command, object, arguments = {})
+      cmd = Command.outgoing(command, object, arguments)
+      @server.write(cmd.to_s)
+    end
+
+    def wait(expectations, read_timeout: 5, &block)
+      data = nil
+      thread = Thread.current
+      expectations.each do |(cmd, object), proc|
+        @listeners[cmd.to_s][object.to_s] = proc {|d|
+          data = proc.call(d);
+          expectations.each {|(cmd, object), _| @listeners[cmd.to_s][object.to_s] = nil }
+          thread.run
+        }
+      end
+      block.call
+      Timeout.timeout(read_timeout) do
+        Thread.stop
+      end
+      Error === data ? raise(data) : data
+    end
+
+    private
+    def start_reader_thread
+      Thread.abort_on_exception = true
+      @reader_thread = Thread.start do
+        loop do
+          raw = @server.gets.chomp
+          value = Command.incoming(raw)
+          if listener = @listeners[value.command][value.object]
+            listener.call(value)
+          end
+
+          @subscriptions.select {|sub| sub.match?(value) }.each {|sub| sub.call(value) }
+        end
+      end
+    end
+  end
+end

data/lib/telos_lwcp/subscription.rb

@@ -0,0 +1,22 @@
+module TelosLWCP
+  class Subscription
+    attr_accessor :command, :object, :matcher, :block
+
+    def initialize(command:, object:, matcher:, block:)
+      self.command = Regexp === command ? command : /\A#{command}\Z/ if command
+      self.object = Regexp === object ? object : /\A#{object}\Z/ if object
+      self.matcher = matcher
+      self.block = block
+    end
+    
+    def match?(cmd)
+      (command.nil? || command =~ cmd.command) &&
+          (object.nil? || object =~ cmd.object) &&
+          (matcher.nil? || matcher.call(cmd))
+    end
+
+    def call(cmd)
+      block.call(cmd)
+    end
+  end
+end

data/lib/telos_lwcp/version.rb

@@ -0,0 +1,3 @@
+module TelosLWCP
+  VERSION = "0.1.0"
+end

data/lib/telos_lwcp.rb

@@ -0,0 +1,5 @@
+module TelosLWCP
+  autoload :Engine, "telos_lwcp/engine"
+  autoload :Command, "telos_lwcp/command"
+  autoload :Subscription, "telos_lwcp/subscription"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'telos_lwcp'

data/spec/telos_lwcp/command_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe TelosLWCP::Command do
+  describe "#new" do
+    context "simple initial server response" do
+      subject { TelosLWCP::Command.incoming('indi cc server_id="VX Engine", server_version="1.1.4", server_caps="brhi", lwcp_version=1, zone=EU, uid="5850AB402297", online=TRUE')}
+      it("parses the command") { expect(subject.command).to eq 'indi' }
+      it("parses the object" ) { expect(subject.object).to eq 'cc' }
+      it("handles strings in arguments") { expect(subject.arguments[:server_id]).to eq 'VX Engine'}
+      it("handles integers in arguments") { expect(subject.arguments[:lwcp_version]).to eq 1}
+      it("handles booleans in arguments") { expect(subject.arguments[:online]).to eq true }
+      it("handles constants in arguments") { expect(subject.arguments[:zone]).to eq :EU}
+    end
+
+    context "server response with extra data" do
+      subject { TelosLWCP::Command.incoming('ack studio $status=ERR $msg="User is not logged in."') }
+
+      it("parses constants in system items") { expect(subject.system_items[:status]).to eq :ERR }
+      it("parses strings in system items") { expect(subject.system_items[:msg]).to eq "User is not logged in." }
+    end
+
+    context "server response with arrays" do
+      subject { TelosLWCP::Command.incoming('event studio id=1, name="Studio 1", show_id=1, show_name="Show 1", next=0, pnext=0, busy_all=FALSE, num_lines=12, num_hybrids=8, num_hyb_fixed=4, mute=FALSE, show_locked=FALSE, auto_answer=FALSE, line_list=[[IDLE, IDLE, "Main-Studio", "10", NULL, 0, NULL, "", NONE], [IDLE, IDLE, "Main-Studio", "10", NULL, 0, NULL, "", NONE], [IDLE, IDLE, "Main-Studio", "10", NULL, 0, NULL, "", NONE], [IDLE, IDLE, "Line 20", "20", NULL, 0, NULL, "", NONE], [IDLE, IDLE, "67-614-448", "67614448", NULL, 0, NULL, "", NONE], [IDLE, IDLE, "67-614-449", "67614449", NULL, 0, NULL, "", NONE], [IDLE, IDLE, "Cisco 40", "40", NULL, 0, NULL, "", NONE], [IDLE, IDLE, "Cisco 80", "80", NULL, 0, NULL, "", NONE], NULL, [IDLE, IDLE, "VIP", "88", NULL, 1, NULL, "", NONE], [IDLE, IDLE, "NEWS", "89", NULL, 2, NULL, "", NONE], [IDLE, IDLE, "HOT-LINE", "90", NULL, 3, NULL, "", NONE]]') }
+
+      it { expect(subject.arguments[:line_list]).to be_an_instance_of Array }
+      it { expect(subject.arguments[:line_list].size).to eq 12 }
+    end
+  end
+end

data/telos_lwcp.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'telos_lwcp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "telos_lwcp"
+  spec.version       = TelosLWCP::VERSION
+  spec.authors       = ["Jan De Poorter"]
+  spec.email         = ["jan.depoorter@medialaan.be"]
+  spec.summary       = %q{Library to communicate with Telos VC devices}
+  spec.description   = %q{A library to communicate with Telos VX devices that support the LWCP protocol}
+  spec.homepage      = "http://github.com/q-music/ruby-telos-lwcp"
+  spec.license       = "Apache-2.0"
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  # spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: telos_lwcp
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jan De Poorter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: A library to communicate with Telos VX devices that support the LWCP
+  protocol
+email:
+- jan.depoorter@medialaan.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- lib/telos_lwcp.rb
+- lib/telos_lwcp/command.rb
+- lib/telos_lwcp/engine.rb
+- lib/telos_lwcp/subscription.rb
+- lib/telos_lwcp/version.rb
+- spec/spec_helper.rb
+- spec/telos_lwcp/command_spec.rb
+- telos_lwcp.gemspec
+homepage: http://github.com/q-music/ruby-telos-lwcp
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Library to communicate with Telos VC devices
+test_files:
+- spec/spec_helper.rb
+- spec/telos_lwcp/command_spec.rb