Compare commits

..

8 Commits

Author SHA1 Message Date
f0a3b0193c Development mode
Use the QBO sandbox & Display DEVEOMPENT in the plugin name
2025-06-18 08:30:21 -04:00
a531ef4f87 Added hour totals to customer job history 2023-01-14 06:20:41 -05:00
1fae647381 Merge branch 'master' into dev 2022-03-19 05:49:54 -04:00
d1764e2203 Removed Comment 2022-03-19 05:49:18 -04:00
f830881883 Don't need to pass customer, only issue 2022-03-17 06:52:46 -04:00
fb87e8a33a Added hook :show_issue_view_right 2022-03-17 06:45:57 -04:00
8bdec410c4 Fixed render of hook :show_customer_view_right 2022-03-17 06:12:35 -04:00
dec9eee90b Merge branch 'master' into dev 2022-03-15 12:29:11 -04:00
25 changed files with 232 additions and 338 deletions

View File

@@ -1,7 +1,7 @@
source 'https://rubygems.org' source 'https://rubygems.org'
gem 'quickbooks-ruby' gem 'quickbooks-ruby'
gem 'oauth2' gem 'oauth2', '1.4.7'
gem 'roxml' gem 'roxml'
gem 'will_paginate' gem 'will_paginate'
gem 'rails-jquery-autocomplete' gem 'rails-jquery-autocomplete'

View File

@@ -1,6 +1,6 @@
The MIT License (MIT) The MIT License (MIT)
Copyright (c) 2016 - 2023 Rick Barrette Copyright (c) 2016 - 2022 Rick Barrette
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

View File

@@ -8,10 +8,7 @@ The goal of this project is to allow Redmine to connect with Quickbooks Online t
Note: Although the core functionality is complete, this project is still under development & the master branch may be unstable. Tags should be stable and are recommended Note: Although the core functionality is complete, this project is still under development & the master branch may be unstable. Tags should be stable and are recommended
Use tags for the following Redmine Versions Use tags Version 1.0.0+ for Redmine 4+ and Version 0.8.1 for Redine 3
* Version 2.0.0+ for Redmine 5+
* Version 1.0.0+ for Redmine 4+
* Version 0.8.1 for Redine 3
#### Features #### Features
* Issues can be assigned to a Customer via drop down in the edit Issue form * Issues can be assigned to a Customer via drop down in the edit Issue form

View File

@@ -36,7 +36,7 @@ class CustomersController < ApplicationController
autocomplete :customer, :name, :full => true, :extra_data => [:id] autocomplete :customer, :name, :full => true, :extra_data => [:id]
def allowed_params def allowed_params
params.require(:customer).permit(:name, :email, :primary_phone, :mobile_phone, :phone_number, :notes) params.require(:customer).permit(:name, :email, :primary_phone, :mobile_phone, :phone_number)
end end
# getter method for a customer's invoices # getter method for a customer's invoices
@@ -108,7 +108,7 @@ class CustomersController < ApplicationController
def update def update
begin begin
@customer = Customer.find_by_id(params[:id]) @customer = Customer.find_by_id(params[:id])
if @customer.update(allowed_params) if @customer.update_attributes(allowed_params)
flash[:notice] = "Customer updated" flash[:notice] = "Customer updated"
redirect_to @customer redirect_to @customer
else else
@@ -211,14 +211,14 @@ class CustomersController < ApplicationController
# format a quickbooks address to a human readable string # format a quickbooks address to a human readable string
def address_to_s (address) def address_to_s (address)
return if address.nil? return if address.nil?
string = address.line1 if address.line1 string = address.line1
string << "\n" + address.line2 if address.line2 string << "\n" + address.line2 if address.line2
string << "\n" + address.line3 if address.line3 string << "\n" + address.line3 if address.line3
string << "\n" + address.line4 if address.line4 string << "\n" + address.line4 if address.line4
string << "\n" + address.line5 if address.line5 string << "\n" + address.line5 if address.line5
string << " " + address.city if address.city string << " " + address.city
string << ", " + address.country_sub_division_code if address.country_sub_division_code string << ", " + address.country_sub_division_code
string << " " + address.postal_code if address.postal_code string << " " + address.postal_code
return string return string
end end

View File

