rbattlenet 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 46f0a0e9ac24c1ddb686d226fe8f484236c7a9d2c380d70f817b424f6d8c271b
-  data.tar.gz: 66641411e1896c5d3d33e94a9e57bf4b1c330ffde0cc21f6dcdd42d7a88730de
+SHA1:
+  metadata.gz: ab8a1b8f4eb2a44f40f0fd6be6bf0b06f28db6ae
+  data.tar.gz: 7304f47e3b1f11dc79ed43d20d602109c3ff92d8
 SHA512:
-  metadata.gz: db1341a52e0881b9eeb0e45d5817f99834351c38b0e7a54081671be6f2486f53c1c823469a2087916f08cd65aa9132f8d1c76b86d579f0baddf4013d72577e24
-  data.tar.gz: cdd928eb7410dcebd8b736ced90fc8372f9aa744d4e5c13fa27bc9cff6a52528bfbca7b9b6660b5b55a28dd6ec3466f454eb8835fed11757f8810d329b89291c
+  metadata.gz: f9b0a80fe43c37b4a6505376af790077aaa4407f6b1ae28256a25fab42bcd1cc42602ed070f9743abd885b844b315d468bc92a70e99e711d9451ceeb7a68d5f8
+  data.tar.gz: 834d779532200843160fc0a5b0d751cdb8e9ab1c7da361c575846bf3e53e717a9aebe4655f3bdcd40163644eb3aea73e7f811defa923dd473c9c009a263e73e8

data/README.md

@@ -83,12 +83,30 @@ characters = RBattlenet::Wow::Character.all
 # => RBattlenet::Errors::IndexNotSupported (Retrieving all entities of this endpoint is not supported)
 ```
 
+### Profile API
+
+The [Account Profile API](https://develop.battle.net/documentation/world-of-warcraft/profile-apis) needs an access token acquired via the [Authorization Code Flow](https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow).
+
+It concerns the following requests:
+
+* `RBattlenet::Wow::Profile::User`
+* `RBattlenet::Wow::Profile::ProtectedSummary`
+* `RBattlenet::Wow::Profile::MountsCollection`
+* `RBattlenet::Wow::Profile::PetsCollection`
+
 ## Testing
+Test against the stored VCR cassettes
+```ruby
+bundle exec rspec spec/ # Execute all the tests
+bundle exec rspec spec/lib/wow/character_spec.rb # Execute only the character_spec tests
+```
+
+If there is no VCR cassette for the test
 ```ruby
