blizzard-community-api 1.0.0

data/lib/blizzard-community-api.rb

@@ -0,0 +1,101 @@
+# Holds the static defaults
+require "configuration"
+
+# The following includes are request objects.
+# You can feel free to uncomment any of them that you want to use independently
+# of the API cass
+
+# This is only required if you need authorized request support
+#require "authorized_api_request"
+# You only need this if you're making character requests
+#require "character_profile_request"
+#require "character_classes_request"
+#require "character_races_request"
+# You only need this if you're making guild requests
+#require "guild_profile_request"
+#require "guild_perks_request"
+#require "guild_rewards_request"
+# You only need this if you're making item requests
+#require "item_request"
+#require "item_classes_request"
+# You only need this if you're making PvP related requests
+#require "arena_team_request"
+# You only need this if you're making auction house requests
+#require "current_auctions_request"
+# You only need this if you're making realm status requests
+#require "realm_status_request"
+
+module WOW
+  class API
+    def self.get_character_profile(name, realm, options={})
+      require "character_profile_request"
+      invoke_request(CharacterProfileRequest.new(name, realm, options))
+    end
+
+    def self.get_guild_profile(name, realm, options={})
+      require "guild_profile_request"
+      invoke_request(GuildProfileRequest.new(name, realm, options))
+    end
+
+    def self.get_realm_status(options={})
+      require "realm_status_request"
+      invoke_request(RealmStatusRequest.new(options))
+    end
+
+    def self.get_current_auctions(realm, options={})
+      require "current_auctions_request"
+      invoke_request(CurrentAuctionsRequest.new(realm, options))
+    end
+
+    def self.get_item(item_id, options={})
+      require "item_request"
+      invoke_request(ItemRequest.new(item_id, options))
+    end
+
+    def self.get_arena_team(realm, team_size, team_name, options={})
+      require "arena_team_request"
+      invoke_request(ArenaTeamRequest.new(realm, team_size, team_name, options))
+    end
+
+    def self.get_character_classes(options={})
+      require "character_classes_request"
+      invoke_request(CharacterClassesRequest.new(options))
+    end
+
+    def self.get_character_races(options={})
+      require "character_races_request"
+      invoke_request(CharacterRacesRequest.new(options))
+    end
+
+    def self.get_guild_perks(options={})
+      require "guild_perks_request"
+      invoke_request(GuildPerksRequest.new(options))
+    end
+
+    def self.get_guild_rewards(options={})
+      require "guild_rewards_request"
+      invoke_request(GuildRewardsRequest.new(options))
+    end
+
+    def self.get_item_classes(options={})
+      require "item_classes_request"
+      invoke_request(ItemClassesRequest.new(options))
+    end
+
+    private
+
+    def self.invoke_request(request)
+      request.invoke
+    end
+
+    class Authorized < API
+
+      private
+
+      def self.invoke_request(request)
+        require "authorized_api_request"
+        AuthorizedApiRequest.new(request,Configuration.public_key,Configuration.private_key).invoke
+      end
+    end
+  end
+end

data/lib/character_classes_request.rb

@@ -0,0 +1,11 @@
+require "api_request"
+
+module WOW
+  class CharacterClassesRequest < ApiRequest
+
+    def path
+      "#{super}/data/character/classes"
+    end
+
+  end
+end

data/lib/character_profile_request.rb

@@ -0,0 +1,33 @@
+require "api_request"
+
+module WOW
+  class CharacterProfileRequest < ApiRequest
+
+    def initialize(name, realm, options={})
+      super(options)
+      if(!name.is_a?(String) || name.empty? || !realm.is_a?(String) || realm.empty?)
+        raise(SyntaxError, "Name and realm must be non-empty string values")
+      end
+      unless(options[:fields].nil? || options[:fields].is_a?(Array))
+        raise(SyntaxError, "Fields collection must be an Array")
+      end
+      @name = name
+      @realm = realm
+      @fields = options[:fields]
+    end
+
+    attr_reader :name, :realm, :fields
+
+    def path
+      "#{super}/character/#{uri_encode(realm)}/#{uri_encode(name)}"
+    end
+
+    def query
+      if(fields.is_a?(Array) && !fields.empty?)
+        return super.merge({ "fields" => fields })
+      end
+      super
+    end
+
+  end
+end

data/lib/character_races_request.rb

@@ -0,0 +1,11 @@
+require "api_request"
+
+module WOW
+  class CharacterRacesRequest < ApiRequest
+
+    def path
+      "#{super}/data/character/races"
+    end
+
+  end
+end

