blizzard_api 0.2.0

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft mythic keystone affixes
+    #
+    # @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.mythic_keystone_affix
+    class MythicKeystoneAffix < Wow::GenericDataEndpoint
+      protected
+
+      def endpoint_setup
+        @endpoint = 'keystone-affix'
+        @namespace = endpoint_namespace :static
+        @collection = 'affixes'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft playable classes
+    #
+    # @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.playable_class
+    class PlayableClass < Wow::GenericDataEndpoint
+      ##
+      # Returns a index of playable classes
+      #
+      # @!macro request_options
+      # @option options [Boolean] :use_community_endpoint If set to true, this method will call the community endpoint
+      #   instead of the data endpoint https://develop.battle.net/documentation/api-reference/world-of-warcraft-community-api
+      #
+      # @!macro response
+      def index(options = {})
+        return super options unless options.include? :use_community_endpoint
+
+        api_request "#{base_url(:community)}/data/character/classes", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # Returns the PvP talent slots data of a specific class
+      #
+      # @param id [Integer] Class id to fetch talent data. One of the IDs returned by the {index} method
+      # @!macro request_options
+      #
+      # @!macro response
+      def talent_slots(id, options = {})
+        api_request "#{base_url(:game_data)}/#{@endpoint}/#{id}/pvp-talent-slots", default_options.merge(options)
+      end
+
+      ##
+      # @!macro complete
+      def complete(options = {})
+        index_data = index options
+        [].tap do |classes|
+          index_data[:classes].each do |pclass|
+            class_id = %r{playable-class/([0-9]+)}.match(pclass[:key].to_s)[1]
+            class_data = get class_id, options
+            class_data.delete :_links
+            classes.push class_data
+          end
+        end
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'playable-class'
+        @namespace = endpoint_namespace :static
+        @collection = 'classes'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft playable specializations
+    #
+    # @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:
+    #   spec = BlizzardApi::Wow.playable_specialization
+    class PlayableSpecialization < Wow::GenericDataEndpoint
+      ##
+      # @!macro complete
+      def complete(options = {})
+        index_data = index options
+        response_data = OpenStruct.new
+        response_data.character_specializations = character_data(index_data, options)
+        response_data.pet_specializations = pet_data(index_data, options)
+        response_data
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'playable-specialization'
+        @namespace = endpoint_namespace :static
+        @collection = 'playable_specialization'
+        @ttl = CACHE_TRIMESTER
+      end
+
+      private
+
+      def character_data(index_data, options)
+        [].tap do |specs|
+          index_data[:character_specializations].each do |spec|
+            spec_id = %r{playable-specialization/([0-9]+)}.match(spec[:key].to_s)[1]
+            spec_data = get spec_id, options
+            spec_data[:icon] = resolve_icon(spec_data[:media][:key][:href])
+            cleanup spec_data
+            specs.push spec_data
+          end
+        end
+      end
+
+      def pet_data(index_data, options)
+        [].tap do |specs|
+          index_data[:pet_specializations].each do |spec|
+            spec_id = %r{playable-specialization/([0-9]+)}.match(spec[:key].to_s)[1]
+            spec_data = get spec_id, options
+            spec_data[:icon] = resolve_icon(spec_data[:media][:key][:href])
+            cleanup spec_data
+            specs.push spec_data
+          end
+        end
+      end
+
+      def cleanup(data)
+        data.delete :_links
+        data[:playable_class].delete :key
+        data.delete :media
+      end
+
+      def resolve_icon(media_url)
+        media_data = api_request(media_url)
+        media_data[:assets][0][:value]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft power types
+    #
+    # @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.power_type
+    class PowerType < Wow::GenericDataEndpoint
+      protected
+
+      def endpoint_setup
+        @endpoint = 'power-type'
+        @namespace = endpoint_namespace :static
+        @collection = 'power_types'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft playable races
+    #
+    # @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:
+    #   race = BlizzardApi::Wow.race
+    class Race < Wow::GenericDataEndpoint
+      ##
+      # Returns a index of playable races
+      #
+      # @!macro request_options
+      # @option options [Boolean] :use_community_endpoint If set to true, this method will call the community endpoint
+      #   instead of the data endpoint https://develop.battle.net/documentation/api-reference/world-of-warcraft-community-api
+      #
+      # @!macro response
+      def index(options = {})
+        return super options unless options.include? :use_community_endpoint
+
+        api_request "#{base_url(:community)}/data/character/races", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # @!macro complete
+      def complete(options = {})
+        index_data = index options
+        [].tap do |races|
+          index_data[:races].each do |race|
+            race_id = %r{race/([0-9]+)}.match(race[:key].to_s)[1]
+            race_data = get race_id, options
+            race_data.delete :name
+            races.push race_data
+          end
+        end
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'race'
+        @namespace = endpoint_namespace :static
+        @collection = 'races'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft realms
+    #
+    # @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.realm
+    class Realm < Wow::GenericDataEndpoint
+      ##
+      # This method is actually located at the community scope, but included here because of its relevance
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-community-api
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def status(options = {})
+        api_request "#{base_url(:community)}/realm/status", { ttl: CACHE_MINUTE }.merge(options)
+      end
+
+      ##
+      # @!macro complete
+      def complete(options = {})
+        index_data = index options
+        [].tap do |realms|
+          index_data[:realms].each do |realm|
+            realm_data = get realm[:id], options
+            realm_data.delete :_links
+            realm_data[:region].delete :key
+            realms.push realm_data
+          end
+        end
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'realm'
+        @namespace = endpoint_namespace :dynamic
+        @collection = 'realms'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # This class allows access to World of Warcraft regions
+    #
+    # @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.region
+    class Region < Wow::GenericDataEndpoint
+      ##
+      # @!macro complete
+      def complete(options = {})
+        [].tap do |data|
+          index_data = index options
+          index_data[:regions].each do |region|
+            region_data = request region[:href], options
+            region_data.delete :_links
+            data.push region_data
+          end
+        end
+      end
+
+      ##
+      # Returns data about region battlegroups
+      #
+      # This method is actually located at the community API, but it is included here due to its relevance.
+      # @see https://develop.battle.net/documentation/api-reference/world-of-warcraft-community-api
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def battlegroups(options = {})
+        api_request "#{base_url(:community)}/data/battlegroups/", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      protected
+
+      def endpoint_setup
+        @endpoint = 'region'
+        @namespace = endpoint_namespace :dynamic
+        @collection = 'regions'
+        @ttl = CACHE_TRIMESTER
+      end
+    end
+  end
+end

