steam-condenser 1.2.0 → 1.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (371) hide show
  1. data/Gemfile.lock +7 -7
  2. data/README.md +9 -2
  3. data/doc/A2M_GET_SERVERS_BATCH2_Packet.html +426 -0
  4. data/doc/A2S_INFO_Packet.html +260 -0
  5. data/doc/A2S_PLAYER_Packet.html +295 -0
  6. data/doc/A2S_RULES_Packet.html +296 -0
  7. data/doc/A2S_SERVERQUERY_GETCHALLENGE_Packet.html +261 -0
  8. data/doc/AbstractL4DStats.html +978 -0
  9. data/doc/AbstractL4DWeapon.html +734 -0
  10. data/doc/Achievement.html +660 -0
  11. data/doc/AlienSwarmMission.html +1557 -0
  12. data/doc/AlienSwarmStats.html +965 -0
  13. data/doc/AlienSwarmWeapon.html +640 -0
  14. data/doc/AppNews.html +1442 -0
  15. data/doc/C2M_CHECKMD5_Packet.html +341 -0
  16. data/doc/CSSMap.html +806 -0
  17. data/doc/CSSStats.html +825 -0
  18. data/doc/CSSWeapon.html +889 -0
  19. data/doc/Cacheable.html +913 -0
  20. data/doc/Cacheable/ClassMethods.html +696 -0
  21. data/doc/DefenseGridStats.html +2559 -0
  22. data/doc/DoDSClass.html +1264 -0
  23. data/doc/DoDSStats.html +486 -0
  24. data/doc/DoDSWeapon.html +806 -0
  25. data/doc/Dota2BetaInventory.html +339 -0
  26. data/doc/Dota2Inventory.html +339 -0
  27. data/doc/Dota2Item.html +388 -0
  28. data/doc/Dota2Stats.html +366 -0
  29. data/doc/GameAchievement.html +1257 -0
  30. data/doc/GameClass.html +321 -0
  31. data/doc/GameInventory.html +1363 -0
  32. data/doc/GameItem.html +1339 -0
  33. data/doc/GameLeaderboard.html +1609 -0
  34. data/doc/GameLeaderboardEntry.html +629 -0
  35. data/doc/GameSchema.html +568 -0
  36. data/doc/GameServer.html +2405 -0
  37. data/doc/GameStats.html +1461 -0
  38. data/doc/GameWeapon.html +590 -0
  39. data/doc/GoldSrcServer.html +740 -0
  40. data/doc/GoldSrcSocket.html +850 -0
  41. data/doc/ItemSchema.html +780 -0
  42. data/doc/L4D2Map.html +739 -0
  43. data/doc/L4D2Stats.html +930 -0
  44. data/doc/L4D2Weapon.html +486 -0
  45. data/doc/L4DExplosive.html +374 -0
  46. data/doc/L4DMap.html +776 -0
  47. data/doc/L4DStats.html +530 -0
  48. data/doc/L4DWeapon.html +296 -0
  49. data/doc/M2A_SERVER_BATCH_Packet.html +430 -0
  50. data/doc/M2C_ISVALIDMD5_Packet.html +383 -0
  51. data/doc/M2S_REQUESTRESTART_Packet.html +382 -0
  52. data/doc/MasterServer.html +1070 -0
  53. data/doc/MasterServerSocket.html +293 -0
  54. data/doc/Module.html +194 -0
  55. data/doc/PacketFormatError.html +257 -0
  56. data/doc/Portal2Inventory.html +339 -0
  57. data/doc/Portal2Item.html +499 -0
  58. data/doc/Portal2Stats.html +368 -0
  59. data/doc/RCONAuthRequest.html +318 -0
  60. data/doc/RCONAuthResponse.html +305 -0
  61. data/doc/RCONBanError.html +247 -0
  62. data/doc/RCONExecRequest.html +318 -0
  63. data/doc/RCONExecResponse.html +407 -0
  64. data/doc/RCONGoldSrcRequest.html +363 -0
  65. data/doc/RCONGoldSrcResponse.html +367 -0
  66. data/doc/RCONNoAuthError.html +247 -0
  67. data/doc/RCONPacket.html +548 -0
  68. data/doc/RCONPacketFactory.html +300 -0
  69. data/doc/RCONSocket.html +669 -0
  70. data/doc/RCONTerminator.html +304 -0
  71. data/doc/RequestWithChallenge.html +233 -0
  72. data/doc/S2A_INFO2_Packet.html +371 -0
  73. data/doc/S2A_INFO_BasePacket.html +357 -0
  74. data/doc/S2A_INFO_DETAILED_Packet.html +370 -0
  75. data/doc/S2A_LOGSTRING_Packet.html +373 -0
  76. data/doc/S2A_PLAYER_Packet.html +417 -0
  77. data/doc/S2A_RULES_Packet.html +411 -0
  78. data/doc/S2C_CHALLENGE_Packet.html +370 -0
  79. data/doc/S2M_HEARTBEAT2_Packet.html +444 -0
  80. data/doc/Server.html +781 -0
  81. data/doc/SourceServer.html +776 -0
  82. data/doc/SourceSocket.html +366 -0
  83. data/doc/StatsAttribute.html +514 -0
  84. data/doc/SteamCondenser.html +155 -0
  85. data/doc/SteamCondenser/A2M_GET_SERVERS_BATCH2_Packet.html +413 -0
  86. data/doc/SteamCondenser/A2S_INFO_Packet.html +249 -0
  87. data/doc/SteamCondenser/A2S_PLAYER_Packet.html +281 -0
  88. data/doc/SteamCondenser/A2S_RULES_Packet.html +282 -0
  89. data/doc/SteamCondenser/A2S_SERVERQUERY_GETCHALLENGE_Packet.html +250 -0
  90. data/doc/SteamCondenser/AbstractL4DStats.html +954 -0
  91. data/doc/SteamCondenser/AbstractL4DWeapon.html +703 -0
  92. data/doc/SteamCondenser/AlienSwarmMission.html +1494 -0
  93. data/doc/SteamCondenser/AlienSwarmStats.html +938 -0
  94. data/doc/SteamCondenser/AlienSwarmWeapon.html +614 -0
  95. data/doc/SteamCondenser/AppNews.html +1387 -0
  96. data/doc/SteamCondenser/C2M_CHECKMD5_Packet.html +327 -0
  97. data/doc/SteamCondenser/CSSMap.html +774 -0
  98. data/doc/SteamCondenser/CSSStats.html +799 -0
  99. data/doc/SteamCondenser/CSSWeapon.html +855 -0
  100. data/doc/SteamCondenser/Cacheable.html +698 -0
  101. data/doc/SteamCondenser/Cacheable/ClassMethods.html +531 -0
  102. data/doc/SteamCondenser/Community.html +134 -0
  103. data/doc/SteamCondenser/DefenseGridStats.html +2455 -0
  104. data/doc/SteamCondenser/DoDSClass.html +1209 -0
  105. data/doc/SteamCondenser/DoDSStats.html +470 -0
  106. data/doc/SteamCondenser/DoDSWeapon.html +774 -0
  107. data/doc/SteamCondenser/Error.html +156 -0
  108. data/doc/SteamCondenser/Error/PacketFormat.html +246 -0
  109. data/doc/SteamCondenser/Error/RCONBan.html +237 -0
  110. data/doc/SteamCondenser/Error/RCONNoAuth.html +236 -0
  111. data/doc/SteamCondenser/Error/Timeout.html +238 -0
  112. data/doc/SteamCondenser/Error/WebApi.html +339 -0
  113. data/doc/SteamCondenser/GameAchievement.html +1210 -0
  114. data/doc/SteamCondenser/GameClass.html +306 -0
  115. data/doc/SteamCondenser/GameInventory.html +1236 -0
  116. data/doc/SteamCondenser/GameItem.html +1282 -0
  117. data/doc/SteamCondenser/GameLeaderboard.html +1562 -0
  118. data/doc/SteamCondenser/GameLeaderboardEntry.html +604 -0
  119. data/doc/SteamCondenser/GameServer.html +2337 -0
  120. data/doc/SteamCondenser/GameStats.html +1416 -0
  121. data/doc/SteamCondenser/GameWeapon.html +566 -0
  122. data/doc/SteamCondenser/GoldSrcServer.html +716 -0
  123. data/doc/SteamCondenser/GoldSrcSocket.html +831 -0
  124. data/doc/SteamCondenser/L4D2Map.html +713 -0
  125. data/doc/SteamCondenser/L4D2Stats.html +906 -0
  126. data/doc/SteamCondenser/L4D2Weapon.html +466 -0
  127. data/doc/SteamCondenser/L4DExplosive.html +362 -0
  128. data/doc/SteamCondenser/L4DMap.html +746 -0
  129. data/doc/SteamCondenser/L4DStats.html +513 -0
  130. data/doc/SteamCondenser/L4DWeapon.html +284 -0
  131. data/doc/SteamCondenser/M2A_SERVER_BATCH_Packet.html +415 -0
  132. data/doc/SteamCondenser/M2C_ISVALIDMD5_Packet.html +368 -0
  133. data/doc/SteamCondenser/M2S_REQUESTRESTART_Packet.html +367 -0
  134. data/doc/SteamCondenser/MasterServer.html +1046 -0
  135. data/doc/SteamCondenser/MasterServerSocket.html +282 -0
  136. data/doc/SteamCondenser/Portal2Inventory.html +217 -0
  137. data/doc/SteamCondenser/Portal2Item.html +483 -0
  138. data/doc/SteamCondenser/Portal2Stats.html +353 -0
  139. data/doc/SteamCondenser/RCONAuthRequest.html +306 -0
  140. data/doc/SteamCondenser/RCONAuthResponse.html +293 -0
  141. data/doc/SteamCondenser/RCONExecRequest.html +306 -0
  142. data/doc/SteamCondenser/RCONExecResponse.html +392 -0
  143. data/doc/SteamCondenser/RCONGoldSrcRequest.html +349 -0
  144. data/doc/SteamCondenser/RCONGoldSrcResponse.html +354 -0
  145. data/doc/SteamCondenser/RCONPacket.html +530 -0
  146. data/doc/SteamCondenser/RCONPacketFactory.html +293 -0
  147. data/doc/SteamCondenser/RCONSocket.html +649 -0
  148. data/doc/SteamCondenser/RCONTerminator.html +292 -0
  149. data/doc/SteamCondenser/RequestWithChallenge.html +223 -0
  150. data/doc/SteamCondenser/S2A_INFO2_Packet.html +359 -0
  151. data/doc/SteamCondenser/S2A_INFO_BasePacket.html +342 -0
  152. data/doc/SteamCondenser/S2A_INFO_DETAILED_Packet.html +358 -0
  153. data/doc/SteamCondenser/S2A_LOGSTRING_Packet.html +358 -0
  154. data/doc/SteamCondenser/S2A_PLAYER_Packet.html +402 -0
  155. data/doc/SteamCondenser/S2A_RULES_Packet.html +396 -0
  156. data/doc/SteamCondenser/S2C_CHALLENGE_Packet.html +356 -0
  157. data/doc/SteamCondenser/S2M_HEARTBEAT2_Packet.html +430 -0
  158. data/doc/SteamCondenser/Server.html +754 -0
  159. data/doc/SteamCondenser/Servers.html +133 -0
  160. data/doc/SteamCondenser/SourceServer.html +752 -0
  161. data/doc/SteamCondenser/SourceSocket.html +355 -0
  162. data/doc/SteamCondenser/SteamGame.html +1802 -0
  163. data/doc/SteamCondenser/SteamGroup.html +969 -0
  164. data/doc/SteamCondenser/SteamId.html +4242 -0
  165. data/doc/SteamCondenser/SteamPacket.html +456 -0
  166. data/doc/SteamCondenser/SteamPacketFactory.html +521 -0
  167. data/doc/SteamCondenser/SteamPlayer.html +1696 -0
  168. data/doc/SteamCondenser/SteamSocket.html +679 -0
  169. data/doc/SteamCondenser/TF2BetaInventory.html +198 -0
  170. data/doc/SteamCondenser/TF2Class.html +1145 -0
  171. data/doc/SteamCondenser/TF2ClassFactory.html +263 -0
  172. data/doc/SteamCondenser/TF2Engineer.html +534 -0
  173. data/doc/SteamCondenser/TF2GoldenWrench.html +731 -0
  174. data/doc/SteamCondenser/TF2Inventory.html +217 -0
  175. data/doc/SteamCondenser/TF2Item.html +482 -0
  176. data/doc/SteamCondenser/TF2Medic.html +445 -0
  177. data/doc/SteamCondenser/TF2Sniper.html +357 -0
  178. data/doc/SteamCondenser/TF2Spy.html +531 -0
  179. data/doc/SteamCondenser/TF2Stats.html +670 -0
  180. data/doc/SteamCondenser/TimeoutError.html +249 -0
  181. data/doc/SteamCondenser/WebApi.html +999 -0
  182. data/doc/SteamCondenser/XMLData.html +171 -0
  183. data/doc/SteamCondenserError.html +153 -0
  184. data/doc/SteamGame.html +1859 -0
  185. data/doc/SteamGroup.html +1012 -0
  186. data/doc/SteamId.html +4369 -0
  187. data/doc/SteamPacket.html +469 -0
  188. data/doc/SteamPacketFactory.html +545 -0
  189. data/doc/SteamPlayer.html +1766 -0
  190. data/doc/SteamSocket.html +699 -0
  191. data/doc/StringIO.html +947 -0
  192. data/doc/TF2BetaInventory.html +315 -0
  193. data/doc/TF2Class.html +1194 -0
  194. data/doc/TF2ClassFactory.html +273 -0
  195. data/doc/TF2Engineer.html +558 -0
  196. data/doc/TF2GoldenWrench.html +760 -0
  197. data/doc/TF2Inventory.html +339 -0
  198. data/doc/TF2Item.html +499 -0
  199. data/doc/TF2Medic.html +465 -0
  200. data/doc/TF2Sniper.html +373 -0
  201. data/doc/TF2Spy.html +555 -0
  202. data/doc/TF2Stats.html +696 -0
  203. data/doc/WebApi.html +1021 -0
  204. data/doc/WebApiError.html +347 -0
  205. data/doc/XMLData.html +253 -0
  206. data/doc/_index.html +717 -0
  207. data/doc/class_list.html +53 -0
  208. data/doc/css/common.css +1 -0
  209. data/doc/css/full_list.css +57 -0
  210. data/doc/css/style.css +328 -0
  211. data/doc/file.LICENSE.html +100 -0
  212. data/doc/file.README.html +136 -0
  213. data/doc/file_list.html +58 -0
  214. data/doc/frames.html +28 -0
  215. data/doc/index.html +136 -0
  216. data/doc/js/app.js +214 -0
  217. data/doc/js/full_list.js +173 -0
  218. data/doc/js/jquery.js +4 -0
  219. data/doc/method_list.html +3988 -0
  220. data/doc/methods_list.html +3900 -0
  221. data/doc/top-level-namespace.html +114 -0
  222. data/lib/steam-condenser/version.rb +1 -1
  223. data/lib/steam/community/cacheable.rb +105 -44
  224. data/lib/steam/community/dota2/dota2_beta_inventory.rb +27 -0
  225. data/lib/steam/community/dota2/dota2_inventory.rb +27 -0
  226. data/lib/steam/community/dota2/dota2_item.rb +33 -0
  227. data/lib/steam/community/game_inventory.rb +18 -16
  228. data/lib/steam/community/game_leaderboard.rb +2 -2
  229. data/lib/steam/community/game_stats.rb +1 -1
  230. data/lib/steam/community/portal2/portal2_inventory.rb +11 -9
  231. data/lib/steam/community/steam_game.rb +0 -2
  232. data/lib/steam/community/steam_group.rb +2 -7
  233. data/lib/steam/community/steam_id.rb +2 -7
  234. data/lib/steam/community/tf2/tf2_beta_inventory.rb +11 -8
  235. data/lib/steam/community/tf2/tf2_inventory.rb +11 -9
  236. data/lib/steam/community/xml_data.rb +8 -1
  237. data/lib/steam/packets/a2s_player_packet.rb +1 -1
  238. data/lib/steam/packets/a2s_rules_packet.rb +1 -1
  239. data/lib/steam/servers/master_server.rb +3 -2
  240. data/lib/steam/sockets/rcon_socket.rb +1 -2
  241. data/pkg/steam-condenser-1.2.0.gem +0 -0
  242. data/pkg/steam-condenser-1.2.0/Gemfile +3 -0
  243. data/pkg/steam-condenser-1.2.0/Gemfile.lock +30 -0
  244. data/pkg/steam-condenser-1.2.0/LICENSE +25 -0
  245. data/pkg/steam-condenser-1.2.0/README.md +47 -0
  246. data/pkg/steam-condenser-1.2.0/Rakefile +46 -0
  247. data/pkg/steam-condenser-1.2.0/lib/core_ext/stringio.rb +91 -0
  248. data/pkg/steam-condenser-1.2.0/lib/errors/packet_format_error.rb +21 -0
  249. data/pkg/steam-condenser-1.2.0/lib/errors/rcon_ban_error.rb +22 -0
  250. data/pkg/steam-condenser-1.2.0/lib/errors/rcon_no_auth_error.rb +21 -0
  251. data/pkg/steam-condenser-1.2.0/lib/errors/steam_condenser_error.rb +11 -0
  252. data/pkg/steam-condenser-1.2.0/lib/errors/timeout_error.rb +28 -0
  253. data/pkg/steam-condenser-1.2.0/lib/errors/web_api_error.rb +57 -0
  254. data/pkg/steam-condenser-1.2.0/lib/steam-condenser.rb +18 -0
  255. data/pkg/steam-condenser-1.2.0/lib/steam-condenser/community.rb +24 -0
  256. data/pkg/steam-condenser-1.2.0/lib/steam-condenser/servers.rb +24 -0
  257. data/pkg/steam-condenser-1.2.0/lib/steam-condenser/version.rb +11 -0
  258. data/pkg/steam-condenser-1.2.0/lib/steam/community/alien_swarm/alien_swarm_mission.rb +119 -0
  259. data/pkg/steam-condenser-1.2.0/lib/steam/community/alien_swarm/alien_swarm_stats.rb +179 -0
  260. data/pkg/steam-condenser-1.2.0/lib/steam/community/alien_swarm/alien_swarm_weapon.rb +49 -0
  261. data/pkg/steam-condenser-1.2.0/lib/steam/community/app_news.rb +133 -0
  262. data/pkg/steam-condenser-1.2.0/lib/steam/community/cacheable.rb +137 -0
  263. data/pkg/steam-condenser-1.2.0/lib/steam/community/css/css_map.rb +61 -0
  264. data/pkg/steam-condenser-1.2.0/lib/steam/community/css/css_stats.rb +136 -0
  265. data/pkg/steam-condenser-1.2.0/lib/steam/community/css/css_weapon.rb +69 -0
  266. data/pkg/steam-condenser-1.2.0/lib/steam/community/defense_grid/defense_grid_stats.rb +237 -0
  267. data/pkg/steam-condenser-1.2.0/lib/steam/community/dods/dods_class.rb +90 -0
  268. data/pkg/steam-condenser-1.2.0/lib/steam/community/dods/dods_stats.rb +61 -0
  269. data/pkg/steam-condenser-1.2.0/lib/steam/community/dods/dods_weapon.rb +67 -0
  270. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_achievement.rb +109 -0
  271. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_class.rb +22 -0
  272. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_inventory.rb +152 -0
  273. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_item.rb +99 -0
  274. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_leaderboard.rb +201 -0
  275. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_leaderboard_entry.rb +43 -0
  276. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_stats.rb +175 -0
  277. data/pkg/steam-condenser-1.2.0/lib/steam/community/game_weapon.rb +41 -0
  278. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/abstract_l4d_stats.rb +173 -0
  279. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/abstract_l4d_weapon.rb +56 -0
  280. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d2_map.rb +90 -0
  281. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d2_stats.rb +165 -0
  282. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d2_weapon.rb +38 -0
  283. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d_explosive.rb +34 -0
  284. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d_map.rb +65 -0
  285. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d_stats.rb +71 -0
  286. data/pkg/steam-condenser-1.2.0/lib/steam/community/l4d/l4d_weapon.rb +26 -0
  287. data/pkg/steam-condenser-1.2.0/lib/steam/community/portal2/portal2_inventory.rb +25 -0
  288. data/pkg/steam-condenser-1.2.0/lib/steam/community/portal2/portal2_item.rb +47 -0
  289. data/pkg/steam-condenser-1.2.0/lib/steam/community/portal2/portal2_stats.rb +32 -0
  290. data/pkg/steam-condenser-1.2.0/lib/steam/community/steam_game.rb +182 -0
  291. data/pkg/steam-condenser-1.2.0/lib/steam/community/steam_group.rb +135 -0
  292. data/pkg/steam-condenser-1.2.0/lib/steam/community/steam_id.rb +513 -0
  293. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_beta_inventory.rb +22 -0
  294. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_class.rb +92 -0
  295. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_class_factory.rb +40 -0
  296. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_engineer.rb +43 -0
  297. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_golden_wrench.rb +70 -0
  298. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_inventory.rb +25 -0
  299. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_item.rb +47 -0
  300. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_medic.rb +35 -0
  301. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_sniper.rb +28 -0
  302. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_spy.rb +41 -0
  303. data/pkg/steam-condenser-1.2.0/lib/steam/community/tf2/tf2_stats.rb +76 -0
  304. data/pkg/steam-condenser-1.2.0/lib/steam/community/web_api.rb +129 -0
  305. data/pkg/steam-condenser-1.2.0/lib/steam/community/xml_data.rb +17 -0
  306. data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2m_get_servers_batch2_packet.rb +59 -0
  307. data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2s_info_packet.rb +24 -0
  308. data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2s_player_packet.rb +31 -0
  309. data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2s_rules_packet.rb +32 -0
  310. data/pkg/steam-condenser-1.2.0/lib/steam/packets/a2s_serverquery_getchallenge_packet.rb +25 -0
  311. data/pkg/steam-condenser-1.2.0/lib/steam/packets/c2m_checkmd5_packet.rb +30 -0
  312. data/pkg/steam-condenser-1.2.0/lib/steam/packets/m2a_server_batch_packet.rb +52 -0
  313. data/pkg/steam-condenser-1.2.0/lib/steam/packets/m2c_isvalidmd5_packet.rb +34 -0
  314. data/pkg/steam-condenser-1.2.0/lib/steam/packets/m2s_requestrestart_packet.rb +34 -0
  315. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_auth_request.rb +28 -0
  316. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_auth_response.rb +30 -0
  317. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_exec_request.rb +28 -0
  318. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_exec_response.rb +37 -0
  319. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_goldsrc_request.rb +35 -0
  320. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_goldsrc_response.rb +34 -0
  321. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_packet.rb +57 -0
  322. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_packet_factory.rb +43 -0
  323. data/pkg/steam-condenser-1.2.0/lib/steam/packets/rcon/rcon_terminator.rb +29 -0
  324. data/pkg/steam-condenser-1.2.0/lib/steam/packets/request_with_challenge.rb +19 -0
  325. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_info2_packet.rb +62 -0
  326. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_info_base_packet.rb +35 -0
  327. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_info_detailed_packet.rb +61 -0
  328. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_logstring_packet.rb +30 -0
  329. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_player_packet.rb +44 -0
  330. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2a_rules_packet.rb +48 -0
  331. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2c_challenge_packet.rb +35 -0
  332. data/pkg/steam-condenser-1.2.0/lib/steam/packets/s2m_heartbeat2_packet.rb +71 -0
  333. data/pkg/steam-condenser-1.2.0/lib/steam/packets/steam_packet.rb +52 -0
  334. data/pkg/steam-condenser-1.2.0/lib/steam/packets/steam_packet_factory.rb +108 -0
  335. data/pkg/steam-condenser-1.2.0/lib/steam/servers/game_server.rb +392 -0
  336. data/pkg/steam-condenser-1.2.0/lib/steam/servers/goldsrc_server.rb +74 -0
  337. data/pkg/steam-condenser-1.2.0/lib/steam/servers/master_server.rb +182 -0
  338. data/pkg/steam-condenser-1.2.0/lib/steam/servers/server.rb +104 -0
  339. data/pkg/steam-condenser-1.2.0/lib/steam/servers/source_server.rb +98 -0
  340. data/pkg/steam-condenser-1.2.0/lib/steam/sockets/goldsrc_socket.rb +142 -0
  341. data/pkg/steam-condenser-1.2.0/lib/steam/sockets/master_server_socket.rb +30 -0
  342. data/pkg/steam-condenser-1.2.0/lib/steam/sockets/rcon_socket.rb +94 -0
  343. data/pkg/steam-condenser-1.2.0/lib/steam/sockets/source_socket.rb +78 -0
  344. data/pkg/steam-condenser-1.2.0/lib/steam/sockets/steam_socket.rb +86 -0
  345. data/pkg/steam-condenser-1.2.0/lib/steam/steam_player.rb +143 -0
  346. data/pkg/steam-condenser-1.2.0/steam-condenser.gemspec +25 -0
  347. data/pkg/steam-condenser-1.2.0/test/core_ext/test_stringio.rb +59 -0
  348. data/pkg/steam-condenser-1.2.0/test/fixtures/invalid.xml +2 -0
  349. data/pkg/steam-condenser-1.2.0/test/fixtures/sonofthor.xml +882 -0
  350. data/pkg/steam-condenser-1.2.0/test/fixtures/status_goldsrc +3 -0
  351. data/pkg/steam-condenser-1.2.0/test/fixtures/status_source +3 -0
  352. data/pkg/steam-condenser-1.2.0/test/fixtures/valve-members.xml +231 -0
  353. data/pkg/steam-condenser-1.2.0/test/helper.rb +45 -0
  354. data/pkg/steam-condenser-1.2.0/test/steam/communtiy/test_steam_group.rb +83 -0
  355. data/pkg/steam-condenser-1.2.0/test/steam/communtiy/test_steam_id.rb +111 -0
  356. data/pkg/steam-condenser-1.2.0/test/steam/communtiy/test_web_api.rb +98 -0
  357. data/pkg/steam-condenser-1.2.0/test/steam/packets/test_steam_packet.rb +37 -0
  358. data/pkg/steam-condenser-1.2.0/test/steam/servers/test_game_server.rb +296 -0
  359. data/pkg/steam-condenser-1.2.0/test/steam/servers/test_goldsrc_server.rb +59 -0
  360. data/pkg/steam-condenser-1.2.0/test/steam/servers/test_master_server.rb +131 -0
  361. data/pkg/steam-condenser-1.2.0/test/steam/servers/test_server.rb +72 -0
  362. data/pkg/steam-condenser-1.2.0/test/steam/servers/test_source_server.rb +126 -0
  363. data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_goldsrc_socket.rb +127 -0
  364. data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_master_server_socket.rb +42 -0
  365. data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_rcon_socket.rb +109 -0
  366. data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_source_socket.rb +77 -0
  367. data/pkg/steam-condenser-1.2.0/test/steam/sockets/test_steam_socket.rb +97 -0
  368. data/steam-condenser.gemspec +3 -3
  369. data/test/steam/communtiy/test_cacheable.rb +100 -0
  370. data/test/steam/servers/test_master_server.rb +3 -3
  371. metadata +366 -15
