teamspeak3 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 047e1ed175699cf16ec1e920abb755a80716aef5
-  data.tar.gz: 4dcb207489d5047c177b0e032ad53787d81cbdbc
+  metadata.gz: 5cfaad253891919553b8e8f9195e6c903a43e94f
+  data.tar.gz: 4b4a47e6af3efea58d63e32f004efb660eae2909
 SHA512:
-  metadata.gz: b9453878d62e0eb4974a27c1207c1d7b4d706ad2f6a4816a26eb6916d23cdd273043619c45bda59b1a388464da7120c600540cf6c4410d0f1bde2274e3fb536d
-  data.tar.gz: d590572ef38941d77bb302d42a4e12fae015143e54485907e9583e09d99f1cc3cdb7e2520cadd0bfb74f60f1d9ebeb7c15c3c1e12ba04396fd473b1f18e3c0ec
+  metadata.gz: 4f2d97920b5994b11b4deb306296e9eef01e1f3d3d55ab62ea92e47e7de5acd3d55566c49e7be9d6becaa4907b391ce46938aaa10a48646121fb7e352c060288
+  data.tar.gz: a4e43cb8cb9ed5eb8c940e237102d6f9b95c6fdf436d9f31b01923dcfa62727a00c2817dc130553a1ea4db578a90ee35c94f956f4090528ff04a2951e6950837

data/lib/channel.rb

@@ -0,0 +1,97 @@
+module TeamSpeak3
+  class Channel
+    attr_reader :virtual_server
+
+    attr_reader :id
+    attr_reader :pid
+    attr_reader :name
+    attr_reader :order
+    attr_reader :total_clients
+    attr_reader :needed_subscribe_power
+
+    attr_reader :topic
+
+    attr_reader :flags
+
+    attr_reader :codec
+    attr_reader :codec_quality
+    attr_reader :needed_talk_power
+
+    attr_reader :icon_id
+
+    attr_reader :total_clients_family
+    attr_reader :max_clients
+    attr_reader :max_family_clients
+
+    def initialize(virtual_server, params)
+      @virtual_server = virtual_server
+
+      @id = params[:cid].to_i
+      @pid = params[:pid].to_i
+      @name = params[:channel_name]
+      @order = params[:order].to_i
+      @total_clients = params[:total_clients].to_i
+      @needed_subscribe_power = params[:channel_needed_subscribe_power].to_i
+
+      # option: :topic
+      @topic = params[:channel_topic]
+
+      # option: :flags
+      @flags = []
+      @flags << :default if params[:channel_flag_default].to_i == 1
+      @flags << :password if params[:channel_flag_password].to_i == 1
+      @flags << :permanent if params[:channel_flag_permanent].to_i == 1
+      @flags << :semi_permanent if params[:channel_flag_semi_permanent].to_i == 1
+
+      # option: :voice
+      @codec = params[:channel_codec].to_i
+      @codec_quality = params[:channel_codec_quality].to_i
+      @needed_talk_power = params[:channel_needed_talk_power].to_i
+
+      # option: :icon
+      @icon_id = params[:channel_icon_id].to_i
+
+      # option: :limits
+      @total_clients_family = params[:total_clients_family].to_i
+      @max_clients = params[:channel_maxclients].to_i
+      @max_family_clients = params[:channel_maxfamilyclients].to_i
+    end
+
+    def codec_name
+      return "Speex Narrowband" if @codec == 0
+      return "Speex Wideband" if @codec == 1
+      return "Speex Ultra-Wideband" if @codec == 2
+      return "CELT Mono" if @codec == 3
+      return "Opus Voice" if @codec == 4
+      return "Opus Music" if @codec == 5
+    end
+
+    def permanent?
+      flag?(:permanent)
+    end
+
+    def semi_permanent?
+      flag?(:semi_permanent)
+    end
+
+    def password?
+      flag?(:password)
+    end
+
+    def default?
+      flag?(:default)
+    end
+
+    def flag?(flag)
+      @flags.include?(flag.to_sym)
+    end
+
+    def send_message(message)
+      virtual_server.server.send_message_to(self, message)
+    end
+
+    def ==(target)
+      @id == target
+    end
+  end
+end

data/lib/client.rb

