starcraft2 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 289ad66c7ad9a879f23a2dd1cd6cfb46e8c9247b
-  data.tar.gz: da8e93fe98d213bcb5f4bd6facc9670654aefaa8
+  metadata.gz: cb15e20a90aea49a917b6a8a61c916d2d0e4058e
+  data.tar.gz: e4e8f2dedc8737c76735f0441a7f3b42f7fbdb14
 SHA512:
-  metadata.gz: fa6f2fd509ed995ac62b979a032f343e6f2943bfb140a1d191668e21ab38f2c7a07340824f6c1c361bf2eb833f5af27d965de8f83f4fcce2e16b5aae6f0d063f
-  data.tar.gz: 7a9ab4656eb12cc34797ec034f19af93f896a59ca2ddc9003bde2fc34ef91e6bf44b7734cca46447fd8aafee94cf7ecaa0392cd16d5f750bcb8424a0792e31e1
+  metadata.gz: 88c2ab90efde9b8b816577212ab1a5d0bcf9f9055f616d23741073c17fa495827bc8d1920809ba861b42028c5ae5c5dd090344f36236dbd37661b63d9c732766
+  data.tar.gz: 7185e84ae6b5a64f8eef4b86ae3165c25cc4406fbacd693f2233b675eef6a9aa8e9aa22ecf613c2f071fe815e110a18bd0450c580d46b2cded2a4fd2aef36726

data/README.md

@@ -25,7 +25,7 @@ client = Starcraft2::Client.new(:host => 'us.battle.net', :locale => 'en_US')
 `Starcraft2::Profile` contains all profile information. Realm, character name and id can all be found in a player's profile url.
 
 ```ruby
-profile = client.profile(realm: 1, character_name: "Minigun", id: 288081)
+profile = client.profile(:realm => 1, :character_name => "Minigun", :id => 288081)
 ```
 
 **Call a player's league**
