sc2ranksapi 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.idea/
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'httparty', '~> 0.11.0'
+gem 'rspec', '~>2.12.0'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Andrew Wong
+
+MIT License
+
+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.md

@@ -0,0 +1,29 @@
+# Sc2ranksapi
+
+This gem is used to access the sc2ranks api as described here. http://www.sc2ranks.com/api.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sc2ranksapi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sc2ranksapi
+
+## Usage
+
+Just instantiate a new instance of the api, and make a character with the url from battle.net and you're good to go
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/sc2ranksapi.rb

@@ -0,0 +1,28 @@
+require 'httparty'
+require 'sc2ranksapi/character'
+
+class Sc2RanksApi
+  include HTTParty
+  format :json
+  base_uri "sc2ranks.com"
+
+  BNET_REGEX = %r{http://([a-zA-Z]+)\.battle\.net/sc2/[a-zA-Z0-9]+/profile/([0-9]+)/[01]/([a-zA-Z0-9]+)/}
+
+  def initialize(appKey)
+    self.class.default_params :appKey => appKey
+  end
+
+  def character(url)
+    region, char = parse_bnet_url url
+
+    json_response = self.class.get("/api/base/teams/#{region}/#{char}.json")
+
+    Character.new json_response.parsed_response
+  end
+
+  def parse_bnet_url(url)
+    Sc2RanksApi::BNET_REGEX =~ url
+    return $1, "#{$3}!#{$2}"
+  end
+
+end

data/lib/sc2ranksapi/character.rb

@@ -0,0 +1,27 @@
+require 'sc2ranksapi/team'
+
+class Sc2RanksApi
+  class Character
+    attr_reader :teams, :portrait, :region, :name, :achievement_points, :updated_at
+
+    def initialize(data)
+      @achievement_points = data["achievement_points"]
+      @name               = data["name"]
+      @region             = data["region"]
+      @updated_at         = data["updated_at"]
+
+      add_teams data["teams"]
+    end
+
+    def add_teams(teams_data)
+      @teams = Hash.new if @teams.nil?
+
+      teams_data.each do |team_data|
+        team = Team.new(team_data)
+        bracket = team_data["bracket"]
+        @teams[bracket] = Array.new if @teams[bracket].nil?
+        @teams[bracket] << team
+      end
+    end
+  end
+end

data/lib/sc2ranksapi/team.rb

@@ -0,0 +1,21 @@
+class Sc2RanksApi
+  class Team
+    attr_reader :world_rank, :region_rank, :division, :division_rank, :league, :points, :wins, :losses, :favorite_race
+
+    def initialize(data)
+      @world_rank    = data["world_rank"]
+      @region_rank   = data["region_rank"]
+      @division_rank = data["division_rank"]
+      @division      = data["division"]
+      @league        = data["league"]
+      @points        = data["points"]
+      @wins          = data["wins"]
+      @losses        = data["losses"]
+      @favorite_race = data["favorite_race"]
+    end
+
+    def ratio
+      @wins/(@wins + @losses)
+    end
+  end
+end

data/lib/sc2ranksapi/version.rb

@@ -0,0 +1,3 @@
+class Sc2RanksApi
+  VERSION = "0.0.1"
+end

data/sc2ranksapi.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sc2ranksapi/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andrew Wong"]
+  gem.email         = ["iamawong@outlook.com"]
+  gem.homepage      = "https://github.com/iamawong/sc2ranksapi"
+  gem.description   = "This gem allows you to access data from http://sc2ranks.com."
+  gem.summary       = "Gem to get Starcraft2 information about players."
+  gem.version       = Sc2RanksApi::VERSION
+
+  gem.add_dependency "httparty", "~> 0.11.0"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "sc2ranksapi"
+  gem.require_paths = ["lib"]
+end

data/spec/sc2ranksapi/character_spec.rb

@@ -0,0 +1,37 @@
+require '../spec_helper'
+
+describe Sc2RanksApi::Character do
+  before :each do
+    data = {
+        "achievement_points" => 1,
+        "name"               => "iamawong",
+        "region"             => "eu",
+        "updated_at"         => 123456,
+        "teams"              => []
+    }
+
+    @character = Sc2RanksApi::Character.new(data)
+  end
+
+  it 'should have one achievement point' do
+    @character.achievement_points.should eq 1
+  end
+
+  it 'should have correct name' do
+    @character.name.should eq 'iamawong'
+  end
+
+  it 'should have european region' do
+    @character.region.should eq 'eu'
+  end
+
+  it 'should be updated time correct' do
+    @character.updated_at.should eq 123456
+  end
+
+  it 'should have empty teams' do
+    @character.teams.should be_an_instance_of Hash
+
+    @character.teams.should be_empty
+  end
+end

data/spec/sc2ranksapi/team_spec.rb

@@ -0,0 +1,34 @@
+require '../spec_helper'
+
+describe Sc2RanksApi::Team do
+  before(:each) do
+    data  = {
+        "world_rank"    => 1,
+        "region_rank"   => 2,
+        "division"      => "alpha",
+        "division_rank" => 3,
+        "league"        => 'centauri',
+        "points"        => 4,
+        "wins"          => 5,
+        "losses"        => 6,
+        "favorite_race" => 'zerg'
+    }
+    @team = Sc2RanksApi::Team.new(data)
+  end
+
+  it 'should parse data' do
+    @team.world_rank.should eq 1
+    @team.region_rank.should eq 2
+    @team.division.should eq "alpha"
+    @team.division_rank.should eq 3
+    @team.league.should eq 'centauri'
+    @team.points.should eq 4
+    @team.wins.should eq 5
+    @team.losses.should eq 6
+    @team.favorite_race.should eq 'zerg'
+  end
+
+  it 'should have correct ratio' do
+    @team.ratio.should eq 5/(5+6)
+  end
+end

data/spec/sc2ranksapi_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Sc2RanksApi do
+  before(:each) do
+    @api = Sc2RanksApi.new "sc2ranksapitest.com"
+  end
+
+  it 'should have default params of hash' do
+    @api.class.default_params.should be_an_instance_of Hash
+  end
+
+  it 'should have app key as a default param' do
+    @api.class.default_params.should have_key :appKey
+  end
+
+  it 'should return a character' do
+    character = @api.character "http://us.battle.net/sc2/en/profile/844448/1/wong/"
+    character.should be_an_instance_of Sc2RanksApi::Character
+  end
+
+  describe 'parsing battle.net url' do
+    before(:each) do
+      @region, @user = @api.parse_bnet_url "http://us.battle.net/sc2/en/profile/844448/1/wong/"
+    end
+
+    it 'should parse the region' do
+      @region.should eq 'us'
+    end
+
+    it 'should parse the user correctly' do
+      @user.should eq 'wong!844448'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec'
+
+require File.dirname(__FILE__) + '/../lib/sc2ranksapi'
+require File.dirname(__FILE__) + '/../lib/sc2ranksapi/team'
+require File.dirname(__FILE__) + '/../lib/sc2ranksapi/character'

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: sc2ranksapi
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Wong
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-04 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.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description: This gem allows you to access data from http://sc2ranks.com.
+email:
+- iamawong@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sc2ranksapi.rb
+- lib/sc2ranksapi/character.rb
+- lib/sc2ranksapi/team.rb
+- lib/sc2ranksapi/version.rb
+- sc2ranksapi.gemspec
+- spec/sc2ranksapi/character_spec.rb
+- spec/sc2ranksapi/team_spec.rb
+- spec/sc2ranksapi_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/iamawong/sc2ranksapi
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Gem to get Starcraft2 information about players.
+test_files:
+- spec/sc2ranksapi/character_spec.rb
+- spec/sc2ranksapi/team_spec.rb
+- spec/sc2ranksapi_spec.rb
+- spec/spec_helper.rb