teamspeak-ruby 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1d8e641ccb877703ab18aa73f28d2de90e990d7
-  data.tar.gz: 0d468dd3fa41c8641b193e57c5a69a5dce4d7115
+  metadata.gz: 48a7dab7b91961d54bacdea425abe4a996dc24f0
+  data.tar.gz: 03f19e56293c044f8fb44e416f6d03ce245072e9
 SHA512:
-  metadata.gz: 920afa92b2e547f2af1454168fd6a159a6dadccfb73bebc594879dbe83de476d4decb0f819471444f681c8c577f18ff4bca3600e4b5720be84c023702a1ea7b0
-  data.tar.gz: 24823d5c09834c13629036aa28bb7d32b1843d5568b6a7d5ccdbf35dde2d40bf503c4531c385ffb56329157b74863339534213376c4966608f94e52bf95db903
+  metadata.gz: acc5f352ce5c12942d29d498aa0cb68bcc241295ed2dd469fc3ef2c991afe5a6fbedd158149d3634e59f18e62f08711a90107a35517de64e42bb7b79c18b988e
+  data.tar.gz: 5e7cfecfc5f0bca28bac5a8e3034f1c76299fbd6d88879614b06809ac501ee9a7de6c82661bba11081e8a789920664c69b27e92173f5c2be091653989676f603

data/lib/teamspeak-ruby.rb

@@ -1,3 +1,3 @@
-require 'teamspeak-ruby/client'
-require 'teamspeak-ruby/exceptions'
-require 'teamspeak-ruby/version'
+require 'teamspeak-ruby/client'
+require 'teamspeak-ruby/exceptions'
+require 'teamspeak-ruby/version'

data/lib/teamspeak-ruby/client.rb

@@ -1,146 +1,178 @@
-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('=', 2)
-
-          data[value[0]] = decode_param(value[1])
-        end
-
-        out.push(data)
-      end
-
-      check_response_error(out)
-
-      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')
-
-      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')
-
-      param
-    end
-
-    def check_response_error(response)
-      id = response.first['id'] || 0
-      message = response.first['msg'] || 0
-
-      raise ServerError.new(id, message) unless id == 0
-    end
-
-    private(:parse_response, :decode_param, :encode_param, :check_response_error)
-  end
-end
+require 'socket'
+
+module Teamspeak
+  class Client
+    # Should commands be throttled? Default is true
+    attr_writer(:flood_protection)
+    # Number of commands within flood_time before pausing. Default is 10
+    attr_writer(:flood_limit)
+    # Length of time before flood_limit is reset in seconds. Default is 3
+    attr_writer(:flood_time)
+
+    # Initializes Client
+    #
+    #   connect('voice.domain.com', 88888)
+    def initialize(host = 'localhost', port = 10011)
+      connect(host, port)
+
+      # Throttle commands by default unless connected to localhost
+      @flood_protection = true unless host
+      @flood_limit = 10
+      @flood_time = 3
+
+      @flood_timer = Time.new
+      @flood_current = 0
+    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 = '')
+      if @flood_protection
+        @flood_current += 1
+
+        flood_time_reached = Time.now - @flood_timer < @flood_time
+        flood_limit_reached = @flood_current == @flood_limit
+
+        if flood_time_reached && flood_limit_reached
+          sleep(@flood_time)
+        end
+
+        if flood_limit_reached
+          # Reset flood protection
+          @flood_timer = Time.now
+          @flood_current = 0
+        end
+      end
+
+      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('=', 2)
+
+          data[value[0]] = decode_param(value[1])
+        end
+
+        out.push(data)
+      end
+
+      check_response_error(out)
+
+      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')
+
+      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')
+
+      param
+    end
+
+    def check_response_error(response)
+      id = response.first['id'] || 0
+      message = response.first['msg'] || 0
+
+      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

@@ -1,18 +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
+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

@@ -1,3 +1,3 @@
-module Teamspeak
-  VERSION = '1.0.2'
-end
+module Teamspeak
+  VERSION = '1.0.3'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: teamspeak-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.3
 platform: ruby
 authors:
 - Justin Harrison
@@ -16,10 +16,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/teamspeak-ruby.rb
 - lib/teamspeak-ruby/client.rb
 - lib/teamspeak-ruby/exceptions.rb
 - lib/teamspeak-ruby/version.rb
-- lib/teamspeak-ruby.rb
 homepage: http://pyrohail.com
 licenses:
 - MIT
@@ -40,7 +40,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby interface for TeamSpeak 3's server query api.