@@ -1,6 +1,6 @@
#The MIT License (MIT) #The MIT License (MIT)
# #
#Copyright (c) 2023 rick barrette #Copyright (c) 2022 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: #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:
# #
@@ -20,13 +20,10 @@ class InvoiceController < ApplicationController
# #
def show def show
begin begin
qbo = Qbo.first base = Invoice.get_base
qbo.perform_authenticated_request do |access_token| invoice = base.fetch_by_id(params[:id])
service = Quickbooks::Service::Invoice.new(:company_id => qbo.realm_id, :access_token => access_token) @pdf = base.pdf(invoice)
invoice = service.fetch_by_id(params[:id]) send_data @pdf, filename: "invoice #{invoice.doc_number}.pdf", :disposition => 'inline', :type => "application/pdf"
@pdf = service.pdf(invoice)
send_data @pdf, filename: "invoice #{invoice.doc_number}.pdf", :disposition => 'inline', :type => "application/pdf"
end
rescue rescue
redirect_to :back, :flash => { :error => "Invoice not found" } redirect_to :back, :flash => { :error => "Invoice not found" }
end end

View File

@@ -1,6 +1,6 @@
#The MIT License (MIT) #The MIT License (MIT)
# #
#Copyright (c) 2023 rick barrette #Copyright (c) 2022 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: #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:
# #
@@ -26,7 +26,7 @@ class QboController < ApplicationController
# Called when the user requests that Redmine to connect to QBO # Called when the user requests that Redmine to connect to QBO
# #
def authenticate def authenticate
oauth2_client = Qbo.construct_oauth2_client oauth2_client = Qbo.get_client
callback = Setting.host_name + "/qbo/oauth_callback/" callback = Setting.host_name + "/qbo/oauth_callback/"
grant_url = oauth2_client.auth_code.authorize_url(redirect_uri: callback, response_type: "code", state: SecureRandom.hex(12), scope: "com.intuit.quickbooks.accounting") grant_url = oauth2_client.auth_code.authorize_url(redirect_uri: callback, response_type: "code", state: SecureRandom.hex(12), scope: "com.intuit.quickbooks.accounting")
redirect_to grant_url redirect_to grant_url
@@ -37,7 +37,7 @@ class QboController < ApplicationController
# #
def oauth_callback def oauth_callback
if params[:state].present? if params[:state].present?
oauth2_client = Qbo.construct_oauth2_client oauth2_client = Qbo.get_client
# use the state value to retrieve from your backend any information you need to identify the customer in your system # use the state value to retrieve from your backend any information you need to identify the customer in your system
redirect_uri = Setting.host_name + "/qbo/oauth_callback/" redirect_uri = Setting.host_name + "/qbo/oauth_callback/"
if resp = oauth2_client.auth_code.get_token(params[:code], redirect_uri: redirect_uri) if resp = oauth2_client.auth_code.get_token(params[:code], redirect_uri: redirect_uri)
@@ -47,8 +47,12 @@ class QboController < ApplicationController
# Save the authentication information # Save the authentication information
qbo = Qbo.new qbo = Qbo.new
qbo.update(oauth2_access_token: resp.token, oauth2_refresh_token: resp.refresh_token, realm_id: params[:realmId]) qbo.company_id = params[:realmId]
qbo.refresh_token!
# Generate Access Token & Serialize it into the database
access_token = OAuth2::AccessToken.new(oauth2_client, resp.token, refresh_token: resp.refresh_token)
qbo.token = access_token.to_hash
qbo.expire = 1.hour.from_now.utc
if qbo.save! if qbo.save!
redirect_to qbo_sync_path, :flash => { :notice => "Successfully connected to Quickbooks" } redirect_to qbo_sync_path, :flash => { :notice => "Successfully connected to Quickbooks" }
@@ -141,6 +145,7 @@ class QboController < ApplicationController
if Qbo.exists? if Qbo.exists?
Customer.sync Customer.sync
Invoice.sync Invoice.sync
QboItem.sync
Employee.sync Employee.sync
Estimate.sync Estimate.sync
@@ -150,6 +155,6 @@ class QboController < ApplicationController
ActiveRecord::Base.connection.close ActiveRecord::Base.connection.close
end end
redirect_to :home, :flash => { :notice => "Syncing Quickbooks" } redirect_to :home, :flash => { :notice => "Successfully synced to Quickbooks" }
end end
end end

View File

@@ -13,7 +13,7 @@ module AuthHelper
def require_user def require_user
return unless session[:token].nil? return unless session[:token].nil?
if !User.current.logged? if !User.current.logged?
render_403 render :file => "public/401.html.erb", :status => :unauthorized, :layout =>true
end end
end end
@@ -27,14 +27,14 @@ module AuthHelper
def check_permission(permission) def check_permission(permission)
if !allowed_to?(permission) if !allowed_to?(permission)
render_403 render :file => "public/401.html.erb", :status => :unauthorized, :layout =>true
end end
end end
def global_check_permission(permission) def global_check_permission(permission)
if !globaly_allowed_to?(permission) if !globaly_allowed_to?(permission)
render_403 render :file => "public/401.html.erb", :status => :unauthorized, :layout =>true
end end
end end

