reddift

reddift is Swift Reddit API Wrapper framework, and includes a browser is developed using the framework.

• Supports OAuth2(is not supported on tvOS currently).
• Supports multi-accounts.
• Includes a sample application(iOS only).

Browser

• It's a typical browser of reddit.com.
• This application uses "reddift framework" in order to access reddit.com.
• Includes almost all of functions, such as image thumbnails, browsing comments, search subreddits and so on.
• If you need more features to this, please send pull requests to me.

Document

• See cocoapods.
• List of not implemented APIs

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

Check that these libraries are checked out at each path correctly.

/framework/vendor/HTMLSpecialCharacters
/framework/vendor/MiniKeychain

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

redirect_uri

redirect_uri

myapp://response

redirect_uri

reddift://response

3. Set up

reddift_config.json

This JSON file saves application information to use OAuth. Rename

reddift_config.json.sample

reddift_config.json

DeveloperName

redirect_uri

client_id

redirect_uri

client_id

{
  "DeveloperName": "",
  "redirect_uri": "",
  "client_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

redirect_uri

://response

URL Schemes

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.

2. Fill out

test_config.json

At first, rename

test_config.json.sample

test_config.json

{
  "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.

How to build browser sample

You have to build dependent frameworks using

carthage

# before open xcode project file.
> carthage update --platform iOS

carthage

/Carthage/Build/iOS/FLAnimatedImage.framework
/Carthage/Build/iOS/YouTubeGetVideoInfoAPIParser.framework
/Carthage/Build/iOS/UZTextView.framework

And, you get to edit URI types and reddift_config.json as same as the framework.

Create you app.

Get something & Error handling

reddift returns

Result

Result

// 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

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

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

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

OAuth2AppOnlyToken

Oauth2AppOnlyToken

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

./reddift.playground/Resources

Dependency

• reddift depends on MiniKeychain for saving access tokens.
• Sample application depends on UZTextView.

License

MIT License.