elekk 0.1.0 → 1.0.1

data/Rakefile

@@ -9,7 +9,7 @@ begin
     s.email = "agnoster@gmail.com"
     s.homepage = "http://github.com/agnoster/elekk"
     s.description = "A simple library for World of Warcraft data in Ruby."
-    s.authors = ["Isaac Wasileski"]
+    s.authors = ["Isaac Wolkerstorfer"]
     s.files =  FileList["*", "{lib,spec}/**/*"]
     s.add_dependency 'typhoeus'
     s.add_dependency 'memcached'

data/VERSION

@@ -1 +1 @@
-0.1.0
+1.0.1

data/changelog.md

@@ -0,0 +1,9 @@
+# elekk v0.1.0
+
+ * Get Achievements
+ * Move JSON/XML well-formedness checks to Elekk::HTTP, so the cache can be busted if the data is bad
+
+# elekk v0.0.1
+
+ * Connect to Armory for basic character information
+ * Connect to Wowhead for searches

data/elekk.gemspec

@@ -5,18 +5,18 @@
 
 Gem::Specification.new do |s|
   s.name = %q{elekk}
-  s.version = "0.1.0"
+  s.version = "1.0.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Isaac Wasileski"]
-  s.date = %q{2010-06-05}
+  s.authors = ["Isaac Wolkerstorfer"]
+  s.date = %q{2010-07-25}
   s.description = %q{A simple library for World of Warcraft data in Ruby.}
   s.email = %q{agnoster@gmail.com}
   s.files = [
-    "CHANGELOG",
-     "Manifest",
+    "Manifest",
      "Rakefile",
      "VERSION",
+     "changelog.md",
      "elekk.gemspec",
      "lib/elekk.rb",
      "lib/elekk/achievement.rb",
@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
      "spec/armory_spec.rb",
      "spec/character_spec.rb",
      "spec/klass_spec.rb",
+     "spec/test.rb",
      "spec/wowhead_spec.rb"
   ]
   s.homepage = %q{http://github.com/agnoster/elekk}
@@ -42,6 +43,7 @@ Gem::Specification.new do |s|
      "spec/armory_spec.rb",
      "spec/character_spec.rb",
      "spec/klass_spec.rb",
+     "spec/test.rb",
      "spec/wowhead_spec.rb"
   ]
 

data/lib/elekk/achievement.rb

@@ -8,7 +8,7 @@ module Elekk
       @points = opts[:points]
       @icon = opts[:icon]
       @description = opts[:description]
-      @category = opts[:category]
+      @category = AchievementCategory[opts[:category]]
       @completed = opts[:completed]
     end
     
@@ -18,7 +18,7 @@ module Elekk
         :points => node['points'].to_i,
         :icon => node['icon'].to_s,
         :description => node['description'].to_s,
-        :category => Achievements[node['categoryId'].to_i]
+        :category => node['categoryId'].to_i
       })
       a.completed = Time.parse(node['dateCompleted'].to_s) if node['dateCompleted']
       a
@@ -33,7 +33,19 @@ module Elekk
     end
   end
   
-  class Achievements < Enum
-    add_item 'Raid', 168
+  class AchievementCategory < Enum
+    add_item 'General', 92
+    add_item 'Quests', 96
+    add_item 'Exploration', 97
+    add_item 'Player vs. Player', 95
+    add_item 'Dungeons & Raids', 168
+    add_item 'Professions', 169
+    add_item 'Reputation', 201
+    add_item 'World Events', 155
+    add_item 'Feats of Strength', 81
+    
+    add_obj  AchievementCategory::DungeonsRaids, :Raid
+    add_obj  AchievementCategory::PlayervsPlayer, :PvP
+    add_obj  AchievementCategory::Reputation, :Rep
   end
 end

data/lib/elekk/armory.rb

@@ -26,18 +26,99 @@ module Elekk
     end
 
     def get_xml(resource, params=nil)
