blizzard-community-api 1.0.0

data/spec/api_spec.rb

@@ -0,0 +1,84 @@
+require "rspec_helper"
+require "../lib/blizzard-community-api"
+
+include WOW
+
+describe API do
+  describe "::get_character_profile" do
+    it "should invoke a CharacterProfileRequest and return a response Hash", :live => true do
+      response = API.get_character_profile("Aven","Draenor")
+      response.should(be_a(Hash))
+      response["name"].should(be == "Aven")
+    end
+  end
+  describe "::get_guild_profile" do
+    it "should invoke a GuildProfileRequest and return a response Hash", :live => true do
+      response = API.get_guild_profile("Little Urban Elites","Draenor")
+      response.should(be_a(Hash))
+      response["name"].should(be == "Little Urban Elites")
+    end
+  end
+  describe "::get_arena_team" do
+    it "should invoke a ArenaTeamRequest and return a response Hash", :live => true do
+      response = API.get_arena_team("Draenor","3v3","Super Squishy")
+      response.should(be_a(Hash))
+      response["name"].should(be == "Super Squishy")
+    end
+  end
+  describe "::get_character_classes" do
+    it "should invoke a CharacterClassesRequest and return a response Hash", :live => true do
+      response = API.get_character_classes()
+      response.should(be_a(Hash))
+      response["classes"].should(be_a(Array))
+    end
+  end
+  describe "::get_character_races" do
+    it "should invoke a CharacterRacesRequest and return a response Hash", :live => true do
+      response = API.get_character_races()
+      response.should(be_a(Hash))
+      response["races"].should(be_a(Array))
+    end
+  end
+  describe "::get_current_auctions" do
+    it "should invoke a CurrentAuctionsRequest and return a response Hash", :live => true do
+      response = API.get_current_auctions("Draenor")
+      response.should(be_a(Hash))
+      response["files"].should(be_a(Array))
+    end
+  end
+  describe "::get_guild_perks" do
+    it "should invoke a GuildPerksRequest and return a response Hash", :live => true do
+      response = API.get_guild_perks()
+      response.should(be_a(Hash))
+      response["perks"].should(be_a(Array))
+    end
+  end
+  describe "::get_guild_rewards" do
+    it "should invoke a GuildRewardsRequest and return a response Hash", :live => true do
+      response = API.get_guild_rewards()
+      response.should(be_a(Hash))
+      response["rewards"].should(be_a(Array))
+    end
+  end
+  describe "::get_item_classes" do
+    it "should invoke a ItemClassesRequest and return a response Hash", :live => true do
+      response = API.get_item_classes()
+      response.should(be_a(Hash))
+      response["classes"].should(be_a(Array))
+    end
+  end
+  describe "::get_item" do
+    it "should invoke a ItemRequest and return a response Hash", :live => true do
+      response = API.get_item(78473)
+      response.should(be_a(Hash))
+      response["id"].should(be == 78473)
+    end
+  end
+  describe "::get_realm_status" do
+    it "should invoke a RealmStatusRequest and return a response Hash", :live => true do
+      response = API.get_realm_status()
+      response.should(be_a(Hash))
+      response["realms"].should(be_a(Array))
+    end
+  end
+end

data/spec/arena_team_request_spec.rb

