ts3query 0.5 → 0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7563f7b294f500b54f47fbde092f70394211170c
+  data.tar.gz: 038562ba7964c61dcde6126454a86f2d40ea06cc
+SHA512:
+  metadata.gz: 031dcdc6b422a648c5f2dd4f09f6ed40f5c5bf1b9be3786d5dcc78beab5393ce390e8ebf67cfb2b7a692cf882cab663b7a8018805e6e4bcada674de12058e17b
+  data.tar.gz: 383df37aefab71c19bdecb82b3399ec263a184641faec6d6fb48e99242f1bf11cd17b9091a8a7c00c18d3269781e068cd80b8a45b437ba5ff083793ea91fee01

data/README.rdoc

@@ -5,39 +5,44 @@
 In <b>Rails 3</b>, add this to your Gemfile and run the +bundle+ command.
 
   gem "ts3query"
-  
+
 == Getting Started
 
 === Connecting to a Teamspeak 3 Server
 
-  @query = TS3Query.connect :address  => "your-address.com" # default => 127.0.0.1
-                            :port     => 1234               # default => 10011
-                            :username => "myqueryuser"      # default => serveradmin
-                            :password => "myquerypassword"
+  @query = TS3Query.server_connect :address  => "your-address.com" # default => 127.0.0.1
+                                   :port     => 1234               # default => 10011
+                                   :username => "myqueryuser"      # default => serveradmin
+                                   :password => "myquerypassword"
+
+=== Connecting to a Teamspeak 3 Client (via ClientQuery plugin)
 
-This will raise an +ConnectionRefused+ error, if the server does not response or the data are wrong.
+  @query = TS3Query.client_connect :address  => "your-address.com" # default => 127.0.0.1
+                                   :port     => 1234               # default => 25639
+
+This will raise an +ConnectionRefused+ error, if the client does not respond or the credentials are wrong.
 
 === Executing query commands
 
 This retuns a result hash with all server informations.
-  
+
   result = @query.version()
-  
+
 This will return a hash with the serverlist. (Options -uid and -short)
 
   result = @query.serverlist do |opt|
-  	opt.uid
-  	opt.short
+    opt.uid
+    opt.short
   end
 
 This will select the first server. (Parameters sid=1)
 
   @query.use :sid => 1
-  
+
 You can also combine parameters and options.
 
   @query.use :sid => 1 do |opt|
-  	opt.virtual
+    opt.virtual
   end
 
 === Close the connection
@@ -45,13 +50,13 @@ You can also combine parameters and options.
 If you don't need the query connection any longer you should close it.
 
   @query.disconnect
-  
+
 === Query commands
 
 For a full command reference you can download the {Teamspeak 3 Query Manuel}[http://media.teamspeak.com/ts3_literature/TeamSpeak%203%20Server%20Query%20Manual.pdf].
 
 == Contributing to TS3Query
- 
+
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
 * Fork the project.

data/lib/ts3query.rb

@@ -1,15 +1,30 @@
-require 'ts3query/ts3_connection'
+require 'ts3query/server_connection'
+require 'ts3query/client_connection'
 
 module TS3Query
-  
+
+  DefaultServerParams = {
+    :address  => "127.0.0.1",
+    :port     => "10011",
+    :username => "serveradmin"
+  }
+
+  DefaultClientParams = {
+    :address  => "127.0.0.1",
+    :port     => "25639"
+  }
+
   def self.connect(params = {})
-    params = {
-      :address  => "127.0.0.1",
-      :port     => "10011",
-      :username => "serveradmin"
-    }.merge(params)
-    
-    TS3Connection.new 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)
+  end
+
+  def self.client_connect(params = {})
+    ClientConnection.new DefaultClientParams.merge(params)
   end
-  
-end
+
+end

data/lib/ts3query/client_connection.rb

@@ -0,0 +1,17 @@
+require 'ts3query/ts3_connection'
+
+module TS3Query
+  class ClientConnection < TS3Connection
+    private
+
+    def connect(params)
+      begin
+        @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"
+      end
+    end
+  end
+end

data/lib/ts3query/errors.rb

@@ -0,0 +1,3 @@
+module TS3Query
+  class ConnectionRefused < StandardError; end
+end

data/lib/ts3query/query_options.rb

@@ -0,0 +1,13 @@
+module TS3Query
+  class QueryOptions
+    attr_reader :options
+
+    def initialize
+      @options = []
+    end
+
+    def method_missing(meth, *args, &block)
+      options << meth.to_s
+    end
+  end
+end

