added error code using Fault class

Author: Patrick FINKELSTEIN

README.md

@@ -8,8 +8,12 @@ https://developers.strava.com/docs/authentication/
 
 
 
-API currently supported in addition to authentication process:
-work in progress
+API currently supported:
+
+- authorize
+- token
+- deauthorize
+
 
 - getLoggedInAthlete
 - updateLoggedInAthlete (scope profile:write)
@@ -20,24 +24,27 @@ work in progress
 - getClubMembersById (no need to be member of the club)
 - getRunningRaces
 - getRunningRaceById
+- uploadActivity (including getUploadById)
 
 
 
-How to use: 
-
-Please check examples.dart for the moment
-
-https://github.com/BirdyF/strava_flutter/blob/master/example/lib/examples.dart
-
 
 How to use it
+
 1 - Create a file secret.dart to put the secret shown on  Strava settings related to your app
 https://www.strava.com/settings/api
 
 2 - In constants.dart put your appID in clientID
 
 3 - To see debug info in Strava API, set isInDebug to true in globals.dart
 
+4 - Please check examples.dart for the moment
+
+https://github.com/BirdyF/strava_flutter/blob/master/example/lib/examples.dart
+
+
+If you have any problem and need an API not yet implemented please post an new issue
+
 
 Tested on:
 - Android 4.4.2 , 4.4.23

example/README.md

@@ -1,4 +1,4 @@
-// examples to use strava_flutter
+// Examples to use strava_flutter
 import 'dart:async';
 import 'dart:io';
 import 'package:flutter/services.dart' show rootBundle;
@@ -45,14 +45,14 @@ import 'package:strava_flutter/Models/summaryActivity.dart';
 
 
     // Do authentication with the right scope
-    final strava = Strava(
+    final strava = Strava(true, // To get display info in API
          secret, 'auto');
 
     bool isAuthOk = false;
 
     isAuthOk = await strava.OAuth(clientID, "http://localhost:8080", 'activity:write', secret);
 
-    print('---> thats it!!, $isAuthOk');
+    print('---> Authentication result: $isAuthOk');
 
     Token tokenStored = await strava.getStoredToken();
 
@@ -72,54 +72,89 @@ import 'package:strava_flutter/Models/summaryActivity.dart';
   }
 
 