@@ -0,0 +1,46 @@
+require "rspec_helper"
+require "../lib/arena_team_request"
+
+include WOW
+
+describe ArenaTeamRequest do
+  describe "::new" do
+    it "should create a new ArenaTeamRequest if valid" do
+      request = ArenaTeamRequest.new("Draenor","3v3","Super Squishy")
+      request.should be_instance_of(ArenaTeamRequest)
+      request.realm.should(be == "Draenor")
+      request.team_size.should(be == "3v3")
+      request.team_name.should(be == "Super Squishy")
+    end
+    it "should require a non-empty string for realm, team_size and team_name" do
+      lambda{ArenaTeamRequest.new(nil,"3v3","Super Squishy")}.should raise_error(SyntaxError)
+      lambda{ArenaTeamRequest.new("","3v3","Super Squishy")}.should raise_error(SyntaxError)
+      lambda{ArenaTeamRequest.new(3,"3v3","Super Squishy")}.should raise_error(SyntaxError)
+      lambda{ArenaTeamRequest.new("Draenor",nil,"Super Squishy")}.should raise_error(SyntaxError)
+      lambda{ArenaTeamRequest.new("Draenor","","Super Squishy")}.should raise_error(SyntaxError)
+      lambda{ArenaTeamRequest.new("Draenor",3,"Super Squishy")}.should raise_error(SyntaxError)
+      lambda{ArenaTeamRequest.new("Draenor","3v3",nil)}.should raise_error(SyntaxError)
+      lambda{ArenaTeamRequest.new("Draenor","3v3","")}.should raise_error(SyntaxError)
+      lambda{ArenaTeamRequest.new("Draenor","3v3",3)}.should raise_error(SyntaxError)
+    end
+  end
+  describe "#query" do
+    it "should be empty" do
+      request = ArenaTeamRequest.new("Draenor","3v3","Super Squishy")
+      request.query.should == {}
+    end
+  end
+  describe "#uri" do
+    it "should be created dynamically" do
+      request = ArenaTeamRequest.new("Draenor","3v3","Super Squishy")
+      request.uri.should == URI.parse("http://us.battle.net/api/wow/arena/Draenor/3v3/Super%20Squishy")
+    end
+  end
+  describe "#invoke" do
+    it "should return a valid character record", :live => true do
+      request = ArenaTeamRequest.new("Draenor","3v3","Super Squishy")
+      response = request.invoke
+      response.should(be_a(Hash))
+    end
+  end
+end

data/spec/authorized_api_request_spec.rb

@@ -0,0 +1,78 @@
+require "rspec_helper"
+require "../lib/authorized_api_request"
+
+include WOW
+
+describe AuthorizedApiRequest do
+  describe "#scheme" do
+    it "should be https" do
+      api_request = ApiRequest.new()
+      authorized_request = AuthorizedApiRequest.new(api_request, "public_key", "private_key")
+      authorized_request.scheme.should == "https"
+    end
+  end
+  describe "#uri" do
+    it "should update scheme to https" do
+      api_request = ApiRequest.new()
+      authorized_request = AuthorizedApiRequest.new(api_request, "public_key", "private_key")
+      authorized_request.uri.should(be == URI.parse("#{authorized_request.scheme}://#{API_HOST_NAMES[authorized_request.locale]}#{API_ROOT_PATH}"))
+    end
+  end
+  describe "#locale" do
+    it "should inherit the value from api_request" do
+      api_request = ApiRequest.new()
+      authorized_request = AuthorizedApiRequest.new(api_request, "public_key", "private_key")
+      authorized_request.locale.should(be(api_request.locale))
+    end
+  end
+  describe "#hostname" do
+    it "should inherit the value from api_request" do
+      api_request = ApiRequest.new()
+      authorized_request = AuthorizedApiRequest.new(api_request, "public_key", "private_key")
+      authorized_request.hostname.should(be(api_request.hostname))
+    end
+  end
+  describe "#path" do
+    it "should inherit the value from api_request" do
+      api_request = ApiRequest.new()
+      authorized_request = AuthorizedApiRequest.new(api_request, "public_key", "private_key")
+      authorized_request.path.should(be(api_request.path))
+    end
+  end
+  describe "#query" do
+    it "should inherit the value from api_request" do
+      api_request = ApiRequest.new()
+      authorized_request = AuthorizedApiRequest.new(api_request, "public_key", "private_key")
+      authorized_request.query.should(be == api_request.query)
+    end
+  end
+  describe "#last_modified" do
+    it "should inherit the value from api_request" do
+      api_request = ApiRequest.new()
+      authorized_request = AuthorizedApiRequest.new(api_request, "public_key", "private_key")
+      authorized_request.last_modified.should(be(api_request.last_modified))
+    end
+  end
+  describe "#headers" do
+    it "should contain default headers" do
+      api_request = ApiRequest.new()
+      authorized_request = AuthorizedApiRequest.new(api_request, "public_key", "private_key")
+      authorized_request.headers["Authorization"].should_not(be_nil)
+      authorized_request.headers["Authorization"][0...16].should(be == "BNET public_key:")
+      authorized_request.headers["Authorization"].length.should(be(45))
+      authorized_request.headers["Date"].should_not(be_nil)
+      DateTime.parse(authorized_request.headers["Date"]).should < DateTime.now
+      authorized_request.headers["If-Modified-Since"].should_not(be_nil)
+      DateTime.parse(authorized_request.headers["If-Modified-Since"]).to_time.should == Time.at(0).utc
+    end
+  end
+  describe "#invoke" do
+    it "should return a valid response", :live => true do
+      require "../lib/character_profile_request"
+      api_request = CharacterProfileRequest.new("Aven","Draenor")
+      authorized_request = AuthorizedApiRequest.new(api_request, "--DONT-CHECK-IN-YOUR-KEYS--", "--DONT-CHECK-IN-YOUR-KEYS--")
+      response = authorized_request.invoke
+      response.should(be_a(Hash))
+    end
+  end
+end

