wow 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e57690e52632a1d8f631ab3faab9e626d49506a
-  data.tar.gz: db53cfe90b6dadb0a30da15dddb61f9cf23c86b3
+  metadata.gz: 377cb66f84d3cc45b4c592a6f72f40e2ea650fff
+  data.tar.gz: f9a903b65b3a628482f8c2a94e69e94acda1c8ae
 SHA512:
-  metadata.gz: 67e3f24949de0b24f669d30e0e204f925ba6ad648fc14fe586b5656c3febb799bcce25c4d05ae7721fa0df51b076aaffbe3959c58566347aa153299947e109c9
-  data.tar.gz: 8b3d27db5fa1ddcfab0271ee5fd4f3beb7ef13abd30521d999beceee7eccff5d957cd127053d0d28de08390466c878bd8041cf1aeb8a15f1545425e22bb6d5bc
+  metadata.gz: 63966434e738399f93767aabf04580db97504f56680e674bb2202c7e6f7f068cac8c69131672ae897b5466f1574e832c4c2fad045359338781194d8c20efd60d
+  data.tar.gz: 68985a434342c46b547294bfc7ad8b915d96d491c2b347a3951ba95cbb1def64d803d29677a9b1004cd59d0b8f5a374abb36e987842dcecbd0544cc2b8329788

data/examples/example.rb

@@ -1,12 +1,8 @@
 require "wow"
 
-# 25.times do |i|
-#   begin
-#     achive = WoW::Achievement.new(i)
-#     puts "#{achive[:id]} : #{achive[:title]}"
-#   rescue WoW::APIError
-#     puts "#{i} : No Achievement"
-#   end
-# end
-
-puts WoW::CharacterProfile.new("Stormreaver", "Epicgrim").lookup(:class)
+epicgrim = WoW::Character.new("Stormreaver", "Epicgrim", [:items, :talents])
+puts epicgrim["achievementPoints"]
+puts epicgrim["items"]["averageItemLevelEquipped"]
+p epicgrim.gets
+puts epicgrim.get?("class")
+puts epicgrim.get("class")

data/lib/wow.rb

@@ -6,6 +6,7 @@ require 'wow/base'
 module WoW
   class ConfigurationError < StandardError; end
   class APIError < StandardError; end
+  class FieldMissingError < StandardError; end
 
   # Blizzard defined hosts, and locales.
   # See http://blizzard.github.io/api-wow-docs/#features/access-and-regions

data/lib/wow/base.rb

@@ -12,13 +12,18 @@ module WoW
       end
     end
 
-    def [](key)
-      super(key.to_sym)
+    def gets
+      private_methods.select { |m| m =~ /get_/ }.map do |name|
+        name.to_s.gsub(/get_/, "")
+      end
     end
 
-    def []=(key, value)
-      super(key.to_sym, value)
+    def get(method)
+      self.send("get_#{method}")
     end
 
+    def get?(method)
+      gets.include?(method)
+    end
   end
 end

data/lib/wow/features.rb

@@ -2,7 +2,7 @@ require 'wow/features/achievement'
 require 'wow/features/auction_data'
 require 'wow/features/battle_pet'
 require 'wow/features/challenge_mode'
-require 'wow/features/character_profile'
+require 'wow/features/character'
 require 'wow/features/guild'
 require 'wow/features/item'
 require 'wow/features/leaderboard'

data/lib/wow/features/character.rb

@@ -0,0 +1,66 @@
+module WoW
+  class Character < Base
+    CLASSES = {
+      1  => "warrior",
+      2  => "paladin",
+      3  => "hunter",
+      4  => "rogue",
+      5  => "priest",
+      6  => "death_knight",
+      7  => "shaman",
+      8  => "mage",
+      9  => "warlock",
+      10 => "monk",
+      11 => "druid",
+    }
+
+    base_uri "#{WoW.host}/api/wow/character"
+
+    def initialize(realm, character_name, fields = [], params = {})
+      if realm.to_s.empty?
+        raise ArgumentError.new("realm cannot be blank")
+      end
+      if character_name.to_s.empty?
+        raise ArgumentError.new("character name cannot be blank")
+      end
+
+      params = params.merge({fields: fields.join(',')})
+      super(self.class.data(realm, character_name, params))
+    end
+
+    class << self
+      def data(realm, character_name, params = {})
+        params.merge!({locale: WoW.locale})
+        get("/#{CGI::escape(realm)}/#{CGI::escape(character_name)}",
+          query: params).parsed_response
+      end
+    end
+
+    private
+
+    def get_class
+      CLASSES[self["class"]]
+    end
+
+    def get_active_spec
+      unless self["talents"]
+        raise FieldMissingError.new("missing field \"talents\"")
+      end
+
+      self["talents"].detect { |t| t["selected"] }
+    end
+
+    def get_inactive_spec
+      unless self["talents"]
+        raise FieldMissingError.new("missing field \"talents\"")
+      end
+
+      self["talents"].detect { |t| !t["selected"] }
+    end
+
+    def get_thumbnail
+      "http://us.battle.net/static-render/us/#{self["thumbnail"]}"
+    end
+
+  end
+end

