blizzard_api 1.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 862b08dc9410cd376ae326bd9617b5dc0a83bcdba3bd72096f9f538993bf65ae
-  data.tar.gz: 81822af210c99fe12144be084cbaaa41dc2ad45a3c968d52dda94137e69e3bbc
+  metadata.gz: 680ed6a0b92283da14b06fd82d2b68d907f54ae43286dcdadce49c59d5d2f006
+  data.tar.gz: 55533dafd67060eaa7c5100da709d9477941cbc3e1d110d01feb7384857bb791
 SHA512:
-  metadata.gz: 1ad2ee3a2e8c6fdecd512967e86645604ff0b5452fecdf7e7511a9d8fcb9b094aef2e96fcbe34d405221a9f41646635a61a0d07281f0a4da3b6b0cb45e59832a
-  data.tar.gz: 3cfa00ba28278318d9348d1ce81fa63f83fb7b455f5a0340360ed402d95c36b7a2a28b9c8a16c4ca3252e55e6dc6e6d721f53e918b923e1726430708f0ec1dc8
+  metadata.gz: 9f389ae7148b0e0527cbae0f00153e9db2d400496223c4c69a86149720115d39959e69365004914128a53072dc838bcec5161d9a436e880a7e96bd8ac39d5669
+  data.tar.gz: cbcfceaeab33b4a85e6c0fe6d408c2762e4cd0ba14fadb471eec2ff00e246e0982bcc7e3820d56c87788e0a011d2055e0b27fb0e4effbb795c0435b93bd0f1d1

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 Please view this file on the master branch, otherwise it may be outdated
 
+**Version 3.1.0**
+
+Fixed the latest build to exclude non 200 responses from caching.
+
+**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.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    blizzard_api (1.0.0)
+    blizzard_api (3.1.0)
       redis (~> 4.1, >= 4.1.0)
 
 GEM

data/lib/blizzard_api/api_response.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+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
+  # Workaround for fake response payloads
+  class HTTPResponse
+    def cached?
+      false
+    end
+  end
+end

data/lib/blizzard_api/diablo/community/{character.rb → character_class.rb}

@@ -9,7 +9,7 @@ module BlizzardApi
     #
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Diablo.character
-    class Character < BlizzardApi::Diablo::Request
+    class CharacterClass < BlizzardApi::Diablo::Request
       ##
       # Return information about a class
       #

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

@@ -35,7 +35,7 @@ module BlizzardApi
       # Fetch leaderboard data for the current endpoint
       #
       # @param [Integer] id One of the IDs returned by the {index}
-      # @param [Integer] leaderboard_id Leaderboard id
+      # @param [String] leaderboard_id Leaderboard id
       # @!macro request_options
       #
       # @!macro response

data/lib/blizzard_api/diablo.rb

@@ -34,7 +34,7 @@ module BlizzardApi
     require_relative 'diablo/community/act'
     require_relative 'diablo/community/artisan'
     require_relative 'diablo/community/follower'
-    require_relative 'diablo/community/character'
+    require_relative 'diablo/community/character_class'
     require_relative 'diablo/community/item_type'
     require_relative 'diablo/community/item'
     require_relative 'diablo/community/profile'
@@ -64,7 +64,7 @@ module BlizzardApi
     # @!macro init_options
     # @return {Character}
     def self.character(**options)
-      BlizzardApi::Diablo::Character.new(**options)
+      BlizzardApi::Diablo::CharacterClass.new(**options)
     end
 
     ##

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

@@ -20,7 +20,7 @@ module BlizzardApi
       # @!macro request_options
       #
       # @!macro response
-      def index(**options)
+      def search(**options)
         api_request "#{base_url(:community)}/#{@endpoint}/", **default_options.merge(options)
       end
 

data/lib/blizzard_api/request.rb

@@ -82,20 +82,28 @@ module BlizzardApi
     def request(url, **options)
       # Creates the whole url for request
       parsed_url = URI.parse(url)
-
       data = using_cache?(options) ? find_in_cache(parsed_url.to_s) : nil
 
       # If data was found that means cache is enabled and valid
-      return JSON.parse(data, symbolize_names: true) if data
+      return prepare_response data if data
 
       response = consume_api parsed_url, **options
 
-      save_in_cache parsed_url.to_s, response.body, options[:ttl] || CACHE_DAY if using_cache? options
+      handle_cache_on_response parsed_url, response, **options
+    end
 
-      response_data = response.code.to_i.eql?(304) ? nil : JSON.parse(response.body, symbolize_names: true)
-      return [response, response_data] if mode.eql? :extended
+    def handle_cache_on_response(parsed_url, response, **options)
+      case response.code.to_i
+      when 304
+        response_data = nil
+      when 200
+        response_data = response.body
+      else
+        return nil, response
+      end
 
-      response_data
+      save_in_cache parsed_url.to_s, response.body, options[:ttl] || CACHE_DAY if using_cache? options
+      prepare_response response_data, response
     end
 
     def api_request(uri, **query_string)
@@ -110,7 +118,7 @@ module BlizzardApi
 
       # In case uri already have query string parameters joins them with &
       if query_string.size.positive?
-        query_string = URI.encode_www_form(query_string, false)
+        query_string = URI.encode_www_form(query_string)
         uri = uri.include?('?') ? "#{uri}&#{query_string}" : "#{uri}?#{query_string}"
       end
 
@@ -119,10 +127,22 @@ module BlizzardApi
 
     private
 
