wowheadr 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+doc/*
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in wowhead.gemspec
+gemspec

data/README.md

@@ -0,0 +1,39 @@
+wowheadr: a Powered by Wowhead Library for Ruby
+===============================================
+
+`wowheadr` (pronounced "wow header") is a Ruby gem designed to help leverage the power the [Powered by Wowhead JavaScript API][powered]. It can help generate links to items, achievements, spells, and other entities in the Wowhead database.
+
+  [powered]: http://www.wowhead.com/tooltips
+
+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)
+
+And, to generate a URL for the ability "Path of Frost" (http://www.wowhead.com/spell=3714), you would use:
+
+    Wowheadr::URI.spell(3714)
+
+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.)
+
+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
+
+(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>
+
+You can add enchants, gems, sockets, other set pieces, and more to an `Entity`:
+
+    Wowheadr::Entity::Item.new(25697).gems(23121).enchant(2647).pieces(25695, 25696, 25697)
+
+More Awesomeness
+----------------
+
+More is planned in the immediate future, including a Ruby on Rails gem that provides various helper methods to make integrating Powered by Wowhead even easier. Stay tuned!

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+require 'rake/testtask'
+
+Bundler::GemHelper.install_tasks
+Rake::TestTask.new do |t|
+  t.libs << "libs"
+  t.test_files = FileList["test/**/*.rb"]
+  t.verbose = false
+end

data/lib/wowheadr/entity/item.rb

@@ -0,0 +1,76 @@
+require 'wowheadr/uri/rel'
+
+module Wowheadr
+  module Entity
+    # Wowheadr::Entity::Item represents a +rel+ entry in an HTML link tag to
+    # specify details about the item being linked to. A list of key/value
+    # combinations can be found at
+    # http://www.wowhead.com/tooltips#related-advanced-usage
+    class Item
+      include Wowheadr::URI::Rel
+
+      # Create a new Item and optionally pass in the ID,
+      # which automatically calls #item on the new object.
+      def initialize(id = nil)
+        super()
+        unless id.nil?
+          self.item(id)
+        end
+        self
+      end
+
+      # Set the item ID for the item. Useful if the +href+ attribute of the
+      # link does not lead to the item's URL on wowhead.com (custom URLs).
+      def item(id)
+        self.set(:item, id)
+      end
+
+      # Set the character's level, useful for heirloom items.
+      def level(level)
+        self.set(:lvl, level)
+      end
+      alias :lvl :level
+
+      # Set the item's enchant using the enchant's ID.
+      def enchantment(enchant_id)
+        self.set(:ench, enchant_id)
+      end
+      alias :ench :enchantment
+      alias :enchant :enchantment
+
+      # Add the specified gems to the items gem slots using the gems' IDs.
+      # gems can be a single gem ID, multiple gem IDs, an array of gem IDs,
+      # or a colon-delimited string of gem IDs.
+      def gems(*gems)
+        if gems.is_a? String
+          self.add(:gems, gems.split(':'))
+        else
+          self.add(:gems, gems)
+        end
+      end
+
+      # Whether or not to add an extra gem socket to the item.
+      def socket(socket)
+        self.set(:sock, socket)
+      end
+      alias :extra_socket :socket
+      alias :sock :socket
+
+      def pieces(*pieces)
+        if pieces.is_a? String
+          self.add(:pcs, pieces.split(':'))
+        else
+          self.add(:pcs, pieces)
+        end
+      end
+      alias :set_pieces :pieces
+      alias :pcs :pieces
+
+      def random_enchantment(enchant_id)
+        self.set(:rand, enchant_id)
+      end
+      alias :rand :random_enchantment
+      alias :rand_enchant :random_enchantment
+    end
+  end
+end

data/lib/wowheadr/uri/rel.rb