@@ -0,0 +1,114 @@
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
+ Top Level Namespace
8
+
9
+ &mdash; Steam Condenser – Ruby API
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ 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</a> &raquo;
35
+
36
+
37
+ <span class="title">Top Level Namespace</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>Top Level Namespace
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+ </dl>
82
+ <div class="clear"></div>
83
+
84
+ <h2>Defined Under Namespace</h2>
85
+ <p class="children">
86
+
87
+
88
+ <strong class="modules">Modules:</strong> <span class='object_link'><a href="AbstractL4DStats.html" title="AbstractL4DStats (module)">AbstractL4DStats</a></span>, <span class='object_link'><a href="AbstractL4DWeapon.html" title="AbstractL4DWeapon (module)">AbstractL4DWeapon</a></span>, <span class='object_link'><a href="Cacheable.html" title="Cacheable (module)">Cacheable</a></span>, <span class='object_link'><a href="GameClass.html" title="GameClass (module)">GameClass</a></span>, <span class='object_link'><a href="GameItem.html" title="GameItem (module)">GameItem</a></span>, <span class='object_link'><a href="GameServer.html" title="GameServer (module)">GameServer</a></span>, <span class='object_link'><a href="GameWeapon.html" title="GameWeapon (module)">GameWeapon</a></span>, <span class='object_link'><a href="RCONPacket.html" title="RCONPacket (module)">RCONPacket</a></span>, <span class='object_link'><a href="RCONPacketFactory.html" title="RCONPacketFactory (module)">RCONPacketFactory</a></span>, <span class='object_link'><a href="RequestWithChallenge.html" title="RequestWithChallenge (module)">RequestWithChallenge</a></span>, <span class='object_link'><a href="S2A_INFO_BasePacket.html" title="S2A_INFO_BasePacket (module)">S2A_INFO_BasePacket</a></span>, <span class='object_link'><a href="Server.html" title="Server (module)">Server</a></span>, <span class='object_link'><a href="SteamCondenser.html" title="SteamCondenser (module)">SteamCondenser</a></span>, <span class='object_link'><a href="SteamPacket.html" title="SteamPacket (module)">SteamPacket</a></span>, <span class='object_link'><a href="SteamPacketFactory.html" title="SteamPacketFactory (module)">SteamPacketFactory</a></span>, <span class='object_link'><a href="SteamSocket.html" title="SteamSocket (module)">SteamSocket</a></span>, <span class='object_link'><a href="TF2ClassFactory.html" title="TF2ClassFactory (module)">TF2ClassFactory</a></span>, <span class='object_link'><a href="WebApi.html" title="WebApi (module)">WebApi</a></span>, <span class='object_link'><a href="XMLData.html" title="XMLData (module)">XMLData</a></span>
89
+
90
+
91
+
92
+ <strong class="classes">Classes:</strong> <span class='object_link'><a href="A2M_GET_SERVERS_BATCH2_Packet.html" title="A2M_GET_SERVERS_BATCH2_Packet (class)">A2M_GET_SERVERS_BATCH2_Packet</a></span>, <span class='object_link'><a href="A2S_INFO_Packet.html" title="A2S_INFO_Packet (class)">A2S_INFO_Packet</a></span>, <span class='object_link'><a href="A2S_PLAYER_Packet.html" title="A2S_PLAYER_Packet (class)">A2S_PLAYER_Packet</a></span>, <span class='object_link'><a href="A2S_RULES_Packet.html" title="A2S_RULES_Packet (class)">A2S_RULES_Packet</a></span>, <span class='object_link'><a href="A2S_SERVERQUERY_GETCHALLENGE_Packet.html" title="A2S_SERVERQUERY_GETCHALLENGE_Packet (class)">A2S_SERVERQUERY_GETCHALLENGE_Packet</a></span>, <span class='object_link'><a href="AlienSwarmMission.html" title="AlienSwarmMission (class)">AlienSwarmMission</a></span>, <span class='object_link'><a href="AlienSwarmStats.html" title="AlienSwarmStats (class)">AlienSwarmStats</a></span>, <span class='object_link'><a href="AlienSwarmWeapon.html" title="AlienSwarmWeapon (class)">AlienSwarmWeapon</a></span>, <span class='object_link'><a href="AppNews.html" title="AppNews (class)">AppNews</a></span>, <span class='object_link'><a href="C2M_CHECKMD5_Packet.html" title="C2M_CHECKMD5_Packet (class)">C2M_CHECKMD5_Packet</a></span>, <span class='object_link'><a href="CSSMap.html" title="CSSMap (class)">CSSMap</a></span>, <span class='object_link'><a href="CSSStats.html" title="CSSStats (class)">CSSStats</a></span>, <span class='object_link'><a href="CSSWeapon.html" title="CSSWeapon (class)">CSSWeapon</a></span>, <span class='object_link'><a href="DefenseGridStats.html" title="DefenseGridStats (class)">DefenseGridStats</a></span>, <span class='object_link'><a href="DoDSClass.html" title="DoDSClass (class)">DoDSClass</a></span>, <span class='object_link'><a href="DoDSStats.html" title="DoDSStats (class)">DoDSStats</a></span>, <span class='object_link'><a href="DoDSWeapon.html" title="DoDSWeapon (class)">DoDSWeapon</a></span>, <span class='object_link'><a href="Dota2BetaInventory.html" title="Dota2BetaInventory (class)">Dota2BetaInventory</a></span>, <span class='object_link'><a href="Dota2Inventory.html" title="Dota2Inventory (class)">Dota2Inventory</a></span>, <span class='object_link'><a href="Dota2Item.html" title="Dota2Item (class)">Dota2Item</a></span>, <span class='object_link'><a href="GameAchievement.html" title="GameAchievement (class)">GameAchievement</a></span>, <span class='object_link'><a href="GameInventory.html" title="GameInventory (class)">GameInventory</a></span>, <span class='object_link'><a href="GameLeaderboard.html" title="GameLeaderboard (class)">GameLeaderboard</a></span>, <span class='object_link'><a href="GameLeaderboardEntry.html" title="GameLeaderboardEntry (class)">GameLeaderboardEntry</a></span>, <span class='object_link'><a href="GameStats.html" title="GameStats (class)">GameStats</a></span>, <span class='object_link'><a href="GoldSrcServer.html" title="GoldSrcServer (class)">GoldSrcServer</a></span>, <span class='object_link'><a href="GoldSrcSocket.html" title="GoldSrcSocket (class)">GoldSrcSocket</a></span>, <span class='object_link'><a href="L4D2Map.html" title="L4D2Map (class)">L4D2Map</a></span>, <span class='object_link'><a href="L4D2Stats.html" title="L4D2Stats (class)">L4D2Stats</a></span>, <span class='object_link'><a href="L4D2Weapon.html" title="L4D2Weapon (class)">L4D2Weapon</a></span>, <span class='object_link'><a href="L4DExplosive.html" title="L4DExplosive (class)">L4DExplosive</a></span>, <span class='object_link'><a href="L4DMap.html" title="L4DMap (class)">L4DMap</a></span>, <span class='object_link'><a href="L4DStats.html" title="L4DStats (class)">L4DStats</a></span>, <span class='object_link'><a href="L4DWeapon.html" title="L4DWeapon (class)">L4DWeapon</a></span>, <span class='object_link'><a href="M2A_SERVER_BATCH_Packet.html" title="M2A_SERVER_BATCH_Packet (class)">M2A_SERVER_BATCH_Packet</a></span>, <span class='object_link'><a href="M2C_ISVALIDMD5_Packet.html" title="M2C_ISVALIDMD5_Packet (class)">M2C_ISVALIDMD5_Packet</a></span>, <span class='object_link'><a href="M2S_REQUESTRESTART_Packet.html" title="M2S_REQUESTRESTART_Packet (class)">M2S_REQUESTRESTART_Packet</a></span>, <span class='object_link'><a href="MasterServer.html" title="MasterServer (class)">MasterServer</a></span>, <span class='object_link'><a href="MasterServerSocket.html" title="MasterServerSocket (class)">MasterServerSocket</a></span>, <span class='object_link'><a href="PacketFormatError.html" title="PacketFormatError (class)">PacketFormatError</a></span>, <span class='object_link'><a href="Portal2Inventory.html" title="Portal2Inventory (class)">Portal2Inventory</a></span>, <span class='object_link'><a href="Portal2Item.html" title="Portal2Item (class)">Portal2Item</a></span>, <span class='object_link'><a href="Portal2Stats.html" title="Portal2Stats (class)">Portal2Stats</a></span>, <span class='object_link'><a href="RCONAuthRequest.html" title="RCONAuthRequest (class)">RCONAuthRequest</a></span>, <span class='object_link'><a href="RCONAuthResponse.html" title="RCONAuthResponse (class)">RCONAuthResponse</a></span>, <span class='object_link'><a href="RCONBanError.html" title="RCONBanError (class)">RCONBanError</a></span>, <span class='object_link'><a href="RCONExecRequest.html" title="RCONExecRequest (class)">RCONExecRequest</a></span>, <span class='object_link'><a href="RCONExecResponse.html" title="RCONExecResponse (class)">RCONExecResponse</a></span>, <span class='object_link'><a href="RCONGoldSrcRequest.html" title="RCONGoldSrcRequest (class)">RCONGoldSrcRequest</a></span>, <span class='object_link'><a href="RCONGoldSrcResponse.html" title="RCONGoldSrcResponse (class)">RCONGoldSrcResponse</a></span>, <span class='object_link'><a href="RCONNoAuthError.html" title="RCONNoAuthError (class)">RCONNoAuthError</a></span>, <span class='object_link'><a href="RCONSocket.html" title="RCONSocket (class)">RCONSocket</a></span>, <span class='object_link'><a href="RCONTerminator.html" title="RCONTerminator (class)">RCONTerminator</a></span>, <span class='object_link'><a href="S2A_INFO2_Packet.html" title="S2A_INFO2_Packet (class)">S2A_INFO2_Packet</a></span>, <span class='object_link'><a href="S2A_INFO_DETAILED_Packet.html" title="S2A_INFO_DETAILED_Packet (class)">S2A_INFO_DETAILED_Packet</a></span>, <span class='object_link'><a href="S2A_LOGSTRING_Packet.html" title="S2A_LOGSTRING_Packet (class)">S2A_LOGSTRING_Packet</a></span>, <span class='object_link'><a href="S2A_PLAYER_Packet.html" title="S2A_PLAYER_Packet (class)">S2A_PLAYER_Packet</a></span>, <span class='object_link'><a href="S2A_RULES_Packet.html" title="S2A_RULES_Packet (class)">S2A_RULES_Packet</a></span>, <span class='object_link'><a href="S2C_CHALLENGE_Packet.html" title="S2C_CHALLENGE_Packet (class)">S2C_CHALLENGE_Packet</a></span>, <span class='object_link'><a href="S2M_HEARTBEAT2_Packet.html" title="S2M_HEARTBEAT2_Packet (class)">S2M_HEARTBEAT2_Packet</a></span>, <span class='object_link'><a href="SourceServer.html" title="SourceServer (class)">SourceServer</a></span>, <span class='object_link'><a href="SourceSocket.html" title="SourceSocket (class)">SourceSocket</a></span>, <span class='object_link'><a href="SteamCondenserError.html" title="SteamCondenserError (class)">SteamCondenserError</a></span>, <span class='object_link'><a href="SteamGame.html" title="SteamGame (class)">SteamGame</a></span>, <span class='object_link'><a href="SteamGroup.html" title="SteamGroup (class)">SteamGroup</a></span>, <span class='object_link'><a href="SteamId.html" title="SteamId (class)">SteamId</a></span>, <span class='object_link'><a href="SteamPlayer.html" title="SteamPlayer (class)">SteamPlayer</a></span>, <span class='object_link'><a href="StringIO.html" title="StringIO (class)">StringIO</a></span>, <span class='object_link'><a href="TF2BetaInventory.html" title="TF2BetaInventory (class)">TF2BetaInventory</a></span>, <span class='object_link'><a href="TF2Class.html" title="TF2Class (class)">TF2Class</a></span>, <span class='object_link'><a href="TF2Engineer.html" title="TF2Engineer (class)">TF2Engineer</a></span>, <span class='object_link'><a href="TF2GoldenWrench.html" title="TF2GoldenWrench (class)">TF2GoldenWrench</a></span>, <span class='object_link'><a href="TF2Inventory.html" title="TF2Inventory (class)">TF2Inventory</a></span>, <span class='object_link'><a href="TF2Item.html" title="TF2Item (class)">TF2Item</a></span>, <span class='object_link'><a href="TF2Medic.html" title="TF2Medic (class)">TF2Medic</a></span>, <span class='object_link'><a href="TF2Sniper.html" title="TF2Sniper (class)">TF2Sniper</a></span>, <span class='object_link'><a href="TF2Spy.html" title="TF2Spy (class)">TF2Spy</a></span>, <span class='object_link'><a href="TF2Stats.html" title="TF2Stats (class)">TF2Stats</a></span>, <span class='object_link'><a href="WebApiError.html" title="WebApiError (class)">WebApiError</a></span>
93
+
94
+
95
+ </p>
96
+
97
+
98
+
99
+
100
+
101
+
102
+
103
+
104
+
105
+ </div>
106
+
107
+ <div id="footer">
108
+ Generated on Sat Jul 21 13:09:28 2012 by
109
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
110
+ 0.8.2.1 (ruby-1.8.7).
111
+ </div>
112
+
113
+ </body>
114
+ </html>
@@ -6,6 +6,6 @@
6
6
  module SteamCondenser