+    ##
+    # Resolves the response based on the mode
+    def prepare_response(data, response = nil)
+      parsed_data = data.nil? ? data : JSON.parse(data, symbolize_names: true)
+
+      return parsed_data unless mode.eql? :extended
+
+      response ||= ApiResponse.new(data)
+
+      [response, parsed_data]
+    end
+
     ##
     # @param options [Hash] Request options
     def using_cache?(options)
-      return false if mode.eql?(:extended) || options.key?(:since)
+      return false if options.key?(:since)
 
       !options.fetch(:ignore_cache, false)
     end
@@ -130,6 +150,7 @@ module BlizzardApi
     def http_connection(url)
       Net::HTTP.new(url.host, url.port).tap do |http|
         http.use_ssl = true
+        http.keep_alive_timeout = 30
       end
     end
 

data/lib/blizzard_api/version.rb

@@ -2,5 +2,5 @@
 
 module BlizzardApi
   # Gem version
-  VERSION = '1.0.0'
+  VERSION = '3.1.0'
 end

data/lib/blizzard_api/wow/game_data/guild_crest.rb

@@ -13,7 +13,7 @@ module BlizzardApi
       setup 'guild-crest', :static, CACHE_TRIMESTER
 
       def get
-        raise BlizzardApi::ApiException, 'This endpoint doens\'t have a get method'
+        raise BlizzardApi::ApiException, 'This endpoint does not have a get method'
       end
 
       ##

data/lib/blizzard_api/wow/game_data/playable_class.rb

@@ -23,22 +23,6 @@ module BlizzardApi
         api_request "#{endpoint_uri}/#{id}/pvp-talent-slots", **default_options.merge(options)
       end
 
-      ##
-      # Return playable class data by its id
-      #
-      # @param id [Integer] Playable class id
-      #
-      # @!macro request_options
-      # @option options [Boolean] :classic If set to true, this method will call the classic version
-      # @option options [Boolean] :classic1x If set to true, this method will call the classic era version
-      #
-      # @!macro response
-      def get(id, **options)
-        data = api_request "#{endpoint_uri}/#{id}", **default_options.merge(options)
-        data[:icon] = get_class_icon data[:media], **options
-        data
-      end
-
       ##
       # Fetch media for one of the playable classes listed by the {#index} using its *id*
       #
@@ -50,15 +34,6 @@ module BlizzardApi
       def media(id, **options)
         api_request "#{base_url(:media)}/playable-class/#{id}", **default_options.merge(options)
       end
-
-      protected
-
-      def get_class_icon(media_url, **options)
-        return if options.include? :classic
-
-        media_data = request media_url[:key][:href], **options
-        %r{56/([a-z_]+).jpg}.match(media_data[:assets][0][:value].to_s)[1]
-      end
     end
   end
 end

data/lib/blizzard_api/wow/game_data/reputation.rb

@@ -17,7 +17,7 @@ module BlizzardApi
       #
       # @!macro response
       def index
-        raise BlizzardApi::ApiException, 'This endpoint does not have a index method'
+        raise BlizzardApi::ApiException, 'This endpoint does not have an index method'
       end
 
       ##

data/lib/blizzard_api/wow/game_data/spell.rb

@@ -19,7 +19,7 @@ module BlizzardApi
       #
       # @!macro response
       def index
-        raise BlizzardApi::ApiException, 'This endpoint does not have a index method'
+        raise BlizzardApi::ApiException, 'This endpoint does not have an index method'
       end
 
       ##

data/lib/blizzard_api/wow/game_data/wow_token.rb

@@ -9,16 +9,11 @@ module BlizzardApi
     #
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.wow_token
-    class WowToken < Wow::Request
-      ##
-      # Returns wow token data
-      #
-      # @!macro request_options
-      #
-      # @!macro response
-      def get(**options)
-        opts = { namespace: :dynamic, ttl: CACHE_HOUR }.merge(options)
-        api_request "#{base_url(:game_data)}/token/index", **opts
+    class WowToken < GenericDataEndpoint
+      setup 'token', :dynamic, CACHE_HOUR
+
+      def get
+        raise BlizzardApi::ApiException, 'This endpoint does not have a index method'
       end
     end
   end

data/lib/blizzard_api/wow/profile/character_profile.rb

@@ -13,7 +13,7 @@ module BlizzardApi
       include BlizzardApi::Wow::Slug
 
       ##
-      # Return character achievements
+      # Return character basic data
       #
       # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
       #

data/lib/blizzard_api.rb

@@ -3,6 +3,7 @@
 require_relative 'blizzard_api/configuration'
 require_relative 'blizzard_api/token_manager'
 require_relative 'blizzard_api/api_standards'
+require_relative 'blizzard_api/api_response'
 require_relative 'blizzard_api/request'
 require_relative 'blizzard_api/exception'
 require_relative 'blizzard_api/version'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-09 00:00:00.000000000 Z
+date: 2022-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -121,12 +121,13 @@ files:
 - bin/setup
 - blizzard_api.gemspec
 - lib/blizzard_api.rb
+- lib/blizzard_api/api_response.rb
 - lib/blizzard_api/api_standards.rb
 - lib/blizzard_api/configuration.rb
 - lib/blizzard_api/diablo.rb
 - lib/blizzard_api/diablo/community/act.rb
 - lib/blizzard_api/diablo/community/artisan.rb
-- lib/blizzard_api/diablo/community/character.rb
+- lib/blizzard_api/diablo/community/character_class.rb
 - lib/blizzard_api/diablo/community/follower.rb
 - lib/blizzard_api/diablo/community/item.rb
 - lib/blizzard_api/diablo/community/item_type.rb