battlenet-api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 683fb02cb8c591d4c10d640cbd8180906f63bff4
-  data.tar.gz: 19c5877277059a1f544599f934b1c6c49ca2f4fb
+  metadata.gz: 2f6009e021ba8b5d67293b21b656dea571e959eb
+  data.tar.gz: 8abe07468e5d82506dd1d7122b639da784bbd9cd
 SHA512:
-  metadata.gz: 624d4c74aec95c3e5e4b908e7b683e29bef24e840ce740898d73cf5c7e31946f289e406a08dcf657db79c403edcd14642ec12a129a4a17eb4e449f46e32588cd
-  data.tar.gz: dcc0b456b88ebef73c8533a98cdef94518f57725b4ae439691745baee5c1fd5d34e9269badd9d774fb414a3352bb41333c9a39693439de127091bf72af50fb0c
+  metadata.gz: 7031729ba3fe8595c0c256bc2ce5b71bab92379419b82ad715ac76e90778148737df8690a714251f74c16454ee995f1a645b2b8a97ba017ac0ca135aae75c1aa
+  data.tar.gz: e48e5d71bc7af0633c32ba4787340aec1aac3aa73562f5ea0d18eb5daaa909d140d533cb958296e64ba217b25930823312fcd39c07e9a3738ac9b769fd80dc4b

data/README.md

