steam_hlds_log_parser 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  metadata.gz: 30af9317dcddbf6bebd31d3bb02ff5df117db707
+  data.tar.gz: ab06662bf153b61c2cdab5b9d64209ced673e4e9
+SHA512: 
+  metadata.gz: 774c7685110aca35822f3642a5a93bbca4bd196f6ddad776345938e29a76df62f3f3b72c866898925f64ed0128a064b8046e9581db9553e6eb4719ea200a07aa
+  data.tar.gz: 5b8c66867b180997d6769fbff9f047346a270bddfce355fc842eafe55c3af72df5a4ab0deaf3f21112704609393682cba8e5b064a9c2e97420e7631d10ece3f9

data/.coveralls.yml

@@ -0,0 +1 @@
+repo_token: WVARN24eiGJQ6GenqWAsqNQEZroHGj2SP

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store
+
+

data/.rspec

@@ -0,0 +1,2 @@
+--color 
+--format documentation 

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Thomas VIAL
+
+MIT License
+
+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.md

@@ -0,0 +1,69 @@
+# Steam Hlds Log Parser
+
+Creates a server with EventMachine which listens to HLDS logs, parse and returns readable content from your game server.
+The returned content can be sent to a website, IRC or flowdock for match live streaming.
+
+Mostly tested on Steam HLDS for Counter-Strike.
+
+Note : content is sent in english or french at this time. Need i18n contributors!
+
+## Build Status
+
+[![Build Status](https://travis-ci.org/tomav/steam_hlds_log_parser.png?branch=master)](https://travis-ci.org/tomav/steam_hlds_log_parser)
+[![Gem Version](https://badge.fury.io/rb/steam_hlds_log_parser.png)](http://badge.fury.io/rb/steam_hlds_log_parser)
+[![Coverage Status](https://coveralls.io/repos/tomav/steam_hlds_log_parser/badge.png)](https://coveralls.io/r/tomav/steam_hlds_log_parser)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'steam_hlds_log_parser'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install steam_hlds_log_parser
+
+## Usage
+
+1. Create your own displayer callback `class` which will receive parsed data
+Ask this `class` to write a file, send content to IRC or flowdock... whatever... and give it as `:displayer` Hash option
+2. Create a new client on desired IP / Port / Options
+3. In your HLDS server: `logaddress 127.0.0.1 27035`  
+
+## Example
+
+    require "rubygems"
+    require "steam_hlds_log_parser"
+
+    class Formatter
+      def initialize(data)
+        # will 'puts' the translated content
+        SteamHldsLogParser::Displayer.new(data).display_translation
+      end
+    end
+
+
+    ## These are default options
+    options = {
+      :locale              => :en,
+      :display_kills       => true,
+      :display_actions     => true,
+      :display_changelevel => true,
+      :displayer           => Formatter
+    }
+
+    parser = SteamHldsLogParser::Client.new("127.0.0.1", 27035, options)
+    parser.start
+
+
+## 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,6 @@
+require "rubygems"
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => [:spec]

data/example/example-1.rb

@@ -0,0 +1,22 @@
+require "rubygems"
+require "steam_hlds_log_parser"
+
+class Formatter
+  def initialize(data)
+    # will 'puts' the translated content
+    SteamHldsLogParser::Displayer.new(data).display_translation
+  end
+end
+
+
+## These are default options
+options = {
+  :locale              => :en,
+  :display_kills       => true,
+  :display_actions     => true,
+  :display_changelevel => true,
+  :displayer           => Formatter
+}
+
+parser = SteamHldsLogParser::Client.new("127.0.0.1", 27035, options)
+parser.start

data/example/example-2.rb

@@ -0,0 +1,24 @@
+require "rubygems"
+require "steam_hlds_log_parser"
+# require "flowdock"
+
+## The displayer class that will be used to send content to Flowdock
+class FlowdockPusher
+  def initialize(data)
+    # Get translated data 
+    content = SteamHldsLogParser::Displayer.new(data).get_translation
+    # Source: https://github.com/flowdock/flowdock-api
+    flow = Flowdock::Flow.new(:api_token => "12345678901234567890123456789012", :external_user_name => "HLDS-Live")
+    flow.push_to_chat(:content => content)
+  end
+end
+
+options = {
+  :locale              => :fr,
+  :display_kills       => true,
+  :display_actions     => true,
+  :display_changelevel => true,
+  :displayer           => FlowdockPusher
+}
+
+SteamHldsLogParser::Client.new("127.0.0.1", 27035, options).start

data/lib/locales/en.yml

@@ -0,0 +1,42 @@
+en:
+  # client
+  client_connect: "HLDS connected and sending data"
+  client_disconnect: "HLDS disconnected? No data is received."
+  client_stop: "HLDS Log Parser stopped."
+  # team
+  full_team_name_te: "Terrorist"
+  full_team_name_ct: "Counter-Terrorist"
+  short_team_name_te: "TE"
+  short_team_name_ct: "CT"
+  # round conclusion types
+  all_hostages_rescued: "All hostages have been rescued"
+  bomb_defused: "Bomb has been defused"
+  cts_preventescape: "The CT's have prevented most of the terrorists from escaping"
+  cts_win: "Counter-Terrorists Win"
+  hostages_not_rescued: "Hostages have not been rescued"
+  target_bombed: "Target Successfully Bombed!"
+  target_saved: "Target has been saved"
+  terrorists_escaped: "Terrorists have escaped"
+  terrorists_not_escaped: "Terrorists have not escaped"
+  terrorists_win: "Terrorists Win"
+  vip_assassinated: "The VIP has been assassinated"
+  vip_escaped: "The VIP has escaped"
+  vip_not_escaped: "VIP has not escaped"
+  # user actions
+  begin_bomb_defuse_with_kit: "begin bomb defuse with kit"
+  begin_bomb_defuse_without_kit: "begin bomb defuse without kit"
+  defused_the_bomb: "defused the bomb"
+  dropped_the_bomb: "dropped the bomb"
+  got_the_bomb: "got the bomb"
+  killed_a_hostage: "killed a hostage"
+  planted_the_bomb: "planted the bom"
+  rescued_a_hostage: "rescued a hostage"
+  spawned_with_the_bomb: "spawned with the bomb"
+  touched_a_hostage: "touched a hostage"
+  # events
+  map_ends: "Map ends: %{winner} => %{score}"
+  victory: "[CT] %{score_ct} - %{score_t} [T]"
+  kill: "[%{killer_team}] %{killer} killed [%{killed_team}] %{killed} with %{weapon}"
+  suicide: "%{killed} commited suicide"
+  event: "[%{person_team}] %{person} %{event_i18n}"
+  loading_map: "Loading %{map}"

data/lib/locales/fr.yml

@@ -0,0 +1,42 @@
+fr:
+  # client
+  client_connect: "HLDS vient de se connecter et transmets des données."
+  client_disconnect: "HLDS s'est déconnecté ?"
+  client_stop: "HLDS Log Parser stoppé."
+  # team
+  full_team_name_te: "Terroriste"
+  full_team_name_ct: "Anti-Terroriste"
+  short_team_name_te: "TE"
+  short_team_name_ct: "CT"
+  # round conclusion types
+  all_hostages_rescued: "Tous les otages ont été sauvés"
+  bomb_defused: "La bombe a été désamorçée"
+  cts_preventescape: "Les CT ont empéché l'évasion des Terroristes"
+  cts_win: "Victoire des Anti-Terroristes"
+  hostages_not_rescued: "Les otages n'ont pas été sauvés"
+  target_bombed: "La cible a été détruite !"
+  target_saved: "La cible a été protégée"
+  terrorists_escaped: "Les Terroristes se sont échappés"
+  terrorists_not_escaped: "Les Terroristes ne se sont pas échappés"
+  terrorists_win: "Victoire des Terroristes"
+  vip_assassinated: "Le VIP a été assassiné"
+  vip_escaped: "Le VIP s'est échappé"
+  vip_not_escaped: "Le VIP ne s'est pas échappé"
+  # user actions
+  begin_bomb_defuse_with_kit: "commence à désamorcer la bombe avec un kit"
+  begin_bomb_defuse_without_kit: "commence à désamorcer la bombe sans kit"
+  defused_the_bomb: "a désamorcé la bombe"
+  dropped_the_bomb: "a perdu la bombe"
+  got_the_bomb: "a récupéré la bombe"
+  killed_a_hostage: "a tué un otage"
+  planted_the_bomb: "a posé la bombe"
+  rescued_a_hostage: "a sauvé un otage"
+  spawned_with_the_bomb: "a la bombe"
+  touched_a_hostage: "a récupéré un otage"
+  # events
+  map_ends: "Fin de partie : Score des %{winner} => %{score}"
+  victory: "[CT] %{score_ct} - %{score_t} [TE]"
+  kill: "[%{killer_team}] %{killer} a tué [%{killed_team}] %{killed} au %{weapon}"
+  suicide: "%{killed} s'est tué"
+  event: "[%{person_team}] %{person} %{event_i18n}"
+  loading_map: "Chargement de %{map}"

data/lib/steam_hlds_log_parser/client.rb

@@ -0,0 +1,52 @@
+module SteamHldsLogParser
+
+  class Client
+
+    attr_reader :host, :port, :options
+
+    # Creates a new client 
+    #
+    # @host [String] Hostname / IP Address the server will be running
+    # @port [Integer] Port to listen to
+    # @options [Hash] Other options
+    #
+    # ==== Options
+    #
+    # * +locale+ - Set the language of returned content
+    # * +display_kills+ Enable kills / frags detail (default=true)
+    # * +display_actions+ Enable players actions / defuse / ... detail (default=true)
+    # * +display_changelevel+ Enable changelevel (map) display (default=true)
+    # * +displayer+ Class that will be use to display content (default=HldsReturnDisplayer)
+    #
+    def initialize(host, port, options = {})
+      default_options = {
+        :locale              => :en,
+        :display_kills       => true,
+        :display_actions     => true,
+        :display_changelevel => true
+      }
+      @host, @port  = host, port
+      @options      = default_options.merge(options)
+     end
+
+     # Starts the client which will receive HLDS logs (using UDP)
+     def start
+      # setting locale
+      I18n.locale = @options[:locale] || I18n.default_locale
+      EM.run {
+        # catch CTRL+C
+        Signal.trap("INT")  { EM.stop }
+        Signal.trap("TERM") { EM.stop }
+        # Let's start
+        EM::open_datagram_socket(@host, @port, Handler, @host, @port, @options)
+      }       
+     end
+
+     # Stops the client
+     def stop
+       puts "## #{@host}:#{@port} => #{I18n.t('client_stop')}"
+       EM::stop_event_loop
+     end
+
+  end
+end

data/lib/steam_hlds_log_parser/displayer.rb

@@ -0,0 +1,37 @@
+module SteamHldsLogParser
+
+  # Default Displayer
+  #
+  #  @data [Hash] Data returned by 'receive_data'
+  #
+  class Displayer
+
+    attr_reader :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    # Return data
+    def get_data
+      return @data 
+    end
+
+    # Display data
+    def display_data
+      puts get_data
+    end
+
+    # Return data translation
+    def get_translation
+      return I18n.t(@data[:type], @data[:params]) unless @data[:type].nil?
+    end
+
+    # Display data translation
+    def display_translation
+      puts get_translation
+    end
+
+  end
+
+end

data/lib/steam_hlds_log_parser/handler.rb

@@ -0,0 +1,103 @@
+module SteamHldsLogParser
+
+  class Handler < EM::Connection
+
+    attr_reader :host, :port, :options
+
+    # Initialize Handler from Client options
+    #
+    # @host [String] Hostname / IP Address the server will be running
+    # @port [Integer] Port to listen to
+    # @options [Hash] Other options
+    #
+    def initialize(host, port, options)
+      @host, @port, @options = host, port, options
+    end
+
+    # Triggered when HLDS connects
+    def post_init
+      puts "## #{@host}:#{@port} => #{I18n.t('client_connect')}"
+    end
+
+    # Triggered when HLDS disconnects
+    def unbind
+      puts "## #{@host}:#{@port} => #{I18n.t('client_disconnect')}" 
+    end
+
+    # Get data from Client and parse using Regexp
+    #
+    # * match end of map, with winner team and score
+    # * match the end of round, with score and victory type
+    # * match who killed who with what (frags)
+    # * match suicides
+    # * match who did what (defuse, drop the bomb...)
+    # * match changelevel
+    #
+    # @data [String] Data received by Client from HLDS server (a line of log)
+    #
+    def receive_data(data)
+
+      # L 05/10/2000 - 12:34:56: Team "CT" scored "17" with "0" players
+      if data.gsub(/Team "(.+)" scored "(\d+)" with "(\d+)"/).count > 0
+        winner, winner_score = data.match(/Team "(.+)" scored "(\d+)" with/).captures
+        content = { :type => 'map_ends', :params => { :winner => get_short_team_name(winner), :score => winner_score } } 
+
+      # L 05/10/2000 - 12:34:56: Team "CT" triggered "CTs_Win" (CT "3") (T "0")
+      elsif data.gsub(/(: Team ")/).count > 0
+        winner, type, score_ct, score_t = data.match(/Team "([A-Z]+)" triggered "([A-Za-z_]+)" \(CT "(\d+)"\) \(T "(\d+)"\)/i).captures
+        content = { :type => 'victory', :params => { :score_ct => score_ct, :score_t => score_t } }
+
+      # L 05/10/2000 - 12:34:56: "Killer | Player<66><STEAM_ID_LAN><TERRORIST>" killed "Killed | Player<60><STEAM_ID_LAN><CT>" with "ak47"
+      elsif @options[:display_kills] && data.gsub(/(\>" killed ")/).count > 0
+        killer, killer_team, killed, killed_team, weapon = data.match(/"(.+)<\d+><STEAM_ID_LAN><(.+)>" killed "(.+)<\d+><STEAM_ID_LAN><(.+)>" with "(.+)"/i).captures
+        content = { :type => 'kill', :params => { :killer_team => get_short_team_name(killer_team), :killer => killer, :killed_team => get_short_team_name(killed_team), :killed => killed, :weapon => weapon } }
+
+      # L 05/10/2000 - 12:34:56: "Player<66><STEAM_ID_LAN><TERRORIST>" committed suicide with "worldspawn" (world)
+      elsif @options[:display_kills] && data.gsub(/>" committed suicide/).count > 0
+        killed = data.match(/: "(.+)<\d+>/).captures.first
+        content = { :type => 'suicide', :params => { :killed => killed } }
+
+      # L 05/10/2000 - 12:34:56: "Killer | Player<66><STEAM_ID_LAN><CT>" triggered "Defused_The_Bomb"
+      elsif @options[:display_actions] && data.gsub(/<STEAM_ID_LAN><.+>" triggered "(.+)"$/).count > 0
+        person, person_team, event = data.match(/: "(.+)<\d+><STEAM_ID_LAN><(.+)>" triggered "(.+)"/i).captures
+        content = { :type => 'event', :params => { :person_team => get_short_team_name(person_team), :person => person, :event_item => event, :event_i18n => I18n.t(event.downcase)} }
+
+      # L 05/10/2000 - 12:34:56: Loading map "de_dust2"
+      elsif @options[:display_changelevel] && data.gsub(/: Loading map "(.+)"/).count > 0
+        map = data.match(/: Loading map "(.+)"/i).captures.first
+        content = { :type => 'loading_map', :params => { :map => map } }
+
+      end
+
+      if @options[:displayer].nil?; return(content) else @options[:displayer].new(content) end
+
+    end
+
+    # Format team name with long format (textual)
+    #
+    # @winner [String] Round winner (+CT+ or +T+) from logs
+    #
+    def get_full_team_name(winner)
+      case winner
+      when "T"
+        return "#{I18n.t('full_team_name_te')}"
+      else
+        return "#{I18n.t('full_team_name_ct')}"
+      end
+    end
+
+    # Format team name with short format (initials)
+    #
+    # @team [String] Round winner (+CT+ or +TERRORIST+) from logs
+    #
+    def get_short_team_name(team)
+      case team
+      when "TERRORIST"
+        return "#{I18n.t('short_team_name_te')}"
+      else
+        return "#{I18n.t('short_team_name_ct')}"
+      end
+    end
+
+  end
+end

data/lib/steam_hlds_log_parser/version.rb

@@ -0,0 +1,3 @@
+module SteamHldsLogParser
+  VERSION = "0.4.0"
+end

data/lib/steam_hlds_log_parser.rb

@@ -0,0 +1,16 @@
+require "rubygems"
+require "eventmachine"
+require "i18n"
+require "rdoc"
+
+require "steam_hlds_log_parser/version"
+require "steam_hlds_log_parser/client"
+require "steam_hlds_log_parser/handler"
+require "steam_hlds_log_parser/displayer"
+
+module SteamHldsLogParser
+
+  I18n.load_path = Dir.glob( File.dirname(__FILE__) + "/locales/*.yml" )
+  I18n.default_locale = :en
+
+end

data/spec/client_spec.rb

@@ -0,0 +1,69 @@
+require "helper_spec"
+
+module SteamHldsLogParser
+
+  describe "SteamHldsLogParser" do
+
+    before :all do
+      @client         = Client.new("0.0.0.0", 27035)
+      @options        = @client.options
+      @custom_options = custom_options
+      @custom_client  = Client.new("127.0.0.1", 27045, @custom_options)
+    end
+
+    describe "Client" do
+
+      it "raises an exception when parameters are missing" do
+        expect { Client.new }.to raise_error(ArgumentError)
+      end
+
+      subject { @client }
+      context "when a 'Client' is created without options"
+      it { should be_an_instance_of Client }
+      it "has a 'host'" do
+        @client.host.should_not be_nil      
+        @client.host.should eq("0.0.0.0")
+      end
+      it "has a 'port'" do
+        @client.port.should_not be_nil      
+        @client.port.should eq(27035)
+      end
+      it "has a default 'options' Hash" do
+        @client.options.should_not be_nil      
+        @client.options.should_not be(nil)
+        @client.options.class.should be(Hash)
+        @client.options.should eq(@options)
+      end
+
+      subject(:custom_client) { @custom_client }
+      context "when custom options are given"
+      it "can get a custom 'options' Hash" do
+        @custom_client.options.should_not be_nil      
+        @custom_client.options.class.should be(Hash)
+        @custom_client.options.should eq(@custom_options)
+        @custom_client.options[:displayer].should eq(RSpecDisplayer)
+        @custom_client.options[:locale].should be(:fr)
+        @custom_client.options[:display_kills].should be(false)
+        @custom_client.options[:display_actions].should be(false)
+        @custom_client.options[:display_changelevel].should be(false)
+      end
+
+      describe "#start and #stop" do
+
+        context "when 'start' and 'stop' are triggered one after the other"
+        it "starts then stops an eventmachine with appropriate messages" do
+          EM.run {
+            capture_stdout { @client.start }.should eq("## 0.0.0.0:27035 => HLDS connected and sending data\n")
+            EM.add_timer(0.2) {
+              capture_stdout { @client.stop }.should eq("## 0.0.0.0:27035 => HLDS Log Parser stopped.\n")
+            }
+          }
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/displayer_spec.rb

@@ -0,0 +1,59 @@
+require "helper_spec"
+
+module SteamHldsLogParser
+
+  describe "SteamHldsLogParser" do
+
+    before :all do
+      @data           = {:type=>"victory", :params=>{:score_ct=>"3", :score_t=>"0"}}
+      @displayer      = Displayer.new(@data)
+    end
+
+    describe "Displayer" do
+
+      context "when 'data' is missing" do
+        it "raises an exception" do
+          expect { Displayer.new }.to raise_error(ArgumentError)
+        end
+      end
+
+      context "when 'data' is given" do
+
+        it "creates a 'Displayer'" do
+          @displayer.should be_an_instance_of Displayer
+        end
+
+        describe "#get_data" do
+          it "returns 'data' given as argument" do
+            @displayer.get_data.should_not be_nil      
+            @displayer.get_data.should be(@data)      
+          end
+        end
+
+        describe "#display_data" do
+          it "displays 'data' given as argument" do
+            eval(capture_stdout { @displayer.display_data }).should eq(@data)
+          end
+        end
+
+        describe "#get_translation" do
+          it "returns translated 'data' given as argument" do
+            @displayer.get_translation.should_not be_nil      
+            @displayer.get_translation.class.should be(String)      
+            @displayer.get_translation.should eq("[CT] 3 - 0 [T]")      
+          end
+        end
+
+        describe "#display_translation" do
+          it "displays translated 'data' given as argument" do
+            capture_stdout { @displayer.display_translation }.should eq("[CT] 3 - 0 [T]\n")
+          end
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/handler_spec.rb

@@ -0,0 +1,138 @@
+require "helper_spec"
+
+module SteamHldsLogParser
+
+  describe "SteamHldsLogParser" do
+
+    before :all do
+      @client         = Client.new("0.0.0.0", 27035)
+      @options        = @client.options
+      @handler        = Handler.new("", "0.0.0.0", 27035, @options)
+    end
+
+    describe "Handler" do
+
+      context "when parameters are missing" do
+        it "raises an exception" do
+          expect { Handler.new }.to raise_error(ArgumentError)
+        end
+      end
+
+      context "when parameters are given" do
+        subject { @handler }
+  
+        context "when 'host' and 'port' are given"
+        it { should be_an_instance_of Handler }
+        it "has a 'host'" do
+          @handler.host.should_not be_nil      
+          @handler.host.should eq("0.0.0.0")
+        end
+        it "has a 'port'" do
+          @handler.port.should_not be_nil      
+          @handler.port.should eq(27035)
+        end
+
+        describe "#post_init" do
+          it "displays a console message when hlds connects" do
+            capture_stdout { @handler.post_init }.should eq("## 0.0.0.0:27035 => HLDS connected and sending data\n")
+          end
+        end
+
+        describe "#unbind" do
+          it "displays a console message when hlds disconnects" do
+            capture_stdout { @handler.unbind }.should eq("## 0.0.0.0:27035 => HLDS disconnected? No data is received.\n")
+          end
+        end
+
+        describe "#receive_data" do
+
+          context "when data is not supported" do
+            it "returns anything" do
+              data = '# L 05/10/2000 - 12:34:56: I am a fake line of log'
+              @handler.receive_data(data).should eq(nil)
+            end
+          end
+
+          context "when data is 'map_ends'" do
+            it "returns Hash on map_ends" do
+              data = '# L 05/10/2000 - 12:34:56: Team "CT" scored "17" with "0" players"'
+              expected = {:type=>"map_ends", :params=>{:winner=>"CT", :score=>"17"}}
+              @handler.receive_data(data).class.should eq(Hash)
+              @handler.receive_data(data).should eq(expected)
+            end
+          end
+
+          context "when data is 'victory'" do
+            it "returns Hash on victory" do
+              data = '# L 05/10/2000 - 12:34:56: Team "CT" triggered "CTs_Win" (CT "3") (T "0")'
+              expected = {:type=>"victory", :params=>{:score_ct=>"3", :score_t=>"0"}}
+              @handler.receive_data(data).class.should eq(Hash)
+              @handler.receive_data(data).should eq(expected)
+            end
+          end
+
+          context "when data is 'killed'" do
+            it "returns Hash on killed" do
+              data = '# L 05/10/2000 - 12:34:56: "Killer | Player<66><STEAM_ID_LAN><TERRORIST>" killed "Killed | Player<60><STEAM_ID_LAN><CT>" with "ak47"'
+              expected = {:type=>"kill", :params => {:killer_team=>"TE", :killer=>"Killer | Player",  :killed_team=>"CT", :killed=>"Killed | Player", :weapon=>"ak47"}}
+              @handler.receive_data(data).class.should eq(Hash)
+              @handler.receive_data(data).should eq(expected)
+            end
+          end
+
+          context "when data is 'suicide'" do
+            it "returns Hash on suicide" do
+              data = '# L 05/10/2000 - 12:34:56: "Player<66><STEAM_ID_LAN><TERRORIST>" committed suicide with "worldspawn" (world)'
+              expected = {:type=>"suicide", :params=>{:killed=>"Player"}}
+              @handler.receive_data(data).class.should eq(Hash)
+              @handler.receive_data(data).should eq(expected)
+            end
+          end
+
+          context "when data is 'event'" do
+            it "returns Hash on event" do
+              data = '# L 05/10/2000 - 12:34:56: "Killer | Player<66><STEAM_ID_LAN><CT>" triggered "Defused_The_Bomb"'
+              expected = {:type=>"event", :params=> {:person_team=>"CT", :person=>"Killer | Player", :event_item=>"Defused_The_Bomb", :event_i18n=>"defused the bomb"}}
+              @handler.receive_data(data).class.should eq(Hash)
+              @handler.receive_data(data).should eq(expected)
+            end
+          end
+
+          context "when data is 'changelevel'" do
+            it "returns Hash on changelevel" do
+              data = '# L 05/10/2000 - 12:34:56: Loading map "de_dust2"'
+              expected = {:type=>"loading_map", :params=>{:map=>"de_dust2"}}
+              @handler.receive_data(data).class.should eq(Hash)
+              @handler.receive_data(data).should eq(expected)
+            end
+          end
+
+        end
+
+        describe "#get_full_team_name" do
+
+          context "when short name is given"
+          it "returns full name" do
+            @handler.get_full_team_name("T").should eq("Terrorist")
+            @handler.get_full_team_name("CT").should eq("Counter-Terrorist")
+          end
+
+        end
+
+        describe "#get_short_team_name" do
+
+          context "when full name is given"
+          it "returns short name" do
+            @handler.get_short_team_name("TERRORIST").should eq("TE")
+            @handler.get_short_team_name("CT").should eq("CT")
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/helper_spec.rb

@@ -0,0 +1,39 @@
+require "simplecov"
+require "coveralls"
+require "rspec"
+
+# Simplecov / Coverall configuration
+SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+SimpleCov.start do
+  add_filter "/example/"
+  add_filter "/spec/"
+end
+
+# Get ouput content of the given block
+# Source: https://github.com/cldwalker/hirb/blob/master/test/test_helper.rb
+def capture_stdout(&block)
+  original_stdout = $stdout
+  $stdout = fake = StringIO.new
+  begin
+    yield
+  ensure
+    $stdout = original_stdout
+  end
+ fake.string
+end
+
+class RSpecDisplayer
+end
+
+require "steam_hlds_log_parser"
+
+# Returns custom options as a Hash
+def custom_options
+  options = {
+    :locale              => :fr,
+    :display_kills       => false,
+    :display_actions     => false,
+    :display_changelevel => false,
+    :displayer           => RSpecDisplayer
+  }  
+end

data/steam_hlds_log_parser.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'steam_hlds_log_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "steam_hlds_log_parser"
+  spec.version       = SteamHldsLogParser::VERSION
+  spec.authors       = ["Thomas VIAL"]
+  spec.email         = ["github@ifusio.com"]
+  spec.description   = %q{Steam HLDS Log Parser receives logs from your Steam game server and parses them in real time to give you usable content for your website, irc channel / flowdock... Works well with Counter-Strike and others Half-life based games.}
+  spec.summary       = %q{Steam HLDS Log Parser receives logs from your Steam game server and parses them in real time to give you usable content for your website, irc channel / flowdock... Works well with Counter-Strike and others Half-life based games.}
+  spec.homepage      = "https://github.com/tomav/steam_hlds_log_parser"
+  spec.license       = "MIT"
+
+  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_dependency "bundler", "~> 1.3"
+  spec.add_dependency "rake"
+  spec.add_dependency "eventmachine", "~> 1.0.3"
+  spec.add_dependency "i18n"
+
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "coveralls"
+  spec.add_development_dependency "rspec-core"
+  spec.add_development_dependency "rspec"
+
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification 
+name: steam_hlds_log_parser
+version: !ruby/object:Gem::Version 
+  version: 0.4.0
+platform: ruby
+authors: 
+- Thomas VIAL
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-08-13 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.3"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id004 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.3
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id004
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id004
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: coveralls
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id004
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rspec-core
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id004
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id004
+  type: :development
+  version_requirements: *id009
+description: Steam HLDS Log Parser receives logs from your Steam game server and parses them in real time to give you usable content for your website, irc channel / flowdock... Works well with Counter-Strike and others Half-life based games.
+email: 
+- github@ifusio.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .coveralls.yml
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/example-1.rb
+- example/example-2.rb
+- lib/.DS_Store
+- lib/locales/en.yml
+- lib/locales/fr.yml
+- lib/steam_hlds_log_parser.rb
+- lib/steam_hlds_log_parser/client.rb
+- lib/steam_hlds_log_parser/displayer.rb
+- lib/steam_hlds_log_parser/handler.rb
+- lib/steam_hlds_log_parser/version.rb
+- spec/client_spec.rb
+- spec/displayer_spec.rb
+- spec/handler_spec.rb
+- spec/helper_spec.rb
+- steam_hlds_log_parser.gemspec
+homepage: https://github.com/tomav/steam_hlds_log_parser
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id004
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id004
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Steam HLDS Log Parser receives logs from your Steam game server and parses them in real time to give you usable content for your website, irc channel / flowdock... Works well with Counter-Strike and others Half-life based games.
+test_files: 
+- spec/client_spec.rb
+- spec/displayer_spec.rb
+- spec/handler_spec.rb
+- spec/helper_spec.rb