wowget 0.2.3 → 0.3.0

data/lib/wowget/item.rb

@@ -187,52 +187,80 @@ module Wowget
       28 => 'Relic'
     }
     
-    def initialize(query)
+    def self.find(query)
+      item_ids = []
+      items    = []
       
       if query.class == Fixnum
         # easy — e.g. 12345
-        item_id = query
+        item_ids << query
       elsif query.class == String
         # try parsing a number, e.g. "12345"
         item_id = id_from_string(query)
         
-        # try searching for this item by name
-        unless item_id
+        unless item_id.nil?
+          item_ids << item_id
+        else
+          # try searching for this item by name
           item_redirect = Net::HTTP.get_response(URI.parse("http://www.wowhead.com/search?q=#{uri_escape(query)}"))["Location"]
           if item_redirect
-            item_id = item_redirect.match(/^\/item=([1-9][0-9]*)$/)[1].to_i
+            item_ids << item_redirect.match(/^\/item=([1-9][0-9]*)$/)[1].to_i
+          else
+            # try retrieving a list of items that match the supplied query
+            begin
+              # horrendously messy. fuck you very much, wowhead.
+              item_json = JSON Nokogiri::XML(open("http://www.wowhead.com/search?q=#{uri_escape(query)}")).inner_text.match(/new Listview\(\{template: 'item'.*, data: (\[.*\])\}\);$/)[1]
+            rescue
+              no_results = true
+            end
+            
+            if no_results || item_json.length == 0
+              self.error = {:error => "no items found"}
+            else
+              item_json.each do |item|
+                item_ids << item["id"].to_i
+              end
+            end
           end
         end
+      elsif query.class == NilClass
+        item_ids << nil
       end
       
-      if item_id
-        item_xml = Nokogiri::XML(open("http://www.wowhead.com/item=#{item_id}&xml"))
-        if item_xml.css('wowhead error').length == 1
-          self.error = {:error => "not found"}
-        else
-          item_json                = JSON "{#{item_xml.css('wowhead item json').inner_text.strip.to_s}}"
-          item_equip_json          = JSON "{#{item_xml.css('wowhead item jsonEquip').inner_text.strip.to_s}}"
-          self.id                  = item_id.to_i
-          self.name                = item_xml.css('wowhead item name').inner_text.strip.to_s
-          self.level               = item_xml.css('wowhead item level').inner_text.strip.to_i
-          self.quality_id          = item_xml.css('wowhead item quality').attribute('id').content.to_i
-          self.category_id    = item_xml.css('wowhead item class').attribute('id').content.to_i
-          self.subcategory_id = item_xml.css('wowhead item subclass').attribute('id').content.to_i
-          self.icon_id             = item_xml.css('wowhead item icon').attribute('displayId').content.to_i
-          self.icon_name           = item_xml.css('wowhead item icon').inner_text.strip.to_s
-          self.required_level      = item_json['reqlevel']
-          self.inventory_slot_id   = item_xml.css('wowhead item inventorySlot').attribute('id').content.to_i
-          self.buy_price           = item_equip_json['buyprice'].to_i
-          self.sell_price          = item_equip_json['sellprice'].to_i
-
-          if item_xml.css('wowhead item createdBy').length == 1
-            self.recipe_id = item_xml.css('wowhead item createdBy spell').attribute('id').content.to_i
-          end
+      if item_ids.length > 0
+        item_ids.each do |item_id|
+          items << Wowget::Item.new(item_id)
         end
-      elsif query.class == NilClass
+      end
+      
+      items.length == 1 ? items[0] : items
+    end
+    
+    def initialize(item_id)
+      item_xml = Nokogiri::XML(open("http://www.wowhead.com/item=#{item_id}&xml"))
+      if item_id.nil?
         self.error = {:error => "no item ID supplied"}
+      elsif item_xml.css('wowhead error').length == 1
+        self.error = {:error => "not found"}
       else
-        self.error = {:error => "unsupported initialiser"}
+        item_json              = JSON "{#{item_xml.css('wowhead item json').inner_text.strip.to_s}}"
+        item_equip_json        = JSON "{#{item_xml.css('wowhead item jsonEquip').inner_text.strip.to_s}}"
+        self.id                = item_id.to_i
+        self.name              = item_xml.css('wowhead item name').inner_text.strip.to_s
+        self.level             = item_xml.css('wowhead item level').inner_text.strip.to_i
+        self.quality_id        = item_xml.css('wowhead item quality').attribute('id').content.to_i
+        self.category_id       = item_xml.css('wowhead item class').attribute('id').content.to_i
+        self.subcategory_id    = item_xml.css('wowhead item subclass').attribute('id').content.to_i
+        self.icon_id           = item_xml.css('wowhead item icon').attribute('displayId').content.to_i
+        self.icon_name         = item_xml.css('wowhead item icon').inner_text.strip.to_s
+        self.required_level    = item_json['reqlevel']
+        self.inventory_slot_id = item_xml.css('wowhead item inventorySlot').attribute('id').content.to_i
+        self.buy_price         = item_equip_json['buyprice'].to_i
+        self.sell_price        = item_equip_json['sellprice'].to_i
+
+        if item_xml.css('wowhead item createdBy').length == 1
+          self.recipe_id = item_xml.css('wowhead item createdBy spell').attribute('id').content.to_i
+        end
       end
     end
 
