blizzard_api 0.2.0

data/lib/blizzard_api.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'blizzard_api/configuration'
+require_relative 'blizzard_api/request'
+require_relative 'blizzard_api/exception'
+require_relative 'blizzard_api/version'
+require_relative 'blizzard_api/wow'
+require_relative 'blizzard_api/diablo'
+require_relative 'blizzard_api/starcraft'
+
+# Blizzard namespace
+module BlizzardApi
+  extend Configuration
+end

data/lib/blizzard_api/configuration.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  # Global configurations
+  module Configuration
+    ##
+    # @!attribute app_id
+    #   Application ID.
+    #   @see https://develop.battle.net/access/clients
+    #   @return [String] Application ID
+    attr_accessor :app_id
+
+    ##
+    # @!attribute app_secret
+    #   Application secret.
+    #   @see https://develop.battle.net/access/clients
+    #   @return [String] Application secret
+    attr_accessor :app_secret
+
+    ##
+    # @!attribute region
+    #   Default region.
+    #   @return [String] Default region
+    attr_accessor :region
+
+    ##
+    # @!attribute use_cache
+    #   If true requests will be cached using a Redis server.
+    #   @see https://redis.io/
+    #   @return [Boolean] Application ID
+    attr_accessor :use_cache
+
+    ##
+    # @!attribute redis_host
+    #   Redis host.
+    #   @see https://redis.io/
+    #   @return [String] Redis host
+    attr_accessor :redis_host
+
+    ##
+    # @!attribute redis_port
+    #   Redis port.
+    #   @see https://redis.io/
+    #   @return [Integer] Redis port
+    attr_accessor :redis_port
+
+    ##
+    # @!attribute format
+    #   Response format:
+    #   * *:raw* plain text (String)
+    #   * *:json* for native ruby json (Array).
+    #   * Any other value *OpenStruct* will be used.
+    #   @return [Symbol] Response format.
+    attr_accessor :format
+
+    ##
+    # @!attribute access_token
+    #   Access token. Optional. If you don't provide one it will be generate using your client credentials.
+    #   @return [String] Access token.
+    attr_accessor :access_token
+
+    ##
+    # This method return the singleton instance of the configuration module. Use this to initialize the default values
+    # and options.
+    #
+    # @yield self
+    #
+    # @example
+    #   Blizzard.configure do |config|
+    #     config.app_id = ENV['BNET_APPLICATION_ID']
+    #     config.app_secret = ENV['BNET_APPLICATION_SECRET']
+    #     config.region = 'us'
+    #     config.use_cache = true
+    #     config.redis_host = ENV['REDIS_HOST']
+    #     config.redis_port = ENV['REDIS_PORT']
+    #     config.format = :json
+    #   end
+    def configure
+      yield self
+    end
+  end
+end

