blizzard_api 0.4.1 → 0.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 242a293ba7b8ca3247dc92e4d4499049f4e81fc5ee425035148ad45d45717076
-  data.tar.gz: 0b4035e8c611f321a516182ec8f95ec88da575a408b43624ffa8ce4d7e1c7a37
+  metadata.gz: 360667c9c66306b2c7557365d3d412b92eb9d64110526f34ebcfe77f47afff9b
+  data.tar.gz: eb1d4b42631e6fa56b11727ea2a437b77a6e89400b7848c65f5f197fda206c77
 SHA512:
-  metadata.gz: f8ffab41d1106b9ae14cab5ca48bd369cd301ad7c833d878d841f96ab5c30fdb6944ed1e52b757e52cb519361e3c1317c798202d8e6333c215013d2b35304a57
-  data.tar.gz: 3a06b3833836360e72578224e53cc1b1cccb8c70bc310958b0ffe3f02a0cbbbf6ad6e545ad6413a5f7b067edf0f70f783b252b97bcfbf71a19eaec1a66ebbaa9
+  metadata.gz: 3a85c0a3953367f8ce5ea531c82f67f78a67799ebcf5450196a6bc32ae9e7ccb23a75dd6b77c8721b5b9048c6c1046db1fea5f510e2fc01739c32960ce4dd49a
+  data.tar.gz: 8a6f610c43bf199170cf94f4075541213ed6ef90d80966790c5a5349e1362f24a176a780f4d49cb0720592268ad113a21e8275f1b6edb0c22960bab6425746a9

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,66 @@
 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

data/Gemfile.lock

@@ -1,31 +1,36 @@
 PATH
   remote: .
   specs:
-    blizzard_api (0.4.0)
+    blizzard_api (0.5.3)
       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'
@@ -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

data/lib/blizzard_api/starcraft.rb

@@ -19,6 +19,7 @@ module BlizzardApi
     require_relative 'starcraft/community/profile'
     require_relative 'starcraft/community/ladder'
     require_relative 'starcraft/community/account'
+    require_relative 'starcraft/community/legacy'
 
     ##
     # @param region [String] API Region
@@ -40,5 +41,11 @@ module BlizzardApi
     def self.account(region = BlizzardApi.region)
       BlizzardApi::Starcraft::Account.new(region)
     end
+    
+    ##
+    # @return {Legacy}
+    def self.legacy(region = BlizzardApi.region)
+      BlizzardApi::Starcraft::Legacy.new(region)
+    end
   end
 end

data/lib/blizzard_api/starcraft/community/legacy.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Starcraft
+    ##
+    # This class allows access to Starcraft II legacy data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/starcraft-2-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Starcraft.legacy
+    class Legacy < Starcraft::Request
+      
+      ##
+      # Profile data
+      #
+      # @!macro sc2_regions
+      # @param [Integer] realm_id Realm ID
+      # @param [Integer] profile_id Profile ID
+      # @!macro request_options
+      def profile(region_id, realm_id, profile_id, options = {})
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}", opts
+      end
+
+      ##
+      # Ladders
+      #
+      # @!macro sc2_regions
+      # @param [Integer] realm_id Realm ID
+      # @param [Integer] profile_id Profile ID
+      # @!macro request_options
+      def ladders(region_id, realm_id, profile_id, options = {})
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}/ladder ", opts
+      end
+
+      ##
+      # Match History
+      #
+      # @!macro sc2_regions
+      # @param [Integer] realm_id Realm ID
+      # @param [Integer] profile_id Profile ID
+      # @!macro request_options
+      def match(region_id, realm_id, profile_id, options = {})
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/legacy/profile/#{reg}/#{realm_id}/#{profile_id}/matches", opts
+      end
+      
+      ##
+      # Ladder
+      #
+      # @!macro sc2_regions
+      # @param [Integer] ladder_id Ladder ID
+      # @!macro request_options
+      def ladder(region_id, ladder_id, options = {})
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/legacy/ladder/#{reg}/#{ladder_id}", opts
+      end
+      
+      ##
+      # Achievement data
+      #
+      # @!macro sc2_regions
+      # @!macro request_options
+      def achievements(region_id, options = {})
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/legacy/data/achievements/#{reg}", opts
+      end
+      
+      ##
+      # Rewards data
+      #
+      # @!macro sc2_regions
+      # @!macro request_options
+      def rewards(region_id, options = {})
+        reg = resolve_region(region_id)
+        opts = { ttl: CACHE_DAY }.merge(options)
+        api_request "#{base_url(:community)}/legacy/data/rewards/#{reg}", opts
+      end
+    end
+  end
+end

