Misc bug fixes and clean up

Author: sharathkumaranbu

README.md

@@ -6,25 +6,14 @@ topcoder-cli
 
 # Installation
 
-- Install the package via npm-cli:
+- Install the package via npm cli
 
 ``` node
 npm i -g @topcoder/topcoder-cli
 ```
 
 # Usage
 
-First, install the package, and then run `tc-submission-cli` command on the root directory of your project with `.topcoderrc` file.
-It'll then automatically zip all files under the root directory recursively(except the .topcoderrc file itself) and finally upload the zip file to the TC challenge as a submission.
+* To understand the commands supported by Topcoder CLI, after installing the package run `topcoder --help` which would list out all supported commands. 
 
-An example `.topcoderrc` file should conform to at least the following structure.
-
-``` jsonr
-{
-  "challengeIds": [
-    "30095545" // at least one item here
-  ],
-  "username": "TonyJ",
-  "password": "******"
-}
-```
+* If you need to understand the options available with each command, run `topcoder [ command ] --help`. E.g. Executing the command `topcoder submit --help` will display the help content related to making topcoder submission using CLI

bin/tc-submission-cli.js

@@ -0,0 +1,81 @@
+#!/usr/bin/env node
+
+const program = require('commander')
+const submissionHandler = require('../src/commands/submit')
+const payHandler = require('../src/commands/pay')
+const configHandler = require('../src/commands/config')
+const logger = require('../src/common/logger')
+
+// Overall help text which will be displayed after usage information
+program.on('--help', () => {
+  console.log(`\nTopcoder CLI to interact with Topcoder systems\n`)
+})
+
+program
+  .command('submit')
+  .description('Submit the contents of current working directory to Topcoder challenge(s)')
+  .option('-u, --username <uname>', 'Topcoder username')
+  .option('-p, --password <password>', 'Topcoder password')
+  .option('-m, --memberId <memberid>', 'Admin submitting on behalf of other member will use the member id')
+  .option('-c, --challengeIds <ids>', 'Comma separated challenge IDs to which submission need to be done')
+  .option('--dev', 'Points to Topcoder development environment')
+  .on('--help', () => {
+    console.log(`\nEither use CLI parameters or Create a file .topcoderrc in JSON format with below details
+    {
+      "challengeIds": [
+        "30095545" // at least one item here
+      ],
+      "username": "<Topcoder username>",
+      "password": "<Topcoder password>"
+    }
+    and execute command \`topcoder submit\` to submit the contents of current working directory except .topcoderrc file to the challenge`)
+  }).action((args) => {
+    try {
+      if (args.dev) {
+        process.env.NODE_ENV = 'dev'
+      }
+      submissionHandler(program.args[0])
+    } catch (error) {
+      logger.error(error)
+      logger.error(error.message)
+    }
+  })
+
+program
+  .command('config')
+  .description('Setup global configuration for the Topcoder CLI')
+  .option('-l --list', 'Print the keys in the config file')
+  .option('-a --add <key> <value>', 'Add / Replace a key in the config file.')
+  .option('--unset <key>', 'Removes a key from the config file')
+  .action((...args) => {
+    try {
+      configHandler.handleSubCommand(args)
+    } catch (error) {
+      logger.error(error.message)
+    }
+  })
+
+program
+  .command('pay')
+  .description('Let copilot/managers process private task payments')
+  .option('-o --copilot <payment>', 'copilot payment.')
+  .option('--dev', 'Points to Topcoder development environment')
+  .action((...args) => {
+    if (args.dev) {
+      process.env.NODE_ENV = 'dev'
+    }
+    payHandler.handleCommand(args)
+  })
+
+// error on unknown commands
+program.on('command:*', function () {
+  console.error('Invalid command: %s\nEnter topcoder --help for the list of available commands.', program.args.join(' '))
+  process.exit(1)
+})
+
+program.parse(process.argv)
+
+// If the CLI is invoked without any command, display help
+if (process.argv.length < 3) {
+  program.help()
+}

