ts3query 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c3bbd454e9189b317a9e381a5661b136a2094c2
-  data.tar.gz: 69ac94e6cc299eb98b664068590a772f1483b47b
+  metadata.gz: 8ffb041073ad0ffbb8603c59f7032564e9988575
+  data.tar.gz: 0bc3615838b731249dda3c7a81acb6367b46d1cd
 SHA512:
-  metadata.gz: 43409ee196b8bbbb34f4436297c18bf7d22528076652893681cb882dff06b4f000adc4ea734469f01b8576e90de671d8e3f5c13625af3fe977c08d5c63ab292c
-  data.tar.gz: ae4227e4d17c8760a23969bcf3ec89ac0edd204b250db4c8dc900c4377d3b53c8a57d295fb77ef8c0a866b0e01281d3c4c5c0a7c58c2095d7331e8d09c0b37fd
+  metadata.gz: e9615ce48e25e229fd6a88cb86229083f8cc4ace175ad781acacae8f39d507ae217611d48b93233eabb669c5c09a6484bfa7705fa4c9ccca988a06d7d65cc67e
+  data.tar.gz: f3d53ab0f3d84fff85cdae06c3f916087ba52a30ec0be99d675441410e499688802d64c5e0706a887f81a72135484dc7686ddb200321f4ad4a7b4443344fe81b

data/LICENSE.txt

@@ -1,4 +1,6 @@
-Copyright (c) 2012 TnT Web Solutions GbR
+Copyright (c) 2015 TnT Web Solutions GbR
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -73,9 +73,3 @@ If you try to run the tests, you need a local teamspeak server running with this
 * Port:     10011
 * User:     serveradmin
 * Password: 0L8awVFD
-
-== Copyright
-
-Copyright (c) 2012 TnT Web Solutions GbR. See LICENSE.txt for
-further details.
-

data/Rakefile

@@ -6,25 +6,11 @@ begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  $stderr.puts 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 require 'rake'
 
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "TS3Query"
-  gem.homepage = "support@tnt-web-solutions.de"
-  gem.license = "MIT"
-  gem.summary = %Q{Simple TS3 Query Library.}
-  gem.description = %Q{Simple TS3 Query Library to connect to the query port of a teamspeak 3 server.}
-  gem.email = "tbraun@tnt-web-solutions.de"
-  gem.authors = ["Torsten Braun"]
-  # dependencies defined in Gemfile
-end
-Jeweler::RubygemsDotOrgTasks.new
-
 require 'rspec/core'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec) do |spec|
@@ -41,12 +27,13 @@ Cucumber::Rake::Task.new(:features)
 
 task :default => :spec
 
+require 'ts3query/version'
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "TS3Query #{version}"
+  rdoc.title = "TS3Query #{TS3Query::VERSION}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/features/step_definitions/run_command_steps.rb

@@ -8,10 +8,10 @@ When /^I run the command version$/ do
 end
 
 When /^I run the command serverlist with the options (.+)$/ do |options|
-  options = options.split(" ")
+  options = options.split(' ')
   @result = @query.serverlist do |opt|
     options.each do |current|
-      current[0] = ""
+      current[0] = ''
       opt.send(current)
     end
   end
@@ -19,26 +19,26 @@ When /^I run the command serverlist with the options (.+)$/ do |options|
 end
 
 When /^I run the command use with the parameters (.+)$/ do |parameters|
-  parameters = parameters.split(" ")
+  parameters = parameters.split(' ')
   params = {}
   parameters.each do |current|
-    params[current.split("=")[0]] = current.split("=")[1]
+    params[current.split('=')[0]] = current.split('=')[1]
   end
   @result = @query.use params
   @query.disconnect
 end
 
 When /^I run the command use with the options (.+) and the parameters (.+)$/ do |options, parameters|
-  parameters = parameters.split(" ")
+  parameters = parameters.split(' ')
   params = {}
   parameters.each do |current|
-    params[current.split("=")[0]] = current.split("=")[1]
+    params[current.split('=')[0]] = current.split('=')[1]
   end
   
-  options = options.split(" ")
+  options = options.split(' ')
   @result = @query.use params do |opt|
     options.each do |current|
-      current[0] = ""
+      current[0] = ''
       opt.send(current)
     end
   end
@@ -49,16 +49,16 @@ Then /^I should get a hash with (.+)$/ do |data|
   list = []
   hash = {}
   
