class User(UserMixin, ResourceMixin, db.Model): ROLE = OrderedDict([ ('member', 'Member'), ('admin', 'Admin') ]) __tablename__ = 'users' id = db.Column(db.Integer, primary_key=True) # Relationships. credit_card = db.relationship(CreditCard, uselist=False, backref='users', passive_deletes=True) subscription = db.relationship(Subscription, uselist=False, backref='users', passive_deletes=True) invoices = db.relationship(Invoice, backref='users', passive_deletes=True) # Authentication. role = db.Column(db.Enum(*ROLE, name='role_types', native_enum=False), index=True, nullable=False, server_default='member') active = db.Column('is_active', db.Boolean(), nullable=False, server_default='1') username = db.Column(db.String(24), unique=True, index=True) email = db.Column(db.String(255), unique=True, index=True, nullable=False, server_default='') password = db.Column(db.String(128), nullable=False, server_default='') # Billing. name = db.Column(db.String(128), index=True) payment_id = db.Column(db.String(128), index=True) cancelled_subscription_on = db.Column(AwareDateTime()) # Activity tracking. sign_in_count = db.Column(db.Integer, nullable=False, default=0) current_sign_in_on = db.Column(AwareDateTime()) current_sign_in_ip = db.Column(db.String(45)) last_sign_in_on = db.Column(AwareDateTime()) last_sign_in_ip = db.Column(db.String(45)) def __init__(self, **kwargs): # Call Flask-SQLAlchemy's constructor. super(User, self).__init__(**kwargs) self.password = User.encrypt_password(kwargs.get('password', '')) def __repr__(self): """ Create a human readable version of a User instance. :return: self """ return f'<User {self.username}>' @classmethod def find_by_identity(cls, identity): """ Find a user by their e-mail or username. :param identity: Email or username :type identity: str :return: User instance """ return User.query.filter( (User.email == identity) | (User.username == identity)).first() @classmethod def encrypt_password(cls, plaintext_password): """ Hash a plaintext string using PBKDF2. This is good enough according to the NIST (National Institute of Standards and Technology). In other words while bcrypt might be superior in practice, if you use PBKDF2 properly (which we are), then your passwords are safe. :param plaintext_password: Password in plain text :type plaintext_password: str :return: str """ if plaintext_password: return generate_password_hash(plaintext_password) return None @classmethod def deserialize_token(cls, token): """ Obtain a user from de-serializing a signed token. :param token: Signed token. :type token: str :return: User instance or None """ private_key = TimedJSONWebSignatureSerializer( current_app.config['SECRET_KEY']) try: decoded_payload = private_key.loads(token) return User.find_by_identity(decoded_payload.get('user_email')) except Exception: return None @classmethod def initialize_password_reset(cls, identity): """ Generate a token to reset the password for a specific user. :param identity: User e-mail address or username :type identity: str :return: User instance """ u = User.find_by_identity(identity) reset_token = u.serialize_token() # This prevents circular imports. from snakeeyes.blueprints.user.tasks import ( deliver_password_reset_email) deliver_password_reset_email.delay(u.id, reset_token) return u def is_active(self): """ Return whether or not the user account is active, this satisfies Flask-Login by overwriting the default value. :return: bool """ return self.active def get_auth_token(self): """ Return the user's auth token. Use their password as part of the token because if the user changes their password we will want to invalidate all of their logins across devices. It is completely fine to use md5 here as nothing leaks. This satisfies Flask-Login by providing a means to create a token. :return: str """ private_key = current_app.config['SECRET_KEY'] serializer = URLSafeTimedSerializer(private_key) data = [str(self.id), md5(self.password.encode('utf-8')).hexdigest()] return serializer.dumps(data) def authenticated(self, with_password=True, password=''): """ Ensure a user is authenticated, and optionally check their password. :param with_password: Optionally check their password :type with_password: bool :param password: Optionally verify this as their password :type password: str :return: bool """ if with_password: return check_password_hash(self.password, password) return True def serialize_token(self, expiration=3600): """ Sign and create a token that can be used for things such as resetting a password or other tasks that involve a one off token. :param expiration: Seconds until it expires, defaults to 1 hour :type expiration: int :return: JSON """ private_key = current_app.config['SECRET_KEY'] serializer = TimedJSONWebSignatureSerializer(private_key, expiration) return serializer.dumps({'user_email': self.email}).decode('utf-8') def update_activity_tracking(self, ip_address): """ Update various fields on the user that's related to meta data on their account, such as the sign in count and ip address, etc.. :param ip_address: IP address :type ip_address: str :return: SQLAlchemy commit results """ self.sign_in_count += 1 self.last_sign_in_on = self.current_sign_in_on self.last_sign_in_ip = self.current_sign_in_ip self.current_sign_in_on = datetime.datetime.now(pytz.utc) self.current_sign_in_ip = ip_address return self.save() @classmethod def search(cls, query): """ Search a resource by 1 or more fields. :param query: Search query :type query: str :return: SQLAlchemy filter """ search_query = '%{0}%'.format(query) search_chain = (User.email.ilike(search_query), User.username.ilike(search_query)) return or_(*search_chain) @classmethod def is_last_admin(cls, user, new_role, new_active): """ Determine whether or not this user is the last admin account. :param user: User being tested :type user: User :param new_role: New role being set :type new_role: str :param new_active: New active status being set :type new_active: bool :return: bool """ is_changing_roles = user.role == 'admin' and new_role != 'admin' is_changing_active = user.active is True and new_active is None if is_changing_roles or is_changing_active: admin_count = User.query.filter(User.role == 'admin').count() active_count = User.query.filter(User.is_active is True).count() if admin_count == 1 or active_count == 1: return True return False @classmethod def bulk_delete(cls, ids): """ Override the general bulk_delete method because we need to delete them one at a time while also deleting them on Stripe. :param ids: List of ids to be deleted :type ids: list :return: int """ delete_count = 0 for id in ids: user = User.query.get(id) if user is None: continue if user.payment_id is None: user.delete() else: subscription = Subscription() cancelled = subscription.cancel(user=user) # If successful, delete it locally. if cancelled: user.delete() delete_count += 1 return delete_count
class CreditCard(ResourceMixin, db.Model): IS_EXPIRING_THRESHOLD_MONTHS = 2 __tablename__ = 'credit_cards' id = db.Column(db.Integer, primary_key=True) # Relationships. user_id = db.Column(db.Integer, db.ForeignKey('users.id', onupdate='CASCADE', ondelete='CASCADE'), index=True, nullable=False) user = db.relationship('User') # Card details. brand = db.Column(db.String(32)) last4 = db.Column(db.Integer) exp_date = db.Column(db.Date, index=True) is_expiring = db.Column(db.Boolean(), nullable=False, server_default='0') def __init__(self, **kwargs): # Call Flask-SQLAlchemy's constructor. super(CreditCard, self).__init__(**kwargs) @classmethod def is_expiring_soon(cls, compare_date=None, exp_date=None): """ Determine whether or not this credit card is expiring soon. :param compare_date: Date to compare at :type compare_date: date :param exp_date: Expiration date :type exp_date: date :return: bool """ return exp_date <= timedelta_months( CreditCard.IS_EXPIRING_THRESHOLD_MONTHS, compare_date=compare_date) @classmethod def mark_old_credit_cards(cls, compare_date=None): """ Mark credit cards that are going to expire soon or have expired. :param compare_date: Date to compare at :type compare_date: date :return: Result of updating the records """ today_with_delta = timedelta_months( CreditCard.IS_EXPIRING_THRESHOLD_MONTHS, compare_date) CreditCard.query.filter(CreditCard.exp_date <= today_with_delta) \ .update({CreditCard.is_expiring: True}) return db.session.commit() @classmethod def extract_card_params(cls, customer): """ Extract the credit card info from a payment customer object. :param customer: Payment customer :type customer: Payment customer :return: dict """ card_data = customer.sources.data[0] exp_date = datetime.date(card_data.exp_year, card_data.exp_month, 1) card = { 'brand': card_data.brand, 'last4': card_data.last4, 'exp_date': exp_date, 'is_expiring': CreditCard.is_expiring_soon(exp_date=exp_date) } return card
class Subscription(ResourceMixin, db.Model): __tablename__ = 'subscriptions' id = db.Column(db.Integer, primary_key=True) # Relationships. user_id = db.Column(db.Integer, db.ForeignKey('users.id', onupdate='CASCADE', ondelete='CASCADE'), index=True, nullable=False) user = db.relationship('User') # Subscription details. plan = db.Column(db.String(128)) coupon = db.Column(db.String(128)) def __init__(self, **kwargs): # Call Flask-SQLAlchemy's constructor. super(Subscription, self).__init__(**kwargs) @classmethod def get_plan_by_id(cls, plan): """ Pick the plan based on the plan identifier. :param plan: Plan identifier :type plan: str :return: dict or None """ for key, value in settings.STRIPE_PLANS.items(): if value.get('id') == plan: return settings.STRIPE_PLANS[key] return None @classmethod def get_new_plan(cls, keys): """ Pick the plan based on the plan identifier. :param keys: Keys to look through :type keys: list :return: str or None """ for key in keys: split_key = key.split('submit_') if isinstance(split_key, list) and len(split_key) == 2: if Subscription.get_plan_by_id(split_key[1]): return split_key[1] return None def create(self, user=None, name=None, plan=None, coupon=None, token=None): """ Create a recurring subscription. :param user: User to apply the subscription to :type user: User instance :param name: User's billing name :type name: str :param plan: Plan identifier :type plan: str :param coupon: Coupon code to apply :type coupon: str :param token: Token returned by JavaScript :type token: str :return: bool """ if token is None: return False if coupon: self.coupon = coupon.upper() customer = PaymentCustomer.create(token=token, email=user.email, plan=plan, coupon=self.coupon) # Update the user account. user.payment_id = customer.id user.name = name user.previous_plan = plan user.coins = add_subscription_coins( user.coins, Subscription.get_plan_by_id(user.previous_plan), Subscription.get_plan_by_id(plan), user.cancelled_subscription_on) user.cancelled_subscription_on = None # Set the subscription details. self.user_id = user.id self.plan = plan # Redeem the coupon. if coupon: coupon = Coupon.query.filter(Coupon.code == self.coupon).first() coupon.redeem() # Create the credit card. credit_card = CreditCard(user_id=user.id, **CreditCard.extract_card_params(customer)) db.session.add(user) db.session.add(credit_card) db.session.add(self) db.session.commit() return True def update(self, user=None, coupon=None, plan=None): """ Update an existing subscription. :param user: User to apply the subscription to :type user: User instance :param coupon: Coupon code to apply :type coupon: str :param plan: Plan identifier :type plan: str :return: bool """ PaymentSubscription.update(user.payment_id, coupon, plan) user.previous_plan = user.subscription.plan user.subscription.plan = plan user.coins = add_subscription_coins( user.coins, Subscription.get_plan_by_id(user.previous_plan), Subscription.get_plan_by_id(plan), user.cancelled_subscription_on) if coupon: user.subscription.coupon = coupon coupon = Coupon.query.filter(Coupon.code == coupon).first() if coupon: coupon.redeem() db.session.add(user.subscription) db.session.commit() return True def cancel(self, user=None, discard_credit_card=True): """ Cancel an existing subscription. :param user: User to apply the subscription to :type user: User instance :param discard_credit_card: Delete the user's credit card :type discard_credit_card: bool :return: bool """ PaymentSubscription.cancel(user.payment_id) user.payment_id = None user.cancelled_subscription_on = datetime.datetime.now(pytz.utc) user.previous_plan = user.subscription.plan db.session.add(user) db.session.delete(user.subscription) # Explicitly delete the credit card because the FK is on the # user, not subscription so we can't depend on cascading deletes. # This is for cases where you may want to keep a user's card # on file even if they cancelled. if discard_credit_card: db.session.delete(user.credit_card) db.session.commit() return True def update_payment_method(self, user=None, credit_card=None, name=None, token=None): """ Update the subscription. :param user: User to modify :type user: User instance :param credit_card: Card to modify :type credit_card: Credit Card instance :param name: User's billing name :type name: str :param token: Token returned by JavaScript :type token: str :return: bool """ if token is None: return False customer = PaymentCard.update(user.payment_id, token) user.name = name # Update the credit card. new_card = CreditCard.extract_card_params(customer) credit_card.brand = new_card.get('brand') credit_card.last4 = new_card.get('last4') credit_card.exp_date = new_card.get('exp_date') credit_card.is_expiring = new_card.get('is_expiring') db.session.add(user) db.session.add(credit_card) db.session.commit() return True
class Bet(ResourceMixin, db.Model): __tablename__ = 'bets' id = db.Column(db.Integer, primary_key=True) # Relationships. user_id = db.Column(db.Integer, db.ForeignKey('users.id', onupdate='CASCADE', ondelete='CASCADE'), index=True, nullable=False) user = db.relationship('User') # Bet details. guess = db.Column(db.Integer()) die_1 = db.Column(db.Integer()) die_2 = db.Column(db.Integer()) roll = db.Column(db.Integer()) wagered = db.Column(db.BigInteger()) payout = db.Column(db.Float()) net = db.Column(db.BigInteger()) def __init__(self, **kwargs): # Call Flask-SQLAlchemy's constructor. super(Bet, self).__init__(**kwargs) @classmethod def is_winner(cls, guess, roll): """ Determine if the result is a win or loss. :param guess: Dice guess :type guess: int :param roll: Dice roll :type roll: int :return: bool """ if guess == roll: return True return False @classmethod def determine_payout(cls, payout, is_winner): """ Determine the payout. :param payout: Dice guess :type payout: float :param is_winner: Was the bet won or lost :type is_winner: bool :return: int """ if is_winner: return payout return 1.0 @classmethod def calculate_net(cls, wagered, payout, is_winner): """ Calculate the net won or lost. :param wagered: Dice guess :type wagered: int :param payout: Dice roll :type payout: float :param is_winner: Was the bet won or lost :type is_winner: bool :return: int """ if is_winner: return int(wagered * payout) return -wagered def save_and_update_user(self, user): """ Commit the bet and update the user's information. :return: SQLAlchemy save result """ self.save() user.coins += self.net user.last_bet_on = tzware_datetime() return user.save() def to_json(self): """ Return JSON fields to represent a bet. :return: dict """ params = { 'guess': self.guess, 'die_1': self.die_1, 'die_2': self.die_2, 'roll': self.roll, 'wagered': self.wagered, 'payout': self.payout, 'net': self.net, 'is_winner': Bet.is_winner(self.guess, self.roll) } return params
class Invoice(ResourceMixin, db.Model): __tablename__ = 'invoices' id = db.Column(db.Integer, primary_key=True) # Relationships. user_id = db.Column(db.Integer, db.ForeignKey('users.id', onupdate='CASCADE', ondelete='CASCADE'), index=True, nullable=False) user = db.relationship('User') # Invoice details. plan = db.Column(db.String(128), index=True) receipt_number = db.Column(db.String(128), index=True) description = db.Column(db.String(128)) period_start_on = db.Column(db.Date) period_end_on = db.Column(db.Date) currency = db.Column(db.String(8)) tax = db.Column(db.Integer()) tax_percent = db.Column(db.Float()) total = db.Column(db.Integer()) # De-normalize the card details so we can render a user's history properly # even if they have no active subscription or changed cards at some point. brand = db.Column(db.String(32)) last4 = db.Column(db.Integer) exp_date = db.Column(db.Date, index=True) def __init__(self, **kwargs): # Call Flask-SQLAlchemy's constructor. super(Invoice, self).__init__(**kwargs) @classmethod def search(cls, query): """ Search a resource by 1 or more fields. :param query: Search query :type query: str :return: SQLAlchemy filter """ from snakeeyes.blueprints.user.models import User if not query: return '' search_query = '%{0}%'.format(query) search_chain = (User.email.ilike(search_query), User.username.ilike(search_query)) return or_(*search_chain) @classmethod def parse_from_event(cls, payload): """ Parse and return the invoice information that will get saved locally. :return: dict """ data = payload['data']['object'] plan_info = data['lines']['data'][0]['plan'] period_start_on = datetime.datetime.utcfromtimestamp( data['lines']['data'][0]['period']['start']).date() period_end_on = datetime.datetime.utcfromtimestamp( data['lines']['data'][0]['period']['end']).date() invoice = { 'payment_id': data['customer'], 'plan': plan_info['name'], 'receipt_number': data['receipt_number'], 'description': plan_info['statement_descriptor'], 'period_start_on': period_start_on, 'period_end_on': period_end_on, 'currency': data['currency'], 'tax': data['tax'], 'tax_percent': data['tax_percent'], 'total': data['total'] } return invoice @classmethod def parse_from_api(cls, payload): """ Parse and return the invoice information we are interested in. :return: dict """ plan_info = payload['lines']['data'][0]['plan'] date = datetime.datetime.utcfromtimestamp(payload['date']) invoice = { 'plan': plan_info['name'], 'description': plan_info['statement_descriptor'], 'next_bill_on': date, 'amount_due': payload['amount_due'], 'interval': plan_info['interval'] } return invoice @classmethod def prepare_and_save(cls, parsed_event): """ Potentially save the invoice after argument the event fields. :param parsed_event: Event params to be saved :type parsed_event: dict :return: User instance """ # Avoid circular imports. from snakeeyes.blueprints.user.models import User # Only save the invoice if the user is valid at this point. id = parsed_event.get('payment_id') user = User.query.filter((User.payment_id == id)).first() if user and user.credit_card: parsed_event['user_id'] = user.id parsed_event['brand'] = user.credit_card.brand parsed_event['last4'] = user.credit_card.last4 parsed_event['exp_date'] = user.credit_card.exp_date del parsed_event['payment_id'] invoice = Invoice(**parsed_event) invoice.save() return user @classmethod def upcoming(cls, customer_id): """ Return the upcoming invoice item. :param customer_id: Stripe customer id :type customer_id: int :return: Stripe invoice object """ invoice = PaymentInvoice.upcoming(customer_id) return Invoice.parse_from_api(invoice) def create(self, user=None, currency=None, amount=None, coins=None, coupon=None, token=None): """ Create an invoice item. :param user: User to apply the subscription to :type user: User instance :param amount: Stripe currency :type amount: str :param amount: Amount in cents :type amount: int :param coins: Amount of coins :type coins: int :param coupon: Coupon code to apply :type coupon: str :param token: Token returned by JavaScript :type token: str :return: bool """ if token is None: return False customer = PaymentCustomer.create(token=token, email=user.email) if coupon: self.coupon = coupon.upper() coupon = Coupon.query.filter(Coupon.code == self.coupon).first() amount = coupon.apply_discount_to(amount) charge = PaymentCharge.create(customer.id, currency, amount) # Redeem the coupon. if coupon: coupon.redeem() # Add the coins to the user. user.coins += coins # Create the invoice item. period_on = datetime.datetime.utcfromtimestamp(charge.get('created')) card_params = CreditCard.extract_card_params(customer) self.user_id = user.id self.plan = '—' self.receipt_number = charge.get('receipt_number') self.description = charge.get('statement_descriptor') self.period_start_on = period_on self.period_end_on = period_on self.currency = charge.get('currency') self.tax = None self.tax_percent = None self.total = charge.get('amount') self.brand = card_params.get('brand') self.last4 = card_params.get('last4') self.exp_date = card_params.get('exp_date') db.session.add(user) db.session.add(self) db.session.commit() return True
class User(UserMixin, db.Model): __tablename__ = 'users' ROLE = OrderedDict([ ('member', "Member"), ("admin", "Admin") ]) # Unique idntification number id = db.Column(db.Integer, primary_key = True) # Credit card relationship credit_card = db.relationship(CreditCard, uselist=False, backref='users', passive_deletes=True) # Subscription relationship subscription = db.relationship(Subscription, backref='users', uselist=False, passive_deletes=True) # Invoic Relationships invoice = db.relationship(Invoice, backref='users', passive_deletes=True) # User credentials role = db.Column(db.Enum(*ROLE, name = 'role_type', native_enum = False), nullable = False, default='member') username = db.Column(db.String(128), nullable=True, unique=True) email = db.Column(db.String(128), nullable=False, unique = True) active = db.Column(db.Boolean, default = True, nullable=False) hash_password = db.Column(db.String(240), nullable=False) confirmed = db.Column(db.Boolean, default = False) # User tracking information sign_in_count = db.Column(db.Integer, default=0) current_sign_in_on = db.Column(db.DateTime(), default=datetime.datetime.utcnow) current_sign_in_ip = db.Column(db.String(24)) last_sign_in_on = db.Column(db.DateTime(), default=datetime.datetime.utcnow) last_sign_in_ip = db.Column(db.String(24)) # Billing. name = db.Column(db.String(128), index=True) payment_id = db.Column(db.String(128), index=True) cancelled_subscription_on = db.Column(db.DateTime(), default=datetime.datetime.utcnow) # User run time created_on = db.Column(db.DateTime(), default = datetime.datetime.utcnow) updated_on = db.Column(db.DateTime(), default=datetime.datetime.utcnow, onupdate=datetime.datetime.utcnow) @property def password(self): raise AttributeError('Password is not a readable attribute') @password.setter def password(self, password): self.hash_password = generate_password_hash(password) def verify_password(self, password): return check_password_hash(self.hash_password, password) def is_active(self): return self.active @classmethod def search(cls, query): """ Search a resource by 1 or more fields. :param query: Search query :type query: str :return: SQLAlchemy filter """ if not query: return '' search_query = '%{0}%'.format(query) search_chain = (User.email.ilike(search_query), User.username.ilike(search_query)) return or_(*search_chain) @classmethod def sort_by(cls, field, direction): """This help to sort the user base on the field column and direction. """ if field not in cls.__table__.columns: field = "created_on" if direction not in ('asc', 'desc'): direction = 'asc' return field, direction @classmethod def is_last_admin(cls, user, new_role, new_active): """This particular method will help to check if this particular user is the last admin.""" is_changing_role = user.role == 'admin' and new_role != 'admin' is_changing_active = user.active is True and new_role is None if is_changing_role or is_changing_active : admin_count = User.query.filter(User.role == 'admin').count() active_count = User.query.filter(User.is_active is True).count() if admin_count == 1 or active_count == 1: return True return False @classmethod def get_bulk_action_id(cls, scope, ids, omit_id=None, query=''): """Determine bulk of id to be deleted.""" omit_id = list(map(str, omit_id)) if scope == 'all_search_result': ids = User.query.with_entities(User.id).filter(User.search(query)) ids = [str(item[0]) for item in ids] if omit_id: ids = [id for id in ids if id not in omit_id] return ids @classmethod def bulk_delete(cls, ids): """Delete selected user id""" delete_count = User.query.filter(User.id.in_(ids)).delete(synchronize_session=False) return delete_count def track_user_activities(self, ip_address): self.sign_in_count = +1 self.last_sign_in_on = self.current_sign_in_on self.last_sign_in_ip = self.current_sign_in_ip self.current_sign_in_ip = ip_address self.current_sign_in_on = datetime.datetime.utcnow() return True def generate_token(self, expiration=3600): s = TimedJSONWebSignatureSerializer(current_app.config["SECRET_KEY"], expires_in=expiration) return s.dumps({"confirm": self.id}).decode('utf-8') def verify_token(self,token): s = TimedJSONWebSignatureSerializer(current_app.config['SECRET_KEY']) try: data = s.loads(token) except: return False if data.get('confirm') != self.id: return False self.confirmed = True db.session.add(self) user = User.query.filter_by(id = data.get('confirm')).first() return user.email def generate_reset_token(self): s = TimedJSONWebSignatureSerializer(current_app.config['SECRET_KEY']) return s.dumps({'user_id': self.id}) @staticmethod def confirm_reset_token(token): s = TimedJSONWebSignatureSerializer(current_app.config['SECRET_KEY']) try: data = s.loads(token) except: return False user = User.query.get(data.get('user_id')) return user.id @classmethod def add_fake(cls): from random import seed, randint, choice from sqlalchemy.exc import IntegrityError from snakeeyes.extensions import fake users = [] seed() while len(users) < 100: u = User( email = fake.email(), username = fake.name()+str(randint(0, 300)), active = bool(choice([True, False])), password = '******', sign_in_count = randint(0,20), current_sign_in_on = fake.date_time_between(start_date='-1y', end_date='now'), last_sign_in_ip = fake.ipv4(), confirmed = bool(choice([True, False])), current_sign_in_ip = fake.ipv4(), last_sign_in_on = fake.date_time_between(start_date='-1y', end_date='now'), created_on = fake.date_time_between(start_date='-15y', end_date='now'), updated_on = fake.date_time_between(start_date='-15y', end_date='now') ) users.append(u) db.session.add(u) try: db.session.commit() except IntegrityError: db.session.rollback() @classmethod def add_admin(cls): admin = User(email = '*****@*****.**', password='******', confirmed=True, role='admin') db.session.add(admin) db.session.commit() return True