15 Commits

20 changed files with 368 additions and 30 deletions

View File

@@ -21,7 +21,7 @@ This plugin allows **billable line items** to be attached to a Redmine issue. Wh
| Plugin Version | Redmine Version | Ruby Version | | Plugin Version | Redmine Version | Ruby Version |
| --- | --- | --- | | --- | --- | --- |
| 2026.3.3+ | 6.1.x | 3.2+ | | 2026.3.6+ | 6.1.x | 3.2+ |
--- ---

View File

@@ -10,13 +10,70 @@
class ItemsController < ApplicationController class ItemsController < ApplicationController
before_action :require_login before_action :require_login
before_action :find_item, only: [:show, :edit, :update, :destroy]
def autocomplete def autocomplete
term = params[:q].to_s term = ActiveRecord::Base.sanitize_sql_like(params[:q].to_s)
items = Item.where("description LIKE ?", "%#{ActiveRecord::Base.sanitize_sql_like(term)}%").where(active: true).order(:description).limit(20)
items = Item.where("description LIKE :t OR name LIKE :t OR sku LIKE :t", t: "%#{term}%")
.where(active: true)
.order(:description)
.limit(20)
render json: items.map { |i| render json: items.map { |i|
{ id: i.id, text: i.description, price: i.unit_price } { id: i.id, name: i.name, sku: i.sku, description: i.description, price: i.unit_price }
} }
end end
def create
@item = Item.new(item_params)
if @item.save
redirect_to item_path(@item), notice: l(:notice_successful_create)
else
render :new
end
end
def destroy
@item.destroy
redirect_to items_path, notice: l(:notice_successful_delete)
end
def edit
end
def index
@items = Item.order(:name)
end
def new
@item = Item.new
end
def show
end
def sync
Item.sync
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
end
def update
if @item.update(item_params)
redirect_to item_path(@item), notice: l(:notice_successful_update)
else
render :edit
end
end
private
def find_item
@item = Item.find(params[:id])
end
def item_params
params.require(:item).permit(:name, :description, :sku, :unit_price, :active)
end
end end

View File

@@ -8,27 +8,39 @@
# #
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
class Item < ApplicationRecord class Item < QboBaseModel
belongs_to :issue belongs_to :issue
validates_presence_of :id, :description validates_presence_of :id, :description
validates :unit_price, numericality: { greater_than_or_equal_to: 0 } validates :unit_price, numericality: { greater_than_or_equal_to: 0 }
self.primary_key = :id self.primary_key = :id
# Sync all items, typically triggered by a scheduled task or manual sync request # Updates Both local & remote DB description
def self.sync def description=(s)
ItemSyncJob.perform_later(full_sync: true) details
@details.description = s
super
end end
# Sync a single items by ID, typically triggered by a webhook notification or manual sync request # Updates Both local & remote DB name
def self.sync_by_id(id) def name=(s)
ItemSyncJob.perform_later(id: id) details
@details.name = s
super
end end
private # Updates Both local & remote DB sku
def sku=(s)
details
@details.sku = s
super
end
def log(msg) # Updates Both local & remote DB price
Rails.logger.info "[LineItem] #{msg}" def unit_price=(s)
details
@details.unit_price = s
super
end end
end end

View File

@@ -0,0 +1,41 @@
#The MIT License (MIT)
#
#Copyright (c) 2026 rick barrette
#
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
class ItemService < ServiceBase
private
def build_qbo_remote
log "Building new QBO Item"
account = default_income_account
log "Account: #{account.id} - #{account.name}"
income = Quickbooks::Model::BaseReference.new
income.value = account.id
income.name = account.name
Quickbooks::Model::Item.new(
type: Quickbooks::Model::Item::NON_INVENTORY_TYPE,
income_account_ref: income
)
end
def default_income_account
log "Looking up sales income account"
qbo = QboConnectionService.current!
qbo.perform_authenticated_request do |token|
service = Quickbooks::Service::Account.new(
company_id: qbo.realm_id,
access_token: token
)
service.query("SELECT * FROM Account WHERE AccountType='Income' AND Name LIKE '%Sales%'").first
end
end
end