-
-
+///
+/// Example of dart code to use Strava API
+/// 
+/// set isInDebug to true in strava init to see the debug info 
 void example(String secret) async {
 
     bool isAuthOk = false;
 
-    final strava = Strava(
+    final strava = Strava(true,
          secret, 'auto');
 
-    isAuthOk = await strava.OAuth(clientID, "http://localhost:8080", 'activity:write', secret);
+    isAuthOk = await strava.OAuth(clientID, "http://localhost:8080", 'profile:read_all', secret);
 
     if (isAuthOk) {
 
+      // Type of expected answer:
+      // {"id":25707617,"username":"patrick_ff","resource_state":3,"firstname":"Patrick","lastname":"FF",
+      // "city":"Le Beausset","state":"Provence-Alpes-Côte d'Azur","country":"France","sex":null,"premium"
       DetailedAthlete _athlete = await strava.getLoggedInAthlete();
       if (_athlete.fault.statusCode != strava.statusOk) {
-
         print('Error in getloggedInAthlete ${_athlete.fault.statusCode}');
       }
-    
 
-      List<RunningRace> listRunningRaces = await strava.getRunningRaces("2019");
+      // Type of expected answer 
+      //  {"biggest_ride_distance":156733.0,"biggest_climb_elevation_gain":null,"recent_ride_totals":{"count":2,"distance":111427.7001953125,
+      // "moving_time":17726,"elapsed_time":23181,"elevation_gain":1354.5838375091553,"achievement_count":0},"recent_run_to
+      Stats _stats = await strava.getStats(_athlete.id);
+      if (_stats.fault.statusCode != strava.statusOk) {
+          print('Error in getloggedInAthlete ${_stats.fault.statusCode}');
+      }
+    
+      // A long list of races per city
+      // Starting by Walt Disney World Marathon
+      List<RunningRace> listRunningRaces = await strava.getRunningRaces('2019');
+      if ((listRunningRaces == null) || (listRunningRaces[0].fault.statusCode != strava.statusOk)) {
+        print('Error in getRunningRaces: ${listRunningRaces[0].fault.statusCode}');
+      }
 
       // id corresponding to BMW Berlin Marathon 29th Sept 2019
       RunningRace race = await strava.getRunningRaceById('2724');
 
-      // Change of the loggedAthlete in profile
+      // Change weight of the loggedAthlete in profile (in kg)
       DetailedAthlete athlete2 = await strava.updateLoggedInAthlete(84);
 
 
-      Gear gear = await strava.getGearById("b4366285");
-      // print('error code getGearById  ${gear.errorCode}');
-
-      Stats stats = await strava.getStats(_athlete.id);
-
-      // List<Zone> list = await strava.getLoggedInAthleteZones();
+      /// Gear should be owned by the loggedIn Athleted
+      /// Type of expected answer:
+      /// {"id":"b4366285","primary":true,"name":"Roubaix Specialized","resource_state":3,"distance":461692.0,
+      /// "brand_name":"Specialized","model_name":"Roubaix Expert","frame_type":3,"description":"So comfortable!"}
+      Gear _gear = await strava.getGearById("b4366285");
+      if (_gear.fault.statusCode != strava.statusOk) {
+         print('error code getGearById  ${_gear.fault.statusCode}');
+      }
 
+      //  You have to join this club to do the test
       final clubStravaMarseille =
-          '226910'; // You have to join this club to do the test
-
+          '226910';
+      /// Answer expected:
+      /// {"id":226910,"resource_state":3,"name":"STRAVA Marseille ",
+      /// "profile_medium":"https://dgalywyr863hv.cloudfront.net/pictures/clubs/226910/5003423/3/medium.jpg","profile":"https://dgalywyr863hv.cloudfront.net/pictures/clubs/226910/5003423/3/larg
       Club club = await strava.getClubById(clubStravaMarseille);
 
-      // Test getActivityById
-      DetailedActivity _activity = await strava.getActivityById('2131889191');
-
+    
+      /// List the member of Strava club
+      /// Expected answer (should start like this):
+      ///  [{"resource_state":2,"firstname":"Adam","lastname":"Š.","membership":"member",
+      /// "admin":false,"owner":false},{"resource_state":2,"firstname":"Alex","lastname":"M.","membership"
       List<SummaryAthlete> listMembers = await strava.getClubMembersById('1');
 
+      // List<Zone> list = await strava.getLoggedInAthleteZones();
+
       List<SummaryActivity> listSumm =
           await strava.getClubActivitiesById(clubStravaMarseille);
+
+
+       /// You have to put an id of one activity of the logged Athlete 
+       /// You can find the id of one activity looking at your web page
+       /// https://www.strava.com/activities/2130215349
+      DetailedActivity _activity = await strava.getActivityById('2130215349');
+      if (_activity.fault.statusCode != strava.statusOk) {
+        print('Error in getActivityById: ${_activity.fault.statusCode}');
+
+      }
     }
   }
 

example/lib/examples.dart

@@ -1,9 +1,6 @@
 import 'package:flutter/material.dart';
 
 
-import 'package:flutter/services.dart' show rootBundle;
-import 'package:path_provider/path_provider.dart';
-
 import 'examples.dart';
 
 import 'secret.dart'; // Store Strava app secret
@@ -43,10 +40,6 @@ class _StravaFlutterPageState extends State<StravaFlutterPage> {
   final String redirectUrl = "http://localhost:8080";
   final String scope = 'profile:write';
 
-  final strava = Strava(
-    secret, // Put your secret key in secret.dart file
-    'auto',  // Prompt strava login only when needed
-  );
 
   @override
   void initState() {
@@ -78,6 +71,11 @@ class _StravaFlutterPageState extends State<StravaFlutterPage> {
 
   void deAuthorize() async {
     // need to get authorized before (valid token)
+    final strava = Strava(
+      true,   // to get disply info in API
+      secret, // Put your secret key in secret.dart file
+      'auto',  // Prompt strava login only when needed
+    );
     await strava.deAuthorize();
   }
 
@@ -102,22 +100,7 @@ class _StravaFlutterPageState extends State<StravaFlutterPage> {
             // Working
             // Image.asset('assets/test.JPG'),
 
-            Text('Push this button'),
-            Text(
-              'to revoke/DeAuthorize Strava user',
-            ),
-            Text(''),
-            RaisedButton(
-              child: Text('DeAuthorize'),
-              onPressed: deAuthorize,
-            ),
-            Text('Push this button to start'),
-            Text(
-              'the Strava authentication',
-            ),
-            Text(
-              'using basic example',
-            ),
+            
             Text(''),
             Text('Authentication'),
             Text('with strava_flutter Api'),
@@ -126,11 +109,24 @@ class _StravaFlutterPageState extends State<StravaFlutterPage> {
               onPressed: exampleStrava,
             ),
             Text(''),
+            Text(''),
             Text('Upload with authentication'),
             RaisedButton(
               child: Text('upload'),
               onPressed: upload,
             ),
+            Text(' '),
+            Text(''),
+            Text(''),
+            Text('Push this button'),
+            Text(
+              'to revoke/DeAuthorize Strava user',
+            ),
+            
+            RaisedButton(
+              child: Text('DeAuthorize'),
+              onPressed: deAuthorize,
+            ),
           ],
         ),
       ),