teamspeak-ruby 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f5293306a7bf6d98ffcd5bd9b7147d8d336636d1
-  data.tar.gz: 4f587d29775bd5d368c85529f965d3785da38049
+  metadata.gz: a9cecd16ae10abd107bf8f9b49cc9bc46c9412f2
+  data.tar.gz: 80bf427a1277df9993d68ab8003f532199378a05
 SHA512:
-  metadata.gz: c9ce3a70837d0945f47ac485386ad64ccc0a125705871b0bcac7ebf44775fa52b68082bd4be7c2a18efc11567d27156718dbba035c37a890f0b175752ae2be30
-  data.tar.gz: a1c1aed6910489fd9fab73ba9f9fbc32c407cf71bdd1d72182fdac4ef70870da0d82a72312fb8a6292c71f8c3c43fc150191b6faa1611f02f4d289bfacde3bed
+  metadata.gz: 02c93f35ad458f72604b2df92adc9974be475e7b90b5887e3744ed68d1e9eff453e1d8ff722aedf10ee8cf45a0b199526c9a5beca8f3a1472af7f07b80a34581
+  data.tar.gz: 12bd82d09e6238b37559d3e3733964e1973885e7cf39b3376112d601f19a784b989380244ec152e14d168f56657b7dfbce55b3ed60bf6101514727b003a92475

data/lib/teamspeak-ruby/client.rb

@@ -9,10 +9,25 @@ module Teamspeak
     # Length of time before flood_limit is reset in seconds. Default is 3
     attr_writer(:flood_time)
 
+    # First is escaped char, second is real char.
+    SPECIAL_CHARS = [
+      ['\\\\', '\\'],
+      ['\\/', '/'],
+      ['\\s', ' '],
+      ['\\p', '|'],
+      ['\\a', '\a'],
+      ['\\b', '\b'],
+      ['\\f', '\f'],
+      ['\\n', '\n'],
+      ['\\r', '\r'],
+      ['\\t', '\t'],
+      ['\\v', '\v']
+    ].freeze
+
     # Initializes Client
     #
     #   connect('voice.domain.com', 88888)
-    def initialize(host = 'localhost', port = 10011)
+    def initialize(host = 'localhost', port = 10_011)
       connect(host, port)
 
       # Throttle commands by default unless connected to localhost
@@ -27,12 +42,13 @@ module Teamspeak
     # Connects to a TeamSpeak 3 server
     #
     #   connect('voice.domain.com', 88888)
-    def connect(host = 'localhost', port = 10011)
+    def connect(host = 'localhost', port = 10_011)
       @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.'
+        msg = 'Server is not responding as a normal TeamSpeak 3 server.'
+        raise InvalidServer, msg
       end
 
       # Remove useless text from the buffer.
@@ -49,9 +65,9 @@ module Teamspeak
     #
     #   login('serveradmin', 'H8YlK1f9')
     def login(user, pass)
-      command('login', {'client_login_name' => user, 'client_login_password' => 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')
@@ -72,32 +88,30 @@ module Teamspeak
       @sock.puts out
 
       if cmd == 'servernotifyregister'
-        2.times {response += @sock.gets}
+        2.times { response += @sock.gets }
         return parse_response(response)
       end
 
-      while true
+      loop do
         response += @sock.gets
-        
-        if response.index(' msg=')
-          break
-        end
+
+        break if response.index(' msg=')
       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'
-      ]
+      should_be_array = %w(
+        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 permfind
+      )
 
       parsed_response = parse_response(response)
 
-      return should_be_array.include?(cmd) ? parsed_response : parsed_response.first
+      should_be_array.include?(cmd) ? parsed_response : parsed_response.first
     end
 
     def parse_response(response)
@@ -106,8 +120,8 @@ module Teamspeak
       response.split('|').each do |key|
         data = {}
 
-        key.split(' ').each do |key|
-          value = key.split('=', 2)
+        key.split(' ').each do |inner_key|
+          value = inner_key.split('=', 2)
 
           data[value[0]] = decode_param(value[1])
         end
@@ -125,33 +139,17 @@ module Teamspeak
       # 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')
+      SPECIAL_CHARS.each do |pair|
+        param.gsub!(pair[0], pair[1])
+      end
 
       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')
+      SPECIAL_CHARS.each do |pair|
+        param.gsub!(pair[1], pair[0])
+      end
 
       param
     end
@@ -170,9 +168,7 @@ module Teamspeak
         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
+        sleep(@flood_time) if flood_time_reached && flood_limit_reached
 
         if flood_limit_reached
           # Reset flood protection
@@ -183,8 +179,8 @@ module Teamspeak
     end
 
     private(
-        :parse_response, :decode_param, :encode_param,
-        :check_response_error, :flood_control
+      :parse_response, :decode_param, :encode_param,
+      :check_response_error, :flood_control
     )
   end
 end

data/lib/teamspeak-ruby/exceptions.rb

@@ -1,7 +1,9 @@
 module Teamspeak
-  # Raised when the connected server does not respond as a normal TeamSpeak 3 would.
+  # 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.'
+  # msg = 'Server is not responding as a normal TeamSpeak 3 server.'
+  # raise InvalidServer, msg
   class InvalidServer < StandardError; end
 
   # Raised when the server returns an error code other than 0.

data/lib/teamspeak-ruby/version.rb

@@ -1,3 +1,3 @@
 module Teamspeak
-  VERSION = '1.0.5'
+  VERSION = '1.0.6'.freeze
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: teamspeak-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.0.6
 platform: ruby
 authors:
 - Justin Harrison
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-01 00:00:00.000000000 Z
-dependencies: []
+date: 2016-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.8'
 description: 
 email: justin@pyrohail.com
 executables: []
@@ -40,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Ruby interface for TeamSpeak 3's server query api.