added user command

Author: CodeF0x

bin/main.js

@@ -10,6 +10,7 @@ const {
   listPastes,
   loginUser,
   logout,
+  getUserInfo,
 } = require('../lib/api-functions.js');
 
 let userToken;
@@ -135,5 +136,13 @@ yargs(hideBin(process.argv))
       console.log(response);
     }
   )
+  .command(
+    'user',
+    'shows info about currently logged in user',
+    () => {},
+    async () => {
+      console.log(await getUserInfo(apiToken, userToken));
+    }
+  )
   .demandCommand(1)
   .parse();

lib/api-functions.js

@@ -4,14 +4,20 @@ const { API_URLS, FORMAT_CHOICES } = require('./constant.js');
 const { readFileSync, rmSync, writeFileSync, existsSync } = require('fs');
 const { homedir } = require('os');
 const { table } = require('table');
-const { getListTable, mapToVisiblityCode, tokenGuard } = require('./util.js');
+const {
+  getListTable,
+  mapToVisiblityCode,
+  tokenGuard,
+  getUserData,
+} = require('./util.js');
 
 module.exports = {
   loginUser,
   listPastes,
   logout,
   deletePaste,
   createPaste,
+  getUserInfo,
 };
 
 async function loginUser(argv, apiToken) {
@@ -145,3 +151,25 @@ async function createPaste(argv, apiToken, userToken) {
 
   return response.status === 200 ? `Success! ${text}` : `Error! ${text}`;
 }
+
+async function getUserInfo(apiToken, userToken) {
+  if (tokenGuard(apiToken)) {
+    return 'Please provide your pastebin.com API token in the ~/.pasty.api file.';
+  }
+
+  if (tokenGuard(userToken)) {
+    return 'Please login first via pasty login <username>';
+  }
+
+  const response = await fetch(API_URLS.apiPost, {
+    body: `api_dev_key=${apiToken}&api_user_key=${userToken}&api_option=userdetails`,
+    headers: {
+      'Content-Type': 'application/x-www-form-urlencoded',
+    },
+    method: 'POST',
+  });
+
+  const text = await response.text();
+
+  return response.status === 200 ? table(getUserData(text)) : `Error! ${text}`;
+}

lib/constant.js

@@ -1,11 +1,17 @@
 module.exports = {
-  TABLE_HEADERS: [
+  LIST_TABLE_HEADERS: [
     'paste id',
     'paste name',
     'paste visibilty',
     'paste expiry',
     'paste syntax highlighting',
   ],
+  USER_TABLE_HEADERS: [
+    'user name',
+    'account visibility',
+    'user email',
+    'account type',
+  ],
   PASTE_LIST_KEYS: {
     key: 'paste_key',
     title: 'paste_title',

lib/util.js

@@ -1,4 +1,8 @@
-const { TABLE_HEADERS, PASTE_LIST_KEYS } = require('./constant.js');
+const {
+  LIST_TABLE_HEADERS,
+  PASTE_LIST_KEYS,
+  USER_TABLE_HEADERS,
+} = require('./constant.js');
 const { JSDOM } = require('jsdom');
 
 module.exports = {
@@ -7,6 +11,9 @@ module.exports = {
   convertToDate,
   tokenGuard,
   getListTable,
+  getUserData,
+  mapAccountPremium,
+  mapAccountVisibility,
 };
 
 function mapToVisibilityString(code) {
@@ -57,7 +64,7 @@ function tokenGuard(token) {
 
 function getListTable(xmlData) {
   const tableData = [];
-  tableData.push(TABLE_HEADERS);
+  tableData.push(LIST_TABLE_HEADERS);
 
   const xmlResponse = new JSDOM(xmlData);
 
@@ -83,3 +90,42 @@ function getListTable(xmlData) {
 
   return tableData;
 }
+
+function getUserData(xml) {
+  const tableData = [];
+  tableData.push(USER_TABLE_HEADERS);
+
+  const xmlResponse = new JSDOM(xml);
+
+  const user = xmlResponse.window.document.querySelector('user');
+  const userName = user.querySelector('user_name').textContent;
+  const privacy = user.querySelector('user_private').textContent;
+  const email = user.querySelector('user_email').textContent;
+  const premium = user.querySelector('user_account_type').textContent;
+
+  tableData.push([
+    userName,
+    mapAccountVisibility(privacy),
+    email,
+    mapAccountPremium(premium),
+  ]);
+
+  return tableData;
+}
+
+function mapAccountPremium(code) {
+  return Number(code) === 0 ? 'free' : 'premium';
+}
+
+function mapAccountVisibility(code) {
+  switch (Number(code)) {
+    case 0:
+      return 'public';
+    case 1:
+      return 'unlisted';
+    case 2:
+      return 'private';
+    default:
+      return 'error, could not get from api';
+  }
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "pasty",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "a cli for pastebin.com",
   "main": "lib/main.js",
   "directories": {

tests/__mocks__/node-fetch.js

@@ -1,17 +1,19 @@
-const { getXml } = require('./../helper/test-helper');
+const { getPasteListXml, getUserXml } = require('./../helper/test-helper');
 
 let fetch;
 
 let statusCode = 200;
 let responseText;
 
-function mockFetch(url) {
+function mockFetch(url, options) {
   return Promise.resolve({
     status: statusCode,
     text: () =>
       responseText
         ? responseText
-        : getXml('paste key', 'paste name', '0', '0', 'text'),
+        : options.body.includes('api_option=list')
+        ? getPasteListXml('paste key', 'paste name', '0', '0', 'text')
+        : getUserXml('test user', '2', '[email protected]', '0'),
   });
 }
 

tests/api-functions.spec.js

@@ -8,8 +8,9 @@ const {
   createPaste,
   logout,
   loginUser,
+  getUserInfo,
 } = require('../lib/api-functions');
-const { TABLE_HEADERS } = require('../lib/constant');
+const { LIST_TABLE_HEADERS, USER_TABLE_HEADERS } = require('../lib/constant');
 const { table } = require('table');
 const { __setStatusCode, __setResponseText } = require('node-fetch');
 const fs = require('fs');
@@ -49,7 +50,7 @@ describe('apiFunctions', () => {
       // is even worse because of newlines, etc.
       expect(actualResponse).toBe(
         table([
-          [...TABLE_HEADERS],
+          [...LIST_TABLE_HEADERS],
           ['paste key', 'paste name', 'public', 'Never', 'text'], // values set in node-fetch.js mock
         ])
       );
@@ -275,3 +276,42 @@ describe('apiFunctions', () => {
     });
   });
 });
+
+describe('getUserInfo', () => {
+  testTokenGuard(
+    true,
+    getUserInfo,
+    [undefined, 'user token'],
+    'Please provide your pastebin.com API token in the ~/.pasty.api file.'
+  );
+
+  testTokenGuard(
+    false,
+    getUserInfo,
+    ['api token', undefined],
+    'Please login first via pasty login <username>'
+  );
+
+  it('should return table with correct data', async () => {
+    __setResponseText(undefined);
+    __setStatusCode(200);
+
+    const actualResponse = await getUserInfo('token', 'another token');
+
+    expect(actualResponse).toBe(
+      table([
+        [...USER_TABLE_HEADERS],
+        ['test user', 'private', '[email protected]', 'free'], // actual values set in node-fetch.mock
+      ])
+    );
+  });
+
+  it('should return error if api returns error', async () => {
+    __setResponseText('Wrong api key');
+    __setStatusCode(304);
+
+    const actualResponse = await getUserInfo('token', 'another token');
+
+    expect(actualResponse).toBe('Error! Wrong api key');
+  });
+});

tests/helper/test-helper.js

@@ -1,4 +1,4 @@
-function getXml(
+function getPasteListXml(
   pasteKey,
   pasteName,
   pasteVisibility,
@@ -21,6 +21,23 @@ function getXml(
         `;
 }
 
+function getUserXml(userName, privacy, email, premium) {
+  return `
+    <user>
+        <user_name>${userName}</user_name>
+        <user_format_short>text</user_format_short>
+        <user_expiration>N</user_expiration>
+        <user_avatar_url>https://pastebin.com/cache/a/1.jpg</user_avatar_url>
+        <user_private>${privacy}</user_private>
+        <user_website>https://myawesomesite.com</user_website>
+        <user_email>${email}</user_email>
+        <user_location>New York</user_location>
+        <user_account_type>${premium}</user_account_type>
+</user>
+  `;
+}
+
 module.exports = {
-  getXml,
+  getPasteListXml,
+  getUserXml,
 };

tests/util.spec.js

@@ -1,12 +1,15 @@
-const { TABLE_HEADERS } = require('../lib/constant');
+const { LIST_TABLE_HEADERS, USER_TABLE_HEADERS } = require('../lib/constant');
 const {
   convertToDate,
   getListTable,
   mapToVisibilityString,
   mapToVisiblityCode,
   tokenGuard,
+  mapAccountPremium,
+  mapAccountVisibility,
+  getUserData,
 } = require('../lib/util');
-const { getXml } = require('./helper/test-helper');
+const { getPasteListXml, getUserXml } = require('./helper/test-helper');
 
 describe('mapToVisibilityString', () => {
   const fixtures = [
@@ -86,7 +89,7 @@ describe('getListTable', () => {
     const pasteExpiryDate = '0';
     const pasteFormat = 'text';
 
-    const xml = getXml(
+    const xml = getPasteListXml(
       pasteKey,
       pasteName,
       pasteVisibility,
@@ -95,7 +98,7 @@ describe('getListTable', () => {
     );
 
     expect(getListTable(xml)).toEqual([
-      [...TABLE_HEADERS],
+      [...LIST_TABLE_HEADERS],
       [pasteKey, pasteName, 'unlisted', 'Never', pasteFormat],
     ]);
   });
@@ -113,14 +116,14 @@ describe('getListTable', () => {
     const pasteExpiryDate2 = '1640992515';
     const pasteFormat2 = 'javascript';
 
-    const xml = `${getXml(
+    const xml = `${getPasteListXml(
       pasteKey,
       pasteName,
       pasteVisibility,
       pasteExpiryDate,
       pasteFormat
     )}
-    ${getXml(
+    ${getPasteListXml(
       pasteKey2,
       pasteName2,
       pasteVisibility2,
@@ -129,9 +132,53 @@ describe('getListTable', () => {
     )}`;
 
     expect(getListTable(xml)).toEqual([
-      [...TABLE_HEADERS],
+      [...LIST_TABLE_HEADERS],
       [pasteKey, pasteName, 'unlisted', 'Never', pasteFormat],
       [pasteKey2, pasteName2, 'public', '01.01.2022 00:15', pasteFormat2],
     ]);
   });
 });
+
+describe('mapAccountPremium', () => {
+  it('should return free for 0', () => {
+    expect(mapAccountPremium(0)).toBe('free');
+  });
+
+  it('should return premium for 1', () => {
+    expect(mapAccountPremium(1)).toBe('premium');
+  });
+});
+
+describe('mapAccountVisibility', () => {
+  it('should return public for 0', () => {
+    expect(mapAccountVisibility(0)).toBe('public');
+  });
+
+  it('should return unlisted for 1', () => {
+    expect(mapAccountVisibility(1)).toBe('unlisted');
+  });
+
+  it('should return private for 2', () => {
+    expect(mapAccountVisibility(2)).toBe('private');
+  });
+
+  it('should return error for something else', () => {
+    expect(mapAccountVisibility(3)).toBe('error, could not get from api');
+  });
+});
+
+describe('getUserData', () => {
+  it('should return table with mapped data', () => {
+    const userName = 'test user';
+    const privacy = '0';
+    const email = '[email protected]';
+    const premium = '1';
+
+    const xml = getUserXml(userName, privacy, email, premium);
+
+    expect(getUserData(xml)).toEqual([
+      [...USER_TABLE_HEADERS],
+      [userName, 'public', email, 'premium'],
+    ]);
+  });
+});