data/spec/authorized_spec.rb

@@ -0,0 +1,89 @@
+require "rspec_helper"
+require "../lib/blizzard-community-api"
+
+include WOW
+
+describe API::Authorized do
+  before(:all) do
+    Configuration.public_key = "--DONT-CHECK-IN-KEYS--"
+    Configuration.private_key = "--DONT-CHECK-IN-KEYS--"
+  end
+
+  describe "::get_character_profile" do
+    it "should invoke a CharacterProfileRequest and return a response Hash", :live => true do
+      response = API::Authorized.get_character_profile("Aven","Draenor")
+      response.should(be_a(Hash))
+      response["name"].should(be == "Aven")
+    end
+  end
+  describe "::get_guild_profile" do
+    it "should invoke a GuildProfileRequest and return a response Hash", :live => true do
+      response = API::Authorized.get_guild_profile("Little Urban Elites","Draenor")
+      response.should(be_a(Hash))
+      response["name"].should(be == "Little Urban Elites")
+    end
+  end
+  describe "::get_arena_team" do
+    it "should invoke a ArenaTeamRequest and return a response Hash", :live => true do
+      response = API.get_arena_team("Draenor","3v3","Super Squishy")
+      response.should(be_a(Hash))
+      response["name"].should(be == "Super Squishy")
+    end
+  end
+  describe "::get_character_classes" do
+    it "should invoke a CharacterClassesRequest and return a response Hash", :live => true do
+      response = API::Authorized.get_character_classes()
+      response.should(be_a(Hash))
+      response["classes"].should(be_a(Array))
+    end
+  end
+  describe "::get_character_races" do
+    it "should invoke a CharacterRacesRequest and return a response Hash", :live => true do
+      response = API::Authorized.get_character_races()
+      response.should(be_a(Hash))
+      response["races"].should(be_a(Array))
+    end
+  end
+  describe "::get_current_auctions" do
+    it "should invoke a CurrentAuctionsRequest and return a response Hash", :live => true do
+      response = API::Authorized.get_current_auctions("Draenor")
+      response.should(be_a(Hash))
+      response["files"].should(be_a(Array))
+    end
+  end
+  describe "::get_guild_perks" do
+    it "should invoke a GuildPerksRequest and return a response Hash", :live => true do
+      response = API::Authorized.get_guild_perks()
+      response.should(be_a(Hash))
+      response["perks"].should(be_a(Array))
+    end
+  end
+  describe "::get_guild_rewards" do
+    it "should invoke a GuildRewardsRequest and return a response Hash", :live => true do
+      response = API::Authorized.get_guild_rewards()
+      response.should(be_a(Hash))
+      response["rewards"].should(be_a(Array))
+    end
+  end
+  describe "::get_item_classes" do
+    it "should invoke a ItemClassesRequest and return a response Hash", :live => true do
+      response = API::Authorized.get_item_classes()
+      response.should(be_a(Hash))
+      response["classes"].should(be_a(Array))
+    end
+  end
+  describe "::get_item" do
+    it "should invoke a ItemRequest and return a response Hash", :live => true do
+      response = API::Authorized.get_item(78473)
+      response.should(be_a(Hash))
+      response["id"].should(be == 78473)
+    end
+  end
+  describe "::get_realm_status" do
+    it "should invoke a RealmStatusRequest and return a response Hash", :live => true do
+      response = API::Authorized.get_realm_status()
+      response.should(be_a(Hash))
+      response["realms"].should(be_a(Array))
+    end
+  end
+end

