teamspeak-ruby 0.0.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8515925df3f7f08ef7b8e72d05f3f5800ebbea4d
-  data.tar.gz: c0181831098873a702cffa107914bd905e45951d
+  metadata.gz: 5e597f9317f78597ad033ee1a497c7a9cf13459d
+  data.tar.gz: 73c37f6efc8231e5fe46ae2fd35c0ec64fd8f23c
 SHA512:
-  metadata.gz: 26244c88b234219155e319a2d0b15a094752c379db516e7edbe5fd60cba4083233e543145ecc580459d21778fffc2c7c20f53670ca93f3fa21eb21e358748a98
-  data.tar.gz: 974d530f0504404c21a4b8603e2aa98b711c956c02e72255fc377a591fc4465bbd9c5807237d0b4854534faf290d3d92d0115f91c8d4a7e125dbbe5f5ceb9424
+  metadata.gz: f244e7925b258b707da5f52084f9e555911ea65104d5f783e00e0a47a5081af66e8822e55b27aa656342e4c2d1bf206bd59316749c46533cbd7f15cda3e6c98e
+  data.tar.gz: 8dcfc08728b28be8c707a2a522ac9128843ab6733546a2be68eab17859f112a3bf43877b96b84d42404bf9938225611f33d696a1d7e11f568ea9a1f58b5e44cd

data/lib/teamspeak-ruby.rb

@@ -1,118 +1,3 @@
-require 'socket'
-
-class Teamspeak
-  def initialize(host = 'localhost', port = 10011)
-    self.connect(host, port)
-  end
-
-  def connect(host = 'localhost', port = 10011)
-    @sock = TCPSocket.new(host, port)
-
-    # Check if the response is the same as a normal teamspeak 3 server.
-    if @sock.gets.strip != 'TS3'
-      puts 'This is not responding as a TeamSpeak 3 server.'
-
-      return false
-    end
-
-    # Remove useless text from the buffer.
-    @sock.gets
-  end
-
-  def disconnect
-    @sock.puts 'quit'
-    @sock.close
-  end
-
-  def login(user, pass)
-    self.command('login', {'client_login_name' => user, 'client_login_password' => pass})
-  end
-
-  def command(cmd, params = {}, options = '')
-    out = ''
-    response = ''
-
-    out += cmd
-
-    params.each_pair do |key, value|
-      out += " #{key}=#{encode_param(value.to_s)}"
-    end
-
-    out += ' ' + options
-
-    @sock.puts out
-
-    while true
-      response += @sock.gets
-      
-      if response.index('msg=')
-        break
-      end
-    end
-
-    # Array of commands that are expected to return as an array.
-    # Not sure - clientgetids
-    should_be_array = ['bindinglist', 'serverlist', 'servergrouplist', 'servergroupclientlist',
-        'servergroupsbyclientid', 'servergroupclientlist', 'logview', 'channellist',
-        'channelfind', 'channelgrouplist', 'channelgrouppermlist', 'channelpermlist', 'clientlist',
-        'clientfind', 'clientdblist', 'clientdbfind', 'channelclientpermlist', 'permissionlist',
-        'permoverview', 'privilegekeylist', 'messagelist', 'complainlist', 'banlist', 'ftlist',
-        'custominfo']
-
-    parsed_response = parse_response(response)
-
-    return should_be_array.include?(cmd) ? parsed_response : parsed_response.first
-  end
-
-  def parse_response(response)
-    out = []
-
-    response = response.split('error id=').first
-
-    response.split('|').each do |key|
-      data = {}
-
-      key.split(' ').each do |key|
-        value = key.split('=')
-
-        data[value[0]] = decode_param(value[1].to_s)
-      end
-
-      out.push(data)
-    end
-
-    return out
-  end
-
-  def decode_param(param)
-    param = param.gsub('\\\\', '\\')
-    param = param.gsub('\\/', '/')
-    param = param.gsub('\\s', ' ')
-    param = param.gsub('\\p', '|')
-    param = param.gsub('\\a', '\a')
-    param = param.gsub('\\b', '\b')
-    param = param.gsub('\\f', '\f')
-    param = param.gsub('\\n', '\n')
-    param = param.gsub('\\r', '\r')
-    param = param.gsub('\\t', '\t')
-    param = param.gsub('\\v', '\v')
-
-    return param == '' ? nil : param
-  end
-
-  def encode_param(param)
-    param = param.gsub('\\', '\\\\')
-    param = param.gsub('/', '\\/')
-    param = param.gsub(' ', '\\s')
-    param = param.gsub('|', '\\p')
-    param = param.gsub('\a', '\\a')
-    param = param.gsub('\b', '\\b')
-    param = param.gsub('\f', '\\f')
-    param = param.gsub('\n', '\\n')
-    param = param.gsub('\r', '\\r')
-    param = param.gsub('\t', '\\t')
-    param = param.gsub('\v', '\\v')
-
-    return param
-  end
-end
+require 'teamspeak-ruby/client'
+require 'teamspeak-ruby/exceptions'
+require 'teamspeak-ruby/version'

data/lib/teamspeak-ruby/client.rb

