chore(internal): rearrange client arguments (#33)

Finch-API · Oct 12, 2023 · 81460c8 · 81460c8
1 parent c9b26ec
commit 81460c8
Show file tree

Hide file tree

Showing 18 changed files with 39 additions and 40 deletions.
diff --git a/README.md b/README.md
@@ -47,7 +47,7 @@ import (
 
 func main() {
 	client := finchgo.NewClient(
-		option.WithAccessToken("my access token"),
+		option.WithAccessToken("My Access Token"),
 	)
 	page, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})
 	if err != nil {

diff --git a/account_test.go b/account_test.go
@@ -23,7 +23,7 @@ func TestAccountDisconnect(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.Account.Disconnect(context.TODO())
 	if err != nil {
@@ -45,7 +45,7 @@ func TestAccountIntrospect(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.Account.Introspect(context.TODO())
 	if err != nil {

diff --git a/client_test.go b/client_test.go
@@ -25,7 +25,7 @@ func TestContextCancel(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	cancelCtx, cancel := context.WithCancel(context.Background())
 	cancel()
@@ -53,7 +53,7 @@ func TestContextCancelDelay(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 		option.WithHTTPClient(&http.Client{Transport: &neverTransport{}}),
 	)
 	cancelCtx, cancel := context.WithCancel(context.Background())
@@ -86,7 +86,7 @@ func TestContextDeadline(t *testing.T) {
 	go func() {
 		client := finchgo.NewClient(
 			option.WithBaseURL(baseURL),
-			option.WithAccessToken("AccessToken"),
+			option.WithAccessToken("My Access Token"),
 			option.WithHTTPClient(&http.Client{Transport: &neverTransport{}}),
 		)
 		res, err := client.HRIS.Directory.List(deadlineCtx, finchgo.HRISDirectoryListParams{})

diff --git a/hrisbenefit_test.go b/hrisbenefit_test.go
@@ -23,7 +23,7 @@ func TestHRISBenefitNewWithOptionalParams(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.HRIS.Benefits.New(context.TODO(), finchgo.HRISBenefitNewParams{
 		Description: finchgo.F("string"),
@@ -49,7 +49,7 @@ func TestHRISBenefitGet(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.HRIS.Benefits.Get(context.TODO(), "string")
 	if err != nil {
@@ -71,7 +71,7 @@ func TestHRISBenefitUpdateWithOptionalParams(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.HRIS.Benefits.Update(
 		context.TODO(),
@@ -99,7 +99,7 @@ func TestHRISBenefitList(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.HRIS.Benefits.List(context.TODO())
 	if err != nil {
@@ -121,7 +121,7 @@ func TestHRISBenefitListSupportedBenefits(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.HRIS.Benefits.ListSupportedBenefits(context.TODO())
 	if err != nil {

diff --git a/hrisbenefitindividual_test.go b/hrisbenefitindividual_test.go
@@ -23,7 +23,7 @@ func TestHRISBenefitIndividualEnrolledIDs(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.HRIS.Benefits.Individuals.EnrolledIDs(context.TODO(), "string")
 	if err != nil {
@@ -45,7 +45,7 @@ func TestHRISBenefitIndividualGetManyBenefitsWithOptionalParams(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.HRIS.Benefits.Individuals.GetManyBenefits(
 		context.TODO(),
@@ -73,7 +73,7 @@ func TestHRISBenefitIndividualUnenrollManyWithOptionalParams(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.HRIS.Benefits.Individuals.UnenrollMany(
 		context.TODO(),

diff --git a/hriscompany_test.go b/hriscompany_test.go
@@ -23,7 +23,7 @@ func TestHRISCompanyGet(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.HRIS.Company.Get(context.TODO())
 	if err != nil {

diff --git a/hrisdirectory_test.go b/hrisdirectory_test.go
@@ -23,7 +23,7 @@ func TestHRISDirectoryListWithOptionalParams(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{
 		Limit:  finchgo.F(int64(0)),
@@ -48,7 +48,7 @@ func TestHRISDirectoryListIndividualsWithOptionalParams(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.HRIS.Directory.ListIndividuals(context.TODO(), finchgo.HRISDirectoryListIndividualsParams{
 		Limit:  finchgo.F(int64(0)),

diff --git a/hrisemployment_test.go b/hrisemployment_test.go
@@ -23,7 +23,7 @@ func TestHRISEmploymentGetMany(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.HRIS.Employments.GetMany(context.TODO(), finchgo.HRISEmploymentGetManyParams{
 		Requests: finchgo.F([]finchgo.HRISEmploymentGetManyParamsRequest{{

diff --git a/hrisindividual_test.go b/hrisindividual_test.go
@@ -23,7 +23,7 @@ func TestHRISIndividualGetManyWithOptionalParams(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.HRIS.Individuals.GetMany(context.TODO(), finchgo.HRISIndividualGetManyParams{
 		Options: finchgo.F(finchgo.HRISIndividualGetManyParamsOptions{

diff --git a/hrispayment_test.go b/hrispayment_test.go
@@ -24,7 +24,7 @@ func TestHRISPaymentList(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.HRIS.Payments.List(context.TODO(), finchgo.HRISPaymentListParams{
 		EndDate:   finchgo.F(time.Now()),

diff --git a/hrispaystatement_test.go b/hrispaystatement_test.go
@@ -23,7 +23,7 @@ func TestHRISPayStatementGetMany(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.HRIS.PayStatements.GetMany(context.TODO(), finchgo.HRISPayStatementGetManyParams{
 		Requests: finchgo.F([]finchgo.HRISPayStatementGetManyParamsRequest{{

diff --git a/internal/requestconfig/requestconfig.go b/internal/requestconfig/requestconfig.go
@@ -131,17 +131,17 @@ type RequestConfig struct {
 	HTTPClient     *http.Client
 	Middlewares    []middleware
 	AccessToken    string
+	ClientID       string
+	ClientSecret   string
+	WebhookSecret  string
 	// If ResponseBodyInto not nil, then we will attempt to deserialize into
 	// ResponseBodyInto. If Destination is a []byte, then it will return the body as
 	// is.
 	ResponseBodyInto interface{}
 	// ResponseInto copies the \*http.Response of the corresponding request into the
 	// given address
-	ResponseInto  **http.Response
-	ClientID      string
-	ClientSecret  string
-	WebhookSecret string
-	Buffer        []byte
+	ResponseInto **http.Response
+	Buffer       []byte
 }
 
 // middleware is exactly the same type as the Middleware type found in the [option] package,

diff --git a/option/requestoption.go b/option/requestoption.go
@@ -181,22 +181,21 @@ func WithRequestTimeout(dur time.Duration) RequestOption {
 	}
 }
 
-// WithAccessToken returns a RequestOption that specifies a Access Token
-// to be used as the basis for authentication.
-func WithAccessToken(key string) RequestOption {
-	return func(r *requestconfig.RequestConfig) error {
-		r.AccessToken = key
-		return r.Apply(WithHeader("Authorization", fmt.Sprintf("Bearer %s", r.AccessToken)))
-	}
-}
-
 // WithEnvironmentProduction returns a RequestOption that sets the current
 // environment to be the "production" environment. An environment specifies which base URL
 // to use by default.
 func WithEnvironmentProduction() RequestOption {
 	return WithBaseURL("https://api.tryfinch.com/")
 }
 
+// WithAccessToken returns a RequestOption that sets the client setting "access_token".
+func WithAccessToken(value string) RequestOption {
+	return func(r *requestconfig.RequestConfig) error {
+		r.AccessToken = value
+		return r.Apply(WithHeader("authorization", fmt.Sprintf("Bearer %s", r.AccessToken)))
+	}
+}
+
 // WithClientID returns a RequestOption that sets the client setting "client_id".
 func WithClientID(value string) RequestOption {
 	return func(r *requestconfig.RequestConfig) error {

diff --git a/paginationauto_test.go b/paginationauto_test.go
@@ -22,7 +22,7 @@ func TestAutoPagination(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	iter := client.HRIS.Directory.ListAutoPaging(context.TODO(), finchgo.HRISDirectoryListParams{})
 	// Prism mock isn't going to give us real pagination

diff --git a/paginationmanual_test.go b/paginationmanual_test.go
@@ -22,7 +22,7 @@ func TestManualPagination(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	page, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})
 	if err != nil {

diff --git a/provider_test.go b/provider_test.go
@@ -23,7 +23,7 @@ func TestProviderList(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.Providers.List(context.TODO())
 	if err != nil {

diff --git a/requestforwarding_test.go b/requestforwarding_test.go
@@ -23,7 +23,7 @@ func TestRequestForwardingForwardWithOptionalParams(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	_, err := client.RequestForwarding.Forward(context.TODO(), finchgo.RequestForwardingForwardParams{
 		Method: finchgo.F("POST"),

diff --git a/usage_test.go b/usage_test.go
@@ -22,7 +22,7 @@ func TestUsage(t *testing.T) {
 	}
 	client := finchgo.NewClient(
 		option.WithBaseURL(baseURL),
-		option.WithAccessToken("AccessToken"),
+		option.WithAccessToken("My Access Token"),
 	)
 	page, err := client.HRIS.Directory.List(context.TODO(), finchgo.HRISDirectoryListParams{})
 	if err != nil {