data/spec/character_classes_request_spec.rb

@@ -0,0 +1,38 @@
+require "rspec_helper"
+require "../lib/character_classes_request"
+
+include WOW
+
+describe CharacterClassesRequest do
+  describe "::new" do
+    it "should create a new CharacterClassesRequest if valid" do
+      request = CharacterClassesRequest.new()
+      request.should be_instance_of(CharacterClassesRequest)
+    end
+  end
+  describe "#query" do
+    it "should be empty" do
+      request = CharacterClassesRequest.new()
+      request.query.should(be == {})
+    end
+  end
+  describe "#uri" do
+    it "should be created dynamically" do
+      request = CharacterClassesRequest.new()
+      request.uri.should == URI.parse("http://us.battle.net/api/wow/data/character/classes")
+    end
+  end
+  describe "#invoke" do
+    it "should return a valid item record", :live => true do
+      request = CharacterClassesRequest.new()
+      response = request.invoke
+      response.should(be_a(Hash))
+      response["classes"].should(be_a(Array))
+      response["classes"][0].should(be_a(Hash))
+      response["classes"][0]["id"].should(be_a(Integer))
+      response["classes"][0]["mask"].should(be_a(Integer))
+      response["classes"][0]["powerType"].should(be_a(String))
+      response["classes"][0]["name"].should(be_a(String))
+    end
+  end
+end

data/spec/character_profile_request_spec.rb

