ts3query 0.1

data/Gemfile

@@ -0,0 +1,8 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "rspec", "~> 2.10.0"
+  gem "rdoc", "~> 3.12"
+  gem "cucumber", "~> 1.2.0"
+  gem "jeweler", "~> 1.8.3"
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 TnT Web Solutions GbR
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.rdoc

@@ -0,0 +1,47 @@
+= TS3Query
+
+== Install
+
+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"
+
+This will raise an +ConnectionRefused+ error, if the server does not response or the data 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
+  end
+
+== 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.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 TnT Web Solutions GbR. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $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 = "http://github.com/tbraun89/TS3Query"
+  gem.license = "MIT"
+  gem.summary = %Q{TODO: one-line summary of your gem}
+  gem.description = %Q{TODO: longer description of your gem}
+  gem.email = "tbraun@stud.hs-heilbronn.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|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "TS3Query #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/features/connect_to_server.feature

@@ -0,0 +1,19 @@
+Feature: Connect with a teamspeak server
+	In order to connect to the server
+	As an application
+	I want to establish a connection and check the server version
+	
+	Scenario: Establish a connection
+		Given I have the server address 127.0.0.1 and the query port 10011
+		When I enter the username serveradmin with the password 0L8awVFD
+		Then I should get a connection with valid response
+
+	Scenario: Try to establish a connection with wrong server data
+		Given I have the server address 127.0.0.1 and the query port 11100
+		When I enter the username serveradmin with the password 0L8awVFD
+		Then I should get a connection refused error: server not available
+		
+	Scenario: Try to establish a connection with wrong user data
+		Given I have the server address 127.0.0.1 and the query port 10011
+		When I enter the username serveradmin with the password 903jsdp
+		Then I should get a connection refused error: wrong user data

data/features/run_command.feature

@@ -0,0 +1,14 @@
+Feature: Run a query command
+	In order to run a command
+	As an application
+	I want to use a method after connection to the server
+	
+	Scenario: Run 'version' command
+		Given I am connected to the default server with the password 0L8awVFD
+		When I run the command version
+		Then I should get a hash with version=3.0.5 build=1335156372 platform=Linux id=0 msg=ok
+		
+	Scenario: Run 'serverlist' command with options
+		Given I am connected to the default server with the password 0L8awVFD
+		When I run the command serverlist with the options -uid -short
+		Then I should get a hash with virtualserver_id=1 virtualserver_port=9987 virtualserver_status=online id=0 msg=ok

data/features/step_definitions/connection_steps.rb

@@ -0,0 +1,30 @@
+Given /^I have the server address (.+) and the query port (.+)$/ do |address, port|
+  @address = address
+  @port    = port
+end
+
+When /^I enter the username (.+) with the password (.+)$/ do |username, password|
+  @username = username
+  @password = password
+end
+
+Then /^I should get a connection with valid response$/ do
+  expect {
+    @query = TS3Query.connect :address  => @address,
+                              :port     => @port,
+                              :username => @username,
+                              :password => @password
+                             
+    @query.should be_kind_of(TS3Connection)
+    @query.disconnect
+  }.should_not raise_error
+end
+
+Then /^I should get a connection refused error: (.+)$/ do |error_msg|
+  expect {
+    @query = TS3Query.connect :address  => @address,
+                              :port     => @port,
+                              :username => @username,
+                              :password => @password
+  }.should raise_error(ConnectionRefused) { |error| error.message.should == error_msg }
+end

data/features/step_definitions/run_command_steps.rb

@@ -0,0 +1,26 @@
+Given /^I am connected to the default server with the password (.+)$/ do |password|
+  @query = TS3Query.connect :password => password
+end
+
+When /^I run the command version$/ do
+  @result = @query.version()
+end
+
+When /^I run the command serverlist with the options (.+)$/ do |options|
+  options = options.split(" ")
+  @result = @query.serverlist do |opt|
+    options.each do |current|
+      current[0] = ""
+      opt.send(current)
+    end
+  end
+end
+
+Then /^I should get a hash with (.+)$/ do |data|
+  hash = {}
+  data.split(" ").each do |entity|
+    hash[entity.split("=")[0]] = entity.split("=")[1]
+  end
+
+  @result.should eq(hash)
+end

data/features/support/env.rb

@@ -0,0 +1,13 @@
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'TS3Query'
+
+require 'rspec/expectations'

data/init.rb

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

data/lib/TS3Query.rb

@@ -0,0 +1,15 @@
+require 'ts3query/ts3_connection'
+
+module TS3Query
+  
+  def self.connect(params = {})
+    params = {
+      :address  => "127.0.0.1",
+      :port     => "10011",
+      :username => "serveradmin"
+    }.merge(params)
+    
+    TS3Connection.new params
+  end
+  
+end

data/lib/ts3query/ts3_connection.rb

@@ -0,0 +1,69 @@
+require 'net/telnet'
+
+class TS3Connection
+  def initialize(params)
+    connect(params)
+  end
+  
+  def disconnect
+    @connection.close
+  end
+  
+  def method_missing(meth, *args, &block)
+    result  = {}
+    options = ""
+    
+    if block
+      query_options = QueryOptions.new
+      yield query_options
+      
+      query_options.options.each do |opt|
+        options += " -#{opt}"
+      end
+    end
+    
+    @connection.cmd("String" => "#{meth}#{options}\r",
+                    "Match" => /error id=0 msg=ok\n/) { |data| 
+      data.split(" ").each do |entity|
+        result[entity.split("=")[0]] = entity.split("=")[1]
+      end
+      result.delete("error")              
+    }
+    result
+  end
+  
+  private
+  
+  def connect(params) 
+    begin
+      @connection = Net::Telnet::new("Host" => params[:address], "Port" => params[:port])
+      @connection.waitfor(/TS3\n(.*)\n/)
+    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/)
+    rescue
+      raise ConnectionRefused, "wrong user data"
+    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

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: ts3query
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- TnT Web Solutions
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-16 00:00:00.000000000 Z
+dependencies: []
+description: Simple TS3 Query Library to connect to the query port of a teamspeak
+  3 server.
+email: support@tnt-web-solutions.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ts3query/ts3_connection.rb
+- lib/TS3Query.rb
+- features/run_command.feature
+- features/support/env.rb
+- features/step_definitions/run_command_steps.rb
+- features/step_definitions/connection_steps.rb
+- features/connect_to_server.feature
+- README.rdoc
+- Rakefile
+- Gemfile
+- LICENSE.txt
+- init.rb
+homepage: https://github.com/tntwebsolutions/ts3query
+licenses: []
+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.22
+signing_key: 
+specification_version: 3
+summary: Simple TS3 Query Library.
+test_files: []