data/lib/blizzard_api/diablo.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  # Diablo III related classes
+  module Diablo
+    require_relative 'diablo/request'
+    require_relative 'diablo/game_data/generic_data_endpoint'
+
+    # Diablo data api
+    require_relative 'diablo/game_data/season'
+    require_relative 'diablo/game_data/era'
+
+    ##
+    # @return {Season}
+    def season
+      BlizzardApi::Diablo::Season.new
+    end
+
+    ##
+    # @return {Era}
+    def era
+      BlizzardApi::Diablo::Era.new
+    end
+
+    # Diablo community api
+    require_relative 'diablo/community/act'
+    require_relative 'diablo/community/artisan'
+    require_relative 'diablo/community/follower'
+    require_relative 'diablo/community/character'
+    require_relative 'diablo/community/item_type'
+    require_relative 'diablo/community/item'
+    require_relative 'diablo/community/profile'
+
+    ##
+    # @return {Act}
+    def act
+      BlizzardApi::Diablo::Act.new
+    end
+
+    ##
+    # @return {Artisan}
+    def artisan
+      BlizzardApi::Diablo::Artisan.new
+    end
+
+    ##
+    # @return {Follower}
+    def follower
+      BlizzardApi::Diablo::Follower.new
+    end
+
+    ##
+    # @return {Character}
+    def character
+      BlizzardApi::Diablo::Character.new
+    end
+
+    ##
+    # @return {ItemType}
+    def item_type
+      BlizzardApi::Diablo::ItemType.new
+    end
+
+    ##
+    # @return {Type}
+    def item
+      BlizzardApi::Diablo::Item.new
+    end
+
+    ##
+    # @return {Profile}
+    def profile
+      BlizzardApi::Diablo::Profile.new
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Diablo
+    ##
+    # This class allows access to Diablo III act data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/diablo-3-community-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Diablo.act
+    class Act < BlizzardApi::Diablo::Request
+      ##
+      # Return a list with all acts
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def index(options = {})
+        api_request "#{base_url(:community)}/data/act", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # Return complete information about an act
+      #
+      # @param id [Integer] Act id
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(id, options = {})
+        api_request "#{base_url(:community)}/data/act/#{id}", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Diablo
+    ##
+    # This class allows access to Diablo III artisan data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/diablo-3-community-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Diablo.artisan
+    class Artisan < BlizzardApi::Diablo::Request
+      ##
+      # Return data about an artisan by its slug
+      #
+      # @param artisan_slug [String] Artisan slug
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(artisan_slug, options = {})
+        api_request "#{base_url(:community)}/data/artisan/#{artisan_slug}", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # Return data about an artisan recipe
+      #
+      # @param artisan_slug [String] Artisan slug
+      # @param recipe_slug [String] Recipe slug
+      # @!macro request_options
+      #
+      # @!macro response
+      def recipe(artisan_slug, recipe_slug, options = {})
+        opts = { ttl: CACHE_TRIMESTER }.merge(options)
+        api_request "#{base_url(:community)}/data/artisan/#{artisan_slug}/recipe/#{recipe_slug}", opts
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Diablo
+    ##
+    # This class allows access to Diablo III character data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/diablo-3-community-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Diablo.character
+    class Character < BlizzardApi::Diablo::Request
+      ##
+      # Return information about a class
+      #
+      # @param class_slug [String] Class slug
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(class_slug, options = {})
+        api_request "#{base_url(:community)}/data/hero/#{class_slug}", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # Return information about a class' skill
+      #
+      # @param class_slug [String] Class slug
+      # @param skill_slug [String] Skill slug
+      # @!macro request_options
+      #
+      # @!macro response
+      def skill(class_slug, skill_slug, options = {})
+        opts = { ttl: CACHE_TRIMESTER }.merge(options)
+        api_request "#{base_url(:community)}/data/hero/#{class_slug}/skill/#{skill_slug}", opts
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Diablo
+    ##
+    # This class allows access to Diablo III follower data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/diablo-3-community-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Diablo.follower
+    class Follower < BlizzardApi::Diablo::Request
+      ##
+      # Return information about a follower
+      #
+      # @param follower_slug [String] Follower slug
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(follower_slug, options = {})
+        api_request "#{base_url(:community)}/data/follower/#{follower_slug}", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Diablo
+    ##
+    # This class allows access to Diablo III item data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/diablo-3-community-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Diablo.item
+    class Item < BlizzardApi::Diablo::Request
+      ##
+      # Return information about an item
+      #
+      # @param item_slug [String] Item slug
+      # @param item_id [Integer] Item id
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(item_slug, item_id, options = {})
+        api_request "#{base_url(:community)}/data/item/#{item_slug}-#{item_id}", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Diablo
+    ##
+    # This class allows access to Diablo III item type data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/diablo-3-community-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Diablo.item_type
+    class ItemType < BlizzardApi::Diablo::Request
+      ##
+      # Return a list of item types
+      #
+      # @!macro request_options
+      #
+      # @!macro response
+      def index(options = {})
+        api_request "#{base_url(:community)}/data/item-type", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+
+      ##
+      # Return more information about an item type
+      #
+      # @param item_type_slug [String] Item type slug
+      # @!macro request_options
+      #
+      # @!macro response
+      def get(item_type_slug, options = {})
+        api_request "#{base_url(:community)}/data/item-type/#{item_type_slug}", { ttl: CACHE_TRIMESTER }.merge(options)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module BlizzardApi
+  module Diablo
+    ##
+    # This class allows access to Diablo III profile data
+    #
+    # @see https://develop.battle.net/documentation/api-reference/diablo-3-community-api
+    #
+    # You can get an instance of this class using the default region as follows:
+    #   api_instance = BlizzardApi::Diablo.profile
+    class Profile < BlizzardApi::Diablo::Request
+      ##
+      # Return an user's profile data with a list of heroes
+      #
+      # @param battletag [String] User's battletag
+      # @param oauth_token [String] A token generated by the OAuth authorization flow. See the link below for more info.
+      # @!macro request_options
+      #
+      # @!macro response
+      #
+      # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
+      def index(battletag, oauth_token, options = {})
+        opts = { access_token: oauth_token, ttl: CACHE_TRIMESTER }.merge(options)
+        api_request "#{base_url(:community)}/data/profile/#{battletag}", opts
+      end
+
+      ##
+      # Return more data about a hero
+      #
+      # @param battletag [String] User's battletag
+      # @param oauth_token [String] A token generated by the OAuth authorization flow. See the link below for more info.
+      # @param hero_id [Integer] Hero id
+      # @!macro request_options
+      #
+      # @!macro response
+      #
+      # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
+      def hero(battletag, oauth_token, hero_id, options = {})
+        opts = { access_token: oauth_token, ttl: CACHE_TRIMESTER }.merge(options)
+        api_request "#{base_url(:community)}/data/profile/#{battletag}/hero/#{hero_id}", opts
+      end
+
+      ##
+      # Return more data about a hero's items
+      #
+      # @param battletag [String] User's battletag
+      # @param oauth_token [String] A token generated by the OAuth authorization flow. See the link below for more info.
+      # @param hero_id [Integer] Hero id
+      # @!macro request_options
+      #
+      # @!macro response
+      #
+      # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
+      def hero_items(battletag, oauth_token, hero_id, options = {})
+        opts = { access_token: oauth_token, ttl: CACHE_TRIMESTER }.merge(options)
+        api_request "#{base_url(:community)}/data/profile/#{battletag}/hero/#{hero_id}/items", opts
+      end
+
+      ##
+      # Return more data about a hero's followers
+      #
+      # @param battletag [String] User's battletag
+      # @param oauth_token [String] A token generated by the OAuth authorization flow. See the link below for more info.
+      # @param hero_id [Integer] Hero id
+      # @!macro request_options
+      #
+      # @!macro response
+      #
+      # @see https://develop.battle.net/documentation/guides/using-oauth/authorization-code-flow
+      def hero_follower_items(battletag, oauth_token, hero_id, options = {})
+        opts = { access_token: oauth_token, ttl: CACHE_TRIMESTER }.merge(options)
+        api_request "#{base_url(:community)}/data/profile/#{battletag}/hero/#{hero_id}/follower-items", opts
+      end
+    end
+  end
+end