This repository has been archived by the owner on Oct 7, 2021. It is now read-only.
forked from aam4510/fitbit4j
-
Notifications
You must be signed in to change notification settings - Fork 2
/
FitbitApiClientAgent.java
3321 lines (3045 loc) · 136 KB
/
FitbitApiClientAgent.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package com.fitbit.api.client;
import com.fitbit.api.APIUtil;
import com.fitbit.api.FitbitAPIException;
import com.fitbit.api.client.http.*;
import com.fitbit.api.common.model.achievement.Achievements;
import com.fitbit.api.common.model.achievement.LifetimeAchievements;
import com.fitbit.api.common.model.activities.*;
import com.fitbit.api.common.model.body.*;
import com.fitbit.api.common.model.bp.Bp;
import com.fitbit.api.common.model.bp.BpLog;
import com.fitbit.api.common.model.devices.*;
import com.fitbit.api.common.model.foods.*;
import com.fitbit.api.common.model.glucose.Glucose;
import com.fitbit.api.common.model.heart.Heart;
import com.fitbit.api.common.model.heart.HeartLog;
import com.fitbit.api.common.model.sleep.Sleep;
import com.fitbit.api.common.model.sleep.SleepLog;
import com.fitbit.api.common.model.timeseries.*;
import com.fitbit.api.common.model.units.UnitSystem;
import com.fitbit.api.common.model.units.VolumeUnits;
import com.fitbit.api.common.model.user.FriendStats;
import com.fitbit.api.common.model.user.UserInfo;
import com.fitbit.api.common.service.FitbitApiService;
import com.fitbit.api.model.*;
import org.nilsding.util.Utils;
import com.github.scribejava.core.model.OAuth2AccessToken;
import com.github.scribejava.core.model.OAuthRequest;
import com.github.scribejava.core.model.Response;
import com.github.scribejava.core.model.Verb;
import com.github.scribejava.core.oauth.OAuth20Service;
import org.apache.commons.lang.StringUtils;
import org.joda.time.LocalDate;
import org.joda.time.LocalTime;
import org.joda.time.format.DateTimeFormat;
import org.json.JSONArray;
import org.json.JSONException;
import org.json.JSONObject;
import javax.servlet.http.HttpServletResponse;
import java.io.Serializable;
import java.text.SimpleDateFormat;
import java.util.*;
@SuppressWarnings({"NonPrivateFieldAccessedInSynchronizedContext"})
public class FitbitApiClientAgent /*extends FitbitAPIClientSupport*/ implements Serializable {
private static final FitbitApiCredentialsCache DEFAULT_CREDENTIALS_CACHE = new FitbitApiCredentialsCacheMapImpl();
private static final long serialVersionUID = -1486360080128882436L;
protected static final String SUBSCRIBER_ID_HEADER_NAME = "X-Fitbit-Subscriber-Id";
private SimpleDateFormat format = new SimpleDateFormat("EEE, d MMM yyyy HH:mm:ss z", Locale.ENGLISH);
private APIVersion apiVersion = APIVersion.BETA_1;
private FitbitApiCredentialsCache credentialsCache;
private OAuth20Service oauth = null;
private OAuth2AccessToken accessToken = null;
private FitbitApiClientAgent() {
}
public FitbitApiClientAgent(FitbitApiCredentialsCache credentialsCache) {
if (null == credentialsCache) {
this.credentialsCache = DEFAULT_CREDENTIALS_CACHE;
} else {
this.credentialsCache = credentialsCache;
}
}
/**
* Creates FitbitApiClientAgent with custom API hosts and credentials cache.
*
* @param apiBaseUrl e.g. api.fitbit.com
* @param webBaseUrl e.g. https://www.fitbit.com
* @param credentialsCache Credentials cache
* @deprecated
*
* @see
* <a href="http://wiki.fitbit.com/display/API/API-Client-Reference-App">Fitbit
* API: API-Client-Reference-App</a>
*/
public FitbitApiClientAgent(String apiBaseUrl, String webBaseUrl, FitbitApiCredentialsCache credentialsCache) {
this("https://" + apiBaseUrl + "/oauth/request_token", webBaseUrl + "/oauth/authorize", "https://" + apiBaseUrl + "/oauth/access_token");
if (null == credentialsCache) {
this.credentialsCache = DEFAULT_CREDENTIALS_CACHE;
} else {
this.credentialsCache = credentialsCache;
}
}
/**
* @param requestTokenURL
* @param authorizationURL
* @param accessTokenURL
* @deprecated
*
* @see
* <a href="http://wiki.fitbit.com/display/API/API-Client-Reference-App">Fitbit
* API: API-Client-Reference-App</a>
*/
public FitbitApiClientAgent(String requestTokenURL, String authorizationURL, String accessTokenURL) {
init();
}
private void init() {
format.setTimeZone(TimeZone.getTimeZone("GMT"));
}
/**
*
* @param requestTokenURL
* @param authorizationURL
* @param accessTokenURL
* @deprecated
*/
private void init(String requestTokenURL, String authorizationURL, String accessTokenURL) {
init();
}
/**
* Returns the base API URL
*
* @return the base API URL
*/
public String getApiBaseUrl() {
return com.fitbit.api.client.oauth.FitbitOAuthApi.API_BASE_URL;
}
/**
* Returns the base API SSL URL
*
* @return the secured base API URL
*/
public String getApiBaseSecuredUrl() {
return com.fitbit.api.client.oauth.FitbitOAuthApi.API_BASE_URL;
}
/**
* Returns currently used API version
*
* @return API version
*/
public APIVersion getApiVersion() {
return apiVersion;
}
/**
* Sets the OAuth consumer credentials
*
* @deprecated use setOAuthClient instead
* @param consumerKey consumer key
* @param consumerSecret consumer secret
*/
public synchronized void setOAuthConsumer(String consumerKey, String consumerSecret) {
setOAuthClient(consumerKey, consumerSecret);
}
public synchronized void setOAuthClient(String clientId, String clientSecret) {
oauth = Utils.buildOAuthInstance(clientId, clientSecret);
}
/**
* Sets id of a default subscriber for subscription requests
*
* @param subscriberId default subscriber id
*
* @deprecated does not work lol
* @see
* <a href="http://wiki.fitbit.com/display/API/Subscriptions-API#Subscriptions-API-Configureyouraccountwithasubscriberendpoint">Fitbit
* API: Subscriptions-API</a>
*/
protected void setSubscriberId(String subscriberId) {
if (null != subscriberId) {
// http.setRequestHeader(SUBSCRIBER_ID_HEADER_NAME, subscriberId);
}
}
/**
* Retrieves credentials cache
*
* @return credentials cache
*/
public FitbitApiCredentialsCache getCredentialsCache() {
return credentialsCache;
}
/**
* Get user's activity statistics (lifetime and bests)
*
* @param localUser authorized user
* @param fitbitUser user to retrieve data from
*
* @return user's activity statistics
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see
* <a href="http://wiki.fitbit.com/display/API/API-Get-Activity-Stats">Fitbit
* API: API-Get-Activity-Stats</a>
*/
public Achievements getAchievements(LocalUserDetail localUser, FitbitUser fitbitUser) throws FitbitAPIException {
setAccessToken(localUser);
// Example: GET /1/user/228TQ4/activities.json
String url = APIUtil.contextualizeUrl(getApiBaseUrl(), getApiVersion(), "/user/" + fitbitUser.getId() + "/activities", APIFormat.JSON);
Response res = httpGet(url, true);
throwExceptionIfError(res);
try {
return Achievements.constructAchievements(res);
} catch (JSONException e) {
throw new FitbitAPIException("Error parsing achievements: " + e, e);
}
}
/**
* Get user's lifetime activity statistics
*
* @param localUser authorized user
* @param fitbitUser user to retrieve data from
*
* @return user's activity statistics
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see
* <a href="http://wiki.fitbit.com/display/API/API-Get-Activity-Stats">Fitbit
* API: API-Get-Activity-Stats</a>
*/
@Deprecated
public LifetimeAchievements getActivitiesAchievements(LocalUserDetail localUser, FitbitUser fitbitUser) throws FitbitAPIException {
setAccessToken(localUser);
// Example: GET /1/user/228TQ4/activities.json
String url = APIUtil.contextualizeUrl(getApiBaseUrl(), getApiVersion(), "/user/" + fitbitUser.getId() + "/activities", APIFormat.JSON);
Response res = httpGet(url, true);
throwExceptionIfError(res);
try {
return new LifetimeAchievements(Utils.toJsonObject(res).getJSONObject("lifetime"));
} catch (JSONException e) {
throw new FitbitAPIException("Error parsing lifetime achievements: " + e, e);
}
}
/**
* Get a summary and list of a user's activities and activity log entries
* for a given day
*
* @param localUser authorized user
* @param fitbitUser user to retrieve data from
* @param date date to retrieve data dor
*
* @return activities for a given day
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see
* <a href="http://wiki.fitbit.com/display/API/API-Get-Activities">Fitbit
* API: API-Get-Activities</a>
*/
public Activities getActivities(LocalUserDetail localUser, FitbitUser fitbitUser, LocalDate date) throws FitbitAPIException {
// Example: GET /1/user/228TQ4/activities/date/2010-02-25.json
Response res = getCollectionResponseForDate(localUser, fitbitUser, APICollectionType.activities, date);
throwExceptionIfError(res);
return Activities.constructActivities(res);
}
/**
* Get a list of a user's favorite activities. The activity id contained in
* the record retrieved can be used to log the activity
*
* @param localUser authorized user
* @param fitbitUser user to retrieve data from
*
* @return list of user's favorite activities
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see
* <a href="http://wiki.fitbit.com/display/API/API-Get-Favorite-Activities">Fitbit
* API: API-Get-Favorite-Activities</a>
*/
public List<ActivityReference> getFavoriteActivities(LocalUserDetail localUser, FitbitUser fitbitUser) throws FitbitAPIException {
// Example: GET /1/user/228TQ4/activities/favorite.json
Response res = getCollectionResponseForProperty(localUser, fitbitUser, APICollectionType.activities, ApiCollectionProperty.favorite);
throwExceptionIfError(res);
return ActivityReference.constructActivityReferenceList(res);
}
/**
* Get a list of a user's recent activities. The activity id contained in
* the record retrieved can be used to log the activity
*
* @param localUser authorized user
* @param fitbitUser user to retrieve data from
*
* @return list of user's recent activities
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see
* <a href="http://wiki.fitbit.com/display/API/API-Get-Recent-Activities">Fitbit
* API: API-Get-Recent-Activities</a>
*/
public List<LoggedActivityReference> getRecentActivities(LocalUserDetail localUser, FitbitUser fitbitUser) throws FitbitAPIException {
// Example: GET /1/user/228TQ4/activities/recent.json
Response res = getCollectionResponseForProperty(localUser, fitbitUser, APICollectionType.activities, ApiCollectionProperty.recent);
throwExceptionIfError(res);
return LoggedActivityReference.constructLoggedActivityReferenceList(res);
}
/**
* Get a list of a user's frequent activities. The activity id contained in
* the record retrieved can be used to log the activity
*
* @param localUser authorized user
* @param fitbitUser user to retrieve data from
*
* @return list of user's frequent activities
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see
* <a href="http://wiki.fitbit.com/display/API/API-Get-Frequent-Activities">Fitbit
* API: API-Get-Frequent-Activities</a>
*/
public List<LoggedActivityReference> getFrequentActivities(LocalUserDetail localUser, FitbitUser fitbitUser) throws FitbitAPIException {
// Example: GET /1/user/228TQ4/activities/recent.json
Response res = getCollectionResponseForProperty(localUser, fitbitUser, APICollectionType.activities, ApiCollectionProperty.frequent);
throwExceptionIfError(res);
return LoggedActivityReference.constructLoggedActivityReferenceList(res);
}
/**
* Create log entry for an activity
*
* @param localUser authorized user
* @param activityId Activity id
* @param steps Start time
* @param durationMillis Duration
* @param distance Distance
* @param date Log entry date
* @param startTime Start time
*
* @return new activity log entry
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see <a href="http://wiki.fitbit.com/display/API/API-Log-Activity">Fitbit
* API: API-Log-Activity</a>
*/
public ActivityLog logActivity(LocalUserDetail localUser,
long activityId,
int steps,
int durationMillis,
float distance,
LocalDate date,
LocalTime startTime) throws FitbitAPIException {
List<PostParameter> params = new ArrayList<PostParameter>(5);
params.add(new PostParameter("activityId", activityId));
params.add(new PostParameter("steps", steps));
params.add(new PostParameter("durationMillis", durationMillis));
params.add(new PostParameter("distance", distance));
params.add(new PostParameter("date", DateTimeFormat.forPattern("yyyy-MM-dd").print(date)));
params.add(new PostParameter("startTime", FitbitApiService.LOCAL_TIME_HOURS_MINUTES_FORMATTER.print(startTime)));
return logActivity(localUser, params);
}
/**
* Create log entry for an activity
*
* @param localUser authorized user
* @param activityId Activity id
* @param steps Start time
* @param durationMillis Duration
* @param distance Distance
* @param distanceUnit distance measurement unit;
* @param date Log entry date
* @param startTime Start time
*
* @return new activity log entry
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see <a href="http://wiki.fitbit.com/display/API/API-Log-Activity">Fitbit
* API: API-Log-Activity</a>
*/
public ActivityLog logActivity(LocalUserDetail localUser,
long activityId,
int steps,
int durationMillis,
float distance,
String distanceUnit,
LocalDate date,
LocalTime startTime) throws FitbitAPIException {
List<PostParameter> params = new ArrayList<PostParameter>(5);
params.add(new PostParameter("activityId", activityId));
params.add(new PostParameter("steps", steps));
params.add(new PostParameter("durationMillis", durationMillis));
params.add(new PostParameter("distance", distance));
params.add(new PostParameter("date", DateTimeFormat.forPattern("yyyy-MM-dd").print(date)));
params.add(new PostParameter("startTime", FitbitApiService.LOCAL_TIME_HOURS_MINUTES_FORMATTER.print(startTime)));
params.add(new PostParameter("distanceUnit", distanceUnit));
return logActivity(localUser, params);
}
/**
* Create log entry for an activity
*
* @param localUser authorized user
* @param activityId Activity id
* @param steps Start time
* @param durationMillis Duration
* @param distance Distance
* @param distanceUnit distance measurement unit;
* @param date Log entry date
* @param startTime Start time
* @param manualCalories manual calories
*
* @return new activity log entry
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see <a href="http://wiki.fitbit.com/display/API/API-Log-Activity">Fitbit
* API: API-Log-Activity</a>
*/
public ActivityLog logActivity(LocalUserDetail localUser,
long activityId,
int steps,
int durationMillis,
float distance,
String distanceUnit,
LocalDate date,
LocalTime startTime,
int manualCalories) throws FitbitAPIException {
List<PostParameter> params = new ArrayList<PostParameter>(5);
params.add(new PostParameter("activityId", activityId));
params.add(new PostParameter("steps", steps));
params.add(new PostParameter("durationMillis", durationMillis));
params.add(new PostParameter("distance", distance));
params.add(new PostParameter("date", DateTimeFormat.forPattern("yyyy-MM-dd").print(date)));
params.add(new PostParameter("startTime", FitbitApiService.LOCAL_TIME_HOURS_MINUTES_FORMATTER.print(startTime)));
params.add(new PostParameter("manualCalories", manualCalories));
params.add(new PostParameter("distanceUnit", distanceUnit));
return logActivity(localUser, params);
}
/**
* Create log entry for a custom activity
*
* @param localUser authorized user
* @param activityName Activity name
* @param durationMillis Duration
* @param date Log entry date
* @param startTime Start time
* @param manualCalories manual calories
*
* @return new activity log entry
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see <a href="http://wiki.fitbit.com/display/API/API-Log-Activity">Fitbit
* API: API-Log-Activity</a>
*/
public ActivityLog logActivity(LocalUserDetail localUser,
String activityName,
int durationMillis,
LocalDate date,
LocalTime startTime,
int manualCalories) throws FitbitAPIException {
List<PostParameter> params = new ArrayList<PostParameter>(5);
params.add(new PostParameter("activityName", activityName));
params.add(new PostParameter("durationMillis", durationMillis));
params.add(new PostParameter("date", DateTimeFormat.forPattern("yyyy-MM-dd").print(date)));
params.add(new PostParameter("startTime", FitbitApiService.LOCAL_TIME_HOURS_MINUTES_FORMATTER.print(startTime)));
params.add(new PostParameter("manualCalories", manualCalories));
return logActivity(localUser, params);
}
/**
* Create log entry for a custom activity
*
* @param localUser authorized user
* @param activityName Activity name
* @param durationMillis Duration
* @param distance Distance
* @param date Log entry date
* @param startTime Start time
* @param manualCalories manual calories
*
* @return new activity log entry
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see <a href="http://wiki.fitbit.com/display/API/API-Log-Activity">Fitbit
* API: API-Log-Activity</a>
*/
public ActivityLog logActivity(LocalUserDetail localUser,
String activityName,
int durationMillis,
float distance,
LocalDate date,
LocalTime startTime,
int manualCalories) throws FitbitAPIException {
List<PostParameter> params = new ArrayList<PostParameter>(6);
params.add(new PostParameter("activityName", activityName));
params.add(new PostParameter("durationMillis", durationMillis));
params.add(new PostParameter("distance", distance));
params.add(new PostParameter("date", DateTimeFormat.forPattern("yyyy-MM-dd").print(date)));
params.add(new PostParameter("startTime", FitbitApiService.LOCAL_TIME_HOURS_MINUTES_FORMATTER.print(startTime)));
params.add(new PostParameter("manualCalories", manualCalories));
return logActivity(localUser, params);
}
/**
* Create log entry for a custom activity
*
* @param localUser authorized user
* @param activityName Activity name
* @param durationMillis Duration
* @param distance Distance
* @param distanceUnit distance measurement unit;
* @param date Log entry date
* @param startTime Start time
* @param manualCalories manual calories
*
* @return new activity log entry
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see <a href="http://wiki.fitbit.com/display/API/API-Log-Activity">Fitbit
* API: API-Log-Activity</a>
*/
public ActivityLog logActivity(LocalUserDetail localUser,
String activityName,
int durationMillis,
float distance,
String distanceUnit,
LocalDate date,
LocalTime startTime,
int manualCalories) throws FitbitAPIException {
List<PostParameter> params = new ArrayList<PostParameter>(7);
params.add(new PostParameter("activityName", activityName));
params.add(new PostParameter("durationMillis", durationMillis));
params.add(new PostParameter("distance", distance));
params.add(new PostParameter("date", DateTimeFormat.forPattern("yyyy-MM-dd").print(date)));
params.add(new PostParameter("startTime", FitbitApiService.LOCAL_TIME_HOURS_MINUTES_FORMATTER.print(startTime)));
params.add(new PostParameter("manualCalories", manualCalories));
params.add(new PostParameter("distanceUnit", distanceUnit));
return logActivity(localUser, params);
}
/**
* Create log entry for an activity
*
* @param localUser authorized user
* @param params POST request parameters
*
* @return new activity log entry
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see <a href="http://wiki.fitbit.com/display/API/API-Log-Activity">Fitbit
* API: API-Log-Activity</a>
*/
public ActivityLog logActivity(LocalUserDetail localUser, List<PostParameter> params) throws FitbitAPIException {
setAccessToken(localUser);
// Example: POST /1/user/-/activities.json
String url = APIUtil.contextualizeUrl(getApiBaseUrl(), getApiVersion(), "/user/-/activities", APIFormat.JSON);
Response res;
try {
res = httpPost(url, params.toArray(new PostParameter[params.size()]), true);
} catch (Exception e) {
throw new FitbitAPIException("Error creating activity: " + e, e);
}
if (res.getCode() != HttpServletResponse.SC_CREATED) {
throw new FitbitAPIException("Error creating activity: " + res.getCode());
}
try {
return new ActivityLog(Utils.toJsonObject(res).getJSONObject("activityLog"));
} catch (JSONException e) {
throw new FitbitAPIException("Error creating activity: " + e, e);
}
}
/**
* Delete user's activity log entry with the given id
*
* @param localUser authorized user
* @param activityLogId Activity log entry id
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see
* <a href="http://wiki.fitbit.com/display/API/API-Delete-Activity-Log">Fitbit
* API: API-Delete-Activity-Log</a>
*/
public void deleteActivityLog(LocalUserDetail localUser, String activityLogId) throws FitbitAPIException {
setAccessToken(localUser);
// Example: DELETE /1/user/-/activities/123.json
String url = APIUtil.contextualizeUrl(getApiBaseUrl(), getApiVersion(), "/user/-/activities/" + activityLogId, APIFormat.JSON);
try {
httpDelete(url, true);
} catch (Exception e) {
throw new FitbitAPIException("Error deleting activity log entry: " + e, e);
}
}
/**
* Get a tree of all valid Fitbit public activities from the activities
* catalog as well as private custom activities the user created
*
* @param localUser authorized user
*
* @return activities catalog
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see
* <a href="http://wiki.fitbit.com/display/API/API-Browse-Activities">Fitbit
* API: API-Browse-Activities</a>
*/
public List<ActivityCategory> getActivityCategories(LocalUserDetail localUser) throws FitbitAPIException {
if (localUser != null) {
setAccessToken(localUser);
}
// Example: GET /1/activities.json
String url = APIUtil.contextualizeUrl(getApiBaseUrl(), getApiVersion(), "/activities", APIFormat.JSON);
Response res = httpGet(url, true);
throwExceptionIfError(res);
try {
return ActivityCategory.jsonArrayToActivityCategoryList(Utils.toJsonObject(res).getJSONArray("categories"));
} catch (JSONException e) {
throw new FitbitAPIException("Error retrieving activity: " + e, e);
}
}
/**
* Get the details of a specific activity in Fitbit activities database. If
* activity has levels, also get list of activity level details.
*
* @param localUser authorized user
* @param activityId Activity id
*
* @return activity description
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see <a href="http://wiki.fitbit.com/display/API/API-Get-Activity">Fitbit
* API: API-Get-Activity</a>
*/
public Activity getActivity(LocalUserDetail localUser, long activityId) throws FitbitAPIException {
return getActivity(localUser, String.valueOf(activityId));
}
/**
* Get the details of a specific activity in Fitbit activities database. If
* activity has levels, also get list of activity level details.
*
* @param localUser authorized user
* @param activityId Activity id
*
* @return activity description
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see <a href="http://wiki.fitbit.com/display/API/API-Get-Activity">Fitbit
* API: API-Get-Activity</a>
*/
public Activity getActivity(LocalUserDetail localUser, String activityId) throws FitbitAPIException {
setAccessToken(localUser);
// Example: GET /1/activities/90009.json
String url = APIUtil.contextualizeUrl(getApiBaseUrl(), getApiVersion(), "/activities/" + activityId, APIFormat.JSON);
Response res = httpGet(url, true);
throwExceptionIfError(res);
try {
return Activity.constructActivity(Utils.toJsonObject(res));
} catch (JSONException e) {
throw new FitbitAPIException("Error retrieving activity: " + e, e);
}
}
/**
* Adds the activity with the given id to user's list of favorite
* activities.
*
* @param localUser authorized user
* @param activityId Activity id
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see
* <a href="http://wiki.fitbit.com/display/API/API-Add-Favorite-Activity">Fitbit
* API: API-Add-Favorite-Activity</a>
*/
public void addFavoriteActivity(LocalUserDetail localUser, String activityId) throws FitbitAPIException {
setAccessToken(localUser);
// Example: POST /1/user/-/activities/favorite/123.json
String url = APIUtil.contextualizeUrl(getApiBaseUrl(), getApiVersion(), "/user/-/activities/favorite/" + activityId, APIFormat.JSON);
try {
httpPost(url, null, true);
} catch (Exception e) {
throw new FitbitAPIException("Error adding favorite activity: " + e, e);
}
}
/**
* Delete the activity with the given id from user's list of favorite
* activities.
*
* @param localUser authorized user
* @param activityId Activity id
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see
* <a href="http://wiki.fitbit.com/display/API/API-Delete-Favorite-Activity">Fitbit
* API: API-Delete-Favorite-Activity</a>
*/
public void deleteFavoriteActivity(LocalUserDetail localUser, String activityId) throws FitbitAPIException {
setAccessToken(localUser);
// Example: DELETE /1/user/-/activities/favorite/123.json
String url = APIUtil.contextualizeUrl(getApiBaseUrl(), getApiVersion(), "/user/-/activities/favorite/" + activityId, APIFormat.JSON);
try {
httpDelete(url, true);
} catch (Exception e) {
throw new FitbitAPIException("Error deleting favorite activity: " + e, e);
}
}
/**
* Create new private food for a user
*
* @param localUser authorized user
* @param name Food name
* @param description Food description
* @param defaultFoodMeasurementUnitId Default measurement unit for a food
* @param defaultServingSize Default size of a serving
* @param caloriesPerServingSize Calories in default serving
* @param formType Form type
*
* @return new food object
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see <a href="http://wiki.fitbit.com/display/API/API-Create-Food">Fitbit
* API: API-Create-Food</a>
*/
public Food createFood(LocalUserDetail localUser, String name, String description, long defaultFoodMeasurementUnitId,
float defaultServingSize, int caloriesPerServingSize, FoodFormType formType) throws FitbitAPIException {
NutritionalValuesEntry nutritionalValuesEntry = new NutritionalValuesEntry();
nutritionalValuesEntry.setCalories(caloriesPerServingSize);
return createFood(localUser, name, description, defaultFoodMeasurementUnitId, defaultServingSize, formType, nutritionalValuesEntry);
}
/**
* Create new private food for a user
*
* @param localUser authorized user
* @param name Food name
* @param description Food description
* @param defaultFoodMeasurementUnitId Default measurement unit for a food
* @param defaultServingSize Default size of a serving
* @param formType Form type
* @param nutritionalValuesEntry Set of nutritional values for a default
* serving
*
* @return new food object
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see <a href="http://wiki.fitbit.com/display/API/API-Create-Food">Fitbit
* API: API-Create-Food</a>
*/
public Food createFood(LocalUserDetail localUser, String name, String description, long defaultFoodMeasurementUnitId,
float defaultServingSize, FoodFormType formType,
NutritionalValuesEntry nutritionalValuesEntry) throws FitbitAPIException {
setAccessToken(localUser);
List<PostParameter> params = new ArrayList<PostParameter>();
params.add(new PostParameter("name", name));
params.add(new PostParameter("description", description));
params.add(new PostParameter("defaultFoodMeasurementUnitId", defaultFoodMeasurementUnitId));
params.add(new PostParameter("defaultServingSize", defaultServingSize));
params.add(new PostParameter("formType", formType.toString()));
for (Map.Entry<String, Number> entry : nutritionalValuesEntry.asMap().entrySet()) {
params.add(new PostParameter(entry.getKey(), entry.getValue().toString()));
}
// Example: POST /1/food/create.json
String url = APIUtil.contextualizeUrl(getApiBaseSecuredUrl(), getApiVersion(), "/foods", APIFormat.JSON);
Response response = httpPost(url, params.toArray(new PostParameter[params.size()]), true);
try {
return new Food(Utils.toJsonObject(response).getJSONObject("food"));
} catch (JSONException e) {
throw new FitbitAPIException("Error parsing json response to Food object: ", e);
}
}
/**
* Get a summary and list of a user's food log entries for a given day
*
* @param localUser authorized user
* @param fitbitUser user to retrieve data from
* @param date date to retrieve data dor
*
* @return food records for a given day
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see <a href="http://wiki.fitbit.com/display/API/API-Get-Foods">Fitbit
* API: API-Get-Foods</a>
*/
public Foods getFoods(LocalUserDetail localUser, FitbitUser fitbitUser, LocalDate date) throws FitbitAPIException {
// Example: GET /1/user/228TQ4/foods/log/date/2010-02-25.json
Response res = getCollectionResponseForDate(localUser, fitbitUser, APICollectionType.foods, date);
return Foods.constructFoods(res);
}
public List<LoggedFood> getLoggedFoods(LocalUserDetail localUser, FitbitUser fitbitUser, ApiCollectionProperty property) throws FitbitAPIException {
// Example: GET /1/user/228TQ4/foods/log/recent.json
Response res = getCollectionResponseForProperty(localUser, fitbitUser, APICollectionType.foods, property);
return LoggedFood.constructLoggedFoodReferenceList(res);
}
/**
* Get a list of a user's favorite foods. A favorite food provides a quick
* way to log the food
*
* @param localUser authorized user
* @param fitbitUser user to retrieve data from
*
* @return list of user's favorite foods
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see
* <a href="http://wiki.fitbit.com/display/API/API-Get-Favorite-Foods">Fitbit
* API: API-Get-Favorite-Foods</a>
*/
public List<Food> getFavoriteFoods(LocalUserDetail localUser, FitbitUser fitbitUser) throws FitbitAPIException {
// Example: GET /1/user/228TQ4/foods/log/favorite.json
Response res = getCollectionResponseForProperty(localUser, fitbitUser, APICollectionType.foods, ApiCollectionProperty.favorite);
return Food.constructFoodListFromArrayResponse(res);
}
/**
* Get a list of a user's recent foods
*
* @param localUser authorized user
* @param fitbitUser user to retrieve data from
*
* @return list of user's recent foods
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see
* <a href="http://wiki.fitbit.com/display/API/API-Get-Recent-Foods">Fitbit
* API: API-Get-Recent-Foods</a>
*/
public List<LoggedFood> getRecentFoods(LocalUserDetail localUser, FitbitUser fitbitUser) throws FitbitAPIException {
// Example: GET /1/user/228TQ4/foods/log/recent.json
return getLoggedFoods(localUser, fitbitUser, ApiCollectionProperty.recent);
}
/**
* Get a list of a user's frequent foods
*
* @param localUser authorized user
* @param fitbitUser user to retrieve data from
*
* @return list of user's frequent foods
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see
* <a href="http://wiki.fitbit.com/display/API/API-Get-Frequent-Foods">Fitbit
* API: API-Get-Frequent-Foods</a>
*/
public List<LoggedFood> getFrequentFoods(LocalUserDetail localUser, FitbitUser fitbitUser) throws FitbitAPIException {
// Example: GET /1/user/228TQ4/foods/log/frequent.json
return getLoggedFoods(localUser, fitbitUser, ApiCollectionProperty.frequent);
}
/**
* Given a search query, get a list of public foods from Fitbit foods
* database and private foods the user created
*
* @param localUser authorized user
* @param query search query
*
* @return list of food search results
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see <a href="http://wiki.fitbit.com/display/API/API-Search-Foods">Fitbit
* API: API-Search-Foods</a>
*/
public List<Food> searchFoods(LocalUserDetail localUser, String query) throws FitbitAPIException {
setAccessToken(localUser);
// Example: GET /1/user/228TQ4/foods/search.json?query=apple
String url = APIUtil.contextualizeUrl(getApiBaseUrl(), getApiVersion(), "/foods/search", APIFormat.JSON);
List<PostParameter> params = new ArrayList<PostParameter>(1);
params.add(new PostParameter("query", query));
Response res = httpGet(url, params.toArray(new PostParameter[params.size()]), true);
return Food.constructFoodList(res);
}
/**
* Get the details of a specific food in Fitbit Food database (or private
* food for the user)
*
* @param localUser authorized user
* @param foodId Food id
*
* @return food description
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see <a href="http://wiki.fitbit.com/display/API/API-Get-Food">Fitbit
* API: API-Get-Food</a>
*/
public Food getFood(LocalUserDetail localUser, Long foodId) throws FitbitAPIException {
if (localUser != null) {
setAccessToken(localUser);
}
// Example: GET /1/foods/1.json
String url = APIUtil.contextualizeUrl(getApiBaseUrl(), getApiVersion(), "/foods/" + foodId, APIFormat.JSON);
Response res = httpGet(url, true);
try {
return new Food(Utils.toJsonObject(res).getJSONObject("food"));
} catch (JSONException e) {
throw new FitbitAPIException("Error retrieving food details: " + e, e);
}
}
/**
* Get list of all valid Fitbit food units
*
* @return list of valid food units
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see
* <a href="http://wiki.fitbit.com/display/API/API-Get-Food-Units">Fitbit
* API: API-Get-Food-Units</a>
*/
public List<FoodUnit> getFoodUnits() throws FitbitAPIException {
clearAccessToken();
// Example: GET https://api.fitbit.com/1/foods/units.json
String url = APIUtil.contextualizeUrl(getApiBaseUrl(), getApiVersion(), "/foods/units", APIFormat.JSON);
Response res = httpGet(url, true);
throwExceptionIfError(res);
return FoodUnit.constructFoodUnitList(res);
}
/**
* Create log entry for a food
*
* @param localUser authorized user
* @param foodId Food id
* @param mealTypeId Meal type id
* @param unitId Unit id
* @param amount Amount consumed
* @param date Log entry date
*
* @return new food log entry
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see <a href="http://wiki.fitbit.com/display/API/API-Log-Food">Fitbit
* API: API-Log-Food</a>
*/
public FoodLog logFood(LocalUserDetail localUser, long foodId, int mealTypeId, int unitId, String amount, LocalDate date) throws FitbitAPIException {
List<PostParameter> params = new ArrayList<PostParameter>(5);
params.add(new PostParameter("foodId", String.valueOf(foodId)));
params.add(new PostParameter("mealTypeId", mealTypeId));
params.add(new PostParameter("unitId", String.valueOf(unitId)));
params.add(new PostParameter("amount", amount));
params.add(new PostParameter("date", DateTimeFormat.forPattern("yyyy-MM-dd").print(date)));
return logFood(localUser, params);
}
/**
* Create log entry for a food
*
* @param localUser authorized user
* @param foodName Food name
* @param brandName Brand name
* @param nutritionalValuesEntry Nutritional Values
* @param mealTypeId Meal type id
* @param unitId Unit id
* @param amount Amount consumed
* @param date Log entry date
*
* @return new food log entry
*
*
* @throws com.fitbit.api.FitbitAPIException Fitbit API Exception
* @see <a href="http://wiki.fitbit.com/display/API/API-Log-Food">Fitbit
* API: API-Log-Food</a>
*/
public FoodLog logFood(LocalUserDetail localUser, String foodName, String brandName, NutritionalValuesEntry nutritionalValuesEntry, int mealTypeId, int unitId, String amount, LocalDate date) throws FitbitAPIException {
List<PostParameter> params = new ArrayList<PostParameter>(5);
params.add(new PostParameter("foodName", foodName));
if (StringUtils.isNotBlank(brandName)) {
params.add(new PostParameter("brandName", brandName));
}
for (Map.Entry<String, Number> entry : nutritionalValuesEntry.asMap().entrySet()) {
params.add(new PostParameter(entry.getKey(), entry.getValue().toString()));
}
params.add(new PostParameter("mealTypeId", mealTypeId));
params.add(new PostParameter("unitId", String.valueOf(unitId)));
params.add(new PostParameter("amount", amount));