rattail/rattail-harvest
2
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Rename all tables/models for Harvest "cache"

Browse source 
make this more explicit, for better naming convention
This commit is contained in:
Lance Edgar 2023-10-04 15:54:52 -05:00
parent 509405cb34
commit aa87ce57be
7 changed files with 324 additions and 88 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

179
rattail_harvest/db/alembic/versions/53c066772ad5_rename_cache_tables.py Normal file
View file

@ -0,0 +1,179 @@
# -*- coding: utf-8; -*-
"""rename cache tables
Revision ID: 53c066772ad5
Revises: f2a1650e7fbc
Create Date: 2023-10-04 15:19:03.857323
"""
# revision identifiers, used by Alembic.
revision = '53c066772ad5'
down_revision = 'f2a1650e7fbc'
branch_labels = None
depends_on = None
from alembic import op
import sqlalchemy as sa
import rattail.db.types
def upgrade():
##############################
# drop all constraints
##############################
# harvest_time_entry
op.drop_constraint('harvest_time_entry_fk_user', 'harvest_time_entry', type_='foreignkey')
op.drop_constraint('harvest_time_entry_fk_client', 'harvest_time_entry', type_='foreignkey')
op.drop_constraint('harvest_time_entry_fk_project', 'harvest_time_entry', type_='foreignkey')
op.drop_constraint('harvest_time_entry_fk_task', 'harvest_time_entry', type_='foreignkey')
op.drop_constraint('harvest_time_entry_uq_id', 'harvest_time_entry', type_='unique')
# harvest_task
op.drop_constraint('harvest_task_uq_id', 'harvest_task', type_='unique')
# harvest_project
op.drop_constraint('harvest_project_fk_client', 'harvest_project', type_='foreignkey')
op.drop_constraint('harvest_project_uq_id', 'harvest_project', type_='unique')
# harvest_client
op.drop_constraint('harvest_client_uq_id', 'harvest_client', type_='unique')
# harvest_user
op.drop_constraint('harvest_user_fk_person', 'harvest_user', type_='foreignkey')
op.drop_constraint('harvest_user_uq_id', 'harvest_user', type_='unique')
##############################
# rename all tables
##############################
op.rename_table('harvest_user', 'harvest_cache_user')
op.rename_table('harvest_user_version', 'harvest_cache_user_version')
op.rename_table('harvest_client', 'harvest_cache_client')
op.rename_table('harvest_client_version', 'harvest_cache_client_version')
op.rename_table('harvest_project', 'harvest_cache_project')
op.rename_table('harvest_project_version', 'harvest_cache_project_version')
op.rename_table('harvest_task', 'harvest_cache_task')
op.rename_table('harvest_task_version', 'harvest_cache_task_version')
op.rename_table('harvest_time_entry', 'harvest_cache_time_entry')
op.rename_table('harvest_time_entry_version', 'harvest_cache_time_entry_version')
##############################
# re-create all constraints
##############################
# harvest_cache_user
op.create_foreign_key('harvest_cache_user_fk_person',
'harvest_cache_user', 'person',
['person_uuid'], ['uuid'])
op.create_unique_constraint('harvest_cache_user_uq_id', 'harvest_cache_user', ['id'])
# harvest_cache_client
op.create_unique_constraint('harvest_cache_client_uq_id', 'harvest_cache_client', ['id'])
# harvest_cache_project
op.create_foreign_key('harvest_cache_project_fk_client',
'harvest_cache_project', 'harvest_cache_client',
['client_id'], ['id'])
op.create_unique_constraint('harvest_cache_project_uq_id', 'harvest_cache_project', ['id'])
# harvest_cache_task
op.create_unique_constraint('harvest_cache_task_uq_id', 'harvest_cache_task', ['id'])
# harvest_cache_time_entry
op.create_foreign_key('harvest_cache_time_entry_fk_user',
'harvest_cache_time_entry', 'harvest_cache_user',
['user_id'], ['id'])
op.create_foreign_key('harvest_cache_time_entry_fk_client',
'harvest_cache_time_entry', 'harvest_cache_client',
['client_id'], ['id'])
op.create_foreign_key('harvest_cache_time_entry_fk_project',
'harvest_cache_time_entry', 'harvest_cache_project',
['project_id'], ['id'])
op.create_foreign_key('harvest_cache_time_entry_fk_task',
'harvest_cache_time_entry', 'harvest_cache_task',
['task_id'], ['id'])
op.create_unique_constraint('harvest_cache_time_entry_uq_id', 'harvest_cache_time_entry', ['id'])
def downgrade():
##############################
# drop all constraints
##############################
# harvest_cache_time_entry
op.drop_constraint('harvest_cache_time_entry_fk_user', 'harvest_cache_time_entry', type_='foreignkey')
op.drop_constraint('harvest_cache_time_entry_fk_client', 'harvest_cache_time_entry', type_='foreignkey')
op.drop_constraint('harvest_cache_time_entry_fk_project', 'harvest_cache_time_entry', type_='foreignkey')
op.drop_constraint('harvest_cache_time_entry_fk_task', 'harvest_cache_time_entry', type_='foreignkey')
op.drop_constraint('harvest_cache_time_entry_uq_id', 'harvest_cache_time_entry', type_='unique')
# harvest_cache_task
op.drop_constraint('harvest_cache_task_uq_id', 'harvest_cache_task', type_='unique')
# harvest_cache_project
op.drop_constraint('harvest_cache_project_fk_client', 'harvest_cache_project', type_='foreignkey')
op.drop_constraint('harvest_cache_project_uq_id', 'harvest_cache_project', type_='unique')
# harvest_cache_client
op.drop_constraint('harvest_cache_client_uq_id', 'harvest_cache_client', type_='unique')
# harvest_cache_user
op.drop_constraint('harvest_cache_user_fk_person', 'harvest_cache_user', type_='foreignkey')
op.drop_constraint('harvest_cache_user_uq_id', 'harvest_cache_user', type_='unique')
##############################
# rename all tables
##############################
op.rename_table('harvest_cache_user', 'harvest_user')
op.rename_table('harvest_cache_user_version', 'harvest_user_version')
op.rename_table('harvest_cache_client', 'harvest_client')
op.rename_table('harvest_cache_client_version', 'harvest_client_version')
op.rename_table('harvest_cache_project', 'harvest_project')
op.rename_table('harvest_cache_project_version', 'harvest_project_version')
op.rename_table('harvest_cache_task', 'harvest_task')
op.rename_table('harvest_cache_task_version', 'harvest_task_version')
op.rename_table('harvest_cache_time_entry', 'harvest_time_entry')
op.rename_table('harvest_cache_time_entry_version', 'harvest_time_entry_version')
##############################
# re-create all constraints
##############################
# harvest_user
op.create_foreign_key('harvest_user_fk_person',
'harvest_user', 'person',
['person_uuid'], ['uuid'])
op.create_unique_constraint('harvest_user_uq_id', 'harvest_user', ['id'])
# harvest_client
op.create_unique_constraint('harvest_client_uq_id', 'harvest_client', ['id'])
# harvest_project
op.create_foreign_key('harvest_project_fk_client',
'harvest_project', 'harvest_client',
['client_id'], ['id'])
op.create_unique_constraint('harvest_project_uq_id', 'harvest_project', ['id'])
# harvest_cache_task
op.create_unique_constraint('harvest_task_uq_id', 'harvest_task', ['id'])
# harvest_time_entry
op.create_foreign_key('harvest_time_entry_fk_user',
'harvest_time_entry', 'harvest_user',
['user_id'], ['id'])
op.create_foreign_key('harvest_time_entry_fk_client',
'harvest_time_entry', 'harvest_client',
['client_id'], ['id'])
op.create_foreign_key('harvest_time_entry_fk_project',
'harvest_time_entry', 'harvest_project',
['project_id'], ['id'])
op.create_foreign_key('harvest_time_entry_fk_task',
'harvest_time_entry', 'harvest_task',
['task_id'], ['id'])
op.create_unique_constraint('harvest_time_entry_uq_id', 'harvest_time_entry', ['id'])

