Compare commits

...
47 Commits
Author SHA1 Message Date
ricky e61217b719 2026.10.1 2026-10-29 21:35:51 -04:00
Claude b8ddf1c38b Issue PDF: allow plugin rows with an HTML value
Rows from the :pdf_left / :pdf_right hooks can now be
[label, text, { html: "..." }]; the value is drawn with writeHTMLCell so
part of it can be bold (used by redmine_qbo_vehicles to bold the last 8
of a VIN). The text still sizes the row, plain rows are unchanged, and
PdfPatch::PDF_HTML_VALUES lets plugins check for support.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
2026-10-29 20:21:07 -04:00
Claude f1d81890de Restore AuthHelper#require_user for plugins that still use it
redmine_qbo_vehicles calls before_action :require_user; removing it in
the security fixes would break every vehicles page. It now simply
requires a logged-in user.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
2026-10-28 22:57:45 -04:00
ricky 609ddb098a 2026.10.0 2026-10-28 22:32:26 -04:00
Claude c4ab97b75e Customer search: bundled nickname data and sound-alike matching
- Nicknames now come from the carltonnorthern/nicknames data set
  (Apache 2.0, ~2,800 pairs, bundled in data/nicknames with its license),
  plus a few extra groups in EXTRA_NICKNAME_GROUPS. Names match if
  directly linked, or if both are short for the same longer name, so
  Bill/William and Bill/Will match but William/Robert don't (the data
  lists "bill" for both)
- Double Metaphone (text gem) matches names that sound alike but are
  spelled differently: Jon/John, Smyth/Smith, Cathy/Kathy,
  Steven/Stephen, Jeffrey/Geoffrey
- Faster ranking: per-search word-pair scores are cached, whole-name
  comparison only runs when it can succeed, and prepared search data is
  kept in process memory until a customer changes (~40 ms per search at
  5,000 customers)

Adds gem 'text', '~> 1.3' to the Gemfile.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
2026-10-28 22:22:00 -04:00
Claude 0523e8dd24 Security, permission and search fixes
Security
- Connecting to QuickBooks (authenticate/oauth_callback) and all syncs
  are admin-only; the OAuth state is stored and verified on callback
- New "Bill issue time to QuickBooks" project permission; billing is now
  a POST and checks the permission and issue visibility
- Estimate/invoice PDFs require a logged-in user, or a customer share
  link limited to the estimate and invoices attached to that issue
  (the old require_user check never ran)
- Attachments patch keeps the share token per request instead of in
  Thread.current, so it can't leak into other requests

Permissions and share links
- customers#autocomplete and the filter_* actions are part of View
  customers, so non-admins can pick customers on forms
- customers#view no longer goes through authorize_global; share needs
  the new "Share issues with customers" permission and a visible issue
- Removed a check in customers#view that compared a value to itself

Bugs
- Subjects and customer names capitalize each word without lowercasing
  the rest (LED, JL, 4x4 stay as typed); subjects only when changed
- Settings page shows Invoice/Estimate sync times (Item/Account models
  no longer exist)
- customers#update shows validation errors instead of reporting success
- Billing marks each activity billed once sent to QBO, so retries and
  token refreshes don't create duplicate TimeActivities

Search
- New CustomerSearchService for autocomplete and the customer search
  page: nicknames (Bill/William), typos, word order, partial words,
  accents, and phone digits in any format; ranked, with the candidate
  list cached until a customer changes

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM
2026-10-28 22:08:36 -04:00
ricky aacc2d645d Refactor customer form layout for improved readability and structure 2026-10-23 09:34:50 -04:00
ricky cf3342bcc5 2026.9.0 2026-09-09 21:12:57 -04:00
ricky bab019a152 Implement global permissions for customer actions and update views to check permissions before rendering buttons 2026-09-08 22:35:52 -04:00
ricky fd91bd6fa2 Bump version to 2026.8.3 for Redmine QBO plugin 2026-08-26 21:22:12 -04:00
ricky 04a0eede5f Register customer and estimate fields with SubtaskFieldCopier if the plugin is installed, ensuring uniqueness to prevent duplicates. 2026-08-26 21:21:22 -04:00
ricky ba40496421 Enhance autocomplete functionality to support name and phone queries with fuzzy matching 2026-08-25 16:05:51 -04:00
ricky 57dc8127b0 2026.8.2 2026-08-24 20:39:38 -04:00
ricky 9dc4b79355 Refactor customer controller and form to enhance error handling and conditional rendering 2026-08-24 20:17:21 -04:00
ricky 8ae82f1423 Updated pdf patch to support markdown tables 2026-08-18 13:14:53 -04:00
ricky b72c82fb2b Dynamically update the link with estimate id 2026-08-17 21:03:37 -04:00
ricky b901e64149 added new issue link to actions 2026-08-17 20:40:42 -04:00
ricky 7abb1aa06c fixed customer view to show attachments 2026-08-17 20:22:23 -04:00
ricky dfd3a641db Version 2026.8.1 2026-08-12 08:41:31 -04:00
ricky 75e5aeb668 Refactor customer details and form views for improved readability and consistency 2026-08-11 18:39:23 -04:00
ricky ea29990cfa Version 2026.8.0 2026-08-10 19:36:25 -04:00
ricky c31ec82e61 Normalize customer name before saving and update QBO display name accordingly 2026-08-10 15:20:14 -04:00
ricky 938f9d9f3b Add customer action hooks to _actions.html.erb for enhanced integration 2026-08-09 21:09:56 -04:00
ricky f2b0186ee2 Add EstimateService class 2026-08-09 20:50:20 -04:00
ricky 9373963c94 Fix association type for issues in Estimate model 2026-08-09 20:47:55 -04:00
ricky 396a56ceec Refactor associations in IssuePatch for clarity and consistency 2026-08-09 20:47:42 -04:00
ricky b3c3006b56 Added transaltion for Estimate 2026-08-06 16:22:12 -04:00
ricky 576ca5a0a9 Added transation for customer 2026-08-06 16:03:31 -04:00
ricky d18a0c180a added name function to estimate 2026-08-06 07:55:51 -04:00
ricky baca0ed6c7 updated readme 2026-07-02 22:48:25 -04:00
ricky 6bf84dd61a Added payment link 2026-07-01 14:06:02 -04:00
ricky 61b02831e3 removed comment 2026-03-28 06:40:59 -04:00
ricky 7c79f2388a removed Custom Field Synchronization 2026-03-28 00:32:22 -04:00
ricky 36267893bd 2026.3.17 2026-03-28 00:25:55 -04:00
ricky e681203a45 Removed custom field sync, it was never really useful anyways. 2026-03-28 00:25:07 -04:00
ricky 681e7f8047 2026.3.16 2026-03-26 08:13:01 -04:00
ricky 4a6c414d9e Updated customer form to use auto complete to help prevent duplicate customer enteries 2026-03-26 07:56:59 -04:00
ricky 925cb1d2bc 2026.3.15
Note: breaking change, need to update settings
2026-03-22 14:24:22 -04:00
ricky 1dcccd7b98 Merge branch 'master' into rails-7 2026-03-21 10:28:46 -04:00
ricky f73973a4e1 2026.3.14 2026-03-21 10:27:33 -04:00
ricky 7cd388dbd4 Fixed webhook 2026-03-21 10:26:57 -04:00
ricky 7149e85d37 Updated how settings are handled.
Note: Breaking change. Will need to update settings after update
2026-03-21 10:25:46 -04:00
ricky eacdecd65b Updated patches and hooks 2026-03-21 00:09:42 -04:00
ricky ee2ab04206 added placeholder 2026-03-19 18:15:04 -04:00
ricky 8a8c6f5fa0 renamed issue_customer_id to customer_id 2026-03-19 18:07:21 -04:00
ricky cc36bc16b4 use the autocomplete 2026-03-19 10:36:46 -04:00
ricky 874ec7c2dc updated plugin_config screenshot 2026-03-19 09:16:32 -04:00
47 changed files with 4181 additions and 695 deletions

No files matched your search

+3
View File
@@ -6,3 +6,6 @@ gem 'roxml'
gem 'will_paginate'
gem 'rexml'
gem 'combine_pdf'
# Double Metaphone sound-alike matching for customer search (CustomerSearchService)
gem 'text', '~> 1.3'
+6 -16
View File
@@ -89,17 +89,6 @@ Supported automation:
Invoices containing an Issue reference (e.g. `#123`) automatically attach to the corresponding Issue.
### Custom Field Synchronization
Invoice custom fields can be mapped to Issue custom fields.
Example use case:
* Mileage In/Out recorded in Redmine
* Automatically synchronized to the QuickBooks invoice.
### Customer Synchronization
Customer records are automatically updated in the local database when changes occur in QuickBooks.
@@ -119,9 +108,10 @@ Available hooks:
|Type|Hook|Note
|--|--|--|
View Hook|:customer_actions_top, { customer: @customer }| Used to add action links to customer view
View Hook|:customer_actions_bottom, { customer: @customer} | Used to add action links to customer view
View Hook|:pdf_left, { issue: issue } | Used to add text to left side of PDF
View Hook|:pdf_right, { issue: issue } | Used to add text to right side of PDF
Hook|process_invoice_custom_fields, { issue: issue, invoice: invoice } | Used to process invoice custom fields
View Hook|:show_customer_view_right, { customer: customer } | Used to show partials on right side of customer view
Hook| :qbo_additional_entities | Used to add additional entites to be processed by the WebhookProcessJob
Hook| :qbo_full_sync | Used to add a Class to be called by the QboSyncDispatcher
@@ -154,7 +144,7 @@ https://redmine.yourdomain.com/qbo/webhook
# Installation
## 1\. Clone the Plugin
## 1. Clone the Plugin
Install the plugin into your Redmine plugins directory.
@@ -169,7 +159,7 @@ Use a **tagged release** for stability.
---
## 2\. Install Dependencies
## 2. Install Dependencies
```bash
bundle install
@@ -179,7 +169,7 @@ Required for **Redmine 6 / Rails 7 compatibility**.
---
## 3\. Run Database Migrations
## 3. Run Database Migrations
```bash
bundle exec rake redmine:plugins:migrate RAILS_ENV=production
@@ -187,7 +177,7 @@ bundle exec rake redmine:plugins:migrate RAILS_ENV=production
---
## 4\. Restart Redmine
## 4. Restart Redmine
Restart your Redmine server so the plugin and hooks are loaded.
Binary file not shown.

Before

Width:  |  Height:  |  Size: 672 KiB

After

Width:  |  Height:  |  Size: 269 KiB

