clean; add command comments; refator

Author: Utsav Krishnan

.github/workflows/go.yml

@@ -13,22 +13,18 @@ jobs:
     runs-on: ubuntu-latest
     steps:
 
-    - name: Set up Go 1.13
+    - name: Set up Go 1.16.4
       uses: actions/setup-go@v1
       with:
-        go-version: 1.13
+        go-version: 1.16.4
       id: go
 
     - name: Check out code into the Go module directory
       uses: actions/checkout@v2
 
     - name: Get dependencies
       run: |
-        go get -v -t -d ./...
-        if [ -f Gopkg.toml ]; then
-            curl https://raw.githubusercontent.com/golang/dep/master/install.sh | sh
-            dep ensure
-        fi
+        go mod download
 
     - name: Build
-      run: cd project && go build -v .
+      run: go build -v . && ./cses-cli help

cmd/github.go

@@ -48,7 +48,7 @@ func pushCommit(ref *github.Reference, tree *github.Tree, opts *GithubConfig) (e
 	}
 	parent.Commit.SHA = parent.SHA
 
-	commitMessage := fmt.Sprintf("file updated by %v [%v]" , opts.AuthorName, opts.AuthorEmail)
+	commitMessage := "file updated"
 	date := time.Now()
 	author := &github.CommitAuthor{Date: &date, Name: &opts.AuthorName, Email: &opts.AuthorEmail}
 	commit := &github.Commit{Author: author, Message: &commitMessage, Tree: tree, Parents: []github.Commit{*parent.Commit}}

cmd/helper.go

@@ -136,7 +136,9 @@ func writeCodeFile(filename string, text string, template string) bool {
 	}
 	_, err = f.WriteString("/*\n" + text + "*/\n" + template)
 	if err != nil {
-		f.Close()
+		err := f.Close()
+		check(err)
+
 		return false
 	}
 

cmd/list.go

@@ -1,5 +1,5 @@
 /*
-Copyright © 2021 NAME HERE <EMAIL ADDRESS>
+Copyright © 2021 UTSAV KRISHNAN github.com/ketankr9
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -23,15 +23,13 @@ import (
 // listCmd represents the list command
 var listCmd = &cobra.Command{
 	Use:   "list",
-	Short: "A brief description of your command",
-	Long: `A longer description that spans multiple lines and likely contains examples
-and usage of using your command. For example:
-
-Cobra is a CLI library for Go that empowers applications.
-This application is a tool to generate the needed files
-to quickly create a Cobra application.`,
+	Example: "cses-cli list, cses-cli list -r",
+	Short: "list all problem statements along with status",
+	Long: `Without any flag it lists all the problems from the cache.
+To invalidate/refresh/reload the problem list cache use flag '-r'
+If you are authenticated it will display the submission status along with the list.
+`,
 	Run: func(cmd *cobra.Command, args []string) {
-		//fmt.Println("list called")
 		if cmd.Flag("refresh").Value.String() == "true" {
 			UpdateProblemListCache(viper.GetString("cookie"))
 		}

cmd/login.go

@@ -1,5 +1,5 @@
 /*
-Copyright © 2021 NAME HERE <EMAIL ADDRESS>
+Copyright © 2021 UTSAV KRISHNAN github.com/ketankr9
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
@@ -29,13 +29,12 @@ import (
 // loginCmd represents the login command
 var loginCmd = &cobra.Command{
 	Use:   "login",
-	Short: "A brief description of your command",
-	Long: `A longer description that spans multiple lines and likely contains examples
-and usage of using your command. For example:
-
-Cobra is a CLI library for Go that empowers applications.
-This application is a tool to generate the needed files
-to quickly create a Cobra application.`,
+	Example: "cses-cli login",
+	Short: "authenticate to cses.fi server by username and password",
+	Long: `This command retrieves the csrf token and signs it to the server,
+reads the cookies and saves it in the config file along with the username
+Note: password is not saved in the config file and is only used to sign the csrf token
+`,
 	Run: func(cmd *cobra.Command, args []string) {
 		if !doLogin() {
 			cobra.CompErrorln("failed to login")
@@ -74,7 +73,7 @@ func doLogin() bool {
 
 	s.Start()
 	wg.Wait()
-	ok := login(csrf, cookie, username, PASSWORD)
+	ok := Login(csrf, cookie, username, PASSWORD)
 	s.Stop()
 
 	if !ok {
@@ -89,12 +88,3 @@ func doLogin() bool {
 
 	return true
 }
-
-func login(csrf string, cookie string, username string, pass string) bool {
-
-	params := "csrf_token=" + csrf + "&nick=" + username + "&pass=" + pass
-	if LoginRequest(params, cookie) {
-		return true
-	}
-	return false
-}

cmd/requests.go

@@ -81,7 +81,16 @@ func submitRequest(opts map[string]string, filename string, cookie string) strin
 	return link
 }
 
-func LoginRequest(params string, cookie string) bool {
+func Login(csrf string, cookie string, username string, pass string) bool {
+
+	params := "csrf_token=" + csrf + "&nick=" + username + "&pass=" + pass
+	if loginRequest(params, cookie) == username {
+		return true
+	}
+	return false
+}
+
+func loginRequest(params string, cookie string) string {
 
 	body := strings.NewReader(params)
 	req, err := http.NewRequest("POST", "https://cses.fi/login", body)
@@ -97,14 +106,10 @@ func LoginRequest(params string, cookie string) bool {
 	check(err)
 	defer resp.Body.Close()
 
-	fmt.Println("Body", resp.Body)
-	//doc, err := goquery.NewDocumentFromReader(resp.Body)
+	doc, err := goquery.NewDocumentFromReader(resp.Body)
 	check(err)
 
-	printResp(resp)
-
-	//return doc.Find(".account").Contents().Text()
-	return resp.StatusCode == 200
+	return doc.Find(".account").Contents().Text()
 }
 
 func ListRequest(cookie string) []*Problem {

cmd/root.go

@@ -31,11 +31,8 @@ var (
 // rootCmd represents the base command when called without any subcommands
 var rootCmd = &cobra.Command{
 	Use:   "cses-cli",
-	Short: "A brief description of your application",
-	Long: `A longer description`,
-	// Uncomment the following line if your bare application
-	// has an action associated with it:
-	// Run: func(cmd *cobra.Command, args []string) { },
+	Short: "command line to solve probmens from https://cses.fi/problemset/",
+	Long: `command line to solve probmens from https://cses.fi/problemset/`,
 }
 
 // Execute adds all child commands to the root command and sets flags appropriately.
@@ -58,32 +55,11 @@ func init() {
 	// will be global for your application.
 
 	rootCmd.PersistentFlags().StringVar(&cfgFile, "config", "", "config file (default is "+rootPath+"/config.*)")
-
-	//rootCmd.PersistentFlags().StringP("username","u",  "", "username on cses")
-	//err := viper.BindPFlag("username", rootCmd.PersistentFlags().Lookup("username"))
-	//cobra.CheckErr(err)
-
-	//rootCmd.PersistentFlags().StringP("csrf","t",  "", "csrf token")
-	//err := viper.BindPFlag("csrf", rootCmd.PersistentFlags().Lookup("csrf"))
-	//cobra.CheckErr(err)
-	//
-	//rootCmd.PersistentFlags().StringP("cookie","c",  "", "http cookie")
-	//err = viper.BindPFlag("cookie", rootCmd.PersistentFlags().Lookup("cookie"))
-	//cobra.CheckErr(err)
-
-	//rootCmd.PersistentFlags().StringP("rootPath","p",  rootPath, "path to store problem statements")
-	//err = viper.BindPFlag("rootPath", rootCmd.PersistentFlags().Lookup("rootPath"))
-	//cobra.CheckErr(err)
-
-
-
-	// Cobra also supports local flags, which will only run
-	// when this action is called directly.
-	rootCmd.Flags().BoolP("toggle", "o", false, "Help message for toggle")
 }
 
 // initConfig reads in config file and ENV variables if set.
 func initConfig() {
+	// disabling it for now
 	//viper.AutomaticEnv() // read in environment variables first to be overwritten by config
 
 	if cfgFile != "" {
@@ -96,7 +72,6 @@ func initConfig() {
 		viper.AddConfigPath("/etc/cses/")
 
 		viper.SetConfigName("config") // name of config file (without extension)
-		viper.SetConfigType("yaml") // REQUIRED if the config file does not have the extension in the name
 	}
 
 	// If a config file is found, read it in.

cmd/show.go

@@ -23,13 +23,9 @@ import (
 var showCmd = &cobra.Command{
 	Use:   "show",
 	Args: cobra.ExactArgs(1),
-	Short: "A brief description of your command",
-	Long: `A longer description that spans multiple lines and likely contains examples
-and usage of using your command. For example:
-
-Cobra is a CLI library for Go that empowers applications.
-This application is a tool to generate the needed files
-to quickly create a Cobra application.`,
+	Short: "show a problem statement by number",
+	Example: "cses-cli show 1068",
+	Long: `Print the problem statement identified by the task number to stdout`,
 	Run: func(cmd *cobra.Command, args []string) {
 		ShowProblem(args[0])
 	},

cmd/solve.go

@@ -26,15 +26,14 @@ import (
 var solveCmd = &cobra.Command{
 	Use:   "solve",
 	Args: cobra.ExactArgs(1),
-	Short: "A brief description of your command",
-	Long: `A longer description that spans multiple lines and likely contains examples
-and usage of using your command. For example:
+	Example: "cses-cli solve 1068",
+	Short: "solve any problem identified by the task number",
+	Long: `This command will print the problem statement by default (use '-s' to disable it)
+By default the editor name is read from the config file to overwrite use like '-e subl', where subl is binary for sublime-text editor.
+The language preference is also read form the config file`,
 
-Cobra is a CLI library for Go that empowers applications.
-This application is a tool to generate the needed files
-to quickly create a Cobra application.`,
 	Run: func(cmd *cobra.Command, args []string) {
-		if cmd.Flag("show").Value.String() == "true" {
+		if cmd.Flag("silent").Value.String() == "false" {
 			ShowProblem(args[0])
 		}
 
@@ -45,7 +44,7 @@ to quickly create a Cobra application.`,
 func init() {
 	rootCmd.AddCommand(solveCmd)
 
-	solveCmd.Flags().BoolP("show", "s", true, "print problem statement before solving")
+	solveCmd.Flags().BoolP("silent", "s", false, "do not print problem statement")
 	solveCmd.Flags().StringP("editor", "e", "", "use editor to solve the problem")
 	err := viper.BindPFlag("editor", solveCmd.Flags().Lookup("editor"))
 

cmd/submit.go

@@ -25,13 +25,11 @@ import (
 var submitCmd = &cobra.Command{
 	Use:   "submit",
 	Args: cobra.ExactArgs(1),
-	Short: "A brief description of your command",
-	Long: `A longer description that spans multiple lines and likely contains examples
-and usage of using your command. For example:
+	Example: "cses-cli submit 1068.Weird-Algorithm.cpp",
+	Short: "submit the solution file and fetch the status",
+	Long: `If the solution is ACCEPTED and github is configured, then it will push the solution to github,
+with limitation that the repo has to be public, since it uses github generated token`,
 
-Cobra is a CLI library for Go that empowers applications.
-This application is a tool to generate the needed files
-to quickly create a Cobra application.`,
 	Run: func(cmd *cobra.Command, args []string) {
 		ghConfig := &GithubConfig{}