7
7
 
8
8
  # The current version of Steam Condenser
9
- VERSION = '1.2.0'
9
+ VERSION = '1.2.1'
10
10
 
11
11
  end
@@ -1,7 +1,14 @@
1
1
  # This code is free software; you can redistribute it and/or modify it under
2
2
  # the terms of the new BSD License.
3
3
  #
4
- # Copyright (c) 2009-2011, Sebastian Staudt
4
+ # Copyright (c) 2009-2012, Sebastian Staudt
5
+
6
+ # @macro [new] cacheable
7
+ # @overload $0(${1--1}, fetch = true, bypass_cache = false)
8
+ # @param [Boolean] fetch if `true` the object's data is fetched after
9
+ # creation
10
+ # @param [Boolean] bypass_cache if `true` the object's data is fetched again
11
+ # even if it has been cached already
5
12
 
6
13
  # This module implements caching functionality to be used in any object class
7
14
  # having one or more unique object identifier (i.e. ID) and using a `fetch`
@@ -13,10 +20,10 @@ module Cacheable
13
20
  # When this module is included in another class it is initialized to make use
14
21
  # of caching
15
22
  #
16
- # The original `new` method of the including class will be aliased with
17
- # `create`, relaying all instantiations to the `new` method defined in
18
- # {ClassMethods}. Additionally the class variable to save the attributes to
19
- # cache (i.e. cache IDs) and the cache class variable itself are initialized.
23
+ # The original `initialize` method of the including class will be wrapped,
24
+ # relaying all instantiations to the `new` method defined in {ClassMethods}.
25
+ # Additionally the class variable to save the attributes to cache (i.e. cache
26
+ # IDs) and the cache class variable itself are initialized.
20
27
  #
