rbattlenet 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2625bfff660d3951abff427ef9692123cf29185cbe43b6619c6f5892257be3f
-  data.tar.gz: e40d9743740c68fcb4a583ed28e3cd355693d097f6f0c2a99c8f8a078589f97e
+  metadata.gz: 46f0a0e9ac24c1ddb686d226fe8f484236c7a9d2c380d70f817b424f6d8c271b
+  data.tar.gz: 66641411e1896c5d3d33e94a9e57bf4b1c330ffde0cc21f6dcdd42d7a88730de
 SHA512:
-  metadata.gz: 66a85707b1e2379f6310ef3db727a3428c046807e2280442da0cfd1e300c37cc1ca1997c0cc91efd4b048e0a8f86a029549b16fc43cdc6337239e3e141ed10c7
-  data.tar.gz: 9f469785d675e271bd36705a83b7354cda046835f613812d795ef7b3492a218133f4b65b205c8b2d23f23564ee4b208d74a6d7fe5ba0e990ee46231ed6c131f1
+  metadata.gz: db1341a52e0881b9eeb0e45d5817f99834351c38b0e7a54081671be6f2486f53c1c823469a2087916f08cd65aa9132f8d1c76b86d579f0baddf4013d72577e24
+  data.tar.gz: cdd928eb7410dcebd8b736ced90fc8372f9aa744d4e5c13fa27bc9cff6a52528bfbca7b9b6660b5b55a28dd6ec3466f454eb8835fed11757f8810d329b89291c

data/README.md

@@ -2,6 +2,8 @@
 
 A Ruby gem that wraps Blizzard's Game Data and Profile APIs.
 
+### Please note, this project is not actively maintained, but PRs are always welcome!
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -32,11 +34,13 @@ RBattlenet.set_options(region: "us", locale: "en_US")
 ```
 
 Singular requests will be returned as a `RBattlenet::Result` object. Requests with an array passed in will
-be returned as a `RBattlenet::ResultCollection` object. If you want to simply receive the raw HTTP response you can
-set that like so:
+be returned as a `RBattlenet::ResultCollection` object by default. If you want to simply receive the raw HTTP response
+or the response as a Hash you can set that like so:
 
 ```ruby
