rattail/tailbone
1
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Add initial API views for inventory batches

Browse source
This commit is contained in:
Lance Edgar 2020-03-29 16:31:16 -05:00
parent e9fc9ccbf7
commit 0fbc8c9247
2 changed files with 217 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
tailbone/api/batch/core.py
View file

@ -26,6 +26,8 @@ Tailbone Web API - Batch Views
from __future__ import unicode_literals, absolute_import
import logging
import six
from rattail.time import localtime
@ -36,6 +38,9 @@ from cornice import resource, Service
from tailbone.api import APIMasterView2 as APIMasterView
log = logging.getLogger(__name__)
class APIBatchMixin(object):
"""
Base class for all API views which are meant to handle "batch" *and/or*
@ -85,14 +90,11 @@ class APIBatchView(APIBatchMixin, APIMasterView):
def normalize(self, batch):
created = batch.created
created = localtime(self.rattail_config, created, from_utc=True)
created = self.pretty_datetime(created)
created = localtime(self.rattail_config, batch.created, from_utc=True)
executed = batch.executed
if executed:
executed = localtime(self.rattail_config, executed, from_utc=True)
executed = self.pretty_datetime(executed)
executed = None
if batch.executed:
executed = localtime(self.rattail_config, batch.executed, from_utc=True)
return {
'uuid': batch.uuid,
@ -103,14 +105,16 @@ class APIBatchView(APIBatchMixin, APIMasterView):
'notes': batch.notes,
'params': batch.params or {},
'rowcount': batch.rowcount,
'created': created,
'created': six.text_type(created),
'created_display': self.pretty_datetime(created),
'created_by_uuid': batch.created_by.uuid,
'created_by_display': six.text_type(batch.created_by),
'complete': batch.complete,
'status_code': batch.status_code,
'status_display': batch.STATUS.get(batch.status_code,
six.text_type(batch.status_code)),
'executed': executed,
'executed': six.text_type(executed) if executed else None,
'executed_display': self.pretty_datetime(executed) if executed else None,
'executed_by_uuid': batch.executed_by_uuid,
'executed_by_display': six.text_type(batch.executed_by or ''),
}
@ -269,6 +273,28 @@ class APIBatchRowView(APIBatchMixin, APIMasterView):
'status_display': row.STATUS.get(row.status_code, six.text_type(row.status_code)),
}
def update_object(self, row, data):
"""
Supplements the default logic as follows:
Invokes the batch handler's ``refresh_row()`` method after updating the
row's field data per usual.
"""
# update row per usual
row = super(APIBatchRowView, self).update_object(row, data)
# okay now we apply handler refresh logic
self.handler.refresh_row(row)
return row
def delete_object(self, row):
"""
Overrides the default logic as follows:
Delegates deletion of the row to the batch handler.
"""
self.handler.do_remove_row(row)
def quick_entry(self):
"""
View for handling "quick entry" user input, for a batch.
@ -285,6 +311,9 @@ class APIBatchRowView(APIBatchMixin, APIMasterView):
try:
row = self.handler.quick_entry(self.Session(), batch, entry)
except Exception as error:
log.warning("quick entry failed for '%s' batch %s: %s",
self.handler.batch_key, batch.id_str, entry,
exc_info=True)
msg = six.text_type(error)
if not msg and isinstance(error, NotImplementedError):
msg = "Feature is not implemented"

179
tailbone/api/batch/inventory.py Normal file
View file

