Giter VIP home page Giter VIP logo

stravaswift's Introduction

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 the Swift Package Manager and CocoaPods.

Swift Package Manager

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:

pod "StravaSwift", '~> 1.0.1'

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 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:.

<key>LSApplicationQueriesSchemes</key>
<array>
    <string>strava</string>
</array>
  • Implement the following method in your AppDelegate.swift to handle the OAuth redirection from Strava:
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:
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:

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.

stravaswift's People

Contributors

fleetphil avatar ehmjaysee avatar lludo avatar agonzalezjr avatar mpclarkson avatar tkikuchi2000 avatar ydemartino avatar dominicholmes avatar

Stargazers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.