Initial support for basic WooCommerce integration
product view tweaks, plus master view for local cache table
This commit is contained in:
Lance Edgar
commit
e4a032c588
14 changed files with 1256 additions and 0 deletions
27
tailbone_woocommerce/__init__.py
Normal file
27
tailbone_woocommerce/__init__.py
Normal file
|
|
@ -0,0 +1,27 @@
|
|||
# -*- coding: utf-8; -*-
|
||||
################################################################################
|
||||
#
|
||||
# Rattail -- Retail Software Framework
|
||||
# Copyright © 2010-2021 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 integration for WooCommerce
|
||||
"""
|
||||
|
||||
from ._version import __version__
|
||||
3
tailbone_woocommerce/_version.py
Normal file
3
tailbone_woocommerce/_version.py
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# -*- coding: utf-8; -*-
|
||||
|
||||
__version__ = '0.1.0'
|
||||
52
tailbone_woocommerce/templates/products/view.mako
Normal file
52
tailbone_woocommerce/templates/products/view.mako
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
## -*- coding: utf-8; -*-
|
||||
<%inherit file="tailbone:templates/products/view.mako" />
|
||||
|
||||
<%def name="object_helpers()">
|
||||
${parent.object_helpers()}
|
||||
${self.render_xref_helper()}
|
||||
</%def>
|
||||
|
||||
<%def name="render_xref_store_button()">
|
||||
<b-button type="is-primary"
|
||||
% if woocommerce_store_url:
|
||||
tag="a" href="${woocommerce_store_url}" target="_blank"
|
||||
% else:
|
||||
disabled title="${woocommerce_store_why_no_url}"
|
||||
% endif
|
||||
>
|
||||
View in WooCommerce Store
|
||||
</b-button>
|
||||
</%def>
|
||||
|
||||
<%def name="render_xref_admin_button()">
|
||||
<b-button type="is-primary"
|
||||
% if woocommerce_admin_url:
|
||||
tag="a" href="${woocommerce_admin_url}" target="_blank"
|
||||
% else:
|
||||
disabled title="${woocommerce_admin_why_no_url}"
|
||||
% endif
|
||||
>
|
||||
View in WooCommerce Admin
|
||||
</b-button>
|
||||
</%def>
|
||||
|
||||
<%def name="render_xref_helper()">
|
||||
<div class="object-helper">
|
||||
<h3>Cross-Reference</h3>
|
||||
<div class="object-helper-content">
|
||||
${self.render_xref_store_button()}
|
||||
${self.render_xref_admin_button()}
|
||||
</div>
|
||||
</div>
|
||||
</%def>
|
||||
|
||||
<%def name="extra_main_fields(form)">
|
||||
${parent.extra_main_fields(form)}
|
||||
${self.extra_main_fields_woocommerce(form)}
|
||||
</%def>
|
||||
|
||||
<%def name="extra_main_fields_woocommerce(form)">
|
||||
${form.render_field_readonly('woocommerce_id')}
|
||||
</%def>
|
||||
|
||||
${parent.body()}
|
||||
0
tailbone_woocommerce/views/__init__.py
Normal file
0
tailbone_woocommerce/views/__init__.py
Normal file
156
tailbone_woocommerce/views/products.py
Normal file
156
tailbone_woocommerce/views/products.py
Normal file
|
|
@ -0,0 +1,156 @@
|
|||
# -*- coding: utf-8; -*-
|
||||
################################################################################
|
||||
#
|
||||
# Rattail -- Retail Software Framework
|
||||
# Copyright © 2010-2021 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/>.
|
||||
#
|
||||
################################################################################
|
||||
"""
|
||||
Product Views
|
||||
"""
|
||||
|
||||
from sqlalchemy import orm
|
||||
|
||||
from rattail_woocommerce.config import woocommerce_admin_product_url
|
||||
|
||||
from tailbone.views import products as base
|
||||
|
||||
|
||||
class ProductView(base.ProductsView):
|
||||
"""
|
||||
Master view for the Product class.
|
||||
"""
|
||||
labels = {
|
||||
'woocommerce_id': "WooCommerce ID",
|
||||
}
|
||||
|
||||
@property
|
||||
def form_fields(self):
|
||||
fields = super(ProductView, self).form_fields
|
||||
return self.woocommerce_add_form_fields(fields)
|
||||
|
||||
def woocommerce_add_form_fields(self, fields):
|
||||
fields.extend([
|
||||
'woocommerce_id',
|
||||
])
|
||||
return fields
|
||||
|
||||
def query(self, session):
|
||||
query = super(ProductView, self).query(session)
|
||||
return self.woocommerce_modify_query(query)
|
||||
|
||||
def woocommerce_modify_query(self, query):
|
||||
model = self.model
|
||||
return query.outerjoin(model.WooProductExtension)
|
||||
|
||||
def configure_grid(self, g):
|
||||
super(ProductView, self).configure_grid(g)
|
||||
self.woocommerce_configure_grid(g)
|
||||
|
||||
def woocommerce_configure_grid(self, g):
|
||||
model = self.model
|
||||
g.set_filter('woocommerce_id', model.WooProductExtension.woocommerce_id)
|
||||
|
||||
def configure_form(self, f):
|
||||
super(ProductView, self).configure_form(f)
|
||||
self.woocommerce_configure_form(f)
|
||||
|
||||
def woocommerce_configure_form(self, f):
|
||||
f.set_required('woocommerce_id', False)
|
||||
if self.creating:
|
||||
f.remove('woocommerce_id')
|
||||
|
||||
def get_version_child_classes(self):
|
||||
classes = super(ProductView, self).get_version_child_classes()
|
||||
return self.woocommerce_add_version_classes(classes)
|
||||
|
||||
def woocommerce_add_version_classes(self, classes):
|
||||
model = self.model
|
||||
classes.extend([
|
||||
model.WooProductExtension,
|
||||
])
|
||||
return classes
|
||||
|
||||
def template_kwargs_view(self, **kwargs):
|
||||
kwargs = super(ProductView, self).template_kwargs_view(**kwargs)
|
||||
return self.woocommerce_template_kwargs_view(**kwargs)
|
||||
|
||||
def get_woo_cached_product(self, product):
|
||||
"""
|
||||
Tries to identify the WooCacheProduct for the given Rattail Product.
|
||||
"""
|
||||
woo_cached = None
|
||||
|
||||
if product.woocommerce_cache_product:
|
||||
# we have an official link between rattail and woo
|
||||
woo_cached = product.woocommerce_cache_product
|
||||
|
||||
elif product.item_id:
|
||||
# try to find matching woo product, even though not linked
|
||||
model = self.rattail_config.get_model()
|
||||
try:
|
||||
woo_cached = self.Session.query(model.WooCacheProduct)\
|
||||
.filter(model.WooCacheProduct.sku == product.item_id)\
|
||||
.one()
|
||||
except orm.exc.NoResultFound:
|
||||
pass
|
||||
|
||||
return woo_cached
|
||||
|
||||
def woocommerce_template_kwargs_view(self, **kwargs):
|
||||
product = kwargs['instance']
|
||||
woo_cached = self.get_woo_cached_product(product)
|
||||
|
||||
# WooCommerce Store URL
|
||||
store_url = why_not = None
|
||||
if woo_cached:
|
||||
store_url = woo_cached.permalink
|
||||
else:
|
||||
why_not = "WooCommerce cache product not found"
|
||||
kwargs['woocommerce_store_url'] = store_url
|
||||
kwargs['woocommerce_store_why_no_url'] = why_not
|
||||
|
||||
# WooCommerce Admin URL
|
||||
admin_url = why_not = None
|
||||
woo_id = woo_cached.id if woo_cached else product.woocommerce_id
|
||||
if woo_id:
|
||||
admin_url = woocommerce_admin_product_url(self.rattail_config,
|
||||
woo_id)
|
||||
if not admin_url:
|
||||
why_not = "WooCommerce Admin URL is not configured"
|
||||
else:
|
||||
why_not = "Product is not known to exist in WooCommerce"
|
||||
kwargs['woocommerce_admin_url'] = admin_url
|
||||
kwargs['woocommerce_admin_why_no_url'] = why_not
|
||||
|
||||
return kwargs
|
||||
|
||||
|
||||
def includeme(config):
|
||||
|
||||
# TODO: getting pretty tired of copy/pasting this extra config...
|
||||
config.add_route('products.autocomplete', '/products/autocomplete')
|
||||
config.add_view(base.ProductsAutocomplete, route_name='products.autocomplete',
|
||||
renderer='json', permission='products.list')
|
||||
|
||||
# TODO: getting pretty tired of copy/pasting this extra config...
|
||||
config.add_route('products.print_labels', '/products/labels')
|
||||
config.add_view(base.print_labels, route_name='products.print_labels',
|
||||
renderer='json', permission='products.print_labels')
|
||||
|
||||
ProductView.defaults(config)
|
||||
29
tailbone_woocommerce/views/woocommerce/__init__.py
Normal file
29
tailbone_woocommerce/views/woocommerce/__init__.py
Normal file
|
|
@ -0,0 +1,29 @@
|
|||
# -*- coding: utf-8; -*-
|
||||
################################################################################
|
||||
#
|
||||
# Rattail -- Retail Software Framework
|
||||
# Copyright © 2010-2021 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/>.
|
||||
#
|
||||
################################################################################
|
||||
"""
|
||||
WooCommerce views
|
||||
"""
|
||||
|
||||
|
||||
def includeme(config):
|
||||
config.include('tailbone_woocommerce.views.woocommerce.products')
|
||||
145
tailbone_woocommerce/views/woocommerce/products.py
Normal file
145
tailbone_woocommerce/views/woocommerce/products.py
Normal file
|
|
@ -0,0 +1,145 @@
|
|||
# -*- coding: utf-8; -*-
|
||||
################################################################################
|
||||
#
|
||||
# Rattail -- Retail Software Framework
|
||||
# Copyright © 2010-2021 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/>.
|
||||
#
|
||||
################################################################################
|
||||
"""
|
||||
WooCommerce product views
|
||||
"""
|
||||
|
||||
from rattail_woocommerce.db.model import WooCacheProduct
|
||||
|
||||
from webhelpers2.html import HTML, tags
|
||||
|
||||
from tailbone.views import MasterView
|
||||
|
||||
|
||||
class WooCacheProductView(MasterView):
|
||||
"""
|
||||
WooCommerce Product views
|
||||
"""
|
||||
model_class = WooCacheProduct
|
||||
url_prefix = '/woocommerce/products'
|
||||
route_prefix = 'woocommerce.products'
|
||||
creatable = False
|
||||
editable = False
|
||||
deletable = False
|
||||
has_versions = True
|
||||
|
||||
labels = {
|
||||
'id': "ID",
|
||||
'sku': "SKU",
|
||||
'parent_id': "Parent ID",
|
||||
'price_html': "Price HTML",
|
||||
'date_created_gmt': "Date Created GMT",
|
||||
'date_modified_gmt': "Date Modified GMT",
|
||||
'date_on_sale_from_gmt': "Date On Sale From GMT",
|
||||
'date_on_sale_to_gmt': "Date On Sale To GMT",
|
||||
}
|
||||
|
||||
grid_columns = [
|
||||
'id',
|
||||
'sku',
|
||||
'name',
|
||||
'price_html',
|
||||
'on_sale',
|
||||
'purchasable',
|
||||
'status',
|
||||
'date_modified',
|
||||
]
|
||||
|
||||
form_fields = [
|
||||
'id',
|
||||
'product',
|
||||
'name',
|
||||
'slug',
|
||||
'permalink',
|
||||
'date_created',
|
||||
'date_created_gmt',
|
||||
'date_modified',
|
||||
'date_modified_gmt',
|
||||
'type',
|
||||
'status',
|
||||
'featured',
|
||||
'catalog_visibility',
|
||||
'description',
|
||||
'short_description',
|
||||
'sku',
|
||||
'price',
|
||||
'regular_price',
|
||||
'sale_price',
|
||||
'date_on_sale_from',
|
||||
'date_on_sale_from_gmt',
|
||||
'date_on_sale_to',
|
||||
'date_on_sale_to_gmt',
|
||||
'price_html',
|
||||
'on_sale',
|
||||
'purchasable',
|
||||
'total_sales',
|
||||
'tax_status',
|
||||
'tax_class',
|
||||
'manage_stock',
|
||||
'stock_quantity',
|
||||
'stock_status',
|
||||
'backorders',
|
||||
'backorders_allowed',
|
||||
'backordered',
|
||||
'sold_individually',
|
||||
'weight',
|
||||
'reviews_allowed',
|
||||
'parent_id',
|
||||
'purchase_note',
|
||||
'menu_order',
|
||||
]
|
||||
|
||||
def configure_grid(self, g):
|
||||
super(WooCacheProductView, self).configure_grid(g)
|
||||
|
||||
g.filters['sku'].default_active = True
|
||||
g.filters['sku'].default_verb = 'contains'
|
||||
|
||||
g.filters['name'].default_active = True
|
||||
g.filters['name'].default_verb = 'contains'
|
||||
|
||||
g.set_sort_defaults('sku')
|
||||
|
||||
g.set_renderer('price_html', self.render_html)
|
||||
g.set_label('price_html', "Price")
|
||||
g.filters['price_html'].label = "Price HTML"
|
||||
|
||||
g.set_link('id')
|
||||
g.set_link('sku')
|
||||
g.set_link('name')
|
||||
|
||||
def configure_form(self, f):
|
||||
super(WooCacheProductView, self).configure_form(f)
|
||||
|
||||
f.set_renderer('product', self.render_product)
|
||||
f.set_renderer('permalink', self.render_url)
|
||||
f.set_renderer('price_html', self.render_html)
|
||||
|
||||
f.set_renderer('date_created_gmt', self.render_as_is)
|
||||
f.set_renderer('date_modified_gmt', self.render_as_is)
|
||||
f.set_renderer('date_on_sale_from_gmt', self.render_as_is)
|
||||
f.set_renderer('date_on_sale_to_gmt', self.render_as_is)
|
||||
|
||||
|
||||
def includeme(config):
|
||||
WooCacheProductView.defaults(config)
|
||||
Loading…
Add table
Add a link
Reference in a new issue