mirror of
https://github.com/rickbarrette/redmine_qbo.git
synced 2026-11-17 18:20:36 -05:00
Show estimate, invoice and payment activity on the activity page
Each type appears only on the overall activity page, and only for users who may see it: estimates need View customers or Write estimates, invoices View customers or Write invoices, and payments View or Receive payments. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
1 parent
dbee228cdf
commit
159420fac1
10 files changed
+185
No files matched your search
@@ -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
|
||||
|
||||
Reference in new issue
Block a user