blizzard_api 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96579c93bc977c1e27958031f03956a7fd19a1c54507a792a8c40fad27c24aea
-  data.tar.gz: b0947d10581d4324503e561dc07059c2fc35f81f27be51b6d322d68abea87064
+  metadata.gz: 4c8fd5029d2b85e30104b35b0a1f4d7f6b2ea7d758b6388f2822408f94d3181c
+  data.tar.gz: 2f74b10c6312c1c85479f99dc498f1eceb65f8afacad3f40a9a94e23d8da2bce
 SHA512:
-  metadata.gz: 1dcdbfc4de7830373ebfda93f8bca5e2f4acc2743b18a5bcd16c6141574e48e13153966041ee4e699c75c76f9ec6af976f8c59116c0dd47f5445cf74d5aded4f
-  data.tar.gz: c2ee55a8fb82065315dc7dc43ff14e6e1e511ffb67984ba57b1983da34d2c94ded0e6a49c46168e129bd991a788bfbe9a8ad4724bd3e7533ca6bd38914a82046
+  metadata.gz: 25a95b728c6d08054858b1c3203bc8b5e5d3f7737ee8e5074e3f5253f1378c94b0e5970b740f9f29b152c67ec289857bb213842aeaaea519f91d7c9a89549328
+  data.tar.gz: c99f65f0f4e15e9076d64dc825d30a55ae5ef7484d14b690065d85a8167329d704d6350594b0576251958b8e938362de589b8afa167ee2e2144c2805e09d017c

data/CHANGELOG.md

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

data/Gemfile.lock

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

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/request.rb

@@ -86,16 +86,14 @@ module BlizzardApi
       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
 
+      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
 
-      response_data = response.code.to_i.eql?(304) ? nil : JSON.parse(response.body, symbolize_names: true)
-      return [response, response_data] if mode.eql? :extended
-
-      response_data
+      prepare_response response_data, response
     end
 
     def api_request(uri, **query_string)
@@ -110,7 +108,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 +117,22 @@ module BlizzardApi
 
     private
 
+    ##
+    # Resolves the response based on the mode
+    def prepare_response(data, response = false)
+      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, 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 +140,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 = '2.0.0'
+  VERSION = '3.0.0'
 end

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: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-12 00:00:00.000000000 Z
+date: 2022-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -121,6 +121,7 @@ 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