steam_hlds_log_parser 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA1: 
-  metadata.gz: 0d6f4970900f52377acd0e1b941a3b9929afadec
-  data.tar.gz: c899a1a093ffdbd74130d2d0df208aee17427e8f
+  metadata.gz: 3e50cd7e02251eb8f005cffa7db04028ef24c230
+  data.tar.gz: 088c9c2ae149c651c7c221885c5df6e3cbcb0b70
 SHA512: 
-  metadata.gz: 20193bfa2615cd4ff28c46d4ede73655dc2ba6dd2f8ad9bc8c296444efcda8e2009cb7b7c699a9157e7625965c6e1e2e1262791598065dab8f9a6911fae6d966
-  data.tar.gz: 6cee787d6eb11cb295d8634f53f259b586b510d3f3630b916a7e845a5930fcd9e9f8e546b1275b00b0a2490a4d9106808f3f946f63f5064c450b1220464ee90e
+  metadata.gz: fe0846e0981463819ccd9e033c2ed5249fc2b6e0c63c59b5333089f635bfd7bca0660d451e059677aba809a4db8484fd1d11e7da661ea6b8a2b94f6c41617a6d
+  data.tar.gz: 6850d1f8eabfaf9fb55c5e3a3878c90582675d4ffab294a66d34499a1515187b026fd78dee4ef38754a1e35c850776f88019d06452e40f7a4e0a047b35bcb80e

data/examples/example-2.rb

@@ -18,7 +18,9 @@ options = {
   :display_actions      => true,
   :display_changelevel  => true,
   :display_chat         => true,
-  :display_team_chat    => true
+  :display_team_chat    => true,
+  :display_connect      => true,
+  :display_disconnect   => true
 }
 
 parser = SteamHldsLogParser::Client.new(Formatter, options)

data/lib/locales/en.yml

@@ -42,3 +42,5 @@ en:
   loading_map: "Loading %{map}"
   chat: "[%{player_team}] %{player} says \"%{chat}\""
   team_chat: "[%{player_team}] %{player} says \"%{chat}\" to others [%{player_team}]"
+  connect: "%{player} is connecting"
+  disconnect: "%{player} disconnected"

data/lib/locales/fr.yml

@@ -42,3 +42,5 @@ fr:
   loading_map: "Chargement de %{map}"
   chat: "[%{player_team}] %{player} dit \"%{chat}\""
   team_chat: "[%{player_team}] %{player} dit \"%{chat}\" aux autres [%{player_team}]"
+  connect: "%{player} se connecte"
+  disconnect: "%{player} s'est connecté"

data/lib/steam_hlds_log_parser/client.rb

@@ -21,6 +21,8 @@ module SteamHldsLogParser
     # @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 [Boolean] :display_connect (true) Enable player connection display
+    # @option options [Boolean] :display_disconnect (true) Enable player disconnection display
     #
     def initialize(displayer, options = {})
       default_options = {
@@ -32,6 +34,8 @@ module SteamHldsLogParser
         :display_changelevel  => true,
         :display_chat         => true,
         :display_team_chat    => true,
+        :display_connect      => true,
+        :display_disconnect   => true
       }
       @options      = default_options.merge(options)
       @displayer    = displayer

data/lib/steam_hlds_log_parser/handler.rb

@@ -39,6 +39,7 @@ module SteamHldsLogParser
     # * match changelevel
     # * match chat (say)
     # * match team chat (say_team)
+    # * user connections / disconnections
     #
     # @param [String] data Data received by Client from HLDS server (a line of log)
     #
@@ -84,6 +85,16 @@ module SteamHldsLogParser
         player, player_team, message = data.match(/: "(.+)<\d+><.+><([A-Z]+)>" say_team "(.+)"/i).captures
         content = { :type => 'team_chat', :params => { :player => player, :player_team => get_short_team_name(player_team), :chat => message } }
 