View File

@@ -1,80 +0,0 @@
#The MIT License (MIT)
#
#Copyright (c) 2023 rick barrette
#
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
#
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
#
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
module QuickbooksOauth
extend ActiveSupport::Concern
OAUTH_CONSUMER_KEY = Setting.plugin_redmine_qbo['settingsOAuthConsumerKey']
OAUTH_CONSUMER_SECRET = Setting.plugin_redmine_qbo['settingsOAuthConsumerSecret']
#== Instance Methods
def perform_authenticated_request(&block)
attempts = 0
begin
yield oauth_access_token
rescue OAuth2::Error, Quickbooks::AuthorizationFailure => ex
Rails.logger.info("QuickbooksOauth.perform: #{ex.message}")
# to prevent an infinite loop here keep a counter and bail out after N times...
attempts += 1
raise "QuickbooksOauth:ExceededAuthAttempts" if attempts >= 3
# check if its an invalid_grant first, but assume it is for now
refresh_token!
retry
end
end
def refresh_token!
t = oauth_access_token
refreshed = t.refresh!
if refreshed.params['x_refresh_token_expires_in'].to_i > 0
oauth2_refresh_token_expires_at = Time.now + refreshed.params['x_refresh_token_expires_in'].to_i.seconds
else
oauth2_refresh_token_expires_at = 100.days.from_now
end
update!(
oauth2_access_token: refreshed.token,
oauth2_access_token_expires_at: Time.at(refreshed.expires_at),
oauth2_refresh_token: refreshed.refresh_token,
oauth2_refresh_token_expires_at: oauth2_refresh_token_expires_at
)
end
def oauth_client
self.class.construct_oauth2_client
end
def oauth_access_token
OAuth2::AccessToken.new(oauth_client, oauth2_access_token, refresh_token: oauth2_refresh_token)
end
def consumer
oauth_access_token
end
module ClassMethods
def construct_oauth2_client
options = {
site: "https://appcenter.intuit.com/connect/oauth2",
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)
end
end
end

View File

@@ -1,6 +1,6 @@
#The MIT License (MIT) #The MIT License (MIT)
# #
#Copyright (c) 2023 rick barrette #Copyright (c) 2022 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: #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:
# #
@@ -22,7 +22,7 @@ class Customer < ActiveRecord::Base
# 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?}" return name
end end
# Convenience Method # Convenience Method
@@ -87,13 +87,6 @@ class Customer < ActiveRecord::Base
update_mobile_phone_number 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 # update the localy stored phone number as a plain string with no special chars
def update_phone_number def update_phone_number
begin begin
@@ -141,26 +134,28 @@ class Customer < ActiveRecord::Base
# proforms a bruteforce sync operation # proforms a bruteforce sync operation
# This needs to be simplified # This needs to be simplified
def self.sync def self.sync
service = Qbo.get_base(:customer)
# Sync ALL customers if the database is empty # Sync ALL customers if the database is empty
qbo = Qbo.first #if count == 0
customers = qbo.perform_authenticated_request do |access_token| customers = service.all
service = Quickbooks::Service::Customer.new(:company_id => qbo.realm_id, :access_token => access_token) #else
service.all # last = Qbo.first.last_sync
end # query = "Select Id, DisplayName From Customer"
# query << " Where Metadata.LastUpdatedTime >= '#{last.iso8601}' " if last
# customers = service.query(query)
#end
return unless customers customers.each do |customer|
customer = Customer.find_or_create_by(id: customer.id)
customers.each do |c| if customer.active?
logger.info "Processing customer #{c.id}" if not customer.name.eql? customer.display_name
customer = Customer.find_or_create_by(id: c.id) customer.name = customer.display_name
if c.active? customer.id = customer.id
if not customer.name.eql? c.display_name
customer.name = c.display_name
customer.id = c.id
customer.save_without_push customer.save_without_push
end end
else else
if not c.new_record? if not customer.new_record?
customer.delete customer.delete
end end
end end
@@ -176,14 +171,9 @@ class Customer < ActiveRecord::Base
# proforms a bruteforce sync operation # proforms a bruteforce sync operation
# This needs to be simplified # This needs to be simplified
def self.sync_by_id(id) def self.sync_by_id(id)
qbo = Qbo.first service = Qbo.get_base(:customer)
customer = 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(id)
end
return unless customer
customer = service.fetch_by_id(id)
customer = Customer.find_or_create_by(id: customer.id) customer = Customer.find_or_create_by(id: customer.id)
if customer.active? if customer.active?
if not customer.name.eql? customer.display_name if not customer.name.eql? customer.display_name
@@ -201,11 +191,7 @@ class Customer < ActiveRecord::Base
# Push the updates # Push the updates
def save_with_push def save_with_push
begin begin
qbo = Qbo.first @details = Qbo.get_base(:customer).update(@details)
@details = qbo.perform_authenticated_request do |access_token|
service = Quickbooks::Service::Customer.new(:company_id => qbo.realm_id, :access_token => access_token)
serivce.update(@details)
end
#raise "QBO Fault" if @details.fault? #raise "QBO Fault" if @details.fault?
self.id = @details.id self.id = @details.id
rescue Exception => e rescue Exception => e
@@ -223,11 +209,7 @@ class Customer < ActiveRecord::Base
def pull def pull
begin begin
raise Exception unless self.id raise Exception unless self.id
qbo = Qbo.first @details = Qbo.get_base(:customer).fetch_by_id(self.id)
@details = 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(self.id)
end
rescue Exception => e rescue Exception => e
@details = Quickbooks::Model::Customer.new @details = Quickbooks::Model::Customer.new
end end

