README.md

OAuthSwift

Swift based OAuth library for iOS and OSX.

Support OAuth1.0, OAuth2.0

Twitter, Flickr, Github, Instagram, Foursquare. Fitbit, Withings, Linkedin, Dropbox, Dribbble, Salesforce, BitBucket, GoogleDrive, Smugmug, Intuit, Zaim, Tumblr, Slack, Uber, Gitter, Facebook, Spotify, Typetalk etc

Installation

OAuthSwift is packaged as a Swift framework. Currently this is the simplest way to add it to your app:

• Drag OAuthSwift.xcodeproj to your project in the Project Navigator.
• Select your project and then your app target. Open the Build Phases panel.
• Expand the Target Dependencies group, and add OAuthSwift framework.
• import OAuthSwift whenever you want to use OAuthSwift.

Support Carthage

• Install Carthage (https://github.com/Carthage/Carthage)
• Create Cartfile file

github "OAuthSwift/OAuthSwift" ~> 0.5.0

• Run carthage update.
• On your application targets’ “General” settings tab, in the “Embedded Binaries” section, drag and drop OAuthSwift.framework from the Carthage/Build/iOS folder on disk.

Support CocoaPods

• Podfile

platform :ios, '8.0'
use_frameworks!

pod "OAuthSwift", "~> 0.5.0"

How to

Setting URL Schemes

Replace oauth-swift by your application name

Examples

Handle URL in AppDelegate

• On iOS9 implement UIApplicationDelegate method

func application(app: UIApplication, openURL url: NSURL, options: [String : AnyObject]) -> Bool {
  if (url.host == "oauth-callback") {
    OAuthSwift.handleOpenURL(url)
  }
  return true
}

⚠️ Any other application may try to open a URL with your url scheme. So you can check the source application, for instance for safari controller :

if (options["UIApplicationOpenURLOptionsSourceApplicationKey"] as? String == "com.apple.SafariViewService") {

• On previous iOS version

func application(application: UIApplication, openURL url: NSURL, sourceApplication: String?, annotation: AnyObject) -> Bool {

• On OSX you must register an handler on NSAppleEventManager for event type kAEGetURL (see demo code)

OAuth1.0

let oauthswift = OAuth1Swift(
    consumerKey:    "********",
    consumerSecret: "********",
    requestTokenUrl: "https://api.twitter.com/oauth/request_token",
    authorizeUrl:    "https://api.twitter.com/oauth/authorize",
    accessTokenUrl:  "https://api.twitter.com/oauth/access_token"
)
oauthswift.authorizeWithCallbackURL(
    NSURL(string: "oauth-swift://oauth-callback/twitter")!,
    success: { credential, response, parameters in
      print(credential.oauth_token)
      print(credential.oauth_token_secret)
      print(parameters["user_id"])
    },
    failure: { error in
      print(error.localizedDescription)
    }             
)

OAuth2.0

let oauthswift = OAuth2Swift(
    consumerKey:    "********",
    consumerSecret: "********",
    authorizeUrl:   "https://api.instagram.com/oauth/authorize",
    responseType:   "token"
)
oauthswift.authorizeWithCallbackURL(
    NSURL(string: "oauth-swift://oauth-callback/instagram")!,
    scope: "likes+comments", state:"INSTAGRAM",
    success: { credential, response, parameters in
      print(credential.oauth_token)
    },
    failure: { error in
      print(error.localizedDescription)
    }
)

See demo for more examples

Handle authorize URL

The authorize URL allow user to connect to a provider and give access to your application.

By default this URL is opened into the external web browser (ie. safari), but apple don't allow it for app-store iOS application.

To change this behavior you must set an OAuthSwiftURLHandlerType, simple protocol to handle an NSURL

oauthswift.authorize_url_handler = ..

For instance you can embed a web view into your application by providing a controller that display a web view (UIWebView, WKWebView). Then this controller must implement OAuthSwiftURLHandlerType to load the URL into the web view

func handle(url: NSURL) {
  let req = NSURLRequest(URL: targetURL)
  self.webView.loadRequest(req)
  ...

and present the view (presentViewController, performSegueWithIdentifier, ...) You can extends OAuthWebViewController for a default implementation of view presentation and dismiss

Use the SFSafariViewController (iOS9)

A default implementation of OAuthSwiftURLHandlerType is provided using the SFSafariViewController, with automatic view dismiss.

oauthswift.authorize_url_handler = SafariURLHandler(viewController: self)

Of course you can create your own class or customize the controller by setting the variable SafariURLHandler#factory.

Make signed request

oauthswift.client.get("https://api.linkedin.com/v1/people/~",
      success: {
        data, response in
        let dataString = NSString(data: data, encoding: NSUTF8StringEncoding)
        print(dataString)
      }
      , failure: { error in
        print(error)
      }
)
// same with request method
oauthswift.client.request("https://api.linkedin.com/v1/people/~", .GET,
      parameters: [:], headers: [:],
      success: { ...

More examples into demo application: ViewController.swift

OAuth provider pages

• Twitter
• Flickr
• Github
• Instagram
• Foursquare
• Fitbit
• Withings
• Linkedin
• Dropbox
• Dribbble
• Salesforce
• BitBucket
• GoogleDrive
• Smugmug
• Intuit
• Zaim
• Tumblr
• Slack
• Uber
• Gitter
• Facebook
• Spotify
• Trello
• Buffer
• Goodreads
• Typetalk

Images

Contributing

See CONTRIBUTING.md

Add a new service in demo app

License

OAuthSwift is available under the MIT license. See the LICENSE file for more info.