@@ -0,0 +1,65 @@
+module Wowheadr
+  module URI
+    # Wowheadr::URI::Rel defines methods for creating the +rel+ portion of a
+    # link using the Powered by Wowhead API. For a list of supported
+    # attributes, see http://www.wowhead.com/tooltips#related-advanced-usage
+    #
+    # Once the key/value combinations for the wowhead.com entity have been
+    # set, you can retrieve the text for the +rel+ portion of an HTML link
+    # 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
+    # represent specific Wowhead entries with known rel attributes) should
+    # be created and used instead.
+    module Rel
+      # Set the wowhead domain (www, ptr, de, es, fr, ru)
+      # to display a different version or localization.
+      def domain(domain)
+        self.set(:domain, domain)
+      end
+
+      # Return the complete "rel" portion of the URL.
+      def to_s
+        return nil if @data.empty?
+
+        @data.collect do |key, value|
+          # Array values are concatenated by colons
+          if value.is_a? Array
+            "#{key}=#{value.join(':')}"
+          # Boolean values don't have a right-side assignment
+          elsif value.class == TrueClass || value.class == FalseClass
+            key
+          # All other values get the standard behavior
+          else
+            "#{key}=#{value.to_s}"
+          end
+        end.join "&"
+      end
+
+      protected
+
+        # Protected self.new to keep from being instantiated
+        def self.new
+        end
+
+        def initialize
+          @instance = nil
+          @data     = {}
+        end
+
+        # Set the given key to a single value.
+        def set(key, value)
+          @data[key.to_s] = value
+          self
+        end
+
+        # Add a value or an array of values to the given key.
+        def add(key, value)
+          @data[key.to_s] ||= []
+          @data[key.to_s] << value
+          self
+        end
+    end
+  end
+end

data/lib/wowheadr/uri.rb

@@ -0,0 +1,18 @@
+module Wowheadr
+  module URI
+    BASE_URL   = "http://www.wowhead.com/"
+    JAVASCRIPT = "http://static.wowhead.com/widgets/power.js"
+
+    def self.item(id)
+      "#{BASE_URL}item=#{id}"
+    end
+
+    def self.achievement(id)
+      "#{BASE_URL}achievement=#{id}"
+    end
+
+    def self.spell(id)
+      "#{BASE_URL}spell=#{id}"
+    end
+  end
+end

data/lib/wowheadr/version.rb

@@ -0,0 +1,3 @@
+module Wowheadr
+  VERSION = "0.0.1"
+end

data/lib/wowheadr.rb

@@ -0,0 +1,4 @@
+require 'wowheadr/version'
+require 'wowheadr/entity/item'
+require 'wowheadr/uri'
+require 'wowheadr/uri/rel'

data/test/wowheadr/entity/item_test.rb

@@ -0,0 +1,93 @@
+require 'test/unit'
+require 'wowheadr/entity/item'
+
+class ItemTest < Test::Unit::TestCase
+  def setup
+    @item = Wowheadr::Entity::Item.new
+  end
+
+  def test_item
+    @item.item(12345)
+    assert_equal "item=12345", @item.to_s
+  end
+
+  def test_new_item
+    item = Wowheadr::Entity::Item.new(12345).level(10)
+    assert_equal "item=12345&amp;lvl=10", item.to_s
+  end
+
+  def test_level
+    @item.level(10)
+    assert_equal "lvl=10", @item.to_s
+  end
+
+  def test_lvl
+    @item.lvl(10)
+    assert_equal "lvl=10", @item.to_s
+  end
+
+  def test_enchant
+    @item.enchantment(501)
+    assert_equal "ench=501", @item.to_s
+  end
+
+  def test_ench
+    @item.ench(501)
+    assert_equal "ench=501", @item.to_s
+  end
+
+  def test_gems
+    @item.gems(101)
+    assert_equal "gems=101", @item.to_s
+  end
+
+  def test_multiple_gems
+    @item.gems(101, 201, 301)
+    assert_equal "gems=101:201:301", @item.to_s
+  end
+
+  def test_multiple_gems_array
+    @item.gems([101, 201, 301])
+    assert_equal "gems=101:201:301", @item.to_s
+  end
+
+  def test_gems_string
+    @item.gems('101:201:301')
+    assert_equal "gems=101:201:301", @item.to_s
+  end
+
+  def test_pieces
+    @item.pieces(101)
+    assert_equal "pcs=101", @item.to_s
+  end
+
+  def test_multiple_pieces
+    @item.pieces(101, 201, 301)
+    assert_equal "pcs=101:201:301", @item.to_s
+  end
+
+  def test_multiple_pieces_array
+    @item.pieces([101, 201, 301])
+    assert_equal "pcs=101:201:301", @item.to_s
+  end
+
+  def test_pieces_string
+    @item.pieces('101:201:301')
+    assert_equal "pcs=101:201:301", @item.to_s
+  end
+
+  def test_random_enchantment
+    @item.random_enchantment('103')
+    assert_equal "rand=103", @item.to_s
+  end
+
+  def test_socket
+    @item.socket(true)
+    assert_equal "sock", @item.to_s
+  end
+
+  def test_chaining
+    @item.level(10).enchant(501).gems(101, 201).socket(true)
+    assert_equal "lvl=10&amp;ench=501&amp;gems=101:201&amp;sock", @item.to_s
+  end
+end