+      # L 05/10/2000 - 12:34:56: "Player<73><STEAM_ID_LAN><>" connected, address "192.168.4.186:1339"
+      elsif @options[:display_connect] && data.gsub(/: "(.+)<\d+><.+>" connected, address "(.+):(.+)"/).count > 0
+        player, ip, port = data.match(/: "(.+)<\d+><.+>" connected, address "(.+):(.+)"/i).captures
+        content = { :type => 'connect', :params => { :player => player, :ip => ip, :port => port } }
+
+      # L 05/10/2000 - 12:34:56: "Player<73><STEAM_ID_LAN><TERRORIST>" disconnected
+      elsif @options[:display_disconnect] && data.gsub(/: "(.+)<\d+><.+><(.+)>" disconnected/).count > 0
+        player, player_team = data.match(/: "(.+)<\d+><.+><(.+)>" disconnected/i).captures
+        content = { :type => 'disconnect', :params => { :player => player, :player_team => get_short_team_name(player_team) } }
+
       end
 
       # no matching pattern, no output

data/lib/steam_hlds_log_parser/version.rb

@@ -1,4 +1,4 @@
 module SteamHldsLogParser
   # Gem Version
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/spec/client_spec.rb

@@ -6,102 +6,120 @@ module SteamHldsLogParser
 
     describe "Client" do
 
-      context "when parameters are missing" do
+      context "when 'Displayer' parameter is missing" do
         it "raises an exception" do
           expect { Client.new }.to raise_error(ArgumentError)
         end
       end
 
-      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 'displayer'" do
-        expect(default_client.displayer).not_to be_nil      
-        expect(default_client.displayer.class).to be(Class)
-        expect(default_client.displayer).to be(RSpecDisplayer)
-      end
-      it "has a default 'options' Hash" do
-        expect(default_client.displayer).not_to be_nil      
-        expect(default_client.displayer.class).to be(Class)
-      end
-      it "has a default 'host'" do
-        expect(default_client.options[:host]).not_to be_nil      
-        expect(default_client.options[:host]).to eq("0.0.0.0")      
-      end
-      it "has a default 'port'" do
-        expect(default_client.options[:port]).not_to be_nil      
-        expect(default_client.options[:port]).to be(27115)
-      end
-      it "has a default 'locale'" do
-        expect(default_client.options[:locale]).not_to be_nil      
-        expect(default_client.options[:locale].class).to be(Symbol)
-        expect(default_client.options[:locale]).to be(:en)
-      end
-      it "has a default 'display_kills'" do
-        expect(default_client.options[:display_kills]).not_to be_nil      
-        expect(default_client.options[:display_kills]).to be_true      
-      end
-      it "has a default 'display_actions'" do
-        expect(default_client.options[:display_actions]).not_to be_nil      
-        expect(default_client.options[:display_actions]).to be_true      
-      end
-      it "has a default 'display_changelevel'" do
-        expect(default_client.options[:display_changelevel]).not_to be_nil      
-        expect(default_client.options[:display_changelevel]).to be_true      
-      end
-      it "has a default 'display_chat'" do
-        expect(default_client.options[:display_chat]).not_to be_nil      
-        expect(default_client.options[:display_chat]).to be_true      
-      end
-      it "has a default 'display_team_chat'" do
-        expect(default_client.options[:display_team_chat]).not_to be_nil      
-        expect(default_client.options[:display_team_chat]).to be_true      
-      end
+      context "when 'Displayer' parameter is set" do
+        subject(:default_client) { Client.new(RSpecDisplayer) }
+        it { should be_an_instance_of Client }
+        it "has a 'displayer'" do
+          expect(default_client.displayer).not_to be_nil      
+          expect(default_client.displayer.class).to be(Class)
+          expect(default_client.displayer).to be(RSpecDisplayer)
+        end
+        it "has a default 'options' Hash" do
+          expect(default_client.displayer).not_to be_nil      
+          expect(default_client.displayer.class).to be(Class)
+        end
+        it "has a default 'host'" do
+          expect(default_client.options[:host]).not_to be_nil      
+          expect(default_client.options[:host]).to eq("0.0.0.0")      
+        end
+        it "has a default 'port'" do
+          expect(default_client.options[:port]).not_to be_nil      
+          expect(default_client.options[:port]).to be(27115)
+        end
+        it "has a default 'locale'" do
+          expect(default_client.options[:locale]).not_to be_nil      
+          expect(default_client.options[:locale].class).to be(Symbol)
+          expect(default_client.options[:locale]).to be(:en)
+        end
+        it "has a default 'display_kills'" do
+          expect(default_client.options[:display_kills]).not_to be_nil      
+          expect(default_client.options[:display_kills]).to be_true      
+        end
+        it "has a default 'display_actions'" do
+          expect(default_client.options[:display_actions]).not_to be_nil      
+          expect(default_client.options[:display_actions]).to be_true      
+        end
+        it "has a default 'display_changelevel'" do
+          expect(default_client.options[:display_changelevel]).not_to be_nil      
+          expect(default_client.options[:display_changelevel]).to be_true      
+        end
+        it "has a default 'display_chat'" do
+          expect(default_client.options[:display_chat]).not_to be_nil      
+          expect(default_client.options[:display_chat]).to be_true      
+        end
+        it "has a default 'display_team_chat'" do
+          expect(default_client.options[:display_team_chat]).not_to be_nil      
+          expect(default_client.options[:display_team_chat]).to be_true      
+        end
+        it "has a default 'display_connect'" do
+          expect(default_client.options[:display_connect]).not_to be_nil      
+          expect(default_client.options[:display_connect]).to be_true      
+        end
+        it "has a default 'display_disconnect'" do
+          expect(default_client.options[:display_connect]).not_to be_nil      
+          expect(default_client.options[:display_connect]).to be_true      
+        end
+     end
 
