Changed library have multiple objects for multiple logins, to be more in line with Home Assistant entries. Updated tests.

Author: RicArch97

README.md

@@ -45,7 +45,7 @@ $ python setup.py install
 #### Async example
 
 ```python
-from crownstone_cloud import CrownstoneCloud
+from crownstone_cloud import CrownstoneCloud, create_clientsession
 import logging
 import asyncio
 
@@ -54,37 +54,38 @@ logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)
 
 
 async def main():
+    # Every instance creates it's own websession for easy accessibility, however using 1 websession is recommended.
+    # Create your websession like so:
+    websession = create_clientsession()
     # Initialize cloud.
-    cloud = CrownstoneCloud()
+    cloud_user_1 = CrownstoneCloud('email_user_1', 'password_user_1', websession)
     # Login to the Crownstone Cloud and synchronize all cloud data.
-    # Important is to save your user id which is returned from the function!
-    user_id_1 = await cloud.async_initialize('email_user_1', 'password_user_1')
+    await cloud_user_1.async_initialize()
 
-    # Get a crownstone by name that can dim, and put it on 20% brightness for user 1.
-    crownstone_lamp = cloud.get_crownstone('Lamp', user_id_1)
+    # Get a crownstone by name that can dim, and put it on 20% brightness for user 1
+    crownstone_lamp = cloud_user_1.get_crownstone('Lamp')
     await crownstone_lamp.async_set_brightness(20)
 
     # Login & synchronize data for an other account.
-    user_id_2 = await cloud.async_initialize("email_user_2", "password_user_2")
+    cloud_user_2 = CrownstoneCloud('email_user_2', 'password_user_2', websession)
+    await cloud_user_2.async_initialize()
 
     # Get a crownstone by name and turn it on for user 2.
-    crownstone_tv = cloud.get_crownstone('TV', user_id_2)
+    crownstone_tv = cloud_user_2.get_crownstone('TV')
     await crownstone_tv.async_turn_on()
 
     # If you want to update specific data you can get the cloud data object for your user.
     # This object has all the cloud data for your user saved in it, which was synced with async_initialize()
     # Parts of the data can also be synced individually without touching the other data.
     # To sync all data at once, use async_synchronize() instead.
-    my_cloud_data = cloud.get_cloud_data(user_id_1)
-    # Now find the specific sphere object
-    my_sphere = my_cloud_data.find("my_sphere_name")
+    my_sphere = cloud_user_1.cloud_data.find("my_sphere_name")
     # request to sync only the locations with the cloud
     my_sphere.locations.async_update_location_data()
     # get the keys for this sphere so you can use them with the Crownstone BLE python library
     sphere_keys = my_sphere.async_get_keys()
 
     # Close the aiohttp clientsession after we are done.
-    await cloud.async_close_session()
+    await websession.close()
 
 asyncio.run(main())
 ```
@@ -99,13 +100,13 @@ import logging
 logging.basicConfig(format='%(levelname)s:%(message)s', level=logging.DEBUG)
 
 # Initialize cloud.
-cloud = CrownstoneCloud()
+cloud = CrownstoneCloud('email', 'password')
 # Use 'run_async' to run async functions in sync context.
-# Login & synchronize all cloud data. Save the user id that the function returns for later use.
-my_user_id = run_async(cloud.async_initialize('email', 'password'))
+# Login & synchronize all cloud data.
+run_async(cloud.async_initialize())
 
 # Get a crownstone by name and turn it on.
-crownstone_coffee_machine = cloud.get_crownstone('Coffee machine', my_user_id)
+crownstone_coffee_machine = cloud.get_crownstone('Coffee machine')
 run_async(crownstone_coffee_machine.async_turn_on())
 
 # Close the session after we are done.
@@ -114,29 +115,23 @@ run_async(cloud.async_close_session())
 
 ### Initialization
 
-The Crownstone cloud can be created without any arguments like so:
+The Crownstone cloud is initialized with the email and password of a user:
 ```python
-cloud = CrownstoneCloud()
+cloud = CrownstoneCloud('email', 'password')
 ```
