Merge pull request #173 from node-strava/drop-sinon

chore: drop sinon as devDep: all mocks are now through nock.

Author: wesleyschlenker

.github/workflows/on-pull-request.yml

@@ -0,0 +1,29 @@
+name: Test Suite
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x, 22.x]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Run test suite
+        run: yarn test

README.md

@@ -138,7 +138,7 @@ Example usage:
 
 ```js
 var strava = require('strava-v3');
-strava.athletes.get({id:12345},function(err,payload,limits) {
+strava.athlete.get({id:12345},function(err,payload,limits) {
     //do something with your payload, track rate limits
 });
 ```
@@ -256,26 +256,22 @@ See Strava API docs for returned data structures.
 * `strava.athlete.get(args,done)`
 * `strava.athlete.update(args,done)` // only 'weight' can be updated.
 * `strava.athlete.listActivities(args,done)` *Get list of activity summaries*
-* `strava.athlete.listRoutes(args,done)`
 * `strava.athlete.listClubs(args,done)`
 * `strava.athlete.listZones(args,done)`
 
 #### Athletes
 
-* `strava.athletes.get(args,done)` *Get a single activity. args.id is required*
 * `strava.athletes.stats(args,done)`
 
 #### Activities
 
 * `strava.activities.get(args,done)`
 * `strava.activities.create(args,done)`
 * `strava.activities.update(args,done)`
-* `strava.activities.listFriends(args,done)` -> deprecated at 2.2.0
 * `strava.activities.listZones(args,done)`
 * `strava.activities.listLaps(args,done)`
 * `strava.activities.listComments(args,done)`
 * `strava.activities.listKudos(args,done)`
-* `strava.activities.listPhotos(args,done)` -> deprecated at 2.2.0
 
 #### Clubs
 