21
28
  # @param [Class] base The class to extend with caching functionality
22
29
  # @see ClassMethods
@@ -26,7 +33,18 @@ module Cacheable
26
33
  base.send :class_variable_set, :@@cache_ids, []
27
34
 
28
35
  class << base
29
- alias_method :create, :new
36
+ def method_added(name)
37
+ if name == :fetch && !(@@in_method_added ||= false)
38
+ @@in_method_added = true
39
+ alias_method :original_fetch, :fetch
40
+
41
+ define_method :fetch do
42
+ original_fetch
43
+ @fetch_time = Time.now
44
+ end
45
+ @@in_method_added = false
46
+ end
47
+ end
30
48
  end
31
49
  end
32
50
 
@@ -41,10 +59,12 @@ module Cacheable
41
59
  #
42
60
  # @note A call to this method is needed if you want a class including this
43
61
  # module to really use the cache.
44
- # @param [Array<Symbol>] ids The symbolic names of the instance variables
45
- # representing a unique identifier for this object class
62
+ # @param [Array<Symbol, Array<Symbol>>] ids The symbolic names of the
63
+ # instance variables representing a unique identifier for this
64
+ # object class. Arrays of symbols are also allowed and are used as
65
+ # compound IDs.
46
66
  def cacheable_with_ids(*ids)
