blizzard_api 0.6.4 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f331c75e7b30062614bb12c18bfe208742debf32143048dfb51e322baa53fe83
-  data.tar.gz: 8653702786c36a232c7698feb4b8559681dd5418fe9ad5e390578977c2b3525c
+  metadata.gz: 862b08dc9410cd376ae326bd9617b5dc0a83bcdba3bd72096f9f538993bf65ae
+  data.tar.gz: 81822af210c99fe12144be084cbaaa41dc2ad45a3c968d52dda94137e69e3bbc
 SHA512:
-  metadata.gz: ac6789833e98e6f0b1a940999ea59ac96bf1c9676bf58fff869c1a78fb98a5ffffb3e52254f4e261b73407606e6659bff3c904f31c436694d65d1e2bf873d45d
-  data.tar.gz: '088809759e0d6afe7ad9824098f54c1c4d4d66457ef187c3e24b0288bf3f6dfdfbb34e39cb0d5396db8f8360f69fdea55c64e988597115dc6920e98259fd414b'
+  metadata.gz: 1ad2ee3a2e8c6fdecd512967e86645604ff0b5452fecdf7e7511a9d8fcb9b094aef2e96fcbe34d405221a9f41646635a61a0d07281f0a4da3b6b0cb45e59832a
+  data.tar.gz: 3cfa00ba28278318d9348d1ce81fa63f83fb7b455f5a0340360ed402d95c36b7a2a28b9c8a16c4ca3252e55e6dc6e6d721f53e918b923e1726430708f0ec1dc8

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 Please view this file on the master branch, otherwise it may be outdated
 
+**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.

data/Gemfile.lock

@@ -1,24 +1,22 @@
 PATH
   remote: .
   specs:
-    blizzard_api (0.6.3)
+    blizzard_api (1.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.2.0)
+    minitest (5.15.0)
+    parallel (1.21.0)
+    parser (3.0.3.2)
       ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.6)
-    redis (4.3.1)
-    regexp_parser (2.1.1)
+    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.8.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_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

data/lib/blizzard_api/request.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+##
+# @!macro [new] init_options
+#   @param [Hash] options
+#   @option options [String] :region API Region
+#   @option options [Symbol] :mode API Mode
+
 ##
 # @!macro [new] request_options
 #   @param {Hash} options You can specify some options
@@ -9,31 +15,18 @@
 #   @option options [Boolean] :ignore_cache If set to true the request will not use the cache
 #   @option options [Integer] :ttl Override the default time (in seconds) a request should be cached
 #   @option options [DateTime] :since Adds the If-modified-since headers. Will always ignore cache when set.
-#   @option options [Integer] :concurrency How many threads to use for complete sets of data.
-#     BEWARE: Might cause 429 responses, in this case lower the number.
-
-##
-# @!macro [new] regions
-#   @param {Symbol} region One of the valid API regions *:us*, *:eu*, *:ko*, and *:tw*
-#   @note This gem do not support nor will support China endpoints
 
 ##
 # @!macro [new] response
 #   @return [Hash] API Response. The actual type of the returned object depends on the *format* option
 #   in the configuration module
 
-##
-# @!macro [new] complete
-#   Iterates through the {index} response data and fetch additional information using {get}, it results in a more
-#   complete set of data
-#   @note IT MAY PERFORM MANY REQUESTS TO FETCH ALL DATA
-#   @!macro request_options
-#   @!macro response
-
 module BlizzardApi
   ##
   # Simplifies the requests to Blizzard APIS
   class Request
+    include ApiStandards
+
     # One hour cache
     CACHE_HOUR = 3600
     # One day cache
@@ -41,16 +34,6 @@ module BlizzardApi
     # Three (commercial) months cache
     CACHE_TRIMESTER = CACHE_DAY * 90
 
-    # 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
-
     ##
     # @!attribute region
     #   @return [String] Api region
@@ -62,14 +45,14 @@ module BlizzardApi
     attr_accessor :mode
 
     ##
-    # @!macro regions
-    def initialize(region = nil, mode = :regular)
-      self.region = region || BlizzardApi.region
-      @redis = Redis.new(host: BlizzardApi.redis_host, port: BlizzardApi.redis_port) if BlizzardApi.use_cache
+    # @!macro init_options
+    def initialize(**options)
+      self.region = options[:region] || BlizzardApi.region
       # Use the shared access_token, or create one if it doesn't exists. This avoids unnecessary calls to create tokens.
-      @access_token = BlizzardApi.access_token || create_access_token
+      create_access_token if BlizzardApi.access_token_expired?
+
       # Mode
-      @mode = mode
+      @mode = options[:mode] || BlizzardApi.mode
     end
 
     require 'net/http'
@@ -79,45 +62,9 @@ module BlizzardApi
 
     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)
-      case options[:namespace]
-      when :dynamic
-        "dynamic-#{version}#{region}"
-      when :static
-        "static-#{version}#{region}"
-      when :profile
-        "profile-#{region}"
-      else
-        raise ArgumentError, 'Invalid namespace scope'
-      end
-    end
-
     def create_access_token
+      return if BlizzardApi.restore_access_token
+
       uri = URI.parse("https://#{BlizzardApi.region}.battle.net/oauth/token")
 
       http = Net::HTTP.new(uri.host, uri.port)
@@ -129,7 +76,7 @@ module BlizzardApi
       request.set_form_data grant_type: 'client_credentials'
 
       response = http.request(request)
-      BlizzardApi.access_token = JSON.parse(response.body)['access_token']
+      BlizzardApi.save_access_token(JSON.parse(response.body))
     end
 
     def request(url, **options)
@@ -180,16 +127,20 @@ module BlizzardApi
       !options.fetch(:ignore_cache, false)
     end
 
+    def http_connection(url)
+      Net::HTTP.new(url.host, url.port).tap do |http|
+        http.use_ssl = true
+      end
+    end
+
     def consume_api(url, **options)
       # Creates a HTTP connection and request to ensure thread safety
-      http = Net::HTTP.new(url.host, url.port)
-      http.use_ssl = true
       request = Net::HTTP::Get.new(url)
 
       add_headers request, options
 
       # Executes the request
-      http.request(request).tap do |response|
+      http_connection(url).request(request).tap do |response|
         if mode.eql?(:regular) && ![200, 304].include?(response.code.to_i)
           raise BlizzardApi::ApiException.new "Request failed with code '#{response.code}' details: #{response.to_hash}", response.code.to_i
         end
@@ -198,20 +149,20 @@ module BlizzardApi
 
     def add_headers(request, options)
       # Blizzard API documentation states the preferred way to send the access_token is using Bearer token on header
-      request['Authorization'] = "Bearer #{options.fetch(:access_token, @access_token)}"
+      request['Authorization'] = "Bearer #{options.fetch(:access_token, BlizzardApi.access_token)}"
       # Format If-modified-since option
       request['If-Modified-Since'] = options[:since].httpdate if options.key? :since
       options[:headers]&.each { |header, content| request[header] = content }
     end
 
     def save_in_cache(resource_url, data, ttl)
-      @redis.setex resource_url, ttl, data if BlizzardApi.use_cache
+      BlizzardApi.redis_connection.setex resource_url, ttl, data if BlizzardApi.use_cache
     end
 
     def find_in_cache(resource_url)
       return false unless BlizzardApi.use_cache
 
-      @redis.get resource_url if @redis.exists? resource_url
+      BlizzardApi.redis_connection.get resource_url if BlizzardApi.redis_connection.exists? resource_url
     end
   end
 end

data/lib/blizzard_api/starcraft/request.rb

@@ -14,9 +14,9 @@ module BlizzardApi
       SC_REGION = { US: 1, EU: 2, KO: 3, TW: 3 }.freeze
 
       ##
-      # @!macro regions
-      def initialize(region = nil, mode = :regular)
-        super region, mode
+      # @!macro init_options
+      def initialize(**options)
+        super(**options)
         @game = 'sc2'
       end