@@ -0,0 +1,144 @@
+require 'socket'
+
+module Teamspeak
+  class Client
+    # Initializes Client
+    #
+    #   connect('voice.domain.com', 88888)
+    def initialize(host = 'localhost', port = 10011)
+      connect(host, port)
+    end
+
+    # Connects to a TeamSpeak 3 server
+    #
+    #   connect('voice.domain.com', 88888)
+    def connect(host = 'localhost', port = 10011)
+      @sock = TCPSocket.new(host, port)
+
+      # Check if the response is the same as a normal teamspeak 3 server.
+      if @sock.gets.strip != 'TS3'
+        raise InvalidServer, 'Server is not responding as a normal TeamSpeak 3 server.'
+      end
+
+      # Remove useless text from the buffer.
+      @sock.gets
+    end
+
+    # Disconnects from the TeamSpeak 3 server
+    def disconnect
+      @sock.puts 'quit'
+      @sock.close
+    end
+
+    # Authenticates with the TeamSpeak 3 server
+    #
+    #   login('serveradmin', 'H8YlK1f9')
+    def login(user, pass)
+      command('login', {'client_login_name' => user, 'client_login_password' => pass})
+    end
+
+    # Sends command to the TeamSpeak 3 server and returns the response
+    #
+    #   command('use', {'sid' => 1}, '-away')
+    def command(cmd, params = {}, options = '')
+      out = ''
+      response = ''
+
+      out += cmd
+
+      params.each_pair do |key, value|
+        out += " #{key}=#{encode_param(value.to_s)}"
+      end
+
+      out += ' ' + options
+
+      @sock.puts out
+
+      while true
+        response += @sock.gets
+        
+        if response.index('msg=')
+          break
+        end
+      end
+
+      # Array of commands that are expected to return as an array.
+      # Not sure - clientgetids
+      should_be_array = ['bindinglist', 'serverlist', 'servergrouplist', 'servergroupclientlist',
+          'servergroupsbyclientid', 'servergroupclientlist', 'logview', 'channellist',
+          'channelfind', 'channelgrouplist', 'channelgrouppermlist', 'channelpermlist', 'clientlist',
+          'clientfind', 'clientdblist', 'clientdbfind', 'channelclientpermlist', 'permissionlist',
+          'permoverview', 'privilegekeylist', 'messagelist', 'complainlist', 'banlist', 'ftlist',
+          'custominfo']
+
+      parsed_response = parse_response(response)
+
+      return should_be_array.include?(cmd) ? parsed_response : parsed_response.first
+    end
+
+    def parse_response(response)
+      out = []
+
+      response.split('|').each do |key|
+        data = {}
+
+        key.split(' ').each do |key|
+          value = key.split('=')
+
+          data[value[0]] = decode_param(value[1])
+        end
+
+        out.push(data)
+      end
+
+      check_response_error(out)
+
+      return out
+    end
+
+    def decode_param(param)
+      return nil unless param
+      # Return as integer if possible
+      return param.to_i if param.to_i.to_s == param 
+
+      param.gsub!('\\\\', '\\')
+      param.gsub!('\\/', '/')
+      param.gsub!('\\s', ' ')
+      param.gsub!('\\p', '|')
+      param.gsub!('\\a', '\a')
+      param.gsub!('\\b', '\b')
+      param.gsub!('\\f', '\f')
+      param.gsub!('\\n', '\n')
+      param.gsub!('\\r', '\r')
+      param.gsub!('\\t', '\t')
+      param.gsub!('\\v', '\v')
+
+      return param
+    end
+
+    def encode_param(param)
+      param.gsub!('\\', '\\\\')
+      param.gsub!('/', '\\/')
+      param.gsub!(' ', '\\s')
+      param.gsub!('|', '\\p')
+      param.gsub!('\a', '\\a')
+      param.gsub!('\b', '\\b')
+      param.gsub!('\f', '\\f')
+      param.gsub!('\n', '\\n')
+      param.gsub!('\r', '\\r')
+      param.gsub!('\t', '\\t')
+      param.gsub!('\v', '\\v')
+
+      return param
+    end
+
+    def check_response_error(response)
+      id = response.first['id']
+      message = response.first['msg']
+
+      raise ServerError.new(id, message) unless id == 0
+    end
+
+    private(:parse_response, :decode_param, :encode_param, :check_response_error)
+  end
+end

data/lib/teamspeak-ruby/exceptions.rb

@@ -0,0 +1,18 @@
+module Teamspeak
+  # Raised when the connected server does not respond as a normal TeamSpeak 3 would.
+  #
+  # raise InvalidServer, 'Server is not responding as a normal TeamSpeak 3 server.'
+  class InvalidServer < StandardError; end
+
+  # Raised when the server returns an error code other than 0.
+  #
+  # raise ServerError.new(1, 'Some generic error message')
+  class ServerError < StandardError
+    attr_reader(:code, :message)
+
+    def initialize(code, message)
+      @code = code
+      @message = message
+    end
+  end
+end

data/lib/teamspeak-ruby/version.rb

@@ -0,0 +1,3 @@
+module Teamspeak
+  VERSION = '1.0.0'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teamspeak-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 1.0.0
 platform: ruby
 authors:
 - Justin Harrison
@@ -16,6 +16,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/teamspeak-ruby/client.rb
+- lib/teamspeak-ruby/exceptions.rb
+- lib/teamspeak-ruby/version.rb
 - lib/teamspeak-ruby.rb
 homepage: http://pyrohail.com
 licenses:
@@ -42,3 +45,4 @@ signing_key:
 specification_version: 4
 summary: Ruby interface for TeamSpeak 3's server query api.
 test_files: []
+has_rdoc: