Merge pull request #12 from bugout-dev/journal-search-order

Added query parameters argument to journal search

Author: zomglings

cmd/bugout/spire/entries.go

@@ -203,6 +203,7 @@ func CreateEntriesListCommand() *cobra.Command {
 func CreateEntriesSearchCommand() *cobra.Command {
 	var token, journalID string
 	var limit, offset int
+	var queryParams map[string]string
 	cmd := &cobra.Command{
 		Use:     "search [query]",
 		Short:   "Search across the entries in a Bugout journal",
@@ -215,7 +216,7 @@ func CreateEntriesSearchCommand() *cobra.Command {
 
 			searchQuery := strings.Join(args, " ")
 
-			entries, err := client.Spire.SearchEntries(token, journalID, searchQuery, limit, offset)
+			entries, err := client.Spire.SearchEntries(token, journalID, searchQuery, limit, offset, queryParams)
 			if err != nil {
 				return err
 			}
@@ -229,6 +230,7 @@ func CreateEntriesSearchCommand() *cobra.Command {
 	cmd.Flags().StringVarP(&journalID, "journal", "j", "", "ID of journal")
 	cmd.Flags().IntVarP(&limit, "limit", "N", 10, "Number of entries per page")
 	cmd.Flags().IntVarP(&offset, "offset", "n", 0, "Index of starting entry on current page")
+	cmd.Flags().StringToStringVarP(&queryParams, "params", "p", nil, "Optional query parameters to add to the query")
 
 	return cmd
 }

pkg/spire/client.go

@@ -28,7 +28,7 @@ type SpireCaller interface {
 	DeleteEntry(token, journalID, entryID string) (Entry, error)
 	GetEntry(token, journalID, entryID string) (Entry, error)
 	ListEntries(token, journalID string, limit, offset int) (EntryResultsPage, error)
-	SearchEntries(token, journalID, searchQuery string, limit, offset int) (EntryResultsPage, error)
+	SearchEntries(token, journalID, searchQuery string, limit, offset int, queryParameters map[string]string) (EntryResultsPage, error)
 	TagEntry(token, journalID, entryID string, tags []string) (Entry, error)
 	UntagEntry(token, journalID, entryID string, tags []string) (Entry, error)
 	UpdateEntry(token, journalID, entryID, title, content string) (Entry, error)

pkg/spire/entries.go

@@ -138,7 +138,7 @@ func (client SpireClient) ListEntries(token, journalID string, limit, offset int
 	return entries, decodeErr
 }
 
-func (client SpireClient) SearchEntries(token, journalID, searchQuery string, limit, offset int) (EntryResultsPage, error) {
+func (client SpireClient) SearchEntries(token, journalID, searchQuery string, limit, offset int, queryParameters map[string]string) (EntryResultsPage, error) {
 	entriesRoute := fmt.Sprintf("%s/%s/search", client.Routes.Journals, journalID)
 	request, requestErr := http.NewRequest("GET", entriesRoute, nil)
 	if requestErr != nil {
@@ -148,6 +148,11 @@ func (client SpireClient) SearchEntries(token, journalID, searchQuery string, li
 	request.Header.Add("Authorization", fmt.Sprintf("Bearer %s", token))
 	// Pattern taken from Stack Overflow: https://stackoverflow.com/a/30657518/13659585
 	query := request.URL.Query()
+	// First add query parameters. q, limit, and offset will override the same parameters passed in
+	// the queryParameters object.
+	for k, v := range queryParameters {
+		query.Add(k, v)
+	}
 	query.Add("q", searchQuery)
 	query.Add("limit", strconv.Itoa(limit))
 	query.Add("offset", strconv.Itoa(offset))