pyicloud/services/findmyiphone.py

import json

from pyicloud.exceptions import PyiCloudNoDevicesException


class FindMyiPhoneService(object):
    """
    The 'Find my iPhone' iCloud service, connects to iCloud and returns
    phone data including the near-realtime latitude and longitude.
    """
    def __init__(self, session, params):
        self.session = session
        self.params = params
        self._fmip_root = 'https://p12-fmipweb.icloud.com'
        self._fmip_endpoint = '%s/fmipservice/client/web' % self._fmip_root
        self._fmip_refresh_url = '%s/refreshClient' % self._fmip_endpoint
        self._fmip_sound_url = '%s/playSound' % self._fmip_endpoint

    def refresh_client(self):
        """
        Refreshes the FindMyiPhoneService endpoint,
        ensuring that the location data is up-to-date.
        """
        self.session.headers.update({'host': 'p12-fmipweb.icloud.com'})
        req = self.session.post(self._fmip_refresh_url, params=self.params)
        self.response = req.json()
        if self.response['content']:
            # TODO: Support multiple devices.
            self.content = self.response['content'][0]
        else:
            message = 'You do not have any active devices.'
            raise PyiCloudNoDevicesException(message)
        self.user_info = self.response['userInfo']

    def location(self):
        self.refresh_client()
        return self.content['location']

    def status(self, additional=[]):
        """
        The FindMyiPhoneService response is quite bloated, this method
        will return a subset of the more useful properties.
        """
        self.refresh_client()
        fields = ['batteryLevel', 'deviceDisplayName', 'deviceStatus', 'name']
        fields += additional
        properties = {}
        for field in fields:
            properties[field] = self.content.get(field, 'Unknown')
        return properties

    def play_sound(self, subject='Find My iPhone Alert'):
        """
        Send a request to the device to play a sound, it's possible to
        pass a custom message by changing the `subject`.
        """
        self.refresh_client()
        data = json.dumps({'device': self.content['id'], 'subject': subject})
        self.session.post(self._fmip_sound_url, params=self.params, data=data)