reddift
reddift is Swift Reddit API Wrapper.
- Supports OAuth2(is not supported on tvOS currently).
- Supports multi-accounts.
- Includes a sample application(iOS only).
Sample on iOS
Sample on tvOS
Document
How to build
Now, it's under developing. You have to pay attention to use this library.
1. Check out source code.
# check out reddift and its submodules.
> git clone --recursive https://github.com/sonsongithub/reddift.git
2. Create application(installed app) at reddit.com
Create new installed app via preference page at reddit.com.
And then, check your app's cliend_id
and fill out redirect_uri
for OAuth2.
For example, redirect_uri
is set to myapp://response
.
In following sample, redirect_uri
is set to reddift://response
.
reddift_config.json
3. Set up This JSON file saves application information to use OAuth.
Rename reddift_config.json.sample
to reddift_config.json
.
And fill out DeveloperName
, redirect_uri
and client_id
.
redirect_uri
must be same one you registered at reddit.com.
You can check client_id
at application tab.
reddift generates http's user-agent property using this JSON and application's info.plist.
{
"DeveloperName": "<YOUR NAME>",
"redirect_uri": "<YOUR REDIRECT URI>",
"client_id": "<YOUR ID>"
}
4. Set up your URI on Xcode
In Xcode, set up URL Types in order to receive call back from Safari.
Set URL Schemes
to redirect_uri
that you set at reddit.com.
You don't have to include ://response
to this form.
These URI must be identical.
If they are not identical, reddit.com does not authorize your OAuth request.
In following sample, URL Schemes
is set to reddift
.
How to build test
1. Register user script app
Test uses Application Only OAuth to remove user interaction from test process. If you want to run tests of reddift, you have to create another "Script" type application(personal use script) at reddit.com.
test_config.json
2. Fill out At first, rename test_config.json.sample
to test_config.json
.
Fill each following value using above preference pain of reddit.com.
{
"username": "test user account",
"password": "test user password",
"client_id": "test app client ID(must be script type app)",
"secret": "test app secret"
}
3. Start test
Cmd + U.
Create you app.
Get something & Error handling
reddift returns Result<T>
object as a result.
Get the value or error from Result<T>
object.
Concretely, you can access either value evaluating enum state like a following code.
// do not use "!" in your code
switch(result) {
case .Failure(let error):
println(error)
case .Success(let listing):
// do something to listing
}
In more detail about this coding style, see "Efficient JSON in Swift with Functional Concepts and Generics".
Create session
At first, you have to implement codes to receive the response of OAuth2 in UIAppDelegate
.
reddift let you save tokens as a specified name into KeyChain.
Specifically, following sample code saves token as user name at reddit.com.
func application(application: UIApplication, openURL url: NSURL, sourceApplication: String?, annotation: AnyObject) -> Bool {
return OAuth2Authorizer.sharedInstance.receiveRedirect(url, completion:{(result) -> Void in
switch result {
case .Failure(let error):
print(error)
case .Success(let token):
dispatch_async(dispatch_get_main_queue(), { () -> Void in
OAuth2TokenRepository.saveIntoKeychainToken(token, name:token.name)
})
}
})
}
To communicate with reddit.com via OAuth2, you have to create Session
object.
See following section about getting response or error handling.
let result = OAuth2TokenRepository.restoreFromKeychainWithName(name)
switch result {
case .Failure(let error):
print(error.description)
case .Success(let token):
con.session = Session(token: token)
}
You can get contents from reddit via Session
object like following codes.
session?.getList(paginator, subreddit:subreddit, sort:sortTypes[seg.selectedSegmentIndex], timeFilterWithin:.All, completion: { (result) in
switch result {
case .Failure(let error):
print(error)
case .Success(let listing):
self.links.appendContentsOf(listing.children.flatMap{$0 as? Link})
}
})
Use Application Only OAuth
You can use OAuth2AppOnlyToken
when you want to write a code for test or personal script tool(such as CLI).
OAuth2AppOnlyToken
enabled to access reddit without human action in order to authorize in web browser apps.
Do not use Oauth2AppOnlyToken
in installed app in terms of security.
OAuth2AppOnlyToken.getOAuth2AppOnlyToken(
username: username,
password: password,
clientID: clientID,
secret: secret,
completion:( { (result) -> Void in
switch result {
case .Failure(let error):
print(error)
case .Success(let token):
self.session = Session(token: token)
}
}))
Further more,
In more detail, See my sample application, test code or Playground code included in this repository.
Playground
You can play with reddift in Playground.
In more detail, check reddift.playground package.
Before using, you have to copy test_config.json
into ./reddift.playground/Resources
in order to specify user account and your application informatin because reddift on Playground uses "Application Only OAuth".
Dependency
- reddift depends on MiniKeychain for saving access tokens.
- Sample application depends on UZTextView.
License
MIT License.