@@ -0,0 +1,122 @@
+module TeamSpeak3
+  class Client
+    attr_reader :virtual_server
+
+    attr_reader :client_id
+    attr_reader :client_database_id
+    attr_reader :channel_id
+    attr_reader :nickname
+    attr_reader :type_id
+    attr_reader :away_message
+    attr_reader :flags
+    attr_reader :talk_power
+    attr_reader :uid
+    attr_reader :version
+    attr_reader :platform
+    attr_reader :servergroups
+    attr_reader :channel_group_id
+    attr_reader :channel_group_inherited_channel_id
+    attr_reader :idle_time
+    attr_reader :created_at
+    attr_reader :last_connected
+    attr_reader :icon_id
+    attr_reader :country
+
+    def initialize(virtual_server, params)
+      @virtual_server = virtual_server
+
+      @client_id = params[:clid].to_i
+      @client_database_id = params[:client_database_id].to_i
+      @channel_id = params[:cid].to_i
+      @nickname = params[:client_nickname]
+      @type_id = params[:client_type].to_i
+      @away = params[:client_away].to_i == 1
+      @away_message = params[:client_away_message]
+
+      @flags = []
+      @flags << :talking if params[:client_flag_talking].to_i == 1
+
+      @input_muted = true if params[:client_input_muted].to_i == 1
+      @output_muted = true if params[:client_output_muted].to_i == 1
+
+      @input_hardware = true if params[:client_input_hardware].to_i == 1
+      @output_hardware = true if params[:client_output_hardware].to_i == 1
+
+      @talk_power = params[:client_talk_power].to_i
+      @talker = params[:client_is_talker].to_i == 1
+      @priority_speaker = params[:client_is_priority_speaker].to_i == 1
+      @recording = params[:client_is_recording].to_i == 1
+      
+      @channel_commander = params[:client_is_channel_commander].to_i == 1
+
+      @uid = params[:client_unique_identifier]
+      @version = params[:client_version]
+      @platform = params[:client_platform]
+      @servergroups = params[:client_servergroups].split(',').map {|group| group.to_i}
+      @channel_group_id = params[:client_channel_group_id].to_i
+      @channel_group_inherited_channel_id = params[:client_channel_group_inherited_channel_id].to_i
+
+      @idle_time = Time.now - params[:client_idle_time].to_i
+      @created_at = Time.at(params[:client_created].to_i)
+      @last_connected = Time.at(params[:client_lastconnected].to_i)
+
+      @icon_id = params[:client_icon_id].to_i
+
+      @country = params[:client_country]
+    end
+
+    def away?
+      @away
+    end
+
+    def channel_commander?
+      @channel_commander
+    end
+
+    def flag?(flag)
+      @flags.include?(flag)
+    end
+
+    def input_hardware?
+      @input_hardware
+    end
+
+    def input_muted?
+      @input_muted
+    end
+
+    def kick_from_server!(reason = nil)
+      virtual_server.server.kick_client!(client_id, :server, reason)
+      true
+    end
+
+    def kick_from_channel!(reason = nil)
+      virtual_server.server.kick_client!(client_id, :channel, reason)
+      true
+    end
+
+    def output_hardware?
+      @output_hardware
+    end
+
+    def output_muted?
+      @output_muted
+    end
+
+    def priority_speaker?
+      @priority_speaker
+    end
+
+    def recording?
+      @recording
+    end
+
+    def talker?
+      @talker
+    end
+
+    def talking?
+      flag?(:talking)
+    end
+  end
+end

data/lib/command_parameter.rb

