Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mpclarkson/stravaswift
A Swift wrapper for the Strava API v3
https://github.com/mpclarkson/stravaswift
strava swift
Last synced: 12 days ago
JSON representation
A Swift wrapper for the Strava API v3
- Host: GitHub
- URL: https://github.com/mpclarkson/stravaswift
- Owner: mpclarkson
- License: mit
- Created: 2016-05-24T01:18:14.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-03-25T02:15:54.000Z (8 months ago)
- Last Synced: 2024-04-25T06:21:10.876Z (7 months ago)
- Topics: strava, swift
- Language: Swift
- Size: 544 KB
- Stars: 98
- Watchers: 11
- Forks: 45
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# StravaSwift
[](https://travis-ci.org/mpclarkson/StravaSwift)
[](https://codebeat.co/projects/github-com-mpclarkson-stravaswift)
[](http://cocoapods.org/pods/StravaSwift)
[](http://cocoapods.org/pods/StravaSwift)
[](http://cocoapods.org/pods/StravaSwift)
This is a Swift wrapper for the [Strava v3 API](https://strava.github.io/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](https://github.com/mpclarkson/StravaSwift) is available through the [Swift Package Manager](https://swift.org/package-manager/) and [CocoaPods](http://cocoapods.org).
### Swift Package Manager
```swift
dependencies: [
.package(url: "https://github.com/mpclarkson/StravaSwift.git", from: "1.0.1")
]
```
### Cocoapods
To install it, simply add the following line to your Podfile:
```ruby
pod "StravaSwift", '~> 1.0.1'
```
## Quick Start
The full library documentation is available [here](http://cocoadocs.org/docsets/StravaSwift).
* First, you must [register your app](http://labs.strava.com/developers/) 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:
```swift
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` file.
* The authentication will use the Strava app be default if it is installed on the device. If the user does not have Strava installed, it will fallback on `SFAuthenticationSession` or `ASWebAuthenticationSession` depending on the iOS version. If your app is linked on or after iOS 9.0, you must add `strava` in you app’s `info.plist` file. It should be added as an entry fo the array under the `LSApplicationQueriesSchemes` key. Failure to do this will result in a crash when calling `canOpenUrl:`.
```xml
LSApplicationQueriesSchemes
strava
```
* Implement the following method in your `AppDelegate.swift` to handle the OAuth redirection from Strava:
```swift
let strava = StravaClient.sharedInstance
func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
return strava.handleAuthorizationRedirect(url)
}
```
* After authorizing, you can start requesting resources:
```swift
strava.authorize() { result in
switch result {
case .success(let token):
//do something for success
case .failure(let error):
//do something for error
}
}
```
* Requesting resources:
> The Router implementation is based on this
Alamofire [example](https://github.com/Alamofire/Alamofire#api-parameter-abstraction):
```swift
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, [email protected]
## License
StravaSwift is available under the MIT license. See the LICENSE file for more info.