blizzard_api 0.6.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: daa79d3a8860c6cfd5b600090627933b7b2710ade24d4c76099198741accff97
-  data.tar.gz: f98d1226d19bfb605aa65c5380f7d3891b0b3fa733b7f85f3e21ba0d92ba9ee9
+  metadata.gz: 4c8fd5029d2b85e30104b35b0a1f4d7f6b2ea7d758b6388f2822408f94d3181c
+  data.tar.gz: 2f74b10c6312c1c85479f99dc498f1eceb65f8afacad3f40a9a94e23d8da2bce
 SHA512:
-  metadata.gz: 97da96397847d2d55c09a1bf7fa8aa81fe828780b58dd4830635c06fcb4070799df4e271ffa92c2dd64e40caa5fe0ab78609a0cb3940abee8d91a73a09e3f156
-  data.tar.gz: 95cd4500e97f933fdd29ac2005524a3b1cb8b5283b82a61dd737a9f04bfaf6206dbc32869c95ff9ca95c72efebb8e3fb6d702126fad41a6f058cd81d88b4f173
+  metadata.gz: 25a95b728c6d08054858b1c3203bc8b5e5d3f7737ee8e5074e3f5253f1378c94b0e5970b740f9f29b152c67ec289857bb213842aeaaea519f91d7c9a89549328
+  data.tar.gz: c99f65f0f4e15e9076d64dc825d30a55ae5ef7484d14b690065d85a8167329d704d6350594b0576251958b8e938362de589b8afa167ee2e2144c2805e09d017c

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 Please view this file on the master branch, otherwise it may be outdated
 
+**Version 3.0.0**
+
+Changed the way `:extended` mode is handled regarding caching. Now the extended mode will use cache and return a fake
+  response object if the content is cached (Cache is still ignored when using the `:since` option).
+A cached response can be identified by the presence of a `cached?` method on the response object.
+
+Some automated tests for SC2 endpoints are now ignoring `503` errors. The state of the API is somehow unknown since it
+  is down most of the time.
+
+**Version 2.0.0**
+
+Removed the `icon` field from PlayableClass, it was meant to mimic the old communit API behavior during the transition
+  to the new game_data version.
+
+**Version 1.0.0**
+
+Removed the `complete` method from WoW game data endpoints.
+Removed the `concurrency` request and configuration option as it is not necessary anymore.
+Removed the `thwait` dependency.
+
+Added the `redis_database` option to support selecting the redis database for caching data.
+The gem will now share a single Redis connection across all calls.
+The gem now creates a new token on demand if the previous one has expired.
+It is now possible to cache the token in Redis to avoid needlessly creating a new token.
+It is now possible to set the default mode for API calls
+
+**Version 0.6.4**
+
+Fixed argument propagation in SC2 legacy profile methods.
+
 **Version 0.6.3**
 
 Fixed argument propagation in some profile methods.

data/Gemfile.lock

@@ -1,24 +1,22 @@
 PATH
   remote: .
   specs:
-    blizzard_api (0.6.3)
+    blizzard_api (3.0.0)
       redis (~> 4.1, >= 4.1.0)
-      thwait (~> 0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
     dotenv (2.7.6)
-    e2mmap (0.1.0)
-    minitest (5.14.4)
-    parallel (1.20.1)
-    parser (3.0.1.1)
+    minitest (5.15.0)
+    parallel (1.21.0)
+    parser (3.0.3.2)
       ast (~> 2.4.1)
     rainbow (3.0.0)
-    rake (13.0.3)
-    redis (4.2.5)
-    regexp_parser (2.1.1)
+    rake (13.0.6)
+    redis (4.5.1)
+    regexp_parser (2.2.0)
     rexml (3.2.5)
     rubocop (0.93.1)
       parallel (~> 1.10)
@@ -29,13 +27,13 @@ GEM
       rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.5.0)
+    rubocop-ast (1.15.1)
       parser (>= 3.0.1.1)
     ruby-progressbar (1.11.0)
