teeworlds 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61cf94210fcf13237887b3c092453ff844712ad7
+  data.tar.gz: 73a08040c3a9d38aaf5e7ddbd01442a6cb3587bf
+SHA512:
+  metadata.gz: a52ce1dc1bb6b94bf1ec0e33d0f54dc87c30cd1a40fccf4dedca6bd45f96885fbd490a8cea938cb3f46751569105b5ce512c80bd26598c3915345a4112bbf232
+  data.tar.gz: 7ce80764ea4bcbb11cfcfab309edb4263367b6438cd371b43d419e53832b08a41c019dc46ffc815aef5172e33834213d37cf3cb72e9c89d0cc54ba2f8d0aa252

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+m.rb
+*.swp
+*~
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in teeworlds.gemspec
+gemspec

data/README.md

@@ -0,0 +1,44 @@
+# Teeworlds
+
+Teeworlds is a multiplayer shooter. This gem allows you to fetch all available game servers and view current status of each.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'teeworlds'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install teeworlds
+
+## Usage
+
+    ms = Teeworlds::MasterServer.new
+
+    ms.servers.each do |tw|
+      puts "#{tw.server}: #{tw.port}"
+    end
+
+    s = ms.servers.first
+    s.connect
+
+    puts "Server name: #{s.name}, map: #{s.map}, type: #{s.gametype}"
+    puts "Num clients: #{s.num_clients}"
+    puts "Max clients: #{s.max_clients}"
+    puts "Num player: #{s.num_players}"
+    puts "Max player: #{s.max_players}"
+
+    s.players.each { |player| puts player }
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+task :default => :spec
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = %w(-fp --color)
+end

data/lib/teeworlds.rb

@@ -0,0 +1,9 @@
+require 'socket'
+require 'timeout'
+
+module Teeworlds
+end
+
+require 'teeworlds/version'
+require 'teeworlds/masterserver'
+require 'teeworlds/server'

data/lib/teeworlds/masterserver.rb

@@ -0,0 +1,33 @@
+module Teeworlds
+  class MasterServer
+    attr_reader :servers
+
+    def initialize
+      @servers = []
+
+      1.upto(4) do |num|
+        connect_and_request("master#{num}.teeworlds.com", 8300)
+      end
+    end
+
+    private
+    def connect_and_request(server, port)
+      udp = UDPSocket.new
+      udp.connect(server, port)
+      udp.send "\x20\x00\x00\x00\x00\x00\xff\xff\xff\xff\x72\x65\x71\x32", 0
+
+      Timeout.timeout(1) do
+        loop { parse_servers udp.recvfrom(1400).first }
+      end
+    rescue SocketError, Errno::ECONNREFUSED, Timeout::Error
+      udp.close
+    end
+
+    def parse_servers(servers_raw)
+      servers_raw.bytes.to_a[14..-1].each_slice(18) do |s|
+        sp = s.pack('C*').unpack('@12C4n')
+        @servers.push Teeworlds::Server.new(server: sp[0..3].join('.'), port: sp.last)
+      end
+    end
+  end
+end

data/lib/teeworlds/server.rb

@@ -0,0 +1,44 @@
+module Teeworlds
+  class Server
+    METHODS = [:version, :name, :map, :gametype, :flags, :num_players, :max_players, :num_clients, :max_clients]
+    attr_reader :server, :port, :players
+
+    def initialize(arg)
+      @server = arg[:server]
+      @port = arg[:port] || 8303
+      @players = []
+    end
+
+    def connect
+      Timeout.timeout(1) do
+        udp = UDPSocket.new
+        udp.connect(@server, @port)
+        udp.send("\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\x67\x69\x65\x33\x00", 0)
+        create_methods udp.recvfrom(1024).first.split("\x00")[1..-1]
+      end
+    end
+
+    private
+    def create_methods(recv)
+      self.class.class_eval do
+        (0...METHODS.size).each do |num|
+          define_method(METHODS[num]) { recv[num] }
+        end
+      end
+
+      parse_players(recv)
+    end
+
+    def parse_players(recv)
+      recv[9..-1].each_slice(5) do |player|
+        @players.push(
+          name: player[0],
+          clan: (player[1].empty?) ? nil : player[1],
+          country: (player[2] == '-1') ? nil : player[2].to_i,
+          score: player[3].to_i,
+          playing?: (player[4] == '1') ? true : false
+        )
+      end
+    end
+  end
+end