-  data.split(" ").each do |entity|
-    hash[entity.split("=")[0]] = entity.split("=")[1]
+  data.split(' ').each do |entity|
+    hash[entity.split('=')[0]] = entity.split('=')[1]
   end
   list << hash
-  list << {"id" => "0", "msg" => "ok"}
+  list << {'id' => '0', 'msg' => 'ok'}
 
   @result.should eq(list)
 end
 
 Then /^I should get a hash$/ do
-  list = [{"id" => "0", "msg" => "ok"}]
+  list = [{'id' => '0', 'msg' => 'ok'}]
   @result.should eq(list)
 end

data/features/support/env.rb

@@ -3,7 +3,7 @@ begin
   Bundler.setup(:default, :development)
 rescue Bundler::BundlerError => e
   $stderr.puts e.message
-  $stderr.puts "Run `bundle install` to install missing gems"
+  $stderr.puts 'Run `bundle install` to install missing gems'
   exit e.status_code
 end
 

data/lib/ts3query.rb

@@ -2,29 +2,22 @@ require 'ts3query/server_connection'
 require 'ts3query/client_connection'
 
 module TS3Query
-
-  DefaultServerParams = {
-    :address  => "127.0.0.1",
-    :port     => "10011",
-    :username => "serveradmin"
+  DEFAULT_SERVER_PARAMS = {
+    address:  '127.0.0.1',
+    port:     '10011',
+    username: 'serveradmin'
   }
 
-  DefaultClientParams = {
-    :address  => "127.0.0.1",
-    :port     => "25639"
+  DEFAULT_CLIENT_PARAMS = {
+    address: '127.0.0.1',
+    port:    '25639'
   }
 
-  def self.connect(params = {})
-    warn "DEPRECATED(#{Kernel.caller.first}) use TS3Query.server_connect instead of TS3Query.connect"
-    server_connect params
-  end
-
   def self.server_connect(params = {})
-    ServerConnection.new DefaultServerParams.merge(params)
+    ServerConnection.new(DEFAULT_SERVER_PARAMS.merge(params))
   end
 
   def self.client_connect(params = {})
-    ClientConnection.new DefaultClientParams.merge(params)
+    ClientConnection.new(DEFAULT_CLIENT_PARAMS.merge(params))
   end
-
 end

data/lib/ts3query/client_connection.rb

@@ -6,11 +6,11 @@ module TS3Query
 
     def connect(params)
       begin
-        @connection = Net::Telnet::new("Host" => params[:address], "Port" => params[:port])
-        @connection.waitfor("Match"   => /TS3 Client\n(.*)\n/,
-                            "Timeout" => 3)
+        @connection = Net::Telnet::new('Host' => params[:address], 'Port' => params[:port])
+        @connection.waitfor('Match'   => /TS3 Client\n(.*)\n/,
+                            'Timeout' => 3)
       rescue
-        raise ConnectionRefused, "client not available"
+        raise(ConnectionRefused, 'client not available')
       end
     end
   end

data/lib/ts3query/escaping.rb

@@ -0,0 +1,29 @@
+module TS3Query
+  module Escaping
+    DECODER_PATTERNS = {
+        '\\\\' => '\\',
+        '\/'   => '/',
+        '\s'   => ' ',
+        '\p'   => '|',
+        '\a'   => '\a',
+        '\b'   => '\b',
+        '\f'   => '\f',
+        '\n'   => '\n',
+        '\r'   => '\r',
+        '\t'   => '\t',
+        '\v'   => '\v',
+    }
+
+    ENCODER_PATTERNS = DECODER_PATTERNS.invert
+    DECODER_REGEXP   = /\\[#{Regexp.escape(DECODER_PATTERNS.keys.map{|k| k[1]}.join)}]/
+    ENCODER_REGEXP   = /[#{Regexp.escape(DECODER_PATTERNS.values.join)}]/
+
+    def self.encode(str)
+      str.gsub(ENCODER_REGEXP, ENCODER_PATTERNS)
+    end
+
+    def self.decode(str)
+      str.gsub(DECODER_REGEXP, DECODER_PATTERNS)
+    end
+  end
+end

data/lib/ts3query/server_connection.rb

@@ -6,19 +6,19 @@ module TS3Query
 
     def connect(params)
       begin
-        @connection = Net::Telnet::new("Host" => params[:address], "Port" => params[:port])
-        @connection.waitfor("Match"   => /TS3\n(.*)\n/,
-                            "Timeout" => 3)
+        @connection = Net::Telnet::new('Host' => params[:address], 'Port' => params[:port])
+        @connection.waitfor('Match'   => /TS3\n(.*)\n/,
+                            'Timeout' => 3)
       rescue
-        raise ConnectionRefused, "server not available"
+        raise(ConnectionRefused, 'server not available')
       end
 
       begin
-        @connection.cmd("String"  => "login client_login_name=#{params[:username]} client_login_password=#{params[:password]}\r",
-                        "Match"   => /error id=0 msg=ok\n/,
-                        "Timeout" => 3)
+        @connection.cmd('String'  => "login client_login_name=#{params[:username]} client_login_password=#{params[:password]}\r",
+                        'Match'   => /error id=0 msg=ok\n/,
+                        'Timeout' => 3)
       rescue
-        raise ConnectionRefused, "wrong user data"
+        raise(ConnectionRefused, 'wrong user data')
       end
     end
   end

data/lib/ts3query/ts3_connection.rb

@@ -1,6 +1,8 @@
 require 'net/telnet'
+require 'stringio'
 require 'ts3query/errors'
 require 'ts3query/query_options'
+require 'ts3query/escaping'
 
 module TS3Query
   class TS3Connection
@@ -13,9 +15,10 @@ module TS3Query
     end
 
     def method_missing(meth, *args, &block)
+      buffer  = StringIO.new
       result  = []
-      options = ""
-      params  = ""
+      options = ''
+      params  = ''
 
       if block
         query_options = QueryOptions.new
@@ -28,28 +31,36 @@ module TS3Query
 
       if args.first
         args.first.each do |key, value|
-          params += " #{key}=#{value}"
+          params += " #{key}=#{value.is_a?(String) ? Escaping.encode(value) : value}"
         end
       end
 
-      @connection.cmd("String"  => "#{meth}#{params}#{options}\r",
-                      "Match"   => /error id=0 msg=ok\n/,
-                      "Timeout" => 3) { |data|
-        data.force_encoding 'UTF-8'
-        data.split("|").each do |current|
-          current_data = {}
-          current.split(" ").each do |entity|
-            key, value = entity.split "="
-            current_data[key] = value
-          end
-          current_data.delete("error")
-          current_data.delete("id")
-          current_data.delete("msg")
-
-          result << current_data
+      @connection.cmd('String'  => "#{meth}#{params}#{options}\r",
+                      'Match'   => /error id=0 msg=ok\n/,
+                      'Timeout' => 3) do |data|
+        buffer << data
+      end
+
+      data = buffer.string
+      data.force_encoding 'UTF-8'
+
+      data.split('|').each do |current|
+        current_data = {}
+
+        current.split(' ').each do |entity|
+          key, value        = entity.split '='
+          current_data[key] = value.is_a?(String) ? Escaping.decode(value) : nil
         end
-      }
-      result << {"id" => "0", "msg" => "ok"}
+
+        current_data.delete('error')
+        current_data.delete('id')
+        current_data.delete('msg')
+
+        result << current_data
+      end
+
+      result << {'id' => '0', 'msg' => 'ok'}
+
       result.delete({})
       result
     end

data/lib/ts3query/version.rb

@@ -0,0 +1,3 @@
+module TS3Query
+  VERSION = '0.7.0'
+end

metadata

@@ -1,18 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: ts3query
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - TnT Web Solutions
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-17 00:00:00.000000000 Z
+date: 2015-03-04 00:00:00.000000000 Z
 dependencies: []
-description: Simple TS3 Query Library to connect to the query port of a teamspeak
+description: Simple TS3 Query Library to connect to the query port of a Teamspeak
   3 server.
-email: support@tnt-web-solutions.de
+email: tbraun@tnt-web-solutions.de
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -26,15 +26,17 @@ files:
 - features/step_definitions/connection_steps.rb
 - features/step_definitions/run_command_steps.rb
 - features/support/env.rb
-- init.rb
 - lib/ts3query.rb
 - lib/ts3query/client_connection.rb
 - lib/ts3query/errors.rb
+- lib/ts3query/escaping.rb
 - lib/ts3query/query_options.rb
 - lib/ts3query/server_connection.rb
 - lib/ts3query/ts3_connection.rb
+- lib/ts3query/version.rb
 homepage: https://github.com/tntwebsolutions/ts3query
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []

data/init.rb

@@ -1 +0,0 @@
-require 'ts3query'