Hackage :: [Package]

strive: A Haskell client for the Strava V3 API.

[ api, library, mit ] [ Propose Tags ] [ Report a vulnerability ]

A Haskell client for the Strava V3 API.

[Skip to Readme]

Downloads

Maintainer's Corner

Package maintainers

For package maintainers and hackage trustees

Candidates

Versions [RSS] 0.5.1, 0.6.0, 0.6.1, 0.6.2, 0.7.0, 0.7.1, 0.8.0, 1.0.0, 1.0.1, 2.0.0, 2.0.1, 2.1.0, 2.2.0, 2.2.1, 2.2.2, 3.0.0, 3.0.1, 3.0.2, 3.0.3, 3.0.4, 4.0.0, 4.0.1, 4.0.2, 4.0.3, 4.1.0, 5.0.0, 5.0.1, 5.0.2, 5.0.3, 5.0.4, 5.0.5, 5.0.6, 5.0.7, 5.0.8, 5.0.9, 5.0.10, 5.0.11, 5.0.12, 5.0.13, 5.0.14, 5.0.15, 5.0.16, 6.0.0.1, 6.0.0.2, 6.0.0.3, 6.0.0.4, 6.0.0.5, 6.0.0.6, 6.0.0.7, 6.0.0.9, 6.0.0.10, 6.0.0.11, 6.0.0.12, 6.0.0.13, 6.0.0.14, 6.0.0.15
Change log CHANGELOG.md
Dependencies aeson (>=0.7 && <0.8), base (>=4 && <5), bytestring (>=0.10 && <0.11), data-default (>=0.5 && <0.6), gpolyline (>=0.1 && <0.2), http-conduit (>=2 && <3), http-types (>=0.8 && <0.9), text (>=0.11 && <0.12), time (>=1 && <2) [details]
Tested with ghc ==7.6.3
License MIT
Copyright 2014 Taylor Fausak <taylor@fausak.me>
Author Taylor Fausak
Maintainer taylor@fausak.me
Category API
Home page http://taylor.fausak.me/strive/
Bug tracker https://github.com/tfausak/strive/issues
Source repo head: git clone git://github.com/tfausak/strive.git
Uploaded by fozworth at 2014-07-08T18:36:43Z
Distributions LTSHaskell:6.0.0.12, NixOS:6.0.0.12, Stackage:6.0.0.15
Reverse Dependencies 1 direct, 0 indirect [details]
Downloads 25762 total (14 in the last 30 days)
Rating (no votes yet) [estimated by Bayesian average]
Your Rating
  • λ
  • λ
  • λ
Status Docs available [build log]
Successful builds reported [all 1 reports]

Readme for strive-0.5.1

[back to package description]

Strive

Build Status

A Haskell client for the Strava V3 API.

Installation

Add it to your Cabal file:

library
  build-depends:
    strive ==0.5.*

Or install it manually:

$ cabal update
$ cabal install strive

This package uses Semantic Versioning.

Usage

To use the API, you'll need an access token. Once you have that, create a new client using the default HTTP manager.

import Strive
let token = "..."
client <- buildClient token

Most types implement lenses for their fields. Lenses are preferred over directly accessing the fields. For instance, instead of doing this:

client_accessToken (client { client_accessToken = "..." })
-- "..."

Do this:

get accessToken (set accessToken "..." client)
-- "..."

Authentication

Request access

  let authorizeUrl = buildAuthorizeUrl 1790 "http://localhost" ?
        [ set approvalPrompt False
        , set privateScope   True
        , set writeScope     True
        , set state          "..."
        ]
  print (authorizeUrl :: String)

Token exchange

  tokenExchangeResponse <- exchangeToken 1790 "secret" "code"
  print (tokenExchangeResponse :: Either String TokenExchangeResponse)

Deauthorization

  deauthorizationResponse <- deauthorize client
  print (deauthorizationResponse :: Either String DeauthorizationResponse)

Athletes

Retrieve current athlete

  currentAthlete <- getCurrentAthlete client
  print (currentAthlete :: Either String AthleteDetailed)

Retrieve another athlete

  anotherAthlete <- getAthlete client 65516
  print (anotherAthlete :: Either String AthleteSummary)

Update current athlete

  updatedAthlete <- updateCurrentAthlete client ?
    [ set city    (Just "Dallas")
    , set state   (Just "Texas")
    , set country (Just "United States")
    , set sex     (Just 'M')
    , set weight  (Just 72.57)
    ]
  print (updatedAthlete :: Either String AthleteDetailed)

List athlete K/QOMs/CRs

  athleteCrs <- getAthleteCrs client 65516 ?
    [ set page    1
    , set perPage 2
    ]
  print (athleteCrs :: Either String [EffortDetailed])

Friends and followers

List athlete friends

  currentFriends <- getCurrentFriends client ?
    [ set page    1
    , set perPage 2
    ]
  print (currentFriends :: Either String [AthleteSummary])

  friends <- getFriends client 65516 ?
    [ set page    1
    , set perPage 2
    ]
  print (friends :: Either String [AthleteSummary])

List athlete followers

  currentFollowers <- getCurrentFollowers client ?
    [ set page    1
    , set perPage 2
    ]
  print (currentFollowers :: Either String [AthleteSummary])

  followers <- getFollowers client 65516 ?
    [ set page    1
    , set perPage 2
    ]
  print (followers :: Either String [AthleteSummary])

List both following

  commonFriends <- getCommonFriends client 65516 ?
    [ set page    1
    , set perPage 2
    ]
  print (commonFriends :: Either String [AthleteSummary])

Activities

