mirror of
https://github.com/rickbarrette/redmine_qbo.git
synced 2026-11-19 10:40:36 -05:00
Compare commits
21
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a1fb88e77c | ||
|
|
0a7b2e34b8 | ||
|
|
895733f534 | ||
|
|
fa1b4eed06 | ||
|
|
95e76a41fd | ||
|
|
92b2a18eb6 | ||
|
|
084df36061 | ||
|
|
3b51625df4 | ||
|
|
7cfc8a370e | ||
|
|
d2cdd798cd | ||
|
|
159420fac1 | ||
|
|
dbee228cdf | ||
|
|
ec00684edd | ||
|
|
839ac976e6 | ||
|
|
dc72b11766 | ||
|
|
778111825b | ||
|
|
4ba96e2dfd | ||
|
|
88160a985d | ||
|
|
e2a871b1e8 | ||
|
|
489edd97fa | ||
|
|
64e4a149ab |
No files matched your search
@@ -3,7 +3,6 @@ source 'https://rubygems.org'
|
||||
gem 'quickbooks-ruby'
|
||||
gem 'oauth2'
|
||||
gem 'roxml'
|
||||
gem 'will_paginate'
|
||||
gem 'rexml'
|
||||
gem 'combine_pdf'
|
||||
|
||||
|
||||
@@ -69,8 +69,10 @@ This ensures Time Activities are recorded under the correct employee in QuickBoo
|
||||
The plugin provides basic Customer management:
|
||||
|
||||
* Create Customers directly from Redmine
|
||||
|
||||
* Browse every Customer on the **Customers** page: a Redmine list with phone numbers, issue counts and last update, sortable by column and paged with Redmine's own pagination (and its per-page choices)
|
||||
|
||||
* Search Customers by **name or phone number**
|
||||
* Search Customers by **name or phone number**: the best matches come first (click a column to sort them instead), and a single match opens that Customer
|
||||
|
||||
* View and edit Customer information
|
||||
|
||||
@@ -101,7 +103,7 @@ Estimates and invoices keep their number, date, customer, total and **man-hours*
|
||||
|
||||
## Billing: Estimates, Invoices and Payments
|
||||
|
||||
* **New estimate** from the customer page: Create Estimate opens the Redmine editor. The customer page no longer links to QuickBooks' estimate or payment screens; the customer's name still opens their QuickBooks account page as a fallback.
|
||||
* **New estimate** from the customer page: Create Estimate opens the Redmine editor. The customer page no longer links to QuickBooks' estimate or payment screens; **Open in QuickBooks** opens their QuickBooks account page as a fallback.
|
||||
* **Edit** any estimate from the Edit link next to it on the customer page or the issue page.
|
||||
* **Keyboard entry**: in a line's product box, Tab picks the product the text points to (an exact name, the only match, or the only name starting with it, e.g. "lab" → Labor) and fills the line. Tabbing into the description, quantity or rate selects it, so typing replaces it. The quantity, rate and amount boxes take simple math (e.g. `33*1.3`, `(120+15)/2`; `+ - * /`, `x` for times, parentheses), worked out when you leave the box; math in the rate or amount is rounded to the nearest penny, and an amount sets the rate from the quantity. Typing `sub`, `subtotal` or `=` in a product box, then Tab or Enter, adds a subtotal there (an empty line becomes the subtotal; a line with a description keeps it and gets the subtotal after it) and moves on to the next line.
|
||||
* **Duplicate** an estimate to start a similar one: same customer, lines, subtotals, custom fields and messages, dated today, with the current user as sales person.
|
||||
@@ -146,7 +148,7 @@ Estimates and invoices keep their number, date, customer, total and **man-hours*
|
||||
* **Hours**: estimated hours on estimates, issues' estimated time, invoiced hours on invoices and time spent, with spent vs. estimated, and the **cost performance index** (CPI = invoiced hours ÷ spent hours): green at 1.00 or more, yellow below 1, red below 0.80. Each month shows its CPI too.
|
||||
* **Charts**: above each set of bars, a line chart of the same figures in the same colors (Chart.js 4.5.1, MIT licensed, bundled with the plugin in assets/javascripts so it doesn't clash with other plugins' copies such as redmine_indicator's Chart.js 2), with a point per day for a week, per week for up to about three months, and per month beyond. Hovering a point shows its figures. **Compare with last year** adds last year's lines, dashed and faded, without reloading: days and weeks go back 52 weeks so weekdays line up, months go back to the same month. Clicking a figure in the legend hides it (and its last-year line); clicking *last year* stops comparing. Today's line stops at today.
|
||||
* **By month**: every figure month by month, with totals.
|
||||
* **Projects**: pick one or more projects (Ctrl/Cmd-click) to count only their issues' estimated time and spent time, in the totals, charts and months; none picked counts every project. Estimates, invoices and payments have no project in QuickBooks, so they always cover the whole business (as do the CPI's invoiced hours). **Remember these projects** saves the choice in your Redmine preferences, and the report opens with it until you save another (saving none goes back to every project).
|
||||
* **Projects**: pick one or more open projects (Ctrl/Cmd-click; closed and archived projects aren't listed) to count only their issues' estimated time and spent time, in the totals, charts and months; none picked counts every project. Estimates, invoices and payments have no project in QuickBooks, so they always cover the whole business (as do the CPI's invoiced hours). **Remember these projects** saves the choice in your Redmine preferences, and the report opens with it until you save another (saving none goes back to every project).
|
||||
|
||||
Estimates, invoices and payments count by their QuickBooks date. Issues' estimated time counts issues created in the period, leaving out parents so subtasks aren't counted twice. Spent time counts time logged in the period. While estimates, invoices or payments are syncing, the report says so (with how many have been read) and refreshes every 30 seconds; the settings page's Synchronization table shows the same per type. Estimates and invoices synced before these figures were added have no total or hours until a full sync (the report says how many); run one again after changing the labor products/services.
|
||||
|
||||
@@ -216,7 +218,7 @@ Available hooks:
|
||||
|
||||
|Type|Hook|Note
|
||||
|--|--|--|
|
||||
View Hook|:view_customers_show_contextual, { customer: @customer } | Used to add action links to the customer page's top-right action area (return links styled like Redmine's, e.g. `link_to sprite_icon('add', 'Label'), path, class: 'icon icon-add'`). Replaces `customer_actions_top` / `customer_actions_bottom`
|
||||
View Hook|:view_customers_show_contextual, { customer: @customer } | Used to add action links to the customer page's action area, under the title (return links styled like Redmine's, e.g. `link_to sprite_icon('add', 'Label'), path, class: 'icon icon-add'`). Replaces `customer_actions_top` / `customer_actions_bottom`
|
||||
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
|
||||
View Hook|:show_customer_view_right, { customer: customer } | Used to show partials on right side of customer view
|
||||
|
||||
@@ -117,13 +117,33 @@ class CustomersController < ApplicationController
|
||||
@filtered_invoices = Invoice.all.where(customer_id: params[:selected_customer])
|
||||
end
|
||||
|
||||
# Most matches a search lists (best first)
|
||||
SEARCH_LIMIT = 200
|
||||
|
||||
# Every customer, sortable and paged like Redmine's lists; a search narrows it to the best matches (a single
|
||||
# match opens that customer). Sorting a search's results by a column replaces the best-first order.
|
||||
def index
|
||||
if params[:search]
|
||||
@customers = CustomerSearchService.call(name: params[:search], limit: 200).paginate(page: params[:page])
|
||||
if only_one_non_zero?(@customers)
|
||||
redirect_to @customers.first
|
||||
end
|
||||
sort_init 'name', 'asc'
|
||||
sort_update 'name' => "#{Customer.table_name}.name",
|
||||
'phone' => "#{Customer.table_name}.phone_number",
|
||||
'mobile' => "#{Customer.table_name}.mobile_phone_number",
|
||||
'updated' => "#{Customer.table_name}.updated_at"
|
||||
|
||||
@search = params[:search].to_s.strip
|
||||
if @search.present?
|
||||
scope = CustomerSearchService.call(name: @search, limit: SEARCH_LIMIT)
|
||||
@best_first = params[:sort].blank?
|
||||
else
|
||||
scope = Customer.all
|
||||
end
|
||||
scope = scope.reorder(sort_clause).order(:id) unless @best_first
|
||||
|
||||
@customer_count = scope.count
|
||||
return redirect_to(scope.first) if @search.present? && @customer_count == 1
|
||||
|
||||
@customer_pages = Paginator.new @customer_count, per_page_option, params['page']
|
||||
@customers = scope.limit(@customer_pages.per_page).offset(@customer_pages.offset).to_a
|
||||
@issue_counts = Issue.where(customer_id: @customers.map(&:id)).group(:customer_id).count
|
||||
end
|
||||
|
||||
def load_issue_data
|
||||
@@ -157,17 +177,6 @@ class CustomersController < ApplicationController
|
||||
end
|
||||
end
|
||||
|
||||
def only_one_non_zero?(array)
|
||||
found_non_zero = false
|
||||
array.each do |val|
|
||||
if val != 0
|
||||
return false if found_non_zero
|
||||
found_non_zero = true
|
||||
end
|
||||
end
|
||||
found_non_zero
|
||||
end
|
||||
|
||||
def share
|
||||
issue = Issue.visible.find(params[:id])
|
||||
token = issue.share_token
|
||||
|
||||
@@ -116,13 +116,19 @@ class QboEstimatesController < ApplicationController
|
||||
customer = Customer.find_by(id: params[:customer_id])
|
||||
return render(json: {}, status: :not_found) unless customer
|
||||
|
||||
render json: {
|
||||
info = {
|
||||
id: customer.id,
|
||||
name: customer.name,
|
||||
email: RedmineQboBilling::EstimateWriter.customer_email(customer),
|
||||
billing_address: RedmineQboBilling::EstimateWriter.customer_address(customer),
|
||||
field_options: RedmineQboBilling.field_options(customer)
|
||||
}
|
||||
# A new invoice warns about the customer's open issues
|
||||
if params[:document] == 'invoice'
|
||||
info[:open_issues_html] = render_to_string(partial: 'qbo_invoices/open_issues', formats: [:html],
|
||||
locals: { customer: customer })
|
||||
end
|
||||
render json: info
|
||||
end
|
||||
|
||||
# Product/service search for the line table (the QuickBooks item list)
|
||||
|
||||
@@ -19,8 +19,8 @@ class QboReportsController < ApplicationController
|
||||
PROJECTS_PREF = :qbo_report_project_ids
|
||||
|
||||
def index
|
||||
# Projects for the issues and spent time: the projects picker can choose some
|
||||
@projects = Project.visible.to_a
|
||||
# Projects for the issues and spent time: the projects picker can choose some of the open ones
|
||||
@projects = Project.visible.active.to_a
|
||||
@project_ids = report_project_ids
|
||||
@report = RedmineQboBilling::BusinessReport.new(period: params[:period].presence || 'this_year',
|
||||
from: params[:from], to: params[:to], today: User.current.today,
|
||||
@@ -35,7 +35,7 @@ class QboReportsController < ApplicationController
|
||||
private
|
||||
|
||||
# The form's projects (none picked is every project), or the user's saved ones when the address has none.
|
||||
# "Remember these projects" saves the form's choice. Only projects the user can see are kept.
|
||||
# "Remember these projects" saves the form's choice. Only open projects the user can see are kept.
|
||||
def report_project_ids
|
||||
visible = @projects.map(&:id)
|
||||
if params.key?(:project_ids)
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
#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.
|
||||
|
||||
# Estimates, invoices and payments on Redmine's activity page. They come from QuickBooks and belong to no
|
||||
# project, so they show on the overall activity page only (not a project's, nor a user's), and each kind only to
|
||||
# users with one of its global permissions.
|
||||
module QboActivity
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
class_methods do
|
||||
# event_type: the activity type registered in init.rb (e.g. 'qbo_estimates'); icon: the event's CSS class
|
||||
# and icon in this plugin's sprite (assets/images/icons.svg); permissions: any one of these shows it
|
||||
def qbo_activity(event_type, icon:, permissions:, title:, description:, url:)
|
||||
# These models can load before Redmine adds acts_as_event to every model
|
||||
include Redmine::Acts::Event unless respond_to?(:acts_as_event)
|
||||
acts_as_event title: title, description: description, url: url, type: icon,
|
||||
datetime: :activity_datetime, author: nil
|
||||
class_attribute :qbo_activity_permissions, instance_writer: false, default: permissions
|
||||
class_attribute :qbo_activity_event_type, instance_writer: false, default: event_type
|
||||
end
|
||||
|
||||
def qbo_activity_visible_to?(user)
|
||||
qbo_activity_permissions.any? { |permission| user.allowed_to?(permission, nil, global: true) }
|
||||
end
|
||||
|
||||
# What Redmine::Activity::Fetcher reads for a project's activity page; these never show there
|
||||
def activity_provider_options
|
||||
{ qbo_activity_event_type => { permission: qbo_activity_permissions.first } }
|
||||
end
|
||||
|
||||
# Documents dated from..to (the page's days, to not included), newest first. From the QuickBooks date, so
|
||||
# a sync bringing in old documents doesn't pile them onto the day it ran.
|
||||
def find_events(event_type, user, from, to, options)
|
||||
return [] if options[:project] || options[:author] || !qbo_activity_visible_to?(user)
|
||||
|
||||
scope = includes(:customer).where.not(txn_date: nil)
|
||||
scope = scope.where('txn_date >= ?', from.to_date) if from
|
||||
scope = scope.where('txn_date < ?', to.to_date) if to
|
||||
scope = scope.order(txn_date: :desc, id: :desc).limit(options[:limit]) if options[:limit]
|
||||
scope.to_a
|
||||
end
|
||||
end
|
||||
|
||||
# When it happened: the time it reached Redmine when that was its QuickBooks date (created or changed in
|
||||
# QuickBooks and sent by the webhook moments later), else midday on its QuickBooks date (e.g. a full sync)
|
||||
def activity_datetime
|
||||
return created_at if created_at && created_at.getlocal.to_date == txn_date
|
||||
|
||||
Time.local(txn_date.year, txn_date.month, txn_date.day, 12)
|
||||
end
|
||||
|
||||
# Activity events have a project; these don't
|
||||
def project
|
||||
nil
|
||||
end
|
||||
|
||||
def activity_money(amount)
|
||||
ActiveSupport::NumberHelper.number_to_currency(amount) if amount
|
||||
end
|
||||
|
||||
def activity_customer
|
||||
customer&.name.presence || I18n.t(:label_none)
|
||||
end
|
||||
end
|
||||
@@ -17,6 +17,12 @@ class Estimate < QboBaseModel
|
||||
self.primary_key = :id
|
||||
qbo_sync push: false
|
||||
|
||||
include QboActivity
|
||||
qbo_activity 'qbo_estimates', icon: 'qbo-estimate', permissions: %i[view_customers write_estimates],
|
||||
title: ->(e) { I18n.t(:label_activity_estimate, number: e.doc_number, customer: e.activity_customer) },
|
||||
description: ->(e) { [e.activity_money(e[:total_amount]), e[:txn_status]].compact.join(' · ') },
|
||||
url: ->(e) { { controller: 'estimates', action: 'show', id: e.id } }
|
||||
|
||||
def name
|
||||
to_s
|
||||
end
|
||||
|
||||
@@ -17,11 +17,26 @@ class Invoice < QboBaseModel
|
||||
self.primary_key = :id
|
||||
qbo_sync push: false
|
||||
|
||||
include QboActivity
|
||||
qbo_activity 'qbo_invoices', icon: 'qbo-invoice', permissions: %i[view_customers write_invoices],
|
||||
title: ->(i) { I18n.t(:label_activity_invoice, number: i.doc_number, customer: i.activity_customer) },
|
||||
description: ->(i) { i.activity_description },
|
||||
url: ->(i) { { controller: 'invoices', action: 'show', id: i.id } }
|
||||
|
||||
# Return the invoice's document number as its string representation
|
||||
def to_s
|
||||
doc_number
|
||||
end
|
||||
|
||||
# Amount and where it stands, e.g. "$1,250.00 · Partially paid ($400.00 owed)"
|
||||
def activity_description
|
||||
state = status
|
||||
owed = activity_money(self[:balance]) if state && self[:balance].to_d.positive?
|
||||
[activity_money(self[:total_amount]),
|
||||
(I18n.t(:"label_invoice_status_#{state}", default: state.to_s.humanize) if state),
|
||||
(I18n.t(:text_activity_invoice_owed, amount: owed) if owed && state != :open && state != :overdue)].compact.join(' · ')
|
||||
end
|
||||
|
||||
# Paid, partially paid, overdue, open or voided, from the cached total, balance and due date
|
||||
# (RedmineQboBilling::InvoiceStatus); nil when the balance isn't cached
|
||||
def status(today: User.current.today)
|
||||
|
||||
@@ -18,6 +18,19 @@ class Payment < QboBaseModel
|
||||
self.primary_key = :id
|
||||
qbo_sync push: false
|
||||
|
||||
include QboActivity
|
||||
qbo_activity 'qbo_payments', icon: 'qbo-payment', permissions: %i[view_payments receive_payments],
|
||||
title: ->(p) { I18n.t(:label_activity_payment, customer: p.activity_customer, amount: p.activity_money(p.total_amount)) },
|
||||
description: ->(p) { p.activity_description },
|
||||
url: ->(p) { { controller: 'qbo_payments', action: 'show', id: p.id } }
|
||||
|
||||
# Money not yet applied to an invoice, when there is some
|
||||
def activity_description
|
||||
return '' unless unapplied_amount.to_d.positive?
|
||||
|
||||
I18n.t(:text_activity_payment_unapplied, amount: activity_money(unapplied_amount))
|
||||
end
|
||||
|
||||
def to_s
|
||||
"#{txn_date} #{total_amount}"
|
||||
end
|
||||
|
||||
+3
-2
@@ -23,16 +23,17 @@ class Qbo < ActiveRecord::Base
|
||||
return I18n.t(:label_qbo_never_synced)
|
||||
end
|
||||
|
||||
# Token expiry times, or nil when QuickBooks isn't connected (the settings page shows N/A)
|
||||
def self.oauth2_access_token_expires_at
|
||||
QboConnectionService.current!.oauth2_access_token_expires_at
|
||||
rescue
|
||||
return I18n.t(:label_qbo_never_synced)
|
||||
nil
|
||||
end
|
||||
|
||||
def self.oauth2_refresh_token_expires_at
|
||||
QboConnectionService.current!.oauth2_refresh_token_expires_at
|
||||
rescue
|
||||
return I18n.t(:label_qbo_never_synced)
|
||||
nil
|
||||
end
|
||||
|
||||
# Updates last sync time stamp
|
||||
|
||||
@@ -27,6 +27,7 @@ class InvoiceAttachmentService
|
||||
unless issue.invoices.exists?(@invoice.id)
|
||||
issue.invoices << @invoice
|
||||
issue.save! if issue.changed?
|
||||
journalize(issue)
|
||||
log "Attached invoice ##{@invoice.id} to issue ##{issue.id}"
|
||||
end
|
||||
end
|
||||
@@ -34,6 +35,18 @@ class InvoiceAttachmentService
|
||||
|
||||
private
|
||||
|
||||
# Records the new invoice in the issue's history (shown by RedmineQbo::Patches::IssuesHelperPatch).
|
||||
# The webhook has no Redmine user, so the entry is by Anonymous. Saving the journal also sends
|
||||
# Redmine's usual issue-updated emails.
|
||||
def journalize(issue)
|
||||
journal = Journal.new(journalized: issue, user: User.anonymous, notes: '')
|
||||
journal.details << JournalDetail.new(property: 'invoice', prop_key: @invoice.id.to_s, value: @invoice.to_s.presence || @invoice.id.to_s)
|
||||
journal.save
|
||||
rescue => e
|
||||
# The invoice is attached either way; a missing history entry shouldn't fail the sync
|
||||
log "Couldn't add invoice ##{@invoice.id} to the history of issue ##{issue.id}: #{e.message}"
|
||||
end
|
||||
|
||||
# Extract issue IDs from the invoice's private note and line descriptions
|
||||
def extract_issue_ids
|
||||
ids = []
|
||||
|
||||
@@ -1,24 +1,66 @@
|
||||
<h2><%=t(:field_customers)%> <span style="float:right"> <%= render partial: 'customers/search' %> </span> </h2>
|
||||
<% if @customers.present? %>
|
||||
<br/>
|
||||
<% @customers.each do |c| %>
|
||||
<div class="row">
|
||||
<div class="span6 columns">
|
||||
<%= link_to c, customer_path(c.id) %>
|
||||
</div>
|
||||
</div>
|
||||
<% html_title l(:label_customers) %>
|
||||
<% phone = ->(digits) { digits.present? ? number_to_phone(digits.gsub(/\D/, '').to_i, area_code: true) : '' } %>
|
||||
|
||||
<div class="contextual">
|
||||
<% if User.current.allowed_to?(:add_customers, nil, global: true) %>
|
||||
<%= link_to sprite_icon('add', l(:label_new_customer)), new_customer_path, class: 'icon icon-add' %>
|
||||
<% end %>
|
||||
<% if User.current.admin? %>
|
||||
<%= link_to sprite_icon('reload', l(:label_sync)), qbo_sync_path, class: 'icon icon-reload' %>
|
||||
<% end %>
|
||||
|
||||
<p><%=t(:label_matching)%> <%= @customers.count %> <%=t(:field_customers)%> </p>
|
||||
|
||||
<div class="actions">
|
||||
<%= will_paginate @customers %>
|
||||
</div>
|
||||
|
||||
<% else %>
|
||||
<p><%=t(:label_no_customers)%> <%= params[:search] %>.</p>
|
||||
<h2><%= l(:label_customers) %></h2>
|
||||
|
||||
<%= form_tag(customers_path, method: :get, id: 'customer-search-form') do %>
|
||||
<p class="qbo-customer-search">
|
||||
<%= text_field_tag :search, @search, class: 'customer-name', size: 40, placeholder: t(:label_search_customers),
|
||||
autocomplete: 'off', data: { autocomplete_url: '/customers/autocomplete' } %>
|
||||
<%= submit_tag l(:label_search), name: nil %>
|
||||
<% if @search.present? %>
|
||||
<%= link_to sprite_icon('reload', l(:button_clear)), customers_path, class: 'icon icon-reload' %>
|
||||
<% end %>
|
||||
</p>
|
||||
<% end %>
|
||||
|
||||
<div>
|
||||
<%= render partial: 'qbo/stats' %>
|
||||
</div>
|
||||
<% if @customers.empty? %>
|
||||
<p class="nodata"><%= @search.present? ? l(:label_no_customers, search: @search) : l(:label_no_data) %></p>
|
||||
<% else %>
|
||||
<% if @best_first %>
|
||||
<p class="info"><%= l(:text_customers_best_match, count: @customer_count) %></p>
|
||||
<% end %>
|
||||
<div class="autoscroll">
|
||||
<table class="list customers odd-even">
|
||||
<thead>
|
||||
<tr>
|
||||
<%= sort_header_tag('name', caption: l(:field_name)) %>
|
||||
<%= sort_header_tag('phone', caption: l(:label_primary_phone)) %>
|
||||
<%= sort_header_tag('mobile', caption: l(:label_mobile_phone)) %>
|
||||
<th><%= l(:label_issue_plural) %></th>
|
||||
<%= sort_header_tag('updated', caption: l(:field_updated_on), default_order: 'desc') %>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<% @customers.each do |customer| %>
|
||||
<tr class="<%= cycle('odd', 'even') %>">
|
||||
<td class="name"><%= link_to customer.name, customer_path(customer.id) %></td>
|
||||
<td class="phone"><%= phone.call(customer.phone_number) %></td>
|
||||
<td class="phone"><%= phone.call(customer.mobile_phone_number) %></td>
|
||||
<td class="issues"><%= @issue_counts[customer.id] || 0 %></td>
|
||||
<td class="updated_on"><%= format_time(customer.updated_at) if customer.updated_at %></td>
|
||||
</tr>
|
||||
<% end %>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<span class="pagination"><%= pagination_links_full @customer_pages, @customer_count %></span>
|
||||
<% end %>
|
||||
|
||||
<p class="qbo-customer-stats"><%= render partial: 'qbo/stats' %></p>
|
||||
|
||||
<style>
|
||||
table.customers td.name { text-align: left; }
|
||||
table.customers td.phone, table.customers td.updated_on { white-space: nowrap; }
|
||||
table.customers td.issues { width: 1%; text-align: center; }
|
||||
.qbo-customer-search input { vertical-align: middle; }
|
||||
</style>
|
||||
@@ -1,11 +1,16 @@
|
||||
<div class="contextual">
|
||||
<% html_title @customer.to_s %>
|
||||
|
||||
<h2><%= link_to l(:label_customers), customers_path %> » <%= @customer.to_s %></h2>
|
||||
|
||||
<%# Under the title rather than beside it, so a long name and the many actions don't crowd each other %>
|
||||
<div class="contextual qbo-under-title">
|
||||
<%# New issue for this customer; picks up what's ticked on this page (an estimate, other plugins' items) %>
|
||||
<%= link_to sprite_icon('add', l(:label_new_issue)), new_issue_path(issue: { customer_id: @customer.id }),
|
||||
id: 'dynamic-new-issue-link', class: 'icon icon-add', target: :_blank %>
|
||||
<%# Plugins add their customer actions here (e.g. redmine_qbo_calendar's Add appointment) %>
|
||||
<%= call_hook :view_customers_show_contextual, { customer: @customer } %>
|
||||
<%# Estimates, invoices and payments are handled here, each shown to users with its permission. The customer's
|
||||
name below links to their QuickBooks account page as a fallback. %>
|
||||
<%# Estimates, invoices and payments are handled here, each shown to users with its permission; Open in
|
||||
QuickBooks goes to their QuickBooks account page for anything else. %>
|
||||
<% if RedmineQboBilling.writer? %>
|
||||
<%= render partial: 'qbo_estimates/customer_link', locals: { customer: @customer } %>
|
||||
<% end %>
|
||||
@@ -22,9 +27,10 @@
|
||||
<%= link_to sprite_icon('edit', l(:button_edit)), edit_customer_path(@customer),
|
||||
class: 'icon icon-edit', accesskey: accesskey(:edit) %>
|
||||
<% end %>
|
||||
<%= link_to sprite_icon('link', l(:button_open_in_quickbooks)),
|
||||
"https://#{RedmineQbo.sandbox_mode? ? 'sandbox' : 'app'}.qbo.intuit.com/app/customerdetail?nameId=#{@customer.id}",
|
||||
class: 'icon icon-link', target: :_blank, rel: 'noopener' %>
|
||||
</div>
|
||||
|
||||
<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">
|
||||
|
||||
@@ -16,6 +16,36 @@
|
||||
multiple: true, size: 8, id: 'settings_labor_item_ids' %>
|
||||
<em class="info"><%= l(:text_labor_items) %></em>
|
||||
</p>
|
||||
<%# QuickBooks custom fields to leave out of estimates and invoices (see RedmineQboBilling::Company). Hidden
|
||||
fields that aren't found right now (e.g. no recent estimate has them) are kept as hidden. %>
|
||||
<% company = RedmineQboBilling::Company %>
|
||||
<% qbo_fields = company.all_custom_fields %>
|
||||
<% hidden_ids = company.hidden_field_ids %>
|
||||
<% sales_field = company.sales_person_field %>
|
||||
<p class="qbo-custom-fields-setting">
|
||||
<label><%= l(:label_qbo_hidden_custom_fields) %></label>
|
||||
<%= hidden_field_tag 'settings[hidden_custom_field_ids][]', '', id: nil %>
|
||||
<% (hidden_ids - qbo_fields.map { |f| f.id.to_i }).each do |id| %>
|
||||
<%= hidden_field_tag 'settings[hidden_custom_field_ids][]', id, id: nil %>
|
||||
<% end %>
|
||||
<% if qbo_fields.empty? %>
|
||||
<%= l(:label_none) %>
|
||||
<% else %>
|
||||
<% qbo_fields.each do |field| %>
|
||||
<label class="block">
|
||||
<%= check_box_tag 'settings[hidden_custom_field_ids][]', field.id, hidden_ids.include?(field.id.to_i),
|
||||
id: "settings_hidden_custom_field_#{field.id}" %>
|
||||
<%= field.name %>
|
||||
<% if sales_field && sales_field.id.to_i == field.id.to_i %>
|
||||
<em>(<%= l(:text_qbo_sales_person_field) %>)</em>
|
||||
<% end %>
|
||||
</label>
|
||||
<% end %>
|
||||
<% end %>
|
||||
<%= link_to sprite_icon('reload', l(:button_refresh_quickbooks_fields)), refresh_company_qbo_estimates_path,
|
||||
method: :post, class: 'icon icon-reload' %>
|
||||
<em class="info"><%= l(:text_qbo_hidden_custom_fields) %></em>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<% issue_builder = RedmineQboBilling::EstimateIssueBuilder %>
|
||||
|
||||
@@ -415,10 +415,18 @@ $(function () {
|
||||
});
|
||||
|
||||
$('#qbo-estimate-clear-lines').on('click', function () {
|
||||
if (!window.confirm($(this).data('confirmText'))) return;
|
||||
rows().remove();
|
||||
addRow(); addRow();
|
||||
changed();
|
||||
function clearLines() {
|
||||
rows().remove();
|
||||
addRow(); addRow();
|
||||
changed();
|
||||
}
|
||||
// redmine_dark_mode asks in a dark dialog on dark pages; otherwise the browser's own box
|
||||
var message = $(this).data('confirmText');
|
||||
if (window.RedmineDarkMode && window.RedmineDarkMode.confirm) {
|
||||
window.RedmineDarkMode.confirm(message, clearLines);
|
||||
} else if (window.confirm(message)) {
|
||||
clearLines();
|
||||
}
|
||||
});
|
||||
|
||||
// Drag lines by the handle to reorder them; they're saved in table order
|
||||
@@ -446,7 +454,9 @@ $(function () {
|
||||
var id = $(this).val();
|
||||
if (!id) return;
|
||||
dirty = true;
|
||||
$.getJSON($form.data('customerInfoUrl'), { customer_id: id }).done(function (info) {
|
||||
$.getJSON($form.data('customerInfoUrl'), { customer_id: id, document: $form.data('document') }).done(function (info) {
|
||||
// A new invoice's open issues notice follows the customer
|
||||
if (info.open_issues_html !== undefined) $('#qbo-open-issues').replaceWith(info.open_issues_html);
|
||||
// Replace the email only if it was the previous customer's (or empty)
|
||||
if (!$email.val().trim() || $email.val() === loadedEmail) $email.val(info.email || '');
|
||||
loadedEmail = info.email || '';
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
<%# A new invoice's customer still has open issues (work orders), so they're not left behind once billed.
|
||||
Replaced when the customer is changed (customer_info's open_issues_html). %>
|
||||
<%
|
||||
issues = customer ? customer.issues.open.visible.order(id: :desc).to_a : []
|
||||
%>
|
||||
<div id="qbo-open-issues">
|
||||
<% if issues.any? %>
|
||||
<div class="warning qbo-estimate-notice">
|
||||
<%= l(:text_invoice_customer_open_issues, count: issues.size) %>
|
||||
<ul>
|
||||
<% issues.each do |issue| %>
|
||||
<li><%= link_to_issue(issue, truncate: 60) %> (<%= issue.status %>)</li>
|
||||
<% end %>
|
||||
</ul>
|
||||
</div>
|
||||
<% end %>
|
||||
</div>
|
||||
@@ -1,4 +1,5 @@
|
||||
<% html_title l(:label_new_invoice) %>
|
||||
|
||||
<%= render partial: 'qbo_estimates/header', locals: { form: @form } %>
|
||||
<%= render partial: 'qbo_invoices/open_issues', locals: { customer: (Customer.find_by(id: @form.customer_id) if @form.customer_id.present?) } %>
|
||||
<%= render partial: 'qbo_estimates/form', locals: { form: @form } %>
|
||||
@@ -289,9 +289,28 @@
|
||||
return 'rgba(' + (n >> 16 & 255) + ',' + (n >> 8 & 255) + ',' + (n & 255) + ',0.45)';
|
||||
}
|
||||
|
||||
// Grid lines and text from the page's colours, so a dark mode (e.g. redmine_dark_mode) can set
|
||||
// --qbo-chart-grid and --qbo-chart-text; Chart.js' own colours otherwise
|
||||
function chartColors() {
|
||||
var style = getComputedStyle(document.documentElement);
|
||||
return { grid: style.getPropertyValue('--qbo-chart-grid').trim() || 'rgba(0,0,0,0.1)',
|
||||
text: style.getPropertyValue('--qbo-chart-text').trim() || '#666' };
|
||||
}
|
||||
function applyColors(chart) {
|
||||
var c = chartColors();
|
||||
['x', 'y'].forEach(function(axis) {
|
||||
var scale = chart.options.scales[axis];
|
||||
scale.grid.color = c.grid;
|
||||
scale.border.color = c.grid;
|
||||
scale.ticks.color = c.text;
|
||||
});
|
||||
chart.options.plugins.legend.labels.color = c.text;
|
||||
}
|
||||
|
||||
function draw(Chart, canvas, compare) {
|
||||
var series = JSON.parse(canvas.getAttribute('data-series'));
|
||||
var isMoney = canvas.getAttribute('data-kind') === 'money';
|
||||
var colors = chartColors();
|
||||
var datasets = [];
|
||||
series.forEach(function(s) {
|
||||
datasets.push({ label: s.label, data: s.current, borderColor: s.color, backgroundColor: s.color,
|
||||
@@ -317,6 +336,7 @@
|
||||
position: 'bottom',
|
||||
labels: {
|
||||
boxWidth: 12,
|
||||
color: colors.text,
|
||||
generateLabels: function(chart) {
|
||||
var items = Chart.defaults.plugins.legend.labels.generateLabels(chart).filter(function(item) {
|
||||
return !chart.data.datasets[item.datasetIndex].previous;
|
||||
@@ -355,7 +375,9 @@
|
||||
}
|
||||
},
|
||||
scales: {
|
||||
y: { beginAtZero: true, ticks: { precision: isMoney ? 0 : 1, callback: function(v) { return isMoney ? money(v, 0) : v; } } }
|
||||
x: { grid: { color: colors.grid }, border: { color: colors.grid }, ticks: { color: colors.text } },
|
||||
y: { beginAtZero: true, grid: { color: colors.grid }, border: { color: colors.grid },
|
||||
ticks: { color: colors.text, precision: isMoney ? 0 : 1, callback: function(v) { return isMoney ? money(v, 0) : v; } } }
|
||||
}
|
||||
}
|
||||
});
|
||||
@@ -406,6 +428,10 @@
|
||||
$('.qbo-report-chart').hide();
|
||||
});
|
||||
$compare.on('change', function() { setCompare(this.checked); });
|
||||
// Switching between light and dark (redmine_dark_mode) recolours the charts
|
||||
document.addEventListener('redmine:color-scheme', function() {
|
||||
charts.forEach(function(chart) { applyColors(chart); chart.update('none'); });
|
||||
});
|
||||
});
|
||||
})();
|
||||
<% end %>
|
||||
@@ -0,0 +1,26 @@
|
||||
<?xml version="1.0"?>
|
||||
<!-- Activity icons (Tabler outline icons, MIT), in the layout of Redmine's own sprite -->
|
||||
<svg xmlns="http://www.w3.org/2000/svg" class="icon--sprite">
|
||||
<defs>
|
||||
<symbol viewBox="0 0 24 24" stroke-linecap="round" stroke-linejoin="round" id="icon--qbo-estimate">
|
||||
<path d="M9 5h-2a2 2 0 0 0 -2 2v12a2 2 0 0 0 2 2h10a2 2 0 0 0 2 -2v-12a2 2 0 0 0 -2 -2h-2"/>
|
||||
<path d="M9 5a2 2 0 0 1 2 -2h2a2 2 0 0 1 2 2a2 2 0 0 1 -2 2h-2a2 2 0 0 1 -2 -2z"/>
|
||||
<path d="M9 12h.01"/>
|
||||
<path d="M13 12h2"/>
|
||||
<path d="M9 16h.01"/>
|
||||
<path d="M13 16h2"/>
|
||||
</symbol>
|
||||
<symbol viewBox="0 0 24 24" stroke-linecap="round" stroke-linejoin="round" id="icon--qbo-invoice">
|
||||
<path d="M14 3v4a1 1 0 0 0 1 1h4"/>
|
||||
<path d="M17 21h-10a2 2 0 0 1 -2 -2v-14a2 2 0 0 1 2 -2h7l5 5v11a2 2 0 0 1 -2 2z"/>
|
||||
<path d="M9 7h1"/>
|
||||
<path d="M9 13h6"/>
|
||||
<path d="M13 17h2"/>
|
||||
</symbol>
|
||||
<symbol viewBox="0 0 24 24" stroke-linecap="round" stroke-linejoin="round" id="icon--qbo-payment">
|
||||
<path d="M7 11a2 2 0 0 1 2 -2h10a2 2 0 0 1 2 2v6a2 2 0 0 1 -2 2h-10a2 2 0 0 1 -2 -2z"/>
|
||||
<path d="M12 14a2 2 0 1 0 4 0a2 2 0 1 0 -4 0"/>
|
||||
<path d="M17 9v-2a2 2 0 0 0 -2 -2h-10a2 2 0 0 0 -2 2v6a2 2 0 0 0 2 2h2"/>
|
||||
</symbol>
|
||||
</defs>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 1.3 KiB |
@@ -2,4 +2,18 @@
|
||||
.ui-autocomplete .autocomplete-meta {
|
||||
color: #888;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
}
|
||||
/* Contextual links on their own line under the page title (customer and vehicle pages), where a long title and
|
||||
many links would otherwise crowd each other */
|
||||
#content .contextual.qbo-under-title {
|
||||
float: none;
|
||||
text-align: right;
|
||||
white-space: normal;
|
||||
margin: -4px 0 10px;
|
||||
padding-left: 0;
|
||||
}
|
||||
|
||||
/* Estimates, invoices and payments on the activity page belong to no project: no " - " after an empty name */
|
||||
div#activity span.project:empty:after {
|
||||
content: none;
|
||||
}
|
||||
+18
-1
@@ -65,7 +65,8 @@ en:
|
||||
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_customers: "No customers match \"%{search}\"."
|
||||
text_customers_best_match: "%{count} best matches, closest first. Click a column to sort them by it instead."
|
||||
label_no_estimates: "No Estimates"
|
||||
label_no_invoices: "No Invoices"
|
||||
label_oauth2_refresh_token_expires_at: "Refresh Token Expires At"
|
||||
@@ -128,6 +129,9 @@ en:
|
||||
button_email_estimate: "Email"
|
||||
button_open_in_quickbooks: "Open in QuickBooks"
|
||||
button_refresh_quickbooks_fields: "Refresh QuickBooks fields"
|
||||
label_qbo_hidden_custom_fields: "Hide QuickBooks custom fields"
|
||||
text_qbo_sales_person_field: "filled in with the sales person"
|
||||
text_qbo_hidden_custom_fields: "Ticked fields are left off estimates and invoices. QuickBooks doesn't tell apps which custom fields are inactive, and a field stays on its old estimates after it's turned off, so tick ones you no longer use (e.g. a renamed \"Sales Rep old\"). The sales person goes in the first field shown whose name has \"sales\" or \"rep\" in it."
|
||||
button_reload_estimate: "Reload the estimate"
|
||||
button_save_and_send: "Save and send"
|
||||
|
||||
@@ -255,6 +259,9 @@ en:
|
||||
notice_invoice_sent: "Invoice #%{number} emailed to %{email}"
|
||||
text_email_invoice_confirmation: "Email invoice #%{number} to %{email}?"
|
||||
text_invoice_from_estimate: "Made from estimate #%{number}. The estimate is closed when the invoice is saved."
|
||||
text_invoice_customer_open_issues:
|
||||
one: "This customer has an open issue. Make sure its work is finished and billed so it isn't left open:"
|
||||
other: "This customer has %{count} open issues. Make sure their work is finished and billed so none are left open:"
|
||||
text_line_bills_time: "Bills a QuickBooks time activity; saving marks the time as billed"
|
||||
text_replace_lines: "Tick the lines the time replaces (e.g. the estimate's labor lines). Each time entry takes the place of the line with its issue's description (e.g. Install Lift Kit), then any others in order."
|
||||
|
||||
@@ -354,3 +361,13 @@ en:
|
||||
text_payment_pick_invoices: "Tick invoices to fill in the amount and pay just those. With none ticked, the payment goes on the oldest invoices first."
|
||||
text_payment_reference: "e.g. the check number"
|
||||
text_payment_unapplied_deposit: "Not applied to any invoice: it's a credit on the customer's account."
|
||||
|
||||
# Activity page
|
||||
label_qbo_estimate_plural: "Estimates"
|
||||
label_qbo_invoice_plural: "Invoices"
|
||||
label_qbo_payment_plural: "Payments"
|
||||
label_activity_estimate: "Estimate #%{number}: %{customer}"
|
||||
label_activity_invoice: "Invoice #%{number}: %{customer}"
|
||||
label_activity_payment: "Payment from %{customer}: %{amount}"
|
||||
text_activity_invoice_owed: "%{amount} owed"
|
||||
text_activity_payment_unapplied: "%{amount} not applied to an invoice"
|
||||
@@ -14,7 +14,7 @@ Redmine::Plugin.register :redmine_qbo do
|
||||
name 'Redmine QBO plugin'
|
||||
author 'Rick Barrette'
|
||||
description 'A pluging for Redmine to connect with QuickBooks Online: customers, time activities for billable hours when an issue is closed, and estimates, invoices and payments written in Redmine'
|
||||
version '2026.11.5'
|
||||
version '2026.11.13'
|
||||
url 'https://github.com/rickbarrette/redmine_qbo'
|
||||
author_url 'https://barrettefabrication.com'
|
||||
settings default: {empty: true}, partial: 'qbo/settings'
|
||||
@@ -27,9 +27,6 @@ Redmine::Plugin.register :redmine_qbo do
|
||||
User.safe_attributes :employee_id
|
||||
TimeEntry.safe_attributes :billed
|
||||
|
||||
# set per_page globally
|
||||
WillPaginate.per_page = 20
|
||||
|
||||
# Global Permissions
|
||||
# autocomplete and the filter_* actions feed the customer, estimate and invoice pickers on issue forms
|
||||
permission :view_customers, { customers: [:index, :show, :autocomplete,
|
||||
@@ -55,6 +52,13 @@ Redmine::Plugin.register :redmine_qbo do
|
||||
permission :view_business_reports, { qbo_reports: [:index] }, global: true
|
||||
# The product/service list, accounts and their syncs are admin-only (see ItemsController, AccountsController)
|
||||
|
||||
# Estimates, invoices and payments on the activity page (QboActivity): the overall page only, for users with
|
||||
# View customers or Write estimates / invoices, and View or Receive payments
|
||||
# (plugin: picks their icons from this plugin's sprite, assets/images/icons.svg)
|
||||
activity_provider :qbo_estimates, class_name: 'Estimate', plugin: :redmine_qbo
|
||||
activity_provider :qbo_invoices, class_name: 'Invoice', plugin: :redmine_qbo
|
||||
activity_provider :qbo_payments, class_name: 'Payment', plugin: :redmine_qbo
|
||||
|
||||
# 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)}
|
||||
menu :top_menu, :qbo_reports, { controller: :qbo_reports, action: :index }, caption: :label_business_report,
|
||||
|
||||
@@ -18,11 +18,16 @@ module RedmineQbo
|
||||
IssueQuery.prepend RedmineQbo::Patches::QueryPatch
|
||||
TimeEntryQuery.prepend RedmineQbo::Patches::TimeEntryQueryPatch
|
||||
|
||||
# === Activity: estimates, invoices and payments, for users who may see them ===
|
||||
Redmine::Activity::Fetcher.prepend RedmineQbo::Patches::ActivityFetcherPatch
|
||||
|
||||
# === Controllers ===
|
||||
RedmineQbo::Patches::IssuesControllerPatch.apply
|
||||
RedmineQbo::Patches::AttachmentsControllerPatch.apply
|
||||
|
||||
# === Helpers / Exports ===
|
||||
IssuesHelper.prepend RedmineQbo::Patches::IssuesHelperPatch
|
||||
QueriesHelper.prepend RedmineQbo::Patches::QueriesHelperPatch
|
||||
Redmine::Export::PDF::IssuesPdfHelper.prepend RedmineQbo::Patches::PdfPatch
|
||||
|
||||
# === Hooks ===
|
||||
|
||||
@@ -0,0 +1,29 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
module RedmineQbo
|
||||
module Patches
|
||||
# The activity page lists every activity type for the whole site, and a project's page those its members may
|
||||
# see. QuickBooks estimates, invoices and payments (QboActivity) belong to no project: they're kept to the
|
||||
# overall page, and to users with one of their permissions, so nobody gets a checkbox for activity they can't see.
|
||||
module ActivityFetcherPatch
|
||||
def event_types
|
||||
return @event_types if @qbo_activity_checked
|
||||
|
||||
@qbo_activity_checked = true
|
||||
@event_types = super.select do |event_type|
|
||||
providers = Redmine::Activity.providers[event_type].map(&:constantize)
|
||||
qbo = providers.select { |provider| provider.respond_to?(:qbo_activity_visible_to?) }
|
||||
qbo.empty? || (project.nil? && qbo.any? { |provider| provider.qbo_activity_visible_to?(user) })
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,69 @@
|
||||
#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
|
||||
module Patches
|
||||
# Shows the customer and estimate by name, and invoices attached by the QuickBooks webhook, in an
|
||||
# issue's history, emails and PDF. Redmine records the customer and estimate by id, like its own
|
||||
# fields, but only looks up names for the fields it knows about. The ids stay in the database, so
|
||||
# existing history entries show names too.
|
||||
module IssuesHelperPatch
|
||||
JOURNAL_NAMED_FIELDS = { 'customer_id' => 'Customer', 'estimate_id' => 'Estimate' }.freeze
|
||||
|
||||
def show_detail(detail, no_html = false, options = {})
|
||||
return qbo_invoice_detail(detail, no_html, options) if detail.property == 'invoice'
|
||||
|
||||
model = detail.property == 'attr' && JOURNAL_NAMED_FIELDS[detail.prop_key]
|
||||
return super unless model
|
||||
|
||||
# Hand Redmine a copy with names in place of ids, so it formats it like any other change
|
||||
named = JournalDetail.new(property: detail.property, prop_key: detail.prop_key,
|
||||
old_value: qbo_journal_name(model, detail.old_value),
|
||||
value: qbo_journal_name(model, detail.value))
|
||||
named.id = detail.id
|
||||
named.journal_id = detail.journal_id
|
||||
super(named, no_html, options)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# "Invoice 1042 added", recorded when the QuickBooks webhook attaches an invoice to the issue
|
||||
# (see InvoiceAttachmentService). The number links to the invoice PDF while the invoice exists.
|
||||
def qbo_invoice_detail(detail, no_html, options)
|
||||
label = l(:field_invoice)
|
||||
value = detail.value
|
||||
old_value = detail.old_value
|
||||
|
||||
unless no_html
|
||||
label = content_tag('strong', label)
|
||||
if value.present?
|
||||
value = Invoice.exists?(detail.prop_key) ? link_to(value, invoice_url(detail.prop_key, only_path: options[:only_path] != false)) : content_tag('i', value)
|
||||
end
|
||||
old_value = content_tag('del', content_tag('i', old_value)) if old_value.present?
|
||||
end
|
||||
|
||||
if detail.value.present?
|
||||
l(:text_journal_added, label: label, value: value).html_safe
|
||||
else
|
||||
l(:text_journal_deleted, label: label, old: old_value).html_safe
|
||||
end
|
||||
end
|
||||
|
||||
# The record's name, or the id when it no longer exists. Cached for the request, since a
|
||||
# history can mention the same customer many times.
|
||||
def qbo_journal_name(model, id)
|
||||
return id if id.blank?
|
||||
|
||||
@qbo_journal_names ||= {}
|
||||
@qbo_journal_names[[model, id]] ||= model.constantize.find_by(id: id)&.to_s.presence || id
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -0,0 +1,31 @@
|
||||
#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
|
||||
module Patches
|
||||
# Links the Customer column in issue lists to the customer's page, for users who may open it
|
||||
# (View customers). Others see the name as plain text. CSV and PDF exports are unchanged.
|
||||
module QueriesHelperPatch
|
||||
def column_value(column, item, value)
|
||||
return super unless column.name == :customer && value.is_a?(Customer) && qbo_can_view_customers?
|
||||
|
||||
link_to(value.to_s, customer_path(value))
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def qbo_can_view_customers?
|
||||
return @qbo_can_view_customers if defined?(@qbo_can_view_customers)
|
||||
|
||||
@qbo_can_view_customers = User.current.allowed_to?(:view_customers, nil, global: true)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -32,7 +32,6 @@ module RedmineQbo
|
||||
unless @available_columns
|
||||
@available_columns = self.class.available_columns.dup
|
||||
@available_columns << QueryColumn.new(:customer, sortable: "#{Issue.table_name}.customer_id", groupable: true, caption: :field_customer)
|
||||
@available_columns << QueryColumn.new(:billed, sortable: "#{TimeEntry.table_name}.billed", groupable: true, caption: :field_billed)
|
||||
end
|
||||
super
|
||||
end
|
||||
|
||||
@@ -17,7 +17,7 @@ module RedmineQbo
|
||||
def available_columns
|
||||
unless @available_columns
|
||||
@available_columns = self.class.available_columns.dup
|
||||
@available_columns << QueryColumn.new(:billed, sortable: "#{TimeEntry.table_name}.name", groupable: true, caption: :field_billed)
|
||||
@available_columns << QueryColumn.new(:billed, sortable: "#{TimeEntry.table_name}.billed", groupable: "#{TimeEntry.table_name}.billed", caption: :field_billed)
|
||||
end
|
||||
super
|
||||
end
|
||||
|
||||
@@ -24,6 +24,8 @@ module RedmineQboBilling
|
||||
MISSING_FIELD_CACHE_TIME = 5.minutes
|
||||
# Recent estimates also show which custom fields exist, for companies whose preferences don't list them
|
||||
RECENT_ESTIMATES = 20
|
||||
# QuickBooks' legacy sales form custom fields; its newer custom fields have larger DefinitionIds
|
||||
LEGACY_FIELD_IDS = (1..3).freeze
|
||||
|
||||
# The sales person field is found loosely, e.g. "Sales Person", "Salesperson", "Sales Rep"
|
||||
SALES_PERSON_NAME = /sales|\brep\b/i
|
||||
@@ -32,11 +34,26 @@ module RedmineQboBilling
|
||||
|
||||
module_function
|
||||
|
||||
# All enabled sales form custom fields, in QuickBooks' order
|
||||
# The sales form custom fields the plugin uses, in QuickBooks' order: all those found, except the ones
|
||||
# hidden in the plugin settings. Everything else (the editor, the sales person, other plugins' VIN and
|
||||
# mileage) goes through here, so a hidden field is never shown or filled in.
|
||||
def custom_fields
|
||||
hidden = hidden_field_ids
|
||||
all_custom_fields.reject { |f| hidden.include?(f.id.to_i) }
|
||||
end
|
||||
|
||||
# Every custom field found, hidden ones included (listed on the plugin settings page)
|
||||
def all_custom_fields
|
||||
Array(settings[:custom_fields]).map { |f| Field.new(f[:id], f[:name]) }
|
||||
end
|
||||
|
||||
# Fields hidden in the plugin settings. QuickBooks doesn't tell apps which custom fields are inactive,
|
||||
# and a field stays on its old estimates after it's turned off (e.g. a renamed "Sales Rep old"), so the
|
||||
# plugin can't leave those out by itself.
|
||||
def hidden_field_ids
|
||||
Array((Setting.plugin_redmine_qbo || {})['hidden_custom_field_ids']).map(&:to_i).reject(&:zero?)
|
||||
end
|
||||
|
||||
# The first enabled custom field whose name matches, e.g. a plugin's VIN field (/\bvin\b/i), or nil
|
||||
def custom_field_matching(pattern)
|
||||
custom_fields.detect { |f| f.name.to_s =~ pattern }
|
||||
@@ -105,9 +122,15 @@ module RedmineQboBilling
|
||||
nil
|
||||
end
|
||||
|
||||
# Fields named in the preferences come first; fields only seen on estimates are added after them.
|
||||
# QuickBooks' newer custom fields (e.g. on Advanced and sandbox companies) may not be in the preferences.
|
||||
# QuickBooks' newer custom fields (made under Settings > Custom fields) aren't in the preferences, which
|
||||
# keep listing the legacy fields (DefinitionIds 1-3) after a company moves to the newer ones, often
|
||||
# renamed or inactive (e.g. "Sales Rep old"). Once estimates show any newer field, those are the
|
||||
# company's fields and the legacy ones are left out. Otherwise the legacy fields named in the
|
||||
# preferences come first, then any only seen on estimates.
|
||||
def merge_fields(from_preferences, from_estimates)
|
||||
newer = from_estimates.reject { |f| LEGACY_FIELD_IDS.cover?(f[:id]) }
|
||||
return newer if newer.any?
|
||||
|
||||
ids = from_preferences.map { |f| f[:id] }
|
||||
from_preferences + from_estimates.reject { |f| ids.include?(f[:id]) }
|
||||
end
|
||||
|
||||
Reference in new issue
Block a user