blizzard_api 0.3.11 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d749ca8885288890aa3fd989b55d761520775a0187bc395802152d09a27b57d
-  data.tar.gz: b9da4c8d1aa1c505737a258780e80db4c41a0ea789fef38b7d673cdd5ad3a29b
+  metadata.gz: 3bf4766a30de47652d2693fb7480ef30e5ef6559fbc6f3bb7cad50a35ab4b1a6
+  data.tar.gz: 447d04397f442f5b7ad4fab941bf54fba397f7b855a26bfd62e67cefad30f78f
 SHA512:
-  metadata.gz: 2320bad31262928a97d77ddf5092ad86a80278ac88572be33a9f252aa639d99973a8c3554b786f3c95fc9a05be0aba099412038eaee56bda11a9e6414221ff40
-  data.tar.gz: 7a9df7fb947da25b9e5ae4e19c6384acfe3f5111f6d4ca2615f4ab87ee80cdfde25bb7cbebde597e2c5bebe4b303a661605e6ff51ef68860c24c07895883c844
+  metadata.gz: 851bdad8472fcaf5e385b8caba51376636ea30be09ee79ecb5a383971196945574b8a3073b465f940a3aee123f885ab5358d3f2ba6bcf5eb38fb59da5bcdb660
+  data.tar.gz: 48bfe00c18fea3f3d296f1b49e800e54c67ff1a6b8e5972086e4d2f95cc014b5751e53c10a526a4e2bf103342cdea6c441a2987e59e00b5c0cfdc2d3d16d4334

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.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
+
+https://develop.battle.net/documentation/world-of-warcraft/guides/search
+
 **Version 0.3.11**
 
 Fixed D3 item URL.

data/Gemfile.lock

@@ -1,39 +1,48 @@
 PATH
   remote: .
   specs:
-    blizzard_api (0.3.11)
+    blizzard_api (0.5.1)
       redis (~> 4.1, >= 4.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
-    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.19.2)
+    parser (2.7.1.5)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
     rake (13.0.1)
-    redis (4.1.3)
-    rubocop (0.74.0)
-      jaro_winkler (~> 1.5.1)
+    redis (4.2.2)
+    regexp_parser (1.8.0)
+    rexml (3.2.4)
+    rubocop (0.92.0)
       parallel (~> 1.10)
-      parser (>= 2.6)
+      parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.5.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.6.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
   ruby
 
 DEPENDENCIES
   blizzard_api!
+  dotenv
   minitest (~> 5.0)
   rake (~> 13.0)
   rubocop (~> 0.61)
+  yard
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/README.md

@@ -73,6 +73,46 @@ Most **data** endpoints will have always 3 methods available `index`, `get` and
 * `get` is used to get all information about a entry of the index returned data. It receives an id or slug as the first parameter, that depends on the endpoint.
 * `complete` is a complete information of all items listed in index. **This may perform various calls to the blizzard api** only use if you really need all information.
 
+### 3.1 Searchable endpoints
+
+Some endpoints support search filters. To perform a search you can use the following formats:
+
+
+To use the **or** operator you may pass an array of values as argument to `where` or `where_not` methods.
+```ruby
+realm = BlizzardApi::Wow.realm
+realm_data = realm.search(1, 100) do |options|
+  options.where 'name.en_US', %w[Azralon Nemesis]
+end
+```
+ 
+To use the **and** operator you may call `where` or `where_not` multiple times methods.
+```ruby
+realm = BlizzardApi::Wow.realm
+realm_data = realm.search(1, 100) do |options|
+  options.where 'name.en_US', 'Azralon'
+  options.where 'id', 3209
+end
+```
+
+To use the **range** operator you may pass a hash to `where` or `where_not`.
+```ruby
+realm = BlizzardApi::Wow.realm
+realm_data = realm.search(1, 100) do |options|
+  options.where 'id', min: 3209, max: 4000, mode: :exclusive
+end
+```
+*Note*: If you don't pass the `mode` key as `:exclusive` it will be `:inclusive` by default.
+
+To **sort** fields you may call the `order_by` method multiple times:
+```ruby
+realm = BlizzardApi::Wow.realm
+realm_data = realm.search(1, 100) do |options|
+  options.where 'id', min: 3209, max: 4000, mode: :exclusive
+  options.order_by 'id', :desc
+end
+```
+
 ## 4. Available endpoints
 
 **Hint**: All methods support an additional optional hash parameter that allows you to override the following configurations for a single call:
@@ -105,6 +145,7 @@ Most **data** endpoints will have always 3 methods available `index`, `get` and
   - types
   - type :id
   - display_media :id
+  - search
 * Blizzard::Wow::Guild
   - rewards
   - perks
@@ -171,6 +212,7 @@ Most **data** endpoints will have always 3 methods available `index`, `get` and
   - get :id
   - complete
   - status :realms
+  - search
 * Blizzard::Wow::Region
   - index
   - get :id
@@ -191,10 +233,12 @@ Most **data** endpoints will have always 3 methods available `index`, `get` and
   - 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
@@ -222,6 +266,7 @@ Most **data** endpoints will have always 3 methods available `index`, `get` and
   - get :id
 * Blizzard::Wow::Spell
   - get :id
+  - search
 * Blizzard::Wow::Zone
   - index
   - get :id

data/blizzard_api.gemspec

@@ -34,7 +34,9 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'redis', '~> 4.1', '>= 4.1.0'
 
+  spec.add_development_dependency 'dotenv'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rubocop', '~> 0.61'
+  spec.add_development_dependency 'yard'
 end

data/lib/blizzard_api/diablo/community/item.rb

@@ -13,7 +13,7 @@ module BlizzardApi
       ##
       # Return information about an item
       #
-      # @param item_slug [String] Item slug
+      # @param item_slug_and_id [String] Item slug
       # @!macro request_options
       #
       # @!macro response

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
@@ -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 = {
@@ -50,7 +45,8 @@ module BlizzardApi
       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'
+      user_profile: 'https://%s.api.blizzard.com/profile/user/%s',
+      search: 'https://%s.api.blizzard.com/data/%s/search'
     }.freeze
 
     ##
@@ -58,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'
@@ -87,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
@@ -97,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")
 
@@ -120,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 }
@@ -158,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