sc2ranks 0.1.2 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. data/README.rdoc +35 -18
  2. data/VERSION +1 -1
  3. data/sc2ranks.gemspec +1 -1
  4. metadata +3 -3
@@ -22,23 +22,23 @@ of the Sc2ranks object with a battle.net profile url:
22
22
 
23
23
  This will return an object with the following methods
24
24
 
25
- * name:: Character name
26
- * bnet_id:: Battle.net ID
27
- * region:: Battle.net region
28
- * id:: Sc2ranks id
29
- * updated_at:: When the sc2ranks data was last updated
30
- * achievement_points:: Current achievement point total
31
- * character_code:: Character Code (sc2ranks won't have access to these anymore)
32
- * portrait:: Portrait object with portrait data
33
- * teams:: An array of Team objects with team data
25
+ +name+:: Character name
26
+ +bnet_id+:: Battle.net ID
27
+ +region+:: Battle.net region
28
+ +id+:: Sc2ranks id
29
+ +updated_at+:: When the sc2ranks data was last updated
30
+ +achievement_points+:: Current achievement point total
31
+ +character_code+:: Character Code (sc2ranks won't have access to these anymore)
32
+ +portrait+:: Portrait object with portrait data
33
+ +teams+:: An array of Team objects with team data
34
34
 
35
35
  == Portrait Data
36
36
 
37
37
  The portrait object contains the following fields
38
38
 
39
- * icon_id:: Which icon graphic to use
40
- * column:: Which column in the graphic to use
41
- * row:: Which row in the graphic to use
39
+ +icon_id+:: Which icon graphic to use
40
+ +column+:: Which column in the graphic to use
41
+ +row+:: Which row in the graphic to use
42
42
 
43
43
  Please see http://sc2ranks.com/api for more information on using this data.
44
44
 
@@ -47,24 +47,41 @@ Please see http://sc2ranks.com/api for more information on using this data.
47
47
  To get to a certain team quick you can use the team method on your Character
48
48
  object
49
49
 
50
- character.team(bracket, is_random)
50
+ team = character.team(bracket, is_random)
51
51
 
52
52
  Bracket can be 1 through 4. The is_random parameter defaults to false so you
53
53
  don't need to use it. Team data does not include team members yet.
54
54
 
55
- If you call this with 1 you get the 1v1 team immediately (or nil if it doesn't exist)
55
+ If you call this with 1 you get the 1v1 team immediately (or nil if it doesn't
56
+ exist.)
56
57
 
57
58
  If you call it with any other parameters you get an array of teams (or [] if
58
- there are none)
59
+ there are none.)
59
60
 
60
61
  # Get 1v1 team
61
- character.team(1)
62
+ team = character.team(1)
62
63
 
63
64
  # Get 2v2 random team
64
- character.team(2, true)
65
+ team = character.team(2, true)
65
66
 
66
67
  # Get 4v4 teams
67
- character.team(4)
68
+ team = character.team(4)
69
+
70
+ Once you get the team you can use the following methods to reach the data.
71
+
72
+ +bracket+:: The number of the bracket (1, 2, 3 or 4)
73
+ +is_random+:: Whether this is a random team (true or false)
74
+ +fav_race+:: Race most played for this team (zerg, terran or protoss)
75
+ +updated_at+:: Time that sc2ranks.com last updated this team's data
76
+ +league+:: League that this team is currently in (bronze, silver, gold, platinum or diamond)
77
+ +division+:: Division that this team is in
78
+ +division_rank+:: Current rank in that division
79
+ +world_rank+:: Current world rank
80
+ +region_rank+:: Current region rank
81
+ +wins+:: Number of wins
82
+ +losses+:: Number of losses
83
+ +points+:: Current ladder point total
84
+ +ratio+:: Ratio of wins to loses
68
85
 
69
86
  == Copyright
70
87
 
data/VERSION CHANGED
@@ -1 +1 @@
1
- 0.1.2
1
+ 0.1.3
@@ -5,7 +5,7 @@
5
5
 
6
6
  Gem::Specification.new do |s|
7
7
  s.name = %q{sc2ranks}
8
- s.version = "0.1.2"
8
+ s.version = "0.1.3"
9
9
 
10
10
  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
11
  s.authors = ["Christopher Giroir"]
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: sc2ranks
3
3
  version: !ruby/object:Gem::Version
4
- hash: 31
4
+ hash: 29
5
5
  prerelease: false
6
6
  segments:
7
7
  - 0
8
8
  - 1
9
- - 2
10
- version: 0.1.2
9
+ - 3
10
+ version: 0.1.3
11
11
  platform: ruby
12
12
  authors:
13
13
  - Christopher Giroir