dblock / strava-ruby-cli

Strava command-line client.

Strava Command-Line Client

A command-line client for Strava Strava API v3.

Table of Contents

• Installation
• Usage
  • Authentication
  • Run Commands
  • Strava Console
• Contributing
• Copyright and License

Installation

gem install 'strava-ruby-cli'

Usage

Authentication

Strava commands require a Strava Client ID and Client Secret from Your API Application. The command-line tool with prompt you for these or you can supply them with --client_id and --client_secret options. You can also adjust access scope with --scope.

The client will fetch an access token. This will open a new browser window, navigate to Strava, request the appropriate permissions, then handle OAuth in a local redirect. The token type, refresh token, access token and token expiration will be displayed in the browser and subsequently used.

You can note the access token and supply it via --access_token to avoid being prompted in the future.

Run Commands

Use strava run to execute commands against the Strava API. Everything in strava-ruby-client is supported.

$ strava run athlete.username

dblockdotorg

Because this is Ruby, you can could fetch all currently logged-in athlete attributes in JSON.

$ strava run athlete.to_json

{"id":26462176,"username":"dblockdotorg", ...}

To retrieve activities you need the activity:read scope.

$ strava --scope=activity:read run athlete_activities.first.name

TCS NYC Marathon 2018

Strava Console

Use strava console to explore the Strava API interactively.

$ strava console

Strava> athlete.name

"Daniel Doubrovkine"

Contributing

See CONTRIBUTING.

Copyright and License

Copyright (c) 2019, Daniel Doubrovkine and Contributors.

This project is licensed under the MIT License.

strava-ruby-cli's Issues

Missing specs

Lots of CLI specs are pending. CLI is a bit difficult to test, but not impossible.

First-time usage, CLI hanging during authentication (Linux)

👋 Hi!

I'm excited to give this a shot, but I'm having trouble getting authentication to work.

I've created an API id and secret in Strava; installed Ruby 2.5.5 and the CLI through rubygems, but any attempt at authentication hangs after entering my credentials:

Here's where it hangs:

matt@penguin:~$ strava run athlete
[2020-05-31 13:00:42] INFO  WEBrick 1.4.2
[2020-05-31 13:00:42] INFO  ruby 2.5.5 (2019-03-15) [aarch64-linux-gnu]
Enter Strava client ID: *****
Enter Strava client secret: ****************************************
[2020-05-31 13:00:52] INFO  WEBrick::HTTPServer#start: pid=12884 port=4242

Hitting ctrl+c results in an ^Cerror: Authorization Error message.

I've tried this on a few Linux workstations (WSL2 Linux container running Debian 10, a "native" Ubuntu 20.04, and a Chromebook crostini container on Debian 10); all with the same result.

Have you seen this error before, maybe I'm missing something in the setup process?

Ensure error if the browser can't launch

Looks like if the browser can't launch there's no error.

For the auth workflow with the cli we want to terminate the local server and fail with a clear error if that's the case.