-      response = HTTP.xml(url(resource+'.xml'), params, {
+      resource+= '.xml' unless resource =~ /\./
+      response = HTTP.xml(url(resource), params, {
         :cache_timeout => 24*3600,
         :user_agent => 'Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.1.9) Gecko/20100315 Firefox/3.5.9'
       })
     end
     
+    def get_feed(characters, realm=nil)
+      characters = [characters] unless characters.is_a? Array
+      feed_xml = get_xml 'character-feed.atom', :r => (realm || @realm), :cn => characters.sort.join(',')
+      feed = feed_xml.css('entry').collect do |c|
+        item = { :title => c.at_css('title').content,
+          :id => c.at_css('id').content,
+          :link => c.at_css('link').content,
+          :time => Time.parse(c.at_css('published').content),
+          :content => c.at_css('content').content
+        }
+        item[:character] = $1 if item[:title] =~ /(\w+)/
+        if item[:title] =~ /\[((.*)\s+\w+\s*\(([^(]+)\))\]\s+\d+\s+times/
+          item[:collator] = $1
+          item[:boss] = $2
+          item[:instance] = $3
+          item[:type] = :boss
+        end
+        if item[:content] =~ /<a href=.*#ach(\d+)">([^<]*)<\/a>/
+          item[:achievement_id] = $1
+          item[:achievement_name] = $2
+          item[:collator] = $2
+          if item[:title] =~ /step \[([^\]]*)\]/
+            item[:type] = :step
+            item[:collator] = item[:achievement_name] + " - " + $1
+            item[:step] = $1
+          else
+            item[:type] = :achievement
+          end
+        end
+        if item[:content] =~ /item-info\.xml\?i=(\d+).*\[(.*)\]/
+          item[:item_id] = $1
+          item[:item_name] = $2
+          item[:collator] = $2
+          item[:type] = :item
+        end
+        item[:coll_id] = [item[:type], item[:collator], item[:time]].hash
+        item
+      end
+    end
+    
+    def get_feeds(characters, realm=nil)
+      # split characters into least set of batches of no more than 5,
+      # no less than 2
+      
+      batches = characters.sort / 5
+      if batches.last.length < 2
+        batches.last.unshift batches[batches.length - 2].pop
+      end
+      
+      feeds = []
+      batches.collect {|chars|
+        feeds += get_feed chars, realm
+      }
+      feeds.sort {|a,b| b[:time] <=> a[:time]}
+    end
+    
+    def collate_feeds(feeds)
+      coll = {}
+      feeds.each do |e|
+        coll[e[:coll_id]] ||= e
+        coll[e[:coll_id]] << e
+      end
+      coll
+    end
+    
+    def search(query, type=:all)
+      xml = get_xml('search', :searchQuery => query, :searchType => type.to_s)
+    end
+    
     def self.icon_url(icon)
-      "http://us.wowarmory.com/wow-icons/_images/51x51/#{icon}.jpg"
+      url "wow-icons/_images/51x51/#{icon}.jpg"
     end
     
     def url(path)
       base + path
     end
   end
-end
+end
+
+class Array
+  def / len
+    a = []
+    each_with_index do |x,i|
+      a << [] if i % len == 0
+      a.last << x
+    end
+    a
+  end
+end

data/lib/elekk/character.rb

@@ -21,6 +21,7 @@ module Elekk
     end
     
     def achievements(category)
+      category = AchievementCategory[category]
       @achievements ||= {}
       @achievements[category.to_sym] ||=
         xml(:achievements, :c => category.to_i).css('achievement').map {|x| Achievement.from_xml x}
@@ -56,6 +57,10 @@ module Elekk
       @properties[:points] ||= sheet.at_css('character')['points'].to_i
     end
     
+    def feed
+      self.armory.get_feed @name, @realm
+    end
+    
     def spec(which)
       if not @properties[:specs]
         specs = {}
@@ -74,7 +79,7 @@ module Elekk
       type = 'default'
       [60, 70, 80].each { |m| type = m if level >= m }
       
-      @armory.url "_images/portraits/wow-#{type}/#{gender.id}-#{race.id}-#{klass.id}.gif"
+      self.armory.url "_images/portraits/wow-#{type}/#{gender.id}-#{race.id}-#{klass.id}.gif"
     end
     
     def fullname(tag=nil)

data/lib/elekk/data.rb

@@ -22,21 +22,32 @@ module Elekk
         @hash[idx.gsub(/\W/,'').to_sym]
       elsif idx.is_a? Symbol
         @hash[idx]
+      elsif idx.is_a? Enum
+        idx
       else
         nil
       end
     end
     
     def self.add_item(name, id=nil?)
-      @hash ||= {}
       @array ||= []
       id ||= @array.length
-      if name.nil?
-        @array[id] = nil
+      obj = name ? self.new(name, id) : nil
+      add_obj obj, nil, id
+    end
+    
+    def self.add_obj(obj, sym=nil, id=nil)
+      @hash ||= {}
+      @array ||= []
+      if obj and @hash[obj.to_sym]
+        # creating an alias
+        @hash[sym] = obj if sym
+        @array[id] = obj if id
       else
-        k = self.new(name,id)
-        @array[id] = k
-        @hash[k.to_sym] = k
+        # adding for the first time
+        @hash[obj.to_sym] = obj if obj
+        id ||= @array.length
+        @array[id] = obj
       end
     end
     

data/readme.md

@@ -2,7 +2,61 @@ Elekk
 =====
 [Elekk][1] is a Ruby library for World of Warcraft data.
 
-It does not do very much right now.
+Goals:
 
+ * Make querying information as natural and simple as possible
+ * Have native representations of every data type
+ * Reflect actual identifiers/schemes as closely as possible
 
-[1]: http://github.com/agnoster/elekk "Elekk on github"
+Here is what you can do with it currently:
+
+ * Get basic character information from the Armory
+	  * Class
+	  * Level
+	  * Faction
+	  * Race
+	  * Gender
+	  * Achievement Points
+	  * Title
+	  * Armory portrait
+ * Search on Wowhead with a simple text query and get
+	  * Internal identifiers for results
+	  * Links back to Wowhead
+	  * Icons (when available)
+	  * Quality (for items)
+ * Query achievements
+	  * Get internal identifiers, icons, title and description
+	  * Get the date the character completed the achievement
+	  * Should support all categories now
+
+To see how all this is done, it's probably best to check the [`spec/`][2] directory, which has exhaustive examples of how to use nearly all the APIs, and is likely to be kept more up-to-date than this readme.
+
+Example:
+
+	>> a = Armory.new 'Uldaman', :us
+	=> #<Elekk::Armory:0x10168cf20 @region=:us, @realm="Uldaman">
+	>> fyrbard = a.character 'Fyrbard'
+	=> #<Elekk::Character:0x101687818 @name="Fyrbard", @properties={:realm=>"Uldaman", :region=>:us, :name=>"Fyrbard"}, @armory=#<Elekk::Armory:0x10168cf20 @region=:us, @realm="Uldaman">, @region=:us, @realm="Uldaman">
+	>> puts fyrbard.race, fyrbard.race.to_i; fyrbard.race.to_sym
+	Dwarf
+	3
+	=> :Dwarf
+	>> fyrbard.level
+	=> 80
+	>> fyrbard.points
+	=> 4505
+	>> bitten = fyrbard.achievements(Achievements::Raid).find {|a| a.title =~ /once bitten/i}
+	=> #<Elekk::Achievement:0x1013e1aa0 @category=#<Elekk::Achievements:0x1016a6308 @name="Raid", @symbol=:Raid, @id=168>, @points=10, @description="", @id=4539, @time=Wed May 19 08:34:00 +0200 2010, @title="Once Bitten, Twice Shy (10 player)", @icon="achievement_boss_lanathel">
+	>> (Time.now - bitten.completed) / (3600*24)
+	=> 17.1609193367708
+	>> bitten.wowhead.icon_url(:large)
+	=> "http://static.wowhead.com/images/wow/icons/large/achievement_boss_lanathel.jpg"
+	>> results = Wowhead.search 'once bitten'
+	=> [#<Elekk::Wowhead::Result:0x101298108 @name="Once Bitten, Twice Shy (10 player)", @id=4539, @kind=#<Elekk::Kind:0x10141eea0 @name="Achievement", @symbol=:Achievement, @id=10>, @icon="achievement_boss_lanathel">, #<Elekk::Wowhead::Result:0x101297460 @name="Once Bitten, Twice Shy (25 player)", @id=4618, @kind=#<Elekk::Kind:0x10141eea0 @name="Achievement", @symbol=:Achievement, @id=10>, @icon="achievement_boss_lanathel">]
+	>> results.first.id == bitten.id
+	=> true
+	>> results.first.to_html
+	=> "<a href='http://www.wowhead.com/achievement=4539'>Once Bitten, Twice Shy (10 player)</a>"
+
+[1]: http://github.com/agnoster/elekk "Elekk on github"
+[2]: http://github.com/agnoster/elekk/tree/master/spec/ "Elekk specs on github"

data/spec/achievement_spec.rb

@@ -3,14 +3,14 @@ include Elekk
 
 describe Achievement do
   before :each do
-    @achievements = Character.new('Fyrbard','Uldaman').achievements(Achievements::Raid)
+    @achievements = Character.new('Fyrbard','Uldaman').achievements(:Raid)
     @oncebitten = @achievements.find {|a| a.id == 4539 }
-    @bane = @achievements.find {|a| a.id == 4608 }
+    @lk25 = @achievements.find {|a| a.id == 4608 }
   end
 
   it "should give a list of achievements" do
     @oncebitten.should_not be_nil
-    @bane.should_not be_nil
+    @lk25.should_not be_nil
   end
   
   it "should have the correct title" do
@@ -22,7 +22,7 @@ describe Achievement do
   end
   
   it "should have the correct category" do
-    @oncebitten.category.should == Achievements::Raid
+    @oncebitten.category.to_s.should == "Dungeons & Raids"
   end
   
   it "should have the correct point total as an integer" do
@@ -31,24 +31,18 @@ describe Achievement do
   
   it "should have the correct time of completion" do
     @oncebitten.completed.to_i.should == 1274250840
-    @bane.completed.should be_nil
+    @lk25.completed.should be_nil
   end
   
   it "should show correct completion state" do
     @oncebitten.complete?.should == true
-    @bane.complete?.should == false
+    @lk25.complete?.should == false
   end
   
   it "should get the correct information to display on wowhead" do
     @oncebitten.wowhead.url.should == 'http://www.wowhead.com/achievement=4539'
     @oncebitten.wowhead.icon_url(:large).should == 'http://static.wowhead.com/images/wow/icons/large/achievement_boss_lanathel.jpg'
   end
-  
-  it "should look bitchin when I print them all" do
-    @achievements.select {|a| a.complete?}.sort_by {|a| -a.completed.to_i}.each do |a|
-      puts "<a href=\"#{a.wowhead.url}\"><img src=\"#{Armory.icon_url(a.icon)}\" /> <img src=\"#{a.wowhead.icon_url(:large)}\" /> #{a.title}</a><br />"
-    end
-  end
 end
 
 

data/spec/armory_spec.rb

@@ -36,9 +36,18 @@ describe Armory do
     @armory.url('character-sheet.xml').should == 'http://us.wowarmory.com/character-sheet.xml';
   end
   
-  it "should get xml from the armory" do
+  it "should get XML from the armory" do
     xml = @armory.get_xml 'character-sheet', :r => 'Uldaman', :cn => 'Fyrbard'
     xml.should_not be_nil
   end
   
+  it "should get XML from armory with custom extensions" do
+    xml = @armory.get_xml 'character-feed.atom', :r => 'Uldaman', :cn => 'Fyrbard'
+    xml.should_not be_nil
+  end
+  
+  it "should get a multi-character feed" do
+    feed = @armory.get_feed ['Aldea', 'Alassiel', 'Puya', 'Ultimohombre', 'Fyrbard']
+  end
+  
 end

data/spec/character_spec.rb

@@ -76,10 +76,10 @@ describe Character do
   end
   
   it "should have the right title" do
-    @fyrbard.fullname.should == 'Fyrbard Jenkins'
+    @fyrbard.fullname.should == 'Fyrbard of the Ashen Verdict'
     @aldea.fullname.should == 'Aldea of the Nightfall'
     @aldea.fullname(:strong).should == '<strong>Aldea</strong> of the Nightfall'
-    @fyrbard.fullname('').should == 'Fyrbard Jenkins'
+    @fyrbard.fullname('').should == 'Fyrbard of the Ashen Verdict'
     @armory.character('Bitterleaf').fullname('strong').should == 'Loremaster <strong>Bitterleaf</strong>'
   end
   
@@ -88,5 +88,10 @@ describe Character do
     @aldea.portrait.should == 'http://us.wowarmory.com/_images/portraits/wow-80/1-1-1.gif';
     @armory.character('Harimad').portrait.should == 'http://us.wowarmory.com/_images/portraits/wow-default/1-3-1.gif';
   end
+  
+  it "should have a valid RSS feed" do
+    feed = @fyrbard.feed
+    feed.should_not be_nil
+  end
 
 end

data/spec/test.rb

@@ -0,0 +1,7 @@
+require '../lib/elekk.rb'
+
+@armory = Elekk::Armory.new 'Uldaman'
+@feeds = @armory.get_feeds ['Fyrbard', 'Aldea', 'Alassiel', 'Ultimohombre', 'Puya', 'Wulffe', 'Silinix', 'Katalia', 'Hdarkone', 'Gleanna', 'Stormrazor', 'Gracasta']
+@collated = @armory.collate_feeds @feeds
+
+@collated.each { |k,v| puts v.first[:title]; v.each {|e| puts e[:character]}; puts }

data/spec/wowhead_spec.rb

@@ -1,7 +1,7 @@
 require 'elekk'
 include Elekk
 
-describe Wowhead do
+describe Wowhead, '#search' do
   before :each do
     @q = Wowhead.search 'Varian'
   end

metadata

@@ -1,21 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: elekk
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 21
   prerelease: false
   segments: 
-  - 0
   - 1
   - 0
-  version: 0.1.0
+  - 1
+  version: 1.0.1
 platform: ruby
 authors: 
-- Isaac Wasileski
+- Isaac Wolkerstorfer
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-06-05 00:00:00 +02:00
+date: 2010-07-25 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -83,10 +83,10 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- CHANGELOG
 - Manifest
 - Rakefile
 - VERSION
+- changelog.md
 - elekk.gemspec
 - lib/elekk.rb
 - lib/elekk/achievement.rb
@@ -100,6 +100,7 @@ files:
 - spec/armory_spec.rb
 - spec/character_spec.rb
 - spec/klass_spec.rb
+- spec/test.rb
 - spec/wowhead_spec.rb
 has_rdoc: true
 homepage: http://github.com/agnoster/elekk
@@ -140,4 +141,5 @@ test_files:
 - spec/armory_spec.rb
 - spec/character_spec.rb
 - spec/klass_spec.rb
+- spec/test.rb
 - spec/wowhead_spec.rb

data/CHANGELOG

@@ -1,7 +0,0 @@
-v0.1.0
--- Get Achievements
--- 
-
-v0.0.1
--- Connect to Armory for basic character information
--- Connect to Wowhead for searches