@@ -380,14 +376,16 @@ This update maintains feature parity with the previous implementation of `reques
 ## Development
 
 This package includes a full test suite runnable via `yarn test`.
-It will both lint and run shallow tests on API endpoints.
+It will both lint and run tests on API endpoints.
 
 ### Running the tests
 
-You'll first need to supply `data/strava_config` with an `access_token` that
+Many unit tests now use nock to mock the Strava API and can run without any real credentials.
+However, some integration-style tests still expect a real token and account data.
+
+If you want to run the full test suite (including integration tests), you'll need to supply `data/strava_config` with an `access_token` that
 has both private read and write permissions. Look in `./scripts` for a tool
-to help generate this token. Going forward we plan to more testing with a mocked
-version of the Strava API so testing with real account credentials are not required.
+to help generate this token.
 
 * Make sure you've filled out all the fields in `data/strava_config`.
 * Use `strava.oauth.getRequestAccessURL({scope:"view_private,write"})` to generate the request url and query it via your browser.
@@ -408,15 +406,17 @@ data in the account:
  * Must have created at least one route
  * Most recent activity with an achievement should also contain a segment
 
-(Contributions to make the test suite more self-contained and robust by converting more tests
-to use `nock` are welcome!)
+(Parts of the test suite already use `nock` to mock the API. Contributions to convert remaining integration tests to mocks are welcome.)
 
-* You're done! Paste the new `access_token` to `data/strava_config` and go run some tests:
+You're done! Paste the new `access_token` to `data/strava_config` and run the full tests:
 
 `yarn test`.
 
 ### How the tests work
 
+- Tests use Mocha and Should.js.
+- HTTP interaction is performed with Axios; tests that mock HTTP use `nock`.
+
 Using the provided `access_token` tests will access each endpoint individually:
 
 * (For all `GET` endpoints) checks to ensure the correct type has been returned from the Strava.

axiosUtility.js

@@ -47,7 +47,7 @@ const httpRequest = async (options) => {
       data: options.body, // For request body
       responseType: options.responseType || 'json', // Support different response types
       maxRedirects: options.maxRedirects || 5, // Set max redirects
-      validateStatus: options.simple === false ? () => true : undefined // Handle 'simple' option
+      validateStatus: options.simple === false ? () => true : (status) => status >= 200 && status < 300 // Handle 'simple' option
     })
     return response.data
   } catch (error) {

index.d.ts

@@ -100,11 +100,6 @@ export interface GearRoutes {
   get(args: any, done?: Callback): Promise<any>;
 }
 
-export interface RunningRacesRoutes {
-  get(args: any, done?: Callback): Promise<any>;
-  listRaces(args: any, done?: Callback): Promise<any>;
-}
-
 export interface ClubsRoutes {
   get(args: ClubsRoutesArgs, done?: Callback): Promise<any>;
   listMembers(args: ClubsRoutesListArgs, done?: Callback): Promise<any>;
@@ -350,7 +345,6 @@ export interface Strava {
   streams: StreamsRoutes;
   uploads: UploadsRoutes;
   rateLimiting: RateLimiting;
-  runningRaces: RunningRacesRoutes;
   routes: RoutesRoutes;
   oauth: OAuthRoutes;
 }

index.js

@@ -12,7 +12,6 @@ const SegmentEfforts = require('./lib/segmentEfforts')
 const Streams = require('./lib/streams')
 const Uploads = require('./lib/uploads')
 const rateLimiting = require('./lib/rateLimiting')
-const RunningRaces = require('./lib/runningRaces')
 const Routes = require('./lib/routes')
 const PushSubscriptions = require('./lib/pushSubscriptions')
 const { axiosInstance, httpRequest } = require('./axiosUtility')
@@ -49,7 +48,6 @@ strava.client = function (token, request = httpRequest) {
   this.streams = new Streams(httpClient)
   this.uploads = new Uploads(httpClient)
   this.rateLimiting = rateLimiting
-  this.runningRaces = new RunningRaces(httpClient)
   this.routes = new Routes(httpClient)
   // No Push subscriptions on the client object because they don't use OAuth.
 }
@@ -77,7 +75,6 @@ strava.segmentEfforts = new SegmentEfforts(strava.defaultHttpClient)
 strava.streams = new Streams(strava.defaultHttpClient)
 strava.uploads = new Uploads(strava.defaultHttpClient)
 strava.rateLimiting = rateLimiting
-strava.runningRaces = new RunningRaces(strava.defaultHttpClient)
 strava.routes = new Routes(strava.defaultHttpClient)
 strava.pushSubscriptions = new PushSubscriptions(strava.defaultHttpClient)
 

lib/athlete.js

@@ -28,9 +28,6 @@ athlete.prototype.listActivities = async function (args) {
 athlete.prototype.listClubs = async function (args) {
   return await this._listHelper('clubs', args)
 }
-athlete.prototype.listRoutes = async function (args) {
-  return await this._listHelper('routes', args)
-}
 athlete.prototype.listZones = async function (args) {
   return await this._listHelper('zones', args)
 }

lib/athletes.js

@@ -3,9 +3,6 @@ var athletes = function (client) {
 }
 
 //= ==== athletes endpoint =====
-athletes.prototype.get = function (args, done) {
-  return this._listHelper('', args, done)
-}
 athletes.prototype.stats = function (args, done) {
   return this._listHelper('stats', args, done)
 }

lib/httpClient.js

@@ -188,19 +188,18 @@ HttpClient.prototype._requestHelper = async function (options) {
     }
 
     if (typeof response === 'string') {
-      // parse the raw JSON string with big-integer reviver for 16+ digit numbers
-      return JSON.parse(response, (key, value) => {
-        if (options.responseType === 'json' || options.responseType === 'formdata') {
-          return JSON.parse(response, (key, value) => {
-            if (typeof value === 'string' && /^\d{16,}$/.test(value)) {
-              return JSONbig.parse(value)
-            }
-            return value
-          })
-        } else {
-          return response
-        }
-      })
+      // If responseType is 'text', return the raw string
+      if (options.responseType === 'text') {
+        return response
+      }
+
+      // For json or formdata, parse the raw JSON string with big-integer reviver for 16+ digit numbers
+      if (options.responseType === 'json' || options.responseType === 'formdata') {
+        return JSONbig.parse(response)
+      }
+
+      // Default: return as-is
+      return response
     }
 
     // response is not a string or object return it

lib/runningRaces.js

@@ -3,6 +3,9 @@ var streams = function (client) {
 }
 
 var _qsAllowedProps = [
+  'keys',
+  'key_by_type',
+  'original_size',
   'resolution',
   'series_type'
 ]
@@ -31,18 +34,14 @@ streams.prototype.route = function (args, done) {
 
 //= ==== helpers =====
 streams.prototype._typeHelper = function (endpoint, args, done) {
-  var qs = this.client.getQS(_qsAllowedProps, args)
-
   // require id
   if (typeof args.id === 'undefined') {
     throw new Error('args must include an id')
   }
-  // require types
-  if (typeof args.types === 'undefined') {
-    throw new Error('args must include types')
-  }
 
-  endpoint += '/' + args.id + '/streams/' + args.types + '?' + qs
+  const qs = this.client.getQS(_qsAllowedProps, args)
+
+  endpoint += '/' + args.id + '/streams' + '?' + qs
   return this.client.getEndpoint(endpoint, args, done)
 }
 //= ==== helpers =====