-      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
-        expect(custom_client.options).not_to be_nil      
-        expect(custom_client.options.class).to be(Hash)      
-      end
-      it "has a custom 'host'" do
-        expect(custom_client.options[:host]).not_to be_nil      
-        expect(custom_client.options[:host]).to eq("127.0.0.1")      
-      end
-      it "has a custom 'port'" do
-        expect(custom_client.options[:port]).not_to be_nil      
-        expect(custom_client.options[:port]).to be(12345)  
-      end
-      it "has a custom 'locale'" do
-        expect(custom_client.options[:locale]).not_to be_nil      
-        expect(custom_client.options[:locale].class).to be(Symbol)      
-        expect(custom_client.options[:locale]).to be(:fr)  
-      end
-      it "has a custom 'display_kills'" do
-        expect(custom_client.options[:display_kills]).not_to be_nil      
-        expect(custom_client.options[:display_kills]).to be_false  
-      end
-      it "has a custom 'display_actions'" do
-        expect(custom_client.options[:display_actions]).not_to be_nil      
-        expect(custom_client.options[:display_actions]).to be_false      
-      end
-      it "has a custom 'display_changelevel'" do
-        expect(custom_client.options[:display_changelevel]).not_to be_nil      
-        expect(custom_client.options[:display_changelevel]).to be_false      
-      end
-      it "has a custom 'display_chat'" do
-        expect(custom_client.options[:display_chat]).not_to be_nil      
-        expect(custom_client.options[:display_chat]).to be_false      
-      end
-      it "has a custom 'display_team_chat'" do
-        expect(custom_client.options[:display_team_chat]).not_to be_nil      
-        expect(custom_client.options[:display_team_chat]).to be_false      
+      context "when 'Displayer' parameter is set with custom options" do
+        subject(:custom_client) { Client.new(RSpecDisplayer, custom_options) }
+        it { should be_an_instance_of Client }
+        it "has a default 'options' Hash" do
+          expect(custom_client.options).not_to be_nil      
+          expect(custom_client.options.class).to be(Hash)      
+        end
+        it "has a custom 'host'" do
+          expect(custom_client.options[:host]).not_to be_nil      
+          expect(custom_client.options[:host]).to eq("127.0.0.1")      
+        end
+        it "has a custom 'port'" do
+          expect(custom_client.options[:port]).not_to be_nil      
+          expect(custom_client.options[:port]).to be(12345)  
+        end
+        it "has a custom 'locale'" do
+          expect(custom_client.options[:locale]).not_to be_nil      
+          expect(custom_client.options[:locale].class).to be(Symbol)      
+          expect(custom_client.options[:locale]).to be(:fr)  
+        end
+        it "has a custom 'display_kills'" do
+          expect(custom_client.options[:display_kills]).not_to be_nil      
+          expect(custom_client.options[:display_kills]).to be_false  
+        end
+        it "has a custom 'display_actions'" do
+          expect(custom_client.options[:display_actions]).not_to be_nil      
+          expect(custom_client.options[:display_actions]).to be_false      
+        end
+        it "has a custom 'display_changelevel'" do
+          expect(custom_client.options[:display_changelevel]).not_to be_nil      
+          expect(custom_client.options[:display_changelevel]).to be_false      
+        end
+        it "has a custom 'display_chat'" do
+          expect(custom_client.options[:display_chat]).not_to be_nil      
+          expect(custom_client.options[:display_chat]).to be_false      
+        end
+        it "has a custom 'display_team_chat'" do
+          expect(custom_client.options[:display_team_chat]).not_to be_nil      
+          expect(custom_client.options[:display_team_chat]).to be_false      
+        end
+        it "has a custom 'display_connect'" do
+          expect(custom_client.options[:display_connect]).not_to be_nil      
+          expect(custom_client.options[:display_connect]).to be_false      
+        end
+        it "has a custom 'display_disconnect'" do
+          expect(custom_client.options[:display_disconnect]).not_to be_nil      
+          expect(custom_client.options[:display_disconnect]).to be_false    
+        end
       end
 
       describe "#start and #stop" do
