Compare commits

..
15 Commits
Author SHA1 Message Date
rickyandClaude Opus 5.5 0552e2f1a3 2026.11.27
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 22:26:56 -05:00
rickyandClaude Opus 5.5 bc822ddc22 Leave vehicles to redmine_qbo_vehicles' hooks
Create issues no longer copies a parent issue's vehicle itself: the parent
is passed to :qbo_billing_issue_defaults (parent_issue:) and
:qbo_billing_build_issue (parent:), and every plugin's defaults are merged
rather than only the first.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 22:17:58 -05:00
rickyandClaude Opus 5.5 62d767b695 Estimates QuickBooks can't read raise an ordinary error
EstimateService had no build_qbo_remote, so a failed read fell back to
ServiceBase's NotImplementedError, which rescue StandardError misses (e.g.
saving an appointment with an estimate while QuickBooks was down gave a 500).
Tests keep refund emails off redmine_qbo_reminders' SMTP server.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 21:50:22 -05:00
rickyandClaude Opus 5.5 7029aa70dc New screenshots
Replaced the old screenshots (outdated, with real names) with current
pages from a test instance with made-up data, and shown them in the
README.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 18:02:32 -05:00
rickyandClaude Opus 5.5 ff9556e728 Show the customer's addresses again; blank missing phones
The customer page's Billing and Shipping Address were always empty: the
controller stopped setting them in March and the view still read them.
The page now formats the QuickBooks addresses itself. A missing phone
number showed as "0", and the balance as "$125.0"; they're now blank
and "$125.00".

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 18:02:32 -05:00
rickyandClaude Opus 5.5 761722bbb1 2026.11.26
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 17:41:13 -05:00
rickyandClaude Opus 5.5 6ea5610b51 README: unlocking linked estimates, PDF permissions, running the tests
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 17:41:13 -05:00
rickyandClaude Opus 5.5 b829593bc2 Limit estimate and invoice PDFs by permission; clean up
Any logged-in user could open any estimate or invoice PDF by id. Now:
- estimates: View customers or Write estimates, or an estimate attached
  to an issue the user can see (the issue page links to it); users
  without the permission don't trigger a sync of uncached estimates
- invoices: View customers, Write invoices, View/Receive payments or
  Issue refunds, or invoices attached to issues the user can see