-A new aiohttp session will be created, which has to be closed at the end of the program.
-If you are using this library in existing software that already uses an own websession, you can use this like so:
-```python
-cloud = CrownstoneCloud(websession)
-```
-To log in to the Crownstone Cloud, the following are required:
-
-* User email
-* User password
-
 If you do not yet have a Crownstone account, go to [My Crownstone](https://my.crownstone.rocks) to set one up.
 The email and password are used to re-login after an access token has expired.
 
+You can log into multiple accounts by creating more CrownstoneCloud objects. When doing so, it is recommended to use
+only 1 websession for all your requests. Create a websession and append it as parameter to all your CrownstoneCloud
+objects. Take a look at the async example above.
+```python
+cloud = CrownstoneCloud('email', 'password', websession)
+```
 To log in and get all your Crownstone from the cloud:
 ```python
-await cloud.async_initialize('email', 'password')
+await cloud.async_initialize()
 ```
-This library supports logging in to multiple accounts. Simply call `async_initialize()` again with the email and
-password of the other account. It is only required to call initialize once for each account.
 
 ## Data structure
 
@@ -205,7 +200,7 @@ Example names of Crownstones:
 
 A Crownstone has the following fields in the cloud lib:
 * abilities: Dict
-* state: Float (0..1)
+* state: Int (0..100)
 * name: String
 * unique_id: String
 * cloud_id: String
@@ -232,20 +227,17 @@ A User has the following fields in the cloud lib:
 
 ### Cloud
 
-#### async_initialize(email: String, password: String)
+#### async_initialize()
 > Login and sync all data for the user from the cloud.
 
-#### async_synchronize(user_id: String)
+#### async_synchronize()
 > Synchronize all data for a user. Use case is to update the local data with new data from the cloud.
-> This function is already called in `async_initialize()` for new logins.
+> This function is already called in `async_initialize()`.
 
-#### get_cloud_data(user_id: String)
-> Get the cloud data object for a logged in user.
-
-#### get_crownstone(crownstone_name: String, user_id: String) -> Crownstone
+#### get_crownstone(crownstone_name: String) -> Crownstone
 > Get a Crownstone object by name for a user, if it exists.
 
-#### get_crownstone_by_id(crownstone_id: String, user_id: String) -> Crownstone
+#### get_crownstone_by_id(crownstone_id: String) -> Crownstone
 > Get a Crownstone object by it's id for a user, if it exists.
 
 #### async_close_session()
@@ -349,8 +341,6 @@ Make sure to see the examples above!
 
 ## Testing
 
-### Tests are not up-to-date yet for the newest commit, only run for version 1.2.1.
-
 To run the tests using tox install tox first by running:
 ```console
 $ pip install tox
@@ -359,7 +349,7 @@ To execute the tests cd to the project folder and run:
 ```console
 $ tox
 ```
-To see which parts of the code are covered by the tests, a coverage report is generated after the tests have been successfull.<br>
+To see which parts of the code are covered by the tests, a coverage report is generated after the tests have been successful.<br>
 To see the coverage report run:
 ```console
 $ coverage report

crownstone_cloud/__init__.py

@@ -1,3 +1,4 @@
 """Top level imports."""
 from crownstone_cloud.cloud import CrownstoneCloud
 from crownstone_cloud.util.runners import run_async
+from crownstone_cloud.helpers.aiohttp_client import create_clientsession

crownstone_cloud/cloud.py

@@ -2,56 +2,55 @@
 import logging
 import asyncio
 import aiohttp
-from crownstone_cloud.cloud_models.spheres import Spheres
+from typing import Optional
+from crownstone_cloud.helpers.conversion import password_to_hash
 from crownstone_cloud.cloud_models.crownstones import Crownstone
+from crownstone_cloud.cloud_models.spheres import Spheres
 from crownstone_cloud.helpers.requests import RequestHandler
-from crownstone_cloud.helpers.logins import LoginManager
-from crownstone_cloud.const import CLOUD_DATA
 
 _LOGGER = logging.getLogger(__name__)
 
 
 class CrownstoneCloud:
     """Create a Crownstone cloud instance."""
 
-    def __init__(self, clientsession: aiohttp.ClientSession = None) -> None:
-        # all data per session is stored here
+    def __init__(self, email: str, password: str, clientsession: aiohttp.ClientSession = None) -> None:
+        # Create request handler instance
         self.request_handler = RequestHandler(self, clientsession)
-        self.login_manager = LoginManager(self)
+        # Instance data
+        self.login_data = {'email': email, 'password': password_to_hash(password)}
+        self.access_token: Optional[str] = None
+        self.cloud_data: Optional[Spheres] = None
 
-    async def async_initialize(self, email: str, password: str) -> str or None:
+    async def async_initialize(self) -> None:
         """
         Login to Crownstone API & synchronize all cloud data.
 
         This method is a coroutine.
-        
-        :param email: Crownstone email.
-        :param password: Crownstone password.
-        :return: user_id of the login.
         """
-        # login
-        user_id = await self.login_manager.async_login(email=email, password=password)
-        _LOGGER.debug("Login to Crownstone Cloud successful")
+        # Login
+        login_response = await self.request_handler.request_login(self.login_data)
 
-        # get data
-        await self.async_synchronize(user_id)
+        # Save access token & create cloud data object
+        self.access_token = login_response['id']
+        self.cloud_data = Spheres(self, login_response['userId'])
+        _LOGGER.debug("Login to Crownstone Cloud successful")
 
-        return user_id
+        # Synchronize data
+        await self.async_synchronize()
 
-    async def async_synchronize(self, user_id: str) -> None:
+    async def async_synchronize(self) -> None:
         """
         Sync all data from cloud.
 
         This method is a coroutine.
-
-        :param user_id: The user id of the login.
         """
         _LOGGER.debug("Initiating all cloud data")
         # get the sphere data for this user_id
-        await self.get_cloud_data(user_id).async_update_sphere_data()
+        await self.cloud_data.async_update_sphere_data()
 
         # get the data from the sphere attributes
-        for sphere in self.get_cloud_data(user_id):
+        for sphere in self.cloud_data:
             await asyncio.gather(
                 sphere.async_update_sphere_presence(),
                 sphere.crownstones.async_update_crownstone_data(),
@@ -61,27 +60,15 @@ async def async_synchronize(self, user_id: str) -> None:
             )
         _LOGGER.debug("Cloud data successfully initialized")
 
-    def get_cloud_data(self, user_id: str) -> Spheres:
-        """
-        Get the cloud data object for a specific logged in user.
-
-        :param user_id: The user id of the login.
-        :return: Spheres object. (Cloud data model)
-        """
-        self.login_manager.set_context(user_id)
-
-        return self.login_manager.get_from_context(CLOUD_DATA)
-
-    def get_crownstone(self, crownstone_name, user_id: str) -> Crownstone:
+    def get_crownstone(self, crownstone_name) -> Crownstone:
         """
         Get a crownstone by name without specifying a sphere.
 
         :param crownstone_name: Name of the Crownstone.
-        :param user_id: The user id of the login.
         :return: Crownstone object.
         """
         try:
-            for sphere in self.get_cloud_data(user_id):
+            for sphere in self.cloud_data:
                 for crownstone in sphere.crownstones:
                     if crownstone.name == crownstone_name:
                         return crownstone
@@ -90,16 +77,15 @@ def get_crownstone(self, crownstone_name, user_id: str) -> Crownstone:
         except ValueError:
             _LOGGER.exception("No sphere data available for this login. Use 'async_synchronize' to load user data.")
 
-    def get_crownstone_by_id(self, crownstone_id, user_id: str) -> Crownstone:
+    def get_crownstone_by_id(self, crownstone_id) -> Crownstone:
         """
         Get a crownstone by id without specifying a sphere.
 
         :param crownstone_id: The cloud id of the Crownstone.
-        :param user_id: The user id of the login.
         :return: Crownstone object.
         """
         try:
-            for sphere in self.get_cloud_data(user_id):
+            for sphere in self.cloud_data:
                 return sphere.crownstones[crownstone_id]
         except KeyError:
             _LOGGER.exception("This login_id does not exist. Use 'async_login' to login.")

crownstone_cloud/cloud_models/crownstones.py

@@ -1,5 +1,9 @@
 """Crownstone handler for Crownstone cloud data"""
 from crownstone_cloud.const import DIMMING_ABILITY
+from crownstone_cloud.exceptions import (
+    CrownstoneAbilityError,
+    AbilityError
+)
 from typing import Dict, Any
 import logging
 
@@ -22,7 +26,7 @@ def __iter__(self):
     async def async_update_crownstone_data(self) -> None:
         """Get the crownstones data from the cloud."""
         # include abilities and current switch state in the request
-        data_filter = {"include": ["currentSwitchState", {"abilities": "properties"}]}
+        data_filter = {"include": ["currentSwitchStateV2", {"abilities": "properties"}]}
         # request data
         crownstone_data = await self.cloud.request_handler.get(
             'Spheres', 'ownedStones', filter=data_filter, model_id=self.sphere_id
@@ -107,7 +111,8 @@ def __init__(self, cloud, data: Dict[str, Any]) -> None:
         self.cloud = cloud
         self.data: Dict[str, Any] = data
         self.abilities: Dict[str, CrownstoneAbility] = {}
-        self._context: str = self.cloud.login_manager.get_context()
+        # power usage (W)
+        self.power_usage = None
 
     @property
     def name(self) -> str:
@@ -164,8 +169,6 @@ async def async_turn_on(self) -> None:
 
         This method is a coroutine.
         """
-        # make sure to use the context of what the object was created in.
-        self.cloud.login_manager.set_context(self._context)
         # send a command to the cloud to turn the Crownstone on.
         await self.cloud.request_handler.post(
             'Stones', 'switch', model_id=self.cloud_id, json={"type": "TURN_ON"}
@@ -177,8 +180,6 @@ async def async_turn_off(self) -> None:
 
         This method is a coroutine.
         """
-        # make sure to use the context of what the object was created in.
-        self.cloud.login_manager.set_context(self._context)
         # send a command to the cloud to turn the Crownstone off.
         await self.cloud.request_handler.post(
             'Stones', 'switch', model_id=self.cloud_id, json={"type": "TURN_OFF"}
@@ -192,16 +193,13 @@ async def async_set_brightness(self, brightness: int) -> None:
 
         This method is a coroutine.
         """
-        # make sure to use the context of what the object was created in.
-        self.cloud.login_manager.set_context(self._context)
         # check dimming availability & value, and send a command to the cloud to dim the Crownstone.
         if self.abilities[DIMMING_ABILITY].is_enabled:
             if brightness < 0 or brightness > 100:
                 raise ValueError("Enter a value between 0 and 100")
             else:
                 await self.cloud.request_handler.post(
-                    'Stones', 'switch', model_id=self.cloud_id, json={"type": "PERCENTAGE","percentage": brightness}
+                    'Stones', 'switch', model_id=self.cloud_id, json={"type": "PERCENTAGE", "percentage": brightness}
                 )
         else:
-            _LOGGER.warning("Dimming is not enabled for this crownstone. Go to the crownstone app to enable it")
-            # TODO: raise error, or just try to set brightness anyway?
+            raise CrownstoneAbilityError(AbilityError["NOT_ENABLED"])

crownstone_cloud/cloud_models/spheres.py

@@ -75,7 +75,6 @@ def __init__(self, cloud, data: Dict[str, Any], user_id: str) -> None:
         self.cloud = cloud
         self.data: Dict[str, Any] = data
         self.user_id: str = user_id
-        self._context = self.cloud.login_manager.get_context()
         self.crownstones = Crownstones(self.cloud, self.cloud_id)
         self.locations = Locations(self.cloud, self.cloud_id)
         self.users = Users(self.cloud, self.cloud_id)
@@ -103,8 +102,6 @@ async def async_get_keys(self) -> dict:
 
         This method is a coroutine.
         """
-        # make sure to use the context of what the object was created in.
-        self.cloud.login_manager.set_context(self._context)
         # get & reformat keys.
         keys = await self.cloud.request_handler.get('users', 'keysV2', model_id=self.user_id)
         for key_set in keys:
@@ -120,8 +117,6 @@ async def async_update_sphere_presence(self) -> None:
 
         This method is a coroutine.
         """
-        # make sure to use the context of what the object was created in.
-        self.cloud.login_manager.set_context(self._context)
         # get presence and create a list with user id's who are in the sphere.
         self.present_people = []
         presence_data = await self.cloud.request_handler.get('Spheres', 'presentPeople', model_id=self.cloud_id)