Generalize Sources

[bbengfort]

Right now the sources that are allowed (CPS, CESN) and disallowed (LAUS, CESSM) are hardcoded into the SourcesView object for the API.

Allowed sources are short enough to give all data to the app, disallowed sources (with state contexts) are too long to give an entire data set from.

We need to generalize the sources such that the database determines if the source is allowed or not. E.g. by creating a sources model.

Note that any source not found in the hardcoded sets is simply a 404.

[bbengfort]

Here is the model:

class Source(db.Model):
    """
    Stores information about data sources from the BLS API
    """

    __tablename__ = "source"

    id          = db.Column(db.Integer, primary_key=True)
    name        = db.Column(db.Unicode(255), unique=True, index=True)
    description = db.Column(db.Unicode(255), nullable=True)
    series      = db.relationship('Series', backref='source', lazy='dynamic')


class Series(db.Model):
    """
    Stores information about TimeSeries data on the BLS API
    """

    __tablename__ = "series"

    id          = db.Column(db.Integer, primary_key=True)
    blsid       = db.Column(db.Unicode(255), unique=True, index=True)
    title       = db.Column(db.Unicode(255), nullable=True)
    source_id   = db.Column(db.Integer, db.ForeignKey('source.id'))
    is_primary  = db.Column(db.Boolean, default=False)
    records     = db.relationship('SeriesRecord', backref='series',
                                  lazy='dynamic')

    def __repr__(self):
        return "<Series %s>" % self.blsid

[bbengfort]

For the migrations:

• create SQL migrations in the migrate folder
• update should alter the table, insert distinct sources, update all columns, then alter table
• downgrade should drop the cps table and do reverse alterations