steam-condenser 1.3.5 → 1.3.6

Sign up to get free protection for your applications and to get access to all the features.
Files changed (161) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +228 -0
  3. data/CONTRIBUTING.md +59 -0
  4. data/Gemfile.lock +12 -13
  5. data/README.md +9 -4
  6. data/lib/steam-condenser/version.rb +1 -1
  7. data/lib/steam/community/alien_swarm/alien_swarm_mission.rb +10 -9
  8. data/lib/steam/community/alien_swarm/alien_swarm_stats.rb +74 -72
  9. data/lib/steam/community/css/css_map.rb +2 -2
  10. data/lib/steam/community/css/css_stats.rb +54 -56
  11. data/lib/steam/community/css/css_weapon.rb +4 -4
  12. data/lib/steam/community/game_item.rb +2 -3
  13. data/lib/steam/community/game_leaderboard.rb +22 -15
  14. data/lib/steam/community/l4d/abstract_l4d_stats.rb +64 -61
  15. data/lib/steam/community/l4d/l4d2_stats.rb +26 -21
  16. data/lib/steam/community/steam_id.rb +8 -11
  17. data/lib/steam/community/web_api.rb +19 -14
  18. data/lib/steam/packets/s2a_info2_packet.rb +16 -14
  19. data/lib/steam/packets/s2a_info_detailed_packet.rb +24 -19
  20. data/lib/steam/packets/steam_packet_factory.rb +7 -2
  21. data/lib/steam/servers/game_server.rb +3 -2
  22. data/lib/steam/servers/master_server.rb +1 -1
  23. data/lib/steam/sockets/source_socket.rb +4 -9
  24. data/pkg/steam-condenser-1.3.5.gem +0 -0
  25. data/pkg/steam-condenser-1.3.5/Gemfile +7 -0
  26. data/pkg/steam-condenser-1.3.5/Gemfile.lock +45 -0
  27. data/pkg/steam-condenser-1.3.5/LICENSE +25 -0
  28. data/pkg/steam-condenser-1.3.5/README.md +70 -0
  29. data/pkg/steam-condenser-1.3.5/Rakefile +46 -0
  30. data/pkg/steam-condenser-1.3.5/lib/core_ext/stringio.rb +91 -0
  31. data/pkg/steam-condenser-1.3.5/lib/errors/packet_format_error.rb +13 -0
  32. data/pkg/steam-condenser-1.3.5/lib/errors/rcon_ban_error.rb +22 -0
  33. data/pkg/steam-condenser-1.3.5/lib/errors/rcon_no_auth_error.rb +21 -0
  34. data/pkg/steam-condenser-1.3.5/lib/errors/steam_condenser_error.rb +26 -0
  35. data/pkg/steam-condenser-1.3.5/lib/errors/timeout_error.rb +28 -0
  36. data/pkg/steam-condenser-1.3.5/lib/errors/web_api_error.rb +57 -0
  37. data/pkg/steam-condenser-1.3.5/lib/steam-condenser.rb +18 -0
  38. data/pkg/steam-condenser-1.3.5/lib/steam-condenser/community.rb +24 -0
  39. data/pkg/steam-condenser-1.3.5/lib/steam-condenser/servers.rb +24 -0
  40. data/pkg/steam-condenser-1.3.5/lib/steam-condenser/version.rb +11 -0
  41. data/pkg/steam-condenser-1.3.5/lib/steam/community/alien_swarm/alien_swarm_mission.rb +119 -0
  42. data/pkg/steam-condenser-1.3.5/lib/steam/community/alien_swarm/alien_swarm_stats.rb +186 -0
  43. data/pkg/steam-condenser-1.3.5/lib/steam/community/alien_swarm/alien_swarm_weapon.rb +49 -0
  44. data/pkg/steam-condenser-1.3.5/lib/steam/community/app_news.rb +133 -0
  45. data/pkg/steam-condenser-1.3.5/lib/steam/community/cacheable.rb +199 -0
  46. data/pkg/steam-condenser-1.3.5/lib/steam/community/css/css_map.rb +61 -0
  47. data/pkg/steam-condenser-1.3.5/lib/steam/community/css/css_stats.rb +142 -0
  48. data/pkg/steam-condenser-1.3.5/lib/steam/community/css/css_weapon.rb +69 -0
  49. data/pkg/steam-condenser-1.3.5/lib/steam/community/defense_grid/defense_grid_stats.rb +238 -0
  50. data/pkg/steam-condenser-1.3.5/lib/steam/community/dods/dods_class.rb +90 -0
  51. data/pkg/steam-condenser-1.3.5/lib/steam/community/dods/dods_stats.rb +62 -0
  52. data/pkg/steam-condenser-1.3.5/lib/steam/community/dods/dods_weapon.rb +67 -0
  53. data/pkg/steam-condenser-1.3.5/lib/steam/community/dota2/dota2_beta_inventory.rb +30 -0
  54. data/pkg/steam-condenser-1.3.5/lib/steam/community/dota2/dota2_inventory.rb +30 -0
  55. data/pkg/steam-condenser-1.3.5/lib/steam/community/dota2/dota2_item.rb +33 -0
  56. data/pkg/steam-condenser-1.3.5/lib/steam/community/game_achievement.rb +109 -0
  57. data/pkg/steam-condenser-1.3.5/lib/steam/community/game_class.rb +22 -0
  58. data/pkg/steam-condenser-1.3.5/lib/steam/community/game_inventory.rb +171 -0
  59. data/pkg/steam-condenser-1.3.5/lib/steam/community/game_item.rb +156 -0
  60. data/pkg/steam-condenser-1.3.5/lib/steam/community/game_item_schema.rb +131 -0
  61. data/pkg/steam-condenser-1.3.5/lib/steam/community/game_leaderboard.rb +205 -0
  62. data/pkg/steam-condenser-1.3.5/lib/steam/community/game_leaderboard_entry.rb +43 -0
  63. data/pkg/steam-condenser-1.3.5/lib/steam/community/game_stats.rb +175 -0
  64. data/pkg/steam-condenser-1.3.5/lib/steam/community/game_weapon.rb +41 -0
  65. data/pkg/steam-condenser-1.3.5/lib/steam/community/l4d/abstract_l4d_stats.rb +185 -0
  66. data/pkg/steam-condenser-1.3.5/lib/steam/community/l4d/abstract_l4d_weapon.rb +56 -0
  67. data/pkg/steam-condenser-1.3.5/lib/steam/community/l4d/l4d2_map.rb +90 -0
  68. data/pkg/steam-condenser-1.3.5/lib/steam/community/l4d/l4d2_stats.rb +174 -0
  69. data/pkg/steam-condenser-1.3.5/lib/steam/community/l4d/l4d2_weapon.rb +38 -0
  70. data/pkg/steam-condenser-1.3.5/lib/steam/community/l4d/l4d_explosive.rb +34 -0
  71. data/pkg/steam-condenser-1.3.5/lib/steam/community/l4d/l4d_map.rb +65 -0
  72. data/pkg/steam-condenser-1.3.5/lib/steam/community/l4d/l4d_stats.rb +73 -0
  73. data/pkg/steam-condenser-1.3.5/lib/steam/community/l4d/l4d_weapon.rb +26 -0
  74. data/pkg/steam-condenser-1.3.5/lib/steam/community/portal2/portal2_inventory.rb +30 -0
  75. data/pkg/steam-condenser-1.3.5/lib/steam/community/portal2/portal2_item.rb +55 -0
  76. data/pkg/steam-condenser-1.3.5/lib/steam/community/portal2/portal2_stats.rb +33 -0
  77. data/pkg/steam-condenser-1.3.5/lib/steam/community/steam_game.rb +193 -0
  78. data/pkg/steam-condenser-1.3.5/lib/steam/community/steam_group.rb +129 -0
  79. data/pkg/steam-condenser-1.3.5/lib/steam/community/steam_id.rb +498 -0
  80. data/pkg/steam-condenser-1.3.5/lib/steam/community/tf2/tf2_beta_inventory.rb +28 -0
  81. data/pkg/steam-condenser-1.3.5/lib/steam/community/tf2/tf2_class.rb +92 -0
  82. data/pkg/steam-condenser-1.3.5/lib/steam/community/tf2/tf2_class_factory.rb +40 -0
  83. data/pkg/steam-condenser-1.3.5/lib/steam/community/tf2/tf2_engineer.rb +43 -0
  84. data/pkg/steam-condenser-1.3.5/lib/steam/community/tf2/tf2_golden_wrench.rb +70 -0
  85. data/pkg/steam-condenser-1.3.5/lib/steam/community/tf2/tf2_inventory.rb +30 -0
  86. data/pkg/steam-condenser-1.3.5/lib/steam/community/tf2/tf2_item.rb +55 -0
  87. data/pkg/steam-condenser-1.3.5/lib/steam/community/tf2/tf2_medic.rb +35 -0
  88. data/pkg/steam-condenser-1.3.5/lib/steam/community/tf2/tf2_sniper.rb +28 -0
  89. data/pkg/steam-condenser-1.3.5/lib/steam/community/tf2/tf2_spy.rb +41 -0
  90. data/pkg/steam-condenser-1.3.5/lib/steam/community/tf2/tf2_stats.rb +77 -0
  91. data/pkg/steam-condenser-1.3.5/lib/steam/community/web_api.rb +130 -0
  92. data/pkg/steam-condenser-1.3.5/lib/steam/community/xml_data.rb +27 -0
  93. data/pkg/steam-condenser-1.3.5/lib/steam/packets/a2m_get_servers_batch2_packet.rb +59 -0
  94. data/pkg/steam-condenser-1.3.5/lib/steam/packets/a2s_info_packet.rb +24 -0
  95. data/pkg/steam-condenser-1.3.5/lib/steam/packets/a2s_player_packet.rb +31 -0
  96. data/pkg/steam-condenser-1.3.5/lib/steam/packets/a2s_rules_packet.rb +32 -0
  97. data/pkg/steam-condenser-1.3.5/lib/steam/packets/a2s_serverquery_getchallenge_packet.rb +25 -0
  98. data/pkg/steam-condenser-1.3.5/lib/steam/packets/c2m_checkmd5_packet.rb +31 -0
  99. data/pkg/steam-condenser-1.3.5/lib/steam/packets/m2a_server_batch_packet.rb +52 -0
  100. data/pkg/steam-condenser-1.3.5/lib/steam/packets/m2c_isvalidmd5_packet.rb +34 -0
  101. data/pkg/steam-condenser-1.3.5/lib/steam/packets/m2s_requestrestart_packet.rb +34 -0
  102. data/pkg/steam-condenser-1.3.5/lib/steam/packets/rcon/rcon_auth_request.rb +28 -0
  103. data/pkg/steam-condenser-1.3.5/lib/steam/packets/rcon/rcon_auth_response.rb +30 -0
  104. data/pkg/steam-condenser-1.3.5/lib/steam/packets/rcon/rcon_exec_request.rb +28 -0
  105. data/pkg/steam-condenser-1.3.5/lib/steam/packets/rcon/rcon_exec_response.rb +37 -0
  106. data/pkg/steam-condenser-1.3.5/lib/steam/packets/rcon/rcon_goldsrc_request.rb +35 -0
  107. data/pkg/steam-condenser-1.3.5/lib/steam/packets/rcon/rcon_goldsrc_response.rb +34 -0
  108. data/pkg/steam-condenser-1.3.5/lib/steam/packets/rcon/rcon_packet.rb +57 -0
  109. data/pkg/steam-condenser-1.3.5/lib/steam/packets/rcon/rcon_packet_factory.rb +43 -0
  110. data/pkg/steam-condenser-1.3.5/lib/steam/packets/rcon/rcon_terminator.rb +29 -0
  111. data/pkg/steam-condenser-1.3.5/lib/steam/packets/request_with_challenge.rb +19 -0
  112. data/pkg/steam-condenser-1.3.5/lib/steam/packets/s2a_info2_packet.rb +74 -0
  113. data/pkg/steam-condenser-1.3.5/lib/steam/packets/s2a_info_base_packet.rb +25 -0
  114. data/pkg/steam-condenser-1.3.5/lib/steam/packets/s2a_info_detailed_packet.rb +59 -0
  115. data/pkg/steam-condenser-1.3.5/lib/steam/packets/s2a_logstring_packet.rb +30 -0
  116. data/pkg/steam-condenser-1.3.5/lib/steam/packets/s2a_player_packet.rb +44 -0
  117. data/pkg/steam-condenser-1.3.5/lib/steam/packets/s2a_rules_packet.rb +48 -0
  118. data/pkg/steam-condenser-1.3.5/lib/steam/packets/s2c_challenge_packet.rb +35 -0
  119. data/pkg/steam-condenser-1.3.5/lib/steam/packets/s2m_heartbeat2_packet.rb +72 -0
  120. data/pkg/steam-condenser-1.3.5/lib/steam/packets/steam_packet.rb +52 -0
  121. data/pkg/steam-condenser-1.3.5/lib/steam/packets/steam_packet_factory.rb +108 -0
  122. data/pkg/steam-condenser-1.3.5/lib/steam/servers/game_server.rb +392 -0
  123. data/pkg/steam-condenser-1.3.5/lib/steam/servers/goldsrc_server.rb +74 -0
  124. data/pkg/steam-condenser-1.3.5/lib/steam/servers/master_server.rb +188 -0
  125. data/pkg/steam-condenser-1.3.5/lib/steam/servers/server.rb +115 -0
  126. data/pkg/steam-condenser-1.3.5/lib/steam/servers/source_server.rb +117 -0
  127. data/pkg/steam-condenser-1.3.5/lib/steam/sockets/goldsrc_socket.rb +142 -0
  128. data/pkg/steam-condenser-1.3.5/lib/steam/sockets/master_server_socket.rb +34 -0
  129. data/pkg/steam-condenser-1.3.5/lib/steam/sockets/rcon_socket.rb +103 -0
  130. data/pkg/steam-condenser-1.3.5/lib/steam/sockets/source_socket.rb +78 -0
  131. data/pkg/steam-condenser-1.3.5/lib/steam/sockets/steam_socket.rb +91 -0
  132. data/pkg/steam-condenser-1.3.5/lib/steam/steam_player.rb +143 -0
  133. data/pkg/steam-condenser-1.3.5/steam-condenser.gemspec +26 -0
  134. data/pkg/steam-condenser-1.3.5/test/core_ext/test_stringio.rb +59 -0
  135. data/pkg/steam-condenser-1.3.5/test/fixtures/invalid.xml +2 -0
  136. data/pkg/steam-condenser-1.3.5/test/fixtures/sonofthor.xml +882 -0
  137. data/pkg/steam-condenser-1.3.5/test/fixtures/status_goldsrc +3 -0
  138. data/pkg/steam-condenser-1.3.5/test/fixtures/status_source +3 -0
  139. data/pkg/steam-condenser-1.3.5/test/fixtures/valve-members.xml +231 -0
  140. data/pkg/steam-condenser-1.3.5/test/helper.rb +48 -0
  141. data/pkg/steam-condenser-1.3.5/test/steam/community/test_cacheable.rb +100 -0
  142. data/pkg/steam-condenser-1.3.5/test/steam/community/test_steam_group.rb +83 -0
  143. data/pkg/steam-condenser-1.3.5/test/steam/community/test_steam_id.rb +144 -0
  144. data/pkg/steam-condenser-1.3.5/test/steam/community/test_web_api.rb +98 -0
  145. data/pkg/steam-condenser-1.3.5/test/steam/packets/test_steam_packet.rb +37 -0
  146. data/pkg/steam-condenser-1.3.5/test/steam/servers/test_game_server.rb +296 -0
  147. data/pkg/steam-condenser-1.3.5/test/steam/servers/test_goldsrc_server.rb +59 -0
  148. data/pkg/steam-condenser-1.3.5/test/steam/servers/test_master_server.rb +131 -0
  149. data/pkg/steam-condenser-1.3.5/test/steam/servers/test_server.rb +72 -0
  150. data/pkg/steam-condenser-1.3.5/test/steam/servers/test_source_server.rb +134 -0
  151. data/pkg/steam-condenser-1.3.5/test/steam/sockets/test_goldsrc_socket.rb +127 -0
  152. data/pkg/steam-condenser-1.3.5/test/steam/sockets/test_master_server_socket.rb +42 -0
  153. data/pkg/steam-condenser-1.3.5/test/steam/sockets/test_rcon_socket.rb +118 -0
  154. data/pkg/steam-condenser-1.3.5/test/steam/sockets/test_source_socket.rb +77 -0
  155. data/pkg/steam-condenser-1.3.5/test/steam/sockets/test_steam_socket.rb +97 -0
  156. data/steam-condenser.gemspec +2 -3
  157. data/test/steam/community/test_cacheable.rb +3 -0
  158. data/test/steam/community/test_web_api.rb +15 -2
  159. data/test/steam/packets/test_steam_packet.rb +1 -1
  160. data/test/steam/sockets/test_source_socket.rb +1 -1
  161. metadata +151 -27