@@ -0,0 +1,37 @@
+module TeamSpeak3
+  module CommandParameter
+    def self.encode(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 self.decode(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
+  end
+end

data/lib/exceptions.rb

@@ -3,6 +3,9 @@ require_relative 'exceptions/standard_exception.rb'
 
 # alphabetical order of exceptions
 require_relative 'exceptions/command_execution_failed.rb'
+require_relative 'exceptions/invalid_kick_action.rb'
+require_relative 'exceptions/invalid_target.rb'
+require_relative 'exceptions/invalid_target_type.rb'
 require_relative 'exceptions/not_connected.rb'
 require_relative 'exceptions/query_login_failed.rb'
 require_relative 'exceptions/server_connection_failed.rb'

data/lib/exceptions/invalid_kick_action.rb

@@ -0,0 +1,12 @@
+module TeamSpeak3
+  module Exceptions
+    class InvalidKickAction < TeamSpeak3::Exceptions::StandardException
+      attr_reader :action
+
+      def initialize(action)
+        @action = action
+        @message = "Invalid kick action '#{action}'."
+      end
+    end
+  end
+end

data/lib/exceptions/invalid_target.rb

@@ -0,0 +1,12 @@
+module TeamSpeak3
+  module Exceptions
+    class InvalidTarget < TeamSpeak3::Exceptions::StandardException
+      attr_reader :target
+
+      def initialize(target)
+        @target = target
+        @message = "Invalid target '#{target}'."
+      end
+    end
+  end
+end

data/lib/exceptions/invalid_target_type.rb

@@ -0,0 +1,12 @@
+module TeamSpeak3
+  module Exceptions
+    class InvalidTargetType < TeamSpeak3::Exceptions::StandardException
+      attr_reader :target_type
+
+      def initialize(target_type)
+        @target_type = target_type
+        @message = "Invalid target type '#{target_type}'."
+      end
+    end
+  end
+end

data/lib/exceptions/server_connection_failed.rb

@@ -1,6 +1,9 @@
 module TeamSpeak3
   module Exceptions
     class ServerConnectionFailed < TeamSpeak3::Exceptions::StandardException
+      attr_reader :ip_address
+      attr_reader :query_port
+
       def initialize(ip_address, query_port, message)
         @ip_address = ip_address
         @query_port = query_port

data/lib/server.rb

@@ -3,6 +3,7 @@ module TeamSpeak3
     attr_reader :ip_address
     attr_reader :query_port
     attr_reader :socket
+    attr_reader :active_server
 
     def initialize(ip_address, query_port, opts = {})
       @ip_address = ip_address
@@ -43,10 +44,73 @@ module TeamSpeak3
       true
     end
 
-    private
+    def select_server(virtual_server_id)
+      execute "use sid=#{virtual_server_id}"
+      @active_server = virtual_server_id
+    end
 
-    def verify_connection
-      raise TeamSpeak3::Exceptions::NotConnected, 'Not connected to a TeamSpeak 3 server.' unless @socket
+    def virtual_servers
+      server_list = []
+
+      servers = execute "serverlist -uid -all"
+      servers[:data].each do |server|
+        server_list << TeamSpeak3::VirtualServer.new(self, server)
+      end
+
+      server_list
+    end
+
+    def kick_client!(client_id, action, reason = nil)
+      # set correct kick action
+      action_id = nil
+      action_id = 4 if action == :channel
+      action_id = 5 if action == :server
+
+      raise TeamSpeak3::Exceptions::InvalidKickAction.new(action) unless action_id
+
+      # handle multiple client ids
+      client_ids = ""
+      if client_id.is_a?(Integer)
+        client_ids = "clid=#{client_id}"
+      elsif client_id.is_a?(Array)
+        client_id.each { |id| client_ids += "clid=#{id}|" }
+        client_ids = client_ids[0..-2]
+      end
+
+      # execute command
+      command = "clientkick #{client_ids} reasonid=#{action_id}"
+      command += " reasonmsg=#{TeamSpeak3::CommandParameter.encode(reason)}" if reason
+      execute command
+    end
+
+    def send_message_to(target, message, target_type = :auto)
+      if target_type == :auto
+        if target.is_a?(TeamSpeak3::VirtualServer)
+          target_id = target.id
+          target_type_id = 3
+
+          select_server target.id
+        elsif target.is_a?(TeamSpeak3::Channel)
+          target_id = target.id
+          target_type_id = 2
+
+          select_server target.virtual_server.id
+        else
+          raise TeamSpeak3::Exceptions::InvalidTarget.new(target)
+        end
+      else
+        target_id = target
+
+        target_type_id = 3 if target_type.to_sym == :server
+        target_type_id = 2 if target_type.to_sym == :channel
+        target_type_id = 1 if target_type.to_sym == :client
+
+        raise TeamSpeak3::Exceptions::InvalidTargetType.new(target_type) unless target_type_id
+      end
+
+      execute "sendtextmessage target=#{target_id} targetmode=#{target_type_id} " \
+        "msg=#{TeamSpeak3::CommandParameter.encode(message)}"
+      true
     end
 
     def execute(command)
@@ -66,5 +130,11 @@ module TeamSpeak3
 
       response
     end
+
+    private
+
+    def verify_connection
+      raise TeamSpeak3::Exceptions::NotConnected, 'Not connected to a TeamSpeak 3 server.' unless @socket
+    end
   end
 end

data/lib/server_response.rb

@@ -37,7 +37,7 @@ module TeamSpeak3
               value = nil
             end
 
-            result[key.to_sym] = parse_value(value)
+            result[key.to_sym] = TeamSpeak3::CommandParameter.decode(value)
           end
 
           return result if opts[:ignore_array_result]
@@ -47,23 +47,6 @@ module TeamSpeak3
         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")
 

data/lib/teamspeak3.rb

@@ -1,5 +1,12 @@
 require 'net/telnet'
 
+# exceptions shall be required first
 require_relative 'exceptions.rb'
+
+# library classes ordered alphabetically
+require_relative 'channel.rb'
+require_relative 'client.rb'
+require_relative 'command_parameter.rb'
+require_relative 'virtual_server.rb'
 require_relative 'server_response.rb'
 require_relative 'server.rb'

data/lib/virtual_server.rb

@@ -0,0 +1,73 @@
+module TeamSpeak3
+  class VirtualServer
+    attr_reader :server
+
+    attr_reader :id
+    attr_reader :name
+    attr_reader :port
+    attr_reader :status
+    attr_reader :clients_online
+    attr_reader :query_clients_online
+    attr_reader :slots
+    attr_reader :uptime
+    attr_reader :autostart
+    attr_reader :uid
+
+    def initialize(server, params)
+      @server = server
+
+      @id = params[:virtualserver_id].to_i
+      @name = params[:virtualserver_name]
+      @port = params[:virtualserver_port].to_i
+      @status = params[:virtualserver_status].to_sym
+      @clients_online = params[:virtualserver_clientsonline].to_i
+      @query_clients_online = params[:virtualserver_queryclientsonline].to_i
+      @slots = params[:virtualserver_maxclients].to_i
+      @uptime = Time.now - params[:virtualserver_uptime].to_i
+      @autostart = params[:virtualserver_uptime].to_i == 1
+      @uid = params[:virtualserver_unique_identifier]
+    end
+
+    def channels
+      check_active_server
+
+      channels_list = []
+      channels = @server.execute "channellist -topic -flags -voice -limits -icon"
+
+      channels[:data].each do |channel|
+        channels_list << TeamSpeak3::Channel.new(self, channel)
+      end
+
+      channels_list
+    end
+
+    def clients
+      check_active_server
+
+      clients_list = []
+      clients = @server.execute "clientlist -uid -away -voice -times -groups -info -icon -country"
+
+      clients[:data].each do |client|
+        clients_list << TeamSpeak3::Client.new(self, client)
+      end
+
+      clients_list
+    end
+
+    def send_message(message)
+      server.send_message_to(self, message)
+    end
+
+    def ==(target)
+      @id == target
+    end
+
+    private
+
+    def check_active_server
+      if @server.active_server != @id
+        @server.select_server(@id)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: teamspeak3
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Manuel Schnitzer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-04 00:00:00.000000000 Z
+date: 2018-03-05 00:00:00.000000000 Z
 dependencies: []
 description: An OOP library to query and manage TeamSpeak 3 servers in Ruby.
 email: webmaster@mschnitzer.de
@@ -16,8 +16,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/channel.rb
+- lib/client.rb
+- lib/command_parameter.rb
 - lib/exceptions.rb
 - lib/exceptions/command_execution_failed.rb
+- lib/exceptions/invalid_kick_action.rb
+- lib/exceptions/invalid_target.rb
+- lib/exceptions/invalid_target_type.rb
 - lib/exceptions/not_connected.rb
 - lib/exceptions/query_login_failed.rb
 - lib/exceptions/server_connection_failed.rb
@@ -25,6 +31,7 @@ files:
 - lib/server.rb
 - lib/server_response.rb
 - lib/teamspeak3.rb
+- lib/virtual_server.rb
 homepage: https://github.com/mschnitzer/teamspeak3
 licenses:
 - MIT