data/lib/wow/version.rb

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

data/spec/features/README.md

@@ -0,0 +1,57 @@
+# WoW
+
+Ruby API wrapper for Blizzards [WoW API](http://blizzard.github.io/api-wow-docs/).
+
+## Ideology
+
+This library exists for 2 purposes.
+
+1. Direct one-to-one mapping of the WoW API to a ruby hash.
+2. Defined helper functions to help accessing data.
+
+### Object Instantiation
+
+Every endpoint of the WoW API has a class. For example `WoW::Character` is the class representing the endpoint of `http://us.battle.net//api/wow/character/`. The name of the class is the CamelCased equivalent of the endpoint name. `http://us.battle.net//api/wow/battlePet/` for example is `WoW::BattlePet`.
+
+The initializer function for the class takes as many *non-blank* arguments as the WoW API requires.
+
+For example, the API dictates the following URL structure for a character.
+```
+URL = Host + "/api/wow/character/" + Realm + "/" + CharacterName
+```
+
+so the Ruby syntax is
+```ruby
+WoW::Character.new(realm, character_name)
+```
+
+Additionally if there are optional fields then they can be requested by passing an array as the third argument.
+```ruby
+WoW::Character.new(realm, character_name, [:items, :talents])
+```
+
+Other params may be specified as a hash in the fourth argument.
+```ruby
+WoW::Character.new(realm, character_name, locale: "es_MX")
+WoW::Character.new(realm, character_name, [:items, :talents], locale: "es_MX")
+```
+
+### Object Attribute Access
+
+Accessing the data from the object is very simple. Each object subclasses from the ruby `Hash` so access is done on the object as a hash.
+
+```ruby
+character["achievementPoints"]          #=> 13450
+character["items"]["averageItemLevel"]  #=> 573
+```
+**Note:** Attribute access is only done through string keys.
+
+### Object Methods
+
+Sometimes the WoW API itself makes getting the data we want harder than we'd like, in these cases this wrapper attempts to help. To keep the API of this wrapper as simple as possible we only define 3 functions.
+
+```ruby
+# Character#gets          #=> Array ["class", "active_spec"]
+# Character#get(String)   #=> Value, ex get("class") might return "druid"
+# Character#get?(String)  #=> Boolean true if object can `get` on the given string.
+```

data/spec/features/character_profile_spec.rb

@@ -1,7 +1,7 @@
 require "spec_helper"
 
-describe WoW::CharacterProfile do
-  subject { WoW::CharacterProfile.new("Stormreaver", "Epicgrim") }
+describe WoW::Character do
+  subject { WoW::Character.new("Stormreaver", "Epicgrim", [:talents]) }
 
   describe "#initialize" do
     it "is valid server, and name" do
@@ -12,51 +12,90 @@ describe WoW::CharacterProfile do
 
     it "is valid with special characters in name" do
       expect {
-        WoW::CharacterProfile.new("Stormreaver", "Disciplíne")
+        WoW::Character.new("Stormreaver", "Disciplíne")
       }.not_to raise_error
     end
 
     it "is invalid server" do
       expect {
-        WoW::CharacterProfile.new("Notaserver", "Epicgrim")
+        WoW::Character.new("Notaserver", "Epicgrim")
       }.to raise_error
     end
 
     it "is invalid name" do
       expect {
-        WoW::CharacterProfile.new("Stormreaver", "Imnotaguyatalllolplz")
+        WoW::Character.new("Stormreaver", "Imnotaguyatalllolplz")
       }.to raise_error
     end
 
     it "is invalid server and name" do
       expect {
-        WoW::CharacterProfile.new("Notaserver", "Imnotaguyatalllolplz")
+        WoW::Character.new("Notaserver", "Imnotaguyatalllolplz")
       }.to raise_error
     end
 
     it "raises WoW::APIError when given nil or server" do
       expect {
-        WoW::CharacterProfile.new(nil, "Imnotaguyatalllolplz")
-      }.to raise_error(WoW::APIError)
+        WoW::Character.new(nil, "Imnotaguyatalllolplz")
+      }.to raise_error
     end
 
     it "raises WoW::APIError when given blank or server" do
       expect {
-        WoW::CharacterProfile.new("", "Imnotaguyatalllolplz")
-      }.to raise_error(WoW::APIError)
+        WoW::Character.new("", "Imnotaguyatalllolplz")
+      }.to raise_error
     end
   end
 