@@ -0,0 +1,92 @@
+require "rspec_helper"
+require "../lib/character_profile_request"
+
+include WOW
+
+describe CharacterProfileRequest do
+  describe "::new" do
+    it "should create a new CharacterProfileRequest if valid" do
+      request = CharacterProfileRequest.new("Aven","Draenor",:fields => [:stats, :talents])
+      request.should be_instance_of(CharacterProfileRequest)
+      request.name.should == "Aven"
+      request.realm.should == "Draenor"
+      request.fields.should == [:stats, :talents]
+    end
+    it "should require a non-empty string for name and realm" do
+      lambda{CharacterProfileRequest.new("", "realm")}.should raise_error(SyntaxError)
+      lambda{CharacterProfileRequest.new(nil, "realm")}.should raise_error(SyntaxError)
+      lambda{CharacterProfileRequest.new("name", "")}.should raise_error(SyntaxError)
+      lambda{CharacterProfileRequest.new("name", nil)}.should raise_error(SyntaxError)
+      lambda{CharacterProfileRequest.new(5, "")}.should raise_error(SyntaxError)
+    end
+    it "should require an array of fields if fields are supplied" do
+      lambda{CharacterProfileRequest.new("Aven","Draenor",:fields => :stats)}.should raise_error(SyntaxError)
+      lambda{CharacterProfileRequest.new("Aven","Draenor",:fields => { :stats => false, :talents => true })}.should raise_error(SyntaxError)
+      CharacterProfileRequest.new("Aven","Dreanor",:fields => nil).should be_instance_of(CharacterProfileRequest)
+      CharacterProfileRequest.new("Aven","Dreanor").should be_instance_of(CharacterProfileRequest)
+    end
+    it "should return additional information if fields collection contains token", :live => true do
+      request = CharacterProfileRequest.new("Aven","Draenor",:fields => [ :guild, :stats, :talents, :items, :reputation, :titles, :professions, :appearance, :companions, :mounts, :pets, :achievements, :progression, :pvp, :quests ])
+      response = request.invoke
+      response.should(be_a(Hash))
+      response["guild"].should(be_a(Hash))
+      response["stats"].should(be_a(Hash))
+      response["talents"].should(be_a(Array))
+      response["items"].should(be_a(Hash))
+      response["reputation"].should(be_a(Array))
+      response["titles"].should(be_a(Array))
+      response["professions"].should(be_a(Hash))
+      response["appearance"].should(be_a(Hash))
+      response["companions"].should(be_a(Array))
+      response["mounts"].should(be_a(Array))
+      response["pets"].should(be_a(Array))
+      response["achievements"].should(be_a(Hash))
+      response["progression"].should(be_a(Hash))
+      response["pvp"].should(be_a(Hash))
+      response["quests"].should(be_a(Array))
+    end
+  end
+  describe "#query" do
+    it "should be created dynamically" do
+      request = CharacterProfileRequest.new("Aven","Draenor",:fields => [:stats, :talents])
+      request.query.should == {"fields" => [ :stats, :talents ]}
+    end
+  end
+  describe "#uri" do
+    it "should be created dynamically" do
+      request = CharacterProfileRequest.new("Aven","Draenor",:fields => [:stats, :talents])
+      request.uri.should == URI.parse("http://us.battle.net/api/wow/character/Draenor/Aven?fields=stats,talents")
+    end
+  end
+  describe "#invoke" do
+    it "should return a valid character record", :live => true do
+      request = CharacterProfileRequest.new("Aven","Draenor")
+      response = request.invoke
+      response.should(be_a(Hash))
+      response["realm"].should(be_a(String))
+      response["name"].should(be_a(String))
+      response["level"].should(be_a(Integer))
+      response["lastModified"].should(be_a(Numeric))
+      response["thumbnail"].should(be_a(String))
+      response["race"].should(be_a(Integer))
+      response["achievementPoints"].should(be_a(Integer))
+      response["gender"].should(be_a(Integer))
+      response["class"].should(be_a(Integer))
+      response["guild"].should(be_nil)
+      response["stats"].should(be_nil)
+      response["talents"].should(be_nil)
+      response["items"].should(be_nil)
+      response["reputation"].should(be_nil)
+      response["titles"].should(be_nil)
+      response["professions"].should(be_nil)
+      response["appearance"].should(be_nil)
+      response["companions"].should(be_nil)
+      response["mounts"].should(be_nil)
+      response["pets"].should(be_nil)
+      response["achievements"].should(be_nil)
+      response["progression"].should(be_nil)
+      response["pvp"].should(be_nil)
+      response["quests"].should(be_nil)
+    end
+  end
+end

data/spec/character_races_spec.rb

@@ -0,0 +1,38 @@
+require "rspec_helper"
+require "../lib/character_races_request"
+
+include WOW
+
+describe CharacterRacesRequest do
+  describe "::new" do
+    it "should create a new CharacterRacesRequest if valid" do
+      request = CharacterRacesRequest.new()
+      request.should be_instance_of(CharacterRacesRequest)
+    end
+  end
+  describe "#query" do
+    it "should be empty" do
+      request = CharacterRacesRequest.new()
+      request.query.should(be == {})
+    end
+  end
+  describe "#uri" do
+    it "should be created dynamically" do
+      request = CharacterRacesRequest.new()
+      request.uri.should == URI.parse("http://us.battle.net/api/wow/data/character/races")
+    end
+  end
+  describe "#invoke" do
+    it "should return a valid item record", :live => true do
+      request = CharacterRacesRequest.new()
+      response = request.invoke
+      response.should(be_a(Hash))
+      response["races"].should(be_a(Array))
+      response["races"][0].should(be_a(Hash))
+      response["races"][0]["id"].should(be_a(Integer))
+      response["races"][0]["mask"].should(be_a(Integer))
+      response["races"][0]["side"].should(be_a(String))
+      response["races"][0]["name"].should(be_a(String))
+    end
+  end
+end