-RBattlenet.set_options(raw_response: true)
+RBattlenet.set_options(response_type: :struct) # Default
+RBattlenet.set_options(response_type: :hash)
+RBattlenet.set_options(response_type: :raw)
 ```
 
 #### Step 3. Call the API methods to request data

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

@@ -3,7 +3,7 @@ module RBattlenet
     class Character < RBattlenet::Endpoints::Base
       SUPPORTED_FIELDS = [:itself, :achievements, :appearance, :equipment, :hunter_pets, :keystones, :media,
                           :mounts, :pets, :pvp_summary, :reputations, :specializations, :statistics, :status,
-                          :titles]
+                          :titles, :legacy]
 
       class << self
         def path(character)
@@ -14,10 +14,30 @@ module RBattlenet
           RBattlenet::Wow::Character::Achievements
         end
 
+        def achievement_statistics
+          RBattlenet::Wow::Character::AchievementStatistics
+        end
+
+        def active_quests
+          RBattlenet::Wow::Character::ActiveQuests
+        end
+
         def appearance
           RBattlenet::Wow::Character::Appearance
         end
 
+        def completed_dungeons
+          RBattlenet::Wow::Character::CompletedDungeons
+        end
+
+        def completed_quests
+          RBattlenet::Wow::Character::CompletedQuests
+        end
+
+        def completed_raids
+          RBattlenet::Wow::Character::CompletedRaids
+        end
+
         def equipment
           RBattlenet::Wow::Character::Equipment
         end
@@ -42,6 +62,22 @@ module RBattlenet
           RBattlenet::Wow::Character::Pets
         end
 
+        def professions
+          RBattlenet::Wow::Character::Professions
+        end
+
+        def pvp_bracket_2v2
+          RBattlenet::Wow::Character::PvpBracket2v2
+        end
+
+        def pvp_bracket_3v3
+          RBattlenet::Wow::Character::PvpBracket3v3
+        end
+
+        def pvp_bracket_rbg
+          RBattlenet::Wow::Character::PvpBracketRbg
+        end
+
         def pvp_summary
           RBattlenet::Wow::Character::PvpSummary
         end
@@ -65,6 +101,10 @@ module RBattlenet
         def titles
           RBattlenet::Wow::Character::Titles
         end
+
+        def legacy
+          RBattlenet::Wow::Character::Legacy
+        end
       end
     end
   end

data/lib/rbattlenet/endpoints/wow/character/{pvp_bracket_statistics.rb → achievement_statistics.rb}

@@ -1,8 +1,8 @@
 module RBattlenet
   module Wow
-    class Character::PvpBracketStatistics < RBattlenet::Endpoints::Base
+    class Character::AchievementStatistics < RBattlenet::Endpoints::Base
       def self.path(character)
-        RBattlenet.uri("profile/wow/character/#{character[:realm]}/#{character[:name]}/pvp-bracket/#{character[:bracket]}?namespace=profile-")
+        RBattlenet.uri("profile/wow/character/#{character[:realm]}/#{character[:name]}/achievements/statistics?namespace=profile-")
       end
     end
   end

data/lib/rbattlenet/endpoints/wow/character/active_quests.rb

@@ -0,0 +1,9 @@
+module RBattlenet
+  module Wow
+    class Character::ActiveQuests < RBattlenet::Endpoints::Base
+      def self.path(character)
+        RBattlenet.uri("profile/wow/character/#{character[:realm]}/#{character[:name]}/quests?namespace=profile-")
+      end
+    end
+  end
+end

data/lib/rbattlenet/endpoints/wow/character/completed_dungeons.rb

@@ -0,0 +1,9 @@
+module RBattlenet
+  module Wow
+    class Character::CompletedDungeons < RBattlenet::Endpoints::Base
+      def self.path(character)
+        RBattlenet.uri("profile/wow/character/#{character[:realm]}/#{character[:name]}/encounters/dungeons?namespace=profile-")
+      end
+    end
+  end
+end

data/lib/rbattlenet/endpoints/wow/character/completed_quests.rb

@@ -0,0 +1,9 @@
+module RBattlenet
+  module Wow
+    class Character::CompletedQuests < RBattlenet::Endpoints::Base
+      def self.path(character)
+        RBattlenet.uri("profile/wow/character/#{character[:realm]}/#{character[:name]}/quests/completed?namespace=profile-")
+      end
+    end
+  end
+end

data/lib/rbattlenet/endpoints/wow/character/completed_raids.rb

@@ -0,0 +1,9 @@
+module RBattlenet
+  module Wow
+    class Character::CompletedRaids < RBattlenet::Endpoints::Base
+      def self.path(character)
+        RBattlenet.uri("profile/wow/character/#{character[:realm]}/#{character[:name]}/encounters/raids?namespace=profile-")
+      end
+    end
+  end
+end

data/lib/rbattlenet/endpoints/wow/character/legacy.rb

@@ -0,0 +1,27 @@
+module RBattlenet
+  module Wow
+    class Character::Legacy < RBattlenet::Endpoints::Base
+      FIELDS = [
+        "items",
+        "reputation",
+        "audit",
+        "statistics",
+        "achievements",
+        "pets",
+        "pvp",
+        "professions",
+        "quests",
+        "mounts",
+        "titles",
+      ]
+
+      def self.path(character)
+        RBattlenet.uri("wow/character/#{character[:realm]}/#{character[:name]}?#{self.endpoints}")
+      end
+
+      def self.endpoints
+        "fields=#{FIELDS.join("&fields=")}"
+      end
+    end
+  end
+end

data/lib/rbattlenet/endpoints/wow/character/professions.rb

@@ -0,0 +1,9 @@
+module RBattlenet
+  module Wow
+    class Character::Professions < RBattlenet::Endpoints::Base
+      def self.path(character)
+        RBattlenet.uri("profile/wow/character/#{character[:realm]}/#{character[:name]}/professions?namespace=profile-")
+      end
+    end
+  end
+end

data/lib/rbattlenet/endpoints/wow/character/pvp_bracket_2v2.rb

@@ -0,0 +1,9 @@
+module RBattlenet
+  module Wow
+    class Character::PvpBracket2v2 < RBattlenet::Endpoints::Base
+      def self.path(character)
+        RBattlenet.uri("profile/wow/character/#{character[:realm]}/#{character[:name]}/pvp-bracket/2v2?namespace=profile-")
+      end
+    end
+  end
+end

data/lib/rbattlenet/endpoints/wow/character/pvp_bracket_3v3.rb

@@ -0,0 +1,9 @@
+module RBattlenet
+  module Wow
+    class Character::PvpBracket3v3 < RBattlenet::Endpoints::Base
+      def self.path(character)
+        RBattlenet.uri("profile/wow/character/#{character[:realm]}/#{character[:name]}/pvp-bracket/3v3?namespace=profile-")
+      end
+    end
+  end
+end

data/lib/rbattlenet/endpoints/wow/character/pvp_bracket_rbg.rb

@@ -0,0 +1,9 @@
+module RBattlenet
+  module Wow
+    class Character::PvpBracketRbg < RBattlenet::Endpoints::Base
+      def self.path(character)
+        RBattlenet.uri("profile/wow/character/#{character[:realm]}/#{character[:name]}/pvp-bracket/rbg?namespace=profile-")
+      end
+    end
+  end
+end

data/lib/rbattlenet/rbattlenet.rb

@@ -1,11 +1,14 @@
 module RBattlenet
   @@region = "eu"
   @@locale = "en_gb"
-  @@raw = false
+  @@response_type = :struct
+  @@concurrency = 20
+  @@timeout = 120
 
   #Set Access Token for requests. Required
   def self.authenticate(client_id:, client_secret:)
-    response = Typhoeus.post("https://#{@@region}.battle.net/oauth/token",
+    oauth_region = ["kr", "tw"].include?(@@region.downcase) ? "apac" : @@region
+    response = Typhoeus.post("https://#{oauth_region}.battle.net/oauth/token",
       body: { grant_type: :client_credentials },
       userpwd: "#{client_id}:#{client_secret}",
     )
@@ -14,8 +17,8 @@ module RBattlenet
     true
   end
 
-  def self.set_options(region: @@region, locale: @@locale, raw_response: @@raw)
-    @@region, @@locale, @@raw = region, locale, raw_response
+  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
   end
 
@@ -23,19 +26,19 @@ module RBattlenet
 
   class << self
     def get(subjects)
-      store = @@raw ? [] : RBattlenet::ResultCollection.new
+      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: 50)
+      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)
+          request = Typhoeus::Request.new(URI.encode(uri), headers: headers, timeout: @@timeout)
 
           request.on_complete do |response|
-            if @@raw
+            if @@response_type == :raw
               store << response
             else
               store.add(subject, field, response)
@@ -52,8 +55,6 @@ module RBattlenet
 
       hydra.run
       store.size == 1 ? store.first : store
-    rescue => err
-      raise RBattlenet::Errors::ConnectionError.new
     end
 
     def uri(path)

data/lib/rbattlenet/result_collection.rb

@@ -6,42 +6,35 @@ module RBattlenet
 
     attr_reader :results
 
-    def initialize
+    def initialize(response_type)
+      @response_object = response_type == :hash ? HashResult : Result
+      @empty_response_object = response_type == :hash ? EmptyHashResult : EmptyResult
       @results = []
     end
 
     def add(subject, field, response)
       data = if response.code == 200
-        result = JSON.parse(response.body, object_class: Result)
-        result.is_a?(Array) ? Result.new(data: result.size == 1 ? result.first : result) : result
-      else
-        EmptyResult.new(status_code: response.code, response: response)
-      end
+        result = JSON.parse(response.body, object_class: @response_object) rescue nil
+        result && (result.is_a?(Array) ? @response_object.new(data: result.size == 1 ? result.first : result) : result)
+      end || @empty_response_object.new(status_code: response.code)
 
-      data.status_code ||= 200
-      data.source, data.field = subject, field
+      data[:status_code] ||= 200
+      data[:source], data[:field] = subject, field
       @results << data
     end
 
     def complete(subject, results_needed)
-      subject_results = @results.group_by(&:source)[subject]
+      subject_results = @results.group_by{ |result| result[:source] }[subject]
       if subject_results.size == results_needed
-        @results.reject!{ |result| result.source == subject }
-
-        unless base_result = subject_results.select{ |result| result.class == EmptyResult }.first
-          base_result = subject_results.select{ |result| result.field == :itself }.first
-          (subject_results - [base_result]).each{ |result| base_result << result }
-        end
+        @results.reject!{ |result| result[:source] == subject }
+        base_result = subject_results.select{ |result| result[:field] == :itself }.first
+        (subject_results - [base_result]).each{ |result| base_result << result }
 
         @results << base_result
         base_result
       end
     end
 
-    def has_errors?
-      @results.map(&:class).include? EmptyResult
-    end
-
     def_delegators :results, :first, :last, :size
   end
 
@@ -51,5 +44,12 @@ module RBattlenet
     end
   end
 
+  class HashResult < Hash
+    def <<(result)
+      self[result[:field]] = result[result[:field]] || result
+    end
+  end
+
   class EmptyResult < Result; end
+  class EmptyHashResult < HashResult; end
 end

data/lib/rbattlenet/version.rb

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

data/rbattlenet.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency 'vcr', '~> 2.9.3'
   spec.add_development_dependency "webmock"
+  spec.add_development_dependency "byebug"
 
   spec.add_runtime_dependency "typhoeus", "~> 1.1"
   spec.add_runtime_dependency "require_all" # convenience

data/spec/lib/wow/character/achievement_statistics_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe RBattlenet::Wow::Character::AchievementStatistics do
+  before do
+    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
+  end
+
+  describe "#find_character_achievement_statistics" do
+    it "fetches character data" do
+      with_connection("wow_character_achievement_statistics") do
+        result = RBattlenet::Wow::Character::AchievementStatistics.find(realm: "stormrage", name: "sheday")
+        expect(result.statistics.class).to eq Array
+      end
+    end
+  end
+
+  describe "#find_multiple_character_achievement_statisticss" do
+    it "fetches character data" do
+      with_connection("wow_character_achievement_statistics_multiple") do
+        collection = RBattlenet::Wow::Character::AchievementStatistics.find([
+          { realm: "stormrage", name: "sheday" },
+          { realm: "howling-fjord", name: "альвеоняша" },
+        ])
+        expect(collection.results.map(&:statistics).map(&:class)).to eq [Array, Array]
+      end
+    end
+  end
+end

data/spec/lib/wow/character/active_quests_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe RBattlenet::Wow::Character::ActiveQuests do
+  before do
+    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
+  end
+
+  describe "#find_character_active_quests" do
+    it "fetches character data" do
+      with_connection("wow_character_active_quests") do
+        result = RBattlenet::Wow::Character::ActiveQuests.find(realm: "stormrage", name: "sheday")
+        expect(result.in_progress.class).to eq Array
+      end
+    end
+  end
+
+  describe "#find_multiple_character_active_questss" do
+    it "fetches character data" do
+      with_connection("wow_character_active_quests_multiple") do
+        collection = RBattlenet::Wow::Character::ActiveQuests.find([
+          { realm: "stormrage", name: "sheday" },
+          { realm: "howling-fjord", name: "альвеоняша" },
+        ])
+        expect(collection.results.map(&:in_progress).map(&:class)).to eq [Array, Array]
+      end
+    end
+  end
+end

data/spec/lib/wow/character/completed_dungeons_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe RBattlenet::Wow::Character::CompletedDungeons do
+  before do
+    RBattlenet.authenticate(client_id: ENV["CLIENT_ID"], client_secret: ENV["CLIENT_SECRET"])
+  end
+
+  describe "#find_character_completed_dungeons" do
+    it "fetches character data" do
+      with_connection("wow_character_completed_dungeons") do
+        result = RBattlenet::Wow::Character::CompletedDungeons.find(realm: "stormrage", name: "sheday")
+        expect(result.expansions.class).to eq Array
+      end
+    end
+  end
+
+  describe "#find_multiple_character_completed_dungeonss" do
+    it "fetches character data" do
+      with_connection("wow_character_completed_dungeons_multiple") do
+        collection = RBattlenet::Wow::Character::CompletedDungeons.find([
+          { realm: "stormrage", name: "sheday" },
+          { realm: "howling-fjord", name: "альвеоняша" },
+        ])
+        expect(collection.results.map(&:expansions).map(&:class)).to eq [Array, Array]
+      end
+    end
+  end
+end