-  describe "#lookup" do
-    it "looks up class" do
-      subject.lookup(:class).should eq(:druid)
+  describe "#[]" do
+    it "acts as a hash with strings" do
+      subject["name"].should eq("Epicgrim")
+    end
+
+    it "doesn't act as a hash with symbols" do
+      subject[:name].should_not eq("Epicgrim")
     end
   end
 
-  describe "#[]" do
-    it "acts as a hash" do
-      subject[:name].should eq("Epicgrim")
+  describe "#gets" do
+    it "returns an array" do
+      subject.gets.should be_an(Array)
+    end
+
+    it "contains strings that are valids arguments to #get" do
+      subject.gets.each do |name|
+        expect { subject.get(name) }.not_to raise_error
+      end
     end
   end
 
-end
+  describe "#get?" do
+    it "returns true when calling #get would succeed" do
+      subject.get?("class").should be_true
+    end
+
+    it "returns false when calling #get would fail" do
+      subject.get?("foo").should be_false
+    end
+  end
+
+  describe "#get" do
+    it "gets the characters class" do
+      subject.get("class").should eq("druid")
+    end
+
+    it "gets the characters active spec" do
+      spec_name = subject.get("active_spec")["spec"]["name"]
+      ["Balance", "Guardian"].should include(spec_name)
+    end
+
+    it "gets the characters inactive spec" do
+      spec_name = subject.get("inactive_spec")["spec"]["name"]
+      ["Balance", "Guardian"].should include(spec_name)
+    end
+
+    it "gets the characters thumbnail" do
+      subject.get("thumbnail").should match(/http.*/)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wow
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Nathan Lilienthal
@@ -83,7 +83,7 @@ files:
 - lib/wow/features/auction_data.rb
 - lib/wow/features/battle_pet.rb
 - lib/wow/features/challenge_mode.rb
-- lib/wow/features/character_profile.rb
+- lib/wow/features/character.rb
 - lib/wow/features/guild.rb
 - lib/wow/features/item.rb
 - lib/wow/features/leaderboard.rb
@@ -92,6 +92,7 @@ files:
 - lib/wow/features/recipe.rb
 - lib/wow/features/spell.rb
 - lib/wow/version.rb
+- spec/features/README.md
 - spec/features/character_profile_spec.rb
 - spec/spec_helper.rb
 - wow.gemspec
@@ -120,5 +121,6 @@ signing_key:
 specification_version: 4
 summary: World of Warcraft API Access.
 test_files:
+- spec/features/README.md
 - spec/features/character_profile_spec.rb
 - spec/spec_helper.rb

data/lib/wow/features/character_profile.rb

@@ -1,48 +0,0 @@
-module WoW
-  class CharacterProfile < Base
-    CLASSES = {
-      1  => :warrior,
-      2  => :paladin,
-      3  => :hunter,
-      4  => :rogue,
-      5  => :priest,
-      6  => :death_knight,
-      7  => :shaman,
-      8  => :mage,
-      9  => :warlock,
-      10 => :monk,
-      11 => :druid,
-    }
-
-    base_uri "#{WoW.host}/api/wow/character"
-
-    def initialize(realm, character_name, fields = [], params = {})
-      if realm.to_s.empty?
-        raise WoW::APIError.new "Realm cannot be blank"
-      end
-      if character_name.to_s.empty?
-        raise WoW::APIError.new "Character name cannot be blank"
-      end
-
-      params = params.merge({fields: fields.join(',')})
-      super(self.class.data(realm, character_name, params))
-    end
-
-    def lookup(key)
-      case key
-      when :class
-        CLASSES[self[key]]
-      else
-        raise "No lookup mapping for #{key}"
-      end
-    end
-
-    class << self
-      def data(realm, character_name, params = {})
-        params.merge!({locale: WoW.locale})
-        get("/#{CGI::escape(realm)}/#{CGI::escape(character_name)}",
-          query: params).parsed_response
-      end
-    end
-  end
-end