teamspeak3 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 047e1ed175699cf16ec1e920abb755a80716aef5
+  data.tar.gz: 4dcb207489d5047c177b0e032ad53787d81cbdbc
+SHA512:
+  metadata.gz: b9453878d62e0eb4974a27c1207c1d7b4d706ad2f6a4816a26eb6916d23cdd273043619c45bda59b1a388464da7120c600540cf6c4410d0f1bde2274e3fb536d
+  data.tar.gz: d590572ef38941d77bb302d42a4e12fae015143e54485907e9583e09d99f1cc3cdb7e2520cadd0bfb74f60f1d9ebeb7c15c3c1e12ba04396fd473b1f18e3c0ec

data/lib/exceptions.rb

@@ -0,0 +1,8 @@
+# the standard exception is the parent of all exceptions
+require_relative 'exceptions/standard_exception.rb'
+
+# alphabetical order of exceptions
+require_relative 'exceptions/command_execution_failed.rb'
+require_relative 'exceptions/not_connected.rb'
+require_relative 'exceptions/query_login_failed.rb'
+require_relative 'exceptions/server_connection_failed.rb'

data/lib/exceptions/command_execution_failed.rb

@@ -0,0 +1,14 @@
+module TeamSpeak3
+  module Exceptions
+    class CommandExecutionFailed < TeamSpeak3::Exceptions::StandardException
+      attr_reader :error_id
+      attr_reader :command
+
+      def initialize(error_id, message, command)
+        @error_id = error_id.to_i
+        @message = message
+        @command = command
+      end
+    end
+  end
+end

data/lib/exceptions/not_connected.rb

@@ -0,0 +1,9 @@
+module TeamSpeak3
+  module Exceptions
+    class NotConnected < TeamSpeak3::Exceptions::StandardException
+      def initialize(message)
+        @message = message
+      end
+    end
+  end
+end

data/lib/exceptions/query_login_failed.rb

@@ -0,0 +1,9 @@
+module TeamSpeak3
+  module Exceptions
+    class QueryLoginFailed < TeamSpeak3::Exceptions::StandardException
+      def initialize(message)
+        @message = message
+      end
+    end
+  end
+end

data/lib/exceptions/server_connection_failed.rb

@@ -0,0 +1,11 @@
+module TeamSpeak3
+  module Exceptions
+    class ServerConnectionFailed < TeamSpeak3::Exceptions::StandardException
+      def initialize(ip_address, query_port, message)
+        @ip_address = ip_address
+        @query_port = query_port
+        @message = message
+      end
+    end
+  end
+end

data/lib/exceptions/standard_exception.rb

@@ -0,0 +1,11 @@
+module TeamSpeak3
+  module Exceptions
+    class StandardException < Exception
+      attr_reader :message
+
+      def to_s
+        @message
+      end
+    end
+  end
+end

data/lib/server.rb

@@ -0,0 +1,70 @@
+module TeamSpeak3
+  class Server
+    attr_reader :ip_address
+    attr_reader :query_port
+    attr_reader :socket
+
+    def initialize(ip_address, query_port, opts = {})
+      @ip_address = ip_address
+      @query_port = query_port
+      @opts = opts
+    end
+
+    def connect
+      begin
+        @socket = Net::Telnet::new(
+          'Host' => @ip_address,
+          'Port' => @query_port,
+          'Timeout' => @opts[:timeout] || 3,
+          'Telnetmode' => false
+        )
+        
+        @socket.waitfor(/Welcome to the TeamSpeak 3 ServerQuery interface/)
+      rescue Net::ReadTimeout => err 
+        raise TeamSpeak3::Exceptions::ServerConnectionFailed.new(@ip_address, @query_port, \
+          "Timeout while waiting for TeamSpeak 3 welcome message.")
+      rescue Net::OpenTimeout, Errno::ECONNREFUSED => err
+        raise TeamSpeak3::Exceptions::ServerConnectionFailed.new(@ip_address, @query_port, \
+          "Could not open connection to server at #{@ip_address}:#{@query_port}")
+      end
+
+      true
+    end
+
+    def login(query_user, query_pass)
+      verify_connection
+
+      begin
+        execute "login client_login_name=#{query_user} client_login_password=#{query_pass}"
+      rescue TeamSpeak3::Exceptions::CommandExecutionFailed => err
+        raise TeamSpeak3::Exceptions::QueryLoginFailed, err.message
+      end
+
+      true
+    end
+
+    private
+
+    def verify_connection
+      raise TeamSpeak3::Exceptions::NotConnected, 'Not connected to a TeamSpeak 3 server.' unless @socket
+    end
+
+    def execute(command)
+      @socket.puts(command)
+
+      # every response contains an error information. so we wait until we receive a response
+      response = @socket.waitfor(/error id=.*/)
+
+      response = TeamSpeak3::ServerResponse.parse(response)
+      if response[:errors][:msg] != 'ok'
+        raise TeamSpeak3::Exceptions::CommandExecutionFailed.new(
+          response[:errors][:id],
+          response[:errors][:msg],
+          command,
+        )
+      end
+
+      response
+    end
+  end
+end