47
- class_variable_set(:@@cache_ids, ids)
67
+ class_variable_set :@@cache_ids, ids
48
68
  end
49
69
 
50
70
  # Returns whether an object with the given ID is already cached
@@ -54,7 +74,7 @@ module Cacheable
54
74
  # cached
55
75
  def cached?(id)
56
76
  id.downcase! if id.is_a? String
57
- class_variable_get(:@@cache).key?(id)
77
+ cache.key?(id)
58
78
  end
59
79
 
60
80
  # Clears the object cache for the class this method is called on
@@ -66,20 +86,42 @@ module Cacheable
66
86
  # returned, otherwise a new object is created.
67
87
  # Overrides the default `new` method of the cacheable object class.
68
88
  #
69
- # @param [Object] id The ID of the object that should be loaded
70
- # @param [Boolean] fetch whether the object's data should be retrieved
71
- # @param [Boolean] bypass_cache whether the object should be loaded again
72
- # even if it is already cached
89
+ # @param [Array<Object>] args The parameters of the object that should be
90
+ # created and if possible loaded from cache
73
91
  # @see #cached?
74
92
  # @see #fetch
75
- def new(id, fetch = true, bypass_cache = false)
76
- if cached?(id) && !bypass_cache
77
- object = class_variable_get(:@@cache)[id]
78
- object.fetch if fetch && !object.fetched?
79
- object
80
- else
81
- super(id, fetch)
93
+ def new(*args)
94
+ arity = self.instance_method(:initialize).arity.abs
95
+ args += [nil] * (arity - args.size) if args.size < arity
96
+ bypass_cache = args.size > arity + 1 ? !!args.pop : false
97
+ fetch = args.size > arity ? !!args.pop : true
98
+
99
+ object = super *args
100
+ cached_object = object.send :cached_instance
101
+ object = cached_object unless cached_object.nil? || bypass_cache
102
+
103
+ if fetch && (bypass_cache || !object.fetched?)
104
+ object.fetch
105
+ object.cache
82
106
  end
