battlenet-api 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a1171469170368aa608c174bbfa4811ae1691f64
-  data.tar.gz: 294f0a5f031bb452b0f775c4287e5c12946fef67
+  metadata.gz: 9abf4010781883ec5d265c7c5afc9800b6d9687c
+  data.tar.gz: 774f81c62b4c50d3604553ab75ea8587d5a1d348
 SHA512:
-  metadata.gz: cd7db73c41e97aebd1c7acc6dc5148a6bcc10de5ed2076122a86a2bdbbd9cabefc61393041cb99d743dcc3a2b45dcba3401271501cef6a6ea37524f2e75659e5
-  data.tar.gz: 497adf45736781823b0c623d10ef9ec7dfb2176a902cd8b345e4beecfe588d9d5149d807254555d3775c7231f2d6bd94022dda07e973d8f7c08a021c6c17b9a5
+  metadata.gz: f23d179f18eee8a09c681c9adb6a0293d52ef111ef0922306522013f3a9f0f225238376cb5523020c6286e29f8af924b3f026469d2bc215241859727f8e79cf0
+  data.tar.gz: 8bd5eaca8a678377abfbc4034b0c8f364c0fc1bb2a5bf4ec41130533b41998e8c9d00805d1a521e8990135b5118dcd8985ad63930494d3fe5df219a11e34e76a

data/.gitignore

@@ -7,8 +7,12 @@
 /pkg/
 /spec/reports/
 /tmp/
+/fixtures/
 *.bundle
 *.so
 *.o
 *.a
 mkmf.log
+*.gem
+.env*
+.ruby-version

data/README.md

@@ -23,11 +23,11 @@ client = Battlenet.WOWClient
 
 achievement = client.achievement({:achievement => 'achievement_id'})
 auction_data = client.auction({:realm => 'realm'})
-character = client.character_profile({:realm => 'realm', :character_name => 'character_name'})
+character = client.character({:realm => 'realm', :character_name => 'character_name'})
 
 # TODO: character methods
 
-guild = client.guild_profile({:realm => 'realm', :guild_name => 'guild_name'})
+guild = client.guild({:realm => 'realm', :guild_name => 'guild_name'})
 
 # TODO: guild methods
 

data/battlenet-api.gemspec

@@ -25,4 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "dotenv"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
 end

data/examples/sandbox.rb

@@ -1,7 +1,7 @@
 require 'battlenet/api'
 
 Battlenet.configure do |config|
-  config.api_key = '5g856v32mx5bwx3rwxzkt9z9yrehtuq2'
+  config.api_key = 'api-key'
   config.region  = :us
 end
 

data/lib/battlenet/api/api_response.rb

@@ -10,7 +10,8 @@ module Battlenet
 
     def get_data(path, options)
       unless @client.nil?
-        @data = @client.get(path, options)
+        response = @client.get(path, options)
+        @data = response.parsed_response
       end
     end
 

data/lib/battlenet/api/client.rb

@@ -16,9 +16,7 @@ module Battlenet
         Configuration::OPTIONS_KEYS.each do |key|
           send("#{key}=", options[key])
         end
-
         self.class.base_uri "https://#{domain}#{endpoint}"
-
       end
 
       def domain
@@ -40,7 +38,7 @@ module Battlenet
 
       def endpoint
           raise "Invalid Game Endpoint" if @endpoint == nil
-          Addressable::URI.encode(@endpoint)
+          @endpoint
       end
 
       def get(path, params = {})
@@ -59,7 +57,7 @@ module Battlenet
           options[:query].merge!({ :apikey => @api_key })
         end
 
-        response = self.class.send(verb, path, options)
+        response = self.class.send(verb, Addressable::URI.encode(path), options)
       end
 
     end

data/lib/battlenet/api/version.rb

@@ -1,5 +1,5 @@
 module Battlenet
   module Api
-    VERSION = "0.3.1"
+    VERSION = "0.3.2"
   end
 end

data/lib/battlenet/api/wow_client.rb

@@ -1,7 +1,7 @@
 require 'battlenet/api/client'
 
-require 'battlenet/modules/wow/character_profile'
-require 'battlenet/modules/wow/guild_profile'
+require 'battlenet/modules/wow/character'
+require 'battlenet/modules/wow/guild'
 require 'battlenet/modules/wow/item'
 require 'battlenet/modules/wow/item_set'
 require 'battlenet/modules/wow/achievement'
@@ -24,12 +24,12 @@ module Battlenet
       super(client_settings)
     end
 
-    def character_profile(options = {})
-      merge_options_and_return_obj(options, Battlenet::WOW::CharacterProfile)
+    def character(options = {})
+      merge_options_and_return_obj(options, Battlenet::WOW::Character)
     end
 
-    def guild_profile(options = {})
-      merge_options_and_return_obj(options, Battlenet::WOW::GuildProfile)
+    def guild(options = {})
+      merge_options_and_return_obj(options, Battlenet::WOW::Guild)
     end
 
     def item(options = {})

