wow_community_api 0.1.0 → 0.2.0

data/lib/wow_community_api.rb

@@ -1,9 +1,11 @@
+require 'active_support/core_ext/class'
 require 'httparty'
 require 'hash-to-ostruct'
 require 'uri'
 
 require "wow_community_api/version"
 require "wow_community_api/regions"
+require "wow_community_api/locales"
 require "wow_community_api/battle_net"
 require "wow_community_api/realm"
 require "wow_community_api/character"

data/lib/wow_community_api/battle_net.rb

@@ -4,19 +4,27 @@ module WowCommunityApi
     
     # TODO: make this configurable?
     DEFAULT_REGION = Regions::US
+    DEFAULT_LOCALE = nil
   
-    def self.region
-      @@region
+    cattr_accessor(:region) { DEFAULT_REGION }
+    cattr_accessor(:locale) { DEFAULT_LOCALE }
+    
+    def self.get(path, options = nil)
+      base_uri "http://#{self.region}/api/wow"
+
+      results = super(URI.encode(path), build_query(options))
+      results.parsed_response.to_ostruct if results.response.code == "200"
     end
-    def self.region=(path)
-      @@region = "http://#{path}/api/wow"
+    
+    def self.build_query(options)
+      query = { :query => options }
+      query[:query].merge!(:locale => locale) if locale
+      query
     end
-    self.region = DEFAULT_REGION
     
-    def self.get(path, options = {})
-      base_uri self.region
-      results = super(URI.encode(path), options)
-      results.parsed_response.to_ostruct if results.response.code == "200"
+    def self.reset!
+      self.region = DEFAULT_REGION
+      self.locale = DEFAULT_LOCALE
     end
 
   end

data/lib/wow_community_api/character.rb

@@ -2,7 +2,7 @@ module WowCommunityApi
   class Character < BattleNet
     def self.find_by_realm_and_name(realm, name, *field)
       fields = { :fields => field.join(",") } unless field.empty?
-      get("/character/#{realm}/#{name}", :query => fields)
+      get("/character/#{realm}/#{name}", fields)
     end
   end
 end

data/lib/wow_community_api/guild.rb

@@ -2,7 +2,7 @@ module WowCommunityApi
   class Guild < BattleNet
     def self.find_by_realm_and_name(realm, name, *field)
       fields = { :fields => field.join(",") } unless field.empty?
-      get("/guild/#{realm}/#{name}", :query => fields)
+      get("/guild/#{realm}/#{name}", fields)
     end
   end
 end

data/lib/wow_community_api/locales.rb

@@ -0,0 +1,26 @@
+module WowCommunityApi::Locales
+  module US
+    EN_US = "en_US"
+    ES_MX = "es_MX"
+  end
+  
+  module EU
+    EN_GB = "en_GB"
+    ES_ES = "es_ES"
+    FR_FR = "fr_FR"
+    RU_RU = "ru_RU"
+    DE_DE = "de_DE"
+  end
+  
+  module KR
+    KO_KR = "ko_KR"
+  end
+  
+  module TW
+    ZH_TW = "zh_TW"
+  end
+  
+  module CN
+    ZH_CN = "zh_CN"
+  end
+end

data/lib/wow_community_api/realm.rb

@@ -2,7 +2,7 @@ module WowCommunityApi
   class Realm < BattleNet
     def self.find_by_name(*name)
       names = { :realms => name.join(",") } unless name.empty?
-      results = get("/realm/status", :query => names)
+      results = get("/realm/status", names)
       (name.size == 1) ? results.realms.first : results.realms
     end
 

data/lib/wow_community_api/regions.rb

@@ -1,9 +1,7 @@
-module WowCommunityApi
-  class Regions
-    US = "us.battle.net"
-    EU = "eu.battle.net"
-    KR = "kr.battle.net"
-    TW = "tw.battle.net"
-    CN = "www.battlenet.com.cn"
-  end
+module WowCommunityApi::Regions
+  US = "us.battle.net"
+  EU = "eu.battle.net"
+  KR = "kr.battle.net"
+  TW = "tw.battle.net"
+  CN = "www.battlenet.com.cn"
 end

data/lib/wow_community_api/version.rb

@@ -1,3 +1,3 @@
 module WowCommunityApi
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/spec/battle_net_spec.rb

@@ -6,19 +6,19 @@ describe BattleNet do
     
     it "sets the base uri to a region" do
       BattleNet.region = Regions::US
-      BattleNet.region.should == "http://us.battle.net/api/wow"
+      BattleNet.region.should == "us.battle.net"
       
       BattleNet.region = Regions::EU
-      BattleNet.region.should == "http://eu.battle.net/api/wow"
+      BattleNet.region.should == "eu.battle.net"
       
       BattleNet.region = Regions::KR
-      BattleNet.region.should == "http://kr.battle.net/api/wow"
+      BattleNet.region.should == "kr.battle.net"
       
       BattleNet.region = Regions::TW
-      BattleNet.region.should == "http://tw.battle.net/api/wow"
+      BattleNet.region.should == "tw.battle.net"
       
       BattleNet.region = Regions::CN
