starcraft2 0.0.1

data/lib/sc2/achievement.rb

@@ -0,0 +1,20 @@
+module SC2
+  class Achievement
+    attr_accessor :title, :description, :achievement_id, :category_id, :points, :icon
+
+    def initialize(options = {})
+      options.each do |k,v|
+        self.send(:"#{k}=", v)
+      end
+    end
+
+    def self.build_achievements(raw_data)
+      data = JSON.parse(raw_data)
+      data['achievements'].map do |achievement|
+        achievement['achievement_id'] = achievement.delete('achievementId')
+        achievement['category_id'] = achievement.delete('categoryId')
+        new(achievement)
+      end
+    end
+  end
+end

data/lib/sc2/client.rb

@@ -0,0 +1,28 @@
+module SC2
+  class Client
+    ACHIEVEMENTS_PATH = "/api/sc2/data/achievements"
+
+    attr_accessor :locale, :host
+
+    def initialize(options)
+      options.each do |k,v|
+        self.send(:"#{k}=", v)
+      end
+    end
+
+    def achievements
+      Achievement.build_achievements(achievements_data)
+    end
+
+    private
+
+    def achievements_data
+      HTTParty.get(achievements_url).body
+    end
+
+    def achievements_url
+      current_locale = locale.nil? ? '' : "?locale=#{locale}"
+      "http://" + host + ACHIEVEMENTS_PATH + current_locale
+    end
+  end
+end

data/lib/sc2/loader.rb

@@ -0,0 +1,5 @@
+require 'httparty'
+require 'json'
+require File.join('sc2', 'client')
+require File.join('sc2', 'achievement')
+require File.join('sc2', 'reward')

data/lib/sc2/reward.rb

@@ -0,0 +1,20 @@
+module SC2
+  class Reward
+    attr_accessor :title, :id, :icon, :achievement_id
+
+    def initialize(options = {})
+      options.each do |k,v|
+        self.send(:"#{k}=", v)
+      end
+    end
+
+    def self.build_rewards(raw_data)
+      data = JSON.parse(raw_data)
+      data['portraits'].map do |reward|
+        reward['achievement_id'] = reward.delete('achievementId')
+        new(reward)
+      end
+    end
+
+  end
+end

data/lib/starcraft2.rb

@@ -0,0 +1 @@
+require File.join('sc2', 'loader.rb')

data/sc2.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |gem|
+  gem.add_dependency 'httparty'
+
+  gem.authors       = ["Josh Ellithorpe", "James Fickel", "Jan Hein Hoogstad"]
+  gem.email         = ["quest@mac.com"]
+  gem.description   = %q{A small SC2 api wrapper}
+  gem.summary       = %q{A small SC2 api wrapper}
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  gem.name          = "starcraft2"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.0.1"
+
+  gem.add_development_dependency 'rspec', '~> 2.6.0'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'webmock', '1.11'
+end

data/spec/sc2/achievement_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe SC2::Achievement do
+  describe '#build_achievements' do
+    let(:achievements) { SC2::Achievement.build_achievements(@raw_achievement_data)}
+
+    before do
+      VCR.use_cassette('achievements') do
+        @raw_achievement_data = HTTParty.get('http://us.battle.net/api/sc2/data/achievements').body
+      end
+    end
+
+    it 'should build an array of achievements' do
+      achievements.class.should == Array
+      achievements.each do |a|
+        a.class.should == SC2::Achievement
+      end
+    end
+  end
+
+  describe '.initialize' do
+    let(:achievement) {SC2::Achievement.new(@options)}
+
+    before do
+      @options = {}
+    end
+
+    it 'should store the title' do
+      @options = {:title => 'Test Title'}
+      achievement.title.should == 'Test Title'
+    end
+
+    it 'should store the description' do
+      @options = {:description => 'Description'}
+      achievement.description.should == 'Description'
+    end
+
+    it 'should store the achievement id' do
+      @options = {:achievement_id => 5}
+      achievement.achievement_id.should == 5
+    end
+
+    it 'should store the category id' do
+      @options = {:category_id => 10}
+      achievement.category_id.should == 10
+    end
+
+    it 'should store the points' do
+      @options = {:points => 5}
+      achievement.points.should == 5
+    end
+
+    it 'should store the icon data' do
+      @options = {:icon => {:x => 1, :y => 2, :w => 3, :h => 4, :offset => 0, :url => 'http://example.com'}}
+      achievement.icon.should == {:x => 1, :y => 2, :w => 3, :h => 4, :offset => 0, :url => 'http://example.com'}
+    end
+  end
+end

