README
¶
Quickbooks goth Provider
An OAuth2 Code Flow Quickbooks goth provider. Inspired by the Fitbit Goth Provider.
See https://github.com/markbates/goth for more information.
Getting Started
go get github.com/munchpass/gothquickbooks
To use the provider:
// Initialize the provider
// (replace the apiCtx values with your own values)
goth.UseProviders(qb.New(apiCtx.QuickbooksClientId, apiCtx.QuickbooksSecret, apiCtx.QuickbooksRedirectUrl))
// Create your HTTP Handlers.
r.GET("/quickbooks/start", qb.OAuthStart)
r.GET("/quickbooks/callback", qb.OAuthCallback)
// You're done!
// Just go to /quickbooks to start the OAuth flow.
Documentation
¶
Overview ¶
Package quickbooks implements the OAuth protocol for authenticating users through quickbooks. This package can be used as a reference implementation of an OAuth provider for Goth.
Index ¶
- Constants
- func SetIsProd(isProd bool)
- type IDToken
- type Provider
- func (p *Provider) BeginAuth(state string) (goth.Session, error)
- func (p *Provider) Client() *http.Client
- func (p *Provider) Debug(debug bool)
- func (p *Provider) FetchUser(session goth.Session) (goth.User, error)
- func (p *Provider) Name() string
- func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error)
- func (p *Provider) RefreshTokenAvailable() bool
- func (p *Provider) SetName(name string)
- func (p *Provider) UnmarshalSession(data string) (goth.Session, error)
- type Session
Constants ¶
const ( // QuickBooks API scopes ScopeAccounting = "com.intuit.quickbooks.accounting" ScopePayment = "com.intuit.quickbooks.payment" // OpenID Connect scopes ScopeOpenID = "openid" ScopeProfile = "profile" ScopeEmail = "email" ScopePhone = "phone" ScopeAddress = "address" )
Scopes defines the available permission scopes for QuickBooks API and OpenID Connect
const PARSED_ID_TOKEN_USER_KEY = "id_token"
Use this to fetch the realm ID:
idToken, ok := user.RawData[PARSED_ID_TOKEN_USER_KEY].(IDToken)
if ok {
realmId := idToken.RealmId
...
}
This will only be specified if you specify the openid scope.
const REFRESH_TOKEN_EXPIRES_AT_USER_KEY = "refresh_token_expires_at"
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Provider ¶
type Provider struct {
ClientKey string
Secret string
CallbackURL string
HTTPClient *http.Client
// contains filtered or unexported fields
}
Provider is the implementation of `goth.Provider` for accessing quickbooks.
func New ¶
New creates a new quickbooks provider, and sets up important connection details. You should always call `quickbooks.New` to get a new Provider. Never try to create one manually.
func (*Provider) FetchUser ¶
FetchUser will go to quickbooks and access basic information about the user.
func (*Provider) RefreshToken ¶
RefreshToken get new access token based on the refresh token
func (*Provider) RefreshTokenAvailable ¶
RefreshTokenAvailable refresh token is not provided by quickbooks
type Session ¶
type Session struct {
AuthURL string
// Each token is associated with a Quickbooks realm
AccessToken string
// Each token is associated with a Quickbooks realm
RefreshToken string
AccessTokenExpiresAt time.Time
RefreshTokenExpiresAt time.Time
// Each token is associated with a Quickbooks realm
IDToken string
// Only specified if IDToken is specified
ParsedIDToken *IDToken
}
Session stores data during the auth process with quickbooks.
func (*Session) Authorize ¶
Authorize completes the authorization with quickbooks and returns the access token to be stored for future use.
func (Session) GetAuthURL ¶
GetAuthURL will return the URL set by calling the `BeginAuth` function on the quickbooks provider.
Source Files
Directories