12 Commits

18 changed files with 391 additions and 155 deletions

View File

@@ -0,0 +1,27 @@
#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 AccountsController < ApplicationController
def index
@accounts = Account.where(classification: 'Revenue').order(:name)
end
def set_default
account = Account.find(params[:default_account_id])
account.update(default: true)
redirect_to accounts_path, notice: "Default account updated."
end
def sync
Account.sync
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
end
end

View File

@@ -12,6 +12,7 @@ class ItemsController < ApplicationController
before_action :require_login
before_action :find_item, only: [:show, :edit, :update, :destroy]
# Used for autocomplete form
def autocomplete
term = ActiveRecord::Base.sanitize_sql_like(params[:q].to_s)
@@ -33,6 +34,19 @@ class ItemsController < ApplicationController
else
render :new
end
rescue => e
log "Unexpected error creating item: #{e.message}"
# Regex now matches across line breaks
existing_id = e.message[/Duplicate Name Exists Error:[\s\S]*Id=(\d+)/, 1]&.to_i
if existing_id
flash[:error] = "Name already exists. Redirecting to existing item."
redirect_to item_path(existing_id)
else
flash[:error] = e.message
redirect_to new_item_path
end
end
def destroy
@@ -41,14 +55,19 @@ class ItemsController < ApplicationController
end
def edit
rescue => e
log "Failed to edit item"
flash[:error] = e.message
render_404
end
def index
def index
@items = Item.order(:name)
end
def new
@item = Item.new
@item.taxable.nil? ? true : @item.taxable
end
def show
@@ -71,9 +90,20 @@ class ItemsController < ApplicationController
def find_item
@item = Item.find(params[:id])
rescue => e
log "Failed to find item"
flash[:error] = e.message
render_404
end
def item_params
params.require(:item).permit(:name, :description, :sku, :unit_price, :active)
params.require(:item).permit(:name, :description, :sku, :unit_price, :active, :account_id, :type, :taxable)
end
private
def log(msg)
Rails.logger.info "[ItemsController] #{msg}"
end
end

View File

@@ -45,8 +45,10 @@ class BillLineItemsJob < ActiveJob::Base
log "Creating Estimate records in QBO for #{issue.customer.name} from issue ##{issue.id}"
estimate = Quickbooks::Model::Estimate.new(customer_id: issue.customer.id)
estimate_service = Quickbooks::Service::Estimate.new( company_id: qbo.realm_id, access_token: access_token)
estimate.line_items << Quickbooks::Model::InvoiceLineItem.new(description: "#{I18n.t(:notice_added_from)}#{issue.id} #{issue.subject}", detail_type: 'DescriptionOnly' )
estimate_service = Quickbooks::Service::Estimate.new( company_id: qbo.realm_id, access_token: access_token)
memo = "Added from: #{issue.tracker} ##{issue.id}: #{issue.subject}"
estimate.private_note = memo
estimate.line_items << Quickbooks::Model::InvoiceLineItem.new(description: memo, detail_type: 'DescriptionOnly' )
unbilled_entries.each do |item|
log "Creating Line Item for #{item.description}"
@@ -56,7 +58,10 @@ class BillLineItemsJob < ActiveJob::Base
line.sales_item! do |detail|
detail.unit_price = item.unit_price
detail.quantity = item.quantity
detail.tax_code_ref = Quickbooks::Model::BaseReference.new("TAX")
# Assign "TAX" only if the item is taxable or unknown
if item.item.nil? || item.item.taxable
detail.tax_code_ref = Quickbooks::Model::BaseReference.new("TAX")
end
end
estimate.line_items << line
@@ -66,8 +71,6 @@ class BillLineItemsJob < ActiveJob::Base
log "Created estimate ##{e.doc_number}"
end
private
def log(msg)
Rails.logger.info "[BillLineItemsJob] #{msg}"
end

View File

