steam-condenser 1.3.8.1 → 1.3.9

Sign up to get free protection for your applications and to get access to all the features.
Files changed (476) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +14 -0
  3. data/Gemfile +1 -1
  4. data/Gemfile.lock +48 -0
  5. data/doc/A2M_GET_SERVERS_BATCH2_Packet.html +1 -1
  6. data/doc/A2S_INFO_Packet.html +1 -1
  7. data/doc/A2S_PLAYER_Packet.html +1 -1
  8. data/doc/A2S_RULES_Packet.html +1 -1
  9. data/doc/A2S_SERVERQUERY_GETCHALLENGE_Packet.html +1 -1
  10. data/doc/AbstractL4DStats.html +1 -1
  11. data/doc/AbstractL4DWeapon.html +1 -1
  12. data/doc/AlienSwarmMission.html +1 -1
  13. data/doc/AlienSwarmStats.html +1 -1
  14. data/doc/AlienSwarmWeapon.html +1 -1
  15. data/doc/AppNews.html +1 -1
  16. data/doc/C2M_CHECKMD5_Packet.html +1 -1
  17. data/doc/CSSMap.html +1 -1
  18. data/doc/CSSStats.html +1 -1
  19. data/doc/CSSWeapon.html +1 -1
  20. data/doc/Cacheable.html +1 -1
  21. data/doc/Cacheable/ClassMethods.html +1 -1
  22. data/doc/DefenseGridStats.html +1 -1
  23. data/doc/DoDSClass.html +1 -1
  24. data/doc/DoDSStats.html +1 -1
  25. data/doc/DoDSWeapon.html +1 -1
  26. data/doc/Dota2BetaInventory.html +1 -1
  27. data/doc/Dota2Inventory.html +1 -1
  28. data/doc/Dota2Item.html +1 -1
  29. data/doc/GameAchievement.html +1 -1
  30. data/doc/GameClass.html +1 -1
  31. data/doc/GameInventory.html +1 -1
  32. data/doc/GameItem.html +1 -1
  33. data/doc/GameItemSchema.html +1 -1
  34. data/doc/GameLeaderboard.html +1 -1
  35. data/doc/GameLeaderboardEntry.html +1 -1
  36. data/doc/GameServer.html +1 -1
  37. data/doc/GameStats.html +1 -1
  38. data/doc/GameWeapon.html +1 -1
  39. data/doc/GoldSrcServer.html +1 -1
  40. data/doc/GoldSrcSocket.html +1 -1
  41. data/doc/L4D2Map.html +1 -1
  42. data/doc/L4D2Stats.html +1 -1
  43. data/doc/L4D2Weapon.html +1 -1
  44. data/doc/L4DExplosive.html +1 -1
  45. data/doc/L4DMap.html +1 -1
  46. data/doc/L4DStats.html +1 -1
  47. data/doc/L4DWeapon.html +1 -1
  48. data/doc/M2A_SERVER_BATCH_Packet.html +1 -1
  49. data/doc/M2C_ISVALIDMD5_Packet.html +1 -1
  50. data/doc/M2S_REQUESTRESTART_Packet.html +1 -1
  51. data/doc/MasterServer.html +1 -1
  52. data/doc/MasterServerSocket.html +1 -1
  53. data/doc/PacketFormatError.html +1 -1
  54. data/doc/Portal2Inventory.html +1 -1
  55. data/doc/Portal2Item.html +1 -1
  56. data/doc/Portal2Stats.html +1 -1
  57. data/doc/RCONAuthRequest.html +1 -1
  58. data/doc/RCONAuthResponse.html +1 -1
  59. data/doc/RCONBanError.html +1 -1
  60. data/doc/RCONExecRequest.html +1 -1
  61. data/doc/RCONExecResponse.html +1 -1
  62. data/doc/RCONGoldSrcRequest.html +1 -1
  63. data/doc/RCONGoldSrcResponse.html +1 -1
  64. data/doc/RCONNoAuthError.html +1 -1
  65. data/doc/RCONPacket.html +1 -1
  66. data/doc/RCONPacketFactory.html +1 -1
  67. data/doc/RCONSocket.html +13 -5
  68. data/doc/RCONTerminator.html +1 -1
  69. data/doc/RequestWithChallenge.html +1 -1
  70. data/doc/S2A_INFO2_Packet.html +1 -1
  71. data/doc/S2A_INFO_BasePacket.html +1 -1
  72. data/doc/S2A_INFO_DETAILED_Packet.html +1 -1
  73. data/doc/S2A_LOGSTRING_Packet.html +1 -1
  74. data/doc/S2A_PLAYER_Packet.html +1 -1
  75. data/doc/S2A_RULES_Packet.html +1 -1
  76. data/doc/S2C_CHALLENGE_Packet.html +1 -1
  77. data/doc/S2M_HEARTBEAT2_Packet.html +1 -1
  78. data/doc/Server.html +1 -1
  79. data/doc/SourceServer.html +33 -34
  80. data/doc/SourceSocket.html +1 -1
  81. data/doc/SteamCondenser.html +2 -2
  82. data/doc/SteamCondenser/Community.html +1 -1
  83. data/doc/SteamCondenser/Servers.html +1 -1
  84. data/doc/SteamCondenser/TimeoutError.html +1 -1
  85. data/doc/SteamCondenserError.html +1 -1
  86. data/doc/SteamGame.html +1 -1
  87. data/doc/SteamGroup.html +1 -1
  88. data/doc/SteamId.html +1 -1
  89. data/doc/SteamPacket.html +1 -1
  90. data/doc/SteamPacketFactory.html +1 -1
  91. data/doc/SteamPlayer.html +1 -1
  92. data/doc/SteamSocket.html +1 -1
  93. data/doc/StringIO.html +1 -1
  94. data/doc/TF2BetaInventory.html +1 -1
  95. data/doc/TF2Class.html +1 -1
  96. data/doc/TF2ClassFactory.html +1 -1
  97. data/doc/TF2Engineer.html +1 -1
  98. data/doc/TF2GoldenWrench.html +1 -1
  99. data/doc/TF2Inventory.html +1 -1
  100. data/doc/TF2Item.html +1 -1
  101. data/doc/TF2Medic.html +1 -1
  102. data/doc/TF2Sniper.html +1 -1
  103. data/doc/TF2Spy.html +1 -1
  104. data/doc/TF2Stats.html +1 -1
  105. data/doc/WebApi.html +1 -1
  106. data/doc/WebApiError.html +1 -1
  107. data/doc/XMLData.html +1 -1
  108. data/doc/_index.html +1 -1
  109. data/doc/file.CHANGELOG.html +20 -1
  110. data/doc/file.CONTRIBUTING.html +1 -1
  111. data/doc/file.LICENSE.html +1 -1
  112. data/doc/file.README.html +1 -1
  113. data/doc/index.html +1 -1
  114. data/doc/top-level-namespace.html +1 -1
  115. data/lib/steam-condenser/version.rb +2 -2
  116. data/lib/steam/servers/source_server.rb +13 -20
  117. data/lib/steam/sockets/rcon_socket.rb +7 -3
  118. data/pkg/steam-condenser-1.3.8.1.gem +0 -0
  119. data/pkg/steam-condenser-1.3.8.1/CHANGELOG.md +233 -0
  120. data/pkg/steam-condenser-1.3.8.1/CONTRIBUTING.md +59 -0
  121. data/pkg/steam-condenser-1.3.8.1/Gemfile +11 -0
  122. data/pkg/steam-condenser-1.3.8.1/LICENSE +25 -0
  123. data/pkg/steam-condenser-1.3.8.1/README.md +75 -0
  124. data/pkg/steam-condenser-1.3.8.1/Rakefile +46 -0
  125. data/pkg/steam-condenser-1.3.8.1/doc/A2M_GET_SERVERS_BATCH2_Packet.html +446 -0
  126. data/pkg/steam-condenser-1.3.8.1/doc/A2S_INFO_Packet.html +264 -0
  127. data/pkg/steam-condenser-1.3.8.1/doc/A2S_PLAYER_Packet.html +300 -0
  128. data/pkg/steam-condenser-1.3.8.1/doc/A2S_RULES_Packet.html +302 -0
  129. data/pkg/steam-condenser-1.3.8.1/doc/A2S_SERVERQUERY_GETCHALLENGE_Packet.html +266 -0
  130. data/pkg/steam-condenser-1.3.8.1/doc/AbstractL4DStats.html +1033 -0
  131. data/pkg/steam-condenser-1.3.8.1/doc/AbstractL4DWeapon.html +752 -0
  132. data/pkg/steam-condenser-1.3.8.1/doc/AlienSwarmMission.html +1598 -0
  133. data/pkg/steam-condenser-1.3.8.1/doc/AlienSwarmStats.html +1035 -0
  134. data/pkg/steam-condenser-1.3.8.1/doc/AlienSwarmWeapon.html +653 -0
  135. data/pkg/steam-condenser-1.3.8.1/doc/AppNews.html +1489 -0
  136. data/pkg/steam-condenser-1.3.8.1/doc/C2M_CHECKMD5_Packet.html +347 -0
  137. data/pkg/steam-condenser-1.3.8.1/doc/CSSMap.html +824 -0
  138. data/pkg/steam-condenser-1.3.8.1/doc/CSSStats.html +888 -0
  139. data/pkg/steam-condenser-1.3.8.1/doc/CSSWeapon.html +910 -0
  140. data/pkg/steam-condenser-1.3.8.1/doc/Cacheable.html +942 -0
  141. data/pkg/steam-condenser-1.3.8.1/doc/Cacheable/ClassMethods.html +721 -0
  142. data/pkg/steam-condenser-1.3.8.1/doc/DefenseGridStats.html +2659 -0
  143. data/pkg/steam-condenser-1.3.8.1/doc/DoDSClass.html +1291 -0
  144. data/pkg/steam-condenser-1.3.8.1/doc/DoDSStats.html +537 -0
  145. data/pkg/steam-condenser-1.3.8.1/doc/DoDSWeapon.html +824 -0
  146. data/pkg/steam-condenser-1.3.8.1/doc/Dota2BetaInventory.html +363 -0
  147. data/pkg/steam-condenser-1.3.8.1/doc/Dota2Inventory.html +363 -0
  148. data/pkg/steam-condenser-1.3.8.1/doc/Dota2Item.html +396 -0
  149. data/pkg/steam-condenser-1.3.8.1/doc/GameAchievement.html +1292 -0
  150. data/pkg/steam-condenser-1.3.8.1/doc/GameClass.html +328 -0
  151. data/pkg/steam-condenser-1.3.8.1/doc/GameInventory.html +1512 -0
  152. data/pkg/steam-condenser-1.3.8.1/doc/GameItem.html +1926 -0
  153. data/pkg/steam-condenser-1.3.8.1/doc/GameItemSchema.html +1477 -0
  154. data/pkg/steam-condenser-1.3.8.1/doc/GameLeaderboard.html +1741 -0
  155. data/pkg/steam-condenser-1.3.8.1/doc/GameLeaderboardEntry.html +642 -0
  156. data/pkg/steam-condenser-1.3.8.1/doc/GameServer.html +2495 -0
  157. data/pkg/steam-condenser-1.3.8.1/doc/GameStats.html +1501 -0
  158. data/pkg/steam-condenser-1.3.8.1/doc/GameWeapon.html +603 -0
  159. data/pkg/steam-condenser-1.3.8.1/doc/GoldSrcServer.html +766 -0
  160. data/pkg/steam-condenser-1.3.8.1/doc/GoldSrcSocket.html +874 -0
  161. data/pkg/steam-condenser-1.3.8.1/doc/L4D2Map.html +758 -0
  162. data/pkg/steam-condenser-1.3.8.1/doc/L4D2Stats.html +1020 -0
  163. data/pkg/steam-condenser-1.3.8.1/doc/L4D2Weapon.html +496 -0
  164. data/pkg/steam-condenser-1.3.8.1/doc/L4DExplosive.html +383 -0
  165. data/pkg/steam-condenser-1.3.8.1/doc/L4DMap.html +789 -0
  166. data/pkg/steam-condenser-1.3.8.1/doc/L4DStats.html +579 -0
  167. data/pkg/steam-condenser-1.3.8.1/doc/L4DWeapon.html +302 -0
  168. data/pkg/steam-condenser-1.3.8.1/doc/M2A_SERVER_BATCH_Packet.html +439 -0
  169. data/pkg/steam-condenser-1.3.8.1/doc/M2C_ISVALIDMD5_Packet.html +390 -0
  170. data/pkg/steam-condenser-1.3.8.1/doc/M2S_REQUESTRESTART_Packet.html +390 -0
  171. data/pkg/steam-condenser-1.3.8.1/doc/MasterServer.html +1104 -0
  172. data/pkg/steam-condenser-1.3.8.1/doc/MasterServerSocket.html +300 -0
  173. data/pkg/steam-condenser-1.3.8.1/doc/PacketFormatError.html +176 -0
  174. data/pkg/steam-condenser-1.3.8.1/doc/Portal2Inventory.html +363 -0
  175. data/pkg/steam-condenser-1.3.8.1/doc/Portal2Item.html +616 -0
  176. data/pkg/steam-condenser-1.3.8.1/doc/Portal2Stats.html +413 -0
  177. data/pkg/steam-condenser-1.3.8.1/doc/RCONAuthRequest.html +325 -0
  178. data/pkg/steam-condenser-1.3.8.1/doc/RCONAuthResponse.html +312 -0
  179. data/pkg/steam-condenser-1.3.8.1/doc/RCONBanError.html +257 -0
  180. data/pkg/steam-condenser-1.3.8.1/doc/RCONExecRequest.html +325 -0
  181. data/pkg/steam-condenser-1.3.8.1/doc/RCONExecResponse.html +416 -0
  182. data/pkg/steam-condenser-1.3.8.1/doc/RCONGoldSrcRequest.html +369 -0
  183. data/pkg/steam-condenser-1.3.8.1/doc/RCONGoldSrcResponse.html +375 -0
  184. data/pkg/steam-condenser-1.3.8.1/doc/RCONNoAuthError.html +256 -0
  185. data/pkg/steam-condenser-1.3.8.1/doc/RCONPacket.html +561 -0
  186. data/pkg/steam-condenser-1.3.8.1/doc/RCONPacketFactory.html +308 -0
  187. data/pkg/steam-condenser-1.3.8.1/doc/RCONSocket.html +725 -0
  188. data/pkg/steam-condenser-1.3.8.1/doc/RCONTerminator.html +312 -0
  189. data/pkg/steam-condenser-1.3.8.1/doc/RequestWithChallenge.html +238 -0
  190. data/pkg/steam-condenser-1.3.8.1/doc/S2A_INFO2_Packet.html +417 -0
  191. data/pkg/steam-condenser-1.3.8.1/doc/S2A_INFO_BasePacket.html +271 -0
  192. data/pkg/steam-condenser-1.3.8.1/doc/S2A_INFO_DETAILED_Packet.html +378 -0
  193. data/pkg/steam-condenser-1.3.8.1/doc/S2A_LOGSTRING_Packet.html +379 -0
  194. data/pkg/steam-condenser-1.3.8.1/doc/S2A_PLAYER_Packet.html +424 -0
  195. data/pkg/steam-condenser-1.3.8.1/doc/S2A_RULES_Packet.html +418 -0
  196. data/pkg/steam-condenser-1.3.8.1/doc/S2C_CHALLENGE_Packet.html +378 -0
  197. data/pkg/steam-condenser-1.3.8.1/doc/S2M_HEARTBEAT2_Packet.html +455 -0
  198. data/pkg/steam-condenser-1.3.8.1/doc/Server.html +886 -0
  199. data/pkg/steam-condenser-1.3.8.1/doc/SourceServer.html +920 -0
  200. data/pkg/steam-condenser-1.3.8.1/doc/SourceSocket.html +359 -0
  201. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser.html +157 -0
  202. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community.html +138 -0
  203. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/AbstractL4DStats.html +1026 -0
  204. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/AbstractL4DWeapon.html +749 -0
  205. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/AlienSwarmMission.html +1557 -0
  206. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/AlienSwarmStats.html +1013 -0
  207. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/AlienSwarmWeapon.html +641 -0
  208. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/AppNews.html +1441 -0
  209. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/CSSMap.html +805 -0
  210. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/CSSStats.html +866 -0
  211. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/CSSWeapon.html +889 -0
  212. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/Cacheable.html +911 -0
  213. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/Cacheable/ClassMethods.html +695 -0
  214. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/DefenseGridStats.html +2593 -0
  215. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/DoDSClass.html +1263 -0
  216. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/DoDSStats.html +520 -0
  217. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/DoDSWeapon.html +803 -0
  218. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/Dota2BetaInventory.html +354 -0
  219. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/Dota2Inventory.html +354 -0
  220. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/Dota2Item.html +388 -0
  221. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/Dota2Match.html +505 -0
  222. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameAchievement.html +1100 -0
  223. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameClass.html +321 -0
  224. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameInventory.html +1469 -0
  225. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameItem.html +1900 -0
  226. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameItemSchema.html +1444 -0
  227. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameLeaderboard.html +1707 -0
  228. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameLeaderboardEntry.html +630 -0
  229. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameStats.html +1461 -0
  230. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameStatsSchema.html +771 -0
  231. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameStatsValue.html +596 -0
  232. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameStatsValue/Instance.html +262 -0
  233. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/GameWeapon.html +608 -0
  234. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/L4D2Map.html +737 -0
  235. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/L4D2Stats.html +989 -0
  236. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/L4D2Weapon.html +486 -0
  237. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/L4DExplosive.html +375 -0
  238. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/L4DMap.html +775 -0
  239. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/L4DStats.html +564 -0
  240. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/L4DWeapon.html +296 -0
  241. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/Portal2Inventory.html +354 -0
  242. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/Portal2Item.html +603 -0
  243. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/Portal2Stats.html +400 -0
  244. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/SteamGame.html +1862 -0
  245. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/SteamGroup.html +1018 -0
  246. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/SteamId.html +4430 -0
  247. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2BetaInventory.html +345 -0
  248. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2Class.html +1186 -0
  249. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2ClassFactory.html +273 -0
  250. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2Engineer.html +555 -0
  251. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2GoldenWrench.html +760 -0
  252. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2Inventory.html +354 -0
  253. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2Item.html +602 -0
  254. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2Medic.html +463 -0
  255. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2Sniper.html +372 -0
  256. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2Spy.html +553 -0
  257. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/TF2Stats.html +728 -0
  258. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/UserStats.html +760 -0
  259. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/WebApi.html +1116 -0
  260. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Community/XMLData.html +274 -0
  261. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Error.html +380 -0
  262. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Error/PacketFormat.html +173 -0
  263. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Error/RCONBan.html +253 -0
  264. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Error/RCONNoAuth.html +252 -0
  265. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Error/Timeout.html +254 -0
  266. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Error/WebApi.html +354 -0
  267. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Logging.html +616 -0
  268. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers.html +137 -0
  269. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/BaseServer.html +870 -0
  270. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/GameServer.html +2428 -0
  271. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/GoldSrcServer.html +738 -0
  272. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/MasterServer.html +819 -0
  273. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets.html +132 -0
  274. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/A2M_GET_SERVERS_BATCH2_Packet.html +427 -0
  275. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/A2S_INFO_Packet.html +260 -0
  276. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/A2S_PLAYER_Packet.html +295 -0
  277. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/A2S_RULES_Packet.html +296 -0
  278. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/A2S_SERVERQUERY_GETCHALLENGE_Packet.html +261 -0
  279. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/BasePacket.html +462 -0
  280. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/M2A_SERVER_BATCH_Packet.html +430 -0
  281. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON.html +119 -0
  282. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/BasePacket.html +564 -0
  283. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/RCONAuthRequest.html +317 -0
  284. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/RCONAuthResponse.html +305 -0
  285. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/RCONExecRequest.html +317 -0
  286. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/RCONExecResponse.html +406 -0
  287. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/RCONGoldSrcRequest.html +363 -0
  288. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/RCONGoldSrcResponse.html +368 -0
  289. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/RCONPacketFactory.html +302 -0
  290. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RCON/RCONTerminator.html +304 -0
  291. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/RequestWithChallenge.html +233 -0
  292. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/S2A_INFO2_Packet.html +416 -0
  293. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/S2A_INFO_BasePacket.html +266 -0
  294. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/S2A_INFO_DETAILED_Packet.html +371 -0
  295. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/S2A_LOGSTRING_Packet.html +373 -0
  296. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/S2A_PLAYER_Packet.html +417 -0
  297. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/S2A_RULES_Packet.html +411 -0
  298. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/S2C_CHALLENGE_Packet.html +370 -0
  299. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Packets/SteamPacketFactory.html +532 -0
  300. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Sockets.html +119 -0
  301. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Sockets/BaseSocket.html +733 -0
  302. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Sockets/GoldSrcSocket.html +862 -0
  303. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Sockets/MasterServerSocket.html +306 -0
  304. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Sockets/RCONSocket.html +709 -0
  305. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/Sockets/SourceSocket.html +367 -0
  306. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/SourceServer.html +892 -0
  307. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/Servers/SteamPlayer.html +1764 -0
  308. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenser/TimeoutError.html +260 -0
  309. data/pkg/steam-condenser-1.3.8.1/doc/SteamCondenserError.html +378 -0
  310. data/pkg/steam-condenser-1.3.8.1/doc/SteamGame.html +2001 -0
  311. data/pkg/steam-condenser-1.3.8.1/doc/SteamGroup.html +1587 -0
  312. data/pkg/steam-condenser-1.3.8.1/doc/SteamId.html +4428 -0
  313. data/pkg/steam-condenser-1.3.8.1/doc/SteamPacket.html +457 -0
  314. data/pkg/steam-condenser-1.3.8.1/doc/SteamPacketFactory.html +574 -0
  315. data/pkg/steam-condenser-1.3.8.1/doc/SteamPlayer.html +1808 -0
  316. data/pkg/steam-condenser-1.3.8.1/doc/SteamSocket.html +728 -0
  317. data/pkg/steam-condenser-1.3.8.1/doc/StringIO.html +986 -0
  318. data/pkg/steam-condenser-1.3.8.1/doc/TF2BetaInventory.html +338 -0
  319. data/pkg/steam-condenser-1.3.8.1/doc/TF2Class.html +1228 -0
  320. data/pkg/steam-condenser-1.3.8.1/doc/TF2ClassFactory.html +281 -0
  321. data/pkg/steam-condenser-1.3.8.1/doc/TF2Engineer.html +572 -0
  322. data/pkg/steam-condenser-1.3.8.1/doc/TF2GoldenWrench.html +776 -0
  323. data/pkg/steam-condenser-1.3.8.1/doc/TF2Inventory.html +363 -0
  324. data/pkg/steam-condenser-1.3.8.1/doc/TF2Item.html +617 -0
  325. data/pkg/steam-condenser-1.3.8.1/doc/TF2Medic.html +476 -0
  326. data/pkg/steam-condenser-1.3.8.1/doc/TF2Sniper.html +381 -0
  327. data/pkg/steam-condenser-1.3.8.1/doc/TF2Spy.html +567 -0
  328. data/pkg/steam-condenser-1.3.8.1/doc/TF2Stats.html +751 -0
  329. data/pkg/steam-condenser-1.3.8.1/doc/WebApi.html +1156 -0
  330. data/pkg/steam-condenser-1.3.8.1/doc/WebApiError.html +375 -0
  331. data/pkg/steam-condenser-1.3.8.1/doc/XMLData.html +280 -0
  332. data/pkg/steam-condenser-1.3.8.1/doc/_index.html +728 -0
  333. data/pkg/steam-condenser-1.3.8.1/doc/class_list.html +54 -0
  334. data/pkg/steam-condenser-1.3.8.1/doc/css/common.css +1 -0
  335. data/pkg/steam-condenser-1.3.8.1/doc/css/full_list.css +57 -0
  336. data/pkg/steam-condenser-1.3.8.1/doc/css/style.css +338 -0
  337. data/pkg/steam-condenser-1.3.8.1/doc/file.CHANGELOG.html +472 -0
  338. data/pkg/steam-condenser-1.3.8.1/doc/file.CONTRIBUTING.html +156 -0
  339. data/pkg/steam-condenser-1.3.8.1/doc/file.LICENSE.html +118 -0
  340. data/pkg/steam-condenser-1.3.8.1/doc/file.README.html +179 -0
  341. data/pkg/steam-condenser-1.3.8.1/doc/file_list.html +65 -0
  342. data/pkg/steam-condenser-1.3.8.1/doc/frames.html +26 -0
  343. data/pkg/steam-condenser-1.3.8.1/doc/index.html +179 -0
  344. data/pkg/steam-condenser-1.3.8.1/doc/js/app.js +219 -0
  345. data/pkg/steam-condenser-1.3.8.1/doc/js/full_list.js +178 -0
  346. data/pkg/steam-condenser-1.3.8.1/doc/js/jquery.js +4 -0
  347. data/pkg/steam-condenser-1.3.8.1/doc/method_list.html +3191 -0
  348. data/pkg/steam-condenser-1.3.8.1/doc/top-level-namespace.html +114 -0
  349. data/pkg/steam-condenser-1.3.8.1/lib/core_ext/stringio.rb +93 -0
  350. data/pkg/steam-condenser-1.3.8.1/lib/errors/packet_format_error.rb +13 -0
  351. data/pkg/steam-condenser-1.3.8.1/lib/errors/rcon_ban_error.rb +22 -0
  352. data/pkg/steam-condenser-1.3.8.1/lib/errors/rcon_no_auth_error.rb +21 -0
  353. data/pkg/steam-condenser-1.3.8.1/lib/errors/steam_condenser_error.rb +26 -0
  354. data/pkg/steam-condenser-1.3.8.1/lib/errors/timeout_error.rb +28 -0
  355. data/pkg/steam-condenser-1.3.8.1/lib/errors/web_api_error.rb +57 -0
  356. data/pkg/steam-condenser-1.3.8.1/lib/steam-condenser.rb +18 -0
  357. data/pkg/steam-condenser-1.3.8.1/lib/steam-condenser/community.rb +24 -0
  358. data/pkg/steam-condenser-1.3.8.1/lib/steam-condenser/servers.rb +24 -0
  359. data/pkg/steam-condenser-1.3.8.1/lib/steam-condenser/version.rb +11 -0
  360. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/alien_swarm/alien_swarm_mission.rb +120 -0
  361. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/alien_swarm/alien_swarm_stats.rb +188 -0
  362. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/alien_swarm/alien_swarm_weapon.rb +49 -0
  363. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/app_news.rb +133 -0
  364. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/cacheable.rb +199 -0
  365. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/css/css_map.rb +61 -0
  366. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/css/css_stats.rb +140 -0
  367. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/css/css_weapon.rb +69 -0
  368. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/defense_grid/defense_grid_stats.rb +238 -0
  369. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/dods/dods_class.rb +90 -0
  370. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/dods/dods_stats.rb +62 -0
  371. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/dods/dods_weapon.rb +67 -0
  372. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/dota2/dota2_beta_inventory.rb +30 -0
  373. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/dota2/dota2_inventory.rb +30 -0
  374. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/dota2/dota2_item.rb +33 -0
  375. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/game_achievement.rb +109 -0
  376. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/game_class.rb +22 -0
  377. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/game_inventory.rb +171 -0
  378. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/game_item.rb +155 -0
  379. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/game_item_schema.rb +131 -0
  380. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/game_leaderboard.rb +212 -0
  381. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/game_leaderboard_entry.rb +43 -0
  382. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/game_stats.rb +175 -0
  383. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/game_weapon.rb +41 -0
  384. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/l4d/abstract_l4d_stats.rb +188 -0
  385. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/l4d/abstract_l4d_weapon.rb +56 -0
  386. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/l4d/l4d2_map.rb +90 -0
  387. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/l4d/l4d2_stats.rb +179 -0
  388. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/l4d/l4d2_weapon.rb +38 -0
  389. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/l4d/l4d_explosive.rb +34 -0
  390. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/l4d/l4d_map.rb +65 -0
  391. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/l4d/l4d_stats.rb +73 -0
  392. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/l4d/l4d_weapon.rb +26 -0
  393. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/portal2/portal2_inventory.rb +30 -0
  394. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/portal2/portal2_item.rb +55 -0
  395. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/portal2/portal2_stats.rb +33 -0
  396. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/steam_game.rb +193 -0
  397. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/steam_group.rb +176 -0
  398. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/steam_id.rb +496 -0
  399. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_beta_inventory.rb +28 -0
  400. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_class.rb +92 -0
  401. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_class_factory.rb +40 -0
  402. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_engineer.rb +43 -0
  403. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_golden_wrench.rb +70 -0
  404. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_inventory.rb +30 -0
  405. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_item.rb +55 -0
  406. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_medic.rb +35 -0
  407. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_sniper.rb +28 -0
  408. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_spy.rb +41 -0
  409. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/tf2/tf2_stats.rb +77 -0
  410. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/web_api.rb +139 -0
  411. data/pkg/steam-condenser-1.3.8.1/lib/steam/community/xml_data.rb +27 -0
  412. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/a2m_get_servers_batch2_packet.rb +59 -0
  413. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/a2s_info_packet.rb +24 -0
  414. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/a2s_player_packet.rb +31 -0
  415. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/a2s_rules_packet.rb +32 -0
  416. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/a2s_serverquery_getchallenge_packet.rb +25 -0
  417. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/c2m_checkmd5_packet.rb +31 -0
  418. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/m2a_server_batch_packet.rb +52 -0
  419. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/m2c_isvalidmd5_packet.rb +34 -0
  420. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/m2s_requestrestart_packet.rb +34 -0
  421. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/rcon/rcon_auth_request.rb +28 -0
  422. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/rcon/rcon_auth_response.rb +30 -0
  423. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/rcon/rcon_exec_request.rb +28 -0
  424. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/rcon/rcon_exec_response.rb +37 -0
  425. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/rcon/rcon_goldsrc_request.rb +35 -0
  426. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/rcon/rcon_goldsrc_response.rb +34 -0
  427. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/rcon/rcon_packet.rb +57 -0
  428. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/rcon/rcon_packet_factory.rb +43 -0
  429. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/rcon/rcon_terminator.rb +29 -0
  430. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/request_with_challenge.rb +19 -0
  431. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/s2a_info2_packet.rb +76 -0
  432. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/s2a_info_base_packet.rb +25 -0
  433. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/s2a_info_detailed_packet.rb +64 -0
  434. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/s2a_logstring_packet.rb +30 -0
  435. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/s2a_player_packet.rb +44 -0
  436. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/s2a_rules_packet.rb +48 -0
  437. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/s2c_challenge_packet.rb +35 -0
  438. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/s2m_heartbeat2_packet.rb +72 -0
  439. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/steam_packet.rb +52 -0
  440. data/pkg/steam-condenser-1.3.8.1/lib/steam/packets/steam_packet_factory.rb +113 -0
  441. data/pkg/steam-condenser-1.3.8.1/lib/steam/servers/game_server.rb +393 -0
  442. data/pkg/steam-condenser-1.3.8.1/lib/steam/servers/goldsrc_server.rb +74 -0
  443. data/pkg/steam-condenser-1.3.8.1/lib/steam/servers/master_server.rb +188 -0
  444. data/pkg/steam-condenser-1.3.8.1/lib/steam/servers/server.rb +115 -0
  445. data/pkg/steam-condenser-1.3.8.1/lib/steam/servers/source_server.rb +123 -0
  446. data/pkg/steam-condenser-1.3.8.1/lib/steam/sockets/goldsrc_socket.rb +142 -0
  447. data/pkg/steam-condenser-1.3.8.1/lib/steam/sockets/master_server_socket.rb +34 -0
  448. data/pkg/steam-condenser-1.3.8.1/lib/steam/sockets/rcon_socket.rb +103 -0
  449. data/pkg/steam-condenser-1.3.8.1/lib/steam/sockets/source_socket.rb +73 -0
  450. data/pkg/steam-condenser-1.3.8.1/lib/steam/sockets/steam_socket.rb +91 -0
  451. data/pkg/steam-condenser-1.3.8.1/lib/steam/steam_player.rb +143 -0
  452. data/pkg/steam-condenser-1.3.8.1/steam-condenser.gemspec +25 -0
  453. data/pkg/steam-condenser-1.3.8.1/test/core_ext/test_stringio.rb +59 -0
  454. data/pkg/steam-condenser-1.3.8.1/test/fixtures/invalid.xml +2 -0
  455. data/pkg/steam-condenser-1.3.8.1/test/fixtures/sonofthor.xml +882 -0
  456. data/pkg/steam-condenser-1.3.8.1/test/fixtures/status_goldsrc +3 -0
  457. data/pkg/steam-condenser-1.3.8.1/test/fixtures/status_source +3 -0
  458. data/pkg/steam-condenser-1.3.8.1/test/fixtures/valve-members.xml +261 -0
  459. data/pkg/steam-condenser-1.3.8.1/test/helper.rb +48 -0
  460. data/pkg/steam-condenser-1.3.8.1/test/steam/community/test_cacheable.rb +103 -0
  461. data/pkg/steam-condenser-1.3.8.1/test/steam/community/test_steam_group.rb +94 -0
  462. data/pkg/steam-condenser-1.3.8.1/test/steam/community/test_steam_id.rb +144 -0
  463. data/pkg/steam-condenser-1.3.8.1/test/steam/community/test_web_api.rb +124 -0
  464. data/pkg/steam-condenser-1.3.8.1/test/steam/packets/test_steam_packet.rb +37 -0
  465. data/pkg/steam-condenser-1.3.8.1/test/steam/servers/test_game_server.rb +296 -0
  466. data/pkg/steam-condenser-1.3.8.1/test/steam/servers/test_goldsrc_server.rb +59 -0
  467. data/pkg/steam-condenser-1.3.8.1/test/steam/servers/test_master_server.rb +131 -0
  468. data/pkg/steam-condenser-1.3.8.1/test/steam/servers/test_server.rb +72 -0
  469. data/pkg/steam-condenser-1.3.8.1/test/steam/servers/test_source_server.rb +145 -0
  470. data/pkg/steam-condenser-1.3.8.1/test/steam/sockets/test_goldsrc_socket.rb +127 -0
  471. data/pkg/steam-condenser-1.3.8.1/test/steam/sockets/test_master_server_socket.rb +42 -0
  472. data/pkg/steam-condenser-1.3.8.1/test/steam/sockets/test_rcon_socket.rb +118 -0
  473. data/pkg/steam-condenser-1.3.8.1/test/steam/sockets/test_source_socket.rb +77 -0
  474. data/pkg/steam-condenser-1.3.8.1/test/steam/sockets/test_steam_socket.rb +97 -0
  475. data/test/steam/sockets/test_rcon_socket.rb +3 -7
  476. metadata +360 -2
