Support OAuth API endpoints #12

aggrolite · 2015-05-05T01:34:28Z

UPDATE

This patch set has changed quite a bit since May.

Here is a little how-to on the basic features of the OAuth code:

https://gist.github.com/aggrolite/160d5be23adb9e597553

aggrolite · 2015-05-05T01:35:49Z

oauth_session.go

+	return session, nil
+}
+
+func (s *OAuthSession) newToken(postValues *url.Values) error {


This was originally broken up into a separate method with the intent of it being used by whatever does re-authorization of tokens. Or however we decide on implementing implicit grant authorization.

jzelinskie · 2015-05-07T04:01:16Z

Thanks for the WIP. I just got back from CoreOS Fest and am quite jetlagged, so you'll have to give me a bit of time to read over everything and generate a response.

aggrolite · 2015-05-07T16:14:14Z

Not a problem. I will leave comments if I make further changes.

jzelinskie · 2015-05-09T01:03:32Z

oauth_request.go

@@ -0,0 +1,53 @@
+package geddit


jzelinskie · 2015-05-09T01:07:06Z

Looks really good so far 👍

jzelinskie · 2015-10-06T19:11:32Z

@aggrolite any progress here? I've also noticed there's this library which should prove extremely useful for this

aggrolite · 2015-10-08T19:39:57Z

@jzelinskie I will update the patch soon. Thanks for linking the oauth library.

aggrolite · 2015-12-17T21:06:57Z

I'm back on this. Sorry for the delay. I'm hoping to crank out some code during Xmas.

jzelinskie · 2015-12-17T21:47:12Z

Cool -- no rush, get it done in your leisure. Have a great holiday ⛄

aggrolite · 2015-12-18T18:40:37Z

The OAuth library really simplified the code. Thanks for pointing it out.

Everything's still WIP, but I have changes to oauth_session.go pushed. For now, oauth_request.go has been removed. I might bring it back if I want to abstract any HTTP client code there. But the OAuth config really handles a lot of that already.

Next TODO's include: adding more endpoints and allowing geddit to authenticate on behalf of a user (not just for personal scripts).

We might consider scrapping the old HTTP API code. I believe it still works, but any client using it will be severely rate limited. Maybe phase it out after we're sure OAuth support is stable.

aggrolite · 2015-12-18T18:43:50Z

oauth_session.go

+
+// NewLoginSession creates a new session for those who want to log into a
+// reddit account via OAuth.
+func NewOAuthSession(username, password, useragent, clientID, clientSecret string) (*OAuthSession, error) {


I don't necessarily like passing more than a few args to functions (it's hard to remember the order without looking at documentation).

I was thinking maybe we could pass a struct or something instead.

However, I was also thinking we have two constructor functions for OAuthSession types: One for user/password tokens, and another for auth code tokens (asking for a user's permission).

edit: and currently useragent is not being used. I will fix that.

aggrolite · 2015-12-21T05:28:05Z

Sorry if I'm getting spammy. I will squash every thing neatly and rewrite the pull request body to explain the changes.

In short:

Most of the changes include API endpoint coverage - some "Me" endpoints, /api/submit support (for links and comments), and fetching subreddit listings.

I added just enough testing to mock JSON responses, that's about it so far.

I've also tinkered around with the constructor. ~~This is because I hope to add support for implicit grant authorization (along with the existing login auth method).~~ (DONE) This will let the caller decide how the token should be created (either by user/password or a auth code). Example usage for a personal script:

o, err := NewOAuthSession("client_id", "client_secret", "Descriptive UserAgent v1.0", "http://my.url")
err = o.LoginAuth("my_bot_user", "my_bot_password")
// Now we can do API calls using variable o

Notice that I've also added a parameter to the constructor which defines the use of a built-in rate limit. I was working on a bot for myself which required lots of requests, and wanted to make sure I stayed within the 60-requests-per-minute limit. I wrote a custom Roundtripper (this took a lot of Googling) which enforces the interval using a channel. Alternatively, the user can opt out and the default Transport type is used.

^ I've changed this to using a library called go-rate. Using a custom transport caused problems since the oauth2 package warns to not modify existing HTTP clients

Like I said, I'll organize everything better and do a proper write up (+docs) so that everything is crystal clear. Many of the changes come from personal taste and experimentation, so feel free to rip it all apart. I'm open to feedback always!

After a new OAuthSession type is created with NewOAuthSession(), the caller is given the choice of how the auth token should be created. The auth token is required to define the HTTP client used for API requests. Currently, LoginAuth() is the only method of token exchange. Other methods should be implemented in the future, which is why LoginAuth() does not happen by default within the constructor of OAuthSession.

Disabled by default. Accepts a time.Duration and each HTTP request must wait on interval to elapse. User can disable any existing throttling by passing 0.

When creating a new OAuthSession type, the caller can now choose between authenticating for personal use or on behalf of a user.

Personal script authentication (password credential exchange) is not issued a refresh token by Reddit's API. The caller must request a new access token after each one expires. The TokenExpiry field indicates the lifetime of a token and will help the user determine when a new access token must be created.

* Adding sort to request for comments * Minor (automatic) changes by gofmt

aggrolite · 2017-03-05T19:02:53Z

This branch is rebased onto upstream/master.

While I haven't used this branch in a while, I did fix the issue of receiving 429 too many requests response code when creating a new token. I had to supply my own transport type which implements a RoundTripper interface.

If anyone gets around to using this code, let me know of any issues...

jzelinskie

This change looks awesome! Just one minor nitpack about printing to stdout.

jzelinskie · 2017-03-06T05:08:14Z

oauth_session.go

+		o.throttle.Wait()
+	}
+
+	fmt.Println("Performing request...")


IMO, if there's going to be any output, it should be to the standard logger and only if debug is enabled.

aggrolite · 2017-03-07T23:10:26Z

Hi @jzelinskie,

Five things:

Debug output has been removed.
New endpoint wrapper added for fetching subreddits for the current user.
Squashing fixups gave me rebase hell. I have left the branch unsquashed.
I accidentally deleted my test project using this branch, but as of this morning I was able to do normal things like authenticate with user/pw, fetch subreddits, frontpage, etc.
Let me know if you have any other feedback. WIP tag removed from the title.

jzelinskie · 2017-03-09T16:20:00Z

🎉 merged 🎉

Thanks again for all your effort!

aggrolite · 2017-03-09T17:04:53Z

Thanks for your feedback!

aggrolite reviewed May 5, 2015
View reviewed changes

jzelinskie reviewed May 9, 2015
View reviewed changes

oauth_request.go Outdated

@@ -0,0 +1,53 @@

package geddit

Copy link

Owner

jzelinskie May 9, 2015

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

copyright

aggrolite force-pushed the master branch 4 times, most recently from e766f04 to 8b42116 Compare December 18, 2015 18:33

aggrolite reviewed Dec 18, 2015
View reviewed changes

aggrolite changed the title ~~First stab at OAuth~~ [WIP] First stab at OAuth Dec 19, 2015

aggrolite force-pushed the master branch from f936b65 to a6014dd Compare December 20, 2015 03:46

aggrolite force-pushed the master branch 7 times, most recently from 8e852da to 1baa3ad Compare December 23, 2015 23:34

aggrolite force-pushed the master branch from 958d0c3 to db716f8 Compare December 30, 2015 03:26

aggrolite and others added 13 commits March 5, 2017 10:58

Add basic test for OAuthSession type

c4b9d82

Add optional client-side throttling with Throttle()

59172bc

Disabled by default. Accepts a time.Duration and each HTTP request must wait on interval to elapse. User can disable any existing throttling by passing 0.

Add example usage of NewOAuthSession

43a80e9

Support implicit grant authorization

83a1c95

When creating a new OAuthSession type, the caller can now choose between authenticating for personal use or on behalf of a user.

Support CAPTCHA endpoints

c0ca459

Apply popularity sort and listing opts for Comments()

272241a

Save, Unsave, and fetch Saved comments

16f7ace

Allow Listing() to accept full options, support more My functions

24e2b3e

fixup! Add basic coverage for OAuth API endpoints

74dfd75

Add Reply

43a196a

Adding sort to Comments

a7d4612

* Adding sort to request for comments * Minor (automatic) changes by gofmt

aggrolite force-pushed the master branch from ffef4f8 to 819f08e Compare March 5, 2017 18:58

aggrolite added 2 commits March 5, 2017 11:07

fixup! Use OAuth2 to make reddit API requests

a9e9878

fixup! Use OAuth2 to make reddit API requests

579cca6

aggrolite force-pushed the master branch from 819f08e to 579cca6 Compare March 5, 2017 19:08

jzelinskie requested changes Mar 7, 2017

View reviewed changes

aggrolite added 2 commits March 7, 2017 14:09

Remove debug output.

5ca7c24

Add function for /subreddits/mine/subscriber.

afc26a1

aggrolite force-pushed the master branch from a75190c to afc26a1 Compare March 7, 2017 22:09

aggrolite changed the title ~~[WIP] First stab at OAuth~~ First stab at OAuth Mar 7, 2017

aggrolite changed the title ~~First stab at OAuth~~ Support OAuth API endpoints Mar 7, 2017

fixup! Use OAuth2 to make reddit API requests

6df3935

jzelinskie approved these changes Mar 9, 2017

View reviewed changes

jzelinskie merged commit eb88cc7 into jzelinskie:master Mar 9, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support OAuth API endpoints #12

Support OAuth API endpoints #12

aggrolite commented May 5, 2015

aggrolite May 5, 2015

jzelinskie commented May 7, 2015

aggrolite commented May 7, 2015

jzelinskie May 9, 2015

jzelinskie commented May 9, 2015

jzelinskie commented Oct 6, 2015

aggrolite commented Oct 8, 2015

aggrolite commented Dec 17, 2015

jzelinskie commented Dec 17, 2015

aggrolite commented Dec 18, 2015

aggrolite Dec 18, 2015

aggrolite commented Dec 21, 2015

aggrolite commented Mar 5, 2017

jzelinskie left a comment

jzelinskie Mar 6, 2017

aggrolite commented Mar 7, 2017

jzelinskie commented Mar 9, 2017 •

edited

Loading

aggrolite commented Mar 9, 2017

Support OAuth API endpoints #12

Support OAuth API endpoints #12

Conversation

aggrolite commented May 5, 2015

aggrolite May 5, 2015

Choose a reason for hiding this comment

jzelinskie commented May 7, 2015

aggrolite commented May 7, 2015

jzelinskie May 9, 2015

Choose a reason for hiding this comment

jzelinskie commented May 9, 2015

jzelinskie commented Oct 6, 2015

aggrolite commented Oct 8, 2015

aggrolite commented Dec 17, 2015

jzelinskie commented Dec 17, 2015

aggrolite commented Dec 18, 2015

aggrolite Dec 18, 2015

Choose a reason for hiding this comment

aggrolite commented Dec 21, 2015

aggrolite commented Mar 5, 2017

jzelinskie left a comment

Choose a reason for hiding this comment

jzelinskie Mar 6, 2017

Choose a reason for hiding this comment

aggrolite commented Mar 7, 2017

jzelinskie commented Mar 9, 2017 • edited Loading

aggrolite commented Mar 9, 2017

jzelinskie commented Mar 9, 2017 •

edited

Loading