-    thwait (0.2.0)
-      e2mmap
-    unicode-display_width (1.7.0)
-    yard (0.9.26)
+    unicode-display_width (1.8.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
 
 PLATFORMS
   ruby

data/blizzard_api.gemspec

@@ -35,7 +35,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'redis', '~> 4.1', '>= 4.1.0'
-  spec.add_runtime_dependency 'thwait', '~> 0.2.0'
 
   spec.add_development_dependency 'dotenv'
   spec.add_development_dependency 'minitest', '~> 5.0'

data/lib/blizzard_api/api_response.rb

@@ -0,0 +1,24 @@
+module BlizzardApi
+  ##
+  # Simple replacement for the http response object for cached data
+  class ApiResponse
+    attr_reader :code, :body
+
+    def initialize(body)
+      @code = 200
+      @body = body
+    end
+
+    def cached?
+      true
+    end
+  end
+end
+
+module Net
+  class HTTPResponse
+    def cached?
+      false
+    end
+  end
+end

data/lib/blizzard_api/api_standards.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  ##
+  # Default constants and helper functions for the API format
+  module ApiStandards
+    # Common endpoints
+    BASE_URLS = {
+      game_data: 'https://%s.api.blizzard.com/data/%s',
+      community: 'https://%s.api.blizzard.com/%s',
+      profile: 'https://%s.api.blizzard.com/profile/%s',
+      media: 'https://%s.api.blizzard.com/data/%s/media',
+      user_profile: 'https://%s.api.blizzard.com/profile/user/%s',
+      search: 'https://%s.api.blizzard.com/data/%s/search'
+    }.freeze
+
+    protected
+
+    def base_url(scope)
+      raise ArgumentError, 'Invalid scope' unless BASE_URLS.include? scope
+
+      format BASE_URLS[scope], region, @game
+    end
+
+    ##
+    # Returns a valid version namespace
+    #
+    # @param [Hash] options A hash containing a valid namespace key
+    def endpoint_version(options)
+      if options.key? :classic
+        'classic-'
+      elsif options.key? :classic1x
+        'classic1x-'
+      else
+        ''
+      end
+    end
+
+    ##
+    # Returns a valid namespace string for consuming the api endpoints
+    #
+    # @param [Hash] options A hash containing the namespace key
+    def endpoint_namespace(options)
+      version = endpoint_version(options)
+
+      return "dynamic-#{version}#{region}" if options[:namespace].eql? :dynamic
+
+      return "static-#{version}#{region}" if options[:namespace].eql? :static
+
+      return "profile-#{region}" if options[:namespace].eql? :profile
+
+      raise ArgumentError, 'Invalid namespace scope'
+    end
+  end
+end

data/lib/blizzard_api/configuration.rb

@@ -23,6 +23,12 @@ module BlizzardApi
     #   @return [String] Default region
     attr_accessor :region
 
+    ##
+    # @!attribute mode
+    #   Api response mode :regular or :extended.
+    #   @return [Symbol] Default API response mode
+    attr_accessor :mode
+
     ##
     # @!attribute use_cache
     #   If true requests will be cached using a Redis server.
@@ -45,18 +51,17 @@ module BlizzardApi
     attr_accessor :redis_port
 
     ##
-    #
-    # @!attribute concurrency
-    #   How many threads to use for WoW game data `complete` payloads. Defaults to 4.
-    #   Should be set to the amount of available cores on the system.
-    #   @return [Integer] Concurrency
-    attr_writer :concurrency
+    # @!attribute redis_database
+    #   Redis databse.
+    #   @see https://redis.io/
+    #   @return [Integer] Redis database
+    attr_accessor :redis_database
 
     ##
-    # @!attribute access_token
-    #   Access token. Optional. If you don't provide one it will be generate using your client credentials.
-    #   @return [String] Access token.
-    attr_accessor :access_token
+    # @!attribute cache_access_token
+    #   If set to true and cache is enabled the current access token will be cached and recovered from Redis
+    #   @return [Boolean] Access token.
+    attr_accessor :cache_access_token
 
     ##
     # This method return the singleton instance of the configuration module. Use this to initialize the default values
@@ -73,18 +78,16 @@ module BlizzardApi
     #     config.use_cache = true
     #     config.redis_host = ENV['REDIS_HOST']
     #     config.redis_port = ENV['REDIS_PORT']
-    #     config.format = :json
-    #
-    #     config.icons_directory = './wow/icons'
-    #     config.guild_crest_directory = './wow/guild_crest'
-    #     config.wow_character_profile_directory = './wow/profile'
     #   end
     def configure
       yield self
     end
 
-    def concurrency
-      @concurrency ||= 4
+    ##
+    # Initializes some default values for the main module
+    def self.extended(base)
+      base.redis_port = 1
+      base.mode = :regular
     end
   end
 end

data/lib/blizzard_api/diablo/game_data/generic_data_endpoint.rb

@@ -4,8 +4,8 @@ module BlizzardApi
   module Diablo
     # Generic endpoint to support most data requests with minor configurations
     class GenericDataEndpoint < Diablo::Request
-      def initialize(region = nil, mode = :regular)
-        super region, mode
+      def initialize(**options)
+        super(**options)
         endpoint_setup
         @ttl ||= CACHE_DAY
       end

data/lib/blizzard_api/diablo/request.rb

@@ -5,9 +5,9 @@ module BlizzardApi
     # Diablo III requests
     class Request < BlizzardApi::Request
       ##
-      # @!macro regions
-      def initialize(region = nil, mode = :regular)
-        super region, mode
+      # @!macro init_options
+      def initialize(**options)
+        super(**options)
         @game = 'd3'
       end
     end

data/lib/blizzard_api/diablo.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+##
+# @!macro [new] init_options
+#   @param options [Hash] Initialization options
+#     @option options [String] :region API region
+#     @option options [Symbol] :model API mode (:regular, :extended)
+
 module BlizzardApi
   # Diablo III related classes
   module Diablo
@@ -11,17 +17,17 @@ module BlizzardApi
     require_relative 'diablo/game_data/era'
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Season}
-    def self.season(region = BlizzardApi.region)
-      BlizzardApi::Diablo::Season.new(region)
+    def self.season(**options)
+      BlizzardApi::Diablo::Season.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Era}
-    def self.era(region = BlizzardApi.region)
-      BlizzardApi::Diablo::Era.new(region)
+    def self.era(**options)
+      BlizzardApi::Diablo::Era.new(**options)
     end
 
     # Diablo community api
