blizzard-community-api 1.0.0

data/spec/current_auctions_request_spec.rb

@@ -0,0 +1,41 @@
+require "rspec_helper"
+require "../lib/current_auctions_request"
+
+include WOW
+
+describe CurrentAuctionsRequest do
+  describe "::new" do
+    it "should create a new CurrentAuctionsRequest if valid" do
+      request = CurrentAuctionsRequest.new("Draenor")
+      request.should be_instance_of(CurrentAuctionsRequest)
+      request.realm.should == "Draenor"
+    end
+    it "should require a non-empty string for realm" do
+      lambda{CurrentAuctionsRequest.new("")}.should raise_error(SyntaxError)
+      lambda{CurrentAuctionsRequest.new(nil)}.should raise_error(SyntaxError)
+      lambda{CurrentAuctionsRequest.new(5)}.should raise_error(SyntaxError)
+    end
+  end
+  describe "#query" do
+    it "should be empty" do
+      request = CurrentAuctionsRequest.new("Draenor")
+      request.query.should(be == {})
+    end
+  end
+  describe "#uri" do
+    it "should be created dynamically" do
+      request = CurrentAuctionsRequest.new("Draenor")
+      request.uri.should == URI.parse("http://us.battle.net/api/wow/auction/data/draenor")
+    end
+  end
+  describe "#invoke" do
+    it "should return a valid guild record", :live => true do
+      request = CurrentAuctionsRequest.new("Draenor")
+      response = request.invoke
+      response.should(be_a(Hash))
+      response["files"].should(be_a(Array))
+      response["files"][0]["url"].should(be_a(String))
+      response["files"][0]["lastModified"].should(be_a(Numeric))
+    end
+  end
+end

data/spec/guild_perks_request_spec.rb

@@ -0,0 +1,33 @@
+require "rspec_helper"
+require "../lib/guild_perks_request"
+
+include WOW
+
+describe GuildPerksRequest do
+  describe "::new" do
+    it "should create a new GuildPerksRequest if valid" do
+      request = GuildPerksRequest.new()
+      request.should be_instance_of(GuildPerksRequest)
+    end
+  end
+  describe "#query" do
+    it "should be empty" do
+      request = GuildPerksRequest.new()
+      request.query.should(be == {})
+    end
+  end
+  describe "#uri" do
+    it "should be created dynamically" do
+      request = GuildPerksRequest.new()
+      request.uri.should == URI.parse("http://us.battle.net/api/wow/data/guild/perks")
+    end
+  end
+  describe "#invoke" do
+    it "should return a valid item record", :live => true do
+      request = GuildPerksRequest.new()
+      response = request.invoke
+      response.should(be_a(Hash))
+      response["perks"].should(be_a(Array))
+    end
+  end
+end

data/spec/guild_profile_request_spec.rb

@@ -0,0 +1,59 @@
+require "rspec_helper"
+require "../lib/guild_profile_request"
+
+include WOW
+
+describe GuildProfileRequest do
+  describe "::new" do
+    it "should create a new GuildProfileRequest if valid" do
+      request = GuildProfileRequest.new("Little Urban Elites","Draenor",:fields => [:members, :achievements])
+      request.should be_instance_of(GuildProfileRequest)
+      request.name.should == "Little Urban Elites"
+      request.realm.should == "Draenor"
+      request.fields.should == [:members, :achievements]
+    end
+    it "should require a non-empty string for name and realm" do
+      lambda{GuildProfileRequest.new("", "realm")}.should raise_error(SyntaxError)
+      lambda{GuildProfileRequest.new(nil, "realm")}.should raise_error(SyntaxError)
+      lambda{GuildProfileRequest.new("name", "")}.should raise_error(SyntaxError)
+      lambda{GuildProfileRequest.new("name", nil)}.should raise_error(SyntaxError)
+      lambda{GuildProfileRequest.new(5, "")}.should raise_error(SyntaxError)
+    end
+    it "should require an array of fields if fields are supplied" do
+      lambda{GuildProfileRequest.new("Little Urban Elites","Draenor",:fields => :members)}.should raise_error(SyntaxError)
+      lambda{GuildProfileRequest.new("Little Urban Elites","Draenor",:fields => { :members => false, :achievements => true })}.should raise_error(SyntaxError)
+      GuildProfileRequest.new("Little Urban Elites","Dreanor",:fields => nil).should be_instance_of(GuildProfileRequest)
+      GuildProfileRequest.new("Little Urban Elites","Dreanor").should be_instance_of(GuildProfileRequest)
+    end
+    it "should return additional information if fields collection contains token", :live => true do
+      request = GuildProfileRequest.new("Little Urban Elites","Draenor",:fields => [ :members, :achievements ])
+      response = request.invoke
+      response.should(be_a(Hash))
+      response["members"].should(be_a(Array))
+      response["achievements"].should(be_a(Hash))
+    end
+  end
+  describe "#query" do
+    it "should be created dynamically" do
+      request = GuildProfileRequest.new("Little Urban Elites","Draenor",:fields => [:members, :achievements])
+      request.query.should == {"fields" => [ :members, :achievements ]}
+    end
+  end
+  describe "#uri" do
+    it "should be created dynamically" do
+      request = GuildProfileRequest.new("Little Urban Elites","Draenor",:fields => [:members, :achievements])
+      request.uri.should == URI.parse("http://us.battle.net/api/wow/guild/Draenor/Little%20Urban%20Elites?fields=members,achievements")
+    end
+  end
+  describe "#invoke" do
+    it "should return a valid guild record", :live => true do
+      request = GuildProfileRequest.new("Little Urban Elites","Draenor")
+      response = request.invoke
+      response.should(be_a(Hash))
+      response["name"].should(be_a(String))
+      response["level"].should(be_a(Integer))
+      response["side"].should(be_a(Numeric))
+      response["achievementPoints"].should(be_a(Integer))
+    end
+  end
+end

