Merge pull request #1 from tikismoke/patch-1

Support API V4

Author: tikismoke

README.md

@@ -19,28 +19,39 @@ from xee import Xee
 
 xee = Xee(client_id="your_client_id", 
 		client_secret="your_client_secret", 
-		redirect_uri="your://redirect:uri")
+		redirect_uri="your://redirect:uri",
+		scope=(
+              AuthScope.VEHICLES_READ,
+              AuthScope.VEHICLES_READ_SIGNALS,
+              AuthScope.VEHICLES_READ_LOCATIONS,
+              AuthScope.VEHICLES_READ_EVENTS,
+              AuthScope.VEHICLES_READ_ACCELEROMETERS,
+              AuthScope.VEHICLES_READ_DEVICE_DATA,
+              AuthScope.ACCOUNT_READ,
+              AuthScope.VEHICLES_MANAGEMENT
+          	  )
+		  )
 ```
 
 ## Using the SDK
 
 ### Authentication
 
-#### Getting the [access code url](https://github.com/xee-lab/xee-api-docs/tree/master/api/api/v3/auth/auth.md)
+#### Getting the [access code url](https://dev.xee.com/v4-openapi/#section/Authentication/Authorization-Code-flow)
 
 ```python
 login_url = xee.get_authentication_url()
 ```
 
 > Then show the webpage to the end user, once the process is complete, we'll redirect to `redirect_uri?code={authorization_code}`. Keep this code in mind
 
-#### Getting a [token from an `authorization_code`](https://github.com/xee-lab/xee-api-docs/tree/master/api/api/v3/auth/access_token.md)
+#### Getting a [token from an `authorization_code`](https://dev.xee.com/v4-openapi/#section/Authentication/Authorization-Code-flow)
 
 ```python
 token, error = xee.get_token_from_code(authorization_code)
 ```
 
-#### Getting a [token from an `refresh_token`](https://github.com/xee-lab/xee-api-docs/tree/master/api/api/v3/auth/access_token.md)
+#### Getting a [token from an `refresh_token`](https://dev.xee.com/v4-openapi/#section/Authentication/Refresh-Token)
 
 ```python
 token, error = xee.get_token_from_refresh_token(token.refresh_token)
@@ -62,7 +73,7 @@ print(status)
 ```
 
 ```python
-signal, error = xee.get_signals(carId, token.access_token,names=['Odometer', 'FuelLevel'])
+signal, error = xee.get_signals(carId, token.access_token)
 print(signal)
 ```
 
@@ -71,7 +82,6 @@ trip_duration, error = xee.get_trip_duration(tripId, token.access_token)
 print(trip_duration.value)
 ```
 
-See the [docs](https://github.com/quentin7b/xee-sdk-python/docs) for more about how to use it
 
 ## Contributing
 

requirements.txt

@@ -1,2 +1,7 @@
 isodate
 requests
+enum
+base64
+arrow
+oauthlib
+requests_oauthlib

xee/__init__.py

@@ -6,3 +6,16 @@
 """
 
 from .sdk import Xee
+
+from enum import Enum
+
+class AuthScope(Enum):
+    """Authorization scopes."""
+    VEHICLES_MANAGEMENT = "vehicles.management"
+    VEHICLES_READ = "vehicles.read"
+    VEHICLES_READ_SIGNALS = "vehicles.signals.read"
+    VEHICLES_READ_LOCATIONS = "vehicles.locations.read"
+    VEHICLES_READ_EVENTS = "vehicles.events.read"
+    VEHICLES_READ_ACCELEROMETERS = "vehicles.accelerometers.read"
+    VEHICLES_READ_DEVICE_DATA = "vehicles.devices-data.read"
+    ACCOUNT_READ = "account.read"

xee/entities.py

@@ -20,27 +20,28 @@
 User = collections.namedtuple(
     'User',
     [
-        'id',
-        'last_name',
-        'first_name',
-        'nick_name',
+        'createdAt',
+        'email',
+        'firstName',
         'gender',
-        'birth_date',
-        'licence_delivery_date',
-        'role',
-        'is_location_enabled'
+        'id',
+        'lastName',
+        'updatedAt'
     ])
 Car = collections.namedtuple(
     'Car',
     [
+        'brand',
+        'createdAt',
+        'firstEntryIntoService',
+        'fleetId',
         'id',
-        'name',
-        'make',
+        'kType',
+        'licensePlate',
         'model',
-        'year',
-        'number_plate',
-        'device_id',
-        'cardb_id'
+        'name',
+        'updatedAt',
+        'userId'
     ])
 Signal = collections.namedtuple(
     'Signal',
@@ -57,6 +58,7 @@
         'altitude',
         'satellites',
         'heading',
+        'hacc',
         'date'
     ])
 Accelerometer = collections.namedtuple(
@@ -162,23 +164,16 @@ def parse_user(user):
         If the dict does not contains the correct data.
 
     """
-    birth_date = None
-    if user['birthDate']:
-        birth_date = isodate.parse_datetime(user['birthDate'])
-    licence_delivery_date = None
-    if user['licenseDeliveryDate']:
-        licence_delivery_date = isodate.parse_datetime(user['licenseDeliveryDate'])
+    print("user=",user)
     try:
         return User(
-            user['id'],
-            user['lastName'],
+            user['createdAt'],
+            user['email'],
             user['firstName'],
-            user['nickName'],
             user['gender'],
-            birth_date,
-            licence_delivery_date,
-            user['role'],
-            user['isLocationEnabled']
+            user['id'],
+            user['lastName'],
+            user['updatedAt']
         )
     except ValueError as err:
         raise xee_exceptions.ParseException(err)
@@ -207,14 +202,17 @@ def parse_car(car):
     """
     try:
         return Car(
+            car['brand'],
+            car['createdAt'],
+            car['firstEntryIntoService'],
+            car['fleetId'],
             car['id'],
-            car['name'],
-            car['make'],
+            car['kType'],
+            car['licensePlate'],
             car['model'],
-            car['year'],
-            car['numberPlate'],
-            car['deviceId'],
-            car['cardbId']
+            car['name'],
+            car['updatedAt'],
+            car['userId']
         )
     except ValueError as err:
         raise xee_exceptions.ParseException(err)
@@ -277,8 +275,9 @@ def parse_location(location):
             location['latitude'],
             location['longitude'],
             location['altitude'],
-            location['satellites'],
+            location['nbSat'],
             location['heading'],
+            location['hacc'],
             isodate.parse_datetime(location['date'])
         )
     except ValueError as err:

xee/exceptions.py

@@ -18,11 +18,10 @@ class APIException(Exception):
         see https://github.com/xee-lab/xee-api-docs/tree/master/api/api/v3#errors
     """
 
-    def __init__(self, type_, message, tip):
-        super(APIException, self).__init__(message)
-        self.type = type_
-        self.message = message
-        self.tip = tip
+    def __init__(self, error, error_description):
+        super(APIException, self).__init__(error_description)
+        self.error = error
+        self.error_description = error_description
 
     def __str__(self):
         return str(self.__dict__)