/usr/lib/python2.7/dist-packages/fitbit/api.py is in python-fitbit 0.1.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | # -*- coding: utf-8 -*-
import requests
import json
import datetime
try:
from urllib.parse import urlencode
except ImportError:
# Python 2.x
from urllib import urlencode
from requests_oauthlib import OAuth1, OAuth1Session
from fitbit.exceptions import (BadResponse, DeleteError, HTTPBadRequest,
HTTPUnauthorized, HTTPForbidden,
HTTPServerError, HTTPConflict, HTTPNotFound,
HTTPTooManyRequests)
from fitbit.utils import curry
class FitbitOauthClient(object):
API_ENDPOINT = "https://api.fitbit.com"
AUTHORIZE_ENDPOINT = "https://www.fitbit.com"
API_VERSION = 1
request_token_url = "%s/oauth/request_token" % API_ENDPOINT
access_token_url = "%s/oauth/access_token" % API_ENDPOINT
authorization_url = "%s/oauth/authorize" % AUTHORIZE_ENDPOINT
def __init__(self, client_key, client_secret, resource_owner_key=None,
resource_owner_secret=None, user_id=None, callback_uri=None,
*args, **kwargs):
"""
Create a FitbitOauthClient object. Specify the first 5 parameters if
you have them to access user data. Specify just the first 2 parameters
to access anonymous data and start the set up for user authorization.
Set callback_uri to a URL and when the user has granted us access at
the fitbit site, fitbit will redirect them to the URL you passed. This
is how we get back the magic verifier string from fitbit if we're a web
app. If we don't pass it, then fitbit will just display the verifier
string for the user to copy and we'll have to ask them to paste it for
us and read it that way.
"""
self.client_key = client_key
self.client_secret = client_secret
self.resource_owner_key = resource_owner_key
self.resource_owner_secret = resource_owner_secret
if user_id:
self.user_id = user_id
params = {'client_secret': client_secret}
if callback_uri:
params['callback_uri'] = callback_uri
if self.resource_owner_key and self.resource_owner_secret:
params['resource_owner_key'] = self.resource_owner_key
params['resource_owner_secret'] = self.resource_owner_secret
self.oauth = OAuth1Session(client_key, **params)
def _request(self, method, url, **kwargs):
"""
A simple wrapper around requests.
"""
return requests.request(method, url, **kwargs)
def make_request(self, url, data={}, method=None, **kwargs):
"""
Builds and makes the OAuth Request, catches errors
https://wiki.fitbit.com/display/API/API+Response+Format+And+Errors
"""
if not method:
method = 'POST' if data else 'GET'
auth = OAuth1(
self.client_key, self.client_secret, self.resource_owner_key,
self.resource_owner_secret, signature_type='auth_header')
response = self._request(method, url, data=data, auth=auth, **kwargs)
if response.status_code == 401:
raise HTTPUnauthorized(response)
elif response.status_code == 403:
raise HTTPForbidden(response)
elif response.status_code == 404:
raise HTTPNotFound(response)
elif response.status_code == 409:
raise HTTPConflict(response)
elif response.status_code == 429:
exc = HTTPTooManyRequests(response)
exc.retry_after_secs = int(response.headers['Retry-After'])
raise exc
elif response.status_code >= 500:
raise HTTPServerError(response)
elif response.status_code >= 400:
raise HTTPBadRequest(response)
return response
def fetch_request_token(self):
"""
Step 1 of getting authorized to access a user's data at fitbit: this
makes a signed request to fitbit to get a token to use in step 3.
Returns that token.}
"""
token = self.oauth.fetch_request_token(self.request_token_url)
self.resource_owner_key = token.get('oauth_token')
self.resource_owner_secret = token.get('oauth_token_secret')
return token
def authorize_token_url(self, **kwargs):
"""Step 2: Return the URL the user needs to go to in order to grant us
authorization to look at their data. Then redirect the user to that
URL, open their browser to it, or tell them to copy the URL into their
browser. Allow the client to request the mobile display by passing
the display='touch' argument.
"""
return self.oauth.authorization_url(self.authorization_url, **kwargs)
def fetch_access_token(self, verifier, token=None):
"""Step 3: Given the verifier from fitbit, and optionally a token from
step 1 (not necessary if using the same FitbitOAuthClient object) calls
fitbit again and returns an access token object. Extract the needed
information from that and save it to use in future API calls.
"""
if token:
self.resource_owner_key = token.get('oauth_token')
self.resource_owner_secret = token.get('oauth_token_secret')
self.oauth = OAuth1Session(
self.client_key,
client_secret=self.client_secret,
resource_owner_key=self.resource_owner_key,
resource_owner_secret=self.resource_owner_secret,
verifier=verifier)
response = self.oauth.fetch_access_token(self.access_token_url)
self.user_id = response.get('encoded_user_id')
self.resource_owner_key = response.get('oauth_token')
self.resource_owner_secret = response.get('oauth_token_secret')
return response
class Fitbit(object):
US = 'en_US'
METRIC = 'en_UK'
API_ENDPOINT = "https://api.fitbit.com"
API_VERSION = 1
WEEK_DAYS = ['SUNDAY', 'MONDAY', 'TUESDAY', 'WEDNESDAY', 'THURSDAY', 'FRIDAY', 'SATURDAY']
_resource_list = [
'body',
'activities',
'foods/log',
'water',
'sleep',
'heart',
'bp',
'glucose',
]
_qualifiers = [
'recent',
'favorite',
'frequent',
]
def __init__(self, client_key, client_secret, system=US, **kwargs):
self.client = FitbitOauthClient(client_key, client_secret, **kwargs)
self.SYSTEM = system
# All of these use the same patterns, define the method for accessing
# creating and deleting records once, and use curry to make individual
# Methods for each
for resource in self._resource_list:
setattr(self, resource.replace('/', '_'),
curry(self._COLLECTION_RESOURCE, resource))
if resource not in ['body', 'glucose']:
# Body and Glucose entries are not currently able to be deleted
setattr(self, 'delete_%s' % resource, curry(
self._DELETE_COLLECTION_RESOURCE, resource))
for qualifier in self._qualifiers:
setattr(self, '%s_activities' % qualifier, curry(self.activity_stats, qualifier=qualifier))
setattr(self, '%s_foods' % qualifier, curry(self._food_stats,
qualifier=qualifier))
def make_request(self, *args, **kwargs):
##@ This should handle data level errors, improper requests, and bad
# serialization
headers = kwargs.get('headers', {})
headers.update({'Accept-Language': self.SYSTEM})
kwargs['headers'] = headers
method = kwargs.get('method', 'POST' if 'data' in kwargs else 'GET')
response = self.client.make_request(*args, **kwargs)
if response.status_code == 202:
return True
if method == 'DELETE':
if response.status_code == 204:
return True
else:
raise DeleteError(response)
try:
rep = json.loads(response.content.decode('utf8'))
except ValueError:
raise BadResponse
return rep
def user_profile_get(self, user_id=None):
"""
Get a user profile. You can get other user's profile information
by passing user_id, or you can get the current user's by not passing
a user_id
.. note:
This is not the same format that the GET comes back in, GET requests
are wrapped in {'user': <dict of user data>}
https://wiki.fitbit.com/display/API/API-Get-User-Info
"""
if user_id is None:
user_id = "-"
url = "%s/%s/user/%s/profile.json" % (self.API_ENDPOINT,
self.API_VERSION, user_id)
return self.make_request(url)
def user_profile_update(self, data):
"""
Set a user profile. You can set your user profile information by
passing a dictionary of attributes that will be updated.
.. note:
This is not the same format that the GET comes back in, GET requests
are wrapped in {'user': <dict of user data>}
https://wiki.fitbit.com/display/API/API-Update-User-Info
"""
url = "%s/%s/user/-/profile.json" % (self.API_ENDPOINT,
self.API_VERSION)
return self.make_request(url, data)
def _COLLECTION_RESOURCE(self, resource, date=None, user_id=None,
data=None):
"""
Retrieving and logging of each type of collection data.
Arguments:
resource, defined automatically via curry
[date] defaults to today
[user_id] defaults to current logged in user
[data] optional, include for creating a record, exclude for access
This implements the following methods::
body(date=None, user_id=None, data=None)
activities(date=None, user_id=None, data=None)
foods_log(date=None, user_id=None, data=None)
water(date=None, user_id=None, data=None)
sleep(date=None, user_id=None, data=None)
heart(date=None, user_id=None, data=None)
bp(date=None, user_id=None, data=None)
* https://wiki.fitbit.com/display/API/Fitbit+Resource+Access+API
"""
if not date:
date = datetime.date.today()
if not user_id:
user_id = '-'
if not isinstance(date, str):
date = date.strftime('%Y-%m-%d')
if not data:
url = "%s/%s/user/%s/%s/date/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
user_id,
resource,
date,
)
else:
data['date'] = date
url = "%s/%s/user/%s/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
user_id,
resource,
)
return self.make_request(url, data)
def _DELETE_COLLECTION_RESOURCE(self, resource, log_id):
"""
deleting each type of collection data
Arguments:
resource, defined automatically via curry
log_id, required, log entry to delete
This builds the following methods::
delete_body(log_id)
delete_activities(log_id)
delete_foods(log_id)
delete_water(log_id)
delete_sleep(log_id)
delete_heart(log_id)
delete_bp(log_id)
"""
url = "%s/%s/user/-/%s/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
resource,
log_id,
)
response = self.make_request(url, method='DELETE')
return response
def time_series(self, resource, user_id=None, base_date='today',
period=None, end_date=None):
"""
The time series is a LOT of methods, (documented at url below) so they
don't get their own method. They all follow the same patterns, and
return similar formats.
Taking liberty, this assumes a base_date of today, the current user,
and a 1d period.
https://wiki.fitbit.com/display/API/API-Get-Time-Series
"""
if not user_id:
user_id = '-'
if period and end_date:
raise TypeError("Either end_date or period can be specified, not both")
if end_date:
if not isinstance(end_date, str):
end = end_date.strftime('%Y-%m-%d')
else:
end = end_date
else:
if not period in ['1d', '7d', '30d', '1w', '1m', '3m', '6m', '1y', 'max']:
raise ValueError("Period must be one of '1d', '7d', '30d', '1w', '1m', '3m', '6m', '1y', 'max'")
end = period
if not isinstance(base_date, str):
base_date = base_date.strftime('%Y-%m-%d')
url = "%s/%s/user/%s/%s/date/%s/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
user_id,
resource,
base_date,
end
)
return self.make_request(url)
def activity_stats(self, user_id=None, qualifier=''):
"""
* https://wiki.fitbit.com/display/API/API-Get-Activity-Stats
* https://wiki.fitbit.com/display/API/API-Get-Favorite-Activities
* https://wiki.fitbit.com/display/API/API-Get-Recent-Activities
* https://wiki.fitbit.com/display/API/API-Get-Frequent-Activities
This implements the following methods::
recent_activities(user_id=None, qualifier='')
favorite_activities(user_id=None, qualifier='')
frequent_activities(user_id=None, qualifier='')
"""
if not user_id:
user_id = '-'
if qualifier:
if qualifier in self._qualifiers:
qualifier = '/%s' % qualifier
else:
raise ValueError("Qualifier must be one of %s"
% ', '.join(self._qualifiers))
else:
qualifier = ''
url = "%s/%s/user/%s/activities%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
user_id,
qualifier,
)
return self.make_request(url)
def _food_stats(self, user_id=None, qualifier=''):
"""
This builds the convenience methods on initialization::
recent_foods(user_id=None, qualifier='')
favorite_foods(user_id=None, qualifier='')
frequent_foods(user_id=None, qualifier='')
* https://wiki.fitbit.com/display/API/API-Get-Recent-Foods
* https://wiki.fitbit.com/display/API/API-Get-Frequent-Foods
* https://wiki.fitbit.com/display/API/API-Get-Favorite-Foods
"""
if not user_id:
user_id = '-'
url = "%s/%s/user/%s/foods/log/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
user_id,
qualifier,
)
return self.make_request(url)
def add_favorite_activity(self, activity_id):
"""
https://wiki.fitbit.com/display/API/API-Add-Favorite-Activity
"""
url = "%s/%s/user/-/activities/favorite/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
activity_id,
)
return self.make_request(url, method='POST')
def log_activity(self, data):
"""
https://wiki.fitbit.com/display/API/API-Log-Activity
"""
url = "%s/%s/user/-/activities.json" % (
self.API_ENDPOINT,
self.API_VERSION)
return self.make_request(url, data = data)
def delete_favorite_activity(self, activity_id):
"""
https://wiki.fitbit.com/display/API/API-Delete-Favorite-Activity
"""
url = "%s/%s/user/-/activities/favorite/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
activity_id,
)
return self.make_request(url, method='DELETE')
def add_favorite_food(self, food_id):
"""
https://wiki.fitbit.com/display/API/API-Add-Favorite-Food
"""
url = "%s/%s/user/-/foods/log/favorite/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
food_id,
)
return self.make_request(url, method='POST')
def delete_favorite_food(self, food_id):
"""
https://wiki.fitbit.com/display/API/API-Delete-Favorite-Food
"""
url = "%s/%s/user/-/foods/log/favorite/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
food_id,
)
return self.make_request(url, method='DELETE')
def create_food(self, data):
"""
https://wiki.fitbit.com/display/API/API-Create-Food
"""
url = "%s/%s/user/-/foods.json" % (
self.API_ENDPOINT,
self.API_VERSION,
)
return self.make_request(url, data=data)
def get_meals(self):
"""
https://wiki.fitbit.com/display/API/API-Get-Meals
"""
url = "%s/%s/user/-/meals.json" % (
self.API_ENDPOINT,
self.API_VERSION,
)
return self.make_request(url)
def get_devices(self):
"""
https://wiki.fitbit.com/display/API/API-Get-Devices
"""
url = "%s/%s/user/-/devices.json" % (
self.API_ENDPOINT,
self.API_VERSION,
)
return self.make_request(url)
def get_alarms(self, device_id):
"""
https://wiki.fitbit.com/display/API/API-Devices-Get-Alarms
"""
url = "%s/%s/user/-/devices/tracker/%s/alarms.json" % (
self.API_ENDPOINT,
self.API_VERSION,
device_id
)
return self.make_request(url)
def add_alarm(self, device_id, alarm_time, week_days, recurring=False, enabled=True, label=None,
snooze_length=None, snooze_count=None, vibe='DEFAULT'):
"""
https://wiki.fitbit.com/display/API/API-Devices-Add-Alarm
alarm_time should be a timezone aware datetime object.
"""
url = "%s/%s/user/-/devices/tracker/%s/alarms.json" % (
self.API_ENDPOINT,
self.API_VERSION,
device_id
)
alarm_time = alarm_time.strftime("%H:%M%z")
# Check week_days list
if not isinstance(week_days, list):
raise ValueError("Week days needs to be a list")
for day in week_days:
if day not in self.WEEK_DAYS:
raise ValueError("Incorrect week day %s. see WEEK_DAY_LIST." % day)
data = {
'time': alarm_time,
'weekDays': week_days,
'recurring': recurring,
'enabled': enabled,
'vibe': vibe
}
if label:
data['label'] = label
if snooze_length:
data['snoozeLength'] = snooze_length
if snooze_count:
data['snoozeCount'] = snooze_count
return self.make_request(url, data=data, method="POST")
# return
def update_alarm(self, device_id, alarm_id, alarm_time, week_days, recurring=False, enabled=True, label=None,
snooze_length=None, snooze_count=None, vibe='DEFAULT'):
"""
https://wiki.fitbit.com/display/API/API-Devices-Update-Alarm
alarm_time should be a timezone aware datetime object.
"""
# TODO Refactor with create_alarm. Tons of overlap.
# Check week_days list
if not isinstance(week_days, list):
raise ValueError("Week days needs to be a list")
for day in week_days:
if day not in self.WEEK_DAYS:
raise ValueError("Incorrect week day %s. see WEEK_DAY_LIST." % day)
url = "%s/%s/user/-/devices/tracker/%s/alarms/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
device_id,
alarm_id
)
alarm_time = alarm_time.strftime("%H:%M%z")
data = {
'time': alarm_time,
'weekDays': week_days,
'recurring': recurring,
'enabled': enabled,
'vibe': vibe
}
if label:
data['label'] = label
if snooze_length:
data['snoozeLength'] = snooze_length
if snooze_count:
data['snoozeCount'] = snooze_count
return self.make_request(url, data=data, method="POST")
# return
def delete_alarm(self, device_id, alarm_id):
"""
https://wiki.fitbit.com/display/API/API-Devices-Delete-Alarm
"""
url = "%s/%s/user/-/devices/tracker/%s/alarms/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
device_id,
alarm_id
)
return self.make_request(url, method="DELETE")
def get_sleep(self, date):
"""
https://wiki.fitbit.com/display/API/API-Get-Sleep
date should be a datetime.date object.
"""
url = "%s/%s/user/-/sleep/date/%s-%s-%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
date.year,
date.month,
date.day
)
return self.make_request(url)
def log_sleep(self, start_time, duration):
"""
https://wiki.fitbit.com/display/API/API-Log-Sleep
start time should be a datetime object. We will be using the year, month, day, hour, and minute.
"""
data = {
'startTime': start_time.strftime("%H:%M"),
'duration': duration,
'date': start_time.strftime("%Y-%m-%d"),
}
url = "%s/%s/user/-/sleep.json" % (
self.API_ENDPOINT,
self.API_VERSION,
)
return self.make_request(url, data=data, method="POST")
def activities_list(self):
"""
https://wiki.fitbit.com/display/API/API-Browse-Activities
"""
url = "%s/%s/activities.json" % (
self.API_ENDPOINT,
self.API_VERSION,
)
return self.make_request(url)
def activity_detail(self, activity_id):
"""
https://wiki.fitbit.com/display/API/API-Get-Activity
"""
url = "%s/%s/activities/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
activity_id
)
return self.make_request(url)
def search_foods(self, query):
"""
https://wiki.fitbit.com/display/API/API-Search-Foods
"""
url = "%s/%s/foods/search.json?%s" % (
self.API_ENDPOINT,
self.API_VERSION,
urlencode({'query': query})
)
return self.make_request(url)
def food_detail(self, food_id):
"""
https://wiki.fitbit.com/display/API/API-Get-Food
"""
url = "%s/%s/foods/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
food_id
)
return self.make_request(url)
def food_units(self):
"""
https://wiki.fitbit.com/display/API/API-Get-Food-Units
"""
url = "%s/%s/foods/units.json" % (
self.API_ENDPOINT,
self.API_VERSION
)
return self.make_request(url)
def get_bodyweight(self, base_date=None, user_id=None, period=None, end_date=None):
"""
https://wiki.fitbit.com/display/API/API-Get-Body-Weight
base_date should be a datetime.date object (defaults to today),
period can be '1d', '7d', '30d', '1w', '1m', '3m', '6m', '1y', 'max' or None
end_date should be a datetime.date object, or None.
You can specify period or end_date, or neither, but not both.
"""
if not base_date:
base_date = datetime.date.today()
if not user_id:
user_id = '-'
if period and end_date:
raise TypeError("Either end_date or period can be specified, not both")
if not isinstance(base_date, str):
base_date_string = base_date.strftime('%Y-%m-%d')
else:
base_date_string = base_date
if period:
if not period in ['1d', '7d', '30d', '1w', '1m', '3m', '6m', '1y', 'max']:
raise ValueError("Period must be one of '1d', '7d', '30d', '1w', '1m', '3m', '6m', '1y', 'max'")
url = "%s/%s/user/%s/body/log/weight/date/%s/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
user_id,
base_date_string,
period
)
elif end_date:
if not isinstance(end_date, str):
end_string = end_date.strftime('%Y-%m-%d')
else:
end_string = end_date
url = "%s/%s/user/%s/body/log/weight/date/%s/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
user_id,
base_date_string,
end_string
)
else:
url = "%s/%s/user/%s/body/log/weight/date/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
user_id,
base_date_string,
)
return self.make_request(url)
def get_bodyfat(self, base_date=None, user_id=None, period=None, end_date=None):
"""
https://wiki.fitbit.com/display/API/API-Get-Body-fat
base_date should be a datetime.date object (defaults to today),
period can be '1d', '7d', '30d', '1w', '1m', '3m', '6m', '1y', 'max' or None
end_date should be a datetime.date object, or None.
You can specify period or end_date, or neither, but not both.
"""
if not base_date:
base_date = datetime.date.today()
if not user_id:
user_id = '-'
if period and end_date:
raise TypeError("Either end_date or period can be specified, not both")
if not isinstance(base_date, str):
base_date_string = base_date.strftime('%Y-%m-%d')
else:
base_date_string = base_date
if period:
if not period in ['1d', '7d', '30d', '1w', '1m', '3m', '6m', '1y', 'max']:
raise ValueError("Period must be one of '1d', '7d', '30d', '1w', '1m', '3m', '6m', '1y', 'max'")
url = "%s/%s/user/%s/body/log/fat/date/%s/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
user_id,
base_date_string,
period
)
elif end_date:
if not isinstance(end_date, str):
end_string = end_date.strftime('%Y-%m-%d')
else:
end_string = end_date
url = "%s/%s/user/%s/body/log/fat/date/%s/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
user_id,
base_date_string,
end_string
)
else:
url = "%s/%s/user/%s/body/log/fat/date/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
user_id,
base_date_string,
)
return self.make_request(url)
def get_friends(self, user_id=None):
"""
https://wiki.fitbit.com/display/API/API-Get-Friends
"""
if not user_id:
user_id = '-'
url = "%s/%s/user/%s/friends.json" % (
self.API_ENDPOINT,
self.API_VERSION,
user_id
)
return self.make_request(url)
def get_friends_leaderboard(self, period):
"""
https://wiki.fitbit.com/display/API/API-Get-Friends-Leaderboard
"""
if not period in ['7d', '30d']:
raise ValueError("Period must be one of '7d', '30d'")
url = "%s/%s/user/-/friends/leaders/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
period
)
return self.make_request(url)
def invite_friend(self, data):
"""
https://wiki.fitbit.com/display/API/API-Create-Invite
"""
url = "%s/%s/user/-/friends/invitations.json" % (
self.API_ENDPOINT,
self.API_VERSION,
)
return self.make_request(url, data=data)
def invite_friend_by_email(self, email):
"""
Convenience Method for
https://wiki.fitbit.com/display/API/API-Create-Invite
"""
return self.invite_friend({'invitedUserEmail': email})
def invite_friend_by_userid(self, user_id):
"""
Convenience Method for
https://wiki.fitbit.com/display/API/API-Create-Invite
"""
return self.invite_friend({'invitedUserId': user_id})
def respond_to_invite(self, other_user_id, accept=True):
"""
https://wiki.fitbit.com/display/API/API-Accept-Invite
"""
url = "%s/%s/user/-/friends/invitations/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
other_user_id,
)
accept = 'true' if accept else 'false'
return self.make_request(url, data={'accept': accept})
def accept_invite(self, other_user_id):
"""
Convenience method for respond_to_invite
"""
return self.respond_to_invite(other_user_id)
def reject_invite(self, other_user_id):
"""
Convenience method for respond_to_invite
"""
return self.respond_to_invite(other_user_id, accept=False)
def get_badges(self, user_id=None):
"""
https://wiki.fitbit.com/display/API/API-Get-Badges
"""
if not user_id:
user_id = '-'
url = "%s/%s/user/%s/badges.json" % (
self.API_ENDPOINT,
self.API_VERSION,
user_id
)
return self.make_request(url)
def subscription(self, subscription_id, subscriber_id, collection=None,
method='POST'):
"""
https://wiki.fitbit.com/display/API/Fitbit+Subscriptions+API
"""
if not collection:
url = "%s/%s/user/-/apiSubscriptions/%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
subscription_id
)
else:
url = "%s/%s/user/-/%s/apiSubscriptions/%s-%s.json" % (
self.API_ENDPOINT,
self.API_VERSION,
collection,
subscription_id,
collection
)
return self.make_request(
url,
method=method,
headers={"X-Fitbit-Subscriber-id": subscriber_id}
)
def list_subscriptions(self, collection=''):
"""
https://wiki.fitbit.com/display/API/Fitbit+Subscriptions+API
"""
if collection:
collection = '/%s' % collection
url = "%s/%s/user/-%s/apiSubscriptions.json" % (
self.API_ENDPOINT,
self.API_VERSION,
collection,
)
return self.make_request(url)
@classmethod
def from_oauth_keys(self, client_key, client_secret, user_key=None,
user_secret=None, user_id=None, system=US):
client = FitbitOauthClient(client_key, client_secret, user_key,
user_secret, user_id)
return self(client, system)
|