mirror of
https://github.com/rickbarrette/redmine_qbo.git
synced 2026-11-18 02:20:37 -05:00
Fold redmine_qbo_billing into redmine_qbo
Estimates, invoices and payments written in Redmine, issues from estimates, and the QuickBooks product/service list and accounts are now part of this plugin (the RedmineQboBilling code, its controllers, views, strings and permissions), so there's one plugin and one version instead of two that had to match. - The customer page, estimate and invoice lists and the issue page render the Create Estimate / Create invoice / Receive payment and Edit links directly; the hooks that only existed to let billing add them are gone. Users without the billing permissions still get the links to QuickBooks. - Migrations 043-046 create the items and accounts tables and the estimate line links, skipping whatever an existing database already has (redmine_qbo_lineitems' tables are used as they are), and copy calendar's existing estimate line links in. - The billing settings are a section of this plugin's settings page. - The hooks other plugins use stay: qbo_billing_issue_values, qbo_billing_validate, qbo_billing_issue_defaults, qbo_billing_issues_created and view_qbo_estimate_contextual. - rake redmine_qbo:relate_estimate_issues Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
This commit is contained in:
67 files changed
+5570
-19
No files matched your search
@@ -0,0 +1,152 @@
|
||||
#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.
|
||||
|
||||
module RedmineQboBilling
|
||||
# What the QuickBooks company is set up with, read from its Preferences so nothing has to be configured
|
||||
# in Redmine: the estimate custom fields (found by name), whether estimate numbers are typed by hand,
|
||||
# and the default message shown on estimates.
|
||||
#
|
||||
# QuickBooks only shares its first three text custom fields with apps (dropdown fields aren't
|
||||
# available), so a "Sales Person" dropdown has to be changed to a text field to be filled in here.
|
||||
module Company
|
||||
CACHE_KEY = 'redmine_qbo_billing:company'
|
||||
CACHE_TIME = 1.hour
|
||||
# While the VIN or sales person field is missing, look again sooner (e.g. right after adding it in QuickBooks)
|
||||
MISSING_FIELD_CACHE_TIME = 5.minutes
|
||||
# Recent estimates also show which custom fields exist, for companies whose preferences don't list them
|
||||
RECENT_ESTIMATES = 20
|
||||
|
||||
# Custom field names are matched loosely, e.g. "VIN", "Vin #", "Sales Person", "Salesperson", "Sales Rep"
|
||||
VIN_NAME = /\bvin\b/i
|
||||
SALES_PERSON_NAME = /sales|\brep\b/i
|
||||
MILEAGE_NAME = /mileage|odometer|\bmiles\b/i
|
||||
|
||||
Field = Struct.new(:id, :name)
|
||||
|
||||
module_function
|
||||
|
||||
# All enabled sales form custom fields, in QuickBooks' order
|
||||
def custom_fields
|
||||
Array(settings[:custom_fields]).map { |f| Field.new(f[:id], f[:name]) }
|
||||
end
|
||||
|
||||
def vin_field
|
||||
custom_fields.detect { |f| f.name.to_s =~ VIN_NAME }
|
||||
end
|
||||
|
||||
# Optional: a text field named like "Mileage" or "Odometer"
|
||||
def mileage_field
|
||||
custom_fields.detect { |f| f.name.to_s =~ MILEAGE_NAME && f.name.to_s !~ VIN_NAME }
|
||||
end
|
||||
|
||||
def sales_person_field
|
||||
custom_fields.detect { |f| f.name.to_s =~ SALES_PERSON_NAME && f.name.to_s !~ VIN_NAME }
|
||||
end
|
||||
|
||||
# When on, QuickBooks leaves estimate numbers to the user; when off it numbers them itself
|
||||
def custom_txn_numbers?
|
||||
settings[:custom_txn_numbers] == true
|
||||
end
|
||||
|
||||
# The "default message shown on estimates" from QuickBooks' sales settings
|
||||
def estimate_message
|
||||
settings[:estimate_message].to_s
|
||||
end
|
||||
|
||||
# The "default message shown on invoices" (and other sales forms)
|
||||
def invoice_message
|
||||
settings[:invoice_message].to_s
|
||||
end
|
||||
|
||||
# Forgets the cached preferences, e.g. after a custom field was renamed in QuickBooks
|
||||
def refresh!
|
||||
Rails.cache.delete(CACHE_KEY)
|
||||
settings
|
||||
end
|
||||
|
||||
# Cached for an hour (five minutes while a field is missing). A failed lookup isn't cached.
|
||||
def settings
|
||||
cached = Rails.cache.read(CACHE_KEY)
|
||||
return cached if cached
|
||||
|
||||
fresh = fetch_settings
|
||||
return {} unless fresh
|
||||
|
||||
names = fresh[:custom_fields].map { |f| f[:name].to_s }
|
||||
complete = names.any? { |n| n =~ VIN_NAME } && names.any? { |n| n =~ SALES_PERSON_NAME && n !~ VIN_NAME }
|
||||
Rails.cache.write(CACHE_KEY, fresh, expires_in: complete ? CACHE_TIME : MISSING_FIELD_CACHE_TIME)
|
||||
fresh
|
||||
end
|
||||
|
||||
def fetch_settings
|
||||
QboConnectionService.with_qbo_service(entity: 'Preferences') do |service|
|
||||
prefs = service.query.entries.first
|
||||
return nil unless prefs
|
||||
|
||||
forms = prefs.sales_forms
|
||||
{
|
||||
custom_fields: merge_fields(parse_custom_fields(forms&.custom_fields), custom_fields_from_estimates),
|
||||
custom_txn_numbers: forms&.custom_txn_numbers? == 'true' || forms&.custom_txn_numbers? == true,
|
||||
estimate_message: forms&.estimate_message.to_s,
|
||||
invoice_message: forms&.default_customer_message.to_s
|
||||
}
|
||||
end
|
||||
rescue StandardError => e
|
||||
Rails.logger.warn "[RedmineQboBilling] Could not read QuickBooks preferences: #{e.message}"
|
||||
nil
|
||||
end
|
||||
|
||||
# Fields named in the preferences come first; fields only seen on estimates are added after them.
|
||||
# QuickBooks' newer custom fields (e.g. on Advanced and sandbox companies) may not be in the preferences.
|
||||
def merge_fields(from_preferences, from_estimates)
|
||||
ids = from_preferences.map { |f| f[:id] }
|
||||
from_preferences + from_estimates.reject { |f| ids.include?(f[:id]) }
|
||||
end
|
||||
|
||||
# The text custom fields on the most recently changed estimates
|
||||
def custom_fields_from_estimates
|
||||
estimates = QboEstimateService.with_service do |service|
|
||||
service.query('SELECT * FROM Estimate ORDERBY MetaData.LastUpdatedTime DESC', per_page: RECENT_ESTIMATES).entries
|
||||
end
|
||||
|
||||
Array(estimates).flat_map { |e| Array(e.custom_fields) }
|
||||
.select { |f| f.id.to_i > 0 && f.name.present? && (f.type.blank? || f.type.to_s == 'StringType') }
|
||||
.map { |f| { id: f.id.to_i, name: f.name.to_s.strip } }
|
||||
.uniq { |f| f[:id] }
|
||||
.sort_by { |f| f[:id] }
|
||||
rescue StandardError => e
|
||||
Rails.logger.warn "[RedmineQboBilling] Could not read custom fields from recent estimates: #{e.message}"
|
||||
[]
|
||||
end
|
||||
|
||||
# Preferences list the custom fields as name/value pairs:
|
||||
# SalesFormsPrefs.UseSalesCustom2 => true (field 2 is turned on)
|
||||
# SalesFormsPrefs.SalesCustomName2 => "VIN" (field 2's name)
|
||||
# The number is the field's DefinitionId on estimates.
|
||||
def parse_custom_fields(entries)
|
||||
enabled = {}
|
||||
names = {}
|
||||
|
||||
Array(entries).each do |entry|
|
||||
case entry.name.to_s
|
||||
when /UseSalesCustom(\d+)\z/
|
||||
enabled[$1.to_i] = entry.boolean_value.to_s == 'true'
|
||||
when /SalesCustomName(\d+)\z/
|
||||
names[$1.to_i] = entry.string_value.to_s.strip
|
||||
end
|
||||
end
|
||||
|
||||
names.keys.sort.filter_map do |id|
|
||||
next if names[id].blank? || enabled[id] == false
|
||||
{ id: id, name: names[id] }
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
Reference in new issue
Block a user