@@ -8,29 +8,34 @@
#
#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 ItemSyncJob < ApplicationJob
queue_as :default
retry_on StandardError, wait: 5.minutes, attempts: 5
class Account < QboBaseModel
has_many :items
validates_presence_of :id, :name
self.primary_key = :id
qbo_sync push: false
before_save :clear_other_defaults, if: :default?
# Performs a sync of items from QuickBooks Online.
def perform(full_sync: false, id: nil)
qbo = QboConnectionService.current!
raise "No QBO configuration found" unless qbo
# Returns the account marked as default
def self.get_default
find_by(default: true)
end
log "Starting #{full_sync ? 'full' : 'incremental'} sync for item ##{id || 'all'}..."
# Returns QBO Refrence object for the account
def ref
r = Quickbooks::Model::BaseReference.new
r.value = id
r.name = name
return r
end
service = ItemSyncService.new(qbo: qbo)
if id.present?
service.sync_by_id(id)
else
service.sync(full_sync: full_sync)
end
def to_s
name
end
private
def log(msg)
Rails.logger.info "[ItemSyncJob] #{msg}"
def clear_other_defaults
Account.where.not(id: id).update_all(default: false)
end
end

View File

@@ -10,37 +10,56 @@
class Item < QboBaseModel
belongs_to :issue
belongs_to :account
validates_presence_of :id, :description
validates :unit_price, numericality: { greater_than_or_equal_to: 0 }
self.primary_key = :id
self.inheritance_column = :_type_disabled
qbo_sync push: true
after_initialize :set_defaults, if: :new_record?
# Updates Both local & remote DB account ref
def account_id=(id)
details.income_account_ref = Account.find(id).ref
super
end
# Updates Both local & remote DB description
def description=(s)
details
@details.description = s
details.description = s
super
end
# Updates Both local & remote DB name
def name=(s)
details
@details.name = s
details.name = s
super
end
def ref
Quickbooks::Model::BaseReference.new
end
def set_defaults
self.taxable = true if taxable.nil?
end
# Updates Both local & remote DB sku
def sku=(s)
details
@details.sku = s
details.sku = s
super
end
# Updates Both local & remote DB type
def type=(s)
details.type = s.to_s
super
end
# Updates Both local & remote DB price
def unit_price=(s)
details
@details.unit_price = s
details.unit_price = s
super
end

View File

@@ -0,0 +1,23 @@
#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 AccountSyncService < SyncServiceBase
private
# Specify the local model this service syncs
def self.model_class
Account
end
map_attribute :active, :active?
map_attributes :classification, :description, :id, :name
end

View File

@@ -14,28 +14,7 @@ class ItemService < ServiceBase
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
Quickbooks::Model::Item.new(type: Account.get_default&.ref)
end
end

View File

@@ -23,6 +23,7 @@ class ItemSyncService < SyncServiceBase
end
map_attribute :active, :active?
map_attributes :description, :id, :name, :sku, :unit_price
map_attribute :taxable, :taxable?
map_attributes :description, :id, :name, :sku, :type, :unit_price
end

View File

@@ -0,0 +1,37 @@
<h2><%= l(:label_accounts) %></h2>
<%= form_tag set_default_accounts_path, method: :patch do %>
<div class="autoscroll">
<table class="list accounts">
<thead>
<tr>
<th style="width:50px;"><%= l(:label_default) %></th>
<th><%= l(:field_name) %></th>
<th><%= l(:field_description) %></th>
<th><%= l(:field_classification) %></th>
<th class="center"><%= l(:field_active) %></th>
</tr>
</thead>
<tbody>
<% @accounts.each do |account| %>
<tr class="<%= cycle("odd", "even") %>">
<td class="center">
<%= radio_button_tag "default_account_id", account.id, account.default %>
</td>
<td class="name"><strong><%= account.name %></strong></td>
<td class="description"><%= truncate(account.description, length: 80) %></td>
<td class="classification"><%= account.classification %></td>
<td class="active center">
<%= checked_image account.active %>
</td>
</tr>
<% end %>
</tbody>
</table>
</div>
<p class="buttons">
<%= submit_tag l(:button_save), class: 'button-small' %>
</p>
<% end %>

View File

