mirror of
https://github.com/rickbarrette/redmine_qbo.git
synced 2026-04-02 16:21:58 -04:00
Compare commits
54 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 1dcccd7b98 | |||
| f73973a4e1 | |||
| 7cd388dbd4 | |||
| 7149e85d37 | |||
| eacdecd65b | |||
| ee2ab04206 | |||
| 8a8c6f5fa0 | |||
| cc36bc16b4 | |||
| 874ec7c2dc | |||
| f3fe38cd57 | |||
| 977cbfe0e1 | |||
| 82712f361c | |||
| 4ae7d75478 | |||
| 8fb9d74277 | |||
| b0e6236cee | |||
| b367687113 | |||
| 460bcd466f | |||
| 020ea01d36 | |||
| df079b767c | |||
| 7d3908ec41 | |||
| f60e507029 | |||
| 3e6650ee65 | |||
| c2d0e5c702 | |||
| a4f461fd4d | |||
| 3e81d2840a | |||
| c9a5dc20f9 | |||
| db3c6021c5 | |||
| b8327be5d6 | |||
| c4e1ece82c | |||
| 9fd7140e4a | |||
| a6c8923ea9 | |||
| eb1174cf7c | |||
| 7993f15441 | |||
| bb57af71ae | |||
| 1a10360884 | |||
| cd109f16b5 | |||
| 164252cb97 | |||
| fd18205c10 | |||
| 6fc8a18e93 | |||
| 8abc95c21e | |||
| 2bcb1840a4 | |||
| c87e18810b | |||
| eb6954ddf1 | |||
| be1a69217f | |||
| 99669f7baa | |||
| 29530e2c95 | |||
| beb4a66a93 | |||
| 40f7a3335c | |||
| da0f7ffc56 | |||
| 4fa8be856a | |||
| ffd8dc6332 | |||
| cd219a0c00 | |||
| cd88ce6217 | |||
| b10665355d |
6
Gemfile
6
Gemfile
@@ -4,11 +4,5 @@ gem 'quickbooks-ruby'
|
||||
gem 'oauth2'
|
||||
gem 'roxml'
|
||||
gem 'will_paginate'
|
||||
gem 'rails-jquery-autocomplete'
|
||||
gem 'jquery-ui-rails'
|
||||
gem 'rexml'
|
||||
gem 'combine_pdf'
|
||||
|
||||
group :assets do
|
||||
gem 'coffee-rails'
|
||||
end
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 672 KiB After Width: | Height: | Size: 269 KiB |
@@ -30,40 +30,49 @@ class CustomersController < ApplicationController
|
||||
before_action :view_customer, except: [:new, :view]
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, only: [:view]
|
||||
|
||||
autocomplete :customer, :name, full: true, extra_data: [:id]
|
||||
def address_to_s(address)
|
||||
return if address.nil?
|
||||
|
||||
lines = [
|
||||
address.line1,
|
||||
address.line2,
|
||||
address.line3,
|
||||
address.line4,
|
||||
address.line5
|
||||
].compact_blank
|
||||
|
||||
city_line = [
|
||||
address.city,
|
||||
address.country_sub_division_code,
|
||||
address.postal_code
|
||||
].compact_blank.join(" ")
|
||||
|
||||
lines << city_line unless city_line.blank?
|
||||
|
||||
lines.join("\n")
|
||||
end
|
||||
|
||||
def add_customer
|
||||
global_check_permission(:add_customers)
|
||||
end
|
||||
|
||||
def allowed_params
|
||||
params.require(:customer).permit(:name, :email, :primary_phone, :mobile_phone, :phone_number, :notes)
|
||||
end
|
||||
|
||||
# getter method for a customer's invoices
|
||||
# used for customer autocomplete field / issue form
|
||||
def filter_invoices_by_customer
|
||||
@filtered_invoices = Invoice.all.where(customer_id: params[:selected_customer])
|
||||
# Used for autocomplete form
|
||||
def autocomplete
|
||||
term = ActiveRecord::Base.sanitize_sql_like(params[:q].to_s)
|
||||
|
||||
items = Customer.where("name LIKE :t OR phone_number LIKE :t OR mobile_phone_number LIKE :t", t: "%#{term}%")
|
||||
.order(:name)
|
||||
.limit(20)
|
||||
|
||||
render json: items.map { |i|
|
||||
{ id: i.id, name: i.name, phone_number: i.phone_number, mobile_phone_number: i.mobile_phone_number }
|
||||
}
|
||||
end
|
||||
|
||||
# getter method for a customer's estimates
|
||||
# used for customer autocomplete field / issue form
|
||||
def filter_estimates_by_customer
|
||||
@filtered_estimates = Estimate.all.where(customer_id: params[:selected_customer])
|
||||
end
|
||||
|
||||
# display a list of all customers
|
||||
def index
|
||||
if params[:search]
|
||||
@customers = Customer.search(params[:search]).order(:name).paginate(page: params[:page])
|
||||
if only_one_non_zero?(@customers)
|
||||
redirect_to @customers.first
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# initialize a new customer
|
||||
def new
|
||||
@customer = Customer.new
|
||||
end
|
||||
|
||||
# create a new customer
|
||||
def create
|
||||
@customer = Customer.new(allowed_params)
|
||||
@customer.save
|
||||
@@ -76,7 +85,79 @@ class CustomersController < ApplicationController
|
||||
redirect_to new_customer_path
|
||||
end
|
||||
|
||||
# display a specific customer
|
||||
def edit
|
||||
@customer = Customer.find_by_id(params[:id])
|
||||
return render_404 unless @customer
|
||||
rescue => e
|
||||
log "Failed to edit customer"
|
||||
flash[:error] = e.message
|
||||
render_404
|
||||
end
|
||||
|
||||
def filter_estimates_by_customer
|
||||
@filtered_estimates = Estimate.all.where(customer_id: params[:selected_customer])
|
||||
end
|
||||
|
||||
def filter_invoices_by_customer
|
||||
@filtered_invoices = Invoice.all.where(customer_id: params[:selected_customer])
|
||||
end
|
||||
|
||||
def index
|
||||
if params[:search]
|
||||
@customers = Customer.search(params[:search]).order(:name).paginate(page: params[:page])
|
||||
if only_one_non_zero?(@customers)
|
||||
redirect_to @customers.first
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
def load_issue_data
|
||||
@journals = @issue.journals.preload(:details).preload(user: :email_address).reorder(:created_on, :id).to_a
|
||||
|
||||
@journals.each_with_index { |j, i| j.indice = i + 1 }
|
||||
@journals.reject!(&:private_notes?) unless User.current.allowed_to?(:view_private_notes, @issue.project)
|
||||
Journal.preload_journals_details_custom_fields(@journals)
|
||||
@journals.select! { |journal| journal.notes? || journal.visible_details.any? }
|
||||
@journals.reverse! if User.current.wants_comments_in_reverse_order?
|
||||
|
||||
@changesets = @issue.changesets.visible.preload(:repository, :user).to_a
|
||||
@changesets.reverse! if User.current.wants_comments_in_reverse_order?
|
||||
|
||||
@relations = @issue.relations.select { |r| r.other_issue(@issue)&.visible? }
|
||||
@allowed_statuses = @issue.new_statuses_allowed_to(User.current)
|
||||
@priorities = IssuePriority.active
|
||||
@time_entry = TimeEntry.new(issue: @issue, project: @issue.project)
|
||||
@relation = IssueRelation.new
|
||||
end
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[CustomersController] #{msg}"
|
||||
end
|
||||
|
||||
def new
|
||||
@customer = Customer.new
|
||||
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.find(params[:id])
|
||||
token = issue.share_token
|
||||
redirect_to view_path(token.token)
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
flash[:error] = t(:notice_issue_not_found)
|
||||
render_404
|
||||
end
|
||||
|
||||
def show
|
||||
@customer = Customer.find_by_id(params[:id])
|
||||
return render_404 unless @customer
|
||||
@@ -109,17 +190,11 @@ class CustomersController < ApplicationController
|
||||
render_404
|
||||
end
|
||||
|
||||
# return an HTML form for editing a customer
|
||||
def edit
|
||||
@customer = Customer.find_by_id(params[:id])
|
||||
return render_404 unless @customer
|
||||
rescue => e
|
||||
log "Failed to edit customer"
|
||||
flash[:error] = e.message
|
||||
render_404
|
||||
def sync
|
||||
Customer.sync
|
||||
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
||||
end
|
||||
|
||||
# update a specific customer
|
||||
def update
|
||||
@customer = Customer.find_by_id(params[:id])
|
||||
@customer.update(allowed_params)
|
||||
@@ -131,108 +206,21 @@ class CustomersController < ApplicationController
|
||||
redirect_to edit_customer_path
|
||||
end
|
||||
|
||||
# creates new customer view tokens, removes expired tokens & redirects to newly created customer view with new token.
|
||||
def share
|
||||
issue = Issue.find(params[:id])
|
||||
token = issue.share_token
|
||||
redirect_to view_path(token.token)
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
flash[:error] = t(:notice_issue_not_found)
|
||||
render_404
|
||||
end
|
||||
|
||||
# displays an issue for a customer with a provided security CustomerToken
|
||||
def view
|
||||
User.current = User.anonymous
|
||||
|
||||
# Load only active, non-expired token
|
||||
@token = CustomerToken.active.find_by(token: params[:token])
|
||||
return render_403 unless @token
|
||||
|
||||
# Load associated issue
|
||||
@issue = @token.issue
|
||||
return render_403 unless @issue
|
||||
|
||||
# Optional: enforce token belongs to the issue's customer
|
||||
return render_403 unless @issue.customer_id == @token.issue.customer_id
|
||||
|
||||
# Store token in session for subsequent requests if needed
|
||||
session[:token] = @token.token
|
||||
|
||||
load_issue_data
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
render_403
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def load_issue_data
|
||||
@journals = @issue.journals.preload(:details).preload(user: :email_address).reorder(:created_on, :id).to_a
|
||||
|
||||
@journals.each_with_index { |j, i| j.indice = i + 1 }
|
||||
@journals.reject!(&:private_notes?) unless User.current.allowed_to?(:view_private_notes, @issue.project)
|
||||
Journal.preload_journals_details_custom_fields(@journals)
|
||||
@journals.select! { |journal| journal.notes? || journal.visible_details.any? }
|
||||
@journals.reverse! if User.current.wants_comments_in_reverse_order?
|
||||
|
||||
@changesets = @issue.changesets.visible.preload(:repository, :user).to_a
|
||||
@changesets.reverse! if User.current.wants_comments_in_reverse_order?
|
||||
|
||||
@relations = @issue.relations.select { |r| r.other_issue(@issue)&.visible? }
|
||||
@allowed_statuses = @issue.new_statuses_allowed_to(User.current)
|
||||
@priorities = IssuePriority.active
|
||||
@time_entry = TimeEntry.new(issue: @issue, project: @issue.project)
|
||||
@relation = IssueRelation.new
|
||||
end
|
||||
|
||||
# redmine permission - add customers
|
||||
def add_customer
|
||||
global_check_permission(:add_customers)
|
||||
end
|
||||
|
||||
# redmine permission - view customers
|
||||
def view_customer
|
||||
global_check_permission(:view_customers)
|
||||
end
|
||||
|
||||
# checks to see if there is only one item in an array
|
||||
# @return true if array only has one item
|
||||
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
|
||||
|
||||
# format a quickbooks address to a human readable string
|
||||
def address_to_s(address)
|
||||
return if address.nil?
|
||||
|
||||
lines = [
|
||||
address.line1,
|
||||
address.line2,
|
||||
address.line3,
|
||||
address.line4,
|
||||
address.line5
|
||||
].compact_blank
|
||||
|
||||
city_line = [
|
||||
address.city,
|
||||
address.country_sub_division_code,
|
||||
address.postal_code
|
||||
].compact_blank.join(" ")
|
||||
|
||||
lines << city_line unless city_line.blank?
|
||||
|
||||
lines.join("\n")
|
||||
end
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[CustomersController] #{msg}"
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
@@ -7,10 +7,20 @@
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
class EstimatePdfService < PdfServiceBase
|
||||
class EmployeesController < ApplicationController
|
||||
include AuthHelper
|
||||
|
||||
def self.model_class
|
||||
Estimate
|
||||
before_action :require_user, unless: -> { session[:token].nil? }
|
||||
|
||||
def sync
|
||||
Employee.sync
|
||||
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Logs messages with a consistent prefix for easier debugging.
|
||||
def log(msg)
|
||||
Rails.logger.info "[EmployeeController] #{msg}"
|
||||
end
|
||||
end
|
||||
@@ -7,7 +7,7 @@
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
class EstimateController < ApplicationController
|
||||
class EstimatesController < ApplicationController
|
||||
include AuthHelper
|
||||
|
||||
before_action :require_user, unless: -> { session[:token].nil? }
|
||||
@@ -24,6 +24,11 @@ class EstimateController < ApplicationController
|
||||
render_pdf(@estimate)
|
||||
end
|
||||
|
||||
def sync
|
||||
Estimate.sync
|
||||
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Loads the estimate based on ID or doc number, with a fallback to sync if not found locally.
|
||||
@@ -65,7 +70,7 @@ class EstimateController < ApplicationController
|
||||
|
||||
# Renders the estimate PDF or redirects with an error if rendering fails.
|
||||
def render_pdf(estimate)
|
||||
pdf, ref = EstimatePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: [estimate.id])
|
||||
pdf, ref = PdfService.new(entity: Estimate).fetch_pdf(doc_ids: [estimate.id])
|
||||
send_data( pdf, filename: "estimate #{ref}.pdf", disposition: :inline, type: "application/pdf" )
|
||||
rescue StandardError => e
|
||||
log "PDF render failed for Estimate #{estimate&.id}: #{e.message}"
|
||||
@@ -7,7 +7,7 @@
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
class InvoiceController < ApplicationController
|
||||
class InvoicesController < ApplicationController
|
||||
include AuthHelper
|
||||
|
||||
before_action :require_user, unless: -> { session[:token].nil? }
|
||||
@@ -18,7 +18,7 @@ class InvoiceController < ApplicationController
|
||||
log "Processing request for #{request.original_url}"
|
||||
|
||||
invoice_ids = Array(params[:invoice_ids] || params[:id])
|
||||
pdf, ref = InvoicePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: invoice_ids)
|
||||
pdf, ref = PdfService.new(entity: Invoice).fetch_pdf(doc_ids: invoice_ids)
|
||||
|
||||
send_data pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf"
|
||||
|
||||
@@ -27,6 +27,11 @@ class InvoiceController < ApplicationController
|
||||
redirect_back fallback_location: root_path, flash: { error: I18n.t(:notice_invoice_not_found) }
|
||||
end
|
||||
|
||||
def sync
|
||||
Invoice.sync
|
||||
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Logs messages with a consistent prefix for easier debugging.
|
||||
@@ -46,9 +46,13 @@ class QboController < ApplicationController
|
||||
redirect_to issue || root_path, flash: { error: e.message }
|
||||
end
|
||||
|
||||
# Manual sync endpoint to trigger a full synchronization of QuickBooks entities with the local database. Enqueues all relevant sync jobs and redirects to the home page with a notice that syncing has started.
|
||||
# Manual sync endpoint to trigger synchronization of QuickBooks entities
|
||||
# with the local database. Supports full or partial sync depending on
|
||||
# the `full_sync` boolean parameter.
|
||||
def sync
|
||||
QboSyncDispatcher.full_sync!
|
||||
full_sync = ActiveModel::Type::Boolean.new.cast(params[:full_sync])
|
||||
QboSyncDispatcher.sync!(full_sync: full_sync)
|
||||
|
||||
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
||||
end
|
||||
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class EmployeeSyncJob < ApplicationJob
|
||||
queue_as :default
|
||||
retry_on StandardError, wait: 5.minutes, attempts: 5
|
||||
|
||||
# Performs a sync of employees from QuickBooks Online.
|
||||
def perform(full_sync: false, id: nil)
|
||||
qbo = QboConnectionService.current!
|
||||
raise "No QBO configuration found" unless qbo
|
||||
|
||||
log "Starting #{full_sync ? 'full' : 'incremental'} sync for employee ##{id || 'all'}..."
|
||||
|
||||
service = EmployeeSyncService.new(qbo: qbo)
|
||||
|
||||
if id.present?
|
||||
service.sync_by_id(id)
|
||||
else
|
||||
service.sync(full_sync: full_sync)
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[EmployeeSyncJob] #{msg}"
|
||||
end
|
||||
end
|
||||
@@ -1,36 +0,0 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class InvoiceSyncJob < ApplicationJob
|
||||
queue_as :default
|
||||
retry_on StandardError, wait: 5.minutes, attempts: 5
|
||||
|
||||
# Performs a sync of invoices from QuickBooks Online.
|
||||
def perform(full_sync: false, id: nil)
|
||||
qbo = QboConnectionService.current!
|
||||
raise "No QBO configuration found" unless qbo
|
||||
|
||||
log "Starting #{full_sync ? 'full' : 'incremental'} sync for invoice ##{id || 'all'}..."
|
||||
|
||||
service = InvoiceSyncService.new(qbo: qbo)
|
||||
|
||||
if id.present?
|
||||
service.sync_by_id(id)
|
||||
else
|
||||
service.sync(full_sync: full_sync)
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[InvoiceSyncJob] #{msg}"
|
||||
end
|
||||
end
|
||||
@@ -11,29 +11,37 @@
|
||||
class QboSyncDispatcher
|
||||
|
||||
SYNC_JOBS = [
|
||||
CustomerSyncJob,
|
||||
EstimateSyncJob,
|
||||
InvoiceSyncJob,
|
||||
EmployeeSyncJob
|
||||
Customer,
|
||||
Estimate,
|
||||
Invoice,
|
||||
Employee
|
||||
].freeze
|
||||
|
||||
# Dispatches all synchronization jobs to perform a full sync of QuickBooks entities with the local database. Each job is enqueued with the `full_sync` flag set to true.
|
||||
def self.full_sync!
|
||||
# Dispatches all synchronization jobs to perform a full sync of QuickBooks entities with the local database.
|
||||
# Each job is enqueued with the `full_sync` flag set to true.
|
||||
def self.sync!(full_sync: false)
|
||||
log "Manual Sync initated for #{full_sync ? "full sync" : "incremental sync"}"
|
||||
enque_jobs full_sync: full_sync
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Dynamically enques all sync jobs
|
||||
def self.enque_jobs(full_sync: full_sync)
|
||||
jobs = SYNC_JOBS.dup
|
||||
|
||||
# Allow other plugins to add addtional sync jobs via Hooks
|
||||
Redmine::Hook.call_hook( :qbo_full_sync ).each do |context|
|
||||
next unless context
|
||||
jobs.push context
|
||||
log "Added additionals QBO Sync Job for #{contex.to_s}"
|
||||
Array(context).each do |entity|
|
||||
jobs.push(entity)
|
||||
log "Added additional QBO Sync Job for #{entity.to_s}"
|
||||
end
|
||||
end
|
||||
|
||||
jobs.each { |job| job.perform_later(full_sync: true) }
|
||||
jobs.each { |job| QboSyncJob.perform_later(entity: job, full_sync: full_sync) }
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def self.log(msg)
|
||||
Rails.logger.info "[QboSyncDispatcher] #{msg}"
|
||||
end
|
||||
|
||||
@@ -8,23 +8,22 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class EstimateSyncJob < ApplicationJob
|
||||
class QboSyncJob < ApplicationJob
|
||||
queue_as :default
|
||||
retry_on StandardError, wait: 5.minutes, attempts: 5
|
||||
|
||||
# Performs a sync of estimates from QuickBooks Online.
|
||||
def perform(full_sync: false, id: nil, doc_number: nil)
|
||||
qbo = QboConnectionService.current!
|
||||
raise "No QBO configuration found" unless qbo
|
||||
# Perform a full sync of all records for the entity, or an incremental sync of only those updated since the last sync
|
||||
def perform(full_sync: false, id: nil, entity: nil, doc_number: nil)
|
||||
raise "An entity to sync is required" unless entity
|
||||
@entity = entity
|
||||
|
||||
log "Starting #{full_sync ? 'full' : 'incremental'} sync for estimate ##{id || doc_number || 'all'}..."
|
||||
|
||||
service = EstimateSyncService.new(qbo: qbo)
|
||||
log "Starting #{full_sync ? 'full' : 'incremental'} sync for #{entity} ##{id || doc_number || 'all'}..."
|
||||
service = "#{entity}SyncService".constantize.new
|
||||
|
||||
if id.present?
|
||||
service.sync_by_id(id)
|
||||
elsif doc_number.present?
|
||||
service.sync_by_doc(doc_number)
|
||||
service.sync_by_doc_number(doc_number)
|
||||
else
|
||||
service.sync(full_sync: full_sync)
|
||||
end
|
||||
@@ -32,7 +31,8 @@ class EstimateSyncJob < ApplicationJob
|
||||
|
||||
private
|
||||
|
||||
# Log messages with the entity type for better traceability
|
||||
def log(msg)
|
||||
Rails.logger.info "[EstimateSyncJob] #{msg}"
|
||||
Rails.logger.info "[#{@entity}SyncJob] #{msg}"
|
||||
end
|
||||
end
|
||||
@@ -14,7 +14,7 @@ class QboWebhookProcessor
|
||||
def self.process!(request:)
|
||||
body = request.raw_post
|
||||
signature = request.headers['intuit-signature']
|
||||
secret = Setting.plugin_redmine_qbo['settingsWebhookToken']
|
||||
secret = RedmineQbo.webhook_token_secret
|
||||
|
||||
raise "Invalid signature" unless valid_signature?(body, signature, secret)
|
||||
|
||||
|
||||
@@ -43,14 +43,16 @@ class WebhookProcessJob < ActiveJob::Base
|
||||
name = entity['name']
|
||||
id = entity['id']&.to_i
|
||||
|
||||
entitys = ALLOWED_ENTITIES.dup
|
||||
entities = ALLOWED_ENTITIES.dup
|
||||
# Allow other plugins to add addtional qbo entities via Hooks
|
||||
Redmine::Hook.call_hook( :qbo_additional_entities ).each do |context|
|
||||
next unless context
|
||||
entitys.push context
|
||||
log "Added additional QBO entities: #{context}"
|
||||
Array(context).each do |entity|
|
||||
entities.push(entity)
|
||||
log "Added additional QBO entity #{entity}"
|
||||
end
|
||||
end
|
||||
return unless entitys.include?(name)
|
||||
return unless entities.include?(name)
|
||||
|
||||
model = name.safe_constantize
|
||||
return unless model
|
||||
|
||||
@@ -75,11 +75,8 @@ module QuickbooksOauth
|
||||
# This method will construct and return an instance of the OAuth2::Client class that is configured with the consumer key, consumer secret and the appropriate URLs for the Intuit OAuth2 service. It will also set the sandbox mode based on the plugin settings. This method is used by the instance method oauth_client to create a new OAuth2 client for each instance of the model that includes this concern.
|
||||
def construct_oauth2_client
|
||||
|
||||
oauth_consumer_key = Setting.plugin_redmine_qbo['settingsOAuthConsumerKey']
|
||||
oauth_consumer_secret = Setting.plugin_redmine_qbo['settingsOAuthConsumerSecret']
|
||||
|
||||
# Are we are playing in the sandbox?
|
||||
Quickbooks.sandbox_mode = Setting.plugin_redmine_qbo[:sandbox] ? true : false
|
||||
Quickbooks.sandbox_mode = RedmineQbo.sandbox_mode?
|
||||
log "Sandbox mode: #{Quickbooks.sandbox_mode}"
|
||||
|
||||
options = {
|
||||
@@ -87,7 +84,7 @@ module QuickbooksOauth
|
||||
authorize_url: "https://appcenter.intuit.com/connect/oauth2",
|
||||
token_url: "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer"
|
||||
}
|
||||
OAuth2::Client.new(oauth_consumer_key, oauth_consumer_secret, options)
|
||||
OAuth2::Client.new(RedmineQbo.oauth_consumer_key, RedmineQbo.oauth_consumer_secret, options)
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
@@ -8,21 +8,19 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class Customer < ActiveRecord::Base
|
||||
class Customer < QboBaseModel
|
||||
|
||||
include Redmine::Acts::Searchable
|
||||
include Redmine::Acts::Event
|
||||
include Redmine::I18n
|
||||
|
||||
has_many :issues
|
||||
has_many :invoices
|
||||
has_many :estimates
|
||||
|
||||
validates_presence_of :id, :name
|
||||
validates_presence_of :name
|
||||
before_validation :normalize_phone_numbers
|
||||
|
||||
self.primary_key = :id
|
||||
|
||||
qbo_sync push: true
|
||||
|
||||
acts_as_searchable columns: %w[name phone_number mobile_phone_number ],
|
||||
scope: ->(_context) { left_joins(:project) },
|
||||
date_column: :updated_at
|
||||
@@ -33,41 +31,14 @@ class Customer < ActiveRecord::Base
|
||||
:description => Proc.new {|o| "#{I18n.t :label_primary_phone}: #{o.phone_number} #{I18n.t:label_mobile_phone}: #{o.mobile_phone_number}"},
|
||||
:datetime => Proc.new {|o| o.updated_at || o.created_at}
|
||||
|
||||
# Returns the details of the customer. If the details have already been fetched, it returns the cached version. Otherwise, it fetches the details from QuickBooks Online and caches them for future use. This method is used to access the customer's information in a way that minimizes unnecessary API calls to QBO, improving performance and reducing latency.
|
||||
def details
|
||||
return (@details ||= Quickbooks::Model::Customer.new) if new_record?
|
||||
|
||||
@details ||= begin
|
||||
xml = Rails.cache.fetch(details_cache_key, expires_in: 10.minutes) do
|
||||
fetch_details.to_xml_ns
|
||||
end
|
||||
|
||||
Quickbooks::Model::Customer.from_xml(xml)
|
||||
end
|
||||
end
|
||||
|
||||
# Generates a unique cache key for storing this customer's QBO details.
|
||||
def details_cache_key
|
||||
"customer:#{id}:qbo_details:#{updated_at.to_i}"
|
||||
end
|
||||
|
||||
# Returns the customer's email address
|
||||
def email
|
||||
details
|
||||
return @details&.email_address&.address
|
||||
return details&.email_address&.address
|
||||
end
|
||||
|
||||
# Updates the customer's email address
|
||||
def email=(s)
|
||||
details
|
||||
@details.email_address = s
|
||||
end
|
||||
|
||||
|
||||
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
|
||||
def self.last_sync
|
||||
return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
|
||||
format_time(maximum(:updated_at))
|
||||
details.email_address = s
|
||||
end
|
||||
|
||||
# Customers are not bound by a project
|
||||
@@ -76,35 +47,21 @@ class Customer < ActiveRecord::Base
|
||||
nil
|
||||
end
|
||||
|
||||
# Magic Method
|
||||
# Maps Get/Set methods to QBO customer object
|
||||
def method_missing(method_name, *args, &block)
|
||||
if Quickbooks::Model::Customer.method_defined?(method_name)
|
||||
details
|
||||
@details.public_send(method_name, *args, &block)
|
||||
else
|
||||
super
|
||||
end
|
||||
end
|
||||
|
||||
# returns the customer's mobile phone
|
||||
def mobile_phone
|
||||
details
|
||||
return @details&.mobile_phone&.free_form_number
|
||||
return details&.mobile_phone&.free_form_number
|
||||
end
|
||||
|
||||
# Updates the custome's mobile phone number
|
||||
def mobile_phone=(n)
|
||||
details
|
||||
pn = Quickbooks::Model::TelephoneNumber.new
|
||||
pn.free_form_number = n
|
||||
@details.mobile_phone = pn
|
||||
details.mobile_phone = pn
|
||||
end
|
||||
|
||||
# Updates Both local DB name & QBO display_name
|
||||
def name=(s)
|
||||
details
|
||||
@details.display_name = s
|
||||
details.display_name = s
|
||||
super
|
||||
end
|
||||
|
||||
@@ -116,27 +73,19 @@ class Customer < ActiveRecord::Base
|
||||
|
||||
# Sets the notes for the customer
|
||||
def notes=(s)
|
||||
details
|
||||
@details.notes = s
|
||||
details.notes = s
|
||||
end
|
||||
|
||||
# returns the customer's primary phone
|
||||
def primary_phone
|
||||
details
|
||||
return @details&.primary_phone&.free_form_number
|
||||
return details&.primary_phone&.free_form_number
|
||||
end
|
||||
|
||||
# Updates the customer's primary phone number
|
||||
def primary_phone=(n)
|
||||
details
|
||||
pn = Quickbooks::Model::TelephoneNumber.new
|
||||
pn.free_form_number = n
|
||||
@details.primary_phone = pn
|
||||
end
|
||||
|
||||
# Repsonds to missing methods by delegating to the QBO customer details object if the method is defined there. This allows for dynamic access to any attributes or methods of the QBO customer without having to explicitly define them in the Customer model, providing flexibility and reducing boilerplate code.
|
||||
def respond_to_missing?(method_name, include_private = false)
|
||||
Quickbooks::Model::Customer.method_defined?(method_name) || super
|
||||
details.primary_phone = pn
|
||||
end
|
||||
|
||||
# Seach for customers by name or phone number
|
||||
@@ -160,47 +109,10 @@ class Customer < ActiveRecord::Base
|
||||
ids.index_with { |id| id }
|
||||
end
|
||||
|
||||
# performs a sync operation for all customers
|
||||
def self.sync
|
||||
CustomerSyncJob.perform_later(full_sync: false)
|
||||
end
|
||||
|
||||
# performs a sync operation for a specific customer
|
||||
def self.sync_by_id(id)
|
||||
CustomerSyncJob.perform_later(id: id)
|
||||
end
|
||||
|
||||
# returns a human readable string
|
||||
def to_s
|
||||
last4 = phone_number&.last(4)
|
||||
last4.present? ? "#{name} - #{last4}" : name.to_s
|
||||
end
|
||||
|
||||
# Push the updates
|
||||
def save_with_push
|
||||
log "Starting push for customer ##{self.id}..."
|
||||
qbo = QboConnectionService.current!
|
||||
CustomerService.new(qbo: qbo, customer: self).push()
|
||||
Rails.cache.delete(details_cache_key)
|
||||
save_without_push
|
||||
end
|
||||
|
||||
alias_method :save_without_push, :save
|
||||
alias_method :save, :save_with_push
|
||||
|
||||
private
|
||||
|
||||
# Fetches the customer's details from QuickBooks Online. If the customer has an ID, it makes an authenticated request to QBO to retrieve the customer's information. If the customer does not have an ID or if there is an error during the fetch, it returns a new instance of Quickbooks::Model::Customer with default values. This method is used to ensure that the customer object has the most up-to-date information from QBO when needed.
|
||||
def fetch_details
|
||||
return Quickbooks::Model::Customer.new unless id.present?
|
||||
log "Fetching details for customer ##{id} from QBO..."
|
||||
qbo = QboConnectionService.current!
|
||||
CustomerService.new(qbo: qbo, customer: self).pull()
|
||||
end
|
||||
|
||||
# Log messages with the entity type for better traceability
|
||||
def log(msg)
|
||||
Rails.logger.info "[Customer] #{msg}"
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
@@ -8,29 +8,11 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class Employee < ActiveRecord::Base
|
||||
|
||||
include Redmine::I18n
|
||||
class Employee < QboBaseModel
|
||||
|
||||
has_many :users
|
||||
validates_presence_of :id, :name
|
||||
|
||||
self.primary_key = :id
|
||||
|
||||
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
|
||||
def self.last_sync
|
||||
return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
|
||||
format_time(maximum(:updated_at))
|
||||
end
|
||||
qbo_sync push: false
|
||||
|
||||
# Sync all employees, typically triggered by a scheduled task or manual sync request
|
||||
def self.sync
|
||||
EmployeeSyncJob.perform_later(full_sync: true)
|
||||
end
|
||||
|
||||
# Sync a single employee by ID, typically triggered by a webhook notification or manual sync request
|
||||
def self.sync_by_id(id)
|
||||
EmployeeSyncJob.perform_later(id: id)
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
@@ -8,45 +8,22 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class Estimate < ActiveRecord::Base
|
||||
|
||||
include Redmine::I18n
|
||||
class Estimate < QboBaseModel
|
||||
|
||||
has_and_belongs_to_many :issues
|
||||
belongs_to :customer
|
||||
validates_presence_of :doc_number, :id
|
||||
self.primary_key = :id
|
||||
|
||||
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
|
||||
def self.last_sync
|
||||
return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
|
||||
format_time(maximum(:updated_at))
|
||||
end
|
||||
qbo_sync push: false
|
||||
|
||||
# returns a human readable string
|
||||
def to_s
|
||||
return self[:doc_number]
|
||||
end
|
||||
|
||||
# sync all estimates
|
||||
def self.sync
|
||||
EstimateSyncJob.perform_later(full_sync: false)
|
||||
end
|
||||
|
||||
# sync only one estimate
|
||||
def self.sync_by_id(id)
|
||||
EstimateSyncJob.perform_later(id: id)
|
||||
end
|
||||
|
||||
# sync only one estimate
|
||||
# sync only one estimate by document number
|
||||
def self.sync_by_doc_number(number)
|
||||
EstimateSyncJob.perform_later(doc_number: number)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[Estimate] #{msg}"
|
||||
QboSyncJob.perform_later(entity: model_name.name, doc_number: number)
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
@@ -8,37 +8,18 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class Invoice < ActiveRecord::Base
|
||||
|
||||
include Redmine::I18n
|
||||
class Invoice < QboBaseModel
|
||||
|
||||
has_and_belongs_to_many :issues
|
||||
belongs_to :customer
|
||||
|
||||
validates :id, presence: true, uniqueness: true
|
||||
validates :doc_number, :txn_date, presence: true
|
||||
|
||||
self.primary_key = :id
|
||||
|
||||
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
|
||||
def self.last_sync
|
||||
return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
|
||||
format_time(maximum(:updated_at))
|
||||
end
|
||||
qbo_sync push: false
|
||||
|
||||
# Return the invoice's document number as its string representation
|
||||
def to_s
|
||||
doc_number
|
||||
end
|
||||
|
||||
# Sync all invoices from QuickBooks, typically triggered by a scheduled task or manual sync request
|
||||
def self.sync
|
||||
InvoiceSyncJob.perform_later(full_sync: true)
|
||||
end
|
||||
|
||||
# Sync a single invoice by ID, typically triggered by a webhook notification or manual sync request
|
||||
def self.sync_by_id(id)
|
||||
InvoiceSyncJob.perform_later(id: id)
|
||||
end
|
||||
|
||||
end
|
||||
@@ -14,6 +14,26 @@ class Qbo < ActiveRecord::Base
|
||||
include Redmine::I18n
|
||||
|
||||
validate :single_record_only, on: :create
|
||||
|
||||
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
|
||||
def self.last_sync
|
||||
qbo = QboConnectionService.current!
|
||||
format_time(qbo.last_sync)
|
||||
rescue
|
||||
return I18n.t(:label_qbo_never_synced)
|
||||
end
|
||||
|
||||
def self.oauth2_access_token_expires_at
|
||||
QboConnectionService.current!.oauth2_access_token_expires_at
|
||||
rescue
|
||||
return I18n.t(:label_qbo_never_synced)
|
||||
end
|
||||
|
||||
def self.oauth2_refresh_token_expires_at
|
||||
QboConnectionService.current!.oauth2_refresh_token_expires_at
|
||||
rescue
|
||||
return I18n.t(:label_qbo_never_synced)
|
||||
end
|
||||
|
||||
# Updates last sync time stamp
|
||||
def self.update_time_stamp
|
||||
@@ -24,13 +44,6 @@ class Qbo < ActiveRecord::Base
|
||||
qbo.save
|
||||
end
|
||||
|
||||
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
|
||||
def self.last_sync
|
||||
qbo = QboConnectionService.current!
|
||||
return I18n.t(:label_qbo_never_synced) unless qbo&.last_sync
|
||||
format_time(qbo.last_sync)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Logs a message with a QBO-specific prefix for easier identification in the logs.
|
||||
|
||||
122
app/models/qbo_base_model.rb
Normal file
122
app/models/qbo_base_model.rb
Normal file
@@ -0,0 +1,122 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class QboBaseModel < ActiveRecord::Base
|
||||
|
||||
include Redmine::I18n
|
||||
|
||||
self.abstract_class = true
|
||||
validates_presence_of :id
|
||||
class_attribute :qbo_push_enabled, default: true
|
||||
attr_accessor :skip_qbo_push
|
||||
before_validation :push_to_qbo, on: :create, if: :push_to_qbo?
|
||||
after_commit :push_to_qbo, on: :update, if: :push_to_qbo?
|
||||
|
||||
# Returns the details of the entity.
|
||||
# If the details have already been fetched, it returns the cached version.
|
||||
# Otherwise, it fetches the details from QuickBooks Online and caches them for future use.
|
||||
# This method is used to access the entity's information in a way that minimizes unnecessary API calls to QBO, improving performance and reducing latency.
|
||||
def details
|
||||
@details ||= begin
|
||||
xml = Rails.cache.fetch(details_cache_key, expires_in: 10.minutes) do
|
||||
fetch_details.to_xml_ns
|
||||
end
|
||||
qbo_model_class.from_xml(xml)
|
||||
end
|
||||
end
|
||||
|
||||
# Generates a unique cache key for storing this customer's QBO details.
|
||||
def details_cache_key
|
||||
"#{model_name.name}:#{id}:qbo_details:#{updated_at.to_i}"
|
||||
end
|
||||
|
||||
# Returns the last sync time formatted for display.
|
||||
# If no sync has occurred, returns a default message.
|
||||
def self.last_sync
|
||||
return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
|
||||
format_time(maximum(:updated_at))
|
||||
end
|
||||
|
||||
# Magic Method
|
||||
# Maps Get/Set methods to QBO entity object
|
||||
def method_missing(method_name, *args, &block)
|
||||
if qbo_model_class.method_defined?(method_name)
|
||||
details
|
||||
@details.public_send(method_name, *args, &block)
|
||||
else
|
||||
super
|
||||
end
|
||||
end
|
||||
|
||||
def push_to_qbo?
|
||||
log "qbo_push_enabled #{self.class.qbo_push_enabled}"
|
||||
log "skip_qbo_push #{skip_qbo_push}"
|
||||
|
||||
self.class.qbo_push_enabled && skip_qbo_push != true
|
||||
end
|
||||
|
||||
# Repsonds to missing methods by delegating to the QBO entity calss if the method is defined there.
|
||||
# This allows for dynamic access to any attributes or methods of the QBO customer without having to explicitly define them in the Subclass model, providing flexibility and reducing boilerplate code.
|
||||
def respond_to_missing?(method_name, include_private = false)
|
||||
qbo_model_class.method_defined?(method_name) || super
|
||||
end
|
||||
|
||||
# Sync all entities, typically triggered by a scheduled task or manual sync request
|
||||
def self.sync
|
||||
QboSyncJob.perform_later(entity: model_name.name, full_sync: true)
|
||||
end
|
||||
|
||||
# Sync a single entity by ID, typically triggered by a webhook notification or manual sync request
|
||||
def self.sync_by_id(id)
|
||||
QboSyncJob.perform_later(entity: model_name.name, id: id)
|
||||
end
|
||||
|
||||
# Flag used to update local without pushing to QBO.
|
||||
# This is used to prevent loops with the webhook
|
||||
def skip_qbo_push?
|
||||
!!skip_qbo_push
|
||||
end
|
||||
|
||||
def self.qbo_sync(push: true)
|
||||
self.qbo_push_enabled = push
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Log messages with a standarized prefix
|
||||
def log(msg)
|
||||
Rails.logger.info "[#{model_name.name}] #{msg}"
|
||||
end
|
||||
|
||||
# Fetches the entity's details from QuickBooks Online.
|
||||
def fetch_details
|
||||
log "Fetching details for #{model_name.name} ##{id} from QBO..."
|
||||
service_class.new(local: self).pull()
|
||||
end
|
||||
|
||||
# Pushs the entity's details from QuickBooks Online.
|
||||
def push_to_qbo
|
||||
log "Starting push for #{model_name.name} ##{id}..."
|
||||
reslut = service_class.new(local: self).push
|
||||
Rails.cache.delete(details_cache_key)
|
||||
return reslut
|
||||
end
|
||||
|
||||
# Dynamically get the Quickbooks Model Class
|
||||
def qbo_model_class
|
||||
@qbo_model_class ||= "Quickbooks::Model::#{model_name.name}".constantize
|
||||
end
|
||||
|
||||
# Dynamically get the Service Class
|
||||
def service_class
|
||||
@service_class ||= "#{model_name.name}Service".constantize
|
||||
end
|
||||
|
||||
end
|
||||
@@ -8,55 +8,13 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class CustomerService
|
||||
|
||||
# Initializes the service with a QBO client and an optional customer record. The QBO client is used to communicate with QuickBooks Online, while the customer record contains the data that needs to be pushed to QBO. If no customer is provided, the service will not perform any operations.
|
||||
def initialize(qbo:, customer: nil)
|
||||
raise "No QBO configuration found" unless qbo
|
||||
raise "Customer record is required for push operation" unless customer
|
||||
@qbo = qbo
|
||||
@customer = customer
|
||||
end
|
||||
|
||||
# Pulls the customer data from QuickBooks Online.
|
||||
def pull
|
||||
return Quickbooks::Model::Customer.new unless @customer.present?
|
||||
log "Fetching details for customer ##{@customer.id} from QBO..."
|
||||
qbo = QboConnectionService.current!
|
||||
qbo.perform_authenticated_request do |access_token|
|
||||
service = Quickbooks::Service::Customer.new(
|
||||
company_id: qbo.realm_id,
|
||||
access_token: access_token
|
||||
)
|
||||
service.fetch_by_id(@customer.id)
|
||||
end
|
||||
rescue => e
|
||||
log "Fetch failed for #{@customer.id}: #{e.message}"
|
||||
Quickbooks::Model::Customer.new
|
||||
end
|
||||
|
||||
# Pushes the customer data to QuickBooks Online. This method handles the communication with QBO, including authentication and error handling. It uses the QBO client to send the customer data and logs the process for monitoring and debugging purposes. If the push is successful, it returns the customer record; otherwise, it logs the error and returns false.
|
||||
def push
|
||||
log "Pushing customer ##{@customer.id} to QBO..."
|
||||
|
||||
customer = @qbo.perform_authenticated_request do |access_token|
|
||||
service = Quickbooks::Service::Customer.new(
|
||||
company_id: @qbo.realm_id,
|
||||
access_token: access_token
|
||||
)
|
||||
service.update(@customer.details)
|
||||
end
|
||||
|
||||
@customer.id = customer.id unless @customer.persisted?
|
||||
log "Push for customer ##{@customer.id} completed."
|
||||
return @customer
|
||||
end
|
||||
class CustomerService < ServiceBase
|
||||
|
||||
private
|
||||
|
||||
# Log messages with the entity type for better traceability
|
||||
def log(msg)
|
||||
Rails.logger.info "[CustomerService] #{msg}"
|
||||
def build_qbo_remote
|
||||
log "Building new QBO Customer"
|
||||
Quickbooks::Model::Customer.new
|
||||
end
|
||||
|
||||
end
|
||||
@@ -17,16 +17,13 @@ class CustomerSyncService < SyncServiceBase
|
||||
Customer
|
||||
end
|
||||
|
||||
# Determine if the remote entity should be deleted locally (e.g. if it's marked inactive in QBO)
|
||||
def destroy_remote?(remote)
|
||||
# Determine if the local entity should be deleted (e.g. if it's marked inactive in QBO)
|
||||
def destroy_local?(remote)
|
||||
!remote.active?
|
||||
end
|
||||
|
||||
# Map relevant attributes from the QBO Customer to the local Customer model
|
||||
def process_attributes(local, remote)
|
||||
local.name = remote.display_name
|
||||
local.phone_number = remote.primary_phone&.free_form_number&.gsub(/\D/, '')
|
||||
local.mobile_phone_number = remote.mobile_phone&.free_form_number&.gsub(/\D/, '')
|
||||
end
|
||||
map_attribute :name, :display_name
|
||||
map_phone :phone_number, :primary_phone
|
||||
map_phone :mobile_phone_number, :mobile_phone
|
||||
|
||||
end
|
||||
@@ -17,14 +17,11 @@ class EmployeeSyncService < SyncServiceBase
|
||||
Employee
|
||||
end
|
||||
|
||||
# Determine if the remote entity should be deleted locally (e.g. if it's marked inactive in QBO)
|
||||
def destroy_remote?(remote)
|
||||
# Determine if the local entity should be deleted (e.g. if it's marked inactive in QBO)
|
||||
def destroy_local?(remote)
|
||||
!remote.active?
|
||||
end
|
||||
|
||||
# Map relevant attributes from the QBO Employee to the local Employee model
|
||||
def process_attributes(local, remote)
|
||||
local.name = remote.display_name
|
||||
end
|
||||
map_attribute :name, :display_name
|
||||
|
||||
end
|
||||
@@ -9,6 +9,14 @@
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class EstimateSyncService < SyncServiceBase
|
||||
|
||||
# sync only one estimate
|
||||
def sync_by_doc_number(number)
|
||||
log "Syncing estimate by doc number #{number}"
|
||||
QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||
persist(service.find_by( :doc_number, number).first)
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
@@ -17,11 +25,7 @@ class EstimateSyncService < SyncServiceBase
|
||||
Estimate
|
||||
end
|
||||
|
||||
# Map relevant attributes from the QBO Estimate to the local Estimate model
|
||||
def process_attributes(local, remote)
|
||||
local.doc_number = remote.doc_number
|
||||
local.txn_date = remote.txn_date
|
||||
local.customer = Customer.find_by(id: remote.customer_ref&.value)
|
||||
end
|
||||
map_attributes :doc_number, :txn_date
|
||||
map_belongs_to :customer
|
||||
|
||||
end
|
||||
@@ -1,16 +0,0 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
class InvoicePdfService < PdfServiceBase
|
||||
|
||||
def self.model_class
|
||||
Invoice
|
||||
end
|
||||
|
||||
end
|
||||
@@ -17,20 +17,11 @@ class InvoicePushService
|
||||
# Push invoice changes to QBO if the invoice is linked to any issues with custom field changes that need to be synced
|
||||
def push
|
||||
return if @invoice.qbo_sync_locked?
|
||||
|
||||
log "Pushing invoice ##{@invoice.id} to QBO due to linked issue custom field changes"
|
||||
|
||||
@invoice.update_column(:qbo_sync_locked, true)
|
||||
|
||||
qbo = QboConnectionService.current!
|
||||
|
||||
qbo.perform_authenticated_request do |access_token|
|
||||
service = Quickbooks::Service::Invoice.new( company_id: qbo.realm_id, access_token: access_token)
|
||||
|
||||
remote = QboConnectionService.with_qbo_service(entity: Invoice) do |service|
|
||||
remote = service.fetch_by_id(@invoice.id)
|
||||
|
||||
# modify remote object here if needed
|
||||
|
||||
service.update(remote)
|
||||
end
|
||||
rescue => e
|
||||
|
||||
@@ -16,20 +16,15 @@ class InvoiceSyncService < SyncServiceBase
|
||||
def self.model_class
|
||||
Invoice
|
||||
end
|
||||
|
||||
# Map relevant attributes from the QBO Invoice to the local Invoice model
|
||||
def process_attributes(local, remote)
|
||||
local.doc_number = remote.doc_number
|
||||
local.txn_date = remote.txn_date
|
||||
local.due_date = remote.due_date
|
||||
local.total_amount = remote.total
|
||||
local.balance = remote.balance
|
||||
local.qbo_updated_at = remote.meta_data&.last_updated_time
|
||||
local.customer = Customer.find_by(id: remote.customer_ref&.value)
|
||||
end
|
||||
|
||||
# Attach QBO Invoices to the local Issues
|
||||
def attach_documents(local, remote)
|
||||
InvoiceAttachmentService.new(local, remote).attach
|
||||
end
|
||||
|
||||
map_attributes :balance, :doc_number, :due_date, :txn_date
|
||||
map_attribute :total_amount, :total
|
||||
map_attribute :qbo_updated_at, "meta_data.last_updated_time"
|
||||
map_belongs_to :customer
|
||||
|
||||
end
|
||||
@@ -7,30 +7,21 @@
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
class PdfServiceBase
|
||||
class PdfService
|
||||
|
||||
require 'combine_pdf'
|
||||
|
||||
# Subclasses should initialize with a QBO client instance
|
||||
def initialize(qbo:)
|
||||
@qbo = qbo
|
||||
@entity = self.class.model_class
|
||||
end
|
||||
|
||||
# Subclasses must implement this to specify which document model to download pdf (e.g. Estimate, Invoice)
|
||||
def self.model_class
|
||||
raise NotImplementedError
|
||||
def initialize(entity: entity)
|
||||
raise "An entity to sync is required" unless entity
|
||||
@entity = entity
|
||||
end
|
||||
|
||||
# Fetches the PDF for the given entity IDs. If multiple IDs are provided, their PDFs are combined into a single document.
|
||||
def fetch_pdf(doc_ids:)
|
||||
log "Fetching PDFs for #{@entity} IDs: #{doc_ids.join(', ')}"
|
||||
@qbo.perform_authenticated_request do |access_token|
|
||||
service_class = "Quickbooks::Service::#{@entity.name}".constantize
|
||||
service = service_class.new(company_id: @qbo.realm_id, access_token: access_token)
|
||||
|
||||
QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||
return single_pdf(service, doc_ids.first) if doc_ids.size == 1
|
||||
|
||||
combined_pdf(service, doc_ids)
|
||||
end
|
||||
end
|
||||
@@ -10,6 +10,11 @@
|
||||
|
||||
class QboConnectionService
|
||||
|
||||
# Returns the current QBO connection record. Raises an error if no connection exists.
|
||||
def self.current!
|
||||
Qbo.first || raise("QBO not connected")
|
||||
end
|
||||
|
||||
# Replaces the existing QBO connection with new credentials. Deletes all existing records and creates a new one with the provided token, refresh token, and realm ID. Refreshes the token immediately after creation.
|
||||
def self.replace!(token:, refresh_token:, realm_id:)
|
||||
Qbo.transaction do
|
||||
@@ -24,9 +29,14 @@ class QboConnectionService
|
||||
end
|
||||
end
|
||||
|
||||
# Returns the current QBO connection record. Raises an error if no connection exists.
|
||||
def self.current!
|
||||
Qbo.first || raise("QBO not connected")
|
||||
# Performs authenticaed requests with QBO service
|
||||
def self.with_qbo_service(entity: nil)
|
||||
qbo = current!
|
||||
raise "An entity to sync is required" unless entity
|
||||
service_class ||= "Quickbooks::Service::#{entity}".constantize
|
||||
qbo.perform_authenticated_request do |access_token|
|
||||
service = service_class.new( company_id: qbo.realm_id, access_token: access_token )
|
||||
yield service
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
@@ -10,7 +10,8 @@
|
||||
|
||||
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.
|
||||
# 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:)
|
||||
client.auth_code.authorize_url(
|
||||
redirect_uri: callback_url,
|
||||
@@ -20,7 +21,8 @@ class QboOauthService
|
||||
)
|
||||
end
|
||||
|
||||
# Exchanges the authorization code for access and refresh tokens. Creates or replaces the QBO connection record with the new credentials and refreshes the token immediately after creation.
|
||||
# Exchanges the authorization code for access and refresh tokens.
|
||||
# Creates or replaces the QBO connection record with the new credentials and refreshes the token immediately after creation.
|
||||
def self.exchange!(code:, callback_url:, realm_id:)
|
||||
resp = client.auth_code.get_token(code, redirect_uri: callback_url)
|
||||
QboConnectionService.replace!( token: resp.token, refresh_token: resp.refresh_token, realm_id: realm_id )
|
||||
|
||||
67
app/services/service_base.rb
Normal file
67
app/services/service_base.rb
Normal file
@@ -0,0 +1,67 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class ServiceBase
|
||||
|
||||
# Subclasses should Initializes the service with a QBO client and a local record.
|
||||
# The QBO client is used to communicate with QuickBooks Online, while the local record contains the data that needs to be pushed to QBO.
|
||||
# If no local is provided, the service will not perform any operations.
|
||||
def initialize(local: nil)
|
||||
@entity = local.class.name
|
||||
raise "#{@entity} record is required for push operation" unless local
|
||||
@local = local
|
||||
end
|
||||
|
||||
# Subclasses must implement this to build a new QBO entity if a remote is not found
|
||||
def build_qbo_remote
|
||||
raise NotImplementedError
|
||||
end
|
||||
|
||||
# Pulls the Item data from QuickBooks Online.
|
||||
def pull
|
||||
return build_qbo_remote unless @local.present?
|
||||
return build_qbo_remote unless @local.id
|
||||
log "Fetching details for #{@entity} ##{@local.id} from QBO..."
|
||||
QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||
service.fetch_by_id(@local.id)
|
||||
end
|
||||
rescue => e
|
||||
log "Fetch failed for #{@local.id}: #{e.message}"
|
||||
build_qbo_remote
|
||||
end
|
||||
|
||||
# Pushes the Item data to QuickBooks Online.
|
||||
# This method handles the communication with QBO, including authentication and error handling.
|
||||
# It uses the QBO client to send the remote data and logs the process for monitoring and debugging purposes.
|
||||
# If the push is successful, it returns the remote record; otherwise, it logs the error and returns false.
|
||||
def push
|
||||
log "Pushing #{@entity} ##{@local.id} to QBO..."
|
||||
remote = QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||
if @local.id.present?
|
||||
log "Updating #{@entity}"
|
||||
service.update(@local.details)
|
||||
else
|
||||
log "Creating #{@entity}"
|
||||
service.create(@local.details)
|
||||
end
|
||||
end
|
||||
@local.id = remote.id unless @local.persisted?
|
||||
log "Push for remote ##{@local.id} completed."
|
||||
@local
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Log messages with the entity type for better traceability
|
||||
def log(msg)
|
||||
Rails.logger.info "[#{@entity}Service] #{msg}"
|
||||
end
|
||||
|
||||
end
|
||||
@@ -12,10 +12,14 @@ class SyncServiceBase
|
||||
PAGE_SIZE = 1000
|
||||
|
||||
# Subclasses should initialize with a QBO client instance
|
||||
def initialize(qbo:)
|
||||
raise "No QBO configuration found" unless qbo
|
||||
@qbo = qbo
|
||||
def initialize()
|
||||
@entity = self.class.model_class
|
||||
@page_size = self.class.page_size
|
||||
end
|
||||
|
||||
# Subclasses can implement this to overide the default page size
|
||||
def self.page_size
|
||||
@page_size = PAGE_SIZE
|
||||
end
|
||||
|
||||
# Subclasses must implement this to specify which local model they sync (e.g. Customer, Invoice)
|
||||
@@ -25,18 +29,12 @@ class SyncServiceBase
|
||||
|
||||
# Sync all entities, or only those updated since the last sync
|
||||
def sync(full_sync: false)
|
||||
log "Starting #{full_sync ? 'full' : 'incremental'} #{@entity.name} sync"
|
||||
|
||||
@qbo.perform_authenticated_request do |access_token|
|
||||
service_class = "Quickbooks::Service::#{@entity.name}".constantize
|
||||
service = service_class.new(company_id: @qbo.realm_id, access_token: access_token)
|
||||
|
||||
query = build_query(full_sync)
|
||||
|
||||
service.query_in_batches(query, per_page: self.class::PAGE_SIZE) do |batch|
|
||||
log "Starting #{full_sync ? 'full' : 'incremental'} #{@entity.name} sync with page size of: #{@page_size}"
|
||||
QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||
query = build_query(full_sync)
|
||||
service.query_in_batches(query, per_page: @page_size) do |batch|
|
||||
entries = Array(batch)
|
||||
log "Processing batch of #{entries.size} #{@entity.name}"
|
||||
|
||||
entries.each do |remote|
|
||||
persist(remote)
|
||||
end
|
||||
@@ -49,11 +47,7 @@ class SyncServiceBase
|
||||
# Sync a single entity by its QBO ID (webhook usage)
|
||||
def sync_by_id(id)
|
||||
log "Syncing #{@entity.name} with ID #{id}"
|
||||
|
||||
@qbo.perform_authenticated_request do |access_token|
|
||||
service_class = "Quickbooks::Service::#{@entity.name}".constantize
|
||||
service = service_class.new(company_id: @qbo.realm_id, access_token: access_token)
|
||||
|
||||
QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||
remote = service.fetch_by_id(id)
|
||||
persist(remote)
|
||||
end
|
||||
@@ -61,6 +55,11 @@ class SyncServiceBase
|
||||
|
||||
private
|
||||
|
||||
def attach_documents(local, remote)
|
||||
# Override in subclasses if the entity has attachments (e.g. Invoice)
|
||||
end
|
||||
|
||||
# Builds a QBO query for retrieving entities
|
||||
def build_query(full_sync)
|
||||
if full_sync
|
||||
"SELECT * FROM #{@entity.name} ORDER BY Id"
|
||||
@@ -75,13 +74,125 @@ class SyncServiceBase
|
||||
end
|
||||
end
|
||||
|
||||
def attach_documents(local, remote)
|
||||
# Override in subclasses if the entity has attachments (e.g. Invoice)
|
||||
# Determine if a remote entity should be deleted locally (e.g. if it's marked inactive in QBO)
|
||||
def destroy_local?(remote)
|
||||
false
|
||||
end
|
||||
|
||||
# Determine if a remote entity should be deleted locally (e.g. if it's marked inactive in QBO)
|
||||
def destroy_remote?(remote)
|
||||
false
|
||||
def extract_value(remote, remote_attr)
|
||||
case remote_attr
|
||||
when Proc
|
||||
remote_attr.call(remote)
|
||||
else
|
||||
remote.public_send(remote_attr)
|
||||
end
|
||||
end
|
||||
|
||||
# Attribute Mapping DSL
|
||||
#
|
||||
# This DSL defines how attributes from a QuickBooks Online (QBO) entity
|
||||
# are mapped onto a local ActiveRecord model during synchronization.
|
||||
#
|
||||
# Each mapping registers a lambda in `attribute_map`. When a remote QBO
|
||||
# object is processed, the lambda is executed to extract and transform
|
||||
# the value that will be assigned to the local model attribute.
|
||||
#
|
||||
# The DSL supports several mapping patterns:
|
||||
#
|
||||
# 1. Direct attribute mapping (same name)
|
||||
#
|
||||
# map_attribute :doc_number
|
||||
#
|
||||
# Equivalent to:
|
||||
#
|
||||
# local.doc_number = remote.doc_number
|
||||
#
|
||||
# 2. Renamed attribute mapping
|
||||
#
|
||||
# map_attribute :total_amount, :total
|
||||
#
|
||||
# Equivalent to:
|
||||
#
|
||||
# local.total_amount = remote.total
|
||||
#
|
||||
# 3. Custom transformation logic
|
||||
#
|
||||
# map_attribute :qbo_updated_at do |remote|
|
||||
# remote.meta_data&.last_updated_time
|
||||
# end
|
||||
#
|
||||
# Useful for nested fields or computed values.
|
||||
#
|
||||
# 4. Bulk attribute mapping
|
||||
#
|
||||
# map_attributes :doc_number, :txn_date, :due_date
|
||||
#
|
||||
# Convenience helper that maps multiple attributes with identical names.
|
||||
#
|
||||
# 5. Foreign key / reference mapping
|
||||
#
|
||||
# map_belongs_to :customer
|
||||
#
|
||||
# Resolves a QBO reference object (e.g. `customer_ref.value`) and finds
|
||||
# the associated local ActiveRecord model.
|
||||
#
|
||||
# 6. Specialized helpers
|
||||
#
|
||||
# map_phone :phone_number, :primary_phone
|
||||
#
|
||||
# Extracts and normalizes phone numbers by stripping non-digit characters.
|
||||
#
|
||||
# Internally, the mappings are stored in `attribute_map` and executed by the
|
||||
# SyncService during `process_attributes`, which iterates through each mapping
|
||||
# and assigns the computed value to the local record.
|
||||
#
|
||||
# This design keeps synchronization services declarative, readable, and easy
|
||||
# to extend while centralizing transformation logic in a single DSL.
|
||||
class << self
|
||||
|
||||
def map_attributes(*attrs)
|
||||
attrs.each do |attr|
|
||||
map_attribute(attr)
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
def map_attribute(local_attr, remote_attr = nil, &block)
|
||||
attribute_map[local_attr] =
|
||||
if block_given?
|
||||
block
|
||||
elsif remote_attr
|
||||
->(remote) do
|
||||
remote_attr.to_s.split('.').reduce(remote) do |obj, method|
|
||||
obj&.public_send(method)
|
||||
end
|
||||
end
|
||||
else
|
||||
->(remote) { remote.public_send(local_attr) }
|
||||
end
|
||||
end
|
||||
|
||||
def attribute_map
|
||||
@attribute_map ||= {}
|
||||
end
|
||||
|
||||
def map_belongs_to(local_attr, ref: nil, model: nil)
|
||||
ref ||= "#{local_attr}_ref"
|
||||
model ||= local_attr.to_s.classify.constantize
|
||||
|
||||
attribute_map[local_attr] = lambda do |remote|
|
||||
ref_obj = remote.public_send(ref)
|
||||
id = ref_obj&.value
|
||||
id ? model.find_by(id: id) : nil
|
||||
end
|
||||
end
|
||||
|
||||
def map_phone(local_attr, remote_attr)
|
||||
attribute_map[local_attr] = lambda do |remote|
|
||||
phone = remote.public_send(remote_attr)
|
||||
phone&.free_form_number&.gsub(/\D/, '')
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# Log messages with the entity type for better traceability
|
||||
@@ -92,8 +203,8 @@ class SyncServiceBase
|
||||
# Create or update a local entity record based on the QBO remote data
|
||||
def persist(remote)
|
||||
local = @entity.find_or_initialize_by(id: remote.id)
|
||||
|
||||
if destroy_remote?(remote)
|
||||
|
||||
if destroy_local?(remote)
|
||||
if local.persisted?
|
||||
local.destroy
|
||||
log "Deleted #{@entity.name} #{remote.id}"
|
||||
@@ -102,10 +213,12 @@ class SyncServiceBase
|
||||
end
|
||||
|
||||
process_attributes(local, remote)
|
||||
|
||||
if local.changed?
|
||||
|
||||
if local.new_record? || local.changed?
|
||||
was_new = local.new_record?
|
||||
local.skip_qbo_push = true
|
||||
local.save!
|
||||
log "Updated #{@entity.name} #{remote.id}"
|
||||
log "#{was_new ? 'Created' : 'Updated'} #{@entity.name} #{remote.id}"
|
||||
attach_documents(local, remote)
|
||||
end
|
||||
|
||||
@@ -113,8 +226,16 @@ class SyncServiceBase
|
||||
log "Failed to sync #{@entity.name} #{remote.id}: #{e.message}"
|
||||
end
|
||||
|
||||
# This method should be implemented in subclasses to map remote attributes to local model
|
||||
# Maps remote attributes to local model
|
||||
def process_attributes(local, remote)
|
||||
raise NotImplementedError, "Subclasses must implement process_attributes"
|
||||
log "Processing #{@entity} ##{remote.id}"
|
||||
|
||||
self.class.attribute_map.each do |local_attr, mapper|
|
||||
value = mapper.call(remote)
|
||||
|
||||
if local.public_send(local_attr) != value
|
||||
local.public_send("#{local_attr}=", value)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -1,5 +1,6 @@
|
||||
<%= form_tag(customers_path, method: "get", id: "customer-search-form") do %>
|
||||
<%= text_field_tag :search, params[:search], placeholder: t(:label_search_customers), autocomplete: "off" %>
|
||||
<%= text_field_tag :search, params[:search], class: "customer-name", placeholder: t(:label_search_customers), autocomplete: "off", data: { autocomplete_url: "/customers/autocomplete" } %>
|
||||
<%= submit_tag t(:label_search) %>
|
||||
<% end %>
|
||||
<%= button_to t(:label_new_customer), new_customer_path, method: :get%>
|
||||
<%= button_to(t(:label_sync), qbo_sync_path, method: :get) if User.current.admin?%>
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
<h2><%=t(:field_customer)%> #<%= @customer.id %> - <%= link_to @customer.to_s, "https://#{Setting.plugin_redmine_qbo[:sandbox] ? "sandbox" : "app"}.qbo.intuit.com/app/customerdetail?nameId=#{@customer.id}", target: :_blank %> </h2>
|
||||
<h2><%=t(:field_customer)%> #<%= @customer.id %> - <%= link_to @customer.to_s, "https://#{RedmineQbo.sandbox_mode? ? "sandbox" : "app"}.qbo.intuit.com/app/customerdetail?nameId=#{@customer.id}", target: :_blank %> </h2>
|
||||
<div class="issue">
|
||||
|
||||
<div class="splitcontent">
|
||||
|
||||
@@ -1,111 +1,79 @@
|
||||
<!--
|
||||
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.
|
||||
-->
|
||||
|
||||
<!-- somewhere in your document include the Javascript -->
|
||||
<script type="text/javascript" src="https://appcenter.intuit.com/Content/IA/intuit.ipp.anywhere.js"></script>
|
||||
|
||||
<!-- configure the Intuit object: 'grantUrl' is a URL in your application which kicks off the flow, see below -->
|
||||
<script>
|
||||
intuit.ipp.anywhere.setup({menuProxy: '/path/to/blue-dot', grantUrl: '<%= qbo_authenticate_path %>'});
|
||||
</script>
|
||||
|
||||
<table >
|
||||
<tbody>
|
||||
<div class="box tabular">
|
||||
<p>
|
||||
<label><%= t(:label_client_id) %></label>
|
||||
<%= text_field_tag 'settings[oauth_consumer_key]', settings[:oauth_consumer_key], size: 50 %>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<label><%= t(:label_client_secret) %></label>
|
||||
<%= password_field_tag 'settings[oauth_consumer_secret]', settings[:oauth_consumer_secret], size: 50 %>
|
||||
</p>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_client_id)%></th>
|
||||
<td>
|
||||
<input
|
||||
type="text"
|
||||
style="width:350px"
|
||||
id="settingsOAuthConsumerKey"
|
||||
value="<%= settings['settingsOAuthConsumerKey'] %>"
|
||||
name="settings[settingsOAuthConsumerKey]" >
|
||||
</td>
|
||||
</tr>
|
||||
<p>
|
||||
<label><%= t(:label_webhook_token) %></label>
|
||||
<%= text_field_tag 'settings[webhook_token]', settings[:webhook_token], size: 50 %>
|
||||
</p>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_client_secret)%></th>
|
||||
<td>
|
||||
<input
|
||||
type="text"
|
||||
style="width:350px"
|
||||
id="settingsOAuthConsumerSecret"
|
||||
value="<%= settings['settingsOAuthConsumerSecret'] %>"
|
||||
name="settings[settingsOAuthConsumerSecret]" >
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_webhook_token)%></th>
|
||||
<td>
|
||||
<input
|
||||
type="text"
|
||||
style="width:350px"
|
||||
id="settingsWebhookToken"
|
||||
value="<%= settings['settingsWebhookToken'] %>"
|
||||
name="settings[settingsWebhookToken]" >
|
||||
</td>
|
||||
</tr>
|
||||
<p>
|
||||
<label><%= t(:label_sandbox) %></label>
|
||||
<%= check_box_tag 'settings[sandbox]', 1, settings[:sandbox] %>
|
||||
</p>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_sandbox)%></th>
|
||||
<td>
|
||||
<%= check_box_tag 'settings[sandbox]', @settings[:sandbox], @settings[:sandbox] %>
|
||||
</td>
|
||||
</tr>
|
||||
<hr />
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_oauth_expires)%></th>
|
||||
<td><%= QboConnectionService.current!&.oauth2_access_token_expires_at %>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_oauth2_refresh_token_expires_at)%></th>
|
||||
<td><%= QboConnectionService.current!&.oauth2_refresh_token_expires_at %>
|
||||
</tr>
|
||||
<p>
|
||||
<label><%= t(:label_oauth_expires) %></label>
|
||||
<span class="icon <%= Qbo.oauth2_access_token_expires_at&.future? ? 'icon-ok' : 'icon-warning' %>">
|
||||
<%= Qbo.oauth2_access_token_expires_at || 'N/A' %>
|
||||
</span>
|
||||
</p>
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
<p>
|
||||
<label><%= t(:label_customer_count) %></label>
|
||||
<%= Customer.count %>
|
||||
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Customer.last_sync %>)</em>
|
||||
</p>
|
||||
|
||||
<br/>
|
||||
<%=t(:label_oauth_note)%>
|
||||
<br/>
|
||||
<br/>
|
||||
<p>
|
||||
<label><%= t(:label_employee_count) %></label>
|
||||
<%= Employee.count %>
|
||||
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Employee.last_sync %>)</em>
|
||||
</p>
|
||||
|
||||
<!-- this will display a button that the user clicks to start the flow -->
|
||||
<ipp:connectToIntuit></ipp:connectToIntuit>
|
||||
<p>
|
||||
<label><%= t(:label_invoice_count) %></label>
|
||||
<%= Invoice.count %>
|
||||
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Item.last_sync %>)</em>
|
||||
</p>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
<p>
|
||||
<label><%= t(:label_estimate_count) %></label>
|
||||
<%= Estimate.count %>
|
||||
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Account.last_sync %>)</em>
|
||||
</p>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_customer_count)%>:</b> <%= Customer.count%> @ <%= Customer.last_sync %>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_employee_count)%>:</b> <%= Employee.count %> @ <%= Employee.last_sync %>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_invoice_count)%>:</b> <%= Invoice.count %> @ <%= Invoice.last_sync%>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_estimate_count)%>:</b> <%= Estimate.count %> @ <%= Estimate.last_sync %>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_last_sync)%> </b> <%= Qbo.last_sync if Qbo.exists? %> <%= link_to t(:label_sync_now), qbo_sync_path %>
|
||||
<p>
|
||||
<label><%= t(:label_last_sync) %> (QBO)</label>
|
||||
<%= Qbo.exists? ? Qbo.last_sync : 'Never synced' %>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<fieldset class="box">
|
||||
<legend>Management & Synchronization</legend>
|
||||
|
||||
<div style="margin-bottom: 20px;">
|
||||
<ipp:connectToIntuit></ipp:connectToIntuit>
|
||||
</div>
|
||||
|
||||
<div style="margin-bottom: 15px;">
|
||||
<%= link_to t(:label_sync_now_customers), sync_customers_path, class: 'button icon icon-reload' %>
|
||||
<%= link_to t(:label_sync_now_employees), employees_sync_path, class: 'button icon icon-reload' %>
|
||||
<%= link_to t(:label_sync_now_invoices), invoices_sync_path, class: 'button icon icon-reload' %>
|
||||
<%= link_to t(:label_sync_now_estimate), estimates_sync_path, class: 'button icon icon-reload' %>
|
||||
</div>
|
||||
</fieldset>
|
||||
@@ -1 +0,0 @@
|
||||
!function(t){t.fn.railsAutocomplete=function(e){var a=function(){this.railsAutoCompleter||(this.railsAutoCompleter=new t.railsAutocomplete(this))};if(void 0!==t.fn.on){if(!e)return;return t(document).on("focus",e,a)}return this.live("focus",a)},t.railsAutocomplete=function(t){var e=t;this.init(e)},t.railsAutocomplete.options={showNoMatches:!0,noMatchesLabel:"no existing match"},t.railsAutocomplete.fn=t.railsAutocomplete.prototype={railsAutocomplete:"0.0.1"},t.railsAutocomplete.fn.extend=t.railsAutocomplete.extend=t.extend,t.railsAutocomplete.fn.extend({init:function(e){function a(t){return t.split(e.delimiter)}function i(t){return a(t).pop().replace(/^\s+/,"")}e.delimiter=t(e).attr("data-delimiter")||null,e.min_length=t(e).attr("data-min-length")||t(e).attr("min-length")||2,e.append_to=t(e).attr("data-append-to")||null,e.autoFocus=t(e).attr("data-auto-focus")||!1,t(e).autocomplete({appendTo:e.append_to,autoFocus:e.autoFocus,delay:t(e).attr("delay")||0,source:function(a,r){var n=this.element[0],o={term:i(a.term)};t(e).attr("data-autocomplete-fields")&&t.each(t.parseJSON(t(e).attr("data-autocomplete-fields")),function(e,a){o[e]=t(a).val()}),t.getJSON(t(e).attr("data-autocomplete"),o,function(){var a={};t.extend(a,t.railsAutocomplete.options),t.each(a,function(i,r){if(a.hasOwnProperty(i)){var n=t(e).attr("data-"+i);a[i]=n?n:r}}),0==arguments[0].length&&t.inArray(a.showNoMatches,[!0,"true"])>=0&&(arguments[0]=[],arguments[0][0]={id:"",label:a.noMatchesLabel}),t(arguments[0]).each(function(a,i){var r={};r[i.id]=i,t(e).data(r)}),r.apply(null,arguments),t(n).trigger("railsAutocomplete.source",arguments)})},change:function(e,a){if(t(this).is("[data-id-element]")&&""!==t(t(this).attr("data-id-element")).val()&&(t(t(this).attr("data-id-element")).val(a.item?a.item.id:"").trigger("change"),t(this).attr("data-update-elements"))){var i=t.parseJSON(t(this).attr("data-update-elements")),r=a.item?t(this).data(a.item.id.toString()):{};if(i&&""===t(i.id).val())return;for(var n in i){var o=t(i[n]);o.is(":checkbox")?null!=r[n]&&o.prop("checked",r[n]):o.val(a.item?r[n]:"").trigger("change")}}},search:function(){var t=i(this.value);return t.length<e.min_length?!1:void 0},focus:function(){return!1},select:function(i,r){if(r.item.value=r.item.value.toString(),-1!=r.item.value.toLowerCase().indexOf("no match")||-1!=r.item.value.toLowerCase().indexOf("too many results"))return t(this).trigger("railsAutocomplete.noMatch",r),!1;var n=a(this.value);if(n.pop(),n.push(r.item.value),null!=e.delimiter)n.push(""),this.value=n.join(e.delimiter);else if(this.value=n.join(""),t(this).attr("data-id-element")&&t(t(this).attr("data-id-element")).val(r.item.id).trigger("change"),t(this).attr("data-update-elements")){var o=r.item,l=-1!=r.item.value.indexOf("Create New")?!0:!1,u=t.parseJSON(t(this).attr("data-update-elements"));for(var s in u)"checkbox"===t(u[s]).attr("type")?o[s]===!0||1===o[s]?t(u[s]).attr("checked","checked"):t(u[s]).removeAttr("checked"):l&&o[s]&&-1==o[s].indexOf("Create New")||!l?t(u[s]).val(o[s]).trigger("change"):t(u[s]).val("").trigger("change")}var c=this.value;return t(this).bind("keyup.clearId",function(){t.trim(t(this).val())!=t.trim(c)&&(t(t(this).attr("data-id-element")).val("").trigger("change"),t(this).unbind("keyup.clearId"))}),t(e).trigger("railsAutocomplete.select",r),!1}}),t(e).trigger("railsAutocomplete.init")}}),t(document).ready(function(){t("input[data-autocomplete]").railsAutocomplete("input[data-autocomplete]")})}(jQuery);
|
||||
102
assets/javascripts/autocomplete.js
Normal file
102
assets/javascripts/autocomplete.js
Normal file
@@ -0,0 +1,102 @@
|
||||
(function () {
|
||||
|
||||
// Helper: escape HTML for safety
|
||||
function escapeHtml(str) {
|
||||
return $("<div>").text(str).html();
|
||||
}
|
||||
|
||||
// Helper: highlight all occurrences of term (case-insensitive)
|
||||
function highlightTerm(text, term) {
|
||||
if (!term) return text;
|
||||
const escapedTerm = term.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
||||
const regex = new RegExp("(" + escapedTerm + ")", "ig");
|
||||
return text.replace(regex, "<strong>$1</strong>");
|
||||
}
|
||||
|
||||
window.initCustomerAutocomplete = function(context) {
|
||||
let scope = context || document;
|
||||
|
||||
$(scope).find(".customer-name").each(function() {
|
||||
if ($(this).data("autocomplete-initialized")) return;
|
||||
$(this).data("autocomplete-initialized", true);
|
||||
|
||||
let $input = $(this);
|
||||
|
||||
let ac = $input.autocomplete({
|
||||
appendTo: "body", // crucial for Redmine positioning
|
||||
minLength: 2,
|
||||
|
||||
source: function(request, response) {
|
||||
$.getJSON("/customers/autocomplete", { q: request.term })
|
||||
.done(function(data) {
|
||||
response(data.map(function(item) {
|
||||
// combine secondary info
|
||||
let secondary = [];
|
||||
if (item.phone_number) secondary.push(item.phone_number);
|
||||
if (item.mobile_phone_number) secondary.push(item.mobile_phone_number);
|
||||
|
||||
let meta = secondary.length ? " (" + secondary.join(" • ") + ")" : "";
|
||||
|
||||
// escape HTML to avoid XSS
|
||||
let safeText = escapeHtml(item.name + meta);
|
||||
|
||||
return {
|
||||
label: item.name + meta, // plain fallback
|
||||
value: item.name, // goes into input
|
||||
id: item.id,
|
||||
html: highlightTerm(safeText, request.term)
|
||||
};
|
||||
}));
|
||||
})
|
||||
.fail(function() {
|
||||
response([]);
|
||||
});
|
||||
},
|
||||
|
||||
select: function(event, ui) {
|
||||
$input.val(ui.item.value); // visible text
|
||||
$("#customer_id").val(ui.item.id); // hidden ID
|
||||
|
||||
// trigger Redmine form update safely
|
||||
setTimeout(function() {
|
||||
$("#customer_id").trigger("change");
|
||||
}, 0);
|
||||
|
||||
return false;
|
||||
},
|
||||
|
||||
change: function(event, ui) {
|
||||
// clear hidden field if no valid selection
|
||||
if (!ui.item && !$input.val()) {
|
||||
$("#customer_id").val("");
|
||||
}
|
||||
}
|
||||
});
|
||||
|
||||
// Render item HTML for highlight
|
||||
ac.autocomplete("instance")._renderItem = function(ul, item) {
|
||||
return $("<li>")
|
||||
.append($("<div>").html(item.html))
|
||||
.appendTo(ul);
|
||||
};
|
||||
});
|
||||
};
|
||||
|
||||
// Re-init after Redmine AJAX form updates
|
||||
$(document).on("ajaxComplete", function() {
|
||||
if (window.initCustomerAutocomplete) {
|
||||
window.initCustomerAutocomplete(document);
|
||||
}
|
||||
});
|
||||
|
||||
// Init on page load
|
||||
$(document).ready(function() {
|
||||
window.initCustomerAutocomplete(document);
|
||||
});
|
||||
|
||||
// Also init on Turbo/Redmine load events
|
||||
document.addEventListener("turbo:load", function() {
|
||||
window.initCustomerAutocomplete(document);
|
||||
});
|
||||
|
||||
})();
|
||||
5
assets/stylesheets/autocomplete.css
Normal file
5
assets/stylesheets/autocomplete.css
Normal file
@@ -0,0 +1,5 @@
|
||||
/* Keep Redmine default look, just enhance metadata */
|
||||
.ui-autocomplete .autocomplete-meta {
|
||||
color: #888;
|
||||
font-size: 0.9em;
|
||||
}
|
||||
@@ -82,6 +82,10 @@ en:
|
||||
label_shipping_address: "Shipping Address"
|
||||
label_sync: "Sync"
|
||||
label_sync_now: "Sync Now"
|
||||
label_sync_now_customers: "Sync Customers"
|
||||
label_sync_now_employees: "Sync Employees"
|
||||
label_sync_now_invoices: "Sync Invoices"
|
||||
label_sync_now_estimate: "Sync Estimates"
|
||||
label_syncing: "Syncing QuickBooks"
|
||||
label_trim: "Trim"
|
||||
label_webhook_token: "Intuit QBO Webhook Token"
|
||||
|
||||
@@ -14,14 +14,17 @@ get 'qbo/oauth_callback', to: 'qbo#oauth_callback'
|
||||
|
||||
#manual sync
|
||||
get 'qbo/sync', to: 'qbo#sync'
|
||||
get 'invoices/sync', to: 'invoices#sync'
|
||||
get 'estimates/sync', to: 'estimates#sync'
|
||||
get 'employees/sync', to: 'employees#sync'
|
||||
|
||||
#webhook
|
||||
post 'qbo/webhook', to: 'qbo#webhook'
|
||||
|
||||
# Estimate & Invoice PDF
|
||||
get 'estimates/:id', to: 'estimate#show', as: :estimate
|
||||
get 'estimates/doc/', to: 'estimate#doc', as: :estimate_doc
|
||||
get 'invoices/:id', to: 'invoice#show', as: :invoice
|
||||
get 'estimates/:id', to: 'estimates#show', as: :estimate
|
||||
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
|
||||
@@ -35,5 +38,8 @@ get 'filter_estimates_by_customer' => 'customers#filter_estimates_by_customer'
|
||||
get 'filter_invoices_by_customer' => 'customers#filter_invoices_by_customer'
|
||||
|
||||
resources :customers do
|
||||
get :autocomplete_customer_name, on: :collection
|
||||
end
|
||||
collection do
|
||||
get :autocomplete
|
||||
get :sync
|
||||
end
|
||||
end
|
||||
10
init.rb
10
init.rb
@@ -14,7 +14,7 @@ Redmine::Plugin.register :redmine_qbo do
|
||||
name 'Redmine QBO plugin'
|
||||
author 'Rick Barrette'
|
||||
description 'A pluging for Redmine to connect with QuickBooks Online to create Time Activity Entries for billable hours logged when an Issue is closed'
|
||||
version '2026.3.4'
|
||||
version '2026.3.14'
|
||||
url 'https://github.com/rickbarrette/redmine_qbo'
|
||||
author_url 'https://barrettefabrication.com'
|
||||
settings default: {empty: true}, partial: 'qbo/settings'
|
||||
@@ -43,10 +43,4 @@ Redmine::Plugin.register :redmine_qbo do
|
||||
|
||||
end
|
||||
|
||||
# Dynamically load all Hooks & Patches recursively
|
||||
base_dir = File.join(File.dirname(__FILE__), 'lib')
|
||||
|
||||
# '**' looks inside subdirectories, '*.rb' matches Ruby files
|
||||
Dir.glob(File.join(base_dir, '**', '*.rb')).sort.each do |file|
|
||||
require file
|
||||
end
|
||||
RedmineQbo.setup
|
||||
@@ -1,6 +1,6 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 2026 rick barrette
|
||||
#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:
|
||||
#
|
||||
@@ -8,29 +8,48 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class CustomerSyncJob < ApplicationJob
|
||||
queue_as :default
|
||||
retry_on StandardError, wait: 5.minutes, attempts: 5
|
||||
module RedmineQbo
|
||||
def self.setup
|
||||
# === Models ===
|
||||
Issue.prepend RedmineQbo::Patches::IssuePatch
|
||||
User.prepend RedmineQbo::Patches::UserPatch
|
||||
|
||||
# Perform a full sync of all customers, or an incremental sync of only those updated since the last sync
|
||||
def perform(full_sync: false, id: nil)
|
||||
qbo = QboConnectionService.current!
|
||||
raise "No QBO configuration found" unless qbo
|
||||
# === Queries ===
|
||||
IssueQuery.prepend RedmineQbo::Patches::QueryPatch
|
||||
TimeEntryQuery.prepend RedmineQbo::Patches::TimeEntryQueryPatch
|
||||
|
||||
log "Starting #{full_sync ? 'full' : 'incremental'} sync for customer ##{id || 'all'}..."
|
||||
# === Controllers ===
|
||||
RedmineQbo::Patches::IssuesControllerPatch.apply
|
||||
RedmineQbo::Patches::AttachmentsControllerPatch.apply
|
||||
|
||||
service = CustomerSyncService.new(qbo: qbo)
|
||||
# === Helpers / Exports ===
|
||||
Redmine::Export::PDF::IssuesPdfHelper.prepend RedmineQbo::Patches::PdfPatch
|
||||
|
||||
if id.present?
|
||||
service.sync_by_id(id)
|
||||
else
|
||||
service.sync(full_sync: full_sync)
|
||||
end
|
||||
# === Hooks ===
|
||||
RedmineQbo::Hooks::IssuesHookListener
|
||||
RedmineQbo::Hooks::UsersShowHookListener
|
||||
RedmineQbo::Hooks::ViewHookListener
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[CustomerSyncJob] #{msg}"
|
||||
def self.settings
|
||||
Setting.plugin_redmine_qbo
|
||||
end
|
||||
|
||||
def self.oauth_consumer_key
|
||||
settings[:oauth_consumer_key]
|
||||
end
|
||||
|
||||
def self.oauth_consumer_secret
|
||||
settings[:oauth_consumer_secret]
|
||||
end
|
||||
|
||||
def self.sandbox_mode?
|
||||
settings[:sandbox] ? true : false
|
||||
end
|
||||
|
||||
def self.webhook_token_secret
|
||||
settings[:webhook_token]
|
||||
end
|
||||
|
||||
|
||||
end
|
||||
@@ -23,13 +23,12 @@ module RedmineQbo
|
||||
project = context[:project]
|
||||
|
||||
# Customer Name Text Box with database backed autocomplete
|
||||
# onchange event will update the hidden customer_id field
|
||||
search_customer = f.autocomplete_field :customer,
|
||||
autocomplete_customer_name_customers_path,
|
||||
selected: issue.customer,
|
||||
update_elements: {
|
||||
id: '#issue_customer_id',
|
||||
value: '#issue_customer'
|
||||
# onchange event will update the hidden customer_id field
|
||||
search_customer = f.text_field :customer,
|
||||
class: "customer-name",
|
||||
autocomplete: "off",
|
||||
data: {
|
||||
autocomplete_url: "/customers/autocomplete"
|
||||
}
|
||||
|
||||
# We need to handle 3 cases for the onchange event of the customer name field:
|
||||
@@ -47,7 +46,7 @@ module RedmineQbo
|
||||
# This hidden field is used for the customer ID for the issue
|
||||
# the onchange event will reload the issue form via ajax to update the available estimates
|
||||
customer_id = f.hidden_field :customer_id,
|
||||
id: "issue_customer_id",
|
||||
id: "customer_id",
|
||||
onchange: js_path.html_safe
|
||||
|
||||
# Generate the drop down list of quickbooks estimates owned by the selected customer
|
||||
|
||||
@@ -17,8 +17,9 @@ module RedmineQbo
|
||||
def view_layouts_base_html_head(context = {})
|
||||
safe_join([
|
||||
javascript_include_tag( 'application.js', plugin: :redmine_qbo),
|
||||
javascript_include_tag( 'autocomplete-rails.js', plugin: :redmine_qbo),
|
||||
javascript_include_tag( 'checkbox_controller.js', plugin: :redmine_qbo)
|
||||
javascript_include_tag( 'autocomplete.js', plugin: :redmine_qbo),
|
||||
javascript_include_tag( 'checkbox_controller.js', plugin: :redmine_qbo),
|
||||
stylesheet_link_tag( 'autocomplete', plugin: :redmine_qbo)
|
||||
])
|
||||
end
|
||||
|
||||
|
||||
@@ -8,41 +8,32 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
require_dependency 'attachments_controller'
|
||||
|
||||
module RedmineQbo
|
||||
module Patches
|
||||
|
||||
module AttachmentsControllerPatch
|
||||
module Helper
|
||||
# Check if login is globally required to access the application
|
||||
def check_if_login_required
|
||||
# Return true if the user is already logged in
|
||||
return true if User.current.logged?
|
||||
|
||||
def self.included(base)
|
||||
# Pull up the attachment and verify if we have a valid token for the issue
|
||||
attachment = Attachment.find_by(id: params[:id])
|
||||
return require_login if attachment.nil?
|
||||
|
||||
base.class_eval do
|
||||
token = CustomerToken.where("token = ? AND expires_at > ?", session[:token], Time.current).first
|
||||
return true if token&.issue_id == attachment.container_id
|
||||
|
||||
# check if login is globally required to access the application
|
||||
def check_if_login_required
|
||||
# no check needed if user is already logged in
|
||||
return true if User.current.logged?
|
||||
|
||||
# Pull up the attachmet, & verify if we have a valid token for the Issue
|
||||
attachment = Attachment.find(params[:id])
|
||||
token = CustomerToken.where("token = ? and expires_at > ?", session[:token], Time.now)
|
||||
token = token.first
|
||||
unless token.nil?
|
||||
return true if token.issue_id == attachment.container_id
|
||||
end
|
||||
|
||||
require_login if Setting.login_required?
|
||||
end
|
||||
|
||||
# Default to requiring login if all else fails
|
||||
require_login if Setting.login_required?
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
# Add module to AttachmentsController
|
||||
AttachmentsController.send(:include, AttachmentsControllerPatch)
|
||||
|
||||
def self.apply
|
||||
AttachmentsController.class_eval do
|
||||
helper Helper
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -8,60 +8,39 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
require_dependency 'issue'
|
||||
|
||||
module RedmineQbo
|
||||
module Patches
|
||||
module IssuePatch
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
def self.included(base)
|
||||
base.extend(ClassMethods)
|
||||
base.send(:include, InstanceMethods)
|
||||
prepended do
|
||||
belongs_to :customer, class_name: 'Customer', foreign_key: :customer_id, optional: true
|
||||
belongs_to :customer_token, primary_key: :id, optional: true
|
||||
belongs_to :estimate, primary_key: :id, optional: true
|
||||
has_and_belongs_to_many :invoices
|
||||
|
||||
base.class_eval do
|
||||
belongs_to :customer, class_name: 'Customer', foreign_key: :customer_id, optional: true
|
||||
belongs_to :customer_token, primary_key: :id
|
||||
belongs_to :estimate, primary_key: :id
|
||||
has_and_belongs_to_many :invoices
|
||||
|
||||
before_save :titlize_subject
|
||||
after_commit :enqueue_billing, on: :update
|
||||
end
|
||||
|
||||
before_save :titlize_subject
|
||||
after_commit :enqueue_billing, on: :update
|
||||
end
|
||||
|
||||
module ClassMethods
|
||||
# Enqueue a background job to bill the time spent on this issue to QuickBooks if the issue is closed and assigned to an employee
|
||||
def enqueue_billing
|
||||
log "Checking if issue needs billing for ##{id}"
|
||||
return unless closed? && customer.present? && assigned_to&.employee_id.present?
|
||||
|
||||
log "Enqueuing billing for issue ##{id}"
|
||||
BillIssueTimeJob.perform_later(id)
|
||||
end
|
||||
|
||||
module InstanceMethods
|
||||
|
||||
# Enqueue a background job to bill the time spent on this issue to the associated customer in Quickbooks, if the issue is closed and has a customer assigned.
|
||||
def enqueue_billing
|
||||
log "Checking if issue needs to be billed for issue ##{id}"
|
||||
return unless closed?
|
||||
return unless customer.present?
|
||||
return unless assigned_to&.employee_id.present?
|
||||
|
||||
log "Enqueuing billing for issue ##{id}"
|
||||
BillIssueTimeJob.perform_later(id)
|
||||
end
|
||||
|
||||
# Titlize the subject of the issue before saving to ensure consistent formatting for billing descriptions in Quickbooks
|
||||
def titlize_subject
|
||||
log "Titlizing subject for issue ##{id}"
|
||||
|
||||
self.subject = subject.split(/\s+/).map do |word|
|
||||
if word =~ /[A-Z]/ && word =~ /[0-9]/
|
||||
word
|
||||
else
|
||||
word.capitalize
|
||||
end
|
||||
end.join(' ')
|
||||
end
|
||||
# Titlize the subject for consistent formatting in billing descriptions
|
||||
def titlize_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(' ')
|
||||
end
|
||||
|
||||
# This method is used to generate a shareable token for the customer associated with this issue, which can be used to link the issue to the corresponding customer in Quickbooks for billing and tracking purposes.
|
||||
# Generate a shareable token linking this issue to the customer for QuickBooks
|
||||
def share_token
|
||||
CustomerToken.get_token(self)
|
||||
end
|
||||
@@ -69,10 +48,8 @@ module RedmineQbo
|
||||
private
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[IssuePatch] #{msg}"
|
||||
Rails.logger.info "[IssuePatch] #{msg}"
|
||||
end
|
||||
end
|
||||
|
||||
Issue.send(:include, IssuePatch)
|
||||
end
|
||||
end
|
||||
@@ -7,30 +7,31 @@
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
require_dependency 'issues_controller'
|
||||
|
||||
module RedmineQbo
|
||||
module Patches
|
||||
module IssuesControllerPatch
|
||||
|
||||
module Helper
|
||||
# Extend the watcher links to include billing and share options
|
||||
def watcher_link(issue, user)
|
||||
link = ''
|
||||
link = link_to(I18n.t(:label_bill_time), bill_path( issue.id ), method: :get, class: 'icon icon-email-add') if user.admin?
|
||||
link << link_to(I18n.t(:label_share), share_path( issue.id ), method: :get, target: :_blank, class: 'icon icon-shared') if user.logged?
|
||||
link.html_safe + super
|
||||
links = ''
|
||||
|
||||
# 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?
|
||||
|
||||
# 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?
|
||||
|
||||
# Append to the original watcher links
|
||||
(links.html_safe + super).html_safe
|
||||
end
|
||||
end
|
||||
|
||||
def self.included(base)
|
||||
base.class_eval do
|
||||
def self.apply
|
||||
IssuesController.class_eval do
|
||||
helper Helper
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# Add module to IssuessController
|
||||
IssuesController.send(:include, IssuesControllerPatch)
|
||||
|
||||
end
|
||||
end
|
||||
@@ -8,278 +8,307 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
require_dependency 'redmine/export/pdf'
|
||||
require_dependency 'redmine/export/pdf/issues_pdf_helper'
|
||||
|
||||
module RedmineQbo
|
||||
module Patches
|
||||
module PdfPatch
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
def self.included(base)
|
||||
base.send(:include, InstanceMethods)
|
||||
base.class_eval do
|
||||
alias_method :issue_to_pdf, :issue_to_pdf_with_patch
|
||||
alias_method :issue_to_pdf_with_patch, :issue_to_pdf
|
||||
end
|
||||
end
|
||||
def issue_to_pdf(issue, assoc={})
|
||||
pdf = setup_pdf(issue)
|
||||
|
||||
module InstanceMethods
|
||||
render_header(pdf, issue)
|
||||
render_ancestors_and_subject(pdf, issue)
|
||||
|
||||
left, right = build_issue_attributes(issue)
|
||||
render_attributes_grid(pdf, left, right)
|
||||
|
||||
def issue_to_pdf_with_patch(issue, assoc={})
|
||||
pdf = ::Redmine::Export::PDF::ITCPDF.new(current_language)
|
||||
pdf.set_title("#{issue.project} - #{issue.tracker} ##{issue.id}")
|
||||
pdf.alias_nb_pages
|
||||
pdf.footer_date = format_date(Date.today)
|
||||
pdf.add_page
|
||||
pdf.SetFontStyle('B',11)
|
||||
buf = "#{issue.project} - #{issue.tracker} ##{issue.id}"
|
||||
pdf.RDMMultiCell(190, 5, buf)
|
||||
pdf.SetFontStyle('',8)
|
||||
base_x = pdf.get_x
|
||||
i = 1
|
||||
issue.ancestors.visible.each do |ancestor|
|
||||
pdf.set_x(base_x + i)
|
||||
buf = "#{ancestor.tracker} # #{ancestor.id} (#{ancestor.status.to_s}): #{ancestor.subject}"
|
||||
pdf.RDMMultiCell(190 - i, 5, buf)
|
||||
i += 1 if i < 35
|
||||
end
|
||||
pdf.SetFontStyle('B',11)
|
||||
pdf.RDMMultiCell(190 - i, 5, issue.subject.to_s)
|
||||
pdf.SetFontStyle('',8)
|
||||
pdf.RDMMultiCell(190, 5, "#{format_time(issue.created_on)} - #{issue.author}")
|
||||
pdf.ln
|
||||
|
||||
customer = issue.customer.name if issue.customer
|
||||
left = []
|
||||
left << [l(:field_status), issue.status]
|
||||
left << [l(:field_priority), issue.priority]
|
||||
left << [l(:field_customer), customer]
|
||||
left << [l(:field_assigned_to), issue.assigned_to] unless issue.disabled_core_fields.include?(:assigned_to_id)
|
||||
#left << [l(:field_category), issue.category] unless issue.disabled_core_fields.include?(:category_id)
|
||||
#left << [l(:field_fixed_version), issue.fixed_version] unless issue.disabled_core_fields.include?(:fixed_version_id)
|
||||
|
||||
log "Calling :pdf_left hook"
|
||||
left_hook_output = Redmine::Hook.call_hook :pdf_left, { issue: issue }
|
||||
unless left_hook_output.nil?
|
||||
left_hook_output.each do |l|
|
||||
left.concat l unless l.nil?
|
||||
end
|
||||
end
|
||||
|
||||
right = []
|
||||
right << [l(:field_start_date), format_date(issue.start_date)] unless issue.disabled_core_fields.include?(:start_date)
|
||||
right << [l(:field_due_date), format_date(issue.due_date)] unless issue.disabled_core_fields.include?(:due_date)
|
||||
right << [l(:field_done_ratio), "#{issue.done_ratio}%"] unless issue.disabled_core_fields.include?(:done_ratio)
|
||||
right << [l(:field_estimated_hours), l_hours(issue.estimated_hours)] unless issue.disabled_core_fields.include?(:estimated_hours)
|
||||
right << [l(:label_spent_time), l_hours(issue.total_spent_hours)] if User.current.allowed_to?(:view_time_entries, issue.project)
|
||||
|
||||
log "Calling :pdf_right hook"
|
||||
right_hook_output = Redmine::Hook.call_hook :pdf_right, { issue: issue }
|
||||
unless right_hook_output.nil?
|
||||
right_hook_output.each do |r|
|
||||
right.concat r unless r.nil?
|
||||
end
|
||||
end
|
||||
|
||||
rows = left.size > right.size ? left.size : right.size
|
||||
while left.size < rows
|
||||
left << nil
|
||||
end
|
||||
while right.size < rows
|
||||
right << nil
|
||||
end
|
||||
|
||||
half = (issue.visible_custom_field_values.size / 2.0).ceil
|
||||
issue.visible_custom_field_values.each_with_index do |custom_value, i|
|
||||
(i < half ? left : right) << [custom_value.custom_field.name, show_value(custom_value, false)]
|
||||
end
|
||||
|
||||
if pdf.get_rtl
|
||||
border_first_top = 'RT'
|
||||
border_last_top = 'LT'
|
||||
border_first = 'R'
|
||||
border_last = 'L'
|
||||
else
|
||||
border_first_top = 'LT'
|
||||
border_last_top = 'RT'
|
||||
border_first = 'L'
|
||||
border_last = 'R'
|
||||
end
|
||||
|
||||
rows = left.size > right.size ? left.size : right.size
|
||||
rows.times do |i|
|
||||
heights = []
|
||||
pdf.SetFontStyle('B',9)
|
||||
item = left[i]
|
||||
heights << pdf.get_string_height(35, item ? "#{item.first}:" : "")
|
||||
item = right[i]
|
||||
heights << pdf.get_string_height(35, item ? "#{item.first}:" : "")
|
||||
pdf.SetFontStyle('',9)
|
||||
item = left[i]
|
||||
heights << pdf.get_string_height(60, item ? item.last.to_s : "")
|
||||
item = right[i]
|
||||
heights << pdf.get_string_height(60, item ? item.last.to_s : "")
|
||||
height = heights.max
|
||||
|
||||
item = left[i]
|
||||
pdf.SetFontStyle('B',9)
|
||||
pdf.RDMMultiCell(35, height, item ? "#{item.first}:" : "", (i == 0 ? border_first_top : border_first), '', 0, 0)
|
||||
pdf.SetFontStyle('',9)
|
||||
pdf.RDMMultiCell(60, height, item ? item.last.to_s : "", (i == 0 ? border_last_top : border_last), '', 0, 0)
|
||||
|
||||
item = right[i]
|
||||
pdf.SetFontStyle('B',9)
|
||||
pdf.RDMMultiCell(35, height, item ? "#{item.first}:" : "", (i == 0 ? border_first_top : border_first), '', 0, 0)
|
||||
pdf.SetFontStyle('',9)
|
||||
pdf.RDMMultiCell(60, height, item ? item.last.to_s : "", (i == 0 ? border_last_top : border_last), '', 0, 2)
|
||||
|
||||
pdf.set_x(base_x)
|
||||
end
|
||||
|
||||
pdf.SetFontStyle('B',9)
|
||||
pdf.RDMCell(35+155, 5, l(:field_description), "LRT", 1)
|
||||
pdf.SetFontStyle('',9)
|
||||
|
||||
# Set resize image scale
|
||||
pdf.set_image_scale(1.6)
|
||||
text = textilizable(issue, :description,
|
||||
only_path: false,
|
||||
edit_section_links: false,
|
||||
headings: false,
|
||||
inline_attachments: false
|
||||
)
|
||||
pdf.RDMwriteFormattedCell(35+155, 5, '', '', text, issue.attachments, "LRB")
|
||||
|
||||
unless issue.leaf?
|
||||
truncate_length = (!is_cjk? ? 90 : 65)
|
||||
pdf.SetFontStyle('B',9)
|
||||
pdf.RDMCell(35+155,5, l(:label_subtask_plural) + ":", "LTR")
|
||||
pdf.ln
|
||||
issue_list(issue.descendants.visible.sort_by(&:lft)) do |child, level|
|
||||
buf = "#{child.tracker} # #{child.id}: #{child.subject}".
|
||||
truncate(truncate_length)
|
||||
level = 10 if level >= 10
|
||||
pdf.SetFontStyle('',8)
|
||||
pdf.RDMCell(35+135,5, (level >=1 ? " " * level : "") + buf, border_first)
|
||||
pdf.SetFontStyle('B',8)
|
||||
pdf.RDMCell(20,5, child.status.to_s, border_last)
|
||||
pdf.ln
|
||||
end
|
||||
end
|
||||
|
||||
relations = issue.relations.select { |r| r.other_issue(issue).visible? }
|
||||
unless relations.empty?
|
||||
truncate_length = (!is_cjk? ? 80 : 60)
|
||||
pdf.SetFontStyle('B',9)
|
||||
pdf.RDMCell(35+155,5, l(:label_related_issues) + ":", "LTR")
|
||||
pdf.ln
|
||||
relations.each do |relation|
|
||||
buf = relation.to_s(issue) {|other|
|
||||
text = ""
|
||||
if Setting.cross_project_issue_relations?
|
||||
text += "#{relation.other_issue(issue).project} - "
|
||||
end
|
||||
text += "#{other.tracker} ##{other.id}: #{other.subject}"
|
||||
text
|
||||
}
|
||||
buf = buf.truncate(truncate_length)
|
||||
pdf.SetFontStyle('', 8)
|
||||
pdf.RDMCell(35+155-60, 5, buf, border_first)
|
||||
pdf.SetFontStyle('B',8)
|
||||
pdf.RDMCell(20,5, relation.other_issue(issue).status.to_s, "")
|
||||
pdf.RDMCell(20,5, format_date(relation.other_issue(issue).start_date), "")
|
||||
pdf.RDMCell(20,5, format_date(relation.other_issue(issue).due_date), border_last)
|
||||
pdf.ln
|
||||
end
|
||||
end
|
||||
pdf.RDMCell(190,5, "", "T")
|
||||
pdf.ln
|
||||
|
||||
if issue.changesets.any? &&
|
||||
User.current.allowed_to?(:view_changesets, issue.project)
|
||||
pdf.SetFontStyle('B',9)
|
||||
pdf.RDMCell(190,5, l(:label_associated_revisions), "B")
|
||||
pdf.ln
|
||||
for changeset in issue.changesets
|
||||
pdf.SetFontStyle('B',8)
|
||||
csstr = "#{l(:label_revision)} #{changeset.format_identifier} - "
|
||||
csstr += format_time(changeset.committed_on) + " - " + changeset.author.to_s
|
||||
pdf.RDMCell(190, 5, csstr)
|
||||
pdf.ln
|
||||
unless changeset.comments.blank?
|
||||
pdf.SetFontStyle('',8)
|
||||
pdf.RDMwriteHTMLCell(190,5,'','',
|
||||
changeset.comments.to_s, issue.attachments, "")
|
||||
end
|
||||
pdf.ln
|
||||
end
|
||||
end
|
||||
|
||||
if assoc[:journals].present?
|
||||
pdf.SetFontStyle('B',9)
|
||||
pdf.RDMCell(190,5, l(:label_history), "B")
|
||||
pdf.ln
|
||||
assoc[:journals].each do |journal|
|
||||
pdf.SetFontStyle('B',8)
|
||||
title = "##{journal.indice} - #{format_time(journal.created_on)} - #{journal.user}"
|
||||
title << " (#{l(:field_private_notes)})" if journal.private_notes?
|
||||
pdf.RDMCell(190,5, title)
|
||||
pdf.ln
|
||||
pdf.SetFontStyle('I',8)
|
||||
details_to_strings(journal.visible_details, true).each do |string|
|
||||
pdf.RDMMultiCell(190,5, "- " + string)
|
||||
end
|
||||
if journal.notes?
|
||||
pdf.ln unless journal.details.empty?
|
||||
pdf.SetFontStyle('',8)
|
||||
text = textilizable(journal, :notes,
|
||||
only_path: false,
|
||||
edit_section_links: false,
|
||||
headings: false,
|
||||
inline_attachments: false
|
||||
)
|
||||
pdf.RDMwriteFormattedCell(190,5,'','', text, issue.attachments, "")
|
||||
end
|
||||
pdf.ln
|
||||
end
|
||||
end
|
||||
|
||||
if issue.attachments.any?
|
||||
pdf.SetFontStyle('B',9)
|
||||
pdf.RDMCell(190,5, l(:label_attachment_plural), "B")
|
||||
pdf.ln
|
||||
for attachment in issue.attachments
|
||||
pdf.SetFontStyle('',8)
|
||||
pdf.RDMCell(80,5, attachment.filename)
|
||||
pdf.RDMCell(20,5, number_to_human_size(attachment.filesize),0,0,"R")
|
||||
pdf.RDMCell(25,5, format_date(attachment.created_on),0,0,"R")
|
||||
pdf.RDMCell(65,5, attachment.author.name,0,0,"R")
|
||||
pdf.ln
|
||||
end
|
||||
end
|
||||
|
||||
# Check to see if there is an estimate attached, then combine them
|
||||
if issue.estimate
|
||||
e_pdf, ref = EstimatePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: [issue.estimate.id])
|
||||
pdf = CombinePDF.parse(pdf.output, allow_optional_content: true)
|
||||
pdf << CombinePDF.parse(e_pdf)
|
||||
return pdf.to_pdf
|
||||
end
|
||||
|
||||
return pdf.output
|
||||
end
|
||||
render_description(pdf, issue)
|
||||
render_subtasks(pdf, issue)
|
||||
render_relations(pdf, issue)
|
||||
render_changesets(pdf, issue)
|
||||
render_journals(pdf, issue, assoc)
|
||||
render_attachments(pdf, issue)
|
||||
|
||||
merge_estimate_if_present(pdf, issue)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[PdfPatch] #{msg}"
|
||||
Rails.logger.info "[PdfPatch] #{msg}"
|
||||
end
|
||||
|
||||
def setup_pdf(issue)
|
||||
pdf = ::Redmine::Export::PDF::ITCPDF.new(current_language)
|
||||
pdf.set_title("#{issue.project} - #{issue.tracker} ##{issue.id}")
|
||||
pdf.alias_nb_pages
|
||||
pdf.footer_date = format_date(Date.today)
|
||||
pdf.add_page
|
||||
pdf
|
||||
end
|
||||
|
||||
def render_header(pdf, issue)
|
||||
pdf.SetFontStyle('B', 11)
|
||||
pdf.RDMMultiCell(190, 5, "#{issue.project} - #{issue.tracker} ##{issue.id}")
|
||||
pdf.SetFontStyle('', 8)
|
||||
end
|
||||
|
||||
def render_ancestors_and_subject(pdf, issue)
|
||||
base_x = pdf.get_x
|
||||
i = 1
|
||||
|
||||
# Render ancestors
|
||||
issue.ancestors.visible.each do |ancestor|
|
||||
pdf.set_x(base_x + i)
|
||||
buf = "#{ancestor.tracker} # #{ancestor.id} (#{ancestor.status}): #{ancestor.subject}"
|
||||
pdf.RDMMultiCell(190 - i, 5, buf)
|
||||
i += 1 if i < 35
|
||||
end
|
||||
|
||||
# Render current issue subject and meta
|
||||
pdf.SetFontStyle('B', 11)
|
||||
pdf.RDMMultiCell(190 - i, 5, issue.subject.to_s)
|
||||
pdf.SetFontStyle('', 8)
|
||||
pdf.RDMMultiCell(190, 5, "#{format_time(issue.created_on)} - #{issue.author}")
|
||||
pdf.ln
|
||||
end
|
||||
|
||||
def build_issue_attributes(issue)
|
||||
left = build_left_attributes(issue)
|
||||
right = build_right_attributes(issue)
|
||||
|
||||
# Pad arrays to equal length
|
||||
rows = [left.size, right.size].max
|
||||
left.fill(nil, left.size...rows)
|
||||
right.fill(nil, right.size...rows)
|
||||
|
||||
# Distribute custom fields evenly
|
||||
half = (issue.visible_custom_field_values.size / 2.0).ceil
|
||||
issue.visible_custom_field_values.each_with_index do |custom_value, i|
|
||||
target_column = i < half ? left : right
|
||||
target_column << [custom_value.custom_field.name, show_value(custom_value, false)]
|
||||
end
|
||||
|
||||
[left, right]
|
||||
end
|
||||
|
||||
def build_left_attributes(issue)
|
||||
left = []
|
||||
left << [l(:field_status), issue.status]
|
||||
left << [l(:field_priority), issue.priority]
|
||||
left << [l(:field_customer), issue.customer&.name]
|
||||
left << [l(:field_assigned_to), issue.assigned_to] unless issue.disabled_core_fields.include?(:assigned_to_id)
|
||||
|
||||
log "Calling :pdf_left hook"
|
||||
left_hook_output = Redmine::Hook.call_hook(:pdf_left, { issue: issue })
|
||||
Array(left_hook_output).compact.each { |l| left.concat(l) }
|
||||
|
||||
left
|
||||
end
|
||||
|
||||
def build_right_attributes(issue)
|
||||
right = []
|
||||
right << [l(:field_start_date), format_date(issue.start_date)] unless issue.disabled_core_fields.include?(:start_date)
|
||||
right << [l(:field_due_date), format_date(issue.due_date)] unless issue.disabled_core_fields.include?(:due_date)
|
||||
right << [l(:field_done_ratio), "#{issue.done_ratio}%"] unless issue.disabled_core_fields.include?(:done_ratio)
|
||||
right << [l(:field_estimated_hours), l_hours(issue.estimated_hours)] unless issue.disabled_core_fields.include?(:estimated_hours)
|
||||
right << [l(:label_spent_time), l_hours(issue.total_spent_hours)] if User.current.allowed_to?(:view_time_entries, issue.project)
|
||||
|
||||
log "Calling :pdf_right hook"
|
||||
right_hook_output = Redmine::Hook.call_hook(:pdf_right, { issue: issue })
|
||||
Array(right_hook_output).compact.each { |r| right.concat(r) }
|
||||
|
||||
right
|
||||
end
|
||||
|
||||
def render_attributes_grid(pdf, left, right)
|
||||
base_x = pdf.get_x
|
||||
borders = determine_borders(pdf.get_rtl)
|
||||
rows = [left.size, right.size].max
|
||||
|
||||
rows.times do |i|
|
||||
item_left = left[i]
|
||||
item_right = right[i]
|
||||
|
||||
# Calculate dynamic row height
|
||||
pdf.SetFontStyle('B', 9)
|
||||
hl1 = pdf.get_string_height(35, item_left ? "#{item_left.first}:" : "")
|
||||
hr1 = pdf.get_string_height(35, item_right ? "#{item_right.first}:" : "")
|
||||
|
||||
pdf.SetFontStyle('', 9)
|
||||
hl2 = pdf.get_string_height(60, item_left ? item_left.last.to_s : "")
|
||||
hr2 = pdf.get_string_height(60, item_right ? item_right.last.to_s : "")
|
||||
|
||||
height = [hl1, hr1, hl2, hr2].max
|
||||
|
||||
# Render cells
|
||||
render_grid_cell(pdf, item_left, height, i == 0 ? borders[:first_top] : borders[:first], i == 0 ? borders[:last_top] : borders[:last], 0)
|
||||
render_grid_cell(pdf, item_right, height, i == 0 ? borders[:first_top] : borders[:first], i == 0 ? borders[:last_top] : borders[:last], 2)
|
||||
|
||||
pdf.set_x(base_x)
|
||||
end
|
||||
end
|
||||
|
||||
def determine_borders(is_rtl)
|
||||
if is_rtl
|
||||
{ first_top: 'RT', last_top: 'LT', first: 'R', last: 'L' }
|
||||
else
|
||||
{ first_top: 'LT', last_top: 'RT', first: 'L', last: 'R' }
|
||||
end
|
||||
end
|
||||
|
||||
def render_grid_cell(pdf, item, height, border_label, border_val, ln_type)
|
||||
pdf.SetFontStyle('B', 9)
|
||||
pdf.RDMMultiCell(35, height, item ? "#{item.first}:" : "", border_label, '', 0, 0)
|
||||
|
||||
pdf.SetFontStyle('', 9)
|
||||
pdf.RDMMultiCell(60, height, item ? item.last.to_s : "", border_val, '', 0, ln_type)
|
||||
end
|
||||
|
||||
def render_description(pdf, issue)
|
||||
pdf.SetFontStyle('B', 9)
|
||||
pdf.RDMCell(190, 5, l(:field_description), "LRT", 1)
|
||||
pdf.SetFontStyle('', 9)
|
||||
|
||||
pdf.set_image_scale(1.6)
|
||||
text = textilizable(issue, :description,
|
||||
only_path: false,
|
||||
edit_section_links: false,
|
||||
headings: false,
|
||||
inline_attachments: false)
|
||||
pdf.RDMwriteFormattedCell(190, 5, '', '', text, issue.attachments, "LRB")
|
||||
end
|
||||
|
||||
def render_subtasks(pdf, issue)
|
||||
return if issue.leaf?
|
||||
|
||||
truncate_length = !is_cjk? ? 90 : 65
|
||||
pdf.SetFontStyle('B', 9)
|
||||
pdf.RDMCell(190, 5, "#{l(:label_subtask_plural)}:", "LTR")
|
||||
pdf.ln
|
||||
|
||||
border_first = pdf.get_rtl ? 'R' : 'L'
|
||||
border_last = pdf.get_rtl ? 'L' : 'R'
|
||||
|
||||
issue_list(issue.descendants.visible.sort_by(&:lft)) do |child, level|
|
||||
buf = "#{child.tracker} # #{child.id}: #{child.subject}".truncate(truncate_length)
|
||||
level = 10 if level >= 10
|
||||
|
||||
pdf.SetFontStyle('', 8)
|
||||
pdf.RDMCell(170, 5, (level >= 1 ? " " * level : "") + buf, border_first)
|
||||
pdf.SetFontStyle('B', 8)
|
||||
pdf.RDMCell(20, 5, child.status.to_s, border_last)
|
||||
pdf.ln
|
||||
end
|
||||
end
|
||||
|
||||
def render_relations(pdf, issue)
|
||||
relations = issue.relations.select { |r| r.other_issue(issue).visible? }
|
||||
return if relations.empty?
|
||||
|
||||
truncate_length = !is_cjk? ? 80 : 60
|
||||
pdf.SetFontStyle('B', 9)
|
||||
pdf.RDMCell(190, 5, "#{l(:label_related_issues)}:", "LTR")
|
||||
pdf.ln
|
||||
|
||||
border_first = pdf.get_rtl ? 'R' : 'L'
|
||||
border_last = pdf.get_rtl ? 'L' : 'R'
|
||||
|
||||
relations.each do |relation|
|
||||
other = relation.other_issue(issue)
|
||||
text = Setting.cross_project_issue_relations? ? "#{other.project} - " : ""
|
||||
text += "#{other.tracker} ##{other.id}: #{other.subject}"
|
||||
|
||||
pdf.SetFontStyle('', 8)
|
||||
pdf.RDMCell(130, 5, text.truncate(truncate_length), border_first)
|
||||
pdf.SetFontStyle('B', 8)
|
||||
pdf.RDMCell(20, 5, other.status.to_s, "")
|
||||
pdf.RDMCell(20, 5, format_date(other.start_date), "")
|
||||
pdf.RDMCell(20, 5, format_date(other.due_date), border_last)
|
||||
pdf.ln
|
||||
end
|
||||
pdf.RDMCell(190, 5, "", "T")
|
||||
pdf.ln
|
||||
end
|
||||
|
||||
def render_changesets(pdf, issue)
|
||||
return unless issue.changesets.any? && User.current.allowed_to?(:view_changesets, issue.project)
|
||||
|
||||
pdf.SetFontStyle('B', 9)
|
||||
pdf.RDMCell(190, 5, l(:label_associated_revisions), "B")
|
||||
pdf.ln
|
||||
|
||||
issue.changesets.each do |changeset|
|
||||
pdf.SetFontStyle('B', 8)
|
||||
csstr = "#{l(:label_revision)} #{changeset.format_identifier} - #{format_time(changeset.committed_on)} - #{changeset.author}"
|
||||
pdf.RDMCell(190, 5, csstr)
|
||||
pdf.ln
|
||||
|
||||
unless changeset.comments.blank?
|
||||
pdf.SetFontStyle('', 8)
|
||||
pdf.RDMwriteHTMLCell(190, 5, '', '', changeset.comments.to_s, issue.attachments, "")
|
||||
end
|
||||
pdf.ln
|
||||
end
|
||||
end
|
||||
|
||||
def render_journals(pdf, issue, assoc)
|
||||
return unless assoc[:journals].present?
|
||||
|
||||
pdf.SetFontStyle('B', 9)
|
||||
pdf.RDMCell(190, 5, l(:label_history), "B")
|
||||
pdf.ln
|
||||
|
||||
assoc[:journals].each do |journal|
|
||||
pdf.SetFontStyle('B', 8)
|
||||
title = "##{journal.indice} - #{format_time(journal.created_on)} - #{journal.user}"
|
||||
title << " (#{l(:field_private_notes)})" if journal.private_notes?
|
||||
pdf.RDMCell(190, 5, title)
|
||||
pdf.ln
|
||||
|
||||
pdf.SetFontStyle('I', 8)
|
||||
details_to_strings(journal.visible_details, true).each do |string|
|
||||
pdf.RDMMultiCell(190, 5, "- " + string)
|
||||
end
|
||||
|
||||
if journal.notes?
|
||||
pdf.ln unless journal.details.empty?
|
||||
pdf.SetFontStyle('', 8)
|
||||
text = textilizable(journal, :notes, only_path: false, edit_section_links: false, headings: false, inline_attachments: false)
|
||||
pdf.RDMwriteFormattedCell(190, 5, '', '', text, issue.attachments, "")
|
||||
end
|
||||
pdf.ln
|
||||
end
|
||||
end
|
||||
|
||||
def render_attachments(pdf, issue)
|
||||
return unless issue.attachments.any?
|
||||
|
||||
pdf.SetFontStyle('B', 9)
|
||||
pdf.RDMCell(190, 5, l(:label_attachment_plural), "B")
|
||||
pdf.ln
|
||||
|
||||
issue.attachments.each do |attachment|
|
||||
pdf.SetFontStyle('', 8)
|
||||
pdf.RDMCell(80, 5, attachment.filename)
|
||||
pdf.RDMCell(20, 5, number_to_human_size(attachment.filesize), 0, 0, "R")
|
||||
pdf.RDMCell(25, 5, format_date(attachment.created_on), 0, 0, "R")
|
||||
pdf.RDMCell(65, 5, attachment.author.name, 0, 0, "R")
|
||||
pdf.ln
|
||||
end
|
||||
end
|
||||
|
||||
def merge_estimate_if_present(pdf, issue)
|
||||
if issue.estimate
|
||||
e_pdf, _ref = PdfService.new(entity: Estimate).fetch_pdf(doc_ids: [issue.estimate.id])
|
||||
combined = CombinePDF.parse(pdf.output, allow_optional_content: true)
|
||||
combined << CombinePDF.parse(e_pdf)
|
||||
combined.to_pdf
|
||||
else
|
||||
pdf.output
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
Redmine::Export::PDF::IssuesPdfHelper.send(:include, PdfPatch)
|
||||
|
||||
end
|
||||
end
|
||||
@@ -8,11 +8,10 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
require_dependency 'issue_query'
|
||||
|
||||
module RedmineQbo
|
||||
module Patches
|
||||
module QueryPatch
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
def base_scope
|
||||
scope = super
|
||||
@@ -59,12 +58,6 @@ module RedmineQbo
|
||||
|
||||
Issue.joins(:customer).sanitize_sql_for_conditions([sql, pattern])
|
||||
end
|
||||
|
||||
|
||||
end
|
||||
|
||||
# Add module to Issue
|
||||
IssueQuery.send(:prepend, QueryPatch)
|
||||
|
||||
end
|
||||
end
|
||||
@@ -8,11 +8,10 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
require_dependency 'time_entry_query'
|
||||
|
||||
module RedmineQbo
|
||||
module Patches
|
||||
module TimeEntryQueryPatch
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
# Add QBO options to columns
|
||||
def available_columns
|
||||
@@ -28,11 +27,6 @@ module RedmineQbo
|
||||
add_available_filter "billed", type: :boolean
|
||||
super
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
# Add module to TimeEntryQuery
|
||||
TimeEntryQuery.send(:prepend, QueryPatch)
|
||||
|
||||
end
|
||||
end
|
||||
@@ -8,37 +8,14 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
require_dependency 'user'
|
||||
|
||||
module RedmineQbo
|
||||
module Patches
|
||||
|
||||
# Patches Redmine's User dynamically.
|
||||
# Adds a relationships
|
||||
module UserPatch
|
||||
def self.included(base) # :nodoc:
|
||||
base.extend(ClassMethods)
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
base.send(:include, InstanceMethods)
|
||||
|
||||
# Same as typing in the class
|
||||
base.class_eval do
|
||||
prepended do
|
||||
belongs_to :employee, primary_key: :id
|
||||
end
|
||||
end
|
||||
|
||||
module ClassMethods
|
||||
|
||||
end
|
||||
|
||||
module InstanceMethods
|
||||
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
# Add module to Issue
|
||||
User.send(:include, UserPatch)
|
||||
|
||||
end
|
||||
end
|
||||
Reference in New Issue
Block a user