data/lib/battlenet/modules/wow/{character_profile.rb → character.rb}

@@ -1,6 +1,6 @@
 module Battlenet
   module WOW
-    class CharacterProfile < Battlenet::APIResponse
+    class Character < Battlenet::APIResponse
 
       def initialize(options={})
         @realm          = options.delete(:realm)

data/lib/battlenet/modules/wow/{guild_profile.rb → guild.rb}

@@ -1,6 +1,6 @@
 module Battlenet
   module WOW
-    class GuildProfile < Battlenet::APIResponse
+    class Guild < Battlenet::APIResponse
 
       def initialize(options={})
         @realm          = options.delete(:realm)

data/spec/battlenetapi_spec.rb

@@ -1,17 +1,12 @@
-require 'battlenet/api'
+require 'spec_helper'
 
 describe Battlenet::Client do
   context "when special characters are in realm names" do
     before do
       Battlenet.configure do |config|
-        config.api_key = 'test-api'
+        config.api_key = ENV['BATTLENET_API_KEY']
         config.region  = :eu
       end
     end
-
-    it "should escape spaces in realm names" do
-      c = Battlenet::Client.new({domain: 'http://www.test.com', endpoint: "/emerald dream/mal'ganis"})
-      expect(c.endpoint).to eq('/emerald%20dream/mal\'ganis')
-    end
   end
 end

data/spec/d3client_spec.rb

@@ -1,16 +1,16 @@
-require 'battlenet/api'
+require 'spec_helper'
 
 describe Battlenet::D3Client do
   before(:all) do
     Battlenet.configure do |config|
-      config.api_key = 'test-d3client-api'
+      config.api_key = ENV['BATTLENET_API_KEY']
       config.region  = :us
     end
   end
 
   it "should pass the api key to the d3 client" do
     c = Battlenet.D3Client
-    expect(c.api_key).to eq('test-d3client-api')
+    expect(c.api_key).to eq(ENV['BATTLENET_API_KEY'])
   end
 
   it { should respond_to(:data_item) }

data/spec/sc2client_spec.rb

@@ -1,16 +1,16 @@
-require 'battlenet/api'
+require 'spec_helper'
 
 describe Battlenet::SC2Client do
   before(:all) do
     Battlenet.configure do |config|
-      config.api_key = 'test-sc2client-api'
+      config.api_key = ENV['BATTLENET_API_KEY']
       config.region  = :us
     end
   end
 
   it "should pass the api key to the SC2 client" do
     c = Battlenet.SC2Client
-    expect(c.api_key).to eq('test-sc2client-api')
+    expect(c.api_key).to eq(ENV['BATTLENET_API_KEY'])
   end
 
   it { should respond_to(:achievements) }

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'battlenet/api'
+require 'dotenv'
+require 'webmock/rspec'
+require 'vcr'
+
+Dotenv.load
+
+VCR.configure do |config|
+  config.cassette_library_dir = "fixtures/cassettes"
+  config.hook_into :webmock
+end

data/spec/wow/character_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe Battlenet::WOW::Character do
+
+  context "when looking up a character" do
+    before do
+      Battlenet.configure do |config|
+        config.api_key = ENV['BATTLENET_API_KEY']
+        config.region  = :us
+      end
+      @wow_client = Battlenet.WOWClient
+    end
+
+    it "should be able to find 'Silverwinter' on 'Sargeras'" do
+      character = @wow_client.character({:realm => 'sargeras', :character_name => 'Silverwinter'})
+      VCR.use_cassette('character/profile') do
+        expect(character.profile['name']).to eq('Silverwinter')
+      end
+    end
+
+    it "should be able to find 'whispä' on 'frostmourne' (handle foreign characters)" do
+      character = @wow_client.character({:realm => 'frostmourne', :character_name => 'whispä'})
+      VCR.use_cassette('character/profile_whispä') do
+        expect(character.profile['name']).to eq('Whispä')
+      end
+    end
+
+    it "should be able to find 'pftpft' on 'emerald dream' (handle spaces)" do
+      character = @wow_client.character({:realm => 'emerald dream', :character_name => 'pftpft'})
+      VCR.use_cassette('character/profile_pft') do
+        expect(character.profile['name']).to eq('Pftpft')
+      end
+    end
+
+    it "should not be able to find 'ThisCharacterShouldntExist' on 'Sargeras'" do
+      character = @wow_client.character({realm: 'sargeras', character_name: 'ThisCharacterShouldntExist'})
+      VCR.use_cassette('character/invalid_character') do
+        expect(character.profile['reason']).to eq('Character not found.')
+      end
+    end
+
+  end
+
+  it { should respond_to(:profile) }
+  it { should respond_to(:achievements) }
+  it { should respond_to(:feed) }
+  it { should respond_to(:appearance) }
+  it { should respond_to(:guild) }
+  it { should respond_to(:hunter_pets) }
+  it { should respond_to(:pets) }
+  it { should respond_to(:items) }
+  it { should respond_to(:mounts) }
+  it { should respond_to(:pet_slots) }
+  it { should respond_to(:progression) }
+  it { should respond_to(:pvp) }
+  it { should respond_to(:quests) }
+  it { should respond_to(:reputation) }
+  it { should respond_to(:stats) }
+  it { should respond_to(:talents) }
+  it { should respond_to(:titles) }
+  it { should respond_to(:audit) }
+
+end