@@ -0,0 +1,205 @@
1
+ # This code is free software; you can redistribute it and/or modify it under
2
+ # the terms of the new BSD License.
3
+ #
4
+ # Copyright (c) 2011-2013, Sebastian Staudt
5
+
6
+ require 'multi_xml'
7
+
8
+ require 'steam/community/game_leaderboard_entry'
9
+ require 'steam/community/steam_id'
10
+ require 'steam/community/xml_data'
11
+
12
+ # The GameLeaderboard class represents a single leaderboard for a specific game
13
+ #
14
+ # @author Sebastian Staudt
15
+ class GameLeaderboard
16
+
17
+ include XMLData
18
+
19
+ LEADERBOARD_DISPLAY_TYPE_NONE = 0
20
+ LEADERBOARD_DISPLAY_TYPE_NUMERIC = 1
21
+ LEADERBOARD_DISPLAY_TYPE_SECONDS = 2
22
+ LEADERBOARD_DISPLAY_TYPE_MILLISECONDS = 3
23
+
24
+ LEADERBOARD_SORT_METHOD_NONE = 0
25
+ LEADERBOARD_SORT_METHOD_ASC = 1
26
+ LEADERBOARD_SORT_METHOD_DESC = 2
27
+
28
+ @@leaderboards = {}
29
+
30
+ # Returns the display type of the scores on this leaderboard
31
+ #
32
+ # @return [Fixnum] The display type of the scores
33
+ attr_reader :display_type
34
+
35
+ # Returns the number of entries on this leaderboard
36
+ #
37
+ # @return [Fixnum] The number of entries on this leaderboard
38
+ attr_reader :entry_count
39
+
40
+ # Returns the ID of the leaderboard
41
+ #
42
+ # @return [Fixnum] The ID of the leaderboard
43
+ attr_reader :id
44
+
45
+ # Returns the name of the leaderboard
46
+ #
47
+ # @return [String] The name of the leaderboard
48
+ attr_reader :name
49
+
50
+ # Returns the method that is used to sort the entries on the leaderboard
51
+ #
52
+ # @return [Fixnum] The sort method
53
+ attr_reader :sort_method
54
+
55
+ # Returns the leaderboard for the given game and leaderboard ID or name
56
+ #
57
+ # @param [String] game_name The short name of the game
58
+ # @param [Fixnum, String] id The ID or name of the leaderboard to return
59
+ # @return [GameLeaderboard] The matching leaderboard if available
60
+ def self.leaderboard(game_name, id)
61
+ leaderboards = self.leaderboards game_name
62
+
63
+ if id.is_a? Fixnum
64
+ leaderboards[id]
65
+ else
66
+ leaderboards.each_value do |board|
67
+ return board if board.name == id
68
+ end
69
+ end
70
+ end
71
+
72
+ # Returns an array containing all of a game's leaderboards
73
+ #
74
+ # @param [String] game_name The name of the game
75
+ # @return [Array<GameLeaderboard>] The leaderboards for this game
76
+ def self.leaderboards(game_name)
77
+ self.load_leaderboards game_name unless @@leaderboards.key? game_name
78
+
79
+ @@leaderboards[game_name]
80
+ end
81
+
82
+ # Returns the entry on this leaderboard for the user with the given SteamID
83
+ #
84
+ # @param [Fixnum, SteamId] steam_id The 64bit SteamID or the `SteamId` object
85
+ # of the user
86
+ # @return [GameLeaderboardEntry] The entry of the user if available
87
+ # raise [SteamCondenserException] if an error occurs while fetching the
88
+ # leaderboard
89
+ def entry_for_steam_id(steam_id)
90
+ steam_id = steam_id.steam_id64 if steam_id.is_a? SteamId
91
+
92
+ parse "#@url&steamid=#{steam_id}"
93
+
94
+ error = @xml_data['error']
95
+ raise SteamCondenserError, error unless error.nil?
96
+
97
+ @xml_data['entries']['entry'].each do |entry_data|
98
+ if entry_data['steamid'].to_i == steam_id
99
+ return GameLeaderboardEntry.new entry_data, self
100
+ end
101
+ end
102
+
103
+ nil
104
+ end
105
+
106
+ # Returns an array of entries on this leaderboard for the user with the given
107
+ # SteamID and his/her friends
108
+ #
109
+ # @param [Fixnum, SteamId] steam_id The 64bit SteamID or the `SteamId` object
110
+ # of the user
111
+ # @return [Array<GameLeaderboardEntry>] The entries of the user and his/her
112
+ # friends
113
+ # raise [SteamCondenserException] if an error occurs while fetching the
114
+ # leaderboard
115
+ def entry_for_steam_id_friends(steam_id)
116
+ steam_id = steam_id.steam_id64 if steam_id.is_a? SteamId
117
+
118
+ parse "#@url&steamid=#{steam_id}"
119
+
120
+ error = @xml_data['error']
121
+ raise SteamCondenserError, error unless error.nil?
122
+
123
+ entries = []
124
+ @xml_data['entries']['entry'].each do |entry_data|
125
+ rank = entry_data['rank'].to_i
126
+ entries[rank] = GameLeaderboardEntry.new entry_data, self
127
+ end
128
+
129
+ entries
130
+ end
131
+
132
+ # Returns the entries on this leaderboard for a given rank range
133
+ #
134
+ # The range is inclusive and a maximum of 5001 entries can be returned in a
135
+ # single request.
136
+ #
137
+ # @param [Fixnum] first The first entry to return from the leaderboard
138
+ # @param [Fixnum] last The last entry to return from the leaderboard
139
+ # @return [Array<GameLeaderboardEntry>] The entries that match the given rank
140
+ # range
141
+ # raise [SteamCondenserException] if an error occurs while fetching the
142
+ # leaderboard
143
+ def entry_range(first, last)
144
+ if last < first
145
+ raise SteamCondenserError,
146
+ 'First entry must be prior to last entry for leaderboard entry lookup.'
147
+ end
148
+
149
+ if (last - first) > 5000
150
+ raise SteamCondenserError,
151
+ 'Leaderboard entry lookup is currently limited to a maximum of 5001 entries per request.'
152
+ end
153
+
154
+ parse "#@url&start=#{first}&end=#{last}"
155
+
156
+ error = @xml_data['error']
157
+ raise SteamCondenserError, error unless error.nil?
158
+
159
+ entries = []
160
+ @xml_data['entries']['entry'].each do |entry_data|
161
+ rank = entry_data['rank'].to_i
162
+ entries[rank] = GameLeaderboardEntry.new entry_data, self
163
+ end
164
+
165
+ entries
166
+ end
167
+
168
+ private
169
+
170
+ # Creates a new leaderboard instance with the given XML data
171
+ #
172
+ # @param [Hash<String, Object>] board_data The XML data of the leaderboard
173
+ def initialize(board_data)
174
+ @url = board_data['url']
175
+ @id = board_data['lbid'].to_i
176
+ @name = board_data['name']
177
+ @entry_count = board_data['entries'].to_i
178
+ @sort_method = board_data['sortmethod'].to_i
179
+ @display_type = board_data['displaytype'].to_i
180
+ end
181
+
182
+ # Loads the leaderboards of the specified games into the cache
183
+ #
184
+ # @param [String] game_name The short name of the game
185
+ # @raise [SteamCondenserException] if an error occurs while fetching the
186
+ # leaderboards
187
+ def self.load_leaderboards(game_name)
188
+ begin
189
+ url = "http://steamcommunity.com/stats/#{game_name}/leaderboards/?xml=1"
190
+ boards_data = MultiXml.parse(open(url, {:proxy => true})).values.first
191
+ rescue
192
+ raise SteamCondenserError.new 'XML data could not be parsed.', $!
193
+ end
194
+
195
+ error = boards_data['error']
196
+ raise SteamCondenserError, error unless error.nil?
197
+
198
+ @@leaderboards[game_name] = []
199
+ boards_data['leaderboard'].each do |board_data|
200
+ leaderboard = GameLeaderboard.new board_data
201
+ @@leaderboards[game_name][leaderboard.id] = leaderboard
202
+ end
203
+ end
204
+
205
+ end
@@ -0,0 +1,43 @@
1
+ # This code is free software; you can redistribute it and/or modify it under
2
+ # the terms of the new BSD License.
3
+ #
4
+ # Copyright (c) 2011-2012, Sebastian Staudt
5
+
6
+ # The GameLeaderboard class represents a single entry in a leaderboard
7
+ #
8
+ # @author Sebastian Staudt
9
+ class GameLeaderboardEntry
10
+
11
+ # Returns the Steam ID of this entry's player
12
+ #
13
+ # @return [SteamId] The Steam ID of the player
14
+ attr_reader :steam_id
15
+
16
+ # Returns the score of this entry
17
+ #
18
+ # @return [Fixnum] The score of this player
19
+ attr_reader :score
20
+
21
+ # Returns the rank where this entry is listed in the leaderboard
22
+ #
23
+ # @return [Fixnum] The rank of this entry
24
+ attr_reader :rank
25
+
26
+ # Returns the leaderboard this entry belongs to
27
+ #
28
+ # @return [GameLeaderboard] The leaderboard of this entry
29
+ attr_reader :leaderboard
30
+
31
+ # Creates new entry instance for the given XML data and leaderboard
32
+ #
33
+ # @param [Hash<String, Object>] entry_data The XML data of the leaderboard of
34
+ # the leaderboard entry
35
+ # @param [GameLeaderboard] leaderboard The leaderboard this entry belongs to
36
+ def initialize(entry_data, leaderboard)
37
+ @steam_id = SteamId.new entry_data['steamid'].to_i, false
38
+ @score = entry_data['score'].to_i
39
+ @rank = entry_data['rank'].to_i
40
+ @leaderboard = leaderboard
41
+ end
42
+
43
+ end
@@ -0,0 +1,175 @@
1
+ # This code is free software; you can redistribute it and/or modify it under
2
+ # the terms of the new BSD License.
3
+ #
4
+ # Copyright (c) 2008-2012, Sebastian Staudt
5
+
6
+ require 'steam/community/game_achievement'
7
+ require 'steam/community/game_leaderboard'
8
+ require 'steam/community/xml_data'
9
+
10
+ # This class represents the game statistics for a single user and a specific
11
+ # game
12
+ #
13
+ # It is subclassed for individual games if the games provide special statistics
14
+ # that are unique to this game.
15
+ #
16
+ # @author Sebastian Staudt
17
+ class GameStats
18
+
19
+ include XMLData
20
+
21
+ # Returns the game these stats belong to
22
+ #
23
+ # @return [SteamGame] The game object
24
+ attr_reader :game
25
+
26
+ # Returns the number of hours this game has been played by the player
27
+ #
28
+ # @return [String] The number of hours this game has been played
29
+ attr_reader :hours_played
30
+
31
+ # Returns the privacy setting of the Steam ID profile
32
+ #
33
+ # @return [String] The privacy setting of the Steam ID
34
+ attr_reader :privacy_state
35
+
36
+ # Returns the Steam ID of the player these stats belong to
37
+ #
38
+ # @return [SteamId] The Steam ID instance of the player
39
+ attr_reader :user
40
+
41
+ # Returns the base Steam Communtiy URL for the given player and game IDs
42
+ #
43
+ # @param [Fixnum, String] user_id The 64bit SteamID or custom URL of the user
44
+ # @param [Fixnum, String] game_id The application ID or short name of the
45
+ # game
46
+ # @return The base URL used for the given stats IDs
47
+ def self.base_url(user_id, game_id)
48
+ game_url = game_id.is_a?(Fixnum) ? "appid/#{game_id}" : game_id
49
+
50
+ if user_id.is_a? Fixnum
51
+ "http://steamcommunity.com/profiles/#{user_id}/stats/#{game_url}"
52
+ else
53
+ "http://steamcommunity.com/id/#{user_id}/stats/#{game_url}"
54
+ end
55
+ end
56
+
57
+ # Creates a `GameStats` (or one of its subclasses) instance for the given
58
+ # user and game
59
+ #
60
+ # @param [String, Fixnum] steam_id The custom URL or the 64bit Steam ID of
61
+ # the user
62
+ # @param [String] game_name The friendly name of the game
63
+ # @return [GameStats] The game stats object for the given user and game
64
+ def self.create_game_stats(steam_id, game_name)
65
+ case game_name
66
+ when 'alienswarm'
67
+ require 'steam/community/alien_swarm/alien_swarm_stats'
68
+ AlienSwarmStats.new(steam_id)
69
+ when 'cs:s'
70
+ require 'steam/community/css/css_stats'
71
+ CSSStats.new(steam_id)
72
+ when 'defensegrid:awakening'
73
+ require 'steam/community/defense_grid/defense_grid_stats'
74
+ DefenseGridStats.new(steam_id)
75
+ when 'dod:s'
76
+ require 'steam/community/dods/dods_stats'
77
+ DoDSStats.new(steam_id)
78
+ when 'l4d'
79
+ require 'steam/community/l4d/l4d_stats'
80
+ L4DStats.new(steam_id)
81
+ when 'l4d2'
82
+ require 'steam/community/l4d/l4d2_stats'
83
+ L4D2Stats.new(steam_id)
84
+ when 'portal2'
85
+ require 'steam/community/portal2/portal2_stats'
86
+ Portal2Stats.new steam_id
87
+ when 'tf2'
88
+ require 'steam/community/tf2/tf2_stats'
89
+ TF2Stats.new(steam_id)
90
+ else
91
+ new(steam_id, game_name)
92
+ end
93
+ end
94
+
95
+ # Creates a `GameStats` object and fetches data from the Steam Community for
96
+ # the given user and game
97
+ #
98
+ # @param [String, Fixnum] user_id The custom URL or the 64bit Steam ID of the
99
+ # user
100
+ # @param [String] game_id The application ID or friendly name of the game
101
+ # @raise [SteamCondenserError] if the stats cannot be fetched
102
+ def initialize(user_id, game_id)
103
+ parse "#{self.class.base_url(user_id, game_id)}?xml=all"
104
+
105
+ @user = SteamId.new user_id, false
106
+
107
+ error = @xml_data['error']
108
+ raise SteamCondenserError, error unless error.nil?
109
+
110
+ @privacy_state = @xml_data['privacyState']
111
+ if public?
112
+ app_id = @xml_data['game']['gameLink'].match(/http:\/\/steamcommunity\.com\/+app\/+([1-9][0-9]*)/)[1].to_i
113
+ @game = SteamGame.new app_id, @xml_data['game']
114
+ @hours_played = @xml_data['stats']['hoursPlayed'] unless @xml_data['stats']['hoursPlayed'].nil?
115
+ end
116
+ end
117
+
118
+ # Returns the achievements for this stats' user and game
119
+ #
120
+ # If the achievements' data hasn't been parsed yet, parsing is done now.
121
+ #
122
+ # @return [Array<GameAchievement>] All achievements belonging to this game
123
+ def achievements
124
+ return unless public?
125
+
126
+ if @achievements.nil?
127
+ @achievements = Array.new
128
+ @xml_data['achievements']['achievement'].each do |achievement|
129
+ @achievements << GameAchievement.new(@user, @game, achievement)
130
+ end
131
+
132
+ @achievements_done = @achievements.reject{ |a| !a.unlocked? }.size
133
+ end
134
+
135
+ @achievements
136
+ end
137
+
138
+ # Returns the number of achievements done by this player
139
+ #
140
+ # If achievements haven't been parsed yet for this player and this game,
141
+ # parsing is done now.
142
+ #
143
+ # @return [Fixnum] The number of achievements completed
144
+ # @see #achievements
145
+ def achievements_done
146
+ achievements if @achievements_done.nil?
147
+ @achievements_done
148
+ end
149
+
150
+ # Returns the percentage of achievements done by this player
151
+ #
152
+ # If achievements haven't been parsed yet for this player and this game,
153
+ # parsing is done now.
154
+ #
155
+ # @return [Float] The percentage of achievements completed
156
+ # @see #achievements_done
157
+ def achievements_percentage
158
+ achievements_done.to_f / @achievements.size
159
+ end
160
+
161
+ # Returns the base Steam Communtiy URL for the stats contained in this object
162
+ #
163
+ # @return [String] The base URL used for queries on these stats
164
+ def base_url
165
+ self.class.base_url @user.id, @game.id
166
+ end
167
+
168
+ # Returns whether this Steam ID is publicly accessible
169
+ #
170
+ # @return [Boolean] `true` if this Steam ID is publicly accessible
171
+ def public?
172
+ @privacy_state == 'public'
173
+ end
174
+
175
+ end
@@ -0,0 +1,41 @@
1
+ # This code is free software; you can redistribute it and/or modify it under
2
+ # the terms of the new BSD License.
3
+ #
4
+ # Copyright (c) 2009-2011, Sebastian Staudt
5
+
6
+ # A module implementing basic functionality for classes representing game
7
+ # weapons
8
+ #
9
+ # @author Sebastian Staudt
10
+ module GameWeapon
11
+
12
+ # Returns the number of kills achieved with this weapon
13
+ #
14
+ # @return [Fixnum] The number of kills achieved
15
+ attr_reader :kills
16
+
17
+ # Returns the unique identifier for this weapon
18
+ #
19
+ # @return [String] The identifier of this weapon
20
+ attr_reader :id
21
+
22
+ # Returns the number of shots fired with this weapon
23
+ #
24
+ # @return [Fixnum] The number of shots fired
25
+ attr_reader :shots
26
+
27
+ # Creates a new game weapon instance with the data provided
28
+ #
29
+ # @param [Hash<String, Object>] weapon_data The data representing this weapon
30
+ def initialize(weapon_data)
31
+ @kills = weapon_data['kills'].to_i
32
+ end
33
+
34
+ # Returns the average number of shots needed for a kill with this weapon
35
+ #
36
+ # @return [Float] The average number of shots needed for a kill
37
+ def avg_shots_per_kill
38
+ @shots.to_f / @kills
39
+ end
40
+
41
+ end