Remaining dashboard endpoints (#26)

Author: mpholcomb

accounting_client.go

@@ -12,6 +12,10 @@ type AccountingClient interface {
 	GetEntitlements(ctx context.Context) (*GetEntitlementsOutput, error)
 	// HasEntitlement will return true if you have the provided entitlement is
 	HasEntitlement(ctx context.Context, entitlement string) (bool, error)
+	// GetLicense returns a truncated view of your license information
+	GetLicense(ctx context.Context) (*GetLicenseOutput, error)
+	// ListAccountingUsers returns account user information
+	ListAccountingUsers(ctx context.Context, input *ListAccountingUsersInput) (*ListAccountingUsersOutput, error)
 }
 
 type standardAccountingClient struct {
@@ -53,3 +57,39 @@ func (c *standardAccountingClient) HasEntitlement(ctx context.Context, entitleme
 	}
 	return false, nil
 }
+func (c *standardAccountingClient) GetLicense(ctx context.Context) (*GetLicenseOutput, error) {
+	var out model.License
+	url := "/api/license"
+	_, err := c.baseClient.requestor.Get(ctx, url, &out)
+	if err != nil {
+		return nil, err
+	}
+
+	return &GetLicenseOutput{
+		License: out,
+	}, nil
+}
+
+func (c *standardAccountingClient) ListAccountingUsers(ctx context.Context, input *ListAccountingUsersInput) (*ListAccountingUsersOutput, error) {
+	input.Paging = input.Paging.withDefaults()
+
+	var items []model.AccountingUser
+	url := "/api/accounting/users"
+	_, links, err := c.baseClient.requestor.List(ctx, url, input.Paging, &items)
+	if err != nil {
+		return nil, err
+	}
+
+	// decide if we have a next page (the next link is not always accurate?)
+	var nextPage *ListAccountingUsersInput
+	if _, hasNextLink := links["next"]; len(items) == input.Paging.PerPage && hasNextLink {
+		nextPage = &ListAccountingUsersInput{
+			Paging: input.Paging.Next(),
+		}
+	}
+
+	return &ListAccountingUsersOutput{
+		Users:    items,
+		NextPage: nextPage,
+	}, nil
+}

accounting_client_test.go

@@ -58,6 +58,41 @@ func TestHasEntitlementHTTPError(t *testing.T) {
 	}
 }
 
+func TestGetLicenseHTTPError(t *testing.T) {
+	serv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(500)
+	}))
+	defer serv.Close()
+
+	client := NewClient(serv.URL)
+	_, err := client.Accounting().GetLicense(context.TODO())
+	if err == nil {
+		t.Errorf("Expected error")
+	}
+}
+
+func TestGetLicense(t *testing.T) {
+	serv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if r.Method != "GET" {
+			t.Errorf("expected method to be GET, got %s", r.Method)
+		}
+		if r.RequestURI != "/api/license" {
+			t.Errorf("get url not expected: %s", r.RequestURI)
+		}
+		w.Write([]byte(`{"companyName": "cn"}`))
+	}))
+	defer serv.Close()
+
+	client := NewClient(serv.URL)
+	out, err := client.Accounting().GetLicense(context.TODO())
+	if err != nil {
+		t.Errorf("err not nil: %v", err)
+	}
+	if out.License.CompanyName != "cn" {
+		t.Errorf("Expected entitlement one, got %s", out.License.CompanyName)
+	}
+}
+
 func TestHasEntitlement(t *testing.T) {
 	serv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
 		if r.Method != "GET" {
@@ -88,3 +123,43 @@ func TestHasEntitlement(t *testing.T) {
 		t.Errorf("Expected to have entitlment")
 	}
 }
+
+func TestListAccountingUsersHTTPError(t *testing.T) {
+	serv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(500)
+	}))
+	defer serv.Close()
+	client := NewClient(serv.URL)
+	_, err := client.Accounting().ListAccountingUsers(context.TODO(), (&ListAccountingUsersInput{}).WithPaging(2, 3))
+	if err == nil {
+		t.Errorf("Expected error")
+	}
+}
+
+func TestListAccountingUsers(t *testing.T) {
+	serv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		if r.Method != "GET" {
+			t.Errorf("expected method to be GET, got %s", r.Method)
+		}
+		if r.RequestURI != "/api/accounting/users?page=7&per-page=2" {
+			t.Errorf("get url not expected: %s", r.RequestURI)
+		}
+		w.Header().Set("Link", `<https://example>; rel="next"`)
+		w.Write([]byte(`[{"email": "jsonID"},{"email": "jsonID2"}]`))
+	}))
+	defer serv.Close()
+	client := NewClient(serv.URL)
+	out, err := client.Accounting().ListAccountingUsers(context.TODO(), (&ListAccountingUsersInput{}).WithPaging(2, 7))
+	if err != nil {
+		t.Errorf("err not nil: %v", err)
+	}
+	if out.Users[0].Email != "jsonID" {
+		t.Errorf("response not parsed")
+	}
+	if out.NextPage == nil {
+		t.Errorf("expected NextPage to have a value")
+	}
+	if out.NextPage.Paging.Page != 8 {
+		t.Errorf("expected NextPage to be next")
+	}
+}

accounting_params.go

@@ -6,3 +6,51 @@ import "github.com/modzy/sdk-go/model"
 type GetEntitlementsOutput struct {
 	Entitlements []model.Entitlement `json:"entitlements"`
 }
+
+type ListAccountingUsersInput struct {
+	Paging PagingInput
+}
+
+// ListAccountingUsersFilterField are known field names that can be used when filtering the jobs history
+type ListAccountingUsersFilterField string
+
+const (
+	ListAccountingUsersFilterFieldFirstName  ListAccountingUsersFilterField = "firstName"
+	ListAccountingUsersFilterFieldLastName   ListAccountingUsersFilterField = "lastName"
+	ListAccountingUsersFilterFieldEmail      ListAccountingUsersFilterField = "email"
+	ListAccountingUsersFilterFieldSearch     ListAccountingUsersFilterField = "search"
+	ListAccountingUsersFilterFieldStatus     ListAccountingUsersFilterField = "status"
+	ListAccountingUsersFilterFieldAccessKey  ListAccountingUsersFilterField = "accessKey"
+	ListAccountingUsersFilterFieldStartDate  ListAccountingUsersFilterField = "startDate"
+	ListAccountingUsersFilterFieldEndDate    ListAccountingUsersFilterField = "endDate"
+	ListAccountingUsersFilterFieldSearchDate ListAccountingUsersFilterField = "searchDate"
+)
+
+func (i *ListAccountingUsersInput) WithPaging(perPage int, page int) *ListAccountingUsersInput {
+	i.Paging = NewPaging(perPage, page)
+	return i
+}
+
+func (i *ListAccountingUsersInput) WithFilter(field ListAccountingUsersFilterField, value string) *ListAccountingUsersInput {
+	i.Paging = i.Paging.WithFilterAnd(string(field), value)
+	return i
+}
+
+func (i *ListAccountingUsersInput) WithFilterAnd(field ListAccountingUsersFilterField, values ...string) *ListAccountingUsersInput {
+	i.Paging = i.Paging.WithFilterAnd(string(field), values...)
+	return i
+}
+
+func (i *ListAccountingUsersInput) WithFilterOr(field ListAccountingUsersFilterField, values ...string) *ListAccountingUsersInput {
+	i.Paging = i.Paging.WithFilterOr(string(field), values...)
+	return i
+}
+
+type ListAccountingUsersOutput struct {
+	Users    []model.AccountingUser    `json:"users"`
+	NextPage *ListAccountingUsersInput `json:"nextPage"`
+}
+
+type GetLicenseOutput struct {
+	License model.License `json:"license"`
+}

accounting_params_test.go

@@ -0,0 +1,63 @@
+package modzy
+
+import (
+	"strings"
+	"testing"
+)
+
+func TestListAccountingUsersInputWithPaging(t *testing.T) {
+	i := &ListAccountingUsersInput{}
+	i.WithPaging(4, 5)
+
+	if i.Paging.PerPage != 4 {
+		t.Errorf("expected perPage to be 4, got %d", i.Paging.PerPage)
+	}
+	if i.Paging.Page != 5 {
+		t.Errorf("expected page to be 5, got %d", i.Paging.Page)
+	}
+}
+
+func TestListAccountingUsersInputWithFilter(t *testing.T) {
+	i := &ListAccountingUsersInput{}
+	i.WithFilter(ListAccountingUsersFilterFieldAccessKey, "a")
+
+	if i.Paging.Filters[0].Field != "accessKey" {
+		t.Errorf("expected filter field to be accessKey, got %s", i.Paging.Filters[0].Field)
+	}
+	if i.Paging.Filters[0].Type != "AND" {
+		t.Errorf("expected filter type to be AND, got %s", i.Paging.Filters[0].Type)
+	}
+	if strings.Join(i.Paging.Filters[0].Values, ",") != "a" {
+		t.Errorf("expected filter values to be [a], got %+v", i.Paging.Filters[0].Values)
+	}
+}
+
+func TestListAccountingUsersInputWithFilterAnd(t *testing.T) {
+	i := &ListAccountingUsersInput{}
+	i.WithFilterAnd(ListAccountingUsersFilterFieldAccessKey, "a", "b")
+
+	if i.Paging.Filters[0].Field != "accessKey" {
+		t.Errorf("expected filter field to be accessKey, got %s", i.Paging.Filters[0].Field)
+	}
+	if i.Paging.Filters[0].Type != "AND" {
+		t.Errorf("expected filter type to be AND, got %s", i.Paging.Filters[0].Type)
+	}
+	if strings.Join(i.Paging.Filters[0].Values, ",") != "a,b" {
+		t.Errorf("expected filter values to be [a, b], got %+v", i.Paging.Filters[0].Values)
+	}
+}
+
+func TestListAccountingUsersInputWithFilterOr(t *testing.T) {
+	i := &ListAccountingUsersInput{}
+	i.WithFilterOr(ListAccountingUsersFilterFieldAccessKey, "c", "d")
+
+	if i.Paging.Filters[0].Field != "accessKey" {
+		t.Errorf("expected filter field to be accessKey, got %s", i.Paging.Filters[0].Field)
+	}
+	if i.Paging.Filters[0].Type != "OR" {
+		t.Errorf("expected filter type to be OR, got %s", i.Paging.Filters[0].Type)
+	}
+	if strings.Join(i.Paging.Filters[0].Values, ",") != "c,d" {
+		t.Errorf("expected filter values to be [c, d], got %+v", i.Paging.Filters[0].Values)
+	}
+}

client.go

@@ -22,13 +22,16 @@ type Client interface {
 	Models() ModelsClient
 	// Dashboard returns a client for access to dashboard API functions
 	Dashboard() DashboardClient
+	// Resources returns a client for access to resource information
+	Resources() ResourcesClient
 }
 
 type standardClient struct {
 	accountingClient *standardAccountingClient
 	jobsClient       *standardJobsClient
 	modelsClient     *standardModelsClient
 	dashboardClient  *standardDashboardClient
+	resourcesClient  *standardResourcesClient
 	requestor        *requestor
 }
 
@@ -67,6 +70,9 @@ func NewClient(baseURL string, opts ...ClientOption) Client {
 	client.dashboardClient = &standardDashboardClient{
 		baseClient: client,
 	}
+	client.resourcesClient = &standardResourcesClient{
+		baseClient: client,
+	}
 
 	return client
 }
@@ -110,3 +116,7 @@ func (c *standardClient) Models() ModelsClient {
 func (c *standardClient) Dashboard() DashboardClient {
 	return c.dashboardClient
 }
+
+func (c *standardClient) Resources() ResourcesClient {
+	return c.resourcesClient
+}

client_fake.go

@@ -9,6 +9,7 @@ type ClientFake struct {
 	JobsFunc        func() JobsClient
 	ModelsFunc      func() ModelsClient
 	DashboardFunc   func() DashboardClient
+	ResourcesFunc   func() ResourcesClient
 }
 
 var _ Client = &ClientFake{}
@@ -40,3 +41,7 @@ func (c *ClientFake) Models() ModelsClient {
 func (c *ClientFake) Dashboard() DashboardClient {
 	return c.DashboardFunc()
 }
+
+func (c *ClientFake) Resources() ResourcesClient {
+	return c.ResourcesFunc()
+}

client_fake_test.go

@@ -48,6 +48,10 @@ func TestClientFake(t *testing.T) {
 			calls++
 			return nil
 		},
+		ResourcesFunc: func() ResourcesClient {
+			calls++
+			return nil
+		},
 	}
 	fake.WithAPIKey("apiKey")
 	fake.WithTeamKey("teamID", "token")
@@ -56,8 +60,9 @@ func TestClientFake(t *testing.T) {
 	fake.Jobs()
 	fake.Models()
 	fake.Dashboard()
+	fake.Resources()
 
-	if calls != 7 {
+	if calls != 8 {
 		t.Errorf("Did not call all of the funcs: %d", calls)
 	}
 }

internal/testing/main.go

@@ -525,4 +525,37 @@ func getDashboard(client modzy.Client) {
 		logrus.Info("  ...")
 		logrus.Infof("  %s: %s", out.Values[len(out.Values)-1].Time, out.Values[len(out.Values)-1].Value)
 	}
+
+	// accounting-users
+	if out, err := client.Accounting().ListAccountingUsers(ctx, &modzy.ListAccountingUsersInput{}); err != nil {
+		logrus.WithError(err).Errorf("Failed to get accoutning-users")
+	} else {
+		logrus.Infof("Total Users: %d\n", len(out.Users))
+	}
+
+	// license
+	if out, err := client.Accounting().GetLicense(ctx); err != nil {
+		logrus.WithError(err).Errorf("Failed to get license")
+	} else {
+		logrus.Infof("# Licensed Engines: %s\n", out.License.ProcessingEngines)
+	}
+
+	// engines
+	if out, err := client.Resources().GetProcessingModels(ctx); err != nil {
+		logrus.WithError(err).Errorf("Failed to get model resources")
+	} else {
+		tot := 0
+		for _, m := range out.Models {
+			tot += len(m.Engines)
+		}
+		logrus.Infof("# Engines processing : %d\n", tot)
+	}
+
+	// latest models
+	if out, err := client.Models().GetLatestModels(ctx); err != nil {
+		logrus.WithError(err).Errorf("Failed to get latest models")
+	} else {
+		logrus.Infof("# Latest Models : %d\n", len(out.Models))
+	}
+
 }

model/accounting.go

@@ -17,3 +17,8 @@ type AccountingUser struct {
 	Visited            bool      `json:"visited"`
 	Onboarded          bool      `json:"onboarded"`
 }
+
+type License struct {
+	CompanyName       string `json:"companyName"`
+	ProcessingEngines string `json:"processingEngines"`
+}