8
rattail_harvest/db/model/__init__.py
View file

@ -2,7 +2,7 @@
################################################################################ ################################################################################
# #
# Rattail -- Retail Software Framework # Rattail -- Retail Software Framework
# Copyright © 2010-2022 Lance Edgar # Copyright © 2010-2023 Lance Edgar
# #
# This file is part of Rattail. # This file is part of Rattail.
# #
@ -24,5 +24,9 @@
Harvest integration data models Harvest integration data models
""" """
from .harvest import (HarvestUser, HarvestClient, HarvestProject, from .harvest import (HarvestCacheUser, HarvestCacheClient,
HarvestCacheProject, HarvestCacheTask,
HarvestCacheTimeEntry,
# TODO: deprecate / remove these
HarvestUser, HarvestClient, HarvestProject,
HarvestTask, HarvestTimeEntry) HarvestTask, HarvestTimeEntry)

105
rattail_harvest/db/model/harvest.py
View file

@ -24,6 +24,8 @@
Harvest "cache" data models Harvest "cache" data models
""" """
import warnings
import sqlalchemy as sa import sqlalchemy as sa
from sqlalchemy import orm from sqlalchemy import orm
@ -31,16 +33,17 @@ from rattail.db import model
from rattail.db.util import normalize_full_name from rattail.db.util import normalize_full_name
class HarvestUser(model.Base): class HarvestCacheUser(model.Base):
""" """
Represents a user record in Harvest. Represents a user record in Harvest.
https://help.getharvest.com/api-v2/users-api/users/users/#the-user-object https://help.getharvest.com/api-v2/users-api/users/users/#the-user-object
""" """
__tablename__ = 'harvest_user' __tablename__ = 'harvest_cache_user'
__table_args__ = ( __table_args__ = (
sa.ForeignKeyConstraint(['person_uuid'], ['person.uuid'], name='harvest_user_fk_person'), sa.ForeignKeyConstraint(['person_uuid'], ['person.uuid'],
sa.UniqueConstraint('id', name='harvest_user_uq_id'), name='harvest_cache_user_fk_person'),
sa.UniqueConstraint('id', name='harvest_cache_user_uq_id'),
) )
__versioned__ = {} __versioned__ = {}
@ -108,15 +111,24 @@ class HarvestUser(model.Base):
return normalize_full_name(self.first_name, self.last_name) return normalize_full_name(self.first_name, self.last_name)
class HarvestClient(model.Base): class HarvestUser(HarvestCacheUser):
""" DEPRECATED """
def __init__(self, *args, **kwargs):
warnings.warn("HarvestUser class is deprecated; "
"please use HarvestCacheUser instead",
DeprecationWarning, stacklevel=2)
class HarvestCacheClient(model.Base):
""" """
Represents a client record in Harvest. Represents a client record in Harvest.
https://help.getharvest.com/api-v2/clients-api/clients/clients/#the-client-object https://help.getharvest.com/api-v2/clients-api/clients/clients/#the-client-object
""" """
__tablename__ = 'harvest_client' __tablename__ = 'harvest_cache_client'
__table_args__ = ( __table_args__ = (
sa.UniqueConstraint('id', name='harvest_client_uq_id'), sa.UniqueConstraint('id', name='harvest_cache_client_uq_id'),
) )
__versioned__ = {} __versioned__ = {}
@ -140,16 +152,26 @@ class HarvestClient(model.Base):
return self.name or '' return self.name or ''
class HarvestProject(model.Base): class HarvestClient(HarvestCacheClient):
""" DEPRECATED """
def __init__(self, *args, **kwargs):
warnings.warn("HarvestClient class is deprecated; "
"please use HarvestCacheClient instead",
DeprecationWarning, stacklevel=2)
class HarvestCacheProject(model.Base):
""" """
Represents a project record in Harvest. Represents a project record in Harvest.
https://help.getharvest.com/api-v2/projects-api/projects/projects/#the-project-object https://help.getharvest.com/api-v2/projects-api/projects/projects/#the-project-object
""" """
__tablename__ = 'harvest_project' __tablename__ = 'harvest_cache_project'
__table_args__ = ( __table_args__ = (
sa.UniqueConstraint('id', name='harvest_project_uq_id'), sa.UniqueConstraint('id', name='harvest_cache_project_uq_id'),
sa.ForeignKeyConstraint(['client_id'], ['harvest_client.id'], name='harvest_project_fk_client'), sa.ForeignKeyConstraint(['client_id'], ['harvest_cache_client.id'],
name='harvest_cache_project_fk_client'),
) )
__versioned__ = {'exclude': ['over_budget_notification_date']} __versioned__ = {'exclude': ['over_budget_notification_date']}
@ -158,7 +180,7 @@ class HarvestProject(model.Base):
id = sa.Column(sa.BigInteger(), nullable=False) id = sa.Column(sa.BigInteger(), nullable=False)
client_id = sa.Column(sa.BigInteger(), nullable=True) # TODO: should not allow null? client_id = sa.Column(sa.BigInteger(), nullable=True) # TODO: should not allow null?
client = orm.relationship(HarvestClient, backref=orm.backref('projects')) client = orm.relationship(HarvestCacheClient, backref=orm.backref('projects'))
name = sa.Column(sa.String(length=255), nullable=True) name = sa.Column(sa.String(length=255), nullable=True)
@ -212,15 +234,24 @@ class HarvestProject(model.Base):
return self.name or '' return self.name or ''
class HarvestTask(model.Base): class HarvestProject(HarvestCacheProject):
""" DEPRECATED """
def __init__(self, *args, **kwargs):
warnings.warn("HarvestProject class is deprecated; "
"please use HarvestCacheProject instead",
DeprecationWarning, stacklevel=2)
class HarvestCacheTask(model.Base):
""" """
Represents a task record in Harvest. Represents a task record in Harvest.
https://help.getharvest.com/api-v2/tasks-api/tasks/tasks/#the-task-object https://help.getharvest.com/api-v2/tasks-api/tasks/tasks/#the-task-object
""" """
__tablename__ = 'harvest_task' __tablename__ = 'harvest_cache_task'
__table_args__ = ( __table_args__ = (
sa.UniqueConstraint('id', name='harvest_task_uq_id'), sa.UniqueConstraint('id', name='harvest_cache_task_uq_id'),
) )
__versioned__ = {} __versioned__ = {}
@ -246,19 +277,32 @@ class HarvestTask(model.Base):
return self.name or '' return self.name or ''
class HarvestTimeEntry(model.Base): class HarvestTask(HarvestCacheTask):
""" DEPRECATED """
def __init__(self, *args, **kwargs):
warnings.warn("HarvestTask class is deprecated; "
"please use HarvestCacheTask instead",
DeprecationWarning, stacklevel=2)
class HarvestCacheTimeEntry(model.Base):
""" """
Represents a time entry record in Harvest. Represents a time entry record in Harvest.
https://help.getharvest.com/api-v2/timesheets-api/timesheets/time-entries/#the-time-entry-object https://help.getharvest.com/api-v2/timesheets-api/timesheets/time-entries/#the-time-entry-object
""" """
__tablename__ = 'harvest_time_entry' __tablename__ = 'harvest_cache_time_entry'
__table_args__ = ( __table_args__ = (
sa.UniqueConstraint('id', name='harvest_time_entry_uq_id'), sa.UniqueConstraint('id', name='harvest_cache_time_entry_uq_id'),
sa.ForeignKeyConstraint(['user_id'], ['harvest_user.id'], name='harvest_time_entry_fk_user'), sa.ForeignKeyConstraint(['user_id'], ['harvest_cache_user.id'],
sa.ForeignKeyConstraint(['client_id'], ['harvest_client.id'], name='harvest_time_entry_fk_client'), name='harvest_cache_time_entry_fk_user'),
sa.ForeignKeyConstraint(['project_id'], ['harvest_project.id'], name='harvest_time_entry_fk_project'), sa.ForeignKeyConstraint(['client_id'], ['harvest_cache_client.id'],
sa.ForeignKeyConstraint(['task_id'], ['harvest_task.id'], name='harvest_time_entry_fk_task'), name='harvest_cache_time_entry_fk_client'),
sa.ForeignKeyConstraint(['project_id'], ['harvest_cache_project.id'],
name='harvest_cache_time_entry_fk_project'),
sa.ForeignKeyConstraint(['task_id'], ['harvest_cache_task.id'],
name='harvest_cache_time_entry_fk_task'),
) )
__versioned__ = {} __versioned__ = {}
model_title_plural = "Harvest Time Entries" model_title_plural = "Harvest Time Entries"
@ -270,16 +314,16 @@ class HarvestTimeEntry(model.Base):
spent_date = sa.Column(sa.Date(), nullable=True) spent_date = sa.Column(sa.Date(), nullable=True)
user_id = sa.Column(sa.BigInteger(), nullable=True) user_id = sa.Column(sa.BigInteger(), nullable=True)
user = orm.relationship(HarvestUser, backref=orm.backref('time_entries')) user = orm.relationship(HarvestCacheUser, backref=orm.backref('time_entries'))
client_id = sa.Column(sa.BigInteger(), nullable=True) client_id = sa.Column(sa.BigInteger(), nullable=True)
client = orm.relationship(HarvestClient, backref=orm.backref('time_entries')) client = orm.relationship(HarvestCacheClient, backref=orm.backref('time_entries'))
project_id = sa.Column(sa.BigInteger(), nullable=True) project_id = sa.Column(sa.BigInteger(), nullable=True)
project = orm.relationship(HarvestProject, backref=orm.backref('time_entries')) project = orm.relationship(HarvestCacheProject, backref=orm.backref('time_entries'))
task_id = sa.Column(sa.BigInteger(), nullable=True) task_id = sa.Column(sa.BigInteger(), nullable=True)
task = orm.relationship(HarvestTask, backref=orm.backref('time_entries')) task = orm.relationship(HarvestCacheTask, backref=orm.backref('time_entries'))
invoice_id = sa.Column(sa.BigInteger(), nullable=True) invoice_id = sa.Column(sa.BigInteger(), nullable=True)
@ -317,3 +361,12 @@ class HarvestTimeEntry(model.Base):
def __str__(self): def __str__(self):
return str(self.spent_date or '') return str(self.spent_date or '')
class HarvestTimeEntry(HarvestCacheTimeEntry):
""" DEPRECATED """
def __init__(self, *args, **kwargs):
warnings.warn("HarvestTimeEntry class is deprecated; "
"please use HarvestCacheTimeEntry instead",
DeprecationWarning, stacklevel=2)