View File

@@ -1,6 +1,6 @@
#The MIT License (MIT) #The MIT License (MIT)
# #
#Copyright (c) 2023 rick barrette #Copyright (c) 2022 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: #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:
# #
@@ -13,35 +13,26 @@ class Employee < ActiveRecord::Base
has_many :users has_many :users
validates_presence_of :id, :name validates_presence_of :id, :name
def self.sync def self.get_base
qbo = Qbo.first Qbo.get_base(:employee)
employees = qbo.perform_authenticated_request do |access_token| end
service = Quickbooks::Service::Employee.new(:company_id => qbo.realm_id, :access_token => access_token)
service.all
end
return unless employees def self.sync
employees = get_base.all
transaction do transaction do
# Update the item table # Update the item table
employees.each { |e| employees.each { |employee|
logger.info "Processing employee #{e.id}" employee = find_or_create_by(id: employee.id)
employee = find_or_create_by(id: e.id) employee.name = employee.display_name
employee.name = e.display_name employee.id = employee.id
employee.id = e.id
employee.save! employee.save!
} }
end end
end end
def self.sync_by_id(id) def self.sync_by_id(id)
qbo = Qbo.first employee = get_base.fetch_by_id(id)
employee = qbo.perform_authenticated_request do |access_token|
service = Quickbooks::Service::Employee.new(:company_id => qbo.realm_id, :access_token => access_token)
service.fetch_by_id(id)
end
return unless employee
employee = find_or_create_by(id: employee.id) employee = find_or_create_by(id: employee.id)
employee.name = employee.display_name employee.name = employee.display_name
employee.id = employee.id employee.id = employee.id

View File

