blizzard_api 0.3.11 → 0.5.2

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

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # Composer for search endpoint arguments
+    class SearchComposer
+      attr_accessor :fields, :order, :page, :page_size
+
+      def initialize(page, page_size)
+        self.page = page
+        self.page_size = page_size
+        self.fields = []
+        self.order = []
+      end
+
+      ##
+      # Add a search field
+      #
+      # 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>|Array<String>]
+      # @option value [Integer] :min Range start
+      # @option value [Integer] :max Range end
+      # @option value [Integer] :mode Range mode (:inclusive|:exclusive)
+      #
+      # @return {SearchComposer}
+      def where(field, value)
+        fields.push "#{field}=#{resolve_value(value)}"
+        self
+      end
+
+      ##
+      # Add a search field
+      #
+      # 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>|Array<String>]
+      # @option value [Integer] :min Range start
+      # @option value [Integer] :max Range end
+      # @option value [Integer] :mode Range mode (:inclusive|:exclusive)
+      #
+      # @return {SearchComposer}
+      def where_not(field, value)
+        fields.push "#{field}!=#{resolve_value(value)}"
+        self
+      end
+
+      ##
+      # Add a sort field
+      #
+      # @param field [String] Field name
+      # @param mode [Symbol] :asc or :desc
+      #
+      # @return {SearchComposer}
+      def order_by(field, mode = :asc)
+        raise ArgumentError, 'Invalid order mode.' unless %i[asc desc].include? mode
+
+        order.push "#{field}:#{mode}"
+        self
+      end
+
+      ##
+      # Returns a valid queryString based on the options
+      #
+      # @return {String}
+      def to_search_query
+        query_string = "_page=#{page}&_pageSize=#{page_size}"
+        query_string += "&#{fields.join('&')}" unless fields.size.zero?
+        query_string += "&orderby=#{order.join(',')}" unless order.size.zero?
+        query_string
+      end
+
+      protected
+
+      def resolve_value(value)
+        return value.join '||' if value.is_a? Array
+
+        return value.to_s unless value.is_a? Hash
+
+        resolve_hash value
+      end
+
+      def resolve_hash(value)
+        min = value.key?(:min) ? value[:min] : ''
+        max = value.key?(:max) ? value[:max] : ''
+        mode = value.key?(:mode) ? value[:mode] : :inclusive
+
+        return "[#{min},#{max}]" if mode.eql? :inclusive
+
+        "(#{min},#{max})"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # Added search support to an endpoint
+    module Searchable
+      ##
+      # Fetch data based on search criteria
+      #
+      # @param page [Integer] Page o return
+      # @param page_size [Integer] Amount of items per page
+      #
+      # @!macro request_options
+      # @!macro response
+      def search(page = 1, page_size = 100, options = {})
+        search_options = SearchComposer.new(page, page_size)
+        yield search_options if block_given?
+
+        api_request "#{endpoint_uri(nil, :search)}?#{search_options.to_search_query}", default_options.merge(options)
+      end
+    end
+  end
+end

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,35 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: blizzard_api
 version: !ruby/object:Gem::Version
-  version: 0.3.11
+  version: 0.5.2
 platform: ruby
 authors:
 - Francis Schiavo
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-17 00:00:00.000000000 Z
+date: 2020-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.1.0
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.1.0
-    - - "~>"
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.1'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -72,6 +86,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.61'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This is a simple interface to obtain data from Blizzard API
 email:
 - francis.schiavo@francisschiavo.com
@@ -127,11 +155,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
@@ -151,12 +182,16 @@ 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
 - lib/blizzard_api/wow/profile/guild.rb
 - lib/blizzard_api/wow/profile/profile.rb
 - lib/blizzard_api/wow/request.rb
+- lib/blizzard_api/wow/search/search_composer.rb
+- lib/blizzard_api/wow/search/search_request.rb
+- lib/blizzard_api/wow/slug.rb
 homepage: https://gitlab.com/francisschiavo/blizzard_api
 licenses:
 - MIT
@@ -179,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Unofficial Ruby client for Blizzard Entertainment API