battlenet 1.2.0 → 1.3.0

data/.gitignore

@@ -3,3 +3,5 @@
 Gemfile.lock
 pkg/*
 .rvmrc
+.yardoc/*
+doc/*

data/.yardopts

@@ -0,0 +1,10 @@
+--readme               README.md
+--markup               markdown
+--markup-provider      redcarpet
+--title                "Battlenet Documentation"
+--private
+lib/**/*.rb
+-
+README.md
+CHANGELOG.md
+LICENSE

data/CHANGELOG.md

@@ -0,0 +1,8 @@
+## v1.1.0
+
+* Added quest resource
+* Added character achievements and guild achievements data resources
+
+## v1.0.0
+
+* Initial release version

data/Gemfile

@@ -2,3 +2,9 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in battlenet.gemspec
 gemspec
+
+group :documentation do
+  gem "yard"
+  gem "redcarpet"
+  gem "github-markup"
+end

data/README.md

@@ -48,10 +48,12 @@ Configuring
 Failing Silently
 ----------------
 
-By default, if Battlenet receives a non-200 response from the Battle.net API, it will throw an exception. You can turn this behavior off via the `fail_silently` attribute:
+By default, if Battlenet receives a 4xx or 5xx response from the Battle.net API, it will throw a `Battlent::ApiException`. You can turn this behavior off via the `fail_silently` attribute:
 
     Battlenet.fail_silently = true
 
+The exception will have its `code` attribute set to the HTTP status code returned from the API; if the response included a JSON response with the `reason` field set, the exception will have a `reason` attribute set to this string. You can also access the raw response via the `response` attribute.
+
 Localization
 ------------
 
@@ -81,6 +83,62 @@ If you would like to contribute to the project, please feel free to do so. Just
 
 Please do not change the contents of the `VERSION` file, or if you do, do so in a separate commit so that I can cherry-pick around it.
 
+Setting Up the Development Environment
+--------------------------------------
+
+The development environment is managed with Bundler.
+
+To install just the gems you need to hack on Battlenet and run the specs, run
+
+    bundle install --without documentation
+
+To install all development gems, including the ones used to generate documentation, run
+
+    bundle install
+
+To run the specs, run
+
+    bundle exec rake
+
+Writing an Integration Test
+---------------------------
+
+High-level integration testing against the Community Platform API is handled via VCR. After the first time running a spec that hits the API, VCR saves the HTTP response in a fixture file and uses this file to run against in the future.
+
+Here's an example (the character integration specs):
+
+    it "fetches character data" do
+      VCR.use_cassette('character_mortawa') do
+        character = api.character 'nazjatar', 'mortawa'
+        character['level'].should == 85
+      end
+    end
+
+    it "fetches additional character data" do
+      VCR.use_cassette('character_mortawa_titles') do
+        character = api.character 'nazjatar', 'mortawa', :fields => 'titles'
+        character['titles'].find { |t| t['selected'] == true }['name'].should == "Twilight Vanquisher %s"
+      end
+    end
+
+    it "fetches characters with non-ASCII characters in their name" do
+      VCR.use_cassette('character_nonstandard_name') do
+        character = api.character 'nazjatar', 'Hikô'
+        character['level'].should == 85
+      end
+    end
+
+You should always wrap tests that hit the actual API in the `VCR.use_cassette` block, and the resulting fixture file should be checked in with your test.
+
+Building the Documentation
+--------------------------
+
+If you have the necessary gems installed (defined in the `documentation` group in the Gemfile), you can easily generate the documentation via
+
+    yard
+
+The generated documentation can be found in `doc/`; open `doc/index.html` to view it.
+
 License
 =======
 

data/Rakefile

@@ -2,6 +2,7 @@ require 'bundler'
 require 'rspec/core/rake_task'
 
 task :default => :spec
+task :test => :spec
 
 Bundler::GemHelper.install_tasks
 RSpec::Core::RakeTask.new(:spec) do |t|

data/battlenet.gemspec

@@ -1,11 +1,11 @@
 # -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 
-version = File.read(File.expand_path('./VERSION')).strip
+require 'battlenet/version'
 
 Gem::Specification.new do |s|
   s.name        = "battlenet"
-  s.version     = version
+  s.version     = Battlenet::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Brandon Tilley"]
   s.email       = ["brandon@brandontilley.com"]

data/lib/battlenet.rb

@@ -1,100 +1 @@
-require 'httparty'
-require 'battlenet/authentication'
-require 'battlenet/modules/character'
-require 'battlenet/modules/guild'
-require 'battlenet/modules/realm'
-require 'battlenet/modules/auction'
-require 'battlenet/modules/item'
-require 'battlenet/modules/recipe'
-require 'battlenet/modules/quest'
-require 'battlenet/modules/arena'
-require 'battlenet/modules/data'
-
-class Battlenet
-  include HTTParty
-
-  include Battlenet::Character
-  include Battlenet::Guild
-  include Battlenet::Realm
-  include Battlenet::Auction
-  include Battlenet::Item
-  include Battlenet::Recipe
-  include Battlenet::Quest
-  include Battlenet::Arena
-  include Battlenet::Data
-
-  class << self
-    attr_accessor :fail_silently
-    attr_accessor :locale
-  end
-
-  @fail_silently = false
-  @locale = nil
-
-  def initialize(region = :us, public = nil, private = nil)
-    @public = public
-    @private = private
-
-    @proto = @public && @private ? "https://" : "http://"
-    @endpoint = '/api/wow'
-    @domain = case region
-    when :us
-      'us.battle.net'
-    when :eu
-      'eu.battle.net'
-    when :kr
-      'kr.battle.net'
-    when :tw
-      'tw.battle.net'
-    when :cn
-      'battlenet.com.cn'
-    else
-      raise "Invalid region: #{region.to_s}"
-    end
-
-    @base_uri = "#{@proto}#{@domain}#{@endpoint}"
-    self.class.base_uri @base_uri
-  end
-
-  def fullpath(path)
-    "#{@endpoint}#{path}"
-  end
-
-  def get(path, params = {})
-    make_request :get, path, params
-  end
-
-  def make_request(verb, path, params = {})
-    options = {}
-    headers = {}
-
-    if @public && @private
-      now = Time.now
-      signed = sign_request verb, path, now
-      headers.merge!({
-        "Authorization" => "BNET #{@public}:#{signed}",
-        "Date" => now.httpdate
-      })
-    end
-
-    options[:headers] = headers unless headers.empty?
-    options[:query]   = params unless params.empty?
-
-    if Battlenet.locale
-      options[:query] ||= {}
-      options[:query].merge!({ :locale => Battlenet.locale })
-    end
-
-    response = self.class.send(verb, path, options)
-
-    if response.code != 200 && Battlenet.fail_silently == false
-      raise "Non-200 response: #{response.code}, #{response.body}"
-    end
-    response
-  end
-
-  def sign_request(verb, path, time)
-    auth = Battlenet::Authentication.new @private
-    auth.sign verb, fullpath(path), time
-  end
-end
+require 'battlenet/battlenet'

data/lib/battlenet/battlenet.rb

@@ -0,0 +1,184 @@
+require 'httparty'
+require 'battlenet/authentication'
+require 'battlenet/exceptions/api_exception'
+require 'battlenet/modules/character'
+require 'battlenet/modules/guild'
+require 'battlenet/modules/realm'
+require 'battlenet/modules/auction'
+require 'battlenet/modules/item'
+require 'battlenet/modules/recipe'
+require 'battlenet/modules/quest'
+require 'battlenet/modules/arena'
+require 'battlenet/modules/data'
+
+# Battlenet exposes the Blizzard Battle.net Community Platform API via an
+# easy-to-use interface.
+#
+# The main API class includes several Modules that define methods for collecting
+# specific API data. See the documentation for `Battlenet::Modules` for a list of
+# these modules.
+#
+# Specific details about the information returned from the API can be found at Blizzard's
+# [official Community Platform API documentation](https://blizzard.github.com/api-wow-docs/).
+#
+# @example Return basic information about a character named Cyaga from the US realm Nazjatar
+#
+#   api  = Battlenet.new :us
+#   char = api.character 'Nazjatar', 'Cyaga'
+#   char['level']
+#   # => 85
+#
+# @example Return additional information about a character
+#
+#   api  = Battlenet.new :us
+#   char = api.character 'Nazjatar', 'Cyaga', :fields => 'titles'
+#   selected_title = char['titles'].find { |t| t['selected'] == true }
+#   selected_title['name']
+#   # => "%s, Guardian of Cenarius"
+#
+# @see Battlenet::Modules
+#
+# @author Brandon Tilley <brandon@brandontilley.com>
+class Battlenet
+
+  # `Battlenet::Modules` is a namespace for modules that define methods that
+  # retrieve data from the Community Platform API. Methods for retrieving information
+  # about related resources are grouped in the same sub-Module. See documentation for
+  # the individual Modules for more information about the methods contained within.
+  module Modules; end
+
+  include HTTParty
+
+  include Battlenet::Modules::Character
+  include Battlenet::Modules::Guild
+  include Battlenet::Modules::Realm
+  include Battlenet::Modules::Auction
+  include Battlenet::Modules::Item
+  include Battlenet::Modules::Recipe
+  include Battlenet::Modules::Quest
+  include Battlenet::Modules::Arena
+  include Battlenet::Modules::Data
+
+  class << self
+    # Whether or not to raise exceptions on error responses from the API endpoint.
+    # A value of `false` causes exceptions to be raised. Defaults to `false`.
+    #
+    # @return [boolean]
+    attr_accessor :fail_silently
+
+    # The locale to use for API calls. Defaults to `nil`, which makes requests with
+    # no `locale` parameter set.
+    #
+    # @return [String|nil]
+    attr_accessor :locale
+  end
+
+  @fail_silently = false
+  @locale = nil
+
+  # Creates a new instance of the Battlenet API.
+  #
+  # @param region [Symbol] the region to perform API calls against.
+  # @param public [String|nil] the public key to use when signing requests
+  # @param private [String|nil]  the private key to use when signing requests
+  def initialize(region = :us, public = nil, private = nil)
+    @public = public
+    @private = private
+
+    @proto = @public && @private ? "https://" : "http://"
+    @endpoint = '/api/wow'
+    @domain = case region
+    when :us
+      'us.battle.net'
+    when :eu
+      'eu.battle.net'
+    when :kr
+      'kr.battle.net'
+    when :tw
+      'tw.battle.net'
+    when :cn
+      'battlenet.com.cn'
+    else
+      raise "Invalid region: #{region.to_s}"
+    end
+
+    @base_uri = "#{@proto}#{@domain}#{@endpoint}"
+    self.class.base_uri @base_uri
+  end
+
+  # Signs and performs an HTTP GET request. The request is only signed if a public and private
+  # key were provided during object instantiation.
+  #
+  # @param path (see #make_request)
+  # @param params (see #make_request)
+  # @return (see #make_request)
+  # @raise (see #make_request)
+  # @see (see #make_request)
+  def get(path, params = {})
+    make_request :get, path, params
+  end
+
+  private
+
+    # Returns the full URI for the given path based on the API endpoint set (varies by region).
+    #
+    # @return [String] the full URI for the path
+    def fullpath(path)
+      "#{@endpoint}#{path}"
+    end
+
+    # Signs and performs an HTTP request. The request is only signed if a public and private
+    # key were provided during object instantiation.
+    #
+    # @param verb [Symbol] the HTTP verb to perform
+    # @param path [String] the path to GET
+    # @param params [Hash] options to be turned into query string parameters
+    # @return [Object] the response object from HTTParty
+    # @raise Battlenet::ApiException if the response has a 4xx or 5xx response and `Battlenet.fail_silently` is `false`
+    # @see #process_response
+    # @see http://rubydoc.info/github/jnunemaker/httparty/master/HTTParty/Response
+    # @private
+    def make_request(verb, path, params = {})
+      options = {}
+      headers = {}
+
+      if @public && @private
+        now = Time.now
+        signed = sign_request verb, path, now
+        headers.merge!({
+          "Authorization" => "BNET #{@public}:#{signed}",
+          "Date" => now.httpdate
+        })
+      end
+
+      options[:headers] = headers unless headers.empty?
+      options[:query]   = params unless params.empty?
+
+      if Battlenet.locale
+        options[:query] ||= {}
+        options[:query].merge!({ :locale => Battlenet.locale })
+      end
+
+      response = self.class.send(verb, path, options)
+      process_response response
+    end
+
+    def process_response(response)
+      if response.code.to_s =~ /^(4|5)/ && Battlenet.fail_silently == false
+        raise Battlenet::ApiException.new(response)
+      end
+      response
+    end
+
+    # Signs an HTTP request.
+    #
+    # @param verb [Symbol] the HTTP verb for the request being signed
+    # @param path [String] the path for the rquest being signed
+    # @param time [Time] the time to use when signing the request
+    # @return [String] value to be used as the final portion of the `Authorization` HTTP header
+    # @see Battlenet::Authentication
+    def sign_request(verb, path, time)
+      auth = Battlenet::Authentication.new @private
+      auth.sign verb, fullpath(path), time
+    end
+end

data/lib/battlenet/exceptions/api_exception.rb

@@ -0,0 +1,11 @@
+class Battlenet
+  class ApiException < Exception
+    attr_accessor :response, :code, :reason
+
+    def initialize(response)
+      @response = response
+      @code     = response.code
+      @reason   = response['reason'] || nil
+    end
+  end
+end

data/lib/battlenet/modules/arena.rb

@@ -1,13 +1,15 @@
 require 'uri'
 
 class Battlenet
-  module Arena
-    def arena(realm, size, name, options = {})
-      realm = URI.escape realm
-      size = URI.escape size
-      name = URI.escape name
+  module Modules
+    module Arena
+      def arena(realm, size, name, options = {})
+        realm = URI.escape realm
+        size = URI.escape size
+        name = URI.escape name
 
-      get "/arena/#{realm}/#{size}/#{name}", options
+        get "/arena/#{realm}/#{size}/#{name}", options
+      end
     end
   end
 end

data/lib/battlenet/modules/auction.rb

@@ -1,18 +1,20 @@
 require 'uri'
 
 class Battlenet
-  module Auction
-    def auction(realm, options = {})
-      realm = URI.escape realm
+  module Modules
+    module Auction
+      def auction(realm, options = {})
+        realm = URI.escape realm
 
-      get "/auction/data/#{realm}", options
-    end
+        get "/auction/data/#{realm}", options
+      end
 
-    def auction_data(realm, options = {})
-      data = auction(realm, options)
-      files = data["files"].first
-      url = files["url"]
-      get url
+      def auction_data(realm, options = {})
+        data = auction(realm, options)
+        files = data["files"].first
+        url = files["url"]
+        get url
+      end
     end
   end
 end

data/lib/battlenet/modules/character.rb

@@ -1,12 +1,14 @@
 require 'uri'
 
 class Battlenet
-  module Character
-    def character(realm, name, options = {})
-      realm = URI.escape realm
-      name = URI.escape name
+  module Modules
+    module Character
+      def character(realm, name, options = {})
+        realm = URI.escape realm
+        name = URI.escape name
 
-      get "/character/#{realm}/#{name}", options
+        get "/character/#{realm}/#{name}", options
+      end
     end
   end
 end

data/lib/battlenet/modules/data.rb

@@ -1,31 +1,33 @@
 class Battlenet
-  module Data
-    def character_races(options = {})
-      get "/data/character/races", options
-    end
+  module Modules
+    module Data
+      def character_races(options = {})
+        get "/data/character/races", options
+      end
 
-    def character_classes(options = {})
-      get "/data/character/classes", options
-    end
+      def character_classes(options = {})
+        get "/data/character/classes", options
+      end
 
-    def guild_rewards(options = {})
-      get "/data/guild/rewards", options
-    end
+      def guild_rewards(options = {})
+        get "/data/guild/rewards", options
+      end
 
-    def guild_perks(options = {})
-      get "/data/guild/perks", options
-    end
+      def guild_perks(options = {})
+        get "/data/guild/perks", options
+      end
 
-    def item_classes(options = {})
-      get "/data/item/classes", options
-    end
+      def item_classes(options = {})
+        get "/data/item/classes", options
+      end
 
-    def character_achievements(options = {})
-      get "/data/character/achievements", options
-    end
+      def character_achievements(options = {})
+        get "/data/character/achievements", options
+      end
 
-    def guild_achievements(options = {})
-      get "/data/guild/achievements", options
+      def guild_achievements(options = {})
+        get "/data/guild/achievements", options
+      end
     end
   end
 end

data/lib/battlenet/modules/guild.rb

@@ -1,12 +1,14 @@
 require 'uri'
 
 class Battlenet
-  module Guild
-    def guild(realm, name, options = {})
-      realm = URI.escape realm
-      name = URI.escape name
+  module Modules
+    module Guild
+      def guild(realm, name, options = {})
+        realm = URI.escape realm
+        name = URI.escape name
 
-      get "/guild/#{realm}/#{name}", options
+        get "/guild/#{realm}/#{name}", options
+      end
     end
   end
 end

data/lib/battlenet/modules/item.rb

@@ -1,7 +1,9 @@
 class Battlenet
-  module Item
-    def item(id, options = {})
-      get "/item/#{id}", options
+  module Modules
+    module Item
+      def item(id, options = {})
+        get "/item/#{id}", options
+      end
     end
   end
 end

data/lib/battlenet/modules/quest.rb

@@ -1,7 +1,9 @@
 class Battlenet
-  module Quest
-    def quest(id, options = {})
-      get "/quest/#{id}", options
+  module Modules
+    module Quest
+      def quest(id, options = {})
+        get "/quest/#{id}", options
+      end
     end
   end
 end

data/lib/battlenet/modules/realm.rb

@@ -1,7 +1,9 @@
 class Battlenet
-  module Realm
-    def realm(options = {})
-      get "/realm/status", options
+  module Modules
+    module Realm
+      def realm(options = {})
+        get "/realm/status", options
+      end
     end
   end
 end

data/lib/battlenet/modules/recipe.rb

@@ -1,7 +1,9 @@
 class Battlenet
-  module Recipe
-    def recipe(id, options = {})
-      get "/recipe/#{id}", options
+  module Modules
+    module Recipe
+      def recipe(id, options = {})
+        get "/recipe/#{id}", options
+      end
     end
   end
 end

data/lib/battlenet/version.rb

@@ -0,0 +1,3 @@
+class Battlenet
+  VERSION = "1.3.0"
+end

data/spec/fixtures/cassettes/not_found.yml

@@ -0,0 +1,26 @@
+---
+- !ruby/struct:VCR::HTTPInteraction
+  request: !ruby/struct:VCR::Request
+    method: :get
+    uri: http://us.battle.net:80/api/wow/item/1234567890
+    body: 
+    headers: 
+  response: !ruby/struct:VCR::Response
+    status: !ruby/struct:VCR::ResponseStatus
+      code: 404
+      message: Not Found
+    headers:
+      date:
+      - Mon, 30 Jan 2012 18:44:15 GMT
+      server:
+      - Apache
+      x-frame-options:
+      - SAMEORIGIN
+      content-length:
+      - '61'
+      vary:
+      - Accept-Encoding
+      content-type:
+      - application/json;charset=utf-8
+    body: ! '{"status":"nok", "reason": "unable to get item information."}'
+    http_version: '1.1'

data/spec/integration/arena_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
-require 'battlenet'
 
-describe Battlenet::Arena do
+describe Battlenet::Modules::Arena do
   let(:api) { Battlenet.new }
 
   it "fetches arena data" do

data/spec/integration/auction_spec.rb

@@ -1,9 +1,6 @@
-# "{\r\n\"realm\":{\"name\":\"Nazjatar\",\"slug\":\"nazjatar\"},\r\n\"alliance\":{\"auctions\":[\r\n\t{\"auc\":1329311139,\"item\":42989,\"owner\":\"Price\",\"bid\":15000000,
-
 require 'spec_helper'
-require 'battlenet'
 
-describe Battlenet::Auction do
+describe Battlenet::Modules::Auction do
   let(:api) { Battlenet.new }
 
   it "fetches auction data" do

data/spec/integration/character_spec.rb

@@ -1,9 +1,8 @@
 # encoding: utf-8
 
 require 'spec_helper'
-require 'battlenet'
 
-describe Battlenet::Character do
+describe Battlenet::Modules::Character do
   let(:api) { Battlenet.new }
 
   it "fetches character data" do

data/spec/integration/data_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
-require 'battlenet'
 
-describe Battlenet::Data do
+describe Battlenet::Modules::Data do
   let(:api) { Battlenet.new }
 
   it "fetches character races data" do

data/spec/integration/exception_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe Battlenet::ApiException do
+  let(:api) { Battlenet.new }
+
+  it "raises an exception with the reason and code set" do
+    VCR.use_cassette('not_found') do
+      begin
+        item = api.item '1234567890'
+      rescue Battlenet::ApiException => e
+        e.code.should == 404
+        e.reason.should == 'unable to get item information.'
+      end
+    end
+  end
+end

data/spec/integration/guild_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
-require 'battlenet'
 
-describe Battlenet::Guild do
+describe Battlenet::Modules::Guild do
   let(:api) { Battlenet.new }
 
   it "fetches guild data" do

data/spec/integration/item_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
-require 'battlenet'
 
-describe Battlenet::Item do
+describe Battlenet::Modules::Item do
   let(:api) { Battlenet.new }
 
   it "fetches item data" do

data/spec/integration/locale_spec.rb

@@ -1,7 +1,6 @@
 # encoding: utf-8
 
 require 'spec_helper'
-require 'battlenet'
 
 describe Battlenet do
   let(:api) { Battlenet.new }

data/spec/integration/quest_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
-require 'battlenet'
 
-describe Battlenet::Quest do
+describe Battlenet::Modules::Quest do
   let(:api) { Battlenet.new }
 
   it "fetches quest data" do

data/spec/integration/realm_spec.rb

@@ -1,9 +1,8 @@
 # encoding: utf-8
 
 require 'spec_helper'
-require 'battlenet'
 
-describe Battlenet::Realm do
+describe Battlenet::Modules::Realm do
   let(:api) { Battlenet.new }
 
   it "fetches realm data" do

data/spec/integration/recipe_spec.rb

@@ -1,7 +1,6 @@
 require 'spec_helper'
-require 'battlenet'
 
-describe Battlenet::Recipe do
+describe Battlenet::Modules::Recipe do
   let(:api) { Battlenet.new }
 
   it "fetches recipe data" do

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+require 'battlenet'
+
 require 'timecop'
 require 'vcr'
 

data/spec/unit/battlenet_authentication_spec.rb

@@ -1,5 +1,4 @@
 require 'spec_helper'
-require 'battlenet/authentication'
 
 describe Battlenet::Authentication do
   let(:auth) { Battlenet::Authentication.new 'private' }

data/spec/unit/battlenet_spec.rb

@@ -1,6 +1,4 @@
 require 'spec_helper'
-require 'battlenet'
-require 'battlenet/authentication'
 
 describe Battlenet do
   before(:each) do
@@ -36,34 +34,17 @@ describe Battlenet do
     end
   end
 
-  context "#fullpath" do
-    it "returns the full path for the resource" do
-      api = Battlenet.new
-      api.instance_variable_set(:@endpoint, "/test/testing")
-      api.fullpath("/thetest").should == "/test/testing/thetest"
-    end
-  end
-
   context "#get" do
     let(:api) { Battlenet.new :us }
 
-    it "delegates to #make_request" do
-      api.should_receive(:make_request).with(:get, '/test', {})
-      api.get '/test'
-    end
-  end
-
-  context "#make_request" do
-    let(:api) { Battlenet.new :us }
-
     it "delegates to HTTParty" do
       Battlenet.should_receive(:get).with('/test', {})
-      api.make_request :get, '/test'
+      api.get '/test'
     end
 
     it "passes query string parameters to HTTParty" do
       Battlenet.should_receive(:get).with('/test', {:query => {:fields => 'talents'}})
-      api.make_request :get, '/test', :fields => 'talents'
+      api.get '/test', :fields => 'talents'
     end
 
     context "when the locale is set" do
@@ -77,7 +58,7 @@ describe Battlenet do
 
       it "adds the locale parameter to the query string" do
         Battlenet.should_receive(:get).with('/test', {:query => {:fields => 'talents', :locale => 'es_ES'}})
-        api.make_request :get, '/test', :fields => 'talents'
+        api.get '/test', :fields => 'talents'
       end
     end
 
@@ -94,20 +75,41 @@ describe Battlenet do
 
       it "signs the request if the public and private key are present" do
         api.should_receive(:sign_request).with(:get, '/test', Time.now)
-        api.make_request :get, '/test'
+        api.get '/test'
       end
 
       it "sets the Authorization and Date headers" do
         Battlenet::Authentication.any_instance.stub(:sign).and_return("signature")
         Battlenet.should_receive(:get).with('/test', :headers => { "Authorization" => "BNET public:signature", "Date" => Time.now.httpdate })
-        api.make_request :get, '/test'
+        api.get '/test'
       end
     end
 
-    context "when the response does not have a 200 status code" do
+    context "when the public and private key are set" do
+      let(:api) { Battlenet.new :us, 'public', 'private' }
+
       before(:each) do
-        response = mock(:response).as_null_object
-        response.should_receive(:code).at_least(:once).and_return(500)
+        Timecop.freeze
+      end
+
+      after(:each) do
+        Timecop.return
+      end
+
+      it "signs the request using the full path" do
+        api.instance_variable_set(:@endpoint, "/tester/testing")
+        auth = mock(:auth)
+        Battlenet::Authentication.should_receive(:new).with('private').and_return(auth)
+        auth.should_receive(:sign).with(:get, '/tester/testing/test', Time.now)
+        api.get '/test'
+      end
+    end
+
+    context "when the response does not have a status code indicating success" do
+      before(:each) do
+        response = stub(:response).as_null_object
+        response.stub(:code).and_return(500)
+        response.stub(:[]).with('reason').and_return('Server Error')
         Battlenet.should_receive(:get).and_return(response)
       end
 
@@ -115,7 +117,16 @@ describe Battlenet do
         it "throws an exception" do
           lambda {
             api.get '/test'
-          }.should raise_error
+          }.should raise_error(Battlenet::ApiException)
+        end
+
+        it "throws an exception with the code and reason set" do
+          begin
+            api.get '/test'
+          rescue Battlenet::ApiException => ex
+            ex.code.should == 500
+            ex.reason.should == 'Server Error'
+          end
         end
       end
 
@@ -132,23 +143,4 @@ describe Battlenet do
       end
     end
   end
-
-  context "#sign_request" do
-    let(:api) { Battlenet.new :us, 'public', 'private' }
-
-    before(:each) do
-      Timecop.freeze
-    end
-
-    after(:each) do
-      Timecop.return
-    end
-
-    it "delegates to a Battlenet::Authentication" do
-      auth = mock(:auth)
-      Battlenet::Authentication.should_receive(:new).with('private').and_return(auth)
-      auth.should_receive(:sign).with(:get, api.fullpath('/test'), Time.now)
-      api.sign_request :get, '/test', Time.now
-    end
-  end
 end

data/spec/unit/exceptions/api_exception_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe Battlenet::ApiException do
+  let(:response) do
+    resp = stub(:response)
+    resp.stub(:code).and_return(500)
+    resp.stub(:[]).with('reason').and_return('Bad Juju!')
+    resp
+  end
+  let(:ex) { Battlenet::ApiException.new(response) }
+
+  it "gives access to the response" do
+    ex.response.should == response
+  end
+
+  it "has a status code based on the HTTP response code" do
+    ex.code.should == 500
+  end
+
+  it "has a reason based on the response" do
+    ex.reason.should == 'Bad Juju!'
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: battlenet
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-19 00:00:00.000000000 Z
+date: 2012-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70242126812520 !ruby/object:Gem::Requirement
+  requirement: &70256286926140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70242126812520
+  version_requirements: *70256286926140
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70242126811520 !ruby/object:Gem::Requirement
+  requirement: &70256286925340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70242126811520
+  version_requirements: *70256286925340
 - !ruby/object:Gem::Dependency
   name: timecop
-  requirement: &70242126810420 !ruby/object:Gem::Requirement
+  requirement: &70256286924780 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70242126810420
+  version_requirements: *70256286924780
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70242126808840 !ruby/object:Gem::Requirement
+  requirement: &70256286924040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70242126808840
+  version_requirements: *70256286924040
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70242126807740 !ruby/object:Gem::Requirement
+  requirement: &70256286923360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70242126807740
+  version_requirements: *70256286923360
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70242126806520 !ruby/object:Gem::Requirement
+  requirement: &70256286922380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70242126806520
+  version_requirements: *70256286922380
 description: Easily consume Blizzard's Community Platform API.
 email:
 - brandon@brandontilley.com
@@ -85,14 +85,17 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .yardopts
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
-- VERSION
 - battlenet.gemspec
 - lib/battlenet.rb
 - lib/battlenet/authentication.rb
+- lib/battlenet/battlenet.rb
+- lib/battlenet/exceptions/api_exception.rb
 - lib/battlenet/modules/arena.rb
 - lib/battlenet/modules/auction.rb
 - lib/battlenet/modules/character.rb
@@ -102,6 +105,7 @@ files:
 - lib/battlenet/modules/quest.rb
 - lib/battlenet/modules/realm.rb
 - lib/battlenet/modules/recipe.rb
+- lib/battlenet/version.rb
 - spec/fixtures/cassettes/arena_fun_and_profit.yml
 - spec/fixtures/cassettes/auction_data.yml
 - spec/fixtures/cassettes/auction_files.yml
@@ -119,6 +123,7 @@ files:
 - spec/fixtures/cassettes/guild_rl_bl_members.yml
 - spec/fixtures/cassettes/item_classes.yml
 - spec/fixtures/cassettes/item_hooooooooooo.yml
+- spec/fixtures/cassettes/not_found.yml
 - spec/fixtures/cassettes/quest.yml
 - spec/fixtures/cassettes/realm.yml
 - spec/fixtures/cassettes/recipe.yml
@@ -126,6 +131,7 @@ files:
 - spec/integration/auction_spec.rb
 - spec/integration/character_spec.rb
 - spec/integration/data_spec.rb
+- spec/integration/exception_spec.rb
 - spec/integration/guild_spec.rb
 - spec/integration/item_spec.rb
 - spec/integration/locale_spec.rb
@@ -135,6 +141,7 @@ files:
 - spec/spec_helper.rb
 - spec/unit/battlenet_authentication_spec.rb
 - spec/unit/battlenet_spec.rb
+- spec/unit/exceptions/api_exception_spec.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -149,7 +156,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -61764017107044446
+      hash: -4028223274569724096
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -158,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -61764017107044446
+      hash: -4028223274569724096
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
@@ -183,6 +190,7 @@ test_files:
 - spec/fixtures/cassettes/guild_rl_bl_members.yml
 - spec/fixtures/cassettes/item_classes.yml
 - spec/fixtures/cassettes/item_hooooooooooo.yml
+- spec/fixtures/cassettes/not_found.yml
 - spec/fixtures/cassettes/quest.yml
 - spec/fixtures/cassettes/realm.yml
 - spec/fixtures/cassettes/recipe.yml
@@ -190,6 +198,7 @@ test_files:
 - spec/integration/auction_spec.rb
 - spec/integration/character_spec.rb
 - spec/integration/data_spec.rb
+- spec/integration/exception_spec.rb
 - spec/integration/guild_spec.rb
 - spec/integration/item_spec.rb
 - spec/integration/locale_spec.rb
@@ -199,3 +208,5 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/battlenet_authentication_spec.rb
 - spec/unit/battlenet_spec.rb
+- spec/unit/exceptions/api_exception_spec.rb
+has_rdoc: 

data/VERSION

@@ -1 +0,0 @@
-1.2.0