battlenet-api 0.3.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9abf4010781883ec5d265c7c5afc9800b6d9687c
-  data.tar.gz: 774f81c62b4c50d3604553ab75ea8587d5a1d348
+  metadata.gz: c7ae9075e2ca3a2e42b93143d7c97f3676250def
+  data.tar.gz: 16f7e1fdf7f6eaac2e0d3dda5ad7529a793c7fde
 SHA512:
-  metadata.gz: f23d179f18eee8a09c681c9adb6a0293d52ef111ef0922306522013f3a9f0f225238376cb5523020c6286e29f8af924b3f026469d2bc215241859727f8e79cf0
-  data.tar.gz: 8bd5eaca8a678377abfbc4034b0c8f364c0fc1bb2a5bf4ec41130533b41998e8c9d00805d1a521e8990135b5118dcd8985ad63930494d3fe5df219a11e34e76a
+  metadata.gz: 5466d77ea061d7b5ddc5a9a2b0de7f7d3614e1cf1178cf7d28a8de73928554e5fd19084364e2bf719307a0cd7f93506097885f9dda678049377e0dbbfd6eec00
+  data.tar.gz: e5348c9e830d6173c460569e4bace47d8ae30c855758b28ce30a8d44aba803cf68c360706a970da1d56c419d8c295cf31b1b7c8b500bf40163413f709c3528d1

data/README.md

@@ -21,13 +21,13 @@ end
 ````ruby
 client = Battlenet.WOWClient
 
-achievement = client.achievement({:achievement => 'achievement_id'})
-auction_data = client.auction({:realm => 'realm'})
-character = client.character({:realm => 'realm', :character_name => 'character_name'})
+achievement = client.achievement({achievement: 'achievement_id'})
+auction_data = client.auction({realm: 'realm_id'})
+character = client.character({realm: 'realm_id', character_name: 'character_name'})
 
 # TODO: character methods
 
-guild = client.guild({:realm => 'realm', :guild_name => 'guild_name'})
+guild = client.guild({realm: 'realm', guild_name: 'guild_name'})
 
 # TODO: guild methods
 
@@ -35,22 +35,22 @@ data = client.data
 
 # TODO: data methods
 
-item = client.item({:item => 'item_id'})
+item = data.item({item: 'item_id'})
 puts item.details
 
-item = client.item_set({:item_set => 'item_set_id'})
+item = data.item_set({item_set: 'item_set_id'})
 puts item.details
 
-pvp_leaderboards = client.pvp_leaderboards({:bracket => 'bracket'})
+pvp_leaderboards = data.pvp_leaderboards({bracket: 'bracket'})
 puts pvp_leaderboards.details
 
-quest = client.quest({:quest => 'quest_id'})
+quest = data.quest({quest: 'quest_id'})
 puts quest.details
 
-recipe = client.recipe({:recipe => 'recipe_id'})
+recipe = data.recipe({recipe: 'recipe_id'})
 puts recipe.details
 
-spell = client.spell({:spell => 'spell_id'})
+spell = data.spell({spell: 'spell_id'})
 puts spell.details
 
 ````
@@ -61,13 +61,15 @@ puts spell.details
 client = Battlenet.D3Client
 
 #Available Methods
+data = client.data
 
-client.data_item(data_id)
-client.data_follower(follower_id)
-client.data_artisan(artisan_id)
+item = data.item({item: 'item_id'})
+follower = data.follower({follower: 'follower_id'})
+artisan = data.artisan({artisan: 'artisan_id'})
 
-client.career_profile(battletag)
-client.hero_profile(battletag,hero_id)
+profile = client.profile({battletag: 'battletag'})
+puts profile.career
+puts profile.hero(hero_id)
 ````
 
 ### Starcraft 2 Client
@@ -76,15 +78,18 @@ client.hero_profile(battletag,hero_id)
 client = Battlenet.S2Client
 
 #Available Methods
+data = client.data
 