@@ -1,43 +1,47 @@
<%= form_with model: @item, local: true do |f| %>
<%= labelled_form_for @item do |f| %>
<%= error_messages_for 'item' %>
<% 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 %>
<div class="box tabular">
<p>
<%= f.text_field :name, required: true, size: 60 %>
</p>
<p>
<%= f.label :name %><br>
<%= f.text_field :name, required: true %>
</p>
<p>
<%= f.text_field :sku, size: 30 %>
</p>
<p>
<%= f.label :sku %><br>
<%= f.text_field :sku %>
</p>
<p>
<%= f.text_area :description, rows: 4, class: 'wiki-edit' %>
</p>
<p>
<%= f.label :description %><br>
<%= f.text_area :description, rows: 3 %>
</p>
<p>
<%= f.number_field :unit_price, step: 0.01, size: 10 %>
</p>
<p>
<%= f.label :unit_price %><br>
<%= f.number_field :unit_price, step: 0.01 %>
</p>
<p>
<%= f.check_box :taxable %>
</p>
<p>
<%= f.label :active %>
<%= f.check_box :active %>
</p>
<p>
<%= f.label :account_id, l(:label_account) %>
<%= f.collection_select :account_id,
Account.where(classification: 'Revenue').order(:name),
:id,
:name,
{ selected: @item.account_id || Account.get_default&.id, include_blank: true } %>
</p>
<p>
<%= f.submit %>
</p>
<p>
<%= f.select :type,
Quickbooks::Model::Item::ITEM_TYPES.map { |t| [t, t] },
{ selected: @item.type || Quickbooks::Model::Item::NON_INVENTORY_TYPE } %>
</p>
<p>
<%= f.check_box :active %>
</p>
</div>
<%= submit_tag l(:button_save) %>
<%= link_to l(:button_cancel), items_path if controller.action_name == 'edit' %>
<% end %>

View File

@@ -1,37 +1,48 @@
<h2>Items</h2>
<div class="contextual">
<%= link_to "New Item", new_item_path, class: "icon icon-add" %>
<%= link_to l(:label_item_new), 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>
<h2><%= l(:label_items) %></h2>
<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>
<% if @items.any? %>
<div class="autoscroll">
<table class="list items">
<thead>
<tr>
<th><%= l(:field_name) %></th>
<th><%= l(:field_sku) %></th>
<th><%= l(:field_description) %></th>
<th><%= l(:field_unit_price) %></th>
<th class="center"><%= l(:field_taxable) %></th>
<th class="center"><%= l(:field_active) %></th>
<th></th>
</tr>
</thead>
<tbody>
<% @items.each do |item| %>
<tr class="<%= cycle("odd", "even") %>">
<td class="name"><%= link_to item.name, item_path(item) %></td>
<td class="sku"><%= item.sku %></td>
<td class="description"><%= truncate(item.description, length: 60) %></td>
<td class="unit_price"><%= number_to_currency(item.unit_price) %></td>
<td class="taxable center">
<%= item.taxable ? content_tag(:span, '', class: 'icon icon-ok') : "" %>
</td>
<td class="active center">
<%= checked_image item.active %>
</td>
<td class="buttons">
<%= link_to l(:button_edit), edit_item_path(item), class: 'icon icon-edit' %>
<%= link_to l(:button_delete), item_path(item),
method: :delete,
data: { confirm: l(:text_are_you_sure) },
class: 'icon icon-del' %>
</td>
</tr>
<% end %>
</tbody>
</table>
</div>
<% else %>
<p class="nodata"><%= l(:label_no_data) %></p>
<% end %>

View File

@@ -1,26 +1,44 @@
<h2><%= @item.name %></h2>
<div class="contextual">
<%= link_to l(:button_edit), edit_item_path(@item), class: 'icon icon-edit' %>
<%= link_to l(:button_back), items_path, class: 'icon icon-list' %>
</div>
<p>
<strong>SKU:</strong>
<%= @item.sku %>
</p>
<h2><%= t(:item) %># <%= @item.id %> <%= @item.name %></h2>
<p>
<strong>Description:</strong>
<%= @item.description %>
</p>
<div class="issue details"> <div class="attributes">
<div class="splitcontent">
<div class="splitcontentleft">
<p><strong>SKU:</strong> <%= @item.sku.presence || "-" %></p>
<p><strong>Type:</strong> <%= @item.type.presence || "-" %></p>
<p><strong>Unit Price:</strong> <%= number_to_currency(@item.unit_price) %></p>
</div>
<p>
<strong>Unit Price:</strong>
<%= number_to_currency(@item.unit_price) %>
</p>
<div class="splitcontentleft">
<p><strong>Account:</strong> <%= @item.account&.name || "-" %></p>
<p>
<strong>Taxable:</strong>
<% if @item.taxable %>
<span class="icon icon-ok" style="color: green;">Yes</span>
<% else %>
<span class="icon icon-not-ok" style="color: #999;">No</span>
<% end %>
</p>
<p>
<strong>Active:</strong>
<% if @item.active %>
<span class="icon icon-ok" style="color: green;">Yes</span>
<% else %>
<span class="icon icon-not-ok" style="color: #999;">No</span>
<% end %>
</p>
</div>
</div>
<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>
<hr />
<p><strong>Description:</strong></p>
<div class="wiki" style="padding-left: 20px;">
<%= @item.description.presence || "<em>No description provided</em>".html_safe %>
</div>
</div>
</div>