107
+
108
+ object
109
+ end
110
+
111
+ private
112
+
113
+ # Returns the current cache for the cacheable class
114
+ #
115
+ # @return [Hash<Object, Cacheable>] The cache for cacheable class
116
+ def cache
117
+ class_variable_get :@@cache
118
+ end
119
+
120
+ # Returns the list of IDs used for caching objects
121
+ #
122
+ # @return [Array<Symbol, Array<Symbol>>] The IDs used for caching objects
123
+ def cache_ids
124
+ class_variable_get :@@cache_ids
83
125
  end
84
126
 
85
127
  end
@@ -89,42 +131,25 @@ module Cacheable
89
131
  # @return [Time] The time the object has been updated the last time
90
132
  attr_reader :fetch_time
91
133
 
92
- # Creates a new object and fetches the associated data of the object if
93
- # desired
94
- #
95
- # @note The real constructor of cacheable classes is {ClassMethods#new}.
96
- # @param [Boolean] fetch_now If `true`, the object's {#fetch} method is
97
- # called to retrieve its data
98
- def initialize(fetch_now = true) #:notnew:
99
- fetch if fetch_now
100
- cache
101
- end
102
-
103
134
  # Saves this object in the cache
104
135
  #
105
136
  # This will use the ID attributes selected for caching
