|
| 1 | +// Package strava implements the OAuth2 protocol for authenticating users through Strava. |
| 2 | +// This package can be used as a reference implementation of an OAuth2 provider for Goth. |
| 3 | +package strava |
| 4 | + |
| 5 | +import ( |
| 6 | + "bytes" |
| 7 | + "encoding/json" |
| 8 | + "fmt" |
| 9 | + "github.com/markbates/goth" |
| 10 | + "golang.org/x/oauth2" |
| 11 | + "io" |
| 12 | + "io/ioutil" |
| 13 | + "net/http" |
| 14 | + "net/url" |
| 15 | +) |
| 16 | + |
| 17 | +const ( |
| 18 | + authURL string = "https://www.strava.com/oauth/authorize" |
| 19 | + tokenURL string = "https://www.strava.com/oauth/token" |
| 20 | + endpointProfile string = "https://www.strava.com/api/v3/athlete" |
| 21 | +) |
| 22 | + |
| 23 | +// New creates a new Strava provider, and sets up important connection details. |
| 24 | +// You should always call `strava.New` to get a new Provider. Never try to create |
| 25 | +// one manually. |
| 26 | +func New(clientKey, secret, callbackURL string, scopes ...string) *Provider { |
| 27 | + p := &Provider{ |
| 28 | + ClientKey: clientKey, |
| 29 | + Secret: secret, |
| 30 | + CallbackURL: callbackURL, |
| 31 | + providerName: "strava", |
| 32 | + } |
| 33 | + p.config = newConfig(p, scopes) |
| 34 | + return p |
| 35 | +} |
| 36 | + |
| 37 | +// Provider is the implementation of `goth.Provider` for accessing Strava. |
| 38 | +type Provider struct { |
| 39 | + ClientKey string |
| 40 | + Secret string |
| 41 | + CallbackURL string |
| 42 | + HTTPClient *http.Client |
| 43 | + config *oauth2.Config |
| 44 | + providerName string |
| 45 | +} |
| 46 | + |
| 47 | +// Name is the name used to retrieve this provider later. |
| 48 | +func (p *Provider) Name() string { |
| 49 | + return p.providerName |
| 50 | +} |
| 51 | + |
| 52 | +// SetName is to update the name of the provider (needed in case of multiple providers of 1 type) |
| 53 | +func (p *Provider) SetName(name string) { |
| 54 | + p.providerName = name |
| 55 | +} |
| 56 | + |
| 57 | +// Client returns an HTTP client to be used in all fetch operations. |
| 58 | +func (p *Provider) Client() *http.Client { |
| 59 | + return goth.HTTPClientWithFallBack(p.HTTPClient) |
| 60 | +} |
| 61 | + |
| 62 | +// Debug is a no-op for the strava package. |
| 63 | +func (p *Provider) Debug(debug bool) {} |
| 64 | + |
| 65 | +// BeginAuth asks Strava for an authentication endpoint. |
| 66 | +func (p *Provider) BeginAuth(state string) (goth.Session, error) { |
| 67 | + authUrl := p.config.AuthCodeURL(state) |
| 68 | + session := &Session{ |
| 69 | + AuthURL: authUrl, |
| 70 | + } |
| 71 | + return session, nil |
| 72 | +} |
| 73 | + |
| 74 | +// FetchUser will go to Strava and access basic information about the user. |
| 75 | +func (p *Provider) FetchUser(session goth.Session) (goth.User, error) { |
| 76 | + sess := session.(*Session) |
| 77 | + user := goth.User{ |
| 78 | + AccessToken: sess.AccessToken, |
| 79 | + Provider: p.Name(), |
| 80 | + RefreshToken: sess.RefreshToken, |
| 81 | + ExpiresAt: sess.ExpiresAt, |
| 82 | + } |
| 83 | + |
| 84 | + if user.AccessToken == "" { |
| 85 | + // data is not yet retrieved since accessToken is still empty |
| 86 | + return user, fmt.Errorf("%s cannot get user information without accessToken", p.providerName) |
| 87 | + } |
| 88 | + |
| 89 | + reqUrl := fmt.Sprint(endpointProfile, |
| 90 | + "?access_token=", url.QueryEscape(sess.AccessToken), |
| 91 | + ) |
| 92 | + response, err := p.Client().Get(reqUrl) |
| 93 | + if err != nil { |
| 94 | + return user, err |
| 95 | + } |
| 96 | + defer response.Body.Close() |
| 97 | + |
| 98 | + if response.StatusCode != http.StatusOK { |
| 99 | + return user, fmt.Errorf("%s responded with a %d trying to fetch user information", p.providerName, response.StatusCode) |
| 100 | + } |
| 101 | + |
| 102 | + bits, err := ioutil.ReadAll(response.Body) |
| 103 | + if err != nil { |
| 104 | + return user, err |
| 105 | + } |
| 106 | + |
| 107 | + err = json.NewDecoder(bytes.NewReader(bits)).Decode(&user.RawData) |
| 108 | + if err != nil { |
| 109 | + return user, err |
| 110 | + } |
| 111 | + |
| 112 | + err = userFromReader(bytes.NewReader(bits), &user) |
| 113 | + return user, err |
| 114 | +} |
| 115 | + |
| 116 | +func userFromReader(reader io.Reader, user *goth.User) error { |
| 117 | + u := struct { |
| 118 | + ID int64 `json:"id"` |
| 119 | + Username string `json:"username"` |
| 120 | + FirstName string `json:"firstname"` |
| 121 | + LastName string `json:"lastname"` |
| 122 | + City string `json:"city"` |
| 123 | + Region string `json:"state"` |
| 124 | + Country string `json:"country"` |
| 125 | + Gender string `json:"sex"` |
| 126 | + Picture string `json:"profile"` |
| 127 | + }{} |
| 128 | + |
| 129 | + err := json.NewDecoder(reader).Decode(&u) |
| 130 | + if err != nil { |
| 131 | + return err |
| 132 | + } |
| 133 | + |
| 134 | + user.UserID = fmt.Sprintf("%d", u.ID) |
| 135 | + user.Name = fmt.Sprintf("%s %s", u.FirstName, u.LastName) |
| 136 | + user.FirstName = u.FirstName |
| 137 | + user.LastName = u.LastName |
| 138 | + user.NickName = u.Username |
| 139 | + user.AvatarURL = u.Picture |
| 140 | + user.Description = fmt.Sprintf(`{"gender":"%s"}`, u.Gender) |
| 141 | + user.Location = fmt.Sprintf(`{"city":"%s","region":"%s","country":"%s"}`, u.City, u.Region, u.Country) |
| 142 | + |
| 143 | + return err |
| 144 | +} |
| 145 | + |
| 146 | +func newConfig(provider *Provider, scopes []string) *oauth2.Config { |
| 147 | + c := &oauth2.Config{ |
| 148 | + ClientID: provider.ClientKey, |
| 149 | + ClientSecret: provider.Secret, |
| 150 | + RedirectURL: provider.CallbackURL, |
| 151 | + Endpoint: oauth2.Endpoint{ |
| 152 | + AuthURL: authURL, |
| 153 | + TokenURL: tokenURL, |
| 154 | + }, |
| 155 | + Scopes: []string{}, |
| 156 | + } |
| 157 | + |
| 158 | + if len(scopes) > 0 { |
| 159 | + for _, scope := range scopes { |
| 160 | + c.Scopes = append(c.Scopes, scope) |
| 161 | + } |
| 162 | + } else { |
| 163 | + c.Scopes = []string{"read"} |
| 164 | + } |
| 165 | + |
| 166 | + return c |
| 167 | +} |
| 168 | + |
| 169 | +// RefreshTokenAvailable refresh token is not provided by Strava |
| 170 | +func (p *Provider) RefreshTokenAvailable() bool { |
| 171 | + return true |
| 172 | +} |
| 173 | + |
| 174 | +// RefreshToken refresh token is not provided by Strava |
| 175 | +func (p *Provider) RefreshToken(refreshToken string) (*oauth2.Token, error) { |
| 176 | + token := &oauth2.Token{RefreshToken: refreshToken} |
| 177 | + ts := p.config.TokenSource(goth.ContextForClient(p.Client()), token) |
| 178 | + newToken, err := ts.Token() |
| 179 | + if err != nil { |
| 180 | + return nil, err |
| 181 | + } |
| 182 | + return newToken, err |
| 183 | +} |
0 commit comments