steam-condenser 1.2.0 → 1.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (371) hide show
  1. data/Gemfile.lock +7 -7
  2. data/README.md +9 -2
  3. data/doc/A2M_GET_SERVERS_BATCH2_Packet.html +426 -0
  4. data/doc/A2S_INFO_Packet.html +260 -0
  5. data/doc/A2S_PLAYER_Packet.html +295 -0
  6. data/doc/A2S_RULES_Packet.html +296 -0
  7. data/doc/A2S_SERVERQUERY_GETCHALLENGE_Packet.html +261 -0
  8. data/doc/AbstractL4DStats.html +978 -0
  9. data/doc/AbstractL4DWeapon.html +734 -0
  10. data/doc/Achievement.html +660 -0
  11. data/doc/AlienSwarmMission.html +1557 -0
  12. data/doc/AlienSwarmStats.html +965 -0
  13. data/doc/AlienSwarmWeapon.html +640 -0
  14. data/doc/AppNews.html +1442 -0
  15. data/doc/C2M_CHECKMD5_Packet.html +341 -0
  16. data/doc/CSSMap.html +806 -0
  17. data/doc/CSSStats.html +825 -0
  18. data/doc/CSSWeapon.html +889 -0
  19. data/doc/Cacheable.html +913 -0
  20. data/doc/Cacheable/ClassMethods.html +696 -0
  21. data/doc/DefenseGridStats.html +2559 -0
  22. data/doc/DoDSClass.html +1264 -0
  23. data/doc/DoDSStats.html +486 -0
  24. data/doc/DoDSWeapon.html +806 -0
  25. data/doc/Dota2BetaInventory.html +339 -0
  26. data/doc/Dota2Inventory.html +339 -0
  27. data/doc/Dota2Item.html +388 -0
  28. data/doc/Dota2Stats.html +366 -0
  29. data/doc/GameAchievement.html +1257 -0
  30. data/doc/GameClass.html +321 -0
  31. data/doc/GameInventory.html +1363 -0
  32. data/doc/GameItem.html +1339 -0
  33. data/doc/GameLeaderboard.html +1609 -0
  34. data/doc/GameLeaderboardEntry.html +629 -0
  35. data/doc/GameSchema.html +568 -0
  36. data/doc/GameServer.html +2405 -0
  37. data/doc/GameStats.html +1461 -0
  38. data/doc/GameWeapon.html +590 -0
  39. data/doc/GoldSrcServer.html +740 -0
  40. data/doc/GoldSrcSocket.html +850 -0
  41. data/doc/ItemSchema.html +780 -0
  42. data/doc/L4D2Map.html +739 -0
  43. data/doc/L4D2Stats.html +930 -0
  44. data/doc/L4D2Weapon.html +486 -0
  45. data/doc/L4DExplosive.html +374 -0
  46. data/doc/L4DMap.html +776 -0
  47. data/doc/L4DStats.html +530 -0
  48. data/doc/L4DWeapon.html +296 -0
  49. data/doc/M2A_SERVER_BATCH_Packet.html +430 -0
  50. data/doc/M2C_ISVALIDMD5_Packet.html +383 -0
  51. data/doc/M2S_REQUESTRESTART_Packet.html +382 -0
  52. data/doc/MasterServer.html +1070 -0
  53. data/doc/MasterServerSocket.html +293 -0
  54. data/doc/Module.html +194 -0
  55. data/doc/PacketFormatError.html +257 -0
  56. data/doc/Portal2Inventory.html +339 -0
  57. data/doc/Portal2Item.html +499 -0
  58. data/doc/Portal2Stats.html +368 -0
  59. data/doc/RCONAuthRequest.html +318 -0
  60. data/doc/RCONAuthResponse.html +305 -0
  61. data/doc/RCONBanError.html +247 -0
  62. data/doc/RCONExecRequest.html +318 -0
  63. data/doc/RCONExecResponse.html +407 -0
  64. data/doc/RCONGoldSrcRequest.html +363 -0
  65. data/doc/RCONGoldSrcResponse.html +367 -0
  66. data/doc/RCONNoAuthError.html +247 -0
  67. data/doc/RCONPacket.html +548 -0
  68. data/doc/RCONPacketFactory.html +300 -0
  69. data/doc/RCONSocket.html +669 -0
  70. data/doc/RCONTerminator.html +304 -0
  71. data/doc/RequestWithChallenge.html +233 -0
  72. data/doc/S2A_INFO2_Packet.html +371 -0
  73. data/doc/S2A_INFO_BasePacket.html +357 -0
  74. data/doc/S2A_INFO_DETAILED_Packet.html +370 -0
  75. data/doc/S2A_LOGSTRING_Packet.html +373 -0
  76. data/doc/S2A_PLAYER_Packet.html +417 -0
  77. data/doc/S2A_RULES_Packet.html +411 -0
  78. data/doc/S2C_CHALLENGE_Packet.html +370 -0
  79. data/doc/S2M_HEARTBEAT2_Packet.html +444 -0
  80. data/doc/Server.html +781 -0
  81. data/doc/SourceServer.html +776 -0
  82. data/doc/SourceSocket.html +366 -0
  83. data/doc/StatsAttribute.html +514 -0
  84. data/doc/SteamCondenser.html +155 -0
  85. data/doc/SteamCondenser/A2M_GET_SERVERS_BATCH2_Packet.html +413 -0
  86. data/doc/SteamCondenser/A2S_INFO_Packet.html +249 -0
  87. data/doc/SteamCondenser/A2S_PLAYER_Packet.html +281 -0
  88. data/doc/SteamCondenser/A2S_RULES_Packet.html +282 -0
  89. data/doc/SteamCondenser/A2S_SERVERQUERY_GETCHALLENGE_Packet.html +250 -0
  90. data/doc/SteamCondenser/AbstractL4DStats.html +954 -0
  91. data/doc/SteamCondenser/AbstractL4DWeapon.html +703 -0
  92. data/doc/SteamCondenser/AlienSwarmMission.html +1494 -0
  93. data/doc/SteamCondenser/AlienSwarmStats.html +938 -0
  94. data/doc/SteamCondenser/AlienSwarmWeapon.html +614 -0
  95. data/doc/SteamCondenser/AppNews.html +1387 -0
  96. data/doc/SteamCondenser/C2M_CHECKMD5_Packet.html +327 -0
  97. data/doc/SteamCondenser/CSSMap.html +774 -0
  98. data/doc/SteamCondenser/CSSStats.html +799 -0
  99. data/doc/SteamCondenser/CSSWeapon.html +855 -0
  100. data/doc/SteamCondenser/Cacheable.html +698 -0
  101. data/doc/SteamCondenser/Cacheable/ClassMethods.html +531 -0
  102. data/doc/SteamCondenser/Community.html +134 -0
  103. data/doc/SteamCondenser/DefenseGridStats.html +2455 -0
  104. data/doc/SteamCondenser/DoDSClass.html +1209 -0
  105. data/doc/SteamCondenser/DoDSStats.html +470 -0
  106. data/doc/SteamCondenser/DoDSWeapon.html +774 -0
  107. data/doc/SteamCondenser/Error.html +156 -0
  108. data/doc/SteamCondenser/Error/PacketFormat.html +246 -0
  109. data/doc/SteamCondenser/Error/RCONBan.html +237 -0
  110. data/doc/SteamCondenser/Error/RCONNoAuth.html +236 -0
  111. data/doc/SteamCondenser/Error/Timeout.html +238 -0
  112. data/doc/SteamCondenser/Error/WebApi.html +339 -0
  113. data/doc/SteamCondenser/GameAchievement.html +1210 -0
  114. data/doc/SteamCondenser/GameClass.html +306 -0
  115. data/doc/SteamCondenser/GameInventory.html +1236 -0
  116. data/doc/SteamCondenser/GameItem.html +1282 -0
  117. data/doc/SteamCondenser/GameLeaderboard.html +1562 -0
  118. data/doc/SteamCondenser/GameLeaderboardEntry.html +604 -0
  119. data/doc/SteamCondenser/GameServer.html +2337 -0
  120. data/doc/SteamCondenser/GameStats.html +1416 -0
  121. data/doc/SteamCondenser/GameWeapon.html +566 -0
  122. data/doc/SteamCondenser/GoldSrcServer.html +716 -0
  123. data/doc/SteamCondenser/GoldSrcSocket.html +831 -0
  124. data/doc/SteamCondenser/L4D2Map.html +713 -0
  125. data/doc/SteamCondenser/L4D2Stats.html +906 -0
  126. data/doc/SteamCondenser/L4D2Weapon.html +466 -0
  127. data/doc/SteamCondenser/L4DExplosive.html +362 -0
  128. data/doc/SteamCondenser/L4DMap.html +746 -0
  129. data/doc/SteamCondenser/L4DStats.html +513 -0
  130. data/doc/SteamCondenser/L4DWeapon.html +284 -0
  131. data/doc/SteamCondenser/M2A_SERVER_BATCH_Packet.html +415 -0
  132. data/doc/SteamCondenser/M2C_ISVALIDMD5_Packet.html +368 -0
  133. data/doc/SteamCondenser/M2S_REQUESTRESTART_Packet.html +367 -0
  134. data/doc/SteamCondenser/MasterServer.html +1046 -0
  135. data/doc/SteamCondenser/MasterServerSocket.html +282 -0
  136. data/doc/SteamCondenser/Portal2Inventory.html +217 -0
  137. data/doc/SteamCondenser/Portal2Item.html +483 -0
  138. data/doc/SteamCondenser/Portal2Stats.html +353 -0
  139. data/doc/SteamCondenser/RCONAuthRequest.html +306 -0
  140. data/doc/SteamCondenser/RCONAuthResponse.html +293 -0
  141. data/doc/SteamCondenser/RCONExecRequest.html +306 -0
  142. data/doc/SteamCondenser/RCONExecResponse.html +392 -0
  143. data/doc/SteamCondenser/RCONGoldSrcRequest.html +349 -0
  144. data/doc/SteamCondenser/RCONGoldSrcResponse.html +354 -0
  145. data/doc/SteamCondenser/RCONPacket.html +530 -0
  146. data/doc/SteamCondenser/RCONPacketFactory.html +293 -0
  147. data/doc/SteamCondenser/RCONSocket.html +649 -0
  148. data/doc/SteamCondenser/RCONTerminator.html +292 -0
  149. data/doc/SteamCondenser/RequestWithChallenge.html +223 -0
  150. data/doc/SteamCondenser/S2A_INFO2_Packet.html +359 -0
  151. data/doc/SteamCondenser/S2A_INFO_BasePacket.html +342 -0
  152. data/doc/SteamCondenser/S2A_INFO_DETAILED_Packet.html +358 -0
  153. data/doc/SteamCondenser/S2A_LOGSTRING_Packet.html +358 -0
  154. data/doc/SteamCondenser/S2A_PLAYER_Packet.html +402 -0
  155. data/doc/SteamCondenser/S2A_RULES_Packet.html +396 -0
  156. data/doc/SteamCondenser/S2C_CHALLENGE_Packet.html +356 -0
  157. data/doc/SteamCondenser/S2M_HEARTBEAT2_Packet.html +430 -0
  158. data/doc/SteamCondenser/Server.html +754 -0
  159. data/doc/SteamCondenser/Servers.html +133 -0
  160. data/doc/SteamCondenser/SourceServer.html +752 -0
  161. data/doc/SteamCondenser/SourceSocket.html +355 -0
  162. data/doc/SteamCondenser/SteamGame.html +1802 -0
  163. data/doc/SteamCondenser/SteamGroup.html +969 -0
  164. data/doc/SteamCondenser/SteamId.html +4242 -0
  165. data/doc/SteamCondenser/SteamPacket.html +456 -0
  166. data/doc/SteamCondenser/SteamPacketFactory.html +521 -0
  167. data/doc/SteamCondenser/SteamPlayer.html +1696 -0
  168. data/doc/SteamCondenser/SteamSocket.html +679 -0
  169. data/doc/SteamCondenser/TF2BetaInventory.html +198 -0
  170. data/doc/SteamCondenser/TF2Class.html +1145 -0
  171. data/doc/SteamCondenser/TF2ClassFactory.html +263 -0
  172. data/doc/SteamCondenser/TF2Engineer.html +534 -0
  173. data/doc/SteamCondenser/TF2GoldenWrench.html +731 -0
  174. data/doc/SteamCondenser/TF2Inventory.html +217 -0
  175. data/doc/SteamCondenser/TF2Item.html +482 -0
  176. data/doc/SteamCondenser/TF2Medic.html +445 -0
  177. data/doc/SteamCondenser/TF2Sniper.html +357 -0
  178. data/doc/SteamCondenser/TF2Spy.html +531 -0
  179. data/doc/SteamCondenser/TF2Stats.html +670 -0
  180. data/doc/SteamCondenser/TimeoutError.html +249 -0
  181. data/doc/SteamCondenser/WebApi.html +999 -0
  182. data/doc/SteamCondenser/XMLData.html +171 -0
  183. data/doc/SteamCondenserError.html +153 -0
  184. data/doc/SteamGame.html +1859 -0
  185. data/doc/SteamGroup.html +1012 -0
  186. data/doc/SteamId.html +4369 -0
  187. data/doc/SteamPacket.html +469 -0
  188. data/doc/SteamPacketFactory.html +545 -0
  189. data/doc/SteamPlayer.html +1766 -0
  190. data/doc/SteamSocket.html +699 -0
  191. data/doc/StringIO.html +947 -0
  192. data/doc/TF2BetaInventory.html +315 -0
  193. data/doc/TF2Class.html +1194 -0
  194. data/doc/TF2ClassFactory.html +273 -0
  195. data/doc/TF2Engineer.html +558 -0
  196. data/doc/TF2GoldenWrench.html +760 -0
  197. data/doc/TF2Inventory.html +339 -0
  198. data/doc/TF2Item.html +499 -0
  199. data/doc/TF2Medic.html +465 -0
  200. data/doc/TF2Sniper.html +373 -0
  201. data/doc/TF2Spy.html +555 -0
  202. data/doc/TF2Stats.html +696 -0
  203. data/doc/WebApi.html +1021 -0
  204. data/doc/WebApiError.html +347 -0
  205. data/doc/XMLData.html +253 -0
  206. data/doc/_index.html +717 -0
  207. data/doc/class_list.html +53 -0
  208. data/doc/css/common.css +1 -0
  209. data/doc/css/full_list.css +57 -0
  210. data/doc/css/style.css +328 -0
  211. data/doc/file.LICENSE.html +100 -0
  212. data/doc/file.README.html +136 -0
  213. data/doc/file_list.html +58 -0
  214. data/doc/frames.html +28 -0
  215. data/doc/index.html +136 -0
  216. data/doc/js/app.js +214 -0
  217. data/doc/js/full_list.js +173 -0
  218. data/doc/js/jquery.js +4 -0
  219. data/doc/method_list.html +3988 -0
  220. data/doc/methods_list.html +3900 -0
  221. data/doc/top-level-namespace.html +114 -0
  222. data/lib/steam-condenser/version.rb +1 -1
  223. data/lib/steam/community/cacheable.rb +105 -44
  224. data/lib/steam/community/dota2/dota2_beta_inventory.rb +27 -0
  225. data/lib/steam/community/dota2/dota2_inventory.rb +27 -0
  226. data/lib/steam/community/dota2/dota2_item.rb +33 -0
  227. data/lib/steam/community/game_inventory.rb +18 -16
  228. data/lib/steam/community/game_leaderboard.rb +2 -2
  229. data/lib/steam/community/game_stats.rb +1 -1
  230. data/lib/steam/community/portal2/portal2_inventory.rb +11 -9
  231. data/lib/steam/community/steam_game.rb +0 -2
  232. data/lib/steam/community/steam_group.rb +2 -7
  233. data/lib/steam/community/steam_id.rb +2 -7
  234. data/lib/steam/community/tf2/tf2_beta_inventory.rb +11 -8
  235. data/lib/steam/community/tf2/tf2_inventory.rb +11 -9
  236. data/lib/steam/community/xml_data.rb +8 -1
  237. data/lib/steam/packets/a2s_player_packet.rb +1 -1
  238. data/lib/steam/packets/a2s_rules_packet.rb +1 -1
  239. data/lib/steam/servers/master_server.rb +3 -2
  240. data/lib/steam/sockets/rcon_socket.rb +1 -2
  241. data/pkg/steam-condenser-1.2.0.gem +0 -0
  242. data/pkg/steam-condenser-1.2.0/Gemfile +3 -0
  243. data/pkg/steam-condenser-1.2.0/Gemfile.lock +30 -0
  244. data/pkg/steam-condenser-1.2.0/LICENSE +25 -0
  245. data/pkg/steam-condenser-1.2.0/README.md +47 -0
  246. data/pkg/steam-condenser-1.2.0/Rakefile +46 -0
  247. data/pkg/steam-condenser-1.2.0/lib/core_ext/stringio.rb +91 -0
  248. data/pkg/steam-condenser-1.2.0/lib/errors/packet_format_error.rb +21 -0
  249. data/pkg/steam-condenser-1.2.0/lib/errors/rcon_ban_error.rb +22 -0
  250. data/pkg/steam-condenser-1.2.0/lib/errors/rcon_no_auth_error.rb +21 -0
  251. data/pkg/steam-condenser-1.2.0/lib/errors/steam_condenser_error.rb +11 -0
  252. data/pkg/steam-condenser-1.2.0/lib/errors/timeout_error.rb +28 -0
  253. data/pkg/steam-condenser-1.2.0/lib/errors/web_api_error.rb +57 -0
  254. data/pkg/steam-condenser-1.2.0/lib/steam-condenser.rb +18 -0
  255. data/pkg/steam-condenser-1.2.0/lib/steam-condenser/community.rb +24 -0
  256. data/pkg/steam-condenser-1.2.0/lib/steam-condenser/servers.rb +24 -0
  257. data/pkg/steam-condenser-1.2.0/lib/steam-condenser/version.rb +11 -0
  258. data/pkg/steam-condenser-1.2.0/lib/steam/community/alien_swarm/alien_swarm_mission.rb +119 -0
  259. data/pkg/steam-condenser-1.2.0/lib/steam/community/alien_swarm/alien_swarm_stats.rb +179 -0
  260. data/pkg/steam-condenser-1.2.0/lib/steam/community/alien_swarm/alien_swarm_weapon.rb +49 -0
  261. data/pkg/steam-condenser-1.2.0/lib/steam/community/app_news.rb +133 -0
  262. data/pkg/steam-condenser-1.2.0/lib/steam/community/cacheable.rb +137 -0
  263. data/pkg/steam-condenser-1.2.0/lib/steam/community/css/css_map.rb +61 -0
  264. data/pkg/steam-condenser-1.2.0/lib/steam/community/css/css_stats.rb +136 -0
  265. data/pkg/steam-condenser-1.2.0/lib/steam/community/css/css_weapon.rb +69 -0
  266. data/pkg/steam-condenser-1.2.0/lib/steam/community/defense_grid/defense_grid_stats.rb +237 -0
  267. data/pkg/steam-condenser-1.2.0/lib/steam/community/dods/dods_class.rb +90 -0
  268. data/pkg/steam-condenser-1.2.0/lib/steam/community/dods/dods_stats.rb +61 -0
  269. data/pkg/steam-condenser-1.2.0/lib/steam/community/dods/dods_weapon.rb +67 -0
  270. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_achievement.rb +109 -0
  271. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_class.rb +22 -0
  272. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_inventory.rb +152 -0
  273. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_item.rb +99 -0
  274. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_leaderboard.rb +201 -0
  275. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_leaderboard_entry.rb +43 -0
  276. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_stats.rb +175 -0
  277. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_weapon.rb +41 -0
  278. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/abstract_l4d_stats.rb +173 -0
  279. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/abstract_l4d_weapon.rb +56 -0
  280. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d2_map.rb +90 -0
  281. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d2_stats.rb +165 -0
  282. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d2_weapon.rb +38 -0
  283. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d_explosive.rb +34 -0
  284. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d_map.rb +65 -0
  285. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d_stats.rb +71 -0
  286. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d_weapon.rb +26 -0
  287. data/pkg/steam-condenser-1.2.0/lib/steam/community/portal2/portal2_inventory.rb +25 -0
  288. data/pkg/steam-condenser-1.2.0/lib/steam/community/portal2/portal2_item.rb +47 -0
  289. data/pkg/steam-condenser-1.2.0/lib/steam/community/portal2/portal2_stats.rb +32 -0
  290. data/pkg/steam-condenser-1.2.0/lib/steam/community/steam_game.rb +182 -0
  291. data/pkg/steam-condenser-1.2.0/lib/steam/community/steam_group.rb +135 -0
  292. data/pkg/steam-condenser-1.2.0/lib/steam/community/steam_id.rb +513 -0
  293. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_beta_inventory.rb +22 -0
  294. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_class.rb +92 -0
  295. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_class_factory.rb +40 -0
  296. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_engineer.rb +43 -0
  297. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_golden_wrench.rb +70 -0
  298. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_inventory.rb +25 -0
  299. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_item.rb +47 -0
  300. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_medic.rb +35 -0
  301. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_sniper.rb +28 -0
  302. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_spy.rb +41 -0
  303. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_stats.rb +76 -0
  304. data/pkg/steam-condenser-1.2.0/lib/steam/community/web_api.rb +129 -0
  305. data/pkg/steam-condenser-1.2.0/lib/steam/community/xml_data.rb +17 -0
  306. data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2m_get_servers_batch2_packet.rb +59 -0
  307. data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2s_info_packet.rb +24 -0
  308. data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2s_player_packet.rb +31 -0
  309. data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2s_rules_packet.rb +32 -0
  310. data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2s_serverquery_getchallenge_packet.rb +25 -0
  311. data/pkg/steam-condenser-1.2.0/lib/steam/packets/c2m_checkmd5_packet.rb +30 -0
  312. data/pkg/steam-condenser-1.2.0/lib/steam/packets/m2a_server_batch_packet.rb +52 -0
  313. data/pkg/steam-condenser-1.2.0/lib/steam/packets/m2c_isvalidmd5_packet.rb +34 -0
  314. data/pkg/steam-condenser-1.2.0/lib/steam/packets/m2s_requestrestart_packet.rb +34 -0
  315. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_auth_request.rb +28 -0
  316. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_auth_response.rb +30 -0
  317. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_exec_request.rb +28 -0
  318. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_exec_response.rb +37 -0
  319. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_goldsrc_request.rb +35 -0
  320. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_goldsrc_response.rb +34 -0
  321. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_packet.rb +57 -0
  322. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_packet_factory.rb +43 -0
  323. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_terminator.rb +29 -0
  324. data/pkg/steam-condenser-1.2.0/lib/steam/packets/request_with_challenge.rb +19 -0
  325. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_info2_packet.rb +62 -0
  326. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_info_base_packet.rb +35 -0
  327. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_info_detailed_packet.rb +61 -0
  328. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_logstring_packet.rb +30 -0
  329. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_player_packet.rb +44 -0
  330. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_rules_packet.rb +48 -0
  331. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2c_challenge_packet.rb +35 -0
  332. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2m_heartbeat2_packet.rb +71 -0
  333. data/pkg/steam-condenser-1.2.0/lib/steam/packets/steam_packet.rb +52 -0
  334. data/pkg/steam-condenser-1.2.0/lib/steam/packets/steam_packet_factory.rb +108 -0
  335. data/pkg/steam-condenser-1.2.0/lib/steam/servers/game_server.rb +392 -0
  336. data/pkg/steam-condenser-1.2.0/lib/steam/servers/goldsrc_server.rb +74 -0
  337. data/pkg/steam-condenser-1.2.0/lib/steam/servers/master_server.rb +182 -0
  338. data/pkg/steam-condenser-1.2.0/lib/steam/servers/server.rb +104 -0
  339. data/pkg/steam-condenser-1.2.0/lib/steam/servers/source_server.rb +98 -0
  340. data/pkg/steam-condenser-1.2.0/lib/steam/sockets/goldsrc_socket.rb +142 -0
  341. data/pkg/steam-condenser-1.2.0/lib/steam/sockets/master_server_socket.rb +30 -0
  342. data/pkg/steam-condenser-1.2.0/lib/steam/sockets/rcon_socket.rb +94 -0
  343. data/pkg/steam-condenser-1.2.0/lib/steam/sockets/source_socket.rb +78 -0
  344. data/pkg/steam-condenser-1.2.0/lib/steam/sockets/steam_socket.rb +86 -0
  345. data/pkg/steam-condenser-1.2.0/lib/steam/steam_player.rb +143 -0
  346. data/pkg/steam-condenser-1.2.0/steam-condenser.gemspec +25 -0
  347. data/pkg/steam-condenser-1.2.0/test/core_ext/test_stringio.rb +59 -0
  348. data/pkg/steam-condenser-1.2.0/test/fixtures/invalid.xml +2 -0
  349. data/pkg/steam-condenser-1.2.0/test/fixtures/sonofthor.xml +882 -0
  350. data/pkg/steam-condenser-1.2.0/test/fixtures/status_goldsrc +3 -0
  351. data/pkg/steam-condenser-1.2.0/test/fixtures/status_source +3 -0
  352. data/pkg/steam-condenser-1.2.0/test/fixtures/valve-members.xml +231 -0
  353. data/pkg/steam-condenser-1.2.0/test/helper.rb +45 -0
  354. data/pkg/steam-condenser-1.2.0/test/steam/communtiy/test_steam_group.rb +83 -0
  355. data/pkg/steam-condenser-1.2.0/test/steam/communtiy/test_steam_id.rb +111 -0
  356. data/pkg/steam-condenser-1.2.0/test/steam/communtiy/test_web_api.rb +98 -0
  357. data/pkg/steam-condenser-1.2.0/test/steam/packets/test_steam_packet.rb +37 -0
  358. data/pkg/steam-condenser-1.2.0/test/steam/servers/test_game_server.rb +296 -0
  359. data/pkg/steam-condenser-1.2.0/test/steam/servers/test_goldsrc_server.rb +59 -0
  360. data/pkg/steam-condenser-1.2.0/test/steam/servers/test_master_server.rb +131 -0
  361. data/pkg/steam-condenser-1.2.0/test/steam/servers/test_server.rb +72 -0
  362. data/pkg/steam-condenser-1.2.0/test/steam/servers/test_source_server.rb +126 -0
  363. data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_goldsrc_socket.rb +127 -0
  364. data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_master_server_socket.rb +42 -0
  365. data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_rcon_socket.rb +109 -0
  366. data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_source_socket.rb +77 -0
  367. data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_steam_socket.rb +97 -0
  368. data/steam-condenser.gemspec +3 -3
  369. data/test/steam/communtiy/test_cacheable.rb +100 -0
  370. data/test/steam/servers/test_master_server.rb +3 -3
  371. metadata +366 -15