-client.achievements
-client.rewards
+achievements = data.achievements
+rewards = data.rewards
 
-client.ladder(ladder_id)
+ladder = client.ladder({ladder_id: 'ladder_id'})
+puts ladder.details
 
-client.profile(id, region, name)
-client.profile_ladders(id, region, name)
-client.profile_match_history(id, region, name)
+profile = client.profile({id: 'id', region: 'region', name: 'name'})
+puts profile.details
+puts profile.ladders
+puts profile.match_history
 ````
 
 
@@ -92,6 +97,3 @@ client.profile_match_history(id, region, name)
 
 - Community OAuth Profile APIs
 - Account APIs
-- Unit Tests for All APIs
-
-- Refactor Client Code to Utilize OpenStruct on JSON Responses

data/lib/battlenet/api/d3_client.rb

@@ -1,6 +1,7 @@
-require File.expand_path('../client', __FILE__)
+require 'battlenet/api/client'
 
-Dir[File.expand_path('../../modules/d3/*.rb', __FILE__)].each{|f| require f}
+require 'battlenet/modules/d3/profile'
+require 'battlenet/modules/d3/data'
 
 module Battlenet
 
@@ -15,6 +16,14 @@ module Battlenet
       super(client_settings)
     end
 
+    def profile(options = {})
+      merge_options_and_return_obj(options, Battlenet::D3::Profile)
+    end
+
+    def data(options = {})
+      merge_options_and_return_obj(options, Battlenet::D3::Data)
+    end
+
   end
 
 end

data/lib/battlenet/api/sc2_client.rb

@@ -17,6 +17,18 @@ module Battlenet
       super(client_settings)
     end
 
+    def data(options = {})
+      merge_options_and_return_obj(options, Battlenet::SC2::Data)
+    end
+
+    def ladder(options = {})
+      merge_options_and_return_obj(options, Battlenet::SC2::Ladder)
+    end
+
+    def profile(options = {})
+      merge_options_and_return_obj(options, Battlenet::SC2::Profile)
+    end
+
   end
 
 end

data/lib/battlenet/api/version.rb

@@ -1,5 +1,5 @@
 module Battlenet
   module Api
-    VERSION = "0.3.2"
+    VERSION = "1.0.0"
   end
 end

data/lib/battlenet/modules/d3/data.rb

@@ -2,22 +2,22 @@ require 'uri'
 
 module Battlenet
   module D3
-    def data_item(data, options = {})
-      data = URI.escape data
+    class Data < Battlenet::APIResponse
+      def initialize(options={})
+        super(options)
+      end
 
-      get "/data/item/#{data}", options
-    end
-
-    def data_follower(follower, options = {})
-      follower = URI.escape follower
-
-      get "/data/follower/#{follower}", options
-    end
+      def item(item, options = {})
+        get_data("/data/item/#{item}", options)
+      end
 
-    def data_artisan(artisan, options = {})
-      artisan = URI.escape artisan
+      def follower(follower, options = {})
+        get_data("/data/follower/#{follower}", options)
+      end
 
-      get "/data/artisan/#{artisan}", options
+      def artisan(artisan, options = {})
+        get_data("/data/artiasn/#{artisan}", options)
+      end
     end
   end
-end
+end

data/lib/battlenet/modules/d3/profile.rb

@@ -2,17 +2,18 @@ require 'uri'
 
 module Battlenet
   module D3
-    def career_profile(battletag, options = {})
-      battletag = URI.escape battletag
+    class Profile < Battlenet::APIResponse
+      def initialize(options={})
+        super(options)
+      end
 
-      get "/profile/#{battletag}", options
-    end
-
-    def hero_profile(battletag, id, options = {})
-      battletag = URI.escape battletag
-      id = URI.escape id
+      def career(battletag, options = {})
+        get_data("/profile/#{battletag}", options)
+      end
 
