wowheadr 0.0.3 → 0.0.4

data/README.md

@@ -10,29 +10,39 @@ Generating URLs
 
 You can generate URLs for (currently) items, achievements, and spells, providing you know the ID for the entity you want a URL for. Use the methods in `Wowheadr::URI` to generate the URLs. For example, to generate a URL for the item "Bloodied Prison Shank" (http://www.wowhead.com/item=43659), you would use:
 
-    Wowheadr::URI.item(43659)
+    gift = Wowheadr::URI.item(43659)
 
-And, to generate a URL for the ability "Path of Frost" (http://www.wowhead.com/spell=3714), you would use:
+And, to generate a URL for the ability "Bear Form" (http://www.wowhead.com/spell=5487), you would use:
 
-    Wowheadr::URI.spell(3714)
+    sum_durids = Wowheadr::URI.spell(5487)
 
 Advanced Usage
 --------------
 
-Wowhead provides the ability to customize links to various entities on their site using the `rel` property of the HTML link tag. Wowheadr supports this via the `Wowheadr::Entity` classes. (Currently, only `Item` is available.)
+Wowhead provides the ability to customize links to various entities on their site using the `rel` property of the HTML link tag. Wowheadr supports this via the `Wowheadr::Entity` classes. (Currently, only `Item` and `Spell` are available.)
+
+### Items
 
 For example, to get the `rel` attribute for a link to a "Bloodied Arcanite Reaper" (http://www.wowhead.com/item=42943) tuned for a level 25 character, you can use:
 
-    Wowheadr::Entity::Item.new(42943).level(25).to_s
+    zinwrath = Wowheadr::Entity::Item.new(42943).level(25).to_s
 
 (Calling `to_s` on any `Entity` class returns the text that should be placed in the `rel` attribute of your link, as shown:)
 
-    <a hef="http://non-wowhead-site.com" rel="item=42943&amp;lvl=25">Got an awesome new item for my character</a>
+    <a hef="http://www.warcraftmovies.com/movieview.php?id=7558" rel="item=42943&amp;lvl=25">Arcanite Reaper, HOOOOO</a>
 
-You can add enchants, gems, sockets, other set pieces, and more to an `Entity`:
+You can add enchants, gems, sockets, other set pieces, and more to an `Item`:
 
     Wowheadr::Entity::Item.new(25697).gems(23121).enchant(2647).pieces(25695, 25696, 25697)
 
+### Spells
+
+Spells work similarly. You can change the level using the `level()` method (for spell scaling), and you can use the `buff()` method to cause the tooltip to show the buff or debuff the spell causes rather than the spell itself.
+
+    man_angle     = Wowheadr::Entity::Spell.new(33878).level(10).to_s
+    level_ten_rel = man_angle.level(10).to_s
+    debuff_rel    = man_angle.buff(true).to_s
+
 More Awesomeness
 ----------------
 

data/lib/wowheadr/entity/spell.rb

@@ -32,7 +32,7 @@ module Wowheadr
       alias :lvl :level
 
       # Whether or not to show the tooltip for the buff the spell provides,
-      # rathern than for the spell itself.
+      # rather than for the spell itself.
       def buff(buff)
         self.set(:buff, buff)
       end

data/lib/wowheadr/uri/rel.rb

@@ -9,7 +9,7 @@ module Wowheadr
     # tag by calling +to_s+ on the object.
     #
     # The methods to modify the data inside a Rel is protected, and a Rel
-    # object can not be instantiated--instead, subclasses of Rel which
+    # object can not be instantiated--instead, subclasses of Rel (which
     # represent specific Wowhead entries with known rel attributes) should
     # be created and used instead.
     module Rel

data/lib/wowheadr/uri.rb

@@ -3,16 +3,30 @@ module Wowheadr
     BASE_URL   = "http://www.wowhead.com/"
     JAVASCRIPT = "http://static.wowhead.com/widgets/power.js"
 
-    def self.item(id)
-      "#{BASE_URL}item=#{id}"
+    # Return a URL for an entity on the wowhead.com site.
+    # For example, self.url(:item, 43659) generates
+    # http://www.wowhead.com/item=43659.
+    #
+    # To generate a URL for a different subdomain, pass the subdomain
+    # (such as "ptr") as the optional third parameter.
+    def self.url(entity, id, subdomain = nil)
+      base_url = subdomain.nil? ? BASE_URL : BASE_URL.gsub("www", subdomain.to_s)
+      "#{base_url}#{entity.to_s}=#{id.to_s}"
     end
 
-    def self.achievement(id)
-      "#{BASE_URL}achievement=#{id}"
+    # Shortcut for self.url(:item, ...)
+    def self.item(id, subdomain = nil)
+      url(:item, id, subdomain)
     end
 
-    def self.spell(id)
-      "#{BASE_URL}spell=#{id}"
+    # Shortcut for self.url(:achievement, ...)
+    def self.achievement(id, subdomain = nil)
+      url(:achievement, id, subdomain)
+    end
+
+    # Shortcut for self.url(:spell, ...)
+    def self.spell(id, subdomain = nil)
+      url(:spell, id, subdomain)
     end
   end
 end

data/lib/wowheadr/version.rb

@@ -1,3 +1,3 @@
 module Wowheadr
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/test/wowheadr/uri.rb

@@ -10,11 +10,31 @@ class URITest < Test::Unit::TestCase
     assert_equal Wowheadr::URI.item(12345), "http://www.wowhead.com/item=12345"
   end
 
+  def test_item_url_subdomain
+    assert_equal Wowheadr::URI.item(12345, 'ptr'), "http://ptr.wowhead.com/item=12345"
+  end
+
   def test_achievement_url
     assert_equal Wowheadr::URI.achievement(12345), "http://www.wowhead.com/achievement=12345"
   end
 
+  def test_achievement_url_subdomain
+    assert_equal Wowheadr::URI.achievement(12345, 'ptr'), "http://ptr.wowhead.com/achievement=12345"
+  end
+
   def test_spell_url
     assert_equal Wowheadr::URI.spell(12345), "http://www.wowhead.com/spell=12345"
   end
-end
+
+  def test_spell_url_subdomain
+    assert_equal Wowheadr::URI.spell(12345, 'ptr'), "http://ptr.wowhead.com/spell=12345"
+  end
+
+  def test_manual_url
+    assert_equal Wowheadr::URI.url(:npc, 48935), "http://www.wowhead.com/npc=48935"
+  end
+
+  def test_manual_url_subdomain
+    assert_equal Wowheadr::URI.url(:npc, 48935, 'ptr'), "http://ptr.wowhead.com/npc=48935"
+  end
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Brandon Tilley
@@ -74,7 +74,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: wowheadr 0.0.3
+summary: wowheadr 0.0.4
 test_files: 
 - test/wowheadr/entity/item_test.rb
 - test/wowheadr/entity/spell_test.rb