A Swift wrapper for the Strava API v3
Clone or download
mpclarkson Merge pull request #9 from tkikuchi2000/Swift-4.0
Convert to Swift 4.0 (Xcode9 beta6)
Latest commit bc5a96d Sep 4, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Example fixed TravisCI config Aug 31, 2017
StravaSwift make all enum members lowercase to comply with Swift 3 API design gui… Aug 29, 2017
.gitignore docs May 25, 2016
.travis.yml fixed TravisCI config Aug 31, 2017
LICENSE Created a new project May 24, 2016
README.md codebeat badge Jun 1, 2016
StravaSwift.podspec updated podspec Jan 28, 2017
_Pods.xcodeproj Initial commit May 24, 2016

README.md

StravaSwift

CI Status codebeat badge Version License Platform

This is a Swift wrapper for the Strava v3 API.

As this is a passion project, I only work on it when I have time. So, if you are interested in contributing, feel free to submit PRs.

Example

To run the example project, clone the repo, and run pod install from the Example directory first.

Installation

StravaSwift is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "StravaSwift"

Quick Start

The full library documentation is available here.

  • First, you must register your app with Strava and get an oAuth client id and client secret.

  • Initialize the Strava Client as follows, preferably in your AppDelegate.swift to ensure it is configured before you call it:

let config = StravaConfig(
    clientId: YourStravaClientId,
    clientSecret: YourStravaClientSecret,
    redirectUri: YourRedirectUrl
)

StravaClient.sharedInstance.initWithConfig(config)
  • Note, by default the oAuth token is only available while the app is running, which means you need to request a new token. You can implement custom token storage and retrieval behaviour by overriding the default token delegate in the StravaConfig initializer which must implement the TokenDelegate protocol.

  • Register your redirect URL scheme in your info.plist.

  • Implement the following method in your AppDelegate.swift to handle the oAuth redirection from Strava:

func application(application: UIApplication, openURL url: NSURL, sourceApplication: String?, annotation: AnyObject) -> Bool {
    guard let code = strava?.handleAuthorizationRedirect(url) else { return false }
    //Exchange the code for a token
    strava.getAccessToken(code) { token in
        //Do something if you want, but the token is already available to the
        //StravaClient thanks to the TokenDelegate
    }
    return true
}
  • Now you can start requesting resources.

The Router implementation is based on this Alamofire example:

let strava = StravaClient.sharedInstance

strava.request(Router.Athletes(id: 9999999999)) { (athlete: Athlete?) in
    //do something with the athlete
}

let params = [
    'page' = 2,
    'per_page' = 25
]

strava.request(Router.AthleteActivities(params: params) { (activities: [Activity]?) in
   //do something with the activities
}

Todos

  • 100% API coverage (about 90% now)
  • Documentation
  • Tests
  • Better example app

Author

Matthew Clarkson, mpclarkson@gmail.com

License

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