@@ -1,6 +1,6 @@
#The MIT License (MIT) #The MIT License (MIT)
# #
#Copyright (c) 2023 rick barrette #Copyright (c) 2022 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: #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:
# #
@@ -16,17 +16,15 @@ class Estimate < ActiveRecord::Base
validates_presence_of :doc_number, :id validates_presence_of :doc_number, :id
self.primary_key = :id self.primary_key = :id
# return the QBO Estimate service
def self.get_base
Qbo.get_base(:estimate)
end
# sync all estimates # sync all estimates
def self.sync def self.sync
logger.debug "Syncing ALL estimates" logger.debug "Syncing ALL estimates"
qbo = Qbo.first estimates = get_base.all
estimates = qbo.perform_authenticated_request do |access_token|
service = Quickbooks::Service::Estimate.new(:company_id => qbo.realm_id, :access_token => access_token)
service.all
end
return unless estimates
estimates.each { |estimate| estimates.each { |estimate|
process_estimate(estimate) process_estimate(estimate)
} }
@@ -38,49 +36,35 @@ class Estimate < ActiveRecord::Base
# sync only one estimate # sync only one estimate
def self.sync_by_id(id) def self.sync_by_id(id)
logger.debug "Syncing estimate #{id}" logger.debug "Syncing estimate #{id}"
qbo = Qbo.first process_estimate(get_base.fetch_by_id(id))
qbo.perform_authenticated_request do |access_token|
service = Quickbooks::Service::Estimate.new(:company_id => qbo.realm_id, :access_token => access_token)
process_estimate(service.fetch_by_id(id))
end
end end
# update an estimate # update an estimate
def self.update(id) def self.update(id)
# Update the item table # Update the item table
qbo = Qbo.first estimate = get_base.fetch_by_id(id)
estimate = qbo.perform_authenticated_request do |access_token| estimate = find_or_create_by(id: id)
service = Quickbooks::Service::Estimate.new(:company_id => qbo.realm_id, :access_token => access_token) estimate.doc_number = estimate.doc_number
service.fetch_by_id(id) estimate.txn_date = estimate.txn_date
end estimate.save!
return unless estimate
e = find_or_create_by(id: id)
e.doc_number = estimate.doc_number
e.txn_date = estimate.txn_date
e.save!
end end
# process an estimate into the database # process an estimate into the database
def self.process_estimate(qbo_estimate) def self.process_estimate(estimate)
logger.info "Processing estimate #{qbo_estimate.id}" logger.info "Processing estimate #{estimate.id}"
estimate = find_or_create_by(id: qbo_estimate.id) estimate = find_or_create_by(id: estimate.id)
estimate.doc_number = qbo_estimate.doc_number estimate.doc_number = estimate.doc_number
estimate.customer_id = qbo_estimate.customer_ref.value estimate.customer_id = estimate.customer_ref.value
estimate.id = qbo_estimate.id estimate.id = estimate.id
estimate.txn_date = qbo_estimate.txn_date estimate.txn_date = estimate.txn_date
estimate.save! estimate.save!
end end
# download the pdf from quickbooks # download the pdf from quickbooks
def pdf def pdf
qbo = Qbo.first base = Estimate.get_base
qbo.perform_authenticated_request do |access_token| estimate = base.fetch_by_id(id)
service = Quickbooks::Service::Estimate.new(:company_id => qbo.realm_id, :access_token => access_token) return base.pdf(estimate)
estimate = service.fetch_by_id(id)
service.pdf(estimate)
end
end end
# Magic Method # Magic Method
@@ -107,11 +91,7 @@ class Estimate < ActiveRecord::Base
def pull def pull
begin begin
raise Exception unless self.id raise Exception unless self.id
qbo = Qbo.first @details = Qbo.get_base(:estimate).fetch_by_id(self.id)
@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 rescue Exception => e
@details = Quickbooks::Model::Estimate.new @details = Quickbooks::Model::Estimate.new
end end

View File

@@ -1,6 +1,6 @@
#The MIT License (MIT) #The MIT License (MIT)
# #
#Copyright (c) 2023 rick barrette #Copyright (c) 2022 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: #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:
# #
@@ -15,6 +15,11 @@ class Invoice < ActiveRecord::Base
validates_presence_of :doc_number, :id, :customer_id, :txn_date validates_presence_of :doc_number, :id, :customer_id, :txn_date
self.primary_key = :id self.primary_key = :id
# Get the quickbooks-ruby base for invoice
def self.get_base
Qbo.get_base(:invoice)
end
# sync ALL the invoices # sync ALL the invoices
def self.sync def self.sync
logger.debug "Syncing all invoices" logger.debug "Syncing all invoices"
@@ -25,14 +30,12 @@ class Invoice < ActiveRecord::Base
# TODO actually do something with the above query # TODO actually do something with the above query
# .all() is never called since count is never initialized # .all() is never called since count is never initialized
qbo = Qbo.first if count == 0
invoices = qbo.perform_authenticated_request do |access_token| invoices = get_base.all
service = Quickbooks::Service::Invoice.new(:company_id => qbo.realm_id, :access_token => access_token) else
service.all invoices = get_base.query()
end end
return unless invoices
invoices.each { | invoice | invoices.each { | invoice |
process_invoice invoice process_invoice invoice
} }
@@ -41,12 +44,8 @@ class Invoice < ActiveRecord::Base
#sync by invoice ID #sync by invoice ID
def self.sync_by_id(id) def self.sync_by_id(id)
logger.debug "Syncing invoice #{id}" logger.debug "Syncing invoice #{id}"
qbo = Qbo.first invoice = get_base.fetch_by_id(id)
qbo.perform_authenticated_request do |access_token| process_invoice invoice
service = Quickbooks::Service::Invoice.new(:company_id => qbo.realm_id, :access_token => access_token)
invoice = service.fetch_by_id(id)
process_invoice invoice
end
end end
private private
@@ -141,11 +140,7 @@ class Invoice < ActiveRecord::Base
# Push updates # Push updates
begin begin
logger.debug "Trying to update invoice" logger.debug "Trying to update invoice"
qbo = Qbo.first get_base.update(invoice) if is_changed
qbo.perform_authenticated_request do |access_token|
service = Quickbooks::Service::Invoice.new(:company_id => qbo.realm_id, :access_token => access_token)
service.update(invoice) if is_changed
end
rescue rescue
# Do nothing, probaly custome field sync confict on the invoice. # Do nothing, probaly custome field sync confict on the invoice.
# This is a problem with how it's billed # This is a problem with how it's billed
@@ -177,11 +172,7 @@ class Invoice < ActiveRecord::Base
def pull def pull
begin begin
raise Exception unless self.id raise Exception unless self.id
qbo = Qbo.first @details = Qbo.get_base(:invoice).fetch_by_id(self.id)
@details = qbo.perform_authenticated_request do |access_token|
service = Quickbooks::Service::Invoice.new(:company_id => qbo.realm_id, :access_token => access_token)
service.fetch_by_id(self.id)
end
rescue Exception => e rescue Exception => e
@details = Quickbooks::Model::Invoice.new @details = Quickbooks::Model::Invoice.new
end end

