rmuh 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bdf1618724cb081a979f3b0f6a1a231fef6c1fa9
+  data.tar.gz: 240edd31827250c654009aa49db1642522f1a5e0
+SHA512:
+  metadata.gz: e691a5b1275db1aec06541e22f7b2d31d75a5240785e8e3fed8240f2f03afec5eca50fa76b905f23a055ad9b9a19943405216e3d3f785f9ed3eb52f2302ff9a0
+  data.tar.gz: c0af65480abe5a18f00ecc934f32ed0e9a55724fde529677cbb109db6bdef7993b28d0ca3e86161b14a5a2bf01bcb91084e5c3c3da7ddf2064a4e3fa6ec4d74c

data/.gitignore

@@ -0,0 +1,33 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+Gemfile.lock
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# misc files
+test.rb

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+- 2.1.0
+- 2.0.0
+- 1.9.3
+notifications:
+  email:
+  - tim+travisci@timheckman.net

data/Gemfile

@@ -0,0 +1,4 @@
+# -*- coding: UTF-8 -*-
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Tim Heckman
+
+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,19 @@
+RMuh
+====
+[![Build Status](https://img.shields.io/travis/theckman/rmuh/master.svg)](https://travis-ci.org/theckman/rpt-ruby)
+[![MIT Licensed](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://tldrlegal.com/license/mit-license)
+[![Coveralls Coverage](https://img.shields.io/coveralls/theckman/rmuh/master.svg)](https://coveralls.io/r/theckman/rmuh)
+[![Code Climate](https://img.shields.io/codeclimate/github/theckman/rmuh.svg)](https://codeclimate.com/github/theckman/rmuh)
+
+**RMuh**, a play on the name ArmA (Armed Assault), is a Ruby library for
+interacting with ArmA 2 servers (specifically tested against Operation
+Arrowhead servers).
+
+In short, this `README` file usless right now. It is a work in progress.
+Please refer to it in the future for more information as it should be helpful
+then...
+
+LICENSE
+-------
+**RMuh** is released under The MIT License. The full text of the license can be
+found in the `LICENSE` file

data/Rakefile

@@ -0,0 +1,15 @@
+# -*- coding: UTF-8 -*_
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+Rubocop::RakeTask.new(:rubocop) do |task|
+  task.patterns = [
+    'lib/**/*.rb', 'spec/*_spec.rb', 'Rakefile', 'rmuh.gemspec', 'Gemfile'
+  ]
+  # task.formatters = ['files']
+  task.fail_on_error = true
+end
+
+task default: [:rubocop, :spec]

data/lib/rmuh.rb

@@ -0,0 +1,22 @@
+# -*- coding: UTF-8 -*-
+# The MIT License (MIT)
+
+# Copyright (c) 2014 Tim Heckman
+
+# 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/lib/rmuh/rpt/log/fetch.rb

@@ -0,0 +1,56 @@
+# -*- coding: UTF-8 -*-
+require 'httparty'
+require 'ostruct'
+
+module RMuh
+  module RPT
+    module Log
+      # TODO: Fetch Class documentation
+      #
+      class Fetch
+        include HTTParty
+        attr_accessor :cfg
+
+        def initialize(log_url, byte_start = 0, byte_end = nil)
+          @cfg = OpenStruct.new(
+            log_url: log_url,
+            byte_start: byte_start,
+            byte_end: byte_end
+          )
+        end
+
+        def byte_start=(bytes)
+          if bytes.is_a?(Integer)
+            @cfg.byte_start = bytes
+          else
+            fail ArgumentError, 'argument 1 must be an integer'
+          end
+        end
+
+        def byte_end=(bytes)
+          if bytes.nil? || bytes.is_a?(Integer)
+            @cfg.byte_end = bytes
+          else
+            fail ArgumentError, 'argument 1 must be nil or an integer'
+          end
+        end
+
+        def size
+          self.class.head(@cfg.log_url).headers['content-length'].to_i
+        end
+
+        def log
+          headers = { 'Range' => "bytes=#{@cfg.byte_start}-#{@cfg.byte_end}" }
+          response = self.class.get(@cfg.log_url, headers: headers)
+          StringIO.new(response.lines.map { |l| dos2unix(l) }.join)
+        end
+
+        private
+
+        def dos2unix(line)
+          line.gsub("\r\n", "\n")
+        end
+      end
+    end
+  end
+end

data/lib/rmuh/rpt/log/parsers/base.rb

@@ -0,0 +1,29 @@
+# -*- coding: UTF-8 -*-
+module RMuh
+  module RPT
+    module Log
+      module Parsers
+        # This is the base RPT parser class. This does nothing but
+        # return each line as a Hash within an Array. There is no
+        # metadata extracted, it's a literal copy and paste of the
+        # provided log line. This class is primarily used as an example
+        # class to be used for subclassing of your own parser
+        #
+        class Base
+          def initialize(opts = {})
+          end
+
+          def parse(loglines)
+            fail(
+              ArgumentError, 'argument 1 must be a StringIO object'
+            ) unless loglines.is_a? StringIO
+
+            loglines.map do |line|
+              { type: :log, message: line }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rmuh/rpt/log/parsers/unitedoperationslog.rb

@@ -0,0 +1,94 @@
+# -*- coding: UTF-8 -*-
+require 'English'
+require 'tzinfo'
+require 'stringio'
+require 'rmuh/rpt/log/parsers/base'
+require 'rmuh/rpt/log/util/unitedoperations'
+require 'rmuh/rpt/log/util/unitedoperationslog'
+
+module RMuh
+  module RPT
+    module Log
+      module Parsers
+        # TODO: UnitedOperationsLog Class Documentation
+        #
+        class UnitedOperationsLog < RMuh::RPT::Log::Parsers::Base
+          include RMuh::RPT::Log::Util::UnitedOperations
+          extend RMuh::RPT::Log::Util::UnitedOperations
+          include RMuh::RPT::Log::Util::UnitedOperationsLog # Regexp Constants
+          extend RMuh::RPT::Log::Util::UnitedOperationsLog
+
+          def self.validate_opts(opts)
+            fail(
+              ArgumentError, 'arg 1 should be an instance of Hash'
+            ) unless opts.is_a?(Hash)
+            validate_bool_opt(opts, :to_zulu)
+            validate_timezone(opts)
+            validate_bool_opt(opts, :chat)
+          end
+
+          def initialize(opts = {})
+            self.class.validate_opts(opts)
+            @include_chat = opts[:chat].nil? ? false : opts[:chat]
+            @to_zulu = opts[:to_zulu].nil? ? true : opts[:to_zulu]
+            @timezone = opts[:timezone].nil? ? UO_TZ : opts[:timezone]
+          end
+
+          def parse(loglines)
+            unless loglines.is_a?(StringIO)
+              fail ArgumentError, 'arg 1 must be a StringIO object'
+            end
+            regex_matches(loglines)
+          end
+
+          private
+
+          def regex_matches(loglines)
+            loglines.map do |l|
+              line = nil
+              if GUID.match(l)
+                line = { type: :beguid }.merge(m_to_h($LAST_MATCH_INFO))
+              elsif @include_chat && CHAT.match(l)
+                line = { type: :chat }.merge(m_to_h($LAST_MATCH_INFO))
+              end
+              line_modifiers(line) unless line.nil?
+            end.compact
+          end
+
+          def line_modifiers(line)
+            when_am_i!(line)
+            zulu!(line, @timezone)
+            add_guid!(line)
+            line
+          end
+
+          def when_am_i!(line)
+            case line[:hour]
+            when 4..23
+              t = date_of_line_based_on_now
+              set_line_date!(line, t)
+            when 0..3
+              set_line_date!(line)
+            end
+            line
+          end
+
+          def date_of_line_based_on_now(time = Time.now)
+            if time.hour.between?(4, 23)
+              @timezone.now
+            else
+              @timezone.now - ONE_DAY
+            end
+          end
+
+          def set_line_date!(line, time = @timezone.now)
+            line[:year] = time.year
+            line[:month] = time.month
+            line[:day] = time.day
+            line
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rmuh/rpt/log/parsers/unitedoperationsrpt.rb

@@ -0,0 +1,65 @@
+# -*- coding: UTF-8 -*-
+require 'stringio'
+require 'English'
+require 'tzinfo'
+require 'rmuh/rpt/log/parsers/base'
+require 'rmuh/rpt/log/util/unitedoperations'
+require 'rmuh/rpt/log/util/unitedoperationsrpt'
+
+module RMuh
+  module RPT
+    module Log
+      module Parsers
+        # TODO: UnitedOperationsRPT Class Documentation
+        #
+        class UnitedOperationsRPT < RMuh::RPT::Log::Parsers::Base
+          include RMuh::RPT::Log::Util::UnitedOperations
+          extend RMuh::RPT::Log::Util::UnitedOperations
+          include RMuh::RPT::Log::Util::UnitedOperationsRPT # Regexp Constants
+
+          def self.validate_opts(opts)
+            fail ArgumentError,
+                 'argument 1 should be a Hash' unless opts.class == Hash
+            validate_bool_opt(opts, :to_zulu)
+            validate_timezone(opts)
+          end
+
+          def initialize(opts = {})
+            self.class.validate_opts(opts)
+
+            @to_zulu = opts[:to_zulu].nil? ? true : opts[:to_zulu]
+            @timezone = opts[:timezone].nil? ? UO_TZ : opts[:timezone]
+          end
+
+          def parse(loglines)
+            unless loglines.is_a?(StringIO)
+              fail ArgumentError, 'argument 1 must be a StringIO object'
+            end
+
+            loglines.map do |l|
+              line = regex_match(l)
+              zulu!(line, @timezone) if @to_zulu && !line.nil?
+              add_guid!(line) unless line.nil?
+              line
+            end.compact
+          end
+
+          private
+
+          def regex_match(l)
+            if ANNOUNCEMENT.match(l)
+              line = { type: :announcement }.merge(m_to_h($LAST_MATCH_INFO))
+            elsif WOUNDED.match(l)
+              line = { type: :wounded }.merge(m_to_h($LAST_MATCH_INFO))
+            elsif KILLED.match(l)
+              line = { type: :killed }.merge(m_to_h($LAST_MATCH_INFO))
+            elsif DIED.match(l)
+              line = { type: :died }.merge(m_to_h($LAST_MATCH_INFO))
+            end
+            (defined?(line)) ? line : nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rmuh/rpt/log/util/unitedoperations.rb

@@ -0,0 +1,127 @@
+# -*- coding: UTF-8 -*-
+require 'tzinfo'
+require 'digest'
+
+module RMuh
+  module RPT
+    module Log
+      module Util
+        # TODO: Module documentation
+        #
+        module UnitedOperations
+          UO_TZ ||= TZInfo::Timezone.get('America/Los_Angeles')
+
+          def m_to_h(match)
+            __check_match_arg(match)
+            h = {}
+            match.names.each do |m|
+              h.merge!(m.to_sym => __line_modifiers(match, m))
+            end
+            h
+          end
+
+          def __check_match_arg(match)
+            fail(
+              ArgumentError,
+              'argument 1 must be of type MatchData'
+            ) unless match.class == MatchData
+          end
+
+          def __line_modifiers(match, match_name)
+            m = match_name
+            if [:year, :month, :day, :hour, :min, :sec].include?(m.to_sym)
+              return match[m].to_i
+            elsif [:server_time, :damage, :distance, :channel, :nearby_players]
+              .include?(m.to_sym)
+              return __modifiers(match, m)
+            else
+              return match[m]
+            end
+          end
+
+          def __modifiers(match, match_name)
+            m = match_name
+            if [:server_time, :damage, :distance].include?(m.to_sym)
+              return match[m].to_f
+            elsif m.to_sym == :channel
+              return match[m].downcase
+            elsif m.to_sym == :nearby_players
+              return __parse_nearby_players(match, m)
+            end
+          end
+
+          def __parse_nearby_players(match, match_name)
+            m = match_name
+            if match[m] != 'None.'
+              val = match[m].gsub('[', '').gsub(']', '').gsub('"', '')
+              return val.split(',')
+            else
+              return []
+            end
+          end
+
+          def zulu!(line, timezone)
+            t = timezone.local_to_utc(Time.new(line[:year], line[:month],
+                                               line[:day], line[:hour],
+                                               line[:min], line[:sec]))
+
+            [:year, :month, :day, :hour, :min, :sec].each do |k|
+              line[k] = t.send(k)
+            end
+
+            line[:iso8601] = t.strftime('%Y-%m-%dT%H:%M:%SZ')
+            line[:dtg] = t.strftime('%d%H%MZ %^b %y')
+
+            line
+          end
+
+          def add_guid!(line)
+            data = __guid_data_base(line)
+            s = guid_keys.map { |k| __guid_add_data(line, k) }
+            line[:event_guid] = Digest::SHA1.hexdigest data + s.join('')
+            line
+          end
+
+          def guid_keys
+            [
+              :message, :victim, :offender, :server_time, :damage,
+              :distance, :player, :player_beguid, :channel
+            ]
+          end
+
+          def __guid_data_base(line)
+            if line[:iso8601].nil?
+              return "#{line[:year]}#{line[:month]}#{line[:day]}" \
+                     "#{line[:hour]}#{line[:min]}#{line[:sec]}" \
+                     "#{line[:type].to_s}"
+            else
+              return "#{line[:iso8601]}#{line[:type].to_s}"
+            end
+          end
+
+          def __guid_add_data(line, key)
+            data = ''
+            data << line[key].to_s unless line[key].nil?
+            data
+          end
+
+          def validate_bool_opt(opts, key)
+            if opts.key?(key) &&
+               ![TrueClass, FalseClass].include?(opts[key].class)
+              fail ArgumentError,
+                   "#{key} must be a boolean value (true|false)"
+            end
+          end
+
+          def validate_timezone(opts)
+            if opts.key?(:timezone) &&
+               opts[:timezone].class != TZInfo::DataTimezone
+              fail ArgumentError,
+                   ':tiemzone must be an instance of TZInfo::DataTimezone'
+            end
+          end
+        end
+      end
+    end
+  end
+end