Wrap curl_get_cookie and curl_post_cookie in empathy_get/empathy_post

This allows for simpler calls tat don't need to each keep repeating te
empathy_game_path variable over and over.

While here we add usage documentation to each of the empathy utility
functions as well.

diff --git a/test b/test
index 9d172c78881e318a9d5c91ada63daf73c7d89b89..12da35fa8f7ce2b71ffc7f62a68d730a9d9923b0 100755 (executable)
--- a/test
+++ b/test
@@ -441,6 +441,18 @@ TEST_END $empathy_game_id
 
 empathy_game_path=empathy/$empathy_game_id
 
+# Usage: empathy_get <player_name> <endpoint> [curl_options]
+empathy_get()
+{
+    curl_get_cookie $1 $empathy_game_path/$2 "${3:-}"
+}
+
+# Usage: empathy_post <player_name> <endpoint> [data]
+empathy_post()
+{
+    curl_post_cookie $1 $empathy_game_path/$2 "${3:-}"
+}
+
 # Given a player name as $1 (eg. "empathy_player_activate alice") set both
 # $1_cookie and $1_pid (that is $alice_cookie and $alice_pid) to
 # a filename containing a cookie and the PID of a running event-streaming
@@ -453,21 +465,25 @@ empathy_player_activate()
 
     eval ${player_cookie}=".cookie-empathy-$player"
     curl_put /profile "{ \"nickname\": \"$player\" }" "-c ${!player_cookie}"
-    curl_get_cookie $player $empathy_game_path/events >/dev/null 2>&1 &
+    empathy_get $player events >/dev/null 2>&1 &
     eval ${player_pid}=$!
 }
 
+# Pulls a single named event out of the empathy event stream
+#
+# Usage: empathy_get_event <player_name> <event_name>
 empathy_get_event()
 {
-    curl_get_cookie $1 $2 "-m 0.1" 2>&1 \
-        | grep "^event: $3" -A 1 \
+    empathy_get $1 events "-m 0.1" 2>&1 \
+        | grep "^event: $2" -A 1 \
         | grep ^data: \
         | sed -e 's,^data: *,,'
 }
 
+# Usage: empathy_player_name <player_name>
 empathy_player_name()
 {
-    empathy_get_event $1 $empathy_game_path/events player-info | jq -r .name
+    empathy_get_event $1 player-info | jq -r .name
 }
 
 TEST "Set 'alice' in session"
@@ -494,9 +510,10 @@ TEST_END
 
 TEST_SUBSECTION "Category selection"
 
+# Usage: empathy_submit_prompt <player_name> <count> <prompt_string>
 empathy_submit_prompt()
 {
-    curl_post_cookie $1 $empathy_game_path/prompts "{ \"items\": $2, \"prompt\": \"$3\"}"
+    empathy_post $1 prompts "{ \"items\": $2, \"prompt\": \"$3\"}"
 }
 
 TEST "Huge numbers are rejected"
@@ -509,9 +526,10 @@ prompt_id=$(empathy_submit_prompt alice 4 "4 things on a beach" | jq .id)
 test "$prompt_id" = "1"
 TEST_END
 
+# Usage: empathy_vote <player_name> <prompt_id>
 empathy_vote()
 {
-    curl_post_cookie $1 $empathy_game_path/vote/$2
+    empathy_post $1 vote/$2
 }
 
 TEST "Vote on this category"
@@ -519,9 +537,10 @@ empathy_vote alice $prompt_id
 test "$?" = "0"
 TEST_END
 
+# Usage: empathy_start <player_name> <prompt_id>
 empathy_start()
 {
-    curl_post_cookie $1 $empathy_game_path/start/$2
+    empathy_post $1 start/$2
 }
 
 TEST "Start the game with this category"
@@ -529,9 +548,10 @@ empathy_start alice $prompt_id
 test "$?" = "0"
 TEST_END
 
+# Usage: empathy_answer <player_name> <prompt_id> <answers_string>
 empathy_answer()
 {
-    curl_post_cookie $1 $empathy_game_path/answer/$2 "{ \"answers\": [$3]}"
+    empathy_post $1 answer/$2 "{ \"answers\": [$3]}"
 }
 
 TEST_SUBSECTION "Submitting answers"
@@ -552,10 +572,10 @@ result=$(empathy_answer bob $prompt_id '"sand", "sands", "SunLight", "towels"')
 test "$result" = '{"valid":true}'
 TEST_END
 
+# Usage: empathy_ambiguities <player_name>
 empathy_ambiguities()
 {
-    empathy_get_event $1 $empathy_game_path/events game-state \
-        | jq .ambiguities
+    empathy_get_event $1 game-state | jq .ambiguities
 }
 
 TEST "Judging hasn't started with player unsubmitted"
@@ -577,10 +597,10 @@ TEST_END
 
 TEST_SUBSECTION "Judging answers"
 
+# Usage: empathy_ambiguities_list <player_name>
 empathy_ambiguities_list()
 {
-    empathy_get_event $1 $empathy_game_path/events game-state \
-        | jq .ambiguities[]
+    empathy_get_event $1 game-state | jq .ambiguities[]
 }
 
 TEST "Received all unique words"
@@ -589,9 +609,10 @@ result=$(echo $(empathy_ambiguities_list alice))
 test "$result" = '"Grains of Sand" "people" "sand" "sands" "sun" "SunLight" "SunShine" "towels" "wafer" "water"'
 TEST_END
 
+# Usage: empathy_judged <player_name> <prompt_id> <word_groups_string>
 empathy_judged()
 {
-    curl_post_cookie $1 $empathy_game_path/judged/$2 "{ \"word_groups\": $3}"
+    empathy_post $1 judged/$2 "{ \"word_groups\": $3}"
 }
 
 TEST "Submit word groups from alice"
@@ -604,10 +625,10 @@ result=$(empathy_judged bob $prompt_id '[["sands","grains of sand"],["water","wa
 test "$result" = '{"valid":true}'
 TEST_END
 
+# Usage: empathy_scores <player_name>
 empathy_scores()
 {
-    empathy_get_event $1 $empathy_game_path/events game-state \
-        | jq .scores
+    empathy_get_event $1 game-state | jq .scores
 }
 
 TEST "Scoring hasn't started with player unsubmitted"
@@ -627,10 +648,10 @@ result=$(echo $(empathy_scores alice))
 test "$result" != "null"
 TEST_END
 
+# Usage: empathy_scores_names_numbers <player_name>
 empathy_scores_names_numbers()
 {
-    empathy_get_event $1 $empathy_game_path/events game-state \
-        | jq '.scores.scores[]|.player,.score'
+    empathy_get_event $1 game-state | jq '.scores.scores[]|.player,.score'
 }
 
 TEST_SUBSECTION "Scoring"
@@ -641,10 +662,10 @@ result=$(echo $(empathy_scores_names_numbers alice))
 test "$result" = '"charlie" 9 "alice" 8 "bob" 6'
 TEST_END
 
+# Usage: empathy_words_submitted <player_name>
 empathy_words_submitted()
 {
-    empathy_get_event $1 $empathy_game_path/events game-state \
-        | jq '.scores.words[].word'
+    empathy_get_event $1 game-state | jq '.scores.words[].word'
 }
 
 TEST "Verify final list of words submitted"
@@ -670,9 +691,10 @@ result=$(echo $(empathy_scores alice))
 test "$result" = "null"
 TEST_END
 
+# Usage: empathy_answering <player_name> <prompt_id>
 empathy_answering()
 {
-    curl_post_cookie $1 $empathy_game_path/answering/$2
+    empathy_post $1 answering/$2
 }
 
 TEST "Start 4-player game, 3 submissions"
@@ -693,9 +715,10 @@ result=$(echo $(empathy_ambiguities alice))
 test "$result" = "null"
 TEST_END
 
+# Usage: empathy_end_answers <player_name> <prompt_id>
 empathy_end_answers()
 {
-    curl_post_cookie $1 $empathy_game_path/end-answers/$2
+    empathy_post $1 end-answers/$2
 }
 
 TEST "Minority of players vote to end answering"
@@ -730,9 +753,10 @@ result=$(echo $(empathy_scores alice))
 test "$result" = "null"
 TEST_END
 
+# Usage: empathy_end_judging <player_name> <prompt_id>
 empathy_end_judging()
 {
-    curl_post_cookie $1 $empathy_game_path/end-judging/$2
+    empathy_post $1 end-judging/$2
 }
 
 TEST "Minority of players vote to end judging"