data/lib/blizzard_api/starcraft/request.rb

@@ -15,8 +15,8 @@ module BlizzardApi
 
       ##
       # @!macro regions
-      def initialize(region = nil)
-        super region
+      def initialize(region = nil, mode = :regular)
+        super region, mode
         @game = 'sc2'
       end
 

data/lib/blizzard_api/version.rb

@@ -2,5 +2,5 @@
 
 module BlizzardApi
   # Gem version
-  VERSION = '0.4.1'
+  VERSION = '0.5.4'
 end

data/lib/blizzard_api/wow.rb

@@ -7,16 +7,20 @@ module BlizzardApi
     require_relative 'wow/game_data/generic_data_endpoint'
     require_relative 'wow/search/search_composer'
     require_relative 'wow/search/search_request'
+    require_relative 'wow/slug'
 
     # WoW data api
     require_relative 'wow/game_data/achievement'
     require_relative 'wow/game_data/auction'
     require_relative 'wow/game_data/azerite_essence'
     require_relative 'wow/game_data/connected_realm'
+    require_relative 'wow/game_data/covenant'
     require_relative 'wow/game_data/creature'
     require_relative 'wow/game_data/guild_crest'
     require_relative 'wow/game_data/item'
     require_relative 'wow/game_data/journal'
+    require_relative 'wow/game_data/media'
+    require_relative 'wow/game_data/modified_crafting'
     require_relative 'wow/game_data/mount'
     require_relative 'wow/game_data/mythic_keystone_affix'
     require_relative 'wow/game_data/mythic_keystone'
@@ -36,6 +40,7 @@ module BlizzardApi
     require_relative 'wow/game_data/reputation'
     require_relative 'wow/game_data/spell'
     require_relative 'wow/game_data/talent'
+    require_relative 'wow/game_data/tech_talent'
     require_relative 'wow/game_data/title'
     require_relative 'wow/game_data/wow_token'
 
@@ -67,6 +72,13 @@ module BlizzardApi
       BlizzardApi::Wow::ConnectedRealm.new(region)
     end
 
+    ##
+    # @param region [String] API Region
+    # @return {Covenant}
+    def self.covenant(region = BlizzardApi.region)
+      BlizzardApi::Wow::Covenant.new(region)
+    end
+
     ##
     # @param region [String] API Region
     # @return {Creature}
@@ -95,6 +107,20 @@ module BlizzardApi
       BlizzardApi::Wow::Journal.new(region)
     end
 
+    ##
+    # @param region [String] API Region
+    # @return {Media}
+    def self.media(region = BlizzardApi.region)
+      BlizzardApi::Wow::Media.new(region)
+    end
+
+    ##
+    # @param region [String] API Region
+    # @return {ModifiedCrafting}
+    def self.modified_crafting(region = BlizzardApi.region)
+      BlizzardApi::Wow::ModifiedCrafting.new(region)
+    end
+
     ##
     # @param region [String] API Region
     # @return {Mount}
@@ -228,6 +254,13 @@ module BlizzardApi
       BlizzardApi::Wow::Talent.new(region)
     end
 
