added List models

Author: matryer

suggestionbox/suggestionbox_model.go

@@ -81,6 +81,44 @@ type ModelOptions struct {
 	Skipgrams int `json:"skipgrams,omitempty"`
 }
 
+// ListModels gets a Model by its ID.
+func (c *Client) ListModels(ctx context.Context, modelID string) ([]Model, error) {
+	u, err := url.Parse(c.addr + "/suggestionbox/models")
+	if err != nil {
+		return nil, err
+	}
+	if !u.IsAbs() {
+		return nil, errors.New("box address must be absolute")
+	}
+	req, err := http.NewRequest(http.MethodGet, u.String(), nil)
+	if err != nil {
+		return nil, err
+	}
+	req = req.WithContext(ctx)
+	req.Header.Set("Accept", "application/json; charset=utf-8")
+	req.Header.Set("Content-Type", "application/json; charset=utf-8")
+	resp, err := c.HTTPClient.Do(req)
+	if err != nil {
+		return nil, err
+	}
+	defer resp.Body.Close()
+	if resp.StatusCode < 200 || resp.StatusCode >= 300 {
+		return nil, errors.New(resp.Status)
+	}
+	var response struct {
+		Success bool
+		Error   string
+		Models  []Model
+	}
+	if err := json.NewDecoder(resp.Body).Decode(&response); err != nil {
+		return nil, errors.Wrap(err, "decoding response")
+	}
+	if !response.Success {
+		return nil, ErrSuggestionbox(response.Error)
+	}
+	return response.Models, nil
+}
+
 // GetModel gets a Model by its ID.
 func (c *Client) GetModel(ctx context.Context, modelID string) (Model, error) {
 	var model Model

suggestionbox/suggestionbox_model_test.go

@@ -72,6 +72,33 @@ func TestGetModel(t *testing.T) {
 	is.Equal(outModel.ID, "model1") // outModel.ID
 }
 
+func TestListModels(t *testing.T) {
+	is := is.New(t)
+	var apiCalls int
+	srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		apiCalls++
+		is.Equal(r.Method, http.MethodGet)
+		is.Equal(r.URL.Path, "/suggestionbox/models")
+		is.Equal(r.Header.Get("Accept"), "application/json; charset=utf-8")
+		model := suggestionbox.Model{
+			ID: "model1",
+		}
+		is.NoErr(json.NewEncoder(w).Encode(struct {
+			Success bool `json:"success"`
+			Models  []suggestionbox.Model
+		}{
+			Success: true,
+			Models:  []suggestionbox.Model{model, model, model},
+		}))
+	}))
+	defer srv.Close()
+	sb := suggestionbox.New(srv.URL)
+	models, err := sb.ListModels(context.Background(), "model1")
+	is.NoErr(err)
+	is.Equal(apiCalls, 1)    // apiCalls
+	is.Equal(len(models), 3) // len(models)
+}
+
 func TestDeleteModel(t *testing.T) {
 	is := is.New(t)
 	var apiCalls int