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
This commit is contained in:
Claude committed 2026-10-28 22:08:36 -04:00
1 parent aacc2d645d
commit 0523e8dd24
18 files changed
+401 -100

No files matched your search

+17 -42
View File
@@ -26,9 +26,11 @@ class CustomersController < ApplicationController
helper :timelog
# This tells Redmine to check global permissions for the current controller/action
before_action :authorize_global
# 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]
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)
@@ -61,45 +63,12 @@ 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
# Support both existing 'q' param and new 'name'/'phone' params
name_query = (params[:name] || params[:q] || params[:term]).to_s.strip
phone_query = params[:phone].to_s.gsub(/\D/, '')
items = CustomerSearchService.call(name: name_query, phone: params[:phone])
sql_matches = []
# 1. Check for phone number matches via SQL
if phone_query.present?
sql_matches += Customer.where("phone_number LIKE :p OR mobile_phone_number LIKE :p", p: "%#{phone_query}%")
end
# 2. Check for exact or partial name matches via SQL
if name_query.present?
safe_name = ActiveRecord::Base.sanitize_sql_like(name_query)
sql_matches += Customer.where("name LIKE :t", t: "%#{safe_name}%")
end
sql_matches = sql_matches.uniq
# 3. Handle spelling errors using built-in string distance
fuzzy_matches = []
if name_query.present?
require 'did_you_mean/jaro_winkler'
# Only scan records we haven't already matched
unmatched = Customer.all - sql_matches
fuzzy_matches = unmatched.select do |c|
# 0.6 is the threshold. 1.0 is an exact match.
DidYouMean::JaroWinkler.distance(c.name.to_s.downcase, name_query.downcase) > 0.6
end
end
# Combine results and limit to top 20
items = (sql_matches + fuzzy_matches).first(20)
# Return JSON formatted for both existing usage and new jQuery UI requirements
render json: items.map { |i|
{ id: i.id, name: i.name, phone_number: i.phone_number, mobile_phone_number: i.mobile_phone_number }
}
@@ -150,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
@@ -200,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)
@@ -247,9 +218,14 @@ class CustomersController < ApplicationController
def update
@customer = Customer.find_by_id(params[:id])
@customer.update(allowed_params)
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
@@ -262,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,10 +10,15 @@
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
render_pdf(@estimate)
@@ -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?
+22 -16
View File
@@ -10,20 +10,32 @@
module AuthHelper
def require_user
return unless session[:token].nil?
if !User.current.logged?
flash[:error] = t :notice_forbidden
render_403
# 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
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)
@@ -33,7 +45,6 @@ module AuthHelper
end
end
def global_check_permission(permission)
if !globaly_allowed_to?(permission)
flash[:error] = t :notice_forbidden
@@ -41,16 +52,11 @@ module AuthHelper
end
end
# 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
+33 -10
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}"
# 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)
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
+2 -2
View File
@@ -21,8 +21,8 @@ class Customer < QboBaseModel
self.primary_key = :id
qbo_sync push: true
# Normalize the local database column :name
normalizes :name, with: ->(name) { name.to_s.strip.titleize }
# 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) },
+195
View File
@@ -0,0 +1,195 @@
#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 'did_you_mean'
# Finds customers by name and/or phone, tolerant of the ways duplicates sneak in:
# - nicknames: "Bill Smith" finds "William Smith", "Bob" finds "Robert"
# - typos: "Willaim Smtih" finds "William Smith"
# - word order: "Smith William" or "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 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
# Groups of interchangeable first names. A name may appear in more than one group (e.g. "chris").
NICKNAME_GROUPS = [
%w[william bill billy will willy willie liam],
%w[robert bob bobby rob robbie bert],
%w[richard rick ricky rich richie dick],
%w[james jim jimmy jamie],
%w[john jack johnny jon],
%w[jonathan jon jonny],
%w[michael mike mikey mick],
%w[thomas tom tommy],
%w[joseph joe joey],
%w[charles charlie chuck chas],
%w[edward ed eddie ted ned],
%w[anthony tony],
%w[christopher chris kit],
%w[christine christina chris tina],
%w[daniel dan danny],
%w[david dave davey],
%w[matthew matt],
%w[andrew andy drew],
%w[steven stephen steve stevie],
%w[benjamin ben benny],
%w[samuel sam sammy],
%w[samantha sam],
%w[alexander alex al xander],
%w[alexandra alex lexi],
%w[albert al bert],
%w[nicholas nick nicky],
%w[patrick pat],
%w[patricia pat patty trish],
%w[peter pete],
%w[timothy tim timmy],
%w[kenneth ken kenny],
%w[ronald ron ronnie],
%w[donald don donnie],
%w[gregory greg],
%w[jeffrey jeff],
%w[gerald jerry gerry],
%w[lawrence larry],
%w[raymond ray],
%w[frederick fred freddie],
%w[theodore ted teddy theo],
%w[douglas doug],
%w[joshua josh],
%w[zachary zach zack],
%w[nathaniel nathan nate],
%w[elizabeth liz lizzie beth betty eliza],
%w[margaret maggie meg peggy],
%w[katherine catherine kathryn kate katie kathy cathy kat],
%w[jennifer jen jenny],
%w[rebecca becky becca],
%w[susan sue susie],
%w[deborah debra deb debbie],
%w[victoria vicky tori],
%w[jessica jess jessie]
].freeze
# name => indexes of the groups it belongs to
NICKNAME_INDEX = NICKNAME_GROUPS.each_with_index.with_object(Hash.new { |h, k| h[k] = [] }) do |(group, index), map|
group.each { |name| map[name] << index }
end.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
# [[id, name, phone_number, mobile_phone_number], ...], cached until any customer changes
def self.candidates
key = ['customer_search_candidates', Customer.count, Customer.maximum(:updated_at).to_i]
Rails.cache.fetch(key, expires_in: 12.hours) do
Customer.pluck(:id, :name, :phone_number, :mobile_phone_number)
end
end
# Pure ranking (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(rows, 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_tokens = tokens(name)
return [] if query_tokens.empty? && phone_digits.length < 4
scored = rows.filter_map do |id, customer_name, phone_number, mobile_number|
score = [
phone_digits.length >= 4 ? phone_score(phone_digits, [phone_number, mobile_number]) : 0.0,
query_tokens.any? ? name_score(query_tokens, customer_name) : 0.0
].max
[id, score, customer_name.to_s] 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
def self.phone_score(digits, numbers)
numbers.compact.map { |n| n.to_s.gsub(/\D/, '') }.reject(&:empty?).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_tokens, customer_name)
name_tokens = tokens(customer_name)
return 0.0 if name_tokens.empty?
best = query_tokens.map { |q| name_tokens.map { |c| token_score(q, c) }.max }
score = best.sum / best.size
score *= 0.5 if best.any?(&:zero?)
# Also compare the names with spaces removed, for "Mc Donald" vs "McDonald"
joined = DidYouMean::JaroWinkler.distance(query_tokens.join, name_tokens.join)
[score, joined >= 0.92 ? joined * 0.9 : 0.0].max
end
def self.token_score(query, candidate)
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"
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.
similarity = DidYouMean::JaroWinkler.distance(query, candidate)
threshold = [query.length, candidate.length].min <= 4 ? 0.9 : 0.85
similarity >= threshold ? similarity * 0.9 : 0.0
end
def self.nicknames?(a, b)
(NICKNAME_INDEX.fetch(a, []) & NICKNAME_INDEX.fetch(b, [])).any?
end
# A partly typed nickname of the candidate's name, e.g. "bil" for "william"
def self.nickname_prefix?(query, candidate)
NICKNAME_INDEX.fetch(candidate, []).any? do |index|
NICKNAME_GROUPS[index].any? { |name| name != candidate && name.start_with?(query) }
end
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
+2 -2
View File
@@ -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>
+3
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"
+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
+7 -1
View File
@@ -31,9 +31,15 @@ Redmine::Plugin.register :redmine_qbo do
WillPaginate.per_page = 20
# Global Permissions
permission :view_customers, { customers: [:index, :show] }, global: true
# 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.allowed_to?(:view_customers, nil, global: true)}
@@ -14,7 +14,7 @@ module RedmineQbo
def self.apply
AttachmentsController.class_eval do
# 1. PREPEND: Must run before ANY of Redmine's ApplicationController filters
prepend_before_action :set_customer_token_thread
prepend_before_action :load_customer_token
# 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?
@@ -25,14 +25,14 @@ module RedmineQbo
private
def set_customer_token_thread
if session[:token].present?
Thread.current[:customer_token] = CustomerToken.active.find_by(token: session[:token])
end
# 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 = Thread.current[:customer_token]
token = @customer_token
return false unless token
# Handle "Download All" zip requests (object_type=issues, object_id=ID)
+5 -4
View File
@@ -32,12 +32,13 @@ module RedmineQbo
BillIssueTimeJob.perform_later(id)
end
# Titlize the subject for consistent formatting in billing descriptions
# Capitalize each word of the subject for consistent billing descriptions, without lowercasing
# the rest of the word (keeps LED, JL, 4x4 as typed). Only runs when the subject changes.
def titlize_subject
return unless subject.present? && will_save_change_to_subject?
log "Titlizing subject for issue ##{id}"
self.subject = subject.split(/\s+/).map do |word|
(word =~ /[A-Z]/ && word =~ /[0-9]/) ? word : word.capitalize
end.join(' ')
self.subject = RedmineQbo::TitleCase.call(subject)
end
# Generate a shareable token linking this issue to the customer for QuickBooks
@@ -16,11 +16,16 @@ module RedmineQbo
def watcher_link(issue, user)
links = ''
# Admin users can bill time
links << link_to(I18n.t(:label_bill_time), bill_path(issue.id), method: :get, class: 'icon icon-email-add') if user.admin?
# 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
# Logged-in users can share the issue
links << link_to(I18n.t(:label_share), share_path(issue.id), method: :get, target: :_blank, class: 'icon icon-shared') if user.logged?
# 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
+27
View File
@@ -0,0 +1,27 @@
#The MIT License (MIT)
#
#Copyright (c) 2016 - 2026 rick barrette
#
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
module RedmineQbo
# 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
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
end
end