steam_hlds_log_parser 0.4.6 → 0.4.7

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA512: 
-  data.tar.gz: 21f9f688aa94ffa40bddb17b43e0b2ae7774bec09d42ebbb00524ff1acaf70350ed703ae1eb59a3fdc52c2c9bd7d1c7a129d0bb2157f380528cb022e149124cb
-  metadata.gz: ec172491894a4a85647baf437dffff1a660f55a160c3e35b01b44b602b48a6497bbdd9ace675b52d22e08d5ccb2026417650011a40913bb5bd9319f41f40e826
+  metadata.gz: d2bd1ead06fc2e944fe5444330d664cdf1b7417163c9f62c4e9a40f86bd5ace016a660d5bb4b7f7f7ddeaae175af51e4c140721dc24c6d6f44f8d856cf0dd05d
+  data.tar.gz: f1d9c090409ddca6135103ddaea5c8c4275bd385e7dd67e79bedec33b3da262df42a09080a505cf21d9ce872915b7d8322bce522c258414ce3fee53c7c48c430
 SHA1: 
-  data.tar.gz: 8b03a0b37424792c0f6698bdd2127b7dac379f36
-  metadata.gz: 3225c8d1342cbe90341bad78fe81404d87be864b
+  metadata.gz: dea6da3483d539c6275bb19b4814913eb8674f84
+  data.tar.gz: d76a18c57ee1aadd6193dcec1ac66a48776683a7

data/README.md

@@ -1,6 +1,8 @@
-# Steam Hlds Log Parser
+# Steam HLDS Log Parser
 
-Steam Hlds Log Parser listens to UDP log packets sent by your (local or remote) HLDS game server, processes data and returns clean or/and translated and readable content that you can use for your website, irc channel, match live streaming, bots, database...
+##### Log parser for Steam HLDS based games like Counter-Strike
+
+Steam Hlds Log Parser listens to UDP log packets sent by your _(local or remote)_ HLDS game server, processes data and returns clean and  readable (translated) content that you can use for your website, irc channel, match live streaming, bots, database...
 
 Should work with all Steam HLDS based games, and has been mostly tested on Counter-Strike 1.6.
 
@@ -26,41 +28,73 @@ Or install it yourself as:
 
     $ gem install steam_hlds_log_parser
 
-## Configuration
+And in your Ruby file:
+
+    require "steam_hlds_log_parser"
 
-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. Of course, you need to have server RCON. In your `server.cfg` (or in server console) add `logaddress 127.0.0.1 27035`. It specifies where the logs will be sent. This must be the IP / Port your ruby client will listen to.
+## Full working example
 
-If you are behind a router/firewall, you probably need to configure it.
+By default, Steam HLDS Log Parser runs on `0.0.0.0:27115` _(+100 than default HLDS port which is 27015)_  
 
-## Example
+1 - On your game server, send logs to your Ruby server (in this example, same machine).
 
-    require "rubygems"
-    require "steam_hlds_log_parser"
+```
+logaddres 0.0.0.0 27115
+``` 
+
+or  
+
+```
+logaddres_add 0.0.0.0 27115
+```
+
+2 - Create a file named, for example, `hlds_parser.rb` with this content:
+
+```ruby
+require "rubygems"
+require "steam_hlds_log_parser"
 
-    class Formatter
-      def initialize(data)
-        # will 'puts' the translated content using built-in displayer
-        SteamHldsLogParser::Displayer.new(data).display_translation
-      end
-    end
+# Your displayer Class is what you will do with your data
+class Formatter
+  def initialize(data)
+    # will 'puts' the translated content, using built-in Displayer
+    SteamHldsLogParser::Displayer.new(data).display_translation
+  end
+end
 
+# Setup the Client to use the 'Formatter' Class as displayer callback
+# Options will be use default values (see example-2.rb)
+SteamHldsLogParser::Client.new(Formatter).start
+```
 
-    ## These are default options
-    options = {
-      :locale              => :en,
-      :display_kills       => true,
-      :display_actions     => true,
-      :display_changelevel => true,
-      :display_chat        => true,
-      :display_team_chat   => true,
-      :displayer           => Formatter
-    }
+3 - Now, run the Ruby script to see parsed content inyour console:
 
