blizzard_api 0.4.0 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba9df0ce8e6bc1398057fa55eae73f4081d370f13d204f0d6f2eccb313f3bed2
-  data.tar.gz: 5f3d190b6d324c45b456ccd856b6271b6e2447816930b7e451aa7fa325c85d98
+  metadata.gz: bf8d2354d8c5693db38cc06fb9a531ea3088c2ef03df14de07369e7b3bf30e3b
+  data.tar.gz: 05fd0395084f152722138b93bed892ceb5cbb826563aae96830b5f4d85acfd0b
 SHA512:
-  metadata.gz: aa67738363d505b469eeb89c5fcc140fe2bbd8834c3be1afd588ba1a7ae9ac79347409bfdecad97a7a24ea1c427b70a5b4f3812b8d838d11c5b41bb34916bc09
-  data.tar.gz: 6489a58fc1132f50ccd977f0ad4dff408997c9fff80be0d38b7e5d43602287c99490af2604b6bed7a913baa22ad701189fe9eb366a58b39b1266b57a275df73d
+  metadata.gz: fcc914e44f283a236eccd316601f175925d0304b34a6dae3dd5a69c5c441cbd5b8f7ba9e7f4b1080375a7b53f82bb93e5e273deedeba1586e612ea7eb6368066
+  data.tar.gz: 5a28789fa6f1839f4a81a8de96756a6d8b7a6ae5ae7c25f9b6f9747f4acd9fd0e7a762ed29f0578465141a278510bf7a211308e4701c1aca1f6d16b8d53bd600

data/.github/workflows/ruby.yml

@@ -0,0 +1,21 @@
+name: Ruby
+
+on: push
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@21351ecc0a7c196081abca5dc55b08f085efe09a
+        with:
+          ruby-version: 2.6
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rake
+        env:
+          BNET_APPLICATION_ID: ${{ secrets.BNET_APPLICATION_ID }}
+          BNET_APPLICATION_SECRET: ${{ secrets.BNET_APPLICATION_SECRET }}
+          USE_CACHE: false

data/.rubocop.yml

@@ -1,6 +1,6 @@
 inherit_from: .rubocop_todo.yml
 
-Metrics/LineLength:
+Layout/LineLength:
   Max: 140
 
 Metrics/ModuleLength:
@@ -12,6 +12,7 @@ Metrics/AbcSize:
 
 AllCops:
   TargetRubyVersion: 2.5
+  NewCops: enable
   Exclude:
     - 'vendor/**/*'
     - 'bin/**/*'

data/CHANGELOG.md

@@ -1,5 +1,70 @@
 Please view this file on the master branch, otherwise it may be outdated
 
+**Version 0.5.3**
+
+Added missing legacy SC2 endpoints
+
+See https://github.com/francis-schiavo/blizzard_api/pull/2
+
+**Version 0.5.2**
+
+Added new endpoints: https://us.forums.blizzard.com/en/blizzard/t/wow-shadowlands-api-update-covenenats-soulbinds-more/13385
+
+**Version 0.5.1**
+
+Added new endpoints: https://us.forums.blizzard.com/en/blizzard/t/wow-game-data-api-modified-crafting-support/12727
+
+**Version 0.5.0**
+
+This version brings a lot of internal changes to the way the gem works. While
+there no breaking change is expected use it carefully.
+
+## New features:
+
+### Extended mode
+
+When creating a request you can now specify **mode** as the last argument. Available modes:
+* **regular**: No changes, should work as it always did.
+* **extended**: All requests now return an array with two objects, the actual HTTPResponse object and the usual Hash.
+
+```ruby
+api_client = BlizzardApi::Wow::Item.new 'us', :extended
+response, item_data = api_client.get 35_000
+
+puts response.code # 200
+puts item_data[:name][:en_US] # Brutal Gladiator's Dragonhide Legguards
+```
+
+This is intended to expose the response code and headers.
+
+**Important**: Extended mode completely disables the cache.
+
+### Custom headers
+
+You an now pass custom headers in the **options** hash.
+
+There is also a new shorthand for the `If-Modified-Since` header.
+
+```ruby
+# If-Modified-Since shorhand
+auction_data = BlizzardApi::Wow.auction.get 1146, since: DateTime.parse('2099-01-01Z')
+
+# Using custom headers
+auction_data = BlizzardApi::Wow.auction.get 1146, headers: { 'If-Modified-Since' => 'Sun, 27 Sep 2020 02:17:03 GMT' }
+```
+
+**Important**
+* Headers are not part of the cache key, use the option `ignore_cache: true` when needed.
+* The `since` shorthand will always disable the cache.
+
+**Version 0.4.2**
+
+Added new retail and classic search endpoints described here: https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-api-patch-notes-20200708/10310
+
+**Version 0.4.1**
+
+Added new retail and classic endpoints described here: https://us.forums.blizzard.com/en/blizzard/t/world-of-warcraft-api-patch-notes-20200609/8902
+
 **Version 0.4.0**
 
 Added support to searchable endpoints