@@ -60,6 +60,16 @@ client.achievements
 client.rewards
 ```
 
+### Authorization
+
+If you require authorization then the changes are very simple. Just set the following two ENV variables.
+
+```
+STARCRAFT2_API_PRIVATE_KEY = <YOUR_PRIVATE_KEY>
+STARCRAFT2_API_PUBLIC_KEY = <YOUR_PUBLIC_KEY>
+```
+
+Once those are set, the gem will take care of the rest for you.
 
 ## Build Status
 [![Build Status](https://travis-ci.org/zquestz/starcraft2.png)](https://travis-ci.org/zquestz/starcraft2)

data/lib/starcraft2/client.rb

@@ -59,7 +59,7 @@ module Starcraft2
     def profile_data(options)
       memoize(:profile_data, options) do
         Utils.get_json do
-          HTTParty.get(profile_url(options))
+          WebResource.get(profile_url(options))
         end
       end
     end
@@ -75,7 +75,7 @@ module Starcraft2
     def match_data(options)
       memoize(:match_data, options) do
         Utils.get_json do
-          HTTParty.get(match_url(options))
+          WebResource.get(match_url(options))
         end
       end
     end
@@ -83,7 +83,7 @@ module Starcraft2
     def ladders_data(options)
       memoize(:ladders_data, options) do
         Utils.get_json do
-          HTTParty.get(ladders_url(options))
+          WebResource.get(ladders_url(options))
         end
       end
     end
@@ -99,7 +99,7 @@ module Starcraft2
     def achievements_data
       memoize(:achievements_data) do
         Utils.get_json do
-          HTTParty.get(achievements_url)
+          WebResource.get(achievements_url)
         end
       end
     end
@@ -111,7 +111,7 @@ module Starcraft2
     def rewards_data
       memoize(:rewards_data) do
         Utils.get_json do
-          HTTParty.get(rewards_url)
+          WebResource.get(rewards_url)
         end
       end
     end
@@ -123,7 +123,7 @@ module Starcraft2
     def ladder_data(id)
       memoize(:ladder_data, id) do
         Utils.get_json do
-          HTTParty.get(ladder_url(id))
+          WebResource.get(ladder_url(id))
         end
       end
     end
@@ -146,4 +146,4 @@ module Starcraft2
       end
     end
   end
-end
+end

data/lib/starcraft2/loader.rb

@@ -1,14 +1,16 @@
 require 'httparty'
 require 'json'
 
-Dir[File.join("#{File.expand_path File.dirname(__FILE__)}", 'errors', '*.rb')].each do |file|
+base = File.expand_path File.dirname(__FILE__)
+
+Dir[File.join(base, 'errors', '*.rb')].each do |file|
   require file
 end
 
-Dir[File.join("#{File.expand_path File.dirname(__FILE__)}", 'profile', '*.rb')].each do |file|
+Dir[File.join(base, 'profile', '*.rb')].each do |file|
   require file
 end
 
-Dir[File.join("#{File.expand_path File.dirname(__FILE__)}", '*.rb')].each do |file|
+Dir[File.join(base, '*.rb')].each do |file|
   require file
 end

data/lib/starcraft2/web_resource.rb

@@ -0,0 +1,33 @@
+require 'base64'
+require 'hmac-sha1'
+require 'addressable/uri'
+
+class WebResource
+  def self.get(url)
+    private_key = ENV['STARCRAFT2_API_PRIVATE_KEY']
+    public_key = ENV['STARCRAFT2_API_PUBLIC_KEY']
+    date = Time.now.gmtime.rfc2822.gsub("-0000", "GMT")
+    response = if public_key && private_key
+      HTTParty.get(url,
+       :headers => { "Date" => date,
+                     "Authorization" => "BNET #{public_key}:#{signature(url, private_key, date)}"})
+    else
+      HTTParty.get(url)
+    end
+  end
+
+  def self.signature(url, private_key, date)
+    url_path = ::Addressable::URI.parse(url).path
+
+    signature = <<-EOF
+GET
+#{date}
+#{url_path}
+EOF
+
+    hmac = HMAC::SHA1.new(private_key.encode('UTF-8'))
+    hmac.update(signature)
+
+    Base64.encode64(hmac.digest)
+  end
+end

data/spec/starcraft2/achievement_spec.rb

@@ -59,7 +59,7 @@ describe Starcraft2::Achievement do
 
     it 'should import the achievements from blizzard' do
       VCR.use_cassette('achievements') do
-        @achievement = Starcraft2::Achievement.build(JSON.parse(HTTParty.get('https://us.battle.net/api/sc2/data/achievements').body)).first
+        @achievement = Starcraft2::Achievement.build(JSON.parse(WebResource.get('https://us.battle.net/api/sc2/data/achievements').body)).first
       end
 
       @achievement.title.should == 'FFA Destroyer'

data/spec/starcraft2/ladder_spec.rb

@@ -8,7 +8,7 @@ describe Starcraft2::Ladder do
 
     before do
       VCR.use_cassette("ladder_#{id}") do
-        @raw_ladder_data = JSON.parse(HTTParty.get("https://us.battle.net/api/sc2/ladder/#{id}").body)
+        @raw_ladder_data = JSON.parse(WebResource.get("https://us.battle.net/api/sc2/ladder/#{id}").body)
       end
     end
 

data/spec/starcraft2/profile_spec.rb

@@ -9,7 +9,7 @@ describe Starcraft2::Profile do
 
     before do
       VCR.use_cassette('profile_999000') do
-        @profile = JSON.parse(HTTParty.get('https://us.battle.net/api/sc2/profile/999000/1/DayNine/').body)
+        @profile = JSON.parse(WebResource.get('https://us.battle.net/api/sc2/profile/999000/1/DayNine/').body)
       end
     end
 

data/spec/starcraft2/reward_spec.rb

@@ -32,7 +32,7 @@ describe Starcraft2::Reward do
 
     before do
       VCR.use_cassette('rewards') do
-        @rewards = JSON.parse(HTTParty.get('https://us.battle.net/api/sc2/data/rewards').body)
+        @rewards = JSON.parse(WebResource.get('https://us.battle.net/api/sc2/data/rewards').body)
       end
     end
 

data/spec/starcraft2/utils_spec.rb

@@ -133,4 +133,4 @@ describe Starcraft2::Utils do
       end
     end
   end
-end
+end

data/starcraft2.gemspec

@@ -2,6 +2,7 @@
 Gem::Specification.new do |gem|
   gem.add_dependency 'httparty'
   gem.add_dependency 'json'
+  gem.add_dependency 'ruby-hmac'
 
   gem.authors       = ["Josh Ellithorpe", "James Fickel", "Jan Hein Hoogstad"]
   gem.email         = ["quest@mac.com"]
@@ -14,7 +15,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {spec}/*`.split("\n")
   gem.name          = "starcraft2"
   gem.require_paths = ["lib"]
-  gem.version       = "0.2.1"
+  gem.version       = "0.3.0"
 
   gem.add_development_dependency 'rspec', '~> 2.6.0'
   gem.add_development_dependency 'rake'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: starcraft2
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Josh Ellithorpe
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-16 00:00:00.000000000 Z
+date: 2013-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -40,6 +40,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-hmac
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -161,6 +175,7 @@ files:
 - lib/starcraft2/profile/swarm_race.rb
 - lib/starcraft2/reward.rb
 - lib/starcraft2/utils.rb
+- lib/starcraft2/web_resource.rb
 - spec/spec_helper.rb
 - spec/starcraft2/achievement_spec.rb
 - spec/starcraft2/character_spec.rb
@@ -206,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: A small SC2 api wrapper