Merged in develop (pull request #31)

Version 0.3.2 release
master
Ensar Sarajcic 2018-10-24 20:22:38 +00:00
commit 04edfcdd90
22 changed files with 190 additions and 78 deletions

View File

@ -14,7 +14,7 @@ def create_account(username, email, password):
:type username: string
:type email: string
:type password: string
:returns: Email confirmation token if creation was successful
:returns: Account and Email confirmation token if creation was successful
:rtype: string
:raises: ValueError if account already exists
"""
@ -24,7 +24,7 @@ def create_account(username, email, password):
account.save()
emailtoken = generate_confirmation_token(account.email)
return emailtoken
return account, emailtoken
raise ValueError("Account with given parameters already exists")
@ -58,6 +58,7 @@ def update_account_role(account_id, role_id):
acc = Account.get(id=account_id)
acc.role_id = role_id
acc.save()
return acc
def create_role(display_name, permissions):
@ -74,6 +75,7 @@ def create_role(display_name, permissions):
"""
role = Role(display_name, permissions)
role.save()
return role
def get_role(role_id):

View File

@ -7,7 +7,7 @@ from calendar import timegm
class Account(db.Model):
__tablename__ = 'accounts'
id = db.Column(db.Integer, primary_key=True)
id = db.Column(db.Integer, primary_key=True, autoincrement=True)
username = db.Column(db.String, index=True, unique=True)
password = db.Column(db.String)
email = db.Column(db.String, index=True, unique=True)
@ -123,7 +123,7 @@ class Account(db.Model):
class Role(db.Model):
__tablename__ = 'roles'
id = db.Column(db.Integer, primary_key=True)
id = db.Column(db.Integer, primary_key=True, autoincrement=True)
display_name = db.Column(db.String, unique=True)
permissions = db.Column(db.ARRAY(db.String))

View File

@ -60,10 +60,9 @@ class RolesResource(ProtectedResource):
@use_args(RoleCreationSchema(), locations=('json',))
@swag_from('swagger/create_role_spec.yaml')
def post(self, args):
success = accounts.create_role(args['display_name'],
args['permissions'])
if success:
return '', 201
created_role = accounts.create_role(args['display_name'],
args['permissions'])
return RoleSchema().dump(created_role), 201
@swag_from('swagger/get_roles_spec.yaml')
def get(self):
@ -77,9 +76,9 @@ class AccountRoleResource(ProtectedResource):
if g.current_account.id == account_id:
abort(403, message='You may not change your own roles',
status='error')
success = accounts.update_account_role(account_id, args['role_id'])
if success:
return '', 204
updated_account = accounts.update_account_role(
account_id, args['role_id'])
return UserSchema().dump(updated_account), 200
class AccountListResource(Resource):
@ -87,7 +86,7 @@ class AccountListResource(Resource):
@swag_from('swagger/create_account_spec.yaml')
def post(self, args):
try:
emailtoken = accounts.create_account(
created_account, emailtoken = accounts.create_account(
args['username'],
args['email'],
args['password'])
@ -101,7 +100,7 @@ class AccountListResource(Resource):
args['email'],
'Please confirm your email',
html)
return '', 201
return UserSchema().dump(created_account), 201
except ValueError:
abort(422, message='Account already exists', status='error')

View File

@ -57,27 +57,25 @@ class DashboardResource(ProtectedResource):
@swag_from('swagger/update_dashboard_spec.yaml')
def put(self, args, dashboard_id):
validate_dashboard_ownership(dashboard_id)
success = dashboard.patch_dashboard(
updated_dashboard = dashboard.patch_dashboard(
g.current_account.id,
dashboard_id,
args['dashboard_data'],
args['active'],
args['name'])
if success:
return '', 204
return DashboardSchema().dump(updated_dashboard), 200
@use_args(DashboardSchema(partial=True), locations=('json',))
@swag_from('swagger/update_dashboard_spec.yaml')
def patch(self, args, dashboard_id):
validate_dashboard_ownership(dashboard_id)
success = dashboard.patch_dashboard(
updated_dashboard = dashboard.patch_dashboard(
g.current_account.id,
dashboard_id,
args.get('dashboard_data'),
args.get('active'),
args.get('name'))
if success:
return '', 204
return DashboardSchema().dump(updated_dashboard), 200
@swag_from('swagger/delete_dashboard_spec.yaml')
def delete(self, dashboard_id):
@ -90,12 +88,11 @@ class DashboardListResource(ProtectedResource):
@use_args(DashboardSchema(), locations=('json',))
@swag_from('swagger/create_dashboard_spec.yaml')
def post(self, args):
success = dashboard.create_dashboard(
created_dashboard = dashboard.create_dashboard(
args['dashboard_data'],
args['name'],
g.current_account.id)
if success:
return '', 201
return DashboardSchema().dump(created_dashboard), 201
@swag_from('swagger/get_dashboards_spec.yaml')
def get(self):
@ -112,7 +109,7 @@ class DashboardWidgetListResource(ProtectedResource):
def post(self, args, dashboard_id):
validate_dashboard_ownership(dashboard_id)
validate_device_ownership(args['device_id'])
success = dashboard.create_widget(
created_widget = dashboard.create_widget(
dashboard_id,
args['device_id'],
args['height'],
@ -121,8 +118,7 @@ class DashboardWidgetListResource(ProtectedResource):
args['y'],
args['chart_type'],
args['filters'])
if success:
return '', 201
return DashboardWidgetSchema().dump(created_widget), 201
@swag_from('swagger/get_dashboard_widgets_spec.yaml')
def get(self, dashboard_id):
@ -143,7 +139,7 @@ class DashboardWidgetResource(ProtectedResource):
def put(self, args, dashboard_id, widget_id):
validate_dashboard_ownership(dashboard_id)
validate_device_ownership(args['device_id'])
success = dashboard.patch_widget(
updated_widget = dashboard.patch_widget(
widget_id,
args['device_id'],
args['height'],
@ -152,8 +148,7 @@ class DashboardWidgetResource(ProtectedResource):
args['y'],
args['chart_type'],
args['filters'])
if success:
return '', 204
return DashboardWidgetSchema().dump(updated_widget), 200
@use_args(DashboardWidgetSchema(partial=True), locations=('json',))
@swag_from('swagger/update_dashboard_widget_spec.yaml')
@ -161,7 +156,7 @@ class DashboardWidgetResource(ProtectedResource):
validate_dashboard_ownership(dashboard_id)
if args.get('device_id') is not None:
validate_device_ownership(args['device_id'])
success = dashboard.patch_widget(
updated_widget = dashboard.patch_widget(
widget_id,
args.get('device_id'),
args.get('height'),
@ -170,8 +165,7 @@ class DashboardWidgetResource(ProtectedResource):
args.get('y'),
args.get('chart_type'),
args.get('filters'))
if success:
return '', 204
return DashboardWidgetSchema().dump(updated_widget), 200
@swag_from('swagger/delete_dashboard_widget_spec.yaml')
def delete(self, dashboard_id, widget_id):

View File

@ -44,7 +44,7 @@ class DeviceResource(ProtectedResource):
@swag_from('swagger/get_device_spec.yaml')
def get(self, device_id):
validate_device_ownership(device_id)
return DeviceSchema().dump(
return DeviceWithConfigurationSchema().dump(
devices.get_device(device_id)), 200
@swag_from('swagger/delete_device_spec.yaml')
@ -68,10 +68,9 @@ class DeviceTypeListResource(ProtectedResource):
if g.current_account.role_id != 1:
abort(403, message='Only admin may create device types',
status='error')
success = devices.create_device_type(
created_device_type = devices.create_device_type(
args['name'])
if success:
return '', 201
return DeviceTypeSchema().dump(created_device_type), 201
@swag_from('swagger/get_device_types_spec.yaml')
def get(self):
@ -94,21 +93,20 @@ class DeviceRecordingResource(ProtectedResource):
@swag_from('swagger/create_device_recording_spec.yaml')
def post(self, device_id):
validate_device_ownership(device_id)
success = devices.create_recording(device_id, request.json)
if success:
return '', 201
created_recording = devices.create_recording_and_return(
device_id, request.json)
return RecordingsSchema().dump(created_recording), 201
class DeviceListResource(ProtectedResource):
@use_args(DeviceSchema(), locations=('json',))
@swag_from('swagger/create_device_spec.yaml')
def post(self, args):
success = devices.create_device(
created_device = devices.create_device(
args['name'],
g.current_account.id,
args['device_type_id'])
if success:
return '', 201
return DeviceSchema().dump(created_device), 201
@swag_from('swagger/get_devices_spec.yaml')
def get(self):
@ -120,9 +118,10 @@ class DeviceConfigurationResource(ProtectedResource):
@swag_from('swagger/update_device_configuration_spec.yaml')
def put(self, device_id):
validate_device_ownership(device_id)
success = devices.set_device_configuration(device_id, request.json)
if success:
return '', 204
updated_device = devices.set_device_configuration(
device_id, request.json)
return DeviceWithConfigurationSchema().dump(
updated_device), 200
@swag_from('swagger/get_device_configuration_spec.yaml')
def get(self, device_id):

View File

@ -14,7 +14,14 @@ parameters:
security: []
responses:
201:
description: Successful creation
description: Success
schema:
type: object
required:
- content
properties:
content:
$ref: '#/definitions/User'
422:
description: Account already exists
schema:

View File

@ -11,5 +11,12 @@ parameters:
type: object
$ref: '#/definitions/DashboardCreation'
responses:
201:
description: Successful creation
200:
description: Success
schema:
type: object
required:
- content
properties:
content:
$ref: '#/definitions/Dashboard'

View File

@ -16,5 +16,12 @@ parameters:
type: object
$ref: '#/definitions/WidgetCreation'
responses:
201:
description: Successful creation
200:
description: Success
schema:
type: object
required:
- content
properties:
content:
$ref: '#/definitions/Widget'

View File

@ -16,4 +16,11 @@ parameters:
$ref: '#/definitions/RecordingCreation'
responses:
201:
description: Successful creation
description: Success
schema:
type: object
required:
- content
properties:
content:
$ref: '#/definitions/Recording'

View File

@ -12,4 +12,11 @@ parameters:
$ref: '#/definitions/DeviceCreation'
responses:
201:
description: Successful creation
description: Success
schema:
type: object
required:
- content
properties:
content:
$ref: '#/definitions/DeviceWithConfig'

View File

@ -12,4 +12,11 @@ parameters:
$ref: '#/definitions/DeviceType'
responses:
201:
description: Successful creation
description: Success
schema:
type: object
required:
- content
properties:
content:
$ref: '#/definitions/DeviceType'

View File

@ -12,4 +12,11 @@ parameters:
$ref: '#/definitions/Role'
responses:
201:
description: Successful creation
description: Success
schema:
type: object
required:
- content
properties:
content:
$ref: '#/definitions/Role'

View File

@ -1,4 +1,4 @@
Deletes a dashboard
Deletes a widget
---
tags:
- Dashboard
@ -8,6 +8,11 @@ parameters:
required: true
type: integer
description: Id of the dashboard
- in: path
name: widget_id
required: true
type: integer
description: Id of the widget
responses:
204:
description: Success

View File

@ -20,5 +20,12 @@ parameters:
role_id:
type: integer
responses:
204:
200:
description: Success
schema:
type: object
required:
- content
properties:
content:
$ref: '#/definitions/User'

View File

@ -16,5 +16,12 @@ parameters:
type: object
$ref: '#/definitions/DashboardCreation'
responses:
204:
200:
description: Success
schema:
type: object
required:
- content
properties:
content:
$ref: '#/definitions/Dashboard'

View File

@ -20,5 +20,12 @@ parameters:
type: object
$ref: '#/definitions/WidgetCreation'
responses:
204:
200:
description: Success
schema:
type: object
required:
- content
properties:
content:
$ref: '#/definitions/Widget'

View File

@ -15,5 +15,12 @@ parameters:
schema:
type: object
responses:
204:
200:
description: Success
schema:
type: object
required:
- content
properties:
content:
$ref: '#/definitions/DeviceWithConfig'

View File

@ -17,6 +17,7 @@ def create_dashboard(dashboard_data, name, account_id):
"""
dashboard = Dashboard(account_id, dashboard_data, name)
dashboard.save()
return dashboard
def get_dashboard(dashboard_id):
@ -49,6 +50,8 @@ def patch_dashboard(account_id, dashboard_id,
dashboard.save()
if active:
set_active_dashboard(account_id, dashboard_id)
dashboard.active = True
return dashboard
def delete_dashboard(dashboard_id):
@ -111,6 +114,7 @@ def create_widget(dashboard_id, device_id, height, width, x, y,
widget = DashboardWidget(dashboard_id, device_id, height, width, x, y,
chart_type, filters)
widget.save()
return widget
def delete_widget(widget_id):
@ -177,4 +181,4 @@ def patch_widget(widget_id, device_id=None, height=None, width=None,
widget.filters = filters
widget.save()
print("Saved widget")
return widget

View File

@ -5,7 +5,7 @@ from sqlalchemy.dialects.postgresql import JSON
class Dashboard(db.Model):
__tablename__ = 'dashboards'
id = db.Column(db.Integer, primary_key=True)
id = db.Column(db.Integer, primary_key=True, autoincrement=True)
dashboard_data = db.Column(JSON, nullable=False)
account_id = db.Column(db.Integer, db.ForeignKey('accounts.id'),
primary_key=True)
@ -121,7 +121,7 @@ class Dashboard(db.Model):
class DashboardWidget(db.Model):
__tablename__ = 'dashboard_widgets'
id = db.Column(db.Integer, primary_key=True)
id = db.Column(db.Integer, primary_key=True, autoincrement=True)
dashboard_id = db.Column(db.Integer, db.ForeignKey('dashboards.id'))
device_id = db.Column(db.Integer, db.ForeignKey('devices.id'))
height = db.Column(db.Integer, nullable=False)

View File

@ -20,6 +20,7 @@ def create_device(name, account_id, device_type=1):
device.save()
device_association = DeviceAssociation(device.id, account_id)
device_association.save()
return device
def create_device_type(name):
@ -33,6 +34,7 @@ def create_device_type(name):
"""
device_type = DeviceType(name)
device_type.save()
return device_type
def set_device_configuration(device_id, configuration_json):
@ -50,6 +52,7 @@ def set_device_configuration(device_id, configuration_json):
device.configuration = configuration_json
device.save()
send_config.delay(device_id, str(configuration_json))
return device
def get_device_configuration(device_id):
@ -173,6 +176,47 @@ def get_device_types():
return DeviceType.get_many()
def parse_raw_json_recording(device_id, json_msg):
"""
Parses raw json recording and creates Recrding object
:param device_id: Id of device
:type device_id: int
:param raw_json: Raw json received
:type raw_json: json
:raises: ValueError if parsing fails
"""
try:
return Recording(device_id=device_id,
record_type=json_msg["record_type"],
record_value=json_msg["record_value"],
recorded_at=json_msg["recorded_at"],
raw_json=json_msg)
except KeyError:
error_type, error_instance, traceback = sys.exc_info()
raise ValueError("JSON parsing failed! Key error: "
+ str(error_instance))
def create_recording_and_return(device_id, raw_json):
"""
Tries to create recording with given parameters and returns it.
Raises error on failure
:param device_id: Id of device
:type device_id: int
:param raw_json: Raw json received
:type raw_json: json
:raises: ValueError if parsing fails or device does not exist
"""
if not Device.exists(id=device_id):
raise ValueError("Device does not exist!")
recording = parse_raw_json_recording(device_id, raw_json)
recording.save()
return recording
def create_recording(device_id, raw_json):
"""
Tries to create recording with given parameters. Raises error on failure
@ -183,18 +227,6 @@ def create_recording(device_id, raw_json):
:type raw_json: json
:raises: ValueError if parsing fails or device does not exist
"""
def parse_raw_json_recording(device_id, json_msg):
try:
return Recording(device_id=device_id,
record_type=json_msg["record_type"],
record_value=json_msg["record_value"],
recorded_at=json_msg["recorded_at"],
raw_json=json_msg)
except KeyError:
error_type, error_instance, traceback = sys.exc_info()
raise ValueError("JSON parsing failed! Key error: "
+ str(error_instance))
if not Device.exists(id=device_id):
raise ValueError("Device does not exist!")

View File

@ -8,7 +8,7 @@ from sqlalchemy.dialects.postgresql import JSON
class Recording(db.Model):
__tablename__ = 'recordings'
id = db.Column(db.Integer, primary_key=True)
id = db.Column(db.Integer, primary_key=True, autoincrement=True)
recorded_at = db.Column(db.DateTime, index=True,
default=db.func.current_timestamp())
received_at = db.Column(db.DateTime, index=True,
@ -115,7 +115,7 @@ class Recording(db.Model):
class Device(db.Model):
__tablename__ = 'devices'
id = db.Column(db.Integer, primary_key=True)
id = db.Column(db.Integer, primary_key=True, autoincrement=True)
created_at = db.Column(db.DateTime,
nullable=False,
default=db.func.current_timestamp())
@ -267,7 +267,7 @@ class DeviceAssociation(db.Model):
class DeviceType(db.Model):
__tablename__ = 'device_types'
id = db.Column(db.Integer, primary_key=True)
id = db.Column(db.Integer, primary_key=True, autoincrement=True)
name = db.Column(db.String, nullable=False)
def __init__(self, name):
@ -320,7 +320,7 @@ class DeviceType(db.Model):
class AccessLevel(db.Model):
__tablename__ = 'access_levels'
id = db.Column(db.Integer, primary_key=True)
id = db.Column(db.Integer, primary_key=True, autoincrement=True)
name = db.Column(db.String, nullable=False)
def __init__(self, name):

View File

@ -2,7 +2,7 @@ import os
# App configuration
DEBUG = os.environ['DEBUG']
APP_VERSION = '0.3.1'
APP_VERSION = '0.3.2'
# Define the application directory
BASE_DIR = os.path.abspath(os.path.dirname(__file__))