bnet_api 0.1.2 → 0.1.3

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZmEwYWMxYWUzNGFkNjhkYmY1NjAyZGJmOTkwZTcxNzczMWE1ZWRiNA==
+    YmZiYWQ0YWIwOWI2MGFkZWZmOWQxZDBmZmM2MWZhNzBmYzMyYzFiNA==
   data.tar.gz: !binary |-
-    ZDBhYTljZjAwYTk3NGQ5NTgyZTIyZjZjMDRiNzliMmZjNjBiNzNkMA==
+    Njc2Y2UwOTcyNWI4N2MyN2I1NWFlNDI2YWE4ZDVkNGM5ZWJlMzljYg==
 SHA512:
   metadata.gz: !binary |-
-    YjU5ZWRhNjRhYmJhZTMwNDUzMjMyZTk4ZTk3MGViYTY1NTJhZWU0ZmVkMDA3
-    ODFkZmZkYjRkZGIyMjg0NDMwOWQ1ZDgwNDYzMjYyZWViYmQ2OTlkZjljMWI1
-    MDc3ZWYzNWNjMzkwMDk0ZjZmY2E5YjAxOTQxYmQ2ZDI0OTQ0ZTY=
+    MjVhOTJmYmU3ODgwZDc1NTY1MTUzMzQyNzRlNDhkYzEwMjQwMjZlYjhhYjBk
+    NDNjYjRhNGU0YmQzMmY4NzE3MTJiOTFlZTkzYjQwNTU4Mzg1OGE4YmMyZDBl
+    NTg3MWM5NDQwNDA4NjA0YjE3MjNhZDI2OGM0MGM4YjU0NjFlMDA=
   data.tar.gz: !binary |-
-    YjM3ZGE3NmRkNTZkYjllN2QzMjU4YjA5OTdmYTJiZDdhMTBjYTQzNmU5MjQx
-    OGVlMjk2ZjE1YWUzZjA0YjhmOGI2ODIzYzEzYTE0MmViNDE2Zjc0YmZlOTY1
-    NmNiNmQwMmRhYjI3ZWNlYjU2ODU5NGIwZmI0ZGU4NmI2Y2YzMDQ=
+    N2ZmNTAyZmFhYmYxYzIwMGQ5NDNkNTRmZTEyMzBhM2YwZTBiYTA1ZWI2OTdh
+    MGIzZTRhZjkxNWNmMjVlN2E4Y2QzNjk0YjU2ZWI2NzM3MzAyOWZjMDRlYmI4
+    MzExNmFhZTcxMWI4MWZmNWRhYzYyZWUzZWZlNzY4MzhhMTZjMjY=

data/README.md

@@ -8,16 +8,55 @@
 
 A Ruby wrapper for the Battle.net API
 
-## Current Version: 0.1.2
+## Current Version: 0.1.3
 
 ### Status
 
         API       | Status
 ------------------|-----------------
 World of Warcraft | Implemented
-Diablo III        | Not implemented
+Diablo III        | Implemented
 Starcraft II      | Not implemented