@@ -0,0 +1,969 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: SteamCondenser::SteamGroup
8
+
9
+ &mdash; Steam Condenser – Ruby API
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ relpath = '..';
19
+ if (relpath != '') relpath += '/';
20
+ </script>
21
+
22
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
25
+
26
+
27
+ </head>
28
+ <body>
29
+ <script type="text/javascript" charset="utf-8">
30
+ if (window.top.frames.main) document.body.className = 'frames';
31
+ </script>
32
+
33
+ <div id="header">
34
+ <div id="menu">
35
+
36
+ <a href="../_index.html">Index (S)</a> &raquo;
37
+ <span class='title'><span class='object_link'><a href="../SteamCondenser.html" title="SteamCondenser (module)">SteamCondenser</a></span></span>
38
+ &raquo;
39
+ <span class="title">SteamGroup</span>
40
+
41
+
42
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
43
+ </div>
44
+
45
+ <div id="search">
46
+
47
+ <a id="class_list_link" href="#">Class List</a>
48
+
49
+ <a id="method_list_link" href="#">Method List</a>
50
+
51
+ <a id="file_list_link" href="#">File List</a>
52
+
53
+ </div>
54
+ <div class="clear"></div>
55
+ </div>
56
+
57
+ <iframe id="search_frame"></iframe>
58
+
59
+ <div id="content"><h1>Class: SteamCondenser::SteamGroup
60
+
61
+
62
+
63
+ </h1>
64
+
65
+ <dl class="box">
66
+
67
+ <dt class="r1">Inherits:</dt>
68
+ <dd class="r1">
69
+ <span class="inheritName">Object</span>
70
+
71
+ <ul class="fullTree">
72
+ <li>Object</li>
73
+
74
+ <li class="next">SteamCondenser::SteamGroup</li>
75
+
76
+ </ul>
77
+ <a href="#" class="inheritanceTree">show all</a>
78
+
79
+ </dd>
80
+
81
+
82
+
83
+
84
+
85
+
86
+ <dt class="r2">Includes:</dt>
87
+ <dd class="r2"><span class='object_link'><a href="Cacheable.html" title="SteamCondenser::Cacheable (module)">Cacheable</a></span>, <span class='object_link'><a href="XMLData.html" title="SteamCondenser::XMLData (module)">XMLData</a></span></dd>
88
+
89
+
90
+
91
+
92
+
93
+ <dt class="r1 last">Defined in:</dt>
94
+ <dd class="r1 last">lib/steam/community/steam_group.rb</dd>
95
+
96
+ </dl>
97
+ <div class="clear"></div>
98
+
99
+ <h2>Overview</h2><div class="docstring">
100
+ <div class="discussion">
101
+ <p>The SteamGroup class represents a group in the Steam Community</p>
102
+
103
+
104
+ </div>
105
+ </div>
106
+ <div class="tags">
107
+
108
+ <h3>Author:</h3>
109
+ <ul class="author">
110
+
111
+ <li>
112
+
113
+
114
+
115
+
116
+
117
+ <div class='inline'><p>Sebastian Staudt</p>
118
+ </div>
119
+
120
+ </li>
121
+
122
+ </ul>
123
+
124
+ </div>
125
+
126
+
127
+
128
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
129
+ <ul class="summary">
130
+
131
+ <li class="public ">
132
+ <span class="summary_signature">
133
+
134
+ <a href="#custom_url-instance_method" title="#custom_url (instance method)">- (String) <strong>custom_url</strong> </a>
135
+
136
+
137
+
138
+ </span>
139
+
140
+
141
+ <span class="note title readonly">readonly</span>
142
+
143
+
144
+
145
+
146
+
147
+
148
+
149
+
150
+ <span class="summary_desc"><div class='inline'><p>Returns the custom URL of this group.</p>
151
+ </div></span>
152
+
153
+ </li>
154
+
155
+
156
+ <li class="public ">
157
+ <span class="summary_signature">
158
+
159
+ <a href="#group_id64-instance_method" title="#group_id64 (instance method)">- (Fixnum) <strong>group_id64</strong> </a>
160
+
161
+
162
+
163
+ </span>
164
+
165
+
166
+ <span class="note title readonly">readonly</span>
167
+
168
+
169
+
170
+
171
+
172
+
173
+
174
+
175
+ <span class="summary_desc"><div class='inline'><p>Returns this group&#39;s 64bit SteamID.</p>
176
+ </div></span>
177
+
178
+ </li>
179
+
180
+
181
+ </ul>
182
+
183
+
184
+
185
+
186
+
187
+ <h3 class="inherited">Attributes included from <span class='object_link'><a href="Cacheable.html" title="SteamCondenser::Cacheable (module)">Cacheable</a></span></h3>
188
+ <p class="inherited"><span class='object_link'><a href="Cacheable.html#fetch_time-instance_method" title="SteamCondenser::Cacheable#fetch_time (method)">#fetch_time</a></span></p>
189
+
190
+
191
+
192
+ <h2>
193
+ Instance Method Summary
194
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
195
+ </h2>
196
+
197
+ <ul class="summary">
198
+
199
+ <li class="public ">
200
+ <span class="summary_signature">
201
+
202
+ <a href="#base_url-instance_method" title="#base_url (instance method)">- (String) <strong>base_url</strong> </a>
203
+
204
+
205
+
206
+ </span>
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+ <span class="summary_desc"><div class='inline'><p>Returns the base URL for this group&#39;s page.</p>
216
+ </div></span>
217
+
218
+ </li>
219
+
220
+
221
+ <li class="public ">
222
+ <span class="summary_signature">
223
+
224
+ <a href="#fetch-instance_method" title="#fetch (instance method)">- (Object) <strong>fetch</strong> </a>
225
+
226
+
227
+
228
+ </span>
229
+
230
+
231
+
232
+
233
+
234
+
235
+
236
+
237
+ <span class="summary_desc"><div class='inline'><p>Loads the members of this group.</p>
238
+ </div></span>
239
+
240
+ </li>
241
+
242
+
243
+ <li class="private ">
244
+ <span class="summary_signature">
245
+
246
+ <a href="#fetch_page-instance_method" title="#fetch_page (instance method)">- (Fixnum) <strong>fetch_page</strong>(page) </a>
247
+
248
+
249
+
250
+ </span>
251
+
252
+
253
+ <span class="note title private">private</span>
254
+
255
+
256
+
257
+
258
+
259
+ <span class="summary_desc"><div class='inline'><p>Fetches a specific page of the member listing of this group.</p>
260
+ </div></span>
261
+
262
+ </li>
263
+
264
+
265
+ <li class="public ">
266
+ <span class="summary_signature">
267
+
268
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (SteamGroup) <strong>initialize</strong>(id, fetch = true) </a>
269
+
270
+
271
+
272
+ </span>
273
+
274
+ <span class="note title constructor">constructor</span>
275
+
276
+
277
+
278
+
279
+
280
+
281
+
282
+
283
+ <span class="summary_desc"><div class='inline'><p>Creates a new <code>SteamGroup</code> instance for the group with the given ID.</p>
284
+ </div></span>
285
+
286
+ </li>
287
+
288
+
289
+ <li class="public ">
290
+ <span class="summary_signature">
291
+
292
+ <a href="#member_count-instance_method" title="#member_count (instance method)">- (Fixnum) <strong>member_count</strong> </a>
293
+
294
+
295
+
296
+ </span>
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+ <span class="summary_desc"><div class='inline'><p>Returns the number of members this group has.</p>
306
+ </div></span>
307
+
308
+ </li>
309
+
310
+
311
+ <li class="public ">
312
+ <span class="summary_signature">
313
+
314
+ <a href="#members-instance_method" title="#members (instance method)">- (Array&lt;SteamId&gt;) <strong>members</strong> </a>
315
+
316
+
317
+
318
+ </span>
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+ <span class="summary_desc"><div class='inline'><p>Returns the members of this group.</p>
328
+ </div></span>
329
+
330
+ </li>
331
+
332
+
333
+ </ul>
334
+
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="XMLData.html" title="SteamCondenser::XMLData (module)">XMLData</a></span></h3>
345
+ <p class="inherited"><span class='object_link'><a href="XMLData.html#parse-instance_method" title="SteamCondenser::XMLData#parse (method)">#parse</a></span></p>
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Cacheable.html" title="SteamCondenser::Cacheable (module)">Cacheable</a></span></h3>
355
+ <p class="inherited"><span class='object_link'><a href="Cacheable.html#cache-instance_method" title="SteamCondenser::Cacheable#cache (method)">#cache</a></span>, <span class='object_link'><a href="Cacheable.html#fetched%3F-instance_method" title="SteamCondenser::Cacheable#fetched? (method)">#fetched?</a></span>, <span class='object_link'><a href="Cacheable.html#included-class_method" title="SteamCondenser::Cacheable.included (method)">included</a></span></p>
356
+ <div id="constructor_details" class="method_details_list">
357
+ <h2>Constructor Details</h2>
358
+
359
+ <div class="method_details first">
360
+ <p class="signature first" id="initialize-instance_method">
361
+
362
+ - (<tt><span class='object_link'><a href="" title="SteamCondenser::SteamGroup (class)">SteamGroup</a></span></tt>) <strong>initialize</strong>(id, fetch = true)
363
+
364
+
365
+
366
+ </p><div class="docstring">
367
+ <div class="discussion">
368
+ <p>Creates a new <code>SteamGroup</code> instance for the group with the given ID</p>
369
+
370
+
371
+ </div>
372
+ </div>
373
+ <div class="tags">
374
+ <h3>Parameters:</h3>
375
+ <ul class="param">
376
+
377
+ <li>
378
+
379
+ <span class='name'>id</span>
380
+
381
+
382
+ <span class='type'>(<tt>String</tt>, <tt>Fixnum</tt>)</span>
383
+
384
+
385
+
386
+ &mdash;
387
+ <div class='inline'><p>The custom URL of the group specified by the
388
+ group admin or the 64bit group ID</p>
389
+ </div>
390
+
391
+ </li>
392
+
393
+ <li>
394
+
395
+ <span class='name'>fetch</span>
396
+
397
+
398
+ <span class='type'>(<tt>Boolean</tt>)</span>
399
+
400
+
401
+ <em class="default">(defaults to: <tt>true</tt>)</em>
402
+
403
+
404
+ &mdash;
405
+ <div class='inline'><p>if <code>true</code> the groups&#39;s data is loaded into the
406
+ object</p>
407
+ </div>
408
+
409
+ </li>
410
+
411
+ </ul>
412
+
413
+
414
+ </div><table class="source_code">
415
+ <tr>
416
+ <td>
417
+ <pre class="lines">
418
+
419
+
420
+ 42
421
+ 43
422
+ 44
423
+ 45
424
+ 46
425
+ 47
426
+ 48
427
+ 49
428
+ 50
429
+ 51</pre>
430
+ </td>
431
+ <td>
432
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_group.rb', line 42</span>
433
+
434
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_id identifier id'>id</span><span class='comma token'>,</span> <span class='rubyid_fetch identifier id'>fetch</span> <span class='assign token'>=</span> <span class='rubyid_true true kw'>true</span><span class='rparen token'>)</span>
435
+ <span class='rubyid_if if kw'>if</span> <span class='rubyid_id identifier id'>id</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span> <span class='rubyid_Numeric constant id'>Numeric</span>
436
+ <span class='rubyid_@group_id64 ivar id'>@group_id64</span> <span class='assign token'>=</span> <span class='rubyid_id identifier id'>id</span>
437
+ <span class='rubyid_else else kw'>else</span>
438
+ <span class='rubyid_@custom_url ivar id'>@custom_url</span> <span class='assign token'>=</span> <span class='rubyid_id identifier id'>id</span><span class='dot token'>.</span><span class='rubyid_downcase identifier id'>downcase</span>
439
+ <span class='rubyid_end end kw'>end</span>
440
+ <span class='rubyid_@members ivar id'>@members</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
441
+
442
+ <span class='rubyid_super super kw'>super</span> <span class='rubyid_fetch identifier id'>fetch</span>
443
+ <span class='rubyid_end end kw'>end</span>
444
+ </pre>
445
+ </td>
446
+ </tr>
447
+ </table>
448
+ </div>
449
+
450
+ </div>
451
+
452
+ <div id="instance_attr_details" class="attr_details">
453
+ <h2>Instance Attribute Details</h2>
454
+
455
+
456
+ <span id=""></span>
457
+ <span id="custom_url-instance_method"></span>
458
+ <div class="method_details first">
459
+ <p class="signature first" id="custom_url-instance_method">
460
+
461
+ - (<tt>String</tt>) <strong>custom_url</strong> <span class="extras">(readonly)</span>
462
+
463
+
464
+
465
+ </p><div class="docstring">
466
+ <div class="discussion">
467
+ <p>Returns the custom URL of this group</p>
468
+
469
+ <p>The custom URL is a admin specified unique string that can be used
470
+ instead of the 64bit SteamID as an identifier for a group.</p>
471
+
472
+
473
+ </div>
474
+ </div>
475
+ <div class="tags">
476
+
477
+ <h3>Returns:</h3>
478
+ <ul class="return">
479
+
480
+ <li>
481
+
482
+
483
+ <span class='type'>(<tt>String</tt>)</span>
484
+
485
+
486
+
487
+ &mdash;
488
+ <div class='inline'><p>The custom URL of this group</p>
489
+ </div>
490
+
491
+ </li>
492
+
493
+ </ul>
494
+
495
+ </div><table class="source_code">
496
+ <tr>
497
+ <td>
498
+ <pre class="lines">
499
+
500
+
501
+ 29
502
+ 30
503
+ 31</pre>
504
+ </td>
505
+ <td>
506
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_group.rb', line 29</span>
507
+
508
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_custom_url identifier id'>custom_url</span>
509
+ <span class='rubyid_@custom_url ivar id'>@custom_url</span>
510
+ <span class='rubyid_end end kw'>end</span>
511
+ </pre>
512
+ </td>
513
+ </tr>
514
+ </table>
515
+ </div>
516
+
517
+
518
+ <span id=""></span>
519
+ <span id="group_id64-instance_method"></span>
520
+ <div class="method_details ">
521
+ <p class="signature " id="group_id64-instance_method">
522
+
523
+ - (<tt>Fixnum</tt>) <strong>group_id64</strong> <span class="extras">(readonly)</span>
524
+
525
+
526
+
527
+ </p><div class="docstring">
528
+ <div class="discussion">
529
+ <p>Returns this group&#39;s 64bit SteamID</p>
530
+
531
+
532
+ </div>
533
+ </div>
534
+ <div class="tags">
535
+
536
+ <h3>Returns:</h3>
537
+ <ul class="return">
538
+
539
+ <li>
540
+
541
+
542
+ <span class='type'>(<tt>Fixnum</tt>)</span>
543
+
544
+
545
+
546
+ &mdash;
547
+ <div class='inline'><p>This group&#39;s 64bit SteamID</p>
548
+ </div>
549
+
550
+ </li>
551
+
552
+ </ul>
553
+
554
+ </div><table class="source_code">
555
+ <tr>
556
+ <td>
557
+ <pre class="lines">
558
+
559
+
560
+ 34
561
+ 35
562
+ 36</pre>
563
+ </td>
564
+ <td>
565
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_group.rb', line 34</span>
566
+
567
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_group_id64 identifier id'>group_id64</span>
568
+ <span class='rubyid_@group_id64 ivar id'>@group_id64</span>
569
+ <span class='rubyid_end end kw'>end</span>
570
+ </pre>
571
+ </td>
572
+ </tr>
573
+ </table>
574
+ </div>
575
+
576
+ </div>
577
+
578
+
579
+ <div id="instance_method_details" class="method_details_list">
580
+ <h2>Instance Method Details</h2>
581
+
582
+
583
+ <div class="method_details first">
584
+ <p class="signature first" id="base_url-instance_method">
585
+
586
+ - (<tt>String</tt>) <strong>base_url</strong>
587
+
588
+
589
+
590
+ </p><div class="docstring">
591
+ <div class="discussion">
592
+ <p>Returns the base URL for this group&#39;s page</p>
593
+
594
+ <p>This URL is different for groups having a custom URL.</p>
595
+
596
+
597
+ </div>
598
+ </div>
599
+ <div class="tags">
600
+
601
+ <h3>Returns:</h3>
602
+ <ul class="return">
603
+
604
+ <li>
605
+
606
+
607
+ <span class='type'>(<tt>String</tt>)</span>
608
+
609
+
610
+
611
+ &mdash;
612
+ <div class='inline'><p>The base URL for this group</p>
613
+ </div>
614
+
615
+ </li>
616
+
617
+ </ul>
618
+
619
+ </div><table class="source_code">
620
+ <tr>
621
+ <td>
622
+ <pre class="lines">
623
+
624
+
625
+ 58
626
+ 59
627
+ 60
628
+ 61
629
+ 62
630
+ 63
631
+ 64</pre>
632
+ </td>
633
+ <td>
634
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_group.rb', line 58</span>
635
+
636
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_base_url identifier id'>base_url</span>
637
+ <span class='rubyid_if if kw'>if</span> <span class='rubyid_@custom_url ivar id'>@custom_url</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
638
+ <span class='string val'>&quot;http://steamcommunity.com/gid/#@group_id64&quot;</span>
639
+ <span class='rubyid_else else kw'>else</span>
640
+ <span class='string val'>&quot;http://steamcommunity.com/groups/#@custom_url&quot;</span>
641
+ <span class='rubyid_end end kw'>end</span>
642
+ <span class='rubyid_end end kw'>end</span>
643
+ </pre>
644
+ </td>
645
+ </tr>
646
+ </table>
647
+ </div>
648
+
649
+ <div class="method_details ">
650
+ <p class="signature " id="fetch-instance_method">
651
+
652
+ - (<tt>Object</tt>) <strong>fetch</strong>
653
+
654
+
655
+
656
+ </p><div class="docstring">
657
+ <div class="discussion">
658
+ <p>Loads the members of this group</p>
659
+
660
+ <p>This might take several HTTP requests as the Steam Community splits this
661
+ data over several XML documents if the group has lots of members.</p>
662
+
663
+
664
+ </div>
665
+ </div>
666
+ <div class="tags">
667
+
668
+
669
+ <h3>See Also:</h3>
670
+ <ul class="see">
671
+
672
+ <li><span class='object_link'><a href="Cacheable.html#fetch-instance_method" title="SteamCondenser::Cacheable#fetch (method)">Cacheable#fetch</a></span></li>
673
+
674
+ </ul>
675
+
676
+ </div><table class="source_code">
677
+ <tr>
678
+ <td>
679
+ <pre class="lines">
680
+
681
+
682
+ 72
683
+ 73
684
+ 74
685
+ 75
686
+ 76
687
+ 77
688
+ 78
689
+ 79
690
+ 80
691
+ 81
692
+ 82
693
+ 83
694
+ 84</pre>
695
+ </td>
696
+ <td>
697
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_group.rb', line 72</span>
698
+
699
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_fetch identifier id'>fetch</span>
700
+ <span class='rubyid_if if kw'>if</span> <span class='rubyid_@member_count ivar id'>@member_count</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span> <span class='orop op'>||</span> <span class='rubyid_@member_count ivar id'>@member_count</span> <span class='eq op'>==</span> <span class='rubyid_@members ivar id'>@members</span><span class='dot token'>.</span><span class='rubyid_size identifier id'>size</span>
701
+ <span class='rubyid_page identifier id'>page</span> <span class='assign token'>=</span> <span class='integer val'>0</span>
702
+ <span class='rubyid_else else kw'>else</span>
703
+ <span class='rubyid_page identifier id'>page</span> <span class='assign token'>=</span> <span class='integer val'>1</span>
704
+ <span class='rubyid_end end kw'>end</span>
705
+
706
+ <span class='rubyid_begin begin kw'>begin</span>
707
+ <span class='rubyid_total_pages identifier id'>total_pages</span> <span class='assign token'>=</span> <span class='rubyid_fetch_page identifier id'>fetch_page</span><span class='lparen token'>(</span><span class='rubyid_page identifier id'>page</span> <span class='opasgn op'>+=</span> <span class='integer val'>1</span><span class='rparen token'>)</span>
708
+ <span class='rubyid_end end kw'>end</span> <span class='rubyid_while while_mod kw'>while</span> <span class='rubyid_page identifier id'>page</span> <span class='lt op'>&lt;</span> <span class='rubyid_total_pages identifier id'>total_pages</span>
709
+
710
+ <span class='rubyid_super super kw'>super</span>
711
+ <span class='rubyid_end end kw'>end</span>
712
+ </pre>
713
+ </td>
714
+ </tr>
715
+ </table>
716
+ </div>
717
+
718
+ <div class="method_details ">
719
+ <p class="signature " id="fetch_page-instance_method">
720
+
721
+ - (<tt>Fixnum</tt>) <strong>fetch_page</strong>(page) <span class="extras">(private)</span>
722
+
723
+
724
+
725
+ </p><div class="docstring">
726
+ <div class="discussion">
727
+ <p>Fetches a specific page of the member listing of this group</p>
728
+
729
+
730
+ </div>
731
+ </div>
732
+ <div class="tags">
733
+ <h3>Parameters:</h3>
734
+ <ul class="param">
735
+
736
+ <li>
737
+
738
+ <span class='name'>page</span>
739
+
740
+
741
+ <span class='type'>(<tt>Fixnum</tt>)</span>
742
+
743
+
744
+
745
+ &mdash;
746
+ <div class='inline'><p>The member page to fetch</p>
747
+ </div>
748
+
749
+ </li>
750
+
751
+ </ul>
752
+
753
+ <h3>Returns:</h3>
754
+ <ul class="return">
755
+
756
+ <li>
757
+
758
+
759
+ <span class='type'>(<tt>Fixnum</tt>)</span>
760
+
761
+
762
+
763
+ &mdash;
764
+ <div class='inline'><p>The total number of pages of this group&#39;s member listing</p>
765
+ </div>
766
+
767
+ </li>
768
+
769
+ </ul>
770
+
771
+ </div><table class="source_code">
772
+ <tr>
773
+ <td>
774
+ <pre class="lines">
775
+
776
+
777
+ 119
778
+ 120
779
+ 121
780
+ 122
781
+ 123
782
+ 124
783
+ 125
784
+ 126
785
+ 127
786
+ 128
787
+ 129
788
+ 130
789
+ 131
790
+ 132
791
+ 133
792
+ 134
793
+ 135</pre>
794
+ </td>
795
+ <td>
796
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_group.rb', line 119</span>
797
+
798
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_fetch_page identifier id'>fetch_page</span><span class='lparen token'>(</span><span class='rubyid_page identifier id'>page</span><span class='rparen token'>)</span>
799
+ <span class='rubyid_member_data identifier id'>member_data</span> <span class='assign token'>=</span> <span class='rubyid_parse identifier id'>parse</span> <span class='dstring node'>&quot;#{base_url}/memberslistxml?p=#{page}&quot;</span>
800
+
801
+ <span class='rubyid_begin begin kw'>begin</span>
802
+ <span class='rubyid_@group_id64 ivar id'>@group_id64</span> <span class='assign token'>=</span> <span class='rubyid_member_data identifier id'>member_data</span><span class='lbrack token'>[</span><span class='string val'>'groupID64'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_page identifier id'>page</span> <span class='eq op'>==</span> <span class='integer val'>1</span>
803
+ <span class='rubyid_@member_count ivar id'>@member_count</span> <span class='assign token'>=</span> <span class='rubyid_member_data identifier id'>member_data</span><span class='lbrack token'>[</span><span class='string val'>'memberCount'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
804
+ <span class='rubyid_total_pages identifier id'>total_pages</span> <span class='assign token'>=</span> <span class='rubyid_member_data identifier id'>member_data</span><span class='lbrack token'>[</span><span class='string val'>'totalPages'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
805
+
806
+ <span class='rubyid_member_data identifier id'>member_data</span><span class='lbrack token'>[</span><span class='string val'>'members'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>'steamID64'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_each identifier id'>each</span> <span class='rubyid_do do kw'>do</span> <span class='bitor op'>|</span><span class='rubyid_member identifier id'>member</span><span class='bitor op'>|</span>
807
+ <span class='rubyid_@members ivar id'>@members</span> <span class='lshft op'>&lt;&lt;</span> <span class='rubyid_SteamId constant id'>SteamId</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span><span class='lparen token'>(</span><span class='rubyid_member identifier id'>member</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span><span class='comma token'>,</span> <span class='rubyid_false false kw'>false</span><span class='rparen token'>)</span>
808
+ <span class='rubyid_end end kw'>end</span>
809
+ <span class='rubyid_rescue rescue kw'>rescue</span>
810
+ <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_Error constant id'>Error</span><span class='comma token'>,</span> <span class='string val'>'XML data could not be parsed.'</span><span class='comma token'>,</span> <span class='rubyid_$! gvar id'>$!</span><span class='dot token'>.</span><span class='rubyid_backtrace identifier id'>backtrace</span>
811
+ <span class='rubyid_end end kw'>end</span>
812
+
813
+ <span class='rubyid_total_pages identifier id'>total_pages</span>
814
+ <span class='rubyid_end end kw'>end</span>
815
+ </pre>
816
+ </td>
817
+ </tr>
818
+ </table>
819
+ </div>
820
+
821
+ <div class="method_details ">
822
+ <p class="signature " id="member_count-instance_method">
823
+
824
+ - (<tt>Fixnum</tt>) <strong>member_count</strong>
825
+
826
+
827
+
828
+ </p><div class="docstring">
829
+ <div class="discussion">
830
+ <p>Returns the number of members this group has</p>
831
+
832
+ <p>If the members have already been fetched the size of the member array is
833
+ returned. Otherwise the the first page of the member listing is fetched
834
+ and the member count and the first batch of members is stored.</p>
835
+
836
+
837
+ </div>
838
+ </div>
839
+ <div class="tags">
840
+
841
+ <h3>Returns:</h3>
842
+ <ul class="return">
843
+
844
+ <li>
845
+
846
+
847
+ <span class='type'>(<tt>Fixnum</tt>)</span>
848
+
849
+
850
+
851
+ &mdash;
852
+ <div class='inline'><p>The number of this group&#39;s members</p>
853
+ </div>
854
+
855
+ </li>
856
+
857
+ </ul>
858
+
859
+ </div><table class="source_code">
860
+ <tr>
861
+ <td>
862
+ <pre class="lines">
863
+
864
+
865
+ 93
866
+ 94
867
+ 95
868
+ 96
869
+ 97
870
+ 98
871
+ 99
872
+ 100</pre>
873
+ </td>
874
+ <td>
875
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_group.rb', line 93</span>
876
+
877
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_member_count identifier id'>member_count</span>
878
+ <span class='rubyid_if if kw'>if</span> <span class='rubyid_@member_count ivar id'>@member_count</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
879
+ <span class='rubyid_total_pages identifier id'>total_pages</span> <span class='assign token'>=</span> <span class='rubyid_fetch_page identifier id'>fetch_page</span><span class='lparen token'>(</span><span class='integer val'>1</span><span class='rparen token'>)</span>
880
+ <span class='rubyid_@fetch_time ivar id'>@fetch_time</span> <span class='assign token'>=</span> <span class='rubyid_Time constant id'>Time</span><span class='dot token'>.</span><span class='rubyid_now identifier id'>now</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_total_pages identifier id'>total_pages</span> <span class='eq op'>==</span> <span class='integer val'>1</span>
881
+ <span class='rubyid_end end kw'>end</span>
882
+
883
+ <span class='rubyid_@member_count ivar id'>@member_count</span>
884
+ <span class='rubyid_end end kw'>end</span>
885
+ </pre>
886
+ </td>
887
+ </tr>
888
+ </table>
889
+ </div>
890
+
891
+ <div class="method_details ">
892
+ <p class="signature " id="members-instance_method">
893
+
894
+ - (<tt>Array&lt;<span class='object_link'><a href="SteamId.html" title="SteamCondenser::SteamId (class)">SteamId</a></span>&gt;</tt>) <strong>members</strong>
895
+
896
+
897
+
898
+ </p><div class="docstring">
899
+ <div class="discussion">
900
+ <p>Returns the members of this group</p>
901
+
902
+ <p>If the members haven&#39;t been fetched yet, this is done now.</p>
903
+
904
+
905
+ </div>
906
+ </div>
907
+ <div class="tags">
908
+
909
+ <h3>Returns:</h3>
910
+ <ul class="return">
911
+
912
+ <li>
913
+
914
+
915
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="SteamId.html" title="SteamCondenser::SteamId (class)">SteamId</a></span>&gt;</tt>)</span>
916
+
917
+
918
+
919
+ &mdash;
920
+ <div class='inline'><p>The Steam ID&#39;s of the members of this group</p>
921
+ </div>
922
+
923
+ </li>
924
+
925
+ </ul>
926
+
927
+ <h3>See Also:</h3>
928
+ <ul class="see">
929
+
930
+ <li><span class='object_link'><a href="#fetch-instance_method" title="SteamCondenser::SteamGroup#fetch (method)">#fetch</a></span></li>
931
+
932
+ </ul>
933
+
934
+ </div><table class="source_code">
935
+ <tr>
936
+ <td>
937
+ <pre class="lines">
938
+
939
+
940
+ 108
941
+ 109
942
+ 110
943
+ 111</pre>
944
+ </td>
945
+ <td>
946
+ <pre class="code"><span class="info file"># File 'lib/steam/community/steam_group.rb', line 108</span>
947
+
948
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_members identifier id'>members</span>
949
+ <span class='rubyid_fetch identifier id'>fetch</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_@members ivar id'>@members</span><span class='dot token'>.</span><span class='rubyid_size identifier id'>size</span> <span class='neq op'>!=</span> <span class='rubyid_@member_count ivar id'>@member_count</span>
950
+ <span class='rubyid_@members ivar id'>@members</span>
951
+ <span class='rubyid_end end kw'>end</span>
952
+ </pre>
953
+ </td>
954
+ </tr>
955
+ </table>
956
+ </div>
957
+
958
+ </div>
959
+
960
+ </div>
961
+
962
+ <div id="footer">
963
+ Generated on Mon Apr 30 07:03:05 2012 by
964
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
965
+ 0.7.5 (ruby-1.8.7).
966
+ </div>
967
+
968
+ </body>
969
+ </html>