+    ##
+    # @param region [String] API Region
+    # @return {TechTalent}
+    def self.tech_talent(region = BlizzardApi.region)
+      BlizzardApi::Wow::TechTalent.new(region)
+    end
+
     ##
     # @param region [String] API Region
     # @return {Title}

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.azerite_essence
     class AzeriteEssence < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
       ##
       # Fetch media for one of the azerite essences listed by the {#index} using its *id*
       #

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft azerite essences
+    #
+    # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.azerite_essence
+    class Covenant < Wow::GenericDataEndpoint
+      ##
+      # Fetch media for one of the covenants listed by the {#index} using its *id*
+      #
+      # @param id [Integer] Covenant id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def media(id, options = {})
+        api_request "#{base_url(:media)}/covenant/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # Fetch all soulbinds
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def soulbinds(options = {})
+        api_request "#{base_url(:game_data)}/covenant/soulbind/index", default_options.merge(options)
+      end
+
+      ##
+      # Fetch a soulbind by its id
+      #
+      # @param id Soulbind id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def soulbind(id, options = {})
+        api_request "#{base_url(:game_data)}/covenant/soulbind/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # Fetch all conduits
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def conduits(options = {})
+        api_request "#{base_url(:game_data)}/covenant/conduit/index", default_options.merge(options)
+      end
+
+      ##
+      # Fetch a conduit by its id
+      #
+      # @param id Conduit id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def conduit(id, options = {})
+        api_request "#{base_url(:game_data)}/covenant/conduit/#{id}", default_options.merge(options)
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'covenant'
+        @namespace = :static
+        @collection = 'covenants'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.creature
     class Creature < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
       def index
         raise BlizzardApi::ApiException, 'Creatures endpoint doesn\'t have a index method'
       end

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

@@ -7,8 +7,8 @@ module BlizzardApi
     class GenericDataEndpoint < Wow::Request
       ##
       # @!macro regions
-      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/wow/game_data/item.rb

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.item
     class Item < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
       ##
       # This method overrides the inherited default behavior to prevent high server load and fetch time
       #

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

@@ -97,6 +97,21 @@ module BlizzardApi
         api_request "#{endpoint_uri('encounter')}/#{id}", default_options.merge(options)
       end
 
+      ##
+      # Fetch data base on search criteria
+      #
+      # @param page [Integer] Page o return
+      # @param page_size [Integer] Amount of items per page
+      #
+      # @!macro request_options
+      # @!macro response
+      def encounter_search(page = 1, page_size = 100, options = {})
+        search_options = SearchComposer.new(page, page_size)
+        yield search_options if block_given?
+
+        api_request "#{endpoint_uri('encounter', :search)}?#{search_options.to_search_query}", default_options.merge(options)
+      end
+
       protected
 
       def endpoint_setup

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft mounts
+    #
+    # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.mount
+    class Media < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
+      def index(_options = nil)
+        raise BlizzardApi::ApiException, 'This endpoint does not have a index method'
+      end
+
+      def get(_options = nil)
+        raise BlizzardApi::ApiException, 'This endpoint does not have a get method'
+      end
+
+      def complete(_options = nil)
+        raise BlizzardApi::ApiException, 'This endpoint does not have a complete method'
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'media'
+        @namespace = :static
+        @collection = 'medias'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft professions
+    #
+    # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-game-data-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.modified_crafting
+    class ModifiedCrafting < Wow::GenericDataEndpoint
+      def complete
+        raise BlizzardApi::ApiException, 'This endpoint does not have a complete method.'
+      end
+
+      ##
+      # Fetch modified crafting category index
+      #
+      # @!macro request_options
+      def categories(options = {})
+        api_request "#{base_url(:game_data)}/modified-crafting/category/index", default_options.merge(options)
+      end
+
+      ##
+      # Fetch a modified crafting category
+      #
+      # @param id [Integer] Modified crafting category id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def category(id, options = {})
+        api_request "#{base_url(:game_data)}/modified-crafting/category/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # Fetch modified crafting slot type index
+      #
+      # @!macro request_options
+      def slot_types(options = {})
+        api_request "#{base_url(:game_data)}/modified-crafting/reagent-slot-type/index", default_options.merge(options)
+      end
+
+      ##
+      # Fetch a modified crafting slot type
+      #
+      # @param id [Integer] Modified crafting slot type id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def slot_type(id, options = {})
+        api_request "#{base_url(:game_data)}/modified-crafting/reagent-slot-type/#{id}", default_options.merge(options)
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'modified-crafting'
+        @namespace = :static
+        @collection = 'professions'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.mount
     class Mount < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
       protected
 
       def endpoint_setup

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.spell
     class Spell < Wow::GenericDataEndpoint