bin/topcoder-cli.js

@@ -1,5 +1,5 @@
 /*
- * Configuration here.
+ * Development environment configuration for Topcoder CLI
  */
 
 module.exports = {
@@ -9,6 +9,6 @@ module.exports = {
   AUTH0_URL: process.env.AUTH0_URL || 'https://topcoder-dev.auth0.com/oauth/token',
   TC_AUTHN_URL: process.env.TC_AUTHN_URL || 'https://topcoder-dev.auth0.com/oauth/ro',
   TC_AUTHZ_URL: process.env.TC_AUTHZ_URL || 'https://api.topcoder-dev.com/v3/authorizations',
-  TC_CLIENT_ID: process.env.TC_CLIENT_ID || 'JFDo7HMkf0q2CkVFHojy3zHWafziprhT', // for dev 'JFDo7HMkf0q2CkVFHojy3zHWafziprhT',
+  TC_CLIENT_ID: process.env.TC_CLIENT_ID || 'JFDo7HMkf0q2CkVFHojy3zHWafziprhT',
   TC_CLIENT_V2CONNECTION: process.env.CLIENT_V2CONNECTION || 'TC-User-Database'
 }

config/default.js renamed to config/dev.js

@@ -0,0 +1,14 @@
+/*
+ * Production or default configuration for the Topcoder CLI
+ */
+
+module.exports = {
+  LOG_LEVEL: process.env.LOG_LEVEL || 'info',
+  TC_MEMBERS_API: process.env.TC_MEMBERS_API || 'https://api.topcoder.com/v3/members',
+  SUBMISSION_API_URL: process.env.TEST_SUBMISSION_API_URL || 'https://api.topcoder.com/v5/submissions',
+  AUTH0_URL: process.env.AUTH0_URL || 'https://topcoder.auth0.com/oauth/token',
+  TC_AUTHN_URL: process.env.TC_AUTHN_URL || 'https://topcoder.auth0.com/oauth/ro',
+  TC_AUTHZ_URL: process.env.TC_AUTHZ_URL || 'https://api.topcoder.com/v3/authorizations',
+  TC_CLIENT_ID: process.env.TC_CLIENT_ID || '6ZwZEUo2ZK4c50aLPpgupeg5v2Ffxp9P',
+  TC_CLIENT_V2CONNECTION: process.env.CLIENT_V2CONNECTION || 'TC-User-Database'
+}

config/prod.js

@@ -1,6 +1,7 @@
 /*
- * Constants here.
+ * Application constants will be stored here
  */
+
 module.exports = {
   rc: {
     name: '.topcoderrc'
@@ -22,5 +23,12 @@ module.exports = {
   scope: 'openid profile offline_access',
   responseType: 'token',
   grantType: 'password',
-  device: 'Browser'
+  device: 'Browser',
+  errorMessages: {
+    connectionError: 'Error while connecting to topcoder. Please check your connection and try again.',
+    invalidCredentials: 'Invalid Authentication credentials. Please check your credentials and try again.',
+    noGlobalConfig: 'Topcoder config file not found',
+    invalidOptions: 'Only one option is required and allowed for this command. Execute topcoder config --help for more details',
+    invalidArgs: 'Invalid number of values passed.'
+  }
 }

constants.js

@@ -30,12 +30,20 @@ The following parameters can be set in config files or in env variables:
   After that, run `npm publish` again to republish the package.
 - If you want to remove the package from npm registry anyway, run `npm unpublish --force` under the root directory of the project.
 
-# test
+## Installing globally
 
-## Prepare
-- Install dependencies `npm install`
+To install the tool globally so that you can test it's working, run the below command from project root directory.
+
+```
+npm install -g .
+```
+
+Later on you will be able to run `topcoder` command from any directory
 
 ## Unit test
+
+- Install dependencies `npm install`
+
 To run unit tests alone
 
 ```bash

docs/Development.md

@@ -1,7 +1,7 @@
 {
   "name": "@topcoder/topcoder-cli",
   "version": "1.0.3",
-  "description": "A CLI tool that will be used by Topcoder members to submit their solutions on challenges.",
+  "description": "A CLI tool to interact with Topcoder systems.",
   "main": "index.js",
   "scripts": {
     "lint": "standard",
@@ -13,7 +13,6 @@
     "@topcoder-platform/topcoder-submission-api-wrapper": "^1.1.0",
     "adm-zip": "^0.4.11",
     "commander": "^3.0.0",
-    "config": "^3.1.0",
     "fast-glob": "^2.2.6",
     "get-parameter-names": "^0.3.0",
     "ini": "^1.3.5",
@@ -26,13 +25,13 @@
     "winston": "^3.2.1"
   },
   "bin": {
-    "tc-submission-cli": "bin/tc-submission-cli.js"
+    "topcoder": "bin/topcoder-cli.js"
   },
   "repository": {
     "type": "git",
     "url": "git+ssh://[email protected]/topcoder-platform/topcoder-cli.git"
   },
-  "author": "lazybaer",
+  "author": "Topcoder",
   "license": "ISC",
   "bugs": {
     "url": "https://github.com/topcoder-platform/topcoder-cli/issues"

package.json

@@ -1,18 +1,14 @@
-const homedir = require('os').homedir()
-const path = require('path')
-const constants = require('../../constants')
 const configService = require('../services/configService')
 const errors = require('../common/errors')
-
-const configPath = path.join(homedir, constants.config.name)
+const constants = require('../../constants')
 
 function handleSubCommand (args) {
   const options = args[args.length - 1].opts()
   // Count the number of options which are enabled.
   const numOptions = Object.values(options).reduce((t, obj) => obj !== undefined ? t + 1 : t, 0)
 
-  if (numOptions > 1) {
-    throw errors.invalidNoOfOptionsUsedError()
+  if (numOptions > 1 || numOptions === 0) {
+    throw errors.customError(constants.errorMessages.invalidOptions)
   }
 
   const allOptions = Object.keys(options)
@@ -28,34 +24,23 @@ function handleSubCommand (args) {
 
   switch (selectedOption) {
     case 'list':
-      showConfigFile()
+      console.log(configService.showConfigFileService())
       break
     case 'add':
       // key is set to the value of option `add`
       // args[0] should contain the value we want to add
       // console.log(options.add, args[0])
       if (args.length > 2) {
-        throw errors.invalidNoOfArgsPassedError()
+        throw errors.customError(constants.errorMessages.invalidArgs)
       }
-      addToConfigFile(options.add, args[0])
-      break
+      return configService.addToConfigFileService(options.add, args[0])
+    case 'unset':
+      return configService.deleteFromConfigFileService(options.unset)
     default :
-
       break
   }
 }
 
-function showConfigFile () {
-  console.log(configService.showConfigFileService(configPath))
-}
-
-function addToConfigFile (key, value) {
-  return configService.addToConfigFileService(key, value, configPath)
-}
-
 module.exports = {
-  handleSubCommand,
-  showConfigFile,
-  addToConfigFile,
-  configPath
+  handleSubCommand
 }

src/commands/config.js

@@ -1,5 +1,5 @@
 const uploadSubmissionService = require('../services/uploadSubmissionService')
-const errors = require('../common/errors')
+const constants = require('../../constants')
 const logger = require('../common/logger')
 const _ = require('lodash')
 const fs = require('fs')
@@ -35,7 +35,7 @@ const submit = (params) => {
     .catch(err => {
       switch (err.code) {
         case 'ENOTFOUND':
-          logger.error(errors.connectionErrorMsg)
+          logger.error(constants.errorMessages.connectionError)
           break
         default:
           logger.error(err.message)