data/test/wowheadr/uri/rel_test.rb

@@ -0,0 +1,63 @@
+require 'test/unit'
+require 'wowheadr/uri/rel'
+
+# Set up a fake entity to include our Wowhead::Rel module in.
+class FakeEntity
+  include Wowheadr::URI::Rel
+end
+
+class RelTest < Test::Unit::TestCase
+  def setup
+    @rel = FakeEntity.new
+  end
+
+  def test_no_entries
+    assert_nil @rel.to_s
+  end
+
+  def test_set
+    @rel.send(:set, :lvl, 10)
+    assert_equal "lvl=10", @rel.to_s
+  end
+
+  def test_multiple_set
+    @rel.send(:set, :lvl, 10)
+    @rel.send(:set, :color, "red")
+    assert_equal "lvl=10&amp;color=red", @rel.to_s
+  end
+
+  def test_overwrite_set
+    @rel.send(:set, :lvl, 10)
+    @rel.send(:set, :lvl, 20)
+    assert_equal "lvl=20", @rel.to_s
+  end
+
+  def test_add
+    @rel.send(:add, :socket, "a")
+    @rel.send(:add, :socket, "b")
+    assert_equal "socket=a:b", @rel.to_s
+  end
+
+  def test_multiple_add
+    @rel.send(:add, :socket, ["a", "b", "c"])
+    assert_equal "socket=a:b:c", @rel.to_s
+  end
+
+  def test_set_add
+    @rel.send(:set, :lvl, 20)
+    @rel.send(:add, :gem, "first")
+    @rel.send(:set, :color, "blue")
+    @rel.send(:add, :gem, "second")
+    assert_equal "lvl=20&amp;gem=first:second&amp;color=blue", @rel.to_s
+  end
+
+  def test_set_bool
+    @rel.send(:set, :socket, true)
+    assert_equal "socket", @rel.to_s
+  end
+
+  def test_domain
+    @rel.domain('ptr')
+    assert_equal "domain=ptr", @rel.to_s
+  end
+end

data/test/wowheadr/uri.rb

@@ -0,0 +1,20 @@
+require 'test/unit'
+require 'wowheadr/uri'
+
+class URITest < Test::Unit::TestCase
+  def test_js_url
+    assert_equal Wowheadr::URI::JAVASCRIPT, "http://static.wowhead.com/widgets/power.js"
+  end
+
+  def test_item_url
+    assert_equal Wowheadr::URI.item(12345), "http://www.wowhead.com/item=12345"
+  end
+
+  def test_achievement_url
+    assert_equal Wowheadr::URI.achievement(12345), "http://www.wowhead.com/achievement=12345"
+  end
+
+  def test_spell_url
+    assert_equal Wowheadr::URI.spell(12345), "http://www.wowhead.com/spell=12345"
+  end
+end

data/wowheadr.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "wowheadr/version"
+
+Gem::Specification.new do |s|
+  s.name        = "wowheadr"
+  s.version     = Wowheadr::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Brandon Tilley"]
+  s.email       = ["binarymuse@binarymuse.net"]
+  s.homepage    = "https://github.com/BinaryMuse/wowhead"
+  s.summary     = "wowheadr #{Wowheadr::VERSION}"
+  s.description = "Leverage the power of Wowhead for your Ruby projects."
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: wowheadr
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brandon Tilley
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-28 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Leverage the power of Wowhead for your Ruby projects.
+email: 
+- binarymuse@binarymuse.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- lib/wowheadr.rb
+- lib/wowheadr/entity/item.rb
+- lib/wowheadr/uri.rb
+- lib/wowheadr/uri/rel.rb
+- lib/wowheadr/version.rb
+- test/wowheadr/entity/item_test.rb
+- test/wowheadr/uri.rb
+- test/wowheadr/uri/rel_test.rb
+- wowheadr.gemspec
+has_rdoc: true
+homepage: https://github.com/BinaryMuse/wowhead
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: wowheadr 0.0.1
+test_files: 
+- test/wowheadr/entity/item_test.rb
+- test/wowheadr/uri.rb
+- test/wowheadr/uri/rel_test.rb