move providers into providers subdirectory
All checks were successful
continuous-integration/drone/push Build is passing
All checks were successful
continuous-integration/drone/push Build is passing
This commit is contained in:
8
providers/questrade/README.md
Normal file
8
providers/questrade/README.md
Normal file
@ -0,0 +1,8 @@
|
||||
# Questrade Provider
|
||||
|
||||
A provider for Questrade using the Questrade API.
|
||||
|
||||
### Environment Variables
|
||||
|
||||
* *questrade_account_[0...]* - A series of Questrade account numbers with a suffix of _0 and each additional account counting up.
|
||||
* *questrade_ynab_account_[0...]* - The YNAB account ID for the matching questrade account. Each configured questrade account must have a matching YNAB account.
|
111
providers/questrade/account.go
Normal file
111
providers/questrade/account.go
Normal file
@ -0,0 +1,111 @@
|
||||
package questrade
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"net/url"
|
||||
"strconv"
|
||||
)
|
||||
|
||||
// Account represents an account associated with the user on behalf
|
||||
// of which the API client is authorized.
|
||||
//
|
||||
// Ref: http://www.questrade.com/api/documentation/rest-operations/account-calls/accounts
|
||||
type Account struct {
|
||||
// Type of the account (e.g., "Cash", "Margin").
|
||||
Type string `json:"type"`
|
||||
|
||||
// Eight-digit account number (e.g., "26598145")
|
||||
// Stored as a string, it's used for making account-related API calls
|
||||
Number string `json:"number"`
|
||||
|
||||
// Status of the account (e.g., Active).
|
||||
Status string `json:"status"`
|
||||
|
||||
// Whether this is a primary account for the holder.
|
||||
IsPrimary bool `json:"isPrimary"`
|
||||
|
||||
// Whether this account is one that gets billed for various expenses such as inactivity fees, market data, etc.
|
||||
IsBilling bool `json:"isBilling"`
|
||||
|
||||
// Type of client holding the account (e.g., "Individual").
|
||||
ClientAccountType string `json:"clientAccountType"`
|
||||
}
|
||||
|
||||
// Balance belonging to an Account
|
||||
//
|
||||
// Ref: http://www.questrade.com/api/documentation/rest-operations/account-calls/accounts-id-balances
|
||||
type Balance struct {
|
||||
|
||||
// Currency of the balance figure(e.g., "USD" or "CAD").
|
||||
Currency string `json:"currency"`
|
||||
|
||||
// Balance amount.
|
||||
Cash float32 `json:"cash"`
|
||||
|
||||
// Market value of all securities in the account in a given currency.
|
||||
MarketValue float32 `json:"marketValue"`
|
||||
|
||||
// Equity as a difference between cash and marketValue properties.
|
||||
TotalEquity float32 `json:"totalEquity"`
|
||||
|
||||
// Buying power for that particular currency side of the account.
|
||||
BuyingPower float32 `json:"buyingPower"`
|
||||
|
||||
// Maintenance excess for that particular side of the account.
|
||||
MaintenanceExcess float32 `json:"maintenanceExcess"`
|
||||
|
||||
// Whether real-time data was used to calculate the above values.
|
||||
IsRealTime bool `json:"isRealTime"`
|
||||
}
|
||||
|
||||
// AccountBalances represents per-currency and combined balances for a specified account.
|
||||
//
|
||||
// Ref: http://www.questrade.com/api/documentation/rest-operations/account-calls/accounts-id-balances
|
||||
type AccountBalances struct {
|
||||
PerCurrencyBalances []Balance `json:"perCurrencyBalances"`
|
||||
CombinedBalances []Balance `json:"combinedBalances"`
|
||||
SODPerCurrencyBalances []Balance `json:"sodPerCurrencyBalances"`
|
||||
SODCombinedBalances []Balance `json:"sodCombinedBalances"`
|
||||
}
|
||||
|
||||
// GetAccounts returns the logged-in User ID, and a list of accounts
|
||||
// belonging to that user.
|
||||
func (c *client) GetAccounts() (int, []Account, error) {
|
||||
list := struct {
|
||||
UserID int `json:"userId"`
|
||||
Accounts []Account `json:"accounts"`
|
||||
}{}
|
||||
|
||||
err := c.get("v1/accounts", &list, url.Values{})
|
||||
if err != nil {
|
||||
return 0, []Account{}, err
|
||||
}
|
||||
return list.UserID, list.Accounts, nil
|
||||
}
|
||||
|
||||
// GetBalances returns the balances for the account with the specified account number
|
||||
func (c *client) GetBalances(number string) (AccountBalances, error) {
|
||||
bal := AccountBalances{}
|
||||
|
||||
err := c.get("v1/accounts/"+number+"/balances", &bal, url.Values{})
|
||||
if err != nil {
|
||||
return AccountBalances{}, err
|
||||
}
|
||||
return bal, nil
|
||||
}
|
||||
|
||||
func (c *client) GetQuestradeAccountBalance(accountID int) (int, error) {
|
||||
balances, err := c.GetBalances(strconv.Itoa(accountID))
|
||||
if err != nil {
|
||||
return 0, fmt.Errorf("failed to get balances for account ID '%d': %v", accountID, err)
|
||||
}
|
||||
|
||||
for _, balance := range balances.CombinedBalances {
|
||||
if balance.Currency != "CAD" {
|
||||
continue
|
||||
}
|
||||
|
||||
return int(balance.TotalEquity) * 1000, nil
|
||||
}
|
||||
return 0, fmt.Errorf("could not find a CAD balance for this account in questade response")
|
||||
}
|
132
providers/questrade/client.go
Normal file
132
providers/questrade/client.go
Normal file
@ -0,0 +1,132 @@
|
||||
package questrade
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"strconv"
|
||||
"time"
|
||||
)
|
||||
|
||||
const loginServerURL = "https://login.questrade.com/oauth2/"
|
||||
|
||||
type LoginCredentials struct {
|
||||
AccessToken string `json:"access_token"`
|
||||
TokenType string `json:"token_type"`
|
||||
ExpiresIn int `json:"expires_in"`
|
||||
RefreshToken string `json:"refresh_token"`
|
||||
ApiServer string `json:"api_server"`
|
||||
}
|
||||
|
||||
// A client is the structure that will be used to consume the API
|
||||
// endpoints. It holds the login credentials, http client/transport,
|
||||
// rate limit information, and the login session timer.
|
||||
type client struct {
|
||||
Credentials LoginCredentials
|
||||
SessionTimer *time.Timer
|
||||
RateLimitRemaining int
|
||||
RateLimitReset time.Time
|
||||
httpClient *http.Client
|
||||
transport *http.Transport
|
||||
}
|
||||
|
||||
// authHeader is a shortcut that returns a string to be placed
|
||||
// in the authorization header of API calls
|
||||
func (l LoginCredentials) authHeader() string {
|
||||
return l.TokenType + " " + l.AccessToken
|
||||
}
|
||||
|
||||
// Send an HTTP GET request, and return the processed response
|
||||
func (c *client) get(endpoint string, out interface{}, query url.Values) error {
|
||||
req, err := http.NewRequest("GET", c.Credentials.ApiServer+endpoint+"?"+query.Encode(), nil)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
req.Header.Add("Authorization", c.Credentials.authHeader())
|
||||
|
||||
res, err := c.httpClient.Do(req)
|
||||
if err != nil {
|
||||
return fmt.Errorf("http get request failed: %v", err)
|
||||
}
|
||||
|
||||
err = c.processResponse(res, out)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// processResponse takes the body of an HTTP response, and either returns
|
||||
// the error code, or unmarshalls the JSON response, extracts
|
||||
// rate limit info, and places it into the object
|
||||
// output parameter. This function closes the response body after reading it.
|
||||
func (c *client) processResponse(res *http.Response, out interface{}) error {
|
||||
body, err := io.ReadAll(res.Body)
|
||||
res.Body.Close()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
if res.StatusCode != 200 {
|
||||
return newQuestradeError(res, body)
|
||||
}
|
||||
|
||||
err = json.Unmarshal(body, out)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
reset, _ := strconv.Atoi(res.Header.Get("X-RateLimit-Reset"))
|
||||
c.RateLimitReset = time.Unix(int64(reset), 0)
|
||||
c.RateLimitRemaining, _ = strconv.Atoi(res.Header.Get("X-RateLimit-Remaining"))
|
||||
return nil
|
||||
}
|
||||
|
||||
// Login takes the refresh token from the client login credentials
|
||||
// and exchanges it for an access token. Returns a timer that
|
||||
// expires when the login session is over.
|
||||
// TODO - Return a proper error when login fails with HTTP 400 - Bad Request
|
||||
func (c *client) login() error {
|
||||
vars := url.Values{"grant_type": {"refresh_token"}, "refresh_token": {c.Credentials.RefreshToken}}
|
||||
res, err := c.httpClient.PostForm(loginServerURL+"token", vars)
|
||||
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
err = c.processResponse(res, &c.Credentials)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
c.SessionTimer = time.NewTimer(time.Duration(c.Credentials.ExpiresIn) * time.Second)
|
||||
return nil
|
||||
}
|
||||
|
||||
// newClient is the factory function for clients - takes a refresh token and logs in
|
||||
func newClient(refreshToken string) (*client, error) {
|
||||
transport := &http.Transport{
|
||||
ResponseHeaderTimeout: 5 * time.Second,
|
||||
}
|
||||
|
||||
httpClient := &http.Client{
|
||||
Transport: transport,
|
||||
}
|
||||
|
||||
// Create a new client
|
||||
c := &client{
|
||||
Credentials: LoginCredentials{
|
||||
RefreshToken: refreshToken,
|
||||
},
|
||||
httpClient: httpClient,
|
||||
transport: transport,
|
||||
}
|
||||
|
||||
err := c.login()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
return c, nil
|
||||
}
|
40
providers/questrade/errors.go
Normal file
40
providers/questrade/errors.go
Normal file
@ -0,0 +1,40 @@
|
||||
package questrade
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"net/http"
|
||||
)
|
||||
|
||||
type QuestradeError struct {
|
||||
Code int `json:"code"`
|
||||
StatusCode int
|
||||
Message string `json:"message"`
|
||||
Endpoint string
|
||||
}
|
||||
|
||||
func newQuestradeError(res *http.Response, body []byte) QuestradeError {
|
||||
// Unmarshall the error text
|
||||
var e QuestradeError
|
||||
err := json.Unmarshal(body, &e)
|
||||
if err != nil {
|
||||
e.Code = -999
|
||||
e.Message = string(body)
|
||||
}
|
||||
|
||||
e.StatusCode = res.StatusCode
|
||||
e.Endpoint = res.Request.URL.String()
|
||||
return e
|
||||
}
|
||||
|
||||
func (q QuestradeError) Error() string {
|
||||
return fmt.Sprintf("\nQuestradeError:\n"+
|
||||
"\tStatus code: HTTP %d\n"+
|
||||
"\tEndpoint: %s\n"+
|
||||
"\tError code: %d\n"+
|
||||
"\tMessage: %s\n",
|
||||
q.StatusCode,
|
||||
q.Endpoint,
|
||||
q.Code,
|
||||
q.Message)
|
||||
}
|
147
providers/questrade/providerImpl.go
Normal file
147
providers/questrade/providerImpl.go
Normal file
@ -0,0 +1,147 @@
|
||||
package questrade
|
||||
|
||||
import (
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"strconv"
|
||||
"time"
|
||||
)
|
||||
|
||||
type persistentData struct {
|
||||
QuestradeRefreshToken string `json:"questradeRefreshToken"` // Questrade API OAuth2 refresh token
|
||||
}
|
||||
|
||||
type Provider struct {
|
||||
questradeAccountIDs []int // Slice of Questrade account numbers this provider monitors
|
||||
ynabAccountIDs []string // Slice of YNAB account ID's this provider updates - index position maps with questradeAccountIDs
|
||||
data *persistentData // Data stored on disk and loaded when program starts
|
||||
client *client // HTTP client for interacting with Questrade API
|
||||
lastRefresh time.Time
|
||||
}
|
||||
|
||||
func (p *Provider) Name() string {
|
||||
return "Questrade"
|
||||
}
|
||||
|
||||
// Configures the provider for usage via environment variables and persistentData
|
||||
// If an error is returned, the provider will not be used
|
||||
func (p *Provider) Configure() error {
|
||||
var err error
|
||||
|
||||
p.questradeAccountIDs = make([]int, 0)
|
||||
p.ynabAccountIDs = make([]string, 0)
|
||||
// Load environment variables in continous series with suffix starting at 0
|
||||
// Multiple accounts can be configured, (eg _1, _2)
|
||||
// As soon as the series is interrupted, we assume we're done
|
||||
for i := 0; true; i++ {
|
||||
questradeAccountIDString := os.Getenv(fmt.Sprintf("questrade_account_%d", i))
|
||||
ynabAccountID := os.Getenv(fmt.Sprintf("questrade_ynab_account_%d", i))
|
||||
if questradeAccountIDString == "" || ynabAccountID == "" {
|
||||
if i == 0 {
|
||||
return fmt.Errorf("this account provider is not configured")
|
||||
}
|
||||
break
|
||||
}
|
||||
questradeAccountID, err := strconv.Atoi(questradeAccountIDString)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to convert environment variable questrade_account_%d with value of '%s' to integer: %v", i, questradeAccountIDString, err)
|
||||
}
|
||||
p.questradeAccountIDs = append(p.questradeAccountIDs, questradeAccountID)
|
||||
p.ynabAccountIDs = append(p.ynabAccountIDs, ynabAccountID)
|
||||
}
|
||||
|
||||
// Load persistent data from disk - the OAuth2.0 refresh tokens are one time use
|
||||
p.data, err = loadPersistentData()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to load questrade configuration: %v", err)
|
||||
}
|
||||
|
||||
// Create new HTTP client and login to API - will error if login fails
|
||||
err = p.refresh()
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to refresh http client: %v", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// Returns slices of account balances and mapped YNAB account IDs, along with an error
|
||||
func (p *Provider) GetBalances() ([]int, []string, error) {
|
||||
// Refresh credentials if past half way until expiration
|
||||
if p.lastRefresh.Add(time.Second * time.Duration(p.client.Credentials.ExpiresIn) / 2).Before(time.Now()) {
|
||||
err := p.refresh()
|
||||
if err != nil {
|
||||
return make([]int, 0), make([]string, 0), fmt.Errorf("failed to refresh http client: %v", err)
|
||||
}
|
||||
}
|
||||
|
||||
// Gather account balances from Questrade API
|
||||
balances := make([]int, 0)
|
||||
for _, questradeAccountID := range p.questradeAccountIDs {
|
||||
balance, err := p.client.GetQuestradeAccountBalance(questradeAccountID)
|
||||
if err != nil {
|
||||
return balances, p.ynabAccountIDs, fmt.Errorf("failed to get questrade account balance for account ID '%d': %v", questradeAccountID, err)
|
||||
}
|
||||
balances = append(balances, balance)
|
||||
}
|
||||
|
||||
return balances, p.ynabAccountIDs, nil
|
||||
}
|
||||
|
||||
func (p *Provider) refresh() error {
|
||||
var err error
|
||||
// Create new HTTP client and login to API - will error if login fails
|
||||
p.client, err = newClient(p.data.QuestradeRefreshToken)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to create new questrade client: %v", err)
|
||||
}
|
||||
p.lastRefresh = time.Now()
|
||||
|
||||
// After logging in, we get a new refresh token - save it for next login
|
||||
p.data.QuestradeRefreshToken = p.client.Credentials.RefreshToken
|
||||
err = savePersistentData(p.data)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to save persistent data: %v", err)
|
||||
}
|
||||
return nil
|
||||
|
||||
}
|
||||
|
||||
// Load persistent data from disk, if it fails it initializes using environment variables
|
||||
func loadPersistentData() (*persistentData, error) {
|
||||
data := &persistentData{}
|
||||
|
||||
f, err := os.Open("data/questrade-data.json")
|
||||
if errors.Is(err, os.ErrNotExist) {
|
||||
// handle the case where the file doesn't exist
|
||||
data.QuestradeRefreshToken = os.Getenv("questrade_refresh_token")
|
||||
return data, nil
|
||||
}
|
||||
defer f.Close()
|
||||
b, err := io.ReadAll(f)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to read file data/questrade-data.json: %v", err)
|
||||
}
|
||||
|
||||
err = json.Unmarshal(b, data)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("failed to unmarshal data/questrade-data.json to PersistentData struct: %v", err)
|
||||
}
|
||||
return data, nil
|
||||
}
|
||||
|
||||
// Save persistent data to disk, this should be done any time the data changes to ensure it can be loaded on next run
|
||||
func savePersistentData(data *persistentData) error {
|
||||
b, err := json.Marshal(data)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to marshal persistentData to bytes: %v", err)
|
||||
}
|
||||
err = os.WriteFile("data/questrade-data.json", b, 0644)
|
||||
if err != nil {
|
||||
return fmt.Errorf("failed to write file data/questrade-data.json: %v", err)
|
||||
}
|
||||
return nil
|
||||
}
|
Reference in New Issue
Block a user