Skip to content

Commit f4685f5

Browse files
ryan-bergerryan-berger
authored
Classlink (#421)
1 parent 710927a commit f4685f5

File tree

5 files changed

+313
-0
lines changed

5 files changed

+313
-0
lines changed

‎README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ $ go get github.com/markbates/goth
2323
* Battle.net
2424
* Bitbucket
2525
* Box
26+
* ClassLink
2627
* Cloud Foundry
2728
* Dailymotion
2829
* Deezer

‎providers/classlink/provider.go‎

Lines changed: 156 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,156 @@
1+
package classlink
2+
3+
import (
4+
"encoding/json"
5+
"errors"
6+
"fmt"
7+
"io/ioutil"
8+
"net/http"
9+
10+
"github.com/markbates/goth"
11+
"golang.org/x/oauth2"
12+
)
13+
14+
const infoURL = "https://nodeapi.classlink.com/v2/my/info"
15+
16+
// Provider is an implementation of
17+
type Provider struct {
18+
ClientKey string
19+
ClientSecret string
20+
CallbackURL string
21+
HTTPClient *http.Client
22+
providerName string
23+
config *oauth2.Config
24+
}
25+
26+
func New(clientKey, secret, callbackURL string, scopes ...string) *Provider {
27+
prov := &Provider{
28+
ClientKey: clientKey,
29+
ClientSecret: secret,
30+
CallbackURL: callbackURL,
31+
providerName: "classlink",
32+
}
33+
prov.config = newConfig(prov, scopes)
34+
return prov
35+
}
36+
37+
func (p Provider) Client() *http.Client {
38+
return goth.HTTPClientWithFallBack(p.HTTPClient)
39+
}
40+
41+
func (p Provider) Name() string {
42+
return p.providerName
43+
}
44+
45+
func (p Provider) SetName(name string) {
46+
p.providerName = name
47+
}
48+
49+
func (p Provider) BeginAuth(state string) (goth.Session, error) {
50+
url := p.config.AuthCodeURL(state)
51+
return &Session{
52+
AuthURL: url,
53+
}, nil
54+
}
55+
56+
func (p Provider) UnmarshalSession(s string) (goth.Session, error) {
57+
var sess Session
58+
err := json.Unmarshal([]byte(s), &sess)
59+
60+
if err != nil {
61+
return nil, err
62+
}
63+
64+
return &sess, nil
65+
}
66+
67+
// classLinkUser contains all relevant fields from the ClassLink response
68+
// to
69+
type classLinkUser struct {
70+
UserID int `json:"UserId"`
71+
Email string `json:"Email"`
72+
DisplayName string `json:"DisplayName"`
73+
FirstName string `json:"FirstName"`
74+
LastName string `json:"LastName"`
75+
}
76+
77+
func (p Provider) FetchUser(session goth.Session) (goth.User, error) {
78+
sess := session.(*Session)
79+
user := goth.User{
80+
AccessToken: sess.AccessToken,
81+
Provider: p.Name(),
82+
RefreshToken: sess.RefreshToken,
83+
ExpiresAt: sess.ExpiresAt,
84+
}
85+
86+
if user.AccessToken == "" {
87+
// Data is not yet retrieved, since accessToken is still empty.
88+
return user, fmt.Errorf("%s cannot get user information without accessToken", p.providerName)
89+
}
90+
91+
req, err := http.NewRequest("GET", infoURL, nil)
92+
if err != nil {
93+
return user, err
94+
}
95+
96+
req.Header.Set("Authorization", fmt.Sprintf("Bearer %s", sess.AccessToken))
97+
98+
resp, err := p.Client().Do(req)
99+
if err != nil {
100+
return user, err
101+
}
102+
103+
defer resp.Body.Close()
104+
105+
bytes, err := ioutil.ReadAll(resp.Body)
106+
if err != nil {
107+
return user, err
108+
}
109+
110+
var u classLinkUser
111+
if err := json.Unmarshal(bytes, &user.RawData); err != nil {
112+
return user, err
113+
}
114+
115+
if err := json.Unmarshal(bytes, &u); err != nil {
116+
return user, err
117+
}
118+
119+
user.UserID = fmt.Sprintf("%d", u.UserID)
120+
user.FirstName = u.FirstName
121+
user.LastName = u.LastName
122+
user.Email = u.Email
123+
user.Name = u.DisplayName
124+
return user, nil
125+
}
126+
127+
func (p Provider) Debug(b bool) {}
128+
129+
func (p Provider) RefreshToken(refreshToken string) (*oauth2.Token, error) {
130+
return nil, errors.New("refresh token is not provided by ClassLink")
131+
}
132+
133+
func (p Provider) RefreshTokenAvailable() bool {
134+
return false
135+
}
136+
137+
func newConfig(provider *Provider, scopes []string) *oauth2.Config {
138+
c := &oauth2.Config{
139+
ClientID: provider.ClientKey,
140+
ClientSecret: provider.ClientSecret,
141+
RedirectURL: provider.CallbackURL,
142+
Endpoint: oauth2.Endpoint{
143+
AuthURL: "https://launchpad.classlink.com/oauth2/v2/auth",
144+
TokenURL: "https://launchpad.classlink.com/oauth2/v2/token",
145+
},
146+
Scopes: []string{},
147+
}
148+
149+
if len(scopes) > 0 {
150+
c.Scopes = append(c.Scopes, scopes...)
151+
} else {
152+
c.Scopes = append(c.Scopes, "profile")
153+
}
154+
155+
return c
156+
}

‎providers/classlink/provider_test.go‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
package classlink_test
2+
3+
import (
4+
"fmt"
5+
"os"
6+
"testing"
7+
8+
"github.com/markbates/goth"
9+
"github.com/markbates/goth/providers/classlink"
10+
"github.com/stretchr/testify/assert"
11+
)
12+
13+
func Test_New(t *testing.T) {
14+
t.Parallel()
15+
a := assert.New(t)
16+
17+
provider := classLinkProvider()
18+
a.Equal(provider.ClientKey, os.Getenv("CLASSLINK_KEY"))
19+
a.Equal(provider.ClientSecret, os.Getenv("CLASSLINK_SECRET"))
20+
a.Equal(provider.CallbackURL, "/foo")
21+
}
22+
23+
func Test_BeginAuth(t *testing.T) {
24+
t.Parallel()
25+
a := assert.New(t)
26+
27+
provider := classLinkProvider()
28+
session, err := provider.BeginAuth("test_state")
29+
s := session.(*classlink.Session)
30+
a.NoError(err)
31+
a.Contains(s.AuthURL, "launchpad.classlink.com/oauth2/v2/")
32+
a.Contains(s.AuthURL, fmt.Sprintf("client_id=%s", os.Getenv("GOOGLE_KEY")))
33+
a.Contains(s.AuthURL, "state=test_state")
34+
a.Contains(s.AuthURL, "scope=profile")
35+
}
36+
37+
func Test_Implements_Provider(t *testing.T) {
38+
t.Parallel()
39+
a := assert.New(t)
40+
41+
a.Implements((*goth.Provider)(nil), classLinkProvider())
42+
}
43+
44+
func Test_SessionFromJSON(t *testing.T) {
45+
t.Parallel()
46+
a := assert.New(t)
47+
48+
provider := classLinkProvider()
49+
50+
s, err := provider.UnmarshalSession(`{"AuthURL":"https://launchpad.classlink.com/oauth2/v2/","AccessToken":"1234567890"}`)
51+
a.NoError(err)
52+
session := s.(*classlink.Session)
53+
a.Equal(session.AuthURL, "https://launchpad.classlink.com/oauth2/v2/")
54+
a.Equal(session.AccessToken, "1234567890")
55+
}
56+
57+
func classLinkProvider() *classlink.Provider {
58+
return classlink.New(os.Getenv("CLASSLINK_KEY"), os.Getenv("CLASSLINK_SECRET"), "/foo")
59+
}

‎providers/classlink/session.go‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
package classlink
2+
3+
import (
4+
"encoding/json"
5+
"errors"
6+
"time"
7+
8+
"github.com/markbates/goth"
9+
)
10+
11+
type Session struct {
12+
AuthURL string
13+
AccessToken string
14+
RefreshToken string
15+
ExpiresAt time.Time
16+
}
17+
18+
func (s *Session) GetAuthURL() (string, error) {
19+
if s.AuthURL == "" {
20+
return "", errors.New(goth.NoAuthUrlErrorMessage)
21+
}
22+
return s.AuthURL, nil
23+
}
24+
25+
func (s *Session) Marshal() string {
26+
bytes, _ := json.Marshal(s)
27+
return string(bytes)
28+
}
29+
30+
func (s *Session) Authorize(provider goth.Provider, params goth.Params) (string, error) {
31+
p := provider.(*Provider)
32+
token, err := p.config.Exchange(goth.ContextForClient(p.Client()), params.Get("code"))
33+
if err != nil {
34+
return "", err
35+
}
36+
37+
if !token.Valid() {
38+
return "", errors.New("Invalid token received from provider")
39+
}
40+
41+
s.AccessToken = token.AccessToken
42+
s.RefreshToken = token.RefreshToken
43+
s.ExpiresAt = token.Expiry
44+
return token.AccessToken, err
45+
}
46+
47+
func (s *Session) String() string {
48+
return s.Marshal()
49+
}

‎providers/classlink/session_test.go‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
package classlink_test
2+
3+
import (
4+
"testing"
5+
6+
"github.com/markbates/goth"
7+
"github.com/markbates/goth/providers/classlink"
8+
"github.com/stretchr/testify/assert"
9+
)
10+
11+
func Test_ImplementsSession(t *testing.T) {
12+
t.Parallel()
13+
a := assert.New(t)
14+
s := &classlink.Session{}
15+
16+
a.Implements((*goth.Session)(nil), s)
17+
}
18+
19+
func Test_GetAuthURL(t *testing.T) {
20+
t.Parallel()
21+
a := assert.New(t)
22+
s := &classlink.Session{}
23+
24+
_, err := s.GetAuthURL()
25+
a.Error(err)
26+
27+
s.AuthURL = "/foo"
28+
29+
url, _ := s.GetAuthURL()
30+
a.Equal(url, "/foo")
31+
}
32+
33+
func Test_ToJSON(t *testing.T) {
34+
t.Parallel()
35+
a := assert.New(t)
36+
s := &classlink.Session{}
37+
38+
data := s.Marshal()
39+
a.Equal(data, `{"AuthURL":"","AccessToken":"","RefreshToken":"","ExpiresAt":"0001-01-01T00:00:00Z"}`)
40+
}
41+
42+
func Test_String(t *testing.T) {
43+
t.Parallel()
44+
a := assert.New(t)
45+
s := &classlink.Session{}
46+
47+
a.Equal(s.String(), s.Marshal())
48+
}

0 commit comments

Comments
 (0)