def getServicesSegmented(self, offset, limit):
"""Get all services, segmented
Uses :func:`~app.DAOs.ServiceDAO.ServiceDAO.getServicesSegmented` as well as:
* :func:`~app.handlers.SharedValidationFunctions.validate_offset_limit`
* :func:`~app.handlers.ServiceHandler._buildCoreServiceResponse`
:param offset: Number of results to skip from top of list.
:type offset: int
:param limit: Number of results to return. Default = 20.
:type limit: int
:returns JSON Response Object: JSON Response Object containing success or error response.
"""
try:
SVF.validate_offset_limit(offset=offset, limit=limit)
except ValueError as ve:
return jsonify(Error=str(ve)), 400
dao = ServiceDAO()
services = dao.getServicesSegmented(offset=offset, limit=limit)
if not services:
response = {'services': None}
else:
service_list = []
for row in services:
service_list.append(_buildCoreServiceResponse(row))
response = {'services': service_list}
return jsonify(response)
def getServicesByKeywords(self, searchstring, offset, limit=20):
"""
Get all services by keyword, segmented
Uses :func:`~app.DAOs.ServiceDAO.ServiceDAO.getServicesByKeywords` as well as
:func:`~app.handlers.ServiceHandler._buildServiceResponse`
:param searchstring: Keyword to search for services.
:type offset: string
:param offset: Number of results to skip from top of list.
:type offset: int
:param limit: Number of results to return. Default = 20.
:type limit: int
:returns JSON Response Object: JSON Response Object containing success
or error response.
"""
try:
SVF.validate_offset_limit(offset=offset, limit=limit)
keywords = SVF.processSearchString(searchstring=searchstring)
except ValueError as ve:
return jsonify(Error=str(ve)), 400
dao = ServiceDAO()
services = dao.getServicesByKeywords(searchstring=keywords,
offset=offset,
limit=limit)
if not services:
response = {'services': None}
else:
service_list = []
for row in services:
service_list.append(
_buildCoreServiceResponse(service_tuple=row))
response = {'services': service_list}
return jsonify(response)
def getServicesByRoomID(self, rid, no_json=False):
"""Return the Service entry belonging to the specified rid.
Uses :func:`~app.DAOs.ServiceDAO.ServiceDAO.getServicesByRoomID` as well as
:func:`~app.handlers.ServiceHandler._buildServiceByRoomResponse`
:param rid: Room ID
:type rid: int
:param no_json: States whether or not to return the successful response as a dictionary.
:type no_json: bool
:returns JSON Response Object: JSON Response Object containing success or error response.
"""
dao = ServiceDAO()
services = dao.getServicesByRoomID(rid=rid)
serviceInfo = []
for row in services:
serviceInfo.append(_buildServiceByRoomResponse(row))
if no_json:
return (serviceInfo)
if len(serviceInfo) > 0:
return jsonify({"services": serviceInfo})
else:
return jsonify({"services": None})
def getServiceByID(self, sid, no_json=False):
"""Return the Service entry belonging to the specified sid.
Uses:
* :func:`~app.DAOs.ServiceDAO.ServiceDAO.getServiceByID`
* :func:`~app.handlers.ServiceHandler._buildCoreServiceResponse`
:param sid: Service ID
:type sid: int
:param no_json: States whether or not to return the successful response as a dictionary.
:type no_json: bool
:returns JSON Response Object: JSON Response Object containing success or error response.
"""
dao = ServiceDAO()
service = dao.getServiceByID(sid=sid)
if not service:
return jsonify(Error='Service does not exist: sid=' +
str(sid)), 404
else:
response = _buildCoreServiceResponse(service_tuple=service)
if no_json:
return response
return jsonify(response)
def deleteService(self, sid, uid):
"""
Attempt to delete a service.
Uses :func:`~app.DAOs.ServiceDAO.ServiceDAO.deleteService` and
:func:`~app.handlers.ServiceHandler._buildCoreServiceResponse`
:param uid: User ID.
:type uid: int
:param sid: Service ID.
:type uid: int
* rid (room ID)
* sname
* sdescription
* sschedule
* Websites
* PNumbers
:type json: JSON
:returns JSON Response Object: JSON Response Object containing success
or error response.
"""
dao = ServiceDAO()
service = dao.deleteService(sid, uid=uid)
if service is not None:
return jsonify(_buildCoreServiceResponse(service))
return jsonify(Error="No service with that ID"), 404
def updateServiceInformation(self, sid, json, uid):
"""Attempt to update a service.
Uses :func:`~app.DAOs.ServiceDAO.ServiceDAO.updateServiceInformation` as well as
:func:`~app.handlers.ServiceHandler._buildServiceResponse`
:param uid: User ID.
:type uid: int
:param json: JSON object with the following keys:
* rid (room ID)
* sname
* sdescription
* sschedule
* websites
* numbers
:type json: JSON
:returns JSON Response Object: JSON Response Object containing success or error response.
"""
service = {}
for key in json:
#TODO:Insert Try catch statement
if key in UPDATESERVICEKEYS:
service[key] = (json[key])
dao = ServiceDAO()
id = dao.updateServiceInformation(service=service, sid=sid, uid=uid)
if id is not None:
if not isinstance(id[0], int):
if isinstance(id, tuple):
return id
return jsonify(id)
else:
response = _buildCoreServiceResponse(dao.getServiceByID(id[0]))
return jsonify(response)
else:
return jsonify(Error="no service with that ID found")
def createService(self, json, uid):
"""
Attempt to create a service.
Uses :func:`~app.DAOs.ServiceDAO.ServiceDAO.createService` as well as:
* :func:`~app.handlers.PhoneHandler.PhoneHandler.unpackPhones`
* :func:`~app.handlers.WebsiteHandler.WebsiteHandler.unpackWebsites`
:param uid: User ID.
:type uid: int
:param json: JSON object with the following keys:
* rid (room ID)
* sname
* sdescription
* sschedule
* Websites
* PNumbers
:type json: JSON
:returns JSON Response Object: JSON Response Object containing result of insertion
or :func:`~app.handlers.ServiceHandler.ServiceHandler.getServiceByID`
"""
# TODO:SHOULD TAKE PARAMETERS DINAMICALLY CHECKING FOR KEYS
# for key in CREATESERVICEKEYS:
# if key not in json:
# return jsonify(Error="Error in credentials from submission: "+ str(key)), 400
try:
websites = WebsiteHandler().unpackWebsites(json=json['websites'])
if len(websites) > 10:
return jsonify(Error="Improper number of websites provided: " +
str(len(websites))), 400
except TypeError:
return jsonify(Error="Error in input Parameters (websites)"), 400
except KeyError as e:
return jsonify(Error=str(e)), 400
try:
phones = PhoneHandler().unpackPhones(json=json['numbers'])
if len(websites) > 10:
return jsonify(Error="Improper number of websites provided: " +
str(len(websites))), 400
except TypeError:
return jsonify(Error="Error in input Parameters (numbers)"), 400
except KeyError as e:
return jsonify(Error=str(e)), 400
# MAKE DICTIONARY TO CRREATE THESE
user = uid
roomID = json['rid']
name = json['sname']
description = json['sdescription']
schedule = json['sschedule']
dao = ServiceDAO()
sid = dao.createService(uid=user,
rid=roomID,
sname=name,
sdescription=description,
sschedule=schedule,
websites=websites,
numbers=phones)
try:
if isinstance(sid[0], int):
return (self.getServiceByID(sid[0])), 201
else:
return jsonify(Error=sid)
except:
return jsonify(Error="Unique service violation " + str(sid))