+46 -21
View File
@@ -8,7 +8,6 @@
#
#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.
# This controller class will handle map management
class CustomersController < ApplicationController
include AuthHelper
@@ -26,8 +25,12 @@ class CustomersController < ApplicationController
include SortHelper
helper :timelog
before_action :add_customer, only: :new
before_action :view_customer, except: [:new, :view]
# This tells Redmine to check global permissions for the current controller/action
# customers#view is the public share-link page: it is authorized by its token, not by Redmine permissions
before_action :authorize_global, except: [:view]
before_action :add_customer, only: [:new, :create]
before_action :view_customer, except: [:new, :create, :view, :share, :sync]
before_action :require_admin, only: :sync
skip_before_action :verify_authenticity_token, :check_if_login_required, only: [:view]
def address_to_s(address)
@@ -60,13 +63,11 @@ class CustomersController < ApplicationController
params.require(:customer).permit(:name, :email, :primary_phone, :mobile_phone, :phone_number, :notes)
end
# Used for autocomplete form
# Used for autocomplete forms. Fuzzy matching (nicknames, typos, word order, phone digits) helps
# staff spot an existing customer before creating a duplicate. See CustomerSearchService.
def autocomplete
term = ActiveRecord::Base.sanitize_sql_like(params[:q].to_s)
items = Customer.where("name LIKE :t OR phone_number LIKE :t OR mobile_phone_number LIKE :t", t: "%#{term}%")
.order(:name)
.limit(20)
name_query = (params[:name] || params[:q] || params[:term]).to_s.strip
items = CustomerSearchService.call(name: name_query, phone: params[:phone])
render json: items.map { |i|
{ id: i.id, name: i.name, phone_number: i.phone_number, mobile_phone_number: i.mobile_phone_number }
@@ -75,14 +76,28 @@ class CustomersController < ApplicationController
def create
@customer = Customer.new(allowed_params)
@customer.save
log "Customer ##{@customer.id} created successfully."
flash[:notice] = t :notice_customer_created
redirect_to @customer
respond_to do |format|
if @customer.save
log "Customer ##{@customer.id} created successfully."
format.html { redirect_to @customer, notice: l(:notice_successful_create) }
format.json { render json: { id: @customer.id, name: @customer.name }, status: :created }
else
format.html { render :new }
format.json { render json: { errors: @customer.errors.full_messages }, status: :unprocessable_entity }
end
end
rescue => e
log "Failed to create customer: #{e.message}"
flash[:error] = e.message
redirect_to new_customer_path
respond_to do |format|
format.html {
flash[:error] = e.message
redirect_to new_customer_path
}
format.json {
render json: { errors: [e.message] }, status: :internal_server_error
}
end
end
def edit
@@ -104,7 +119,7 @@ class CustomersController < ApplicationController
def index
if params[:search]
@customers = Customer.search(params[:search]).order(:name).paginate(page: params[:page])
@customers = CustomerSearchService.call(name: params[:search], limit: 200).paginate(page: params[:page])
if only_one_non_zero?(@customers)
redirect_to @customers.first
end
@@ -136,6 +151,10 @@ class CustomersController < ApplicationController
def new
@customer = Customer.new
if request.xhr?
render partial: 'form', layout: false, locals: { hide_submit: true, hide_toolbar: true }
end
end
def only_one_non_zero?(array)
@@ -150,8 +169,10 @@ class CustomersController < ApplicationController
end
def share
issue = Issue.find(params[:id])
issue = Issue.visible.find(params[:id])
token = issue.share_token
return render_403 unless token
redirect_to view_path(token.token)
rescue ActiveRecord::RecordNotFound
flash[:error] = t(:notice_issue_not_found)
@@ -197,9 +218,14 @@ class CustomersController < ApplicationController
def update
@customer = Customer.find_by_id(params[:id])
@customer.update(allowed_params)
flash[:notice] = t :notice_customer_updated
redirect_to @customer
return render_404 unless @customer
if @customer.update(allowed_params)
flash[:notice] = t :notice_customer_updated
redirect_to @customer
else
render :edit, status: :unprocessable_entity
end
rescue => e
log "Failed to update customer: #{e.message}"
flash[:error] = e.message
@@ -212,7 +238,6 @@ class CustomersController < ApplicationController
return render_403 unless @token
@issue = @token.issue
return render_403 unless @issue
return render_403 unless @issue.customer_id == @token.issue.customer_id
session[:token] = @token.token
load_issue_data
rescue ActiveRecord::RecordNotFound
+2 -1
View File
@@ -10,7 +10,8 @@
class EmployeesController < ApplicationController
include AuthHelper
before_action :require_user, unless: -> { session[:token].nil? }
# Syncing is admin-only
before_action :require_admin
def sync
Employee.sync
+26 -2
View File
@@ -10,9 +10,14 @@
class EstimatesController < ApplicationController
include AuthHelper
before_action :require_user, unless: -> { session[:token].nil? }
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: -> { session[:token].nil? }
# PDFs: logged-in users, or a customer with a share link (limited to their issue's estimate).
# 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]
before_action :require_login_or_customer_token, only: [:show, :doc]
before_action :load_estimate, only: [:show, :doc]
# Syncing is admin-only
before_action :require_admin, only: :sync
# Displays the estimate PDF in the browser or redirects with an error if not found.
def doc
@@ -34,6 +39,10 @@ class EstimatesController < ApplicationController
# Loads the estimate based on ID or doc number, with a fallback to sync if not found locally.
def load_estimate
log "Attempting to load Estimate with params: #{params.inspect}"
# Share-link customers may only open the estimate attached to their issue (checked before any sync)
return load_customer_estimate if customer_token_only?
@estimate = find_estimate || sync_and_find_estimate
unless @estimate
@@ -41,6 +50,21 @@ class EstimatesController < ApplicationController
end
end
# For share-link customers: only the estimate attached to the token's issue, by ID or doc number.
def load_customer_estimate
estimate = customer_token.issue&.estimate
requested =
if params[:search].present?
estimate && estimate.doc_number.to_s == params[:search].to_s
else
estimate && estimate.id.to_s == params[:id].to_s
end
return render_403 unless requested
@estimate = estimate
end
# Attempts to find the estimate locally by ID or doc number.
def find_estimate
return Estimate.find_by(doc_number: params[:search]) if params[:search].present?
+20 -3
View File
@@ -10,14 +10,19 @@
class InvoicesController < ApplicationController
include AuthHelper
before_action :require_user, unless: -> { session[:token].nil? }
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: -> { session[:token].nil? }
# PDFs: logged-in users, or a customer with a share link (limited to their issue's invoices).
# 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
before_action :require_login_or_customer_token, only: :show
before_action :authorize_customer_invoices, only: :show
# Syncing is admin-only
before_action :require_admin, only: :sync
# Displays the invoice PDF in the browser or redirects with an error if not found.
def show
log "Processing request for #{request.original_url}"
invoice_ids = Array(params[:invoice_ids] || params[:id])
pdf, ref = PdfService.new(entity: Invoice).fetch_pdf(doc_ids: invoice_ids)
send_data pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf"
@@ -34,6 +39,18 @@ class InvoicesController < ApplicationController
private
def invoice_ids
@invoice_ids ||= Array(params[:invoice_ids] || params[:id]).map(&:to_s).reject(&:blank?)
end
# Share-link customers may only open invoices attached to their issue
def authorize_customer_invoices
return true unless customer_token_only?
allowed = customer_token.issue&.invoice_ids.to_a.map(&:to_s)
render_403 if invoice_ids.empty? || (invoice_ids - allowed).any?
end
# Logs messages with a consistent prefix for easier debugging.
def log(msg)
Rails.logger.info "[InvoiceController] #{msg}"
+21 -4
View File
@@ -11,16 +11,31 @@
class QboController < ApplicationController
include AuthHelper
before_action :require_user, except: :webhook
# Connecting to QuickBooks and syncing are admin-only. Billing needs the "Bill issues" permission.
# The webhook is called by Intuit, not a user, and is verified by its signature instead.
before_action :require_admin, except: [:webhook, :bill]
before_action :require_login, only: :bill
skip_before_action :verify_authenticity_token, :check_if_login_required, only: :webhook
# Session key for the OAuth "state" value, which ties the callback to the admin who started connecting
OAUTH_STATE_SESSION_KEY = :qbo_oauth_state
# Initiates the OAuth authentication process by redirecting the user to the QuickBooks authorization URL. The callback URL is generated based on the application's settings and routes.
def authenticate
redirect_to QboOauthService.authorization_url(callback_url: callback_url)
state = SecureRandom.urlsafe_base64(32)
session[OAUTH_STATE_SESSION_KEY] = state
redirect_to QboOauthService.authorization_url(callback_url: callback_url, state: state), allow_other_host: true
end
# Handles the OAuth callback from QuickBooks. Exchanges the authorization code for access and refresh tokens, saves the connection details, and redirects to the sync page with a success notice. If any error occurs during the process, logs the error and redirects back to the plugin settings page with an error message.
def oauth_callback
# Only accept a callback for a connection this admin started (prevents swapping in another QBO company)
expected_state = session.delete(OAUTH_STATE_SESSION_KEY).to_s
unless expected_state.present? && ActiveSupport::SecurityUtils.secure_compare(expected_state, params[:state].to_s)
log "OAuth callback rejected: state did not match"
return redirect_to plugin_settings_path(:redmine_qbo), flash: { error: I18n.t(:notice_qbo_oauth_state_mismatch) }
end
QboOauthService.exchange!(code: params[:code], callback_url: callback_url, realm_id: params[:realmId])
redirect_to qbo_sync_path, flash: { notice: I18n.t(:label_connected) }
@@ -32,8 +47,10 @@ class QboController < ApplicationController
# Manual billing endpoint to trigger the billing process for a specific issue. Validates the issue and its associations, enqueues a job to bill the issue's time entries, and redirects back to the issue with a notice. If validation fails, redirects back with an error message.
def bill
issue = Issue.find_by(id: params[:id])
raise I18n.t(:notice_error_issue_not_found) unless issue
issue = Issue.visible.find_by(id: params[:id])
return render_404 unless issue
return deny_access unless User.current.allowed_to?(:bill_issues, issue.project)
raise I18n.t(:notice_billing_error_no_customer) unless issue.customer
raise I18n.t(:notice_billing_error_no_employee) unless issue.assigned_to&.employee_id.present?
raise I18n.t(:notice_billing_error_no_qbo) unless Qbo.exists?
+37 -23
View File
@@ -10,47 +10,61 @@
module AuthHelper
def require_user
return unless session[:token].nil?
if !User.current.logged?
flash[:error] = t :notice_forbidden
render_403
end
# The active customer share token stored in the session by customers#view, if any.
def customer_token
return @customer_token if defined?(@customer_token)
@customer_token = session[:token].present? ? CustomerToken.active.find_by(token: session[:token]) : nil
end
# True when the visitor is a customer using a share link rather than a logged-in user.
def customer_token_only?
!User.current.logged? && customer_token.present?
end
# Logged-in users pass. Customers with an active share link pass too (each controller then limits them
# to their own issue's documents). Everyone else is sent to the login page.
def require_login_or_customer_token
return true if User.current.logged?
return true if customer_token
require_login
end
# Kept for plugins that still call it (e.g. redmine_qbo_vehicles): requires a logged-in user.
# The old version effectively never ran; share-link customers use require_login_or_customer_token.
def require_user
return true if User.current.logged?
require_login
end
def allowed_to?(action)
return false if User.current.nil?
project = Project.find(params[:project_id])
project = Project.find_by(id: params[:project_id])
return false if project.nil?
return true if User.current.allowed_to?(action, project)
false
User.current.allowed_to?(action, project)
end
def check_permission(permission)
if !allowed_to?(permission)
flash[:error] = t :notice_forbidden
render_403
end
end
def global_check_permission(permission)
if !globaly_allowed_to?(permission)
flash[:error] = t :notice_forbidden
render_403
end
end
def globaly_allowed_to?( action)
# True if the user has the permission through any of their roles (or is an admin)
def globaly_allowed_to?(action)
return false if User.current.nil?
projects = Project.all
projects.each { |p|
if User.current.allowed_to?(action, p)
return true
end
}
false
User.current.allowed_to?(action, nil, global: true)
end
end
+35 -12
View File
@@ -17,23 +17,36 @@ class BillIssueTimeJob < ActiveJob::Base
issue = Issue.find(issue_id)
log "Starting billing for issue ##{issue.id}"
failure = nil
issue.with_lock do
unbilled_entries = issue.time_entries.where(billed: [false, nil]).lock
unbilled_entries = issue.time_entries.where(billed: [false, nil]).lock.includes(:activity).to_a
return if unbilled_entries.blank?
totals = aggregate_hours(unbilled_entries)
return if totals.blank?
log "Aggregated hours for billing: #{totals.inspect}"
qbo = QboConnectionService.current!
qbo.perform_authenticated_request do |access_token|
create_time_activities(issue, totals, access_token, qbo)
# Activities already sent to QBO (or deliberately skipped) in this run. If QBO fails part way, or the
# token refresh re-runs the block, finished activities are not sent again.
done = []
begin
qbo = QboConnectionService.current!
qbo.perform_authenticated_request do |access_token|
create_time_activities(issue, totals, access_token, qbo, done)
end
rescue => e
failure = e
end
# Only mark billed AFTER successful QBO creation
unbilled_entries.update_all(billed: true)
# Mark billed only the entries whose activity was finished, and commit that even if a later
# activity failed, so a retry only sends what's left
finished = unbilled_entries.select { |entry| done.include?(entry.activity&.name) }
TimeEntry.where(id: finished.map(&:id)).update_all(billed: true) if finished.any?
end
raise failure if failure
log "Completed billing for issue ##{issue.id}"
Qbo.update_time_stamp
rescue => e
@@ -45,25 +58,34 @@ class BillIssueTimeJob < ActiveJob::Base
# Aggregate time entries by activity name and sum their hours
def aggregate_hours(entries)
entries.includes(:activity)
.group_by { |e| e.activity&.name }
entries.group_by { |e| e.activity&.name }
.transform_values { |rows| rows.sum(&:hours) }
.compact
end
# Create TimeActivity records in QBO for each activity type with the appropriate hours and link them to the issue's assigned employee and customer
def create_time_activities(issue, totals, access_token, qbo)
# Adds each activity name to done once it has been created in QBO (or skipped because it can't be billed).
def create_time_activities(issue, totals, access_token, qbo, done)
log "Creating TimeActivity records in QBO for issue ##{issue.id}"
time_service = Quickbooks::Service::TimeActivity.new( company_id: qbo.realm_id, access_token: access_token)
item_service = Quickbooks::Service::Item.new( company_id: qbo.realm_id, access_token: access_token )
totals.each do |activity_name, hours_float|
next if activity_name.blank?
next if hours_float.to_f <= 0
next if done.include?(activity_name)
# Not billable: skipped, and marked billed as before
if activity_name.blank? || hours_float.to_f <= 0
done << activity_name
next
end
item = find_item(item_service, activity_name)
next unless item
unless item
log "No QBO item named #{activity_name.inspect}; skipping"
done << activity_name
next
end
hours, minutes = convert_hours(hours_float)
@@ -82,6 +104,7 @@ class BillIssueTimeJob < ActiveJob::Base
log "Creating TimeActivity for #{activity_name} (#{hours}h #{minutes}m)"
time_service.create(time_entry)
done << activity_name
end
end
+1 -1
View File
@@ -14,7 +14,7 @@ class QboWebhookProcessor
def self.process!(request:)
body = request.raw_post
signature = request.headers['intuit-signature']
secret = Setting.plugin_redmine_qbo['settingsWebhookToken']
secret = RedmineQbo.webhook_token_secret
raise "Invalid signature" unless valid_signature?(body, signature, secret)
+1 -1
View File
@@ -48,7 +48,7 @@ class WebhookProcessJob < ActiveJob::Base
Redmine::Hook.call_hook( :qbo_additional_entities ).each do |context|
next unless context
Array(context).each do |entity|
jobs.push(entity)
entities.push(entity)
log "Added additional QBO entity #{entity}"
end
end
+2 -5
View File
@@ -75,11 +75,8 @@ module QuickbooksOauth
# This method will construct and return an instance of the OAuth2::Client class that is configured with the consumer key, consumer secret and the appropriate URLs for the Intuit OAuth2 service. It will also set the sandbox mode based on the plugin settings. This method is used by the instance method oauth_client to create a new OAuth2 client for each instance of the model that includes this concern.
def construct_oauth2_client
oauth_consumer_key = Setting.plugin_redmine_qbo['settingsOAuthConsumerKey']
oauth_consumer_secret = Setting.plugin_redmine_qbo['settingsOAuthConsumerSecret']
# Are we are playing in the sandbox?
Quickbooks.sandbox_mode = Setting.plugin_redmine_qbo[:sandbox] ? true : false
Quickbooks.sandbox_mode = RedmineQbo.sandbox_mode?
log "Sandbox mode: #{Quickbooks.sandbox_mode}"
options = {
@@ -87,7 +84,7 @@ module QuickbooksOauth
authorize_url: "https://appcenter.intuit.com/connect/oauth2",
token_url: "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer"
}
OAuth2::Client.new(oauth_consumer_key, oauth_consumer_secret, options)
OAuth2::Client.new(RedmineQbo.oauth_consumer_key, RedmineQbo.oauth_consumer_secret, options)
end
end
+6 -2
View File
@@ -20,6 +20,9 @@ class Customer < QboBaseModel
before_validation :normalize_phone_numbers
self.primary_key = :id
qbo_sync push: true
# Normalize the local database column :name (capitalize each word, keep acronyms like LLC as typed)
normalizes :name, with: ->(name) { RedmineQbo::TitleCase.call(name.to_s.strip) }
acts_as_searchable columns: %w[name phone_number mobile_phone_number ],
scope: ->(_context) { left_joins(:project) },
@@ -61,8 +64,9 @@ class Customer < QboBaseModel
# Updates Both local DB name & QBO display_name
def name=(s)
details.display_name = s
super
super(s)
# Write the normalized value from Active Record to QBO details
details.display_name = self.name
end
# Normalizes phone numbers by removing non-digit characters. This method is called before validation to ensure that phone numbers are stored in a consistent format, which can help with searching and integration with external systems like QuickBooks Online.
+5 -1
View File
@@ -10,12 +10,16 @@
class Estimate < QboBaseModel
has_and_belongs_to_many :issues
has_many :issues
belongs_to :customer
validates_presence_of :doc_number, :id
self.primary_key = :id
qbo_sync push: false
def name
to_s
end
# returns a human readable string
def to_s
return self[:doc_number]
+233
View File
@@ -0,0 +1,233 @@
#The MIT License (MIT)
#
#Copyright (c) 2016 - 2026 rick barrette
#
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
require 'csv'
require 'did_you_mean'
require 'text'
# Finds customers by name and/or phone, tolerant of the ways duplicates sneak in:
# - nicknames: "Bill Smith" finds "William Smith", "Bob" finds "Robert" (about 2,800 pairs, see data/nicknames)
# - sound-alikes: "Jon" finds "John", "Smyth" finds "Smith", "Cathy" finds "Kathy" (Double Metaphone)
# - typos: "Willaim Smtih" finds "William Smith"
# - word order: "Smith, William" finds "William Smith"
# - partial: "will smi" finds "William Smith" while typing
# - phone: any 4+ digits, in any format, matched against both phone numbers
#
# Results are ranked best match first. Only id, name and phone numbers are loaded, and the prepared
# search data is cached until a customer changes, so searching stays fast as the customer list grows.
class CustomerSearchService
DEFAULT_LIMIT = 20
# Lowest score (0..1) a customer needs to be returned
MIN_SCORE = 0.72
# Bundled nickname data (Apache 2.0, see data/nicknames/README.md)
NICKNAMES_CSV = File.expand_path('../../data/nicknames/names.csv', __dir__)
# Groups missing from the bundled data. Add more here: every name in a group matches every other.
EXTRA_NICKNAME_GROUPS = [
%w[william liam],
%w[alexander xander],
%w[alexandra lexi],
%w[theodore theo],
%w[christopher kit]
].freeze
# Words that don't help tell customers apart
STOP_WORDS = %w[and the llc inc co corp company].freeze
# Returns matching Customer records, best match first.
def self.call(name: nil, phone: nil, limit: DEFAULT_LIMIT)
ids = rank(candidates, name: name, phone: phone, limit: limit).map(&:first)
return Customer.none if ids.empty?
Customer.where(id: ids).in_order_of(:id, ids)
end
# Prepared search rows for every customer, cached until any customer changes. Kept in this process's
# memory as well, so each keystroke doesn't reload it from the Rails cache.
def self.candidates
key = ['customer_search_candidates', 2, Customer.count, Customer.maximum(:updated_at).to_i]
cached_key, cached_rows = @candidates
return cached_rows if cached_key == key
rows = Rails.cache.fetch(key, expires_in: 12.hours) do
prepare(Customer.pluck(:id, :name, :phone_number, :mobile_phone_number))
end
@candidates = [key, rows]
rows
end
# [[id, name, phone, mobile], ...] -> [[id, name, phone_digits, tokens, sound_codes], ...]
def self.prepare(rows)
rows.map do |id, name, phone_number, mobile_number|
words = tokens(name)
phones = [phone_number, mobile_number].compact.map { |n| n.to_s.gsub(/\D/, '') }.reject(&:empty?)
[id, name.to_s, phones, words, words.map { |w| sound_codes(w) }]
end
end
# Pure ranking over prepared rows (no database), so it can be tested on its own.
# Returns [[id, score], ...] best first. A query of mostly digits is also treated as a phone number.
def self.rank(prepared, name: nil, phone: nil, limit: DEFAULT_LIMIT)
name = name.to_s.strip
phone_digits = phone.to_s.gsub(/\D/, '')
# "401-555-1234" typed into the name box is a phone search
name_digits = name.gsub(/\D/, '')
if phone_digits.empty? && name_digits.length >= 4 && name_digits.length >= name.gsub(/\s/, '').length * 0.7
phone_digits = name_digits
name = ''
end
query_words = tokens(name)
return [] if query_words.empty? && phone_digits.length < 4
query = query_words.map { |w| [w, sound_codes(w)] }
memo = {} # word-pair scores for this search; customer names repeat words a lot ("smith", "john")
scored = prepared.filter_map do |id, customer_name, phones, words, codes|
score = [
phone_digits.length >= 4 ? phone_score(phone_digits, phones) : 0.0,
query.any? ? name_score(query, words, codes, memo) : 0.0
].max
[id, score, customer_name] if score >= MIN_SCORE
end
scored.sort_by { |id, score, customer_name| [-score, customer_name.downcase, id] }
.first(limit)
.map { |id, score, _| [id, score.round(3)] }
end
# Lowercase words with accents and punctuation removed: "O'Brien-Smith, José" -> ["obrien", "smith", "jose"]
def self.tokens(text)
normalized = text.to_s.unicode_normalize(:nfkd).gsub(/\p{Mn}/, '').downcase
normalized = normalized.gsub(/['’]/, '').gsub(/[^a-z0-9]+/, ' ')
words = normalized.split
meaningful = words - STOP_WORDS
meaningful.empty? ? words : meaningful
end
# Double Metaphone codes (primary and alternate) for a word; empty for very short or numeric words
def self.sound_codes(word)
return [] if word.length < 3 || word.match?(/\d/)
Text::Metaphone.double_metaphone(word).compact.reject(&:empty?).uniq
end
def self.phone_score(digits, phones)
phones.map do |number|
if number == digits || number.end_with?(digits) && digits.length >= 7 then 1.0
elsif number.include?(digits) then 0.9
else 0.0
end
end.max || 0.0
end
# Each query word is matched to its best word in the customer's name; the score is the average.
# A query word with no match at all halves the score, so "bill jones" won't match "william smith".
def self.name_score(query, words, codes, memo = {})
return 0.0 if words.empty?
best = query.map do |q_word, q_codes|
scores = (memo[q_word] ||= {})
words.each_with_index.map do |c_word, i|
scores.fetch(c_word) { scores[c_word] = word_score(q_word, q_codes, c_word, codes[i]) }
end.max
end
score = best.sum / best.size
score *= 0.5 if best.any?(&:zero?)
return score if score >= 0.9 # already a strong match; skip the whole-name comparison
# Also compare the names with spaces removed, for "Mc Donald" vs "McDonald". Only worth it when the
# strings could reach the 0.92 bar at all: same first letter and nearly the same length.
query_joined = query.map(&:first).join
name_joined = words.join
return score unless query_joined[0] == name_joined[0] && (query_joined.length - name_joined.length).abs <= 2
joined = DidYouMean::JaroWinkler.distance(query_joined, name_joined)
[score, joined >= 0.92 ? joined * 0.9 : 0.0].max
end
def self.word_score(query, query_codes, candidate, candidate_codes)
return 1.0 if query == candidate
return 0.95 if nicknames?(query, candidate)
return 0.9 if query.length >= 2 && candidate.start_with?(query) # still typing: "wil" -> "william"
return 0.85 if query.length >= 2 && nickname_prefix?(query, candidate) # "bil" -> "william" via "bill"
similarity = DidYouMean::JaroWinkler.distance(query, candidate)
# Sounds the same ("jon"/"john", "smyth"/"smith"). The similarity check keeps unrelated words that
# happen to share a code (e.g. "john" and "ann" via the Spanish-J alternate) from matching.
return 0.88 if similarity >= 0.7 && (query_codes & candidate_codes).any?
return 0.8 if query.length >= 4 && candidate.include?(query) # "donald" in "mcdonald"
return 0.7 if query.length == 1 && candidate.start_with?(query) # an initial
# Typos. Short words need to be closer to count.
threshold = [query.length, candidate.length].min <= 4 ? 0.9 : 0.85
similarity >= threshold ? similarity * 0.9 : 0.0
end
# Nickname matching treats the data as connections between names (the file lists both directions,
# e.g. "william -> bill" and "bill -> william"). Two names match if they are connected directly, or both
# connect to a LONGER name they're short for: "bill" and "will" via "william". Requiring the shared
# name to be longer stops unrelated full names linking through a short one: "bill" is listed for both
# William and Robert, but that doesn't make William match Robert.
def self.nicknames?(a, b)
related_names(a).include?(b)
end
# A partly typed nickname of the candidate's name, e.g. "bil" for "william" (via "bill")
def self.nickname_prefix?(query, candidate)
related_names(candidate).any? { |name| name.start_with?(query) }
end
# All names interchangeable with name, cached per process
def self.related_names(name)
cache = (@related_names_cache ||= {})
cache[name] ||= begin
graph = nickname_graph
direct = graph.fetch(name, EMPTY)
through_full_names = direct.select { |full| full.length > name.length }.flat_map do |full|
graph.fetch(full, EMPTY).select { |other| other.length < full.length }
end
((direct + through_full_names).uniq - [name]).freeze
end
end
EMPTY = [].freeze
# name => [connected names], built once per process from the bundled data plus EXTRA_NICKNAME_GROUPS
def self.nickname_graph
@nickname_graph ||= begin
graph = Hash.new { |h, k| h[k] = [] }
connect = lambda do |a, b|
next if a.empty? || b.empty? || a == b
graph[a] << b
graph[b] << a
end
if File.exist?(NICKNAMES_CSV)
CSV.foreach(NICKNAMES_CSV, headers: true) do |row|
connect.call(row['name1'].to_s.strip.downcase, row['name2'].to_s.strip.downcase)
end
end
EXTRA_NICKNAME_GROUPS.each do |group|
group.combination(2) { |a, b| connect.call(a, b) }
end
graph.transform_values { |names| names.uniq.freeze }.to_h.freeze
end
end
end
+13
View File
@@ -0,0 +1,13 @@
#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.
class EstimateService < ServiceBase
end
@@ -29,8 +29,6 @@ class InvoiceAttachmentService
issue.save! if issue.changed?
log "Attached invoice ##{@invoice.id} to issue ##{issue.id}"
end
InvoiceCustomFieldSyncService.new(issue, @invoice, @remote).sync
end
end
@@ -1,69 +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.
class InvoiceCustomFieldSyncService
def initialize(issue, invoice, remote)
@issue = issue
@invoice = invoice
@remote = remote
end
# Sync custom fields on the issue based on the invoice data, then push changes to QBO if any fields were updated
def sync
return if @invoice.qbo_sync_locked?
log "Syncing custom fields for issue ##{@issue.id} based on invoice ##{@invoice.doc_number}"
changed = false
# Process Invoice Custom Fields via Hooks
Redmine::Hook.call_hook(
:process_invoice_custom_fields,
issue: @issue,
invoice: @remote
).each do |context|
next unless context
changed ||= context[:is_changed]
log "Custom fields updated by hook, marking invoice for push to QBO" if context[:is_changed]
end
# Process Issue Custom Values from any issue custom fields that match the invoice custom fields
begin
value = @issue.custom_values.find_by(custom_field_id: CustomField.find_by_name(cf.name).id)
# Check to see if the value is blank...
if not value.value.to_s.blank?
# Check to see if the value is diffrent
if not cf.string_value.to_s.eql? value.value.to_s
# update the custom field on the invoice
cf.string_value = value.value.to_s
is_changed = true
end
end
rescue
# Nothing to do here, there is no match
end
push_if_changed if changed
end
private
# If any custom fields were changed during the sync process, this method will trigger a push of the invoice data to QuickBooks Online to ensure that the remote data stays in sync with the local changes. It uses the InvoicePushService to handle the actual communication with QBO.
def push_if_changed
InvoicePushService.new(@invoice).push
end
def log(msg)
Rails.logger.info "[InvoiceCustomFieldSyncService] #{msg}"
end
end
+3 -2
View File
@@ -12,11 +12,12 @@ class QboOauthService
# Generates the QuickBooks OAuth authorization URL with the specified callback URL.
# The URL includes necessary parameters such as response type, state, and scope.
def self.authorization_url(callback_url:)
# The state value must be stored by the caller and checked when the callback arrives.
def self.authorization_url(callback_url:, state:)
client.auth_code.authorize_url(
redirect_uri: callback_url,
response_type: "code",
state: SecureRandom.hex(12),
state: state,
scope: "com.intuit.quickbooks.accounting"
)
end
+71 -7
View File
@@ -1,11 +1,75 @@
<%= link_to t(:label_appointment), "https://calendar.google.com/calendar/render?action=TEMPLATE&text=#{@customer.name}+-&details=#{ link_to t(:customer_details), "https://#{Setting.host_name}#{customer_path @customer.id}"}%0A#{@customer.primary_phone}%3Cbr/%3E+&dates=#{Time.now.strftime("%Y%m%d")}T090000/#{Time.now.strftime("%Y%m%d")}T170000", target: :_blank, id: :appointment_link %>
<%= call_hook :customer_actions_top, { customer: @customer } %>
<br/>
<br/>
<p>
<%= link_to t(:label_new_issue), new_issue_path(issue: { customer_id: @customer.id }), id: "dynamic-new-issue-link", target: :_blank %>
</p>
<%= link_to t(:label_create_estimate), "https://qbo.intuit.com/app/estimate?nameId=#{@customer.id}", target: :_blank %>
<p>
<%= link_to t(:label_create_estimate), "https://qbo.intuit.com/app/estimate?nameId=#{@customer.id}", target: :_blank %>
</p>
<br/>
<br/>
<p>
<%= link_to t(:label_create_payment), "https://qbo.intuit.com/app/recvpayment?nameId=#{@customer.id}", target: :_blank %>
</p>
<%= button_to t(:label_edit_customer), edit_customer_path(@customer), method: :get%>
<%= call_hook :customer_actions_bottom, { customer: @customer } %>
<% if User.current.allowed_to?(:edit_customers, nil, global: true) %>
<%= button_to t(:label_edit_customer), edit_customer_path(@customer), method: :get%>
<% end %>
<script>
function handleSingleSelect(event, className) {
if (event.target.checked) {
// Uncheck all other checkboxes of the same type
document.querySelectorAll('.' + className).forEach(cb => {
if (cb !== event.target) {
cb.checked = false;
}
});
}
updateLink();
}
// Bind single-select behavior to checkboxes once the DOM is loaded
document.addEventListener('DOMContentLoaded', function() {
document.querySelectorAll('.estimate-checkbox').forEach(cb => {
cb.addEventListener('change', (e) => handleSingleSelect(e, 'estimate-checkbox'));
});
document.querySelectorAll('.vehicle-checkbox').forEach(cb => {
cb.addEventListener('change', (e) => handleSingleSelect(e, 'vehicle-checkbox'));
});
});
function updateLink() {
const link = document.getElementById('dynamic-new-issue-link');
if (!link) return;
// Cache the pristine base URL on first run
if (!link.dataset.baseUrl) {
link.dataset.baseUrl = link.getAttribute('href');
}
// Build base URL object
let url = new URL(link.dataset.baseUrl, window.location.origin);
// 1. Handle Single Estimate
const checkedEstimate = document.querySelector('.estimate-checkbox:checked');
if (checkedEstimate) {
url.searchParams.set('issue[estimate_id]', checkedEstimate.value);
} else {
url.searchParams.delete('issue[estimate_id]');
}
// 2. Handle Single Vehicle
const checkedVehicle = document.querySelector('.vehicle-checkbox:checked');
if (checkedVehicle) {
url.searchParams.set('issue[vehicle_id]', checkedVehicle.value);
} else {
url.searchParams.delete('issue[vehicle_id]');
}
// Update the link's href attribute
link.setAttribute('href', url.toString());
}
</script>
+25 -29
View File
@@ -2,59 +2,55 @@
<tbody>
<tr>
<th><%=t(:label_name)%></th>
<th><%= t(:label_name) %></th>
<td><%= customer.name %></td>
</tr>
<tr>
<th><%=t(:label_email)%></th>
<th><%= t(:label_email) %></th>
<td><%= customer.email %></td>
</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>
</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>
</tr>
<tr>
<th><%=t(:label_billing_address)%></th>
<td><pre><%= @billing_address %></pre></td>
</tr>
<tr>
<th><%=t(:label_shipping_address)%></th>
<td><pre><%= @shipping_address %></pre></td>
<tr>
<th><%= t(:label_billing_address) %></th>
<td><pre><%= @billing_address %></pre></td>
</tr>
<tr>
<th><%=t(:label_account_balance)%></th>
<td>$<%= customer.balance %></td>
<th><%= t(:label_shipping_address) %></th>
<td><pre><%= @shipping_address %></pre></td>
</tr>
<tr>
<th colspan="2"><h4><%=t(:field_notes)%></hr></th>
<th><%= t(:label_account_balance) %></th>
<td>$<%= customer.balance %></td>
</tr>
<% if customer.notes.present? %>
<tr>
<th colspan="2"><h4><%= t(:field_notes) %></h4></th>
</tr>
<tr>
<td colspan="2">
<pre id="note-display" style="text-align: left; white-space: pre-wrap; font-family: inherit;">
<%= customer.notes %>
</pre>
</td>
</tr>
<script>
const preElement = document.getElementById('note-display');
// This takes the text, trims the edges, and puts it back
preElement.textContent = preElement.textContent.trim();
</script>
<tr>
<td colspan="2">
<div class="wiki">
<%= textilizable(customer, :notes) %>
</div>
</td>
</tr>
<% end %>
</tbody>
</table>
<br/>
<br/>
<br/>
+41 -56
View File
@@ -1,59 +1,44 @@
<div class="row">
<div class="span6 columns">
<fieldset>
<%= form_for @customer do |f| %>
<%= error_messages_for 'customer' %>
<%= form_for @customer do |f| %>
<div class="clearfix">
<%=t(:label_display_name)%>
<div class="input">
<%= f.text_field :name, required: true, autocomplete: "off" %>
</div>
</div>
<div class="clearfix">
<%=t(:label_primary_phone)%>
<div class="input">
<%= f.telephone_field :primary_phone, autocomplete: "off" %>
</div>
</div>
<div class="clearfix">
<%=t(:label_mobile_phone)%>:
<div class="input">
<%= f.telephone_field :mobile_phone, autocomplete: "off" %>
</div>
</div>
<div class="clearfix">
<%=t(:label_email)%>:
<div class="input">
<%= f.email_field :email, autocomplete: "off" %>
</div>
</div>
<div class="clearfix">
<%=t(:field_notes)%>:
<div class="input">
<p>
<%= content_tag :span, id: "issue_description_and_toolbar" do %>
<%= f.text_area :notes,
cols: 60,
rows: 10,
accesskey: accesskey(:edit),
class: 'wiki-edit',
no_label: true %>
<% end %>
</p>
<%= wikitoolbar_for :issue_description %>
</div>
</div>
<div class="actions">
<%= f.submit %>
</div>
<% end %>
<div class="box tabular">
</fieldset>
<p>
<%= f.label :name, t(:label_display_name) %>
<%= f.text_field :name, required: true, class: "customer-name", autocomplete: "off", data: { autocomplete_url: "/customers/autocomplete" } %>
</p>
<p>
<%= f.label :primary_phone, t(:label_primary_phone) %>
<%= f.telephone_field :primary_phone, autocomplete: "off" %>
</p>
<p>
<%= f.label :mobile_phone, t(:label_mobile_phone) %>
<%= f.telephone_field :mobile_phone, autocomplete: "off" %>
</p>
<p>
<%= f.label :email, t(:label_email) %>
<%= f.email_field :email, autocomplete: "off" %>
</p>
<p>
<%= f.label :notes, t(:field_notes) %>
<%= f.text_area :notes,
rows: 8,
class: 'wiki-edit',
style: 'width: 99%;',
id: 'customer_notes' %>
<% unless local_assigns[:hide_toolbar] %>
<%= wikitoolbar_for 'customer_notes' %>
<% end %>
</p>
</div>
</div>
<% unless local_assigns[:hide_submit] %>
<p class="buttons">
<%= submit_tag t(:button_save) %>
</p>
<% end %>
<% end %>
+4 -2
View File
@@ -1,6 +1,8 @@
<%= form_tag(customers_path, method: "get", id: "customer-search-form") do %>
<%= text_field_tag :search, params[:search], placeholder: t(:label_search_customers), autocomplete: "off" %>
<%= text_field_tag :search, params[:search], class: "customer-name", placeholder: t(:label_search_customers), autocomplete: "off", data: { autocomplete_url: "/customers/autocomplete" } %>
<%= submit_tag t(:label_search) %>
<% end %>
<%= button_to t(:label_new_customer), new_customer_path, method: :get%>
<% if User.current.allowed_to?(:add_customers, nil, global: true) %>
<%= button_to t(:label_new_customer), new_customer_path, method: :get%>
<% end %>
<%= button_to(t(:label_sync), qbo_sync_path, method: :get) if User.current.admin?%>
+1 -2
View File
@@ -1,3 +1,2 @@
<h2><%=t(:label_new_customer)%></h2>
<br/>
<%= render partial: 'customers/form' %>
<%= render partial: 'customers/form' %>
+1 -1
View File
@@ -1,4 +1,4 @@
<h2><%=t(:field_customer)%> #<%= @customer.id %> - <%= link_to @customer.to_s, "https://#{Setting.plugin_redmine_qbo[:sandbox] ? "sandbox" : "app"}.qbo.intuit.com/app/customerdetail?nameId=#{@customer.id}", target: :_blank %> </h2>
<h2><%=t(:field_customer)%> #<%= @customer.id %> - <%= link_to @customer.to_s, "https://#{RedmineQbo.sandbox_mode? ? "sandbox" : "app"}.qbo.intuit.com/app/customerdetail?nameId=#{@customer.id}", target: :_blank %> </h2>
<div class="issue">
<div class="splitcontent">
+2 -2
View File
@@ -2,11 +2,11 @@
<% estimates.sort.reverse.each do |estimate| %>
<div class="row">
<%= check_box_tag "estimate_ids[]", estimate.id, false, onchange: "updateLink()", data: { url: estimate_path(estimate), text: "Estimate ##{estimate.to_s}" }, class: "estimate-checkbox appointment" %>
<%= check_box_tag "estimate_ids[]", estimate.id, false, onchange: "updateLink()", data: { text: "Estimate ##{estimate.doc_number}" }, class: "estimate-checkbox appointment" %>
<b><%= link_to "##{estimate.doc_number}", estimate_path(estimate), target: :_blank %></b> <%= estimate.txn_date %>
</div>
<% end %>
<% else %>
<p><%=t(:label_no_estimates)%>.</p>
<% end %>
<% end %>
+5 -5
View File
@@ -6,17 +6,17 @@
<div class="box tabular">
<p>
<label><%= t(:label_client_id) %></label>
<%= text_field_tag 'settings[settingsOAuthConsumerKey]', settings['settingsOAuthConsumerKey'], size: 50 %>
<%= text_field_tag 'settings[oauth_consumer_key]', settings[:oauth_consumer_key], size: 50 %>
</p>
<p>
<label><%= t(:label_client_secret) %></label>
<%= password_field_tag 'settings[settingsOAuthConsumerSecret]', settings['settingsOAuthConsumerSecret'], size: 50 %>
<%= password_field_tag 'settings[oauth_consumer_secret]', settings[:oauth_consumer_secret], size: 50 %>
</p>
<p>
<label><%= t(:label_webhook_token) %></label>
<%= text_field_tag 'settings[settingsWebhookToken]', settings['settingsWebhookToken'], size: 50 %>
<%= text_field_tag 'settings[webhook_token]', settings[:webhook_token], size: 50 %>
</p>
<p>
@@ -48,13 +48,13 @@
<p>
<label><%= t(:label_invoice_count) %></label>
<%= Invoice.count %>
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Item.last_sync %>)</em>
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Invoice.last_sync %>)</em>
</p>
<p>
<label><%= t(:label_estimate_count) %></label>
<%= Estimate.count %>
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Account.last_sync %>)</em>
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Estimate.last_sync %>)</em>
</p>
<p>
+4 -1
View File
@@ -1,6 +1,9 @@
<% if User.current.logged? %>
<%= render partial: 'customers/sidebar' %>
<% if User.current.allowed_to?(:view_customers, nil, global: true) %>
<%= render partial: 'customers/sidebar' %>
<% end %>
<%= render partial: 'estimates/sidebar' %>
<% end %>
+3 -3
View File
@@ -55,11 +55,11 @@
select: function(event, ui) {
$input.val(ui.item.value); // visible text
$("#issue_customer_id").val(ui.item.id); // hidden ID
$("#customer_id").val(ui.item.id); // hidden ID
// trigger Redmine form update safely
setTimeout(function() {
$("#issue_customer_id").trigger("change");
$("#customer_id").trigger("change");
}, 0);
return false;
@@ -68,7 +68,7 @@
change: function(event, ui) {
// clear hidden field if no valid selection
if (!ui.item && !$input.val()) {
$("#issue_customer_id").val("");
$("#customer_id").val("");
}
}
});
+7
View File
@@ -11,6 +11,9 @@
# English strings go here for Rails i18n
# Usage I18n.t(:label)
en:
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_share_issues_with_customers: "Share issues with customers"
button_bulk_pdf: "Bulk PDF"
customer_details: "Customer Details"
field_billed: "Billed"
@@ -34,8 +37,10 @@ en:
label_closed_issues: "Closed Issues"
label_connected: "Successfully connected to QuickBooks"
label_create_estimate: "Create Estimate"
label_create_payment: "Create Payment"
label_customer_count: "Customer Count"
label_customer_link_expires: "This customer link expires in"
label_customer: "Customer"
label_customers: "Customers"
label_delete: "Delete"
label_deposit_into: "Deposit to Account"
@@ -49,6 +54,7 @@ en:
label_error: "Error"
label_estimate_404: "Estimate not found"
label_estimate_count: "Estimate Count"
label_estimate: "Estimate"
label_estimates: "Estimates"
label_hours: "Hours"
label_invoice_404: "Invoice not found"
@@ -62,6 +68,7 @@ en:
label_model: "Model"
label_name: "Name"
label_new_customer: "New Customer"
label_new_issue: "New Issue"
label_qbo_never_synced: "Never Synced"
label_no_customers: "There are no customers matching the search term(s)."
label_no_estimates: "No Estimates"
+1 -1
View File
@@ -27,7 +27,7 @@ get 'estimates/doc/', to: 'estimates#doc', as: :estimate_doc
get 'invoices/:id', to: 'invoices#show', as: :invoice
#manual billing
get 'bill/:id', to: 'qbo#bill', as: :bill
post 'bill/:id', to: 'qbo#bill', as: :bill
#customer issue view
get 'customers/view/:token', to: 'customers#view', as: :view
+201
View File
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright {yyyy} {name of copyright owner}
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
+9
View File
@@ -0,0 +1,9 @@
# Nickname data
`names.csv` is from the [nicknames](https://github.com/carltonnorthern/nicknames) project by
Carlton Northern and contributors (commit `ed160b3`), used under the Apache License 2.0
(see `LICENSE.txt`). It is unmodified.
Each row is `name1,has_nickname,name2`. `CustomerSearchService` uses it so that a search for
"Bill Smith" finds "William Smith". To update it, replace `names.csv` with a newer copy from the
project; extra name groups can also be added in `CustomerSearchService::EXTRA_NICKNAME_GROUPS`.
File diff suppressed because it is too large. Load diff
+13 -12
View File
@@ -14,7 +14,7 @@ Redmine::Plugin.register :redmine_qbo do
name 'Redmine QBO plugin'
author 'Rick Barrette'
description 'A pluging for Redmine to connect with QuickBooks Online to create Time Activity Entries for billable hours logged when an Issue is closed'
version '2026.3.12'
version '2026.10.1'
url 'https://github.com/rickbarrette/redmine_qbo'
author_url 'https://barrettefabrication.com'
settings default: {empty: true}, partial: 'qbo/settings'
@@ -30,12 +30,19 @@ Redmine::Plugin.register :redmine_qbo do
# set per_page globally
WillPaginate.per_page = 20
# Permissions for security
permission :view_customers, customers: :index, public: false
permission :add_customers, customers: :new, public: false
# Global Permissions
# autocomplete and the filter_* actions feed the customer, estimate and invoice pickers on issue forms
permission :view_customers, { customers: [:index, :show, :autocomplete,
:filter_estimates_by_customer, :filter_invoices_by_customer] }, global: true
permission :add_customers, { customers: [:new, :create] }, global: true
permission :edit_customers, { customers: [:edit, :update] }, global: true
permission :share_issues_with_customers, { customers: [:share] }, global: true
# Project permissions
permission :bill_issues, { qbo: [:bill] }
# Register top menu items
menu :top_menu, :customers, { controller: :customers, action: :index }, caption: :label_customers, if: Proc.new {User.current.logged?}
menu :top_menu, :customers, { controller: :customers, action: :index }, caption: :label_customers, if: Proc.new {User.current.allowed_to?(:view_customers, nil, global: true)}
Redmine::Search.map do |search|
search.register :customers
@@ -43,10 +50,4 @@ Redmine::Plugin.register :redmine_qbo do
end
# Dynamically load all Hooks & Patches recursively
base_dir = File.join(File.dirname(__FILE__), 'lib')
# '**' looks inside subdirectories, '*.rb' matches Ruby files
Dir.glob(File.join(base_dir, '**', '*.rb')).sort.each do |file|
require file
end
RedmineQbo.setup
+64
View File
@@ -0,0 +1,64 @@
#The MIT License (MIT)
#
#Copyright (c) 2026 rick barrette
#
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
module RedmineQbo
def self.setup
# === Models ===
Issue.prepend RedmineQbo::Patches::IssuePatch
User.prepend RedmineQbo::Patches::UserPatch
# === Queries ===
IssueQuery.prepend RedmineQbo::Patches::QueryPatch
TimeEntryQuery.prepend RedmineQbo::Patches::TimeEntryQueryPatch
# === Controllers ===
RedmineQbo::Patches::IssuesControllerPatch.apply
RedmineQbo::Patches::AttachmentsControllerPatch.apply
# === Helpers / Exports ===
Redmine::Export::PDF::IssuesPdfHelper.prepend RedmineQbo::Patches::PdfPatch
# === Hooks ===
RedmineQbo::Hooks::IssuesHookListener
RedmineQbo::Hooks::UsersShowHookListener
RedmineQbo::Hooks::ViewHookListener
# If the SubtaskFieldCopier plugin is installed, register our fields
if defined?(SubtaskFieldCopier)
SubtaskFieldCopier.registered_fields << :customer
SubtaskFieldCopier.registered_fields << :estimate
# Ensure there are no duplicates in case of hot-reloads in development mode
SubtaskFieldCopier.registered_fields.uniq!
end
end
def self.settings
Setting.plugin_redmine_qbo
end
def self.oauth_consumer_key
settings[:oauth_consumer_key]
end
def self.oauth_consumer_secret
settings[:oauth_consumer_secret]
end
def self.sandbox_mode?
settings[:sandbox] ? true : false
end
def self.webhook_token_secret
settings[:webhook_token]
end
end
@@ -46,7 +46,7 @@ module RedmineQbo
# This hidden field is used for the customer ID for the issue
# the onchange event will reload the issue form via ajax to update the available estimates
customer_id = f.hidden_field :customer_id,
id: "issue_customer_id",
id: "customer_id",
onchange: js_path.html_safe
# Generate the drop down list of quickbooks estimates owned by the selected customer
@@ -15,10 +15,7 @@ module RedmineQbo
# View User
def view_users_form(context={})
# Update the users
#Employee.update_all
# Check to see if there is a quickbooks user attached to the issue
@selected = context[:user]&.employee&.id
@@ -8,41 +8,56 @@
#
#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_dependency 'attachments_controller'
module RedmineQbo
module Patches
module AttachmentsControllerPatch
def self.apply
AttachmentsController.class_eval do
# 1. PREPEND: Must run before ANY of Redmine's ApplicationController filters
prepend_before_action :load_customer_token
def self.included(base)
# 2. Skip global login redirects if the user holds a valid token for this file
skip_before_action :check_if_login_required, if: :valid_customer_token?
skip_before_action :check_project_privacy, raise: false, if: :valid_customer_token?
base.class_eval do
# Note: We do NOT need to skip :read_authorize anymore.
# Because we patched Attachment#visible?, read_authorize will pass naturally!
# check if login is globally required to access the application
def check_if_login_required
# no check needed if user is already logged in
return true if User.current.logged?
# Pull up the attachmet, & verify if we have a valid token for the Issue
attachment = Attachment.find(params[:id])
token = CustomerToken.where("token = ? and expires_at > ?", session[:token], Time.now)
token = token.first
unless token.nil?
return true if token.issue_id == attachment.container_id
private
# Kept on the controller instance (one per request) rather than Thread.current, which is reused
# across requests by the web server and could carry one customer's token into another request.
def load_customer_token
@customer_token = session[:token].present? ? CustomerToken.active.find_by(token: session[:token]) : nil
end
def valid_customer_token?
token = @customer_token
return false unless token
# 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])
return false unless attachment
# Allow if attachment belongs directly to the Issue
if attachment.container_type == 'Issue' && attachment.container_id == token.issue_id
return true
end
require_login if Setting.login_required?
# Allow if attachment belongs to a Journal (comment) on the Issue
if attachment.container_type == 'Journal' && attachment.container.journalized_type == 'Issue' && attachment.container.journalized_id == token.issue_id
return true
end
false
end
end
end
end
# Add module to AttachmentsController
AttachmentsController.send(:include, AttachmentsControllerPatch)
end
end
end
+22 -44
View File
@@ -8,60 +8,40 @@
#
#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_dependency 'issue'
module RedmineQbo
module Patches
module IssuePatch
extend ActiveSupport::Concern
def self.included(base)
base.extend(ClassMethods)
base.send(:include, InstanceMethods)
prepended do
belongs_to :customer
belongs_to :customer_token
belongs_to :estimate
has_and_belongs_to_many :invoices
base.class_eval do
belongs_to :customer, class_name: 'Customer', foreign_key: :customer_id, optional: true
belongs_to :customer_token, primary_key: :id
belongs_to :estimate, primary_key: :id
has_and_belongs_to_many :invoices
before_save :titlize_subject
after_commit :enqueue_billing, on: :update
end
before_save :titlize_subject
after_commit :enqueue_billing, on: :update
end
module ClassMethods
# Enqueue a background job to bill the time spent on this issue to QuickBooks if the issue is closed and assigned to an employee
def enqueue_billing
log "Checking if issue needs billing for ##{id}"
return unless closed? && customer.present? && assigned_to&.employee_id.present?
log "Enqueuing billing for issue ##{id}"
BillIssueTimeJob.perform_later(id)
end
module InstanceMethods
# Capitalize each word of the subject for consistent billing descriptions, without lowercasing
# the rest of the word (keeps LED, JL, 4x4 as typed). Only runs when the subject changes.
def titlize_subject
return unless subject.present? && will_save_change_to_subject?
# Enqueue a background job to bill the time spent on this issue to the associated customer in Quickbooks, if the issue is closed and has a customer assigned.
def enqueue_billing
log "Checking if issue needs to be billed for issue ##{id}"
return unless closed?
return unless customer.present?
return unless assigned_to&.employee_id.present?
log "Enqueuing billing for issue ##{id}"
BillIssueTimeJob.perform_later(id)
end
# Titlize the subject of the issue before saving to ensure consistent formatting for billing descriptions in Quickbooks
def titlize_subject
log "Titlizing subject for issue ##{id}"
self.subject = subject.split(/\s+/).map do |word|
if word =~ /[A-Z]/ && word =~ /[0-9]/
word
else
word.capitalize
end
end.join(' ')
end
log "Titlizing subject for issue ##{id}"
self.subject = RedmineQbo::TitleCase.call(subject)
end
# This method is used to generate a shareable token for the customer associated with this issue, which can be used to link the issue to the corresponding customer in Quickbooks for billing and tracking purposes.
# Generate a shareable token linking this issue to the customer for QuickBooks
def share_token
CustomerToken.get_token(self)
end
@@ -69,10 +49,8 @@ module RedmineQbo
private
def log(msg)
Rails.logger.info "[IssuePatch] #{msg}"
Rails.logger.info "[IssuePatch] #{msg}"
end
end
Issue.send(:include, IssuePatch)
end
end
@@ -7,30 +7,36 @@
#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_dependency 'issues_controller'
module RedmineQbo
module Patches
module IssuesControllerPatch
module Helper
# Extend the watcher links to include billing and share options
def watcher_link(issue, user)
link = ''
link = link_to(I18n.t(:label_bill_time), bill_path( issue.id ), method: :get, class: 'icon icon-email-add') if user.admin?
link << link_to(I18n.t(:label_share), share_path( issue.id ), method: :get, target: :_blank, class: 'icon icon-shared') if user.logged?
link.html_safe + super
links = ''
# Users with the "Bill issues" permission can bill time (POST, so it can't be triggered by a plain link)
if user.allowed_to?(:bill_issues, issue.project)
links << link_to(I18n.t(:label_bill_time), bill_path(issue.id), method: :post,
data: { confirm: I18n.t(:text_are_you_sure) }, class: 'icon icon-email-add')
end
# Users with the "Share issues with customers" permission can create a customer link
if user.allowed_to?(:share_issues_with_customers, nil, global: true)
links << link_to(I18n.t(:label_share), share_path(issue.id), method: :get, target: :_blank, class: 'icon icon-shared')
end
# Append to the original watcher links
(links.html_safe + super).html_safe
end
end
def self.included(base)
base.class_eval do
def self.apply
IssuesController.class_eval do
helper Helper
end
end
end
end
# Add module to IssuessController
IssuesController.send(:include, IssuesControllerPatch)
end
end
+340 -257
View File
@@ -8,278 +8,361 @@
#
#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_dependency 'redmine/export/pdf'
require_dependency 'redmine/export/pdf/issues_pdf_helper'
module RedmineQbo
module Patches
module PdfPatch
extend ActiveSupport::Concern
def self.included(base)
base.send(:include, InstanceMethods)
base.class_eval do
alias_method :issue_to_pdf, :issue_to_pdf_with_patch
alias_method :issue_to_pdf_with_patch, :issue_to_pdf
end
end
# Rows returned by the :pdf_left / :pdf_right hooks are [label, text], or
# [label, text, { html: "..." }] to draw the value as simple HTML (e.g. part of it in <b>).
# text is still required: it sizes the row. Other plugins can check this constant before
# sending HTML values, so they keep working with older versions of this plugin.
PDF_HTML_VALUES = true
module InstanceMethods
def issue_to_pdf(issue, assoc={})
pdf = setup_pdf(issue)
def issue_to_pdf_with_patch(issue, assoc={})
pdf = ::Redmine::Export::PDF::ITCPDF.new(current_language)
pdf.set_title("#{issue.project} - #{issue.tracker} ##{issue.id}")
pdf.alias_nb_pages
pdf.footer_date = format_date(Date.today)
pdf.add_page
pdf.SetFontStyle('B',11)
buf = "#{issue.project} - #{issue.tracker} ##{issue.id}"
pdf.RDMMultiCell(190, 5, buf)
pdf.SetFontStyle('',8)
base_x = pdf.get_x
i = 1
issue.ancestors.visible.each do |ancestor|
pdf.set_x(base_x + i)
buf = "#{ancestor.tracker} # #{ancestor.id} (#{ancestor.status.to_s}): #{ancestor.subject}"
pdf.RDMMultiCell(190 - i, 5, buf)
i += 1 if i < 35
end
pdf.SetFontStyle('B',11)
pdf.RDMMultiCell(190 - i, 5, issue.subject.to_s)
pdf.SetFontStyle('',8)
pdf.RDMMultiCell(190, 5, "#{format_time(issue.created_on)} - #{issue.author}")
pdf.ln
render_header(pdf, issue)
render_ancestors_and_subject(pdf, issue)
left, right = build_issue_attributes(issue)
render_attributes_grid(pdf, left, right)
customer = issue.customer.name if issue.customer
left = []
left << [l(:field_status), issue.status]
left << [l(:field_priority), issue.priority]
left << [l(:field_customer), customer]
left << [l(:field_assigned_to), issue.assigned_to] unless issue.disabled_core_fields.include?(:assigned_to_id)
#left << [l(:field_category), issue.category] unless issue.disabled_core_fields.include?(:category_id)
#left << [l(:field_fixed_version), issue.fixed_version] unless issue.disabled_core_fields.include?(:fixed_version_id)
log "Calling :pdf_left hook"
left_hook_output = Redmine::Hook.call_hook :pdf_left, { issue: issue }
unless left_hook_output.nil?
left_hook_output.each do |l|
left.concat l unless l.nil?
end
end
right = []
right << [l(:field_start_date), format_date(issue.start_date)] unless issue.disabled_core_fields.include?(:start_date)
right << [l(:field_due_date), format_date(issue.due_date)] unless issue.disabled_core_fields.include?(:due_date)
right << [l(:field_done_ratio), "#{issue.done_ratio}%"] unless issue.disabled_core_fields.include?(:done_ratio)
right << [l(:field_estimated_hours), l_hours(issue.estimated_hours)] unless issue.disabled_core_fields.include?(:estimated_hours)
right << [l(:label_spent_time), l_hours(issue.total_spent_hours)] if User.current.allowed_to?(:view_time_entries, issue.project)
log "Calling :pdf_right hook"
right_hook_output = Redmine::Hook.call_hook :pdf_right, { issue: issue }
unless right_hook_output.nil?
right_hook_output.each do |r|
right.concat r unless r.nil?
end
end
rows = left.size > right.size ? left.size : right.size
while left.size < rows
left << nil
end
while right.size < rows
right << nil
end
half = (issue.visible_custom_field_values.size / 2.0).ceil
issue.visible_custom_field_values.each_with_index do |custom_value, i|
(i < half ? left : right) << [custom_value.custom_field.name, show_value(custom_value, false)]
end
if pdf.get_rtl
border_first_top = 'RT'
border_last_top = 'LT'
border_first = 'R'
border_last = 'L'
else
border_first_top = 'LT'
border_last_top = 'RT'
border_first = 'L'
border_last = 'R'
end
rows = left.size > right.size ? left.size : right.size
rows.times do |i|
heights = []
pdf.SetFontStyle('B',9)
item = left[i]
heights << pdf.get_string_height(35, item ? "#{item.first}:" : "")
item = right[i]
heights << pdf.get_string_height(35, item ? "#{item.first}:" : "")
pdf.SetFontStyle('',9)
item = left[i]
heights << pdf.get_string_height(60, item ? item.last.to_s : "")
item = right[i]
heights << pdf.get_string_height(60, item ? item.last.to_s : "")
height = heights.max
item = left[i]
pdf.SetFontStyle('B',9)
pdf.RDMMultiCell(35, height, item ? "#{item.first}:" : "", (i == 0 ? border_first_top : border_first), '', 0, 0)
pdf.SetFontStyle('',9)
pdf.RDMMultiCell(60, height, item ? item.last.to_s : "", (i == 0 ? border_last_top : border_last), '', 0, 0)
item = right[i]
pdf.SetFontStyle('B',9)
pdf.RDMMultiCell(35, height, item ? "#{item.first}:" : "", (i == 0 ? border_first_top : border_first), '', 0, 0)
pdf.SetFontStyle('',9)
pdf.RDMMultiCell(60, height, item ? item.last.to_s : "", (i == 0 ? border_last_top : border_last), '', 0, 2)
pdf.set_x(base_x)
end
pdf.SetFontStyle('B',9)
pdf.RDMCell(35+155, 5, l(:field_description), "LRT", 1)
pdf.SetFontStyle('',9)
# Set resize image scale
pdf.set_image_scale(1.6)
text = textilizable(issue, :description,
only_path: false,
edit_section_links: false,
headings: false,
inline_attachments: false
)
pdf.RDMwriteFormattedCell(35+155, 5, '', '', text, issue.attachments, "LRB")
unless issue.leaf?
truncate_length = (!is_cjk? ? 90 : 65)
pdf.SetFontStyle('B',9)
pdf.RDMCell(35+155,5, l(:label_subtask_plural) + ":", "LTR")
pdf.ln
issue_list(issue.descendants.visible.sort_by(&:lft)) do |child, level|
buf = "#{child.tracker} # #{child.id}: #{child.subject}".
truncate(truncate_length)
level = 10 if level >= 10
pdf.SetFontStyle('',8)
pdf.RDMCell(35+135,5, (level >=1 ? " " * level : "") + buf, border_first)
pdf.SetFontStyle('B',8)
pdf.RDMCell(20,5, child.status.to_s, border_last)
pdf.ln
end
end
relations = issue.relations.select { |r| r.other_issue(issue).visible? }
unless relations.empty?
truncate_length = (!is_cjk? ? 80 : 60)
pdf.SetFontStyle('B',9)
pdf.RDMCell(35+155,5, l(:label_related_issues) + ":", "LTR")
pdf.ln
relations.each do |relation|
buf = relation.to_s(issue) {|other|
text = ""
if Setting.cross_project_issue_relations?
text += "#{relation.other_issue(issue).project} - "
end
text += "#{other.tracker} ##{other.id}: #{other.subject}"
text
}
buf = buf.truncate(truncate_length)
pdf.SetFontStyle('', 8)
pdf.RDMCell(35+155-60, 5, buf, border_first)
pdf.SetFontStyle('B',8)
pdf.RDMCell(20,5, relation.other_issue(issue).status.to_s, "")
pdf.RDMCell(20,5, format_date(relation.other_issue(issue).start_date), "")
pdf.RDMCell(20,5, format_date(relation.other_issue(issue).due_date), border_last)
pdf.ln
end
end
pdf.RDMCell(190,5, "", "T")
pdf.ln
if issue.changesets.any? &&
User.current.allowed_to?(:view_changesets, issue.project)
pdf.SetFontStyle('B',9)
pdf.RDMCell(190,5, l(:label_associated_revisions), "B")
pdf.ln
for changeset in issue.changesets
pdf.SetFontStyle('B',8)
csstr = "#{l(:label_revision)} #{changeset.format_identifier} - "
csstr += format_time(changeset.committed_on) + " - " + changeset.author.to_s
pdf.RDMCell(190, 5, csstr)
pdf.ln
unless changeset.comments.blank?
pdf.SetFontStyle('',8)
pdf.RDMwriteHTMLCell(190,5,'','',
changeset.comments.to_s, issue.attachments, "")
end
pdf.ln
end
end
if assoc[:journals].present?
pdf.SetFontStyle('B',9)
pdf.RDMCell(190,5, l(:label_history), "B")
pdf.ln
assoc[:journals].each do |journal|
pdf.SetFontStyle('B',8)
title = "##{journal.indice} - #{format_time(journal.created_on)} - #{journal.user}"
title << " (#{l(:field_private_notes)})" if journal.private_notes?
pdf.RDMCell(190,5, title)
pdf.ln
pdf.SetFontStyle('I',8)
details_to_strings(journal.visible_details, true).each do |string|
pdf.RDMMultiCell(190,5, "- " + string)
end
if journal.notes?
pdf.ln unless journal.details.empty?
pdf.SetFontStyle('',8)
text = textilizable(journal, :notes,
only_path: false,
edit_section_links: false,
headings: false,
inline_attachments: false
)
pdf.RDMwriteFormattedCell(190,5,'','', text, issue.attachments, "")
end
pdf.ln
end
end
if issue.attachments.any?
pdf.SetFontStyle('B',9)
pdf.RDMCell(190,5, l(:label_attachment_plural), "B")
pdf.ln
for attachment in issue.attachments
pdf.SetFontStyle('',8)
pdf.RDMCell(80,5, attachment.filename)
pdf.RDMCell(20,5, number_to_human_size(attachment.filesize),0,0,"R")
pdf.RDMCell(25,5, format_date(attachment.created_on),0,0,"R")
pdf.RDMCell(65,5, attachment.author.name,0,0,"R")
pdf.ln
end
end
# Check to see if there is an estimate attached, then combine them
if issue.estimate
e_pdf, ref = PdfService.new(entity: Estimate).fetch_pdf(doc_ids: [issue.estimate.id])
pdf = CombinePDF.parse(pdf.output, allow_optional_content: true)
pdf << CombinePDF.parse(e_pdf)
return pdf.to_pdf
end
return pdf.output
end
render_description(pdf, issue)
render_subtasks(pdf, issue)
render_relations(pdf, issue)
render_changesets(pdf, issue)
render_journals(pdf, issue, assoc)
render_attachments(pdf, issue)
merge_estimate_if_present(pdf, issue)
end
private
def log(msg)
Rails.logger.info "[PdfPatch] #{msg}"
Rails.logger.info "[PdfPatch] #{msg}"
end
def setup_pdf(issue)
pdf = ::Redmine::Export::PDF::ITCPDF.new(current_language)
pdf.set_title("#{issue.project} - #{issue.tracker} ##{issue.id}")
pdf.alias_nb_pages
pdf.footer_date = format_date(Date.today)
pdf.add_page
pdf
end
def render_header(pdf, issue)
pdf.SetFontStyle('B', 11)
pdf.RDMMultiCell(190, 5, "#{issue.project} - #{issue.tracker} ##{issue.id}")
pdf.SetFontStyle('', 8)
end
def render_ancestors_and_subject(pdf, issue)
base_x = pdf.get_x
i = 1
# Render ancestors
issue.ancestors.visible.each do |ancestor|
pdf.set_x(base_x + i)
buf = "#{ancestor.tracker} # #{ancestor.id} (#{ancestor.status}): #{ancestor.subject}"
pdf.RDMMultiCell(190 - i, 5, buf)
i += 1 if i < 35
end
# Render current issue subject and meta
pdf.SetFontStyle('B', 11)
pdf.RDMMultiCell(190 - i, 5, issue.subject.to_s)
pdf.SetFontStyle('', 8)
pdf.RDMMultiCell(190, 5, "#{format_time(issue.created_on)} - #{issue.author}")
pdf.ln
end
def build_issue_attributes(issue)
left = build_left_attributes(issue)
right = build_right_attributes(issue)
# Pad arrays to equal length
rows = [left.size, right.size].max
left.fill(nil, left.size...rows)
right.fill(nil, right.size...rows)
# Distribute custom fields evenly
half = (issue.visible_custom_field_values.size / 2.0).ceil
issue.visible_custom_field_values.each_with_index do |custom_value, i|
target_column = i < half ? left : right
target_column << [custom_value.custom_field.name, show_value(custom_value, false)]
end
[left, right]
end
def build_left_attributes(issue)
left = []
left << [l(:field_status), issue.status]
left << [l(:field_priority), issue.priority]
left << [l(:field_customer), issue.customer&.name]
left << [l(:field_assigned_to), issue.assigned_to] unless issue.disabled_core_fields.include?(:assigned_to_id)
log "Calling :pdf_left hook"
left_hook_output = Redmine::Hook.call_hook(:pdf_left, { issue: issue })
Array(left_hook_output).compact.each { |l| left.concat(l) }
left
end
def build_right_attributes(issue)
right = []
right << [l(:field_start_date), format_date(issue.start_date)] unless issue.disabled_core_fields.include?(:start_date)
right << [l(:field_due_date), format_date(issue.due_date)] unless issue.disabled_core_fields.include?(:due_date)
right << [l(:field_done_ratio), "#{issue.done_ratio}%"] unless issue.disabled_core_fields.include?(:done_ratio)
right << [l(:field_estimated_hours), l_hours(issue.estimated_hours)] unless issue.disabled_core_fields.include?(:estimated_hours)
right << [l(:label_spent_time), l_hours(issue.total_spent_hours)] if User.current.allowed_to?(:view_time_entries, issue.project)
log "Calling :pdf_right hook"
right_hook_output = Redmine::Hook.call_hook(:pdf_right, { issue: issue })
Array(right_hook_output).compact.each { |r| right.concat(r) }
right
end
def render_attributes_grid(pdf, left, right)
base_x = pdf.get_x
borders = determine_borders(pdf.get_rtl)
rows = [left.size, right.size].max
rows.times do |i|
item_left = left[i]
item_right = right[i]
# Calculate dynamic row height
pdf.SetFontStyle('B', 9)
hl1 = pdf.get_string_height(35, item_left ? "#{item_left.first}:" : "")
hr1 = pdf.get_string_height(35, item_right ? "#{item_right.first}:" : "")
pdf.SetFontStyle('', 9)
hl2 = pdf.get_string_height(60, item_left ? item_left[1].to_s : "")
hr2 = pdf.get_string_height(60, item_right ? item_right[1].to_s : "")
height = [hl1, hr1, hl2, hr2].max
# Render cells
render_grid_cell(pdf, item_left, height, i == 0 ? borders[:first_top] : borders[:first], i == 0 ? borders[:last_top] : borders[:last], 0)
render_grid_cell(pdf, item_right, height, i == 0 ? borders[:first_top] : borders[:first], i == 0 ? borders[:last_top] : borders[:last], 2)
pdf.set_x(base_x)
end
end
def determine_borders(is_rtl)
if is_rtl
{ first_top: 'RT', last_top: 'LT', first: 'R', last: 'L' }
else
{ first_top: 'LT', last_top: 'RT', first: 'L', last: 'R' }
end
end
def render_grid_cell(pdf, item, height, border_label, border_val, ln_type)
pdf.SetFontStyle('B', 9)
pdf.RDMMultiCell(35, height, item ? "#{item.first}:" : "", border_label, '', 0, 0)
pdf.SetFontStyle('', 9)
html = item && item[2].is_a?(Hash) ? item[2][:html].presence : nil
if html
# Plugin-supplied HTML value, drawn directly (RDMwriteHTMLCell would run wiki formatting on it)
pdf.writeHTMLCell(60, height, '', '', html, border_val, ln_type, 0)
else
pdf.RDMMultiCell(60, height, item ? item[1].to_s : "", border_val, '', 0, ln_type)
end
end
def render_description(pdf, issue)
pdf.SetFontStyle('B', 9)
pdf.RDMCell(190, 5, l(:field_description), "LRT", 1)
pdf.SetFontStyle('', 9)
pdf.set_image_scale(1.6)
text = textilizable(issue, :description,
only_path: false,
edit_section_links: false,
headings: false,
inline_attachments: false)
# Apply the fix here
text = sanitize_html_for_pdf(text)
pdf.RDMwriteFormattedCell(190, 5, '', '', text, issue.attachments, "LRB")
end
def render_subtasks(pdf, issue)
return if issue.leaf?
truncate_length = !is_cjk? ? 90 : 65
pdf.SetFontStyle('B', 9)
pdf.RDMCell(190, 5, "#{l(:label_subtask_plural)}:", "LTR")
pdf.ln
border_first = pdf.get_rtl ? 'R' : 'L'
border_last = pdf.get_rtl ? 'L' : 'R'
issue_list(issue.descendants.visible.sort_by(&:lft)) do |child, level|
buf = "#{child.tracker} # #{child.id}: #{child.subject}".truncate(truncate_length)
level = 10 if level >= 10
pdf.SetFontStyle('', 8)
pdf.RDMCell(170, 5, (level >= 1 ? " " * level : "") + buf, border_first)
pdf.SetFontStyle('B', 8)
pdf.RDMCell(20, 5, child.status.to_s, border_last)
pdf.ln
end
end
def render_relations(pdf, issue)
relations = issue.relations.select { |r| r.other_issue(issue).visible? }
return if relations.empty?
truncate_length = !is_cjk? ? 80 : 60
pdf.SetFontStyle('B', 9)
pdf.RDMCell(190, 5, "#{l(:label_related_issues)}:", "LTR")
pdf.ln
border_first = pdf.get_rtl ? 'R' : 'L'
border_last = pdf.get_rtl ? 'L' : 'R'
relations.each do |relation|
other = relation.other_issue(issue)
text = Setting.cross_project_issue_relations? ? "#{other.project} - " : ""
text += "#{other.tracker} ##{other.id}: #{other.subject}"
pdf.SetFontStyle('', 8)
pdf.RDMCell(130, 5, text.truncate(truncate_length), border_first)
pdf.SetFontStyle('B', 8)
pdf.RDMCell(20, 5, other.status.to_s, "")
pdf.RDMCell(20, 5, format_date(other.start_date), "")
pdf.RDMCell(20, 5, format_date(other.due_date), border_last)
pdf.ln
end
pdf.RDMCell(190, 5, "", "T")
pdf.ln
end
def render_changesets(pdf, issue)
return unless issue.changesets.any? && User.current.allowed_to?(:view_changesets, issue.project)
pdf.SetFontStyle('B', 9)
pdf.RDMCell(190, 5, l(:label_associated_revisions), "B")
pdf.ln
issue.changesets.each do |changeset|
pdf.SetFontStyle('B', 8)
csstr = "#{l(:label_revision)} #{changeset.format_identifier} - #{format_time(changeset.committed_on)} - #{changeset.author}"
pdf.RDMCell(190, 5, csstr)
pdf.ln
unless changeset.comments.blank?
pdf.SetFontStyle('', 8)
pdf.RDMwriteHTMLCell(190, 5, '', '', changeset.comments.to_s, issue.attachments, "")
end
pdf.ln
end
end
def render_journals(pdf, issue, assoc)
return unless assoc[:journals].present?
pdf.SetFontStyle('B', 9)
pdf.RDMCell(190, 5, l(:label_history), "B")
pdf.ln
assoc[:journals].each do |journal|
pdf.SetFontStyle('B', 8)
title = "##{journal.indice} - #{format_time(journal.created_on)} - #{journal.user}"
title << " (#{l(:field_private_notes)})" if journal.private_notes?
pdf.RDMCell(190, 5, title)
pdf.ln
pdf.SetFontStyle('I', 8)
details_to_strings(journal.visible_details, true).each do |string|
pdf.RDMMultiCell(190, 5, "- " + string)
end
if journal.notes?
pdf.ln unless journal.details.empty?
pdf.SetFontStyle('', 8)
text = textilizable(journal, :notes, only_path: false, edit_section_links: false, headings: false, inline_attachments: false)
# Apply the fix here
text = sanitize_html_for_pdf(text)
pdf.RDMwriteFormattedCell(190, 5, '', '', text, issue.attachments, "")
end
pdf.ln
end
end
def render_attachments(pdf, issue)
return unless issue.attachments.any?
pdf.SetFontStyle('B', 9)
pdf.RDMCell(190, 5, l(:label_attachment_plural), "B")
pdf.ln
issue.attachments.each do |attachment|
pdf.SetFontStyle('', 8)
pdf.RDMCell(80, 5, attachment.filename)
pdf.RDMCell(20, 5, number_to_human_size(attachment.filesize), 0, 0, "R")
pdf.RDMCell(25, 5, format_date(attachment.created_on), 0, 0, "R")
pdf.RDMCell(65, 5, attachment.author.name, 0, 0, "R")
pdf.ln
end
end
def merge_estimate_if_present(pdf, issue)
if issue.estimate
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(e_pdf)
combined.to_pdf
else
pdf.output
end
end
private
# NEW HELPER: Aggressively cleans up HTML so RBPDF doesn't crash on tables
def sanitize_html_for_pdf(text)
clean_text = text.to_s.dup
# 1. RBPDF layout engine hates div wrappers. Strip all opening and closing divs.
clean_text.gsub!(/<\/?div[^>]*>/i, '')
# 2. Rebuild tables into a completely flat, pure HTML structure that TCPDF supports
clean_text.gsub!(/<table[^>]*>.*?<\/table>/mi) do |match|
table_html = match.dup
# Strip thead and tbody tags completely
table_html.gsub!(/<\/?thead[^>]*>/i, '')
table_html.gsub!(/<\/?tbody[^>]*>/i, '')
# TCPDF cell width calculations crash on <th> tags. Convert them to <td> + bold.
table_html.gsub!(/<th([^>]*)>/i, '<td\1><strong>')
table_html.gsub!(/<\/th>/i, '</strong></td>')
# Remove all newlines and spaces between tags to prevent stray text nodes crashing the parser
table_html.gsub!(/>\s+</m, '><')
table_html.gsub!(/\r?\n/, '')
# Inject a standardized <table> tag with borders so the table actually renders visibly
table_html.sub!(/<table[^>]*>/i, '<table border="1" cellpadding="4" style="border-collapse: collapse;">')
table_html
end
clean_text
end
end
Redmine::Export::PDF::IssuesPdfHelper.send(:include, PdfPatch)
end
end
+1 -8
View File
@@ -8,11 +8,10 @@
#
#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_dependency 'issue_query'
module RedmineQbo
module Patches
module QueryPatch
extend ActiveSupport::Concern
def base_scope
scope = super
@@ -59,12 +58,6 @@ module RedmineQbo
Issue.joins(:customer).sanitize_sql_for_conditions([sql, pattern])
end
end
# Add module to Issue
IssueQuery.send(:prepend, QueryPatch)
end
end
@@ -8,11 +8,10 @@
#
#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_dependency 'time_entry_query'
module RedmineQbo
module Patches
module TimeEntryQueryPatch
extend ActiveSupport::Concern
# Add QBO options to columns
def available_columns
@@ -28,11 +27,6 @@ module RedmineQbo
add_available_filter "billed", type: :boolean
super
end
end
# Add module to TimeEntryQuery
TimeEntryQuery.send(:prepend, QueryPatch)
end
end
+2 -25
View File
@@ -8,37 +8,14 @@
#
#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_dependency 'user'
module RedmineQbo
module Patches
# Patches Redmine's User dynamically.
# Adds a relationships
module UserPatch
def self.included(base) # :nodoc:
base.extend(ClassMethods)
extend ActiveSupport::Concern
base.send(:include, InstanceMethods)
# Same as typing in the class
base.class_eval do
prepended do
belongs_to :employee, primary_key: :id
end
end
module ClassMethods
end
module InstanceMethods
end
end
# Add module to Issue
User.send(:include, UserPatch)
end
end
@@ -8,31 +8,20 @@
#
#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 InvoicePushService
def initialize(invoice)
@invoice = invoice
end
module RedmineQbo
# Capitalizes the first letter of every word and leaves the rest of each word exactly as typed,
# so acronyms and model names survive: "led light bar for JL" -> "Led Light Bar For JL",
# "LED" stays "LED", "4x4" stays "4x4", "(front)" -> "(Front)". Runs of whitespace become one space.
# (Rails' titleize lowercases the rest of each word, turning "LED" into "Led" and "JL" into "Jl".)
module TitleCase
module_function
# Push invoice changes to QBO if the invoice is linked to any issues with custom field changes that need to be synced
def push
return if @invoice.qbo_sync_locked?
log "Pushing invoice ##{@invoice.id} to QBO due to linked issue custom field changes"
@invoice.update_column(:qbo_sync_locked, true)
remote = QboConnectionService.with_qbo_service(entity: Invoice) do |service|
remote = service.fetch_by_id(@invoice.id)
# modify remote object here if needed
service.update(remote)
def call(text)
return text if text.nil?
text.to_s.split(/\s+/).reject(&:empty?).map do |word|
word.sub(/\A([^\p{L}\p{N}]*)(\p{Ll})/) { "#{Regexp.last_match(1)}#{Regexp.last_match(2).upcase}" }
end.join(' ')
end
rescue => e
Rails.logger.error "[InvoicePushService] #{e.message}"
ensure
@invoice.update_column(:qbo_sync_locked, false)
end
private
def log(msg)
Rails.logger.info "[InvoicePushService] #{msg}"
end
end
end