Added new webLogOn method to API.

docs/API.md

@@ -29,6 +29,7 @@
   * [.removeAllHandlers(options)](#API+removeAllHandlers)
   * [.getDataFolderPath()](#API+getDataFolderPath) ⇒ <code>string</code>
   * [.getLogger()](#API+getLogger) ⇒ <code>Object</code>
+  * [.webLogOn()](#API+webLogOn)
 
 <a name="new_API_new"></a>
 ### new API(Vapor, pluginName)
@@ -65,13 +66,14 @@ Returns active Steam handler used by Vapor.
 
 <a name="API+getUtils"></a>
 ### apI.getUtils() ⇒ <code>Object</code>
-Returns Utils class.
+Returns instance of Utils class.
 
 **Kind**: instance method of <code>[API](#API)</code>  
 **Returns**: <code>Object</code> - Instantiated Utils class.  
 <a name="API+getSteam"></a>
 ### apI.getSteam() ⇒ <code>Object</code>
 Returns Steam object.
+
 This is useful for all the ESomething enums.
 
 **Kind**: instance method of <code>[API](#API)</code>  
@@ -155,6 +157,20 @@ Returns logger prefixed with plugin's name.
 
 **Kind**: instance method of <code>[API](#API)</code>  
 **Returns**: <code>Object</code> - Logger.  
+<a name="API+webLogOn"></a>
+### apI.webLogOn()
+Calls Vapor's internal webLogOn method.
+
+Listen to `cookies` event to receive new array of cookies.
+
+You should call this function ONLY if you believe cookies have expired, e.g.
+you logged into your account from another IP / browser and you are getting
+HTTP 403 etc.
+
+You do NOT have to call this method on startup as it's automatically called
+by Vapor after successfully logging in.
+
+**Kind**: instance method of <code>[API](#API)</code>  
 <a name="Utils"></a>
 ## Utils
 **Kind**: global class  
@@ -280,7 +296,8 @@ Converts 64 bit SteamID string to account ID.
 ### utils.getTimestamp(unixTimestamp, format) ⇒ <code>string</code>
 Converts unix timestamp into formatted timestamp.
 
-The timestamp format is taken from Vapor's logs configuration.
+The timestamp format is taken from Vapor's logs configuration
+if not provided.
 
 **Kind**: instance method of <code>[Utils](#Utils)</code>  
 **Returns**: <code>string</code> - Formatted timestamp.  
@@ -289,4 +306,3 @@ The timestamp format is taken from Vapor's logs configuration.
 | --- | --- | --- |
 | unixTimestamp | <code>number</code> | Unix timestamp. |
 | format | <code>string</code> | Timestamp format. |
-

docs/EVENTS.md

@@ -0,0 +1,8 @@
+# Vapor Events
+
+Vapor emits events and any plugin can register appropriate callback function.
+
+Event | Callback arguments | Description
+----- | ---- | -----------
+ready | - | Vapor has completely logged into Steam network.
+cookies | cookies | Array of cookies provided by Steam's `ISteamUserAuth/AuthenticateUser/v1` web API method. This event is emitted automatically by Vapor after successful login. This functionality was previously provided by node-steam's `webLogOn` method.

docs/README.md

@@ -9,3 +9,5 @@ Docs in this folder are automatically generated.
   * Description of Utils class methods and properties
 * __BUILT-IN-PLUGINS.md__
   * List of built-in plugins and their descriptions
+* __EVENTS.md__
+  * Description of Vapor's internal events

lib/api.js

@@ -70,7 +70,7 @@ API.prototype.getHandler = function(handler) {
 };
 
 /**
- * Returns Utils class.
+ * Returns instance of Utils class.
  * @return {Object} Instantiated Utils class.
  */
 API.prototype.getUtils = function() {
@@ -79,6 +79,7 @@ API.prototype.getUtils = function() {
 
 /**
  * Returns Steam object.
+ *
  * This is useful for all the ESomething enums.
  * @return {Object} Steam.
  */
@@ -272,3 +273,21 @@ API.prototype.getLogger = function() {
         info: function(message) { log.info(prefix + message); }
     };
 };
+
+/**
+ * Calls Vapor's internal webLogOn method.
+ *
+ * Listen to `cookies` event to receive new array of cookies.
+ *
+ * You should call this function ONLY if you believe cookies have expired, e.g.
+ * you logged into your account from another IP / browser and you are getting
+ * HTTP 403 etc.
+ *
+ * You do NOT have to call this method on startup as it's automatically called
+ * by Vapor after successfully logging in.
+ */
+API.prototype.webLogOn = function() {
+    _vapor.steamUser.requestWebAPIAuthenticateUserNonce(function(nonce) {
+        this.webLogOn(nonce.webapi_authenticate_user_nonce);
+    }.bind(_vapor));
+};

lib/handlers/logOnResponse.js

@@ -40,11 +40,7 @@ module.exports = function(response) {
         self.emit('ready');
 
         // Call web login
-        self.webLogOn(response.webapi_authenticate_user_nonce, function(cookies) {
-            self.log.info("Received new web cookies.");
-            self.cookies = cookies;
-            self.emit('cookies', cookies);
-        });
+        self.webLogOn(response.webapi_authenticate_user_nonce);
 
     // Auth code needed
     } else if(response.eresult === Steam.EResult.AccountLogonDenied ||

lib/index.js

@@ -5,6 +5,7 @@ var fs = require('fs');
 var EventEmitter = require('events').EventEmitter;
 var util = require('util');
 var https = require('https');
+var crypto = require('crypto');
 
 var Steam = require('steam');
 var SteamGroups = require('steam-groups');
@@ -122,9 +123,8 @@ Vapor.prototype.shutdown = function() {
  *
  * Adopted from node-steam v0.6.8 by seishun.
  * @param  {string}   webLoginKey Login key provided by the logOn method.
- * @param  {Function} callback    Callback function which receives the cookie array.
  */
-Vapor.prototype.webLogOn = function(webLoginKey, callback) {
+Vapor.prototype.webLogOn = function(webLoginKey) {
     var self = this;
 
     var sessionKey = SteamCrypto.generateSessionKey();
@@ -147,25 +147,28 @@ Vapor.prototype.webLogOn = function(webLoginKey, callback) {
         if (res.statusCode === 200) {
             res.on('data', function(chunk) {
                 var response = JSON.parse(chunk);
-                var sessionID = Math.floor(Math.random() * 1000000000).toString();
 
-                callback([
-                    'sessionid=' + sessionID,
+                var cookies = [
+                    'sessionid=' + crypto.randomBytes(12).toString('hex'),
                     'steamLogin=' + response.authenticateuser.token,
                     'steamLoginSecure=' + response.authenticateuser.tokensecure
-                ]);
+                ];
+
+                self.log.info("Received new web cookies.");
+                self.cookies = cookies;
+                self.emit('cookies', cookies);
             });
         } else {
             self.steamUser.requestWebAPIAuthenticateUserNonce(function(nonce) {
-                self.webLogOn(nonce.webapi_authenticate_user_nonce, callback);
+                self.webLogOn(nonce.webapi_authenticate_user_nonce);
             });
 
             return;
         }
     });
 
     req.on('error', function() {
-        self.webLogOn(webLoginKey, callback);
+        self.webLogOn(webLoginKey);
     });
 
     req.end(data);

lib/utils.js

@@ -131,7 +131,8 @@ Utils.prototype.steamIDToAccountID = function(steamID) {
 /**
  * Converts unix timestamp into formatted timestamp.
  *
- * The timestamp format is taken from Vapor's logs configuration.
+ * The timestamp format is taken from Vapor's logs configuration
+ * if not provided.
  * @param  {number} unixTimestamp Unix timestamp.
  * @param  {string} format      - Timestamp format.
  * @return {string}               Formatted timestamp.