data/lib/ts3query/server_connection.rb

@@ -0,0 +1,25 @@
+require 'ts3query/ts3_connection'
+
+module TS3Query
+  class ServerConnection < TS3Connection
+    private
+
+    def connect(params)
+      begin
+        @connection = Net::Telnet::new("Host" => params[:address], "Port" => params[:port])
+        @connection.waitfor("Match"   => /TS3\n(.*)\n/,
+                            "Timeout" => 3)
+      rescue
+        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)
+      rescue
+        raise ConnectionRefused, "wrong user data"
+      end
+    end
+  end
+end

data/lib/ts3query/ts3_connection.rb

@@ -1,88 +1,57 @@
 require 'net/telnet'
+require 'ts3query/errors'
+require 'ts3query/query_options'
 
-class TS3Connection
-  def initialize(params)
-    connect(params)
-  end
-
-  def disconnect
-    @connection.close
-  end
+module TS3Query
+  class TS3Connection
+    def initialize(params)
+      connect(params)
+    end
 
-  def method_missing(meth, *args, &block)
-    result  = []
-    options = ""
-    params  = ""
+    def disconnect
+      @connection.close
+    end
 
-    if block
-      query_options = QueryOptions.new
-      yield query_options
+    def method_missing(meth, *args, &block)
+      result  = []
+      options = ""
+      params  = ""
 
-      query_options.options.each do |opt|
-        options += " -#{opt}"
-      end
-    end
+      if block
+        query_options = QueryOptions.new
+        yield query_options
 
-    if args.first
-      args.first.each do |key, value|
-        params += " #{key}=#{value}"
+        query_options.options.each do |opt|
+          options += " -#{opt}"
+        end
       end
-    end
 
-    @connection.cmd("String"  => "#{meth}#{params}#{options}\r",
-                    "Match"   => /error id=0 msg=ok\n/,
-                    "Timeout" => 3) { |data|
-      data.split("|").each do |current|
-        current_data = {}
-        current.split(" ").each do |entity|
-          current_data[entity.split("=")[0]] = entity.split("=")[1]
+      if args.first
+        args.first.each do |key, value|
+          params += " #{key}=#{value}"
         end
-        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
-
-  private
 
-  def connect(params)
-    begin
-      @connection = Net::Telnet::new("Host" => params[:address], "Port" => params[:port])
-      @connection.waitfor("Match"   => /TS3\n(.*)\n/,
-                          "Timeout" => 3)
-    rescue
-      raise ConnectionRefused, "server not available"
-    end
-
-    begin
-      @connection.cmd("String"  => "login client_login_name=#{params[:username]} client_login_password=#{params[:password]}\r",
+      @connection.cmd("String"  => "#{meth}#{params}#{options}\r",
                       "Match"   => /error id=0 msg=ok\n/,
-                      "Timeout" => 3)
-    rescue
-      raise ConnectionRefused, "wrong user data"
+                      "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
+        end
+      }
+      result << {"id" => "0", "msg" => "ok"}
+      result.delete({})
+      result
     end
   end
 end
-
-class QueryOptions
-  def initialize
-    @options = []
-  end
-
-  def method_missing(meth, *args, &block)
-    options << meth.to_s
-  end
-
-  def options
-    @options
-  end
-end
-
-class ConnectionRefused < StandardError
-end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ts3query
 version: !ruby/object:Gem::Version
-  version: '0.5'
-  prerelease: 
+  version: '0.6'
 platform: ruby
 authors:
 - TnT Web Solutions
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-29 00:00:00.000000000 Z
+date: 2014-09-11 00:00:00.000000000 Z
 dependencies: []
 description: Simple TS3 Query Library to connect to the query port of a teamspeak
   3 server.
@@ -18,40 +17,43 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/ts3query/ts3_connection.rb
-- lib/ts3query.rb
-- features/connect_to_server.feature
-- features/run_command.feature
-- features/support/env.rb
-- features/step_definitions/run_command_steps.rb
-- features/step_definitions/connection_steps.rb
 - Gemfile
-- Rakefile
 - LICENSE.txt
 - README.rdoc
+- Rakefile
+- features/connect_to_server.feature
+- features/run_command.feature
+- 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/query_options.rb
+- lib/ts3query/server_connection.rb
+- lib/ts3query/ts3_connection.rb
 homepage: https://github.com/tntwebsolutions/ts3query
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Simple TS3 Query Library.
 test_files: []