View File

@@ -10,8 +10,6 @@
class ItemSyncService < SyncServiceBase class ItemSyncService < SyncServiceBase
PAGE_SIZE = 10
private private
# Specify the local model this service syncs # Specify the local model this service syncs
@@ -19,6 +17,11 @@ class ItemSyncService < SyncServiceBase
Item Item
end end
# Specify a page size of 20, as the API only returns 20 items at a time.
def self.page_size
20
end
# Map relevant attributes from the QBO Employee to the local Employee model # Map relevant attributes from the QBO Employee to the local Employee model
def process_attributes(local, remote) def process_attributes(local, remote)
log "Processing Item ##{remote.id}" log "Processing Item ##{remote.id}"
@@ -26,6 +29,8 @@ class ItemSyncService < SyncServiceBase
local.description = remote.description local.description = remote.description
local.unit_price = remote.unit_price local.unit_price = remote.unit_price
local.active = remote.active? local.active = remote.active?
local.name = remote.name
local.sku = remote.sku
end end
def log(msg) def log(msg)

View File

@@ -0,0 +1,43 @@
<%= form_with model: @item, local: true do |f| %>
<% if @item.errors.any? %>
<div id="errorExplanation">
<h2><%= pluralize(@item.errors.count, "error") %></h2>
<ul>
<% @item.errors.full_messages.each do |msg| %>
<li><%= msg %></li>
<% end %>
</ul>
</div>
<% end %>
<p>
<%= f.label :name %><br>
<%= f.text_field :name, required: true %>
</p>
<p>
<%= f.label :sku %><br>
<%= f.text_field :sku %>
</p>
<p>
<%= f.label :description %><br>
<%= f.text_area :description, rows: 3 %>
</p>
<p>
<%= f.label :unit_price %><br>
<%= f.number_field :unit_price, step: 0.01 %>
</p>
<p>
<%= f.label :active %>
<%= f.check_box :active %>
</p>
<p>
<%= f.submit %>
</p>
<% end %>

View File

@@ -0,0 +1,5 @@
<h2>Edit Item</h2>
<%= render "form" %>
<%= link_to "Back", items_path %>

View File

@@ -0,0 +1,37 @@
<h2>Items</h2>
<div class="contextual">
<%= link_to "New Item", new_item_path, class: "icon icon-add" %>
</div>
<table class="list items">
<thead>
<tr>
<th>Name</th>
<th>SKU</th>
<th>Description</th>
<th>Price</th>
<th>Active</th>
<th></th>
</tr>
</thead>
<tbody>
<% @items.each do |item| %>
<tr>
<td><%= link_to item.name, item_path(item) %></td>
<td><%= item.sku %></td>
<td><%= item.description %></td>
<td><%= number_to_currency(item.unit_price) %></td>
<td><%= item.active ? "Yes" : "No" %></td>
<td>
<%= link_to "Edit", edit_item_path(item), class: "icon icon-edit" %>
<%= link_to "Delete", item_path(item),
method: :delete,
data: { confirm: "Are you sure?" },
class: "icon icon-del" %>
</td>
</tr>
<% end %>
</tbody>
</table>

View File

@@ -0,0 +1,5 @@
<h2>New Item</h2>
<%= render "form" %>
<%= link_to "Back", items_path %>

View File

@@ -0,0 +1,26 @@
<h2><%= @item.name %></h2>
<p>
<strong>SKU:</strong>
<%= @item.sku %>
</p>
<p>
<strong>Description:</strong>
<%= @item.description %>
</p>
<p>
<strong>Unit Price:</strong>
<%= number_to_currency(@item.unit_price) %>
</p>
<p>
<strong>Active:</strong>
<%= @item.active ? "Yes" : "No" %>
</p>
<p>
<%= link_to "Edit", edit_item_path(@item), class: "icon icon-edit" %>
<%= link_to "Back", items_path %>
</p>

View File