data/spec/sc2/client_spec.rb

@@ -0,0 +1,45 @@
+require "spec_helper"
+
+describe SC2::Client do
+  let(:client) { SC2::Client.new(@options)}
+
+  before do
+    @options = {:host => 'us.battle.net'}
+  end
+
+  context 'url constants' do
+    it 'should store the achievements url' do
+      SC2::Client::ACHIEVEMENTS_PATH.should == '/api/sc2/data/achievements'
+    end
+  end
+
+  it 'should store the locale' do
+    @options = { :locale => 'en_US' }
+    client.locale.should == 'en_US'
+  end
+
+  it 'should store the host' do
+    @options = { :host => 'someserver.com'}
+    client.host.should == 'someserver.com'
+  end
+
+  it 'should return an array of achievements' do
+    VCR.use_cassette('achievements') do
+      client.achievements.class.should == Array
+    end
+  end
+
+  it 'should return items of type SC2::Achievement' do
+    VCR.use_cassette('achievements') do
+      client.achievements.first.class.should == SC2::Achievement
+    end
+  end
+
+  it "should return achievements in the correct locale" do
+    @options.merge!({:locale => "pt_BR"})
+
+    VCR.use_cassette('achievements') do
+      client.achievements.first.title.should == "TCT Destruidor"
+    end
+  end
+end

data/spec/sc2/reward_spec.rb

@@ -0,0 +1,48 @@
+require "spec_helper"
+
+describe SC2::Reward do
+  describe '#build_rewards' do
+    let(:rewards) { SC2::Reward.build_rewards(@raw_reward_data)}
+
+    before do
+      VCR.use_cassette('rewards') do
+        @raw_reward_data = HTTParty.get('http://us.battle.net/api/sc2/data/rewards').body
+      end
+    end
+
+    it 'should build an array of rewards' do
+      rewards.class.should == Array
+      rewards.each do |r|
+        r.class.should == SC2::Reward
+      end
+    end
+  end
+
+  describe '.initialize' do
+    let(:reward) {SC2::Reward.new(@options)}
+
+    before do
+      @options = {}
+    end
+
+    it 'should store the title' do
+      @options = {:title => 'Test Title'}
+      reward.title.should == 'Test Title'
+    end
+
+    it 'should store the id' do
+      @options = {:id => 3}
+      reward.id.should == 3 
+    end
+
+    it 'should store the icon data' do
+      @options = {:icon => {:x => 1, :y => 2, :w => 3, :h => 4, :offset => 0, :url => 'http://example.com'}}
+      reward.icon.should == {:x => 1, :y => 2, :w => 3, :h => 4, :offset => 0, :url => 'http://example.com'}
+    end
+
+    it "should store the achievement id" do
+      @options = {:achievement_id => 5}
+      reward.achievement_id.should == 5
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require File.join('bundler', 'setup')
+require 'rspec'
+require 'vcr'
+require 'starcraft2'
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'fixtures/vcr_cassettes'
+  c.hook_into :webmock
+  c.default_cassette_options = { :record => :new_episodes, :erb => true }
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: starcraft2
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Josh Ellithorpe
+- James Fickel
+- Jan Hein Hoogstad
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: '1.11'
+description: A small SC2 api wrapper
+email:
+- quest@mac.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-version
+- .rvmrc
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- fixtures/vcr_cassettes/achievements.yml
+- fixtures/vcr_cassettes/rewards.yml
+- lib/sc2/achievement.rb
+- lib/sc2/client.rb
+- lib/sc2/loader.rb
+- lib/sc2/reward.rb
+- lib/starcraft2.rb
+- sc2.gemspec
+- spec/sc2/achievement_spec.rb
+- spec/sc2/client_spec.rb
+- spec/sc2/reward_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2271089934831786972
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2271089934831786972
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: A small SC2 api wrapper
+test_files: []