adam 1.1.2 → 1.2.0

data/README.md

@@ -8,9 +8,9 @@ Adam is a library for all things [EVE](http://www.eveonline.com/).
 
 ## Features
 
-* Killmail parser
-* Kill log parser
-* EDK-compatible killboard importer
+* Parses killmails
+* Parses kill logs
+* Imports killmails from EDK-compatible feeds
 
 ## Synopsis
 

data/config/database.yml

@@ -2,4 +2,4 @@ adapter:  mysql
 database: eve_arena_development
 username: root
 password: frkt
-host:     localhost
+host:     localhost

data/lib/adam.rb

@@ -1,5 +1,5 @@
 module Adam
-  VERSION = '1.1.2'
+  VERSION = '1.2.0'
   
   autoload :Killmail, 'adam/killmail'
   autoload :KillLog, 'adam/kill_log'

data/lib/adam/kill.rb

@@ -2,6 +2,16 @@ require 'digest'
 
 module Adam
   
+  # Instances of the Kill class represent a kill in the EVE Online universe.
+  #
+  # Accessors:
+  # * +eve_id+ - The EVE ID of the killmail. This is only populated if the kill was derived from a kill log.
+  # * +time+ - A time object set to the time of the kill.
+  # * +solar_system+ - A solar system object (see the SolarSystem class).
+  # * +victim+ - A victim object (see the Victim class).
+  # * +solar_system+ - A solar system object (see the SolarSystem class).
+  # * +involved_parties+ - An array of involved party objects (see the InvolvedParty class).
+  # * +loot+ - An array of loot objects (see the Loot class).
   class Kill
     attr_accessor :eve_id, :time, :solar_system, :victim, :involved_parties, :loot
     
@@ -9,6 +19,8 @@ module Adam
       yield self if block_given?
     end
     
+    # Reverse-engineer the killmail. This is particularly useful if it
+    # was originally derived from a kill log.
     def to_killmail
 
       killmail = ""
@@ -17,9 +29,9 @@ module Adam
       killmail << "Victim: #{victim.pilot}\n"
       killmail << "Corp: #{victim.corporation}\n"
       killmail << "Alliance: #{victim.alliance}\n" if victim.alliance
-      killmail << "Alliance: Unknown\n" unless victim.alliance
+      killmail << "Alliance: Unknown\n" if victim.alliance.nil?
       killmail << "Faction: #{victim.faction}\n" if victim.faction
-      killmail << "Faction: NONE\n" unless victim.faction
+      killmail << "Faction: NONE\n" if victim.faction.nil?
       killmail << "Destroyed: #{victim.ship}\n"
       killmail << "System: #{solar_system.name}\n"
       killmail << "Security: #{solar_system.security_status.round(2)}\n"
@@ -38,9 +50,9 @@ module Adam
             killmail << "Security: #{involved_party.security_status.round(2)}\n"
             killmail << "Corp: #{involved_party.corporation}\n"
             killmail << "Alliance: #{involved_party.alliance}\n" if involved_party.alliance
-            killmail << "Alliance: NONE\n" unless involved_party.alliance
+            killmail << "Alliance: NONE\n" if involved_party.alliance.nil?
             killmail << "Faction: #{involved_party.faction}\n" if involved_party.faction
-            killmail << "Faction: NONE\n" unless involved_party.faction
+            killmail << "Faction: NONE\n" if involved_party.faction.nil?
             killmail << "Ship: #{involved_party.ship}\n"
             killmail << "Weapon: #{involved_party.weapon}\n"
             killmail << "Damage Done: #{involved_party.damage_done}\n"
@@ -66,7 +78,7 @@ module Adam
         destroyed_items.each do |loot|
           killmail << "#{loot.name}"
           killmail << ", Qty: #{loot.quantity}" if loot.quantity > 1
-          killmail << " (Cargo)" if loot.cargo
+          killmail << " (Cargo)" if loot.cargo_hold
           killmail << " (Drone Bay)" if loot.drone_bay
           killmail << "\n"
         end
@@ -80,7 +92,7 @@ module Adam
         dropped_items.each do |loot|
           killmail << "#{loot.name}"
           killmail << ", Qty: #{loot.quantity}" if loot.quantity > 1
-          killmail << " (Cargo)" if loot.cargo
+          killmail << " (Cargo)" if loot.cargo_hold
           killmail << " (Drone Bay)" if loot.drone_bay
           killmail << "\n"
         end
@@ -91,6 +103,7 @@ module Adam
     
     alias_method :to_s, :to_killmail
     
+    # Calculates the message digest of the killmail.
     def digest
       string = "#{time}#{victim.pilot}#{victim.ship}#{solar_system.name}#{victim.damage_taken}"
       involved_parties.sort! { |x, y| x.damage_done <=> y.damage_done }
@@ -100,39 +113,87 @@ module Adam
     
   end
   
+  # Instances of the SolarSystem class represent a solar system in the EVE universe.
+  #
+  # Accessors:
+  # * +name+ - A string describing the name of the solar system.
+  # * +security_status+ - A floating-point number describing the security status of the solar system.
   class Kill::SolarSystem
     attr_accessor :name, :security_status
     
     def initialize
       yield self if block_given?
     end
-    
   end
   
+  # Instances of the Kill class represent a victim of a kill.
+  #
+  # Accessors:
+  # * +pilot+ - A string describing the name of the pilot.
+  # * +corporation+ - A string describing the name of the corporation the pilot is enrolled in.
+  # * +alliance+ - A string describing the name of the alliance the corporation is a member of. May be +nil+ if the corporation is not in an alliance.
+  # * +faction+ - A string describing the name of the faction the pilot is involved in. May be +nil+ if the pilot is not in a faction.
+  # * +ship+ - A string describing the name of the ship that was destroyed.
+  # * +damage_taken+ - An integer describing damage taken.
   class Kill::Victim
     attr_accessor :pilot, :corporation, :alliance, :faction, :ship, :damage_taken
     
     def initialize
       yield self if block_given?
     end
-
   end
   
+  # Instances of the InvolvedParty class represent an involved party in a kill.
+  #
+  # Accessors:
+  # * +type+ - A symbol describing whether the pilot was player-controlled (:PC) or non-player controlled (:NPC).
+  # * +pilot+ - A string describing the name of the pilot. For NPCs, this is +nil+.
+  # * +security_status+ - A floating-point number describing the security status of the pilot. For NPCs, this is +nil+.
+  # * +corporation+ - A string describing the name of the corporation the pilot is enrolled in. For NPCs, this may be nil.
+  # * +alliance+ - A string describing the name of the alliance the corporation is a member of. May be +nil+ if the corporation is not in an alliance.
+  # * +faction+ - A string describing the name of the faction the pilot is involved in. May be +nil+ if the pilot is not in a faction.
+  # * +ship+ - A string describing the name of the ship that the pilot was flying.
+  # * +weapon+ - A string describing the name of the weapon that was last fired by this pilot.
+  # * +damage_done+ - An integer describing damage done by this pilot.
+  # * +final_blow+ - A boolean describing whether or not this pilot made the final blow.
   class Kill::InvolvedParty
     attr_accessor :type, :pilot, :security_status, :corporation, :alliance, :faction, :ship, :weapon, :damage_done, :final_blow
     
+    def pc?
+      type == :PC
+    end
+    
+    def npc?
+      type == :NPC
+    end
+    
     def initialize
       yield self if block_given?
     end
-    
   end
   
+  # Instances of the Loot class represent a piece of loot of a kill.
+  #
+  # Accessors:
+  # * +name+ - A string describing the name of the item.
+  # * +quantity+ - An integer describing the quantity of the item.
+  # * +cargo_hold+ - A boolean describing whether or not this item was in the cargo hold.
+  # * +drone_bay+ - A boolean describing whether or not this item was in the drone bay.
+  # * +dropped+ - A boolean describing whether or not this item was dropped.
   class Kill::Loot
-    attr_accessor :name, :quantity, :cargo, :drone_bay, :dropped
+    attr_accessor :name, :quantity, :cargo_hold, :drone_bay, :dropped
+    
+    def cargo_hold?
+      cargo_hold
+    end
+    
+    def dropped?
+      dropped
+    end
     
     def initialize
       yield self if block_given?
     end
   end
   
-end
+end

data/lib/adam/kill_log.rb

@@ -9,7 +9,11 @@ module Adam
   module KillLog
    
     extend self
-   
+    
+    # Parses a kill log and returns an array of Kill objects.
+    #
+    # Parameters:
+    # * +source+ - A kill log as returned by the EVE Online API.
     def parse(source)
       document = Hpricot.XML(source)
 
@@ -27,6 +31,10 @@ module Adam
 
     private
     
+    # Parses a single element of a kill log.
+    #
+    # Parameters:
+    # * +kill_element+ - A single kill element.
     def parse_single(kill_element)
       
       Adam::Kill.new do |k|
@@ -48,8 +56,8 @@ module Adam
           
           v.pilot         = victim_element['characterName']
           v.corporation   = victim_element['corporatioNname']
-          v.alliance      = victim_element['allianceName'] == '' ? false : victim_element['allianceName']
-          v.faction       = victim_element['factionName'] == '' ? false: victim_element['factionName']
+          v.alliance      = victim_element['allianceName'] == '' ? nil : victim_element['allianceName']
+          v.faction       = victim_element['factionName'] == '' ? nil: victim_element['factionName']
           v.ship          = Item.find(victim_element['shipTypeID']).name
           v.damage_taken  = victim_element['damageTaken'].to_i
         end
@@ -62,11 +70,11 @@ module Adam
             raise ValidationError, "Involved party corporation no longer exists" if involved_party_element['corporationName'].empty?
             raise ValidationError, "Involved party alliance no longer exists" if involved_party_element['allianceName'].empty?
             
-            ip.type             = involved_party_element['characterName'].empty? ? 'NPC' : 'PC'
+            ip.type             = involved_party_element['characterName'].empty? ? :NPC : :PC
             ip.pilot            = involved_party_element['characterName'] unless involved_party_element['characterName'].empty?
             ip.corporation      = involved_party_element['corporationName']
-            ip.alliance         = involved_party_element['allianceName'] == '' ? false : involved_party_element['allianceName']
-            ip.faction          = involved_party_element['factionName'] == '' ? false : involved_party_element['factionName']
+            ip.alliance         = involved_party_element['allianceName'] == '' ? nil : involved_party_element['allianceName']
+            ip.faction          = involved_party_element['factionName'] == '' ? nil : involved_party_element['factionName']
             ip.security_status  = involved_party_element['securityStatus'].to_f
             ip.ship             = Item.find(involved_party_element['shipTypeID']).name
             ip.weapon           = Item.find(involved_party_element['weaponTypeID']).name
@@ -82,7 +90,7 @@ module Adam
             k.loot << Adam::Kill::Loot.new do |l|
               l.name           = Item.find(loot_element['typeID']).name
               l.quantity       = loot_element['qtyDropped'].to_i
-              l.cargo          = loot_element['flag'] == '5' ? true : false
+              l.cargo_hold     = loot_element['flag'] == '5' ? true : false
               l.drone_bay      = loot_element['flag'] == '87' ? true : false
               l.dropped        = true
             end
@@ -92,7 +100,7 @@ module Adam
             k.loot << Adam::Kill::Loot.new do |l|
               l.name           = Item.find(loot_element['typeID']).name
               l.quantity       = loot_element['qtyDestroyed'].to_i
-              l.cargo          = loot_element['flag'] == '5' ? true : false
+              l.cargo_hold     = loot_element['flag'] == '5' ? true : false
               l.drone_bay      = loot_element['flag'] == '87' ? true : false
               l.dropped        = false
             end
@@ -105,4 +113,4 @@ module Adam
    
   end
   
-end
+end

data/lib/adam/kill_log/validation_error.rb

@@ -2,4 +2,4 @@ module Adam
   module KillLog
     class ValidationError < RuntimeError; end
   end
-end
+end

data/lib/adam/killboard.rb

@@ -15,7 +15,7 @@ module Adam
       @uri, @feed_uri = options[:uri], options[:feed_uri]
     end
     
-    # Loads an array of killmails from an EDK-compatible feed.
+    # Parses an EDK-compatible feed and returns an array of killmail strings.
     #
     # +options+ is a hash with these keys:
     # * +week+ - An integer determining which week to import. Defaults to current week.
@@ -49,4 +49,4 @@ module Adam
     
   end
   
-end
+end

data/lib/adam/killboard/feed_error.rb

@@ -12,4 +12,4 @@ module Adam
   
   end
   
-end
+end

data/lib/adam/killmail.rb

@@ -9,6 +9,10 @@ module Adam
     
     extend self
     
+    # Parses killmails and populates corresponding Kill objects.
+    #
+    # Parameters:
+    # * +source+ - A string containing the killmail to parse.
     def parse(source)
       raise ValidationError.new(source), "Killmail is empty" if source.empty?
       
@@ -40,9 +44,9 @@ module Adam
           # Set pilot to nil if it's a moon
           v.pilot = nil if v.pilot =~ /[a-zA-Z0-9\- ]+ - Moon [0-9]+/
         
-          # Convert alliance/faction from "unknown" or "none" to false
-          v.alliance = false if v.alliance =~ /unknown|none/i
-          v.faction = false if v.faction =~ /unknown|none/i
+          # Convert alliance/faction from "unknown" or "none" to nil
+          v.alliance = nil if v.alliance =~ /unknown|none/i
+          v.faction = nil if v.faction =~ /unknown|none/i
         end
         
         raise ValidationError.new(source), "No faction called '#{kill.victim.faction}' exists" if kill.victim.faction and !Faction.exists? :name => kill.victim.faction
@@ -60,7 +64,7 @@ module Adam
             
           when 8
             involved_party = Adam::Kill::InvolvedParty.new do |ip|
-              ip.type                   = "PC"
+              ip.type                   = :PC
               ip.pilot                  = snippet[/Name: ([a-zA-Z0-9]{1}[a-zA-Z0-9'. -]{1,48}[a-zA-Z0-9.]{1})/, 1] or raise ValidationError.new(source), "Involved party #{i+1} pilot malformed"
               ip.security_status        = snippet[/Security: ([\-\.0-9]+)/, 1].to_f or raise ValidationError.new(source), "Involved party #{i+1} security malformed"
               ip.corporation            = snippet[/Corp: ([a-zA-Z0-9]{1}[a-zA-Z0-9'. -]{1,48}[a-zA-Z0-9.]{1})/, 1] or raise ValidationError.new(source), "Involved party #{i+1} corporation malformed"
@@ -71,14 +75,14 @@ module Adam
               ip.damage_done            = (snippet[/Damage Done: ([0-9]+)/, 1] or raise ValidationError.new(source), "Involved party #{i+1} damage malformed").to_i
               ip.final_blow             = snippet =~ /\(laid the final blow\)/ ? true : false
               
-              # Convert alliance/faction from "unknown" or "none" to false
-              ip.alliance = false if ip.alliance =~ /unknown|none/i
-              ip.faction = false if ip.faction =~ /unknown|none/i
+              # Convert alliance/faction from "unknown" or "none" to nil
+              ip.alliance = nil if ip.alliance =~ /unknown|none/i
+              ip.faction = nil if ip.faction =~ /unknown|none/i
             end
               
           when 2
             involved_party = Adam::Kill::InvolvedParty.new do |ip|
-              ip.type                   = "NPC"
+              ip.type                   = :NPC
               ip.ship                   = snippet[/Name: ([a-zA-Z0-9]{1}[a-zA-Z0-9'. -]{1,48}[a-zA-Z0-9.]{1})/, 1] or raise ValidationError.new(source), "Involved party #{i+1} ship malformed"
               ip.damage_done            = (snippet[/Damage Done: ([0-9]+)/, 1] or raise ValidationError.new(source), "Involved party #{i+1} damage malformed").to_i
               ip.final_blow             = snippet =~ /\(laid the final blow\)/ ? true : false
@@ -110,11 +114,11 @@ module Adam
             loot = Adam::Kill::Loot.new do |l|
               l.name       = snippet[/([^,\(\)]+)/, 1] or raise ValidationError.new(source), "Destroyed item #{i+1} name malformed"
               l.quantity   = snippet =~ /Qty: ([0-9]+)/ ? snippet[/Qty: ([0-9]+)/, 1].to_i : 1
-              l.cargo      = snippet[/(Cargo)/] ? true : false
+              l.cargo_hold = snippet[/(Cargo)/] ? true : false
               l.drone_bay  = snippet[/(Drone Bay)/] ? true : false
               l.dropped    = false
             end
-            existing_loot = kill.loot.select { |el| el.name.eql?(loot.name) and el.cargo.eql?(loot.cargo) and el.drone_bay.eql?(loot.drone_bay) and el.dropped.eql?(loot.dropped) }[0]
+            existing_loot = kill.loot.select { |el| el.name.eql?(loot.name) and el.cargo_hold.eql?(loot.cargo_hold) and el.drone_bay.eql?(loot.drone_bay) and el.dropped.eql?(loot.dropped) }[0]
             existing_loot ? existing_loot.quantity += loot.quantity : kill.loot << loot
           end
         end
@@ -124,11 +128,11 @@ module Adam
             loot = Adam::Kill::Loot.new do |l|
               l.name       = snippet[/([^,\(\)]+)/, 1] or raise ValidationError.new(source), "Dropped item #{i+1} name malformed"
               l.quantity   = snippet =~ /Qty: ([0-9]+)/ ? snippet[/Qty: ([0-9]+)/, 1].to_i : 1
-              l.cargo      = snippet[/(Cargo)/] ? true : false
+              l.cargo_hold = snippet[/(Cargo)/] ? true : false
               l.drone_bay  = snippet[/(Drone Bay)/] ? true : false
               l.dropped    = true
             end
-            existing_loot = kill.loot.select { |el| el.name.eql?(loot.name) and el.cargo.eql?(loot.cargo) and el.drone_bay.eql?(loot.drone_bay) and el.dropped.eql?(loot.dropped) }[0]
+            existing_loot = kill.loot.select { |el| el.name.eql?(loot.name) and el.cargo_hold.eql?(loot.cargo_hold) and el.drone_bay.eql?(loot.drone_bay) and el.dropped.eql?(loot.dropped) }[0]
             existing_loot ? existing_loot.quantity += loot.quantity : kill.loot << loot
           end
         end
@@ -139,4 +143,4 @@ module Adam
     
   end
   
-end
+end

data/lib/adam/killmail/validation_error.rb

@@ -12,4 +12,4 @@ module Adam
     
   end
 
-end
+end

data/lib/models.rb

@@ -5,4 +5,4 @@ ActiveRecord::Base.establish_connection(database_configuration)
 
 class Item < ActiveRecord::Base; end
 class SolarSystem < ActiveRecord::Base; end
-class Faction < ActiveRecord::Base; end
+class Faction < ActiveRecord::Base; end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 1
-  - 1
   - 2
-  version: 1.1.2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
 - Johannes Gorset