+      include BlizzardApi::Wow::Searchable
+
       ##
       # This method overrides the inherited default behavior to prevent high server load and fetch time
       #

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft talent data
+    #
+    # @see https://develop.battle.net/documentation/world-of-warcraft/game-data-apis
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Wow.talent
+    class TechTalent < Wow::GenericDataEndpoint
+      ##
+      # Fetch tech talent trees
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def tech_talent_trees(options = {})
+        api_request "#{base_url(:game_data)}/tech-talent-tree/index", default_options.merge(options)
+      end
+
+      ##
+      # Fetch a tech talent tree
+      #
+      # @param id [Integer] Tech talent id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def tech_talent_tree(id, options = {})
+        api_request "#{base_url(:game_data)}/tech-talent-tree/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # Fetch a tech talent media
+      #
+      # @param id [Integer] Tech talent id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def media(id, options = {})
+        api_request "#{base_url(:media)}/tech-talent/#{id}", default_options.merge(options)
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'tech-talent'
+        @namespace = :static
+        @collection = 'tech-talents'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.achievement
     class CharacterProfile < Wow::Request
+      include BlizzardApi::Wow::Slug
+
       ##
       # Return character achievements
       #
@@ -287,9 +289,11 @@ module BlizzardApi
       # @param realm [String] The character realm's slug
       # @param character [String] The character name
       # @!macro request_options
+      #   @option options [Boolean] :completed Should return completed quests
       #
       # @!macro response
-      def quests(realm, character, completed = false, options = {})
+      def quests(realm, character, options = {})
+        completed = options.delete(:completed) || false
         return character_request realm, character, options, 'quests/completed' if completed
 
         character_request realm, character, options, 'quests'
@@ -309,6 +313,20 @@ module BlizzardApi
         character_request realm, character, options, 'reputations'
       end
 
+      ##
+      # Return a character's soulbinds
+      #
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-profile-api
+      #
+      # @param realm [String] The character realm's slug
+      # @param character [String] The character name
+      # @!macro request_options
+      #
+      # @!macro response
+      def soulbinds(realm, character, options = {})
+        character_request realm, character, options, 'soulbinds'
+      end
+
       ##
       # Return a character's specialization
       #

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

@@ -10,6 +10,8 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.guild
     class Guild < Wow::Request
+      include BlizzardApi::Wow::Slug
+
       ##
       # Return data about the specified guild
       #

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

@@ -7,8 +7,8 @@ module BlizzardApi
     class AccountProfile < Request
       ##
       # @param token [String] A token obtained using the authorization_code flow
-      def initialize(token, region = nil)
-        super region
+      def initialize(token, region = nil, mode = :regular)
+        super region, mode
         @token = token
       end
 

data/lib/blizzard_api/wow/request.rb

@@ -7,8 +7,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 = 'wow'
       end
     end

data/lib/blizzard_api/wow/search/search_composer.rb

@@ -20,7 +20,7 @@ module BlizzardApi
       # The second argument takes a simple value, an array of values or a hash for range searches.
       #
       # @param field [String] Field name
-      # @param value [String|Integer|Hash|Array<Integer|String>]
+      # @param value [String|Integer|Hash|Array<Integer>|Array<String>]
       # @option value [Integer] :min Range start
       # @option value [Integer] :max Range end
       # @option value [Integer] :mode Range mode (:inclusive|:exclusive)
@@ -37,7 +37,7 @@ module BlizzardApi
       # The second argument takes a simple value, an array of values or a hash for range searches.
       #
       # @param field [String] Field name
-      # @param value [String|Integer|Hash|Array<Integer|String>]
+      # @param value [String|Integer|Hash|Array<Integer>|Array<String>]
       # @option value [Integer] :min Range start
       # @option value [Integer] :max Range end
       # @option value [Integer] :mode Range mode (:inclusive|:exclusive)
@@ -68,7 +68,7 @@ module BlizzardApi
       # @return {String}
       def to_search_query
         query_string = "_page=#{page}&_pageSize=#{page_size}"
-        query_string += '&' + fields.join('&') unless fields.size.zero?
+        query_string += "&#{fields.join('&')}" unless fields.size.zero?
         query_string += "&orderby=#{order.join(',')}" unless order.size.zero?
         query_string
       end