-    parser = SteamHldsLogParser::Client.new("127.0.0.1", 27035, options)
-    parser.start
+```
+ruby hlds_parser.rb
+```
+
+Your game server activity should look something like that:
+
+```
+[T] Jim_Carrey spawned with the bomb
+[CT] Tomav says "Com'on guys!"
+[CT] V0id killed [T] killaruna with deagle
+[T] Funky Byte killed [CT] Neuromancer with m4a1
+[CT] Tomav killed [T] Funky Byte with deagle
+[T] Juliet_Lewis killed [CT] Make my Day with ak47
+[CT] Alloc killed [T] Juliet_Lewis with famas
+[T] Jim_Carrey planted the bomb
+[CT] Tomav killed [T] Jim_Carrey with sg552
+[CT] Tomav begin bomb defuse with kit
+[CT] Jim_Carrey says "aaaaaargh!!!" to others [T]
+[CT] Tomav defused the bomb
+[CT] 1 - 6 [T]
+Map ends: CT => 1
+Map ends: T => 6
+Loading de_dust2
+```
+
+Now customize your Formatter class to make it fit your needs.
 
 ## Documentation
 
@@ -73,6 +107,21 @@ Full documentation can be found on [Steam HLDS Parser Log page on Rubydoc](http:
 Steam HLDS Log Parser uses RSpec as test / specification framework and should be 100% tested too.
 Here again, feel free to improve it.
 
+## FAQ
+
+### What do I need to use this gem?
+
+* Ruby 1.9+
+* Basic Ruby skill
+* Steam HLDS Server with SSH access or RCON password
+
+### My Client is running, but nothing appears in my console?!
+Common issues are:
+
+* HLDS with no or miconfigured `logaddress`
+* Firewall not properly configured (remember that HLDS sends `UDP` packets, not `TCP`)
+* Have a look to your Displayer Class
+
 ## Contributing
 
 1. Fork it

data/examples/example-1.rb

@@ -1,24 +1,14 @@
 require "rubygems"
 require "steam_hlds_log_parser"
 
+# Your displayer Class is what you will do with your data
 class Formatter
   def initialize(data)
-    # will 'puts' the translated content
+    # will 'puts' the translated content, using built-in Displayer
     SteamHldsLogParser::Displayer.new(data).display_translation
   end
 end
 
-
-## These are default options
-options = {
-  :locale              => :en,
-  :display_kills       => true,
-  :display_actions     => true,
-  :display_changelevel => true,
-  :display_chat        => true,
-  :display_team_chat   => true,
-  :displayer           => Formatter
-}
-
-parser = SteamHldsLogParser::Client.new("127.0.0.1", 27035, options)
-parser.start
+# Setup the Client to use the 'Formatter' Class
+# Options will be use default values (see example-2.rb)
+SteamHldsLogParser::Client.new(Formatter).start

data/examples/example-2.rb

@@ -1,26 +1,25 @@
 require "rubygems"
 require "steam_hlds_log_parser"
-# require "flowdock"
 
-## The displayer class that will be used to send content to Flowdock
-class FlowdockPusher
+# Your displayer Class is what you will do with your data
+class Formatter
   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)
+    # will 'puts' the translated content, using built-in Displayer
+    SteamHldsLogParser::Displayer.new(data).display_translation
   end
 end
 
+# These are default options
 options = {
-  :locale              => :fr,
-  :display_kills       => true,
-  :display_actions     => true,
-  :display_changelevel => true,
-  :display_chat        => true,
-  :display_team_chat   => true,
-  :displayer           => FlowdockPusher
+  :host                 => "0.0.0.0",
+  :port                 => 27115,
+  :locale               => :en,
+  :display_kills        => true,
+  :display_actions      => true,
+  :display_changelevel  => true,
+  :display_chat         => true,
+  :display_team_chat    => true
 }
 
-SteamHldsLogParser::Client.new("127.0.0.1", 27035, options).start
+parser = SteamHldsLogParser::Client.new(Formatter, options)
+parser.start

data/lib/steam_hlds_log_parser/client.rb

@@ -2,37 +2,37 @@ module SteamHldsLogParser
 
   # Listens to HLDS logs received via UDP on configured port
   #
