class Currency(db.Model):
code = db.Column(db.String(3), primary_key=True)
country = db.Column(db.String(50), nullable=False)
rate = db.Column(db.Numeric(12, 6), nullable=False)
# relationships --------------------------------------
stores = db.relationship('Store', backref='currency')
orders = db.relationship('Order', backref='currency')
class User(UserMixin, db.Model):
''' Table of everyone capable of logging in to the system '''
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(100), unique=True, nullable=False)
email = db.Column(db.String(100), unique=True, nullable=False)
password = db.Column(db.String(200), nullable=False)
active = db.Column(db.Boolean, default=True)
# relationships --------------------------------------
orders = db.relationship('Order', backref='user')
roles = db.relationship(
'Role', secondary=roles_users,
backref=db.backref('users', lazy='dynamic'))
stores = db.relationship('Store', backref='user')
@property
def is_authenticated(self):
return True
@property
def is_active(self):
if self.active:
return True
return False
def get_id(self):
return str(self.id)
def __repr__(self):
return '<User {}>'.format(self.name)
class AccountDetail(db.Model):
id = db.Column(db.Integer, primary_key=True)
account_name = db.Column(db.String(50), nullable=False)
account_num = db.Column(db.Integer, nullable=False)
bank = db.Column(db.String(100), nullable=False)
sub_number = db.Column(db.Integer)
sub_id = db.Column(db.Integer, )
# relationships --------------------------------------
stores = db.relationship('Store', backref='account')
dispatchers = db.relationship('Dispatcher', backref='account')
class Order(db.Model):
'''
Table of orders: status can be one of
* `cart`: The order havenot been checked-out
* `placed`: It has been checkout, but not yet paid for
* `paid`: It has been fully paid for
* `dispatched`: It has been handed to the dispatcher
* `fulfilled`: It has been delivered to the customer
Note:
* When the `PAYMENT_SPLIT_POINT = 'instant'`, the `dispatched`
and `fulfiled` status are not used.
'''
id = db.Column(db.Integer, primary_key=True)
user_id = db.Column(db.Integer, db.ForeignKey('user.id'), nullable=False)
iso_code = db.Column(db.Integer,
db.ForeignKey('currency.code'),
nullable=False)
status = db.Column(db.String(5), default='open', nullable=False)
amount = db.Column(db.String(20))
created_at = db.Column(db.DateTime(), default=datetime.utcnow())
last_modified_at = db.Column(db.DateTime(), default=datetime.utcnow())
# relationship ---------------
orderlines = db.relationship('OrderLine', backref='order')
@classmethod
def cart(cls):
# only products from active stores are made public
return (Order.query.filter(Order.status == 'open'))
class Store(db.Model):
'''
Table of stores information. Key features are:
- A User is permitted to register more than one store
- A Store is given assigned a dispatch ride
'''
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(50), nullable=False)
# Yes, images are stored on the database
# from experience, it is preferrable a scenario like this
logo = db.Column(db.BLOB)
about = db.Column(db.String(150), nullable=False)
iso_code = db.Column(db.Integer,
db.ForeignKey('currency.code'),
nullable=False)
account_id = db.Column(db.Integer, db.ForeignKey('account_detail.id'))
dispatcher_id = db.Column(db.Integer,
db.ForeignKey('dispatcher.id'),
nullable=False)
user_id = db.Column(db.Integer, db.ForeignKey('user.id'), nullable=False)
phone = db.Column(db.String(15), nullable=False)
email = db.Column(db.String(100), nullable=False)
created_at = db.Column(db.DateTime(), default=datetime.utcnow())
is_active = db.Column(db.Boolean(), default=True)
# relationships --------------------------------------
products = db.relationship('Product', backref='store')
@classmethod
def public(cls):
# only products from active stores are made public
return (Store.query.filter(Store.is_active == 1))
class Dispatcher(db.Model):
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(100), unique=True, nullable=False)
charge = db.Column(db.Integer, nullable=False)
phone = db.Column(db.String(15), nullable=False)
email = db.Column(db.String(100), nullable=False)
account_id = db.Column(db.Integer, db.ForeignKey('account_detail.id'))
is_active = db.Column(db.Boolean(), default=True)
# relationships --------------------------------------
stores = db.relationship('Store', backref='dispatcher')
class Ticket(db.Model):
id = db.Column(db.Integer, primary_key=True)
email = db.Column(db.String(120), unique=True, nullable=False)
name = db.Column(db.String(120), nullable=False)
email = db.Column(db.String(120), nullable=False)
subject = db.Column(db.String(120), nullable=False)
message = db.Column(db.String(120), nullable=False)
type = db.Column(db.String(120), nullable=False)
urgency = db.Column(db.String(120), nullable=False)
status = db.Column(db.String(120), nullable=False)
created_at = db.Column(db.DateTime, nullable=False, default=func.now())
comments = db.relationship('Comment', backref='comments', lazy=True)
def __repr__(self):
return '<id: %r, email: %r, subject: %r>' % (self.id, self.email,
self.subject)
class Product(db.Model):
'''
Table of all Products from all stores.
When `PRODUCT_PRICING = 'localize'`, the product prices
will be converted from their store currencies to the
visitor's currency. 4 currencies (GBP, KES, NGN, USA,
are currently supported, and the applicable one defaults to the
automatically computed ISO CODE based on the visitor's IP location,
and when the detected ISO_CODE is not part of the supported
currencies, the product prices are served in USD.
'''
id = db.Column(db.Integer, primary_key=True)
name = db.Column(db.String(100))
price = db.Column(db.Numeric(20, 2))
description = db.Column(db.String(200))
# Yes, images are stored on the database
# from experience, it is preferrable a scenario like this
image = db.Column(db.BLOB)
store_id = db.Column(db.Integer, db.ForeignKey('store.id'), nullable=False)
is_active = db.Column(db.Boolean, default=False)
created_at = db.Column(db.DateTime(), default=datetime.utcnow())
last_modified_at = db.Column(db.DateTime, default=datetime.utcnow())
# relationships ---------------------------------------------
orderlines = db.relationship('OrderLine', backref='product')
@classmethod
def public(cls):
# only active products are made public
return (Product.query.filter(Product.is_active == 1))
def sale_price(self, product_pricing, to_currency, multi_currency):
'''
Converts price of products to visitor's currency based on scale
'''
if (product_pricing == 'localize' and multi_currency):
scale = (Currency.query.filter_by(code=to_currency).first().rate /
self.store.currency.rate)
return round(self.price * scale, 2)
return self.price