telos 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8819a9c4c3d7a349aaa2ea69216af74c3b193769
+  data.tar.gz: 866273a2c6d1b692d4486dec1675917d7c51c51e
+SHA512:
+  metadata.gz: cf8508ed5bd7776f0080f875bac28b9b717e4f897f12a109438dbadfd7cfac2f771197312eaf61610aa0c30a1ed00e286578a658badf7f891fb48862ccd9c58e
+  data.tar.gz: 456078edccd55f1ec92ffefde6013388e4b8a96ce0ee7088b289576b086d8f9e0bff59e82082b037b89f6847af54a0c88c4ea4589629b3edb9ad0bb4457d3467

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+gem 'pry'
+gem 'rspec'

data/Gemfile.lock

@@ -0,0 +1,30 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.0)
+    diff-lcs (1.2.5)
+    method_source (0.8.2)
+    pry (0.10.1)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.7)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.3)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.2)
+    slop (3.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  rspec

data/LICENSE

@@ -0,0 +1,201 @@
+                               Apache License
+                         Version 2.0, January 2004
+                      http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+    "License" shall mean the terms and conditions for use, reproduction,
+    and distribution as defined by Sections 1 through 9 of this document.
+
+    "Licensor" shall mean the copyright owner or entity authorized by
+    the copyright owner that is granting the License.
+
+    "Legal Entity" shall mean the union of the acting entity and all
+    other entities that control, are controlled by, or are under common
+    control with that entity. For the purposes of this definition,
+    "control" means (i) the power, direct or indirect, to cause the
+    direction or management of such entity, whether by contract or
+    otherwise, or (ii) ownership of fifty percent (50%) or more of the
+    outstanding shares, or (iii) beneficial ownership of such entity.
+
+    "You" (or "Your") shall mean an individual or Legal Entity
+    exercising permissions granted by this License.
+
+    "Source" form shall mean the preferred form for making modifications,
+    including but not limited to software source code, documentation
+    source, and configuration files.
+
+    "Object" form shall mean any form resulting from mechanical
+    transformation or translation of a Source form, including but
+    not limited to compiled object code, generated documentation,
+    and conversions to other media types.
+
+    "Work" shall mean the work of authorship, whether in Source or
+    Object form, made available under the License, as indicated by a
+    copyright notice that is included in or attached to the work
+    (an example is provided in the Appendix below).
+
+    "Derivative Works" shall mean any work, whether in Source or Object
+    form, that is based on (or derived from) the Work and for which the
+    editorial revisions, annotations, elaborations, or other modifications
+    represent, as a whole, an original work of authorship. For the purposes
+    of this License, Derivative Works shall not include works that remain
+    separable from, or merely link (or bind by name) to the interfaces of,
+    the Work and Derivative Works thereof.
+
+    "Contribution" shall mean any work of authorship, including
+    the original version of the Work and any modifications or additions
+    to that Work or Derivative Works thereof, that is intentionally
+    submitted to Licensor for inclusion in the Work by the copyright owner
+    or by an individual or Legal Entity authorized to submit on behalf of
+    the copyright owner. For the purposes of this definition, "submitted"
+    means any form of electronic, verbal, or written communication sent
+    to the Licensor or its representatives, including but not limited to
+    communication on electronic mailing lists, source code control systems,
+    and issue tracking systems that are managed by, or on behalf of, the
+    Licensor for the purpose of discussing and improving the Work, but
+    excluding communication that is conspicuously marked or otherwise
+    designated in writing by the copyright owner as "Not a Contribution."
+
+    "Contributor" shall mean Licensor and any individual or Legal Entity
+    on behalf of whom a Contribution has been received by Licensor and
+    subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    copyright license to reproduce, prepare Derivative Works of,
+    publicly display, publicly perform, sublicense, and distribute the
+    Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+    this License, each Contributor hereby grants to You a perpetual,
+    worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+    (except as stated in this section) patent license to make, have made,
+    use, offer to sell, sell, import, and otherwise transfer the Work,
+    where such license applies only to those patent claims licensable
+    by such Contributor that are necessarily infringed by their
+    Contribution(s) alone or by combination of their Contribution(s)
+    with the Work to which such Contribution(s) was submitted. If You
+    institute patent litigation against any entity (including a
+    cross-claim or counterclaim in a lawsuit) alleging that the Work
+    or a Contribution incorporated within the Work constitutes direct
+    or contributory patent infringement, then any patent licenses
+    granted to You under this License for that Work shall terminate
+    as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+    Work or Derivative Works thereof in any medium, with or without
+    modifications, and in Source or Object form, provided that You
+    meet the following conditions:
+
+    (a) You must give any other recipients of the Work or
+        Derivative Works a copy of this License; and
+
+    (b) You must cause any modified files to carry prominent notices
+        stating that You changed the files; and
+
+    (c) You must retain, in the Source form of any Derivative Works
+        that You distribute, all copyright, patent, trademark, and
+        attribution notices from the Source form of the Work,
+        excluding those notices that do not pertain to any part of
+        the Derivative Works; and
+
+    (d) If the Work includes a "NOTICE" text file as part of its
+        distribution, then any Derivative Works that You distribute must
+        include a readable copy of the attribution notices contained
+        within such NOTICE file, excluding those notices that do not
+        pertain to any part of the Derivative Works, in at least one
+        of the following places: within a NOTICE text file distributed
+        as part of the Derivative Works; within the Source form or
+        documentation, if provided along with the Derivative Works; or,
+        within a display generated by the Derivative Works, if and
+        wherever such third-party notices normally appear. The contents
+        of the NOTICE file are for informational purposes only and
+        do not modify the License. You may add Your own attribution
+        notices within Derivative Works that You distribute, alongside
+        or as an addendum to the NOTICE text from the Work, provided
+        that such additional attribution notices cannot be construed
+        as modifying the License.
+
+    You may add Your own copyright statement to Your modifications and
+    may provide additional or different license terms and conditions
+    for use, reproduction, or distribution of Your modifications, or
+    for any such Derivative Works as a whole, provided Your use,
+    reproduction, and distribution of the Work otherwise complies with
+    the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+    any Contribution intentionally submitted for inclusion in the Work
+    by You to the Licensor shall be under the terms and conditions of
+    this License, without any additional terms or conditions.
+    Notwithstanding the above, nothing herein shall supersede or modify
+    the terms of any separate license agreement you may have executed
+    with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+    names, trademarks, service marks, or product names of the Licensor,
+    except as required for reasonable and customary use in describing the
+    origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+    agreed to in writing, Licensor provides the Work (and each
+    Contributor provides its Contributions) on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+    implied, including, without limitation, any warranties or conditions
+    of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+    PARTICULAR PURPOSE. You are solely responsible for determining the
+    appropriateness of using or redistributing the Work and assume any
+    risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+    whether in tort (including negligence), contract, or otherwise,
+    unless required by applicable law (such as deliberate and grossly
+    negligent acts) or agreed to in writing, shall any Contributor be
+    liable to You for damages, including any direct, indirect, special,
+    incidental, or consequential damages of any character arising as a
+    result of this License or out of the use or inability to use the
+    Work (including but not limited to damages for loss of goodwill,
+    work stoppage, computer failure or malfunction, or any and all
+    other commercial damages or losses), even if such Contributor
+    has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+    the Work or Derivative Works thereof, You may choose to offer,
+    and charge a fee for, acceptance of support, warranty, indemnity,
+    or other liability obligations and/or rights consistent with this
+    License. However, in accepting such obligations, You may act only
+    on Your own behalf and on Your sole responsibility, not on behalf
+    of any other Contributor, and only if You agree to indemnify,
+    defend, and hold each Contributor harmless for any liability
+    incurred by, or claims asserted against, such Contributor by reason
+    of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+    To apply the Apache License to your work, attach the following
+    boilerplate notice, with the fields enclosed by brackets "{}"
+    replaced with your own identifying information. (Don't include
+    the brackets!)  The text should be enclosed in the appropriate
+    comment syntax for the file format. We also recommend that a
+    file or class name and description of purpose be included on the
+    same "printed page" as the copyright notice for easier
+    identification within third-party archives.
+
+ Copyright {yyyy} {name of copyright owner}
+
+ 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/Rakefile

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

data/lib/telos.rb

@@ -0,0 +1,30 @@
+module Telos
+  autoload :Message, "telos/message.rb"
+  autoload :Device, "telos/device.rb"
+
+  module Command
+    Login = 0
+    EnumerateShows = 1
+    EnumerateHostsForShow = 2
+    ConnectToShow = 4
+    ChangeShow = 3
+    EnumerateDirectors = 5
+    AttachToDirector = 6
+    AttachAsTalent = 7
+    PostBusyAllButton = 8
+    PostDelayDumpButton = 9
+    PostDialKey = 10
+    PostDropButton = 11
+    PostHoldButton = 12
+    PostLineButton = 13
+    PostMuteButton = 14
+    PostNextButton = 15
+    PostRecordButton = 16
+    PostSpeakerButton = 17
+    PostText = 18
+    PostTransferButton = 19
+    PostUpdateAll = 20
+    PostMuteRinger = 22
+    PostAcousticAddapt = 23
+  end
+end

data/lib/telos/device.rb

@@ -0,0 +1,65 @@
+require 'socket'
+
+module Telos
+  class Device
+    attr_accessor :host, :port
+
+    def initialize(host:, port: 9998)
+      self.host = host
+      self.port = port
+    end
+
+    def shows
+    end
+
+    def connect(reader_thread: false)
+      @server = TCPSocket.new host, port
+      start_reader_thread if reader_thread
+      if block_given?
+        yield
+        stop_reader_thread if reader_thread
+        @server.close
+      end
+    end
+
+    def disconnect
+      @server.close
+    end
+
+    def write(command, arguments = {})
+      message = Message.outgoing(command, arguments)
+
+      @server.write(message.to_bytes)
+    end
+
+    def read
+      if @mutex
+        @mutex.synchronize do
+          @messages.shift
+        end
+      else
+        _read
+      end
+    end
+
+    private
+    def _read
+      response_size = Message.response_size(@server.read(8))
+      Message.incoming(@server.read(response_size))
+    end
+
+    def start_reader_thread
+      @messages = []
+      @mutex = Mutex.new
+      @reader_thread ||= Thread.start(@messages) do |messages|
+        loop do
+          message = _read
+          @mutex.synchronize do
+            messages << message
+          end
+        end
+      end
+      Thread.pass # Make sure the reader thread starts
+    end
+  end
+end

data/lib/telos/message.rb

@@ -0,0 +1,28 @@
+module Telos
+  class Error < StandardError; end
+
+  class Message
+    class ChecksumMismatch < Telos::Error; end
+    autoload :Outgoing, "telos/message/outgoing"
+    autoload :Incoming, "telos/message/incoming"
+
+    class << self
+      def outgoing(command, arguments = {})
+        Outgoing.new(command, arguments)
+      end
+
+      def incoming(data)
+        Incoming.new(data)
+      end
+
+      def response_size(data)
+        size = data.slice(0,4).unpack('N')[0]
+        checksum = data.slice(4,4).unpack('N')[0]
+
+        raise(ChecksumMismatch) if size ^ 0xA5A55A5A != checksum
+
+        size
+      end
+    end
+  end
+end

data/lib/telos/message/incoming.rb

@@ -0,0 +1,56 @@
+module Telos
+  class Message
+    class Incoming
+      def initialize(data)
+        @data = data
+      end
+
+      def command
+        from_dword(@data.byteslice(0,4))
+      end
+
+      def argument_size
+        from_word(@data.byteslice(4,2))
+      end
+
+      def arguments
+        pos = 6
+        arguments = {}
+        argument_size.times do
+          key = @data.byteslice(pos, 4)
+          type = @data.byteslice(pos + 4, 1)
+          case type
+          when "\x02" # Array / String
+            size = from_word(@data.byteslice(pos + 5, 2))
+            value = @data.byteslice(pos + 7, size - 1)
+            pos += 7 + size
+          when "\x01" # DWord
+            value = from_dword(@data.byteslice(pos + 5, 4))
+            pos += 5 + 4
+          end
+
+          arguments[key] = value
+        end
+
+        arguments
+      end
+
+      def to_hash
+        arguments
+      end
+
+      def inspect
+        %{#<Telos::Message::Incoming command="#{command}" arguments=#{arguments.inspect}>}
+      end
+
+      private
+      def from_dword(string)
+        string.unpack('N')[0]
+      end
+
+      def from_word(string)
+        string.unpack('n')[0]
+      end
+    end
+  end
+end

data/lib/telos/message/outgoing.rb

@@ -0,0 +1,62 @@
+module Telos
+  class Message
+    class Outgoing
+      def initialize(command, arguments = {})
+        @command = command
+        @arguments = arguments
+      end
+
+      def to_bytes
+        [
+            dword(payload_size),
+            dword(payload_xor),
+            payload
+        ].join
+      end
+
+      def payload
+        [
+            dword(@command),
+            word(@arguments.size),
+            @arguments.map do |name, argument|
+              content = case argument
+                        when String
+                          [
+                              "\x02", # Array Type
+                              word(argument.length + 1), # Argument length + end
+                              argument + "\x00"
+                          ]
+                        when Integer
+                          [
+                              "\x01", # DWORD type
+                              dword(argument)
+                          ]
+                        end
+
+              [
+                  name.to_s.upcase,
+                  content
+              ]
+            end
+        ].flatten.join
+      end
+
+      def payload_size
+        payload.size
+      end
+
+      def payload_xor
+        0xA5A55A5A ^ payload_size
+      end
+
+      private
+      def dword(content)
+        [content].pack('N')
+      end
+
+      def word(content)
+        [content].pack('n')
+      end
+    end
+  end
+end

data/lib/telos/version.rb

@@ -0,0 +1,3 @@
+module Telos
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'telos'
+
+RSpec::Matchers.define :byte_eq do |expected|
+  match do |actual|
+    actual.bytes == expected.bytes
+  end
+end

data/spec/telos/message/incoming_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Telos::Message::Incoming do
+  describe "#to_hash" do
+    subject { Telos::Message::Incoming.new("\x00\x00\x00\x00\x00\x05SHOW\x02\x00\vHybrid 1&2\x00PASS\x01\x00\x00\x00\x00ACTV\x01\x00\x00\x00\x01HOST\x02\x00\x05Nx12\x00LAST\x01\x00\x00\x00\x00").to_hash }
+    it "should return a correct hash" do
+      is_expected.to eq({
+                          "SHOW" => "Hybrid 1&2",
+                          "PASS" => 0,
+                          "ACTV" => 1,
+                          "HOST" => "Nx12",
+                          "LAST" => 0
+                        })
+    end
+  end
+end
+

data/spec/telos/message/outgoing_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+
+describe Telos::Message::Outgoing do
+  describe "#to_bytes" do
+    context "for a command without arguments" do
+      subject { Telos::Message::Outgoing.new(1).to_bytes }
+      it { is_expected.to byte_eq "\x00\x00\x00\x06\xA5\xA5\x5A\x5C\x00\x00\x00\x01\x00\x00" }
+    end
+
+    context "for a command with string arguments" do
+      subject { Telos::Message::Outgoing.new(0, {'USER' => 'user', 'PASS' => 'pwd'}).to_bytes }
+      it { is_expected.to byte_eq "\x00\x00\x00\x1D\xA5\xA5\x5A\x47\x00\x00\x00\x00\x00\x02\x55\x53\x45\x52\x02\x00\x05\x75\x73\x65\x72\x00\x50\x41\x53\x53\x02\x00\x04\x70\x77\x64\x00" }
+    end
+
+    context "for a command with integer arguments" do
+      subject { Telos::Message::Outgoing.new(4, 'SSN_' => 1, 'SHOW' => 'show1', 'PASS' => 'pwd', 'HOST' => 'host1').to_bytes }
+      it { is_expected.to byte_eq "\x00\x00\x00\x34\xA5\xA5\x5A\x6E\x00\x00\x00\x04\x00\x04\x53\x53\x4E\x5F\x01\x00\x00\x00\x01\x53\x48\x4F\x57\x02\x00\x06\x73\x68\x6F\x77\x31\x00\x50\x41\x53\x53\x02\x00\x04\x70\x77\x64\x00\x48\x4F\x53\x54\x02\x00\x06\x68\x6F\x73\x74\x31\x00" }
+    end
+  end
+end
+

data/spec/telos/message_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Telos::Message do
+  describe ".response_size" do
+    it 'should report the correct size' do
+      expect(
+          Telos::Message.response_size("\x00\x00\x00\x3f\xA5\xA5\x5A\x65")
+      ).to eq 63
+    end
+
+    it 'should raise an error when the checksum is incorrect' do
+      expect {
+          Telos::Message.response_size("\x00\x00\x00\x3f\xA5\xA5\x5A\x64")
+      }.to raise_error(Telos::Message::ChecksumMismatch)
+    end
+  end
+end
+

data/telos.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'telos/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "telos"
+  spec.version       = Telos::VERSION
+  spec.authors       = ["Jan De Poorter"]
+  spec.email         = ["jan.depoorter@medialaan.be"]
+  spec.summary       = %q{Library to communicate with Telos devices}
+  spec.description   = %q{A library to communicate with Telos devices over the low-level protocol}
+  spec.homepage      = "http://github.com/q-music/ruby-telos"
+  spec.license       = "Apache-2.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,91 @@
+--- !ruby/object:Gem::Specification
+name: telos
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jan De Poorter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-03 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 devices over the low-level protocol
+email:
+- jan.depoorter@medialaan.be
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- Rakefile
+- lib/telos.rb
+- lib/telos/device.rb
+- lib/telos/message.rb
+- lib/telos/message/incoming.rb
+- lib/telos/message/outgoing.rb
+- lib/telos/version.rb
+- spec/spec_helper.rb
+- spec/telos/message/incoming_spec.rb
+- spec/telos/message/outgoing_spec.rb
+- spec/telos/message_spec.rb
+- telos.gemspec
+homepage: http://github.com/q-music/ruby-telos
+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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Library to communicate with Telos devices
+test_files:
+- spec/spec_helper.rb
+- spec/telos/message/incoming_spec.rb
+- spec/telos/message/outgoing_spec.rb
+- spec/telos/message_spec.rb