-      BattleNet.region.should == "http://www.battlenet.com.cn/api/wow"
+      BattleNet.region.should == "www.battlenet.com.cn"
     end
     
     it "defaults to US region" do
@@ -28,9 +28,11 @@ describe BattleNet do
     it "can switch regions" do
       BattleNet.region = Regions::EU
       BattleNet.region.should == Realm.region
+      Realm.region.should == "eu.battle.net"
       
       BattleNet.region = Regions::KR
       BattleNet.region.should == Realm.region
+      Realm.region.should == "kr.battle.net"
     end
     
     it "returns nil for 404 not found error" do

data/spec/character_spec.rb

@@ -33,5 +33,14 @@ describe Character do
       character.titles.size.should == 3
       character.titles[0].name.should == "Centurion %s"
     end
+    
+    it 'gets a character with foreign locale' do
+      BattleNet.locale = Locales::US::ES_MX
+      
+      stub_json 'http://us.battle.net/api/wow/character/uther/malkyth?fields=titles&locale=es_MX', 'character-mexican.json'
+
+      character = Character.find_by_realm_and_name('uther', 'malkyth', :titles)
+      character.titles[0].name.should == "Conquistador %s"
+    end
   end
 end

data/spec/fixtures/character-mexican.json

@@ -0,0 +1,17 @@
+{
+  "lastModified":1311430176000,
+  "name":"Malkyth",
+  "realm":"Uther",
+  "class":9,
+  "race":5,
+  "gender":0,
+  "level":85,
+  "achievementPoints":11050,
+  "thumbnail":"uther/243/6004211-avatar.jpg",
+  "titles":[
+    {
+      "id":47,
+      "name":"Conquistador %s"
+    }
+  ]
+}

data/spec/locale_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe BattleNet do
+  describe "#locale" do
+    
+    it "sets the locale" do
+      BattleNet.locale = Locales::US::EN_US
+
+      BattleNet.locale.should == Locales::US::EN_US
+      BattleNet.locale.should == "en_US"
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -3,6 +3,10 @@ require 'webmock/rspec'
 
 include WowCommunityApi
 
+RSpec.configure do |config|
+  config.after(:each) { BattleNet.reset! }
+end
+
 def stub_json(uri, filename)
   body = open("spec/fixtures/#{filename}")
   stub_request(:get, uri).to_return(:body => body, :headers => { 'Content-Type' => 'application/json' })

data/wow_community_api.gemspec

@@ -18,6 +18,8 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_dependency "activesupport"
+  s.add_dependency "i18n"
   s.add_dependency "httparty"
   s.add_dependency "hash-to-ostruct"
 

metadata

@@ -2,7 +2,7 @@
 name: wow_community_api
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - eddie cianci
@@ -13,7 +13,7 @@ cert_chain: []
 date: 2011-07-23 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: httparty
+  name: activesupport
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
@@ -24,7 +24,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: hash-to-ostruct
+  name: i18n
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -35,7 +35,7 @@ dependencies:
   type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rake
+  name: httparty
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -43,10 +43,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: hash-to-ostruct
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -54,10 +54,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version 
         version: "0"
-  type: :development
+  type: :runtime
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: webmock
+  name: rake
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -67,6 +67,28 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id007
 description: a Ruby library for Blizzard's World of Warcraft Community Platform API
 email: 
 - defeated2k4@gmail.com
@@ -89,6 +111,7 @@ files:
 - lib/wow_community_api/battle_net.rb
 - lib/wow_community_api/character.rb
 - lib/wow_community_api/guild.rb
+- lib/wow_community_api/locales.rb
 - lib/wow_community_api/realm.rb
 - lib/wow_community_api/regions.rb
 - lib/wow_community_api/version.rb
@@ -97,6 +120,7 @@ files:
 - spec/fixtures/character-all-fields.json
 - spec/fixtures/character-doe.json
 - spec/fixtures/character-guild.json
+- spec/fixtures/character-mexican.json
 - spec/fixtures/character.json
 - spec/fixtures/error.json
 - spec/fixtures/guild-all-fields.json
@@ -107,6 +131,7 @@ files:
 - spec/fixtures/realms-aos.json
 - spec/fixtures/realms.json
 - spec/guild_spec.rb
+- spec/locale_spec.rb
 - spec/realm_spec.rb
 - spec/regions_spec.rb
 - spec/spec_helper.rb
@@ -144,6 +169,7 @@ test_files:
 - spec/fixtures/character-all-fields.json
 - spec/fixtures/character-doe.json
 - spec/fixtures/character-guild.json
+- spec/fixtures/character-mexican.json
 - spec/fixtures/character.json
 - spec/fixtures/error.json
 - spec/fixtures/guild-all-fields.json
@@ -154,6 +180,7 @@ test_files:
 - spec/fixtures/realms-aos.json
 - spec/fixtures/realms.json
 - spec/guild_spec.rb
+- spec/locale_spec.rb
 - spec/realm_spec.rb
 - spec/regions_spec.rb
 - spec/spec_helper.rb