steam_codec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a20d0abedea3bf35bc7450fb8574604122eb1eb0
+  data.tar.gz: 49112685b3c267451119b966912abe90fafd0e5f
+SHA512:
+  metadata.gz: 04de7885b1804cd714e7e4e662b47628593f2b32af300d863f05856d6dbb24049cb7f0ced3c60e534a1c900c6bcae024dafa834f8dc8ac1e1518418c29fdb489
+  data.tar.gz: b0057fcefcf85748fe4d3fa4767eb3d44b05407727206b8a70e9e88c31dcd343179d1bf48d0ad595b9a75791211405ba73c3733255aa7302732d81132a142a14

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,21 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head
+jdk:
+  - oraclejdk7
+  - openjdk7
+matrix:
+  exclude:
+    - rvm: 2.0.0
+      jdk: openjdk7
+    - rvm: 1.9.3
+      jdk: openjdk7
+    - rvm: rbx-19mode
+      jdk: openjdk7
+    - rvm: ruby-head
+      jdk: openjdk7

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+group :development, :test do
+    gem 'redcarpet',  :platforms => [:ruby, :mswin, :mingw]
+    gem 'coveralls',  require: false if ENV['CI']
+end
+
+# Specify your gem's dependencies in SteamCodec.gemspec
+gemspec

data/README.md