-      get "/profile/#{battletag}/hero/#{id}", options
+      def hero(battletag, hero_id, options = {})
+        get_data("/profile/#{battletag}/hero/#{hero_id}", options)
+      end
     end
   end
-end
+end

data/lib/battlenet/modules/sc2/data.rb

@@ -2,12 +2,19 @@ require 'uri'
 
 module Battlenet
   module SC2
-    def achievements(options = {})
-      get "/data/achievements", options
-    end
+    class Data < Battlenet::APIResponse
+      def initialize(options={})
+        super(options)
+      end
+
+      def achievements(options = {})
+        get_data("/data/achievements", options)
+      end
+
+      def rewards(options = {})
+        get_data("/data/rewards", options)
+      end
 
-    def rewards(options = {})
-      get "/data/rewards", options
     end
   end
-end
+end

data/lib/battlenet/modules/sc2/ladder.rb

@@ -2,10 +2,18 @@ require 'uri'
 
 module Battlenet
   module SC2
-    def ladder(id, options = {})
-      id = URI.escape id
+    class Ladder < Battlenet::APIResponse
+      def initialize(options={})
+        @ladder_id      = options.delete(:ladder_id)
+        @endpoint       = "/ladder/#{@ladder_id}"
+
+        super(options)
+      end
+
+      def details(options = {})
+        get_data(@endpoint, options)
+      end
 
-      get "/ladder/#{id}", options
     end
   end
-end
+end

data/lib/battlenet/modules/sc2/profile.rb

@@ -2,28 +2,28 @@ require 'uri'
 
 module Battlenet
   module SC2
-    def profile(id, region, name, options = {})
-      id = URI.escape id
-      region = URI.escape region
-      name = URI.escape name
+    class Profile < Battlenet::APIResponse
+      def initialize(options={})
+        @profile_id     = options.delete(:id)
+        @region         = options.delete(:region)
+        @name           = options.delete(:name)
 
-      get "/profile/#{id}/#{region}/#{name}", options
-    end
+        @endpoint       = "/profile/#{@profile_id}/#{@region}/#{@name}"
 
-    def profile_ladders(id, region, name, options = {})
-      id = URI.escape id
-      region = URI.escape region
-      name = URI.escape name
+        super(options)
+      end
 
-      get "/profile/#{id}/#{region}/#{name}/ladders", options
-    end
+      def details(options = {})
+        get_data(@endpoint, options)
+      end
 
-    def profile_match_history(id, region, name, options = {})
-      id = URI.escape id
-      region = URI.escape region
-      name = URI.escape name
+      def ladders(options = {})
+        get_data("#{@endpoint}/ladders", options)
+      end
 
-      get "/profile/#{id}/#{region}/#{name}/matches", options
+      def match_history(options = {})
+        get_data("#{@endpoint}/matches", options)
+      end
     end
   end
-end
+end

data/lib/battlenet/modules/wow/achievement.rb

@@ -3,8 +3,7 @@ module Battlenet
     class Achievement < Battlenet::APIResponse
 
       def initialize(options={})
-        @realm          = options.delete(:achievement)
-
+        @achievement    = options.delete(:achievement)
         @endpoint       = "/achievement/#{@achievement}"
 
         super(options)

data/lib/battlenet/modules/wow/auction.rb

@@ -4,7 +4,6 @@ module Battlenet
 
       def initialize(options={})
         @realm          = options.delete(:realm)
-
         @endpoint       = "/auction/data/#{@realm}"
 
         super(options)

data/spec/d3/data_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Battlenet::D3::Data do
+
+  context "when looking up data" do
+    before do
+      Battlenet.configure do |config|
+        config.api_key = ENV['BATTLENET_API_KEY']
+        config.region  = :us
+      end
+      @d3_client = Battlenet.D3Client
+    end
+
+  end
+
+  it { should respond_to(:item) }
+  it { should respond_to(:follower) }
+  it { should respond_to(:artisan) }
+
+end