Create an activity

  createdActivity <- createActivity client "An Example" "run" (UTCTime (fromGregorian 1970 0 0) 0) 10 ?
    [ set description (Just "...")
    , set distance    (Just 100.0)
    ]
  print (createdActivity :: Either String ActivityDetailed)

Retrieve an activity

  activity <- getActivity client 141273622 ?
    [ set allEfforts True
    ]
  print (activity :: Either String ActivitySummary)

Update an activity

  updatedActivity <- updateActivity client 141273622 ?
    [ set name        (Just "WedEx Pit Stop")
    , set type_       (Just "Ride")
    , set private     (Just False)
    , set commute     (Just True)
    , set trainer     (Just False)
    , set gearId      (Just "b387882")
    , set description Nothing
    ]
  print (updatedActivity :: Either String ActivityDetailed)

Delete an activity

  nothing <- deleteActivity client 162674281
  print (nothing :: Either String ())

List athlete activities

  currentActivities <- getCurrentActivities client ?
    [ set before  (Just (UTCTime (fromGregorian 1970 0 0) 0))
    , set after   (Just (UTCTime (fromGregorian 1970 0 0) 0))
    , set page    1
    , set perPage 2
    ]
  print (currentActivities :: Either String [ActivitySummary])

List friends' activities

  feed <- getFeed client ?
    [ set page    1
    , set perPage 2
    ]
  print (feed :: Either String [ActivitySummary])

List activity zones

  activityZones <- getActivityZones client 141273622
  print (activityZones :: Either String [ActivityZoneDetailed])

List activity laps

  activityLaps <- getActivityLaps client 141273622
  print (activityLaps :: Either String [ActivityLapSummary])

Comments

List activity comments

  activityComments <- getActivityComments client 90112360 ?
    [ set markdown True
    , set page     1
    , set perPage  2
    ]
  print (activityComments :: Either String [CommentSummary])

Kudos

List activity kudoers

  activityKudoers <- getActivityKudoers client 141273622 ?
    [ set page    1
    , set perPage 2
    ]
  print (activityKudoers :: Either String [AthleteSummary])

Photos

List activity photos

  activityPhotos <- getActivityPhotos client 141273622
  print (activityPhotos :: Either String [PhotoSummary])

Clubs

Retrieve a club

  club <- getClub client 11193
  print (club :: Either String ClubDetailed)

List athlete clubs

  currentClubs <- getCurrentClubs client
  print (currentClubs :: Either String [ClubSummary])

List club members

  clubMembers <- getClubMembers client 11193 ?
    [ set page    1
    , set perPage 2
    ]
  print (clubMembers :: Either String [AthleteSummary])

List club activities

  clubActivities <- getClubActivities client 11193 ?
    [ set page    1
    , set perPage 2
    ]
  print (clubActivities :: Either String [ActivitySummary])

Gear

Retrieve gear

  theGear <- getGear client "b387855"
  print (theGear :: Either String GearDetailed)

Segments

Retrieve a segment

  theSegment <- getSegment client 4773104
  print (theSegment :: Either String SegmentDetailed)

List starred segments

  starredSegments <- getStarredSegments client ?
    [ set page    1
    , set perPage 2
    ]
  print (starredSegments :: Either String [SegmentSummary])

List efforts

  theSegmentEfforts <- getSegmentEfforts client 4773104 ?
    [ set athleteId (Just 65516)
    , set range     (Just ((UTCTime (fromGregorian 1970 0 0) 0), (UTCTime (fromGregorian 1970 0 0) 0)))
    , set page      1
    , set perPage   2
    ]
  print (theSegmentEfforts :: Either String [EffortDetailed])

Segment leaderboard

  segmentLeaderboardResponse <- getSegmentLeaderboard client 4773104 ?
    [ set gender      (Just 'M')
    , set ageGroup    (Just "0_24")
    , set weightClass (Just "65_74")
    , set following   (Just True)
    , set clubId      (Just 11193)
    , set dateRange   (Just "this_year")
    , set page        1
    , set perPage     2
    ]
  print (segmentLeaderboardResponse :: Either String SegmentLeaderboardResponse)

Segment explorer

  segmentExplorerResponse <- exploreSegments client (32.0, -96.0, 33.0, -95.0) ?
    [ set activityType "riding"
    , set minCat 0
    , set maxCat 5
    ]
  print (segmentExplorerResponse :: Either String SegmentExplorerResponse)

Segment efforts

Retrieve a segment effort

  segmentEffort <- getSegmentEffort client 1595370098
  print (segmentEffort :: Either String EffortDetailed)

Streams

Retrieve activity streams

  activityStreams <- getActivityStreams client 141273622 ["latlng", "watts"] ?
    [ set resolution (Just "low")
    , set seriesType "time"
    ]
  print (activityStreams :: Either String [StreamDetailed])

Retrieve effort streams

  effortStreams <- getEffortStreams client 1595370098 ["latlng", "watts"] ?
    [ set resolution (Just "low")
    , set seriesType "time"
    ]
  print (effortStreams :: Either String [StreamDetailed])

Retrieve segment streams

  segmentStreams <- getSegmentStreams client 4773104 ["latlng", "watts"] ?
    [ set resolution (Just "low")
    , set seriesType "time"
    ]
  print (segmentStreams :: Either String [StreamDetailed])

Uploads

Upload an activity

  uploadedActivity <- uploadActivity client (pack "...") "gpx.gz" ?
    [ set activityType (Just "ride")
    , set name         (Just "An Example")
    , set description  (Just "...")
    , set private      True
    , set trainer      False
    , set externalId   (Just "...")
    ]
  print (uploadedActivity :: Either String UploadStatus)

Check upload status

  upload <- getUpload client 16486788
  print (upload :: Either String UploadStatus)