mirror of
https://github.com/rickbarrette/redmine_qbo.git
synced 2026-04-02 16:21:58 -04:00
Compare commits
21 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 2520892e2c | |||
| b96678a2e9 | |||
| bccfcd9dbc | |||
| 8ba99b7db2 | |||
| aff7d0c48e | |||
| e9b3b1c838 | |||
| 2fc2f94cd1 | |||
| 9f9810686f | |||
| f041e1bce4 | |||
| d44d5e2fb7 | |||
| 4403267abb | |||
| be400c2b2a | |||
| 23e565a304 | |||
| 2e2b17fac3 | |||
| 28db5cb8c8 | |||
| 0df15693d2 | |||
| f8b1c72394 | |||
| 899237c5ab | |||
| f02b50ae26 | |||
| 485a977d1a | |||
| 03d5a5d148 |
@@ -66,67 +66,76 @@ class CustomersController < ApplicationController
|
|||||||
# create a new customer
|
# create a new customer
|
||||||
def create
|
def create
|
||||||
@customer = Customer.new(allowed_params)
|
@customer = Customer.new(allowed_params)
|
||||||
if @customer.save
|
@customer.save
|
||||||
|
log "Customer ##{@customer.id} created successfully."
|
||||||
flash[:notice] = t :notice_customer_created
|
flash[:notice] = t :notice_customer_created
|
||||||
redirect_to @customer
|
redirect_to @customer
|
||||||
else
|
rescue => e
|
||||||
flash[:error] = @customer.errors.full_messages.to_sentence
|
log "Failed to create customer: #{e.message}"
|
||||||
|
flash[:error] = e.message
|
||||||
redirect_to new_customer_path
|
redirect_to new_customer_path
|
||||||
end
|
end
|
||||||
end
|
|
||||||
|
|
||||||
# display a specific customer
|
# display a specific customer
|
||||||
def show
|
def show
|
||||||
begin
|
|
||||||
@customer = Customer.find_by_id(params[:id])
|
@customer = Customer.find_by_id(params[:id])
|
||||||
@issues = @customer.issues.order(id: :desc)
|
return render_404 unless @customer
|
||||||
@billing_address = address_to_s(@customer.billing_address)
|
|
||||||
@shipping_address = address_to_s(@customer.shipping_address)
|
@open_issues = @customer.issues
|
||||||
@closed_issues = (@issues - @issues.open)
|
.joins(:status)
|
||||||
@hours = 0
|
.includes(:status, :project, :tracker, :priority)
|
||||||
@closed_hours = 0
|
.where(issue_statuses: { is_closed: false })
|
||||||
@issues.open.each { |i| @hours+= i.total_spent_hours }
|
.order(id: :desc)
|
||||||
@closed_issues.each { |i| @closed_hours+= i.total_spent_hours }
|
|
||||||
rescue
|
@closed_issues = @customer.issues
|
||||||
flash[:error] = t :notice_customer_not_found
|
.joins(:status)
|
||||||
|
.includes(:status, :project, :tracker, :priority)
|
||||||
|
.where(issue_statuses: { is_closed: true })
|
||||||
|
.order(id: :desc)
|
||||||
|
|
||||||
|
@hours = TimeEntry
|
||||||
|
.joins(:issue)
|
||||||
|
.where(issues: { id: @open_issues.select(:id) })
|
||||||
|
.sum(:hours)
|
||||||
|
|
||||||
|
@closed_hours = TimeEntry
|
||||||
|
.joins(:issue)
|
||||||
|
.where(issues: { id: @closed_issues.select(:id) })
|
||||||
|
.sum(:hours)
|
||||||
|
|
||||||
|
rescue => e
|
||||||
|
Rails.logger.error "Failed to load customer ##{params[:id]}: #{e.message}\n#{e.backtrace.join("\n")}"
|
||||||
|
flash[:error] = e.message
|
||||||
render_404
|
render_404
|
||||||
end
|
end
|
||||||
end
|
|
||||||
|
|
||||||
# return an HTML form for editing a customer
|
# return an HTML form for editing a customer
|
||||||
def edit
|
def edit
|
||||||
begin
|
|
||||||
@customer = Customer.find_by_id(params[:id])
|
@customer = Customer.find_by_id(params[:id])
|
||||||
rescue
|
return render_404 unless @customer
|
||||||
flash[:error] = t :notice_customer_not_found
|
rescue => e
|
||||||
|
log "Failed to edit customer"
|
||||||
|
flash[:error] = e.message
|
||||||
render_404
|
render_404
|
||||||
end
|
end
|
||||||
end
|
|
||||||
|
|
||||||
# update a specific customer
|
# update a specific customer
|
||||||
def update
|
def update
|
||||||
begin
|
|
||||||
@customer = Customer.find_by_id(params[:id])
|
@customer = Customer.find_by_id(params[:id])
|
||||||
if @customer.update(allowed_params)
|
@customer.update(allowed_params)
|
||||||
flash[:notice] = t :notice_customer_updated
|
flash[:notice] = t :notice_customer_updated
|
||||||
redirect_to @customer
|
redirect_to @customer
|
||||||
else
|
rescue => e
|
||||||
|
log "Failed to update customer: #{e.message}"
|
||||||
|
flash[:error] = e.message
|
||||||
redirect_to edit_customer_path
|
redirect_to edit_customer_path
|
||||||
flash[:error] = @customer.errors.full_messages.to_sentence if @customer.errors
|
|
||||||
end
|
|
||||||
rescue
|
|
||||||
flash[:error] = t :notice_customer_not_found
|
|
||||||
render_404
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# creates new customer view tokens, removes expired tokens & redirects to newly created customer view with new token.
|
# creates new customer view tokens, removes expired tokens & redirects to newly created customer view with new token.
|
||||||
def share
|
def share
|
||||||
issue = Issue.find(params[:id])
|
issue = Issue.find(params[:id])
|
||||||
|
|
||||||
token = issue.share_token
|
token = issue.share_token
|
||||||
redirect_to view_path(token.token)
|
redirect_to view_path(token.token)
|
||||||
|
|
||||||
rescue ActiveRecord::RecordNotFound
|
rescue ActiveRecord::RecordNotFound
|
||||||
flash[:error] = t(:notice_issue_not_found)
|
flash[:error] = t(:notice_issue_not_found)
|
||||||
render_404
|
render_404
|
||||||
|
|||||||
@@ -12,12 +12,14 @@ class Customer < ActiveRecord::Base
|
|||||||
|
|
||||||
include Redmine::Acts::Searchable
|
include Redmine::Acts::Searchable
|
||||||
include Redmine::Acts::Event
|
include Redmine::Acts::Event
|
||||||
|
include Redmine::I18n
|
||||||
|
|
||||||
has_many :issues
|
has_many :issues
|
||||||
has_many :invoices
|
has_many :invoices
|
||||||
has_many :estimates
|
has_many :estimates
|
||||||
|
|
||||||
validates_presence_of :id, :name
|
validates_presence_of :id, :name
|
||||||
|
before_validation :normalize_phone_numbers
|
||||||
|
|
||||||
self.primary_key = :id
|
self.primary_key = :id
|
||||||
|
|
||||||
@@ -31,44 +33,41 @@ 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}"},
|
: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}
|
:datetime => Proc.new {|o| o.updated_at || o.created_at}
|
||||||
|
|
||||||
# Convenience Method
|
# 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.
|
||||||
# returns the customer's email
|
def details
|
||||||
def email
|
return Quickbooks::Model::Customer.new unless id.present?
|
||||||
pull unless @details
|
|
||||||
begin
|
@details ||= begin
|
||||||
return @details.email_address.address
|
xml = Rails.cache.fetch(details_cache_key, expires_in: 10.minutes) do
|
||||||
rescue
|
fetch_details.to_xml_ns
|
||||||
return nil
|
end
|
||||||
|
|
||||||
|
Quickbooks::Model::Customer.from_xml(xml)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Convenience Method
|
# Generates a unique cache key for storing this customer's QBO details.
|
||||||
# Sets the email
|
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
|
||||||
|
end
|
||||||
|
|
||||||
|
# Updates the customer's email address
|
||||||
def email=(s)
|
def email=(s)
|
||||||
pull unless @details
|
details
|
||||||
@details.email_address = s
|
@details.email_address = s
|
||||||
end
|
end
|
||||||
|
|
||||||
# Convenience Method
|
|
||||||
# returns the customer's primary phone
|
|
||||||
def primary_phone
|
|
||||||
pull unless @details
|
|
||||||
begin
|
|
||||||
return @details.primary_phone.free_form_number
|
|
||||||
rescue
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Convenience Method
|
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
|
||||||
# Updates the customer's primary phone number
|
def self.last_sync
|
||||||
def primary_phone=(n)
|
return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
|
||||||
pull unless @details
|
format_time(maximum(:updated_at))
|
||||||
pn = Quickbooks::Model::TelephoneNumber.new
|
|
||||||
pn.free_form_number = n
|
|
||||||
@details.primary_phone = pn
|
|
||||||
#update our locally stored number too
|
|
||||||
update_phone_number
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Customers are not bound by a project
|
# Customers are not bound by a project
|
||||||
@@ -77,81 +76,72 @@ class Customer < ActiveRecord::Base
|
|||||||
nil
|
nil
|
||||||
end
|
end
|
||||||
|
|
||||||
# Convenience Method
|
# Magic Method
|
||||||
# returns the customer's mobile phone
|
# Maps Get/Set methods to QBO customer object
|
||||||
def mobile_phone
|
def method_missing(method_name, *args, &block)
|
||||||
pull unless @details
|
if Quickbooks::Model::Customer.method_defined?(method_name)
|
||||||
begin
|
details
|
||||||
return @details.mobile_phone.free_form_number
|
@details.public_send(method_name, *args, &block)
|
||||||
rescue
|
else
|
||||||
return nil
|
super
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Convenience Method
|
# returns the customer's mobile phone
|
||||||
|
def mobile_phone
|
||||||
|
details
|
||||||
|
return @details&.mobile_phone&.free_form_number
|
||||||
|
end
|
||||||
|
|
||||||
# Updates the custome's mobile phone number
|
# Updates the custome's mobile phone number
|
||||||
def mobile_phone=(n)
|
def mobile_phone=(n)
|
||||||
pull unless @details
|
details
|
||||||
pn = Quickbooks::Model::TelephoneNumber.new
|
pn = Quickbooks::Model::TelephoneNumber.new
|
||||||
pn.free_form_number = n
|
pn.free_form_number = n
|
||||||
@details.mobile_phone = pn
|
@details.mobile_phone = pn
|
||||||
#update our locally stored number too
|
|
||||||
update_mobile_phone_number
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Convenience Method
|
|
||||||
# Sets the notes
|
|
||||||
def notes=(s)
|
|
||||||
pull unless @details
|
|
||||||
@details.notes = s
|
|
||||||
end
|
|
||||||
|
|
||||||
# update the localy stored phone number as a plain string with no special chars
|
|
||||||
def update_phone_number
|
|
||||||
begin
|
|
||||||
self.phone_number = self.primary_phone.tr('^0-9', '')
|
|
||||||
rescue
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# update the localy stored phone number as a plain string with no special chars
|
|
||||||
def update_mobile_phone_number
|
|
||||||
begin
|
|
||||||
self.mobile_phone_number = self.mobile_phone.tr('^0-9', '')
|
|
||||||
rescue
|
|
||||||
return nil
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Convenience Method
|
|
||||||
# Updates Both local DB name & QBO display_name
|
# Updates Both local DB name & QBO display_name
|
||||||
def name=(s)
|
def name=(s)
|
||||||
pull unless @details
|
details
|
||||||
@details.display_name = s
|
@details.display_name = s
|
||||||
super
|
super
|
||||||
end
|
end
|
||||||
|
|
||||||
# Magic Method
|
# Normalizes phone numbers by removing non-digit characters. This method is called before validation to ensure that phone numbers are stored in a consistent format, which can help with searching and integration with external systems like QuickBooks Online.
|
||||||
# Maps Get/Set methods to QBO customer object
|
def normalize_phone_numbers
|
||||||
def method_missing(sym, *arguments)
|
self.phone_number = phone_number.to_s.gsub(/\D/, '') if phone_number.present?
|
||||||
# Check to see if the method exists
|
self.mobile_phone_number = mobile_phone_number.to_s.gsub(/\D/, '') if mobile_phone_number.present?
|
||||||
if Quickbooks::Model::Customer.method_defined?(sym)
|
|
||||||
# download details if required
|
|
||||||
pull unless @details
|
|
||||||
method_name = sym.to_s
|
|
||||||
# Setter
|
|
||||||
if method_name[-1, 1] == "="
|
|
||||||
@details.method(method_name).call(arguments[0])
|
|
||||||
# Getter
|
|
||||||
else
|
|
||||||
return @details.method(method_name).call
|
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Sets the notes for the customer
|
||||||
|
def notes=(s)
|
||||||
|
details
|
||||||
|
@details.notes = s
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# returns the customer's primary phone
|
||||||
|
def primary_phone
|
||||||
|
details
|
||||||
|
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
|
||||||
end
|
end
|
||||||
|
|
||||||
# Seach for customers by name or phone number
|
# Seach for customers by name or phone number
|
||||||
def self.search(search)
|
def self.search(search)
|
||||||
|
#return none if search.blank?
|
||||||
search = sanitize_sql_like(search)
|
search = sanitize_sql_like(search)
|
||||||
where("name LIKE ? OR phone_number LIKE ? OR mobile_phone_number LIKE ?", "%#{search}%", "%#{search}%", "%#{search}%")
|
where("name LIKE ? OR phone_number LIKE ? OR mobile_phone_number LIKE ?", "%#{search}%", "%#{search}%", "%#{search}%")
|
||||||
end
|
end
|
||||||
@@ -170,39 +160,28 @@ class Customer < ActiveRecord::Base
|
|||||||
ids.index_with { |id| id }
|
ids.index_with { |id| id }
|
||||||
end
|
end
|
||||||
|
|
||||||
# proforms a bruteforce sync operation
|
# performs a sync operation for all customers
|
||||||
def self.sync
|
def self.sync
|
||||||
CustomerSyncJob.perform_later(full_sync: false)
|
CustomerSyncJob.perform_later(full_sync: false)
|
||||||
end
|
end
|
||||||
|
|
||||||
# proforms a bruteforce sync operation
|
# performs a sync operation for a specific customer
|
||||||
def self.sync_by_id(id)
|
def self.sync_by_id(id)
|
||||||
CustomerSyncJob.perform_later(id: id)
|
CustomerSyncJob.perform_later(id: id)
|
||||||
end
|
end
|
||||||
|
|
||||||
# returns a human readable string
|
# returns a human readable string
|
||||||
def to_s
|
def to_s
|
||||||
return "#{self[:name]} - #{phone_number.split(//).last(4).join unless phone_number.nil?}"
|
last4 = phone_number&.last(4)
|
||||||
|
last4.present? ? "#{name} - #{last4}" : name.to_s
|
||||||
end
|
end
|
||||||
|
|
||||||
# Push the updates
|
# Push the updates
|
||||||
def save_with_push
|
def save_with_push
|
||||||
begin
|
log "Starting push for customer ##{self.id}..."
|
||||||
qbo = Qbo.first
|
qbo = QboConnectionService.current!
|
||||||
@details = qbo.perform_authenticated_request do |access_token|
|
CustomerService.new(qbo: qbo, customer: self).push()
|
||||||
service = Quickbooks::Service::Customer.new(
|
Rails.cache.delete(details_cache_key)
|
||||||
company_id: qbo.realm_id,
|
|
||||||
access_token: access_token
|
|
||||||
)
|
|
||||||
service.update(@details)
|
|
||||||
end
|
|
||||||
|
|
||||||
self.id = @details.id
|
|
||||||
rescue => e
|
|
||||||
errors.add(:base, e.message)
|
|
||||||
return false
|
|
||||||
end
|
|
||||||
|
|
||||||
save_without_push
|
save_without_push
|
||||||
end
|
end
|
||||||
|
|
||||||
@@ -211,18 +190,17 @@ class Customer < ActiveRecord::Base
|
|||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
# pull the details
|
# 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 pull
|
def fetch_details
|
||||||
begin
|
return Quickbooks::Model::Customer.new unless id.present?
|
||||||
raise Exception unless self.id
|
log "Fetching details for customer ##{id} from QBO..."
|
||||||
qbo = QboConnectionService.current!
|
qbo = QboConnectionService.current!
|
||||||
@details = qbo.perform_authenticated_request do |access_token|
|
CustomerService.new(qbo: qbo, customer: self).pull()
|
||||||
service = Quickbooks::Service::Customer.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
service.fetch_by_id(self.id)
|
|
||||||
end
|
|
||||||
rescue Exception => e
|
|
||||||
@details = Quickbooks::Model::Customer.new
|
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# Log messages with the entity type for better traceability
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[Customer] #{msg}"
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -10,11 +10,19 @@
|
|||||||
|
|
||||||
class Employee < ActiveRecord::Base
|
class Employee < ActiveRecord::Base
|
||||||
|
|
||||||
|
include Redmine::I18n
|
||||||
|
|
||||||
has_many :users
|
has_many :users
|
||||||
validates_presence_of :id, :name
|
validates_presence_of :id, :name
|
||||||
|
|
||||||
self.primary_key = :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
|
||||||
|
|
||||||
# Sync all employees, typically triggered by a scheduled task or manual sync request
|
# Sync all employees, typically triggered by a scheduled task or manual sync request
|
||||||
def self.sync
|
def self.sync
|
||||||
EmployeeSyncJob.perform_later(full_sync: true)
|
EmployeeSyncJob.perform_later(full_sync: true)
|
||||||
|
|||||||
@@ -10,11 +10,19 @@
|
|||||||
|
|
||||||
class Estimate < ActiveRecord::Base
|
class Estimate < ActiveRecord::Base
|
||||||
|
|
||||||
|
include Redmine::I18n
|
||||||
|
|
||||||
has_and_belongs_to_many :issues
|
has_and_belongs_to_many :issues
|
||||||
belongs_to :customer
|
belongs_to :customer
|
||||||
validates_presence_of :doc_number, :id
|
validates_presence_of :doc_number, :id
|
||||||
self.primary_key = :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
|
||||||
|
|
||||||
# returns a human readable string
|
# returns a human readable string
|
||||||
def to_s
|
def to_s
|
||||||
return self[:doc_number]
|
return self[:doc_number]
|
||||||
@@ -35,41 +43,8 @@ class Estimate < ActiveRecord::Base
|
|||||||
EstimateSyncJob.perform_later(doc_number: number)
|
EstimateSyncJob.perform_later(doc_number: number)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Magic Method
|
|
||||||
# Maps Get/Set methods to QBO estimate object
|
|
||||||
def method_missing(sym, *arguments)
|
|
||||||
# Check to see if the method exists
|
|
||||||
if Quickbooks::Model::Estimate.method_defined?(sym)
|
|
||||||
# download details if required
|
|
||||||
pull unless @details
|
|
||||||
method_name = sym.to_s
|
|
||||||
# Setter
|
|
||||||
if method_name[-1, 1] == "="
|
|
||||||
@details.method(method_name).call(arguments[0])
|
|
||||||
# Getter
|
|
||||||
else
|
|
||||||
return @details.method(method_name).call
|
|
||||||
end
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
# pull the details
|
|
||||||
def pull
|
|
||||||
log "Pulling details for estimate ##{self.id}..."
|
|
||||||
begin
|
|
||||||
raise Exception unless self.id
|
|
||||||
qbo = QboConnectionService.current!
|
|
||||||
@details = qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Estimate.new(company_id: qbo.realm_id, access_token: access_token)
|
|
||||||
service(:estimate).fetch_by_id(self.id)
|
|
||||||
end
|
|
||||||
rescue Exception => e
|
|
||||||
@details = Quickbooks::Model::Estimate.new
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
def log(msg)
|
def log(msg)
|
||||||
Rails.logger.info "[Estimate] #{msg}"
|
Rails.logger.info "[Estimate] #{msg}"
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -9,6 +9,9 @@
|
|||||||
#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.
|
#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
|
class Invoice < ActiveRecord::Base
|
||||||
|
|
||||||
|
include Redmine::I18n
|
||||||
|
|
||||||
has_and_belongs_to_many :issues
|
has_and_belongs_to_many :issues
|
||||||
belongs_to :customer
|
belongs_to :customer
|
||||||
|
|
||||||
@@ -17,6 +20,12 @@ class Invoice < ActiveRecord::Base
|
|||||||
|
|
||||||
self.primary_key = :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
|
||||||
|
|
||||||
# Return the invoice's document number as its string representation
|
# Return the invoice's document number as its string representation
|
||||||
def to_s
|
def to_s
|
||||||
doc_number
|
doc_number
|
||||||
|
|||||||
62
app/services/customer_service.rb
Normal file
62
app/services/customer_service.rb
Normal file
@@ -0,0 +1,62 @@
|
|||||||
|
#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 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
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Log messages with the entity type for better traceability
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[CustomerService] #{msg}"
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
@@ -13,6 +13,7 @@ class SyncServiceBase
|
|||||||
|
|
||||||
# Subclasses should initialize with a QBO client instance
|
# Subclasses should initialize with a QBO client instance
|
||||||
def initialize(qbo:)
|
def initialize(qbo:)
|
||||||
|
raise "No QBO configuration found" unless qbo
|
||||||
@qbo = qbo
|
@qbo = qbo
|
||||||
@entity = self.class.model_class
|
@entity = self.class.model_class
|
||||||
end
|
end
|
||||||
|
|||||||
@@ -13,12 +13,12 @@
|
|||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
<th><%=t(:label_primary_phone)%></th>
|
<th><%=t(:label_primary_phone)%></th>
|
||||||
<td><%= number_to_phone(customer.primary_phone.gsub(/[^\d]/, '').to_i, area_code: true) if customer.primary_phone %></td>
|
<td><%= number_to_phone(customer&.primary_phone&.gsub(/[^\d]/, '').to_i, area_code: true) %></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
<th><%=t(:label_mobile_phone)%></th>
|
<th><%=t(:label_mobile_phone)%></th>
|
||||||
<td><%= number_to_phone(customer.mobile_phone.gsub(/[^\d]/, '').to_i, area_code: true) if customer.mobile_phone %></td>
|
<td><%= number_to_phone(customer&.mobile_phone&.gsub(/[^\d]/, '').to_i, area_code: true) %></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
|
|||||||
@@ -46,8 +46,8 @@
|
|||||||
</div>
|
</div>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
<h3><%=@issues.open.count%> <%=t(:label_open_issues)%> - <%=@hours.round(1)%> <%=t(:label_hours)%></h3>
|
<h3><%=@open_issues.count%> <%=t(:label_open_issues)%> - <%=@hours.round(1)%> <%=t(:label_hours)%></h3>
|
||||||
<%= render partial: 'issues/list_simple', locals: {issues: @issues.open} %>
|
<%= render partial: 'issues/list_simple', locals: {issues: @open_issues.open} %>
|
||||||
|
|
||||||
<h3><%=@closed_issues.count%> <%=t(:label_closed_issues)%> - <%= @closed_hours.round(1)%> <%=t(:label_hours)%></h3>
|
<h3><%=@closed_issues.count%> <%=t(:label_closed_issues)%> - <%= @closed_hours.round(1)%> <%=t(:label_hours)%></h3>
|
||||||
<%= render partial: 'issues/list_simple', locals: {issues: @closed_issues} %>
|
<%= render partial: 'issues/list_simple', locals: {issues: @closed_issues} %>
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
<b><%=t(:label_last_sync)%>: </b> <%= Qbo.last_sync if Qbo.exists? %>
|
<b><%=t(:label_last_sync)%>: </b> <%= Qbo.last_sync %>
|
||||||
|
|||||||
@@ -66,12 +66,12 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
|
|||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
<th><%=t(:label_oauth_expires)%></th>
|
<th><%=t(:label_oauth_expires)%></th>
|
||||||
<td><%= if Qbo.exists? then QboConnectionService.current!.oauth2_access_token_expires_at end %>
|
<td><%= QboConnectionService.current!&.oauth2_access_token_expires_at %>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
<th><%=t(:label_oauth2_refresh_token_expires_at)%></th>
|
<th><%=t(:label_oauth2_refresh_token_expires_at)%></th>
|
||||||
<td><%= if Qbo.exists? then QboConnectionService.current!.oauth2_refresh_token_expires_at end %>
|
<td><%= QboConnectionService.current!&.oauth2_refresh_token_expires_at %>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
@@ -89,19 +89,19 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
|
|||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
<div>
|
<div>
|
||||||
<b><%=t(:label_customer_count)%>:</b> <%= Customer.count%>
|
<b><%=t(:label_customer_count)%>:</b> <%= Customer.count%> @ <%= Customer.last_sync %>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div>
|
<div>
|
||||||
<b><%=t(:label_employee_count)%>:</b> <%= Employee.count %>
|
<b><%=t(:label_employee_count)%>:</b> <%= Employee.count %> @ <%= Employee.last_sync %>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div>
|
<div>
|
||||||
<b><%=t(:label_invoice_count)%>:</b> <%= Invoice.count %>
|
<b><%=t(:label_invoice_count)%>:</b> <%= Invoice.count %> @ <%= Invoice.last_sync%>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<div>
|
<div>
|
||||||
<b><%=t(:label_estimate_count)%>:</b> <%= Estimate.count %>
|
<b><%=t(:label_estimate_count)%>:</b> <%= Estimate.count %> @ <%= Estimate.last_sync %>
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
<br/>
|
<br/>
|
||||||
|
|||||||
@@ -11,7 +11,6 @@
|
|||||||
class AddTxnDates < ActiveRecord::Migration[5.1]
|
class AddTxnDates < ActiveRecord::Migration[5.1]
|
||||||
|
|
||||||
def change
|
def change
|
||||||
begin
|
|
||||||
add_column :qbo_invoices, :txn_date, :date
|
add_column :qbo_invoices, :txn_date, :date
|
||||||
add_column :qbo_estimates, :txn_date, :date
|
add_column :qbo_estimates, :txn_date, :date
|
||||||
end
|
end
|
||||||
|
|||||||
2
init.rb
2
init.rb
@@ -14,7 +14,7 @@ Redmine::Plugin.register :redmine_qbo do
|
|||||||
name 'Redmine QBO plugin'
|
name 'Redmine QBO plugin'
|
||||||
author 'Rick Barrette'
|
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'
|
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.0'
|
version '2026.3.1'
|
||||||
url 'https://github.com/rickbarrette/redmine_qbo'
|
url 'https://github.com/rickbarrette/redmine_qbo'
|
||||||
author_url 'https://barrettefabrication.com'
|
author_url 'https://barrettefabrication.com'
|
||||||
settings default: {empty: true}, partial: 'qbo/settings'
|
settings default: {empty: true}, partial: 'qbo/settings'
|
||||||
|
|||||||
@@ -21,8 +21,6 @@ module RedmineQbo
|
|||||||
f = context[:form]
|
f = context[:form]
|
||||||
issue = context[:issue]
|
issue = context[:issue]
|
||||||
project = context[:project]
|
project = context[:project]
|
||||||
log issue.inspect
|
|
||||||
log project.inspect
|
|
||||||
|
|
||||||
# Customer Name Text Box with database backed autocomplete
|
# Customer Name Text Box with database backed autocomplete
|
||||||
# onchange event will update the hidden customer_id field
|
# onchange event will update the hidden customer_id field
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ module RedmineQbo
|
|||||||
#Employee.update_all
|
#Employee.update_all
|
||||||
|
|
||||||
# Check to see if there is a quickbooks user attached to the issue
|
# Check to see if there is a quickbooks user attached to the issue
|
||||||
@selected = context[:user].employee.id if context[:user].employee
|
@selected = context[:user]&.employee&.id
|
||||||
|
|
||||||
# Generate the drop down list of quickbooks contacts
|
# Generate the drop down list of quickbooks contacts
|
||||||
return "<p>#{context[:form].select :employee_id, Employee.all.pluck(:name, :id), selected: @selected, include_blank: true}</p>"
|
return "<p>#{context[:form].select :employee_id, Employee.all.pluck(:name, :id), selected: @selected, include_blank: true}</p>"
|
||||||
|
|||||||
@@ -260,8 +260,9 @@ module RedmineQbo
|
|||||||
|
|
||||||
# Check to see if there is an estimate attached, then combine them
|
# Check to see if there is an estimate attached, then combine them
|
||||||
if issue.estimate
|
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(pdf.output, allow_optional_content: true)
|
||||||
pdf << CombinePDF.parse(issue.estimate.pdf)
|
pdf << CombinePDF.parse(e_pdf)
|
||||||
return pdf.to_pdf
|
return pdf.to_pdf
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user