def find_users(limit=None, **kwargs):
"""This method is used to retrieve already created User entities.
It queries the database for all users matching the attributes in
kwargs.
limit when None means all matching users will be returned. If limit
is set to a number then all users matching the query will be returned
up to the amount specified by limit.
For each user found an instance of accounts.accounts.User is created
and added to a list. This list is returned at the end of the method.
If no users are found the list will be empty.
Query parameters will be specified by tuples. The first item in a tuple
will be the search operator e.g. '=' and the second item will be
the value for that search operator e.g. 'Smith'
So to search for a list of Users with last name of 'Smith' and
first name of 'John' the function call would be
findUsers(lname=('=','Smith'),fname=('=','John'))
"""
if(limit is not None and limit <= 0):
raise TypeError("limit must be a number greater than 0 or None")
query = UserModel.all()
# for each kwarg filter the query
for key in kwargs:
# check if the UserModel has such an attribute
if not hasattr(UserModel, key):
raise AttributeError("%s attribute doesn't exist" % key)
# check if the attribute is accessible
if key in User.non_accessible_attr:
raise AttributeError("%s attribute is not accessible" % key)
try:
query.filter('%s %s' % (key, kwargs[key][0]), kwargs[key][1])
except IndexError:
raise TypeError("%s=%s is a malformated Query tuple" %
(key, kwargs[key]))
except BadValueError:
raise AttributeError("invalid type for attribute %s" % key)
# set limit to the proper value
if(limit is not None):
if(limit > query.count()):
limit = query.count()
else:
limit = query.count()
# execute the query
results = query.fetch(limit)
# construct instances of the User class for each UserModel returned
users = []
for user_model in results:
user = User()
user._User__UserModel = user_model # pylint: disable=C0103,W0201
users.append(user)
return users
def find_users(limit=None, **kwargs):
"""This method is used to retrieve already created User entities.
It queries the database for all users matching the attributes in
kwargs.
limit when None means all matching users will be returned. If limit
is set to a number then all users matching the query will be returned
up to the amount specified by limit.
For each user found an instance of accounts.accounts.User is created
and added to a list. This list is returned at the end of the method.
If no users are found the list will be empty.
Query parameters will be specified by tuples. The first item in a tuple
will be the search operator e.g. '=' and the second item will be
the value for that search operator e.g. 'Smith'
So to search for a list of Users with last name of 'Smith' and
first name of 'John' the function call would be
findUsers(lname=('=','Smith'),fname=('=','John'))
"""
if (limit is not None and limit <= 0):
raise TypeError("limit must be a number greater than 0 or None")
query = UserModel.all()
# for each kwarg filter the query
for key in kwargs:
# check if the UserModel has such an attribute
if not hasattr(UserModel, key):
raise AttributeError("%s attribute doesn't exist" % key)
# check if the attribute is accessible
if key in User.non_accessible_attr:
raise AttributeError("%s attribute is not accessible" % key)
try:
query.filter('%s %s' % (key, kwargs[key][0]), kwargs[key][1])
except IndexError:
raise TypeError("%s=%s is a malformated Query tuple" %
(key, kwargs[key]))
except BadValueError:
raise AttributeError("invalid type for attribute %s" % key)
# set limit to the proper value
if (limit is not None):
if (limit > query.count()):
limit = query.count()
else:
limit = query.count()
# execute the query
results = query.fetch(limit)
# construct instances of the User class for each UserModel returned
users = []
for user_model in results:
user = User()
user._User__UserModel = user_model # pylint: disable=C0103,W0201
users.append(user)
return users
def create_user(fname, lname, cwruid, password, **kwargs):
"""This method is a factory method for User accounts.
It takes in the required fields of fname, lname,
and cwruid. It queries the database to make sure that the
cwruid is unique. If it is not an AttributeError exception
is raised with the message stating that the cwruid is not
unique. It then generates a string of salt using the
secure random number generator in the Crypto module. The
provided password is then hashed with the salt. All of this
information is added to an instance of a UserModel class
from the application.accounts.models module.
If any optional arguments are supplied through the kwargs
dictionary they are checked against the attributes of the
UserModel class. If the argument matches an attribute
in the UserModel and the attribute is modifiable
outside of the accounts module and the value is valid
for that attribute it is added to the UserModel instance
created during the initial steps. If these conditions are
not met an AttributeError exception is raised with the
message specifying the argument that caused the problem.
Finally the entire UserModel instance is saved to the
datastore via the UserModel's put method. This UserModel
is then stored inside of a new instance of the
application.accounts.accounts.User class.
If everything was successful the User instance is
returned. Otherwise None is returned
"""
query = UserModel.all()
query.filter('cwruid =', cwruid)
# If there is already a user in the database
# with the same cwruID
if(query.count() > 0):
raise AttributeError('CWRU ID %s already exists. ' % cwruid +
'CWRU ID must be unique')
salt = generate_randomkey(256)
hasher = SHA.new(salt + password)
user_model = UserModel(fname=fname,
lname=lname,
cwruid=cwruid,
salt=salt,
hash=hasher.hexdigest())
for key in kwargs:
# the values in non_modifiable_attr
# should not be modified by information
# from outside of this function
if key in User.non_modifiable_attr:
raise AttributeError
try:
if hasattr(user_model, key):
user_model.__setattr__(key, kwargs[key])
except BadValueError:
raise AttributeError("%s has invalid type" % key)
user_model.put()
new_user = User()
new_user._User__UserModel = user_model # pylint: disable=C0103,W0201
return new_user
def create_user(fname, lname, cwruid, password, **kwargs):
"""This method is a factory method for User accounts.
It takes in the required fields of fname, lname,
and cwruid. It queries the database to make sure that the
cwruid is unique. If it is not an AttributeError exception
is raised with the message stating that the cwruid is not
unique. It then generates a string of salt using the
secure random number generator in the Crypto module. The
provided password is then hashed with the salt. All of this
information is added to an instance of a UserModel class
from the application.accounts.models module.
If any optional arguments are supplied through the kwargs
dictionary they are checked against the attributes of the
UserModel class. If the argument matches an attribute
in the UserModel and the attribute is modifiable
outside of the accounts module and the value is valid
for that attribute it is added to the UserModel instance
created during the initial steps. If these conditions are
not met an AttributeError exception is raised with the
message specifying the argument that caused the problem.
Finally the entire UserModel instance is saved to the
datastore via the UserModel's put method. This UserModel
is then stored inside of a new instance of the
application.accounts.accounts.User class.
If everything was successful the User instance is
returned. Otherwise None is returned
"""
query = UserModel.all()
query.filter('cwruid =', cwruid)
# If there is already a user in the database
# with the same cwruID
if (query.count() > 0):
raise AttributeError('CWRU ID %s already exists. ' % cwruid +
'CWRU ID must be unique')
salt = generate_randomkey(256)
hasher = SHA.new(salt + password)
user_model = UserModel(fname=fname,
lname=lname,
cwruid=cwruid,
salt=salt,
hash=hasher.hexdigest())
for key in kwargs:
# the values in non_modifiable_attr
# should not be modified by information
# from outside of this function
if key in User.non_modifiable_attr:
raise AttributeError
try:
if hasattr(user_model, key):
user_model.__setattr__(key, kwargs[key])
except BadValueError:
raise AttributeError("%s has invalid type" % key)
user_model.put()
new_user = User()
new_user._User__UserModel = user_model # pylint: disable=C0103,W0201
return new_user