-OAuth			  | Implemented
+OAuth			        | Implemented
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](http://doctoc.herokuapp.com/)*
+
+- [BnetApi](#bnetapi)
+  - [Current Version: 0.1.3](#current-version-013)
+    - [Status](#status)
+  - [Installation](#installation)
+  - [Configuration](#configuration)
+    - [Regions](#regions)
+    - [Locales](#locales)
+  - [Examples](#examples)
+    - [Achievement API](#achievement-api)
+    - [Auction Data API](#auction-data-api)
+      - [Sample Request](#sample-request)
+      - [Sample Response](#sample-response)
+    - [Battlepet API](#battlepet-api)
+      - [Battlepet Abilities](#battlepet-abilities)
+      - [Battlepet Species](#battlepet-species)
+      - [Battlepet Stats](#battlepet-stats)
+    - [Challenge Mode API](#challenge-mode-api)
+      - [Realm](#realm)
+      - [Region](#region)
+    - [Character Profile API](#character-profile-api)
+    - [Guild API](#guild-api)
+    - [Item API](#item-api)
+    - [PvP API](#pvp-api)
+    - [Quest API](#quest-api)
+    - [Realm Status API](#realm-status-api)
+    - [Recipe API](#recipe-api)
+    - [Spell API](#spell-api)
+    - [OAuth APIs](#oauth-apis)
+      - [Account ID](#account-id)
+      - [Battletag](#battletag)
+      - [Starcraft II Profile](#starcraft-ii-profile)
+      - [World of Warcraft Profile](#world-of-warcraft-profile)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
 
 ## Installation
 
@@ -85,7 +124,7 @@ The Auction Data API returns the URL of a JSON file containing an auction data d
 #### Sample Request
 
 ```ruby
-BnetApi::WoW.auction_data('Thunderhorn')
+BnetApi::WoW.auction_data('REALM')
 ```
 
 #### Sample Response
@@ -146,7 +185,7 @@ BnetApi::WoW.battlepet_stats(258, level: 25, breedId: 5, qualityId: 4)
 To get the challenge mode leaderboard for a realm:
 
 ```ruby
-BnetApi::WoW.challenge_mode_realm('Thunderhorn')
+BnetApi::WoW.challenge_mode_realm('REALM')
 ```
 
 #### Region
@@ -162,19 +201,19 @@ BnetApi::WoW.challenge_mode_region
 To get the basic data for a character:
 
 ```ruby
-BnetApi::WoW.character('Thunderhorn', 'Ragwolf')
+BnetApi::WoW.character('REALM', 'CHARACTER_NAME')
 ```
 
 To get any additional data fields, pass them in as extra symbol values:
 
 ```ruby
-BnetApi::WoW.character('Thunderhorn', 'Ragwolf', :achievements, :quests)
+BnetApi::WoW.character('REALM', 'CHARACTER_NAME', :achievements, :quests)
 ```
 
 To get all additional data fields, pass in :all as the extra parameter:
 
 ```ruby
-BnetApi::WoW.character('Thunderhorn', 'Ragwolf', :all)
+BnetApi::WoW.character('REALM', 'CHARACTER_NAME', :all)
 ```
 
 Available optional fields:
@@ -201,19 +240,19 @@ Available optional fields:
 To get the basic data for a guild:
 
 ```ruby
-BnetApi::WoW.guild('Thunderhorn', 'Banana Revolution')
+BnetApi::WoW.guild('REALM', 'GUILD_NAME')
 ```
 
 To get any additional data fields, pass them in as extra symbol values:
 
 ```ruby
-BnetApi::WoW.guild('Thunderhorn', 'Banana Revolution', :news, :achievements)
+BnetApi::WoW.guild('REALM', 'GUILD_NAME', :news, :achievements)
 ```
 
 To get all additional data fields, pass in :all as the extra parameter:
 
 ```ruby
-BnetApi::WoW.guild('Thunderhorn', 'Banana Revolution', :all)
+BnetApi::WoW.guild('REALM', 'GUILD_NAME', :all)
 ```
 
 Available optional fields:
@@ -283,3 +322,39 @@ To get the data for a spell:
 ```ruby
 BnetApi::WoW.spell(8056)
 ```
+
+### OAuth APIs
+
+This library isn't concerned with the OAuth authentication, just retrieving data from the API.
+
+You can use the [OmniAuth Bnet](https://github.com/Blizzard/omniauth-bnet) or any other OAuth library to authenticate against the Battle.net OAuth service, and then just pass the user's OAuth Access Token to the OAuth API methods.
+
+#### Account ID
+
+To get the user's account ID:
+
+```ruby
+BnetApi::OAuth.account_id('ACCESS_TOKEN')
+```
+
+#### Battletag
+
+To get the user's battletag:
+
+```ruby
+BnetApi::OAuth.battletag('ACCESS_TOKEN')
+```
+
+#### Starcraft II Profile
+
+To get the user's Starcraft II profile:
+
+```ruby
+BnetApi::OAuth.sc2_profile('ACCESS_TOKEN')
+```
+
+#### World of Warcraft Profile
+
+```ruby
+BnetApi::OAuth.wow_profile('ACCESS_TOKEN')
+```

data/lib/bnet_api/d3.rb

@@ -0,0 +1,27 @@
+require 'uri'
+
+module BnetApi
+  module D3
+    extend self
+
+    def career_profile(battletag)
+      BnetApi.make_request("/d3/profile/#{URI.encode(battletag)}/")
+    end
+
+    def hero_profile(battletag, id)
+      BnetApi.make_request("/d3/profile/#{URI.encode(battletag)}/hero/#{id}")
+    end
+
+    def item_data(data)
+      BnetApi.make_request("/d3/data/item/#{data}")
+    end
+
+    def follower_data(follower)
+      BnetApi.make_request("/d3/data/follower/#{follower}")
+    end
+
+    def artisan_data(artisan)
+      BnetApi.make_request("/d3/data/artisan/#{artisan}")
+    end
+  end
+end

data/lib/bnet_api/version.rb

@@ -1,3 +1,3 @@
 module BnetApi
-	VERSION = '0.1.2'
+	VERSION = '0.1.3'
 end

data/lib/bnet_api.rb

@@ -1,3 +1,4 @@
+require 'bnet_api/d3'
 require 'bnet_api/oauth'
 require 'bnet_api/wow'
 require 'bnet_api/wow_data'
@@ -19,13 +20,7 @@ module BnetApi
   end
 
   def make_request(request, *optional_fields)
-    response = self.get("https://#{@config.region}.api.battle.net/#{request}#{build_url_params(optional_fields)}")
-    if response["class"] != nil
-      response["classId"] = response["class"]
-      response.delete("class")
-    end
-    
-    return response
+    self.get("https://#{@config.region}.api.battle.net/#{request}#{build_url_params(optional_fields)}")
   end
 
   def make_request_with_params(request, params)
@@ -35,13 +30,7 @@ module BnetApi
     end
     url += "locale=#{@config.locale}&apikey=#{@config.api_key}"
 
-    response = self.get(url)
-    if response["class"] != nil
-      response["classId"] = response["class"]
-      response.delete("class")
-    end
-
-    return response
+    self.get(url)
   end
 
   def make_request_oauth(request, access_token)

data/spec/bnet_api/d3_spec.rb

@@ -0,0 +1,92 @@
+require 'spec_helper'
+
+describe BnetApi::D3 do
+
+  before :each do
+    BnetApi.configure do |config|
+      config.api_key = ENV['BNET_ID']
+      config.api_secret = ENV['BNET_SECRET']
+    end
+  end
+
+  it "gets a career profile from the API" do
+    profile = BnetApi::D3.career_profile('Ragwolf#2851')
+
+    expect(profile['battleTag']).to eq 'Ragwolf#2851'
+    expect(profile['heroes']).not_to be_nil
+  end
+
+  it "gets a hero profile from the API" do
+    profile = BnetApi::D3.hero_profile('Ragwolf#2851', 47516365)
+
+    expect(profile['name']).to eq 'Ragwolf'
+    expect(profile['class']).to eq 'demon-hunter'
+    expect(profile['skills']).not_to be_nil
+  end
+
+  it "gets the data for an item from the API" do
+    item = BnetApi::D3.item_data('Co4BCJbokeUHEgcIBBV_-U5dHcj6vKAdjs3dnR2dB5UkHSCd5AQd6XAvux3DDZzlIgsIARW1RAMAGAogJjCLAjjqA0AASBNQEFgEYOwEaisKDAgAEMPSgK2BgIDAEhIbCJ7JnZUJEgcIBBUVn9irMIsCOABAAVgEkAEBpQEgneQErQFmIwZQuAHSiJmSBcABBhj-5ffUC1AAWAI')
+
+    expect(item['id']).to eq 'Helm_208'
+    expect(item['name']).to eq 'Prime Shelter'
+    expect(item['icon']).to eq 'helm_208_demonhunter_male'
+    expect(item['displayColor']).to eq 'yellow'
+  end
+
+  it "gets the data for the templar follower from the API" do
+    follower = BnetApi::D3.follower_data('templar')
+
+    expect(follower['slug']).to eq 'templar'
+    expect(follower['name']).to eq 'Templar'
+    expect(follower['realName']).to eq 'd3.follower.templar.realName'
+    expect(follower['portrait']).to eq 'templar'
+    expect(follower['skills']).not_to be_nil
+  end
+
+  it "gets the data for the enchantress follower from the API" do
+    follower = BnetApi::D3.follower_data('enchantress')
+
+    expect(follower['slug']).to eq 'enchantress'
+    expect(follower['name']).to eq 'Enchantress'
+    expect(follower['realName']).to eq 'd3.follower.enchantress.realName'
+    expect(follower['portrait']).to eq 'enchantress'
+    expect(follower['skills']).not_to be_nil
+  end
+
+  it "gets the data for the scoundrel follower from the API" do
+    follower = BnetApi::D3.follower_data('scoundrel')
+
+    expect(follower['slug']).to eq 'scoundrel'
+    expect(follower['name']).to eq 'Scoundrel'
+    expect(follower['realName']).to eq 'd3.follower.scoundrel.realName'
+    expect(follower['portrait']).to eq 'scoundrel'
+    expect(follower['skills']).not_to be_nil
+  end
+
+  it "gets the data for the blacksmith artisan from the API" do
+    artisan = BnetApi::D3.artisan_data('blacksmith')
+
+    expect(artisan['slug']).to eq 'blacksmith'
+    expect(artisan['name']).to eq 'Blacksmith'
+    expect(artisan['portrait']).to eq 'pt_blacksmith'
+    expect(artisan['training']).not_to be_nil
+  end
+
+  it "gets the data for the jeweler artisan from the API" do
+    artisan = BnetApi::D3.artisan_data('jeweler')
+
+    expect(artisan['slug']).to eq 'jeweler'
+    expect(artisan['name']).to eq 'Jeweler'
+    expect(artisan['portrait']).to eq 'pt_jeweler'
+    expect(artisan['training']).not_to be_nil
+  end
+
+  it "gets the data for the mystic artisan from the API" do
+    artisan = BnetApi::D3.artisan_data('mystic')
+
+    expect(artisan['slug']).to eq 'mystic'
+    expect(artisan['name']).to eq 'Mystic'
+    expect(artisan['portrait']).to eq 'pt_mystic'
+    expect(artisan['training']).not_to be_nil
+  end
+end

data/spec/bnet_api/wow/wow_character_spec.rb

@@ -18,7 +18,7 @@ describe BnetApi::WoW do
     expect(character['name']).to eq('Ragwolf')
     expect(character['realm']).to eq('Thunderhorn')
     expect(character['battlegroup']).to eq('Misery')
-    expect(character['classId']).to eq(8)
+    expect(character['class']).to eq(8)
     expect(character['race']).to eq(5)
     expect(character['gender']).to eq(1)
     expect(character['level']).to eq(100)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bnet_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Tom Connolly
@@ -70,11 +70,13 @@ files:
 - Rakefile
 - bnet_api.gemspec
 - lib/bnet_api.rb
+- lib/bnet_api/d3.rb
 - lib/bnet_api/oauth.rb
 - lib/bnet_api/version.rb
 - lib/bnet_api/wow.rb
 - lib/bnet_api/wow_data.rb
 - spec/bnet_api/bnet_api_spec.rb
+- spec/bnet_api/d3_spec.rb
 - spec/bnet_api/oauth_spec.rb
 - spec/bnet_api/wow/wow_achievement_spec.rb
 - spec/bnet_api/wow/wow_auction_data_spec.rb
@@ -116,6 +118,7 @@ specification_version: 4
 summary: Ruby wrapper for the Battle.net web API.
 test_files:
 - spec/bnet_api/bnet_api_spec.rb
+- spec/bnet_api/d3_spec.rb
 - spec/bnet_api/oauth_spec.rb
 - spec/bnet_api/wow/wow_achievement_spec.rb
 - spec/bnet_api/wow/wow_auction_data_spec.rb