data/spec/guild_rewards_request_spec.rb

@@ -0,0 +1,54 @@
+require "rspec_helper"
+require "../lib/guild_rewards_request"
+
+include WOW
+
+describe GuildRewardsRequest do
+  describe "::new" do
+    it "should create a new GuildRewardsRequest if valid" do
+      request = GuildRewardsRequest.new()
+      request.should be_instance_of(GuildRewardsRequest)
+    end
+  end
+  describe "#query" do
+    it "should be empty" do
+      request = GuildRewardsRequest.new()
+      request.query.should(be == {})
+    end
+  end
+  describe "#uri" do
+    it "should be created dynamically" do
+      request = GuildRewardsRequest.new()
+      request.uri.should == URI.parse("http://us.battle.net/api/wow/data/guild/rewards")
+    end
+  end
+  describe "#invoke" do
+    it "should return a valid item record", :live => true do
+      request = GuildRewardsRequest.new()
+      response = request.invoke
+      response.should(be_a(Hash))
+      response["rewards"].should(be_a(Array))
+      response["rewards"][0].should(be_a(Hash))
+      response["rewards"][0]["minGuildLevel"].should(be_a(Integer))
+      response["rewards"][0]["minGuildRepLevel"].should(be_a(Integer))
+      response["rewards"][0]["achievement"].should(be_a(Hash))
+      response["rewards"][0]["achievement"]["id"].should(be_a(Integer))
+      response["rewards"][0]["achievement"]["title"].should(be_a(String))
+      response["rewards"][0]["achievement"]["points"].should(be_a(Integer))
+      response["rewards"][0]["achievement"]["description"].should(be_a(String))
+      response["rewards"][0]["achievement"]["reward"].should(be_a(String))
+      response["rewards"][0]["achievement"]["rewardItem"].should(be_a(Hash))
+      response["rewards"][0]["achievement"]["rewardItem"]["id"].should(be_a(Integer))
+      response["rewards"][0]["achievement"]["rewardItem"]["name"].should(be_a(String))
+      response["rewards"][0]["achievement"]["rewardItem"]["icon"].should(be_a(String))
+      response["rewards"][0]["achievement"]["rewardItem"]["quality"].should(be_a(Integer))
+      response["rewards"][0]["achievement"]["rewardItem"]["tooltipParams"].should(be_a(Hash))
+      response["rewards"][0]["item"].should(be_a(Hash))
+      response["rewards"][0]["item"]["id"].should(be_a(Integer))
+      response["rewards"][0]["item"]["name"].should(be_a(String))
+      response["rewards"][0]["item"]["icon"].should(be_a(String))
+      response["rewards"][0]["item"]["quality"].should(be_a(Integer))
+      response["rewards"][0]["item"]["tooltipParams"].should(be_a(Hash))
+    end
+  end
+end

data/spec/item_classes_request_spec.rb