data/spec/d3/profile_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Battlenet::D3::Profile do
+
+  context "when looking up profile" do
+    before do
+      Battlenet.configure do |config|
+        config.api_key = ENV['BATTLENET_API_KEY']
+        config.region  = :us
+      end
+      @d3_client = Battlenet.D3Client
+    end
+
+  end
+
+  it { should respond_to(:career) }
+  it { should respond_to(:hero) }
+  
+end

data/spec/d3client_spec.rb

@@ -13,11 +13,7 @@ describe Battlenet::D3Client do
     expect(c.api_key).to eq(ENV['BATTLENET_API_KEY'])
   end
 
-  it { should respond_to(:data_item) }
-  it { should respond_to(:data_follower) }
-  it { should respond_to(:data_artisan) }
-
-  it { should respond_to(:career_profile) }
-  it { should respond_to(:hero_profile) }
+  it { should respond_to(:data) }
+  it { should respond_to(:profile) }
 
 end

data/spec/sc2/data_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Battlenet::SC2::Data do
+
+  context "when looking up data" do
+    before do
+      Battlenet.configure do |config|
+        config.api_key = ENV['BATTLENET_API_KEY']
+        config.region  = :us
+      end
+      @sc2_client = Battlenet.SC2Client
+    end
+
+  end
+
+  it { should respond_to(:achievements) }
+  it { should respond_to(:rewards) }
+
+end

data/spec/sc2/ladder_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe Battlenet::SC2::Ladder do
+
+  context "when looking up ladder" do
+    before do
+      Battlenet.configure do |config|
+        config.api_key = ENV['BATTLENET_API_KEY']
+        config.region  = :us
+      end
+      @sc2_client = Battlenet.SC2Client
+    end
+
+  end
+
+  it { should respond_to(:details) }
+
+end

data/spec/sc2/profile_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Battlenet::SC2::Profile do
+
+  context "when looking up profile" do
+    before do
+      Battlenet.configure do |config|
+        config.api_key = ENV['BATTLENET_API_KEY']
+        config.region  = :us
+      end
+      @sc2_client = Battlenet.SC2Client
+    end
+
+  end
+
+  it { should respond_to(:details) }
+  it { should respond_to(:ladders) }
+  it { should respond_to(:match_history) }
+
+end

data/spec/sc2client_spec.rb

@@ -13,13 +13,8 @@ describe Battlenet::SC2Client do
     expect(c.api_key).to eq(ENV['BATTLENET_API_KEY'])
   end
 
-  it { should respond_to(:achievements) }
-  it { should respond_to(:rewards) }
-
+  it { should respond_to(:data) }
   it { should respond_to(:ladder) }
-
   it { should respond_to(:profile) }
-  it { should respond_to(:profile_ladders) }
-  it { should respond_to(:profile_match_history) }
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: battlenet-api
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 1.0.0
 platform: ruby
 authors:
 - goodcodeguy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-11 00:00:00.000000000 Z
+date: 2016-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -177,7 +177,12 @@ files:
 - lib/battlenet/modules/wow/recipe.rb
 - lib/battlenet/modules/wow/spell.rb
 - spec/battlenetapi_spec.rb
+- spec/d3/data_spec.rb
+- spec/d3/profile_spec.rb
 - spec/d3client_spec.rb
+- spec/sc2/data_spec.rb
+- spec/sc2/ladder_spec.rb
+- spec/sc2/profile_spec.rb
 - spec/sc2client_spec.rb
 - spec/spec_helper.rb
 - spec/wow/character_spec.rb
@@ -203,13 +208,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Battlenet Client API
 test_files:
 - spec/battlenetapi_spec.rb
+- spec/d3/data_spec.rb
+- spec/d3/profile_spec.rb
 - spec/d3client_spec.rb
+- spec/sc2/data_spec.rb
+- spec/sc2/ladder_spec.rb
+- spec/sc2/profile_spec.rb
 - spec/sc2client_spec.rb
 - spec/spec_helper.rb
 - spec/wow/character_spec.rb