data/lib/teeworlds/version.rb

@@ -0,0 +1,3 @@
+module Teeworlds
+  VERSION = '1.0.2'
+end

data/spec/teeworlds_spec.rb

@@ -0,0 +1,182 @@
+require 'teeworlds'
+
+describe Teeworlds::MasterServer do
+  before do
+    master_5_servers = [File.open('spec/fixtures/master_5_servers', 'r:ASCII-8BIT').read]
+    @socket_mock = mock
+    @socket_mock.should_receive(:connect).exactly(4).times
+    @socket_mock.should_receive(:send).exactly(4).times
+    @socket_mock.should_receive(:recvfrom).and_return(master_5_servers)
+    @socket_mock.should_receive(:recvfrom).at_least(3).times.and_return(['.' * 14])
+    @socket_mock.should_receive(:close).exactly(4).times
+    UDPSocket.stub(new: @socket_mock)
+  end
+
+  describe '.new' do
+    it 'should connect to masterservers 1-4' do
+      Teeworlds::MasterServer.new
+    end
+  end
+
+  describe '#servers' do
+    it 'should be an array of Teeworlds::Server' do
+      Teeworlds::MasterServer.new.servers.each do |server|
+        server.should be_a(Teeworlds::Server)
+      end
+    end
+
+    it 'should return 5 servers' do
+      ms = Teeworlds::MasterServer.new
+
+      [ms.servers[0].server, ms.servers[0].port].should ==  ['88.198.182.255', 9123]
+      [ms.servers[1].server, ms.servers[1].port].should ==  ['109.73.50.121',  9016]
+      [ms.servers[2].server, ms.servers[2].port].should ==  ['46.38.237.106', 8308]
+      [ms.servers[3].server, ms.servers[3].port].should ==  ['188.233.98.250', 8303]
+      [ms.servers[4].server, ms.servers[4].port].should ==  ['217.29.118.189', 8202]
+    end
+  end
+end
+
+describe Teeworlds::Server do
+  context 'when connection failed' do
+    it 'raises Errno::ECONNREFUSED if could not connect to server' do
+      expect { Teeworlds::Server.new(server: '127.0.0.1', port: 6666).connect }.to raise_error(Errno::ECONNREFUSED)
+    end
+  end
+
+  context 'when connection succeeded' do
+    before do
+      server_3_players = [File.open('spec/fixtures/server_3_players', 'r:ASCII-8BIT').read]
+      @socket_mock = mock
+      @socket_mock.should_receive(:send).with("\xff\xff\xff\xff\xff\xff\xff\xff\xff\xff\x67\x69\x65\x33\x00", 0)
+      @socket_mock.should_receive(:recvfrom).and_return(server_3_players)
+      UDPSocket.stub(new: @socket_mock)
+      #UDPSocket.should_receive(:new).and_return(@socket_mock)
+    end
+
+    let(:tw_server) { Teeworlds::Server.new(server: '127.0.0.1', port: 8500) }
+    let(:tw_server_no_port) { Teeworlds::Server.new(server: '127.0.0.1') }
+
+    describe '.new' do
+      it 'should connect to requested server and port' do
+        @socket_mock.should_receive(:connect).with('127.0.0.1', 8500)
+        tw_server.connect
+      end
+
+      it "should connect to default port if none is given" do
+        @socket_mock.should_receive(:connect).with('127.0.0.1', 8303)
+        tw_server_no_port.connect
+      end
+    end
+
+    describe 'instance method' do
+      before do
+        @socket_mock.should_receive(:connect).with('127.0.0.1', 8500)
+        tw_server.connect
+      end
+
+      subject { tw_server }
+
+      describe '#version' do
+        it { should respond_to(:version) }
+        it 'equals "0.6 trunk, 1.14a"' do
+          subject.version.should eql '0.6 trunk, 1.14a'
+        end
+      end
+
+      describe '#name' do
+        it { should respond_to(:name) }
+        it 'equals "FS Server"' do
+          subject.name.should eql 'FS Server'
+        end
+      end
+
+      describe '#map' do
+        it { should respond_to(:map) }
+        it 'equals "xyz_ddrace2"' do
+          subject.map.should eql 'xyz_ddrace2'
+        end
+      end
+
+      describe '#gametype' do
+        it { should respond_to(:gametype) }
+        it 'equals "DDRace"' do
+          subject.gametype.should eql 'DDRace'
+        end
+      end
+
+      describe '#flags' do
+        it { should respond_to(:flags) }
+        it 'equals "0"' do
+          subject.flags.should eql '0'
+        end
+      end
+
+      describe '#num_players' do
+        it { should respond_to(:num_players) }
+        it 'equals "3"' do
+          subject.num_players.should eql '3'
+        end
+      end
+
+      describe '#max_players' do
+        it { should respond_to(:max_players) }
+        it 'equals "15"' do
+          subject.max_players.should eql '15'
+        end
+      end
+
+      describe '#num_clients' do
+        it { should respond_to(:num_clients) }
+        it 'equals "3"' do
+          subject.num_clients.should eql '3'
+        end
+      end
+
+      describe '#max_clients' do
+        it { should respond_to(:max_clients) }
+        it 'equals "15"' do
+          subject.max_clients.should eql '15'
+        end
+      end
+
+      describe '#players' do
+        it { should respond_to(:players) }
+
+        it 'returns an array' do
+          subject.players.should be_an(Array)
+        end
+
+        it 'has 3 elements' do
+          subject.players.should have(3).items
+        end
+
+        it 'is an array of hashes with name, clan, country, score and playing keys' do
+          subject.players[0].should == {
+            name: 'Jules',
+            clan: 'Gangsta',
+            country: 616,
+            score: -9999,
+            playing?: true
+          }
+
+          subject.players[1].should == {
+            name: 'Vincent',
+            clan: 'Gangsta',
+            country: 276,
+            score: -9999,
+            playing?: false
+          }
+
+          subject.players[2].should == {
+            name: 'Butch',
+            clan: 'Boxer',
+            country: nil,
+            score: -9999,
+            playing?: true
+          }
+        end
+      end
+    end
+  end
+end