@@ -0,0 +1,36 @@
+require "rspec_helper"
+require "../lib/item_classes_request"
+
+include WOW
+
+describe ItemClassesRequest do
+  describe "::new" do
+    it "should create a new ItemClassesRequest if valid" do
+      request = ItemClassesRequest.new()
+      request.should be_instance_of(ItemClassesRequest)
+    end
+  end
+  describe "#query" do
+    it "should be empty" do
+      request = ItemClassesRequest.new()
+      request.query.should(be == {})
+    end
+  end
+  describe "#uri" do
+    it "should be created dynamically" do
+      request = ItemClassesRequest.new()
+      request.uri.should == URI.parse("http://us.battle.net/api/wow/data/item/classes")
+    end
+  end
+  describe "#invoke" do
+    it "should return a valid item record", :live => true do
+      request = ItemClassesRequest.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]["class"].should(be_a(Integer))
+      response["classes"][0]["name"].should(be_a(String))
+    end
+  end
+end

data/spec/item_request_spec.rb

@@ -0,0 +1,74 @@
+require "rspec_helper"
+require "../lib/item_request"
+
+include WOW
+
+describe ItemRequest do
+  describe "::new" do
+    it "should create a new ItemRequest if valid" do
+      request = ItemRequest.new(78473)
+      request.should be_instance_of(ItemRequest)
+      request.item_id.should == 78473
+    end
+    it "should require an integer for item_id" do
+      lambda{ItemRequest.new("")}.should raise_error(SyntaxError)
+      lambda{ItemRequest.new(nil)}.should raise_error(SyntaxError)
+      lambda{ItemRequest.new(true)}.should raise_error(SyntaxError)
+    end
+  end
+  describe "#query" do
+    it "should be empty" do
+      request = ItemRequest.new(78473)
+      request.query.should(be == {})
+    end
+  end
+  describe "#uri" do
+    it "should be created dynamically" do
+      request = ItemRequest.new(78473)
+      request.uri.should == URI.parse("http://us.battle.net/api/wow/item/78473")
+    end
+  end
+  describe "#invoke" do
+    it "should return a valid item record", :live => true do
+      request = ItemRequest.new(78473)
+      response = request.invoke
+      response.should(be_a(Hash))
+      response["id"].should(be_a(Integer))
+      response["disenchantingSkillRank"].should(be_a(Integer))
+      response["description"].should(be_a(String))
+      response["name"].should(be_a(String))
+      response["stackable"].should(be_a(Integer))
+      response["itemBind"].should(be_a(Integer))
+      response["bonusStats"].should(be_a(Array))
+      response["itemSpells"].should(be_a(Array))
+      response["buyPrice"].should(be_a(Integer))
+      response["itemClass"].should(be_a(Integer))
+      response["itemSubClass"].should(be_a(Integer))
+      response["containerSlots"].should(be_a(Integer))
+      response["weaponInfo"].should(be_a(Hash))
+      response["weaponInfo"]["damage"].should(be_a(Hash))
+      response["weaponInfo"]["damage"]["min"].should(be_a(Integer))
+      response["weaponInfo"]["damage"]["max"].should(be_a(Integer))
+      response["weaponInfo"]["weaponSpeed"].should(be_a(Float))
+      response["weaponInfo"]["dps"].should(be_a(Float))
+      response["inventoryType"].should(be_a(Integer))
+      response["equippable"].should(be_boolean)
+      response["itemLevel"].should(be_a(Integer))
+      response["maxCount"].should(be_a(Integer))
+      response["maxDurability"].should(be_a(Integer))
+      response["minFactionId"].should(be_a(Integer))
+      response["minReputation"].should(be_a(Integer))
+      response["quality"].should(be_a(Integer))
+      response["sellPrice"].should(be_a(Integer))
+      response["requiredLevel"].should(be_a(Integer))
+      response["requiredSkill"].should(be_a(Integer))
+      response["requiredSkillRank"].should(be_a(Integer))
+      response["itemSource"].should(be_a(Hash))
+      response["itemSource"]["sourceId"].should(be_a(Integer))
+      response["itemSource"]["sourceType"].should(be_a(String))
+      response["baseArmor"].should(be_a(Integer))
+      response["hasSockets"].should(be_boolean)
+      response["isAuctionable"].should(be_boolean)
+    end
+  end
+end

data/spec/realm_status_request_spec.rb