@ -0,0 +1,179 @@
# -*- coding: utf-8; -*-
################################################################################
#
# Rattail -- Retail Software Framework
# Copyright © 2010-2020 Lance Edgar
#
# This file is part of Rattail.
#
# Rattail is free software: you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation, either version 3 of the License, or (at your option) any later
# version.
#
# Rattail is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# Rattail. If not, see <http://www.gnu.org/licenses/>.
#
################################################################################
"""
Tailbone Web API - Inventory Batches
"""
from __future__ import unicode_literals, absolute_import
import six
from rattail import pod
from rattail.db import model
from rattail.util import pretty_quantity
from cornice import Service
from tailbone.api.batch import APIBatchView, APIBatchRowView
class InventoryBatchViews(APIBatchView):
model_class = model.InventoryBatch
default_handler_spec = 'rattail.batch.inventory:InventoryBatchHandler'
route_prefix = 'inventory'
permission_prefix = 'batch.inventory'
collection_url_prefix = '/inventory-batches'
object_url_prefix = '/inventory-batch'
supports_toggle_complete = True
def normalize(self, batch):
data = super(InventoryBatchViews, self).normalize(batch)
data['mode'] = batch.mode
data['mode_display'] = self.enum.INVENTORY_MODE.get(batch.mode)
if data['mode_display'] is None and batch.mode is not None:
data['mode_display'] = six.text_type(batch.mode)
data['reason_code'] = batch.reason_code
return data
def count_modes(self):
"""
Retrieve info about the available batch count modes.
"""
permission_prefix = self.get_permission_prefix()
if self.request.is_root:
modes = self.handler.get_count_modes()
else:
modes = self.handler.get_allowed_count_modes(
self.Session(), self.request.user,
permission_prefix=permission_prefix)
return modes
def adjustment_reasons(self):
"""
Retrieve info about the available "reasons" for inventory adjustment
batches.
"""
raw_reasons = self.handler.get_adjustment_reasons(self.Session())
reasons = []
for reason in raw_reasons:
reasons.append({
'uuid': reason.uuid,
'code': reason.code,
'description': reason.description,
'hidden': reason.hidden,
})
return reasons
@classmethod
def defaults(cls, config):
cls._defaults(config)
cls._batch_defaults(config)
cls._inventory_defaults(config)
@classmethod
def _inventory_defaults(cls, config):
route_prefix = cls.get_route_prefix()
permission_prefix = cls.get_permission_prefix()
collection_url_prefix = cls.get_collection_url_prefix()
# get count modes
count_modes = Service(name='{}.count_modes'.format(route_prefix),
path='{}/count-modes'.format(collection_url_prefix))
count_modes.add_view('GET', 'count_modes', klass=cls,
permission='{}.list'.format(permission_prefix))
config.add_cornice_service(count_modes)
# get adjustment reasons
adjustment_reasons = Service(name='{}.adjustment_reasons'.format(route_prefix),
path='{}/adjustment-reasons'.format(collection_url_prefix))
adjustment_reasons.add_view('GET', 'adjustment_reasons', klass=cls,
permission='{}.list'.format(permission_prefix))
config.add_cornice_service(adjustment_reasons)
class InventoryBatchRowViews(APIBatchRowView):
model_class = model.InventoryBatchRow
default_handler_spec = 'rattail.batch.inventory:InventoryBatchHandler'
route_prefix = 'inventory.rows'
permission_prefix = 'batch.inventory'
collection_url_prefix = '/inventory-batch-rows'
object_url_prefix = '/inventory-batch-row'
editable = True
supports_quick_entry = True
def normalize(self, row):
batch = row.batch
data = super(InventoryBatchRowViews, self).normalize(row)
data['item_id'] = row.item_id
data['upc'] = six.text_type(row.upc)
data['upc_pretty'] = row.upc.pretty() if row.upc else None
data['brand_name'] = row.brand_name
data['description'] = row.description
data['size'] = row.size
data['full_description'] = row.product.full_description if row.product else row.description
data['image_url'] = pod.get_image_url(self.rattail_config, row.upc) if row.upc else None
data['case_quantity'] = pretty_quantity(row.case_quantity or 1)
data['cases'] = row.cases
data['units'] = row.units
data['unit_uom'] = 'LB' if row.product and row.product.weighed else 'EA'
data['quantity_display'] = "{} {}".format(
pretty_quantity(row.cases or row.units),
'CS' if row.cases else data['unit_uom'])
data['allow_cases'] = self.handler.allow_cases(batch)
return data
def update_object(self, row, data):
"""
Supplements the default logic as follows:
Converts certain fields within the data, to proper "native" types.
"""
# convert some data types as needed
if 'cases' in data:
if data['cases'] == '':
data['cases'] = None
elif data['cases']:
data['cases'] = int(data['cases'])
if 'units' in data:
if data['units'] == '':
data['units'] = None
elif data['units']:
data['units'] = int(data['units'])
# update row per usual
row = super(InventoryBatchRowViews, self).update_object(row, data)
return row
def includeme(config):
InventoryBatchViews.defaults(config)
InventoryBatchRowViews.defaults(config)