wowget 0.0.1 → 0.1.0

data/lib/wowget.rb

@@ -1,5 +1,5 @@
-class Wowget
-  def self.foo
-    puts "Foo!"
-  end
+require 'wowget/item.rb'
+
+module Wowget
+  # ...
 end

data/lib/wowget/item.rb

@@ -0,0 +1,231 @@
+require 'open-uri'
+require 'nokogiri'
+require 'json'
+
+module Wowget
+  class Item
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :level
+    attr_accessor :quality_id
+    attr_accessor :item_class_id
+    attr_accessor :item_subclass_id
+    attr_accessor :icon_id
+    attr_accessor :icon_name
+    attr_accessor :required_level
+    attr_accessor :inventory_slot_id
+    attr_accessor :buy_price
+    attr_accessor :sell_price
+    attr_accessor :recipe_id
+    attr_accessor :error
+    
+    ITEM_QUALITIES = ['Poor', 'Common', 'Uncommon', 'Rare', 'Epic', 'Legendary', 'Artifact', 'Heirloom']
+    ITEM_CLASSES = {
+      0 => 'Consumables',
+      1 => 'Containers',
+      2 => 'Weapons',
+      3 => 'Gems',
+      4 => 'Armor',
+      7 => 'Trade Goods',
+      9 => 'Recipes',
+      10 => 'Currency',
+      12 => 'Quest',
+      13 => 'Keys',
+      15 => 'Miscellaneous',
+      16 => 'Glyphs'
+    }  
+    ITEM_SUBCLASSES = {
+      'Consumables' => {
+        0 => 'Consumables',
+        1 => 'Potions',
+        2 => 'Elixirs',
+        3 => 'Flasks',
+        4 => 'Scrolls',
+        5 => 'Food & Drinks',
+        6 => 'Item Enhancements (Permanent)',
+        -3 => 'Item Enhancements (Temporary)',
+        7 => 'Bandages',
+        8 => 'Other'
+      },
+      'Containers' => {
+        0 => 'Bags',
+        2 => 'Herb Bags',
+        3 => 'Enchanting Bags',
+        4 => 'Engineering Bags',
+        5 => 'Gem Bags',
+        6 => 'Mining Bags',
+        7 => 'Leatherworking Bags',
+        8 => 'Inscription Bags',
+        9 => 'Tackle Boxes'
+      },
+      'Weapons' => {
+        1 => 'Two-Handed Axes',
+        2 => 'Bows',
+        3 => 'Guns',
+        4 => 'One-Handed Maces',
+        5 => 'Two-Handed Maces',
+        6 => 'Polearms',
+        7 => 'One-Handed Swords',
+        8 => 'Two-Handed Swords',
+        10 => 'Staves',
+        13 => 'Fist Weapons',
+        14 => 'Miscellaneous',
+        15 => 'Daggers',
+        16 => 'Thrown',
+        18 => 'Crossbows',
+        19 => 'Wands',
+        20 => 'Fishing Poles'
+      },
+      'Gems' => {
+        1 => 'Blue',
+        2 => 'Yellow',
+        3 => 'Purple',
+        4 => 'Green',
+        5 => 'Orange',
+        6 => 'Meta',
+        7 => 'Simple',
+        8 => 'Prismatic',
+        9 => 'Hydraulic',
+        10 => 'Cogwheel'
+      },
+      'Armor' => {
+        -8 => 'Shirts',
+        -7 => 'Tabards',
+        -6 => 'Cloaks',
+        -5 => 'Off-hand Frills',
+        -4 => 'Trinkets',
+        -3 => 'Amulets',
+        -2 => 'Rings',
+        0 => 'Miscellaneous',
+        1 => 'Cloth Armor',
+        2 => 'Leather Armor',
+        3 => 'Mail Armor',
+        4 => 'Plate Armor',
+        6 => 'Shields',
+        11 => 'Relics'
+      },
+      'Trade Goods' => {
+        1 => 'Parts',
+        2 => 'Explosives',
+        3 => 'Devices',
+        4 => 'Jewelcrafting',
+        5 => 'Cloth',
+        6 => 'Leather',
+        7 => 'Metal & Stone',
+        8 => 'Meat',
+        9 => 'Herbs',
+        10 => 'Elemental',
+        11 => 'Other',
+        12 => 'Enchanting',
+        13 => 'Materials',
+        14 => 'Armor Enchantments',
+        15 => 'Weapon Enchantments'
+      },
+      'Recipes' => {
+        0 => 'Books ',
+        1 => 'Leatherworking Patterns',
+        2 => 'Tailoring Patterns',
+        3 => 'Engineering Schematics',
+        4 => 'Blacksmithing Plans',
+        5 => 'Cooking Recipes',
+        6 => 'Alchemy Recipes',
+        7 => 'First Aid Manuals',
+        8 => 'Enchanting Formulae',
+        9 => 'Fishing Books',
+        10 => 'Jewelcrafting Designs',
+        11 => 'Inscription Techniques'
+      },
+      'Miscellaneous' => {
+        -2 => 'Armor Tokens',
+        0 => 'Junk',
+        1 => 'Reagents',
+        2 => 'Companions',
+        3 => 'Holiday',
+        4 => 'Other',
+        5 => 'Mounts'
+      },
+      'Glyphs' => {
+        1 => 'Warrior',
+        2 => 'Paladin',
+        3 => 'Hunter',
+        4 => 'Rogue',
+        5 => 'Priest',
+        6 => 'Death Knight',
+        7 => 'Shaman',
+        8 => 'Mage',
+        9 => 'Warlock',
+        11 => 'Druid'
+      }
+    }
+    INVENTORY_SLOTS = {
+      16 => 'Back',
+      18 => 'Bag',
+      5 => 'Chest',
+      8 => 'Feet',
+      11 => 'Finger',
+      10 => 'Hands',
+      1 => 'Head',
+      23 => 'Held In Off-hand',
+      7 => 'Legs',
+      21 => 'Main Hand',
+      2 => 'Neck',
+      22 => 'Off Hand',
+      13 => 'One-Hand',
+      24 => 'Projectile',
+      15 => 'Ranged',
+      28 => 'Relic',
+      14 => 'Shield',
+      4 => 'Shirt',
+      3 => 'Shoulder',
+      19 => 'Tabard',
+      25 => 'Thrown',
+      12 => 'Trinket',
+      17 => 'Two-Hand',
+      6 => 'Waist',
+      9 => 'Wrist'
+    }
+    
+    def initialize(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.item_class_id     = item_xml.css('wowhead item class').attribute('id').content.to_i
+        self.item_subclass_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']
+        self.sell_price        = item_equip_json['sellprice']
+        
+        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
+
+    def quality
+      ITEM_QUALITIES[self.quality_id]
+    end
+    
+    def item_class
+      ITEM_CLASSES[self.item_class_id]
+    end
+    
+    def item_subclass
+      ITEM_SUBCLASSES[self.item_class][self.item_subclass_id]
+    end
+    
+    def inventory_slot
+      INVENTORY_SLOTS[self.inventory_slot_id]
+    end
+    
+  end
+end

data/lib/wowget/spell.rb

@@ -0,0 +1,53 @@
+require 'open-uri'
+require 'nokogiri'
+
+module Wowget
+  class Spell
+    attr_accessor :id
+    attr_accessor :name
+    attr_accessor :item_id
+    attr_accessor :reagents
+    attr_accessor :profession
+    attr_accessor :skill_level
+    attr_accessor :error
+
+    def initialize(spell_id)
+      begin
+        url = open("http://www.wowhead.com/spell=#{spell_id}")        
+      rescue
+        not_found = true
+      end
+      
+      spell_xml = Nokogiri::XML(url) unless not_found
+      
+      if not_found || spell_xml.css('div#inputbox-error').length == 1
+        self.error = {:error => "not found"}
+      else
+        self.name = spell_xml.css('div.text h1').inner_text.strip.to_s
+        
+        if spell_xml.css('table#spelldetails td span.q4 a').length == 1
+          self.item_id = spell_xml.css('table#spelldetails td span.q4 a').attribute('href').content.scan(/\/item=([0-9]+)/)[0][0].to_i          
+        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.scan(/\/item=([0-9]+)/)[0][0].to_i
+            quantity = r.content.scan(/\(([0-9]+)\)$/)[0][0].to_i
+            self.reagents.push({:item => Wowget::Item.new(item_id), :quantity => quantity})
+          end
+        end
+        
+        # profession
+        unless self.item_id.nil?
+          p = spell_xml.xpath("//script[contains(., 'Markup')]").inner_text.scan(/\[ul\]\[li\](.+?)\[\/li\]/)[0][0].scan(/Requires (.+?) \(([0-9]+?)\)/)[0]
+          self.profession = p[0]
+          self.skill_level = p[1].to_i
+        end
+      end
+    end
+    
+  end
+end

data/spec/item_spec.rb

@@ -0,0 +1,85 @@
+require "lib/wowget/item.rb"
+
+describe Wowget::Item do
+  
+  describe "With a valid ID" do
+    item = Wowget::Item.new(4817)
+    
+    it "should have an item name" do
+      item.name.should == "Blessed Claymore"
+    end
+    
+    it "should have an item level" do
+      item.level.should == 22
+    end
+    
+    it "should have a quality value" do
+      item.quality_id.should == 2
+    end
+    
+    it "should have a quality name" do
+      item.quality.should == "Uncommon"
+    end
+    
+    it "should have an item class value" do
+      item.item_class_id.should == 2
+    end
+    
+    it "should have an item class name" do
+      item.item_class.should == "Weapons"
+    end
+
+    it "should have an item subclass value" do
+      item.item_subclass_id.should == 8
+    end
+
+    it "should have an item subclass name" do
+      item.item_subclass.should == "Two-Handed Swords"
+    end
+    
+    it "should have an icon value" do
+      item.icon_id.should == 7319
+    end
+    
+    it "should have an icon name" do
+      item.icon_name.should == "INV_Sword_13"
+    end
+    
+    it "should have an inventory slot value" do
+      item.inventory_slot_id.should == 17
+    end
+    
+    it "should have an inventory slot name" do
+      item.inventory_slot.should == "Two-Hand"
+    end
+    
+    it "should have a required minimum level" do
+      item.required_level.should == 17
+    end
+    
+    it "should have a vendor sell price" do
+      item.sell_price.should == 2462
+    end
+    
+    it "should have a vendor buy price" do
+      item.buy_price.should == 12311
+    end
+    
+  end
+  
+  describe "With a recipe" do
+    item = Wowget::Item.new(45559)
+    
+    it "should have a recipe spell to create this item" do
+      item.recipe_id.should == 63188
+    end
+  end
+  
+  describe "With an invalid ID" do
+    item = Wowget::Item.new(nil)
+    it "should return an error" do
+      item.error.should == {:error => "not found"}
+    end   
+  end
+
+end

data/spec/spell_spec.rb

@@ -0,0 +1,52 @@
+require "lib/wowget/item.rb"
+require "lib/wowget/spell.rb"
+
+describe Wowget::Spell do
+  
+  describe "With a valid ID" do
+    spell = Wowget::Spell.new(63188)
+    
+    it "should have a spell name" do
+      spell.name.should == "Battlelord's Plate Boots"
+    end
+    
+  end
+
+  describe "With a recipe" do
+    spell = Wowget::Spell.new(63188)
+    
+    it "should have the ID for the item it produces" do
+      spell.item_id.should == 45559
+    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
+      spell.reagents[0][:item].name.should == 'Titansteel Bar' and
+      spell.reagents[0][:quantity].should == 5 and
+      spell.reagents[1][:item].name.should == 'Runed Orb' and
+      spell.reagents[1][:quantity].should == 6
+    end
+    
+    it "should have a professional skill requirement" do
+      spell.profession.should == 'Blacksmithing' and
+      spell.skill_level.should == 450
+    end
+  end
+  
+  describe "Without a recipe" do
+    spell = Wowget::Spell.new(50842)
+    
+    it "shouldn't have an ID for an item" do
+      spell.item_id.should == nil
+    end
+  end
+  
+  describe "With an invalid ID" do
+    spell = Wowget::Spell.new(nil)
+    it "should return an error" do
+      spell.error.should == {:error => "not found"}
+    end   
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: wowget
 version: !ruby/object:Gem::Version 
-  hash: 29
-  prerelease: 
+  hash: 27
+  prerelease: false
   segments: 
   - 0
-  - 0
   - 1
-  version: 0.0.1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - Ben Darlow
@@ -15,11 +15,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-26 00:00:00 +01:00
+date: 2011-06-27 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
-description: Provides a RESTful API to wowhead.com's database.
+description: Ruby API to wowhead.com's item and spell database.
 email: ben@kapowaz.net
 executables: []
 
@@ -28,7 +28,11 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- lib/wowget/item.rb
+- lib/wowget/spell.rb
 - lib/wowget.rb
+- spec/item_spec.rb
+- spec/spell_spec.rb
 has_rdoc: true
 homepage: http://github.com/kapowaz/wowget
 licenses: []
@@ -59,7 +63,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: wowget