friedmag-warcraft-armory 0.0.1

data/Changelog

@@ -0,0 +1,2 @@
+2008-08-14
+ * [1.0.0] ariejan - Initial release

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Ariejan de Vroom, Andrea Nall
+
+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.textile

@@ -0,0 +1,44 @@
+h1. Warcraft Armory
+
+Warcraft Armory allows you to easily query the World of Warcraft Armory site to retrieve information about your character.
+
+Both US and EU servers are supported.
+
+Written by "Ariejan de Vroom":mailto:ariejan@ariejan.net
+"Andrea Nall":mailto:anall@andreanall.com
+
+Copyright 2008 Ariejan de Vroom, Andrea Nall
+
+h2. Disclaimer
+
+This is the usual dislaimer. I'm not liable when you use this gem. Using it may be against the current (or future) terms of service from Blizzard or WoWarmory.com. 
+
+h2. Download and installation
+
+Simply install the RubyGem and require it in your project. If you're on rails, require it in your config/environment.rb.
+
+<pre>gem install anall-warcraft-armory --source http://gems.github.com</pre>
+
+And require it when you need it:
+
+<pre><code>require 'warcraft-armory'</code></pre>
+
+Add the following to your environment.rb if you want to use Rails 2.1's dependency manager (which is highly recommended):
+
+<pre><code>config.gem "anall-warcraft-armory",
+           :lib    => "warcraft-armory",
+           :source => "http://gems.github.com"</code></pre>
+
+h2. Usage
+
+<pre><code>character = WarcraftAmory.find(:eu, 'Aszune', 'Nosius')</code></pre>
+
+This will either return a WarcraftCharacter object or nil when not character information was found. 
+
+h2. More Information
+
+"Ariejan.net":http://ariejan.net
+
+"Blizzard":http://www.blizzard.com
+"WoW Armory US":http://www.wowarmory.com
+"WoW Armory EU":http://eu.wowarmory.com

data/Rakefile

@@ -0,0 +1,25 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('warcraft-armory', '0.0.1') do |p|
+  p.description     = "Retrieve character information from the World of Warcraft Armory"
+  p.url             = "http://github.com/anall/warcraft-armory"
+  p.author          = "Andrea Nall"
+  p.email           = "anall@andreanall.com"
+  p.ignore_pattern  = ["tmp/*", "script/*", "coverage.data","lib/warcraft_armory_test_hacks.rb"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }
+
+namespace :test do
+  desc 'Measures test coverage'
+  task :coverage do
+    rm_f "coverage"
+    rm_f "coverage.data"
+    rcov = "rcov --aggregate coverage.data --text-summary -Ilib"
+    system("#{rcov} test/*_test.rb")
+    system("open coverage/index.html") if PLATFORM['darwin']
+  end
+end

data/init.rb

@@ -0,0 +1,2 @@
+$:.unshift "#{File.dirname(__FILE__)}/lib"
+require 'warcraft_armory'

data/lib/warcraft_armory.rb

@@ -0,0 +1,34 @@
+require 'warcraft_armory/character_part'
+require 'warcraft_armory/character'
+
+require 'warcraft_armory/character_reputation'
+
+require 'warcraft_armory/guild_lite'
+require 'warcraft_armory/guild'
+require 'warcraft_armory/guild_statistics'
+
+require 'warcraft_armory/faction'
+require 'warcraft_armory/faction_category'
+
+module WarcraftArmory
+  def self.getRace(id)
+    [nil,:human,:orc,:dwarf,:nightelf,:undead,:tauren,:gnome,:troll,nil,:bloodelf,:draenei][id]
+  end
+  
+  def self.getRaceFaction(id)
+    [nil,:alliance,:horde,:alliance,:alliance,:horde,:horde,:alliance,:horde,nil,:horde,:alliance][id]
+  end
+
+  def self.getFaction(id)
+    [:alliance,:horde][id]
+  end
+  
+  def self.getGender(id)
+    [:male,:female][id]
+  end
+  
+  def self.getClass(id)
+    [nil,:warrior,:paladin,:hunter,:rogue,:priest,:deathknight,:shaman,:mage,:warlock,nil,:druid][id]
+  end
+  
+end

data/lib/warcraft_armory/character.rb