106
137
  def cache
107
- cache = self.class.send :class_variable_get, :@@cache
108
- cache_ids = self.class.send :class_variable_get, :@@cache_ids
109
-
138
+ cache = self.class.send :cache
110
139
  cache_ids.each do |cache_id|
111
- cache_id_value = instance_variable_get('@' + cache_id.to_s)
112
- unless cache_id_value.nil? or cache.key?(cache_id_value)
113
- cache[cache_id_value] = self
114
- end
140
+ cache[cache_id] = self
115
141
  end
116
142
 
117
143
  true
118
144
  end
119
145
 
120
- # Sets the time this object has been fetched the last time
146
+ # Fetches the object from some data source
121
147
  #
122
148
  # @note This method should be overridden in cacheable object classes and
123
- # should implement the logic to retrieve the object's data. The
124
- # overriding method should always call `super` to have the fetch time
125
- # up-to-date.
149
+ # should implement the logic to retrieve the object's data. Updating
150
+ # the time is handled dynamically and does not need to be implemented
151
+ # separately.
126
152
  def fetch
127
- @fetch_time = Time.now
128
153
  end
129
154
 
130
155
  # Returns whether the data for this object has already been fetched
@@ -134,4 +159,40 @@ module Cacheable
134
159
  !@fetch_time.nil?
135
160
  end
136
161
 