data/lib/blizzard_api/wow/search/search_request.rb

@@ -6,7 +6,7 @@ module BlizzardApi
     # Added search support to an endpoint
     module Searchable
       ##
-      # Fetch data base on search criteria
+      # Fetch data based on search criteria
       #
       # @param page [Integer] Page o return
       # @param page_size [Integer] Amount of items per page

data/lib/blizzard_api/wow/slug.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    # Support for slugs
+    module Slug
+      def string_to_slug(string)
+        CGI.escape(string.downcase.tr(' ', '-'))
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.4
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-09 00:00:00.000000000 Z
+date: 2020-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
@@ -102,13 +102,13 @@ dependencies:
         version: '0'
 description: This is a simple interface to obtain data from Blizzard API
 email:
-- francis.schiavo@francisschiavo.com
+- francis@schiavo.dev
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
-- ".gitlab-ci.yml"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - CHANGELOG.md
@@ -146,6 +146,7 @@ files:
 - lib/blizzard_api/starcraft.rb
 - lib/blizzard_api/starcraft/community/account.rb
 - lib/blizzard_api/starcraft/community/ladder.rb
+- lib/blizzard_api/starcraft/community/legacy.rb
 - lib/blizzard_api/starcraft/community/profile.rb
 - lib/blizzard_api/starcraft/game_data/league.rb
 - lib/blizzard_api/starcraft/request.rb
@@ -155,11 +156,14 @@ files:
 - lib/blizzard_api/wow/game_data/auction.rb
 - lib/blizzard_api/wow/game_data/azerite_essence.rb
 - lib/blizzard_api/wow/game_data/connected_realm.rb
+- lib/blizzard_api/wow/game_data/covenant.rb
 - lib/blizzard_api/wow/game_data/creature.rb
 - lib/blizzard_api/wow/game_data/generic_data_endpoint.rb
 - lib/blizzard_api/wow/game_data/guild_crest.rb
 - lib/blizzard_api/wow/game_data/item.rb
 - lib/blizzard_api/wow/game_data/journal.rb
+- lib/blizzard_api/wow/game_data/media.rb
+- lib/blizzard_api/wow/game_data/modified_crafting.rb
 - lib/blizzard_api/wow/game_data/mount.rb
 - lib/blizzard_api/wow/game_data/mythic_keystone.rb
 - lib/blizzard_api/wow/game_data/mythic_keystone_affix.rb
@@ -179,6 +183,7 @@ files:
 - lib/blizzard_api/wow/game_data/reputation.rb
 - lib/blizzard_api/wow/game_data/spell.rb
 - lib/blizzard_api/wow/game_data/talent.rb
+- lib/blizzard_api/wow/game_data/tech_talent.rb
 - lib/blizzard_api/wow/game_data/title.rb
 - lib/blizzard_api/wow/game_data/wow_token.rb
 - lib/blizzard_api/wow/profile/character_profile.rb
@@ -187,13 +192,16 @@ files:
 - lib/blizzard_api/wow/request.rb
 - lib/blizzard_api/wow/search/search_composer.rb
 - lib/blizzard_api/wow/search/search_request.rb
-homepage: https://gitlab.com/francisschiavo/blizzard_api
+- lib/blizzard_api/wow/slug.rb
+homepage: https://github.com/francis-schiavo/blizzard_api
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://gitlab.com/francisschiavo/blizzard_api
-  source_code_uri: https://gitlab.com/francisschiavo/blizzard_api
-  changelog_uri: https://gitlab.com/francisschiavo/blizzard_api/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/francis-schiavo/blizzard_api
+  source_code_uri: https://github.com/francis-schiavo/blizzard_api
+  bug_tracker_uri: https://github.com/francis-schiavo/blizzard_api/issues
+  changelog_uri: https://github.com/francis-schiavo/blizzard_api/blob/master/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/blizzard_api
 post_install_message: 
 rdoc_options: []
 require_paths:

data/.gitlab-ci.yml

@@ -1,12 +0,0 @@
-image: ruby:2.6
-
-stages:
-  - test
-
-test:
-  stage: test
-  script:
-    - gem install bundler -v 2.1.2
-    - bundle install
-    - rubocop
-    - rake