-  # @attr_reader [String] host Client host / IP
-  # @attr_reader [Integer] port Client port to listen to
   # @attr_reader [Hash] options Client options
+  #
   class Client
 
-    attr_reader :host, :port, :options
+    attr_reader :displayer, :options
 
     # Creates a new client 
     #
-    # @param [String] host Hostname / IP Address the server will be running
-    # @param [Integer] port Port will be listening to
-    # @param [Hash] options Other configuration options
+    # @param [Class] displayer Callback class which will receive parsed content, do what you want with this class
+    # @param [Hash] options Optional parameters to setup your client
     #
+    # @option options [String] :host (0.0.0.0) IP Address the client will be running, usually localhost
+    # @option options [Integer] :port (27115) Port will be listening to
     # @option options [Symbol] :locale (:en) Set the language of returned content
     # @option options [Boolean] :display_kills (true) Enable kills / frags detail 
     # @option options [Boolean] :display_actions (true) Enable players actions / defuse / ... detail
     # @option options [Boolean] :display_changelevel (true) Enable changelevel (map) display
     # @option options [Boolean] :display_chat (true) Enable chat ('say') display
     # @option options [Boolean] :display_team_chat (true) Enable chat ('say_team') display
-    # @option options [Class] :displayer Class that will be use to display content
     #
-    def initialize(host, port, options = {})
+    def initialize(displayer, options = {})
       default_options = {
-        :locale              => :en,
-        :display_kills       => true,
-        :display_actions     => true,
-        :display_changelevel => true,
-        :display_chat        => true,
-        :display_team_chat   => true,
+        :host                 => "0.0.0.0",
+        :port                 => 27115,
+        :locale               => :en,
+        :display_kills        => true,
+        :display_actions      => true,
+        :display_changelevel  => true,
+        :display_chat         => true,
+        :display_team_chat    => true,
       }
-      @host, @port  = host, port
       @options      = default_options.merge(options)
      end
 
@@ -45,13 +45,13 @@ module SteamHldsLogParser
         Signal.trap("INT")  { EM.stop }
         Signal.trap("TERM") { EM.stop }
         # Let's start
-        EM::open_datagram_socket(@host, @port, Handler, @host, @port, @options)
+        EM::open_datagram_socket(@options[:host], @options[:port], Handler, @displayer, @options)
       }       
      end
 
      # Stops the client
      def stop
-       puts "## #{@host}:#{@port} => #{I18n.t('client_stop')}"
+       puts "## #{@options[:host]}:#{@options[:port]} => #{I18n.t('client_stop')}"
        EM::stop_event_loop
      end
 

data/lib/steam_hlds_log_parser/handler.rb

@@ -2,31 +2,31 @@ module SteamHldsLogParser
 
   # Process data received by 'Client'
   #
-  # @attr_reader [String] host Client host / IP
-  # @attr_reader [Integer] port Client port to listen to
+  # @attr_reader [Class] displayer Callback
   # @attr_reader [Hash] options Client options
+  #
   class Handler < EM::Connection
 
-    attr_reader :host, :port, :options
+    attr_reader :displayer, :options
 
     # Initialize Handler from Client options
     #
-    # @param [String] host Hostname / IP Address the server is running
-    # @param [Integer] port Port is listening to
-    # @param [Hash] options Other client configuration options
+    # @param [Class] displayer Class to call when data is parsed
+    # @param [Hash] options Client configuration options
     #
-    def initialize(host, port, options)
-      @host, @port, @options = host, port, options
+    def initialize(displayer, options)
+      @displayer  = displayer
+      @options    = options
     end
 
     # Triggered when HLDS connects
     def post_init
-      puts "## #{@host}:#{@port} => #{I18n.t('client_connect')}"
+      puts "## #{@options[:host]}:#{@options[:port]} => #{I18n.t('client_connect')}"
     end
 
     # Triggered when HLDS disconnects
     def unbind
-      puts "## #{@host}:#{@port} => #{I18n.t('client_disconnect')}" 
+      puts "## #{@options[:host]}:#{@options[:port]} => #{I18n.t('client_disconnect')}" 
     end
 
     # Get data from Client and parse using Regexp
@@ -37,6 +37,8 @@ module SteamHldsLogParser
     # * match suicides
     # * match who did what (defuse, drop the bomb...)
     # * match changelevel