36
rattail_harvest/importing/harvest.py
View file

@ -49,11 +49,11 @@ class FromHarvestToRattail(importing.ToRattailHandler):
def get_importers(self): def get_importers(self):
importers = OrderedDict() importers = OrderedDict()
importers['HarvestUser'] = HarvestUserImporter importers['HarvestCacheUser'] = HarvestCacheUserImporter
importers['HarvestClient'] = HarvestClientImporter importers['HarvestCacheClient'] = HarvestCacheClientImporter
importers['HarvestProject'] = HarvestProjectImporter importers['HarvestCacheProject'] = HarvestCacheProjectImporter
importers['HarvestTask'] = HarvestTaskImporter importers['HarvestCacheTask'] = HarvestCacheTaskImporter
importers['HarvestTimeEntry'] = HarvestTimeEntryImporter importers['HarvestCacheTimeEntry'] = HarvestCacheTimeEntryImporter
return importers return importers
@ -90,14 +90,14 @@ class FromHarvest(importing.Importer):
return data return data
class HarvestUserImporter(FromHarvest, rattail_harvest_importing.model.HarvestUserImporter): class HarvestCacheUserImporter(FromHarvest, rattail_harvest_importing.model.HarvestCacheUserImporter):
""" """
Import user data from Harvest Import user data from Harvest
""" """
@property @property
def supported_fields(self): def supported_fields(self):
fields = list(super(HarvestUserImporter, self).supported_fields) fields = list(super().supported_fields)
# this is for local tracking only; is not in harvest # this is for local tracking only; is not in harvest
fields.remove('person_uuid') fields.remove('person_uuid')
@ -111,7 +111,7 @@ class HarvestUserImporter(FromHarvest, rattail_harvest_importing.model.HarvestUs
return self.webapi.get_users()['users'] return self.webapi.get_users()['users']
def normalize_host_object(self, user): def normalize_host_object(self, user):
data = super(HarvestUserImporter, self).normalize_host_object(user) data = super().normalize_host_object(user)
if data: if data:
# TODO: for some reason the API used to include the these # TODO: for some reason the API used to include the these
@ -131,7 +131,7 @@ class HarvestUserImporter(FromHarvest, rattail_harvest_importing.model.HarvestUs
return data return data
class HarvestClientImporter(FromHarvest, rattail_harvest_importing.model.HarvestClientImporter): class HarvestCacheClientImporter(FromHarvest, rattail_harvest_importing.model.HarvestCacheClientImporter):
""" """
Import client data from Harvest Import client data from Harvest
""" """
@ -140,14 +140,14 @@ class HarvestClientImporter(FromHarvest, rattail_harvest_importing.model.Harvest
return self.webapi.get_clients()['clients'] return self.webapi.get_clients()['clients']
class HarvestProjectImporter(FromHarvest, rattail_harvest_importing.model.HarvestProjectImporter): class HarvestCacheProjectImporter(FromHarvest, rattail_harvest_importing.model.HarvestCacheProjectImporter):
""" """
Import project data from Harvest Import project data from Harvest
""" """
@property @property
def supported_fields(self): def supported_fields(self):
fields = list(super(HarvestProjectImporter, self).supported_fields) fields = list(super().supported_fields)
# this is for local tracking only; is not in harvest # this is for local tracking only; is not in harvest
fields.remove('deleted') fields.remove('deleted')
@ -156,16 +156,16 @@ class HarvestProjectImporter(FromHarvest, rattail_harvest_importing.model.Harves
def cache_query(self): def cache_query(self):
model = self.model model = self.model
return self.session.query(model.HarvestProject)\ return self.session.query(model.HarvestCacheProject)\
.filter(sa.or_( .filter(sa.or_(
model.HarvestProject.deleted == False, model.HarvestCacheProject.deleted == False,
model.HarvestProject.deleted == None)) model.HarvestCacheProject.deleted == None))
def get_host_objects(self): def get_host_objects(self):
return self.webapi.get_projects() return self.webapi.get_projects()
def normalize_host_object(self, project): def normalize_host_object(self, project):
data = super(HarvestProjectImporter, self).normalize_host_object(project) data = super().normalize_host_object(project)
if not data: if not data:
return return
@ -211,7 +211,7 @@ class HarvestProjectImporter(FromHarvest, rattail_harvest_importing.model.Harves
return True return True
class HarvestTaskImporter(FromHarvest, rattail_harvest_importing.model.HarvestTaskImporter): class HarvestCacheTaskImporter(FromHarvest, rattail_harvest_importing.model.HarvestCacheTaskImporter):
""" """
Import task data from Harvest Import task data from Harvest
""" """
@ -220,7 +220,7 @@ class HarvestTaskImporter(FromHarvest, rattail_harvest_importing.model.HarvestTa
return self.webapi.get_tasks()['tasks'] return self.webapi.get_tasks()['tasks']
class HarvestTimeEntryImporter(FromHarvest, rattail_harvest_importing.model.HarvestTimeEntryImporter): class HarvestCacheTimeEntryImporter(FromHarvest, rattail_harvest_importing.model.HarvestCacheTimeEntryImporter):
""" """
Import time entry data from Harvest Import time entry data from Harvest
""" """
@ -239,7 +239,7 @@ class HarvestTimeEntryImporter(FromHarvest, rattail_harvest_importing.model.Harv
return self.webapi.get_time_entry(entry_id) return self.webapi.get_time_entry(entry_id)
def normalize_host_object(self, entry): def normalize_host_object(self, entry):
data = super(HarvestTimeEntryImporter, self).normalize_host_object(entry) data = super().normalize_host_object(entry)
if not data: if not data:
return return

32
rattail_harvest/importing/model.py
View file

@ -37,20 +37,20 @@ log = logging.getLogger(__name__)
# harvest cache models # harvest cache models
############################## ##############################
class HarvestUserImporter(ToRattail): class HarvestCacheUserImporter(ToRattail):
model_class = model.HarvestUser model_class = model.HarvestCacheUser
class HarvestClientImporter(ToRattail): class HarvestCacheClientImporter(ToRattail):
model_class = model.HarvestClient model_class = model.HarvestCacheClient
class HarvestProjectImporter(ToRattail): class HarvestCacheProjectImporter(ToRattail):
model_class = model.HarvestProject model_class = model.HarvestCacheProject
class HarvestTaskImporter(ToRattail): class HarvestCacheTaskImporter(ToRattail):
model_class = model.HarvestTask model_class = model.HarvestCacheTask
class HarvestTimeEntryImporter(ToRattail): class HarvestCacheTimeEntryImporter(ToRattail):
model_class = model.HarvestTimeEntry model_class = model.HarvestCacheTimeEntry
# flags to auto-create records for "unknown" references # flags to auto-create records for "unknown" references
auto_create_unknown_project = True auto_create_unknown_project = True
@ -59,12 +59,12 @@ class HarvestTimeEntryImporter(ToRattail):
warn_for_unknown_project = True warn_for_unknown_project = True
def setup(self): def setup(self):
super(HarvestTimeEntryImporter, self).setup() super().setup()
model = self.model model = self.model
if 'project_id' in self.fields: if 'project_id' in self.fields:
self.harvest_projects_by_id = self.app.cache_model( self.harvest_projects_by_id = self.app.cache_model(
self.session, model.HarvestProject, key='id') self.session, model.HarvestCacheProject, key='id')
def cache_query(self): def cache_query(self):
query = super().cache_query() query = super().cache_query()
@ -81,12 +81,12 @@ class HarvestTimeEntryImporter(ToRattail):
return self.harvest_projects_by_id.get(project_id) return self.harvest_projects_by_id.get(project_id)
model = self.model model = self.model
return self.session.query(model.HarvestProject)\ return self.session.query(model.HarvestCacheProject)\
.filter(model.HarvestProject.id == project_id)\ .filter(model.HarvestCacheProject.id == project_id)\
.first() .first()
def update_object(self, entry, data, local_data=None): def update_object(self, entry, data, local_data=None):
entry = super(HarvestTimeEntryImporter, self).update_object(entry, data, local_data) entry = super().update_object(entry, data, local_data)
model = self.model model = self.model
if 'project_id' in self.fields: if 'project_id' in self.fields:
@ -97,7 +97,7 @@ class HarvestTimeEntryImporter(ToRattail):
logger("unknown project id %s for time entry id %s: %s", logger("unknown project id %s for time entry id %s: %s",
project_id, entry.id, entry) project_id, entry.id, entry)
if self.auto_create_unknown_project: if self.auto_create_unknown_project:
project = model.HarvestProject() project = model.HarvestCacheProject()
project.id = project_id project.id = project_id
project.name = "(unknown)" project.name = "(unknown)"
self.session.add(project) self.session.add(project)

20
rattail_harvest/importing/rattail.py
View file

@ -34,11 +34,11 @@ class FromRattailToRattailHarvestMixin(object):
""" """
def add_harvest_importers(self, importers): def add_harvest_importers(self, importers):
importers['HarvestUser'] = HarvestUserImporter importers['HarvestCacheUser'] = HarvestCacheUserImporter
importers['HarvestClient'] = HarvestClientImporter importers['HarvestCacheClient'] = HarvestCacheClientImporter
importers['HarvestProject'] = HarvestProjectImporter importers['HarvestCacheProject'] = HarvestCacheProjectImporter
importers['HarvestTask'] = HarvestTaskImporter importers['HarvestCacheTask'] = HarvestCacheTaskImporter
importers['HarvestTimeEntry'] = HarvestTimeEntryImporter importers['HarvestCacheTimeEntry'] = HarvestCacheTimeEntryImporter
return importers return importers
@ -46,19 +46,19 @@ class FromRattailToRattailHarvestMixin(object):
# harvest cache models # harvest cache models
############################## ##############################
class HarvestUserImporter(base.FromRattail, rattail_harvest_importing.model.HarvestUserImporter): class HarvestCacheUserImporter(base.FromRattail, rattail_harvest_importing.model.HarvestCacheUserImporter):
pass pass
class HarvestClientImporter(base.FromRattail, rattail_harvest_importing.model.HarvestClientImporter): class HarvestCacheClientImporter(base.FromRattail, rattail_harvest_importing.model.HarvestCacheClientImporter):
pass pass
class HarvestProjectImporter(base.FromRattail, rattail_harvest_importing.model.HarvestProjectImporter): class HarvestCacheProjectImporter(base.FromRattail, rattail_harvest_importing.model.HarvestCacheProjectImporter):
pass pass
class HarvestTaskImporter(base.FromRattail, rattail_harvest_importing.model.HarvestTaskImporter): class HarvestCacheTaskImporter(base.FromRattail, rattail_harvest_importing.model.HarvestCacheTaskImporter):
pass pass
class HarvestTimeEntryImporter(base.FromRattail, rattail_harvest_importing.model.HarvestTimeEntryImporter): class HarvestCacheTimeEntryImporter(base.FromRattail, rattail_harvest_importing.model.HarvestCacheTimeEntryImporter):
def query(self): def query(self):
query = super().query() query = super().query()

32
rattail_harvest/importing/versions.py
View file

@ -2,7 +2,7 @@
################################################################################ ################################################################################
# #
# Rattail -- Retail Software Framework # Rattail -- Retail Software Framework
# Copyright © 2010-2022 Lance Edgar # Copyright © 2010-2023 Lance Edgar
# #
# This file is part of Rattail. # This file is part of Rattail.
# #
@ -30,44 +30,44 @@ from rattail.importing import versions as base
class HarvestVersionMixin(object): class HarvestVersionMixin(object):
def add_harvest_importers(self, importers): def add_harvest_importers(self, importers):
importers['HarvestUser'] = HarvestUserImporter importers['HarvestCacheUser'] = HarvestCacheUserImporter
importers['HarvestClient'] = HarvestClientImporter importers['HarvestCacheClient'] = HarvestCacheClientImporter
importers['HarvestProject'] = HarvestProjectImporter importers['HarvestCacheProject'] = HarvestCacheProjectImporter
importers['HarvestTask'] = HarvestTaskImporter importers['HarvestCacheTask'] = HarvestCacheTaskImporter
importers['HarvestTimeEntry'] = HarvestTimeEntryImporter importers['HarvestCacheTimeEntry'] = HarvestCacheTimeEntryImporter
return importers return importers
class HarvestUserImporter(base.VersionImporter): class HarvestCacheUserImporter(base.VersionImporter):
@property @property
def host_model_class(self): def host_model_class(self):
return self.model.HarvestUser return self.model.HarvestCacheUser
class HarvestClientImporter(base.VersionImporter): class HarvestCacheClientImporter(base.VersionImporter):
@property @property
def host_model_class(self): def host_model_class(self):
return self.model.HarvestClient return self.model.HarvestCacheClient
class HarvestProjectImporter(base.VersionImporter): class HarvestCacheProjectImporter(base.VersionImporter):
@property @property
def host_model_class(self): def host_model_class(self):
return self.model.HarvestProject return self.model.HarvestCacheProject
class HarvestTaskImporter(base.VersionImporter): class HarvestCacheTaskImporter(base.VersionImporter):
@property @property
def host_model_class(self): def host_model_class(self):
return self.model.HarvestTask return self.model.HarvestCacheTask
class HarvestTimeEntryImporter(base.VersionImporter): class HarvestCacheTimeEntryImporter(base.VersionImporter):
@property @property
def host_model_class(self): def host_model_class(self):
return self.model.HarvestTimeEntry return self.model.HarvestCacheTimeEntry