@@ -268,11 +296,11 @@ module Wowget
     
     private
     
-    def id_from_string(string)
+    def self.id_from_string(string)
       string.to_i if string.match /^[1-9][0-9]*$/
     end
     
-    def uri_escape(string)
+    def self.uri_escape(string)
       URI.escape(string, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
     end
     

data/lib/wowget/spell.rb

@@ -1,15 +1,20 @@
 require 'open-uri'
 require 'nokogiri'
+require 'json'
 
 module Wowget
   class Spell
     attr_accessor :id
     attr_accessor :name
     attr_accessor :item_id
+    attr_accessor :item_quantity_min
+    attr_accessor :item_quantity_max
     attr_accessor :reagents
     attr_accessor :profession
     attr_accessor :profession_id
     attr_accessor :skill
+    attr_accessor :skillup
+    attr_accessor :source_id
     attr_accessor :error
 
     def initialize(spell_id)
@@ -26,59 +31,76 @@ module Wowget
       else
         self.name = spell_xml.css('div.text h1').inner_text.strip.to_s
         
-        # does this spell produce an item? if so, what item_id?
-        if spell_xml.css('table#spelldetails th#icontab-icon1 + td span a').length == 1
-          self.item_id = spell_xml.css('table#spelldetails th#icontab-icon1 + td span a').attribute('href').content.match(/\/item=([0-9]+)/)[1].to_i
-        end
-
-        # profession
-        unless self.item_id.nil?
-          prof_markup = spell_xml.xpath("//script[contains(., 'Markup')]")
+        # retrieve recipe data
+        recipe = spell_xml.inner_text.match(/^new Listview\(\{template: 'spell', id: 'recipes', .*, data: (\[\{.*\}\])\}\);$/)
+        unless recipe.nil?
+          recipe_json = (JSON recipe[1])[0]
           
-          unless prof_markup.empty?
-            matches = prof_markup.inner_text.match(/\[ul\]\[li\](.+?)\[\/li\]/)[1].match(/Requires (.+?) \(([0-9]+?)\)/)
-            self.profession = matches[1]
-            self.profession_id = case self.profession
-              when "Alchemy" then 1
-              when "Blacksmithing" then 2
-              when "Cooking" then 3
-              when "Enchanting" then 4
-              when "Engineering" then 5
-              when "First Aid" then 6
-              when "Jewelcrafting" then 7
-              when "Leatherworking" then 8
-              when "Mining" then 9
-              when "Tailoring" then 10
-              when "Yes" then 11
-              when "No" then 12
-              when "Fishing" then 13
-              when "Herbalism" then 14
-              when "Inscription" then 15
-              when "Archaeology" then 16
+          unless recipe_json["creates"].nil?
+            # item produced and quantity
+            self.item_id           = recipe_json["creates"][0]
+            self.item_quantity_min = recipe_json["creates"][1]
+            self.item_quantity_max = recipe_json["creates"][2]
+            
+            # profession
+            unless recipe_json["skill"].nil?
+              profession         = wowhead_profession(recipe_json["skill"][0])
+              self.profession    = profession[:name]
+              self.profession_id = profession[:id]
+              self.skill         = recipe_json["learnedat"]
+              self.skillup       = recipe_json["nskillup"]
+              self.source_id     = recipe_json["source"][0]
             end
-            self.skill = matches[2].to_i
-          end
-        end
-        
-        # reagents
-        if spell_xml.css("h3:contains('Reagents')").length == 1
-          self.reagents = []
-          reagents = spell_xml.css("h3:contains('Reagents')+table.iconlist tr td")
-          reagents.each do |r|
-            item_id = r.css("span a").attribute('href').content.match(/\/item=([0-9]+)/)[1].to_i
-            quantity_match = r.content.match(/\(([0-9]+)\)$/)
-            if quantity_match.nil?
-              quantity = 1
-            else
-              quantity = quantity_match[1].to_i
-              quantity += 1 if self.profession.nil? # see http://www.wowhead.com/spell=49244#comments:id=448843
-            end
-            self.reagents.push({:item => Wowget::Item.new(item_id), :quantity => quantity})
+            
+            # reagents
+            self.reagents = []
+            recipe_json["reagents"].each do |reagent|
+              item_id  = reagent[0]
+              quantity = self.profession_id.nil? ? reagent[1] + 1 : reagent[1]
+              self.reagents.push({:item => Wowget::Item.new(item_id), :quantity => quantity})
+            end 
           end
         end
         
       end
     end
     
+    def source
+      case self.source_id
+        when 1 then "Crafted"
+        when 2 then "Drop"
+        when 3 then "PvP"
+        when 4 then "Quest"
+        when 5 then "Vendor"
+        when 6 then "Trainer"
+        when 7 then "Discovery"
+        when 8 then "Redemption"
+        when 9 then "Talent"
+        when 10 then "Starter"
+        when 11 then "Event"
+        when 12 then "Achievement"
+      end
+    end
+    
+    private
+    
+    def wowhead_profession(id)
+      case id
+        when 171 then {:name => "Alchemy",        :id => 1}
+        when 164 then {:name => "Blacksmithing",  :id => 2}
+        when 333 then {:name => "Enchanting",     :id => 4}
+        when 202 then {:name => "Engineering",    :id => 5}
+        when 182 then {:name => "Herbalism",      :id => 14}
+        when 773 then {:name => "Inscription",    :id => 15}
+        when 755 then {:name => "Jewelcrafting",  :id => 7}
+        when 165 then {:name => "Leatherworking", :id => 8}
+        when 186 then {:name => "Mining",         :id => 9}
+        when 197 then {:name => "Tailoring",      :id => 10}
+        when 794 then {:name => "Archaeology",    :id => 16}
+        when 185 then {:name => "Cooking",        :id => 3}
+        when 129 then {:name => "First Aid",      :id => 6}
+      end
+    end
+    
   end
 end

data/lib/wowget.rb

@@ -1,2 +1,6 @@
 require 'wowget/item.rb'
-require 'wowget/spell.rb'
+require 'wowget/spell.rb'
+
+module Wowget
+  VERSION = '0.3.0'
+end

data/spec/item_spec.rb

@@ -3,7 +3,7 @@ require_relative "../lib/wowget/item.rb"
 describe Wowget::Item do
   
   describe "With a valid ID" do
-    item = Wowget::Item.new(4817)
+    item = Wowget::Item.find(4817)
     
     it "should have an item name" do
       item.name.should == "Blessed Claymore"
@@ -58,11 +58,11 @@ describe Wowget::Item do
     end
     
     it "should have a vendor sell price" do
-      item.sell_price.should == 2462
+      item.sell_price.should == 2462 and item.sell_price.class.should == Fixnum
     end
     
     it "should have a vendor buy price" do
-      item.buy_price.should == 12311
+      item.buy_price.should == 12311 and item.sell_price.class.should == Fixnum
     end
     
     it "should produce a colorised link" do
@@ -72,14 +72,14 @@ describe Wowget::Item do
   end
   
   describe "With an ID passed as a string" do
-    item = Wowget::Item.new("4817")
+    item = Wowget::Item.find("4817")
     it "should have an item name" do
       item.name.should == "Blessed Claymore"
     end
   end
   
   describe "With a recipe" do
-    item = Wowget::Item.new(45559)
+    item = Wowget::Item.find(45559)
     
     it "should have a recipe spell to create this item" do
       item.recipe_id.should == 63188
@@ -87,25 +87,33 @@ describe Wowget::Item do
   end
   
   describe "With an invalid ID" do
-    item = Wowget::Item.new(-1000)
-    it "should return an error" do
+    item = Wowget::Item.find(-1000)
+    it "should return the error 'not found'" do
       item.error.should == {:error => "not found"}
     end
   end
   
   describe "With no item ID supplied" do
-    item = Wowget::Item.new(nil)
-    it "should return an error" do
+    item = Wowget::Item.find(nil)
+    it "should return the error 'no item ID supplied'" do
       item.error.should == {:error => "no item ID supplied"}
     end
   end
   
   describe "When the name of an item is supplied" do
-    item = Wowget::Item.new("Blessed Claymore")
+    item = Wowget::Item.find("Blessed Claymore")
     
     it "should find the appropriate item" do
       item.id.should == 4817
     end
   end
 
+  describe "When an item name with multiple matches is supplied" do
+    it "should return an array of items" do
+      items = Wowget::Item.find("Titansteel")
+      items.class.should == ::Array
+      items.length.should == 15
+    end
+  end
+
 end

data/spec/spell_spec.rb

@@ -36,6 +36,10 @@ describe Wowget::Spell do
       spell.item_id.should == 45559
     end
     
+    it "should have a minimum and maximum number of items produced" do
+      spell.item_quantity_min.should == 1 and spell.item_quantity_max.should == 1
+    end
+    
     it "should have a list of reagents" do
       spell.reagents.length.should == 2 and
       spell.reagents.all? {|r| r[:item].class == Wowget::Item}.should == true and
@@ -50,6 +54,10 @@ describe Wowget::Spell do
       spell.profession.should == 'Blacksmithing' and
       spell.skill.should == 450
     end
+    
+    it "should have a source" do
+      spell.source.should == "Drop"
+    end
   end
   
   describe "Without a recipe" do

metadata

@@ -2,7 +2,7 @@
 name: wowget
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors: 
 - Ben Darlow
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-05 00:00:00 +01:00
+date: 2011-07-12 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency