From 2f19ebae25fecc9c8770c0ade7715f32d5dc75f0 Mon Sep 17 00:00:00 2001 From: Isaac Wengler Date: Mon, 19 May 2025 20:36:48 -0400 Subject: [PATCH 1/3] add quickbooks provider add all supported scopes add examples fix --- README.md | 1 + examples/main.go | 3 + providers/quickbooks/quickbooks.go | 165 ++++++++++++++++++++++++ providers/quickbooks/quickbooks_test.go | 115 +++++++++++++++++ providers/quickbooks/session.go | 51 ++++++++ providers/quickbooks/session_test.go | 75 +++++++++++ 6 files changed, 410 insertions(+) create mode 100644 providers/quickbooks/quickbooks.go create mode 100644 providers/quickbooks/quickbooks_test.go create mode 100644 providers/quickbooks/session.go create mode 100644 providers/quickbooks/session_test.go diff --git a/README.md b/README.md index af0dc00b..b42d32b5 100644 --- a/README.md +++ b/README.md @@ -57,6 +57,7 @@ $ go get github.com/markbates/goth * Oura * Patreon * Paypal +* Quickbooks * Reddit * SalesForce * Shopify diff --git a/examples/main.go b/examples/main.go index 8bb9ddf9..c05da0ce 100644 --- a/examples/main.go +++ b/examples/main.go @@ -48,6 +48,7 @@ import ( "github.com/markbates/goth/providers/openidConnect" "github.com/markbates/goth/providers/patreon" "github.com/markbates/goth/providers/paypal" + "github.com/markbates/goth/providers/quickbooks" "github.com/markbates/goth/providers/salesforce" "github.com/markbates/goth/providers/seatalk" "github.com/markbates/goth/providers/shopify" @@ -149,6 +150,7 @@ func main() { wecom.New(os.Getenv("WECOM_CORP_ID"), os.Getenv("WECOM_SECRET"), os.Getenv("WECOM_AGENT_ID"), "http://localhost:3000/auth/wecom/callback"), zoom.New(os.Getenv("ZOOM_KEY"), os.Getenv("ZOOM_SECRET"), "http://localhost:3000/auth/zoom/callback", "read:user"), patreon.New(os.Getenv("PATREON_KEY"), os.Getenv("PATREON_SECRET"), "http://localhost:3000/auth/patreon/callback"), + quickbooks.New(os.Getenv("QUICKBOOKS_KEY"), os.Getenv("QUICKBOOKS_SECRET"), "http://localhost:3000/auth/quickbooks/callback", nil, quickbooks.ScopeAccounting, quickbooks.ScopePayments), ) // OpenID Connect is based on OpenID Connect Auto Discovery URL (https://openid.net/specs/openid-connect-discovery-1_0-17.html) @@ -197,6 +199,7 @@ func main() { "openid-connect": "OpenID Connect", "patreon": "Patreon", "paypal": "Paypal", + "quickbooks": "Quickbooks", "salesforce": "Salesforce", "seatalk": "SeaTalk", "shopify": "Shopify", diff --git a/providers/quickbooks/quickbooks.go b/providers/quickbooks/quickbooks.go new file mode 100644 index 00000000..db329e86 --- /dev/null +++ b/providers/quickbooks/quickbooks.go @@ -0,0 +1,165 @@ +package quickbooks + +import ( + "encoding/json" + "fmt" + "net/http" + "strings" + + "github.com/markbates/goth" + "golang.org/x/oauth2" +) + +const ( + authEndpoint = "https://appcenter.intuit.com/connect/oauth2" + tokenEndpoint = "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer" + userInfoURL = "https://accounts.platform.intuit.com/v1/openid_connect/userinfo" + + ScopeAccounting = "com.intuit.quickbooks.accounting" + ScopePayments = "com.intuit.quickbooks.payments" + ScopeOpenId = "openid" + ScopeEmail = "email" + ScopeProfile = "profile" + ScopePhone = "phone" + ScopeAddress = "address" +) + +type Provider struct { + providerName string + clientId string + secret string + redirectURL string + config *oauth2.Config + httpClient *http.Client + userInfoURL string +} + +func New(clientId, secret, redirectURL string, httpClient *http.Client, scopes ...string) *Provider { + p := &Provider{ + clientId: clientId, + secret: secret, + redirectURL: redirectURL, + providerName: "quickbooks", + userInfoURL: userInfoURL, + } + p.configure(scopes) + p.httpClient = httpClient + return p +} + +func (p Provider) Name() string { + return p.providerName +} + +func (p *Provider) SetName(name string) { + p.providerName = name +} + +func (p Provider) ClientId() string { + return p.clientId +} + +func (p Provider) Secret() string { + return p.secret +} + +func (p Provider) RedirectURL() string { + return p.redirectURL +} + +func (p Provider) BeginAuth(state string) (goth.Session, error) { + authURL := p.config.AuthCodeURL(state) + return &Session{ + AuthURL: authURL, + }, nil +} + +func (Provider) UnmarshalSession(data string) (goth.Session, error) { + s := &Session{} + err := json.NewDecoder(strings.NewReader(data)).Decode(s) + return s, err +} + +func (p Provider) FetchUser(session goth.Session) (goth.User, error) { + s := session.(*Session) + if s.AccessToken == "" { + return goth.User{}, fmt.Errorf("no access token obtained for session with provider %s", p.Name()) + } + + req, err := http.NewRequest("GET", p.userInfoURL, nil) + if err != nil { + return goth.User{}, err + } + req.Header.Set("Authorization", "Bearer "+s.AccessToken) + + resp, err := p.Client().Do(req) + if err != nil { + return goth.User{}, err + } + defer resp.Body.Close() + + if resp.StatusCode != http.StatusOK { + return goth.User{}, fmt.Errorf("failed to get user info: %d", resp.StatusCode) + } + + var userInfo struct { + Sub string `json:"sub"` + Email string `json:"email"` + EmailVerified bool `json:"email_verified"` + Name string `json:"name"` + GivenName string `json:"given_name"` + FamilyName string `json:"family_name"` + } + + if err := json.NewDecoder(resp.Body).Decode(&userInfo); err != nil { + return goth.User{}, err + } + + return goth.User{ + Provider: p.Name(), + UserID: userInfo.Sub, + Email: userInfo.Email, + Name: userInfo.Name, + FirstName: userInfo.GivenName, + LastName: userInfo.FamilyName, + AccessToken: s.AccessToken, + RefreshToken: s.RefreshToken, + ExpiresAt: s.ExpiresAt, + }, nil +} + +func (Provider) Debug(bool) {} + +func (p Provider) Client() *http.Client { + return goth.HTTPClientWithFallBack(p.httpClient) +} + +func (p Provider) RefreshToken(refreshToken string) (*oauth2.Token, error) { + token := &oauth2.Token{RefreshToken: refreshToken} + ts := p.config.TokenSource(goth.ContextForClient(p.Client()), token) + newToken, err := ts.Token() + if err != nil { + return nil, err + } + return newToken, err +} + +func (Provider) RefreshTokenAvailable() bool { + return true +} + +func (p *Provider) configure(scopes []string) { + c := &oauth2.Config{ + ClientID: p.clientId, + ClientSecret: p.secret, + RedirectURL: p.redirectURL, + Endpoint: oauth2.Endpoint{ + AuthURL: authEndpoint, + TokenURL: tokenEndpoint, + }, + Scopes: make([]string, 0, len(scopes)), + } + + c.Scopes = append(c.Scopes, scopes...) + p.config = c +} diff --git a/providers/quickbooks/quickbooks_test.go b/providers/quickbooks/quickbooks_test.go new file mode 100644 index 00000000..e0cfa93a --- /dev/null +++ b/providers/quickbooks/quickbooks_test.go @@ -0,0 +1,115 @@ +package quickbooks + +import ( + "encoding/json" + "net/http" + "net/http/httptest" + "testing" + "time" + + "github.com/markbates/goth" + "github.com/stretchr/testify/assert" +) + +func Test_New(t *testing.T) { + t.Parallel() + a := assert.New(t) + + provider := New("client-id", "secret", "http://example.com/callback", nil, ScopeAccounting) + a.Equal(provider.ClientId(), "client-id") + a.Equal(provider.Secret(), "secret") + a.Equal(provider.RedirectURL(), "http://example.com/callback") + a.Equal(provider.Name(), "quickbooks") +} + +func Test_Implements_Provider(t *testing.T) { + t.Parallel() + a := assert.New(t) + a.Implements((*goth.Provider)(nil), New("", "", "", nil)) +} + +func Test_BeginAuth(t *testing.T) { + t.Parallel() + a := assert.New(t) + + provider := New("client-id", "secret", "http://example.com/callback", nil, ScopeAccounting) + session, err := provider.BeginAuth("test_state") + s := session.(*Session) + a.NoError(err) + a.Contains(s.AuthURL, "appcenter.intuit.com/connect/oauth2") + a.Contains(s.AuthURL, "client_id=client-id") + a.Contains(s.AuthURL, "state=test_state") + a.Contains(s.AuthURL, "scope=com.intuit.quickbooks.accounting") +} + +func Test_FetchUser(t *testing.T) { + t.Parallel() + a := assert.New(t) + + ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + a.Equal(r.Header.Get("Authorization"), "Bearer access_token") + w.Header().Set("Content-Type", "application/json") + json.NewEncoder(w).Encode(map[string]interface{}{ + "sub": "user123", + "email": "user@example.com", + "email_verified": true, + "name": "John Doe", + "given_name": "John", + "family_name": "Doe", + }) + })) + defer ts.Close() + + provider := New("client-id", "secret", "http://example.com/callback", nil, ScopeAccounting) + provider.userInfoURL = ts.URL + session := &Session{ + AccessToken: "access_token", + ExpiresAt: time.Now().Add(time.Hour), + } + + user, err := provider.FetchUser(session) + a.NoError(err) + a.Equal(user.UserID, "user123") + a.Equal(user.Email, "user@example.com") + a.Equal(user.Name, "John Doe") + a.Equal(user.FirstName, "John") + a.Equal(user.LastName, "Doe") + a.Equal(user.AccessToken, "access_token") +} + +func Test_RefreshToken(t *testing.T) { + t.Parallel() + a := assert.New(t) + + ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { + a.Equal(r.Method, "POST") + a.Equal(r.Header.Get("Content-Type"), "application/x-www-form-urlencoded") + + w.Header().Set("Content-Type", "application/json") + json.NewEncoder(w).Encode(map[string]interface{}{ + "access_token": "new_access_token", + "token_type": "bearer", + "expires_in": 3600, + "refresh_token": "new_refresh_token", + }) + })) + defer ts.Close() + + provider := New("client-id", "secret", "http://example.com/callback", nil, ScopeAccounting) + provider.config.Endpoint.TokenURL = ts.URL + + token, err := provider.RefreshToken("refresh_token") + a.NoError(err) + a.NotNil(token) + a.Equal(token.AccessToken, "new_access_token") + a.Equal(token.RefreshToken, "new_refresh_token") + a.True(token.Expiry.After(time.Now())) +} + +func Test_RefreshTokenAvailable(t *testing.T) { + t.Parallel() + a := assert.New(t) + + provider := New("client-id", "secret", "http://example.com/callback", nil, ScopeAccounting) + a.True(provider.RefreshTokenAvailable()) +} diff --git a/providers/quickbooks/session.go b/providers/quickbooks/session.go new file mode 100644 index 00000000..ff701117 --- /dev/null +++ b/providers/quickbooks/session.go @@ -0,0 +1,51 @@ +package quickbooks + +import ( + "encoding/json" + "errors" + "time" + + "github.com/markbates/goth" +) + +type Session struct { + AuthURL string + AccessToken string + RefreshToken string + ExpiresAt time.Time +} + +var _ goth.Session = &Session{} + +func (s Session) GetAuthURL() (string, error) { + if s.AuthURL == "" { + return "", errors.New(goth.NoAuthUrlErrorMessage) + } + return s.AuthURL, nil +} + +func (s *Session) Authorize(provider goth.Provider, params goth.Params) (string, error) { + p := provider.(*Provider) + token, err := p.config.Exchange(goth.ContextForClient(p.Client()), params.Get("code")) + if err != nil { + return "", err + } + + if !token.Valid() { + return "", errors.New("invalid token received from provider") + } + + s.AccessToken = token.AccessToken + s.RefreshToken = token.RefreshToken + s.ExpiresAt = token.Expiry + return token.AccessToken, err +} + +func (s Session) Marshal() string { + b, _ := json.Marshal(s) + return string(b) +} + +func (s Session) String() string { + return s.Marshal() +} diff --git a/providers/quickbooks/session_test.go b/providers/quickbooks/session_test.go new file mode 100644 index 00000000..0b1a165f --- /dev/null +++ b/providers/quickbooks/session_test.go @@ -0,0 +1,75 @@ +package quickbooks + +import ( + "testing" + "time" + + "github.com/stretchr/testify/assert" +) + +type mockParams struct { + params map[string]string +} + +func (m *mockParams) Get(key string) string { + return m.params[key] +} + +func Test_GetAuthURL(t *testing.T) { + t.Parallel() + a := assert.New(t) + + s := &Session{} + url, err := s.GetAuthURL() + a.Error(err) + a.Empty(url) + + s.AuthURL = "https://example.com/auth" + url, err = s.GetAuthURL() + a.NoError(err) + a.Equal(url, "https://example.com/auth") +} + +func Test_Authorize(t *testing.T) { + t.Parallel() + a := assert.New(t) + + s := &Session{} + provider := New("client-id", "secret", "http://example.com/callback", nil, ScopeAccounting) + _, err := s.Authorize(provider, &mockParams{params: map[string]string{"code": "test_code"}}) + a.Error(err) +} + +func Test_Marshal(t *testing.T) { + t.Parallel() + a := assert.New(t) + + s := &Session{ + AuthURL: "https://example.com/auth", + AccessToken: "access_token", + RefreshToken: "refresh_token", + ExpiresAt: time.Now(), + } + + str := s.Marshal() + a.Contains(str, "https://example.com/auth") + a.Contains(str, "access_token") + a.Contains(str, "refresh_token") +} + +func Test_String(t *testing.T) { + t.Parallel() + a := assert.New(t) + + s := &Session{ + AuthURL: "https://example.com/auth", + AccessToken: "access_token", + RefreshToken: "refresh_token", + ExpiresAt: time.Now(), + } + + str := s.String() + a.Contains(str, "https://example.com/auth") + a.Contains(str, "access_token") + a.Contains(str, "refresh_token") +} From 0eeeed3d3bf90b3e4ada635055a9f6f64bb46b06 Mon Sep 17 00:00:00 2001 From: Isaac Wengler Date: Mon, 26 May 2025 20:26:34 -0400 Subject: [PATCH 2/3] support quickbooks sandbox --- examples/main.go | 2 +- providers/quickbooks/quickbooks.go | 13 ++++++++----- providers/quickbooks/quickbooks_test.go | 12 ++++++------ providers/quickbooks/session_test.go | 2 +- 4 files changed, 16 insertions(+), 13 deletions(-) diff --git a/examples/main.go b/examples/main.go index c05da0ce..0c452bf0 100644 --- a/examples/main.go +++ b/examples/main.go @@ -150,7 +150,7 @@ func main() { wecom.New(os.Getenv("WECOM_CORP_ID"), os.Getenv("WECOM_SECRET"), os.Getenv("WECOM_AGENT_ID"), "http://localhost:3000/auth/wecom/callback"), zoom.New(os.Getenv("ZOOM_KEY"), os.Getenv("ZOOM_SECRET"), "http://localhost:3000/auth/zoom/callback", "read:user"), patreon.New(os.Getenv("PATREON_KEY"), os.Getenv("PATREON_SECRET"), "http://localhost:3000/auth/patreon/callback"), - quickbooks.New(os.Getenv("QUICKBOOKS_KEY"), os.Getenv("QUICKBOOKS_SECRET"), "http://localhost:3000/auth/quickbooks/callback", nil, quickbooks.ScopeAccounting, quickbooks.ScopePayments), + quickbooks.New(os.Getenv("QUICKBOOKS_KEY"), os.Getenv("QUICKBOOKS_SECRET"), "http://localhost:3000/auth/quickbooks/callback", false, quickbooks.ScopeAccounting, quickbooks.ScopePayments), ) // OpenID Connect is based on OpenID Connect Auto Discovery URL (https://openid.net/specs/openid-connect-discovery-1_0-17.html) diff --git a/providers/quickbooks/quickbooks.go b/providers/quickbooks/quickbooks.go index db329e86..d4543588 100644 --- a/providers/quickbooks/quickbooks.go +++ b/providers/quickbooks/quickbooks.go @@ -11,9 +11,10 @@ import ( ) const ( - authEndpoint = "https://appcenter.intuit.com/connect/oauth2" - tokenEndpoint = "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer" - userInfoURL = "https://accounts.platform.intuit.com/v1/openid_connect/userinfo" + authEndpoint = "https://appcenter.intuit.com/connect/oauth2" + tokenEndpoint = "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer" + userInfoURL = "https://accounts.platform.intuit.com/v1/openid_connect/userinfo" + sandboxUserInfoURL = "https://sandbox-accounts.platform.intuit.com/v1/openid_connect/userinfo" ScopeAccounting = "com.intuit.quickbooks.accounting" ScopePayments = "com.intuit.quickbooks.payments" @@ -34,7 +35,7 @@ type Provider struct { userInfoURL string } -func New(clientId, secret, redirectURL string, httpClient *http.Client, scopes ...string) *Provider { +func New(clientId, secret, redirectURL string, isSandbox bool, scopes ...string) *Provider { p := &Provider{ clientId: clientId, secret: secret, @@ -42,8 +43,10 @@ func New(clientId, secret, redirectURL string, httpClient *http.Client, scopes . providerName: "quickbooks", userInfoURL: userInfoURL, } + if isSandbox { + p.userInfoURL = sandboxUserInfoURL + } p.configure(scopes) - p.httpClient = httpClient return p } diff --git a/providers/quickbooks/quickbooks_test.go b/providers/quickbooks/quickbooks_test.go index e0cfa93a..4e863ed9 100644 --- a/providers/quickbooks/quickbooks_test.go +++ b/providers/quickbooks/quickbooks_test.go @@ -15,7 +15,7 @@ func Test_New(t *testing.T) { t.Parallel() a := assert.New(t) - provider := New("client-id", "secret", "http://example.com/callback", nil, ScopeAccounting) + provider := New("client-id", "secret", "http://example.com/callback", false, ScopeAccounting) a.Equal(provider.ClientId(), "client-id") a.Equal(provider.Secret(), "secret") a.Equal(provider.RedirectURL(), "http://example.com/callback") @@ -25,14 +25,14 @@ func Test_New(t *testing.T) { func Test_Implements_Provider(t *testing.T) { t.Parallel() a := assert.New(t) - a.Implements((*goth.Provider)(nil), New("", "", "", nil)) + a.Implements((*goth.Provider)(nil), New("", "", "", false)) } func Test_BeginAuth(t *testing.T) { t.Parallel() a := assert.New(t) - provider := New("client-id", "secret", "http://example.com/callback", nil, ScopeAccounting) + provider := New("client-id", "secret", "http://example.com/callback", false, ScopeAccounting) session, err := provider.BeginAuth("test_state") s := session.(*Session) a.NoError(err) @@ -60,7 +60,7 @@ func Test_FetchUser(t *testing.T) { })) defer ts.Close() - provider := New("client-id", "secret", "http://example.com/callback", nil, ScopeAccounting) + provider := New("client-id", "secret", "http://example.com/callback", false, ScopeAccounting) provider.userInfoURL = ts.URL session := &Session{ AccessToken: "access_token", @@ -95,7 +95,7 @@ func Test_RefreshToken(t *testing.T) { })) defer ts.Close() - provider := New("client-id", "secret", "http://example.com/callback", nil, ScopeAccounting) + provider := New("client-id", "secret", "http://example.com/callback", false, ScopeAccounting) provider.config.Endpoint.TokenURL = ts.URL token, err := provider.RefreshToken("refresh_token") @@ -110,6 +110,6 @@ func Test_RefreshTokenAvailable(t *testing.T) { t.Parallel() a := assert.New(t) - provider := New("client-id", "secret", "http://example.com/callback", nil, ScopeAccounting) + provider := New("client-id", "secret", "http://example.com/callback", false, ScopeAccounting) a.True(provider.RefreshTokenAvailable()) } diff --git a/providers/quickbooks/session_test.go b/providers/quickbooks/session_test.go index 0b1a165f..c7ce9df4 100644 --- a/providers/quickbooks/session_test.go +++ b/providers/quickbooks/session_test.go @@ -35,7 +35,7 @@ func Test_Authorize(t *testing.T) { a := assert.New(t) s := &Session{} - provider := New("client-id", "secret", "http://example.com/callback", nil, ScopeAccounting) + provider := New("client-id", "secret", "http://example.com/callback", false, ScopeAccounting) _, err := s.Authorize(provider, &mockParams{params: map[string]string{"code": "test_code"}}) a.Error(err) } From 6f9faedfc5e6a5d129dfb01909d0cb8e3cf91a54 Mon Sep 17 00:00:00 2001 From: Isaac Wengler Date: Mon, 26 May 2025 23:48:39 -0400 Subject: [PATCH 3/3] set raw data --- providers/quickbooks/quickbooks.go | 45 ++++++++++++++++++++---------- 1 file changed, 30 insertions(+), 15 deletions(-) diff --git a/providers/quickbooks/quickbooks.go b/providers/quickbooks/quickbooks.go index d4543588..92d29162 100644 --- a/providers/quickbooks/quickbooks.go +++ b/providers/quickbooks/quickbooks.go @@ -1,8 +1,10 @@ package quickbooks import ( + "bytes" "encoding/json" "fmt" + "io" "net/http" "strings" @@ -85,6 +87,10 @@ func (Provider) UnmarshalSession(data string) (goth.Session, error) { func (p Provider) FetchUser(session goth.Session) (goth.User, error) { s := session.(*Session) + user := goth.User{ + Provider: p.Name(), + } + if s.AccessToken == "" { return goth.User{}, fmt.Errorf("no access token obtained for session with provider %s", p.Name()) } @@ -102,33 +108,42 @@ func (p Provider) FetchUser(session goth.Session) (goth.User, error) { defer resp.Body.Close() if resp.StatusCode != http.StatusOK { - return goth.User{}, fmt.Errorf("failed to get user info: %d", resp.StatusCode) + return user, fmt.Errorf("failed to get user info: %d", resp.StatusCode) + } + + bits, err := io.ReadAll(resp.Body) + if err != nil { + return user, err } - var userInfo struct { + u := struct { Sub string `json:"sub"` Email string `json:"email"` EmailVerified bool `json:"email_verified"` Name string `json:"name"` GivenName string `json:"given_name"` FamilyName string `json:"family_name"` + }{} + + if err := json.NewDecoder(bytes.NewReader(bits)).Decode(&u); err != nil { + return user, err } - if err := json.NewDecoder(resp.Body).Decode(&userInfo); err != nil { - return goth.User{}, err + user.UserID = u.Sub + user.Email = u.Email + user.Name = u.Name + user.FirstName = u.GivenName + user.LastName = u.FamilyName + user.AccessToken = s.AccessToken + user.RefreshToken = s.RefreshToken + user.ExpiresAt = s.ExpiresAt + + err = json.NewDecoder(bytes.NewReader(bits)).Decode(&user.RawData) + if err != nil { + return user, err } - return goth.User{ - Provider: p.Name(), - UserID: userInfo.Sub, - Email: userInfo.Email, - Name: userInfo.Name, - FirstName: userInfo.GivenName, - LastName: userInfo.FamilyName, - AccessToken: s.AccessToken, - RefreshToken: s.RefreshToken, - ExpiresAt: s.ExpiresAt, - }, nil + return user, err } func (Provider) Debug(bool) {}