Skip to content

Commit fe02a9f

Browse files
kylecarbskylecarbs
committed
chore: remove Get prefix from *Client functions
1 parent 9747757 commit fe02a9f

File tree

9 files changed

+34
-34
lines changed

9 files changed

+34
-34
lines changed

‎cli/tokens.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ func listTokens() *cobra.Command {
103103
return xerrors.Errorf("create codersdk client: %w", err)
104104
}
105105

106-
keys, err := client.GetTokens(cmd.Context(), codersdk.Me)
106+
keys, err := client.Tokens(cmd.Context(), codersdk.Me)
107107
if err != nil {
108108
return xerrors.Errorf("create tokens: %w", err)
109109
}

‎coderd/apikey_test.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,15 @@ func TestTokenCRUD(t *testing.T) {
1919
defer cancel()
2020
client := coderdtest.New(t, nil)
2121
_ = coderdtest.CreateFirstUser(t, client)
22-
keys, err := client.GetTokens(ctx, codersdk.Me)
22+
keys, err := client.Tokens(ctx, codersdk.Me)
2323
require.NoError(t, err)
2424
require.Empty(t, keys)
2525

2626
res, err := client.CreateToken(ctx, codersdk.Me, codersdk.CreateTokenRequest{})
2727
require.NoError(t, err)
2828
require.Greater(t, len(res.Key), 2)
2929

30-
keys, err = client.GetTokens(ctx, codersdk.Me)
30+
keys, err = client.Tokens(ctx, codersdk.Me)
3131
require.NoError(t, err)
3232
require.EqualValues(t, len(keys), 1)
3333
require.Contains(t, res.Key, keys[0].ID)
@@ -40,7 +40,7 @@ func TestTokenCRUD(t *testing.T) {
4040

4141
err = client.DeleteAPIKey(ctx, codersdk.Me, keys[0].ID)
4242
require.NoError(t, err)
43-
keys, err = client.GetTokens(ctx, codersdk.Me)
43+
keys, err = client.Tokens(ctx, codersdk.Me)
4444
require.NoError(t, err)
4545
require.Empty(t, keys)
4646
}
@@ -59,7 +59,7 @@ func TestTokenScoped(t *testing.T) {
5959
require.NoError(t, err)
6060
require.Greater(t, len(res.Key), 2)
6161

62-
keys, err := client.GetTokens(ctx, codersdk.Me)
62+
keys, err := client.Tokens(ctx, codersdk.Me)
6363
require.NoError(t, err)
6464
require.EqualValues(t, len(keys), 1)
6565
require.Contains(t, res.Key, keys[0].ID)
@@ -78,7 +78,7 @@ func TestTokenDuration(t *testing.T) {
7878
Lifetime: time.Hour * 24 * 7,
7979
})
8080
require.NoError(t, err)
81-
keys, err := client.GetTokens(ctx, codersdk.Me)
81+
keys, err := client.Tokens(ctx, codersdk.Me)
8282
require.NoError(t, err)
8383
require.Greater(t, keys[0].ExpiresAt, time.Now().Add(time.Hour*6*24))
8484
require.Less(t, keys[0].ExpiresAt, time.Now().Add(time.Hour*8*24))

‎coderd/coderdtest/authorize.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -342,7 +342,7 @@ func NewAuthTester(ctx context.Context, t *testing.T, client *codersdk.Client, a
342342
})
343343
require.NoError(t, err, "create token")
344344

345-
apiKeys, err := client.GetTokens(ctx, admin.UserID.String())
345+
apiKeys, err := client.Tokens(ctx, admin.UserID.String())
346346
require.NoError(t, err, "get tokens")
347347
apiKey := apiKeys[0]
348348

‎coderd/users_test.go

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -230,15 +230,15 @@ func TestPostLogin(t *testing.T) {
230230
defer cancel()
231231

232232
split := strings.Split(client.SessionToken(), "-")
233-
key, err := client.GetAPIKey(ctx, admin.UserID.String(), split[0])
233+
key, err := client.APIKey(ctx, admin.UserID.String(), split[0])
234234
require.NoError(t, err, "fetch login key")
235235
require.Equal(t, int64(86400), key.LifetimeSeconds, "default should be 86400")
236236

237237
// tokens have a longer life
238238
token, err := client.CreateToken(ctx, codersdk.Me, codersdk.CreateTokenRequest{})
239239
require.NoError(t, err, "make new token api key")
240240
split = strings.Split(token.Key, "-")
241-
apiKey, err := client.GetAPIKey(ctx, admin.UserID.String(), split[0])
241+
apiKey, err := client.APIKey(ctx, admin.UserID.String(), split[0])
242242
require.NoError(t, err, "fetch api key")
243243

244244
require.True(t, apiKey.ExpiresAt.After(time.Now().Add(time.Hour*24*29)), "default tokens lasts more than 29 days")
@@ -307,7 +307,7 @@ func TestPostLogout(t *testing.T) {
307307
defer cancel()
308308

309309
keyID := strings.Split(client.SessionToken(), "-")[0]
310-
apiKey, err := client.GetAPIKey(ctx, admin.UserID.String(), keyID)
310+
apiKey, err := client.APIKey(ctx, admin.UserID.String(), keyID)
311311
require.NoError(t, err)
312312
require.Equal(t, keyID, apiKey.ID, "API key should exist in the database")
313313

@@ -331,7 +331,7 @@ func TestPostLogout(t *testing.T) {
331331
}
332332
require.True(t, found, "auth cookie should be returned")
333333

334-
_, err = client.GetAPIKey(ctx, admin.UserID.String(), keyID)
334+
_, err = client.APIKey(ctx, admin.UserID.String(), keyID)
335335
sdkErr := &codersdk.Error{}
336336
require.ErrorAs(t, err, &sdkErr)
337337
require.Equal(t, http.StatusUnauthorized, sdkErr.StatusCode(), "Expecting 401")
@@ -615,7 +615,7 @@ func TestUpdateUserPassword(t *testing.T) {
615615

616616
// Trying to get an API key should fail since our client's token
617617
// has been deleted.
618-
_, err = client.GetAPIKey(ctx, user.UserID.String(), apikey1.Key)
618+
_, err = client.APIKey(ctx, user.UserID.String(), apikey1.Key)
619619
require.Error(t, err)
620620
cerr := coderdtest.SDKError(t, err)
621621
require.Equal(t, http.StatusUnauthorized, cerr.StatusCode())
@@ -630,12 +630,12 @@ func TestUpdateUserPassword(t *testing.T) {
630630

631631
// Trying to get an API key should fail since all keys are deleted
632632
// on password change.
633-
_, err = client.GetAPIKey(ctx, user.UserID.String(), apikey1.Key)
633+
_, err = client.APIKey(ctx, user.UserID.String(), apikey1.Key)
634634
require.Error(t, err)
635635
cerr = coderdtest.SDKError(t, err)
636636
require.Equal(t, http.StatusNotFound, cerr.StatusCode())
637637

638-
_, err = client.GetAPIKey(ctx, user.UserID.String(), apikey2.Key)
638+
_, err = client.APIKey(ctx, user.UserID.String(), apikey2.Key)
639639
require.Error(t, err)
640640
cerr = coderdtest.SDKError(t, err)
641641
require.Equal(t, http.StatusNotFound, cerr.StatusCode())
@@ -833,7 +833,7 @@ func TestInitialRoles(t *testing.T) {
833833
client := coderdtest.New(t, nil)
834834
first := coderdtest.CreateFirstUser(t, client)
835835

836-
roles, err := client.GetUserRoles(ctx, codersdk.Me)
836+
roles, err := client.UserRoles(ctx, codersdk.Me)
837837
require.NoError(t, err)
838838
require.ElementsMatch(t, roles.Roles, []string{
839839
rbac.RoleOwner(),

‎coderd/workspaceapps.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ func (api *API) appHost(rw http.ResponseWriter, r *http.Request) {
8585
host += fmt.Sprintf(":%s", api.AccessURL.Port())
8686
}
8787

88-
httpapi.Write(r.Context(), rw, http.StatusOK, codersdk.GetAppHostResponse{
88+
httpapi.Write(r.Context(), rw, http.StatusOK, codersdk.AppHostResponse{
8989
Host: host,
9090
})
9191
}

‎coderd/workspaceapps_test.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,12 @@ func TestGetAppHost(t *testing.T) {
9696
defer cancel()
9797

9898
// Should not leak to unauthenticated users.
99-
host, err := client.GetAppHost(ctx)
99+
host, err := client.AppHost(ctx)
100100
require.Error(t, err)
101101
require.Equal(t, "", host.Host)
102102

103103
_ = coderdtest.CreateFirstUser(t, client)
104-
host, err = client.GetAppHost(ctx)
104+
host, err = client.AppHost(ctx)
105105
require.NoError(t, err)
106106
require.Equal(t, c.expected, host.Host)
107107
})
@@ -437,7 +437,7 @@ func TestWorkspaceApplicationAuth(t *testing.T) {
437437
// Get the current user and API key.
438438
user, err := client.User(ctx, codersdk.Me)
439439
require.NoError(t, err)
440-
currentAPIKey, err := client.GetAPIKey(ctx, firstUser.UserID.String(), strings.Split(client.SessionToken(), "-")[0])
440+
currentAPIKey, err := client.APIKey(ctx, firstUser.UserID.String(), strings.Split(client.SessionToken(), "-")[0])
441441
require.NoError(t, err)
442442

443443
// Try to load the application without authentication.
@@ -499,7 +499,7 @@ func TestWorkspaceApplicationAuth(t *testing.T) {
499499
apiKey := cookies[0].Value
500500

501501
// Fetch the API key.
502-
apiKeyInfo, err := client.GetAPIKey(ctx, firstUser.UserID.String(), strings.Split(apiKey, "-")[0])
502+
apiKeyInfo, err := client.APIKey(ctx, firstUser.UserID.String(), strings.Split(apiKey, "-")[0])
503503
require.NoError(t, err)
504504
require.Equal(t, user.ID, apiKeyInfo.UserID)
505505
require.Equal(t, codersdk.LoginTypePassword, apiKeyInfo.LoginType)
@@ -730,7 +730,7 @@ func TestWorkspaceAppsProxySubdomain(t *testing.T) {
730730
require.NoError(t, err, "get workspaces")
731731
require.Len(t, res.Workspaces, 1, "expected 1 workspace")
732732

733-
appHost, err := client.GetAppHost(ctx)
733+
appHost, err := client.AppHost(ctx)
734734
require.NoError(t, err, "get app host")
735735

736736
subdomain := httpapi.ApplicationURL{
@@ -1049,7 +1049,7 @@ func TestAppSubdomainLogout(t *testing.T) {
10491049
_, err := client.User(ctx, codersdk.Me)
10501050
require.NoError(t, err)
10511051

1052-
appHost, err := client.GetAppHost(ctx)
1052+
appHost, err := client.AppHost(ctx)
10531053
require.NoError(t, err, "get app host")
10541054

10551055
if c.cookie == "-" {

‎codersdk/apikey.go

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -84,8 +84,8 @@ func (c *Client) CreateAPIKey(ctx context.Context, user string) (GenerateAPIKeyR
8484
return apiKey, json.NewDecoder(res.Body).Decode(&apiKey)
8585
}
8686

87-
// GetTokens list machine API keys.
88-
func (c *Client) GetTokens(ctx context.Context, userID string) ([]APIKey, error) {
87+
// Tokens list machine API keys.
88+
func (c *Client) Tokens(ctx context.Context, userID string) ([]APIKey, error) {
8989
res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/users/%s/keys/tokens", userID), nil)
9090
if err != nil {
9191
return nil, err
@@ -98,8 +98,8 @@ func (c *Client) GetTokens(ctx context.Context, userID string) ([]APIKey, error)
9898
return apiKey, json.NewDecoder(res.Body).Decode(&apiKey)
9999
}
100100

101-
// GetAPIKey returns the api key by id.
102-
func (c *Client) GetAPIKey(ctx context.Context, userID string, id string) (*APIKey, error) {
101+
// APIKey returns the api key by id.
102+
func (c *Client) APIKey(ctx context.Context, userID string, id string) (*APIKey, error) {
103103
res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/users/%s/keys/%s", userID, id), nil)
104104
if err != nil {
105105
return nil, err

‎codersdk/users.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -253,8 +253,8 @@ func (c *Client) UpdateOrganizationMemberRoles(ctx context.Context, organization
253253
return member, json.NewDecoder(res.Body).Decode(&member)
254254
}
255255

256-
// GetUserRoles returns all roles the user has
257-
func (c *Client) GetUserRoles(ctx context.Context, user string) (UserRoles, error) {
256+
// UserRoles returns all roles the user has
257+
func (c *Client) UserRoles(ctx context.Context, user string) (UserRoles, error) {
258258
res, err := c.Request(ctx, http.MethodGet, fmt.Sprintf("/api/v2/users/%s/roles", user), nil)
259259
if err != nil {
260260
return UserRoles{}, err

‎codersdk/workspaces.go

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -350,29 +350,29 @@ func (c *Client) WorkspaceByOwnerAndName(ctx context.Context, owner string, name
350350
return workspace, json.NewDecoder(res.Body).Decode(&workspace)
351351
}
352352

353-
type GetAppHostResponse struct {
353+
type AppHostResponse struct {
354354
// Host is the externally accessible URL for the Coder instance.
355355
Host string `json:"host"`
356356
}
357357

358-
// GetAppHost returns the site-wide application wildcard hostname without the
358+
// AppHost returns the site-wide application wildcard hostname without the
359359
// leading "*.", e.g. "apps.coder.com". Apps are accessible at:
360360
// "<app-name>--<agent-name>--<workspace-name>--<username>.<app-host>", e.g.
361361
// "my-app--agent--workspace--username.apps.coder.com".
362362
//
363363
// If the app host is not set, the response will contain an empty string.
364-
func (c *Client) GetAppHost(ctx context.Context) (GetAppHostResponse, error) {
364+
func (c *Client) AppHost(ctx context.Context) (AppHostResponse, error) {
365365
res, err := c.Request(ctx, http.MethodGet, "/api/v2/applications/host", nil)
366366
if err != nil {
367-
return GetAppHostResponse{}, err
367+
return AppHostResponse{}, err
368368
}
369369
defer res.Body.Close()
370370

371371
if res.StatusCode != http.StatusOK {
372-
return GetAppHostResponse{}, readBodyAsError(res)
372+
return AppHostResponse{}, readBodyAsError(res)
373373
}
374374

375-
var host GetAppHostResponse
375+
var host AppHostResponse
376376
return host, json.NewDecoder(res.Body).Decode(&host)
377377
}
378378

0 commit comments

Comments
 (0)