View File

@@ -1,6 +1,6 @@
#The MIT License (MIT) #The MIT License (MIT)
# #
#Copyright (c) 2023 rick barrette #Copyright (c) 2022 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: #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:
# #
@@ -10,15 +10,85 @@
class Qbo < ActiveRecord::Base class Qbo < ActiveRecord::Base
unloadable unloadable
validates_presence_of :token, :company_id, :expire
serialize :token
include QuickbooksOauth OAUTH_CONSUMER_KEY = Setting.plugin_redmine_qbo['settingsOAuthConsumerKey']
OAUTH_CONSUMER_SECRET = Setting.plugin_redmine_qbo['settingsOAuthConsumerSecret']
#
# Getter for quickbooks OAuth2 client
#
def self.get_client
oauth_params = {
site: "https://appcenter.intuit.com/connect/oauth2",
authorize_url: "https://appcenter.intuit.com/connect/oauth2",
token_url: "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer"
}
return OAuth2::Client.new(OAUTH_CONSUMER_KEY, OAUTH_CONSUMER_SECRET, oauth_params)
end
#
# Getter for oauth consumer
#
def self.get_oauth_consumer
# Quickbooks Config Info
return $qb_oauth_consumer
end
#
# Get a quickbooks base service object for type
# @params type of base
#
def self.get_base(type)
# lets getnourbold access token from the database
oauth2_client = get_client
qbo = self.first
access_token = OAuth2::AccessToken.from_hash(oauth2_client, qbo.token)
# check to see if we need to refresh the acesstoken
if qbo.expire.to_time.utc.past?
puts "Updating access token"
new_access_token_object = access_token.refresh!
qbo.token = new_access_token_object.to_hash
qbo.expire = 1.hour.from_now.utc
qbo.save!
access_token = new_access_token_object
else
puts "Using current token"
end
# build the reqiested service
case type
when :item
return Quickbooks::Service::Item.new(:company_id => qbo.company_id, :access_token => access_token)
when :time_activity
return Quickbooks::Service::TimeActivity.new(:company_id => qbo.company_id, :access_token => access_token)
when :customer
return Quickbooks::Service::Customer.new(:company_id => qbo.company_id, :access_token => access_token)
when :invoice
return Quickbooks::Service::Invoice.new(:company_id => qbo.company_id, :access_token => access_token)
when :estimate
return Quickbooks::Service::Estimate.new(:company_id => qbo.company_id, :access_token => access_token)
when :account
return Quickbooks::Service::Account.new(:company_id => qbo.company_id, :access_token => access_token)
when :employee
return Quickbooks::Service::Employee.new(:company_id => qbo.company_id, :access_token => access_token)
else
return access_token
end
end
# Get the QBO account
def self.get_account
first
end
# Updates last sync time stamp # Updates last sync time stamp
def self.update_time_stamp def self.update_time_stamp
date = DateTime.now
logger.info "Updating QBO timestamp to #{date}"
qbo = Qbo.first qbo = Qbo.first
qbo.last_sync = date qbo.last_sync = DateTime.now
qbo.save qbo.save
end end

View File

@@ -24,7 +24,7 @@
</div> </div>
<div class="splitcontentleft"> <div class="splitcontentleft">
<% call_hook :show_customer_view_right %> <%= call_hook :show_customer_view_right, {customer: @customer} %>
</div> </div>
</div> </div>

View File

@@ -8,8 +8,3 @@
<p> <p>
<%= select_estimate %> <%= select_estimate %>
</p> </p>
<%# <p> %>
<%# <%= call_hook here %> %>
<%# </p> %>

View File

@@ -17,6 +17,6 @@
</div> </div>
<div class="splitcontentleft"> <div class="splitcontentleft">
<%# call_hook here %> <%= call_hook :show_issue_view_right, {issue: issue} %>
</div> </div>
</div> </div>

View File

@@ -0,0 +1 @@
<%= flash.now[:error] = t(:label_401) %>

View File