data/spec/wow/guild_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Battlenet::WOW::Guild do
+
+  context "when looking up a guild" do
+    before do
+      Battlenet.configure do |config|
+        config.api_key = ENV['BATTLENET_API_KEY']
+        config.region  = :us
+      end
+      @wow_client = Battlenet.WOWClient
+    end
+
+  end
+
+  it { should respond_to(:profile) }
+  it { should respond_to(:achievements) }
+  it { should respond_to(:members) }
+  it { should respond_to(:news) }
+  it { should respond_to(:challenge) }
+
+end

data/spec/wowclient_spec.rb

@@ -1,20 +1,20 @@
-require 'battlenet/api'
+require 'spec_helper'
 
 describe Battlenet::WOWClient do
   before(:all) do
     Battlenet.configure do |config|
-      config.api_key = 'test-wow-client'
+      config.api_key = ENV['BATTLENET_API_KEY']
       config.region  = :us
     end
   end
 
   it "should pass the api key to the wow client" do
     c = Battlenet.WOWClient
-    expect(c.api_key).to eq('test-wow-client')
+    expect(c.api_key).to eq(ENV['BATTLENET_API_KEY'])
   end
 
-  it { should respond_to(:character_profile) }
-  it { should respond_to(:guild_profile) }
+  it { should respond_to(:character) }
+  it { should respond_to(:guild) }
   it { should respond_to(:item) }
   it { should respond_to(:item_set) }
   it { should respond_to(:achievement) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: battlenet-api
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - goodcodeguy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-04 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -94,6 +94,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: API Wrapper for the Battlenet API
 email:
 - goodcodeguy@gmail.com
@@ -124,9 +166,9 @@ files:
 - lib/battlenet/modules/sc2/profile.rb
 - lib/battlenet/modules/wow/achievement.rb
 - lib/battlenet/modules/wow/auction.rb
-- lib/battlenet/modules/wow/character_profile.rb
+- lib/battlenet/modules/wow/character.rb
 - lib/battlenet/modules/wow/data.rb
-- lib/battlenet/modules/wow/guild_profile.rb
+- lib/battlenet/modules/wow/guild.rb
 - lib/battlenet/modules/wow/item.rb
 - lib/battlenet/modules/wow/item_set.rb
 - lib/battlenet/modules/wow/pvp_leaderboard.rb
@@ -137,8 +179,9 @@ files:
 - spec/battlenetapi_spec.rb
 - spec/d3client_spec.rb
 - spec/sc2client_spec.rb
-- spec/wow/characterprofile_spec.rb
-- spec/wow/guildprofile_spec.rb
+- spec/spec_helper.rb
+- spec/wow/character_spec.rb
+- spec/wow/guild_spec.rb
 - spec/wowclient_spec.rb
 homepage: https://github.com/goodcodeguy/battlenet-api
 licenses:
@@ -160,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Battlenet Client API
@@ -168,6 +211,7 @@ test_files:
 - spec/battlenetapi_spec.rb
 - spec/d3client_spec.rb
 - spec/sc2client_spec.rb
-- spec/wow/characterprofile_spec.rb
-- spec/wow/guildprofile_spec.rb
+- spec/spec_helper.rb
+- spec/wow/character_spec.rb
+- spec/wow/guild_spec.rb
 - spec/wowclient_spec.rb

data/spec/wow/characterprofile_spec.rb

@@ -1,24 +0,0 @@
-require 'battlenet/api'
-
-describe Battlenet::WOW::CharacterProfile do
-
-  it { should respond_to(:profile) }
-  it { should respond_to(:achievements) }
-  it { should respond_to(:feed) }
-  it { should respond_to(:appearance) }
-  it { should respond_to(:guild) }
-  it { should respond_to(:hunter_pets) }
-  it { should respond_to(:pets) }
-  it { should respond_to(:items) }
-  it { should respond_to(:mounts) }
-  it { should respond_to(:pet_slots) }
-  it { should respond_to(:progression) }
-  it { should respond_to(:pvp) }
-  it { should respond_to(:quests) }
-  it { should respond_to(:reputation) }
-  it { should respond_to(:stats) }
-  it { should respond_to(:talents) }
-  it { should respond_to(:titles) }
-  it { should respond_to(:audit) }
-
-end

data/spec/wow/guildprofile_spec.rb

@@ -1,11 +0,0 @@
-require 'battlenet/api'
-
-describe Battlenet::WOW::GuildProfile do
-
-  it { should respond_to(:profile) }
-  it { should respond_to(:achievements) }
-  it { should respond_to(:members) }
-  it { should respond_to(:news) }
-  it { should respond_to(:challenge) }
-
-end