-CLIENT_ID=<your_id> CLIENT_SECRET=<your_secret> bundle exec rspec
+RECORD_CASSETTE=1 CLIENT_ID=<your_id> CLIENT_SECRET=<your_secret> bundle exec rspec
 ```
 
-If you wish to test with real API connections:
+If you wish to test against the real API and bypass the :
 ```ruby
 REAL_CONNECTIONS=1 CLIENT_ID=<your_id> CLIENT_SECRET=<your_secret> bundle exec rspec
 ```

data/lib/rbattlenet/endpoints/wow/profile.rb

@@ -0,0 +1,25 @@
+module RBattlenet
+  module Wow
+    class Profile < RBattlenet::Endpoints::Base
+      SUPPORTED_FIELDS = [:itself, :user, :protected_summary, :mounts_collection, :pets_collection]
+
+      class << self
+        def user
+          RBattlenet::Wow::Profile::User
+        end
+
+        def protected_summary
+          RBattlenet::Wow::Profile::ProtectedSummary
+        end
+
+        def mounts_collection
+          RBattlenet::Wow::Profile::MountsCollection
+        end
+
+        def pets_collection
+          RBattlenet::Wow::Profile::PetsCollection
+        end
+      end
+    end
+  end
+end

data/lib/rbattlenet/endpoints/wow/profile/mounts_collection.rb

@@ -0,0 +1,9 @@
+module RBattlenet
+  module Wow
+    class Profile::MountsCollection < RBattlenet::Endpoints::Base
+      def self.path(token)
+        RBattlenet.uri("/profile/user/wow/collections/mounts?access_token=#{token}&namespace=profile-")
+      end
+    end
+  end
+end

data/lib/rbattlenet/endpoints/wow/profile/pets_collection.rb

@@ -0,0 +1,9 @@
+module RBattlenet
+  module Wow
+    class Profile::PetsCollection < RBattlenet::Endpoints::Base
+      def self.path(token)
+        RBattlenet.uri("/profile/user/wow/collections/pets?access_token=#{token}&namespace=profile-")
+      end
+    end
+  end
+end

data/lib/rbattlenet/endpoints/wow/profile/protected_summary.rb

@@ -0,0 +1,9 @@
+module RBattlenet
+  module Wow
+    class Profile::ProtectedSummary < RBattlenet::Endpoints::Base
+      def self.path(params)
+        RBattlenet.uri("profile/user/wow/protected-character/#{params[:realm_id]}-#{params[:character_id]}?access_token=#{params[:token]}&namespace=profile-")
+      end
+    end
+  end
+end

data/lib/rbattlenet/endpoints/wow/profile/user.rb

@@ -0,0 +1,9 @@
+module RBattlenet
+  module Wow
+    class Profile::User < RBattlenet::Endpoints::Base
+      def self.path(token)
+        RBattlenet.uri("/profile/user/wow?access_token=#{token}&namespace=profile-")
+      end
+    end
+  end
+end

data/lib/rbattlenet/rbattlenet.rb

@@ -17,6 +17,11 @@ module RBattlenet
     true
   end
 
+  # Set a fake token for RSpec tests
+  def self.fake_authenticate
+    @@token = "abcdefghijklmnopqrstuvwxyz01234567"
+  end
+
   def self.set_options(region: @@region, locale: @@locale, response_type: @@response_type, concurrency: @@concurrency, timeout: @@timeout)
     @@region, @@locale, @@response_type, @@concurrency, @@timeout = region, locale, response_type, concurrency, timeout
     true
@@ -28,14 +33,13 @@ module RBattlenet
     def get(subjects)
       store = @@response_type == :raw ? [] : RBattlenet::ResultCollection.new(@@response_type)
 
-      headers = {}
-      headers['Authorization'] = "Bearer #{@@token}" if @@token
-
       # Limit concurrency to prevent hitting the API request per-second cap.
       hydra = Typhoeus::Hydra.new(max_concurrency: @@concurrency)
       subjects.each do |uris, subject|
         uris.each do |field, uri|
-          request = Typhoeus::Request.new(URI.encode(uri), headers: headers, timeout: @@timeout)
+          headers = {}
+          headers['Authorization'] = "Bearer #{@@token}" if @@token && !uri.include?('access_token')
+          request = Typhoeus::Request.new(URI::DEFAULT_PARSER.escape(uri), headers: headers, timeout: @@timeout)
 
           request.on_complete do |response|
             if @@response_type == :raw
@@ -48,7 +52,6 @@ module RBattlenet
             end
           end
 
-
           hydra.queue request
         end
       end

data/lib/rbattlenet/version.rb

@@ -1,3 +1,3 @@
 module RBattlenet
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

data/spec/lib/d3/account_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::D3::Account do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::D3::Account, type: :community do
 
   describe "#find_account" do
     it "fetches account data" do

data/spec/lib/d3/act_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::D3::Act do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::D3::Act, type: :community do
 
   describe "#find_act" do
     it "fetches act data" do

data/spec/lib/d3/artisan_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::D3::Artisan do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::D3::Artisan, type: :community do
 
   describe "#find_artisan" do
     it "fetches artisan data" do

data/spec/lib/d3/character_class_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::D3::CharacterClass do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::D3::CharacterClass, type: :community do
 
   describe "#find_character_class" do
     it "fetches character_class data" do

data/spec/lib/d3/era_leaderboard_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::D3::EraLeaderboard do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::D3::EraLeaderboard, type: :game_data do
 
   describe "#find_era_leaderboard" do
     it "fetches era leaderboard data" do

data/spec/lib/d3/era_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::D3::Era do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::D3::Era, type: :game_data do
 
   describe "#find_era" do
     it "fetches era data" do

data/spec/lib/d3/follower_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::D3::Follower do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::D3::Follower, type: :community do
 
   describe "#find_follower" do
     it "fetches follower data" do

data/spec/lib/d3/hero_follower_items_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::D3::Hero::FollowerItems do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::D3::Hero::FollowerItems, type: :community do
 
   describe "#find_hero_follower_items" do
     it "fetches hero follower items data" do

data/spec/lib/d3/hero_items_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::D3::Hero::Items do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::D3::Hero::Items, type: :community do
 
   describe "#find_hero_items" do
     it "fetches hero items data" do

data/spec/lib/d3/hero_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::D3::Hero do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::D3::Hero, type: :community do
 
   describe "#find_hero" do
     it "fetches hero data" do

data/spec/lib/d3/item_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::D3::Item do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::D3::Item, type: :community do
 
   describe "#find_item" do
     it "fetches item data" do

data/spec/lib/d3/item_type_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::D3::ItemType do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::D3::ItemType, type: :community do
 
   describe "#find_item_type" do
     it "fetches item_type data" do

data/spec/lib/d3/recipe_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::D3::Recipe do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::D3::Recipe, type: :community do
 
   describe "#find_recipe" do
     it "fetches recipe data" do

data/spec/lib/d3/season_leaderboard_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::D3::SeasonLeaderboard do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::D3::SeasonLeaderboard, type: :game_data do
 
   describe "#find_season_leaderboard" do
     it "fetches season leaderboard data" do

data/spec/lib/d3/season_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::D3::Season do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::D3::Season, type: :game_data do
 
   describe "#find_season" do
     it "fetches season data" do

data/spec/lib/d3/skill_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::D3::Skill do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::D3::Skill, type: :community do
 
   describe "#find_skill" do
     it "fetches skill data" do

data/spec/lib/hearthstone/card_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::Hearthstone::Card do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::Hearthstone::Card, type: :game_data do
 
   describe "#find_single_card" do
     it "fetches card data" do

data/spec/lib/hearthstone/deck_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
 describe RBattlenet::Hearthstone::Deck do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
 
   describe "#find_deck" do
     it "fetches deck data" do

data/spec/lib/hearthstone/metadata_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
 describe RBattlenet::Hearthstone::Metadata do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
 
   describe "#find_metadata" do
     it "fetches metadata" do

data/spec/lib/sc2/account_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::Sc2::Account do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::Sc2::Account, type: :community do
 
   describe "#find_account" do
     it "fetches account data" do

data/spec/lib/sc2/leaderboard_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::Sc2::Leaderboard do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::Sc2::Leaderboard, type: :community do
 
   describe "#find_leaderboard" do
     it "fetches leaderboard profile data" do

data/spec/lib/sc2/league_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::Sc2::League do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::Sc2::League, type: :game_data do
 
   describe "#find_league" do
     it "fetches league data" do

data/spec/lib/sc2/legacy/achievements_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::Sc2::Legacy::Achievements do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::Sc2::Legacy::Achievements, type: :community do
 
   describe "#find_achievements" do
     it "fetches achievements data" do

data/spec/lib/sc2/legacy/ladder_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::Sc2::Legacy::Ladder do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::Sc2::Legacy::Ladder, type: :community do
 
   describe "#find_ladder" do
     it "fetches ladder data" do

data/spec/lib/sc2/legacy/profile_ladders_spec.rb

@@ -1,9 +1,6 @@
 require 'spec_helper'
 
-describe RBattlenet::Sc2::Legacy::ProfileLadders do
-  before do
-    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
-  end
+describe RBattlenet::Sc2::Legacy::ProfileLadders, type: :community do
 
   describe "#find_legacy_profile_ladders" do
     it "fetches legacy profile ladders data" do