@@ -58,13 +58,8 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
</tr> </tr>
<tr> <tr>
<th><%=t(:label_oauth_expires)%></th> <th><%=t(:label_oauth_expires)%></th>
<td><%= if Qbo.exists? then Qbo.first.oauth2_access_token_expires_at end %> <td><%= if Qbo.exists? then Qbo.first.expire end %>
</tr>
<tr>
<th><%=t(:label_oauth2_refresh_token_expires_at)%></th>
<td><%= if Qbo.exists? then Qbo.first.oauth2_refresh_token_expires_at end %>
</tr> </tr>
</tbody> </tbody>

View File

@@ -22,6 +22,7 @@ en:
label_search_estimates: "Search Estimates" label_search_estimates: "Search Estimates"
label_search: "Search" label_search: "Search"
label_estimates: "Estimates" label_estimates: "Estimates"
label_401: "Not Authorized"
warn_ru_sure: "You sure?" warn_ru_sure: "You sure?"
label_delete: "Delete" label_delete: "Delete"
label_edit: "Edit" label_edit: "Edit"
@@ -79,5 +80,4 @@ en:
label_billing_error: "Cannot bill without a customer assigned" label_billing_error: "Cannot bill without a customer assigned"
label_qbo_sync_success: "Successfully synced to Quickbooks" label_qbo_sync_success: "Successfully synced to Quickbooks"
label_hours: "Hours" label_hours: "Hours"
label_oauth2_refresh_token_expires_at: "Refresh Token Expires At"

View File