data/lib/server_response.rb

@@ -0,0 +1,84 @@
+module TeamSpeak3
+  class ServerResponse
+    class << self
+      def parse(response)
+        data, errors = split_data_from_errors(response)
+
+        data = split_keys_from_values(data) if data
+        errors = split_keys_from_values(errors, ignore_array_result: true) if errors
+
+        { data: data, errors: errors } 
+      end
+
+      private
+
+      def split_keys_from_values(data, opts = {})
+        # some commands return an array as response (indicated by a pipe)
+        response_list = data.split('|')
+        result_list = []
+
+        response_list.each do |data|
+          # split data packets (e.g.: cid=1 channel_name=test)
+          data = data.split(' ')
+          result = {}
+
+          data.each do |key_and_value|
+            # the start of the error section is always indicated with 'error'. As there is no '=' and no
+            # data we have to split, we can safely skip this iteration
+            next if key_and_value == "error"
+
+            trim_pos = key_and_value.index('=')
+            
+            if trim_pos
+              key = key_and_value[0..trim_pos-1]
+              value = key_and_value[trim_pos+1..-1]
+            else
+              key = key_and_value
+              value = nil
+            end
+
+            result[key.to_sym] = parse_value(value)
+          end
+
+          return result if opts[:ignore_array_result]
+          result_list.push(result)
+        end
+
+        result_list
+      end
+
+      def parse_value(value)
+        return unless value
+
+        value.gsub!("\\\\", "\\")
+        value.gsub!("\/", "/")
+        value.gsub!("\\s", " ")
+        value.gsub!("\\p", "|")
+        value.gsub!("\\a", "\a")
+        value.gsub!("\\b", "\b")
+        value.gsub!("\\f", "\f")
+        value.gsub!("\\n", "\n")
+        value.gsub!("\\r", "\r")
+        value.gsub!("\\t", "\t")
+        value.gsub!("\\v", "\v")
+        value
+      end
+
+      def split_data_from_errors(response)
+        data, errors = response.split("\n")
+
+        # the response always consists of an error information (even if everything was fine) divided
+        # by a new line. normally, 'errors' contains the error information, but in case there is only
+        # an error and no data has been responded, the 'data' variable actually contains our error
+        # information
+
+        if data && !errors
+          errors = data
+          data = nil
+        end
+
+        [ data, errors ]
+      end
+    end
+  end
+end

data/lib/teamspeak3.rb

@@ -0,0 +1,5 @@
+require 'net/telnet'
+
+require_relative 'exceptions.rb'
+require_relative 'server_response.rb'
+require_relative 'server.rb'

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: teamspeak3
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Manuel Schnitzer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-04 00:00:00.000000000 Z
+dependencies: []
+description: An OOP library to query and manage TeamSpeak 3 servers in Ruby.
+email: webmaster@mschnitzer.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/exceptions.rb
+- lib/exceptions/command_execution_failed.rb
+- lib/exceptions/not_connected.rb
+- lib/exceptions/query_login_failed.rb
+- lib/exceptions/server_connection_failed.rb
+- lib/exceptions/standard_exception.rb
+- lib/server.rb
+- lib/server_response.rb
+- lib/teamspeak3.rb
+homepage: https://github.com/mschnitzer/teamspeak3
+licenses:
+- MIT
+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.5
+signing_key: 
+specification_version: 4
+summary: A TeamSpeak 3 Query Library
+test_files: []