Merge pull request #270 from exercism/submission-comments

Allow including a comment during submission using --comment

Author: kytrinyx

CHANGELOG.md

@@ -6,6 +6,7 @@ The exercism CLI follows [semantic versioning](http://semver.org/).
 
 ## Next Release
 * **Your contribution here**
+* [#270](https://github.com/exercism/cli/pull/270) Allow commenting on submission with --comment [@Tonkpils](https://github.com/Tonkpils)
 
 ## v2.2.3 (2015-12-27)
 * [#264](https://github.com/exercism/cli/pull/264) Fix version flag to use --version and --v - [@Tonkpils](https://github.com/Tonkpils)

api/api_test.go

@@ -1,6 +1,7 @@
 package api
 
 import (
+	"encoding/json"
 	"fmt"
 	"io"
 	"net/http"
@@ -148,9 +149,20 @@ func TestGetSubmission(t *testing.T) {
 }
 
 func TestSubmitAssignment(t *testing.T) {
+	submissionComment := "hello world!"
 	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, req *http.Request) {
 		w.WriteHeader(http.StatusCreated)
 
+		var body map[string]string
+		if err := json.NewDecoder(req.Body).Decode(&body); err != nil {
+			t.Fatal(err)
+		}
+
+		comment, ok := body["comment"]
+		if ok && comment != submissionComment {
+			t.Fatal("comment found and was empty")
+		}
+
 		if err := respondWithFixture(w, "submit.json"); err != nil {
 			t.Fatal(err)
 		}
@@ -163,6 +175,11 @@ func TestSubmitAssignment(t *testing.T) {
 	assert.NoError(t, err)
 
 	assert.Equal(t, sub.Language, "ruby")
+
+	// Test sending comment
+	iter.Comment = submissionComment
+	_, err = client.Submit(iter)
+	assert.NoError(t, err)
 }
 
 func TestListTrack(t *testing.T) {

api/iteration.go

@@ -69,13 +69,13 @@ type Iteration struct {
 	TrackID  string            `json:"language"`
 	Problem  string            `json:"problem"`
 	Solution map[string]string `json:"solution"`
+	Comment  string            `json:"comment,omitempty"`
 }
 
 // NewIteration prepares an iteration of a problem in a track for submission to the API.
 // It takes a dir (from the global config) and a list of files which it will read from disk.
 // All paths are assumed to be absolute paths with symlinks resolved.
 func NewIteration(dir string, filenames []string) (*Iteration, error) {
-
 	if len(filenames) == 0 {
 		return nil, errNoFiles
 	}

cmd/submit.go

@@ -84,6 +84,7 @@ func Submit(ctx *cli.Context) {
 		log.Fatalf("Unable to submit - %s", err)
 	}
 	iteration.Key = c.APIKey
+	iteration.Comment = ctx.String("comment")
 
 	client := api.NewClient(c)
 	submission, err := client.Submit(iteration)

exercism/main.go

@@ -117,6 +117,10 @@ func main() {
 					Name:  "test",
 					Usage: "allow submission of test files",
 				},
+				cli.StringFlag{
+					Name:  "comment",
+					Usage: "includes a comment with the submission",
+				},
 			},
 		},
 		{