@@ -0,0 +1,142 @@
+require 'open-uri'
+require "rexml/document"
+require "cgi"
+
+module WarcraftArmory
+  class Character < CharacterPart
+    def self.find(location, realm, character_name)
+      site = "http://#{location.to_s}.wowarmory.com"
+      url = "#{site}/character-sheet.xml?r=#{CGI.escape realm}&n=#{CGI.escape character_name}"
+      
+      WarcraftArmory::Character.new(site,open(url,"User-Agent" => "Mozilla/5.0 (WarcraftArmory) Firefox/3.0.2"))
+    end
+
+    def self.fetch(site,urlArgs)
+      url = "#{site}/character-sheet.xml?#{urlArgs}"
+      WarcraftArmory::Character.new(site,open(url,"User-Agent" => "Mozilla/5.0 (WarcraftArmory) Firefox/3.0.2"))
+    end
+    
+    def initialize(site,xml_or_stream)
+      if (xml_or_stream.class == Hash)
+        @lite = true
+        super(site,xml_or_stream)
+      elsif (xml_or_stream.class == REXML::Attributes)
+          @lite = true
+          super(site,xml_or_stream)
+      else
+        @doc = REXML::Document.new xml_or_stream
+        
+        info = REXML::XPath.first(@doc,"//characterInfo").attributes
+        if (info["errCode"] != nil)
+          raise info["errCode"]
+        end
+        
+        attribs = REXML::XPath.first(@doc,"//character").attributes
+        @lite = false
+        
+        super(site,attribs)
+      end
+    end
+    
+    def inspect
+      full_name
+    end
+    
+    def current_title_format
+      if (@lite)
+        "%s"
+      else
+        @current_title_format ||= (REXML::XPath.first(@doc,"//title/@value") || "%s").to_s
+      end
+    end
+    
+    def title_formats
+      if (@lite)
+        []
+      else
+        @title_formats ||= _title_formats
+      end
+    end
+    
+    def titles
+      title_formats.map { |x| sprintf(x,name) }
+    end
+    
+    def full_name
+      if (@lite)
+        name
+      else
+        @full_name ||= sprintf(current_title_format,name)
+      end
+    end
+    
+    def name
+      @name ||= @character["name"]
+    end
+    
+    def faction
+      @faction ||= WarcraftArmory.getFaction(@character["factionId"].to_i)
+    end
+    
+    def level
+      @level ||= @character["level"].to_i
+    end
+    
+    def race
+      @race ||= WarcraftArmory.getRace(@character["raceId"].to_i)
+    end
+    
+    def gender
+      @gender ||= WarcraftArmory.getGender(@character["genderId"].to_i)
+    end
+    
+    def class_name
+      @class ||= WarcraftArmory.getClass(@character["classId"].to_i)
+    end
+    
+    def guild
+      if (@lite)
+        nil
+      else
+        @guild ||= _guild
+      end
+    end
+
+    def full_character(location = nil)
+      if (@lite)
+        @site ||= "http://#{location.to_s}.wowarmory.com"
+        
+        url = "#{@site}/character-sheet.xml?#{urlSuffix}"
+        stuff = open(url,"User-Agent" => "Mozilla/5.0 (WarcraftArmory) Firefox/3.0.2")
+        
+        @doc = REXML::Document.new stuff
+        
+        info = REXML::XPath.first(@doc,"//characterInfo").attributes
+        if (info["errCode"] != nil)
+          raise info["errCode"]
+        end
+        
+        @character = REXML::XPath.first(@doc,"//character").attributes
+        @lite = false
+      end
+      self
+    end
+    
+    private
+    def _title_formats
+      tf = REXML::XPath.match(@doc,"//knownTitles/title/@value").map { |x| x.to_s }
+      tf << current_title_format if (current_title_format)
+      tf.sort
+    end
+    
+    def _guild
+      if (@character["guildName"] == nil)
+        nil
+      elsif (@site)
+        WarcraftArmory::Guild.fetch(@site,@character['guildUrl'])
+      else
+        WarcraftArmory::GuildLite.new(@character)
+      end
+    end
+  end
+end

data/lib/warcraft_armory/character_part.rb

@@ -0,0 +1,41 @@
+module WarcraftArmory
+  class CharacterPart
+    def initialize(site,attributes)
+      @site = site
+      
+      @character = attributes
+      
+      @other_parts = {}
+      _setBits(self)
+    end
+    
+    def reputation(location = nil)
+      @site ||= "http://#{location.to_s}.wowarmory.com"
+      @other_parts[:reputation] ||= WarcraftArmory::CharacterReputation.fetch(@site,urlSuffix)
+      @other_parts[:reputation]._setBits(self)
+      @other_parts[:reputation]
+    end
+    
+    def character(location = nil)
+      @site ||= "http://#{location.to_s}.wowarmory.com"
+      @other_parts[:character] ||= WarcraftArmory::Character.fetch(@site,urlSuffix)
+      @other_parts[:character]._setBits(self)
+      @other_parts[:character]
+    end
+    
+    def urlSuffix
+      @urlSuffix ||= (@character["url"] || @character["charUrl"])
+    end
+    
+    protected
+    def _setBits(what)
+      @other_parts = what._otherParts
+      @other_parts[:character] = what if (what.class == WarcraftArmory::Character)
+      @other_parts[:reputation] = what if (what.class == WarcraftArmory::CharacterReputation)
+    end
+    
+    def _otherParts
+      @other_parts
+    end
+  end
+end

data/lib/warcraft_armory/character_reputation.rb