data/Gemfile.lock

@@ -1,31 +1,36 @@
 PATH
   remote: .
   specs:
-    blizzard_api (0.4.0)
+    blizzard_api (0.5.2)
       redis (~> 4.1, >= 4.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    dotenv (2.7.5)
-    jaro_winkler (1.5.3)
-    minitest (5.11.3)
-    parallel (1.17.0)
-    parser (2.6.3.0)
-      ast (~> 2.4.0)
+    ast (2.4.1)
+    dotenv (2.7.6)
+    minitest (5.14.2)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.1)
-    redis (4.1.4)
-    rubocop (0.74.0)
-      jaro_winkler (~> 1.5.1)
+    redis (4.2.5)
+    regexp_parser (2.0.0)
+    rexml (3.2.4)
+    rubocop (0.93.1)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 0.6.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
     ruby-progressbar (1.10.1)
-    unicode-display_width (1.6.0)
+    unicode-display_width (1.7.0)
     yard (0.9.25)
 
 PLATFORMS

data/README.md

@@ -1,9 +1,7 @@
 # Blizzard Api
 
-[![pipeline status](https://gitlab.com/francisschiavo/blizzard_api/badges/master/pipeline.svg)](https://gitlab.com/francisschiavo/blizzard_api/commits/master)
 [![Gem Version](https://badge.fury.io/rb/blizzard_api.svg)](https://badge.fury.io/rb/blizzard_api)
 
-
 This gem allow you to interface with the new blizzard api (2018) using the OAuth2 protocol for every request.
 
 **Important**: This gem does not support, nor will support China endpoints. 
@@ -145,6 +143,7 @@ end
   - types
   - type :id
   - display_media :id
+  - search
 * Blizzard::Wow::Guild
   - rewards
   - perks
@@ -211,6 +210,7 @@ end
   - get :id
   - complete
   - status :realms
+  - search
 * Blizzard::Wow::Region
   - index
   - get :id
@@ -231,10 +231,12 @@ end
   - class :id
   - subclass :class_id, :subclass_id
   - media :id
+  - search
 * Blizzard::Wow::AzeriteEssence
   - index
   - get :id
   - media :id
+  - search
 * Blizzard::Wow::ReputationTier
   - index
   - get :id
@@ -262,6 +264,7 @@ end
   - get :id
 * Blizzard::Wow::Spell
   - get :id
+  - search
 * Blizzard::Wow::Zone
   - index
   - get :id
@@ -346,7 +349,7 @@ Every endpoint requiring a *region_id* parameter will accepts either the integer
 
 ## Contributing
 
-Bug reports and pull requests are welcome on Gitlab at https://gitlab.com/francisschiavo/blizzard_api/issues
+Bug reports and pull requests are welcome on Github at https://github.com/francis-schiavo/blizzard_api/issues
 
 ## License
 

data/blizzard_api.gemspec

@@ -9,10 +9,10 @@ Gem::Specification.new do |spec|
   spec.name = 'blizzard_api'
   spec.version = BlizzardApi::VERSION
   spec.authors = ['Francis Schiavo']
-  spec.email = ['francis.schiavo@francisschiavo.com']
+  spec.email = ['francis@schiavo.dev']
   spec.summary = 'Unofficial Ruby client for Blizzard Entertainment API'
   spec.description = 'This is a simple interface to obtain data from Blizzard API'
-  spec.homepage = 'https://gitlab.com/francisschiavo/blizzard_api'
+  spec.homepage = 'https://github.com/francis-schiavo/blizzard_api'
   spec.license = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
@@ -20,8 +20,10 @@ Gem::Specification.new do |spec|
   raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.' unless spec.respond_to?(:metadata)
 
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] = 'https://gitlab.com/francisschiavo/blizzard_api'
-  spec.metadata['changelog_uri'] = 'https://gitlab.com/francisschiavo/blizzard_api/blob/master/CHANGELOG.md'
+  spec.metadata['source_code_uri'] = 'https://github.com/francis-schiavo/blizzard_api'
+  spec.metadata['bug_tracker_uri'] = 'https://github.com/francis-schiavo/blizzard_api/issues'
+  spec.metadata['changelog_uri'] = 'https://github.com/francis-schiavo/blizzard_api/blob/master/CHANGELOG.md'
+  spec.metadata['documentation_uri'] = 'https://rubydoc.info/gems/blizzard_api'
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

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)
-        super region
+      def initialize(region = nil, mode = :regular)
+        super region, mode
         endpoint_setup
         @ttl ||= CACHE_DAY
       end

data/lib/blizzard_api/diablo/request.rb

@@ -6,8 +6,8 @@ module BlizzardApi
     class Request < BlizzardApi::Request
       ##
       # @!macro regions
-      def initialize(region = nil)
-        super region
+      def initialize(region = nil, mode = :regular)
+        super region, mode
         @game = 'd3'
       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)
-        super region
+      def initialize(region = nil, mode = :regular)
+        super region, mode
         endpoint_setup
         @ttl ||= CACHE_DAY
       end

data/lib/blizzard_api/hearthstone/request.rb

@@ -6,8 +6,8 @@ module BlizzardApi
     class Request < BlizzardApi::Request
       ##
       # @!macro regions
-      def initialize(region = nil)
-        super region
+      def initialize(region = nil, mode = :regular)
+        super region, mode
         @game = 'hearthstone'
       end
     end

data/lib/blizzard_api/request.rb

@@ -8,6 +8,7 @@
 #   @option options [String] :access_token Overrides the access_token for a single call
 #   @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.
 
 ##
 # @!macro [new] regions
@@ -16,7 +17,7 @@
 
 ##
 # @!macro [new] response
-#   @return [OpenStruct,Array] API Response. The actual type of the returned object depends on the *format* option
+#   @return [Hash] API Response. The actual type of the returned object depends on the *format* option
 #   in the configuration module
 
 ##
@@ -31,18 +32,12 @@ module BlizzardApi
   ##
   # Simplifies the requests to Blizzard APIS
   class Request
-    # One minute cache
-    CACHE_MINUTE = 60
     # One hour cache
-    CACHE_HOUR = 60 * CACHE_MINUTE
+    CACHE_HOUR = 3600
     # One day cache
     CACHE_DAY = 24 * CACHE_HOUR
-    # One week cache
-    CACHE_WEEK = CACHE_DAY * 7
-    # One (commercial) month cache
-    CACHE_MONTH = CACHE_DAY * 30
     # Three (commercial) months cache
-    CACHE_TRIMESTER = CACHE_MONTH * 3
+    CACHE_TRIMESTER = CACHE_DAY * 90
 
     # Common endpoints
     BASE_URLS = {
@@ -59,13 +54,20 @@ module BlizzardApi
     #   @return [String] Api region
     attr_accessor :region
 
+    ##
+    # @!attribute mode
+    #   @return [:regular, :extended]
+    attr_accessor :mode
+
     ##
     # @!macro regions
-    def initialize(region = nil)
+    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
       # 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
+      # Mode
+      @mode = mode
     end
 
     require 'net/http'
@@ -88,7 +90,7 @@ module BlizzardApi
     def endpoint_namespace(options)
       case options[:namespace]
       when :dynamic
-        "dynamic-#{region}"
+        options.include?(:classic) ? "dynamic-classic-#{region}" : "dynamic-#{region}"
       when :static
         options.include?(:classic) ? "static-classic-#{region}" : "static-#{region}"
       when :profile
@@ -98,10 +100,6 @@ module BlizzardApi
       end
     end
 
-    def string_to_slug(string)
-      CGI.escape(string.downcase.tr(' ', '-'))
-    end
-
     def create_access_token
       uri = URI.parse("https://#{BlizzardApi.region}.battle.net/oauth/token")
 
@@ -121,26 +119,24 @@ module BlizzardApi
       # Creates the whole url for request
       parsed_url = URI.parse(url)
 
-      data = options[:ignore_cache] ? nil : find_in_cache(parsed_url.to_s)
+      data = using_cache?(options) ? find_in_cache(parsed_url.to_s) : nil
+
       # If data was found that means cache is enabled and valid
-      return format_response data if data
+      return JSON.parse(data, symbolize_names: true) if data
 
-      # Override access_token
-      @access_token = options[:access_token] if options.include? :access_token
+      response = consume_api parsed_url, options
 
-      response = consume_api parsed_url
+      save_in_cache parsed_url.to_s, response.body, options[:ttl] || CACHE_DAY if using_cache? options
 
-      unless options[:ignore_cache]
-        ttl = options[:ttl] || CACHE_DAY
-        save_in_cache parsed_url.to_s, response.body, ttl
-      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
 
-      format_response response.body
+      response_data
     end
 
     def api_request(uri, query_string = {})
       # List of request options
-      options_key = %i[ignore_cache ttl format access_token namespace classic]
+      options_key = %i[ignore_cache ttl format access_token namespace classic headers since]
 
       # Separates request options from api fields and options. Any user-defined option will be treated as api field.
       options = query_string.select { |k, _v| query_string.delete(k) || true if options_key.include? k }
@@ -159,35 +155,46 @@ module BlizzardApi
 
     private
 
-    def consume_api(url)
+    ##
+    # @param options [Hash] Request options
+    def using_cache?(options)
+      return false if mode.eql?(:extended) || options.key?(:since)
+
+      !options.fetch(:ignore_cache, false)
+    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)
 
-      # Blizzard API documentation states the preferred way to send the access_token is using Bearer token on header
-      request['Authorization'] = "Bearer #{@access_token}"
+      add_headers request, options
 
       # Executes the request
       http.request(request).tap do |response|
-        raise BlizzardApi::ApiException.new 'Request failed', response.code.to_i unless response.code.to_i == 200
+        if mode.eql?(:regular) && ![200, 304].include?(response.code.to_i)
+          raise BlizzardApi::ApiException.new 'Request failed', response.code.to_i
+        end
       end
     end
 
-    def save_in_cache(resource_url, data, ttl)
-      return nil unless BlizzardApi.use_cache
+    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)}"
+      # 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
 
-      @redis.setex resource_url, ttl, data
+    def save_in_cache(resource_url, data, ttl)
+      @redis.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
-    end
-
-    def format_response(data)
-      JSON.parse(data, symbolize_names: true)
+      @redis.get resource_url if @redis.exists? resource_url
     end
   end
 end