+        subject(:default_client) { Client.new(RSpecDisplayer) }
 
-        context "when 'start' and 'stop' are triggered one after the other"
         it "starts then stops an eventmachine with appropriate messages" do
           EM.run {
             expect(capture_stdout { default_client.start }).to eq("## 0.0.0.0:27115 => HLDS connected and sending data\n")

data/spec/displayer_spec.rb

@@ -19,14 +19,14 @@ module SteamHldsLogParser
 
       context "when 'data' is given" do
 
-        it "creates a 'Displayer'" do
-          expect(@displayer).to be_an_instance_of Displayer
-        end
+        subject { @displayer }
+        it { should be_an_instance_of Displayer } 
 
         describe "#get_data" do
+          subject { @displayer.get_data }
           it "returns 'data' given as argument" do
-            expect(@displayer.get_data).not_to be_nil      
-            expect(@displayer.get_data).to be(@data)      
+            should_not be_nil      
+            should be(@data)      
           end
         end
 

data/spec/handler_spec.rb

@@ -57,7 +57,6 @@ module SteamHldsLogParser
             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"}}
-              puts @handler.receive_data(data)
               expect(@handler.receive_data(data).class).to be(RSpecDisplayer)
               expect(@handler.receive_data(data).data).to eq(expected)
               expect(@handler.receive_data(data).data.class).to be(Hash)
@@ -164,6 +163,26 @@ module SteamHldsLogParser
             end
           end
 
+          context "when data is 'connect'" do
+            it "returns Hash when a user connects the server" do
+              data = '# L 05/10/2000 - 12:34:56: "Player<73><STEAM_ID_LAN><>" connected, address "192.168.4.186:1339"'
+              expected = {:type=>"connect", :params=>{:player=>"Player", :ip=>"192.168.4.186", :port=>"1339"}}
+              expect(@handler.receive_data(data).class).to be(RSpecDisplayer)
+              expect(@handler.receive_data(data).data).to eq(expected)
+              expect(@handler.receive_data(data).data.class).to be(Hash)
+            end
+          end
+
+          context "when data is 'disconnect'" do
+            it "returns Hash when a user disconnects" do
+              data = '# L 05/10/2000 - 12:34:56: "Player<73><STEAM_ID_LAN><TERRORIST>" disconnected'
+              expected = {:type=>"disconnect", :params=>{:player=>"Player", :player_team=>"T"}}
+              expect(@handler.receive_data(data).class).to be(RSpecDisplayer)
+              expect(@handler.receive_data(data).data).to eq(expected)
+              expect(@handler.receive_data(data).data.class).to be(Hash)
+            end
+          end
+
           subject { @custom_handler }
           context "when 'displayer' is set" do
             it "returns Hash on changelevel provided by 'displayer'" do

data/spec/helper_spec.rb

@@ -2,6 +2,12 @@ require "simplecov"
 require "coveralls"
 require "rspec"
 
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+
 # Simplecov / Coverall configuration
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
   SimpleCov::Formatter::HTMLFormatter,
@@ -45,6 +51,8 @@ def custom_options
     :display_changelevel  => false,
     :display_chat         => false,
     :display_team_chat    => false,
+    :display_connect      => false,
+    :display_disconnect   => false,
     :displayer            => RSpecDisplayer
   }  
 end

metadata

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