bnet_api 0.1.4 → 0.1.5

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NTVkN2Y3N2RhNjUzYTBmYjJkNzRjYzEyODc3Nzg0ZjYxZmQyZDE3Yg==
+    NjEwNzFmMzlkNTRhZDAwMzYwMjU3MTI4NmNlYmM2OTg2YTBmMDAyZg==
   data.tar.gz: !binary |-
-    M2VmMDM2ZmNlMmExODE5MDdlNGFhYTczYzc5Zjg2MDEyNjg1NjdlMQ==
+    Njg1Y2JiNmJmMmU2ODk5ZjNkZmZjYmVkODk1ZGI5MzM3MzljNGJjZg==
 SHA512:
   metadata.gz: !binary |-
-    MGYyMGYwZDRjYTkzZGVkNTE2ZmJmMTNjOGM1N2YxZTE0ZmRjN2ZiZmIyYzE1
-    ZGU5NWY2ZWNlZWI5ZDIzOTI4MDkxZTZhNDQ0ZTUxMjkwMmU1ZGY3MDk3NTNm
-    OWE5OGU4OTIxNmNlZWViNTE0YTFlOWQ5YzA1NTEzZDAwNTA3NDU=
+    Y2VhNzgzZDcyODk3YWY2NGRhNDQ4ZDBkNmI4MTg5MjYyNTE2MGJmZWFmN2Uw
+    OGY0OTdkN2Y0NjkwZmI4ZmJjNjgzMTg3ZTBjMzIxZDZmMGY3OGY5NDZhZmE1
+    OWRmZmQ4MjhiNDI5MTYzOTAxMmUxNDA5NzRjNWFkMjJjYmJiNjI=
   data.tar.gz: !binary |-
-    YTc2MDc1M2U0MzAxMDAwMDA4MTk3NmM5NjBkYzgyY2VmNjBkNTU3YTI4M2Rh
-    MDNiZDE1YjViODZhMWI4YzgwZjJlNzI2ZjIzOWUxMzYzOGE3OGU0YWNhMjVm
-    YTYxNzU0OWQwZGQzOGYzNjAyMGZmNTE4NWIwZjE3MmViMzIzNTU=
+    Y2IzYTM4MjRjYjM0MmM2ODlkMWM5M2ZhNWI4NmY0YzE5NjM4OTU3Mjc0NzY0
+    ZGJmMjFjMGM2ODBkZjU5ZjM4NDI4NzhhMTY5MDk4NjI2MTViZjhmYmZkN2Qw
+    Y2VmMjY0MmQ2Y2EwY2U3NzczZWEyYjgzYjUxYjczMDU4ODY4Nzc=

data/.gitignore