@@ -23,9 +23,10 @@
</td> </td>
<td data-label="<%= t :label_price %>"> <td data-label="<%= t :label_price %>">
<%= f.number_field :unit_price, <%= f.text_field :unit_price,
step: 0.01,
class: "price-field", class: "price-field",
inputmode: "decimal",
autocomplete: "off",
no_label: true, no_label: true,
disabled: readonly %> disabled: readonly %>
</td> </td>

View File

@@ -0,0 +1,6 @@
<div>
<b><%=t(:label_item_count)%></b> <%= Item.count %> @ <%= Item.last_sync %>
<br/>
<%=t(:label_last_sync)%> </b> <%= Qbo.last_sync if Qbo.exists? %>
</div>
<%= link_to t(:label_sync_now), sync_items_path %>

View File

@@ -2,35 +2,45 @@
window.initLineItemAutocomplete = function(context) { window.initLineItemAutocomplete = function(context) {
let scope = context || document; let scope = context || document;
$(scope).find(".line-item-description").each(function() { $(scope).find(".line-item-description").each(function() {
if ($(this).data("autocomplete-initialized")) return; if ($(this).data("autocomplete-initialized")) return;
$(this).data("autocomplete-initialized", true); $(this).data("autocomplete-initialized", true);
$(this).autocomplete({ let ac = $(this).autocomplete({
appendTo: "body", appendTo: "body",
minLength: 2, minLength: 2,
source: function(request, response) { source: function(request, response) {
$.getJSON("/items/autocomplete", { q: request.term }) $.getJSON("/items/autocomplete", { q: request.term })
.done(function(data) { .done(function(data) {
response(data.map(function(item) { response(data.map(function(item) {
return { return {
label: item.text, label: item.description,
value: item.text, value: item.description,
id: item.id, id: item.id,
name: item.name,
sku: item.sku,
description: item.description,
price: item.price || 0 price: item.price || 0
}; };
})); }));
}) })
.fail(function(err){ .fail(function(err){
console.error("Autocomplete error:", err); console.error("Autocomplete error:", err);
response([]); response([]);
}); });
}, },
select: function(event, ui) { select: function(event, ui) {
let $input = $(this); let $input = $(this);
let row = $input.closest(".line-item"); let row = $input.closest(".line-item");
$input.val(ui.item.value); // <-- set description // set description into input
$input.val(ui.item.description);
row.find(".item-id-field").val(ui.item.id); row.find(".item-id-field").val(ui.item.id);
if (ui.item.price !== undefined && row.find(".price-field").length) { if (ui.item.price !== undefined && row.find(".price-field").length) {
@@ -39,15 +49,31 @@
updateLineItemTotals(); updateLineItemTotals();
return false; // still prevent default to avoid double entry return false;
}, },
change: function(event, ui) { change: function(event, ui) {
if (!ui.item) { if (!ui.item) {
let row = $(this).closest(".line-item"); let row = $(this).closest(".line-item");
row.find(".item-id-field").val(""); row.find(".item-id-field").val("");
} }
} }
}); });
// Custom rendering of autocomplete suggestions
ac.autocomplete("instance")._renderItem = function(ul, item) {
return $("<li>")
.append(
"<div class='autocomplete-item'>" +
"<div class='item-name'>" + item.name + "</div>" +
"<div class='item-sku'>" + item.sku + "</div>" +
"<div class='item-description'>" + item.description + "</div>" +
"</div>"
)
.appendTo(ul);
};
}); });
}; };

View File

@@ -0,0 +1,33 @@
function evaluateMathExpression(expr) {
if (!expr) return null;
// allow only digits, decimal, operators, parentheses, spaces
if (!/^[0-9+\-*/().\s]+$/.test(expr)) {
return null;
}
try {
return Function('"use strict"; return (' + expr + ')')();
} catch {
return null;
}
}
document.addEventListener("blur", function(e) {
if (!e.target.classList.contains("price-field")) return;
const field = e.target;
const value = field.value.trim();
const result = evaluateMathExpression(value);
if (result !== null && !isNaN(result)) {
field.value = Number(result).toFixed(2);
}
if (typeof updateLineItemTotals === "function") {
updateLineItemTotals();
}
}, true);

View File

@@ -15,6 +15,24 @@
max-width: 120px; max-width: 120px;
} }
.autocomplete-item {
line-height: 1.2;
}
.item-name {
font-weight: 600;
}
.item-sku {
font-size: 0.75em;
color: #666;
}
.item-description {
font-size: 0.70em;
color: #999;
}
/* MOBILE MODE */ /* MOBILE MODE */
@media screen and (max-width: 700px) { @media screen and (max-width: 700px) {

View File

@@ -13,6 +13,7 @@
en: en:
label_description: "Description" label_description: "Description"
label_item: "Item" label_item: "Item"
label_item_count: "Item Count:"
label_line_items: "Line Items" label_line_items: "Line Items"
label_price: "Unit Price" label_price: "Unit Price"
label_qty: "Quantity" label_qty: "Quantity"

View File

@@ -8,4 +8,9 @@
# #
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
get 'items/autocomplete', to: 'items#autocomplete' resources :items do
collection do
get :autocomplete
get :sync
end
end

View File

@@ -0,0 +1,16 @@
#The MIT License (MIT)
#
#Copyright (c) 2026 rick barrette
#
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
class UpdateItems < ActiveRecord::Migration[7.0]
def change
add_column :items, :name, :string, null: false
add_column :items, :sku, :string
end
end

View File

@@ -14,21 +14,21 @@ Redmine::Plugin.register :redmine_qbo_lineitems do
name 'Redmine QBO Line Items plugin' name 'Redmine QBO Line Items plugin'
author 'Rick Barrette' author 'Rick Barrette'
description 'A plugin for Redmine to extend the capabilitys of the Redmine QuickBooks Online plugin to attach billable line items to an isuue' description 'A plugin for Redmine to extend the capabilitys of the Redmine QuickBooks Online plugin to attach billable line items to an isuue'
version '2026.3.3' version '2026.3.7'
url 'https://github.com/rickbarrette/redmine_qbo' url 'https://github.com/rickbarrette/redmine_qbo_lineitems'
author_url 'https://barrettefabrication.com' author_url 'https://barrettefabrication.com'
requires_redmine version_or_higher: '6.1.0' requires_redmine version_or_higher: '6.1.0'
settings partial: 'line_items/settings'
# Ensure redmine_qbo is installed # Ensure redmine_qbo is installed
begin begin
requires_redmine_plugin :redmine_qbo, version_or_higher: '2026.3.3' requires_redmine_plugin :redmine_qbo, version_or_higher: '2026.3.6'
rescue Redmine::PluginNotFound rescue Redmine::PluginNotFound
raise 'Please install the redmine_qbo plugin (https://github.com/rickbarrette/redmine_qbo)' raise 'Please install the redmine_qbo plugin (https://github.com/rickbarrette/redmine_qbo)'
end end
# Add safe attributes for core models # Add safe attributes for core models
Issue.safe_attributes :line_items_attributes Issue.safe_attributes :line_items_attributes
end end
# Dynamically load all Hooks & Patches recursively # Dynamically load all Hooks & Patches recursively

View File

@@ -19,6 +19,7 @@ module RedmineQboLineItems
javascript_include_tag( 'nested_form_controller', plugin: :redmine_qbo_lineitems), javascript_include_tag( 'nested_form_controller', plugin: :redmine_qbo_lineitems),
javascript_include_tag("line_items", plugin: :redmine_qbo_lineitems), javascript_include_tag("line_items", plugin: :redmine_qbo_lineitems),
javascript_include_tag("autocomplete", plugin: :redmine_qbo_lineitems), javascript_include_tag("autocomplete", plugin: :redmine_qbo_lineitems),
javascript_include_tag("blur", plugin: :redmine_qbo_lineitems),
stylesheet_link_tag("line_items", plugin: :redmine_qbo_lineitems) stylesheet_link_tag("line_items", plugin: :redmine_qbo_lineitems)
]) ])
end end