data/lib/configuration.rb

@@ -0,0 +1,67 @@
+module WOW
+  class Configuration
+    @@private_key = nil
+    @@public_key = nil
+    @@default_locale = :en_US
+    @@default_proxy_host = nil
+    @@default_proxy_port = nil
+    @@default_proxy_username = nil
+    @@default_proxy_password = nil
+
+    def self.private_key=(value)
+      @@private_key = value
+    end
+
+    def self.private_key
+      @@private_key
+    end
+
+    def self.public_key
+      @@public_key
+    end
+
+    def self.public_key=(value)
+      @@public_key = value
+    end
+
+    def self.default_locale=(value)
+      @@default_locale = value
+    end
+
+    def self.default_locale
+      @@default_locale
+    end
+
+    def self.default_proxy_port=(value)
+      @@default_proxy_port = value
+    end
+
+    def self.default_proxy_host=(value)
+      @@default_proxy_host = value
+    end
+
+    def self.default_proxy_port
+      @@default_proxy_port
+    end
+
+    def self.default_proxy_host
+      @@default_proxy_host
+    end
+
+    def self.default_proxy_username
+      @@default_proxy_username
+    end
+
+    def self.default_proxy_username=(value)
+      @@default_proxy_username = value
+    end
+
+    def self.default_proxy_password
+      @@default_proxy_password
+    end
+
+    def self.default_proxy_password=(value)
+      @@default_proxy_password = value
+    end
+  end
+end

data/lib/current_auctions_request.rb

@@ -0,0 +1,21 @@
+require 'api_request'
+
+module WOW
+  class CurrentAuctionsRequest < ApiRequest
+
+    def initialize(realm, options={})
+      super(options)
+      if(!realm.is_a?(String) || realm.empty?)
+        raise(SyntaxError, "Realm must be non-empty string values")
+      end
+      @realm = realm
+    end
+
+    attr_reader :realm
+
+    def path
+      "#{super}/auction/data/#{uri_encode(realm).downcase}"
+    end
+
+  end
+end

data/lib/guild_perks_request.rb

@@ -0,0 +1,11 @@
+require 'api_request'
+
+module WOW
+  class GuildPerksRequest < ApiRequest
+
+    def path
+      "#{super}/data/guild/perks"
+    end
+
+  end
+end

data/lib/guild_profile_request.rb

@@ -0,0 +1,33 @@
+require "api_request.rb"
+
+module WOW
+  class GuildProfileRequest < ApiRequest
+
+    def initialize(name, realm, options={})
+      super(options)
+      if(!name.is_a?(String) || name.empty? || !realm.is_a?(String) || realm.empty?)
+        raise(SyntaxError, "Name and realm must be non-empty string values")
+      end
+      unless(options[:fields].nil? || options[:fields].is_a?(Array))
+        raise(SyntaxError, "Fields collection must be an Array")
+      end
+      @name = name
+      @realm = realm
+      @fields = options[:fields]
+    end
+
+    attr_reader :name, :realm, :fields
+
+    def path
+      "#{super}/guild/#{uri_encode(realm)}/#{uri_encode(name)}"
+    end
+
+    def query
+      if(fields.is_a?(Array) && !fields.empty?)
+        return super.merge({ "fields" => fields })
+      end
+      super
+    end
+
+  end
+end

data/lib/guild_rewards_request.rb

@@ -0,0 +1,11 @@
+require 'api_request'
+
+module WOW
+  class GuildRewardsRequest < ApiRequest
+
+    def path
+      "#{super}/data/guild/rewards"
+    end
+
+  end
+end

data/lib/item_classes_request.rb

@@ -0,0 +1,11 @@
+require 'api_request'
+
+module WOW
+  class ItemClassesRequest < ApiRequest
+
+    def path
+      "#{super}/data/item/classes"
+    end
+
+  end
+end

data/lib/item_request.rb

@@ -0,0 +1,21 @@
+require 'api_request'
+
+module WOW
+  class ItemRequest < ApiRequest
+
+    def initialize(item_id, options={})
+      super(options)
+      if(!item_id.is_a?(Integer))
+        raise(SyntaxError, "ItemId must be an integer value")
+      end
+      @item_id = item_id
+    end
+
+    attr_reader :item_id
+
+    def path
+      "#{super}/item/#{item_id}"
+    end
+
+  end
+end

data/lib/realm_status_request.rb