@@ -1,6 +1,122 @@
-# Battlenet API Gem [![Dependency Status](https://gemnasium.com/goodcodeguy/battlenet-api.svg)](https://gemnasium.com/goodcodeguy/battlenet-api) [![Code Climate](https://codeclimate.com/github/goodcodeguy/battlenet-api/badges/gpa.svg)](https://codeclimate.com/github/goodcodeguy/battlenet-api)
+# Battlenet API Gem
+[![Gem Version](https://badge.fury.io/rb/battlenet-api.svg)](http://badge.fury.io/rb/battlenet-api) [![Dependency Status](https://gemnasium.com/goodcodeguy/battlenet-api.svg)](https://gemnasium.com/goodcodeguy/battlenet-api) [![Code Climate](https://codeclimate.com/github/goodcodeguy/battlenet-api/badges/gpa.svg)](https://codeclimate.com/github/goodcodeguy/battlenet-api)
 
-TODO:
+## Installation
+
+`$ gem install battlenet-api`
+
+## How to Use
+
+### Configuration
+
+````ruby
+Battlenet.configure do |config|
+  config.api_key = 'apikey'
+  config.region  = :us
+end
+````
+
+### World of Warcraft Client
+
+````ruby
+client = Battlenet.WOWClient
+
+# Available Methods
+client.achievement(id)
+client.auction_data_status(realm)
+
+client.battlepet_ability(ability_id)
+client.battlepet_species(species_id)
+client.battlepet_stats(species_id)
+
+client.challengemode_realm_leaderboard(realm)
+client.challengemode_region_leaderboard
+
+client.character_profile(realm, character_name)
+client.character_achievements(realm, character_name)
+client.character_appearance(realm, character_name)
+client.character_feed(realm, character_name)
+client.character_guild(realm, character_name)
+client.character_hunter_pets(realm, character_name)
+client.character_items(realm, character_name)
+client.character_mounts(realm, character_name)
+client.character_pets(realm, character_name)
+client.character_pet_slots(realm, character_name)
+client.character_progression(realm, character_name)
+client.character_pvp(realm, character_name)
+client.character_quests(realm, character_name)
+client.character_reputation(realm, character_name)
+client.character_stats(realm, character_name)
+client.character_talents(realm, character_name)
+client.character_titles(realm, character_name)
+client.character_audit(realm, character_name)
+
+client.data_battlegroups
+client.data_character_races
+client.data_character_classes
+client.data_character_achievements
+client.data_guild_rewards
+client.data_guild_perks
+client.data_guild_achievements
+client.data_item_classes
+client.data_talents
+client.data_pet_types
+
+client.guild_profile(realm, guild_name)
+client.guild_members(realm, guild_name)
+client.guild_achievements(realm, guild_name)
+client.guild_news(realm, guild_name)
+client.guild_challenge(realm, guild_name)
+
+client.item(item_id)
+client.item_set(set_id)
+
+client.pvp_leaderboards(bracket)
+
+client.quest(quest_id)
+
+client.realm_status
+
+client.recipe(recipe_id)
+
+client.spell(spell_id)
+
+````
+
+### Diablo 3 Client
+
+````ruby
+client = Battlenet.D3Client
+
+#Available Methods
+
+client.data_item(data_id)
+client.data_follower(follower_id)
+client.data_artisan(artisan_id)
+
+client.career_profile(battletag)
+client.hero_profile(battletag,hero_id)
+````
+
+### Starcraft 2 Client
+
+````ruby
+client = Battlenet.S2Client
+
+#Available Methods
+
+client.achievements
+client.rewards
+
+client.ladder(ladder_id)
+
+client.profile(id, region, name)
+client.profile_ladders(id, region, name)
+client.profile_match_history(id, region, name)
+````
+
+
+## TODO
 
 - Community OAuth Profile APIs
 - Account APIs

data/battlenet-api.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "httparty"
-  spec.add_dependency "oauth2"
+  spec.add_runtime_dependency "httparty", "~> 0.13"
+  spec.add_runtime_dependency "oauth2", "~> 1.0"
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec", "~> 3.1"
 end

data/lib/battlenet/api.rb

@@ -1,6 +1,26 @@
-require 'battlenet/api/version'
+require File.expand_path('../api/version', __FILE__)
 
-require 'battlenet/api/client'
-require 'battlenet/api/wow_client'
-require 'battlenet/api/sc2_client'
-require 'battlenet/api/d3_client'
+require File.expand_path('../api/configuration', __FILE__)
+require File.expand_path('../api/client', __FILE__)
+require File.expand_path('../api/wow_client', __FILE__)
+require File.expand_path('../api/d3_client', __FILE__)
+require File.expand_path('../api/sc2_client', __FILE__)
+
+
+
+module Battlenet
+  extend Configuration
+
+  def self.WOWClient(options={})
+    Battlenet::WOWClient.new(options)
+  end
+
+  def self.SC2Client(options={})
+    Battlenet::SC2Client.new(options)
+  end
+
+  def self.D3Client(options={})
+    Battlenet::D3Client.new(options)
+  end
+
+end

data/lib/battlenet/api/client.rb

@@ -6,19 +6,23 @@ module Battlenet
     class Client
       include HTTParty
 
-      def initialize(api_key = nil, region = :us)
-        
-        @api_key = api_key
-        @endpoint = nil
+      attr_accessor *Configuration::OPTIONS_KEYS
 
-        domain   = region_uri(region)
+      def initialize(options={})
+
+        options = Battlenet.options.merge(client_defaults)
+        options = Battlenet.options.merge(options)
+
+        Configuration::OPTIONS_KEYS.each do |key|
+          send("#{key}=", options[key])
+        end
 
         self.class.base_uri "https://#{domain}#{endpoint}"
 
       end
 
-      def region_uri(region = :us)
-        domain = case region
+      def domain
+        domain = case @region
         when :us
           'us.api.battle.net'
         when :eu
@@ -58,4 +62,4 @@ module Battlenet
 
     end
 
-end
+end

data/lib/battlenet/api/configuration.rb

@@ -0,0 +1,27 @@
+module Battlenet
+  module Configuration
+
+    OPTIONS_KEYS = [
+      :api_key,
+      :region,
+      :endpoint
+    ].freeze
+
+    DEFAULT_API_KEY  = nil
+    DEFAULT_ENDPOINT = nil
+    DEFAULT_REGION   = :us
+
+    attr_accessor *OPTIONS_KEYS
+
+    def configure
+      yield self
+    end
+
+    def options
+      OPTIONS_KEYS.inject({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+  end
+end

data/lib/battlenet/api/d3_client.rb

@@ -9,12 +9,8 @@ module Battlenet
 
     include Battlenet::D3
 
-    def initialize(api_key = nil, region = :us)
-      super(api_key, region)
-    end
-
-    def endpoint
-      @endpoint = '/d3'
+    def client_defaults
+      { :endpoint => '/d3', :region => :us }
     end
 
   end

data/lib/battlenet/api/sc2_client.rb

@@ -10,12 +10,8 @@ module Battlenet
 
     include Battlenet::SC2
 
-    def initialize(api_key = nil, region = :us)
-      super(api_key, region)
-    end
-
-    def endpoint
-      @endpoint = '/sc2'
+    def client_defaults
+      { :endpoint => '/sc2', :region => :us }
     end
 
   end

data/lib/battlenet/api/version.rb

@@ -1,5 +1,5 @@
 module Battlenet
   module Api
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/battlenet/api/wow_client.rb

@@ -16,18 +16,14 @@ require 'battlenet/modules/wow/data'
 
 module Battlenet
 
-    class WOWClient < Client
+  class WOWClient < Client
 
-      include Battlenet::WOW
-
-      def initialize(api_key = nil, region = :us)
-        super(api_key, region)
-      end
-
-      def endpoint
-        @endpoint = '/wow'
-      end
+    include Battlenet::WOW
 
+    def client_defaults
+      { :endpoint => '/wow', :region => :us }
     end
 
+  end
+
 end

data/spec/battlenetapi_spec.rb

@@ -1,11 +1,11 @@
 require 'battlenet/api'
 
 describe Battlenet::Client do
-
-  it "has a valid factory" do
-    c = Battlenet::Client.new('5g856v32mx5bwx3rwxzkt9z9yrehtuq2')
+  before(:all) do
+    Battlenet.configure do |config|
+      config.api_key = 'test-api'
+      config.region  = :us
+    end
   end
 
-  it "connects to the battlenet wow community servers"
-
-end
+end

data/spec/d3client_spec.rb

@@ -0,0 +1,23 @@
+require 'battlenet/api'
+
+describe Battlenet::D3Client do
+  before(:all) do
+    Battlenet.configure do |config|
+      config.api_key = 'test-d3client-api'
+      config.region  = :us
+    end
+  end
+
+  it "should pass the api key to the d3 client" do
+    c = Battlenet.D3Client
+    expect(c.api_key).to eq('test-d3client-api')
+  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) }
+
+end

data/spec/sc2client_spec.rb

@@ -0,0 +1,25 @@
+require 'battlenet/api'
+
+describe Battlenet::SC2Client do
+  before(:all) do
+    Battlenet.configure do |config|
+      config.api_key = 'test-sc2client-api'
+      config.region  = :us
+    end
+  end
+
+  it "should pass the api key to the SC2 client" do
+    c = Battlenet.SC2Client
+    expect(c.api_key).to eq('test-sc2client-api')
+  end
+
+  it { should respond_to(:achievements) }
+  it { should respond_to(:rewards) }
+
+  it { should respond_to(:ladder) }
+
+  it { should respond_to(:profile) }
+  it { should respond_to(:profile_ladders) }
+  it { should respond_to(:profile_match_history) }
+
+end

data/spec/wowclient_spec.rb

@@ -0,0 +1,75 @@
+require 'battlenet/api'
+
+describe Battlenet::WOWClient do
+  before(:all) do
+    Battlenet.configure do |config|
+      config.api_key = 'test-wow-api-key'
+      config.region  = :us
+    end
+  end
+
+  it "should pass the api key to the wow client" do
+    c = Battlenet.WOWClient
+    expect(c.api_key).to eq('test-wow-api-key')
+  end
+
+  it { should respond_to(:achievement) }
+  it { should respond_to(:auction_data_status) }
+
+  it { should respond_to(:battlepet_ability) }
+  it { should respond_to(:battlepet_species) }
+  it { should respond_to(:battlepet_stats) }
+
+  it { should respond_to(:challengemode_realm_leaderboard) }
+  it { should respond_to(:challengemode_region_leaderboard) }
+
+  it { should respond_to(:character_profile) }
+  it { should respond_to(:character_achievements) }
+  it { should respond_to(:character_appearance) }
+  it { should respond_to(:character_feed) }
+  it { should respond_to(:character_guild) }
+  it { should respond_to(:character_hunter_pets) }
+  it { should respond_to(:character_items) }
+  it { should respond_to(:character_mounts) }
+  it { should respond_to(:character_pets) }
+  it { should respond_to(:character_pet_slots) }
+  it { should respond_to(:character_progression) }
+  it { should respond_to(:character_pvp) }
+  it { should respond_to(:character_quests) }
+  it { should respond_to(:character_reputation) }
+  it { should respond_to(:character_stats) }
+  it { should respond_to(:character_talents) }
+  it { should respond_to(:character_titles) }
+  it { should respond_to(:character_audit) }
+
+  it { should respond_to(:data_battlegroups) }
+  it { should respond_to(:data_character_races) }
+  it { should respond_to(:data_character_classes) }
+  it { should respond_to(:data_character_achievements) }
+  it { should respond_to(:data_guild_rewards) }
+  it { should respond_to(:data_guild_perks) }
+  it { should respond_to(:data_guild_achievements) }
+  it { should respond_to(:data_item_classes) }
+  it { should respond_to(:data_talents) }
+  it { should respond_to(:data_pet_types) }
+
+  it { should respond_to(:guild_profile) }
+  it { should respond_to(:guild_members) }
+  it { should respond_to(:guild_achievements) }
+  it { should respond_to(:guild_news) }
+  it { should respond_to(:guild_challenge) }
+
+  it { should respond_to(:item) }
+  it { should respond_to(:item_set) }
+
+  it { should respond_to(:pvp_leaderboards)}
+
+  it { should respond_to(:quest) }
+
+  it { should respond_to(:realm_status) }
+
+  it { should respond_to(:recipe) }
+
+  it { should respond_to(:spell) }
+
+end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: battlenet-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - goodcodeguy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-13 00:00:00.000000000 Z
+date: 2014-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -70,16 +70,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.1'
 description: API Wrapper for the Battlenet API
 email:
 - goodcodeguy@gmail.com
@@ -96,6 +96,7 @@ files:
 - examples/example_oauth.rb
 - lib/battlenet/api.rb
 - lib/battlenet/api/client.rb
+- lib/battlenet/api/configuration.rb
 - lib/battlenet/api/d3_client.rb
 - lib/battlenet/api/sc2_client.rb
 - lib/battlenet/api/version.rb
@@ -119,6 +120,9 @@ files:
 - lib/battlenet/modules/wow/recipe.rb
 - lib/battlenet/modules/wow/spell.rb
 - spec/battlenetapi_spec.rb
+- spec/d3client_spec.rb
+- spec/sc2client_spec.rb
+- spec/wowclient_spec.rb
 homepage: https://github.com/goodcodeguy/battlenet-api
 licenses:
 - MIT
@@ -145,3 +149,6 @@ specification_version: 4
 summary: Battlenet Client API
 test_files:
 - spec/battlenetapi_spec.rb
+- spec/d3client_spec.rb
+- spec/sc2client_spec.rb
+- spec/wowclient_spec.rb