blizzard_api 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c8fd5029d2b85e30104b35b0a1f4d7f6b2ea7d758b6388f2822408f94d3181c
-  data.tar.gz: 2f74b10c6312c1c85479f99dc498f1eceb65f8afacad3f40a9a94e23d8da2bce
+  metadata.gz: 680ed6a0b92283da14b06fd82d2b68d907f54ae43286dcdadce49c59d5d2f006
+  data.tar.gz: 55533dafd67060eaa7c5100da709d9477941cbc3e1d110d01feb7384857bb791
 SHA512:
-  metadata.gz: 25a95b728c6d08054858b1c3203bc8b5e5d3f7737ee8e5074e3f5253f1378c94b0e5970b740f9f29b152c67ec289857bb213842aeaaea519f91d7c9a89549328
-  data.tar.gz: c99f65f0f4e15e9076d64dc825d30a55ae5ef7484d14b690065d85a8167329d704d6350594b0576251958b8e938362de589b8afa167ee2e2144c2805e09d017c
+  metadata.gz: 9f389ae7148b0e0527cbae0f00153e9db2d400496223c4c69a86149720115d39959e69365004914128a53072dc838bcec5161d9a436e880a7e96bd8ac39d5669
+  data.tar.gz: cbcfceaeab33b4a85e6c0fe6d408c2762e4cd0ba14fadb471eec2ff00e246e0982bcc7e3820d56c87788e0a011d2055e0b27fb0e4effbb795c0435b93bd0f1d1

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 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

data/Gemfile.lock

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

data/lib/blizzard_api/api_response.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module BlizzardApi
   ##
   # Simple replacement for the http response object for cached data
@@ -16,6 +18,7 @@ module BlizzardApi
 end
 
 module Net
+  # Workaround for fake response payloads
   class HTTPResponse
     def cached?
       false

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,7 +82,6 @@ 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
@@ -90,9 +89,20 @@ module BlizzardApi
 
       response = consume_api parsed_url, **options
 
-      response_data = response.code.to_i.eql?(304) ? nil : response.body
-      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
 
+    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
+
+      save_in_cache parsed_url.to_s, response.body, options[:ttl] || CACHE_DAY if using_cache? options
       prepare_response response_data, response
     end
 
@@ -119,12 +129,12 @@ module BlizzardApi
 
     ##
     # Resolves the response based on the mode
-    def prepare_response(data, response = false)
+    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) unless response
+      response ||= ApiResponse.new(data)
 
       [response, parsed_data]
     end

data/lib/blizzard_api/version.rb

@@ -2,5 +2,5 @@
 
 module BlizzardApi
   # Gem version
-  VERSION = '3.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/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
       #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-08 00:00:00.000000000 Z
+date: 2022-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -127,7 +127,7 @@ files:
 - 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