@@ -0,0 +1,28 @@
+require "api_request"
+
+module WOW
+  class RealmStatusRequest < ApiRequest
+
+    def initialize(options={})
+      super(options)
+      unless(options[:realms].nil? || options[:realms].is_a?(Array))
+        raise(SyntaxError, "Fields collection must be an Array")
+      end
+      @realms = options[:realms] ||= []
+    end
+
+    attr_reader :realms
+
+    def path
+      "#{super}/realm/status"
+    end
+
+    def query
+      if(realms.is_a?(Array) && !realms.empty?)
+        return super.merge({ "realms" => realms })
+      end
+      super
+    end
+
+  end
+end

data/spec/api_request_spec.rb

@@ -0,0 +1,99 @@
+require "rspec_helper"
+require "../lib/api_request"
+
+include WOW
+
+describe ApiRequest do
+  describe "::new" do
+    it "should create an instance of ApiRequest" do
+      request = ApiRequest.new()
+      request.should be_a(ApiRequest)
+    end
+  end
+  describe "#query" do
+    it "should be initialized to an empty hash" do
+      request = ApiRequest.new()
+      request.query.should == {}
+    end
+  end
+  describe "#locale" do
+    it "should be initialized to configuration defaults" do
+      request = ApiRequest.new()
+      request.locale.should == Configuration.default_locale
+    end
+    it "should be modifiable via constructor options" do
+      request = ApiRequest.new(:locale => API_LOCALES[1])
+      request.locale.should == API_LOCALES[1]
+    end
+  end
+  describe "#last_modified" do
+    it "should be initialized to min time" do
+      request = ApiRequest.new()
+      request.last_modified.should == Time.at(0)
+    end
+    it "should be modifiable via constructor options" do
+      now = Time.now
+      request = ApiRequest.new(:last_modified => now)
+      request.last_modified.should == now
+    end
+  end
+  describe "#scheme" do
+    it "should be http" do
+      request = ApiRequest.new()
+      request.scheme.should == "http"
+    end
+  end
+  describe "#hostname" do
+    it "should be initialized to the default locale" do
+      request = ApiRequest.new()
+      request.hostname.should == API_HOST_NAMES[Configuration.default_locale]
+    end
+    it "should change with locale change" do
+      request = ApiRequest.new(:locale => API_LOCALES[1])
+      request.hostname.should == API_HOST_NAMES[API_LOCALES[1]]
+    end
+  end
+  describe "#uri" do
+    it "should be initialized to the scheme hostname and api root" do
+      request = ApiRequest.new()
+      request.uri.should == URI.parse("#{request.scheme}://#{API_HOST_NAMES[request.locale]}#{API_ROOT_PATH}")
+    end
+    it "should be changed by locale" do
+      request = ApiRequest.new(:locale => API_LOCALES[1])
+      request.uri.should == URI.parse("#{request.scheme}://#{API_HOST_NAMES[API_LOCALES[1]]}#{API_ROOT_PATH}")
+    end
+  end
+  describe "#headers" do
+    it "should contain default headers" do
+      request = ApiRequest.new()
+      request.headers["Date"].should_not be_nil
+      DateTime.parse(request.headers["Date"]).should < DateTime.now
+      request.headers["If-Modified-Since"].should_not be_nil
+      DateTime.parse(request.headers["If-Modified-Since"]).to_time.should == Time.at(0).utc
+    end
+    it "should change with the last_modified option" do
+      last_modified = Time.now.utc
+      request = ApiRequest.new(:last_modified => last_modified)
+      DateTime.parse(request.headers["If-Modified-Since"]).to_time.utc.to_i.should == last_modified.to_i
+    end
+  end
+  describe "#invoke", :live => true do
+    require "../lib/character_profile_request"
+    it "should return a json response" do
+      request = CharacterProfileRequest.new("Aven","Draenor")
+      request.invoke.should be_a(Hash)
+    end
+    it "should return cached value on subsequent calls" do
+      request = CharacterProfileRequest.new("Aven","Draenor")
+      obj_id_1 = request.invoke.object_id
+      obj_id_2 = request.invoke.object_id
+      obj_id_1.should == obj_id_2
+    end
+    it "should force refresh with option[:force_refresh => true]" do
+      request = CharacterProfileRequest.new("Aven","Draenor")
+      obj_id_1 = request.invoke.object_id
+      obj_id_2 = request.invoke(:force_refresh => true).object_id
+      obj_id_1.should_not == obj_id_2
+    end
+  end
+end