+    # * match chat (say)
+    # * match team chat (say_team)
     #
     # @param [String] data Data received by Client from HLDS server (a line of log)
     #
@@ -86,10 +88,10 @@ module SteamHldsLogParser
 
       # no matching pattern, no output
       unless content.nil?
-        if @options[:displayer].nil?
+        if @displayer.nil?
           return(content)
         else
-          @options[:displayer].new(content)
+          @displayer.new(content)
         end
       end
 
@@ -105,8 +107,9 @@ module SteamHldsLogParser
       case winner
       when "T"
         return "#{I18n.t('full_team_name_te')}"
-      else
+      when "CT"
         return "#{I18n.t('full_team_name_ct')}"
+      else
       end
     end
 
@@ -120,8 +123,9 @@ module SteamHldsLogParser
       case team
       when "TERRORIST"
         return "#{I18n.t('short_team_name_te')}"
-      else
+      when "CT"
         return "#{I18n.t('short_team_name_ct')}"
+      else
       end
     end
 

data/lib/steam_hlds_log_parser/version.rb

@@ -1,4 +1,4 @@
 module SteamHldsLogParser
   # Gem Version
-  VERSION = "0.4.6"
+  VERSION = "0.4.7"
 end

data/spec/client_spec.rb

@@ -4,48 +4,96 @@ 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)
+      context "when parameters are missing" do
+        it "raises an exception" do
+          expect { Client.new }.to raise_error(ArgumentError)
+        end
       end
 
-      subject { @client }
-      context "when a 'Client' is created without options"
+      subject(:default_client) { Client.new(RSpecDisplayer) }
+      context "when a 'Client' is created with default 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")
+      it "has a default 'options' Hash" do
+        default_client.options.should_not be_nil      
+        default_client.options.should_not be(nil)
+        default_client.options.class.should be(Hash)
       end
-      it "has a 'port'" do
-        @client.port.should_not be_nil      
-        @client.port.should eq(27035)
+      it "has a default 'host'" do
+        default_client.options[:host].should_not be_nil      
+        default_client.options[:host].should eq("0.0.0.0")
       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)
+      it "has a default 'port'" do
+        default_client.options[:port].should_not be_nil      
+        default_client.options[:port].should eq(27115)
+      end
+      it "has a default 'locale'" do
+        default_client.options[:locale].should_not be_nil      
+        default_client.options[:locale].class.should eq(Symbol)      
+        default_client.options[:locale].should eq(:en)
+      end
+      it "has a default 'display_kills'" do
+        default_client.options[:display_kills].should_not be_nil      
+        default_client.options[:display_kills].should be(true)
+      end
+      it "has a default 'display_actions'" do
+        default_client.options[:display_actions].should_not be_nil      
+        default_client.options[:display_actions].should be(true)
+      end
+      it "has a default 'display_changelevel'" do
+        default_client.options[:display_changelevel].should_not be_nil      
+        default_client.options[:display_changelevel].should be(true)
+      end
+      it "has a default 'display_chat'" do
+        default_client.options[:display_chat].should_not be_nil      
+        default_client.options[:display_chat].should be(true)
+      end
+      it "has a default 'display_team_chat'" do
+        default_client.options[:display_team_chat].should_not be_nil      
+        default_client.options[:display_team_chat].should be(true)
       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(true)