162
+ private
163
+
164
+ # If available, returns the cached instance for the object it is called on
165
+ #
166
+ # This may be used to either replace an initial object with a completely
167
+ # cached instance of the same ID or to compare a modified object with the
168
+ # copy that was cached before.
169
+ #
170
+ # @see #cache_ids
171
+ def cached_instance
172
+ ids = cache_ids
173
+ cached = self.class.send(:cache).find { |id, object| ids.include? id}
174
+ cached.nil? ? nil : cached.last
175
+ end
176
+
177
+ # Returns a complete list of all values for the cache IDs of the cachable
178
+ # object
179
+ #
180
+ # @return [Array<Object, Array<Object>>] The values for the cache IDs
181
+ # @see #cache_id_value
182
+ def cache_ids
183
+ values = lambda do |id|
184
+ id.is_a?(Array) ? id.map(&values) : cache_id_value(id)
185
+ end
186
+
187
+ self.class.send(:cache_ids).map &values
188
+ end
189
+
190
+ # Returns the value for the ID
191
+ #
192
+ # @param [Symbol] id The name of an instance variable
193
+ # @return [Object] The value of the given instance variable
194
+ def cache_id_value(id)
195
+ instance_variable_get "@#{id}".to_sym
196
+ end
197
+
137
198
  end
@@ -0,0 +1,27 @@
1
+ # This code is free software; you can redistribute it and/or modify it under
2
+ # the terms of the new BSD License.
3
+ #
4
+ # Copyright (c) 2012, Sebastian Staudt
5
+
6
+ require 'steam/community/dota2/dota2_item'
7
+ require 'steam/community/game_inventory'
8
+
9
+ # Represents the inventory of a player of the DotA 2 beta
10
+ #
11
+ # @author Sebastian Staudt
12
+ class Dota2BetaInventory < GameInventory
13
+
14
+ # Creates a new inventory object for the given SteamID64 in the DotA 2 beta
15
+ # (App ID 205790)
16
+ #
17
+ # @param [Fixnum] steam_id64 The 64bit SteamID of the player to get the
18
+ # inventory for
19
+ # @macro cacheable
20
+ def initialize(steam_id64)
21
+ super 205790, steam_id64
22
+ end
23
+
24
+ # The class representing DotA 2 items
25
+ @@item_class = Dota2Item
26
+
27
+ end
@@ -0,0 +1,27 @@
1
+ # This code is free software; you can redistribute it and/or modify it under
2
+ # the terms of the new BSD License.
3
+ #
4
+ # Copyright (c) 2012, Sebastian Staudt
5
+
6
+ require 'steam/community/dota2/dota2_item'
7
+ require 'steam/community/game_inventory'
8
+
9
+ # Represents the inventory of a DotA 2 player
10
+ #
11
+ # @author Sebastian Staudt
12
+ class Dota2Inventory < GameInventory
13
+
14
+ # Creates a new inventory object for the given SteamID64 in DotA 2
15
+ # (App ID 570)
16
+ #
17
+ # @param [Fixnum] steam_id64 The 64bit SteamID of the player to get the
18
+ # inventory for
19
+ # @macro cacheable
20
+ def initialize(steam_id64)
21
+ super 570, steam_id64
22
+ end
23
+
24
+ # The class representing DotA 2 items
25
+ @@item_class = Dota2Item
26
+
27
+ end
@@ -0,0 +1,33 @@
1
+ # This code is free software; you can redistribute it and/or modify it under
2
+ # the terms of the new BSD License.
3
+ #
4
+ # Copyright (c) 2012, Sebastian Staudt
5
+
6
+ require 'steam/community/game_item'
7
+
8
+ # Represents a DotA 2 item
9
+ #
10
+ # @author Sebastian Staudt
11
+ class Dota2Item
12
+
13
+ include GameItem
14
+
15
+ # Creates a new instance of a DotA 2 item with the given data
16
+ #
17
+ # @param [Dota2Inventory] inventory The inventory this item is contained in
18
+ # @param [Hash<Symbol, Object>] item_data The data specifying this item
19
+ # @raise [WebApiError] on Web API errors
20
+ def initialize(inventory, item_data)
21
+ super
22
+
23
+ @equipped = !item_data[:equipped].nil?
24
+ end
25
+
26
+ # Returns whether this item is equipped by this player at all
27
+ #
28
+ # @return [Boolean] Whether this item is equipped by this player at all
29
+ def equipped?
30
+ @equipped
31
+ end
32
+
33
+ end
@@ -10,7 +10,15 @@ require 'steam/community/web_api'
10
10
  # Provides basic functionality to represent an inventory of player in a game
11
11
  #
12
12
  # @author Sebastian Staudt
13
- module GameInventory
13
+ class GameInventory
14
+
15
+ include Cacheable
16
+ cacheable_with_ids [:app_id, :steam_id64]
17
+
18
+ # Returns the application ID of the game this inventory class belongs to
19
+ #
20
+ # @return [Fixnum] The application ID of the game
21
+ attr_reader :app_id
14
22
 
15
23
  # Returns an array of all items in this players inventory.
16
24
  #
@@ -32,7 +40,7 @@ module GameInventory
32
40
 
33
41
  # Sets the language the schema should be fetched in (default is: `'en'`)
34
42
  #
35
- # @param [String] The ISO 639-1 code of the schema language
43
+ # @param [String] language The ISO 639-1 code of the schema language
36
44
  def self.schema_language=(language)
37
45
  @@schema_language = language
38
46
  end
@@ -41,13 +49,14 @@ module GameInventory
41
49
  # calls update to fetch the data and create the item instances contained in
42
50
  # this players backpack
43
51
  #
44
- # @param [Fixnum] steam_id64 The 64bit SteamID of the player to get the
52
+ # @param [Fixnum] app_id The application ID of the game
53
+ # @param [Fixnum] steam_id64 The 64bit SteamID of the player to get the
45
54
  # inventory for
46
- # @param [Boolean] fetch_now if `true` the data will be fetched immediately
47
- def initialize(steam_id64, fetch_now = true)
48
- @user = SteamId.new steam_id64, false
49
-
50
- super fetch_now
55
+ # @macro cacheable
56
+ def initialize(app_id, steam_id64)
57
+ @app_id = app_id
58
+ @steam_id64 = steam_id64
59
+ @user = SteamId.new steam_id64, false
51
60
  end
52
61
 
53
62
  # Returns the item at the given position in the inventory. The positions
@@ -58,13 +67,6 @@ module GameInventory
58
67
  @items[index - 1]
59
68
  end
60
69
 
61
- # Returns the application ID of the game this inventory class belongs to
62
- #
63
- # @return [Fixnum] The application ID of the game
64
- def app_id
65
- self.class.send :class_variable_get, :@@app_id
66
- end
67
-
68
70
  # Returns the attribute schema
69
71
  #
70
72
  # The schemas are fetched first if not done already
@@ -80,7 +82,7 @@ module GameInventory
80
82
 
81
83
  # Updates the contents of the inventory using Steam Web API
82
84
  def fetch
83
- result = WebApi.json!("IEconItems_#{app_id}", 'GetPlayerItems', 1, { :SteamID => @user.steam_id64 })
85
+ result = WebApi.json!("IEconItems_#@app_id", 'GetPlayerItems', 1, { :SteamID => @user.steam_id64 })
84
86
  item_class = self.class.send :class_variable_get, :@@item_class
85
87
 
86
88
  @items = []