data/lib/blizzard_api/wow/request.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Wow
+    ##
+    # World of Warcraft requests
+    class Request < BlizzardApi::Request
+      ##
+      # @!macro regions
+      def initialize(region = nil)
+        super region
+        @game = 'wow'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: blizzard_api
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Francis Schiavo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-15 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'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.61'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.61'
+description: This is a simple interface to obtain data from Blizzard API
+email:
+- francis.schiavo@francisschiavo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- blizzard_api.gemspec
+- lib/blizzard_api.rb
+- lib/blizzard_api/configuration.rb
+- lib/blizzard_api/diablo.rb
+- lib/blizzard_api/diablo/community/act.rb
+- lib/blizzard_api/diablo/community/artisan.rb
+- lib/blizzard_api/diablo/community/character.rb
+- lib/blizzard_api/diablo/community/follower.rb
+- lib/blizzard_api/diablo/community/item.rb
+- lib/blizzard_api/diablo/community/item_type.rb
+- lib/blizzard_api/diablo/community/profile.rb
+- lib/blizzard_api/diablo/game_data/era.rb
+- lib/blizzard_api/diablo/game_data/generic_data_endpoint.rb
+- lib/blizzard_api/diablo/game_data/season.rb
+- lib/blizzard_api/diablo/request.rb
+- lib/blizzard_api/exception.rb
+- lib/blizzard_api/request.rb
+- lib/blizzard_api/starcraft.rb
+- lib/blizzard_api/starcraft/community/account.rb
+- lib/blizzard_api/starcraft/community/ladder.rb
+- lib/blizzard_api/starcraft/community/profile.rb
+- lib/blizzard_api/starcraft/game_data/league.rb
+- lib/blizzard_api/starcraft/request.rb
+- lib/blizzard_api/version.rb
+- lib/blizzard_api/wow.rb
+- lib/blizzard_api/wow/community/achievements.rb
+- lib/blizzard_api/wow/community/auction.rb
+- lib/blizzard_api/wow/community/boss.rb
+- lib/blizzard_api/wow/community/challenge.rb
+- lib/blizzard_api/wow/community/character.rb
+- lib/blizzard_api/wow/community/guild.rb
+- lib/blizzard_api/wow/community/item.rb
+- lib/blizzard_api/wow/community/mount.rb
+- lib/blizzard_api/wow/community/pets.rb
+- lib/blizzard_api/wow/community/pvp.rb
+- lib/blizzard_api/wow/community/quest.rb
+- lib/blizzard_api/wow/community/recipe.rb
+- lib/blizzard_api/wow/community/spell.rb
+- lib/blizzard_api/wow/community/zone.rb
+- lib/blizzard_api/wow/game_data/connected_realm.rb
+- lib/blizzard_api/wow/game_data/generic_data_endpoint.rb
+- lib/blizzard_api/wow/game_data/mythic_keystone_affix.rb
+- lib/blizzard_api/wow/game_data/playable_class.rb
+- lib/blizzard_api/wow/game_data/playable_specialization.rb
+- lib/blizzard_api/wow/game_data/power_type.rb
+- lib/blizzard_api/wow/game_data/race.rb
+- lib/blizzard_api/wow/game_data/realm.rb
+- lib/blizzard_api/wow/game_data/region.rb
+- lib/blizzard_api/wow/request.rb
+homepage: https://gitlab.com/francisschiavo/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
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.2
+signing_key: 
+specification_version: 4
+summary: Unofficial Ruby client for Blizzard Entertainment API
+test_files: []