@@ -1,6 +1,6 @@
#The MIT License (MIT) #The MIT License (MIT)
# #
#Copyright (c) 2023 rick barrette #Copyright (c) 2022 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: #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:
# #
@@ -26,13 +26,7 @@ class AddTxnDates < ActiveRecord::Migration[5.1]
say "Sync Invoices" say "Sync Invoices"
qbo = Qbo.first invoices = QboInvoice.get_base.all
invoices = qbo.perform_authenticated_request do |access_token|
service = Quickbooks::Service::Invoice.new(:company_id => qbo.realm_id, :access_token => access_token)
service.all
end
return unless invoices
invoices.each { |invoice| invoices.each { |invoice|
# Load the invoice into the database # Load the invoice into the database

View File

@@ -1,22 +0,0 @@
#The MIT License (MIT)
#
#Copyright (c) 2023 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 UpdateQboToken < ActiveRecord::Migration[5.1]
def change
add_column :qbos, :oauth2_access_token, :text
add_column :qbos, :oauth2_access_token_expires_at, :datetime
add_column :qbos, :oauth2_refresh_token, :text
add_column :qbos, :oauth2_refresh_token_expires_at, :datetime
add_column :qbos, :realm_id, :text
remove_column :qbos, :company_id
remove_column :qbos, :token
remove_column :qbos, :expire
end
end

14
init.rb
View File

@@ -1,6 +1,6 @@
#The MIT License (MIT) #The MIT License (MIT)
# #
#Copyright (c) 2023 rick barrette #Copyright (c) 2022 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: #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:
# #
@@ -19,14 +19,14 @@ end
Redmine::Plugin.register :redmine_qbo do Redmine::Plugin.register :redmine_qbo do
# About # About
name 'Redmine Quickbooks Online plugin' name 'Redmine QBO DEVELOPMENT plugin'
author 'Rick Barrette' author 'Rick Barrette'
description 'This is a plugin for Redmine to intergrate with Quickbooks Online to allow for seamless intergration CRM and invoicing of completed issues' description 'This is a plugin for Redmine to integrate with QuickBooks Online to allow for seamless integration CRM and invoicing of completed issues'
version '2.0.2' version '1.1.6'
url 'https://github.com/rickbarrette/redmine_qbo' url 'https://github.com/rickbarrette/redmine_qbo'
author_url 'https://barrettefabrication.com' author_url 'http://rickbarrette.org'
settings :default => {'empty' => true}, :partial => 'qbo/settings' settings :default => {'empty' => true}, :partial => 'qbo/settings'
requires_redmine :version_or_higher => '5.1.0' requires_redmine :version_or_higher => '6.0.0'
# Add safe attributes for core models # Add safe attributes for core models
Issue.safe_attributes 'customer_id' Issue.safe_attributes 'customer_id'
@@ -38,7 +38,7 @@ Redmine::Plugin.register :redmine_qbo do
Project.safe_attributes 'customer_id' Project.safe_attributes 'customer_id'
# We are playing in the sandbox # We are playing in the sandbox
#Quickbooks.sandbox_mode = true Quickbooks.sandbox_mode = true
# set per_page globally # set per_page globally
WillPaginate.per_page = 20 WillPaginate.per_page = 20

View File

@@ -1,6 +1,6 @@
#The MIT License (MIT) #The MIT License (MIT)
# #
#Copyright (c) 2023 rick barrette #Copyright (c) 2022 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: #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:
# #
@@ -51,49 +51,46 @@ module IssuePatch
if spent_hours > 0 then if spent_hours > 0 then
# Prepare to create a new Time Activity # Prepare to create a new Time Activity
qbo = Qbo.first time_service = Qbo.get_base(:time_activity)
qbo.perform_authenticated_request do |access_token| item_service = Qbo.get_base(:item)
time_service = Quickbooks::Service::TimeActivity.new(:company_id => qbo.realm_id, :access_token => access_token) time_entry = Quickbooks::Model::TimeActivity.new
item_service = Quickbooks::Service::Item.new(:company_id => qbo.realm_id, :access_token => access_token)
time_entry = Quickbooks::Model::TimeActivity.new
# Lets total up each activity before billing. # Lets total up each activity before billing.
# This will simpify the invoicing with a single billable time entry per time activity # This will simpify the invoicing with a single billable time entry per time activity
h = Hash.new(0) h = Hash.new(0)
spent_time.each do |entry| spent_time.each do |entry|
h[entry.activity.name] += entry.hours h[entry.activity.name] += entry.hours
# update time entries billed status # update time entries billed status
entry.billed = true entry.billed = true
entry.save entry.save
end end
# Now letes upload our totals for each activity as their own billable time entry # Now letes upload our totals for each activity as their own billable time entry
h.each do |key, val| h.each do |key, val|
# Convert float spent time to hours and minutes # Convert float spent time to hours and minutes
hours = val.to_i hours = val.to_i
minutesDecimal = (( val - hours) * 60) minutesDecimal = (( val - hours) * 60)
minutes = minutesDecimal.to_i minutes = minutesDecimal.to_i
# Lets match the activity to an qbo item # Lets match the activity to an qbo item
item = item_service.query("SELECT * FROM Item WHERE Name = '#{key}' ").first item = item_service.query("SELECT * FROM Item WHERE Name = '#{key}' ").first
next if item.nil? next if item.nil?
# Create the new billable time entry and upload it # Create the new billable time entry and upload it
time_entry.description = "#{tracker} ##{id}: #{subject} #{"(Partial @ #{done_ratio}%)" if not closed?}" time_entry.description = "#{tracker} ##{id}: #{subject} #{"(Partial @ #{done_ratio}%)" if not closed?}"
time_entry.employee_id = assigned_to.employee_id time_entry.employee_id = assigned_to.employee_id
time_entry.customer_id = customer_id time_entry.customer_id = customer_id
time_entry.billable_status = "Billable" time_entry.billable_status = "Billable"
time_entry.hours = hours time_entry.hours = hours
time_entry.minutes = minutes time_entry.minutes = minutes
time_entry.name_of = "Employee" time_entry.name_of = "Employee"
time_entry.txn_date = Date.today time_entry.txn_date = Date.today
time_entry.hourly_rate = item.unit_price time_entry.hourly_rate = item.unit_price
time_entry.item_id = item.id time_entry.item_id = item.id
time_entry.start_time = start_date time_entry.start_time = start_date
time_entry.end_time = Time.now time_entry.end_time = Time.now
time_service.create(time_entry) time_service.create(time_entry)
end
end end
end end
end end

View File

@@ -39,6 +39,7 @@ class IssuesShowHookListener < Redmine::Hook::ViewListener
context[:controller].send(:render_to_string, { context[:controller].send(:render_to_string, {
:partial => 'issues/show_details', :partial => 'issues/show_details',
locals: { locals: {
issue: issue,
customer: customer, customer: customer,
estimate_link: estimate_link, estimate_link: estimate_link,
invoice_link: invoice_link invoice_link: invoice_link

View File

@@ -1,6 +1,6 @@
#The MIT License (MIT) #The MIT License (MIT)
# #
#Copyright (c) 2023 rick barrette #Copyright (c) 2022 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: #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:
# #
@@ -11,7 +11,7 @@
require_dependency 'redmine/export/pdf' require_dependency 'redmine/export/pdf'
require_dependency 'redmine/export/pdf/issues_pdf_helper' require_dependency 'redmine/export/pdf/issues_pdf_helper'
module PdfPatch module IssuesPdfHelperPatch
def self.included(base) def self.included(base)
base.send(:include, InstanceMethods) base.send(:include, InstanceMethods)
@@ -253,4 +253,4 @@ module PdfPatch
end end
end end
Redmine::Export::PDF::IssuesPdfHelper.send(:include, PdfPatch) Redmine::Export::PDF::IssuesPdfHelper.send(:include, IssuesPdfHelperPatch)