@@ -34,52 +40,52 @@ module BlizzardApi
     require_relative 'diablo/community/profile'
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Act}
-    def self.act(region = BlizzardApi.region)
-      BlizzardApi::Diablo::Act.new(region)
+    def self.act(**options)
+      BlizzardApi::Diablo::Act.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Artisan}
-    def self.artisan(region = BlizzardApi.region)
-      BlizzardApi::Diablo::Artisan.new(region)
+    def self.artisan(**options)
+      BlizzardApi::Diablo::Artisan.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Follower}
-    def self.follower(region = BlizzardApi.region)
-      BlizzardApi::Diablo::Follower.new(region)
+    def self.follower(**options)
+      BlizzardApi::Diablo::Follower.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Character}
-    def self.character(region = BlizzardApi.region)
-      BlizzardApi::Diablo::Character.new(region)
+    def self.character(**options)
+      BlizzardApi::Diablo::Character.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {ItemType}
-    def self.item_type(region = BlizzardApi.region)
-      BlizzardApi::Diablo::ItemType.new(region)
+    def self.item_type(**options)
+      BlizzardApi::Diablo::ItemType.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Type}
-    def self.item(region = BlizzardApi.region)
-      BlizzardApi::Diablo::Item.new(region)
+    def self.item(**options)
+      BlizzardApi::Diablo::Item.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Profile}
-    def self.profile(region = BlizzardApi.region)
-      BlizzardApi::Diablo::Profile.new(region)
+    def self.profile(**options)
+      BlizzardApi::Diablo::Profile.new(**options)
     end
   end
 end

data/lib/blizzard_api/hearthstone/game_data/generic_data_endpoint.rb

@@ -4,8 +4,8 @@ module BlizzardApi
   module Hearthstone
     # Generic endpoint to support most data requests with minor configurations
     class GenericDataEndpoint < Hearthstone::Request
-      def initialize(region = nil, mode = :regular)
-        super region, mode
+      def initialize(**options)
+        super(**options)
         endpoint_setup
         @ttl ||= CACHE_DAY
       end

data/lib/blizzard_api/hearthstone/request.rb

@@ -5,9 +5,9 @@ module BlizzardApi
     # Hearthstone requests
     class Request < BlizzardApi::Request
       ##
-      # @!macro regions
-      def initialize(region = nil, mode = :regular)
-        super region, mode
+      # @!macro init_options
+      def initialize(**options)
+        super(**options)
         @game = 'hearthstone'
       end
     end

data/lib/blizzard_api/hearthstone.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+##
+# @!macro [new] init_options
+#   @param options [Hash] Initialization options
+#     @option options [String] :region API region
+#     @option options [Symbol] :model API mode (:regular, :extended)
+
 module BlizzardApi
   # Hearthstone related classes
   module Hearthstone
@@ -13,31 +19,31 @@ module BlizzardApi
     require_relative 'hearthstone/game_data/metadata'
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Card}
-    def self.card(region = BlizzardApi.region)
-      BlizzardApi::Hearthstone::Card.new(region)
+    def self.card(**options)
+      BlizzardApi::Hearthstone::Card.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Back}
-    def self.back(region = BlizzardApi.region)
-      BlizzardApi::Hearthstone::Back.new(region)
+    def self.back(**options)
+      BlizzardApi::Hearthstone::Back.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Deck}
-    def self.deck(region = BlizzardApi.region)
-      BlizzardApi::Hearthstone::Deck.new(region)
+    def self.deck(**options)
+      BlizzardApi::Hearthstone::Deck.new(**options)
     end
 
     ##
-    # @param region [String] API Region
+    # @!macro init_options
     # @return {Metadata}
-    def self.metadata(region = BlizzardApi.region)
-      BlizzardApi::Hearthstone::Metadata.new(region)
+    def self.metadata(**options)
+      BlizzardApi::Hearthstone::Metadata.new(**options)
     end
   end
 end