mirror of
https://github.com/rickbarrette/redmine_qbo.git
synced 2026-11-21 10:50:37 -05:00
Compare commits
2
Commits
2026.11.28
...
master
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
6006bd98f0 | ||
|
|
eb8bfc724b |
No files matched your search
@@ -35,6 +35,8 @@ For production deployments, **use a tagged release**.
|
||||
* Optionally associate a **QuickBooks Estimate** with the Issue.
|
||||
|
||||
* Automatically associates a **QuickBooks Invoice** with the Issue.
|
||||
|
||||
* **Macros** in an issue's subject or description are filled in when it's saved, e.g. an issue template's `Estimate {{estimate}} for {{customer}}`: `{{customer}}` is the customer's name and `{{estimate}}` the estimate number. A macro without a value yet (no estimate linked) stays as typed and fills on a later save. Companion plugins add more through the `:qbo_issue_macros` hook (redmine_qbo_vehicles: `{{vehicle}}`).
|
||||
|
||||
|
||||
---
|
||||
@@ -278,6 +280,7 @@ Hook|:qbo_billing_field_defaults, { customer:, issues: } | Return `{ field_id =>
|
||||
Hook|:qbo_billing_field_options, { customer: } | Return `{ field_id => [{ value:, label: }, ...] }` to suggest in the editor's custom field boxes for a customer (redmine_qbo_vehicles: the customer's vehicles for the VIN box)
|
||||
View|:view_qbo_estimate_form_bottom, { form:, document: } | Add your plugin's script to the estimate/invoice editor. It can use `window.qboEditor` (`field(id)`, `fieldNamed(/name/)`, `setFieldOptions(id, options)`) and listen for `qbo:customer-changed` and `qbo:imported` on the form (redmine_qbo_vehicles fills the VIN and mileage)
|
||||
View|checkboxes with `data-ticked-field="field"`, links with `data-ticked-params` on the customer page | Ticking a box adds its value to every link with `data-ticked-params`, named by that format: `issue[%s]` for the New issue link, `%s` for a plain param (e.g. redmine_qbo_calendar's Add appointment link). One box per field (redmine_qbo's estimates: `estimate_id`, redmine_qbo_vehicles' vehicles: `vehicle_id`)
|
||||
Hook|:qbo_issue_macros, { issue: } | Return `{ 'name' => text }` to fill `{{name}}` in an issue's subject and description when it's saved (redmine_qbo_vehicles: `{{vehicle}}`). Leave a name out, or give nil, while it has no value; the macro then waits for a later save
|
||||
Hook|:qbo_billing_issue_carry_params | Return names of request params the Create issues from estimate page keeps through its form (redmine_qbo_calendar: `appointment_id`)
|
||||
Hook|:qbo_mail_settings | Return any of `shop_name`, `from`, `reply_to` and `delivery` (options for ActionMailer's `mail()`, e.g. an SMTP server) for customer emails such as refund summaries (redmine_qbo_reminders: its shop name and email settings). Blank ones fall back to Redmine's settings
|
||||
View Hook|:view_qbo_estimate_contextual, { estimate_id:, customer_id:, custom_fields:, doc_number: } | Adds links to an estimate page's action area (e.g. redmine_qbo_calendar's Add appointment); `custom_fields` is `{ field_id => value }`
|
||||
|
||||
@@ -14,7 +14,7 @@ Redmine::Plugin.register :redmine_qbo do
|
||||
name 'Redmine QBO plugin'
|
||||
author 'Rick Barrette'
|
||||
description 'A pluging for Redmine to connect with QuickBooks Online: customers, time activities for billable hours when an issue is closed, and estimates, invoices and payments written in Redmine'
|
||||
version '2026.11.28'
|
||||
version '2026.11.29'
|
||||
url 'https://github.com/rickbarrette/redmine_qbo'
|
||||
author_url 'https://barrettefabrication.com'
|
||||
settings default: {empty: true}, partial: 'qbo/settings'
|
||||
|
||||
@@ -0,0 +1,52 @@
|
||||
#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 RedmineQbo
|
||||
# Fills {{name}} macros in an issue's subject and description (e.g. from an issue template:
|
||||
# "Estimate {{estimate}} for {{customer}}") when the issue is saved. Built in: {{customer}} and
|
||||
# {{estimate}}. Other plugins add their own through the :qbo_issue_macros hook (e.g.
|
||||
# redmine_qbo_vehicles' {{vehicle}}).
|
||||
#
|
||||
# A macro without a value yet (no estimate linked) stays as typed, so it fills on a later save.
|
||||
# Names nobody provides are left alone, which keeps Redmine's own wiki macros such as {{toc}} working.
|
||||
module IssueMacros
|
||||
PATTERN = /\{\{\s*([a-z][a-z0-9_]*)\s*\}\}/i
|
||||
FIELDS = %i[subject description].freeze
|
||||
|
||||
module_function
|
||||
|
||||
def fill(issue)
|
||||
texts = FIELDS.to_h { |field| [field, issue.send(field).to_s] }
|
||||
return unless texts.values.any? { |text| text.match?(PATTERN) }
|
||||
|
||||
known = values(issue)
|
||||
return if known.empty?
|
||||
|
||||
texts.each do |field, text|
|
||||
filled = text.gsub(PATTERN) { known[Regexp.last_match(1).downcase] || Regexp.last_match(0) }
|
||||
issue.send("#{field}=", filled) unless filled == text
|
||||
end
|
||||
end
|
||||
|
||||
# { 'name' => text } for every macro with a value for this issue
|
||||
def values(issue)
|
||||
found = {
|
||||
'customer' => issue.customer&.name,
|
||||
'estimate' => issue.estimate&.to_s
|
||||
}
|
||||
Redmine::Hook.call_hook(:qbo_issue_macros, { issue: issue }).each do |result|
|
||||
next unless result.is_a?(Hash)
|
||||
|
||||
result.each { |name, value| found[name.to_s.downcase] = value }
|
||||
end
|
||||
found.transform_values { |value| value.to_s.strip.presence }.compact
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -1,55 +1,57 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 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 RedmineQbo
|
||||
module Patches
|
||||
module IssuePatch
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
prepended do
|
||||
belongs_to :customer
|
||||
belongs_to :estimate
|
||||
has_and_belongs_to_many :invoices
|
||||
|
||||
before_save :titlize_subject
|
||||
after_commit :enqueue_billing, on: :update
|
||||
end
|
||||
|
||||
# Enqueue a background job to bill the time spent on this issue to QuickBooks if the issue is closed and assigned to an employee
|
||||
def enqueue_billing
|
||||
log "Checking if issue needs billing for ##{id}"
|
||||
return unless closed? && customer.present? && assigned_to&.employee_id.present?
|
||||
|
||||
log "Enqueuing billing for issue ##{id}"
|
||||
BillIssueTimeJob.perform_later(id)
|
||||
end
|
||||
|
||||
# Capitalize each word of the subject for consistent billing descriptions, without lowercasing
|
||||
# the rest of the word (keeps LED, JL, 4x4 as typed). Only runs when the subject changes.
|
||||
def titlize_subject
|
||||
return unless subject.present? && will_save_change_to_subject?
|
||||
|
||||
log "Titlizing subject for issue ##{id}"
|
||||
self.subject = RedmineQbo::TitleCase.call(subject)
|
||||
end
|
||||
|
||||
# Generate a shareable token linking this issue to the customer for QuickBooks
|
||||
def share_token
|
||||
CustomerToken.get_token(self)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[IssuePatch] #{msg}"
|
||||
end
|
||||
end
|
||||
end
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 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 RedmineQbo
|
||||
module Patches
|
||||
module IssuePatch
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
prepended do
|
||||
belongs_to :customer
|
||||
belongs_to :estimate
|
||||
has_and_belongs_to_many :invoices
|
||||
|
||||
# {{customer}}, {{estimate}} and other plugins' macros (e.g. from an issue template)
|
||||
before_validation { RedmineQbo::IssueMacros.fill(self) }
|
||||
before_save :titlize_subject
|
||||
after_commit :enqueue_billing, on: :update
|
||||
end
|
||||
|
||||
# Enqueue a background job to bill the time spent on this issue to QuickBooks if the issue is closed and assigned to an employee
|
||||
def enqueue_billing
|
||||
log "Checking if issue needs billing for ##{id}"
|
||||
return unless closed? && customer.present? && assigned_to&.employee_id.present?
|
||||
|
||||
log "Enqueuing billing for issue ##{id}"
|
||||
BillIssueTimeJob.perform_later(id)
|
||||
end
|
||||
|
||||
# Capitalize each word of the subject for consistent billing descriptions, without lowercasing
|
||||
# the rest of the word (keeps LED, JL, 4x4 as typed). Only runs when the subject changes.
|
||||
def titlize_subject
|
||||
return unless subject.present? && will_save_change_to_subject?
|
||||
|
||||
log "Titlizing subject for issue ##{id}"
|
||||
self.subject = RedmineQbo::TitleCase.call(subject)
|
||||
end
|
||||
|
||||
# Generate a shareable token linking this issue to the customer for QuickBooks
|
||||
def share_token
|
||||
CustomerToken.get_token(self)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[IssuePatch] #{msg}"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,87 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 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.
|
||||
|
||||
require File.expand_path('../test_helper', __dir__)
|
||||
|
||||
# {{customer}}, {{estimate}} and hooked macros in issue subjects and descriptions (RedmineQbo::IssueMacros)
|
||||
class IssueMacrosTest < ActiveSupport::TestCase
|
||||
fixtures :projects, :users, :issues, :trackers, :issue_statuses, :enumerations
|
||||
|
||||
CUSTOMER_ID = 9311
|
||||
ESTIMATE_ID = 9411
|
||||
|
||||
class MacroHook < Redmine::Hook::Listener
|
||||
cattr_accessor :value
|
||||
|
||||
def qbo_issue_macros(_context = {})
|
||||
value ? { 'Truck' => value } : nil
|
||||
end
|
||||
end
|
||||
|
||||
def setup
|
||||
User.current = User.find(1)
|
||||
Estimate.where(id: ESTIMATE_ID).delete_all
|
||||
Customer.where(id: CUSTOMER_ID).delete_all
|
||||
@customer = Customer.new(id: CUSTOMER_ID, name: 'Jane Customer', phone_number: '555-0100')
|
||||
@customer.skip_qbo_push = true
|
||||
@customer.save!
|
||||
@estimate = Estimate.create!(id: ESTIMATE_ID, doc_number: '1068', customer_id: CUSTOMER_ID)
|
||||
@issue = Issue.find(1)
|
||||
@issue.update_columns(customer_id: nil, estimate_id: nil)
|
||||
MacroHook.value = nil
|
||||
end
|
||||
|
||||
def teardown
|
||||
MacroHook.value = nil
|
||||
end
|
||||
|
||||
def test_customer_and_estimate_fill_the_description
|
||||
@issue.description = "Estimate {{estimate}} for {{ Customer }}.\n{{toc}} {{unknown}}"
|
||||
@issue.customer = @customer
|
||||
@issue.estimate = @estimate
|
||||
assert @issue.save, @issue.errors.full_messages.join(', ')
|
||||
assert_equal "Estimate 1068 for Jane Customer.\r\n{{toc}} {{unknown}}", @issue.reload.description
|
||||
end
|
||||
|
||||
def test_a_macro_without_a_value_waits_for_a_later_save
|
||||
@issue.description = 'Estimate {{estimate}} for {{customer}}'
|
||||
@issue.customer = @customer
|
||||
@issue.save!
|
||||
assert_equal 'Estimate {{estimate}} for Jane Customer', @issue.reload.description
|
||||
|
||||
@issue.estimate = @estimate
|
||||
@issue.save!
|
||||
assert_equal 'Estimate 1068 for Jane Customer', @issue.reload.description
|
||||
end
|
||||
|
||||
def test_the_subject_too
|
||||
@issue.subject = 'Work order {{estimate}}'
|
||||
@issue.estimate = @estimate
|
||||
@issue.save!
|
||||
assert_equal 'Work Order 1068', @issue.reload.subject
|
||||
end
|
||||
|
||||
def test_other_plugins_add_macros_through_the_hook
|
||||
@issue.description = 'Inspect the {{truck}}'
|
||||
@issue.valid?
|
||||
assert_equal 'Inspect the {{truck}}', @issue.description
|
||||
|
||||
MacroHook.value = '2018 Jeep Wrangler'
|
||||
@issue.valid?
|
||||
assert_equal 'Inspect the 2018 Jeep Wrangler', @issue.description
|
||||
end
|
||||
|
||||
def test_text_without_macros_is_left_alone
|
||||
@issue.description = 'Nothing to fill'
|
||||
RedmineQbo::IssueMacros.expects(:values).never
|
||||
@issue.valid?
|
||||
assert_equal 'Nothing to fill', @issue.description
|
||||
end
|
||||
end
|
||||
Reference in new issue
Block a user