@@ -0,0 +1,57 @@
+require "rspec_helper"
+require "../lib/realm_status_request"
+
+include WOW
+
+describe RealmStatusRequest do
+
+  describe "::new" do
+    it "should create a new RealmStatusRequest if valid" do
+      request = RealmStatusRequest.new()
+      request.should be_instance_of(RealmStatusRequest)
+      request.realms.should(be == [])
+    end
+    it "should require an array of realms if realms are provided" do
+      lambda{RealmStatusRequest.new(:realms => "Little Urban Elites")}.should raise_error(SyntaxError)
+      RealmStatusRequest.new(:realms => nil).should be_instance_of(RealmStatusRequest)
+    end
+    it "should limit realms when realm collection is provided", :broken => true do
+      request = RealmStatusRequest.new(:realms => [ "Little Urban Elites" ])
+      response = request.invoke
+      response.should(be_a(Hash))
+      response["realms"].should(be_a(Array))
+      response["realms"].length.should(be == 1)
+    end
+  end
+
+  describe "#query" do
+    it "should be created dynamically" do
+      request = RealmStatusRequest.new(:realms => [ "Little Urban Elites", "Hoss" ])
+      request.query.should == {"realms" => [ "Little Urban Elites", "Hoss" ]}
+    end
+  end
+
+  describe "#uri" do
+    it "should be created dynamically" do
+      request = RealmStatusRequest.new(:realms => [ "Hoss" ])
+      request.uri.should == URI.parse("http://us.battle.net/api/wow/realm/status?realms=Hoss")
+    end
+  end
+
+  describe "#invoke" do
+    it "should return all realms by default", :live => true do
+      request = RealmStatusRequest.new()
+      response = request.invoke
+      response.should(be_a(Hash))
+      response["realms"].should(be_a(Array))
+      response["realms"].length.should(be > 1)
+      response["realms"][0]["type"].should(be_a(String))
+      response["realms"][0]["queue"].should(be_boolean)
+      response["realms"][0]["status"].should(be_boolean)
+      response["realms"][0]["population"].should(be_a(String))
+      response["realms"][0]["name"].should(be_a(String))
+      response["realms"][0]["slug"].should(be_a(String))
+    end
+  end
+
+end

data/spec/rspec_helper.rb

@@ -0,0 +1,8 @@
+require "rspec"
+require "rspec_matchers"
+
+RSpec.configure do |c|
+  c.filter_run_excluding(:live => true)
+  c.filter_run_excluding(:broken => true)
+  c.include(RspecMatchers)
+end

data/spec/rspec_matchers.rb

@@ -0,0 +1,18 @@
+module RspecMatchers
+  class BeBoolean
+    def matches?(target)
+      @target = target
+      (@target.is_a?(TrueClass) || @target.is_a?(FalseClass))
+    end
+    def failure_message
+      "expected #{@target.inspect} to be boolean class"
+    end
+    def negative_failure_message
+      "expected #{@target.inspect} not to be a boolean class"
+    end
+  end
+
+  def be_boolean
+    BeBoolean.new
+  end
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: blizzard-community-api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Eric Scholz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-10 00:00:00.000000000Z
+dependencies: []
+description: A ruby implementation of standard and authorized (OpenAuth) calls to
+  the Blizzard Community API
+email: eric.scholz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- lib/api_enums.rb
+- lib/api_request.rb
+- lib/api_requestor.rb
+- lib/arena_team_request.rb
+- lib/authorized_api_request.rb
+- lib/blizzard-community-api.rb
+- lib/character_classes_request.rb
+- lib/character_profile_request.rb
+- lib/character_races_request.rb
+- lib/configuration.rb
+- lib/current_auctions_request.rb
+- lib/guild_perks_request.rb
+- lib/guild_profile_request.rb
+- lib/guild_rewards_request.rb
+- lib/item_classes_request.rb
+- lib/item_request.rb
+- lib/realm_status_request.rb
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- Rakefile
+- README.rdoc
+- VERSION
+- spec/api_request_spec.rb
+- spec/api_spec.rb
+- spec/arena_team_request_spec.rb
+- spec/authorized_api_request_spec.rb
+- spec/authorized_spec.rb
+- spec/character_classes_request_spec.rb
+- spec/character_profile_request_spec.rb
+- spec/character_races_spec.rb
+- spec/current_auctions_request_spec.rb
+- spec/guild_perks_request_spec.rb
+- spec/guild_profile_request_spec.rb
+- spec/guild_rewards_request_spec.rb
+- spec/item_classes_request_spec.rb
+- spec/item_request_spec.rb
+- spec/realm_status_request_spec.rb
+- spec/rspec_helper.rb
+- spec/rspec_matchers.rb
+homepage: http://github.com/escholz/blizzard-community-api-rubygem
+licenses: []
+post_install_message: 
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- Blizzard Community API RubyGem
+- --main
+- README.rdoc
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.2'
+requirements: []
+rubyforge_project: blizzard-community-api
+rubygems_version: 1.8.12
+signing_key: 
+specification_version: 3
+summary: Blizzard Community API RubyGem
+test_files: []