- share-link customers are unchanged (their own issue's documents)
- the sidebar's estimate search only shows to those who can use it

The issue PDF merges an estimate PDF with optional content, as it
already did for the issue's own PDF, instead of failing.

Removed dead code: the JSON branches of CustomersController#create
(Redmine refuses JSON there) and the scaffold views for
qbo#authenticate, #oauth_callback and #webhook, which those actions
never render. An invalid customer now shows the form with a 422.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 17:36:20 -05:00
rickyandClaude Opus 5.5 17f24f9641 Add tests for billing time, OAuth, patches and helpers
BillIssueTimeJob (hours by activity, partial failure and retry, quoted
item names), the QuickBooks connection and token refresh, the business
report's periods and database figures, the Redmine page patches and
hooks (issue page, form, history, issue list column and filter, billed
time, user employee, bill/share links, issue PDF with its estimate,
activity), RefundGateway, the refund email and PDF, the services' query
string and emailing, invoice lines' LinkedTxn, combined PDFs, invoice
attachment, and the plugin settings page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 16:41:58 -05:00
rickyandClaude Opus 5.5 da82f7e12c Add controller and job tests
Integration tests for every controller: permissions, the estimate and
invoice editors (drafts, save and send, conflicts, the linked-estimate
and paid-invoice unlocks), payments, drafts, customers and share
links, estimate/invoice PDFs for share-link customers, items, accounts,
the business report, and QboController (OAuth state check, webhook
signature, manual billing). Unit tests for the webhook job, the sync
dispatcher and QboSyncJob.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 16:36:02 -05:00
rickyandClaude Opus 5.5 9ed3ef23fb Add tests for the QuickBooks writers and services
A fake QuickBooks service (test/qbo_fake_service.rb) stands in for the
estimate, invoice and connection services, so the writers are tested
end to end without QuickBooks.

Covers EstimateWriter (reading, saving, subtotals, discounts, custom
fields, locks, accepting, emailing), InvoiceWriter (from estimates,
paid-invoice unlock, closing estimates, imports of time and
estimates), PaymentWriter (oldest-first allocation, deposits, edits),
EstimateIssueBuilder, Company, the sync services and
CustomerSearchService.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 16:28:38 -05:00
rickyandClaude Opus 5.5 00400c21dc Add tests for forms, billing helpers and models
Unit tests for EstimateForm, PaymentForm, RefundForm, InvoiceRefundForm,
InvoiceStatus, LaborItems/ManHours, IssueValues, TitleCase, the
RedmineQboBilling permission helpers and field hooks, and the models:
Customer, Estimate, Invoice, Payment (with their activity events), Item,
Account, QboDraft, QboRefund, QboSyncStatus and QboBaseModel's push and
sync behaviour.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 16:22:03 -05:00
rickyandClaude Opus 5.5 48f92f241f Allow unlocking estimates linked to issues
An estimate attached to an issue was read-only, so changing it after a
customer asked for tweaks meant taking it off the work order first.

A new global permission, "Edit estimates linked to issues" (on top of
Write estimates), shows an "Unlock to edit" button on a linked
estimate. After a confirmation the estimate opens for editing, and the
issues stay linked when it's saved. EstimateWriter.save still refuses a
linked estimate unless it was unlocked by a user with the permission.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-20 16:08:52 -05:00
rickyandClaude Opus 5.5 22af08cee7 2026.11.25
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:44:30 -05:00
rickyandClaude Opus 5.5 7c87f4f9c5 Fix attachments on customer share links
The attachments patch skipped the login redirect for share-link holders
but left Redmine's read_authorize, find_container and
find_downloadable_attachments in place, which deny the anonymous user.
It relied on an Attachment#visible? patch that never existed, so every
file on a shared issue sent the customer to the login page.

Those checks now pass when the session holds an active share token for
the file's issue (show, download, thumbnail, Download all), and defer
to Redmine otherwise. Files on private notes stay hidden, matching the
share page.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-18 18:44:30 -05:00
79 changed files with 5339 additions and 144 deletions

No files matched your search

+33 -3
View File
@@ -119,7 +119,7 @@ Estimates and invoices keep their number, date, customer, total, sales tax and *
* **Edit** any estimate from the Edit link next to it on the customer page or the issue page. * **Edit** any estimate from the Edit link next to it on the customer page or the issue page.
* **Keyboard entry**: in a line's product box, Tab picks the product the text points to (an exact name, the only match, or the only name starting with it, e.g. "lab" → Labor) and fills the line. Tabbing into the description, quantity or rate selects it, so typing replaces it. The quantity, rate and amount boxes take simple math (e.g. `33*1.3`, `(120+15)/2`; `+ - * /`, `x` for times, parentheses), worked out when you leave the box; math in the rate or amount is rounded to the nearest penny, and an amount sets the rate from the quantity. Typing `sub`, `subtotal` or `=` in a product box, then Tab or Enter, adds a subtotal there (an empty line becomes the subtotal; a line with a description keeps it and gets the subtotal after it) and moves on to the next line. * **Keyboard entry**: in a line's product box, Tab picks the product the text points to (an exact name, the only match, or the only name starting with it, e.g. "lab" → Labor) and fills the line. Tabbing into the description, quantity or rate selects it, so typing replaces it. The quantity, rate and amount boxes take simple math (e.g. `33*1.3`, `(120+15)/2`; `+ - * /`, `x` for times, parentheses), worked out when you leave the box; math in the rate or amount is rounded to the nearest penny, and an amount sets the rate from the quantity. Typing `sub`, `subtotal` or `=` in a product box, then Tab or Enter, adds a subtotal there (an empty line becomes the subtotal; a line with a description keeps it and gets the subtotal after it) and moves on to the next line.
* **Duplicate** an estimate to start a similar one: same customer, lines, subtotals, custom fields and messages, dated today, with the current user as sales person. * **Duplicate** an estimate to start a similar one: same customer, lines, subtotals, custom fields and messages, dated today, with the current user as sales person.
* **Read-only once linked to an issue**: an estimate that an issue is linked to can be viewed, emailed and duplicated, but not changed, so the work doesn't drift from what was quoted. The list shows a View link for these instead of Edit. * **Read-only once linked to an issue**: an estimate that an issue is linked to can be viewed, emailed and duplicated, but not changed by accident, so the work doesn't drift from what was quoted. The list shows a View link for these instead of Edit. Users with **Edit estimates linked to issues** get **Unlock to edit** on the estimate's page (e.g. a customer asks for changes to the estimate on a diagnostic work order): after a confirmation it opens for editing, and the issues stay linked when it's saved.
* **Read-only once billed**: an estimate that's Converted or Closed in QuickBooks, or linked to an invoice, can't be changed here either (including redmine_qbo_lineitems' estimates once they're invoiced). Its page lists the invoices it's on; it can still be viewed, emailed and duplicated, and it shows View instead of Edit in lists. * **Read-only once billed**: an estimate that's Converted or Closed in QuickBooks, or linked to an invoice, can't be changed here either (including redmine_qbo_lineitems' estimates once they're invoiced). Its page lists the invoices it's on; it can still be viewed, emailed and duplicated, and it shows View instead of Edit in lists.
* **Create issues** from an estimate's labor lines (moved here from redmine_qbo_calendar): each line with one of the **labor products/services** (e.g. Labor) becomes an issue with the line's description as subject and its quantity as estimated hours. Pick the project, trackers, templates and shared custom fields first. Lines already turned into issues can't be created twice, and issues from the same estimate are related to each other. Creating issues marks a pending estimate **Accepted** in QuickBooks (dated today), since the work is going ahead; estimates that are already accepted, closed, converted or rejected keep their status. Opened from an appointment, the issues get the appointment's dates, technician and vehicle. * **Create issues** from an estimate's labor lines (moved here from redmine_qbo_calendar): each line with one of the **labor products/services** (e.g. Labor) becomes an issue with the line's description as subject and its quantity as estimated hours. Pick the project, trackers, templates and shared custom fields first. Lines already turned into issues can't be created twice, and issues from the same estimate are related to each other. Creating issues marks a pending estimate **Accepted** in QuickBooks (dated today), since the work is going ahead; estimates that are already accepted, closed, converted or rejected keep their status. Opened from an appointment, the issues get the appointment's dates, technician and vehicle.
* **Email** the estimate with QuickBooks' own estimate email, with **Save and send** or the Email link. * **Email** the estimate with QuickBooks' own estimate email, with **Save and send** or the Email link.
@@ -222,6 +222,7 @@ Administration → Items lists the QuickBooks product/service list (synced from
1. Navigate to Administration -> Roles and permissions. 1. Navigate to Administration -> Roles and permissions.
2. Assign these global permissions as needed: 2. Assign these global permissions as needed:
* **Write estimates**: create and edit estimates * **Write estimates**: create and edit estimates
* **Edit estimates linked to issues**: unlock an estimate an issue is linked to and change it (on top of Write estimates)
* **Email estimates**: email estimates to customers (Save and send, and the Email link) * **Email estimates**: email estimates to customers (Save and send, and the Email link)
* **Create issues from estimates**: the Create issues page (was redmine_qbo_calendar's "Create issues from appointment estimates") * **Create issues from estimates**: the Create issues page (was redmine_qbo_calendar's "Create issues from appointment estimates")
* **View payments**: a customer's Payments list, the payment page and its PDF * **View payments**: a customer's Payments list, the payment page and its PDF
@@ -229,9 +230,12 @@ Administration → Items lists the QuickBooks product/service list (synced from
* **View business reports**: the Business report * **View business reports**: the Business report
* **Write invoices**: create and edit invoices, and import time and estimates into them * **Write invoices**: create and edit invoices, and import time and estimates into them
* **Email invoices**: email invoices to customers * **Email invoices**: email invoices to customers
* **Edit partially paid invoices** / **Edit paid invoices**: unlock an invoice with a payment applied and change it, never below what's been paid (on top of Write invoices)
* **Issue refunds**: the Refund page (customer credit) and refunds of paid invoices, refunds and their PDFs * **Issue refunds**: the Refund page (customer credit) and refunds of paid invoices, refunds and their PDFs
* **Share issues with customers**: the Share link on issues (see Sharing an issue with the customer) * **Share issues with customers**: the Share link on issues (see Sharing an issue with the customer)
Estimate and invoice PDFs follow these permissions: any estimate with **View customers** or **Write estimates**; any invoice with **View customers**, **Write invoices**, **View payments**, **Receive payments** or **Issue refunds**. Other users open only the estimates and invoices attached to issues they can see (the issue page links to them), and a shared link opens only that issue's.
2. Settings (Administration -> Plugins -> Configure) 2. Settings (Administration -> Plugins -> Configure)
* **Estimates expire after (days)**: new estimates get an expiration date this many days after the estimate date (e.g. 30). Leave blank for none. * **Estimates expire after (days)**: new estimates get an expiration date this many days after the estimate date (e.g. 30). Leave blank for none.
* **Labor products/services** (e.g. Labor): one list used three ways. An estimate's lines with them can become issues (their quantities are also the estimate's labor hours, which an appointment's hours can't be less than); an invoice's lines with them are offered under Replace these lines when time is imported; and their quantities are the hours on estimates and invoices in the business report. While none are chosen, products/services named Labor are used. * **Labor products/services** (e.g. Labor): one list used three ways. An estimate's lines with them can become issues (their quantities are also the estimate's labor hours, which an appointment's hours can't be less than); an invoice's lines with them are offered under Replace these lines when time is imported; and their quantities are the hours on estimates and invoices in the business report. While none are chosen, products/services named Labor are used.
@@ -266,8 +270,8 @@ Hook| :qbo_additional_entities | Used to add additional entites to be processed
Hook| :qbo_full_sync | Used to add a Class to be called by the QboSyncDispatcher Hook| :qbo_full_sync | Used to add a Class to be called by the QboSyncDispatcher
Hook|:qbo_billing_issue_values, { issues: } | Return `{ field_id => { issue_id => value } }` (QuickBooks custom field id; find yours with `RedmineQboBilling::Company.custom_field_matching(/name/)`) for the work orders behind an invoice, e.g. redmine_qbo_vehicles' VIN and mileage. They're given to the editor with imported time and estimates (the `qbo:imported` event) and put on redmine_qbo_lineitems' estimates Hook|:qbo_billing_issue_values, { issues: } | Return `{ field_id => { issue_id => value } }` (QuickBooks custom field id; find yours with `RedmineQboBilling::Company.custom_field_matching(/name/)`) for the work orders behind an invoice, e.g. redmine_qbo_vehicles' VIN and mileage. They're given to the editor with imported time and estimates (the `qbo:imported` event) and put on redmine_qbo_lineitems' estimates
Hook|:qbo_billing_validate, { document:, form:, issues: } | Return an error message (or several) to stop an estimate or invoice from saving, e.g. redmine_qbo_vehicles: one vehicle per invoice Hook|:qbo_billing_validate, { document:, form:, issues: } | Return an error message (or several) to stop an estimate or invoice from saving, e.g. redmine_qbo_vehicles: one vehicle per invoice
Hook|:qbo_billing_issue_defaults, { estimate:, params: } | Return `start_date`, `due_date`, `assignee`, `project`, `description`, `return_path`, `return_label`, plus any values your own fields need (e.g. redmine_qbo_calendar's `vehicle_id`), for issues created from an estimate (redmine_qbo_calendar, when opened from an appointment) Hook|:qbo_billing_issue_defaults, { estimate:, params:, parent_issue: } | Return `start_date`, `due_date`, `assignee`, `project`, `description`, `return_path`, `return_label`, plus any values your own fields need, for issues created from an estimate (redmine_qbo_calendar, when opened from an appointment; redmine_qbo_vehicles: the parent's or appointment's vehicle). Every plugin's hash is merged
Hook|:qbo_billing_build_issue, { issue:, estimate:, defaults: } | Set your plugin's own fields on each issue created from an estimate, before it's saved (redmine_qbo_vehicles sets the vehicle: the one in `defaults`, or the customer's vehicle whose VIN is on the estimate) Hook|:qbo_billing_build_issue, { issue:, estimate:, defaults:, parent: } | Set your plugin's own fields on each issue created from an estimate, before it's saved; `parent` is the parent issue, if any (redmine_qbo_vehicles sets the vehicle: the one in `defaults`, the customer's vehicle whose VIN is on the estimate, or the parent's)
View|:view_qbo_estimate_issues_form, { estimate:, defaults:, project: } | Draw your plugin's fields on the Create issues from estimate page, applied to every issue. Name them `issue_plugin_fields[name]`; the posted values reach `:qbo_billing_build_issue` in `defaults` (redmine_qbo_vehicles: the Vehicle, preselected from the estimate's VIN) View|:view_qbo_estimate_issues_form, { estimate:, defaults:, project: } | Draw your plugin's fields on the Create issues from estimate page, applied to every issue. Name them `issue_plugin_fields[name]`; the posted values reach `:qbo_billing_build_issue` in `defaults` (redmine_qbo_vehicles: the Vehicle, preselected from the estimate's VIN)
Hook|:qbo_billing_issues_created, { estimate:, issues:, params: } | Called after issues are created from an estimate Hook|:qbo_billing_issues_created, { estimate:, issues:, params: } | Called after issues are created from an estimate
Hook|:qbo_billing_field_defaults, { customer:, issues: } | Return `{ field_id => value }` for a document's work orders: used when an invoice is made from an estimate, for the fields it leaves blank. New estimates and invoices start blank (redmine_qbo_vehicles: the work orders' VIN and highest mileage) Hook|:qbo_billing_field_defaults, { customer:, issues: } | Return `{ field_id => value }` for a document's work orders: used when an invoice is made from an estimate, for the fields it leaves blank. New estimates and invoices start blank (redmine_qbo_vehicles: the work orders' VIN and highest mileage)
@@ -281,6 +285,22 @@ Other plugins create estimates with `RedmineQboBilling::EstimateWriter.create_es
--- ---
# Screenshots
All names and figures are made up.
<table>
<tr><td width="50%"><img src="Screenshots/issue.png" alt="An issue with its customer, estimate and invoice, and Bill Time / Share"><br><sub>An issue with its customer, estimate and invoice, and Bill Time / Share</sub></td><td width="50%"><img src="Screenshots/issue_form.png" alt="The customer and estimate on the issue form"><br><sub>The customer and estimate on the issue form</sub></td></tr>
<tr><td width="50%"><img src="Screenshots/issue_list.png" alt="The Customer column in issue lists"><br><sub>The Customer column in issue lists</sub></td><td width="50%"><img src="Screenshots/customers.png" alt="Customers, searchable by name or phone"><br><sub>Customers, searchable by name or phone</sub></td></tr>
<tr><td width="50%"><img src="Screenshots/customer.png" alt="A customer: QuickBooks details, estimates and invoices"><br><sub>A customer: QuickBooks details, estimates and invoices</sub></td><td width="50%"><img src="Screenshots/estimate_editor.png" alt="Writing an estimate"><br><sub>Writing an estimate</sub></td></tr>
<tr><td width="50%"><img src="Screenshots/estimate_linked_unlock.png" alt="An estimate linked to an issue, with Unlock to edit"><br><sub>An estimate linked to an issue, with Unlock to edit</sub></td><td width="50%"><img src="Screenshots/issues_from_estimate.png" alt="Creating issues from an estimate"><br><sub>Creating issues from an estimate</sub></td></tr>
<tr><td width="50%"><img src="Screenshots/invoice_editor.png" alt="Writing an invoice"><br><sub>Writing an invoice</sub></td><td width="50%"><img src="Screenshots/receive_payment.png" alt="Receiving a payment"><br><sub>Receiving a payment</sub></td></tr>
<tr><td width="50%"><img src="Screenshots/payment.png" alt="A payment and the invoices it paid"><br><sub>A payment and the invoices it paid</sub></td><td width="50%"><img src="Screenshots/business_report.png" alt="The business report"><br><sub>The business report</sub></td></tr>
<tr><td width="50%"><img src="Screenshots/plugin_config.png" alt="Plugin settings"><br><sub>Plugin settings</sub></td><td width="50%"><img src="Screenshots/user_edit.png" alt="Linking a user to a QuickBooks employee"><br><sub>Linking a user to a QuickBooks employee</sub></td></tr>
</table>
---
# Prerequisites # Prerequisites
Before installing the plugin: Before installing the plugin:
@@ -399,6 +419,16 @@ After the initial synchronization, the plugin receives updates through **Intuit
--- ---
# Running the tests
The tests run with Redmine's own test setup on MySQL (the customer search index needs it), with QuickBooks replaced by a fake (`test/qbo_fake_service.rb`), so they never call QuickBooks:
```
bundle exec rake redmine:plugins:test NAME=redmine_qbo RAILS_ENV=test
```
---
# Troubleshooting # Troubleshooting
### Time Activities Not Created ### Time Activities Not Created
Binary file not shown.

After

Width:  |  Height:  |  Size: 169 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 122 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 104 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 100 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 724 KiB

After

Width:  |  Height:  |  Size: 104 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 520 KiB

After

Width:  |  Height:  |  Size: 83 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 63 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 269 KiB

After

Width:  |  Height:  |  Size: 129 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 148 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 539 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 181 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 141 KiB

+2 -13
View File
@@ -47,27 +47,16 @@ class CustomersController < ApplicationController
def create def create
@customer = Customer.new(allowed_params) @customer = Customer.new(allowed_params)
respond_to do |format|
if @customer.save if @customer.save
log "Customer ##{@customer.id} created successfully." log "Customer ##{@customer.id} created successfully."
format.html { redirect_to @customer, notice: l(:notice_successful_create) } redirect_to @customer, notice: l(:notice_successful_create)
format.json { render json: { id: @customer.id, name: @customer.name }, status: :created }
else else
format.html { render :new } render :new, status: :unprocessable_entity
format.json { render json: { errors: @customer.errors.full_messages }, status: :unprocessable_entity }
end
end end
rescue => e rescue => e
log "Failed to create customer: #{e.message}" log "Failed to create customer: #{e.message}"
respond_to do |format|
format.html {
flash[:error] = e.message flash[:error] = e.message
redirect_to new_customer_path redirect_to new_customer_path
}
format.json {
render json: { errors: [e.message] }, status: :internal_server_error
}
end
end end
def edit def edit
+12 -1
View File
@@ -10,7 +10,8 @@
class EstimatesController < ApplicationController class EstimatesController < ApplicationController
include AuthHelper include AuthHelper
# PDFs: logged-in users, or a customer with a share link (limited to their issue's estimate). # PDFs: logged-in users with View customers or Write estimates, other logged-in users for the estimates on
# issues they can see, and share-link customers for their issue's estimate.
# Redmine's own login check is replaced by require_login_or_customer_token for these actions. # Redmine's own login check is replaced by require_login_or_customer_token for these actions.
skip_before_action :check_if_login_required, only: [:show, :doc] skip_before_action :check_if_login_required, only: [:show, :doc]
before_action :require_login_or_customer_token, only: [:show, :doc] before_action :require_login_or_customer_token, only: [:show, :doc]
@@ -42,6 +43,7 @@ class EstimatesController < ApplicationController
# Share-link customers may only open the estimate attached to their issue (checked before any sync) # Share-link customers may only open the estimate attached to their issue (checked before any sync)
return load_customer_estimate if customer_token_only? return load_customer_estimate if customer_token_only?
return load_issue_estimate unless RedmineQboBilling.estimate_viewer?
@estimate = find_estimate || sync_and_find_estimate @estimate = find_estimate || sync_and_find_estimate
@@ -65,6 +67,15 @@ class EstimatesController < ApplicationController
@estimate = estimate @estimate = estimate
end end
# For logged-in users without a billing permission: only an estimate attached to an issue they can see,
# which is always cached locally (no sync from QuickBooks)
def load_issue_estimate
estimate = find_estimate
return render_403 unless estimate && estimate_pdf_allowed?(estimate)
@estimate = estimate
end
# Attempts to find the estimate locally by ID or doc number. # Attempts to find the estimate locally by ID or doc number.
def find_estimate def find_estimate
return Estimate.find_by(doc_number: params[:search]) if params[:search].present? return Estimate.find_by(doc_number: params[:search]) if params[:search].present?
+10 -1
View File
@@ -10,11 +10,13 @@
class InvoicesController < ApplicationController class InvoicesController < ApplicationController
include AuthHelper include AuthHelper
# PDFs: logged-in users, or a customer with a share link (limited to their issue's invoices). # PDFs: logged-in users with a billing permission (RedmineQboBilling.invoice_viewer?), other logged-in users for
# the invoices on issues they can see, and share-link customers for their issue's invoices.
# Redmine's own login check is replaced by require_login_or_customer_token for this action. # Redmine's own login check is replaced by require_login_or_customer_token for this action.
skip_before_action :check_if_login_required, only: :show skip_before_action :check_if_login_required, only: :show
before_action :require_login_or_customer_token, only: :show before_action :require_login_or_customer_token, only: :show
before_action :authorize_customer_invoices, only: :show before_action :authorize_customer_invoices, only: :show
before_action :authorize_user_invoices, only: :show
# Syncing is admin-only # Syncing is admin-only
before_action :require_admin, only: :sync before_action :require_admin, only: :sync
@@ -51,6 +53,13 @@ class InvoicesController < ApplicationController
render_403 if invoice_ids.empty? || (invoice_ids - allowed).any? render_403 if invoice_ids.empty? || (invoice_ids - allowed).any?
end end
# Logged-in users: a billing permission, or invoices attached to issues they can see
def authorize_user_invoices
return true unless User.current.logged?
render_403 unless invoice_pdfs_allowed?(invoice_ids)
end
# Logs messages with a consistent prefix for easier debugging. # Logs messages with a consistent prefix for easier debugging.
def log(msg) def log(msg)
Rails.logger.info "[InvoiceController] #{msg}" Rails.logger.info "[InvoiceController] #{msg}"
+30 -19
View File
@@ -59,9 +59,11 @@ class QboEstimatesController < ApplicationController
show_error(e, :new) show_error(e, :new)
end end
# ?unlock=1 opens an estimate linked to an issue for editing anyway (after the editor's confirmation)
def edit def edit
@form = RedmineQboBilling::EstimateWriter.load(params[:id]) @form = RedmineQboBilling::EstimateWriter.load(params[:id])
@linked_issues = RedmineQboBilling::EstimateWriter.linked_issues(@form.id).visible.to_a @linked_issues = RedmineQboBilling::EstimateWriter.linked_issues(@form.id).visible.to_a
unlock_form if unlock?
rescue *QBO_ERRORS => e rescue *QBO_ERRORS => e
flash[:error] = qbo_message(e) flash[:error] = qbo_message(e)
redirect_back_or_default home_path redirect_back_or_default home_path
@@ -70,9 +72,10 @@ class QboEstimatesController < ApplicationController
def update def update
@form = RedmineQboBilling::EstimateForm.from_params(estimate_params, id: params[:id]) @form = RedmineQboBilling::EstimateForm.from_params(estimate_params, id: params[:id])
@form.sales_person = params.dig(:estimate, :sales_person).to_s @form.sales_person = params.dig(:estimate, :sales_person).to_s
unlock_form if unlock?
return show_invalid(:edit) unless @form.valid? return show_invalid(:edit) unless @form.valid?
saved = RedmineQboBilling::EstimateWriter.save(@form, user: User.current) saved = RedmineQboBilling::EstimateWriter.save(@form, user: User.current, unlock: unlock?)
finish_save(saved, l(:notice_estimate_saved_in_quickbooks, number: saved.doc_number)) finish_save(saved, l(:notice_estimate_saved_in_quickbooks, number: saved.doc_number))
rescue RedmineQboBilling::EstimateWriter::Conflict => e rescue RedmineQboBilling::EstimateWriter::Conflict => e
@conflict = true @conflict = true
@@ -92,8 +95,8 @@ class QboEstimatesController < ApplicationController
end end
# Preview of the issues that can be created from the estimate's labor lines. Each line gets a tracker and # Preview of the issues that can be created from the estimate's labor lines. Each line gets a tracker and
# (optionally) a template before anything is created. Opened from an appointment, the appointment's dates, # (optionally) a template before anything is created. Plugins fill in defaults through
# technician and vehicle are used (redmine_qbo_calendar's :qbo_billing_issue_defaults). # :qbo_billing_issue_defaults (e.g. redmine_qbo_calendar: the appointment's dates and technician).
def issues_preview def issues_preview
end end
@@ -224,19 +227,11 @@ class QboEstimatesController < ApplicationController
# What the new issues start from: # What the new issues start from:
# - dates: another plugin's (e.g. the appointment's), else the parent issue's # - dates: another plugin's (e.g. the appointment's), else the parent issue's
# - vehicle: the parent issue's, else another plugin's (e.g. the appointment's) # - plugins' own fields: what they return for :qbo_billing_issue_defaults (they're given the parent issue)
# Values posted with the form (the dates, plugins' fields such as redmine_qbo_vehicles' vehicle) win. # Values posted with the form (the dates, plugins' fields) win.
def build_defaults def build_defaults
parent_dates = {} parent_dates = @parent_issue ? { start_date: @parent_issue.start_date, due_date: @parent_issue.due_date }.compact : {}
parent_vehicle = {} parent_dates.merge(issue_defaults.compact).merge(submitted_plugin_fields).merge(submitted_dates)
if @parent_issue
parent_dates = { start_date: @parent_issue.start_date, due_date: @parent_issue.due_date }.compact
if @parent_issue.respond_to?(:vehicle_id) && @parent_issue.vehicle_id.present?
parent_vehicle = { vehicle_id: @parent_issue.vehicle_id.to_s }
end
end
parent_dates.merge(issue_defaults.compact).merge(parent_vehicle).merge(submitted_plugin_fields).merge(submitted_dates)
end end
# The Start date / Due date entered on the page, only when the form was posted. A blank one means no date. # The Start date / Due date entered on the page, only when the form was posted. A blank one means no date.
@@ -266,14 +261,15 @@ class QboEstimatesController < ApplicationController
end end
end end
# The first non-empty hash a plugin returns for :qbo_billing_issue_defaults # What plugins return for :qbo_billing_issue_defaults, merged (each fills in its own keys)
def issue_defaults def issue_defaults
results = Redmine::Hook.call_hook(:qbo_billing_issue_defaults, { estimate: @estimate, params: params }) results = Redmine::Hook.call_hook(:qbo_billing_issue_defaults,
(results.detect { |r| r.is_a?(Hash) && r.any? } || {}).symbolize_keys { estimate: @estimate, params: params, parent_issue: @parent_issue })
results.select { |r| r.is_a?(Hash) }.reduce({}) { |merged, r| merged.merge(r.symbolize_keys) }
end end
# Plugins' own fields on the preview form (issue_plugin_fields[...], drawn by :view_qbo_estimate_issues_form), # Plugins' own fields on the preview form (issue_plugin_fields[...], drawn by :view_qbo_estimate_issues_form),
# only when the form was posted: { vehicle_id: "5" } # only when the form was posted, e.g. { some_plugin_field: "5" }
def submitted_plugin_fields def submitted_plugin_fields
return {} unless request.post? return {} unless request.post?
@@ -296,6 +292,21 @@ class QboEstimatesController < ApplicationController
) )
end end
def unlock?
params[:unlock].to_s == '1'
end
# Shows an estimate linked to an issue editable, for users allowed to. EstimateWriter.save checks again.
def unlock_form
return unless RedmineQboBilling.linked_estimate_editor?
@linked_issues ||= RedmineQboBilling::EstimateWriter.linked_issues(@form.id).visible.to_a
return unless @form.locked == :linked || (@form.locked.nil? && @linked_issues.any?)
@form.locked = nil
@form.unlocked = true
end
def save_and_send? def save_and_send?
params[:save_and_send].present? params[:save_and_send].present?
end end
+15
View File
@@ -31,6 +31,21 @@ module AuthHelper
require_login require_login
end end
# A logged-in user may open the estimate's PDF with a billing permission (RedmineQboBilling.estimate_viewer?),
# or when it's attached to an issue they can see (the issue page links to it)
def estimate_pdf_allowed?(estimate)
RedmineQboBilling.estimate_viewer? || Issue.visible.where(estimate_id: estimate.id).exists?
end
# The same for invoices: every one of them must be attached to an issue the user can see
def invoice_pdfs_allowed?(invoice_ids)
return true if RedmineQboBilling.invoice_viewer?
ids = Array(invoice_ids).map(&:to_s).uniq
visible = Invoice.joins(:issues).merge(Issue.visible).where(id: ids).distinct.pluck(:id).map(&:to_s)
ids.any? && (ids - visible).empty?
end
def global_check_permission(permission) def global_check_permission(permission)
if !globaly_allowed_to?(permission) if !globaly_allowed_to?(permission)
flash[:error] = t :notice_forbidden flash[:error] = t :notice_forbidden
+10
View File
@@ -9,5 +9,15 @@
#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 EstimateService < ServiceBase class EstimateService < ServiceBase
# Raised when an estimate can't be read from QuickBooks (e.g. QuickBooks is down or disconnected)
class FetchError < StandardError; end
private
# Estimates are only read here (EstimateWriter saves them). When the read fails, raise an ordinary error
# rather than ServiceBase's NotImplementedError, which callers' `rescue StandardError` would miss; nothing
# is cached, so the next read tries QuickBooks again.
def build_qbo_remote
raise FetchError, "Could not read estimate ##{@local.id} from QuickBooks"
end
end end
+7 -5
View File
@@ -1,3 +1,5 @@
<%# Phone numbers as (401) 555-0101, left blank when the customer has none %>
<% phone = ->(number) { digits = number.to_s.gsub(/\D/, ''); digits.present? ? number_to_phone(digits.to_i, area_code: true) : '' } %>
<table> <table>
<tbody> <tbody>
@@ -13,27 +15,27 @@
<tr> <tr>
<th><%= t(:label_primary_phone) %></th> <th><%= t(:label_primary_phone) %></th>
<td><%= number_to_phone(customer&.primary_phone&.gsub(/[^\d]/, '').to_i, area_code: true) %></td> <td><%= phone.call(customer&.primary_phone) %></td>
</tr> </tr>
<tr> <tr>
<th><%= t(:label_mobile_phone) %></th> <th><%= t(:label_mobile_phone) %></th>
<td><%= number_to_phone(customer&.mobile_phone&.gsub(/[^\d]/, '').to_i, area_code: true) %></td> <td><%= phone.call(customer&.mobile_phone) %></td>
</tr> </tr>
<tr> <tr>
<th><%= t(:label_billing_address) %></th> <th><%= t(:label_billing_address) %></th>
<td><pre><%= @billing_address %></pre></td> <td><pre><%= RedmineQboBilling::EstimateWriter.format_address(customer.billing_address) %></pre></td>
</tr> </tr>
<tr> <tr>
<th><%= t(:label_shipping_address) %></th> <th><%= t(:label_shipping_address) %></th>
<td><pre><%= @shipping_address %></pre></td> <td><pre><%= RedmineQboBilling::EstimateWriter.format_address(customer.shipping_address) %></pre></td>
</tr> </tr>
<tr> <tr>
<th><%= t(:label_account_balance) %></th> <th><%= t(:label_account_balance) %></th>
<td>$<%= customer.balance %></td> <td><%= number_to_currency(customer.balance || 0) %></td>
</tr> </tr>
<% if customer.notes.present? %> <% if customer.notes.present? %>
+2 -1
View File
@@ -4,6 +4,7 @@
<%= render partial: 'customers/sidebar' %> <%= render partial: 'customers/sidebar' %>
<% end %> <% end %>
<%= render partial: 'estimates/sidebar' %> <%# Finding an estimate by number needs View customers or Write estimates %>
<%= render partial: 'estimates/sidebar' if RedmineQboBilling.estimate_viewer? %>
<% end %> <% end %>
-32
View File
@@ -1,32 +0,0 @@
<!--
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.
-->
<h2>QboController#authenticate</h2>
<body>
<!-- REPLACE THE BODY of the default application.html.erb with this -->
<% unless session[:token] %>
<ipp:connectToIntuit></ipp:connectToIntuit>
<% end %>
<% if notice %>
<div style="padding: 10px;background: gainsboro;font-weight: 900;width: 50%;"><%= notice %></div>
<% end %>
<%= yield %>
<script type="text/javascript" src="https://appcenter.intuit.com/Content/IA/intuit.ipp.anywhere.js"></script>
<script>
intuit.ipp.anywhere.setup({menuProxy: '/path/to/blue-dot', grantUrl: '<%= authenticate_vendors_url %>'});
</script>
</body>
-13
View File
@@ -1,13 +0,0 @@
<!--
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.
-->
<h2>QboController#oauth_callback</h2>
-13
View File
@@ -1,13 +0,0 @@
<!--
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.
-->
<h2>QboController#webhook</h2>
+2
View File
@@ -50,6 +50,8 @@
<%= hidden_field_tag 'estimate[txn_status]', form.txn_status, id: nil %> <%= hidden_field_tag 'estimate[txn_status]', form.txn_status, id: nil %>
<%# Shown again if the page is redisplayed; the saved value is worked out when saving %> <%# Shown again if the page is redisplayed; the saved value is worked out when saving %>
<%= hidden_field_tag 'estimate[sales_person]', form.sales_person, id: nil if form.persisted? || form.invoice? %> <%= hidden_field_tag 'estimate[sales_person]', form.sales_person, id: nil if form.persisted? || form.invoice? %>
<%# An estimate linked to an issue opened for editing (Unlock) stays unlocked if the page is shown again %>
<%= hidden_field_tag 'unlock', '1', id: nil if !invoice && form.unlocked %>
<% if invoice %> <% if invoice %>
<%= hidden_field_tag 'estimate[balance]', form.balance, id: nil %> <%= hidden_field_tag 'estimate[balance]', form.balance, id: nil %>
<%# A paid invoice opened for editing (Unlock) stays unlocked if the page is shown again %> <%# A paid invoice opened for editing (Unlock) stays unlocked if the page is shown again %>
+15
View File
@@ -67,6 +67,21 @@
<li><%= link_to_issue(issue, truncate: 60) %></li> <li><%= link_to_issue(issue, truncate: 60) %></li>
<% end %> <% end %>
</ul> </ul>
<%# Opened for editing anyway after a confirmation (e.g. the customer asks for changes after the diagnosis) %>
<% if RedmineQboBilling.linked_estimate_editor? %>
<%= link_to sprite_icon('unlock', l(:button_unlock_estimate)), edit_qbo_estimate_path(form.id, unlock: 1),
class: 'icon icon-unlock', id: 'qbo-unlock-estimate',
data: { confirm: l(:text_unlock_estimate_confirmation) } %>
<% end %>
</div>
<% elsif form.unlocked && !invoice %>
<div class="warning qbo-estimate-notice">
<%= l(:text_estimate_unlocked) %>
<ul>
<% Array(@linked_issues).each do |issue| %>
<li><%= link_to_issue(issue, truncate: 60) %></li>
<% end %>
</ul>
</div> </div>
<% elsif form.locked == :paid %> <% elsif form.locked == :paid %>
<p class="warning"> <p class="warning">
@@ -15,7 +15,7 @@
</h2> </h2>
<%# Target project and parent task: changing either reloads the page (the project's trackers and templates; <%# Target project and parent task: changing either reloads the page (the project's trackers and templates;
the parent's project, vehicle and custom field values) %> the parent's project, custom field values and plugins' fields) %>
<%= form_tag issues_preview_qbo_estimate_path(@estimate.id), method: :get, id: 'estimate-issues-project-form' do %> <%= form_tag issues_preview_qbo_estimate_path(@estimate.id), method: :get, id: 'estimate-issues-project-form' do %>
<% carry.each do |key, value| %><%= hidden_field_tag key, value, id: nil %><% end %> <% carry.each do |key, value| %><%= hidden_field_tag key, value, id: nil %><% end %>
<p> <p>
+6 -1
View File
@@ -15,7 +15,7 @@ en:
error_estimate_parent_not_found: "Parent task #%{id} wasn't found, or you can't see it." error_estimate_parent_not_found: "Parent task #%{id} wasn't found, or you can't see it."
error_estimate_parent_not_allowed: "You aren't allowed to add subtasks in %{project}." error_estimate_parent_not_allowed: "You aren't allowed to add subtasks in %{project}."
label_estimate_parent_placeholder: "Optional" label_estimate_parent_placeholder: "Optional"
text_estimate_parent_info: "The issues are created as subtasks. They get the parent's customer, and the vehicle and custom field values below start from the parent's; any left empty are filled from the parent." text_estimate_parent_info: "The issues are created as subtasks. They get the parent's customer, and the fields below start from the parent's; any left empty are filled from the parent."
notice_qbo_oauth_state_mismatch: "QuickBooks connection was not completed: the request could not be verified. Please try connecting again." notice_qbo_oauth_state_mismatch: "QuickBooks connection was not completed: the request could not be verified. Please try connecting again."
permission_bill_issues: "Bill issue time to QuickBooks" permission_bill_issues: "Bill issue time to QuickBooks"
permission_share_issues_with_customers: "Share issues with customers" permission_share_issues_with_customers: "Share issues with customers"
@@ -99,6 +99,7 @@ en:
permission_send_invoices: "Email invoices" permission_send_invoices: "Email invoices"
permission_edit_partially_paid_invoices: "Edit partially paid invoices" permission_edit_partially_paid_invoices: "Edit partially paid invoices"
permission_edit_paid_invoices: "Edit paid invoices" permission_edit_paid_invoices: "Edit paid invoices"
permission_edit_linked_estimates: "Edit estimates linked to issues"
error_invoice_paid_not_allowed: "You're not allowed to change invoices with this much paid on them" error_invoice_paid_not_allowed: "You're not allowed to change invoices with this much paid on them"
permission_create_estimate_issues: "Create issues from estimates" permission_create_estimate_issues: "Create issues from estimates"
permission_receive_payments: "Receive payments" permission_receive_payments: "Receive payments"
@@ -169,6 +170,10 @@ en:
error_discount_too_large: "The discount can't be more than the subtotal" error_discount_too_large: "The discount can't be more than the subtotal"
error_invoice_below_paid: "The invoice total (about %{total} with tax) can't be less than the %{paid} already paid on it" error_invoice_below_paid: "The invoice total (about %{total} with tax) can't be less than the %{paid} already paid on it"
button_unlock_invoice: "Unlock to edit" button_unlock_invoice: "Unlock to edit"
button_unlock_estimate: "Unlock to edit"
text_unlock_estimate_confirmation: "This estimate is linked to an issue. Unlock it to make changes? The issues stay linked to it."
text_estimate_unlocked: "Unlocked: this estimate is linked to these issues, and they stay linked when you save:"
error_estimate_linked_not_allowed: "You're not allowed to change an estimate linked to an issue."
text_unlock_invoice_confirmation: "A payment has been applied to this invoice. Unlock it to make changes, such as a discount? The payment stays applied, and the total can't go below what's been paid." text_unlock_invoice_confirmation: "A payment has been applied to this invoice. Unlock it to make changes, such as a discount? The payment stays applied, and the total can't go below what's been paid."
text_invoice_unlocked: "Unlocked: %{paid} has been paid on this invoice. The payment stays applied when you save, and the total can't go below it." text_invoice_unlocked: "Unlocked: %{paid} has been paid on this invoice. The payment stays applied when you save, and the total can't go below it."
label_drag_to_reorder: "Drag to reorder" label_drag_to_reorder: "Drag to reorder"
+3 -1
View File
@@ -14,7 +14,7 @@ Redmine::Plugin.register :redmine_qbo do
name 'Redmine QBO plugin' name 'Redmine QBO plugin'
author 'Rick Barrette' 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' 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.24' version '2026.11.27'
url 'https://github.com/rickbarrette/redmine_qbo' url 'https://github.com/rickbarrette/redmine_qbo'
author_url 'https://barrettefabrication.com' author_url 'https://barrettefabrication.com'
settings default: {empty: true}, partial: 'qbo/settings' settings default: {empty: true}, partial: 'qbo/settings'
@@ -42,6 +42,8 @@ Redmine::Plugin.register :redmine_qbo do
# Drafts (QboDraft): each user sees the drafts of the documents they may write # Drafts (QboDraft): each user sees the drafts of the documents they may write
permission :write_estimates, { qbo_estimates: [:new, :create, :edit, :update, :customer_info, :items], permission :write_estimates, { qbo_estimates: [:new, :create, :edit, :update, :customer_info, :items],
qbo_drafts: [:index, :destroy] }, global: true qbo_drafts: [:index, :destroy] }, global: true
# Unlocking an estimate linked to an issue (on top of Write estimates); see RedmineQboBilling.linked_estimate_editor?
permission :edit_linked_estimates, {}, global: true
permission :send_estimates, { qbo_estimates: [:send_email] }, global: true permission :send_estimates, { qbo_estimates: [:send_email] }, global: true
permission :create_estimate_issues, { qbo_estimates: [:issues_preview, :create_issues] }, global: true permission :create_estimate_issues, { qbo_estimates: [:issues_preview, :create_issues] }, global: true
permission :write_invoices, { qbo_invoices: [:new, :create, :edit, :update, :import_options], permission :write_invoices, { qbo_invoices: [:new, :create, :edit, :update, :import_options],
@@ -11,17 +11,45 @@
module RedmineQbo module RedmineQbo
module Patches module Patches
module AttachmentsControllerPatch module AttachmentsControllerPatch
# Redmine's own access checks, which deny the anonymous viewer of a share link. Each one defers
# to Redmine unless the session holds a customer share token for the issue the file belongs to.
module CustomerTokenAccess
private
def read_authorize
valid_customer_token? || super
end
def find_container
return super unless customer_token_for_download_all?
@container = Issue.find(params[:object_id])
@project = @container.project
rescue ActiveRecord::RecordNotFound
render_404
end
def find_downloadable_attachments
return super unless customer_token_for_download_all?
@attachments = @container.attachments.select(&:readable?)
bulk_download_max_size = Setting.bulk_download_max_size.to_i.kilobytes
if @attachments.sum(&:filesize) > bulk_download_max_size
flash[:error] = l(:error_bulk_download_size_too_big, max_size: number_to_human_size(bulk_download_max_size.to_i))
redirect_back_or_default(container_url, referer: true)
end
end
end
def self.apply def self.apply
AttachmentsController.prepend(CustomerTokenAccess)
AttachmentsController.class_eval do AttachmentsController.class_eval do
# 1. PREPEND: Must run before ANY of Redmine's ApplicationController filters # Must run before any of Redmine's ApplicationController filters
prepend_before_action :load_customer_token prepend_before_action :load_customer_token
# 2. Skip global login redirects if the user holds a valid token for this file # Skip the login redirect if the session holds a valid token for this file
skip_before_action :check_if_login_required, if: :valid_customer_token? skip_before_action :check_if_login_required, if: :valid_customer_token?
skip_before_action :check_project_privacy, raise: false, if: :valid_customer_token?
# Note: We do NOT need to skip :read_authorize anymore.
# Because we patched Attachment#visible?, read_authorize will pass naturally!
private private
@@ -31,29 +59,27 @@ module RedmineQbo
@customer_token = session[:token].present? ? CustomerToken.active.find_by(token: session[:token]) : nil @customer_token = session[:token].present? ? CustomerToken.active.find_by(token: session[:token]) : nil
end end
def customer_token_for_download_all?
@customer_token.present? && params[:action] == 'download_all' &&
params[:object_type] == 'issues' && params[:object_id].to_i == @customer_token.issue_id
end
def valid_customer_token? def valid_customer_token?
token = @customer_token token = @customer_token
return false unless token return false unless token
return customer_token_for_download_all? if params[:action] == 'download_all'
return false unless %w[show download thumbnail].include?(params[:action])
# Handle "Download All" zip requests (object_type=issues, object_id=ID)
if params[:action] == 'download_all'
return params[:object_type] == 'issues' && params[:object_id].to_i == token.issue_id
end
# Handle normal single attachment requests (show, download, thumbnail)
attachment = Attachment.find_by(id: params[:id]) attachment = Attachment.find_by(id: params[:id])
return false unless attachment return false unless attachment
# Allow if attachment belongs directly to the Issue case attachment.container_type
if attachment.container_type == 'Issue' && attachment.container_id == token.issue_id when 'Issue'
return true attachment.container_id == token.issue_id
end when 'Journal'
journal = attachment.container
# Allow if attachment belongs to a Journal (comment) on the Issue journal&.journalized_type == 'Issue' && journal.journalized_id == token.issue_id && !journal.private_notes?
if attachment.container_type == 'Journal' && attachment.container.journalized_type == 'Issue' && attachment.container.journalized_id == token.issue_id else
return true
end
false false
end end
end end
@@ -61,3 +87,4 @@ module RedmineQbo
end end
end end
end end
end
+2 -1
View File
@@ -325,7 +325,8 @@ module RedmineQbo
if issue.estimate if issue.estimate
e_pdf, _ref = PdfService.new(entity: Estimate).fetch_pdf(doc_ids: [issue.estimate.id]) e_pdf, _ref = PdfService.new(entity: Estimate).fetch_pdf(doc_ids: [issue.estimate.id])
combined = CombinePDF.parse(pdf.output, allow_optional_content: true) combined = CombinePDF.parse(pdf.output, allow_optional_content: true)
combined << CombinePDF.parse(e_pdf) # The estimate may have optional content too (layers); merged the same way as the issue's PDF
combined << CombinePDF.parse(e_pdf, allow_optional_content: true)
combined.to_pdf combined.to_pdf
else else
pdf.output pdf.output
+19
View File
@@ -93,6 +93,25 @@ module RedmineQboBilling
user.allowed_to?(:view_payments, nil, global: true) || payment_receiver?(user) user.allowed_to?(:view_payments, nil, global: true) || payment_receiver?(user)
end end
# True when the user may unlock and change an estimate linked to an issue (e.g. a customer asks for changes to
# an estimate already on the diagnostic work order): "Edit estimates linked to issues" on top of "Write estimates"
def self.linked_estimate_editor?(user = User.current)
writer?(user) && user.allowed_to?(:edit_linked_estimates, nil, global: true)
end
# True when the user may open any estimate's PDF: View customers or Write estimates. Others open only the
# estimates attached to issues they can see (see AuthHelper#estimate_pdf_allowed?).
def self.estimate_viewer?(user = User.current)
user.allowed_to?(:view_customers, nil, global: true) || writer?(user)
end
# True when the user may open any invoice's PDF: View customers, Write invoices, View or Receive payments, or
# Issue refunds (those pages link to invoices). Others open only the invoices attached to issues they can see.
def self.invoice_viewer?(user = User.current)
user.allowed_to?(:view_customers, nil, global: true) || invoice_writer?(user) || payment_viewer?(user) ||
refunder?(user)
end
# True when the user may write invoices # True when the user may write invoices
def self.invoice_writer?(user = User.current) def self.invoice_writer?(user = User.current)
user.allowed_to?(:write_invoices, nil, global: true) user.allowed_to?(:write_invoices, nil, global: true)
+2 -1
View File
@@ -112,7 +112,8 @@ module RedmineQboBilling
# (discount: the discount amount QuickBooks worked out when it was last saved) # (discount: the discount amount QuickBooks worked out when it was last saved)
:billing_address, :total, :total_tax, :discount, :email_status, :txn_status, :duplicated_from, :billing_address, :total, :total_tax, :discount, :email_status, :txn_status, :duplicated_from,
:balance, :converted_from, :balance, :converted_from,
# Invoices: a paid invoice opened for editing anyway (Unlock), and the amount paid on it # Invoices: a paid invoice opened for editing anyway (Unlock), and the amount paid on it.
# Estimates: an estimate linked to an issue opened for editing anyway (Unlock).
:unlocked, :amount_paid, :unlocked, :amount_paid,
# Estimates: the invoices it's billed on ([[id, number], ...]) # Estimates: the invoices it's billed on ([[id, number], ...])
:invoiced_on, :invoiced_on,
@@ -17,16 +17,16 @@ module RedmineQboBilling
# - Lines already turned into issues are shown but can't be created again # - Lines already turned into issues are shown but can't be created again
# - Creation is all-or-nothing: if any issue fails validation, none are saved # - Creation is all-or-nothing: if any issue fails validation, none are saved
# - All issues created from the same estimate are related to each other, across batches # - All issues created from the same estimate are related to each other, across batches
# - With a parent issue, the issues are created as its subtasks and take its customer, plus its vehicle and # - With a parent issue, the issues are created as its subtasks and take its customer, plus its custom field
# custom field values where the page left them empty (the same rules as the subtask_field_copier plugin, # values where the page left them empty (the same rules as the subtask_field_copier plugin, which is used
# which is used when installed) # when installed). Plugins copy their own fields from the parent in :qbo_billing_build_issue.
# #
# Other plugins fill in more through hooks: # Other plugins fill in more through hooks:
# :qbo_billing_issue_defaults, { estimate:, params: } => a hash of start_date, due_date, assignee, # :qbo_billing_issue_defaults, { estimate:, params:, parent_issue: } => a hash of start_date, due_date,
# description, project, return_path, return_label, plus anything a plugin's own fields need (e.g. # assignee, description, project, return_path, return_label, plus anything a plugin's own fields need.
# redmine_qbo_calendar's vehicle_id, when the page is opened from an appointment) # Every plugin's hash is merged.
# :qbo_billing_build_issue, { issue:, estimate:, defaults: } for each new issue before it's saved, to set # :qbo_billing_build_issue, { issue:, estimate:, defaults:, parent: } for each new issue before it's saved,
# plugins' own fields (e.g. redmine_qbo_vehicles sets the vehicle) # to set plugins' own fields (e.g. redmine_qbo_vehicles sets the vehicle, else the parent's)
# :view_qbo_estimate_issues_form, { estimate:, defaults:, project: } (view hook) draws plugins' fields on # :view_qbo_estimate_issues_form, { estimate:, defaults:, project: } (view hook) draws plugins' fields on
# the page, applied to every issue; posted as issue_plugin_fields[name], they reach :qbo_billing_build_issue # the page, applied to every issue; posted as issue_plugin_fields[name], they reach :qbo_billing_build_issue
# in defaults (e.g. redmine_qbo_vehicles' Vehicle, preselected from the estimate's VIN) # in defaults (e.g. redmine_qbo_vehicles' Vehicle, preselected from the estimate's VIN)
@@ -237,7 +237,7 @@ module RedmineQboBilling
issue.estimate_id = estimate.id if issue.respond_to?(:estimate_id=) issue.estimate_id = estimate.id if issue.respond_to?(:estimate_id=)
# Plugins set their own fields (e.g. redmine_qbo_vehicles: the vehicle) # Plugins set their own fields (e.g. redmine_qbo_vehicles: the vehicle)
Redmine::Hook.call_hook(:qbo_billing_build_issue, { issue: issue, estimate: estimate, defaults: defaults }) Redmine::Hook.call_hook(:qbo_billing_build_issue, { issue: issue, estimate: estimate, defaults: defaults, parent: parent })
if parent if parent
issue.parent_issue_id = parent.id issue.parent_issue_id = parent.id
@@ -248,7 +248,7 @@ module RedmineQboBilling
end end
# Fills the subtask's empty fields from the parent: custom fields (those the author can see on the parent # Fills the subtask's empty fields from the parent: custom fields (those the author can see on the parent
# and edit on the subtask) and plugins' registered fields (customer, vehicle). Values entered on the page win. # and edit on the subtask), and with subtask_field_copier its registered fields. Values entered on the page win.
def copy_from_parent(issue, author) def copy_from_parent(issue, author)
if defined?(::SubtaskFieldCopier) if defined?(::SubtaskFieldCopier)
::SubtaskFieldCopier.copy_from_parent(issue, parent, author, {}) ::SubtaskFieldCopier.copy_from_parent(issue, parent, author, {})
@@ -263,10 +263,6 @@ module RedmineQboBilling
values[custom_value.custom_field_id.to_s] = value values[custom_value.custom_field_id.to_s] = value
end end
issue.custom_field_values = copied if copied.any? issue.custom_field_values = copied if copied.any?
if issue.respond_to?(:vehicle_id=) && issue.vehicle_id.blank? && parent.respond_to?(:vehicle_id)
issue.vehicle_id = parent.vehicle_id
end
end end
def default_description def default_description
+11 -2
View File
@@ -105,6 +105,13 @@ module RedmineQboBilling
Issue.where(estimate_id: estimate_id.to_s) Issue.where(estimate_id: estimate_id.to_s)
end end
# An estimate linked to an issue is only changed when unlocked by a user allowed to
def check_linked(form, unlock, user)
return unless linked_issues(form.id).exists?
raise Error, I18n.t(:error_estimate_linked_to_issues) unless unlock
raise Error, I18n.t(:error_estimate_linked_not_allowed) unless RedmineQboBilling.linked_estimate_editor?(user)
end
# Loads the estimate from QuickBooks for editing # Loads the estimate from QuickBooks for editing
def load(id) def load(id)
remote = QboEstimateService.with_service { |service| service.fetch_by_id(id) } remote = QboEstimateService.with_service { |service| service.fetch_by_id(id) }
@@ -114,7 +121,9 @@ module RedmineQboBilling
# Creates or updates the estimate in QuickBooks and returns the saved QuickBooks estimate. # Creates or updates the estimate in QuickBooks and returns the saved QuickBooks estimate.
# The sales person is the user who creates the estimate; editing keeps the original one. # The sales person is the user who creates the estimate; editing keeps the original one.
def save(form, user: User.current) # unlock: an estimate linked to an issue may be changed (the user unlocked it, see
# RedmineQboBilling.linked_estimate_editor?)
def save(form, user: User.current, unlock: false)
customer = Customer.find_by(id: form.customer_id) customer = Customer.find_by(id: form.customer_id)
raise Error, I18n.t(:error_estimate_needs_customer) unless customer raise Error, I18n.t(:error_estimate_needs_customer) unless customer
@@ -125,7 +134,7 @@ module RedmineQboBilling
raise Conflict, I18n.t(:error_estimate_changed_in_quickbooks) if remote.sync_token.to_s != form.sync_token.to_s raise Conflict, I18n.t(:error_estimate_changed_in_quickbooks) if remote.sync_token.to_s != form.sync_token.to_s
raise Error, I18n.t(:error_estimate_billed) if billed?(remote) raise Error, I18n.t(:error_estimate_billed) if billed?(remote)
raise Error, I18n.t(:error_estimate_has_bundles) if group_lines?(remote) raise Error, I18n.t(:error_estimate_has_bundles) if group_lines?(remote)
raise Error, I18n.t(:error_estimate_linked_to_issues) if linked_issues(form.id).any? check_linked(form, unlock, user)
estimate = Quickbooks::Model::Estimate.new estimate = Quickbooks::Model::Estimate.new
estimate.id = remote.id estimate.id = remote.id
@@ -0,0 +1,87 @@
#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.
require File.expand_path('../test_helper', __dir__)
# Files on an issue shared through a customer link (customers/view/:token) open for the anonymous
# visitor holding the link, and nothing else does.
class CustomerShareAttachmentsTest < Redmine::IntegrationTest
fixtures :projects, :users, :email_addresses, :members, :member_roles, :roles, :issues, :trackers,
:projects_trackers, :issue_statuses, :enabled_modules, :enumerations, :attachments, :journals
# Issue 4 is in a private project; attachment 7 is on it, attachment 1 is on issue 3.
def setup
set_fixtures_attachments_directory
CustomerToken.delete_all
User.current = User.find(1)
@token = CustomerToken.create!(issue_id: 4, expires_at: 1.week.from_now)
User.current = nil
end
def teardown
set_tmp_attachments_directory
end
def open_share_link
get "/customers/view/#{@token.token}"
assert_response :success
end
def test_without_the_link_files_need_a_login
with_settings login_required: '1' do
get '/attachments/download/7/archive.zip'
assert_redirected_to %r{/login}
end
end
def test_share_link_opens_the_issues_files
with_settings login_required: '1' do
open_share_link
assert_select 'a[href=?]', '/attachments/7'
get '/attachments/7'
assert_response :success
get '/attachments/download/7/archive.zip'
assert_response :success
assert_equal 'application/zip', response.media_type
get '/attachments/issues/4/download'
assert_response :success
end
end
def test_share_link_does_not_open_other_files
with_settings login_required: '1' do
open_share_link
get '/attachments/download/1/error281.txt'
assert_redirected_to %r{/login}
get '/attachments/issues/3/download'
assert_redirected_to %r{/login}
end
end
def test_files_on_private_notes_stay_hidden
journal = Journal.create!(journalized: Issue.find(4), user: User.find(1), notes: 'internal', private_notes: true)
Attachment.find(1).update_columns(container_type: 'Journal', container_id: journal.id)
with_settings login_required: '1' do
open_share_link
get '/attachments/download/1/error281.txt'
assert_redirected_to %r{/login}
end
end
def test_expired_link_opens_nothing
with_settings login_required: '1' do
open_share_link
@token.update_columns(expires_at: 1.minute.ago)
get '/attachments/download/7/archive.zip'
assert_redirected_to %r{/login}
end
end
end
@@ -0,0 +1,214 @@
#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.
require File.expand_path('../test_helper', __dir__)
class CustomersControllerTest < Redmine::IntegrationTest
include QboFakeServiceHelper
fixtures :projects, :users, :email_addresses, :members, :member_roles, :roles, :issues, :trackers,
:projects_trackers, :issue_statuses, :enabled_modules, :enumerations, :workflows, :journals,
:journal_details
def setup
# The search keeps its rows in memory, keyed by customer count and newest change (to the second); tests
# roll back, so two tests can make the same key with different customers
CustomerSearchService.instance_variable_set(:@candidates, nil)
Customer.where(id: [9101, 9102]).delete_all
@customer = local_customer(9101, 'Jane Customer')
@customer.update_columns(phone_number: '4015550101')
local_customer(9102, 'Bob Builder')
Issue.find(1).update_column(:customer_id, 9101)
Issue.find(8).update_column(:customer_id, 9101)
CustomerToken.delete_all
@fake = install_fake_quickbooks
end
# Gives jsmith's Manager role the permissions and logs jsmith in (again, if someone was logged in)
def grant(*permissions)
permissions.each { |p| Role.find(1).add_permission!(p) }
reset!
log_user('jsmith', 'jsmith')
end
def test_pages_need_view_customers
log_user('jsmith', 'jsmith')
Role.find(1).remove_permission!(:view_customers)
get '/customers'
assert_response :forbidden
get '/customers/9101'
assert_response :forbidden
get '/customers/autocomplete', params: { q: 'jane' }
assert_response :forbidden
end
def test_index_lists_and_sorts
grant(:view_customers)
get '/customers', params: { sort: 'name' }
assert_response :success
assert_select 'a[href=?]', '/customers/9101'
assert_select 'a[href=?]', '/customers/9102'
end
def test_a_single_search_match_opens_the_customer
grant(:view_customers)
get '/customers', params: { search: 'Jane Customer' }
assert_redirected_to '/customers/9101'
end
def test_show_lists_open_and_closed_issues
grant(:view_customers)
get '/customers/9101'
assert_response :success
assert_select 'a[href=?]', '/issues/1'
assert_select 'a[href=?]', '/issues/8'
get '/customers/424242'
assert_response :not_found
end
def test_show_details_from_quickbooks
address = Quickbooks::Model::PhysicalAddress.new
address.line1 = '123 Main St'
address.city = 'Springfield'
address.country_sub_division_code = 'RI'
address.postal_code = '02900'
details = Quickbooks::Model::Customer.new(display_name: 'Jane Customer', balance: BigDecimal('125'))
details.billing_address = address
details.primary_phone = Quickbooks::Model::TelephoneNumber.new.tap { |t| t.free_form_number = '401-555-0101' }
@fake.customers['9101'] = details
grant(:view_customers)
get '/customers/9101'
rows = css_select('table tr').to_h { |tr| [tr.at('th')&.text.to_s.strip, tr.at('td')&.text.to_s.strip] }
assert_equal "123 Main St\nSpringfield, RI 02900", rows[I18n.t(:label_billing_address)]
assert_equal '(401) 555-0101', rows[I18n.t(:label_primary_phone)]
# No mobile number: blank, not "0"
assert_equal '', rows[I18n.t(:label_mobile_phone)]
assert_equal '$125.00', rows[I18n.t(:label_account_balance)]
end
def test_autocomplete
grant(:view_customers)
get '/customers/autocomplete', params: { q: 'jane custmer' }
assert_response :success
assert_equal [9101], JSON.parse(response.body).map { |c| c['id'] }
get '/customers/autocomplete', params: { phone: '0101' }
assert_equal ['Jane Customer'], JSON.parse(response.body).map { |c| c['name'] }
end
def test_create_needs_add_customers
grant(:view_customers)
Role.find(1).remove_permission!(:add_customers)
get '/customers/new'
assert_response :forbidden
post '/customers', params: { customer: { name: 'New Person' } }
assert_response :forbidden
end
def test_create_pushes_to_quickbooks
grant(:view_customers, :add_customers)
post '/customers', params: { customer: { name: 'new person', phone_number: '(401) 555-0123', email: 'new@example.com' } }
customer = Customer.find_by(name: 'New Person')
assert customer, 'customer created'
assert_redirected_to "/customers/#{customer.id}"
assert_equal '4015550123', customer.phone_number
assert_equal 'new@example.com', @fake.created.last.email_address.address
end
# Customers are created from the page only; JSON requests are refused
def test_json_create_is_refused
Role.find(1).add_permission!(:view_customers)
Role.find(1).add_permission!(:add_customers)
with_settings rest_api_enabled: '1' do
post '/customers.json', params: { customer: { name: 'Json Person' } },
headers: { 'X-Redmine-API-Key' => User.find(2).api_key }
end
assert_includes [401, 403, 406], response.status
assert_not Customer.exists?(name: 'Json Person')
end
def test_invalid_customer_shows_the_form_again
grant(:view_customers, :add_customers)
post '/customers', params: { customer: { name: '' } }
assert_response :unprocessable_entity
assert_select '#errorExplanation'
end
def test_quickbooks_error_on_create_is_shown
grant(:view_customers, :add_customers)
@fake.define_singleton_method(:create) { |_doc| raise Quickbooks::IntuitRequestException, 'Duplicate Name Exists' }
post '/customers', params: { customer: { name: 'Jane Customer' } }
assert_redirected_to '/customers/new'
assert_match 'Duplicate Name Exists', flash[:error]
end
def test_update_needs_edit_customers
grant(:view_customers)
Role.find(1).remove_permission!(:edit_customers)
patch '/customers/9101', params: { customer: { name: 'Changed' } }
assert_response :forbidden
grant(:edit_customers)
get '/customers/9101/edit'
assert_response :success
patch '/customers/9101', params: { customer: { name: 'jane changed' } }
assert_redirected_to '/customers/9101'
assert_equal 'Jane Changed', @customer.reload.name
assert_equal 'Jane Changed', @fake.updated.last.display_name
end
def test_sync_is_admin_only
grant(:view_customers)
get '/customers/sync'
assert_response :forbidden
reset!
log_user('admin', 'admin')
Customer.expects(:sync)
get '/customers/sync'
assert_response :redirect
end
# ---- share links ----
def test_share_needs_the_permission_and_a_visible_issue
grant(:view_customers)
Role.find(1).remove_permission!(:share_issues_with_customers)
get '/customers/share/1'
assert_response :forbidden
grant(:share_issues_with_customers)
get '/customers/share/1'
token = CustomerToken.find_by(issue_id: 1)
assert_redirected_to "/customers/view/#{token.token}"
Project.find(2).update_column(:is_public, false)
Member.where(user_id: 2, project_id: 2).destroy_all
hidden = Issue.find(4)
assert_not hidden.visible?(User.find(2))
get "/customers/share/#{hidden.id}"
assert_response :not_found
assert_not CustomerToken.exists?(issue_id: hidden.id)
end
def test_share_link_shows_the_issue_to_anyone
token = CustomerToken.create!(issue_id: 1, expires_at: 1.week.from_now)
with_settings login_required: '1' do
get "/customers/view/#{token.token}"
end
assert_response :success
assert_select 'h3, h2, div.subject', text: /#{Regexp.escape(Issue.find(1).subject)}/
end
def test_expired_or_unknown_share_links_are_refused
expired = CustomerToken.create!(issue_id: 1, expires_at: 1.week.from_now)
expired.update_column(:expires_at, 1.day.ago)
get "/customers/view/#{expired.token}"
assert_response :forbidden
get '/customers/view/not-a-token'
assert_response :forbidden
end
end
+188
View File
@@ -0,0 +1,188 @@
#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.
require File.expand_path('../test_helper', __dir__)
# Estimate and invoice PDFs: users with a billing permission open any of them; other logged-in users only the
# documents attached to issues they can see; share-link customers only their own issue's documents
class DocumentPdfsTest < Redmine::IntegrationTest
include QboFakeServiceHelper
fixtures :projects, :users, :email_addresses, :members, :member_roles, :roles, :issues, :trackers,
:projects_trackers, :issue_statuses, :enabled_modules, :enumerations
def setup
local_customer
Estimate.where(id: [598, 599]).delete_all
Invoice.where(id: [601, 602]).delete_all
Estimate.create!(id: 598, doc_number: '1068', customer_id: 9101)
Estimate.create!(id: 599, doc_number: '1069', customer_id: 9101)
@invoice = Invoice.create!(id: 601, doc_number: '1234', customer_id: 9101, txn_date: Date.new(2026, 11, 12))
Invoice.create!(id: 602, doc_number: '1235', customer_id: 9101, txn_date: Date.new(2026, 11, 12))
issue = Issue.find(1)
issue.update_column(:estimate_id, 598)
issue.invoices = [@invoice]
CustomerToken.delete_all
@token = CustomerToken.create!(issue_id: 1, expires_at: 1.week.from_now)
@fake = install_fake_quickbooks
[qbo_estimate(id: 598, doc_number: '1068'), qbo_estimate(id: 599, doc_number: '1069'),
qbo_invoice(id: 601, doc_number: '1234'), qbo_invoice(id: 602, doc_number: '1235')].each { |d| @fake.add(d) }
@fake.pdf_body = CombinePDF.new.tap { |pdf| pdf << CombinePDF.create_page }.to_pdf
Role.find(1).remove_permission!(:view_customers, :write_estimates, :write_invoices, :view_payments,
:receive_payments, :issue_refunds)
end
def login(*permissions)
permissions.each { |p| Role.find(1).add_permission!(p) }
reset!
log_user('jsmith', 'jsmith')
end
def open_share_link
get "/customers/view/#{@token.token}"
assert_response :success
end
def test_billing_users_open_any_estimate
%i[view_customers write_estimates].each do |permission|
Role.find(1).remove_permission!(:view_customers, :write_estimates)
login(permission)
get '/estimates/599'
assert_response :success, permission
assert_equal 'application/pdf', response.media_type
assert_match 'estimate 1069.pdf', response.headers['Content-Disposition']
get '/estimates/doc', params: { search: '1069' }
assert_response :success, permission
end
end
def test_other_users_open_only_estimates_on_issues_they_can_see
login
get '/estimates/598'
assert_response :success
get '/estimates/doc', params: { search: '1068' }
assert_response :success
get '/estimates/599'
assert_response :forbidden
get '/estimates/doc', params: { search: '1069' }
assert_response :forbidden
end
def test_estimate_on_a_hidden_issue_is_refused
Issue.find(1).update_column(:estimate_id, nil)
Issue.find(4).update_column(:estimate_id, 598)
Project.find(2).update_column(:is_public, false)
Member.where(user_id: 2, project_id: 2).destroy_all
login
get '/estimates/598'
assert_response :forbidden
end
def test_only_billing_users_sync_missing_estimates
login
Estimate.expects(:sync_by_id).never
get '/estimates/777'
assert_response :forbidden
login(:view_customers)
Estimate.expects(:sync_by_id).with('777')
get '/estimates/777'
assert_response :redirect
assert_equal I18n.t(:notice_estimate_not_found), flash[:error]
end
def test_billing_users_open_any_invoice
%i[view_customers write_invoices view_payments receive_payments issue_refunds].each do |permission|
Role.find(1).remove_permission!(:view_customers, :write_invoices, :view_payments, :receive_payments, :issue_refunds)
login(permission)
get '/invoices/602'
assert_response :success, permission
get '/invoices/601', params: { invoice_ids: %w[601 602] }
assert_response :success, permission
end
end
def test_other_users_open_only_invoices_on_issues_they_can_see
login
get '/invoices/601'
assert_response :success
assert_match 'invoice 1234.pdf', response.headers['Content-Disposition']
get '/invoices/602'
assert_response :forbidden
get '/invoices/601', params: { invoice_ids: %w[601 602] }
assert_response :forbidden
end
def test_estimate_search_shows_only_to_billing_users
login
get '/projects/ecookbook/issues'
assert_select '#estimate-search-form', 0
login(:write_estimates)
get '/projects/ecookbook/issues'
assert_select '#estimate-search-form'
end
def test_anonymous_visitors_must_log_in
get '/estimates/598'
assert_redirected_to %r{/login}
get '/invoices/601'
assert_redirected_to %r{/login}
end
def test_share_link_customer_sees_only_their_estimate
open_share_link
get '/estimates/598'
assert_response :success
get '/estimates/doc', params: { search: '1068' }
assert_response :success
get '/estimates/599'
assert_response :forbidden
get '/estimates/doc', params: { search: '1069' }
assert_response :forbidden
end
def test_share_link_customer_sees_only_their_invoices
open_share_link
get '/invoices/601'
assert_response :success
assert_match 'invoice 1234.pdf', response.headers['Content-Disposition']
get '/invoices/602'
assert_response :forbidden
get '/invoices/601', params: { invoice_ids: %w[601 602] }
assert_response :forbidden
end
def test_expired_share_link_stops_working
open_share_link
@token.update_column(:expires_at, 1.minute.ago)
get '/invoices/601'
assert_redirected_to %r{/login}
end
def test_invoice_pdf_failure_redirects
login(:write_invoices)
get '/invoices/999'
assert_response :redirect
assert_equal I18n.t(:notice_invoice_not_found), flash[:error]
end
def test_syncs_are_admin_only
login
get '/estimates/sync'
assert_response :forbidden
get '/invoices/sync'
assert_response :forbidden
reset!
log_user('admin', 'admin')
Estimate.expects(:sync)
Invoice.expects(:sync)
get '/estimates/sync'
get '/invoices/sync'
end
end
+164
View File
@@ -0,0 +1,164 @@
#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.
require File.expand_path('../test_helper', __dir__)
# Items, accounts and employee syncs (admin), and the business report
class QboAdminPagesTest < Redmine::IntegrationTest
include QboFakeServiceHelper
fixtures :projects, :users, :email_addresses, :members, :member_roles, :roles, :issues, :trackers,
:projects_trackers, :issue_statuses, :enabled_modules, :enumerations, :workflows
def setup
Item.where(id: [9701, 9702]).delete_all
Account.where(id: [9801, 9802]).delete_all
@fake = install_fake_quickbooks
end
def item(id, name, attrs = {})
Item.new({ id: id, name: name, description: '', unit_price: 10, active: true, type: 'Service' }.merge(attrs))
.tap { |i| i.skip_qbo_push = true }.tap(&:save!)
end
def admin
reset!
log_user('admin', 'admin')
end
def jsmith
reset!
log_user('jsmith', 'jsmith')
end
def test_items_are_admin_only
item(9701, 'Labor')
jsmith
%w[/items /items/new /items/9701 /items/9701/edit /items/sync /accounts /accounts/sync /employees/sync].each do |path|
get path
assert_response :forbidden, path
end
post '/items', params: { item: { name: 'Sneaky' } }
assert_response :forbidden
end
def test_item_pages
item(9701, 'Labor')
admin
get '/items'
assert_response :success
assert_select 'body', text: /Labor/
get '/items/9701'
assert_response :success
get '/items/9701/edit'
assert_response :success
get '/items/424242'
assert_response :not_found
end
def test_create_item_in_quickbooks
admin
post '/items', params: { item: { name: 'Brake Pads', description: 'Front pads', unit_price: '45', type: 'NonInventory', taxable: '1' } }
created = @fake.created.last
assert_equal 'Brake Pads', created.name
assert_redirected_to "/items/#{created.id}"
assert Item.exists?(created.id.to_i)
end
def test_duplicate_name_opens_the_existing_item
admin
@fake.define_singleton_method(:create) do |_doc|
raise Quickbooks::IntuitRequestException, "Duplicate Name Exists Error:\nThe name supplied already exists. : Id=9702"
end
post '/items', params: { item: { name: 'Labor', description: '', unit_price: '1' } }
assert_redirected_to '/items/9702'
end
def test_update_and_destroy_item
item(9701, 'Labor')
admin
patch '/items/9701', params: { item: { name: 'Shop Labor', unit_price: '125' } }
assert_redirected_to '/items/9701'
assert_equal 'Shop Labor', Item.find(9701).name
assert_equal 'Shop Labor', @fake.updated.last.name
patch '/items/9701', params: { item: { unit_price: '-1' } }
assert_response :unprocessable_entity
delete '/items/9701'
assert_redirected_to '/items'
assert_not Item.exists?(9701)
assert_equal false, @fake.updated.last.active?
end
def test_item_autocomplete_lists_sellable_items
item(9701, 'Labor', description: 'Shop labor')
item(9702, 'Labor old', active: false)
admin
get '/items/autocomplete', params: { q: 'lab' }
assert_equal [9701], JSON.parse(response.body).map { |i| i['id'] }
end
def test_accounts
Account.create!(id: 9801, name: 'Sales', classification: 'Revenue')
Account.create!(id: 9802, name: 'Rent', classification: 'Expense')
admin
get '/accounts'
assert_response :success
assert_select 'body', text: /Sales/
patch '/accounts/set_default', params: { default_account_id: 9801 }
assert_redirected_to '/accounts'
assert Account.find(9801).default
patch '/accounts/set_default', params: { default_account_id: 424_242 }
assert_equal I18n.t(:error_default_account_not_selected), flash[:error]
end
def test_admin_syncs
admin
Item.expects(:sync)
Account.expects(:sync)
Employee.expects(:sync)
Payment.expects(:sync)
%w[/items/sync /accounts/sync /employees/sync /qbo_payments/sync].each do |path|
get path
assert_response :redirect, path
end
end
def test_plugin_settings_page
RedmineQboBilling::Company.stubs(:settings).returns(custom_fields: [{ id: 1, name: 'Sales Rep' }, { id: 2, name: 'VIN' }])
QboSyncStatus.queued('Invoice')
admin
get '/settings/plugin/redmine_qbo'
assert_response :success
assert_match "grantUrl: '/qbo/authenticate'", response.body
assert_select 'body', text: /VIN/
end
# ---- business report ----
def test_report_needs_the_permission
Role.find(1).remove_permission!(:view_business_reports)
jsmith
get '/qbo_reports'
assert_response :forbidden
end
def test_report_remembers_projects
Role.find(1).add_permission!(:view_business_reports)
jsmith
get '/qbo_reports', params: { period: 'last_month' }
assert_response :success
get '/qbo_reports', params: { project_ids: ['1', '999'], save_projects: '1' }
assert_response :success
assert_equal [1], User.find(2).pref[:qbo_report_project_ids]
get '/qbo_reports'
assert_response :success
end
end
+182
View File
@@ -0,0 +1,182 @@
#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.
require File.expand_path('../test_helper', __dir__)
# Connecting to QuickBooks, manual syncs and billing, and Intuit's webhook
class QboControllerTest < Redmine::IntegrationTest
fixtures :projects, :users, :email_addresses, :members, :member_roles, :roles, :issues, :trackers,
:projects_trackers, :issue_statuses, :enabled_modules, :enumerations, :workflows
SECRET = 'webhook-secret'.freeze
def setup
Qbo.delete_all
Customer.where(id: 9101).delete_all
end
# Redmine keeps plugin settings with indifferent access (RedmineQbo.settings reads symbol keys)
def settings(token)
{ 'webhook_token' => token }.with_indifferent_access
end
def signed(body, secret = SECRET)
Base64.strict_encode64(OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), secret, body))
end
def post_webhook(body, signature)
post '/qbo/webhook', params: body, headers: { 'CONTENT_TYPE' => 'application/json', 'intuit-signature' => signature }
end
# ---- webhook ----
def test_webhook_with_a_valid_signature_queues_the_job
body = '{"eventNotifications":[]}'
WebhookProcessJob.expects(:perform_later).with(body)
with_settings plugin_redmine_qbo: settings(SECRET) do
post_webhook(body, signed(body))
end
assert_response :ok
end
def test_webhook_refuses_bad_or_missing_signatures
body = '{"eventNotifications":[]}'
WebhookProcessJob.expects(:perform_later).never
with_settings plugin_redmine_qbo: settings(SECRET) do
post_webhook(body, signed(body, 'wrong'))
assert_response :unauthorized
post_webhook(body, '')
assert_response :unauthorized
end
with_settings plugin_redmine_qbo: settings('') do
post_webhook(body, signed(body, ''))
assert_response :unauthorized
end
end
def test_webhook_needs_no_login
body = '{}'
WebhookProcessJob.stubs(:perform_later)
with_settings login_required: '1', plugin_redmine_qbo: settings(SECRET) do
post_webhook(body, signed(body))
end
assert_response :ok
end
# ---- admin pages ----
def test_connecting_and_syncing_are_admin_only
log_user('jsmith', 'jsmith')
get '/qbo/authenticate'
assert_response :forbidden
get '/qbo/sync'
assert_response :forbidden
get '/qbo/oauth_callback', params: { code: 'x', state: 'y', realmId: '1' }
assert_response :forbidden
end
def test_authenticate_redirects_to_intuit_with_a_state
log_user('admin', 'admin')
QboOauthService.expects(:authorization_url).with { |args| args[:state].present? && args[:callback_url].end_with?('/qbo/oauth_callback') }
.returns('https://appcenter.intuit.com/connect/oauth2?x=1')
get '/qbo/authenticate'
assert_redirected_to 'https://appcenter.intuit.com/connect/oauth2?x=1'
end
def test_oauth_callback_checks_the_state
log_user('admin', 'admin')
QboOauthService.expects(:exchange!).never
get '/qbo/oauth_callback', params: { code: 'abc', state: 'forged', realmId: '123' }
assert_redirected_to '/settings/plugin/redmine_qbo'
assert_equal I18n.t(:notice_qbo_oauth_state_mismatch), flash[:error]
end
def test_oauth_callback_connects
log_user('admin', 'admin')
state = nil
QboOauthService.stubs(:authorization_url).with { |args| state = args[:state] }.returns('https://intuit.example/')
get '/qbo/authenticate'
QboOauthService.expects(:exchange!).with(code: 'abc', callback_url: anything, realm_id: '123')
get '/qbo/oauth_callback', params: { code: 'abc', state: state, realmId: '123' }
assert_redirected_to '/qbo/sync'
assert_equal I18n.t(:label_connected), flash[:notice]
# The state is used once
get '/qbo/oauth_callback', params: { code: 'abc', state: state, realmId: '123' }
assert_equal I18n.t(:notice_qbo_oauth_state_mismatch), flash[:error]
end
def test_oauth_failure_is_reported
log_user('admin', 'admin')
state = nil
QboOauthService.stubs(:authorization_url).with { |args| state = args[:state] }.returns('https://intuit.example/')
get '/qbo/authenticate'
QboOauthService.stubs(:exchange!).raises(OAuth2::Error.new(Struct.new(:parsed, :body, :status).new({}, 'bad', 400)))
get '/qbo/oauth_callback', params: { code: 'abc', state: state, realmId: '123' }
assert_redirected_to '/settings/plugin/redmine_qbo'
assert_equal I18n.t(:label_error), flash[:error]
end
def test_sync
log_user('admin', 'admin')
QboSyncDispatcher.expects(:sync!).with(full_sync: true)
get '/qbo/sync', params: { full_sync: 'true' }
assert_response :redirect
assert_equal I18n.t(:label_syncing), flash[:notice]
end
# ---- billing ----
def billable_issue
customer = Customer.new(id: 9101, name: 'Jane Customer')
customer.skip_qbo_push = true
customer.save!
User.find(3).update_column(:employee_id, 31)
Issue.find(1).tap { |i| i.update_columns(customer_id: 9101, assigned_to_id: 3) }
end
def test_bill_needs_the_permission
billable_issue
log_user('jsmith', 'jsmith')
Role.find(1).remove_permission!(:bill_issues)
post '/bill/1'
assert_response :forbidden
post '/bill/99999'
assert_response :not_found
end
def test_bill_queues_the_job
issue = billable_issue
Qbo.new(realm_id: '1').save!(validate: false)
Role.find(1).add_permission!(:bill_issues)
log_user('jsmith', 'jsmith')
BillIssueTimeJob.expects(:perform_later).with(issue.id)
post "/bill/#{issue.id}"
assert_redirected_to "/issues/#{issue.id}"
assert_match 'Jane Customer', flash[:notice]
end
def test_bill_explains_what_is_missing
Role.find(1).add_permission!(:bill_issues)
log_user('jsmith', 'jsmith')
BillIssueTimeJob.expects(:perform_later).never
Issue.find(1).update_columns(customer_id: nil)
post '/bill/1'
assert_equal I18n.t(:notice_billing_error_no_customer), flash[:error]
billable_issue
post '/bill/1'
assert_equal I18n.t(:notice_billing_error_no_qbo), flash[:error]
User.find(3).update_column(:employee_id, nil)
post '/bill/1'
assert_equal I18n.t(:notice_billing_error_no_employee), flash[:error]
end
end
@@ -0,0 +1,250 @@
#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.
require File.expand_path('../test_helper', __dir__)
class QboEstimatesControllerTest < Redmine::IntegrationTest
include QboEditorTestHelper
def estimate_params(extra = {})
{ customer_id: '9101', txn_date: '2026-11-20', email: 'jane@example.com', lines: line_params }.merge(extra)
end
def test_editor_needs_write_estimates
login_with(:view_customers)
get '/qbo_estimates/new'
assert_response :forbidden
post '/qbo_estimates', params: { estimate: estimate_params }
assert_response :forbidden
assert_empty @fake.created
end
def test_new_estimate
login_with(:write_estimates)
get '/qbo_estimates/new', params: { customer_id: 9101 }
assert_response :success
assert_select 'input[name=?][value=?]', 'estimate[customer_id]', '9101'
end
def test_create
login_with(:write_estimates)
post '/qbo_estimates', params: { estimate: estimate_params }
saved = @fake.created.first
assert saved
assert_redirected_to "/qbo_estimates/#{saved.id}/edit"
assert_equal BigDecimal('240'), saved.line_items.first.amount
end
def test_invalid_form_is_shown_again
login_with(:write_estimates)
post '/qbo_estimates', params: { estimate: estimate_params(customer_id: '', lines: {}) }
assert_response :unprocessable_entity
assert_select '#errorExplanation', text: /#{Regexp.escape(I18n.t(:error_estimate_needs_customer))}/
assert_empty @fake.created
end
def test_save_and_send_needs_send_estimates
login_with(:write_estimates)
post '/qbo_estimates', params: { estimate: estimate_params, save_and_send: '1' }
assert_response :forbidden
login_with(:send_estimates)
post '/qbo_estimates', params: { estimate: estimate_params, save_and_send: '1' }
assert_equal [[@fake.created.first.id, 'jane@example.com']], @fake.sent
end
def test_quickbooks_error_is_shown
login_with(:write_estimates)
@fake.define_singleton_method(:create) { |_doc| raise Quickbooks::IntuitRequestException, 'Business Validation Error' }
post '/qbo_estimates', params: { estimate: estimate_params }
assert_response :unprocessable_entity
assert_select '#errorExplanation', text: /Business Validation Error/
end
def test_edit_and_update
login_with(:write_estimates)
@fake.add(estimate_doc)
get '/qbo_estimates/598/edit'
assert_response :success
assert_select 'fieldset.qbo-estimate-sheet[disabled]', 0
patch '/qbo_estimates/598', params: { estimate: estimate_params(sync_token: '3', lines: line_params(rate: '150')) }
assert_redirected_to '/qbo_estimates/598/edit'
assert_equal BigDecimal('300'), @fake.updated.first.line_items.first.amount
end
def test_stale_update_is_a_conflict
login_with(:write_estimates)
@fake.add(estimate_doc)
patch '/qbo_estimates/598', params: { estimate: estimate_params(sync_token: '1') }
assert_response :unprocessable_entity
assert_select '#errorExplanation', text: /#{Regexp.escape(I18n.t(:error_estimate_changed_in_quickbooks))}/
end
def test_missing_estimate_redirects
login_with(:write_estimates)
get '/qbo_estimates/999/edit'
assert_response :redirect
assert_equal I18n.t(:notice_estimate_not_found), flash[:error]
end
# ---- estimates linked to an issue ----
def test_linked_estimate_is_read_only_without_the_permission
login_with(:write_estimates)
@fake.add(estimate_doc)
Issue.find(1).update_column(:estimate_id, 598)
get '/qbo_estimates/598/edit'
assert_select 'fieldset.qbo-estimate-sheet[disabled]'
assert_select '#qbo-unlock-estimate', 0
# Asking to unlock without the permission changes nothing
get '/qbo_estimates/598/edit', params: { unlock: 1 }
assert_select 'fieldset.qbo-estimate-sheet[disabled]'
patch '/qbo_estimates/598', params: { estimate: estimate_params(sync_token: '3'), unlock: '1' }
assert_response :unprocessable_entity
assert_empty @fake.updated
end
def test_unlock_a_linked_estimate
login_with(:write_estimates, :edit_linked_estimates)
@fake.add(estimate_doc)
Issue.find(1).update_column(:estimate_id, 598)
get '/qbo_estimates/598/edit'
assert_select 'a#qbo-unlock-estimate[href=?][data-confirm=?]', '/qbo_estimates/598/edit?unlock=1',
I18n.t(:text_unlock_estimate_confirmation)
get '/qbo_estimates/598/edit', params: { unlock: 1 }
assert_select 'fieldset.qbo-estimate-sheet[disabled]', 0
assert_select 'input[type=hidden][name=unlock][value="1"]'
assert_select '.qbo-estimate-notice', text: /#{Regexp.escape(I18n.t(:text_estimate_unlocked))}/
patch '/qbo_estimates/598', params: { estimate: estimate_params(sync_token: '3', lines: line_params(rate: '150')), unlock: '1' }
assert_redirected_to '/qbo_estimates/598/edit'
assert_equal BigDecimal('300'), @fake.updated.first.line_items.first.amount
assert_equal 598, Issue.find(1).estimate_id
end
def test_billed_estimate_cannot_be_unlocked
login_with(:write_estimates, :edit_linked_estimates)
@fake.add(estimate_doc(status: 'Closed'))
Issue.find(1).update_column(:estimate_id, 598)
get '/qbo_estimates/598/edit', params: { unlock: 1 }
assert_select 'fieldset.qbo-estimate-sheet[disabled]'
patch '/qbo_estimates/598', params: { estimate: estimate_params(sync_token: '3'), unlock: '1' }
assert_response :unprocessable_entity
assert_empty @fake.updated
end
# ---- duplicates, drafts, emails ----
def test_duplicate
login_with(:write_estimates)
@fake.add(estimate_doc)
get '/qbo_estimates/new', params: { duplicate: 598 }
assert_response :success
assert_select '.flash.notice', text: /1068/
end
def test_drafts
login_with(:write_estimates)
post '/qbo_estimates', params: { estimate: estimate_params(customer_id: '9101', lines: line_params), save_draft: '1' }
draft = QboDraft.last
assert_redirected_to "/qbo_estimates/new?draft_id=#{draft.id}"
assert_equal [9101, 2], [draft.customer_id, draft.user_id]
get "/qbo_estimates/new?draft_id=#{draft.id}"
assert_response :success
# Saving to QuickBooks deletes the draft
post '/qbo_estimates', params: { estimate: estimate_params, draft_id: draft.id }
assert_not QboDraft.exists?(draft.id)
get '/qbo_estimates/new', params: { draft_id: draft.id }
assert_redirected_to '/qbo_drafts'
end
def test_send_email
login_with(:write_estimates)
@fake.add(estimate_doc)
post '/qbo_estimates/598/send_email', params: { email: 'jane@example.com' }
assert_response :forbidden
login_with(:send_estimates)
post '/qbo_estimates/598/send_email', params: { email: 'jane@example.com' }
assert_redirected_to '/qbo_estimates/598/edit'
assert_equal [%w[598 jane@example.com]], @fake.sent
end
# ---- editor lookups ----
def test_customer_info
login_with(:write_estimates)
get '/qbo_estimates/customer_info', params: { customer_id: 9101 }
assert_equal 'Jane Customer', JSON.parse(response.body)['name']
get '/qbo_estimates/customer_info', params: { customer_id: 424_242 }
assert_response :not_found
get '/qbo_estimates/customer_info', params: { customer_id: 9101, document: 'invoice' }
assert JSON.parse(response.body).key?('open_issues_html')
end
def test_items_search
Item.where(id: [9701, 9702]).delete_all
[[9701, 'Labor', true], [9702, 'Lab coat', false]].each do |id, name, active|
Item.new(id: id, name: name, description: '', unit_price: 120, active: active, type: 'Service')
.tap { |i| i.skip_qbo_push = true }.save!
end
login_with(:write_invoices)
get '/qbo_estimates/items', params: { q: 'lab' }
assert_equal [9701], JSON.parse(response.body).map { |i| i['id'] }
end
def test_refresh_company_is_admin_only
login_with(:write_estimates)
post '/qbo_estimates/refresh_company'
assert_response :forbidden
reset!
log_user('admin', 'admin')
RedmineQboBilling::Company.expects(:refresh!)
post '/qbo_estimates/refresh_company'
assert_response :redirect
end
# ---- issues from an estimate ----
def test_issues_from_an_estimate
Estimate.where(id: 598).delete_all
Estimate.create!(id: 598, doc_number: '1068', customer_id: 9101)
Estimate.any_instance.stubs(:line_items).returns([qbo_sales_line(2, 10, 'Labor', 2, 120, description: 'Install lift kit')])
Setting.stubs(:plugin_redmine_qbo).returns('issue_default_project_id' => '1')
@fake.add(estimate_doc)
login_with(:write_estimates)
get '/qbo_estimates/598/issues_preview'
assert_response :forbidden
login_with(:create_estimate_issues, :add_issues)
get '/qbo_estimates/598/issues_preview'
assert_response :success
post '/qbo_estimates/598/create_issues', params: { project_id: 1, lines: { '2' => { selected: '1', tracker_id: '1' } } }
assert_redirected_to '/qbo_estimates/598/edit'
issue = Issue.where(estimate_id: 598).last
assert_equal 'Install Lift Kit', issue.subject
# The work is going ahead: the estimate is accepted
assert_equal 'Accepted', @fake.updated.last.txn_status
end
def test_create_issues_with_nothing_selected
Estimate.where(id: 598).delete_all
Estimate.create!(id: 598, doc_number: '1068', customer_id: 9101)
Estimate.any_instance.stubs(:line_items).returns([qbo_sales_line(2, 10, 'Labor', 2, 120, description: 'Install')])
login_with(:create_estimate_issues, :add_issues)
post '/qbo_estimates/598/create_issues', params: { project_id: 1, lines: {} }
assert_response :unprocessable_entity
end
end
@@ -0,0 +1,137 @@
#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.
require File.expand_path('../test_helper', __dir__)
class QboInvoicesControllerTest < Redmine::IntegrationTest
include QboEditorTestHelper
def invoice_params(extra = {})
{ customer_id: '9101', txn_date: '2026-11-20', email: 'jane@example.com', lines: line_params }.merge(extra)
end
def test_editor_needs_write_invoices
login_with(:write_estimates)
get '/qbo_invoices/new'
assert_response :forbidden
post '/qbo_invoices', params: { estimate: invoice_params }
assert_response :forbidden
end
def test_new_and_create
login_with(:write_invoices)
get '/qbo_invoices/new', params: { customer_id: 9101 }
assert_response :success
post '/qbo_invoices', params: { estimate: invoice_params }
saved = @fake.created.first
assert_redirected_to "/qbo_invoices/#{saved.id}/edit"
assert_kind_of Quickbooks::Model::Invoice, saved
end
def test_new_from_an_estimate
login_with(:write_invoices)
@fake.add(estimate_doc)
get '/qbo_invoices/new', params: { estimate_id: 598 }
assert_response :success
assert_select 'input[name=?][value=?]', 'estimate[linked_estimate_ids][]', '598'
post '/qbo_invoices', params: { estimate: invoice_params(linked_estimate_ids: ['598']) }
assert_equal 'Closed', @fake.records['598'].txn_status
end
def test_new_from_a_billed_estimate_explains_why
login_with(:write_invoices)
@fake.add(estimate_doc(status: 'Closed'))
get '/qbo_invoices/new', params: { estimate_id: 598 }
assert_not_equal 500, response.status
assert_equal I18n.t(:error_estimate_closed_billed, number: '1068', status: 'Closed'), flash[:error]
end
def test_save_and_send_needs_send_invoices
login_with(:write_invoices)
post '/qbo_invoices', params: { estimate: invoice_params, save_and_send: '1' }
assert_response :forbidden
login_with(:send_invoices)
post '/qbo_invoices', params: { estimate: invoice_params, save_and_send: '1' }
assert_equal 1, @fake.sent.size
end
def test_edit_and_update
login_with(:write_invoices)
@fake.add(invoice_doc)
get '/qbo_invoices/601/edit'
assert_response :success
patch '/qbo_invoices/601', params: { estimate: invoice_params(sync_token: '3', lines: line_params(rate: '150')) }
assert_redirected_to '/qbo_invoices/601/edit'
assert_equal BigDecimal('300'), @fake.updated.first.line_items.first.amount
end
def test_paid_invoice_is_locked
login_with(:write_invoices)
@fake.add(invoice_doc(balance: '0'))
get '/qbo_invoices/601/edit'
assert_select 'fieldset.qbo-estimate-sheet[disabled]'
assert_select '#qbo-unlock-invoice', 0
patch '/qbo_invoices/601', params: { estimate: invoice_params(sync_token: '3'), unlock: '1' }
assert_response :unprocessable_entity
assert_empty @fake.updated
end
def test_unlock_a_paid_invoice
login_with(:write_invoices, :edit_paid_invoices)
@fake.add(invoice_doc(balance: '0'))
get '/qbo_invoices/601/edit'
assert_select 'a#qbo-unlock-invoice[href=?]', '/qbo_invoices/601/edit?unlock=1'
get '/qbo_invoices/601/edit', params: { unlock: 1 }
assert_select 'fieldset.qbo-estimate-sheet[disabled]', 0
patch '/qbo_invoices/601', params: { estimate: invoice_params(sync_token: '3', balance: '0'), unlock: '1' }
assert_redirected_to '/qbo_invoices/601/edit'
end
def test_partly_paid_invoice_needs_its_own_permission
login_with(:write_invoices, :edit_paid_invoices)
@fake.add(invoice_doc(balance: '100'))
get '/qbo_invoices/601/edit'
assert_select '#qbo-unlock-invoice', 0
login_with(:edit_partially_paid_invoices)
get '/qbo_invoices/601/edit'
assert_select '#qbo-unlock-invoice'
end
def test_import_options
login_with(:write_invoices)
@fake.query_results = { 'FROM Estimate' => [estimate_doc] }
get '/qbo_invoices/import_options', params: { customer_id: 9101 }
assert_response :success
data = JSON.parse(response.body)
assert_equal ['598'], data['estimates'].map { |e| e['id'] }
get '/qbo_invoices/import_options', params: { customer_id: 424_242 }
assert_response :not_found
end
def test_send_email
login_with(:write_invoices, :send_invoices)
@fake.add(invoice_doc)
post '/qbo_invoices/601/send_email', params: { email: 'jane@example.com' }
assert_redirected_to '/qbo_invoices/601/edit'
assert_equal [%w[601 jane@example.com]], @fake.sent
end
def test_drafts
login_with(:write_invoices)
post '/qbo_invoices', params: { estimate: invoice_params(sales_person: 'Ricky'), save_draft: '1' }
draft = QboDraft.last
assert draft.invoice?
assert_equal 'Ricky', draft.fields['sales_person']
assert_redirected_to "/qbo_invoices/new?draft_id=#{draft.id}"
get "/qbo_invoices/new?draft_id=#{draft.id}"
assert_response :success
end
end
@@ -0,0 +1,129 @@
#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.
require File.expand_path('../test_helper', __dir__)
class QboPaymentsAndDraftsControllerTest < Redmine::IntegrationTest
include QboEditorTestHelper
def setup
Invoice.where(id: 601).delete_all
@fake.query_results = { 'FROM Invoice' => [invoice_doc(balance: '240')], 'PaymentMethod' => [
Quickbooks::Model::PaymentMethod.new(id: 2, name: 'Check', active: true)
] }
end
def payment_params(extra = {})
{ customer_id: '9101', txn_date: '2026-11-20', payment_method_id: '2', amount: '100' }.merge(extra)
end
def saved_payment
doc = Quickbooks::Model::Payment.new(customer_ref: qbo_ref(9101, 'Jane Customer'), txn_date: Date.new(2026, 11, 20),
total: BigDecimal('100'), payment_method_ref: qbo_ref(2, 'Check'))
doc.id = '801'
doc.sync_token = 1
doc.line_items = [Quickbooks::Model::Line.new.tap { |l| l.amount = BigDecimal('100'); l.invoice_id = '601' }]
@fake.add(doc)
end
def test_receiving_needs_receive_payments
login_with(:view_payments)
get '/qbo_payments/new'
assert_response :forbidden
post '/qbo_payments', params: { payment: payment_params }
assert_response :forbidden
get '/qbo_payments', params: { customer_id: 9101 }
assert_response :success
end
def test_receive_a_payment
login_with(:receive_payments)
get '/qbo_payments/new', params: { customer_id: 9101 }
assert_response :success
post '/qbo_payments', params: { payment: payment_params }
payment = @fake.created.first
assert_redirected_to "/qbo_payments/#{payment.id}"
assert_equal BigDecimal('100'), payment.line_items.first.amount
end
def test_invalid_payment
login_with(:receive_payments)
post '/qbo_payments', params: { payment: payment_params(amount: '0') }
assert_response :unprocessable_entity
assert_empty @fake.created
end
def test_show_edit_update_pdf
login_with(:receive_payments)
saved_payment
get '/qbo_payments/801'
assert_response :success
get '/qbo_payments/801/edit'
assert_response :success
patch '/qbo_payments/801', params: { payment: payment_params(sync_token: '1', invoice_ids: ['601'], memo: 'Edited') }
assert_redirected_to '/qbo_payments/801'
assert_equal 'Edited', @fake.updated.first.private_note
@fake.pdf_body = '%PDF-1.4'
get '/qbo_payments/801/pdf'
assert_equal 'application/pdf', response.media_type
end
def test_stale_payment_update
login_with(:receive_payments)
saved_payment
patch '/qbo_payments/801', params: { payment: payment_params(sync_token: '0') }
assert_response :unprocessable_entity
end
def test_missing_payment
login_with(:view_payments)
get '/qbo_payments/999'
assert_response :redirect
assert_equal I18n.t(:notice_payment_not_found), flash[:error]
end
def test_open_invoices
login_with(:receive_payments)
get '/qbo_payments/open_invoices', params: { customer_id: 9101 }
assert_equal ['601'], JSON.parse(response.body).map { |i| i['id'] }
get '/qbo_payments/open_invoices', params: { customer_id: 424_242 }
assert_response :not_found
end
def test_payment_sync_is_admin_only
login_with(:receive_payments)
get '/qbo_payments/sync'
assert_response :forbidden
end
# ---- drafts ----
def test_drafts_by_permission
estimate = QboDraft.create!(document: 'estimate', fields: { 'customer_name' => 'Est Draft' })
invoice = QboDraft.create!(document: 'invoice', fields: { 'customer_name' => 'Inv Draft' })
login_with(:view_customers)
get '/qbo_drafts'
assert_response :forbidden
login_with(:write_estimates)
get '/qbo_drafts'
assert_response :success
assert_select 'body', text: /Est Draft/
assert_select 'body', text: /Inv Draft/, count: 0
# Not allowed to delete an invoice draft
delete "/qbo_drafts/#{invoice.id}"
assert QboDraft.exists?(invoice.id)
assert_equal I18n.t(:error_qbo_draft_not_found), flash[:error]
delete "/qbo_drafts/#{estimate.id}"
assert_not QboDraft.exists?(estimate.id)
end
end
+224
View File
@@ -0,0 +1,224 @@
#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.
require File.expand_path('../test_helper', __dir__)
# What the plugin adds to Redmine's own pages: the issue's customer, estimate and invoices, the issue form, the
# issue list's Customer column and filter, spent time's Billed column, the issue history, the user form's
# employee, the bill and share links, the issue PDF, and the activity page
class RedminePagesTest < Redmine::IntegrationTest
include QboFakeServiceHelper
fixtures :projects, :users, :email_addresses, :members, :member_roles, :roles, :issues, :trackers,
:projects_trackers, :issue_statuses, :enabled_modules, :enumerations, :workflows, :journals,
:journal_details, :time_entries, :queries
def setup
@customer = local_customer(9101, 'Jane Customer')
local_customer(9102, 'Bob Builder')
Estimate.where(id: 598).delete_all
Invoice.where(id: 601).delete_all
@estimate = Estimate.create!(id: 598, doc_number: '1068', customer_id: 9101)
@invoice = Invoice.create!(id: 601, doc_number: '1234', customer_id: 9101, txn_date: Date.new(2026, 11, 12))
@issue = Issue.find(1)
@issue.update_columns(customer_id: 9101, estimate_id: 598)
@issue.invoices = [@invoice]
@fake = install_fake_quickbooks
Role.find(1).remove_permission!(:view_customers, :bill_issues, :share_issues_with_customers, :write_estimates)
end
def login(*permissions)
permissions.each { |p| Role.find(1).add_permission!(p) }
reset!
log_user('jsmith', 'jsmith')
end
# ---- issue page ----
def test_issue_shows_customer_estimate_and_invoices
login
get '/issues/1'
assert_response :success
assert_select '.customer_id .value a[href=?]', '/customers/9101', text: 'Jane Customer'
assert_select '.estimate_id .value a[href=?]', '/estimates/598', text: '1068'
assert_select '.invoice_id .value a[href=?]', '/invoices/601', text: '1234'
end
def test_estimate_actions_need_write_estimates
login
get '/issues/1'
assert_select '.qbo-estimate-edit-link', 0
login(:write_estimates)
get '/issues/1'
assert_select 'a.qbo-estimate-edit-link[href=?]', '/qbo_estimates/598/edit'
end
def test_bill_and_share_links_follow_permissions
login
get '/issues/1'
assert_select 'a[href=?]', '/bill/1', 0
assert_select 'a[href=?]', '/customers/share/1', 0
login(:bill_issues, :share_issues_with_customers)
get '/issues/1'
assert_select 'a[href=?][data-method=post]', '/bill/1'
assert_select 'a[href=?]', '/customers/share/1'
end
def test_issue_form_has_the_customer_and_their_estimates
login
get '/issues/1/edit'
assert_response :success
assert_select 'input.customer-name[data-autocomplete-url=?]', '/customers/autocomplete'
assert_select 'input#customer_id[type=hidden][value=?]', '9101'
assert_select 'select[name=?] option[value=?][selected]', 'issue[estimate_id]', '598'
end
def test_setting_the_customer_on_an_issue
login
patch '/issues/2', params: { issue: { customer_id: '9102' } }
assert_redirected_to '/issues/2'
assert_equal 9102, Issue.find(2).customer_id
end
# ---- issue history ----
def test_history_names_the_customer_and_estimate
journal = Journal.create!(journalized: @issue, user: User.find(2), notes: '')
JournalDetail.create!(journal: journal, property: 'attr', prop_key: 'customer_id', old_value: '9102', value: '9101')
JournalDetail.create!(journal: journal, property: 'attr', prop_key: 'estimate_id', old_value: '777', value: '598')
JournalDetail.create!(journal: journal, property: 'invoice', prop_key: '601', value: '1234')
login
get '/issues/1'
assert_select '.journal ul.journal-details li', text: /Bob Builder.*Jane Customer/
# An estimate that's gone shows its id
assert_select '.journal ul.journal-details li', text: /777.*1068/
assert_select '.journal ul.journal-details li a[href$=?]', '/invoices/601', text: '1234'
end
def test_invoice_history_without_the_invoice
journal = Journal.create!(journalized: @issue, user: User.anonymous, notes: '')
JournalDetail.create!(journal: journal, property: 'invoice', prop_key: '999', value: '9999')
login
get '/issues/1'
assert_select '.journal ul.journal-details li i', text: '9999'
end
def test_subjects_are_title_cased
@issue.update!(subject: 'install LED light bar on JL')
assert_equal 'Install LED Light Bar On JL', @issue.reload.subject
end
# ---- closing an issue bills it ----
def test_closing_a_billable_issue_queues_billing
User.find(3).update_column(:employee_id, 31)
@issue.update_columns(assigned_to_id: 3)
BillIssueTimeJob.expects(:perform_later).with(1)
@issue.reload.update!(status: IssueStatus.where(is_closed: true).first)
end
def test_closing_without_an_employee_does_not_bill
User.find(3).update_column(:employee_id, nil)
@issue.update_columns(assigned_to_id: 3)
BillIssueTimeJob.expects(:perform_later).never
@issue.reload.update!(status: IssueStatus.where(is_closed: true).first)
end
# ---- issue list ----
def test_customer_column_links_for_view_customers
login
get '/projects/ecookbook/issues', params: { set_filter: 1, c: %w[subject customer] }
assert_response :success
assert_select 'td.customer', text: 'Jane Customer'
assert_select 'td.customer a', 0
login(:view_customers)
get '/projects/ecookbook/issues', params: { set_filter: 1, c: %w[subject customer] }
assert_select 'td.customer a[href=?]', '/customers/9101'
end
def test_customer_name_filter
login
get '/projects/ecookbook/issues', params: { set_filter: 1, f: ['customer_name'], op: { customer_name: '~' },
v: { customer_name: ['jane'] }, c: %w[subject] }
assert_response :success
assert_select 'tr#issue-1'
assert_select 'tr#issue-2', 0
get '/projects/ecookbook/issues', params: { set_filter: 1, f: ['customer_name'], op: { customer_name: '!~' },
v: { customer_name: ['jane'] }, c: %w[subject] }
assert_select 'tr#issue-1', 0
end
def test_customer_name_filter_sql_is_escaped
query = IssueQuery.new(name: '_')
sql = query.sql_for_customer_name_field('customer_name', '~', ["x' OR 1=1 --"])
assert_match "LIKE '%x'' OR 1=1 --%'", sql.gsub('\\\'', "''")
assert_nil query.sql_for_customer_name_field('customer_name', '=', ['x'])
end
def test_billed_column_and_filter_on_spent_time
TimeEntry.where(id: 1).update_all(billed: true)
login
get '/projects/ecookbook/time_entries', params: { set_filter: 1, f: ['billed'], op: { billed: '=' }, v: { billed: ['1'] },
c: %w[hours billed] }
assert_response :success
assert_select 'tr#time-entry-1'
assert_select 'th', text: I18n.t(:field_billed)
end
# ---- users ----
def test_user_form_picks_the_employee
Employee.where(id: [31, 32]).delete_all
Employee.create!(id: 31, name: 'Tech One')
User.find(3).update_column(:employee_id, 31)
reset!
log_user('admin', 'admin')
get '/users/3/edit'
assert_select 'select[name=?] option[value="31"][selected]', 'user[employee_id]', text: 'Tech One'
patch '/users/3', params: { user: { employee_id: '' } }
assert_nil User.find(3).employee_id
end
# ---- issue PDF ----
def test_issue_pdf_includes_the_estimate
# Made by Redmine's own PDF writer, which adds optional content: merged like the issue's PDF
estimate_pdf = Redmine::Export::PDF::ITCPDF.new('en').tap { |p| p.add_page; p.write(5, 'ESTIMATE') }.output
PdfService.any_instance.expects(:fetch_pdf).with(doc_ids: [598]).returns([estimate_pdf, '1068'])
login
get '/issues/1.pdf'
assert_response :success
assert_equal 'application/pdf', response.media_type
assert_operator CombinePDF.parse(response.body).pages.size, :>=, 2
end
def test_issue_pdf_without_an_estimate
@issue.update_column(:estimate_id, nil)
PdfService.any_instance.expects(:fetch_pdf).never
login
get '/issues/1.pdf'
assert_response :success
end
# ---- activity ----
def test_activity_shows_quickbooks_documents_only_to_permitted_users
login
get '/activity'
assert_select 'input[name=show_qbo_estimates]', 0
login(:view_customers)
get '/activity'
assert_select 'input[name=show_qbo_estimates]'
# Never on a project's activity
get '/projects/ecookbook/activity'
assert_select 'input[name=show_qbo_estimates]', 0
end
end
+52
View File
@@ -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.
# Shared setup for the estimate, invoice and payment editor tests: jsmith with chosen billing permissions,
# QuickBooks replaced by QboFakeServiceHelper's fake
module QboEditorTestHelper
def self.included(base)
base.include QboFakeServiceHelper
base.fixtures :projects, :users, :email_addresses, :members, :member_roles, :roles, :issues, :trackers,
:projects_trackers, :issue_statuses, :enabled_modules, :enumerations, :workflows
base.setup do
@customer = local_customer
@fake = install_fake_quickbooks
stub_company
stub_local_syncs
Issue.where(estimate_id: [598, 599]).update_all(estimate_id: nil)
QboDraft.delete_all
Role.find(1).remove_permission!(*BILLING_PERMISSIONS)
end
end
BILLING_PERMISSIONS = %i[write_estimates send_estimates create_estimate_issues write_invoices send_invoices
edit_partially_paid_invoices edit_paid_invoices edit_linked_estimates view_payments
receive_payments view_customers].freeze
def login_with(*permissions)
permissions.each { |p| Role.find(1).add_permission!(p) }
reset!
log_user('jsmith', 'jsmith')
end
def estimate_doc(**options)
qbo_estimate(customer_name: 'Jane Customer', doc_number: '1068', status: 'Pending',
lines: [qbo_sales_line(2, 10, 'Labor', 2, 120, description: 'Install lift kit')], **options)
end
def invoice_doc(total: '240', balance: '240', **options)
qbo_invoice(customer_name: 'Jane Customer', doc_number: '1234', total: total, balance: balance,
lines: [qbo_sales_line(1, 10, 'Labor', 2, 120)], **options)
end
def line_params(rate: '120')
{ '0' => { item_id: '10', item_name: 'Labor', quantity: '2', rate: rate, taxable: '0', description: 'Install' } }
end
end
+222
View File
@@ -0,0 +1,222 @@
#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.
# Stands in for QuickBooks in the estimate, invoice and payment writer tests: one in-memory service answers
# QboEstimateService.with_service, QboInvoiceService.with_service and QboConnectionService.with_qbo_service.
module QboFakeServiceHelper
class FakeService
attr_reader :records, :created, :updated, :sent, :queries, :entities, :customers
# query_results: { "SQL fragment" or entity name => [records] }; fail_query: a regexp of queries to refuse
attr_accessor :query_results, :fail_query, :pdf_body
def initialize(*records)
@records = {}
records.each { |record| add(record) }
@created = []
@updated = []
@sent = []
@queries = []
@entities = []
@query_results = {}
@customers = {}
end
def add(record)
@records[record.id.to_s] = record
record
end
# Local models' details (Customer#details, Item#details...) are looked up through with_qbo_service; they
# get a blank QuickBooks record unless one was added to customers
DETAIL_ENTITIES = %w[Customer Item Account Employee].freeze
def fetch_by_id(id)
return records[id.to_s] if records.key?(id.to_s)
entity = entities.last.to_s
return customers[id.to_s] ||= Quickbooks::Model::Customer.new if entity == 'Customer'
return "Quickbooks::Model::#{entity}".constantize.new if DETAIL_ENTITIES.include?(entity)
nil
end
def create(doc)
doc.id ||= (5000 + created.size).to_s
doc.sync_token = 0
doc.doc_number ||= "N#{doc.id}" if doc.respond_to?(:doc_number=)
created << doc
add(doc)
end
def update(doc, sparse: false)
doc.sync_token = doc.sync_token.to_i + 1
updated << doc
add(doc)
end
def send_document(id, email)
sent << [id.to_s, email]
records[id.to_s]
end
alias send_estimate send_document
alias send_invoice send_document
def query(sql = nil, per_page: nil)
queries << sql
raise StandardError, 'query refused' if fail_query && sql.to_s.match?(fail_query)
key = sql ? query_results.keys.detect { |k| sql.include?(k) } : entities.last
Struct.new(:entries).new(Array(query_results[key]))
end
# SyncServiceBase#sync: query_results[entity name] in pages
def query_in_batches(sql, per_page: 1000)
queries << sql
Array(query_results[entities.last.to_s]).each_slice(per_page) { |batch| yield batch }
end
def find_by(field, value)
records.values.select { |r| r.respond_to?(field) && r.public_send(field).to_s == value.to_s }
end
def all(sql)
query(sql).entries
end
def pdf(doc)
pdf_body || "PDF #{doc.id}"
end
end
def install_fake_quickbooks(fake = FakeService.new)
@restore_quickbooks ||= []
[RedmineQboBilling::QboEstimateService, RedmineQboBilling::QboInvoiceService].each do |klass|
replace_class_method(klass, :with_service) do |&block|
fake.entities << klass.name.demodulize.gsub(/\AQbo|Service\z/, '')
block.call(fake)
end
end
replace_class_method(QboConnectionService, :with_qbo_service) do |entity: nil, &block|
fake.entities << entity
block.call(fake)
end
fake
end
def replace_class_method(klass, name, &body)
original = klass.method(name)
klass.define_singleton_method(name, &body)
@restore_quickbooks << -> { klass.define_singleton_method(name, original) }
end
def self.included(base)
base.teardown { Array(@restore_quickbooks).reverse_each(&:call) }
end
# The QuickBooks company's sales form settings (RedmineQboBilling::Company.settings)
def stub_company(custom_fields: [{ id: 1, name: 'Sales Rep' }, { id: 2, name: 'VIN' }], custom_txn_numbers: false,
estimate_message: 'Thank you for your business', invoice_message: 'Payment due on receipt')
RedmineQboBilling::Company.stubs(:settings).returns(
custom_fields: custom_fields, custom_txn_numbers: custom_txn_numbers, allow_discount: true,
estimate_message: estimate_message, invoice_message: invoice_message
)
end
def stub_local_syncs
EstimateSyncService.any_instance.stubs(:sync_by_id)
InvoiceSyncService.any_instance.stubs(:sync_by_id)
PaymentSyncService.any_instance.stubs(:sync_by_id)
end
# ---- QuickBooks documents ----
def qbo_ref(value, name = nil)
Quickbooks::Model::BaseReference.new(value.to_s, name: name)
end
def qbo_link(type, id)
Quickbooks::Model::LinkedTransaction.new(txn_id: id.to_s, txn_type: type)
end
def qbo_sales_line(id, item_id, name, quantity, rate, taxable: true, description: '')
line = Quickbooks::Model::InvoiceLineItem.new
line.id = id.to_s
line.description = description
line.amount = (BigDecimal(quantity.to_s) * BigDecimal(rate.to_s)).round(2)
line.sales_item! do |d|
d.item_ref = qbo_ref(item_id, name)
d.quantity = BigDecimal(quantity.to_s)
d.unit_price = BigDecimal(rate.to_s)
d.tax_code_ref = qbo_ref(taxable ? 'TAX' : 'NON')
end
line
end
def qbo_note_line(id, text)
line = Quickbooks::Model::InvoiceLineItem.new
line.id = id.to_s
line.description = text
line.description_only!
line
end
def qbo_discount_line(amount, percent: nil, account: nil)
line = Quickbooks::Model::InvoiceLineItem.new
line.amount = BigDecimal(amount.to_s)
line.discount_item! do |d|
d.percent_based = !percent.nil?
d.discount_percent = BigDecimal(percent.to_s) if percent
d.discount_account_ref = qbo_ref(account) if account
end
line
end
def qbo_custom_field(id, name, value)
field = Quickbooks::Model::CustomField.new
field.id = id
field.name = name
field.type = 'StringType'
field.string_value = value
field
end
def qbo_document(klass, id:, customer_id:, customer_name: nil, lines: [], status: nil, links: [], doc_number: nil,
total: nil, balance: nil, custom_fields: [], sync_token: 3, txn_date: Date.new(2026, 11, 10))
doc = klass.new
doc.id = id.to_s
doc.sync_token = sync_token
doc.doc_number = doc_number || id.to_s
doc.txn_date = txn_date
doc.customer_ref = qbo_ref(customer_id, customer_name)
doc.line_items = lines
doc.txn_status = status if doc.respond_to?(:txn_status=)
doc.linked_transactions = links
doc.total = BigDecimal(total.to_s) if total
doc.balance = BigDecimal(balance.to_s) if balance && doc.respond_to?(:balance=)
doc.custom_fields = custom_fields
doc
end
def qbo_estimate(id: 598, customer_id: 9101, **options)
qbo_document(Quickbooks::Model::Estimate, id: id, customer_id: customer_id, **options)
end
def qbo_invoice(id: 601, customer_id: 9101, **options)
qbo_document(Quickbooks::Model::Invoice, id: id, customer_id: customer_id, **options)
end
def local_customer(id = 9101, name = 'Jane Customer')
Customer.where(id: id).delete_all
customer = Customer.new(id: id, name: name)
customer.skip_qbo_push = true
customer.save!
customer
end
end
+10
View File
@@ -9,6 +9,16 @@
#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.
require File.expand_path('../../../test/test_helper', __dir__) require File.expand_path('../../../test/test_helper', __dir__)
require File.expand_path('qbo_fake_service', __dir__)
require File.expand_path('qbo_editor_test_helper', __dir__)
# With redmine_qbo_reminders installed, refund emails go out through its SMTP server
# (smtp-relay.gmail.com by default). Keep tests on Redmine's own (test) delivery.
if defined?(RedmineQboReminders::Settings)
ActiveSupport::TestCase.setup do
Setting.plugin_redmine_qbo_reminders = { 'delivery' => 'redmine' }
end
end
module QboRefundTestHelper module QboRefundTestHelper
CUSTOMER_ID = 9101 CUSTOMER_ID = 9101
+133
View File
@@ -0,0 +1,133 @@
#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.
require File.expand_path('../test_helper', __dir__)
class BillIssueTimeJobTest < ActiveSupport::TestCase
include QboFakeServiceHelper
fixtures :projects, :users, :members, :member_roles, :roles, :issues, :trackers, :projects_trackers,
:issue_statuses, :enabled_modules, :enumerations, :time_entries
# Stands in for QuickBooks' time activity and item services
class FakeTimeService
attr_reader :created
attr_accessor :fail_on
def initialize
@created = []
end
def create(activity)
raise Quickbooks::IntuitRequestException, 'QuickBooks is down' if fail_on && activity.hours.to_i == fail_on
created << activity
activity
end
end
class FakeItemService
attr_reader :queries
def initialize(items)
@items = items
@queries = []
end
def query(sql)
queries << sql
name = sql[/Name = '(.*)'\z/, 1].to_s.gsub("\\'", "'")
Array(@items[name])
end
end
def setup
local_customer
@issue = Issue.find(1)
@issue.update_columns(customer_id: 9101, assigned_to_id: 3, done_ratio: 40)
User.find(3).update_column(:employee_id, 31)
TimeEntry.delete_all
@design = TimeEntryActivity.find(9) # Design
@dev = TimeEntryActivity.find(10) # Development
@times = FakeTimeService.new
@items = FakeItemService.new('Design' => [Quickbooks::Model::Item.new(id: '5', unit_price: BigDecimal('90'))],
'Development' => [Quickbooks::Model::Item.new(id: '6', unit_price: BigDecimal('120'))])
Quickbooks::Service::TimeActivity.stubs(:new).returns(@times)
Quickbooks::Service::Item.stubs(:new).returns(@items)
qbo = Qbo.new(realm_id: '1')
qbo.define_singleton_method(:perform_authenticated_request) { |&block| block.call('token') }
QboConnectionService.stubs(:current!).returns(qbo)
Qbo.stubs(:update_time_stamp)
end
def spend(activity, hours, billed: false)
TimeEntry.create!(issue: @issue, project: @issue.project, user: User.find(2), activity: activity, hours: hours,
spent_on: Date.new(2026, 11, 18), billed: billed)
end
def test_sums_hours_by_activity_and_marks_them_billed
first = spend(@design, 1.25)
second = spend(@design, 0.5)
third = spend(@dev, 2)
spend(@dev, 3, billed: true)
BillIssueTimeJob.perform_now(@issue.id)
by_item = @times.created.to_h { |a| [a.item_ref.value, [a.hours, a.minutes]] }
assert_equal({ '5' => [1, 45], '6' => [2, 0] }, by_item)
activity = @times.created.first
assert_equal ['31', '9101', 'Billable', 'Employee'], [activity.employee_ref.value.to_s, activity.customer_ref.value.to_s,
activity.billable_status, activity.name_of]
assert_equal "#{@issue.tracker} ##{@issue.id}: #{@issue.subject} (Partial @ 40%)", activity.description
assert [first, second, third].all? { |e| e.reload.billed }
end
def test_closed_issue_description_has_no_partial_note
@issue.update_column(:status_id, IssueStatus.where(is_closed: true).first.id)
spend(@design, 1)
BillIssueTimeJob.perform_now(@issue.id)
assert_equal "#{@issue.tracker} ##{@issue.id}: #{@issue.subject}", @times.created.first.description
end
def test_nothing_unbilled_does_nothing
spend(@design, 1, billed: true)
BillIssueTimeJob.perform_now(@issue.id)
assert_empty @times.created
end
def test_activity_without_a_quickbooks_item_is_skipped_but_marked_billed
@items = FakeItemService.new({})
Quickbooks::Service::Item.stubs(:new).returns(@items)
entry = spend(@design, 1)
BillIssueTimeJob.perform_now(@issue.id)
assert_empty @times.created
assert entry.reload.billed
end
def test_a_failure_keeps_the_rest_for_a_retry
design = spend(@design, 1)
dev = spend(@dev, 2)
@times.fail_on = 2
assert_raises(Quickbooks::IntuitRequestException) { BillIssueTimeJob.new.perform(@issue.id) }
assert design.reload.billed
assert_not dev.reload.billed
# The retry only sends what's left
@times.fail_on = nil
BillIssueTimeJob.new.perform(@issue.id)
assert_equal [1, 2], @times.created.map(&:hours)
assert dev.reload.billed
end
def test_item_names_are_quoted
quoted = TimeEntryActivity.create!(name: "Tech's time", active: true)
spend(quoted, 1)
BillIssueTimeJob.perform_now(@issue.id)
assert_equal "SELECT * FROM Item WHERE Name = 'Tech\\'s time'", @items.queries.last
end
end
+101
View File
@@ -0,0 +1,101 @@
#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.
require File.expand_path('../test_helper', __dir__)
# PaymentForm, RefundForm and InvoiceRefundForm
class BillingFormsTest < ActiveSupport::TestCase
def payment(attrs = {})
RedmineQboBilling::PaymentForm.from_params({ 'customer_id' => '9101', 'txn_date' => '2026-11-20',
'payment_method_id' => '2', 'amount' => '$1,000' }.merge(attrs))
end
def test_payment_form_from_params
form = payment('invoice_ids' => ['7', '', '7', '8'], 'sync_token' => '3', 'deposit' => '1')
assert_equal %w[7 8], form.invoice_ids
assert_equal '3', form.sync_token
assert_equal BigDecimal('1000'), form.amount_value
assert_equal Date.new(2026, 11, 20), form.txn_date_value
assert form.deposit?
assert_not form.persisted?
assert RedmineQboBilling::PaymentForm.from_params({}, id: '12').persisted?
assert_equal [], RedmineQboBilling::PaymentForm.new.invoice_ids
end
def test_payment_form_validation
assert payment.valid?
form = RedmineQboBilling::PaymentForm.from_params({ 'amount' => '0', 'txn_date' => 'x' })
assert_not form.valid?
assert_includes form.errors[:base], I18n.t(:error_estimate_needs_customer)
assert_includes form.errors[:base], I18n.t(:error_payment_needs_method)
assert_includes form.errors[:base], I18n.t(:error_payment_amount)
assert_includes form.errors[:base], I18n.t(:error_estimate_field_invalid, field: I18n.t(:label_payment_date))
assert_not payment('amount' => 'abc').valid?
assert_not payment('amount' => '-5').valid?
end
def refund(attrs = {})
RedmineQboBilling::RefundForm.from_params({ 'customer_id' => '9101', 'txn_date' => '2026-11-20',
'method' => 'card', 'reason' => 'Canceled order' }.merge(attrs))
end
def test_refund_form
form = refund('parts_amount' => '307.99', 'close_estimate' => '1', 'cancel_issues' => '0')
assert form.valid?, form.errors.full_messages.inspect
assert_equal BigDecimal('307.99'), form.parts_value
assert form.close_estimate?
assert_not form.cancel_issues?
assert_not form.email_customer?
assert_not form.check?
assert_equal BigDecimal('0'), refund.parts_value
end
def test_refund_form_validation
form = RedmineQboBilling::RefundForm.from_params('method' => 'check', 'parts_amount' => '-1')
assert_not form.valid?
%i[error_estimate_needs_customer error_refund_check_number error_refund_reason error_refund_parts_amount].each do |key|
assert_includes form.errors[:base], I18n.t(key)
end
assert_includes refund('method' => 'cash').tap(&:valid?).errors[:base], I18n.t(:error_refund_method)
assert_includes refund('parts_amount' => 'lots').tap(&:valid?).errors[:base], I18n.t(:error_refund_parts_amount)
assert refund('method' => 'check', 'check_number' => '1042').valid?
end
def invoice_refund(attrs = {})
RedmineQboBilling::InvoiceRefundForm.from_params(
{ 'customer_id' => '9101', 'invoice_id' => '601', 'txn_date' => '2026-11-20', 'method' => 'card',
'reason' => 'Returned part', 'lines' => { '3' => { 'refund' => '1', 'quantity' => '2', 'amount' => '$1,060.00' },
'4' => { 'refund' => '0', 'quantity' => '', 'amount' => '' } } }.merge(attrs)
)
end
def test_invoice_refund_form_lines
form = invoice_refund('charge_fee' => '1')
assert form.valid?, form.errors.full_messages.inspect
assert_equal ['3'], form.chosen.keys
assert_equal BigDecimal('2'), form.line(3).quantity_value
assert_equal BigDecimal('1060'), form.line('3').amount_value
assert_nil form.line('4').quantity_value
assert_nil form.line('4').amount_value
assert_nil form.line('9')
assert form.charge_fee?
assert_not form.note_issues?
assert_includes RedmineQboBilling::InvoiceRefundForm.permitted, { lines: {} }
end
def test_invoice_refund_form_validation
form = RedmineQboBilling::InvoiceRefundForm.from_params('method' => 'check')
assert_not form.valid?
%i[error_estimate_needs_customer error_refund_no_invoice error_refund_check_number error_refund_reason
error_refund_no_lines].each { |key| assert_includes form.errors[:base], I18n.t(key) }
assert_includes form.errors[:base], I18n.t(:error_estimate_field_invalid, field: I18n.t(:label_refund_date))
assert_equal({}, form.lines)
end
end
+152
View File
@@ -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.
require File.expand_path('../test_helper', __dir__)
# BusinessReport's periods, chart points, hours and loading its figures from the database
class BusinessReportPeriodsTest < ActiveSupport::TestCase
fixtures :projects, :users, :issues, :trackers, :issue_statuses, :enumerations, :time_entries
Report = RedmineQboBilling::BusinessReport
TODAY = Date.new(2026, 11, 20) # a Friday
def range(period, **options)
Report.range_for(period, today: TODAY, **options)
end
def test_periods
assert_equal [Date.new(2026, 11, 16), Date.new(2026, 11, 22)], range('this_week')
assert_equal [Date.new(2026, 11, 15), Date.new(2026, 11, 21)], range('this_week', week_start: :sunday)
assert_equal [Date.new(2026, 11, 9), Date.new(2026, 11, 15)], range('last_week')
assert_equal [Date.new(2026, 11, 1), Date.new(2026, 11, 30)], range('this_month')
assert_equal [Date.new(2026, 10, 1), Date.new(2026, 10, 31)], range('last_month')
assert_equal [Date.new(2026, 10, 1), Date.new(2026, 12, 31)], range('this_quarter')
assert_equal [Date.new(2026, 7, 1), Date.new(2026, 9, 30)], range('last_quarter')
assert_equal [Date.new(2025, 1, 1), Date.new(2025, 12, 31)], range('last_year')
assert_equal [Date.new(2026, 1, 1), Date.new(2026, 12, 31)], range('this_year')
assert_equal [Date.new(2026, 1, 1), Date.new(2026, 12, 31)], range('bogus')
end
def test_custom_period
assert_equal [Date.new(2026, 3, 1), Date.new(2026, 4, 1)], range('custom', from: '2026-04-01', to: '2026-03-01')
assert_equal [Date.new(2026, 1, 1), TODAY], range('custom', from: 'nope')
assert_nil Report.parse_date('2026-13-01')
assert_equal TODAY, Report.parse_date(TODAY)
end
def test_unknown_period_is_this_year
assert_equal 'this_year', Report.new(period: 'forever', today: TODAY, data: {}).period
end
def test_week_start_setting
assert_equal :sunday, Report.week_start_from_setting('7')
assert_equal :saturday, Report.week_start_from_setting(6)
assert_equal :monday, Report.week_start_from_setting('')
end
def report(period, **options)
Report.new(period: period, today: TODAY, data: empty, previous_data: empty, **options)
end
def empty
{ estimates: [], invoices: [], paid: [], payments: [], issues: [], time_entries: [] }
end
def test_buckets_by_day_week_and_month
week = report('this_week')
assert_equal :day, week.granularity
assert_equal 7, week.buckets.size
month = report('this_month')
assert_equal :week, month.granularity
assert_equal [Date.new(2026, 11, 1), Date.new(2026, 11, 1)], month.buckets.first
assert_equal [Date.new(2026, 11, 30), Date.new(2026, 11, 30)], month.buckets.last
assert_equal [Date.new(2026, 11, 2) - 364, Date.new(2026, 11, 8) - 364], month.previous_buckets[1]
year = report('this_year')
assert_equal :month, year.granularity
assert_equal 12, year.buckets.size
assert_equal [Date.new(2025, 1, 1), Date.new(2025, 1, 31)], year.previous_buckets.first
end
def test_chart_stops_at_today
r = Report.new(period: 'this_week', today: TODAY, data: empty.merge(payments: [[TODAY, '100']]), previous_data: empty)
chart = r.chart
assert_equal '2026-11-16', chart[:points].first
assert_equal [0.0, 0.0, 0.0, 0.0, 100.0, nil, nil], chart[:current][:payments]
assert_equal [0.0] * 7, chart[:previous][:payments]
end
def test_hours_cpi_and_ratios
r = Report.new(period: 'this_month', today: TODAY, previous_data: empty,
data: empty.merge(estimates: [[TODAY, '0', 10]], invoices: [[TODAY, '0', 6, '0']],
issues: [[TODAY, 8]], time_entries: [[TODAY, 7.5], [TODAY, 0.5]]))
assert_equal({ estimate_hours: 10.0, issue_hours: 8.0, invoice_hours: 6.0, spent_hours: 8.0 }, r.hours)
assert_equal 0.75, r.cpi
assert_equal 75, r.ratios[:invoiced_of_spent]
assert_equal 100, r.ratios[:spent_of_estimated]
assert_nil r.ratios[:invoiced_of_estimated]
november = r.months.last
assert_equal [10.0, 8.0], november.values_at(:estimate_hours, :spent_hours)
end
def test_cpi_levels
assert_nil Report.cpi(5, 0)
assert_nil Report.cpi_level(nil)
assert_equal :poor, Report.cpi_level(0.79)
assert_equal :under, Report.cpi_level(0.95)
assert_equal :good, Report.cpi_level(1.2)
end
def test_months_stop_at_the_current_month
assert_equal (1..11).to_a, report('this_year').months.map { |m| m[:month].month }
assert_equal [1], Report.new(period: 'custom', from: '2027-01-01', to: '2027-02-01', today: TODAY, data: empty)
.months.map { |m| m[:month].month }
end
def test_project_ids
assert_not report('this_year').projects_filtered?
filtered = report('this_year', project_ids: ['1', '0', 1, 'x'])
assert_equal [1], filtered.project_ids
assert filtered.projects_filtered?
end
def test_loads_figures_from_the_database
Estimate.where(id: 9401).delete_all
Invoice.where(id: [9501, 9502]).delete_all
Payment.where(id: 9601).delete_all
TimeEntry.delete_all
Estimate.create!(id: 9401, doc_number: 'E1', customer_id: 1, txn_date: TODAY - 1, total_amount: 540, hours: 4, tax_amount: 40)
Invoice.create!(id: 9501, doc_number: '1', customer_id: 1, txn_date: TODAY - 2, total_amount: 535, balance: 0,
hours: 3, tax_amount: 35, paid_on: TODAY - 1)
Invoice.create!(id: 9502, doc_number: '2', customer_id: 1, txn_date: Date.new(2025, 11, 2), total_amount: 100, balance: 100)
Payment.create!(id: 9601, customer_id: 1, txn_date: TODAY - 1, total_amount: 535)
Issue.find(1).update_columns(created_on: TODAY.in_time_zone.change(hour: 9), estimated_hours: 5)
Issue.find(5).update_columns(created_on: TODAY.in_time_zone.change(hour: 9), estimated_hours: 2)
TimeEntry.new(issue_id: 1, project_id: 1, user_id: 2, author_id: 2, activity_id: 9, hours: 3.5, spent_on: TODAY).save!(validate: false)
TimeEntry.new(issue_id: 5, project_id: 3, user_id: 2, author_id: 2, activity_id: 9, hours: 1, spent_on: TODAY).save!(validate: false)
r = Report.new(period: 'this_month', today: TODAY)
assert_equal({ total: BigDecimal('500'), count: 1 }, r.money[:estimates])
assert_equal({ total: BigDecimal('500'), count: 1 }, r.money[:paid])
assert_equal BigDecimal('535'), r.money[:payments][:total]
assert_equal 1, r.money[:invoices][:count]
assert_equal 7.0, r.hours[:issue_hours]
assert_equal 4.5, r.hours[:spent_hours]
assert_equal 0, r.unsynced_count
only_one = Report.new(period: 'this_month', today: TODAY, project_ids: [1])
assert_equal [5.0, 3.5], only_one.hours.values_at(:issue_hours, :spent_hours)
# QuickBooks figures have no project
assert_equal BigDecimal('535'), only_one.money[:payments][:total]
# Last year's invoice is on the comparison line
assert_equal 100.0, Report.new(period: 'this_month', today: TODAY).chart[:previous][:invoices].sum
end
end
+84
View File
@@ -0,0 +1,84 @@
#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.
require File.expand_path('../test_helper', __dir__)
class CompanyTest < ActiveSupport::TestCase
include QboFakeServiceHelper
Company = RedmineQboBilling::Company
def name_value(name, string: nil, boolean: nil)
Struct.new(:name, :string_value, :boolean_value).new(name, string, boolean)
end
def settings(fields, extra = {})
Company.stubs(:settings).returns({ custom_fields: fields }.merge(extra))
end
def test_parse_custom_fields
entries = [name_value('SalesFormsPrefs.UseSalesCustom1', boolean: 'true'),
name_value('SalesFormsPrefs.SalesCustomName1', string: ' Sales Rep '),
name_value('SalesFormsPrefs.UseSalesCustom2', boolean: 'false'),
name_value('SalesFormsPrefs.SalesCustomName2', string: 'Old'),
name_value('SalesFormsPrefs.SalesCustomName3', string: 'VIN'),
name_value('SalesFormsPrefs.SalesCustomName4', string: '')]
assert_equal [{ id: 1, name: 'Sales Rep' }, { id: 3, name: 'VIN' }], Company.parse_custom_fields(entries)
end
def test_merge_fields_prefers_newer_custom_fields
legacy = [{ id: 1, name: 'Sales Rep old' }]
assert_equal [{ id: 5_000_001, name: 'Sales Person' }],
Company.merge_fields(legacy, [{ id: 1, name: 'x' }, { id: 5_000_001, name: 'Sales Person' }])
assert_equal [{ id: 1, name: 'Sales Rep old' }, { id: 2, name: 'VIN' }],
Company.merge_fields(legacy, [{ id: 1, name: 'Sales' }, { id: 2, name: 'VIN' }])
end
def test_fields_hidden_in_settings_are_left_out
settings([{ id: 1, name: 'Sales Rep' }, { id: 2, name: 'VIN' }, { id: 3, name: 'Mileage' }])
Setting.stubs(:plugin_redmine_qbo).returns('hidden_custom_field_ids' => ['3', ''])
assert_equal [1, 2], Company.custom_fields.map(&:id)
assert_equal [1, 2, 3], Company.all_custom_fields.map(&:id)
assert_equal 1, Company.sales_person_field.id
assert_equal [2], Company.editable_custom_fields.map(&:id)
assert_equal 2, Company.custom_field_matching(/\bvin\b/i).id
assert_nil Company.custom_field_matching(/mileage/i)
end
def test_flags_and_messages
settings([], custom_txn_numbers: true, allow_discount: false, estimate_message: 'Thanks', invoice_message: nil)
assert Company.custom_txn_numbers?
assert_not Company.discounts_allowed?
assert_equal 'Thanks', Company.estimate_message
assert_equal '', Company.invoice_message
settings([])
assert Company.discounts_allowed?
assert_not Company.custom_txn_numbers?
end
def test_fetch_settings_from_preferences_and_recent_estimates
fake = install_fake_quickbooks
prefs = Struct.new(:sales_forms).new(
Struct.new(:custom_fields, :custom_txn_numbers?, :allow_discount?, :estimate_message, :default_customer_message)
.new([name_value('SalesFormsPrefs.SalesCustomName1', string: 'Sales Rep')], 'true', 'false', 'Thanks', 'Pay up')
)
fake.query_results = { 'Preferences' => [prefs],
'FROM Estimate' => [qbo_estimate(custom_fields: [qbo_custom_field(2, 'VIN', 'x')])] }
result = Company.fetch_settings
assert_equal [{ id: 1, name: 'Sales Rep' }, { id: 2, name: 'VIN' }], result[:custom_fields]
assert_equal [true, false, 'Thanks', 'Pay up'], result.values_at(:custom_txn_numbers, :allow_discount, :estimate_message, :invoice_message)
end
def test_settings_are_empty_when_quickbooks_is_unreachable
QboConnectionService.stubs(:with_qbo_service).raises(StandardError, 'QBO not connected')
assert_nil Company.fetch_settings
assert_equal({}, Company.settings)
assert_equal({}, Company.refresh!)
end
end
+83
View File
@@ -0,0 +1,83 @@
#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.
require File.expand_path('../test_helper', __dir__)
class CustomerSearchServiceTest < ActiveSupport::TestCase
Search = CustomerSearchService
ROWS = [
[1, 'William Smith', '4015550101', nil],
[2, 'Robert Jones', nil, '4015550199'],
[3, 'Kathy McDonald', '5085551234', nil],
[4, "Sean O'Brien LLC", nil, nil],
[5, 'José Alvarez', nil, nil],
[6, 'Jon Smyth', nil, nil]
].freeze
def rank(**query)
Search.rank(Search.prepare(ROWS), **query).map(&:first)
end
def test_tokens
assert_equal %w[obrien smith jose], Search.tokens("O'Brien-Smith, José")
assert_equal %w[sean obrien], Search.tokens("Sean O'Brien LLC")
assert_equal %w[the company], Search.tokens('The Company')
end
def test_nicknames_sound_alikes_typos_and_order
assert_equal 1, rank(name: 'Bill Smith').first
assert_equal 2, rank(name: 'Bob Jones').first
assert_equal 1, rank(name: 'Smith, William').first
assert_equal 1, rank(name: 'Willaim Smtih').first
assert_includes rank(name: 'John Smith'), 6
assert_equal 3, rank(name: 'Cathy Mc Donald').first
assert_equal 5, rank(name: 'jose alvarez').first
end
def test_partial_names_while_typing
assert_equal 1, rank(name: 'will smi').first
assert_equal 1, rank(name: 'bil smith').first
end
def test_unrelated_names_do_not_match
assert_empty rank(name: 'Bill Jones') & [1]
assert_empty rank(name: 'Zebulon')
assert_empty rank(name: '')
end
def test_phone_numbers
assert_equal [2], rank(phone: '0199')
assert_equal [1], rank(name: '(401) 555-0101')
assert_equal [], rank(phone: '12')
assert_equal 1.0, Search.phone_score('5550101', ['4015550101'])
assert_equal 0.9, Search.phone_score('5550', ['4015550101'])
end
def test_limit
assert_equal 1, Search.rank(Search.prepare(ROWS), phone: '401555', limit: 1).size
end
def test_nicknames_need_a_shared_longer_name
assert Search.nicknames?('bill', 'will')
assert_not Search.nicknames?('william', 'robert')
assert Search.nicknames?('liam', 'william')
end
def test_call_returns_customers_best_first
CustomerSearchService.instance_variable_set(:@candidates, nil)
Customer.where(id: [9101, 9102]).delete_all
[[9101, 'William Smith'], [9102, 'Bill Smithers']].each do |id, name|
Customer.new(id: id, name: name).tap { |c| c.skip_qbo_push = true }.save!
end
assert_equal 9101, Search.call(name: 'William Smith').first.id
assert_empty Search.call(name: 'zzzz')
end
end
+86
View File
@@ -0,0 +1,86 @@
#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.
require File.expand_path('../test_helper', __dir__)
class CustomerTest < ActiveSupport::TestCase
def setup
Customer.where(id: [9201, 9202, 9203]).delete_all
end
def customer(id, name, phone: nil, mobile: nil)
record = Customer.new(id: id, name: name, phone_number: phone, mobile_phone_number: mobile)
record.skip_qbo_push = true
record.save!
record
end
def test_name_is_title_cased_locally_and_in_quickbooks
record = Customer.new(id: 9201, name: ' jane DOE llc ')
assert_equal 'Jane DOE Llc', record.name
assert_equal 'Jane DOE Llc', record.details.display_name
end
def test_phone_numbers_keep_digits_only
record = customer(9201, 'Jane', phone: '(401) 555-0101', mobile: '+1 401.555.0102')
assert_equal '4015550101', record.phone_number
assert_equal '14015550102', record.mobile_phone_number
end
def test_to_s_adds_the_last_four_digits
assert_equal 'Jane - 0101', customer(9201, 'Jane', phone: '4015550101').to_s
assert_equal 'Bob', customer(9202, 'Bob').to_s
end
def test_needs_a_name_and_a_unique_id
assert_not Customer.new(id: 9201, name: '').tap { |c| c.skip_qbo_push = true }.valid?
customer(9201, 'Jane')
duplicate = Customer.new(id: 9201, name: 'Other')
duplicate.skip_qbo_push = true
assert_not duplicate.valid?
end
def test_search_by_name_or_phone
customer(9201, 'Jane Customer', phone: '4015550101')
customer(9202, 'Bob Builder', mobile: '4015550199')
customer(9203, '100% Jeep')
assert_equal [9201], Customer.search('jane').pluck(:id)
assert_equal [9202], Customer.search('0199').pluck(:id)
# LIKE wildcards are matched literally
assert_equal [9203], Customer.search('100%').pluck(:id)
end
def test_redmine_search_needs_every_token
customer(9201, 'Jane Customer', phone: '4015550101')
customer(9202, 'Jane Other')
assert_equal({ 9201 => 9201 }, Customer.search_result_ranks_and_ids(%w[jane 0101], User.find(1)))
assert_equal({}, Customer.search_result_ranks_and_ids([], User.find(1)))
end
def test_quickbooks_details_setters
record = Customer.new(id: 9201, name: 'Jane')
record.primary_phone = '401-555-0101'
record.mobile_phone = '401-555-0102'
record.email = 'jane@example.com'
record.notes = 'Prefers texts'
assert_equal '401-555-0101', record.primary_phone
assert_equal '401-555-0102', record.mobile_phone
assert_equal 'jane@example.com', record.email
assert_equal 'Prefers texts', record.details.notes
assert_nil record.project
end
def test_saving_pushes_to_quickbooks_unless_skipped
CustomerService.any_instance.expects(:push).once.returns(true)
Customer.create!(id: 9201, name: 'Jane')
CustomerService.any_instance.expects(:push).never
customer(9202, 'Bob')
end
end
+216
View File
@@ -0,0 +1,216 @@
#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.
require File.expand_path('../test_helper', __dir__)
class EstimateFormTest < ActiveSupport::TestCase
Form = RedmineQboBilling::EstimateForm
Line = Form::Line
def line(attrs = {})
Line.from_params(attrs)
end
def valid_form(attrs = {})
Form.new({ customer_id: '9101', txn_date: '2026-11-20',
lines: [line(item_id: '1', item_name: 'Labor', quantity: '2', rate: '120')] }.merge(attrs))
end
# Line
def test_line_from_params_cleans_up_the_row
row = line('id' => '', 'kind' => 'other', 'item_id' => '5', 'item_name' => ' Labor ', 'description' => ' Brakes ',
'quantity' => ' 2 ', 'rate' => '$1,200.50', 'taxable' => '1', 'time_activity_id' => '')
assert_nil row.id
assert_nil row.kind
assert_equal 'Labor', row.item_name
assert_equal 'Brakes', row.description
assert_equal BigDecimal('1200.50'), row.rate_value
assert row.taxable?
assert_nil row.time_activity_id
assert_not line('taxable' => '0').taxable?
end
def test_line_amount_defaults_quantity_to_one_and_rounds
assert_equal BigDecimal('45.50'), line(rate: '45.50').amount
assert_equal BigDecimal('3.33'), line(quantity: '0.333', rate: '10').amount
assert_equal BigDecimal('0'), line(description: 'note').amount
assert_equal BigDecimal('0'), line(kind: 'subtotal', rate: '10').amount
end
def test_line_kinds
assert line(kind: 'subtotal').subtotal?
assert line(item_id: '1').item?
assert_not line(kind: 'subtotal', item_id: '1').item?
assert line(description: 'Notes').description_only?
assert_not line(description: 'Notes', rate: '5').description_only?
assert line.blank?
assert_not line(kind: 'subtotal').blank?
assert line(item_name: 'Typed only').unmatched_item?
assert_not line(item_id: '1', item_name: 'Labor').unmatched_item?
end
def test_line_number_invalid
assert line(quantity: 'two').number_invalid?
assert line(rate: 'abc').number_invalid?
assert_not line(quantity: '2', rate: '1,000').number_invalid?
assert_not line(kind: 'subtotal', rate: 'abc').number_invalid?
end
# Parsing helpers
def test_decimal
assert_equal BigDecimal('1234.5'), Form.decimal('$1,234.50')
assert_nil Form.decimal('')
assert_nil Form.decimal('abc')
end
def test_date
assert_equal Date.new(2026, 11, 20), Form.date('2026-11-20')
assert_equal Date.new(2026, 1, 2), Form.date(Date.new(2026, 1, 2))
assert_nil Form.date('')
assert_nil Form.date('11/20/2026')
end
def test_custom_field_hash_keeps_numeric_ids_only
field = Struct.new(:id).new(3)
assert_equal({ '2' => 'VIN1', '3' => 'x' }, Form.custom_field_hash(2 => ' VIN1 ', 'name' => 'no', field => 'x'))
assert_equal({}, Form.custom_field_hash(nil))
form = Form.new(custom_fields: { 2 => 'VIN1' })
assert_equal 'VIN1', form.custom_field(2)
assert_equal 'VIN1', form.custom_field(Struct.new(:id).new('2'))
assert_equal '', form.custom_field(9)
end
def test_from_params
form = Form.from_params({ 'customer_id' => ' 9101 ', 'txn_date' => '2026-11-20', 'sync_token' => '',
'total_tax' => '4.20', 'linked_estimate_ids' => ['5', '', '5', '6'],
'custom_fields' => { '2' => 'VIN' },
'lines' => { '0' => { 'item_id' => '1', 'rate' => '10' }, '1' => { 'description' => 'Note' } } },
id: '42', document: 'invoice')
assert_equal '42', form.id
assert form.persisted?
assert form.invoice?
assert_nil form.sync_token
assert_equal '9101', form.customer_id
assert_equal '4.20', form.total_tax
assert_equal %w[5 6], form.linked_estimate_ids
assert_equal({ '2' => 'VIN' }, form.custom_fields)
assert_equal 2, form.lines.size
assert_equal 'Note', form.lines.last.description
end
def test_defaults
form = Form.new
assert_equal 'estimate', form.document
assert_not form.invoice?
assert_not form.persisted?
assert_equal [], form.lines
assert_equal [], form.linked_estimate_ids
end
# Totals and discounts
def test_subtotal_skips_blank_rows
form = Form.new(lines: [line(quantity: '2', rate: '10', item_id: '1'), line, line(rate: '5.25', item_id: '2')])
assert_equal 2, form.filled_lines.size
assert_equal BigDecimal('25.25'), form.subtotal
end
def test_percent_discount
form = valid_form(discount_value: '10%')
assert form.percent_discount?
assert form.discount?
assert_equal BigDecimal('24'), form.discount_amount
end
def test_amount_discount_and_unknown_type
assert_equal BigDecimal('15.56'), valid_form(discount_type: 'amount', discount_value: '15.555').discount_amount
assert_equal 'percent', valid_form(discount_type: 'bogus').discount_type
assert_not valid_form(discount_value: '0').discount?
assert_equal BigDecimal('0'), valid_form.discount_amount
end
def test_fully_paid_and_sent
assert Form.new(balance: '0').fully_paid?
assert Form.new(balance: '-1').fully_paid?
assert_not Form.new(balance: '10').fully_paid?
assert_not Form.new.fully_paid?
assert Form.new(email_status: 'EmailSent').sent?
assert_not Form.new(email_status: 'NeedToSend').sent?
end
# Validation
def test_valid_form
assert valid_form.valid?, valid_form.errors.full_messages.inspect
end
def test_needs_customer_line_and_date
form = Form.new(txn_date: '')
assert_not form.valid?
assert_includes form.errors[:base], I18n.t(:error_estimate_needs_customer)
assert_includes form.errors[:base], I18n.t(:error_estimate_needs_a_line)
assert_includes form.errors[:base], I18n.t(:error_estimate_field_invalid, field: I18n.t(:label_estimate_date))
end
def test_invoice_date_label
form = valid_form(txn_date: 'nope', document: 'invoice')
assert_not form.valid?
assert_includes form.errors[:base], I18n.t(:error_estimate_field_invalid, field: I18n.t(:label_invoice_date))
end
def test_bad_expiration_and_due_dates
form = valid_form(expiration_date: 'soon', due_date: '13/45/2026')
assert_not form.valid?
assert_includes form.errors[:base], I18n.t(:error_estimate_field_invalid, field: I18n.t(:label_expiration_date))
assert_includes form.errors[:base], I18n.t(:error_estimate_field_invalid, field: I18n.t(:label_due_date))
end
def test_line_errors_are_numbered_by_filled_row
form = valid_form(lines: [line, line(item_name: 'Ghost'), line(item_id: '1', rate: 'x')])
assert_not form.valid?
assert_includes form.errors[:base], I18n.t(:error_estimate_line_unmatched_item, line: 1, name: 'Ghost')
assert_includes form.errors[:base], I18n.t(:error_estimate_line_number, line: 2)
end
# A row with an unreadable price and no product or description: kept, so it needs a description
def test_description_line_needs_text
form = valid_form
form.lines << line(rate: 'abc')
assert_not form.valid?
assert_includes form.errors[:base], I18n.t(:error_estimate_line_description, line: 2)
end
def test_email_addresses
assert valid_form(email: 'a@example.com, b@example.com').valid?
form = valid_form(email: 'a@example.com, not-an-address')
assert_not form.valid?
assert_includes form.errors[:base], I18n.t(:error_estimate_field_invalid, field: I18n.t(:label_customer_email))
end
def test_discount_validation
invalid = I18n.t(:error_estimate_field_invalid, field: I18n.t(:label_discount_from_quickbooks))
assert_includes valid_form(discount_value: '101').tap(&:valid?).errors[:base], invalid
assert_includes valid_form(discount_value: '-5').tap(&:valid?).errors[:base], invalid
assert_includes valid_form(discount_value: 'ten').tap(&:valid?).errors[:base], invalid
assert_includes valid_form(discount_type: 'amount', discount_value: '241').tap(&:valid?).errors[:base],
I18n.t(:error_discount_too_large)
assert valid_form(discount_type: 'amount', discount_value: '240').valid?
assert valid_form(discount_value: '100').valid?
end
def test_plugin_errors_block_the_save
RedmineQboBilling::IssueValues.stubs(:plugin_errors).returns(['One vehicle per invoice'])
form = valid_form
assert_not form.valid?
assert_includes form.errors[:base], 'One vehicle per invoice'
end
end
+133
View File
@@ -0,0 +1,133 @@
#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.
require File.expand_path('../test_helper', __dir__)
class EstimateIssueBuilderTest < ActiveSupport::TestCase
include QboFakeServiceHelper
fixtures :projects, :users, :email_addresses, :roles, :members, :member_roles, :issues, :issue_statuses, :trackers,
:projects_trackers, :enabled_modules, :enumerations, :workflows, :custom_fields, :custom_values,
:custom_fields_projects, :custom_fields_trackers, :issue_relations
Builder = RedmineQboBilling::EstimateIssueBuilder
def setup
Setting.stubs(:plugin_redmine_qbo).returns('issue_default_tracker_id' => '2', 'issue_default_project_id' => '1')
QboEstimateLineIssue.delete_all
Estimate.where(id: 598).delete_all
local_customer
@estimate = Estimate.create!(id: 598, doc_number: '1068', customer_id: 9101)
@estimate.stubs(:line_items).returns([
qbo_sales_line(1, 10, 'Labor', 2, 120, description: 'Install lift kit'),
qbo_sales_line(2, 11, 'Brake pads', 4, 30, description: 'Pads'),
qbo_sales_line(3, 10, 'Labor', 0, 120, description: 'Diagnose noise'),
qbo_sales_line(4, 10, 'Labor', 1, 120, description: ' ')
])
@project = Project.find(1)
@author = User.find(1)
User.current = @author
end
def rows(*line_ids, **extra)
line_ids.to_h { |id| [id.to_s, { 'selected' => '1', 'tracker_id' => '1' }.merge(extra.transform_keys(&:to_s))] }
end
def test_settings
assert_equal 2, Builder.default_tracker_id
assert_equal 1, Builder.default_project_id
end
def test_labor_hours
assert_equal 3.0, Builder.labor_hours(@estimate)
assert_equal 0.0, Builder.labor_hours(nil)
end
def test_proposals_are_labor_lines_with_a_description
proposals = Builder.new(@estimate).proposals
assert_equal %w[1 3], proposals.map(&:line_id)
assert_equal ['Install lift kit', 2.0], [proposals.first.description, proposals.first.hours]
assert_nil proposals.last.hours
assert_not proposals.first.created?
assert_equal [], Builder.new(nil).proposals
end
def test_create_issues
builder = Builder.new(@estimate, defaults: { start_date: Date.new(2026, 11, 23), assignee: User.find(3) })
created = builder.create_issues(project: @project, rows: rows(1, 3, estimated_hours: '1.5'), author: @author)
assert_empty builder.errors
# Subjects are title-cased by the issue patch
assert_equal ['Install Lift Kit', 'Diagnose Noise'], created.map(&:subject)
issue = created.first.reload
assert_equal [598, 9101, 1.5, Date.new(2026, 11, 23)], [issue.estimate_id, issue.customer_id, issue.estimated_hours, issue.start_date]
assert_match 'Estimate #1068', issue.description
assert_equal 2, QboEstimateLineIssue.where(estimate_id: 598).count
assert issue.relations.any? { |r| r.other_issue(issue) == created.last }
# Shown as created; can't be made again
again = Builder.new(@estimate)
assert again.proposals.all?(&:created?)
assert_equal [], again.create_issues(project: @project, rows: rows(1), author: @author)
assert_equal [I18n.t(:error_no_estimate_lines_selected)], again.errors
end
def test_later_batches_are_related_to_earlier_ones
first = Builder.new(@estimate).create_issues(project: @project, rows: rows(1), author: @author)
second = Builder.new(@estimate).create_issues(project: @project, rows: rows(3), author: @author)
assert IssueRelation.where(issue_from_id: [first.first.id, second.first.id], issue_to_id: [first.first.id, second.first.id]).exists?
end
def test_nothing_is_created_when_one_issue_fails
builder = Builder.new(@estimate)
count = Issue.count
created = builder.create_issues(project: @project, rows: rows(1).merge(rows(3, tracker_id: '999')), author: @author)
assert_equal [], created
assert_equal count, Issue.count
assert_match 'Diagnose noise', builder.errors.first
assert_equal 0, QboEstimateLineIssue.count
end
def test_subject_and_default_description_overrides
builder = Builder.new(@estimate, defaults: { description: 'From the appointment' })
created = builder.create_issues(project: @project, rows: rows(1, subject: 'Custom subject'), author: @author)
assert_equal 'Custom Subject', created.first.subject
assert_equal 'From the appointment', created.first.description
end
def test_unassignable_user_is_left_off
outsider = User.find(7)
created = Builder.new(@estimate, defaults: { assignee: outsider }).create_issues(project: @project, rows: rows(1), author: @author)
assert_nil created.first.assigned_to
end
def test_subtasks_take_the_parents_customer
parent = Issue.find(1)
parent.update_column(:customer_id, 9102)
created = Builder.new(@estimate, parent: parent).create_issues(project: @project, rows: rows(1), author: @author)
issue = created.first.reload
assert_equal parent.id, issue.parent_id
assert_equal 9102, issue.customer_id
# Not related to its own parent
assert_not issue.relations.any? { |r| r.other_issue(issue) == parent }
end
def test_plugins_set_their_fields
Redmine::Hook.expects(:call_hook).with(:qbo_billing_build_issue, has_key(:issue)).once
Builder.new(@estimate).create_issues(project: @project, rows: rows(1), author: @author)
end
def test_relate_all_skips_existing_relations
issues = Issue.where(id: [1, 2, 3]).order(:id).to_a
IssueRelation.where(issue_from_id: [1, 2, 3]).or(IssueRelation.where(issue_to_id: [1, 2, 3])).delete_all
IssueRelation.create!(issue_from: issues[0], issue_to: issues[1], relation_type: 'relates')
assert_equal 2, Builder.relate_all(issues + [nil, issues[0]])
assert_equal 0, Builder.relate_all(issues)
assert_equal 0, Builder.relate_all([issues.first])
end
end
+32
View File
@@ -0,0 +1,32 @@
#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.
require File.expand_path('../test_helper', __dir__)
class EstimateServiceTest < ActiveSupport::TestCase
def setup
Estimate.where(id: 9601).delete_all
@estimate = Estimate.create!(id: 9601, doc_number: '1068', customer_id: 9101)
end
def test_an_estimate_quickbooks_cannot_read_raises_an_ordinary_error
QboConnectionService.stubs(:with_qbo_service).raises(RuntimeError, 'QBO not connected')
error = assert_raises(EstimateService::FetchError) { @estimate.details }
assert_kind_of StandardError, error
assert_match(/9601/, error.message)
end
def test_labor_hours_are_zero_while_quickbooks_is_down
skip 'redmine_qbo_calendar is not installed' unless defined?(CustomerAppointment)
QboConnectionService.stubs(:with_qbo_service).raises(RuntimeError, 'QBO not connected')
assert_equal 0, CustomerAppointment.estimate_labor_hours(@estimate)
end
end
+372
View File
@@ -0,0 +1,372 @@
#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.
require File.expand_path('../test_helper', __dir__)
class EstimateWriterTest < ActiveSupport::TestCase
include QboFakeServiceHelper
fixtures :projects, :users, :issues, :trackers, :issue_statuses, :enumerations
Writer = RedmineQboBilling::EstimateWriter
Form = RedmineQboBilling::EstimateForm
def setup
@customer = local_customer
@fake = install_fake_quickbooks
stub_company
stub_local_syncs
Setting.stubs(:plugin_redmine_qbo).returns('expiration_days' => '30')
Issue.where(estimate_id: [598, 599]).update_all(estimate_id: nil)
@user = User.find(2)
end
def remote_estimate(**options)
qbo_estimate(customer_name: 'Jane Customer', doc_number: '1068', status: 'Pending',
custom_fields: [qbo_custom_field(1, 'Sales Rep', 'Ricky'), qbo_custom_field(2, 'VIN', '1C4HJXDG5JW123456')],
lines: [qbo_note_line(1, 'Lift kit install'),
qbo_sales_line(2, 10, 'Labor', 2, 120, taxable: false, description: 'Install'),
qbo_note_line(3, 'Subtotal: $240.00'),
qbo_sales_line(4, 11, 'Brake pads', 4, '30.5')],
**options)
end
def form(attrs = {})
Form.new({ customer_id: @customer.id.to_s, txn_date: '2026-11-20', email: 'jane@example.com',
lines: [Form::Line.new(item_id: '10', quantity: '2', rate: '120', taxable: false, description: 'Install'),
Form::Line.new(kind: 'subtotal'),
Form::Line.new(item_id: '11', quantity: '4', rate: '30.50', taxable: true)] }.merge(attrs))
end
# ---- reading ----
def test_form_from_remote
result = Writer.form_from_remote(remote_estimate)
assert_equal '598', result.id
assert_equal '3', result.sync_token
assert_equal '9101', result.customer_id
assert_equal 'Jane Customer', result.customer_name
assert_equal '1068', result.doc_number
assert_equal 'Ricky', result.sales_person
assert_equal({ '1' => 'Ricky', '2' => '1C4HJXDG5JW123456' }, result.custom_fields)
assert_equal [nil, nil, 'subtotal', nil], result.lines.map(&:kind)
labor = result.lines[1]
assert_equal %w[10 Labor 2 120], [labor.item_id, labor.item_name, labor.quantity, labor.rate]
assert_not labor.taxable?
assert result.lines[3].taxable?
assert_equal '30.5', result.lines[3].rate
assert_nil result.locked
end
def test_locked_states
assert_equal :billed, Writer.form_from_remote(remote_estimate(status: 'Converted')).locked
assert_equal :billed, Writer.form_from_remote(remote_estimate(links: [qbo_link('Invoice', 601)])).locked
bundle = Quickbooks::Model::InvoiceLineItem.new
bundle.group_line_detail!
assert_equal :bundles, Writer.form_from_remote(remote_estimate(lines: [bundle])).locked
Issue.find(1).update_column(:estimate_id, 598)
assert_equal :linked, Writer.form_from_remote(remote_estimate).locked
end
def test_invoiced_on_lists_the_invoices
Invoice.where(id: 601).delete_all
Invoice.create!(id: 601, doc_number: '1234', customer_id: 9101, txn_date: Date.new(2026, 11, 12))
result = Writer.form_from_remote(remote_estimate(links: [qbo_link('Invoice', 601), qbo_link('Invoice', 601), qbo_link('Payment', 7)]))
assert_equal [%w[601 1234]], result.invoiced_on
end
def test_discount_fields
percent = remote_estimate(lines: [qbo_sales_line(1, 10, 'Labor', 1, 100), qbo_discount_line(10, percent: 10)])
assert_equal({ discount_type: 'percent', discount_value: '10' }, Writer.discount_fields(percent))
amount = remote_estimate(lines: [qbo_discount_line('12.5'), qbo_discount_line('2.5', percent: 1)])
assert_equal({ discount_type: 'amount', discount_value: '15' }, Writer.discount_fields(amount))
assert_equal({}, Writer.discount_fields(remote_estimate))
assert_equal BigDecimal('15'), Writer.discount_total(amount)
assert_nil Writer.discount_total(remote_estimate)
end
def test_line_from_remote_skips_quickbooks_own_lines
subtotal = Quickbooks::Model::InvoiceLineItem.new
subtotal.detail_type = 'SubTotalLineDetail'
assert_nil Writer.line_from_remote(subtotal)
assert_nil Writer.line_from_remote(qbo_discount_line(5))
assert Writer.line_from_remote(qbo_note_line(1, 'subtotal: -$1,000.25')).subtotal?
assert_equal 'Subtotal for brakes', Writer.line_from_remote(qbo_note_line(1, 'Subtotal for brakes')).description
end
def test_custom_value
remote = remote_estimate
assert_equal 'Ricky', Writer.custom_value(remote, RedmineQboBilling::Company::Field.new(1, 'Sales Rep'))
assert_equal '', Writer.custom_value(remote, RedmineQboBilling::Company::Field.new(3, 'Other'))
# Unknown field: found by name, but never a hidden one
assert_equal 'Ricky', Writer.custom_value(remote, nil, /sales/i)
RedmineQboBilling::Company.stubs(:hidden_field_ids).returns([1])
assert_equal '', Writer.custom_value(remote, nil, /sales/i)
end
def test_load
@fake.add(remote_estimate)
assert_equal '1068', Writer.load(598).doc_number
error = assert_raises(Writer::Error) { Writer.load(999) }
assert_equal I18n.t(:notice_estimate_not_found), error.message
end
# ---- new, duplicate, create for plugins ----
def test_new_form
@user.stubs(:today).returns(Date.new(2026, 11, 20))
result = Writer.new_form(customer: @customer, user: @user)
assert_equal '2026-11-20', result.txn_date
assert_equal '2026-12-20', result.expiration_date
assert_equal @user.name, result.sales_person
assert_equal 'Thank you for your business', result.customer_memo
assert_equal 2, result.lines.size
assert result.lines.all?(&:taxable?)
assert_equal 'Jane Customer', result.customer_name
end
def test_no_expiration_without_the_setting
Setting.stubs(:plugin_redmine_qbo).returns({})
assert_nil Writer.new_form(user: @user).expiration_date
end
def test_duplicate_form
@fake.add(remote_estimate(lines: [qbo_sales_line(2, 10, 'Labor', 2, 120), qbo_discount_line(24, percent: 10)]))
@user.stubs(:today).returns(Date.new(2026, 11, 20))
copy = Writer.duplicate_form(598, user: @user)
assert_not copy.persisted?
assert_equal '1068', copy.duplicated_from
assert_equal '2026-11-20', copy.txn_date
assert_equal @user.name, copy.sales_person
assert_equal 'percent', copy.discount_type
assert_equal '10', copy.discount_value
assert_equal [nil], copy.lines.map(&:id)
assert_equal '1C4HJXDG5JW123456', copy.custom_field(2)
end
def test_create_estimate_for_another_plugin
saved = Writer.create_estimate(customer: @customer, private_note: 'From #116',
lines: [{ description: 'Added from: Install #116: lift' },
{ item_id: 11, quantity: 2.0, rate: '45.50', taxable: false }],
custom_fields: { 2 => 'VIN9' }, txn_date: Date.new(2026, 11, 20))
assert_equal 1, @fake.created.size
assert_equal 'From #116', saved.private_note
assert_equal 'Thank you for your business', saved.customer_memo
sales = saved.line_items.find(&:sales_item?)
assert_equal BigDecimal('91'), sales.amount
assert_equal 'NON', sales.sales_line_item_detail.tax_code_ref.value
assert_equal Date.new(2026, 12, 20), saved.expiration_date
# Made without a user: no sales person
assert_equal({ 2 => 'VIN9' }, saved.custom_fields.to_h { |f| [f.id, f.string_value] })
end
# ---- saving ----
def test_create
saved = Writer.save(form, user: @user)
estimate = @fake.created.first
assert_equal saved, estimate
assert_equal 9101, estimate.customer_ref.value.to_i
assert_equal 'jane@example.com', estimate.bill_email.address
assert_equal Date.new(2026, 11, 20), estimate.txn_date
assert_equal ['Install', 'Subtotal: $240.00', nil], estimate.line_items.map(&:description)
assert_equal [1, 2, 3], estimate.line_items.map(&:line_num)
assert_equal BigDecimal('122'), estimate.line_items.last.amount
# Sales person on create
assert_equal({ 1 => @user.name }, estimate.custom_fields.to_h { |f| [f.id, f.string_value] })
assert_nil estimate.doc_number.to_s[/\A\d+\z/]
end
def test_create_numbers_estimates_with_custom_transaction_numbers
stub_company(custom_txn_numbers: true)
Estimate.where(id: [9401, 9402]).delete_all
Estimate.create!(id: 9401, doc_number: '1068', customer_id: 9101)
Estimate.create!(id: 9402, doc_number: 'X-1', customer_id: 9101)
Writer.save(form, user: @user)
assert_equal '1069', @fake.created.first.doc_number
end
def test_create_with_discount
Writer.save(form(discount_value: '10'), user: @user)
estimate = @fake.created.first
discount = estimate.line_items.last
assert discount.discount_item?
assert_equal BigDecimal('36.2'), discount.amount
assert_equal BigDecimal('10'), discount.discount_line_detail.discount_percent
assert estimate.apply_tax_after_discount?
end
def test_needs_a_local_customer
error = assert_raises(Writer::Error) { Writer.save(form(customer_id: '424242'), user: @user) }
assert_equal I18n.t(:error_estimate_needs_customer), error.message
end
def test_update_keeps_line_ids_custom_fields_and_discount_account
remote = @fake.add(remote_estimate(lines: [qbo_sales_line(2, 10, 'Labor', 2, 120), qbo_discount_line(5, account: '86')]))
edited = Writer.form_from_remote(remote)
edited.lines.first.quantity = '3'
edited.lines << Form::Line.new(description: 'New note')
edited.custom_fields['2'] = 'NEWVIN'
edited.discount_type = 'amount'
edited.discount_value = '20'
Writer.save(edited, user: @user)
update = @fake.updated.first
assert_equal '598', update.id
assert_equal ['2', nil, nil], update.line_items.map(&:id)
assert_equal BigDecimal('360'), update.line_items.first.amount
assert_equal '86', update.line_items.last.discount_line_detail.discount_account_ref.value
fields = update.custom_fields.to_h { |f| [f.id, f.string_value] }
# The sales person isn't replaced by whoever edits it
assert_equal({ 1 => 'Ricky', 2 => 'NEWVIN' }, fields)
assert_nil update.billing_address
end
def test_changing_customer_copies_the_billing_address
other = local_customer(9102, 'Bob Builder')
remote = @fake.add(remote_estimate)
address = Quickbooks::Model::PhysicalAddress.new
address.line1 = '1 Main St'
@fake.customers['9102'] = Quickbooks::Model::Customer.new(billing_address: address)
edited = Writer.form_from_remote(remote)
edited.customer_id = other.id.to_s
Writer.save(edited, user: @user)
assert_equal '1 Main St', @fake.updated.first.billing_address.line1
end
def test_update_refuses_stale_billed_and_bundled_estimates
remote = @fake.add(remote_estimate)
stale = Writer.form_from_remote(remote)
stale.sync_token = '2'
assert_raises(Writer::Conflict) { Writer.save(stale, user: @user) }
remote.txn_status = 'Closed'
error = assert_raises(Writer::Error) { Writer.save(Writer.form_from_remote(remote), user: @user) }
assert_equal I18n.t(:error_estimate_billed), error.message
bundle = Quickbooks::Model::InvoiceLineItem.new
bundle.group_line_detail!
remote.txn_status = 'Pending'
remote.line_items = [qbo_sales_line(2, 10, 'Labor', 1, 1), bundle]
error = assert_raises(Writer::Error) { Writer.save(Writer.form_from_remote(remote).tap { |f| f.locked = nil }, user: @user) }
assert_equal I18n.t(:error_estimate_has_bundles), error.message
assert_raises(Writer::Error) { Writer.save(form.tap { |f| f.id = '999' }, user: @user) }
assert_empty @fake.updated
end
def test_rate_falls_back_to_the_item_price
Item.where(id: 11).delete_all
item = Item.new(id: 11, name: 'Brake pads', description: '', unit_price: 42)
item.skip_qbo_push = true
item.save!
Writer.save(form(lines: [Form::Line.new(item_id: '11', quantity: '2')]), user: @user)
assert_equal BigDecimal('84'), @fake.created.first.line_items.first.amount
end
def test_unsaved_answer_is_an_error
@fake.define_singleton_method(:create) { |_doc| nil }
error = assert_raises(Writer::Error) { Writer.save(form, user: @user) }
assert_equal I18n.t(:error_estimate_not_saved), error.message
end
# ---- accepting, emailing, custom fields ----
def test_accept_a_pending_estimate
@fake.add(remote_estimate)
@user.stubs(:today).returns(Date.new(2026, 11, 20))
result = Writer.accept(598, user: @user)
assert result.accepted?
update = @fake.updated.first
assert_equal 'Accepted', update.txn_status
assert_equal 'Jane Customer', update.accepted_by
assert_equal Date.new(2026, 11, 20), update.accepted_date
assert_equal 4, update.line_items.size
end
def test_accept_leaves_other_statuses_and_reports_failures
@fake.add(remote_estimate(status: 'Rejected'))
result = Writer.accept(598, user: @user)
assert_equal :unchanged, result.outcome
assert_equal 'Rejected', result.message
assert_empty @fake.updated
assert Writer.accept(999, user: @user).failed?
@fake.add(remote_estimate)
@fake.define_singleton_method(:update) { |_doc, sparse: false| raise Quickbooks::IntuitRequestException, 'Stale' }
result = Writer.accept(598, user: @user)
assert result.failed?
assert_equal 'Stale', result.message
end
def test_send_email
@fake.add(remote_estimate)
assert_equal '598', Writer.send_email(598, 'jane@example.com').id
assert_equal [%w[598 jane@example.com]], @fake.sent
assert_raises(Writer::Error) { Writer.send_email(999, 'jane@example.com') }
end
def test_custom_field_value
@fake.add(remote_estimate)
assert_equal '1C4HJXDG5JW123456', Writer.custom_field_value(598, 2)
assert_nil Writer.custom_field_value(598, 9)
assert_nil Writer.custom_field_value('', 2)
assert_nil Writer.custom_field_value(999, 2)
end
# ---- helpers ----
def test_subtotal_text
assert_equal 'Subtotal: $1,342.60', Writer.subtotal_text('1342.6')
assert_equal 'Subtotal: -$5.00', Writer.subtotal_text(-5)
assert_equal 'Subtotal: $1,000,000.00', Writer.subtotal_text(1_000_000)
end
def test_tidy_subtotals
lines = [Form::Line.new(kind: 'subtotal'), Form::Line.new(rate: '1'), Form::Line.new(kind: 'subtotal'),
Form::Line.new(kind: 'subtotal'), Form::Line.new(rate: '2')]
assert_equal [nil, 'subtotal', nil], Writer.tidy_subtotals(lines).map(&:kind)
end
def test_subtotals_total_their_own_section
Writer.save(form(lines: [Form::Line.new(item_id: '1', rate: '10'), Form::Line.new(description: 'Note'),
Form::Line.new(kind: 'subtotal'), Form::Line.new(item_id: '1', rate: '5'),
Form::Line.new(kind: 'subtotal')]), user: @user)
assert_equal ['Subtotal: $10.00', 'Subtotal: $5.00'],
@fake.created.first.line_items.map(&:description).grep(/Subtotal/)
end
def test_plain_number_and_format_address
assert_equal '2', Writer.plain_number(BigDecimal('2.0'))
assert_equal '12.5', Writer.plain_number('12.50')
assert_equal '', Writer.plain_number(nil)
address = Quickbooks::Model::PhysicalAddress.new
address.line1 = '1 Main St'
address.line2 = ' '
address.city = 'Providence'
address.country_sub_division_code = 'RI'
address.postal_code = '02903'
assert_equal "1 Main St\nProvidence, RI 02903", Writer.format_address(address)
assert_equal '', Writer.format_address(nil)
end
def test_time_activity_links
line = Quickbooks::Model::InvoiceLineItem.new
Writer.link_time_activity(line, '77')
assert_equal '77', Writer.linked_time_activity_id(line)
Writer.link_time_activity(line, '')
assert_equal '77', Writer.linked_time_activity_id(line)
end
def test_next_doc_number
Invoice.delete_all
assert_nil Writer.next_doc_number(Invoice)
end
end
+63
View File
@@ -0,0 +1,63 @@
#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.
require File.expand_path('../test_helper', __dir__)
class InvoiceStatusTest < ActiveSupport::TestCase
Status = RedmineQboBilling::InvoiceStatus
TODAY = Date.new(2026, 11, 20)
def status(total, balance, due: nil)
Status.status(total: total, balance: balance, due_date: due, today: TODAY)
end
def test_statuses
assert_nil status(100, nil)
assert_nil status(100, ' ')
assert_equal :voided, status(0, 0)
assert_equal :paid, status(100, 0)
assert_equal :paid, status(100, -5)
assert_equal :overdue, status(100, 40, due: TODAY - 1)
assert_equal :partial, status(100, 40, due: TODAY)
assert_equal :open, status(100, 100)
assert_equal :open, status('100.00', '100')
end
def test_bad_numbers_count_as_zero
assert_equal :voided, status('junk', '0')
assert_equal BigDecimal('0'), Status.to_d('abc')
assert_equal BigDecimal('0'), Status.to_d(nil)
end
def test_labels
paid_on = Date.new(2026, 11, 3)
assert_equal '', Status.label(nil)
assert_equal I18n.t(:label_invoice_status_open), Status.label(:open)
assert_equal I18n.t(:label_invoice_status_paid_on, date: I18n.l(paid_on)), Status.label(:paid, paid_on: paid_on)
assert_equal I18n.t(:label_invoice_status_paid), Status.label(:paid)
end
def test_short_label_counts_days_to_pay
assert_equal I18n.t(:label_invoice_status_paid_days, days: 3),
Status.short_label(:paid, paid_on: Date.new(2026, 11, 4), invoice_date: Date.new(2026, 11, 1))
# Paid the same day (or before the invoice): just "Paid"
assert_equal I18n.t(:label_invoice_status_paid),
Status.short_label(:paid, paid_on: Date.new(2026, 11, 1), invoice_date: Date.new(2026, 11, 1))
assert_equal I18n.t(:label_invoice_status_open), Status.short_label(:open, paid_on: Date.new(2026, 11, 4), invoice_date: Date.new(2026, 11, 1))
end
def test_title_and_days
assert_nil Status.title(:open, paid_on: TODAY)
assert_nil Status.title(:paid)
assert_equal I18n.t(:text_invoice_paid_in_full, date: I18n.l(TODAY)), Status.title(:paid, paid_on: TODAY)
assert_nil Status.days_to_pay(nil, TODAY)
assert_equal(-2, Status.days_to_pay(TODAY, TODAY - 2))
end
end
+285
View File
@@ -0,0 +1,285 @@
#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.
require File.expand_path('../test_helper', __dir__)
class InvoiceWriterTest < ActiveSupport::TestCase
include QboFakeServiceHelper
fixtures :projects, :users, :issues, :trackers, :issue_statuses, :enumerations
Writer = RedmineQboBilling::InvoiceWriter
Form = RedmineQboBilling::EstimateForm
def setup
@customer = local_customer
@fake = install_fake_quickbooks
stub_company
stub_local_syncs
Issue.where(estimate_id: [598, 599]).update_all(estimate_id: nil)
Invoice.where(id: [601, 602]).delete_all
@user = User.find(2)
@user.stubs(:today).returns(Date.new(2026, 11, 20))
end
def estimate(**options)
qbo_estimate(customer_name: 'Jane Customer', doc_number: '1068', status: 'Accepted',
custom_fields: [qbo_custom_field(1, 'Sales Rep', 'Ricky'), qbo_custom_field(2, 'VIN', '')],
lines: [qbo_sales_line(2, 10, 'Labor', 2, 120, taxable: false, description: 'Install #1: lift'),
qbo_sales_line(4, 11, 'Brake pads', 4, 30)], **options)
end
# Invoice #1234: $360 of lines plus $8.40 tax
def invoice(total: '368.40', balance: '368.40', **options)
doc = qbo_invoice(customer_name: 'Jane Customer', doc_number: '1234', total: total, balance: balance,
lines: [qbo_sales_line(1, 10, 'Labor', 2, 120, taxable: false), qbo_sales_line(2, 11, 'Brake pads', 4, 30)],
**options)
doc.txn_tax_detail = Quickbooks::Model::TransactionTaxDetail.new
doc.txn_tax_detail.total_tax = BigDecimal('8.40')
doc
end
def form(attrs = {})
Form.new({ document: 'invoice', customer_id: '9101', txn_date: '2026-11-20',
lines: [Form::Line.new(item_id: '10', quantity: '2', rate: '120')] }.merge(attrs))
end
def allow(*permissions)
@user.stubs(:allowed_to?).returns(false)
permissions.each { |p| @user.stubs(:allowed_to?).with(p, nil, global: true).returns(true) }
end
# ---- new invoices ----
def test_new_form
result = Writer.new_form(customer: @customer, user: @user)
assert result.invoice?
assert_equal '2026-11-20', result.txn_date
assert_equal 'Payment due on receipt', result.customer_memo
assert_equal @user.name, result.sales_person
end
def test_from_estimate
@fake.add(estimate(lines: [qbo_sales_line(2, 10, 'Labor', 2, 120), qbo_discount_line(24, percent: 10)]))
Issue.find(1).update_column(:estimate_id, 598)
RedmineQboBilling.expects(:field_defaults).with(@customer, issues: [Issue.find(1)]).returns('2' => 'VINFROMISSUE')
result = Writer.from_estimate(598, user: @user)
assert_equal '1068', result.converted_from
assert_equal ['598'], result.linked_estimate_ids
assert_equal 'Ricky', result.sales_person
assert_equal({ '2' => 'VINFROMISSUE', '1' => 'Ricky' }, result.custom_fields)
assert_equal '10', result.discount_value
assert_equal [nil], result.lines.map(&:id)
end
def test_from_estimate_refuses_billed_estimates
assert_raises(Writer::Error) { Writer.from_estimate(999, user: @user) }
Invoice.create!(id: 601, doc_number: '1234', customer_id: 9101, txn_date: Date.new(2026, 11, 12))
@fake.add(estimate(links: [qbo_link('Invoice', 601)]))
error = assert_raises(Writer::Error) { Writer.from_estimate(598, user: @user) }
assert_equal I18n.t(:error_estimate_already_invoiced, number: '1068', invoice: '1234'), error.message
end
def test_billing_error
assert_nil Writer.billing_error(estimate)
assert_equal I18n.t(:error_estimate_closed_billed, number: '1068', status: 'Closed'),
Writer.billing_error(estimate(status: 'Closed'))
assert_equal I18n.t(:error_estimate_rejected, number: '1068'), Writer.billing_error(estimate(status: 'Rejected'))
assert_equal I18n.t(:error_estimate_already_invoiced, number: '1068', invoice: '777'),
Writer.billing_error(estimate(links: [qbo_link('Invoice', 777)]))
end
# ---- reading ----
def test_form_from_remote
result = Writer.form_from_remote(invoice(balance: '100', links: [qbo_link('Estimate', 598), qbo_link('Payment', 9)]))
assert result.invoice?
assert_equal '1234', result.doc_number
assert_equal ['598'], result.linked_estimate_ids
assert_equal BigDecimal('268.40'), result.amount_paid
assert_equal :paid, result.locked
assert_nil Writer.form_from_remote(invoice).locked
end
def test_paid_helpers
assert_not Writer.paid?(invoice)
assert_not Writer.paid?(qbo_invoice)
assert Writer.paid?(invoice(balance: '100'))
assert_not Writer.fully_paid?(invoice(balance: '100'))
assert Writer.fully_paid?(invoice(balance: '0'))
assert_equal BigDecimal('0'), Writer.amount_paid(invoice)
end
def test_estimated_total_scales_the_tax
remote = invoice
assert_equal BigDecimal('368.40'), Writer.estimated_total(form(lines: [Form::Line.new(item_id: '1', rate: '360')]), remote)
assert_equal BigDecimal('184.20'), Writer.estimated_total(form(lines: [Form::Line.new(item_id: '1', rate: '180')]), remote)
remote.txn_tax_detail.total_tax = 0
assert_equal BigDecimal('180'), Writer.estimated_total(form(lines: [Form::Line.new(item_id: '1', rate: '180')]), remote)
end
# ---- saving ----
def test_create_closes_its_estimates_and_credits_their_sales_person
@fake.add(estimate)
Writer.save(form(linked_estimate_ids: ['598']), user: @user)
created = @fake.created.first
assert_equal({ 1 => 'Ricky' }, created.custom_fields.to_h { |f| [f.id, f.string_value] })
assert_equal [%w[Estimate 598]], created.linked_transactions.map { |t| [t.txn_type, t.txn_id] }
closed = @fake.updated.first
assert_equal ['598', 'Closed'], [closed.id, closed.txn_status]
end
def test_create_refuses_an_estimate_billed_meanwhile
@fake.add(estimate(status: 'Converted'))
assert_raises(Writer::Error) { Writer.save(form(linked_estimate_ids: ['598']), user: @user) }
assert_empty @fake.created
assert_raises(Writer::Error) { Writer.save(form(linked_estimate_ids: ['999']), user: @user) }
end
def test_create_with_time_and_due_date
Writer.save(form(due_date: '2026-12-20', lines: [Form::Line.new(item_id: '10', quantity: '1.5', rate: '120',
time_activity_id: '77', description: 'Install #1: lift')]),
user: @user)
created = @fake.created.first
assert_equal Date.new(2026, 12, 20), created.due_date
assert_equal [%w[TimeActivity 77]], created.linked_transactions.map { |t| [t.txn_type, t.txn_id] }
assert_equal '77', created.line_items.first.linked_transactions.first.txn_id
assert_equal @user.name, created.custom_fields.first.string_value
end
def test_update_keeps_payment_links
remote = @fake.add(invoice(links: [qbo_link('Estimate', 598), qbo_link('Payment', 9), qbo_link('TimeActivity', 5)]))
@fake.add(estimate(status: 'Closed'))
edited = Writer.form_from_remote(remote)
Writer.save(edited, user: @user)
update = @fake.updated.first
assert_equal [%w[Estimate 598], %w[Payment 9]], update.linked_transactions.map { |t| [t.txn_type, t.txn_id] }
# Already closed: left alone
assert_equal 1, @fake.updated.size
end
def test_paid_invoice_needs_unlocking_and_permission
remote = @fake.add(invoice(balance: '0'))
edited = Writer.form_from_remote(remote)
error = assert_raises(Writer::Error) { Writer.save(edited, user: @user) }
assert_equal I18n.t(:error_invoice_paid), error.message
allow(:write_invoices, :edit_partially_paid_invoices)
error = assert_raises(Writer::Error) { Writer.save(edited, user: @user, unlock: true) }
assert_equal I18n.t(:error_invoice_paid_not_allowed), error.message
allow(:write_invoices, :edit_paid_invoices)
Writer.save(edited, user: @user, unlock: true)
assert_equal 1, @fake.updated.size
end
def test_unlocked_invoice_cannot_drop_below_what_was_paid
allow(:write_invoices, :edit_paid_invoices)
remote = @fake.add(invoice(balance: '0'))
edited = Writer.form_from_remote(remote)
edited.discount_type = 'amount'
edited.discount_value = '50'
error = assert_raises(Writer::Error) { Writer.save(edited, user: @user, unlock: true) }
assert_match '$368.40', error.message
end
def test_update_refuses_stale_and_bundled_invoices
remote = @fake.add(invoice)
stale = Writer.form_from_remote(remote)
stale.sync_token = '1'
assert_raises(Writer::Conflict) { Writer.save(stale, user: @user) }
bundle = Quickbooks::Model::InvoiceLineItem.new
bundle.group_line_detail!
remote.line_items = [bundle]
assert_raises(Writer::Error) { Writer.save(Writer.form_from_remote(remote).tap { |f| f.lines = form.lines }, user: @user) }
assert_raises(Writer::Error) { Writer.save(form(id: '999'), user: @user) }
assert_raises(Writer::Error) { Writer.save(form(customer_id: '424242'), user: @user) }
end
def test_close_estimates_survives_errors
@fake.add(estimate)
@fake.define_singleton_method(:update) { |_doc, sparse: false| raise StandardError, 'down' }
assert_nothing_raised { Writer.close_estimates(%w[598 598 999]) }
end
def test_send_email
@fake.add(invoice)
Writer.send_email(601, 'jane@example.com')
assert_equal [%w[601 jane@example.com]], @fake.sent
assert_raises(Writer::Error) { Writer.send_email(999, 'x@example.com') }
end
def test_estimate_sales_person
@fake.add(estimate(id: 598, custom_fields: []))
@fake.add(estimate(id: 599))
assert_equal 'Ricky', Writer.estimate_sales_person(%w[598 599])
assert_nil Writer.estimate_sales_person([])
stub_company(custom_fields: [{ id: 2, name: 'VIN' }])
assert_nil Writer.estimate_sales_person(%w[599])
end
def test_invoice_number
assert_equal '601', Writer.invoice_number(601)
Invoice.create!(id: 601, doc_number: '1234', customer_id: 9101, txn_date: Date.new(2026, 11, 12))
assert_equal '1234', Writer.invoice_number('601')
end
# ---- importing ----
def time_activity(id, hours: nil, minutes: nil, status: 'Billable', customer_id: 9101, start: nil, finish: nil)
activity = Quickbooks::Model::TimeActivity.new
activity.id = id.to_s
activity.txn_date = '2026-11-18'
activity.customer_ref = qbo_ref(customer_id)
activity.employee_ref = qbo_ref(3, 'Tech One')
activity.item_ref = qbo_ref(10, 'Labor')
activity.hourly_rate = '120'
activity.hours = hours
activity.minutes = minutes
activity.start_time = start
activity.end_time = finish
activity.billable_status = status
activity.description = 'Install #1: lift kit'
activity
end
def test_activity_hours
assert_equal BigDecimal('1.5'), Writer.activity_hours(time_activity(1, hours: 1, minutes: 30))
timed = time_activity(2, start: DateTime.new(2026, 11, 18, 8), finish: DateTime.new(2026, 11, 18, 10, 30))
timed.break_minutes = 30
assert_equal BigDecimal('2'), Writer.activity_hours(timed)
assert_equal BigDecimal('0'), Writer.activity_hours(time_activity(3))
end
def test_import_options
@fake.query_results = {
'FROM TimeActivity' => [time_activity(71, hours: 2), time_activity(72, hours: 1, status: 'HasBeenBilled'),
time_activity(73, hours: 1, customer_id: 9999)],
'FROM Estimate' => [estimate(id: 598, status: 'Pending'), estimate(id: 599, status: 'Closed')]
}
Issue.find(2).update_column(:estimate_id, 598)
result = Writer.import_options(@customer, issue_ids: [3])
assert_equal ['71'], result[:time_activities].map { |t| t[:id] }
time = result[:time_activities].first
assert_equal ['1', '2', '120', '240.0', 'Tech One', false], time.values_at(:issue_id, :quantity, :rate, :amount, :employee, :taxable)
assert_equal ['598'], result[:estimates].map { |e| e[:id] }
open = result[:estimates].first
assert_equal '1', open[:issue_id]
assert_match '#2:', open[:issue]
assert_equal 2, open[:lines].size
assert_kind_of Hash, result[:issue_values]
end
def test_time_falls_back_to_recent_time
@fake.fail_query = /CustomerRef/
@fake.query_results = { 'TxnDate >=' => [time_activity(71, hours: 2)] }
assert_equal ['71'], Writer.open_time_activities(@customer).map { |t| t[:id] }
end
end
+66
View File
@@ -0,0 +1,66 @@
#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.
require File.expand_path('../test_helper', __dir__)
class IssueValuesTest < ActiveSupport::TestCase
fixtures :projects, :users, :issues, :trackers, :issue_statuses, :enumerations
Values = RedmineQboBilling::IssueValues
Form = RedmineQboBilling::EstimateForm
def form(lines, attrs = {})
Form.new({ lines: lines.map { |l| Form::Line.new(l) } }.merge(attrs))
end
def test_issue_reference_reads_the_first_line
assert_equal '116', Values.issue_reference("Install #116: lift kit\nmore #200: text")
assert_nil Values.issue_reference('no reference')
assert_nil Values.issue_reference(nil)
end
def test_issue_ids_from_time_lines_added_from_notes_and_linked_estimates
Issue.find(3).update_column(:estimate_id, 777)
doc = form([{ description: 'Install #1: lift', time_activity_id: '55', rate: '1' },
{ description: 'Added from: Repair #2: brakes' },
{ description: 'Mentions #5: but not imported', rate: '1' },
{ description: 'Subtotal #6: x', kind: 'subtotal', time_activity_id: '9' }],
document: 'invoice', linked_estimate_ids: ['777'])
assert_equal %w[1 2 3], Values.issue_ids(doc).sort
assert_equal [1, 2, 3], Values.issues(doc).map(&:id).sort
end
def test_saved_estimate_counts_its_own_issues
Issue.find(4).update_column(:estimate_id, 888)
assert_equal ['4'], Values.issue_ids(form([], id: '888'))
assert_equal [], Values.issue_ids(form([]))
assert_equal [], Values.issues(form([]))
end
def test_values_merge_plugins_and_drop_blanks
Redmine::Hook.stubs(:call_hook).with(:qbo_billing_issue_values, anything)
.returns([{ 2 => { 1 => 'VIN1', 2 => ' ' } }, 'junk', { '2' => { 3 => 'VIN3' }, '4' => 'not a hash' }])
issues = Issue.where(id: [1, 2, 3]).to_a
assert_equal({ '2' => { '1' => 'VIN1', '3' => 'VIN3' } }, Values.values_for(issues))
assert_equal({ '1' => { '2' => 'VIN1' }, '3' => { '2' => 'VIN3' } }, Values.by_issue(issues))
assert_equal({}, Values.values_for([]))
end
def test_plugin_errors
Redmine::Hook.stubs(:call_hook).with(:qbo_billing_validate, has_entries(document: 'invoice'))
.returns([['Two vehicles', nil], '', 'Other'])
assert_equal ['Two vehicles', 'Other'], Values.plugin_errors(form([], document: 'invoice'))
end
def test_a_failing_plugin_does_not_stop_the_save
Redmine::Hook.stubs(:call_hook).raises(StandardError, 'boom')
assert_equal [], Values.plugin_errors(form([]))
end
end
+56
View File
@@ -0,0 +1,56 @@
#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.
require File.expand_path('../test_helper', __dir__)
# Estimates linked to an issue are read-only unless unlocked by a user with "Edit estimates linked to issues"
class LinkedEstimateUnlockTest < ActiveSupport::TestCase
Writer = RedmineQboBilling::EstimateWriter
def user(*permissions)
user = User.new
user.stubs(:allowed_to?).returns(false)
permissions.each { |p| user.stubs(:allowed_to?).with(p, nil, global: true).returns(true) }
user
end
def form(linked:)
Writer.stubs(:linked_issues).with('701').returns(stub(exists?: linked))
RedmineQboBilling::EstimateForm.new.tap { |f| f.id = '701' }
end
def test_editor_needs_write_estimates_and_edit_linked_estimates
assert RedmineQboBilling.linked_estimate_editor?(user(:write_estimates, :edit_linked_estimates))
assert_not RedmineQboBilling.linked_estimate_editor?(user(:write_estimates))
assert_not RedmineQboBilling.linked_estimate_editor?(user(:edit_linked_estimates))
end
def test_unlinked_estimate_saves_without_unlocking
assert_nothing_raised { Writer.check_linked(form(linked: false), false, user(:write_estimates)) }
end
def test_linked_estimate_is_locked_without_unlock
error = assert_raises(Writer::Error) do
Writer.check_linked(form(linked: true), false, user(:write_estimates, :edit_linked_estimates))
end
assert_equal I18n.t(:error_estimate_linked_to_issues), error.message
end
def test_unlock_needs_the_permission
error = assert_raises(Writer::Error) { Writer.check_linked(form(linked: true), true, user(:write_estimates)) }
assert_equal I18n.t(:error_estimate_linked_not_allowed), error.message
end
def test_unlocked_by_an_editor_saves
assert_nothing_raised do
Writer.check_linked(form(linked: true), true, user(:write_estimates, :edit_linked_estimates))
end
end
end
+81
View File
@@ -0,0 +1,81 @@
#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.
require File.expand_path('../test_helper', __dir__)
# LaborItems and ManHours
class ManHoursTest < ActiveSupport::TestCase
def ref(id, name)
Quickbooks::Model::BaseReference.new(id.to_s, name: name)
end
def sales_line(item_id, name, quantity)
line = Quickbooks::Model::InvoiceLineItem.new
line.sales_item! do |d|
d.item_ref = ref(item_id, name)
d.quantity = BigDecimal(quantity.to_s)
end
line
end
def invoice(*lines)
Quickbooks::Model::Invoice.new.tap { |i| i.line_items = lines }
end
def test_ids_from_settings
assert_equal %w[1 2], RedmineQboBilling::LaborItems.ids('labor_item_ids' => [1, '2', '', '1'])
assert_equal [], RedmineQboBilling::LaborItems.ids({})
end
def test_match_by_id_or_name
labor = RedmineQboBilling::LaborItems
assert labor.match?(ref(5, 'Anything'), ids: ['5'])
assert_not labor.match?(ref(6, 'Labor'), ids: ['5'])
assert labor.match?(ref(6, 'Labor'), ids: [])
assert labor.match?(ref(6, 'Services:labor'), ids: [])
assert_not labor.match?(ref(6, 'Laborious part'), ids: [])
assert_not labor.match?(nil, ids: [])
assert_not labor.name_matches?(' ', ['Labor'])
assert labor.name_matches?('Shop Labor', ['shop labor'])
end
def test_item_ids_and_names_fall_back_to_matching_names
Setting.stubs(:plugin_redmine_qbo).returns({})
Item.stubs(:sellable).returns(stub(pluck: [[11, 'Labor'], [12, 'Brake pads'], [13, 'Shop:Labor']]))
assert_equal %w[11 13], RedmineQboBilling::LaborItems.item_ids
assert_equal ['Labor'], RedmineQboBilling::LaborItems.names
end
def test_chosen_item_ids_and_names
Setting.stubs(:plugin_redmine_qbo).returns('labor_item_ids' => ['21'])
assert_equal ['21'], RedmineQboBilling::LaborItems.item_ids
Item.stubs(:where).with(id: ['21']).returns(stub(pluck: []))
assert_equal ['21'], RedmineQboBilling::LaborItems.names
end
def test_hours_by_name
Setting.stubs(:plugin_redmine_qbo).returns({})
doc = invoice(sales_line(1, 'Labor', 2.5), sales_line(2, 'Brake pads', 4), sales_line(1, 'Labor', '1.25'))
assert_equal 3.75, RedmineQboBilling::ManHours.hours(doc)
end
def test_hours_by_id_include_bundles
bundle = Quickbooks::Model::InvoiceLineItem.new
bundle.group_line_detail!
bundle.group_line_detail.line_items = [sales_line(9, 'Install', 3), sales_line(2, 'Part', 1)]
doc = invoice(bundle, sales_line(9, 'Install', 1))
assert_equal 4.0, RedmineQboBilling::ManHours.hours(doc, item_ids: ['9'])
end
def test_hours_of_nothing
assert_equal 0.0, RedmineQboBilling::ManHours.hours(nil)
assert_equal 0.0, RedmineQboBilling::ManHours.hours(invoice, item_ids: ['9'])
end
end
+202
View File
@@ -0,0 +1,202 @@
#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.
require File.expand_path('../test_helper', __dir__)
class PaymentWriterTest < ActiveSupport::TestCase
include QboFakeServiceHelper
fixtures :users
Writer = RedmineQboBilling::PaymentWriter
Form = RedmineQboBilling::PaymentForm
def setup
@customer = local_customer
@fake = install_fake_quickbooks
stub_local_syncs
Invoice.where(id: [601, 602, 603]).delete_all
@fake.query_results = { 'FROM Invoice' => [open_invoice(603, '1236', '2026-11-12', 50),
open_invoice(601, '1234', '2026-11-01', 100),
open_invoice(602, '1235', '2026-11-01', 200),
open_invoice(604, '1237', '2026-11-02', 0)] }
end
def open_invoice(id, number, date, balance)
qbo_invoice(id: id, doc_number: number, txn_date: Date.parse(date), total: 300, balance: balance)
end
def form(attrs = {})
Form.from_params({ 'customer_id' => '9101', 'txn_date' => '2026-11-20', 'payment_method_id' => '2',
'amount' => '250' }.merge(attrs))
end
def payment(id: 801, total: 250, applied: { '601' => 100, '602' => 150 }, others: [])
doc = Quickbooks::Model::Payment.new
doc.id = id.to_s
doc.sync_token = 2
doc.customer_ref = qbo_ref(9101, 'Jane Customer')
doc.txn_date = Date.new(2026, 11, 15)
doc.total = BigDecimal(total.to_s)
doc.payment_method_ref = qbo_ref(2, 'Check')
doc.payment_ref_number = '1042'
lines = applied.map do |invoice_id, amount|
Quickbooks::Model::Line.new.tap do |line|
line.amount = BigDecimal(amount.to_s)
line.invoice_id = invoice_id
end
end
others.each do |type|
lines << Quickbooks::Model::Line.new.tap do |line|
line.amount = 5
line.linked_transactions = [qbo_link(type, 9)]
end
end
doc.line_items = lines
@fake.add(doc)
end
def applied(doc)
doc.line_items.map { |l| [l.linked_transactions.first.txn_id, l.amount] }
end
def test_new_form
user = User.find(2)
user.stubs(:today).returns(Date.new(2026, 11, 20))
result = Writer.new_form(customer: @customer, user: user)
assert_equal ['9101', 'Jane Customer', '2026-11-20'], [result.customer_id.to_s, result.customer_name, result.txn_date]
end
def test_open_invoices_oldest_first
list = Writer.open_invoices(@customer)
assert_equal %w[1234 1235 1236], list.map { |i| i[:doc_number] }
assert_equal '100.0', list.first[:balance]
end
def test_allocate
invoices = [{ id: 'a', balance: '100' }, { id: 'b', balance: '0' }, { id: 'c', balance: '200' }]
result, left = Writer.allocate(BigDecimal('150'), invoices)
assert_equal [['a', BigDecimal('100')], ['c', BigDecimal('50')]], result.map { |i, take| [i[:id], take] }
assert_equal BigDecimal('0'), left
assert_equal BigDecimal('100'), Writer.allocate(400, invoices).last
end
def test_save_applies_oldest_first
saved = Writer.save(form)
assert_equal [['601', BigDecimal('100')], ['602', BigDecimal('150')]], applied(saved)
assert_equal BigDecimal('250'), saved.total
assert_equal '2', saved.payment_method_ref.value
assert_nil saved.payment_ref_number
assert_nil saved.private_note
end
def test_save_to_ticked_invoices_with_credit_left_over
saved = Writer.save(form('invoice_ids' => ['603'], 'amount' => '80', 'reference' => '1042', 'memo' => 'Deposit'))
assert_equal [['603', BigDecimal('50')]], applied(saved)
assert_equal '1042', saved.payment_ref_number
assert_equal 'Deposit', saved.private_note
end
def test_deposit_stays_unapplied
saved = Writer.save(form('deposit' => '1'))
assert_empty saved.line_items
end
def test_save_needs_a_customer_and_an_answer
assert_raises(Writer::Error) { Writer.save(form('customer_id' => '424242')) }
@fake.define_singleton_method(:create) { |_doc| nil }
error = assert_raises(Writer::Error) { Writer.save(form) }
assert_equal I18n.t(:error_payment_not_saved), error.message
end
def test_load_form
payment
result = Writer.load_form(801)
assert result.persisted?
assert_equal %w[601 602], result.invoice_ids
assert_equal '250.0', result.amount
assert_equal '0', result.deposit
assert_equal '1042', result.reference
assert_nil result.locked
assert_raises(Writer::Error) { Writer.load_form(999) }
end
def test_update_unchanged_keeps_amounts
payment
edited = Writer.load_form(801)
edited.memo = 'Edited'
saved = Writer.save(edited)
assert_equal [['601', BigDecimal('100')], ['602', BigDecimal('150')]], applied(saved)
assert_equal 'Edited', saved.private_note
end
def test_update_with_a_new_amount_spreads_it_again
payment(applied: { '602' => 200 }, total: 200)
edited = Writer.load_form(801)
edited.amount = '120'
edited.invoice_ids = []
saved = Writer.save(edited)
# What this payment paid on 602 counts as open again
assert_equal [['601', BigDecimal('100')], ['602', BigDecimal('20')]], applied(saved)
end
def test_update_refusals
payment
stale = Writer.load_form(801)
stale.sync_token = '1'
assert_raises(Writer::Conflict) { Writer.save(stale) }
payment(others: ['CreditMemo'])
error = assert_raises(Writer::Error) { Writer.save(Writer.load_form(801)) }
assert_equal I18n.t(:error_payment_not_editable, types: 'CreditMemo'), error.message
assert_raises(Writer::Error) { Writer.save(form.tap { |f| f.id = '999' }) }
end
def test_payment_methods
@fake.query_results = { 'PaymentMethod' => [
Quickbooks::Model::PaymentMethod.new(id: 2, name: 'Check', active: true),
Quickbooks::Model::PaymentMethod.new(id: 1, name: 'cash', active: true),
Quickbooks::Model::PaymentMethod.new(id: 3, name: 'Old card', active: false)
] }
assert_equal [%w[cash 1], %w[Check 2]], Writer.payment_methods
end
def test_payment_methods_survive_errors
QboConnectionService.stubs(:with_qbo_service).raises(StandardError, 'down')
assert_equal [], Writer.payment_methods
end
def test_customer_payments_and_totals
old = payment(id: 801)
old.txn_date = Date.new(2026, 10, 1)
old.unapplied_amount = 0
recent = payment(id: 802, total: 100, applied: {})
recent.unapplied_amount = 100
@fake.query_results = { 'FROM Payment' => [old, recent] }
list = Writer.customer_payments(@customer)
assert_equal %w[802 801], list.map(&:id)
assert_equal({ received: BigDecimal('350'), unapplied: BigDecimal('100') }, Writer.payment_totals(list))
end
def test_payment_method_name
doc = payment
assert_equal 'Check', Writer.payment_method_name(doc)
doc.payment_method_ref = qbo_ref(7)
Writer.stubs(:payment_methods).returns([%w[Visa 7]])
assert_equal 'Visa', Writer.payment_method_name(doc)
doc.payment_method_ref = nil
assert_equal '', Writer.payment_method_name(doc)
end
def test_pdf
@fake.pdf_body = '%PDF-1.4'
assert_equal '%PDF-1.4', Writer.pdf(801)
end
end
+114
View File
@@ -0,0 +1,114 @@
#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.
require File.expand_path('../test_helper', __dir__)
# The QuickBooks connection (Qbo), its OAuth token handling (QuickbooksOauth) and QboConnectionService
class QboConnectionTest < ActiveSupport::TestCase
def setup
Qbo.delete_all
end
def connection
Qbo.create!(oauth2_access_token: 'access', oauth2_refresh_token: 'refresh', realm_id: '123')
end
def test_only_one_connection
connection
assert_not Qbo.new(realm_id: '456').valid?
end
def test_current_needs_a_connection
assert_raises(RuntimeError) { QboConnectionService.current! }
record = connection
assert_equal record, QboConnectionService.current!
end
def test_with_qbo_service_needs_an_entity
connection
assert_raises(RuntimeError) { QboConnectionService.with_qbo_service { |_s| nil } }
end
def test_with_qbo_service_builds_the_service
record = connection
record.class.any_instance.stubs(:perform_authenticated_request).yields(record.oauth_access_token)
service = nil
QboConnectionService.with_qbo_service(entity: 'Invoice') { |s| service = s }
assert_kind_of Quickbooks::Service::Invoice, service
assert_equal '123', service.company_id
end
def test_last_sync_and_expiry_without_a_connection
assert_equal I18n.t(:label_qbo_never_synced), Qbo.last_sync
assert_nil Qbo.oauth2_access_token_expires_at
assert_nil Qbo.oauth2_refresh_token_expires_at
end
def test_update_time_stamp
record = connection
Qbo.update_time_stamp
assert_in_delta Time.now.to_i, record.reload.last_sync.to_i, 5
assert_not_equal I18n.t(:label_qbo_never_synced), Qbo.last_sync
end
def test_authenticated_request_refreshes_and_retries
record = connection
record.expects(:refresh_token!).twice
attempts = 0
result = record.perform_authenticated_request do |token|
attempts += 1
raise Quickbooks::AuthorizationFailure if attempts < 3
token.token
end
assert_equal 'access', result
end
def test_authenticated_request_gives_up
record = connection
record.stubs(:refresh_token!)
error = assert_raises(RuntimeError) do
record.perform_authenticated_request { |_token| raise Quickbooks::AuthorizationFailure }
end
assert_equal 'QuickbooksOauth:ExceededAuthAttempts', error.message
end
def test_refresh_token_saves_the_new_tokens
record = connection
refreshed = OAuth2::AccessToken.new(record.oauth_client, 'new-access', refresh_token: 'new-refresh',
expires_at: 1.hour.from_now.to_i, 'x_refresh_token_expires_in' => 8_640_000)
OAuth2::AccessToken.any_instance.stubs(:refresh!).returns(refreshed)
record.refresh_token!
record.reload
assert_equal %w[new-access new-refresh], [record.oauth2_access_token, record.oauth2_refresh_token]
assert_in_delta 100.days.from_now.to_i, record.oauth2_refresh_token_expires_at.to_i, 5
end
def test_oauth_client_follows_the_settings
Setting.stubs(:plugin_redmine_qbo).returns({ 'oauth_consumer_key' => 'key', 'oauth_consumer_secret' => 'secret',
'sandbox' => '1' }.with_indifferent_access)
client = Qbo.construct_oauth2_client
assert_equal 'key', client.id
assert Quickbooks.sandbox_mode
url = QboOauthService.authorization_url(callback_url: 'https://redmine.example/qbo/oauth_callback', state: 'abc')
assert_match 'state=abc', url
assert_match 'scope=com.intuit.quickbooks.accounting', url
ensure
Quickbooks.sandbox_mode = false
end
def test_replace_swaps_the_connection
connection
Qbo.any_instance.stubs(:refresh_token!)
replaced = QboConnectionService.replace!(token: 't', refresh_token: 'r', realm_id: '999')
assert_equal [replaced.id], Qbo.pluck(:id)
assert_equal '999', replaced.realm_id
end
end
+112
View File
@@ -0,0 +1,112 @@
#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.
require File.expand_path('../test_helper', __dir__)
# Estimate, Invoice and Payment: the local QuickBooks caches, and their events on the activity page (QboActivity)
class QboDocumentsTest < ActiveSupport::TestCase
fixtures :users
CUSTOMER_ID = 9301
def setup
Estimate.where(id: [9401, 9402]).delete_all
Invoice.where(id: [9501, 9502, 9503]).delete_all
Payment.where(id: [9601]).delete_all
Customer.where(id: CUSTOMER_ID).delete_all
customer = Customer.new(id: CUSTOMER_ID, name: 'Jane Customer')
customer.skip_qbo_push = true
customer.save!
end
def estimate(id, attrs = {})
Estimate.create!({ id: id, doc_number: "E#{id}", customer_id: CUSTOMER_ID, txn_date: Date.new(2026, 11, 10),
total_amount: 1250, txn_status: 'Pending' }.merge(attrs))
end
def invoice(id, attrs = {})
Invoice.create!({ id: id, doc_number: id.to_s, customer_id: CUSTOMER_ID, txn_date: Date.new(2026, 11, 10),
total_amount: 1250, balance: 1250, due_date: Date.new(2026, 12, 10) }.merge(attrs))
end
def user(*permissions)
user = User.find(2)
user.stubs(:allowed_to?).returns(false)
permissions.each { |p| user.stubs(:allowed_to?).with(p, nil, global: true).returns(true) }
user
end
def test_estimate
record = estimate(9401)
assert_equal 'E9401', record.to_s
assert_equal 'E9401', record.name
assert_not record.billed?
RedmineQboBilling::EstimateWriter::BILLED_STATUSES.each do |status|
assert estimate(9402, txn_status: status).billed?, status
Estimate.where(id: 9402).delete_all
end
assert_not Estimate.new(id: 9402).valid?
end
def test_invoice_status_and_activity_description
today = Date.new(2026, 11, 20)
assert_equal :open, invoice(9501).status(today: today)
partial = invoice(9502, balance: 400)
assert_equal :partial, partial.status(today: today)
User.current.stubs(:today).returns(today)
assert_equal "$1,250.00 · #{I18n.t(:label_invoice_status_partial)} · #{I18n.t(:text_activity_invoice_owed, amount: '$400.00')}",
partial.activity_description
assert_equal "$1,250.00 · #{I18n.t(:label_invoice_status_open)}", Invoice.find(9501).activity_description
unknown = invoice(9503, balance: nil)
assert_nil unknown.status
assert_equal '$1,250.00', unknown.activity_description
assert_equal '9503', unknown.to_s
end
def test_payment_activity_description
payment = Payment.create!(id: 9601, customer_id: CUSTOMER_ID, txn_date: Date.new(2026, 11, 2),
total_amount: 500, unapplied_amount: 0)
assert_equal '', payment.activity_description
payment.unapplied_amount = 150
assert_equal I18n.t(:text_activity_payment_unapplied, amount: '$150.00'), payment.activity_description
assert_equal '2026-11-02 500.0', payment.to_s
end
def test_activity_needs_a_permission_and_no_project
estimate(9401)
assert_equal [], Estimate.find_events('qbo_estimates', user, nil, nil, {})
viewer = user(:view_customers)
assert_equal [9401], Estimate.find_events('qbo_estimates', viewer, nil, nil, {}).map(&:id)
assert_equal [], Estimate.find_events('qbo_estimates', viewer, nil, nil, project: Project.new)
assert_equal [], Estimate.find_events('qbo_estimates', viewer, nil, nil, author: viewer)
assert_equal({ 'qbo_estimates' => { permission: :view_customers } }, Estimate.activity_provider_options)
assert Payment.qbo_activity_visible_to?(user(:receive_payments))
end
def test_activity_by_quickbooks_date
estimate(9401, txn_date: Date.new(2026, 11, 10))
estimate(9402, txn_date: Date.new(2026, 11, 12))
viewer = user(:write_estimates)
found = Estimate.find_events('qbo_estimates', viewer, Date.new(2026, 11, 11), Date.new(2026, 11, 13), {})
assert_equal [9402], found.map(&:id)
assert_equal [9402], Estimate.find_events('qbo_estimates', viewer, nil, nil, limit: 1).map(&:id)
end
def test_activity_datetime
record = estimate(9401, txn_date: Date.new(2026, 11, 10))
assert_equal Time.local(2026, 11, 10, 12), record.activity_datetime
record.txn_date = record.created_at.getlocal.to_date
assert_equal record.created_at, record.activity_datetime
assert_equal 'Jane Customer', record.activity_customer
assert_nil record.project
assert_nil record.activity_money(nil)
assert_equal I18n.t(:label_none), Estimate.new.activity_customer
end
end
+67
View File
@@ -0,0 +1,67 @@
#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.
require File.expand_path('../test_helper', __dir__)
class QboDraftTest < ActiveSupport::TestCase
fixtures :users
def setup
QboDraft.delete_all
end
def draft(document, fields = {})
QboDraft.create!(document: document, fields: fields)
end
def test_document_must_be_known
assert_not QboDraft.new(document: 'payment').valid?
assert QboDraft.new(document: 'invoice').valid?
end
def test_fields_round_trip_and_bad_data
record = draft('estimate', 'customer_name' => 'Jane', 'lines' => { '0' => { 'rate' => '10', 'item_id' => '1' } })
assert_equal 'Jane', record.reload.fields['customer_name']
record.data = 'not json'
assert_equal({}, record.fields)
record.data = '[1, 2]'
assert_equal({}, record.fields)
record.data = nil
assert_equal({}, record.fields)
end
def test_form_subtotal_and_line_count
record = draft('invoice', 'lines' => { '0' => { 'item_id' => '1', 'quantity' => '2', 'rate' => '10' },
'1' => { 'kind' => 'subtotal' }, '2' => { 'description' => 'Note' },
'3' => {} })
assert record.invoice?
assert record.form.invoice?
assert_equal BigDecimal('20'), record.subtotal
assert_equal 2, record.line_count
end
def test_customer_name_falls_back_to_the_typed_name
assert_equal 'Typed Name', draft('estimate', 'customer_name' => 'Typed Name').customer_name
assert_nil draft('estimate').customer_name
end
def test_visible_by_permission
estimate = draft('estimate')
invoice = draft('invoice')
user = User.find(2)
user.stubs(:allowed_to?).returns(false)
assert_empty QboDraft.visible(user)
user.stubs(:allowed_to?).with(:write_estimates, nil, global: true).returns(true)
assert_equal [estimate], QboDraft.visible(user).to_a
user.stubs(:allowed_to?).with(:write_invoices, nil, global: true).returns(true)
assert_equal [estimate, invoice], QboDraft.visible(user).order(:id).to_a
assert_equal [invoice], QboDraft.for_document(:invoice).to_a
end
end
+190
View File
@@ -0,0 +1,190 @@
#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.
require File.expand_path('../test_helper', __dir__)
# RefundGateway's QuickBooks calls, the refund email, and the smaller QuickBooks helpers: the services' query
# string and emailing, invoice lines' LinkedTxn, combined PDFs and attaching invoices to issues
class QboHelpersTest < ActiveSupport::TestCase
include QboFakeServiceHelper
fixtures :projects, :users, :email_addresses, :members, :member_roles, :roles, :issues, :trackers,
:projects_trackers, :issue_statuses, :enabled_modules, :enumerations, :journals, :journal_details
def setup
@customer = local_customer
@fake = install_fake_quickbooks
stub_local_syncs
@gateway = RedmineQboBilling::RefundGateway.new
end
def payment(id, unapplied, date, lines: [])
doc = Quickbooks::Model::Payment.new(txn_date: date, total: BigDecimal('500'), unapplied_amount: BigDecimal(unapplied.to_s),
customer_ref: qbo_ref(9101))
doc.id = id.to_s
doc.sync_token = 1
doc.line_items = lines
doc
end
# ---- RefundGateway ----
def test_unapplied_payments_oldest_first
@fake.query_results = { 'FROM Payment' => [payment(52, 100, Date.new(2026, 11, 5)), payment(50, 0, Date.new(2026, 11, 1)),
payment(51, 200, Date.new(2026, 11, 2))] }
assert_equal %w[51 52], @gateway.unapplied_payments(9101).map(&:id)
end
def test_apply_payment_keeps_existing_lines
existing = RedmineQboBilling::RefundGateway.linked_line(BigDecimal('100'), 601, 'Invoice')
doc = payment(50, 400, Date.new(2026, 11, 1), lines: [existing])
saved = @gateway.apply_payment(doc, BigDecimal('50'), 601, 'Invoice')
assert_equal [[BigDecimal('150'), '601']], saved.line_items.map { |l| [l.amount, l.linked_transactions.first.txn_id] }
saved = @gateway.apply_payment(doc, BigDecimal('25'), 800, 'Expense')
assert_equal [%w[601 Invoice], %w[800 Expense]], saved.line_items.map { |l| [l.linked_transactions.first.txn_id, l.linked_transactions.first.txn_type] }
assert_equal BigDecimal('500'), saved.total
end
def test_payment_method_ids
RedmineQboBilling::PaymentWriter.stubs(:payment_methods).returns([%w[Cash 1], ['Cheque', '2'], ['Visa', '3']])
assert_equal '2', @gateway.payment_method_id(:check)
assert_equal '3', @gateway.payment_method_id(:card)
end
def test_account_and_balance
@fake.query_results = { "AccountType = 'Bank'" => [Quickbooks::Model::Account.new(id: 35)] }
assert_equal '35', @gateway.account_id('Bank')
assert_nil @gateway.account_id('Accounts Receivable')
@fake.customers['9101'] = Quickbooks::Model::Customer.new(balance: BigDecimal('-120'))
assert_equal BigDecimal('-120'), @gateway.customer_balance(9101)
end
def test_reject_estimate_and_documents
estimate = @fake.add(qbo_estimate(status: 'Pending', lines: [qbo_sales_line(1, 10, 'Labor', 1, 100)]))
assert_equal estimate, @gateway.estimate(598)
@gateway.reject_estimate(estimate)
assert_equal 'Rejected', @fake.updated.last.txn_status
invoice = @gateway.create_invoice(qbo_invoice(id: nil))
assert_equal invoice, @gateway.invoice(invoice.id)
end
def test_syncs_never_raise
InvoiceSyncService.any_instance.stubs(:sync_by_id).raises(StandardError)
PaymentSyncService.any_instance.stubs(:sync_by_id).raises(StandardError)
EstimateSyncService.any_instance.stubs(:sync_by_id).raises(StandardError)
assert_nothing_raised do
@gateway.sync_invoice(1)
@gateway.sync_payment(1)
@gateway.sync_estimate(1)
end
end
# ---- refund email ----
def refund
QboRefund.create!(customer_id: 9101, method: 'check', check_number: '5001', status: 'done', refund_amount: 407.6,
txn_date: Date.new(2026, 11, 16), reason: 'Canceled', kind: 'credit')
end
def test_refund_email
with_settings app_title: 'Test Shop', mail_from: 'shop@example.com' do
mail = QboRefundMailer.refund_summary(refund, 'jane@example.com')
assert_equal ['jane@example.com'], mail.to
assert_equal ['shop@example.com'], mail.from
assert_match '$407.60', mail.subject
assert_match 'Test Shop', mail.subject
end
end
def test_refund_email_when_delivery_is_off
ActionMailer::Base.stubs(:perform_deliveries).returns(false)
assert_raises(QboRefundMailer::DeliveryOff) { QboRefundMailer.refund_summary(refund, 'jane@example.com').message }
end
def test_refund_pdf
record = refund
pdf = RedmineQboBilling::RefundPdf.new(record)
assert pdf.render.start_with?('%PDF')
assert_equal 'refund-2026-11-16-jane-customer.pdf', pdf.filename
assert_match 'Jane Customer', pdf.title
end
# ---- QuickBooks service helpers ----
def access_token
OAuth2::AccessToken.new(OAuth2::Client.new('key', 'secret', site: 'https://appcenter.intuit.com'), 'token')
end
def test_services_ask_for_every_custom_field
service = RedmineQboBilling::QboEstimateService.new(company_id: '1', access_token: access_token)
url = service.send(:add_query_string_to_url, 'https://quickbooks.example/v3/estimate', { 'query' => 'x' })
assert_match 'minorversion=75', url
assert_match 'include=enhancedAllCustomFields', url
assert_match 'query=x', url
assert_match '&include', service.send(:add_query_string_to_url, 'https://quickbooks.example/v3/estimate?a=1')
end
def test_send_document
service = RedmineQboBilling::QboInvoiceService.new(company_id: '1', access_token: access_token)
sent_url = nil
response = Struct.new(:code, :plain_body).new(200, '<IntuitResponse><Invoice><Id>601</Id></Invoice></IntuitResponse>')
service.define_singleton_method(:do_http_post) { |url, *_args| sent_url = url; response }
service.define_singleton_method(:parse_singular_entity_response) { |_model, body| body[/<Invoice>.*<\/Invoice>/m] }
invoice = service.send_invoice(601, 'jane+x@example.com')
assert_equal '601', invoice.id
assert_match '/invoice/601/send?sendTo=jane%2Bx%40example.com', sent_url
service.define_singleton_method(:do_http_post) { |*_args| Struct.new(:code).new(400) }
assert_nil service.send_invoice(601)
end
def test_invoice_lines_carry_linked_transactions_after_the_amount
line = Quickbooks::Model::InvoiceLineItem.new
line.amount = BigDecimal('120')
line.linked_transactions = [qbo_link('TimeActivity', 77)]
line.sales_item! { |d| d.quantity = 1 }
xml = line.to_xml.to_s
assert_operator xml.index('<Amount>'), :<, xml.index('<LinkedTxn>')
assert_operator xml.index('<LinkedTxn>'), :<, xml.index('<SalesItemLineDetail>')
# Applying again changes nothing
RedmineQboBilling::Patches::InvoiceLineItemLinkedTxn.apply!
assert_equal xml, line.to_xml.to_s
end
def test_combined_pdf
page = CombinePDF.new.tap { |p| p << CombinePDF.create_page }.to_pdf
@fake.add(qbo_invoice(id: 601, doc_number: '1234'))
@fake.add(qbo_invoice(id: 602, doc_number: '1235'))
@fake.pdf_body = page
pdf, ref = PdfService.new(entity: Invoice).fetch_pdf(doc_ids: %w[601 602])
assert_equal '1234 1235', ref
assert_equal 2, CombinePDF.parse(pdf).pages.size
assert_raises(RuntimeError) { PdfService.new(entity: nil) }
end
# ---- invoices attached to issues ----
def test_invoice_attaches_to_its_customers_issues_once
Invoice.where(id: 601).delete_all
invoice = Invoice.create!(id: 601, doc_number: '1234', customer_id: 9101, txn_date: Date.new(2026, 11, 12))
Issue.find(1).update_column(:customer_id, 9101)
Issue.find(2).update_column(:customer_id, 424_242)
remote = qbo_invoice(lines: [qbo_note_line(1, 'Install #1: lift, see #2 and #99999')])
remote.private_note = 'Work order #1'
InvoiceAttachmentService.new(invoice, remote).attach
assert_equal [invoice], Issue.find(1).invoices.to_a
assert_empty Issue.find(2).invoices
journal = Issue.find(1).journals.last
assert_equal User.anonymous, journal.user
assert_equal [%w[invoice 601 1234]], journal.details.map { |d| [d.property, d.prop_key, d.value] }
assert_no_difference('Journal.count') { InvoiceAttachmentService.new(invoice, remote).attach }
end
end
+122
View File
@@ -0,0 +1,122 @@
#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.
require File.expand_path('../test_helper', __dir__)
# Item, Account and what every QuickBooks-backed model shares (QboBaseModel)
class QboItemsAndAccountsTest < ActiveSupport::TestCase
def setup
Item.where(id: [9701, 9702, 9703, 9704]).delete_all
Account.where(id: [9801, 9802]).delete_all
end
def item(id, attrs = {})
record = Item.new({ id: id, name: "Item #{id}", description: '', unit_price: 10, active: true, type: 'Service' }.merge(attrs))
record.skip_qbo_push = true
record.save!
record
end
def account(id, attrs = {})
Account.create!({ id: id, name: "Account #{id}" }.merge(attrs))
end
def test_item_setters_write_through_to_quickbooks
income = account(9801, name: 'Sales')
record = Item.new(id: 9701, name: 'Labor', description: 'Shop labor', sku: 'LAB', unit_price: 120, type: 'Service',
account_id: income.id)
assert_equal 'Labor', record.details.name
assert_equal 'Shop labor', record.details.description
assert_equal 'LAB', record.details.sku
assert_equal BigDecimal('120'), record.details.unit_price
assert_equal 'Service', record.details.type
assert_equal '9801', record.details.income_account_ref.value.to_s
assert record.taxable
end
def test_unknown_account_leaves_the_quickbooks_ref_alone
record = Item.new(id: 9701, name: 'Labor', account_id: 12_345)
assert_nil record.details.income_account_ref
assert_equal 12_345, record.account_id
end
def test_item_validation
assert_not Item.new(id: 9701, name: '').tap { |i| i.skip_qbo_push = true }.valid?
assert_not Item.new(id: 9701, name: 'Part', unit_price: -1).tap { |i| i.skip_qbo_push = true }.valid?
end
def test_sellable
item(9701)
item(9702, type: 'Category')
item(9703, active: false)
item(9704, type: nil)
assert_equal [9701, 9704], Item.sellable.where(id: [9701, 9702, 9703, 9704]).order(:id).pluck(:id)
end
def test_destroying_an_item_makes_it_inactive_in_quickbooks
record = item(9701)
record.expects(:push_to_qbo).once
record.destroy
assert_equal false, record.details.active?
end
def test_one_default_account
first = account(9801, default: true)
second = account(9802, default: true)
assert_not first.reload.default
assert_equal second, Account.get_default
ref = second.ref
assert_equal 9802, ref.value
assert_equal 'Account 9802', ref.name
assert_equal 'Account 9802', second.to_s
end
def test_push_toggle
assert Item.qbo_push_enabled
assert_not Estimate.qbo_push_enabled
record = Item.new(id: 9701, name: 'Part')
assert record.push_to_qbo?
record.skip_qbo_push = true
assert_not record.push_to_qbo?
assert_not Estimate.new.push_to_qbo?
end
def test_method_missing_reaches_the_quickbooks_entity
record = Item.new(id: 9701, name: 'Part')
assert record.respond_to?(:purchase_desc)
record.purchase_desc = 'Bought in bulk'
assert_equal 'Bought in bulk', record.purchase_desc
assert_raises(NoMethodError) { record.not_a_quickbooks_field }
end
def test_sync_queues_jobs
QboSyncStatus.delete_all
QboSyncJob.expects(:perform_later).with(entity: 'Item', full_sync: true)
Item.sync
assert_equal 'queued', QboSyncStatus.find_by(entity: 'Item').state
QboSyncJob.expects(:perform_later).with(entity: 'Item', id: 5)
Item.sync_by_id(5)
QboSyncJob.expects(:perform_later).with(entity: 'Estimate', doc_number: '1068')
Estimate.sync_by_doc_number('1068')
end
def test_last_sync
Employee.delete_all
assert_equal I18n.t(:label_qbo_never_synced), Employee.last_sync
end
def test_estimate_line_issue_link
QboEstimateLineIssue.delete_all
link = QboEstimateLineIssue.create!(estimate_id: 1, line_id: '3', issue_id: 1)
assert link.created_on
assert_not QboEstimateLineIssue.new(estimate_id: 1, line_id: '3', issue_id: 2).valid?
assert_not QboEstimateLineIssue.new(line_id: '4').valid?
end
end
+87
View File
@@ -0,0 +1,87 @@
#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.
require File.expand_path('../test_helper', __dir__)
class QboRefundTest < ActiveSupport::TestCase
def refund(attrs = {})
QboRefund.new({ customer_id: 9101, method: 'card', status: 'done', kind: 'credit' }.merge(attrs))
end
def test_validations
assert refund.valid?
assert_not refund(method: 'cash').valid?
assert_not refund(status: 'maybe').valid?
assert_not refund(kind: 'other').valid?
assert_not refund(customer_id: nil).valid?
end
def test_flags_and_method_name
record = refund(method: 'check', kind: 'invoice', status: 'incomplete')
assert record.check?
assert record.invoice?
assert_not record.done?
assert_equal I18n.t(:label_refund_method_check), record.method_name
end
def test_issue_id_lists
record = refund
record.canceled_issue_ids = ['3', 3, 4]
record.noted_issue_ids = [7]
assert_equal [3, 4], record.canceled_issue_ids
assert_equal [7], record.noted_issue_ids
record[:canceled_issue_ids] = 'garbage'
record[:noted_issue_ids] = nil
assert_equal [], record.canceled_issue_ids
assert_equal [], record.noted_issue_ids
end
def test_refunded_lines_round_trip
record = refund
record.refunded_lines = [QboRefund::RefundedLine.new(key: 3, description: 'Brake pads', quantity: 2,
amount: BigDecimal('60'), parts: true),
QboRefund::RefundedLine.new(key: 'L1', description: 'Labor', quantity: nil,
amount: 120, parts: nil)]
lines = record.refunded_lines
assert_equal %w[3 L1], lines.map(&:key)
assert_equal '2', lines.first.quantity
assert_equal BigDecimal('60'), lines.first.amount
assert lines.first.parts
assert_not lines.last.parts
assert_nil lines.last.quantity
record[:refunded_lines] = '{bad'
assert_equal [], record.refunded_lines
end
def test_document_label
assert_equal 'E1068', refund(estimate_number: '1068').document_label
assert_nil refund.document_label
assert_equal I18n.t(:label_refund_invoice_number, number: '1234'),
refund(kind: 'invoice', invoice_number: '1234').document_label
end
def test_purchase_url
RedmineQbo.stubs(:sandbox_mode?).returns(false)
assert_nil refund.purchase_url
assert_equal 'https://app.qbo.intuit.com/app/expense?txnId=5', refund(purchase_id: '5').purchase_url
assert_equal 'https://app.qbo.intuit.com/app/check?txnId=5', refund(purchase_id: '5', method: 'check').purchase_url
assert_equal 'https://app.qbo.intuit.com/app/refundreceipt?txnId=5', refund(purchase_id: '5', kind: 'invoice').purchase_url
RedmineQbo.stubs(:sandbox_mode?).returns(true)
assert_equal 'https://sandbox.qbo.intuit.com/app/expense?txnId=5', refund(purchase_id: '5').purchase_url
end
def test_of_invoice_needs_a_receipt
QboRefund.delete_all
with_receipt = refund(kind: 'invoice', invoice_id: 601, purchase_id: '900').tap { |r| r.save!(validate: false) }
refund(kind: 'invoice', invoice_id: 601, purchase_id: '').save!(validate: false)
refund(kind: 'invoice', invoice_id: 602, purchase_id: '901').save!(validate: false)
assert_equal [with_receipt.id], QboRefund.of_invoice(601).pluck(:id)
end
end
+106
View File
@@ -0,0 +1,106 @@
#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.
require File.expand_path('../test_helper', __dir__)
# WebhookProcessJob, QboSyncDispatcher and QboSyncJob
class QboSyncJobsTest < ActiveSupport::TestCase
def setup
QboSyncStatus.delete_all
Qbo.stubs(:update_time_stamp)
end
def notification(*entities)
{ eventNotifications: [{ realmId: '1', dataChangeEvent: { entities: entities } }] }.to_json
end
# Items and accounts come from the plugin's own hook (QboHookListener); anything else is ignored
def test_webhook_syncs_allowed_entities
Invoice.expects(:sync_by_id).with(601)
Customer.expects(:sync_by_id).with(9101)
Item.expects(:sync_by_id).with(5)
Account.expects(:sync_by_id).with(84)
Kernel.expects(:sync_by_id).never
WebhookProcessJob.perform_now(notification({ name: 'Invoice', id: '601', operation: 'Update' },
{ name: 'Customer', id: '9101', operation: 'Create' },
{ name: 'Item', id: '5', operation: 'Update' },
{ name: 'Account', id: '84', operation: 'Update' },
{ name: 'Kernel', id: '1', operation: 'Update' },
{ name: 'Vendor', id: '2', operation: 'Update' }))
end
def test_webhook_deletes
Estimate.expects(:delete).with(598)
Payment.expects(:delete).with('801')
WebhookProcessJob.perform_now(notification({ name: 'Estimate', id: '598', operation: 'Delete' },
{ name: 'Payment', id: '802', operation: 'Merge', deletedId: '801' }))
end
def test_plugins_add_webhook_entities
Redmine::Hook.stubs(:call_hook).with(:qbo_additional_entities).returns([['Vehicle'], nil])
vehicle = Class.new { def self.sync_by_id(_id); end }
Object.const_set(:Vehicle, vehicle) unless defined?(::Vehicle)
::Vehicle.expects(:sync_by_id).with(5)
WebhookProcessJob.perform_now(notification({ name: 'Vehicle', id: '5', operation: 'Update' }))
ensure
Object.send(:remove_const, :Vehicle) if defined?(::Vehicle) && ::Vehicle == vehicle
end
def test_plugin_hook_adds_items_and_accounts
listener = RedmineQboBilling::Hooks::QboHookListener.instance
assert_equal %w[Item Account], listener.qbo_additional_entities
assert_equal [Account, Item], listener.qbo_full_sync
end
def test_one_bad_entity_does_not_stop_the_rest
Invoice.stubs(:sync_by_id).raises(StandardError, 'boom')
Customer.expects(:sync_by_id).with(9101)
WebhookProcessJob.perform_now(notification({ name: 'Invoice', id: '601' }, { name: 'Customer', id: '9101' }))
end
def test_webhook_updates_the_time_stamp
Qbo.expects(:update_time_stamp)
WebhookProcessJob.perform_now('{}')
end
def test_dispatcher_queues_every_entity_payments_before_invoices
queued = []
QboSyncJob.stubs(:perform_later).with { |args| queued << [args[:entity].to_s, args[:full_sync]] }
Redmine::Hook.stubs(:call_hook).with(:qbo_full_sync).returns([[Item], nil])
QboSyncDispatcher.sync!(full_sync: true)
assert_equal %w[Customer Estimate Payment Invoice Employee Item], queued.map(&:first)
assert queued.all?(&:last)
assert_equal 6, QboSyncStatus.where(state: 'queued').count
end
def test_sync_job_by_id_doc_number_or_all
CustomerSyncService.any_instance.expects(:sync_by_id).with(9101)
QboSyncJob.perform_now(entity: 'Customer', id: 9101)
EstimateSyncService.any_instance.expects(:sync_by_doc_number).with('1068')
QboSyncJob.perform_now(entity: 'Estimate', doc_number: '1068')
InvoiceSyncService.any_instance.expects(:sync).with(full_sync: true)
QboSyncStatus.queued('Invoice')
QboSyncJob.perform_now(entity: 'Invoice', full_sync: true)
assert_not QboSyncStatus.exists?(entity: 'Invoice')
end
def test_sync_status_is_cleared_when_the_sync_fails
InvoiceSyncService.any_instance.stubs(:sync).raises(StandardError, 'QuickBooks down')
job = QboSyncJob.new(entity: 'Invoice')
assert_raises(StandardError) { job.perform(entity: 'Invoice') }
assert_not QboSyncStatus.exists?(entity: 'Invoice')
end
def test_sync_job_needs_an_entity
assert_raises(RuntimeError) { QboSyncJob.new.perform }
end
end
+54
View File
@@ -0,0 +1,54 @@
#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.
require File.expand_path('../test_helper', __dir__)
class QboSyncStatusTest < ActiveSupport::TestCase
def setup
QboSyncStatus.delete_all
end
def test_queued_running_progress_finished
QboSyncStatus.queued('Invoice')
status = QboSyncStatus.find_by(entity: 'Invoice')
assert_equal 'queued', status.state
assert_not status.running?
QboSyncStatus.running('Invoice')
QboSyncStatus.progress('Invoice', 25)
QboSyncStatus.progress(:Invoice, '5')
status.reload
assert status.running?
assert_equal 30, status.processed
assert status.started_at
# Asking again while it runs doesn't put it back in the queue
QboSyncStatus.queued('Invoice')
assert status.reload.running?
QboSyncStatus.finished('Invoice')
assert_not QboSyncStatus.exists?(entity: 'Invoice')
end
def test_by_entity_ignores_stale_rows
QboSyncStatus.queued('Invoice')
QboSyncStatus.queued('Estimate')
QboSyncStatus.create!(entity: 'Payment', state: 'running', updated_at: 7.hours.ago)
assert_equal %w[Estimate Invoice], QboSyncStatus.by_entity.keys.sort
assert_equal ['Invoice'], QboSyncStatus.by_entity([:Invoice]).keys
end
def test_errors_are_logged_not_raised
QboSyncStatus.stubs(:where).raises(StandardError, 'db gone')
assert_nothing_raised { QboSyncStatus.progress('Invoice', 1) }
assert_nothing_raised { QboSyncStatus.finished('Invoice') }
assert_equal({}, QboSyncStatus.by_entity)
end
end
+81
View File
@@ -0,0 +1,81 @@
#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.
require File.expand_path('../test_helper', __dir__)
# RedmineQboBilling's permission helpers and plugin hooks for the editor's custom fields
class RedmineQboBillingTest < ActiveSupport::TestCase
Billing = RedmineQboBilling
def user(*permissions)
user = User.new
user.stubs(:allowed_to?).returns(false)
permissions.each { |p| user.stubs(:allowed_to?).with(p, nil, global: true).returns(true) }
user
end
def test_simple_permissions
{ writer?: :write_estimates, sender?: :send_estimates, payment_receiver?: :receive_payments,
refunder?: :issue_refunds, invoice_writer?: :write_invoices, invoice_sender?: :send_invoices }.each do |helper, permission|
assert Billing.public_send(helper, user(permission)), helper
assert_not Billing.public_send(helper, user), helper
end
end
def test_payment_viewer
assert Billing.payment_viewer?(user(:view_payments))
assert Billing.payment_viewer?(user(:receive_payments))
assert_not Billing.payment_viewer?(user)
end
def test_document_viewers
assert RedmineQboBilling.estimate_viewer?(user(:view_customers))
assert RedmineQboBilling.estimate_viewer?(user(:write_estimates))
assert_not RedmineQboBilling.estimate_viewer?(user(:write_invoices))
%i[view_customers write_invoices view_payments receive_payments issue_refunds].each do |permission|
assert RedmineQboBilling.invoice_viewer?(user(permission)), permission
end
assert_not RedmineQboBilling.invoice_viewer?(user(:write_estimates))
end
def test_paid_invoice_editor
assert Billing.paid_invoice_editor?(true, user(:write_invoices, :edit_paid_invoices))
assert_not Billing.paid_invoice_editor?(false, user(:write_invoices, :edit_paid_invoices))
assert Billing.paid_invoice_editor?(false, user(:write_invoices, :edit_partially_paid_invoices))
assert_not Billing.paid_invoice_editor?(true, user(:write_invoices, :edit_partially_paid_invoices))
assert_not Billing.paid_invoice_editor?(true, user(:edit_paid_invoices))
end
def test_field_options_merge_and_dedupe
field = Struct.new(:id).new(2)
Redmine::Hook.stubs(:call_hook).with(:qbo_billing_field_options, anything).returns([
{ field => [{ value: 'vin1', label: 'Jeep' }, { 'value' => ' ' }] },
{ '2' => [{ value: 'VIN1' }, { value: 'VIN2' }] },
'not a hash'
])
assert_equal({ '2' => [{ value: 'vin1', label: 'Jeep' }, { value: 'VIN2', label: 'VIN2' }] },
Billing.field_options(Customer.new))
assert_equal({}, Billing.field_options(nil))
end
def test_field_options_survive_a_failing_plugin
Redmine::Hook.stubs(:call_hook).raises(StandardError)
assert_equal({}, Billing.field_options(Customer.new))
assert_equal({}, Billing.field_defaults(Customer.new))
end
def test_field_defaults_first_value_wins
Redmine::Hook.stubs(:call_hook).with(:qbo_billing_field_defaults, has_entries(issues: [])).returns([
{ 2 => '', 3 => 'first' }, { '2' => 'VIN', '3' => 'second' }, nil
])
assert_equal({ '3' => 'first', '2' => 'VIN' }, Billing.field_defaults(Customer.new))
assert_equal({}, Billing.field_defaults(nil))
end
end
+140
View File
@@ -0,0 +1,140 @@
#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.
require File.expand_path('../test_helper', __dir__)
# SyncServiceBase and the entity sync services: QuickBooks records cached locally
class SyncServicesTest < ActiveSupport::TestCase
include QboFakeServiceHelper
fixtures :projects, :users, :issues, :trackers, :issue_statuses, :enumerations
def setup
Customer.where(id: [9101, 9102]).delete_all
Estimate.where(id: 598).delete_all
Invoice.where(id: 601).delete_all
Payment.where(id: 801).delete_all
Employee.where(id: 31).delete_all
Account.where(id: 84).delete_all
QboSyncStatus.delete_all
@fake = install_fake_quickbooks
end
def remote_customer(id, name, active: true, phone: nil)
customer = Quickbooks::Model::Customer.new(id: id.to_s, display_name: name, active: active)
if phone
customer.primary_phone = Quickbooks::Model::TelephoneNumber.new
customer.primary_phone.free_form_number = phone
end
customer
end
def test_customer_sync_by_id
@fake.add(remote_customer(9101, 'jane customer', phone: '(401) 555-0101'))
CustomerSyncService.new.sync_by_id(9101)
customer = Customer.find(9101)
assert_equal ['Jane Customer', '4015550101'], [customer.name, customer.phone_number]
end
def test_inactive_customer_is_removed
local_customer(9101)
@fake.add(remote_customer(9101, 'Jane Customer', active: false))
CustomerSyncService.new.sync_by_id(9101)
assert_not Customer.exists?(9101)
end
def test_full_sync_in_pages_reports_progress
QboSyncStatus.running('Customer')
@fake.query_results = { 'Customer' => [remote_customer(9101, 'Jane'), remote_customer(9102, 'Bob')] }
CustomerSyncService.new.sync(full_sync: true)
assert_equal %w[Bob Jane], Customer.where(id: [9101, 9102]).order(:name).pluck(:name)
assert_equal 'SELECT * FROM Customer ORDER BY Id', @fake.queries.last
assert_equal 2, QboSyncStatus.find_by(entity: 'Customer').processed
end
def test_incremental_sync_asks_for_changes_since_the_last_update
local_customer(9101)
CustomerSyncService.new.sync
assert_match(/WHERE MetaData.LastUpdatedTime > '\d{4}-\d\d-\d\dT/, @fake.queries.last)
end
def test_estimate_sync
local_customer(9101)
remote = qbo_estimate(doc_number: '1068', status: 'Pending', total: '368.40',
lines: [qbo_sales_line(1, 10, 'Labor', 2, 120)])
remote.txn_tax_detail = Quickbooks::Model::TransactionTaxDetail.new(total_tax: BigDecimal('8.40'))
@fake.add(remote)
Setting.stubs(:plugin_redmine_qbo).returns({})
EstimateSyncService.new.sync_by_id(598)
estimate = Estimate.find(598)
assert_equal ['1068', 'Pending', BigDecimal('368.40'), 2.0, BigDecimal('8.40'), 9101],
[estimate.doc_number, estimate.txn_status, estimate.total_amount, estimate.hours, estimate.tax_amount, estimate.customer_id]
end
def test_estimate_sync_by_doc_number
local_customer(9101)
@fake.add(qbo_estimate(doc_number: '1068'))
EstimateSyncService.new.sync_by_doc_number('1068')
assert Estimate.exists?(598)
end
def test_invoice_sync_attaches_issues
local_customer(9101)
Issue.find(1).update_columns(customer_id: 9101)
remote = qbo_invoice(doc_number: '1234', total: 100, balance: 100,
lines: [qbo_sales_line(1, 10, 'Labor', 1, 100, description: 'Install #1: lift')])
@fake.add(remote)
InvoiceSyncService.new.sync_by_id(601)
invoice = Invoice.find(601)
assert_equal ['1234', BigDecimal('100'), nil], [invoice.doc_number, invoice.balance, invoice.paid_on]
assert_includes Issue.find(1).invoices, invoice
end
def test_unchanged_record_is_not_saved_again
local_customer(9101, 'Jane Customer')
@fake.add(remote_customer(9101, 'Jane Customer'))
Customer.any_instance.expects(:save!).never
CustomerSyncService.new.sync_by_id(9101)
end
def test_payment_waits_for_its_customer
@fake.add(Quickbooks::Model::Payment.new(id: '801', total: BigDecimal('50'), unapplied_amount: BigDecimal('0'),
txn_date: Date.new(2026, 11, 2), customer_ref: qbo_ref(424_242)))
PaymentSyncService.new.sync_by_id(801)
payment = Payment.find(801)
assert_nil payment.customer_id
assert_equal BigDecimal('50'), payment.total_amount
end
def test_employee_and_account_sync
@fake.add(Quickbooks::Model::Employee.new(id: '31', display_name: 'Tech One', active: true))
EmployeeSyncService.new.sync_by_id(31)
assert_equal 'Tech One', Employee.find(31).name
@fake.add(Quickbooks::Model::Account.new(id: '84', name: 'Sales', classification: 'Revenue', active: true))
AccountSyncService.new.sync_by_id(84)
assert_equal ['Sales', 'Revenue', true], Account.find(84).values_at(:name, :classification, :active)
end
def test_a_bad_record_is_logged_not_raised
@fake.add(remote_customer(9101, ''))
assert_nothing_raised { CustomerSyncService.new.sync_by_id(9101) }
assert_not Customer.exists?(9101)
end
def test_a_record_inserted_meanwhile_is_updated
local_customer(9101, 'Old Name')
@fake.add(remote_customer(9101, 'New Name'))
service = CustomerSyncService.new
calls = 0
Customer.stubs(:find_or_initialize_by).with { calls += 1 }.returns(Customer.new(id: 9101), Customer.find(9101))
Customer.any_instance.stubs(:save!).raises(ActiveRecord::RecordNotUnique).then.returns(true)
service.sync_by_id(9101)
assert_equal 2, calls
end
end
+21
View File
@@ -0,0 +1,21 @@
#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.
require File.expand_path('../test_helper', __dir__)
class TitleCaseTest < ActiveSupport::TestCase
def test_capitalizes_first_letters_only
assert_equal 'Led Light Bar For JL', RedmineQbo::TitleCase.call('led light bar for JL')
assert_equal 'LED 4x4 (Front)', RedmineQbo::TitleCase.call("LED 4x4\t(front)")
assert_equal 'Éclair', RedmineQbo::TitleCase.call('éclair')
assert_equal '', RedmineQbo::TitleCase.call(' ')
assert_nil RedmineQbo::TitleCase.call(nil)
end
end