View File

@@ -1,6 +1,39 @@
<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 class="box tabular">
<p>
<label><strong><%= t(:label_item_count) %></strong></label>
<%= Item.count %>
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">
(@ <%= Item.last_sync %>)
</em>
</p>
<p>
<label><strong><%= t(:label_account_count) %></strong></label>
<%= Account.count %>
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">
(@ <%= Account.last_sync %>)
</em>
</p>
<p>
<label><strong><%= t(:label_last_sync) %> (QBO)</strong></label>
<%= Qbo.exists? ? Qbo.last_sync : 'Never synced' %>
</p>
<p>
<label><strong><%= t(:label_default_account) %></strong></label>
<%= Account.get_default %>
</p>
</div>
<%= link_to t(:label_sync_now), sync_items_path %>
<fieldset class="box">
<legend>Management & Synchronization</legend>
<div style="margin-bottom: 15px;">
<%= link_to t(:label_sync_now_items), sync_items_path, class: 'button icon icon-reload' %>
<%= link_to t(:label_sync_now_accounts), sync_accounts_path, class: 'button icon icon-reload' %>
</div>
<div>
<%= link_to t(:label_items), items_path, class: 'icon icon-list' %>
<span style="margin: 0 10px; color: #ccc;">|</span>
<%= link_to t(:label_accounts), accounts_path, class: 'icon icon-list' %>
</div>
</fieldset>

View File

@@ -11,13 +11,26 @@
# English strings go here for Rails i18n
# Usage I18n.t(:label)
en:
field_classification: "Classification"
field_sku: "SKU"
field_taxable: "Taxable"
field_unit_price: "Unit Price"
label_account: "Account"
label_accounts: "Accounts"
label_account_count: "Number of Accounts:"
label_default_account: "Default Item Income Account"
label_description: "Description"
label_item: "Item"
label_item_count: "Item Count:"
label_items: "Items"
label_line_items: "Line Items"
label_price: "Unit Price"
label_qty: "Quantity"
label_remove: "Remove"
label_sync_now_accounts: "Sync Accounts"
label_sync_now_items: "Sync Items"
label_total: "Total"
notice_added_from: "Added from issue #"

View File

@@ -13,4 +13,11 @@ resources :items do
get :autocomplete
get :sync
end
end
resources :accounts do
collection do
patch :set_default
get :sync
end
end

View File

@@ -0,0 +1,26 @@
#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 CreateAccounts < ActiveRecord::Migration[7.0]
def change
create_table :accounts do |t|
t.text :name, null: false
t.text :description
t.boolean :active, default: true, null: false
t.boolean :default, default: false, null: false
t.text :classification
t.timestamps
end
add_reference :items, :account, foreign_key: true
add_column :items, :type, :string
add_column :items, :taxable, :boolean, null: true
end
end

View File

@@ -14,7 +14,7 @@ Redmine::Plugin.register :redmine_qbo_lineitems do
name 'Redmine QBO Line Items plugin'
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'
version '2026.3.8'
version '2026.3.9'
url 'https://github.com/rickbarrette/redmine_qbo_lineitems'
author_url 'https://barrettefabrication.com'
requires_redmine version_or_higher: '6.1.0'
@@ -22,7 +22,7 @@ Redmine::Plugin.register :redmine_qbo_lineitems do
# Ensure redmine_qbo is installed
begin
requires_redmine_plugin :redmine_qbo, version_or_higher: '2026.3.7'
requires_redmine_plugin :redmine_qbo, version_or_higher: '2026.3.9'
rescue Redmine::PluginNotFound
raise 'Please install the redmine_qbo plugin (https://github.com/rickbarrette/redmine_qbo)'
end

View File

@@ -16,13 +16,13 @@ module RedmineQboLineItems
# Called by WebhookProcessJob
def qbo_additional_entities(context={})
log "Added QBO Item to allowed webook entities"
return "Item"
return ["Item", "Account"]
end
# Called by the QboSyncDispatcher
def qbo_full_sync (context={})
log "Adding ItemSyncJob to QBO sync dispatcher"
return ItemSyncJob
log "Adding Item to QBO sync dispatcher"
return [Item, Account]
end
private