@@ -1,2 +1,5 @@
-/coverage
-*.gem
+*.gem
+.yardoc
+Gemfile.lock
+coverage/*
+doc/*

data/.travis.yml

@@ -6,6 +6,7 @@ rvm:
   - 2.1
   - jruby-19mode
   - jruby-head
+  - rbx-2
   - ruby-head
 
 sudo: false

data/.yardopts

@@ -0,0 +1,7 @@
+--no-private
+--protected
+--markup markdown
+-
+CHANGELOG.md
+LICENSE.md
+README.md

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 0.1.4
+
+* Added Starcraft II APIs
+
 # 0.1.3
 
 * Added Diablo III APIs

data/README.md

@@ -8,8 +8,6 @@
 
 A Ruby wrapper for the Battle.net API.
 
-## Current Version: 0.1.4
-
 ## Installation
 
 	gem install bnet_api

data/lib/bnet_api/d3.rb

@@ -1,25 +1,48 @@
 require 'uri'
 
 module BnetApi
+  # All API methods relating to Diablo III are contained in this module.
   module D3
     extend self
 
+    # Retrieves the career profile for the user with the specified battletag.
+    #
+    # @param battletag [String] The battletag of the user profile.
+    # @return [Hash] A hash containing the career profile data.
     def career_profile(battletag)
       BnetApi.make_request("/d3/profile/#{URI.encode(battletag)}/")
     end
 
+    # Retrieves the hero profile for the hero with the specified ID belonging
+    # to the user with the specified battletag.
+    #
+    # @param battletag [String] The battletag of the user profile.
+    # @param id [Integer] The ID of the hero.
+    # @return [Hash] A hash containing the hero profile data.
     def hero_profile(battletag, id)
       BnetApi.make_request("/d3/profile/#{URI.encode(battletag)}/hero/#{id}")
     end
 
+    # Retrieves the data for an item with the specified item data string.
+    #
+    # @param data [String] The item data string of the item.
+    # @return [Hash] A hash containing the item data.
     def item_data(data)
       BnetApi.make_request("/d3/data/item/#{data}")
     end
 
+    # Retrieves the data for the specified follower.
+    #
+    # @param follower [String] The name of the follower.
+    # @return [Hash] A hash containing the follower data.
     def follower_data(follower)
       BnetApi.make_request("/d3/data/follower/#{follower}")
     end
 
+    # Retrieves the data for the specified artisan.
+    #
+    # @param artisan [String] The name of the artisan.
+    # @return [Hash] A hash containing the artisan data.
     def artisan_data(artisan)
       BnetApi.make_request("/d3/data/artisan/#{artisan}")
     end

data/lib/bnet_api/oauth.rb

@@ -1,19 +1,36 @@
 module BnetApi
+  # All API methods requiring OAuth authentication are contained in this module.
   module OAuth
     extend self
 
+    # Retrieves the account ID number for the user with the specified access token.
+    #
+    # @param access_token [String] The user's OAuth access token.
+    # @return [Hash] A hash containing the user's account ID.
     def account_id(access_token)
       BnetApi.make_request_oauth('/account/user/id', access_token)
     end
 
+    # Retrieves the battletag for the user with the specified access token.
+    #
+    # @param access_token [String] The user's OAuth access token.
+    # @return [Hash] A hash containing the user's battletag.
     def battletag(access_token)
       BnetApi.make_request_oauth('/account/user/battletag', access_token)
     end
 
+    # Retrieves the Starcraft II profile for the user with the specified access token.
+    #
+    # @param access_token [String] The user's OAuth access token.
+    # @return [Hash] A hash containing the user's Starcraft II profile data.
     def sc2_profile(access_token)
       BnetApi.make_request_oauth('/sc2/profile/user', access_token)
     end
 
+    # Retrieves the World of Warcraft profile for the user with the specified access token.
+    #
+    # @param access_token [String] The user's OAuth access token.
+    # @return [Hash] A hash containing the user's World of Warcraft profile data.
     def wow_profile(access_token)
       BnetApi.make_request_oauth('/wow/user/characters', access_token)
     end

data/lib/bnet_api/sc2.rb

@@ -1,29 +1,56 @@
 require 'uri'
 
 module BnetApi
+  # All API methods relating to Starcraft II are contained in this module.
   module SC2
     extend self
 
+    # Retrieves the profile for specified user.
+    #
+    # @param id [Integer] The user's profile ID.
+    # @param region [Integer] The region the user is in.
+    # @param name [String] The name of the user's profile.
+    # @return [Hash] A hash containing the profile data.
     def profile(id, region, name)
       BnetApi.make_request("/sc2/profile/#{id}/#{region}/#{name}/")
     end
 
+    # Retrieves the ladders a profile is in.
+    #
+    # @param id [Integer] The user's profile ID.
+    # @param region [Integer] The region the user is in.
+    # @param name [String] The name of the user's profile.
+    # @return [Hash] A hash containing the profile's ladder data.
     def profile_ladders(id, region, name)
       BnetApi.make_request("/sc2/profile/#{id}/#{region}/#{name}/ladders")
     end
 
+    # Retrieves the match history for the specified profile.
+    #
+    # @param id [Integer] The user's profile ID.
+    # @param region [Integer] The region the user is in.
+    # @param name [String] The name of the user's profile.
+    # @return [Hash] A hash containing the profile's match history data.
     def match_history(id, region, name)
       BnetApi.make_request("/sc2/profile/#{id}/#{region}/#{name}/matches")
     end
 
+    # Retrieves the ladder data for the ladder with the specified ID.
+    #
+    # @param id [String] The ID of the ladder.
+    # @return [Hash] A hash containing the ladder data.
     def ladder(id)
       BnetApi.make_request("/sc2/ladder/#{id}")
     end
 
+    # Retrieves all achievements data.
+    # @return [Hash] A hash containing the achievements data.
     def achievements_data
       BnetApi.make_request('/sc2/data/achievements')
     end
 
+    # Retrieves all rewards data.
+    # @return [Hash] A hash containing the rewards data.
     def rewards_data
       BnetApi.make_request('/sc2/data/rewards')
     end

data/lib/bnet_api/version.rb

@@ -1,3 +1,3 @@
 module BnetApi
-	VERSION = '0.1.4'
+	VERSION = '0.1.5'
 end

data/lib/bnet_api/wow.rb

@@ -1,25 +1,50 @@
 require 'uri'
 
 module BnetApi
+  # All API methods relating to World of Warcraft are contained in this module.
   module WoW
     extend self
 
+    # Retrieves the achievement with the specified ID.
+    #
+    # @param id [Integer] The ID of the achievement.
+    # @return [Hash] A hash containing the achievement data.
     def achievement(id)
       BnetApi.make_request("/wow/achievement/#{id}")
     end
 
+    # Retrieves the URL of a JSON file containing the most recent auction data dump.
+    #
+    # @param realm [String] The realm to retrieve auction data for.
+    # @return [Hash] A hash containing the URL of the auction data file.
     def auction_data(realm)
       BnetApi.make_request("/wow/auction/data/#{realm}")
     end
 
+    # Retrieves the battlepet ability with the specified ID.
+    #
+    # @param id [Integer] The ID of the ability.
+    # @return [Hash] A hash containing the ability data.
     def battlepet_ability(id)
       BnetApi.make_request("/wow/battlePet/ability/#{id}")
     end
 
+    # Retrieves the battlepet species with the specified ID.
+    #
+    # @param id [Integer] The ID of the species.
+    # @return [Hash] A hash containing the species data.
     def battlepet_species(id)
       BnetApi.make_request("/wow/battlePet/species/#{id}")
     end
 
+    # Retrieves the stats for the battlepet with the specified ID.
+    #
+    # @param species_id [Integer] The ID of the battlepet species.
+    # @param options [Hash] Any additional options.
+    # @option options [Integer] :level The level of the species.
+    # @option options [Integer] :breedId The ID of the breed.
+    # @option options [Integer] :qualityId The quality of the battlepet.
+    # @return [Hash] A hash containing the battlepet stats data.
     def battlepet_stats(species_id, options = {})
       level = options[:level] || 1
       breedId = options[:breedId] || 3
@@ -33,14 +58,27 @@ module BnetApi
       )
     end
 
+    # Retrieves the challenge mode leaderboard for the specified realm.
+    #
+    # @param realm [String] The realm to retrieve the leaderboard for.
+    # @return [Hash] A hash containing the leaderboard data.
     def challenge_mode_realm(realm)
       BnetApi.make_request("/wow/challenge/#{realm}")
     end
 
+    # Retrieves the challenge mode leaderboard for the current API region.
+    #
+    # @return [Hash] A hash containing the leaderboard data.
     def challenge_mode_region
       BnetApi.make_request('/wow/challenge/region')
     end
 
+    # Retrieves the character with the specified name on the specified realm.
+    #
+    # @param realm [String] The realm the character is on.
+    # @param name [String] The name of the character.
+    # @param *optional_fields [Array<Symbol>] Any optional fields to retrieve data for.
+    # @return [Hash] A hash containing the character data.
     def character(realm, name, *optional_fields)
       if optional_fields[0] == :all
         optional_fields = :achievements, :appearance, :feed, :guild, :items, :mounts, :pets, :petSlots, :progression, :pvp, :quests, :reputation, :stats, :talents, :titles, :audit
@@ -48,14 +86,28 @@ module BnetApi
       BnetApi.make_request("/wow/character/#{URI.escape(realm)}/#{URI.escape(name)}", optional_fields)
     end
 
+    # Retrieves the item with the specified ID.
+    #
+    # @param id [Integer] The ID of the item.
+    # @return [Hash] A hash containing the item data.
     def item(id)
       BnetApi.make_request("/wow/item/#{id}")
     end
 
+    # Retrieves the item set with the specified ID.
+    #
+    # @param id [Integer] The ID of the item set.
+    # @return [Hash] A hash containing the item set data.
     def item_set(id)
       BnetApi.make_request("/wow/item/set/#{id}")
     end
 
+    # Retrieves the guild with the specified name on the specified realm.
+    #
+    # @param realm [String] The realm the guild is on.
+    # @param name [String] The name of the guild.
+    # @param *optional_fields[Array<Symbol>] Any optional fields to retrieve data for.
+    # @return [Hash] A hash containing the guild data.
     def guild(realm, name, *optional_fields)
       if optional_fields[0] == :all
         optional_fields = :members, :achievements, :news, :challenge
@@ -63,14 +115,27 @@ module BnetApi
       BnetApi.make_request("/wow/guild/#{URI.escape(realm)}/#{URI.escape(name)}", optional_fields)
     end
 
+    # Retrieves the PvP leaderboard for the specified bracket.
+    #
+    # @param bracket [String] The PvP bracket to retrieve data for.
+    # @return [Hash] A hash containing the leaderboard data.
     def pvp(bracket)
       BnetApi.make_request("/wow/leaderboard/#{bracket}")
     end
 
+    # Retrieves the quest with the specified ID.
+    #
+    # @param id [Integer] The ID of the quest.
+    # @return [Hash] A hash containing the quest data.
     def quest(id)
       BnetApi.make_request("/wow/quest/#{id}")
     end
 
+    # Retrieves the realm status for the region. If any realms are specified as parameters,
+    # only the status of these realms will be returned.
+    #
+    # @param *realms [Array<String>] Any realms to restrict the data to.
+    # @return [Hash] A hash containing the realm status data.
     def realm_status(*realms)
       if realms.count > 0
         BnetApi.make_request_with_params("/wow/realm/status", { realms: realms.join(',') })
@@ -79,10 +144,18 @@ module BnetApi
       end
     end
 
+    # Retrieves the recipe with the specified ID.
+    #
+    # @param id [Integer] The ID of the recipe.
+    # @return [Hash] A hash containing the recipe data.
     def recipe(id)
       BnetApi.make_request("/wow/recipe/#{id}")
     end
 
+    # Retrieves the spell with the specified ID.
+    #
+    # @param id [Integer] The ID of the spell.
+    # @return [Hash] A hash containing the spell data.
     def spell(id)
       BnetApi.make_request("/wow/spell/#{id}")
     end

data/lib/bnet_api/wow_data.rb

@@ -1,44 +1,75 @@
 module BnetApi
   module WoW
+    # All API methods relating to World of Warcraft Data are contained in this module.
     module Data
       extend self
 
+      # Retrieves all battlegroups for the region.
+      #
+      # @return [Hash] A hash containing the battlegroups.
       def battlegroups
         BnetApi::make_request('/wow/data/battlegroups/')
       end
 
+      # Retrieves all character races.
+      #
+      # @return [Hash] A hash containing the character races.
       def character_races
         BnetApi::make_request('/wow/data/character/races')
       end
 
+      # Retrieves all character classes.
+      #
+      # @return [Hash] A hash containing the character classes.
       def character_classes
         BnetApi::make_request('/wow/data/character/classes')
       end
 
+      # Retrieves all character achievements.
+      #
+      # @return [Hash] A hash containing the character achievements.
       def character_achievements
         BnetApi::make_request('/wow/data/character/achievements')
       end
 
+      # Retrieves all guild rewards.
+      #
+      # @return [Hash] A hash containing the guild rewards.
       def guild_rewards
         BnetApi::make_request('/wow/data/guild/rewards')
       end
 
+      # Retrieves all guild perks.
+      #
+      # @return [Hash] A hash containing the guild perks.
       def guild_perks
         BnetApi::make_request('/wow/data/guild/perks')
       end
 
+      # Retrieves all guild achievements.
+      #
+      # @return [Hash] A hash containing the guild achievements.
       def guild_achievements
         BnetApi::make_request('/wow/data/guild/achievements')
       end
 
+      # Retrieves all item classes.
+      #
+      # @return [Hash] A hash containing the item classes.
       def item_classes
         BnetApi::make_request('/wow/data/item/classes')
       end
 
+      # Retrieves all talents.
+      #
+      # @return [Hash] A hash containing the talents.
       def talents
         BnetApi::make_request('/wow/data/talents')
       end
 
+      # Retrieves all pet types.
+      #
+      # @return [Hash] A hash containing the pet types.
       def pet_types
         BnetApi::make_request('/wow/data/pet/types')
       end

data/lib/bnet_api.rb

@@ -8,22 +8,36 @@ require 'bnet_api/version'
 require 'httparty'
 require 'ostruct'
 
+# The base module namespace for the BnetApi library.
 module BnetApi
   extend self
   include HTTParty
 
+  # Yields the API configuration object.
   def configure
     yield config
   end
 
+  # Sets up the configuration of the API.
   def config
     @config ||= OpenStruct.new(region: :eu, locale: :en_GB)
   end
 
+  # Sends a HTTPS GET request to the Battle.net API and returns the retrieved data in a hash.
+  #
+  # @param request [String] The API endpoint to request.
+  # @param *optional_fields[Array<Symbol>] Any optional fields to be requested from the API.
+  # @return [Hash] A hash of the data returned from the API.
   def make_request(request, *optional_fields)
     self.get("https://#{@config.region}.api.battle.net/#{request}#{build_url_params(optional_fields)}")
   end
 
+  # Sends a HTTPS GET request to the Battle.net API with some additional URL parameters
+  # and returns the retrieved data in a hash.
+  #
+  # @param request [String] The API endpoint to request.
+  # @param params [Hash] A hash containing key/value pairs of URL parameters.
+  # @return [Hash] A hash of the data returned from the API.
   def make_request_with_params(request, params)
     url = "https://#{@config.region}.api.battle.net/#{request}?"
     params.each do |k, v|
@@ -34,11 +48,21 @@ module BnetApi
     self.get(url)
   end
 
+  # Sends a HTTPS GET request to the Battle.net API using OAuth instead of API key authentication
+  # and returns the retrieved data in a hash.
+  #
+  # @param request [String] The API endpoint to request.
+  # @param access_token [String] The user's OAuth access token.
+  # @return [Hash] A hash of the data returned from the API.
   def make_request_oauth(request, access_token)
     self.get("https://#{@config.region}.api.battle.net/#{request}?locale=#{@config.locale}&access_token=#{access_token}")
   end
 
   private
+    # Builds the URL parameters for the make_request method.
+    #
+    # @params *optional_fields [Array<Symbol>] Any optional fields to put in the URL.
+    # @return [String] The URL parameters for the request.
     def build_url_params(*optional_fields)
       url_params = "?locale=#{@config.locale}&apikey=#{@config.api_key}"
       if optional_fields != nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bnet_api
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Tom Connolly
@@ -62,9 +62,9 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- .yardopts
 - CHANGELOG.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.md
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,59 +0,0 @@
-PATH
-  remote: .
-  specs:
-    bnet_api (0.1.3)
-      httparty (= 0.13.3)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coveralls (0.7.2)
-      multi_json (~> 1.3)
-      rest-client (= 1.6.7)
-      simplecov (>= 0.7)
-      term-ansicolor (= 1.2.2)
-      thor (= 0.18.1)
-    diff-lcs (1.2.5)
-    docile (1.1.5)
-    httparty (0.13.3)
-      json (~> 1.8)
-      multi_xml (>= 0.5.2)
-    json (1.8.1)
-    mime-types (2.4.3)
-    multi_json (1.10.1)
-    multi_xml (0.5.5)
-    rake (10.4.2)
-    rest-client (1.6.7)
-      mime-types (>= 1.16)
-    rspec (3.1.0)
-      rspec-core (~> 3.1.0)
-      rspec-expectations (~> 3.1.0)
-      rspec-mocks (~> 3.1.0)
-    rspec-core (3.1.7)
-      rspec-support (~> 3.1.0)
-    rspec-expectations (3.1.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.1.0)
-    rspec-mocks (3.1.3)
-      rspec-support (~> 3.1.0)
-    rspec-support (3.1.2)
-    simplecov (0.9.1)
-      docile (~> 1.1.0)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.8.0)
-    simplecov-html (0.8.0)
-    term-ansicolor (1.2.2)
-      tins (~> 0.8)
-    thor (0.18.1)
-    tins (0.13.2)
-
-PLATFORMS
-  x64-mingw32
-  x86-mingw32
-
-DEPENDENCIES
-  bnet_api!
-  bundler
-  coveralls
-  rake
-  rspec (>= 2.14)