@@ -0,0 +1,90 @@
+# SteamCodec
+
+SteamCodec is a library for working with different [Steam client](http://store.steampowered.com/about/) (and [Source engine](http://source.valvesoftware.com/)) file formats.
+
+Currently supported formats:
+
+* [KeyValues](https://developer.valvesoftware.com/wiki/KeyValues)
+* VDF (Valve Data Format)
+* ACF (ApplicationCacheFile)
+
+
+PKV (packed KeyValues) isn't supported yet.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'steam_codec'
+```
+
+And then execute:
+
+```shell
+bundle
+```
+
+Or install it yourself as:
+
+```shell
+gem install SteamCodec
+```
+
+### Dependencies
+
+gem `insensitive_hash`
+
+## Usage
+
+```ruby
+require 'steam_codec'
+
+File.open("appmanifest_220.acf") do |file|
+    acf = SteamCodec::ACF::loadFromFile(file)
+    puts acf.UserConfig.Name
+end
+```
+
+## Documentation
+
+YARD with markdown is used for documentation (`redcarpet` required)
+
+## Specs
+
+RSpec and simplecov are required, to run tests just `rake spec`
+code coverage will also be generated
+
+## Code status
+
+[![Build Status](https://travis-ci.org/davispuh/SteamCodec.png?branch=master)](https://travis-ci.org/davispuh/SteamCodec)
+[![Dependency Status](https://gemnasium.com/davispuh/SteamCodec.png)](https://gemnasium.com/davispuh/SteamCodec)
+[![Coverage Status](https://coveralls.io/repos/davispuh/SteamCodec/badge.png)](https://coveralls.io/r/davispuh/SteamCodec)
+
+## Unlicense
+
+![Copyright-Free](http://unlicense.org/pd-icon.png)
+
+All text, documentation, code and files in this repository are in public domain (including this text, README).
+It means you can copy, modify, distribute and include in your own work/code, even for commercial purposes, all without asking permission.
+
+[About Unlicense](http://unlicense.org/)
+
+## Contributing
+
+Feel free to improve anything.
+
+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
+
+
+**Warning**: By sending pull request to this repository you dedicate any and all copyright interest in pull request (code files and all other) to the public domain. (files will be in public domain even if pull request doesn't get merged)
+
+Also before sending pull request you acknowledge that you own all copyrights or have authorization to dedicate them to public domain.
+
+If you don't want to dedicate code to public domain or if you're not allowed to (eg. you don't own required copyrights) then DON'T send pull request.
+

data/Rakefile

@@ -0,0 +1,13 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'yard'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new(:spec) do |t|
+end
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+end

data/UNLICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <http://unlicense.org/>

data/lib/steam_codec.rb

@@ -0,0 +1,5 @@
+require "steam_codec/version"
+require "steam_codec/key_values"
+require "steam_codec/value_array"
+require "steam_codec/vdf"
+require "steam_codec/acf"

data/lib/steam_codec/ACF.rb

@@ -0,0 +1,176 @@
+module SteamCodec
+    class ACF
+
+        # More about AppID => https://developer.valvesoftware.com/wiki/Steam_Application_IDs
+        attr_accessor :AppID
+        attr_accessor :Universe
+        attr_accessor :StateFlags
+        attr_accessor :InstallDir
+        attr_accessor :LastUpdated
+        attr_accessor :UpdateResult
+        attr_accessor :SizeOnDisk
+        attr_accessor :BuildID
+        attr_accessor :LastOwner
+        attr_accessor :BytesToDownload
+        attr_accessor :BytesDownloaded
+        attr_accessor :FullValidateOnNextUpdate
+        attr_reader :UserConfig
+        attr_reader :MountedDepots
+        attr_reader :SharedDepots
+        attr_reader :CheckGuid
+        attr_reader :InstallScripts
+        def self.loadFromFile(file)
+            acf = KeyValues::loadFromFile(file)
+            return self.new(acf.AppState) if acf and acf.key?(:AppState)
+            nil
+        end
+
+        def self.load(data)
+            acf = KeyValues::load(data)
+            return self.new(acf.AppState) if acf and acf.key?(:AppState)
+            nil
+        end
+
+        def initialize(appState = nil)
+            load(appState || KeyValues.new)
+        end
+
+        def load(appState)
+            raise ArgumentError, "AppState must be instance of KeyValues" unless appState.is_a?(KeyValues)
+            @AppState = appState
+            @AppID = @AppState.AppID.to_i if @AppState.key?(:AppID)
+            @Universe = @AppState.Universe.to_i if @AppState.key?(:Universe)
+            @StateFlags = @AppState.StateFlags.to_i if @AppState.key?(:StateFlags)
+            @InstallDir = @AppState.InstallDir if @AppState.key?(:InstallDir)
+            @LastUpdated = @AppState.LastUpdated.to_i if @AppState.key?(:LastUpdated)
+            @UpdateResult = @AppState.UpdateResult.to_i if @AppState.key?(:UpdateResult)
+            @SizeOnDisk = @AppState.SizeOnDisk.to_i if @AppState.key?(:SizeOnDisk)
+            @BuildID = @AppState.BuildID.to_i if @AppState.key?(:BuildID)
+            @LastOwner = @AppState.LastOwner if @AppState.key?(:LastOwner)
+            @BytesToDownload = @AppState.BytesToDownload.to_i if @AppState.key?(:BytesToDownload)
+            @BytesDownloaded = @AppState.BytesDownloaded.to_i if @AppState.key?(:BytesDownloaded)
+            @FullValidateOnNextUpdate = !@AppState.FullValidateOnNextUpdate.to_i.zero? if @AppState.key?(:FullValidateOnNextUpdate)
+            userConfig = nil
+            mountedDepots = {}
+            sharedDepots = {}
+            checkGuid = {}
+            installScripts = {}
+            userConfig = @AppState.UserConfig if @AppState.key?(:UserConfig)
+            mountedDepots = @AppState.MountedDepots if @AppState.key?(:MountedDepots)
+            sharedDepots = @AppState.SharedDepots if @AppState.key?(:sharedDepots)
+            checkGuid = @AppState.CheckGuid if @AppState.key?(:CheckGuid)
+            installScripts = @AppState.InstallScripts if @AppState.key?(:InstallScripts)
+            @UserConfig = UserConfig.new(userConfig)
+            @MountedDepots = MountedDepots.new(mountedDepots)
+            @SharedDepots = SharedDepots.new(sharedDepots)
+            @InstallScripts = InstallScripts.new(installScripts)
+        end
+
+        class UserConfig
+            attr_accessor :Name
+            attr_accessor :GameID
+            attr_accessor :Installed
+            attr_accessor :AppInstallDir
+            attr_accessor :Language
+            attr_accessor :BetaKey
+            def initialize(userConfig = nil)
+                load(userConfig || KeyValues.new)
+            end
+
+            def load(userConfig)
+                raise ArgumentError, "UserConfig must be instance of KeyValues" unless userConfig.is_a?(KeyValues)
+                @UserConfig = userConfig
+                @Name = @UserConfig.name if @UserConfig.key?(:name)
+                @GameID = @UserConfig.gameid.to_i if @UserConfig.key?(:gameid)
+                @Installed = !@UserConfig.installdir.to_i.zero? if @UserConfig.key?(:installdir)
+                @AppInstallDir = @UserConfig.appinstalldir if @UserConfig.key?(:appinstalldir)
+                @Language = @UserConfig.language if @UserConfig.key?(:language)
+                @BetaKey = @UserConfig.BetaKey if @UserConfig.key?(:BetaKey)
+            end
+        end
+
+        class MountedDepots
+            def initialize(mountedDepots = {})
+                load(mountedDepots)
+            end
+
+            def load(mountedDepots)
+                raise ArgumentError, "MountedDepots must be instance of Hash" unless mountedDepots.is_a?(Hash)
+                @MountedDepots = {}
+                mountedDepots.each do |depot, manifest|
+                    @MountedDepots[depot.to_i] = manifest
+                end
+            end
+
+            def depots
+                @MountedDepots.keys
+            end
+
+            def manifests
+                @MountedDepots.values
+            end
+
+            def getManifest(depotID)
+                @MountedDepots.each do |depot, manifest|
+                    return manifest if depot == depotID
+                end
+                nil
+            end
+
+            def getDepot(manifestID)
+                @MountedDepots.each do |depot, manifest|
+                    return depot if manifest == manifestID
+                end
+                nil
+            end
+
+            def set(depot, manifest)
+                @MountedDepots[depot] = manifest
+            end
+
+            def remove(depot)
+                @MountedDepots.delete(depot)
+            end
+        end
+
+        class SharedDepots
+            attr_reader :Depots
+            def initialize(sharedDepots = {})
+                load(sharedDepots)
+            end
+
+            def load(sharedDepots)
+                raise ArgumentError, "SharedDepots must be instance of Hash" unless sharedDepots.is_a?(Hash)
+                @SharedDepots = {}
+                sharedDepots.each do |depot, baseDepot|
+                    @SharedDepots[depot.to_i] = baseDepot.to_i
+                end
+            end
+
+            def depots
+                @SharedDepots.keys
+            end
+
+            def getDepot(depotID)
+                @SharedDepots.each do |depot, baseDepot|
+                    return baseDepot if depot == depotID
+                end
+                nil
+            end
+
+            def set(depot, baseDepot)
+                @SharedDepots[depot] = baseDepot
+            end
+
+            def remove(depot)
+                @SharedDepots.delete(depot)
+            end
+        end
+
+        class CheckGuid < ValueArray
+        end
+
+        class InstallScripts < ValueArray
+        end
+    end
+end

data/lib/steam_codec/key_values.rb

@@ -0,0 +1,116 @@
+require 'json'
+require 'insensitive_hash/minimal'
+
+module SteamCodec
+    # About KeyValues => https://developer.valvesoftware.com/wiki/KeyValues
+    # Valve's implementation => https://github.com/ValveSoftware/source-sdk-2013/blob/master/mp/src/tier1/KeyValues.cpp
+    # SteamKit's implementation => https://github.com/SteamRE/SteamKit/blob/master/SteamKit2/SteamKit2/Types/KeyValue.cs
+    class KeyValues < InsensitiveHash
+        class Parser
+            def self.proccess(data, last = true)
+                token = /"[^"]*"/
+                data = data.gsub(/(?<=^|[\s{}])(\s*)([^"{}\s\n\r]+)(\s*)(?=[\s{}]|\z)/, '\1"\2"\3')
+                if last
+                    data.gsub!(/(#{token}:\s*#{token}|})(?=\s*")/, '\1,')
+                    data.gsub!(/(#{token})(?=\s*{|[ \t\f]+")/, '\1:')
+                else
+                    data.gsub!(/(#{token}:\s*#{token}|})(?=\s*"|\s*\z)/, '\1,')
+                    data.gsub!(/(#{token})(?=\s*{|[ \t\f]+"|\s*\z)/, '\1:')
+                end
+                data
+            end
+
+            def self.isEscaped(data, index, char = '\\')
+                return false if index == 0
+                escaped = false
+                (index - 1).downto(0) do |num|
+                    if data[num] == char
+                        escaped = !escaped
+                    else
+                        break
+                    end
+                end
+                escaped
+            end
+
+            def self.getQuoteList(data)
+                indexes = []
+                quoted = false
+                length = data.length
+                length.times do |index|
+                    if data[index] == '"'
+                        escaped = false
+                        escaped = self.isEscaped(data, index) if quoted
+                        if not escaped
+                            indexes << index
+                            quoted = !quoted
+                        end
+                    end
+                end
+                raise RuntimeError, "Unmatched quotes" if quoted
+                indexes
+            end
+
+            def self.toJSON(data)
+                raise ArgumentError, "data must be String" unless data.is_a?(String)
+                str = ''
+                previous = 0
+                data.gsub!(/^#(include|base).*$/, '') # include and base not supported so just ignore
+                quoteList = self.getQuoteList(data)
+                quoteList.each_index  do |index|
+                    quoted = index % 2 == 1
+                    part = data[previous...quoteList[index]]
+                    previous = quoteList[index] + 1
+                    next if part.empty? and not quoted
+                    if quoted
+                        str += '"' + part.gsub(/\n/,'\n') + '"'
+                        lastIndex = data.length
+                        lastIndex = quoteList[index + 1] if index + 1 < quoteList.length
+                        nextPart = data[previous...lastIndex].gsub(/\\\\.*$/,'') # remove comments
+                        nextPart = self.proccess(nextPart, true)
+                        case nextPart
+                        when /\A(\s*{|[ \t]+\z)/
+                            str += ':'
+                        when /\A\s+\z/
+                            str += ','
+                        end
+                    else
+                        part = part.gsub(/\\\\[^\n]*$/,'') # remove comments
+                        str += self.proccess(part, index + 1 >= quoteList.length)
+                    end
+                end
+                lastIndex = data.length
+                part = data[previous...lastIndex]
+                str += self.proccess(part, true) if part
+                '{' + str + '}'
+            end
+        end
+
+        def self.loadFromJSON(json)
+            JSON.parse(json, {:object_class => self})
+        rescue JSON::ParserError
+            nil
+        end
+
+        def self.loadFromFile(file)
+            raise ArgumentError, "file must respond to :read" unless file.respond_to?(:read)
+            json = self::Parser::toJSON(file.read)
+            self.loadFromJSON(json)
+        end
+
+        def self.load(data)
+            json = self::Parser::toJSON(data)
+            self.loadFromJSON(json)
+        end
+
+        def method_missing(name, *args, &block) # :nodoc:
+            return self[name] if args.empty? and block.nil? and key?(name)
+            super
+        end
+
+        def respond_to_missing?(name, include_private = false) # :nodoc:
+            return true if key?(name)
+            super
+        end
+    end
+end

data/lib/steam_codec/value_array.rb

@@ -0,0 +1,45 @@
+module SteamCodec
+    class ValueArray
+        def initialize(valueHash = {})
+            load(valueHash)
+        end
+
+        def load(valueHash)
+            raise ArgumentError, "ValueHash must be instance of Hash" unless valueHash.is_a?(Hash)
+            @ValueHash = {}
+            valueHash.each do |id, file|
+                @ValueHash[id.to_i] = file
+            end
+        end
+
+        def [](id)
+            @ValueHash[id]
+        end
+
+        def []=(id, file)
+            @ValueHash[id] = file
+        end
+
+        def add(file)
+            id = @ValueHash.keys.max + 1
+            @ValueHash[id] = file
+            id
+        end
+
+        def remove(id)
+            @ValueHash.delete(id)
+        end
+
+        def to_a
+            check = []
+            @ValueHash.sort_by { |key, value| key.to_s.to_i }.each do |array|
+                check << array.last
+            end
+            check
+        end
+
+        alias_method :all, :to_a
+        alias_method :get, :[]
+        alias_method :set, :[]=
+    end
+end

data/lib/steam_codec/vdf.rb

@@ -0,0 +1,26 @@
+module SteamCodec
+    class VDF < KeyValues
+        # About VDF => http://wiki.teamfortress.com/wiki/WebAPI/VDF
+        def self.loadFromFile(file)
+            vdf = KeyValues::loadFromFile(file)
+            return self[vdf] if vdf
+            nil
+        end
+
+        def self.load(data)
+            vdf = KeyValues::load(data)
+            return self[vdf] if vdf
+            nil
+        end
+
+        def isSignaturesValid?(publicKey)
+            return true unless key?("kvsignatures")
+            self["kvsignatures"].each do |key, signature|
+                # TODO
+                return false
+            end
+            true
+        end
+
+    end
+end

data/lib/steam_codec/version.rb

@@ -0,0 +1,3 @@
+module SteamCodec
+  VERSION = "0.0.1"
+end

data/spec/acf_spec.rb

@@ -0,0 +1,137 @@
+require 'spec_helper'
+
+describe SteamCodec::ACF do
+
+    let(:appCacheFile) { <<-EOS
+        "AppState"
+        {
+            "appid"             "207930"
+            "Universe"          "1"
+            "StateFlags"        "4"
+            "installdir"        "sacred_citadel"
+            "LastUpdated"       "1377100000"
+            "UpdateResult"      "0"
+            "SizeOnDisk"        "1193761500"
+            "buildid"           "60250"
+            "LastOwner"         "0"
+            "BytesToDownload"   "0"
+            "BytesDownloaded"   "0"
+            "FullValidateOnNextUpdate"    "1"
+            "UserConfig"
+            {
+                "name"          "Sacred Citadel"
+                "gameid"        "207930"
+                "installed"     "1"
+                "appinstalldir" "C:\\Steam\\steamapps\\common\\sacred_citadel"
+                "language"      "english"
+                "BetaKey"       "public"
+            }
+            "MountedDepots"
+            {
+                "228982"        "6039653574073929574"
+                "228983"        "4721092052804263356"
+            }
+            "SharedDepots"
+            {
+                "228984"        "228980"
+            }
+            "checkguid"
+            {
+                "0"     "Bin\\some.exe"
+                "1"     "Bin\\another.exe"
+            }
+            "InstallScripts"
+            {
+                "0"     "_CommonRedist\\vcredist\\2008\\installscript.vdf"
+                "1"     "_CommonRedist\\vcredist\\2010\\installscript.vdf"
+            }
+        }
+        EOS
+    }
+
+    describe '.loadFromFile' do
+        it 'should successfully load from file' do
+            StringIO.open(appCacheFile) do |file|
+                SteamCodec::ACF::loadFromFile(file).should be_an_instance_of SteamCodec::ACF
+            end
+        end
+    end
+
+    describe '.load' do
+        it 'should successfully load' do
+            SteamCodec::ACF::load(appCacheFile).should be_an_instance_of SteamCodec::ACF
+        end
+    end
+
+    describe '.new' do
+        it 'should initialize new instance with empty fields' do
+            SteamCodec::ACF.new.AppID.should be_nil
+        end
+    end
+
+    describe '#InstallDir' do
+        it 'should return value' do
+            SteamCodec::ACF::load(appCacheFile).InstallDir.should eq("sacred_citadel")
+        end
+    end
+
+    describe SteamCodec::ACF::UserConfig do
+        describe '.new' do
+            it 'should initialize new instance with empty fields' do
+                SteamCodec::ACF::UserConfig.new.Name.should be_nil
+            end
+
+            it 'should initialize new instance with provided fields' do
+                SteamCodec::ACF::UserConfig.new(SteamCodec::KeyValues[{"Name" => "Game"}]).Name.should eq("Game")
+            end
+        end
+    end
+
+    describe SteamCodec::ACF::MountedDepots do
+        let(:depots) { {"228982" => "6039653574073929574"} }
+        describe '.new' do
+            it 'should initialize new instance with empty fields' do
+                SteamCodec::ACF::MountedDepots.new.depots.should eq([])
+                SteamCodec::ACF::MountedDepots.new.manifests.should eq([])
+            end
+
+            it 'should initialize new instance with provided fields' do
+                SteamCodec::ACF::MountedDepots.new(depots).depots.should eq([228982])
+                SteamCodec::ACF::MountedDepots.new(depots).manifests.should eq(["6039653574073929574"])
+            end
+        end
+
+        describe '#getManifest' do
+            it 'should return manifest' do
+                SteamCodec::ACF::MountedDepots.new(depots).getManifest(228982).should eq("6039653574073929574")
+            end
+        end
+
+        describe '#getDepot' do
+            it 'should return depot' do
+                SteamCodec::ACF::MountedDepots.new(depots).getDepot("6039653574073929574").should eq(228982)
+            end
+        end
+    end
+
+    describe SteamCodec::ACF::SharedDepots do
+        let(:depots) { {"228984" => "228980"} }
+        describe '.new' do
+            it 'should initialize new instance with empty fields' do
+                SteamCodec::ACF::SharedDepots.new.depots.should eq([])
+            end
+
+            it 'should initialize new instance with provided fields' do
+                SteamCodec::ACF::SharedDepots.new(depots).depots.should eq([228984])
+                SteamCodec::ACF::SharedDepots.new(depots).getDepot(228984).should eq(228980)
+            end
+        end
+
+        describe '#getDepot' do
+            it 'should return depot' do
+                SteamCodec::ACF::SharedDepots.new(depots).getDepot(228984).should eq(228980)
+            end
+        end
+    end
+
+end

data/spec/key_values_spec.rb

@@ -0,0 +1,179 @@
+require 'spec_helper'
+
+describe SteamCodec::KeyValues do
+
+    let(:tokenKey) { 'TokenKey123' }
+    let(:tokenValue) { 'Token+Value4567' }
+    let(:tokenKeyQuoted) { "\"#{tokenKey}\"" }
+    let(:tokenValueQuoted) { "\"#{tokenValue}\"" }
+
+    let(:jsonSample1a) { "#{tokenKeyQuoted} #{tokenValueQuoted}" }
+    let(:jsonSample1b) { "#{tokenKeyQuoted}\n{\t#{tokenKeyQuoted}\t#{tokenValueQuoted}\n}" }
+
+    let(:jsonSample2a) { "#{tokenKeyQuoted} #{tokenValueQuoted}\n#{tokenKeyQuoted}\t#{tokenValueQuoted}" }
+    let(:jsonSample2b) { "#{tokenKeyQuoted}\t{}\n#{tokenKeyQuoted} #{tokenValueQuoted}" }
+
+    let(:jsonSample3a) { '"Ke\\ty\\\\is" "Val\\nue\\\\\\""' }
+    let(:jsonSample3b) { '"Ke\\\\ty\\is\\\\" "te\\\\s\\\\n\\\\v\\"\\\\"' }
+
+    let(:jsonSample4a) { "#{tokenKey} #{tokenValue}" }
+    let(:jsonSample4b) { "#{tokenKey}\n{\t#{tokenKey}\t#{tokenValue}\n}" }
+
+    let(:jsonSample5a) { 'abc "lol this {weird string}"' }
+    let(:jsonSample5b) { "\"\\\"really weird\\\"\n{\n\\\"string\\\" \\\"this is\\\"\n}\"\n{\n\"string\" \"this is\"\n}" }
+
+    let(:jsonSample6a) { "#{tokenKeyQuoted}\\\\this should be ignored\n{\t#{tokenKeyQuoted}\t#{tokenValueQuoted}\n}" }
+
+    let(:jsonSample7a) { "#base <blah.vdf>\n#{tokenKey}\n{\t#{tokenKey}\t#{tokenValue}\n}" }
+    let(:jsonSample7b) { "#include <blah.vdf>\n#{tokenKey}\n{\t#{tokenKey}\t#{tokenValue}\n}" }
+
+    let(:keyValueData) { <<-EOS
+        "AppState"
+        {
+            "appid"     "320"
+            "Universe"  "1"
+        }
+        EOS
+    }
+
+    describe SteamCodec::KeyValues::Parser do
+
+        describe '.isEscaped' do
+            it 'empty string should not be escaped' do
+                SteamCodec::KeyValues::Parser::isEscaped('', 0).should be_false
+            end
+
+            it 'should be escaped' do
+                SteamCodec::KeyValues::Parser::isEscaped('\\"', 1).should be_true
+                SteamCodec::KeyValues::Parser::isEscaped('\\\\\\"', 3).should be_true
+                SteamCodec::KeyValues::Parser::isEscaped('trol\\lol\\lol\\"trrr', 13).should be_true
+            end
+
+            it 'should not be escaped' do
+                SteamCodec::KeyValues::Parser::isEscaped('\\\\"', 2).should be_false
+                SteamCodec::KeyValues::Parser::isEscaped('\\\\\\\\"', 4).should be_false
+                SteamCodec::KeyValues::Parser::isEscaped('trol\\lol\\lol\\\\"trrr', 14).should be_false
+            end
+
+        end
+
+        describe '.toJSON' do
+            it 'should convert correctly empty data' do
+                SteamCodec::KeyValues::Parser::toJSON('').should eq('{}')
+            end
+
+            it 'should raise exception on invalid data' do
+                expect { SteamCodec::KeyValues::Parser::toJSON(nil) }.to raise_error(ArgumentError)
+                expect { SteamCodec::KeyValues::Parser::toJSON({})  }.to raise_error(ArgumentError)
+            end
+
+            it 'should add colon after tokens' do
+                SteamCodec::KeyValues::Parser::toJSON(jsonSample1a).should eq("{#{tokenKeyQuoted}: #{tokenValueQuoted}}")
+                SteamCodec::KeyValues::Parser::toJSON(jsonSample1b).should eq("{#{tokenKeyQuoted}:\n{\t#{tokenKeyQuoted}:\t#{tokenValueQuoted}\n}}")
+            end
+
+            it 'should add comma after entries' do
+                SteamCodec::KeyValues::Parser::toJSON(jsonSample2a).should eq("{#{tokenKeyQuoted}: #{tokenValueQuoted},\n#{tokenKeyQuoted}:\t#{tokenValueQuoted}}")
+                SteamCodec::KeyValues::Parser::toJSON(jsonSample2b).should eq("{#{tokenKeyQuoted}:\t{},\n#{tokenKeyQuoted}: #{tokenValueQuoted}}")
+            end
+
+            it 'should regard slashes' do
+                SteamCodec::KeyValues::Parser::toJSON(jsonSample3a).should eq('{"Ke\\ty\\\\is": "Val\\nue\\\\\\""}')
+                SteamCodec::KeyValues::Parser::toJSON(jsonSample3b).should eq('{"Ke\\\\ty\\is\\\\": "te\\\\s\\\\n\\\\v\\"\\\\"}')
+            end
+
+            it 'should parse keys and values without quotes' do
+                SteamCodec::KeyValues::Parser::toJSON(jsonSample4a).should eq("{#{tokenKeyQuoted}: #{tokenValueQuoted}}")
+                SteamCodec::KeyValues::Parser::toJSON(jsonSample4b).should eq("{#{tokenKeyQuoted}:\n{\t#{tokenKeyQuoted}:\t#{tokenValueQuoted}\n}}")
+            end
+
+            it 'should parse special cases' do
+                SteamCodec::KeyValues::Parser::toJSON(jsonSample5a).should eq("{\"abc\": \"lol this {weird string}\"}")
+                SteamCodec::KeyValues::Parser::toJSON(jsonSample5b).should eq("{\"\\\"really weird\\\"\\n{\\n\\\"string\\\" \\\"this is\\\"\\n}\":\n{\n\"string\": \"this is\"\n}}")
+            end
+
+            it 'should ignore comments' do
+                SteamCodec::KeyValues::Parser::toJSON(jsonSample6a).should eq("{#{tokenKeyQuoted}:\n{\t#{tokenKeyQuoted}:\t#{tokenValueQuoted}\n}}")
+            end
+
+            it 'should ignore #include and #base' do
+                SteamCodec::KeyValues::Parser::toJSON(jsonSample7a).should eq("{\n#{tokenKeyQuoted}:\n{\t#{tokenKeyQuoted}:\t#{tokenValueQuoted}\n}}")
+                SteamCodec::KeyValues::Parser::toJSON(jsonSample7b).should eq("{\n#{tokenKeyQuoted}:\n{\t#{tokenKeyQuoted}:\t#{tokenValueQuoted}\n}}")
+            end
+        end
+    end
+
+    describe '.loadFromJSON' do
+        it 'should return nil for invalid json' do
+            SteamCodec::KeyValues::loadFromJSON('invalid :P').should be_nil
+        end
+    end
+
+    describe '.load' do
+        it 'should load correctly empty data' do
+            SteamCodec::KeyValues::load('').should eq({})
+        end
+
+        it 'should raise exception on invalid data' do
+            expect { SteamCodec::KeyValues::load(nil) }.to raise_error(ArgumentError)
+            expect { SteamCodec::KeyValues::load({})  }.to raise_error(ArgumentError)
+        end
+
+        it 'should load correctly various representations' do
+            SteamCodec::KeyValues::load(jsonSample1a).should eq({ tokenKey => tokenValue })
+            SteamCodec::KeyValues::load(jsonSample1b).should eq({ tokenKey => { tokenKey => tokenValue } })
+            SteamCodec::KeyValues::load(jsonSample2a).should eq({ tokenKey => tokenValue })
+            SteamCodec::KeyValues::load(jsonSample2b).should eq({ tokenKey => tokenValue })
+            SteamCodec::KeyValues::load(jsonSample3a).should eq({"Ke\ty\\is" => "Val\nue\\\""})
+            SteamCodec::KeyValues::load(jsonSample3b).should eq({'Ke\\tyis\\' => "te\\s\\n\\v\"\\"})
+            SteamCodec::KeyValues::load(jsonSample4a).should eq({ tokenKey => tokenValue })
+            SteamCodec::KeyValues::load(jsonSample4b).should eq({ tokenKey => { tokenKey => tokenValue } })
+            SteamCodec::KeyValues::load(jsonSample5a).should eq({"abc" => "lol this {weird string}"})
+            SteamCodec::KeyValues::load(jsonSample5b).should eq({"\"really weird\"\n{\n\"string\" \"this is\"\n}" => {"string" => "this is"}})
+            SteamCodec::KeyValues::load(jsonSample6a).should eq({ tokenKey => { tokenKey => tokenValue } })
+            SteamCodec::KeyValues::load(jsonSample7a).should eq({ tokenKey => { tokenKey => tokenValue } })
+            SteamCodec::KeyValues::load(jsonSample7b).should eq({ tokenKey => { tokenKey => tokenValue } })
+        end
+    end
+
+    describe '.loadFromFile' do
+        it 'should raise exception if not file' do
+            expect { SteamCodec::KeyValues::loadFromFile("blah") }.to raise_error(ArgumentError)
+        end
+
+        it 'should succesfully load from file' do
+            StringIO.open(keyValueData) do |file|
+                SteamCodec::KeyValues::loadFromFile(file).should eq({ "AppState" => { "appid" => "320", "Universe" => "1" } })
+            end
+        end
+
+        it 'should be KeyValues instance' do
+            StringIO.open(keyValueData) do |file|
+                SteamCodec::KeyValues::loadFromFile(file).should be_an_instance_of SteamCodec::KeyValues
+            end
+        end
+    end
+
+    describe 'access any field' do
+        let(:keyValues) { SteamCodec::KeyValues::load(keyValueData) }
+        it 'should be able to access AppState' do
+            keyValues.AppState.should eq({ "appid" => "320", "Universe" => "1" })
+        end
+
+        it 'should be able to read AppID' do
+            keyValues.AppState.AppID.should eq("320")
+        end
+
+        it 'should check if field exists' do
+            keyValues.AppState.has_key?(:AppID).should be_true
+            keyValues.AppState.has_key?(:UserConfig).should be_false
+            keyValues.respond_to?(:appstate).should be_true
+            keyValues.respond_to?(:nope).should be_false
+        end
+
+        it 'should raise exception for non-existent field' do
+            expect { keyValues.AppState.UserConfig }.to raise_error(NoMethodError)
+        end
+    end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'simplecov'
+
+SimpleCov.start
+require_relative '../lib/steam_codec'

data/spec/vdf_spec.rb

@@ -0,0 +1,136 @@
+require 'spec_helper'
+
+describe SteamCodec::VDF do
+
+    let(:valveDataFile) { <<-EOS
+        "InstallScript"
+        {
+            "Registry"
+            {
+                "HKEY_LOCAL_MACHINE\\SOFTWARE\\Activision\\Singularity"
+                {
+                    "string"
+                    {
+                        "EXEString"     "%INSTALLDIR%\\Binaries\\Singularity.exe"
+                        "InstallPath"       "%INSTALLDIR%"
+                        "IntVersion"        "35.0"
+                        "Version"       "1.0"
+                        "english"
+                        {
+                            "Language"      "1033"
+                            "LanguageCode"      "ENU"
+                            "Localization"      "ENU"
+                        }
+                        "french"
+                        {
+                            "Language"      "1036"
+                            "LanguageCode"      "FRA"
+                            "Localization"      "FRA"
+                        }
+                        "german"
+                        {
+                            "Language"      "1031"
+                            "LanguageCode"      "DEU"
+                            "Localization"      "DEU"
+                        }
+                        "italian"
+                        {
+                            "Language"      "1040"
+                            "LanguageCode"      "ITA"
+                            "Localization"      "ITA"
+                        }
+                        "spanish"
+                        {
+                            "Language"      "1034"
+                            "LanguageCode"      "ESP"
+                            "Localization"      "ESP"
+                        }
+                    }
+                    "dword"
+                    {
+                        "english"
+                        {
+                            "GameLanguage"      "0"
+                        }
+                        "french"
+                        {
+                            "GameLanguage"      "1"
+                        }
+                        "german"
+                        {
+                            "GameLanguage"      "0"
+                        }
+                        "italian"
+                        {
+                            "GameLanguage"      "2"
+                        }
+                        "spanish"
+                        {
+                            "GameLanguage"      "4"
+                        }
+                    }
+                }
+            }
+            "Run Process"
+            {
+                "DirectX"
+                {
+                    "process 1"     "%INSTALLDIR%\\redist\\DirectX\\DXSETUP.exe"
+                    "command 1"     "/silent"
+                    "Description"       "DirectX Installation"
+                    "NoCleanUp"     "1"
+                }
+                "VC++"
+                {
+                    "process 1"     "%INSTALLDIR%\\redist\\vcredist_x86.exe"
+                    "command 1"     "/q:a"
+                    "process 2"     "%INSTALLDIR%\\redist\\vcredist_x86_2005.exe"
+                    "command 2"     "/q:a"
+                    "Description"       "VC++ Redist Installation"
+                    "NoCleanUp"     "1"
+                }
+                "PhysX Version"
+                {
+                    "HasRunKey"     "HKEY_LOCAL_MACHINE\\SOFTWARE\\AGEIA Technologies"
+                    "process 1"     "%INSTALLDIR%\\redist\\PhysX_9.09.1112_SystemSoftware.exe"
+                    "command 1"     "/quiet"
+                    "NoCleanUp"     "1"
+                    "MinimumHasRunValue"        "9091112"
+                }
+            }
+        }
+        "kvsignatures"
+        {
+            "InstallScript"     "973f7d89125ad1fc782a970deb175cf84d48c49581ba3a76fedfefa8116a6d500459fd8df99285850ef99d767a83c2de009de5951607930557c937439908fbc1cc8156e963320c54080e7a1a634ccbf2e5f58883bd11bb2ed10c07be5af8e482d9a17d22a6fe40980124e5fced1c241f158b460941984c41432eeeb2aeaa01b1"
+        }        
+        EOS
+    }
+
+    describe '.loadFromFile' do
+        it 'should successfully load from file' do
+            StringIO.open(valveDataFile) do |file|
+                SteamCodec::VDF::loadFromFile(file).should be_an_instance_of SteamCodec::VDF
+            end
+        end
+    end
+
+    describe '.load' do
+        it 'should successfully load' do
+            SteamCodec::VDF::load(valveDataFile).should be_an_instance_of SteamCodec::VDF
+        end
+    end
+
+    describe 'key field' do
+        it 'should return value' do
+            SteamCodec::VDF::load(valveDataFile).InstallScript.Registry.should be_an_instance_of SteamCodec::KeyValues
+        end
+    end
+
+    describe '#isSignaturesValid?' do
+        it 'should check if signature is valid' do
+            SteamCodec::VDF.new.isSignaturesValid?(nil).should be_true
+            SteamCodec::VDF::load(valveDataFile).isSignaturesValid?(nil).should be_false
+        end
+    end
+
+end

data/steam_codec.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'steam_codec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'steam_codec'
+  spec.version       = SteamCodec::VERSION
+  spec.authors       = ['Dāvis']
+  spec.email         = ['davispuh@gmail.com']
+  spec.description   = 'Load, parse and manage various Steam client, Source Engine file formats. For example VDF and ACF'
+  spec.summary       = 'Library for working with different Steam client (and Source engine) file formats.'
+  spec.homepage      = 'https://github.com/davispuh/SteamCodec'
+  spec.license       = 'UNLICENSE'
+
+  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_runtime_dependency 'insensitive_hash', '~> 0.3', '>= 0.3.3'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'simplecov'
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: steam_codec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dāvis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: insensitive_hash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.3.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Load, parse and manage various Steam client, Source Engine file formats.
+  For example VDF and ACF
+email:
+- davispuh@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- .yardopts
+- Gemfile
+- README.md
+- Rakefile
+- UNLICENSE
+- lib/steam_codec.rb
+- lib/steam_codec/ACF.rb
+- lib/steam_codec/key_values.rb
+- lib/steam_codec/value_array.rb
+- lib/steam_codec/vdf.rb
+- lib/steam_codec/version.rb
+- spec/acf_spec.rb
+- spec/key_values_spec.rb
+- spec/spec_helper.rb
+- spec/vdf_spec.rb
+- steam_codec.gemspec
+homepage: https://github.com/davispuh/SteamCodec
+licenses:
+- UNLICENSE
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.7
+signing_key: 
+specification_version: 4
+summary: Library for working with different Steam client (and Source engine) file
+  formats.
+test_files:
+- spec/acf_spec.rb
+- spec/key_values_spec.rb
+- spec/spec_helper.rb
+- spec/vdf_spec.rb
+has_rdoc: