blizzard-community-api 1.0.0

data/Gemfile

@@ -0,0 +1,15 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+gem "json", "~> 1.6.3"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem "rcov", "~> 0.9.11"
+  gem "rspec", "~> 2.7.0"
+  gem "rdoc", "~> 3.11"
+end

data/Gemfile.lock

@@ -0,0 +1,33 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.6.3)
+    rake (0.9.2.2)
+    rcov (0.9.11)
+    rdoc (3.11)
+      json (~> 1.4)
+    rspec (2.7.0)
+      rspec-core (~> 2.7.0)
+      rspec-expectations (~> 2.7.0)
+      rspec-mocks (~> 2.7.0)
+    rspec-core (2.7.1)
+    rspec-expectations (2.7.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.6.4)
+  json (~> 1.6.3)
+  rcov (~> 0.9.11)
+  rdoc (~> 3.11)
+  rspec (~> 2.7.0)

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Eric Scholz
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,40 @@
+= Blizzard Community API RubyGem (blizzard-community-api-rubygem)
+
+This is a ruby client library to proxy requests to the Blizzard Community API. It has been built in a way to allow request creation and execution to happen asynchronously so you can queue up requests and load balance the execution to get around per-ip-address call limits.
+
+== Installing
+
+This is currently in pre-release. My test coverage is terrible and there may be a few architectural changes before I consider it complete. That being said, you're welcome to download it and use it as it is a functional work.
+
+Once I deem the release stable it will be available on popular rubygem distribution sites.
+
+== Usage
+
+There are requests based off of resources and actions in the API.
+For instance, to access a character's profile you would create a CharacterProfileRequest:
+
+# Request a character profile for Aven on Draenor
+request = CharacterProfileRequest.new("Aven","Draenor")
+# Execute the API call (subsequent calls to read on this object will return a stored object)
+request.read
+
+# Authorized requests
+auth_request = AuthorizedApiRequest.new(request, "public_key", "private_key")
+auth_request.read
+
+
+== Contributing to blizzard-community-api-rubygem
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Eric Scholz. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "blizzard-community-api"
+  gem.homepage = "http://github.com/escholz/blizzard-community-api-rubygem"
+  gem.license = "MIT"
+  gem.summary = %Q{Blizzard Community API Client Library}
+  gem.description = %Q{Ruby Implementation of Blizzard's Community API}
+  gem.email = "eric.scholz@gmail.com"
+  gem.authors = ["Eric Scholz"]
+  # dependencies defined in Gemfile
+end
+Jeweler::GemcutterTasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+RSpec::Core::RakeTask.new(:rcov) do |rcov|
+  rcov.rcov = true
+  rcov.rcov_opts = ['--exclude', 'spec']
+  rcov.rspec_opts = ["-c"]
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "battle.net #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/api_enums.rb

@@ -0,0 +1,65 @@
+module WOW
+  API_ROOT_PATH = "/api/wow"
+
+  API_LOCALES = [
+    :en_US,
+    :es_MX,
+    :en_GB,
+    :es_ES,
+    :fr_FR,
+    :ru_RU,
+    :de_DE,
+    :ko_KR,
+    :zh_TW,
+    :zh_CN,
+  ].freeze()
+
+  API_HOST_NAMES = {
+    :en_US => "us.battle.net",
+    :es_MX => "us.battle.net",
+    :en_GB => "eu.battle.net",
+    :es_ES => "eu.battle.net",
+    :fr_FR => "eu.battle.net",
+    :ru_RU => "eu.battle.net",
+    :de_DE => "eu.battle.net",
+    :ko_KR => "kr.battle.net",
+    :zh_TW => "tw.battle.net",
+    :zh_CN => "battlenet.com.cn",
+  }.freeze()
+
+  CHARACTER_PROFILE_FIELDS = {
+    :guild        => "guild",
+    :items        => "items",
+    :professions  => "professions",
+    :reputation   => "reputation",
+    :stats        => "stats",
+    :talents      => "talents",
+    :titles       => "titles",
+    :appearance   => "appearance",
+    :companions   => "companions",
+    :mounts       => "mounts",
+    :pets         => "pets",
+    :achievements => "achievements",
+    :progression  => "progression",
+    :pvp          => "pvp",
+    :quests       => "quests",
+  }.freeze()
+
+  GUILD_PROFILE_FIELDS = {
+    :members      => "members",
+    :achievements => "achievements",
+  }.freeze()
+
+  ARENA_TEAM_SIZES = [
+    "2v2",
+    "3v3",
+    "4v4",
+    "5v5",
+  ].freeze()
+
+  class HttpClientError < RuntimeError
+  end
+
+  class HttpServerError < RuntimeError
+  end
+end

data/lib/api_request.rb

@@ -0,0 +1,133 @@
+require "net/http"
+require "uri"
+require 'openssl'
+require "json"
+require "api_enums"
+require "configuration"
+
+module WOW
+  class ApiRequest
+    def invoke(options={})
+      if(options[:force_refresh] || @json_response.nil?)
+        raw_response = get_response(options)
+        return nil if(raw_response.nil?)
+        @json_response = JSON.parse(raw_response)
+        if (@json_response.has_key?('Error'))
+          raise(RuntimeError, "JsonParsingError: #{@json_response['Error']}")
+        end
+      end
+      @json_response
+    end
+
+    def initialize(options={})
+      @options = options
+    end
+
+    def locale
+      @options[:locale] ||= WOW::Configuration.default_locale
+    end
+
+    def last_modified
+      @options[:last_modified] ||= Time.at(0)
+    end
+
+    def uri
+      URI.parse("#{scheme}://#{hostname}#{path}#{hash_to_query_string(query)}")
+    end
+
+    def scheme
+      "http"
+    end
+
+    def hostname
+      API_HOST_NAMES[locale]
+    end
+
+    def path
+      API_ROOT_PATH
+    end
+
+    def query
+      {}
+    end
+
+    def headers
+      { "Date" => time_to_http_time(Time.now), "If-Modified-Since" => time_to_http_time(last_modified) }
+    end
+
+    protected
+
+    def use_ssl
+      false
+    end
+
+    def get_request
+      Net::HTTP::Get.new(uri.request_uri, headers)
+    end
+
+    def get_response(options={})
+      begin
+        http_response = nil
+        Net::HTTP::Proxy(get_proxy_host(options),
+                         get_proxy_port(options),
+                         get_proxy_username(options),
+                         get_proxy_password(options)).start(uri.host,
+                                                            uri.port,
+                                                            {
+                                                                :use_ssl => use_ssl,
+                                                                :verify_mode => OpenSSL::SSL::VERIFY_NONE
+                                                            }) do |http|
+          http_response = http.request(get_request)
+        end
+        if (http_response.kind_of?(Net::HTTPSuccess)) # 2XX
+          return http_response.body
+        elsif (http_response.kind_of?(Net::HTTPNotModified)) # 304
+          return nil # No Data
+        elsif (http_response.kind_of?(Net::HTTPClientError)) # 4XX
+          raise(HttpClientError, http_response.body)
+        elsif (http_response.kind_of?(Net::HTTPServerError)) # 5XX
+          raise(HttpServerError, http_response.body)
+        end
+        raise(RuntimeError, "Unknown Error")
+      rescue Timeout::Error => e
+        raise(e)
+      end
+    end
+
+    def get_proxy_host(options)
+      options[:proxy_host] ||= WOW::Configuration.default_proxy_host
+    end
+
+    def get_proxy_port(options)
+      options[:proxy_port] ||= WOW::Configuration.default_proxy_port
+    end
+
+    def get_proxy_username(options)
+      options[:proxy_username] ||= WOW::Configuration.default_proxy_username
+    end
+
+    def get_proxy_password(options)
+      options[:proxy_password] ||= WOW::Configuration.default_proxy_password
+    end
+
+    def time_to_http_time(time)
+      time.utc.strftime("%a, %d %b %Y %R:%S GMT")
+    end
+
+    def hash_to_query_string(hash)
+      "?" + hash.collect { |k,v| "#{uri_encode(k)}=#{uri_encode(v)}" }.join("&") unless(hash.empty?)
+    end
+
+    def uri_encode(raw)
+      if (raw.is_a?(Symbol))
+        return uri_encode(raw.to_s)
+      end
+      if (raw.is_a?(String))
+        return URI.escape(raw, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+      end
+      if (raw.is_a?(Array))
+        return raw.collect { |v| uri_encode(v) }.join(",")
+      end
+    end
+  end
+end

data/lib/api_requestor.rb

@@ -0,0 +1,5 @@
+module WOW
+  class ApiRequestor
+
+  end
+end

data/lib/arena_team_request.rb

@@ -0,0 +1,23 @@
+require 'api_request'
+
+module WOW
+  class ArenaTeamRequest < ApiRequest
+
+    def initialize(realm, team_size, team_name, options={})
+      super(options)
+      if(!realm.is_a?(String) || realm.empty? || !team_size.is_a?(String) || team_size.empty? || !team_name.is_a?(String) || team_name.empty?)
+        raise(SyntaxError, "Realm, TeamSize and TeamName must be non-empty string values")
+      end
+      @realm = realm
+      @team_size = team_size
+      @team_name = team_name
+    end
+
+    attr_reader :realm, :team_size, :team_name
+
+    def path
+      "#{super}/arena/#{uri_encode(realm)}/#{uri_encode(team_size)}/#{uri_encode(team_name)}"
+    end
+
+  end
+end

data/lib/authorized_api_request.rb

@@ -0,0 +1,62 @@
+require "api_request"
+require "base64"
+require "openssl"
+
+module WOW
+  ### Example of Authenticated Api Use:
+  ### character_api_request = BattleNet::Character.profile("Aven","Draenor",:fields => [:stats, :talents])
+  ### character_api_request_with_auth = AuthorizedApiRequest.new(character_api_request, "public_key", "private_key")
+  ### character_hash = character_api_request_with_auth.read
+  class AuthorizedApiRequest < ApiRequest
+
+    def initialize(api_request, public_key, private_key)
+      @api_request = api_request
+      @public_key = public_key
+      @private_key = private_key
+    end
+
+    def scheme
+      "https"
+    end
+
+    def locale
+      @api_request.locale
+    end
+
+    def hostname
+      @api_request.hostname
+    end
+
+    def path
+      @api_request.path
+    end
+
+    def query
+      @api_request.query
+    end
+
+    def last_modified
+      @api_request.last_modified
+    end
+
+    def headers
+      @api_request.headers.merge({ "Authorization" => authorization_header })
+    end
+
+    protected
+
+    def use_ssl
+      true
+    end
+
+    private
+
+    def authorization_header
+      "BNET #{@public_key}:#{signature}"
+    end
+
+    def signature
+      Base64.encode64((OpenSSL::HMAC.new(@private_key,"sha1") << "GET\n#{@api_request.headers["Date"]}\n#{uri.path}\n").digest)
+    end
+  end
+end