lolreplay 0.1

data/Gemfile.lock

@@ -0,0 +1,10 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    json (1.6.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  json

data/README.md

@@ -0,0 +1,231 @@
+# LoL Replay Library
+
+Greetings, summoners! (too cheesy?)
+
+This is a Ruby library for accessing the end game metadata in .lrf files (LoL
+Replay files). It's pretty small and simple at the moment and just makes life a
+bit easier if you want to run some stats analysis on your LoL Replay files.
+
+# Installation
+
+Provided you have Ruby with RubyGems installed, installation is the standard gem
+one liner:
+
+    $ gem install lolreplay
+
+# Usage
+
+The program under the bin directory should give you a little idea as to how this
+library works. Here's another short example:
+
+``` ruby
+  game = LolReplay::Game.new "path/to/lrffile.lrf"
+
+  samwho = game.player "Samwho"
+
+  samwho.kills
+  #=> the number of kills I had
+
+  samwho.largest_crit
+  #=> the largest crit I did
+
+  samwho.gold
+  #=> the amount of gold I earned
+
+  samwho.killing_spree
+  #=> the largest killing spree I had
+```
+
+LoL Replay files contain JSON metadata in them, all this library
+does is read that metadata and expose it through some classes. I took a bit of a
+shortcut when exposing the JSON data and made the method names the hash keys. So
+there isn't a single method for each bit of data, the method names are
+dynamically translated from underscored_names to camelCase and then fed to the
+hash as a key.
+
+The upside is that the library should stand the test of time. Provided the guys
+at LoL Replay don't change where the JSON data is located in the file, this
+library should be able to get at any new metadata added to the files.
+
+The downside is that RDocs won't represent the library very well. So I'll
+explain how to know where to find the data you want.
+
+# What data can I access?
+
+Here's some JSON output of a recent game I had:
+
+``` json
+{
+  "accountID": 12345678,
+    "clientHash": "6f7t2dcaga7hfg64g9433408s8defy6y",
+    "clientVersion": "1.0.0.130",
+    "dataIndex": [
+    {
+      "Key": "stream",
+      "Value": {
+        "offset": 0,
+        "size": 4367077
+      }
+    },
+    {
+      "Key": "s0",
+      "Value": {
+        "offset": 4367077,
+        "size": 84609
+      }
+    },
+    {
+      "Key": "s1",
+      "Value": {
+        "offset": 4451686,
+        "size": 109687
+      }
+    },
+    {
+      "Key": "s2",
+      "Value": {
+        "offset": 4561373,
+        "size": 112188
+      }
+    },
+    {
+      "Key": "s3",
+      "Value": {
+        "offset": 4673561,
+        "size": 132680
+      }
+    },
+    {
+      "Key": "s4",
+      "Value": {
+        "offset": 4806241,
+        "size": 93201
+      }
+    },
+    {
+      "Key": "s5",
+      "Value": {
+        "offset": 4899442,
+        "size": 107907
+      }
+    },
+    {
+      "Key": "s6",
+      "Value": {
+        "offset": 5007349,
+        "size": 113622
+      }
+    }
+  ],
+    "encryptionKey": "tPsrrs4l8e0qqe3ly6ouut4p",
+    "firstWinBonus": 0,
+    "gameMode": 1,
+    "map": 2,
+    "matchID": 263521613,
+    "matchLength": 1849,
+    "matchType": 3,
+    "name": "YouSummonerName - ChampionName",
+    "players": [
+    {
+      "accountID": 23608408,
+      "assists": 8,
+      "barracks": 0,
+      "champion": "XinZhao",
+      "damageDealt": 49554,
+      "damageTaken": 22591,
+      "deaths": 7,
+      "elo": 0,
+      "eloChange": 0,
+      "gold": 5860,
+      "healed": 3375,
+      "item1": 1055,
+      "item2": 3006,
+      "item3": 3072,
+      "item4": 3086,
+      "killingSpree": 2,
+      "kills": 2,
+      "largestCrit": 389,
+      "largestMultiKill": 1,
+      "leaver": false,
+      "leaves": 8,
+      "level": 13,
+      "losses": 143,
+      "magicDamageDealt": 965,
+      "magicDamageTaken": 8270,
+      "minions": 69,
+      "neutralMinionsKilled": 6,
+      "physicalDamageDealt": 48589,
+      "physicalDamageTaken": 13535,
+      "profileIconId": 23,
+      "spell1": 3,
+      "spell2": 4,
+      "summoner": "ASummonerName",
+      "summonerLevel": 30,
+      "team": 2,
+      "timeDead": 195,
+      "turrets": 0,
+      "wins": 153,
+      "won": false
+    }],
+    "queueType": "NORMAL",
+    "ranked": false,
+    "region": "EUW",
+    "replayID": -1,
+    "replayVersion": "0.7.4.12",
+    "screenshots": [
+    {
+      "name": "s0",
+      "timestamp": 30052,
+      "type": ".jpg"
+    },
+    {
+      "name": "s1",
+      "timestamp": 329992,
+      "type": ".jpg"
+    },
+    {
+      "name": "s2",
+      "timestamp": 630036,
+      "type": ".jpg"
+    },
+    {
+      "name": "s3",
+      "timestamp": 930077,
+      "type": ".jpg"
+    },
+    {
+      "name": "s4",
+      "timestamp": 1230186,
+      "type": ".jpg"
+    },
+    {
+      "name": "s5",
+      "timestamp": 1530203,
+      "type": ".jpg"
+    },
+    {
+      "name": "s6",
+      "timestamp": 1830247,
+      "type": ".jpg"
+    }
+  ],
+    "serverAddress": "31.186.224.155",
+    "serverPort": 5158,
+    "spectatorMode": false,
+    "summonerName": "YourSummerName",
+    "teams": null,
+    "timestamp": 1323233142,
+    "winningTeam": 1
+}
+```
+
+I've scrubbed any sensitive data and the names and timestamps have all been
+changed, just in case I get in trouble.
+
+Basically, you can access all of this. The LolReplay::Game object you create
+will have this JSON inside it and whenever a method comes in, it will convert
+the method name from an underscore_name to a camelCase name and use it as a key
+to this hash.
+
+To access the players, use the `players` method. Then you can access all of the
+stuff you see for the example player up there. That's all there is to it :)

data/lib/lolreplay.rb

@@ -0,0 +1,5 @@
+# Require all files in the main lib directory
+Dir[File.dirname(__FILE__) + '/lolreplay/**/*.rb'].each do |file|
+  require file
+end
+

data/lib/lolreplay/game.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/hash_method_accessor'
+require 'json'
+
+module LolReplay
+  class Game
+    include ::HashMethodAccessor
+    attr_accessor :json, :path, :players
+
+    # Constructor takes a path to a .lrf file. The file path that it is given
+    # is read and the meta data is extracted for later use.
+    def initialize path
+      @path = path
+
+      @data = File.open(path) do |f|
+        f.read(4) # skip first four bytes
+        size = f.read(4).unpack("L").first
+        JSON.parse f.read(size), symbolize_names: true
+      end
+
+      @players = @data[:players].map { |p| Player.new p }
+    end
+
+    # Gets a player by name. If the player was not present in this game, nil
+    # is returned.
+    #
+    # Example:
+    #
+    #   puts game.player "Samwho"
+    #   #=> #<LolReplay::Player:0x8317074>
+    def player name
+      @players.each do |player|
+        return player if player.name == name
+      end
+
+      nil
+    end
+  end
+end

data/lib/lolreplay/hash_method_accessor.rb

@@ -0,0 +1,10 @@
+module HashMethodAccessor
+  def method_missing id, *args
+    hash_key = id.to_s.gsub(/_./) { $&[1].chr.upcase }.to_sym
+    if @data[hash_key].nil?
+      super
+    else
+      @data[hash_key]
+    end
+  end
+end

data/lib/lolreplay/player.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/hash_method_accessor'
+
+module LolReplay
+  class Player
+    include ::HashMethodAccessor
+
+    def initialize data
+      @data = data
+    end
+
+    # Alias for summoner
+    def name
+      @data[:summoner]
+    end
+
+    # Alias for leaver
+    def leaver?
+      @data[:leaver]
+    end
+
+    # Alias for won
+    def won?
+      @data[:won]
+    end
+
+    def to_s
+
+    end
+  end
+end

data/lib/lolreplay/string.rb

@@ -0,0 +1,3 @@
+class String
+
+end

data/lolreplay.gemspec

@@ -0,0 +1,16 @@
+Gem::Specification.new do |s|
+  s.name = %q{lolreplay}
+  s.version = "0.1"
+  s.date = %q{2011-12-11}
+  s.authors = ["Sam Rose"]
+  s.email = %q{samwho@lbak.co.uk}
+  s.summary = %q{A library for accessing the metadata of LoL Replay .lrf files.}
+  s.homepage = %q{http://github.com/samwho/lolreplay}
+  s.description = %q{Allows for access of the metadata in a LoL Replay .lrf file.}
+  s.required_ruby_version = '>= 1.9.2'
+  s.license = 'GPL-2'
+
+  # Add all files to the files parameter.
+  s.files = []
+  Dir["**/*.*"].each { |path| s.files.push path }
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: lolreplay
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Sam Rose
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-11 00:00:00.000000000Z
+dependencies: []
+description: Allows for access of the metadata in a LoL Replay .lrf file.
+email: samwho@lbak.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lolreplay.gemspec
+- README.md
+- lib/lolreplay/game.rb
+- lib/lolreplay/string.rb
+- lib/lolreplay/player.rb
+- lib/lolreplay/hash_method_accessor.rb
+- lib/lolreplay.rb
+- lolreplay-0.1.gem
+- Gemfile.lock
+homepage: http://github.com/samwho/lolreplay
+licenses:
+- GPL-2
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: A library for accessing the metadata of LoL Replay .lrf files.
+test_files: []