@@ -0,0 +1,66 @@
+require 'open-uri'
+require "rexml/document"
+require "cgi"
+
+module WarcraftArmory
+  class CharacterReputation < CharacterPart
+    def self.find(location, realm, character_name)
+      site = "http://#{location.to_s}.wowarmory.com"
+      url = "#{site}/character-reputation.xml?r=#{CGI.escape realm}&n=#{CGI.escape character_name}"
+      
+      WarcraftArmory::CharacterReputation.new(site,open(url,"User-Agent" => "Mozilla/5.0 (WarcraftArmory) Firefox/3.0.2"))
+    end
+
+    def reputation(location = nil)
+      self
+    end
+    
+    def self.fetch(site,urlArgs)
+      url = "#{site}/character-reputation.xml?#{urlArgs}"
+      WarcraftArmory::CharacterReputation.new(site,open(url,"User-Agent" => "Mozilla/5.0 (WarcraftArmory) Firefox/3.0.2"))
+    end
+    
+    def initialize(site,xml_or_stream)
+      @doc = REXML::Document.new xml_or_stream
+      
+      info = REXML::XPath.first(@doc,"//characterInfo").attributes
+      if (info["errCode"] != nil)
+        raise info["errCode"]
+      end
+      
+      attribs = REXML::XPath.first(@doc,"//character").attributes
+      
+      super(site,attribs)
+    end
+    
+    def factions
+      parse
+      @factions
+    end
+    
+    def categories
+      parse
+      @categories
+    end
+    
+    private
+    def parse
+      return if (@parsed)
+      @factions = {}
+      @categories = {}
+      REXML::XPath.each(@doc,"//factionCategory") do |cat|
+        factions = {}
+        REXML::XPath.each(cat,"faction") do |faction|
+          attrs = faction.attributes
+          _faction = WarcraftArmory::Faction.new(cat,attrs)
+          factions[attrs["key"]] = _faction
+          @factions[attrs["key"]] = _faction
+        end
+        attrs = cat.attributes
+        @categories[attrs["key"]] = WarcraftArmory::FactionCategory.new(attrs,factions)
+      end
+      
+      @parsed = true
+    end
+  end
+end

data/lib/warcraft_armory/faction.rb

@@ -0,0 +1,124 @@
+module WarcraftArmory
+  class Faction
+    def initialize(cat,faction)
+      @data = faction
+      @cat = cat
+    
+      @name = faction["name"].to_s
+    end
+
+    def inspect
+      sprintf("%s - %s - %i / %i",name,repLevel,currentRep,maxRep)
+    end
+    
+    def name
+      @name
+    end
+    
+    def category
+      @cat
+    end
+    
+    def percent
+      currentRep.to_f/maxRep.to_f
+    end
+    
+    def fullPercent
+      if rawReputation >= 0
+        rawReputation.to_f / 42999.0
+      else
+        (rawReputation.to_f / 42000.0)
+      end
+    end
+    
+    def currentRep
+      _rep = rawReputation
+      if repLevelSymbol == :hated
+        42000 + _rep
+      elsif repLevelSymbol == :hostile
+        6000 + _rep
+      elsif repLevelSymbol == :unfriendly
+        3000 + _rep
+      elsif repLevelSymbol == :neutral
+        _rep
+      elsif repLevelSymbol == :friendly
+        _rep - 3000
+      elsif repLevelSymbol == :honored
+        _rep - 9000
+      elsif repLevelSymbol == :revered
+        _rep - 21000
+      elsif repLevelSymbol == :exalted
+        _rep - 42000
+      end
+    end
+    
+    def maxRep
+      if repLevelSymbol == :hated
+        36000
+      elsif repLevelSymbol == :hostile
+        3000
+      elsif repLevelSymbol == :unfriendly
+        3000
+      elsif repLevelSymbol == :neutral
+        3000
+      elsif repLevelSymbol == :friendly
+        6000
+      elsif repLevelSymbol == :honored
+        12000
+      elsif repLevelSymbol == :revered
+        21000
+      elsif repLevelSymbol == :exalted
+        999
+      end
+    end
+    
+    def repLevel
+      if repLevelSymbol == :hated
+        "Hated"
+      elsif repLevelSymbol == :hostile
+        "Hostile"
+      elsif repLevelSymbol == :unfriendly
+        "Unfriendly"
+      elsif repLevelSymbol == :neutral
+        "Neutral"
+      elsif repLevelSymbol == :friendly
+        "Friendly"
+      elsif repLevelSymbol == :honored
+        "Honored"
+      elsif repLevelSymbol == :revered
+        "Revered"
+      elsif repLevelSymbol == :exalted
+        "Exalted"
+      end
+    end
+    
+    def repLevelSymbol
+      @repLevelSymbol ||= _repLevelSymbol
+    end
+    
+    private
+    def _repLevelSymbol
+      if rawReputation <= -6000
+        :hated
+      elsif rawReputation <= -3000
+        :hostile
+      elsif rawReputation <= 0
+        :unfriendly
+      elsif rawReputation < 3000
+        :neutral
+      elsif rawReputation < 9000
+        :friendly
+      elsif rawReputation < 21000
+        :honored
+      elsif rawReputation < 42000
+        :revered
+      else
+        :exalted
+      end
+    end
+    
+    def rawReputation
+      @rawReputation ||= @data["reputation"].to_i
+    end
+  end
+end