data/teeworlds.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'teeworlds/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "teeworlds"
+  spec.version       = Teeworlds::VERSION
+  spec.authors       = ["Maciej Borosiewicz"]
+  spec.email         = ["m.borosiewicz@gmail.com"]
+  spec.description   = %q{Teeworlds is a multiplayer shooter. This gem allows you to fetch all available game servers and view current status of each.}
+  spec.summary       = %q{Classes to parse Teeworlds servers.}
+  spec.homepage      = "https://github.com/xmbr/teeworlds"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec", "~> 2.13"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: teeworlds
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Maciej Borosiewicz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Teeworlds is a multiplayer shooter. This gem allows you to fetch all
+  available game servers and view current status of each.
+email:
+- m.borosiewicz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README.md
+- Rakefile
+- lib/teeworlds.rb
+- lib/teeworlds/masterserver.rb
+- lib/teeworlds/server.rb
+- lib/teeworlds/version.rb
+- spec/fixtures/master_5_servers
+- spec/fixtures/server_3_players
+- spec/teeworlds_spec.rb
+- teeworlds.gemspec
+homepage: https://github.com/xmbr/teeworlds
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Classes to parse Teeworlds servers.
+test_files:
+- spec/fixtures/master_5_servers
+- spec/fixtures/server_3_players
+- spec/teeworlds_spec.rb