blizzard_api 0.4.0 → 0.5.3

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

@@ -10,6 +10,52 @@ module BlizzardApi
     # You can get an instance of this class using the default region as follows:
     #   api_instance = BlizzardApi::Wow.pet
     class Pet < Wow::GenericDataEndpoint
+      ##
+      # Fetch media for one of the pets listed by the {#index} using its *id*
+      #
+      # @param id [Integer] Pet id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def media(id, options = {})
+        api_request "#{base_url(:media)}/pet/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # Fetch all pet abilities
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def abilities(options = {})
+        api_request "#{endpoint_uri('ability')}/index", default_options.merge(options)
+      end
+
+      ##
+      # Fetch a pet ability
+      #
+      # @param id [Integer] Pet id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def ability(id, options = {})
+        api_request "#{endpoint_uri('ability')}/#{id}", default_options.merge(options)
+      end
+
+      ##
+      # Fetch media for one of the pet abilities listed by the {#abilities} using its *id*
+      #
+      # @param id [Integer] Pet ability id
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def ability_media(id, options = {})
+        api_request "#{base_url(:media)}/pet-ability/#{id}", default_options.merge(options)
+      end
+
       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.0
+  version: 0.5.3
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-08 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