@@ -0,0 +1,1707 @@
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::Community::GameLeaderboard
8
+
9
+ &mdash; Metior — API Documentation
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../../';
20
+ framesUrl = "../../frames.html#!" + escape(window.location.href);
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../../_index.html">Index (G)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../../SteamCondenser.html" title="SteamCondenser (module)">SteamCondenser</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Community.html" title="SteamCondenser::Community (module)">Community</a></span></span>
36
+ &raquo;
37
+ <span class="title">GameLeaderboard</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: SteamCondenser::Community::GameLeaderboard
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Object</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">SteamCondenser::Community::GameLeaderboard</li>
82
+
83
+ </ul>
84
+ <a href="#" class="inheritanceTree">show all</a>
85
+
86
+ </dd>
87
+
88
+
89
+
90
+
91
+
92
+
93
+ <dt class="r2">Includes:</dt>
94
+ <dd class="r2"><span class='object_link'><a href="XMLData.html" title="SteamCondenser::Community::XMLData (module)">XMLData</a></span></dd>
95
+
96
+
97
+
98
+
99
+
100
+ <dt class="r1 last">Defined in:</dt>
101
+ <dd class="r1 last">lib/steam-condenser/community/game_leaderboard.rb</dd>
102
+
103
+ </dl>
104
+ <div class="clear"></div>
105
+
106
+ <h2>Overview</h2><div class="docstring">
107
+ <div class="discussion">
108
+ <p>The GameLeaderboard class represents a single leaderboard for a specific
109
+ game</p>
110
+
111
+
112
+ </div>
113
+ </div>
114
+ <div class="tags">
115
+
116
+ <p class="tag_title">Author:</p>
117
+ <ul class="author">
118
+
119
+ <li>
120
+
121
+
122
+
123
+
124
+
125
+ <div class='inline'><p>Sebastian Staudt</p>
126
+ </div>
127
+
128
+ </li>
129
+
130
+ </ul>
131
+
132
+ </div>
133
+ <h2>Constant Summary</h2>
134
+
135
+ <dl class="constants">
136
+
137
+ <dt id="DISPLAY_TYPE_NONE-constant" class="">DISPLAY_TYPE_NONE =
138
+
139
+ </dt>
140
+ <dd><pre class="code"><span class='integer val'>0</span>
141
+ </pre></dd>
142
+
143
+ <dt id="DISPLAY_TYPE_NUMERIC-constant" class="">DISPLAY_TYPE_NUMERIC =
144
+
145
+ </dt>
146
+ <dd><pre class="code"><span class='integer val'>1</span>
147
+ </pre></dd>
148
+
149
+ <dt id="DISPLAY_TYPE_SECONDS-constant" class="">DISPLAY_TYPE_SECONDS =
150
+
151
+ </dt>
152
+ <dd><pre class="code"><span class='integer val'>2</span>
153
+ </pre></dd>
154
+
155
+ <dt id="DISPLAY_TYPE_MILLISECONDS-constant" class="">DISPLAY_TYPE_MILLISECONDS =
156
+
157
+ </dt>
158
+ <dd><pre class="code"><span class='integer val'>3</span>
159
+ </pre></dd>
160
+
161
+ <dt id="SORT_METHOD_NONE-constant" class="">SORT_METHOD_NONE =
162
+
163
+ </dt>
164
+ <dd><pre class="code"><span class='integer val'>0</span>
165
+ </pre></dd>
166
+
167
+ <dt id="SORT_METHOD_ASC-constant" class="">SORT_METHOD_ASC =
168
+
169
+ </dt>
170
+ <dd><pre class="code"><span class='integer val'>1</span>
171
+ </pre></dd>
172
+
173
+ <dt id="SORT_METHOD_DESC-constant" class="">SORT_METHOD_DESC =
174
+
175
+ </dt>
176
+ <dd><pre class="code"><span class='integer val'>2</span>
177
+ </pre></dd>
178
+
179
+ <dt id="leaderboards-classvariable" class="">@@leaderboards =
180
+
181
+ </dt>
182
+ <dd><pre class="code"><span class='lbrace token'>{</span><span class='rbrace token'>}</span>
183
+ </pre></dd>
184
+
185
+ </dl>
186
+
187
+
188
+
189
+
190
+
191
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
192
+ <ul class="summary">
193
+
194
+ <li class="public ">
195
+ <span class="summary_signature">
196
+
197
+ <a href="#display_type-instance_method" title="#display_type (instance method)">- (Fixnum) <strong>display_type</strong> </a>
198
+
199
+
200
+
201
+ </span>
202
+
203
+
204
+
205
+
206
+ <span class="note title readonly">readonly</span>
207
+
208
+
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+ <span class="summary_desc"><div class='inline'><p>Returns the display type of the scores on this leaderboard.</p>
217
+ </div></span>
218
+
219
+ </li>
220
+
221
+
222
+ <li class="public ">
223
+ <span class="summary_signature">
224
+
225
+ <a href="#entry_count-instance_method" title="#entry_count (instance method)">- (Fixnum) <strong>entry_count</strong> </a>
226
+
227
+
228
+
229
+ </span>
230
+
231
+
232
+
233
+
234
+ <span class="note title readonly">readonly</span>
235
+
236
+
237
+
238
+
239
+
240
+
241
+
242
+
243
+
244
+ <span class="summary_desc"><div class='inline'><p>Returns the number of entries on this leaderboard.</p>
245
+ </div></span>
246
+
247
+ </li>
248
+
249
+
250
+ <li class="public ">
251
+ <span class="summary_signature">
252
+
253
+ <a href="#id-instance_method" title="#id (instance method)">- (Fixnum) <strong>id</strong> </a>
254
+
255
+
256
+
257
+ </span>
258
+
259
+
260
+
261
+
262
+ <span class="note title readonly">readonly</span>
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+ <span class="summary_desc"><div class='inline'><p>Returns the ID of the leaderboard.</p>
273
+ </div></span>
274
+
275
+ </li>
276
+
277
+
278
+ <li class="public ">
279
+ <span class="summary_signature">
280
+
281
+ <a href="#name-instance_method" title="#name (instance method)">- (String) <strong>name</strong> </a>
282
+
283
+
284
+
285
+ </span>
286
+
287
+
288
+
289
+
290
+ <span class="note title readonly">readonly</span>
291
+
292
+
293
+
294
+
295
+
296
+
297
+
298
+
299
+
300
+ <span class="summary_desc"><div class='inline'><p>Returns the name of the leaderboard.</p>
301
+ </div></span>
302
+
303
+ </li>
304
+
305
+
306
+ <li class="public ">
307
+ <span class="summary_signature">
308
+
309
+ <a href="#sort_method-instance_method" title="#sort_method (instance method)">- (Fixnum) <strong>sort_method</strong> </a>
310
+
311
+
312
+
313
+ </span>
314
+
315
+
316
+
317
+
318
+ <span class="note title readonly">readonly</span>
319
+
320
+
321
+
322
+
323
+
324
+
325
+
326
+
327
+
328
+ <span class="summary_desc"><div class='inline'><p>Returns the method that is used to sort the entries on the leaderboard.</p>
329
+ </div></span>
330
+
331
+ </li>
332
+
333
+
334
+ </ul>
335
+
336
+
337
+
338
+
339
+
340
+ <h2>
341
+ Class Method Summary
342
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
343
+ </h2>
344
+
345
+ <ul class="summary">
346
+
347
+ <li class="public ">
348
+ <span class="summary_signature">
349
+
350
+ <a href="#leaderboard-class_method" title="leaderboard (class method)">+ (GameLeaderboard) <strong>leaderboard</strong>(game_name, id) </a>
351
+
352
+
353
+
354
+ </span>
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+
364
+ <span class="summary_desc"><div class='inline'><p>Returns the leaderboard for the given game and leaderboard ID or name.</p>
365
+ </div></span>
366
+
367
+ </li>
368
+
369
+
370
+ <li class="public ">
371
+ <span class="summary_signature">
372
+
373
+ <a href="#leaderboards-class_method" title="leaderboards (class method)">+ (Array&lt;GameLeaderboard&gt;) <strong>leaderboards</strong>(game_name) </a>
374
+
375
+
376
+
377
+ </span>
378
+
379
+
380
+
381
+
382
+
383
+
384
+
385
+
386
+
387
+ <span class="summary_desc"><div class='inline'><p>Returns an array containing all of a game&#39;s leaderboards.</p>
388
+ </div></span>
389
+
390
+ </li>
391
+
392
+
393
+ <li class="private ">
394
+ <span class="summary_signature">
395
+
396
+ <a href="#load_leaderboards-class_method" title="load_leaderboards (class method)">+ (Object) <strong>load_leaderboards</strong>(game_name) </a>
397
+
398
+
399
+
400
+ </span>
401
+
402
+
403
+
404
+ <span class="note title private">private</span>
405
+
406
+
407
+
408
+
409
+
410
+ <span class="summary_desc"><div class='inline'><p>Loads the leaderboards of the specified games into the cache.</p>
411
+ </div></span>
412
+
413
+ </li>
414
+
415
+
416
+ </ul>
417
+
418
+ <h2>
419
+ Instance Method Summary
420
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
421
+ </h2>
422
+
423
+ <ul class="summary">
424
+
425
+ <li class="public ">
426
+ <span class="summary_signature">
427
+
428
+ <a href="#entry_for_steam_id-instance_method" title="#entry_for_steam_id (instance method)">- (GameLeaderboardEntry) <strong>entry_for_steam_id</strong>(steam_id) </a>
429
+
430
+
431
+
432
+ </span>
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+ <span class="summary_desc"><div class='inline'><p>Returns the entry on this leaderboard for the user with the given SteamID.</p>
443
+ </div></span>
444
+
445
+ </li>
446
+
447
+
448
+ <li class="public ">
449
+ <span class="summary_signature">
450
+
451
+ <a href="#entry_for_steam_id_friends-instance_method" title="#entry_for_steam_id_friends (instance method)">- (Array&lt;GameLeaderboardEntry&gt;) <strong>entry_for_steam_id_friends</strong>(steam_id) </a>
452
+
453
+
454
+
455
+ </span>
456
+
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+ <span class="summary_desc"><div class='inline'><p>Returns an array of entries on this leaderboard for the user with the given SteamID and his/her friends.</p>
466
+ </div></span>
467
+
468
+ </li>
469
+
470
+
471
+ <li class="public ">
472
+ <span class="summary_signature">
473
+
474
+ <a href="#entry_range-instance_method" title="#entry_range (instance method)">- (Array&lt;GameLeaderboardEntry&gt;) <strong>entry_range</strong>(first, last) </a>
475
+
476
+
477
+
478
+ </span>
479
+
480
+
481
+
482
+
483
+
484
+
485
+
486
+
487
+
488
+ <span class="summary_desc"><div class='inline'><p>Returns the entries on this leaderboard for a given rank range.</p>
489
+ </div></span>
490
+
491
+ </li>
492
+
493
+
494
+ <li class="private ">
495
+ <span class="summary_signature">
496
+
497
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (GameLeaderboard) <strong>initialize</strong>(board_data) </a>
498
+
499
+
500
+
501
+ </span>
502
+
503
+
504
+ <span class="note title constructor">constructor</span>
505
+
506
+
507
+ <span class="note title private">private</span>
508
+
509
+
510
+
511
+
512
+
513
+ <span class="summary_desc"><div class='inline'><p>Creates a new leaderboard instance with the given XML data.</p>
514
+ </div></span>
515
+
516
+ </li>
517
+
518
+
519
+ <li class="private ">
520
+ <span class="summary_signature">
521
+
522
+ <a href="#parse_entries-instance_method" title="#parse_entries (instance method)">- (Array&lt;GameLeaderboardEntry&gt;) <strong>parse_entries</strong> </a>
523
+
524
+
525
+
526
+ </span>
527
+
528
+
529
+
530
+ <span class="note title private">private</span>
531
+
532
+
533
+
534
+
535
+
536
+ <span class="summary_desc"><div class='inline'><p>Parses all entries available in the XML data.</p>
537
+ </div></span>
538
+
539
+ </li>
540
+
541
+
542
+ </ul>
543
+
544
+
545
+
546
+
547
+
548
+
549
+
550
+
551
+
552
+
553
+
554
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="XMLData.html" title="SteamCondenser::Community::XMLData (module)">XMLData</a></span></h3>
555
+ <p class="inherited"><span class='object_link'><a href="XMLData.html#parse-instance_method" title="SteamCondenser::Community::XMLData#parse (method)">#parse</a></span></p>
556
+ <div id="constructor_details" class="method_details_list">
557
+ <h2>Constructor Details</h2>
558
+
559
+ <div class="method_details first">
560
+ <h3 class="signature first" id="initialize-instance_method">
561
+
562
+ - (<tt><span class='object_link'><a href="" title="SteamCondenser::Community::GameLeaderboard (class)">GameLeaderboard</a></span></tt>) <strong>initialize</strong>(board_data) <span class="extras">(private)</span>
563
+
564
+
565
+
566
+
567
+
568
+ </h3><div class="docstring">
569
+ <div class="discussion">
570
+ <p>Creates a new leaderboard instance with the given XML data</p>
571
+
572
+
573
+ </div>
574
+ </div>
575
+ <div class="tags">
576
+ <p class="tag_title">Parameters:</p>
577
+ <ul class="param">
578
+
579
+ <li>
580
+
581
+ <span class='name'>board_data</span>
582
+
583
+
584
+ <span class='type'>(<tt>Hash&lt;String, Object&gt;</tt>)</span>
585
+
586
+
587
+
588
+ &mdash;
589
+ <div class='inline'><p>The XML data of the leaderboard</p>
590
+ </div>
591
+
592
+ </li>
593
+
594
+ </ul>
595
+
596
+
597
+ </div><table class="source_code">
598
+ <tr>
599
+ <td>
600
+ <pre class="lines">
601
+
602
+
603
+ 170
604
+ 171
605
+ 172
606
+ 173
607
+ 174
608
+ 175
609
+ 176
610
+ 177</pre>
611
+ </td>
612
+ <td>
613
+ <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_leaderboard.rb', line 170</span>
614
+
615
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rubyid_board_data identifier id'>board_data</span><span class='rparen token'>)</span>
616
+ <span class='rubyid_@url ivar id'>@url</span> <span class='assign token'>=</span> <span class='rubyid_board_data identifier id'>board_data</span><span class='lbrack token'>[</span><span class='string val'>'url'</span><span class='rbrack token'>]</span>
617
+ <span class='rubyid_@id ivar id'>@id</span> <span class='assign token'>=</span> <span class='rubyid_board_data identifier id'>board_data</span><span class='lbrack token'>[</span><span class='string val'>'lbid'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
618
+ <span class='rubyid_@name ivar id'>@name</span> <span class='assign token'>=</span> <span class='rubyid_board_data identifier id'>board_data</span><span class='lbrack token'>[</span><span class='string val'>'name'</span><span class='rbrack token'>]</span>
619
+ <span class='rubyid_@entry_count ivar id'>@entry_count</span> <span class='assign token'>=</span> <span class='rubyid_board_data identifier id'>board_data</span><span class='lbrack token'>[</span><span class='string val'>'entries'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
620
+ <span class='rubyid_@sort_method ivar id'>@sort_method</span> <span class='assign token'>=</span> <span class='rubyid_board_data identifier id'>board_data</span><span class='lbrack token'>[</span><span class='string val'>'sortmethod'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
621
+ <span class='rubyid_@display_type ivar id'>@display_type</span> <span class='assign token'>=</span> <span class='rubyid_board_data identifier id'>board_data</span><span class='lbrack token'>[</span><span class='string val'>'displaytype'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
622
+ <span class='rubyid_end end kw'>end</span>
623
+ </pre>
624
+ </td>
625
+ </tr>
626
+ </table>
627
+ </div>
628
+
629
+ </div>
630
+
631
+ <div id="instance_attr_details" class="attr_details">
632
+ <h2>Instance Attribute Details</h2>
633
+
634
+
635
+ <span id=""></span>
636
+ <div class="method_details first">
637
+ <h3 class="signature first" id="display_type-instance_method">
638
+
639
+ - (<tt>Fixnum</tt>) <strong>display_type</strong> <span class="extras">(readonly)</span>
640
+
641
+
642
+
643
+
644
+
645
+ </h3><div class="docstring">
646
+ <div class="discussion">
647
+ <p>Returns the display type of the scores on this leaderboard</p>
648
+
649
+
650
+ </div>
651
+ </div>
652
+ <div class="tags">
653
+
654
+ <p class="tag_title">Returns:</p>
655
+ <ul class="return">
656
+
657
+ <li>
658
+
659
+
660
+ <span class='type'>(<tt>Fixnum</tt>)</span>
661
+
662
+
663
+
664
+ &mdash;
665
+ <div class='inline'><p>The display type of the scores</p>
666
+ </div>
667
+
668
+ </li>
669
+
670
+ </ul>
671
+
672
+ </div><table class="source_code">
673
+ <tr>
674
+ <td>
675
+ <pre class="lines">
676
+
677
+
678
+ 36
679
+ 37
680
+ 38</pre>
681
+ </td>
682
+ <td>
683
+ <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_leaderboard.rb', line 36</span>
684
+
685
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_display_type identifier id'>display_type</span>
686
+ <span class='rubyid_@display_type ivar id'>@display_type</span>
687
+ <span class='rubyid_end end kw'>end</span>
688
+ </pre>
689
+ </td>
690
+ </tr>
691
+ </table>
692
+ </div>
693
+
694
+
695
+ <span id=""></span>
696
+ <div class="method_details ">
697
+ <h3 class="signature " id="entry_count-instance_method">
698
+
699
+ - (<tt>Fixnum</tt>) <strong>entry_count</strong> <span class="extras">(readonly)</span>
700
+
701
+
702
+
703
+
704
+
705
+ </h3><div class="docstring">
706
+ <div class="discussion">
707
+ <p>Returns the number of entries on this leaderboard</p>
708
+
709
+
710
+ </div>
711
+ </div>
712
+ <div class="tags">
713
+
714
+ <p class="tag_title">Returns:</p>
715
+ <ul class="return">
716
+
717
+ <li>
718
+
719
+
720
+ <span class='type'>(<tt>Fixnum</tt>)</span>
721
+
722
+
723
+
724
+ &mdash;
725
+ <div class='inline'><p>The number of entries on this leaderboard</p>
726
+ </div>
727
+
728
+ </li>
729
+
730
+ </ul>
731
+
732
+ </div><table class="source_code">
733
+ <tr>
734
+ <td>
735
+ <pre class="lines">
736
+
737
+
738
+ 41
739
+ 42
740
+ 43</pre>
741
+ </td>
742
+ <td>
743
+ <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_leaderboard.rb', line 41</span>
744
+
745
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_entry_count identifier id'>entry_count</span>
746
+ <span class='rubyid_@entry_count ivar id'>@entry_count</span>
747
+ <span class='rubyid_end end kw'>end</span>
748
+ </pre>
749
+ </td>
750
+ </tr>
751
+ </table>
752
+ </div>
753
+
754
+
755
+ <span id=""></span>
756
+ <div class="method_details ">
757
+ <h3 class="signature " id="id-instance_method">
758
+
759
+ - (<tt>Fixnum</tt>) <strong>id</strong> <span class="extras">(readonly)</span>
760
+
761
+
762
+
763
+
764
+
765
+ </h3><div class="docstring">
766
+ <div class="discussion">
767
+ <p>Returns the ID of the leaderboard</p>
768
+
769
+
770
+ </div>
771
+ </div>
772
+ <div class="tags">
773
+
774
+ <p class="tag_title">Returns:</p>
775
+ <ul class="return">
776
+
777
+ <li>
778
+
779
+
780
+ <span class='type'>(<tt>Fixnum</tt>)</span>
781
+
782
+
783
+
784
+ &mdash;
785
+ <div class='inline'><p>The ID of the leaderboard</p>
786
+ </div>
787
+
788
+ </li>
789
+
790
+ </ul>
791
+
792
+ </div><table class="source_code">
793
+ <tr>
794
+ <td>
795
+ <pre class="lines">
796
+
797
+
798
+ 46
799
+ 47
800
+ 48</pre>
801
+ </td>
802
+ <td>
803
+ <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_leaderboard.rb', line 46</span>
804
+
805
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_id identifier id'>id</span>
806
+ <span class='rubyid_@id ivar id'>@id</span>
807
+ <span class='rubyid_end end kw'>end</span>
808
+ </pre>
809
+ </td>
810
+ </tr>
811
+ </table>
812
+ </div>
813
+
814
+
815
+ <span id=""></span>
816
+ <div class="method_details ">
817
+ <h3 class="signature " id="name-instance_method">
818
+
819
+ - (<tt>String</tt>) <strong>name</strong> <span class="extras">(readonly)</span>
820
+
821
+
822
+
823
+
824
+
825
+ </h3><div class="docstring">
826
+ <div class="discussion">
827
+ <p>Returns the name of the leaderboard</p>
828
+
829
+
830
+ </div>
831
+ </div>
832
+ <div class="tags">
833
+
834
+ <p class="tag_title">Returns:</p>
835
+ <ul class="return">
836
+
837
+ <li>
838
+
839
+
840
+ <span class='type'>(<tt>String</tt>)</span>
841
+
842
+
843
+
844
+ &mdash;
845
+ <div class='inline'><p>The name of the leaderboard</p>
846
+ </div>
847
+
848
+ </li>
849
+
850
+ </ul>
851
+
852
+ </div><table class="source_code">
853
+ <tr>
854
+ <td>
855
+ <pre class="lines">
856
+
857
+
858
+ 51
859
+ 52
860
+ 53</pre>
861
+ </td>
862
+ <td>
863
+ <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_leaderboard.rb', line 51</span>
864
+
865
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_name identifier id'>name</span>
866
+ <span class='rubyid_@name ivar id'>@name</span>
867
+ <span class='rubyid_end end kw'>end</span>
868
+ </pre>
869
+ </td>
870
+ </tr>
871
+ </table>
872
+ </div>
873
+
874
+
875
+ <span id=""></span>
876
+ <div class="method_details ">
877
+ <h3 class="signature " id="sort_method-instance_method">
878
+
879
+ - (<tt>Fixnum</tt>) <strong>sort_method</strong> <span class="extras">(readonly)</span>
880
+
881
+
882
+
883
+
884
+
885
+ </h3><div class="docstring">
886
+ <div class="discussion">
887
+ <p>Returns the method that is used to sort the entries on the leaderboard</p>
888
+
889
+
890
+ </div>
891
+ </div>
892
+ <div class="tags">
893
+
894
+ <p class="tag_title">Returns:</p>
895
+ <ul class="return">
896
+
897
+ <li>
898
+
899
+
900
+ <span class='type'>(<tt>Fixnum</tt>)</span>
901
+
902
+
903
+
904
+ &mdash;
905
+ <div class='inline'><p>The sort method</p>
906
+ </div>
907
+
908
+ </li>
909
+
910
+ </ul>
911
+
912
+ </div><table class="source_code">
913
+ <tr>
914
+ <td>
915
+ <pre class="lines">
916
+
917
+
918
+ 56
919
+ 57
920
+ 58</pre>
921
+ </td>
922
+ <td>
923
+ <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_leaderboard.rb', line 56</span>
924
+
925
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_sort_method identifier id'>sort_method</span>
926
+ <span class='rubyid_@sort_method ivar id'>@sort_method</span>
927
+ <span class='rubyid_end end kw'>end</span>
928
+ </pre>
929
+ </td>
930
+ </tr>
931
+ </table>
932
+ </div>
933
+
934
+ </div>
935
+
936
+
937
+ <div id="class_method_details" class="method_details_list">
938
+ <h2>Class Method Details</h2>
939
+
940
+
941
+ <div class="method_details first">
942
+ <h3 class="signature first" id="leaderboard-class_method">
943
+
944
+ + (<tt><span class='object_link'><a href="" title="SteamCondenser::Community::GameLeaderboard (class)">GameLeaderboard</a></span></tt>) <strong>leaderboard</strong>(game_name, id)
945
+
946
+
947
+
948
+
949
+
950
+ </h3><div class="docstring">
951
+ <div class="discussion">
952
+ <p>Returns the leaderboard for the given game and leaderboard ID or name</p>
953
+
954
+
955
+ </div>
956
+ </div>
957
+ <div class="tags">
958
+ <p class="tag_title">Parameters:</p>
959
+ <ul class="param">
960
+
961
+ <li>
962
+
963
+ <span class='name'>game_name</span>
964
+
965
+
966
+ <span class='type'>(<tt>String</tt>)</span>
967
+
968
+
969
+
970
+ &mdash;
971
+ <div class='inline'><p>The short name of the game</p>
972
+ </div>
973
+
974
+ </li>
975
+
976
+ <li>
977
+
978
+ <span class='name'>id</span>
979
+
980
+
981
+ <span class='type'>(<tt>Fixnum</tt>, <tt>String</tt>)</span>
982
+
983
+
984
+
985
+ &mdash;
986
+ <div class='inline'><p>The ID or name of the leaderboard to return</p>
987
+ </div>
988
+
989
+ </li>
990
+
991
+ </ul>
992
+
993
+ <p class="tag_title">Returns:</p>
994
+ <ul class="return">
995
+
996
+ <li>
997
+
998
+
999
+ <span class='type'>(<tt><span class='object_link'><a href="" title="SteamCondenser::Community::GameLeaderboard (class)">GameLeaderboard</a></span></tt>)</span>
1000
+
1001
+
1002
+
1003
+ &mdash;
1004
+ <div class='inline'><p>The matching leaderboard if available</p>
1005
+ </div>
1006
+
1007
+ </li>
1008
+
1009
+ </ul>
1010
+
1011
+ </div><table class="source_code">
1012
+ <tr>
1013
+ <td>
1014
+ <pre class="lines">
1015
+
1016
+
1017
+ 63
1018
+ 64
1019
+ 65
1020
+ 66
1021
+ 67
1022
+ 68
1023
+ 69
1024
+ 70
1025
+ 71
1026
+ 72
1027
+ 73</pre>
1028
+ </td>
1029
+ <td>
1030
+ <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_leaderboard.rb', line 63</span>
1031
+
1032
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_leaderboard identifier id'>leaderboard</span><span class='lparen token'>(</span><span class='rubyid_game_name identifier id'>game_name</span><span class='comma token'>,</span> <span class='rubyid_id identifier id'>id</span><span class='rparen token'>)</span>
1033
+ <span class='rubyid_leaderboards identifier id'>leaderboards</span> <span class='assign token'>=</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_leaderboards identifier id'>leaderboards</span> <span class='rubyid_game_name identifier id'>game_name</span>
1034
+
1035
+ <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_Fixnum constant id'>Fixnum</span>
1036
+ <span class='rubyid_leaderboards identifier id'>leaderboards</span><span class='lbrack token'>[</span><span class='rubyid_id identifier id'>id</span><span class='rbrack token'>]</span>
1037
+ <span class='rubyid_else else kw'>else</span>
1038
+ <span class='rubyid_leaderboards identifier id'>leaderboards</span><span class='dot token'>.</span><span class='rubyid_each_value identifier id'>each_value</span> <span class='rubyid_do do kw'>do</span> <span class='bitor op'>|</span><span class='rubyid_board identifier id'>board</span><span class='bitor op'>|</span>
1039
+ <span class='rubyid_return return kw'>return</span> <span class='rubyid_board identifier id'>board</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_board identifier id'>board</span><span class='dot token'>.</span><span class='rubyid_name identifier id'>name</span> <span class='eq op'>==</span> <span class='rubyid_id identifier id'>id</span>
1040
+ <span class='rubyid_end end kw'>end</span>
1041
+ <span class='rubyid_end end kw'>end</span>
1042
+ <span class='rubyid_end end kw'>end</span>
1043
+ </pre>
1044
+ </td>
1045
+ </tr>
1046
+ </table>
1047
+ </div>
1048
+
1049
+ <div class="method_details ">
1050
+ <h3 class="signature " id="leaderboards-class_method">
1051
+
1052
+ + (<tt>Array&lt;<span class='object_link'><a href="" title="SteamCondenser::Community::GameLeaderboard (class)">GameLeaderboard</a></span>&gt;</tt>) <strong>leaderboards</strong>(game_name)
1053
+
1054
+
1055
+
1056
+
1057
+
1058
+ </h3><div class="docstring">
1059
+ <div class="discussion">
1060
+ <p>Returns an array containing all of a game&#39;s leaderboards</p>
1061
+
1062
+
1063
+ </div>
1064
+ </div>
1065
+ <div class="tags">
1066
+ <p class="tag_title">Parameters:</p>
1067
+ <ul class="param">
1068
+
1069
+ <li>
1070
+
1071
+ <span class='name'>game_name</span>
1072
+
1073
+
1074
+ <span class='type'>(<tt>String</tt>)</span>
1075
+
1076
+
1077
+
1078
+ &mdash;
1079
+ <div class='inline'><p>The name of the game</p>
1080
+ </div>
1081
+
1082
+ </li>
1083
+
1084
+ </ul>
1085
+
1086
+ <p class="tag_title">Returns:</p>
1087
+ <ul class="return">
1088
+
1089
+ <li>
1090
+
1091
+
1092
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="" title="SteamCondenser::Community::GameLeaderboard (class)">GameLeaderboard</a></span>&gt;</tt>)</span>
1093
+
1094
+
1095
+
1096
+ &mdash;
1097
+ <div class='inline'><p>The leaderboards for this game</p>
1098
+ </div>
1099
+
1100
+ </li>
1101
+
1102
+ </ul>
1103
+
1104
+ </div><table class="source_code">
1105
+ <tr>
1106
+ <td>
1107
+ <pre class="lines">
1108
+
1109
+
1110
+ 79
1111
+ 80
1112
+ 81
1113
+ 82
1114
+ 83</pre>
1115
+ </td>
1116
+ <td>
1117
+ <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_leaderboard.rb', line 79</span>
1118
+
1119
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_leaderboards identifier id'>leaderboards</span><span class='lparen token'>(</span><span class='rubyid_game_name identifier id'>game_name</span><span class='rparen token'>)</span>
1120
+ <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_load_leaderboards identifier id'>load_leaderboards</span> <span class='rubyid_game_name identifier id'>game_name</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_@@leaderboards ivar id'>@@leaderboards</span><span class='dot token'>.</span><span class='rubyid_key? fid id'>key?</span> <span class='rubyid_game_name identifier id'>game_name</span>
1121
+
1122
+ <span class='rubyid_@@leaderboards ivar id'>@@leaderboards</span><span class='lbrack token'>[</span><span class='rubyid_game_name identifier id'>game_name</span><span class='rbrack token'>]</span>
1123
+ <span class='rubyid_end end kw'>end</span>
1124
+ </pre>
1125
+ </td>
1126
+ </tr>
1127
+ </table>
1128
+ </div>
1129
+
1130
+ <div class="method_details ">
1131
+ <h3 class="signature " id="load_leaderboards-class_method">
1132
+
1133
+ + (<tt>Object</tt>) <strong>load_leaderboards</strong>(game_name) <span class="extras">(private)</span>
1134
+
1135
+
1136
+
1137
+
1138
+
1139
+ </h3><div class="docstring">
1140
+ <div class="discussion">
1141
+ <p>Loads the leaderboards of the specified games into the cache</p>
1142
+
1143
+
1144
+ </div>
1145
+ </div>
1146
+ <div class="tags">
1147
+ <p class="tag_title">Parameters:</p>
1148
+ <ul class="param">
1149
+
1150
+ <li>
1151
+
1152
+ <span class='name'>game_name</span>
1153
+
1154
+
1155
+ <span class='type'>(<tt>String</tt>)</span>
1156
+
1157
+
1158
+
1159
+ &mdash;
1160
+ <div class='inline'><p>The short name of the game</p>
1161
+ </div>
1162
+
1163
+ </li>
1164
+
1165
+ </ul>
1166
+
1167
+ <p class="tag_title">Raises:</p>
1168
+ <ul class="raise">
1169
+
1170
+ <li>
1171
+
1172
+
1173
+ <span class='type'>(<tt>SteamCondenserException</tt>)</span>
1174
+
1175
+
1176
+
1177
+ &mdash;
1178
+ <div class='inline'><p>if an error occurs while fetching the
1179
+ leaderboards</p>
1180
+ </div>
1181
+
1182
+ </li>
1183
+
1184
+ </ul>
1185
+
1186
+ </div><table class="source_code">
1187
+ <tr>
1188
+ <td>
1189
+ <pre class="lines">
1190
+
1191
+
1192
+ 197
1193
+ 198
1194
+ 199
1195
+ 200
1196
+ 201
1197
+ 202
1198
+ 203
1199
+ 204
1200
+ 205
1201
+ 206
1202
+ 207
1203
+ 208
1204
+ 209
1205
+ 210
1206
+ 211
1207
+ 212
1208
+ 213</pre>
1209
+ </td>
1210
+ <td>
1211
+ <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_leaderboard.rb', line 197</span>
1212
+
1213
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_self self kw'>self</span><span class='dot token'>.</span><span class='rubyid_load_leaderboards identifier id'>load_leaderboards</span><span class='lparen token'>(</span><span class='rubyid_game_name identifier id'>game_name</span><span class='rparen token'>)</span>
1214
+ <span class='rubyid_begin begin kw'>begin</span>
1215
+ <span class='rubyid_url identifier id'>url</span> <span class='assign token'>=</span> <span class='dstring node'>&quot;http://steamcommunity.com/stats/#{game_name}/leaderboards/?xml=1&quot;</span>
1216
+ <span class='rubyid_boards_data identifier id'>boards_data</span> <span class='assign token'>=</span> <span class='rubyid_MultiXml constant id'>MultiXml</span><span class='dot token'>.</span><span class='rubyid_parse identifier id'>parse</span><span class='lparen token'>(</span><span class='rubyid_open identifier id'>open</span><span class='lparen token'>(</span><span class='rubyid_url identifier id'>url</span><span class='comma token'>,</span> <span class='lbrace token'>{</span><span class='symbol val'>:proxy</span> <span class='assign token'>=</span><span class='gt op'>&gt;</span> <span class='rubyid_true true kw'>true</span><span class='rbrace token'>}</span><span class='rparen token'>)</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='rubyid_values identifier id'>values</span><span class='dot token'>.</span><span class='rubyid_first identifier id'>first</span>
1217
+ <span class='rubyid_rescue rescue kw'>rescue</span>
1218
+ <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_SteamCondenser constant id'>SteamCondenser</span><span class='colon2 op'>::</span><span class='rubyid_Error constant id'>Error</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='string val'>'XML data could not be parsed.'</span><span class='comma token'>,</span> <span class='rubyid_$! gvar id'>$!</span>
1219
+ <span class='rubyid_end end kw'>end</span>
1220
+
1221
+ <span class='rubyid_error identifier id'>error</span> <span class='assign token'>=</span> <span class='rubyid_boards_data identifier id'>boards_data</span><span class='lbrack token'>[</span><span class='string val'>'error'</span><span class='rbrack token'>]</span>
1222
+ <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_SteamCondenser constant id'>SteamCondenser</span><span class='colon2 op'>::</span><span class='rubyid_Error constant id'>Error</span><span class='comma token'>,</span> <span class='rubyid_error identifier id'>error</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_error identifier id'>error</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
1223
+
1224
+ <span class='rubyid_@@leaderboards ivar id'>@@leaderboards</span><span class='lbrack token'>[</span><span class='rubyid_game_name identifier id'>game_name</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
1225
+ <span class='rubyid_boards_data identifier id'>boards_data</span><span class='lbrack token'>[</span><span class='string val'>'leaderboard'</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_board_data identifier id'>board_data</span><span class='bitor op'>|</span>
1226
+ <span class='rubyid_leaderboard identifier id'>leaderboard</span> <span class='assign token'>=</span> <span class='rubyid_GameLeaderboard constant id'>GameLeaderboard</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_board_data identifier id'>board_data</span>
1227
+ <span class='rubyid_@@leaderboards ivar id'>@@leaderboards</span><span class='lbrack token'>[</span><span class='rubyid_game_name identifier id'>game_name</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='rubyid_leaderboard identifier id'>leaderboard</span><span class='dot token'>.</span><span class='rubyid_id identifier id'>id</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_leaderboard identifier id'>leaderboard</span>
1228
+ <span class='rubyid_end end kw'>end</span>
1229
+ <span class='rubyid_end end kw'>end</span>
1230
+ </pre>
1231
+ </td>
1232
+ </tr>
1233
+ </table>
1234
+ </div>
1235
+
1236
+ </div>
1237
+
1238
+ <div id="instance_method_details" class="method_details_list">
1239
+ <h2>Instance Method Details</h2>
1240
+
1241
+
1242
+ <div class="method_details first">
1243
+ <h3 class="signature first" id="entry_for_steam_id-instance_method">
1244
+
1245
+ - (<tt><span class='object_link'><a href="GameLeaderboardEntry.html" title="SteamCondenser::Community::GameLeaderboardEntry (class)">GameLeaderboardEntry</a></span></tt>) <strong>entry_for_steam_id</strong>(steam_id)
1246
+
1247
+
1248
+
1249
+
1250
+
1251
+ </h3><div class="docstring">
1252
+ <div class="discussion">
1253
+ <p>Returns the entry on this leaderboard for the user with the given SteamID</p>
1254
+
1255
+ <p>raise [SteamCondenserException] if an error occurs while fetching the
1256
+ leaderboard</p>
1257
+
1258
+
1259
+ </div>
1260
+ </div>
1261
+ <div class="tags">
1262
+ <p class="tag_title">Parameters:</p>
1263
+ <ul class="param">
1264
+
1265
+ <li>
1266
+
1267
+ <span class='name'>steam_id</span>
1268
+
1269
+
1270
+ <span class='type'>(<tt>Fixnum</tt>, <tt><span class='object_link'><a href="SteamId.html" title="SteamCondenser::Community::SteamId (class)">SteamId</a></span></tt>)</span>
1271
+
1272
+
1273
+
1274
+ &mdash;
1275
+ <div class='inline'><p>The 64bit SteamID or the <code>SteamId</code>
1276
+ object of the user</p>
1277
+ </div>
1278
+
1279
+ </li>
1280
+
1281
+ </ul>
1282
+
1283
+ <p class="tag_title">Returns:</p>
1284
+ <ul class="return">
1285
+
1286
+ <li>
1287
+
1288
+
1289
+ <span class='type'>(<tt><span class='object_link'><a href="GameLeaderboardEntry.html" title="SteamCondenser::Community::GameLeaderboardEntry (class)">GameLeaderboardEntry</a></span></tt>)</span>
1290
+
1291
+
1292
+
1293
+ &mdash;
1294
+ <div class='inline'><p>The entry of the user if available</p>
1295
+ </div>
1296
+
1297
+ </li>
1298
+
1299
+ </ul>
1300
+ <p class="tag_title">Raises:</p>
1301
+ <ul class="raise">
1302
+
1303
+ <li>
1304
+
1305
+
1306
+ <span class='type'>(<tt><span class='object_link'><a href="../Error.html" title="SteamCondenser::Error (class)">SteamCondenser::Error</a></span></tt>)</span>
1307
+
1308
+
1309
+
1310
+ </li>
1311
+
1312
+ </ul>
1313
+
1314
+ </div><table class="source_code">
1315
+ <tr>
1316
+ <td>
1317
+ <pre class="lines">
1318
+
1319
+
1320
+ 92
1321
+ 93
1322
+ 94
1323
+ 95
1324
+ 96
1325
+ 97
1326
+ 98
1327
+ 99
1328
+ 100
1329
+ 101
1330
+ 102
1331
+ 103
1332
+ 104
1333
+ 105
1334
+ 106
1335
+ 107</pre>
1336
+ </td>
1337
+ <td>
1338
+ <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_leaderboard.rb', line 92</span>
1339
+
1340
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_entry_for_steam_id identifier id'>entry_for_steam_id</span><span class='lparen token'>(</span><span class='rubyid_steam_id identifier id'>steam_id</span><span class='rparen token'>)</span>
1341
+ <span class='rubyid_steam_id identifier id'>steam_id</span> <span class='assign token'>=</span> <span class='rubyid_steam_id identifier id'>steam_id</span><span class='dot token'>.</span><span class='rubyid_steam_id64 identifier id'>steam_id64</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_steam_id identifier id'>steam_id</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span> <span class='rubyid_SteamId constant id'>SteamId</span>
1342
+
1343
+ <span class='rubyid_parse identifier id'>parse</span> <span class='dstring node'>&quot;#@url&amp;steamid=#{steam_id}&quot;</span>
1344
+
1345
+ <span class='rubyid_error identifier id'>error</span> <span class='assign token'>=</span> <span class='rubyid_@xml_data ivar id'>@xml_data</span><span class='lbrack token'>[</span><span class='string val'>'error'</span><span class='rbrack token'>]</span>
1346
+ <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_SteamCondenser constant id'>SteamCondenser</span><span class='colon2 op'>::</span><span class='rubyid_Error constant id'>Error</span><span class='comma token'>,</span> <span class='rubyid_error identifier id'>error</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_error identifier id'>error</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
1347
+
1348
+ <span class='rubyid_@xml_data ivar id'>@xml_data</span><span class='lbrack token'>[</span><span class='string val'>'entries'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>'entry'</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_entry_data identifier id'>entry_data</span><span class='bitor op'>|</span>
1349
+ <span class='rubyid_if if kw'>if</span> <span class='rubyid_entry_data identifier id'>entry_data</span><span class='lbrack token'>[</span><span class='string val'>'steamid'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span> <span class='eq op'>==</span> <span class='rubyid_steam_id identifier id'>steam_id</span>
1350
+ <span class='rubyid_return return kw'>return</span> <span class='rubyid_GameLeaderboardEntry constant id'>GameLeaderboardEntry</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_entry_data identifier id'>entry_data</span><span class='comma token'>,</span> <span class='rubyid_self self kw'>self</span>
1351
+ <span class='rubyid_end end kw'>end</span>
1352
+ <span class='rubyid_end end kw'>end</span>
1353
+
1354
+ <span class='rubyid_nil nil kw'>nil</span>
1355
+ <span class='rubyid_end end kw'>end</span>
1356
+ </pre>
1357
+ </td>
1358
+ </tr>
1359
+ </table>
1360
+ </div>
1361
+
1362
+ <div class="method_details ">
1363
+ <h3 class="signature " id="entry_for_steam_id_friends-instance_method">
1364
+
1365
+ - (<tt>Array&lt;<span class='object_link'><a href="GameLeaderboardEntry.html" title="SteamCondenser::Community::GameLeaderboardEntry (class)">GameLeaderboardEntry</a></span>&gt;</tt>) <strong>entry_for_steam_id_friends</strong>(steam_id)
1366
+
1367
+
1368
+
1369
+
1370
+
1371
+ </h3><div class="docstring">
1372
+ <div class="discussion">
1373
+ <p>Returns an array of entries on this leaderboard for the user with the
1374
+ given SteamID and his/her friends</p>
1375
+
1376
+ <p>raise [SteamCondenserException] if an error occurs while fetching the
1377
+ leaderboard</p>
1378
+
1379
+
1380
+ </div>
1381
+ </div>
1382
+ <div class="tags">
1383
+ <p class="tag_title">Parameters:</p>
1384
+ <ul class="param">
1385
+
1386
+ <li>
1387
+
1388
+ <span class='name'>steam_id</span>
1389
+
1390
+
1391
+ <span class='type'>(<tt>Fixnum</tt>, <tt><span class='object_link'><a href="SteamId.html" title="SteamCondenser::Community::SteamId (class)">SteamId</a></span></tt>)</span>
1392
+
1393
+
1394
+
1395
+ &mdash;
1396
+ <div class='inline'><p>The 64bit SteamID or the <code>SteamId</code>
1397
+ object of the user</p>
1398
+ </div>
1399
+
1400
+ </li>
1401
+
1402
+ </ul>
1403
+
1404
+ <p class="tag_title">Returns:</p>
1405
+ <ul class="return">
1406
+
1407
+ <li>
1408
+
1409
+
1410
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="GameLeaderboardEntry.html" title="SteamCondenser::Community::GameLeaderboardEntry (class)">GameLeaderboardEntry</a></span>&gt;</tt>)</span>
1411
+
1412
+
1413
+
1414
+ &mdash;
1415
+ <div class='inline'><p>The entries of the user and his/her
1416
+ friends</p>
1417
+ </div>
1418
+
1419
+ </li>
1420
+
1421
+ </ul>
1422
+ <p class="tag_title">Raises:</p>
1423
+ <ul class="raise">
1424
+
1425
+ <li>
1426
+
1427
+
1428
+ <span class='type'>(<tt><span class='object_link'><a href="../Error.html" title="SteamCondenser::Error (class)">SteamCondenser::Error</a></span></tt>)</span>
1429
+
1430
+
1431
+
1432
+ </li>
1433
+
1434
+ </ul>
1435
+
1436
+ </div><table class="source_code">
1437
+ <tr>
1438
+ <td>
1439
+ <pre class="lines">
1440
+
1441
+
1442
+ 118
1443
+ 119
1444
+ 120
1445
+ 121
1446
+ 122
1447
+ 123
1448
+ 124
1449
+ 125
1450
+ 126
1451
+ 127</pre>
1452
+ </td>
1453
+ <td>
1454
+ <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_leaderboard.rb', line 118</span>
1455
+
1456
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_entry_for_steam_id_friends identifier id'>entry_for_steam_id_friends</span><span class='lparen token'>(</span><span class='rubyid_steam_id identifier id'>steam_id</span><span class='rparen token'>)</span>
1457
+ <span class='rubyid_steam_id identifier id'>steam_id</span> <span class='assign token'>=</span> <span class='rubyid_steam_id identifier id'>steam_id</span><span class='dot token'>.</span><span class='rubyid_steam_id64 identifier id'>steam_id64</span> <span class='rubyid_if if_mod kw'>if</span> <span class='rubyid_steam_id identifier id'>steam_id</span><span class='dot token'>.</span><span class='rubyid_is_a? fid id'>is_a?</span> <span class='rubyid_SteamId constant id'>SteamId</span>
1458
+
1459
+ <span class='rubyid_parse identifier id'>parse</span> <span class='dstring node'>&quot;#@url&amp;steamid=#{steam_id}&quot;</span>
1460
+
1461
+ <span class='rubyid_error identifier id'>error</span> <span class='assign token'>=</span> <span class='rubyid_@xml_data ivar id'>@xml_data</span><span class='lbrack token'>[</span><span class='string val'>'error'</span><span class='rbrack token'>]</span>
1462
+ <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_SteamCondenser constant id'>SteamCondenser</span><span class='colon2 op'>::</span><span class='rubyid_Error constant id'>Error</span><span class='comma token'>,</span> <span class='rubyid_error identifier id'>error</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_error identifier id'>error</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
1463
+
1464
+ <span class='rubyid_parse_entries identifier id'>parse_entries</span>
1465
+ <span class='rubyid_end end kw'>end</span>
1466
+ </pre>
1467
+ </td>
1468
+ </tr>
1469
+ </table>
1470
+ </div>
1471
+
1472
+ <div class="method_details ">
1473
+ <h3 class="signature " id="entry_range-instance_method">
1474
+
1475
+ - (<tt>Array&lt;<span class='object_link'><a href="GameLeaderboardEntry.html" title="SteamCondenser::Community::GameLeaderboardEntry (class)">GameLeaderboardEntry</a></span>&gt;</tt>) <strong>entry_range</strong>(first, last)
1476
+
1477
+
1478
+
1479
+
1480
+
1481
+ </h3><div class="docstring">
1482
+ <div class="discussion">
1483
+ <p>Returns the entries on this leaderboard for a given rank range</p>
1484
+
1485
+ <p>The range is inclusive and a maximum of 5001 entries can be returned in a
1486
+ single request.</p>
1487
+
1488
+ <p>raise [SteamCondenserException] if an error occurs while fetching the
1489
+ leaderboard</p>
1490
+
1491
+
1492
+ </div>
1493
+ </div>
1494
+ <div class="tags">
1495
+ <p class="tag_title">Parameters:</p>
1496
+ <ul class="param">
1497
+
1498
+ <li>
1499
+
1500
+ <span class='name'>first</span>
1501
+
1502
+
1503
+ <span class='type'>(<tt>Fixnum</tt>)</span>
1504
+
1505
+
1506
+
1507
+ &mdash;
1508
+ <div class='inline'><p>The first entry to return from the leaderboard</p>
1509
+ </div>
1510
+
1511
+ </li>
1512
+
1513
+ <li>
1514
+
1515
+ <span class='name'>last</span>
1516
+
1517
+
1518
+ <span class='type'>(<tt>Fixnum</tt>)</span>
1519
+
1520
+
1521
+
1522
+ &mdash;
1523
+ <div class='inline'><p>The last entry to return from the leaderboard</p>
1524
+ </div>
1525
+
1526
+ </li>
1527
+
1528
+ </ul>
1529
+
1530
+ <p class="tag_title">Returns:</p>
1531
+ <ul class="return">
1532
+
1533
+ <li>
1534
+
1535
+
1536
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="GameLeaderboardEntry.html" title="SteamCondenser::Community::GameLeaderboardEntry (class)">GameLeaderboardEntry</a></span>&gt;</tt>)</span>
1537
+
1538
+
1539
+
1540
+ &mdash;
1541
+ <div class='inline'><p>The entries that match the given
1542
+ rank range</p>
1543
+ </div>
1544
+
1545
+ </li>
1546
+
1547
+ </ul>
1548
+ <p class="tag_title">Raises:</p>
1549
+ <ul class="raise">
1550
+
1551
+ <li>
1552
+
1553
+
1554
+ <span class='type'>(<tt><span class='object_link'><a href="../Error.html" title="SteamCondenser::Error (class)">SteamCondenser::Error</a></span></tt>)</span>
1555
+
1556
+
1557
+
1558
+ </li>
1559
+
1560
+ </ul>
1561
+
1562
+ </div><table class="source_code">
1563
+ <tr>
1564
+ <td>
1565
+ <pre class="lines">
1566
+
1567
+
1568
+ 140
1569
+ 141
1570
+ 142
1571
+ 143
1572
+ 144
1573
+ 145
1574
+ 146
1575
+ 147
1576
+ 148
1577
+ 149
1578
+ 150
1579
+ 151
1580
+ 152
1581
+ 153
1582
+ 154
1583
+ 155
1584
+ 156
1585
+ 157
1586
+ 158
1587
+ 159
1588
+ 160
1589
+ 161
1590
+ 162
1591
+ 163</pre>
1592
+ </td>
1593
+ <td>
1594
+ <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_leaderboard.rb', line 140</span>
1595
+
1596
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_entry_range identifier id'>entry_range</span><span class='lparen token'>(</span><span class='rubyid_first identifier id'>first</span><span class='comma token'>,</span> <span class='rubyid_last identifier id'>last</span><span class='rparen token'>)</span>
1597
+ <span class='rubyid_if if kw'>if</span> <span class='rubyid_last identifier id'>last</span> <span class='lt op'>&lt;</span> <span class='rubyid_first identifier id'>first</span>
1598
+ <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_SteamCondenser constant id'>SteamCondenser</span><span class='colon2 op'>::</span><span class='rubyid_Error constant id'>Error</span><span class='comma token'>,</span>
1599
+ <span class='string val'>'First entry must be prior to last entry for leaderboard entry lookup.'</span>
1600
+ <span class='rubyid_end end kw'>end</span>
1601
+
1602
+ <span class='rubyid_if if kw'>if</span> <span class='lparen token'>(</span><span class='rubyid_last identifier id'>last</span> <span class='minus op'>-</span> <span class='rubyid_first identifier id'>first</span><span class='rparen token'>)</span> <span class='gt op'>&gt;</span> <span class='integer val'>5000</span>
1603
+ <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_SteamCondenser constant id'>SteamCondenser</span><span class='colon2 op'>::</span><span class='rubyid_Error constant id'>Error</span><span class='comma token'>,</span>
1604
+ <span class='string val'>'Leaderboard entry lookup is currently limited to a maximum of 5001 entries per request.'</span>
1605
+ <span class='rubyid_end end kw'>end</span>
1606
+
1607
+ <span class='rubyid_parse identifier id'>parse</span> <span class='dstring node'>&quot;#@url&amp;start=#{first}&amp;end=#{last}&quot;</span>
1608
+
1609
+ <span class='rubyid_error identifier id'>error</span> <span class='assign token'>=</span> <span class='rubyid_@xml_data ivar id'>@xml_data</span><span class='lbrack token'>[</span><span class='string val'>'error'</span><span class='rbrack token'>]</span>
1610
+ <span class='rubyid_raise identifier id'>raise</span> <span class='rubyid_SteamCondenser constant id'>SteamCondenser</span><span class='colon2 op'>::</span><span class='rubyid_Error constant id'>Error</span><span class='comma token'>,</span> <span class='rubyid_error identifier id'>error</span> <span class='rubyid_unless unless_mod kw'>unless</span> <span class='rubyid_error identifier id'>error</span><span class='dot token'>.</span><span class='rubyid_nil? fid id'>nil?</span>
1611
+
1612
+ <span class='rubyid_entries identifier id'>entries</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
1613
+ <span class='rubyid_@xml_data ivar id'>@xml_data</span><span class='lbrack token'>[</span><span class='string val'>'entries'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>'entry'</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_entry_data identifier id'>entry_data</span><span class='bitor op'>|</span>
1614
+ <span class='rubyid_rank identifier id'>rank</span> <span class='assign token'>=</span> <span class='rubyid_entry_data identifier id'>entry_data</span><span class='lbrack token'>[</span><span class='string val'>'rank'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span>
1615
+ <span class='rubyid_entries identifier id'>entries</span><span class='lbrack token'>[</span><span class='rubyid_rank identifier id'>rank</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rubyid_GameLeaderboardEntry constant id'>GameLeaderboardEntry</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_entry_data identifier id'>entry_data</span><span class='comma token'>,</span> <span class='rubyid_self self kw'>self</span>
1616
+ <span class='rubyid_end end kw'>end</span>
1617
+
1618
+ <span class='rubyid_parse_entries identifier id'>parse_entries</span>
1619
+ <span class='rubyid_end end kw'>end</span>
1620
+ </pre>
1621
+ </td>
1622
+ </tr>
1623
+ </table>
1624
+ </div>
1625
+
1626
+ <div class="method_details ">
1627
+ <h3 class="signature " id="parse_entries-instance_method">
1628
+
1629
+ - (<tt>Array&lt;<span class='object_link'><a href="GameLeaderboardEntry.html" title="SteamCondenser::Community::GameLeaderboardEntry (class)">GameLeaderboardEntry</a></span>&gt;</tt>) <strong>parse_entries</strong> <span class="extras">(private)</span>
1630
+
1631
+
1632
+
1633
+
1634
+
1635
+ </h3><div class="docstring">
1636
+ <div class="discussion">
1637
+ <p>Parses all entries available in the XML data</p>
1638
+
1639
+
1640
+ </div>
1641
+ </div>
1642
+ <div class="tags">
1643
+
1644
+ <p class="tag_title">Returns:</p>
1645
+ <ul class="return">
1646
+
1647
+ <li>
1648
+
1649
+
1650
+ <span class='type'>(<tt>Array&lt;<span class='object_link'><a href="GameLeaderboardEntry.html" title="SteamCondenser::Community::GameLeaderboardEntry (class)">GameLeaderboardEntry</a></span>&gt;</tt>)</span>
1651
+
1652
+
1653
+
1654
+ &mdash;
1655
+ <div class='inline'><p>All available entries</p>
1656
+ </div>
1657
+
1658
+ </li>
1659
+
1660
+ </ul>
1661
+
1662
+ </div><table class="source_code">
1663
+ <tr>
1664
+ <td>
1665
+ <pre class="lines">
1666
+
1667
+
1668
+ 182
1669
+ 183
1670
+ 184
1671
+ 185
1672
+ 186
1673
+ 187
1674
+ 188
1675
+ 189
1676
+ 190</pre>
1677
+ </td>
1678
+ <td>
1679
+ <pre class="code"><span class="info file"># File 'lib/steam-condenser/community/game_leaderboard.rb', line 182</span>
1680
+
1681
+ <span class='rubyid_def def kw'>def</span> <span class='rubyid_parse_entries identifier id'>parse_entries</span>
1682
+ <span class='rubyid_entries identifier id'>entries</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span>
1683
+ <span class='rubyid_@xml_data ivar id'>@xml_data</span><span class='lbrack token'>[</span><span class='string val'>'entries'</span><span class='rbrack token'>]</span><span class='lbrack token'>[</span><span class='string val'>'entry'</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_entry_data identifier id'>entry_data</span><span class='bitor op'>|</span>
1684
+ <span class='rubyid_entries identifier id'>entries</span><span class='lbrack token'>[</span><span class='rubyid_entry_data identifier id'>entry_data</span><span class='lbrack token'>[</span><span class='string val'>'rank'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='rubyid_to_i identifier id'>to_i</span><span class='rbrack token'>]</span> <span class='assign token'>=</span>
1685
+ <span class='rubyid_GameLeaderboardEntry constant id'>GameLeaderboardEntry</span><span class='dot token'>.</span><span class='rubyid_new identifier id'>new</span> <span class='rubyid_entry_data identifier id'>entry_data</span><span class='comma token'>,</span> <span class='rubyid_self self kw'>self</span>
1686
+ <span class='rubyid_end end kw'>end</span>
1687
+
1688
+ <span class='rubyid_entries identifier id'>entries</span>
1689
+ <span class='rubyid_end end kw'>end</span>
1690
+ </pre>
1691
+ </td>
1692
+ </tr>
1693
+ </table>
1694
+ </div>
1695
+
1696
+ </div>
1697
+
1698
+ </div>
1699
+
1700
+ <div id="footer">
1701
+ Generated on Wed Aug 14 21:47:59 2013 by
1702
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1703
+ 0.8.7 (ruby-1.8.7).
1704
+ </div>
1705
+
1706
+ </body>
1707
+ </html>