+      subject(:custom_client) { Client.new(RSpecDisplayer, custom_options) }
+      context "when custom parameters are given"
+      it { should be_an_instance_of Client }
+      it "has a default 'options' Hash" do
+        custom_client.options.should_not be_nil      
+        custom_client.options.should_not be(nil)
+        custom_client.options.class.should be(Hash)
+      end
+      it "has a custom 'host'" do
+        custom_client.options[:host].should_not be_nil      
+        custom_client.options[:host].should eq("127.0.0.1")
+      end
+      it "has a custom 'port'" do
+        custom_client.options[:port].should_not be_nil      
+        custom_client.options[:port].should eq(12345)
+      end
+      it "has a custom 'locale'" do
+        custom_client.options[:locale].should_not be_nil      
+        custom_client.options[:locale].class.should eq(Symbol)      
+        custom_client.options[:locale].should eq(:fr)
+      end
+      it "has a custom 'display_kills'" do
+        custom_client.options[:display_kills].should_not be_nil      
+        custom_client.options[:display_kills].should be(false)
+      end
+      it "has a custom 'display_actions'" do
+        custom_client.options[:display_actions].should_not be_nil      
+        custom_client.options[:display_actions].should be(false)
+      end
+      it "has a custom 'display_changelevel'" do
+        custom_client.options[:display_changelevel].should_not be_nil      
+        custom_client.options[:display_changelevel].should be(false)
+      end
+      it "has a custom 'display_chat'" do
+        custom_client.options[:display_chat].should_not be_nil      
+        custom_client.options[:display_chat].should be(false)
+      end
+      it "has a custom 'display_team_chat'" do
+        custom_client.options[:display_team_chat].should_not be_nil      
+        custom_client.options[:display_team_chat].should be(false)
       end
 
       describe "#start and #stop" do
@@ -53,9 +101,9 @@ module SteamHldsLogParser
         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")
+            capture_stdout { default_client.start }.should eq("## 0.0.0.0:27115 => 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")
+              capture_stdout { default_client.stop }.should eq("## 0.0.0.0:27115 => HLDS Log Parser stopped.\n")
             }
           }
         end

data/spec/handler_spec.rb

@@ -5,10 +5,9 @@ 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)
-      @custom_handler = Handler.new("", "0.0.0.0", 27035, custom_options)
+      @client         = Client.new(RSpecDisplayer)
+      @handler        = Handler.new("", @client.displayer, @client.options)
+      @custom_handler = Handler.new("", RSpecDisplayer, { :host => "0.0.0.0", :port => 27115, :display_changelevel => true })
     end
 
     describe "Handler" do
@@ -24,24 +23,24 @@ module SteamHldsLogParser
   
         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")
+        it "has a 'host' option" do
+          @handler.options[:host].should_not be_nil      
+          @handler.options[:host].should eq("0.0.0.0")
         end
-        it "has a 'port'" do
-          @handler.port.should_not be_nil      
-          @handler.port.should eq(27035)
+        it "has a 'port' option" do
+          @handler.options[:port].should_not be_nil      
+          @handler.options[:port].should eq(27115)
         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")
+            capture_stdout { @handler.post_init }.should eq("## 0.0.0.0:27115 => 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")
+            capture_stdout { @handler.unbind }.should eq("## 0.0.0.0:27115 => HLDS disconnected? No data is received.\n")
           end
         end
 
@@ -153,11 +152,13 @@ module SteamHldsLogParser
             end
           end
 
+          subject { @custom_handler }
           context "when 'displayer' is set" do
             it "returns Hash on changelevel provided by 'displayer'" do
               data = '# L 05/10/2000 - 12:34:56: Loading map "de_dust2"'
               expected = {:type=>"loading_map", :params=>{:map=>"de_dust2"}}
-              @custom_handler.options[:displayer].should eq(RSpecDisplayer)
+              @custom_handler.displayer.should eq(RSpecDisplayer)
+              @custom_handler.options[:display_changelevel].should be(true)
               @custom_handler.receive_data(data).data.should eq(expected)
             end
           end

data/spec/helper_spec.rb

@@ -37,12 +37,14 @@ 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 => true,
-    :display_chat        => false,
-    :display_team_chat   => false,
-    :displayer           => RSpecDisplayer
+    :host                 => "127.0.0.1",
+    :port                 => 12345,
+    :locale               => :fr,
+    :display_kills        => false,
+    :display_actions      => false,
+    :display_changelevel  => false,
+    :display_chat         => false,
+    :display_team_chat    => false,
+    :displayer            => RSpecDisplayer
   }  
 end

data/spec/log_tester_spec.rb

@@ -5,9 +5,8 @@ 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)
+      @client         = Client.new(RSpecDisplayer)
+      @handler        = Handler.new("", @client.displayer, @client.options)
     end
 
     describe "LogTester" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: steam_hlds_log_parser
 version: !ruby/object:Gem::Version 
-  version: 0.4.6
+  version: 0.4.7
 platform: ruby
 authors: 
 - Thomas VIAL
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-08-15 00:00:00 Z
+date: 2013-08-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: bundler