Compare commits
133 Commits
2026.2.4
...
40f7a3335c
| Author | SHA1 | Date | |
|---|---|---|---|
| 40f7a3335c | |||
| da0f7ffc56 | |||
| 4fa8be856a | |||
| ffd8dc6332 | |||
| cd219a0c00 | |||
| cd88ce6217 | |||
| b10665355d | |||
| 17ac19e435 | |||
| ef5089438c | |||
| 1f64e36892 | |||
| 643b15391b | |||
| d8a26f98c0 | |||
| 8fc01cd8fb | |||
| fe3da8c452 | |||
| c4c02f8d27 | |||
| 00b1baa1f3 | |||
| 2520892e2c | |||
| b96678a2e9 | |||
| bccfcd9dbc | |||
| 8ba99b7db2 | |||
| aff7d0c48e | |||
| e9b3b1c838 | |||
| 2fc2f94cd1 | |||
| 9f9810686f | |||
| f041e1bce4 | |||
| d44d5e2fb7 | |||
| 4403267abb | |||
| be400c2b2a | |||
| 23e565a304 | |||
| 2e2b17fac3 | |||
| 28db5cb8c8 | |||
| 0df15693d2 | |||
| f8b1c72394 | |||
| 899237c5ab | |||
| f02b50ae26 | |||
| 485a977d1a | |||
| 03d5a5d148 | |||
| 0deab9dbd3 | |||
| 899c9878c4 | |||
| b95a3b6623 | |||
| ef3f00c445 | |||
| 46f06df995 | |||
| b15b88f48d | |||
| 7b7b07b5fa | |||
| 16ca1caabc | |||
| 69d266bdca | |||
| 3728ec2a12 | |||
| cefa36c880 | |||
| ed111fefe7 | |||
| 5a662f67b8 | |||
| 6e90548dbb | |||
| f921f227e2 | |||
| a34ae46358 | |||
| e4cfb0674e | |||
| 348c521491 | |||
| 6cee8c1d81 | |||
| d4a0aa1db5 | |||
| 12884a211e | |||
| 4ed71f5667 | |||
| 8303dec501 | |||
| 9b07ae7073 | |||
| baf321d4d6 | |||
| 0a2d38a927 | |||
| b80dbaa015 | |||
| 9e399b934b | |||
| cc6fd07435 | |||
| 7a50df24d9 | |||
| ca02ead9f9 | |||
| 9089adaba0 | |||
| dc6eba8566 | |||
| 19911b7940 | |||
| a80f59cc45 | |||
| eee99e4d83 | |||
| b3f01bd372 | |||
| d1ba93d61a | |||
| 9a688c4841 | |||
| e94352e2c4 | |||
| ea0f42b68e | |||
| 5a31c194a5 | |||
| 6f8af9bba8 | |||
| 03109d5775 | |||
| a1cbf9a0a9 | |||
| 9c0f153518 | |||
| f32b48296d | |||
| 3d37f01bff | |||
| 889e9bf31f | |||
| 208e839e6a | |||
| 4f55751500 | |||
| a64016eb95 | |||
| 5d858ae186 | |||
| b38f850df3 | |||
| 138e55933b | |||
| 5fbc169ade | |||
| d6737a6747 | |||
| 65db8f00a8 | |||
| 0197dc2a30 | |||
| cd1caa502d | |||
| 4b45d24a75 | |||
| 64a4526aa4 | |||
| 3514401808 | |||
| 3deafd8a6d | |||
| a54de28db5 | |||
| 6434eea906 | |||
| 9b656534ae | |||
| 659a1fbcf0 | |||
| 4dc1f5d0bd | |||
| 02f34582f4 | |||
| 2f9ef6304f | |||
| 886d5f4ace | |||
| 1ade938eb3 | |||
| 3111f391f3 | |||
| d2b9113914 | |||
| 447e048819 | |||
| e7dfc3f2ad | |||
| 139f5dd618 | |||
| 9c11704d03 | |||
| 2ae53adf08 | |||
| 877c1b78a5 | |||
| 1d47703206 | |||
| a069556ed9 | |||
| 359c582e22 | |||
| e63b9e4217 | |||
| 6fd355d8cc | |||
| e6b57392d1 | |||
| 331c1eabeb | |||
| 167385bb99 | |||
| 11b9876d4f | |||
| 9cf72821b0 | |||
| 57adcce431 | |||
| 7fdb15f7e8 | |||
| 6e11e05a24 | |||
| a6751d3f41 | |||
| 8944e92ffc |
316
README.md
@@ -1,14 +1,21 @@
|
||||
# Redmine QuickBooks Online
|
||||
# Redmine QuickBooks Online Plugin
|
||||
|
||||
A plugin for Redmine to connect to QuickBooks Online.
|
||||
A plugin for **Redmine** that integrates with **QuickBooks Online (QBO)** to automatically create **Time Activity entries** from billable hours logged on Issues.
|
||||
|
||||
The goal of this project is to allow Redmine to connect with QuickBooks Online to create Time Activity Entries for billable hours logged when an Issue is closed.
|
||||
When an Issue associated with a Customer is closed, the plugin generates corresponding Time Activities in QuickBooks based on the Redmine Time Entries recorded for that Issue.
|
||||
|
||||
## Disclaimer
|
||||
---
|
||||
|
||||
**Note:** Although the core functionality is complete, this project is still under development and the master branch may be unstable. Tags should be stable and are recommended.
|
||||
# Disclaimer
|
||||
|
||||
## Compatibility
|
||||
The core functionality is implemented, but the project is **under active development**.
|
||||
|
||||
The `master` branch may contain unstable changes.
|
||||
For production deployments, **use a tagged release**.
|
||||
|
||||
---
|
||||
|
||||
# Compatibility
|
||||
|
||||
| Plugin Version | Redmine Version |
|
||||
| :--- | :--- |
|
||||
@@ -17,85 +24,244 @@ The goal of this project is to allow Redmine to connect with QuickBooks Online t
|
||||
| Version 1.0.0+ | Redmine 4 |
|
||||
| Version 0.8.1 | Redmine 3 |
|
||||
|
||||
## Features
|
||||
---
|
||||
|
||||
* **Customer Assignment:** Issues can be assigned to a Customer via a dropdown in the edit Issue form.
|
||||
* Once a customer is attached to an Issue, you can attach an Estimate to the issue via a dropdown menu.
|
||||
* **Employee Mapping:** An Employee is assigned to a Redmine User via a dropdown in the User Administration page.
|
||||
* **Automatic Billing:** If an Issue has been assigned a Customer, the following happens when the Issue is closed:
|
||||
* A new Time Activity will be billed against the Customer assigned to the issue for each Redmine Time Entry.
|
||||
* Time Entries will be totalled up by Activity name. This allows billing for different activities without having to create separate Issues.
|
||||
* The Time Activity names are used to dynamically lookup Items in QuickBooks.
|
||||
* If there are no Items that match the Activity name, it will be skipped and will not be billed to the Customer.
|
||||
* Labor Rates are set by the corresponding Item in QuickBooks.
|
||||
* **Customer Management:** Customers can be created via the New Customer Page.
|
||||
* Customers can be searched by name or phone number.
|
||||
* Basic information for the Customer can be viewed/edited via the Customer page.
|
||||
* **Webhook Support:**
|
||||
* **Invoices:** Automatically attached to an Issue if a line item contains a hashtag number (e.g., `#123`).
|
||||
* **Custom Fields:** Invoice Custom Fields are matched to Issue Custom Fields and are automatically updated in QuickBooks. (Useful for extracting Mileage In/Out from the Issue to update the Invoice).
|
||||
* **Sync:** Customers are automatically updated in the local database.
|
||||
* **Plugin View Hooks** Allows intergration of other features supported by companion plugins, for example [redmine_qbo_vehicles](https://github.com/rickbarrette/redmine_qbo_vehicles) adds customer vehicle interation
|
||||
# Features
|
||||
|
||||
## Prerequisites
|
||||
## Issue Billing Integration
|
||||
|
||||
* Sign up to become a developer for Intuit: https://developer.intuit.com/
|
||||
* Create your own application to obtain your API keys.
|
||||
* Set up the webhook service to `https://redmine.yourdomain.com/qbo/webhook`
|
||||
* Assign a **QuickBooks Customer** to a Redmine Issue.
|
||||
|
||||
## Installation
|
||||
* Optionally associate a **QuickBooks Estimate** with the Issue.
|
||||
|
||||
1. **Clone the plugin:**
|
||||
Clone this repo into your plugin folder and checkout a tagged version.
|
||||
```bash
|
||||
cd path/to/redmine/plugins
|
||||
git clone git@github.com:rickbarrette/redmine_qbo.git
|
||||
cd redmine_qbo
|
||||
git checkout <tag>
|
||||
```
|
||||
|
||||
2. **Install dependencies:** *Crucial for Redmine 6 / Rails 7 compatibility.*
|
||||
|
||||
Bash
|
||||
|
||||
```
|
||||
bundle install
|
||||
```
|
||||
|
||||
3. **Migrate your database:**
|
||||
|
||||
Bash
|
||||
|
||||
```
|
||||
bundle exec rake redmine:plugins:migrate RAILS_ENV=production
|
||||
```
|
||||
|
||||
4. **Restart Redmine:** You must restart your Redmine server instance for the plugin and hooks to load.
|
||||
|
||||
5. **Configuration:**
|
||||
|
||||
* Navigate to the plugin configuration page (`Administration > Plugins > Configure`).
|
||||
|
||||
* Supply your own OAuth Key & Secret.
|
||||
|
||||
* After saving the Key & Secret, click the **Authenticate** link on the configuration page to connect to QBO.
|
||||
|
||||
6. **User Mapping:**
|
||||
|
||||
* Assign an Employee to each of your users via the **User Administration Page**.
|
||||
* Automatically associates a **QuickBooks Invoice** with the Issue.
|
||||
|
||||
|
||||
## Usage
|
||||
---
|
||||
|
||||
To enable automatic Time Activity entries for an Issue, you simply need to assign a Customer to an Issue via the dropdowns in the issue creation/update form.
|
||||
## Automatic Time Activity Creation
|
||||
|
||||
**Note:** After the initial synchronization, this plugin will receive push notifications via Intuit's webhook service.
|
||||
When an Issue with an assigned Customer is closed:
|
||||
|
||||
## Companion Plugin Hooks
|
||||
* :pdf_left, { issue: issue }
|
||||
* :pdf_right, { issue: issue }
|
||||
* :process_invoice_custom_fields, { issue: issue, invoice: invoice }
|
||||
* :show_customer_view_right, {customer: @customer}
|
||||
* A **Time Activity** is created in QuickBooks for each relevant Redmine Time Entry.
|
||||
|
||||
* Time Entries are **grouped by Activity name**.
|
||||
|
||||
* Activity names are used to **dynamically match Items in QuickBooks**.
|
||||
|
||||
* If no matching Item exists, the activity is **skipped**.
|
||||
|
||||
* **Labor rates** are determined by the associated QuickBooks Item.
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Employee Mapping
|
||||
|
||||
Redmine Users can be mapped to **QuickBooks Employees** through the **User Administration** page.
|
||||
|
||||
This ensures Time Activities are recorded under the correct employee in QuickBooks.
|
||||
|
||||
---
|
||||
|
||||
## Customer Management
|
||||
|
||||
The plugin provides basic Customer management:
|
||||
|
||||
* Create Customers directly from Redmine
|
||||
|
||||
* Search Customers by **name or phone number**
|
||||
|
||||
* View and edit Customer information
|
||||
|
||||
|
||||
Customers are synchronized with QuickBooks.
|
||||
|
||||
---
|
||||
|
||||
## Webhook Support
|
||||
|
||||
The plugin listens for **QuickBooks webhook events**.
|
||||
|
||||
Supported automation:
|
||||
|
||||
### Invoice Linking
|
||||
|
||||
Invoices containing an Issue reference (e.g. `#123`) automatically attach to the corresponding Issue.
|
||||
|
||||
### Custom Field Synchronization
|
||||
|
||||
Invoice custom fields can be mapped to Issue custom fields.
|
||||
|
||||
Example use case:
|
||||
|
||||
* Mileage In/Out recorded in Redmine
|
||||
|
||||
* Automatically synchronized to the QuickBooks invoice.
|
||||
|
||||
|
||||
### Customer Synchronization
|
||||
|
||||
Customer records are automatically updated in the local database when changes occur in QuickBooks.
|
||||
|
||||
---
|
||||
|
||||
## Plugin Hooks
|
||||
|
||||
The plugin exposes several hooks for extending functionality through companion plugins.
|
||||
|
||||
Example:
|
||||
|
||||
`redmine_qbo_vehicles`
|
||||
Adds support for tracking **customer vehicles** associated with Issues.
|
||||
|
||||
Available hooks:
|
||||
|
||||
|Type|Hook|Note
|
||||
|--|--|--|
|
||||
View Hook|:pdf_left, { issue: issue } | Used to add text to left side of PDF
|
||||
View Hook|:pdf_right, { issue: issue } | Used to add text to right side of PDF
|
||||
Hook|process_invoice_custom_fields, { issue: issue, invoice: invoice } | Used to process invoice custom fields
|
||||
View Hook|:show_customer_view_right, { customer: customer } | Used to show partials on right side of customer view
|
||||
Hook| :qbo_additional_entities | Used to add additional entites to be processed by the WebhookProcessJob
|
||||
Hook| :qbo_full_sync | Used to add a Class to be called by the QboSyncDispatcher
|
||||
|
||||
---
|
||||
|
||||
# Prerequisites
|
||||
|
||||
Before installing the plugin:
|
||||
|
||||
1. Create a QuickBooks developer account:
|
||||
|
||||
|
||||
[https://developer.intuit.com/](https://developer.intuit.com/)
|
||||
|
||||
2. Create an **Intuit application** to obtain:
|
||||
|
||||
|
||||
* Client ID
|
||||
|
||||
* Client Secret
|
||||
|
||||
|
||||
3. Configure the QuickBooks webhook endpoint:
|
||||
|
||||
|
||||
https://redmine.yourdomain.com/qbo/webhook
|
||||
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
## 1\. Clone the Plugin
|
||||
|
||||
Install the plugin into your Redmine plugins directory.
|
||||
|
||||
```bash
|
||||
cd /path/to/redmine/plugins
|
||||
git clone https://github.com/rickbarrette/redmine_qbo.git
|
||||
cd redmine_qbo
|
||||
git checkout <tag>
|
||||
```
|
||||
|
||||
Use a **tagged release** for stability.
|
||||
|
||||
---
|
||||
|
||||
## 2\. Install Dependencies
|
||||
|
||||
```bash
|
||||
bundle install
|
||||
```
|
||||
|
||||
Required for **Redmine 6 / Rails 7 compatibility**.
|
||||
|
||||
---
|
||||
|
||||
## 3\. Run Database Migrations
|
||||
|
||||
```bash
|
||||
bundle exec rake redmine:plugins:migrate RAILS_ENV=production
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 4\. Restart Redmine
|
||||
|
||||
Restart your Redmine server so the plugin and hooks are loaded.
|
||||
|
||||
---
|
||||
|
||||
# Configuration
|
||||
|
||||
1. Navigate to:
|
||||
|
||||
|
||||
Administration → Plugins → Configure
|
||||
|
||||
2. Enter your **QuickBooks Client ID and Client Secret**.
|
||||
|
||||
3. Save the configuration.
|
||||
|
||||
4. Click **Authenticate** to complete the OAuth connection with QuickBooks Online.
|
||||
|
||||
|
||||
Once authentication succeeds, the plugin performs an **initial synchronization**.
|
||||
|
||||
---
|
||||
|
||||
# User Mapping
|
||||
|
||||
Each Redmine user must be mapped to a QuickBooks Employee.
|
||||
|
||||
Navigate to:
|
||||
|
||||
Administration → Users
|
||||
|
||||
Then assign the corresponding **QuickBooks Employee** to each user.
|
||||
|
||||
---
|
||||
|
||||
# Usage
|
||||
|
||||
To enable automatic billing:
|
||||
|
||||
1. Assign a **Customer** to an Issue.
|
||||
|
||||
2. Log billable time using **Redmine Time Entries**.
|
||||
|
||||
3. Close the Issue.
|
||||
|
||||
|
||||
When the Issue is closed, the plugin automatically generates the corresponding **Time Activity entries in QuickBooks Online**.
|
||||
|
||||
After the initial synchronization, the plugin receives updates through **Intuit webhooks**.
|
||||
|
||||
---
|
||||
|
||||
# Troubleshooting
|
||||
|
||||
### Time Activities Not Created
|
||||
|
||||
Verify that:
|
||||
|
||||
* The Issue has a **Customer assigned**
|
||||
|
||||
* Time Entries exist for the Issue
|
||||
|
||||
* Activity names match **QuickBooks Item names**
|
||||
|
||||
|
||||
---
|
||||
|
||||
### Webhooks Not Triggering
|
||||
|
||||
Ensure the QuickBooks webhook endpoint is reachable:
|
||||
|
||||
https://redmine.yourdomain.com/qbo/webhook
|
||||
|
||||
Also verify webhook configuration in the Intuit developer dashboard.
|
||||
|
||||
## License
|
||||
|
||||
|
||||
BIN
Screenshots/issue.png
Normal file
|
After Width: | Height: | Size: 724 KiB |
BIN
Screenshots/issue_form.png
Normal file
|
After Width: | Height: | Size: 520 KiB |
|
Before Width: | Height: | Size: 346 KiB After Width: | Height: | Size: 672 KiB |
|
Before Width: | Height: | Size: 303 KiB After Width: | Height: | Size: 538 KiB |
|
Before Width: | Height: | Size: 240 KiB |
|
Before Width: | Height: | Size: 512 KiB |
@@ -30,8 +30,6 @@ class CustomersController < ApplicationController
|
||||
before_action :view_customer, except: [:new, :view]
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, only: [:view]
|
||||
|
||||
default_search_scope :names
|
||||
|
||||
autocomplete :customer, :name, full: true, extra_data: [:id]
|
||||
|
||||
def allowed_params
|
||||
@@ -53,7 +51,7 @@ class CustomersController < ApplicationController
|
||||
# display a list of all customers
|
||||
def index
|
||||
if params[:search]
|
||||
@customers = Customer.search(params[:search]).paginate(page: params[:page])
|
||||
@customers = Customer.search(params[:search]).order(:name).paginate(page: params[:page])
|
||||
if only_one_non_zero?(@customers)
|
||||
redirect_to @customers.first
|
||||
end
|
||||
@@ -68,128 +66,125 @@ class CustomersController < ApplicationController
|
||||
# create a new customer
|
||||
def create
|
||||
@customer = Customer.new(allowed_params)
|
||||
if @customer.save
|
||||
flash[:notice] = t :notice_customer_created
|
||||
redirect_to @customer
|
||||
else
|
||||
flash[:error] = @customer.errors.full_messages.to_sentence
|
||||
redirect_to new_customer_path
|
||||
end
|
||||
@customer.save
|
||||
log "Customer ##{@customer.id} created successfully."
|
||||
flash[:notice] = t :notice_customer_created
|
||||
redirect_to @customer
|
||||
rescue => e
|
||||
log "Failed to create customer: #{e.message}"
|
||||
flash[:error] = e.message
|
||||
redirect_to new_customer_path
|
||||
end
|
||||
|
||||
# display a specific customer
|
||||
def show
|
||||
begin
|
||||
@customer = Customer.find_by_id(params[:id])
|
||||
@issues = @customer.issues.order(id: :desc)
|
||||
@billing_address = address_to_s(@customer.billing_address)
|
||||
@shipping_address = address_to_s(@customer.shipping_address)
|
||||
@closed_issues = (@issues - @issues.open)
|
||||
@hours = 0
|
||||
@closed_hours = 0
|
||||
@issues.open.each { |i| @hours+= i.total_spent_hours }
|
||||
@closed_issues.each { |i| @closed_hours+= i.total_spent_hours }
|
||||
rescue
|
||||
flash[:error] = t :notice_customer_not_found
|
||||
render_404
|
||||
end
|
||||
@customer = Customer.find_by_id(params[:id])
|
||||
return render_404 unless @customer
|
||||
|
||||
@open_issues = @customer.issues
|
||||
.joins(:status)
|
||||
.includes(:status, :project, :tracker, :priority)
|
||||
.where(issue_statuses: { is_closed: false })
|
||||
.order(id: :desc)
|
||||
|
||||
@closed_issues = @customer.issues
|
||||
.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
|
||||
end
|
||||
|
||||
# return an HTML form for editing a customer
|
||||
def edit
|
||||
begin
|
||||
@customer = Customer.find_by_id(params[:id])
|
||||
rescue
|
||||
flash[:error] = t :notice_customer_not_found
|
||||
render_404
|
||||
end
|
||||
@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
|
||||
|
||||
# update a specific customer
|
||||
def update
|
||||
begin
|
||||
@customer = Customer.find_by_id(params[:id])
|
||||
if @customer.update(allowed_params)
|
||||
flash[:notice] = t :notice_customer_updated
|
||||
redirect_to @customer
|
||||
else
|
||||
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
|
||||
|
||||
# delete a customer
|
||||
def destroy
|
||||
begin
|
||||
Customer.find_by_id(params[:id]).destroy
|
||||
flash[:notice] = t :notice_customer_deleted
|
||||
redirect_to action: :index
|
||||
rescue
|
||||
flash[:error] = t :notice_customer_not_deleted
|
||||
render_404
|
||||
end
|
||||
@customer = Customer.find_by_id(params[:id])
|
||||
@customer.update(allowed_params)
|
||||
flash[:notice] = t :notice_customer_updated
|
||||
redirect_to @customer
|
||||
rescue => e
|
||||
log "Failed to update customer: #{e.message}"
|
||||
flash[:error] = e.message
|
||||
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
|
||||
|
||||
Thread.new do
|
||||
logger.info "Removing expired customer tokens"
|
||||
CustomerToken.remove_expired_tokens
|
||||
ActiveRecord::Base.connection.close
|
||||
end
|
||||
|
||||
begin
|
||||
issue = Issue.find_by_id(params[:id])
|
||||
redirect_to view_path issue.share_token.token
|
||||
rescue
|
||||
flash[:error] = t :notice_issue_not_found
|
||||
render_404
|
||||
end
|
||||
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
|
||||
|
||||
User.current = User.find_by lastname: 'Anonymous'
|
||||
# Load only active, non-expired token
|
||||
@token = CustomerToken.active.find_by(token: params[:token])
|
||||
return render_403 unless @token
|
||||
|
||||
@token = CustomerToken.find_by token: params[:token]
|
||||
begin
|
||||
@token.destroy if @token.expired?
|
||||
raise "Token Expired" if @token.destroyed
|
||||
# Load associated issue
|
||||
@issue = @token.issue
|
||||
return render_403 unless @issue
|
||||
|
||||
session[:token] = @token.token
|
||||
@issue = Issue.find @token.issue_id
|
||||
@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?
|
||||
# Optional: enforce token belongs to the issue's customer
|
||||
return render_403 unless @issue.customer_id == @token.issue.customer_id
|
||||
|
||||
@changesets = @issue.changesets.visible.preload(:repository, :user).to_a
|
||||
@changesets.reverse! if User.current.wants_comments_in_reverse_order?
|
||||
# Store token in session for subsequent requests if needed
|
||||
session[:token] = @token.token
|
||||
|
||||
@relations = @issue.relations.select {|r| r.other_issue(@issue) && 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
|
||||
rescue
|
||||
flash[:error] = t :notice_forbidden
|
||||
render_403
|
||||
end
|
||||
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)
|
||||
@@ -214,17 +209,30 @@ class CustomersController < ApplicationController
|
||||
end
|
||||
|
||||
# format a quickbooks address to a human readable string
|
||||
def address_to_s (address)
|
||||
def address_to_s(address)
|
||||
return if address.nil?
|
||||
string = address.line1 if address.line1
|
||||
string << "\n" + address.line2 if address.line2
|
||||
string << "\n" + address.line3 if address.line3
|
||||
string << "\n" + address.line4 if address.line4
|
||||
string << "\n" + address.line5 if address.line5
|
||||
string << " " + address.city if address.city
|
||||
string << ", " + address.country_sub_division_code if address.country_sub_division_code
|
||||
string << " " + address.postal_code if address.postal_code
|
||||
return string
|
||||
|
||||
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
|
||||
|
||||
@@ -8,51 +8,72 @@
|
||||
#
|
||||
#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
|
||||
|
||||
include AuthHelper
|
||||
|
||||
before_action :require_user, unless: proc {|c| session[:token].nil? }
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: proc {|c| session[:token].nil? }
|
||||
before_action :require_user, unless: -> { session[:token].nil? }
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: -> { session[:token].nil? }
|
||||
before_action :load_estimate, only: [:show, :doc]
|
||||
|
||||
def get_estimate
|
||||
# Force sync for estimate by doc number if not found
|
||||
if Estimate.find_by_doc_number(params[:search]).nil?
|
||||
begin
|
||||
Estimate.sync_by_doc_number(params[:search]) if params[:search]
|
||||
rescue
|
||||
logger.info "Estimate.find_by_doc_number failed"
|
||||
end
|
||||
end
|
||||
|
||||
estimate = Estimate.find_by_id(params[:id]) if params[:id]
|
||||
estimate = Estimate.find_by_doc_number(params[:search]) if params[:search]
|
||||
return estimate
|
||||
end
|
||||
|
||||
#
|
||||
# Downloads and forwards the estimate pdf
|
||||
#
|
||||
def show
|
||||
estimate = get_estimate
|
||||
|
||||
begin
|
||||
send_data estimate.pdf, filename: "estimate #{estimate.doc_number}.pdf", disposition: :inline, type: "application/pdf"
|
||||
rescue
|
||||
redirect_to :back, flash: { error: I18n.t(:notice_estimate_not_found) }
|
||||
end
|
||||
end
|
||||
|
||||
#
|
||||
# Downloads estimate by document number
|
||||
#
|
||||
# Displays the estimate PDF in the browser or redirects with an error if not found.
|
||||
def doc
|
||||
estimate = get_estimate
|
||||
render_pdf(@estimate)
|
||||
end
|
||||
|
||||
begin
|
||||
send_data estimate.pdf, filename: "estimate #{estimate.doc_number}.pdf", disposition: :inline, type: "application/pdf"
|
||||
rescue
|
||||
redirect_to :back, flash: { error: I18n.t(:notice_estimate_not_found) }
|
||||
# Displays the estimate PDF in the browser or redirects with an error if not found.
|
||||
def show
|
||||
render_pdf(@estimate)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Loads the estimate based on ID or doc number, with a fallback to sync if not found locally.
|
||||
def load_estimate
|
||||
log "Attempting to load Estimate with params: #{params.inspect}"
|
||||
@estimate = find_estimate || sync_and_find_estimate
|
||||
|
||||
unless @estimate
|
||||
redirect_back fallback_location: root_path, flash: { error: I18n.t(:notice_estimate_not_found) }
|
||||
end
|
||||
end
|
||||
|
||||
# Attempts to find the estimate locally by ID or doc number.
|
||||
def find_estimate
|
||||
return Estimate.find_by(doc_number: params[:search]) if params[:search].present?
|
||||
return Estimate.find_by(id: params[:id]) if params[:id].present?
|
||||
end
|
||||
|
||||
# If the estimate is not found locally, attempts to sync it from the source and find it again.
|
||||
def sync_and_find_estimate
|
||||
|
||||
if params[:search].present?
|
||||
log "Estimate #{params[:search]} not found locally. Syncing by doc number."
|
||||
Estimate.sync_by_doc_number(params[:search])
|
||||
return Estimate.find_by(doc_number: params[:search])
|
||||
end
|
||||
|
||||
if params[:id].present?
|
||||
log "Estimate #{params[:id]} not found locally. Syncing by ID."
|
||||
Estimate.sync_by_id(params[:id])
|
||||
return Estimate.find_by(id: params[:id])
|
||||
end
|
||||
|
||||
nil
|
||||
rescue StandardError => e
|
||||
log "Estimate sync failed: #{e.message}"
|
||||
nil
|
||||
end
|
||||
|
||||
# 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])
|
||||
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}"
|
||||
redirect_back fallback_location: root_path, flash: { error: I18n.t(:notice_estimate_not_found) }
|
||||
end
|
||||
|
||||
# Logs messages with a consistent prefix for easier debugging.
|
||||
def log(msg)
|
||||
Rails.logger.info "[EstimateController] #{msg}"
|
||||
end
|
||||
end
|
||||
@@ -8,47 +8,29 @@
|
||||
#
|
||||
#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
|
||||
|
||||
include AuthHelper
|
||||
require 'combine_pdf'
|
||||
|
||||
before_action :require_user, unless: proc {|c| session[:token].nil? }
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: proc {|c| session[:token].nil? }
|
||||
before_action :require_user, unless: -> { session[:token].nil? }
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: -> { session[:token].nil? }
|
||||
|
||||
#
|
||||
# Downloads and forwards the invoice pdf
|
||||
#
|
||||
# Displays the invoice PDF in the browser or redirects with an error if not found.
|
||||
def show
|
||||
logger.info("Processing request for URL: #{request.original_url}")
|
||||
begin
|
||||
qbo = Qbo.first
|
||||
qbo.perform_authenticated_request do |access_token|
|
||||
service = Quickbooks::Service::Invoice.new(company_id: qbo.realm_id, access_token: access_token)
|
||||
log "Processing request for #{request.original_url}"
|
||||
|
||||
# If multiple id's then pull each pdf & combine them
|
||||
if params[:invoice_ids]
|
||||
logger.info("Grabbing pdfs for " + params[:invoice_ids].join(', '))
|
||||
ref = ""
|
||||
params[:invoice_ids].each do |i|
|
||||
logger.info("processing " + i)
|
||||
invoice = service.fetch_by_id(i)
|
||||
ref += " #{invoice.doc_number}"
|
||||
@pdf << CombinePDF.parse(service.pdf(invoice)) unless @pdf.nil?
|
||||
if @pdf.nil?
|
||||
@pdf = CombinePDF.parse(service.pdf(invoice))
|
||||
end
|
||||
end
|
||||
@pdf = @pdf.to_pdf
|
||||
else
|
||||
invoice = service.fetch_by_id(params[:id])
|
||||
@pdf = service.pdf(invoice)
|
||||
ref = invoice.doc_number
|
||||
end
|
||||
invoice_ids = Array(params[:invoice_ids] || params[:id])
|
||||
pdf, ref = InvoicePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: invoice_ids)
|
||||
|
||||
send_data @pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf"
|
||||
end
|
||||
rescue
|
||||
redirect_to :back, flash: { error: I18n.t(:notice_invoice_not_found) }
|
||||
end
|
||||
send_data pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf"
|
||||
|
||||
rescue StandardError => e
|
||||
log "Invoice PDF failure: #{e.message}"
|
||||
redirect_back fallback_location: root_path, flash: { error: I18n.t(:notice_invoice_not_found) }
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Logs messages with a consistent prefix for easier debugging.
|
||||
def log(msg)
|
||||
Rails.logger.info "[InvoiceController] #{msg}"
|
||||
end
|
||||
end
|
||||
@@ -9,149 +9,68 @@
|
||||
#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 QboController < ApplicationController
|
||||
|
||||
require 'openssl'
|
||||
|
||||
include AuthHelper
|
||||
|
||||
before_action :require_user, except: :webhook
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, only: [:webhook]
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, only: :webhook
|
||||
|
||||
def allowed_params
|
||||
params.permit(:code, :state, :realmId, :id)
|
||||
end
|
||||
|
||||
#
|
||||
# Called when the user requests that Redmine to connect to QBO
|
||||
#
|
||||
# Initiates the OAuth authentication process by redirecting the user to the QuickBooks authorization URL. The callback URL is generated based on the application's settings and routes.
|
||||
def authenticate
|
||||
redirect_uri = "#{Setting.protocol}://#{Setting.host_name + qbo_oauth_callback_path}"
|
||||
logger.info "redirect_uri: #{redirect_uri}"
|
||||
oauth2_client = Qbo.construct_oauth2_client
|
||||
grant_url = oauth2_client.auth_code.authorize_url(redirect_uri: redirect_uri, response_type: "code", state: SecureRandom.hex(12), scope: "com.intuit.quickbooks.accounting")
|
||||
redirect_to grant_url
|
||||
redirect_to QboOauthService.authorization_url(callback_url: callback_url)
|
||||
end
|
||||
|
||||
#
|
||||
# Called by QBO after authentication has been processed
|
||||
#
|
||||
# Handles the OAuth callback from QuickBooks. Exchanges the authorization code for access and refresh tokens, saves the connection details, and redirects to the sync page with a success notice. If any error occurs during the process, logs the error and redirects back to the plugin settings page with an error message.
|
||||
def oauth_callback
|
||||
if params[:state].present?
|
||||
oauth2_client = Qbo.construct_oauth2_client
|
||||
# use the state value to retrieve from your backend any information you need to identify the customer in your system
|
||||
redirect_uri = "#{Setting.protocol}://#{Setting.host_name + qbo_oauth_callback_path}"
|
||||
if resp = oauth2_client.auth_code.get_token(params[:code], redirect_uri: redirect_uri)
|
||||
QboOauthService.exchange!(code: params[:code], callback_url: callback_url, realm_id: params[:realmId])
|
||||
|
||||
# Remove the last authentication information
|
||||
Qbo.delete_all
|
||||
redirect_to qbo_sync_path, flash: { notice: I18n.t(:label_connected) }
|
||||
|
||||
# Save the authentication information
|
||||
qbo = Qbo.new
|
||||
qbo.update(oauth2_access_token: resp.token, oauth2_refresh_token: resp.refresh_token, realm_id: params[:realmId])
|
||||
qbo.refresh_token!
|
||||
|
||||
if qbo.save!
|
||||
redirect_to qbo_sync_path, flash: { notice: I18n.t(:label_connected) }
|
||||
else
|
||||
redirect_to plugin_settings_path(:redmine_qbo), flash: { error: I18n.t(:label_error) }
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
rescue StandardError => e
|
||||
log "OAuth failure: #{e.message}"
|
||||
redirect_to plugin_settings_path(:redmine_qbo), flash: { error: I18n.t(:label_error) }
|
||||
end
|
||||
|
||||
# Manual Billing
|
||||
# Manual billing endpoint to trigger the billing process for a specific issue. Validates the issue and its associations, enqueues a job to bill the issue's time entries, and redirects back to the issue with a notice. If validation fails, redirects back with an error message.
|
||||
def bill
|
||||
i = Issue.find_by_id params[:id]
|
||||
if i.customer
|
||||
i.bill_time
|
||||
redirect_to i, flash: { notice: I18n.t(:label_billed_success) + i.customer.name }
|
||||
else
|
||||
redirect_to i, flash: { error: I18n.t(:label_billing_error) }
|
||||
end
|
||||
issue = Issue.find_by(id: params[:id])
|
||||
raise I18n.t(:notice_error_issue_not_found) unless issue
|
||||
raise I18n.t(:notice_billing_error_no_customer) unless issue.customer
|
||||
raise I18n.t(:notice_billing_error_no_employee) unless issue.assigned_to&.employee_id.present?
|
||||
raise I18n.t(:notice_billing_error_no_qbo) unless Qbo.exists?
|
||||
|
||||
BillIssueTimeJob.perform_later(issue.id)
|
||||
|
||||
redirect_to issue, flash: { notice: "#{I18n.t(:label_billing_enqueued)} #{issue.customer.name}"}
|
||||
|
||||
rescue StandardError => e
|
||||
redirect_to issue || root_path, flash: { error: e.message }
|
||||
end
|
||||
|
||||
# Quickbooks Webhook Callback
|
||||
def webhook
|
||||
|
||||
logger.info "Quickbooks is calling webhook"
|
||||
|
||||
# check the payload
|
||||
signature = request.headers['intuit-signature']
|
||||
key = Setting.plugin_redmine_qbo['settingsWebhookToken']
|
||||
data = request.body.read
|
||||
hash = Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha256'), key, data)).strip()
|
||||
|
||||
# proceed if the request is good
|
||||
if hash.eql? signature
|
||||
Thread.new do
|
||||
if request.headers['content-type'] == 'application/json'
|
||||
data = JSON.parse(data)
|
||||
else
|
||||
# application/x-www-form-urlencoded
|
||||
data = params.as_json
|
||||
end
|
||||
# Process the information
|
||||
entities = data['eventNotifications'][0]['dataChangeEvent']['entities']
|
||||
entities.each do |entity|
|
||||
id = entity['id'].to_i
|
||||
name = entity['name']
|
||||
|
||||
logger.info "Casting #{name.constantize} to obj"
|
||||
|
||||
# Magicly initialize the correct class
|
||||
obj = name.constantize
|
||||
|
||||
# for merge events
|
||||
obj.destroy(entity['deletedId']) if entity['deletedId']
|
||||
|
||||
#Check to see if we are deleting a record
|
||||
if entity['operation'].eql? "Delete"
|
||||
obj.destroy(id)
|
||||
#if not then update!
|
||||
else
|
||||
begin
|
||||
obj.sync_by_id(id)
|
||||
rescue => e
|
||||
logger.error "Failed to call sync_by_id on obj"
|
||||
logger.error e.message
|
||||
logger.error e.backtrace.join("\n")
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# Record that last time we updated
|
||||
Qbo.update_time_stamp
|
||||
ActiveRecord::Base.connection.close
|
||||
end
|
||||
# The webhook doesn't require a response but let's make sure we don't send anything
|
||||
render nothing: true, status: 200
|
||||
else
|
||||
render nothing: true, status: 400
|
||||
end
|
||||
|
||||
logger.info "Quickbooks webhook complete"
|
||||
end
|
||||
|
||||
#
|
||||
# Synchronizes the QboCustomer table with QBO
|
||||
#
|
||||
# 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.
|
||||
def sync
|
||||
logger.info "Syncing EVERYTHING"
|
||||
# Update info in background
|
||||
Thread.new do
|
||||
if Qbo.exists?
|
||||
Customer.sync
|
||||
Invoice.sync
|
||||
Employee.sync
|
||||
Estimate.sync
|
||||
|
||||
# Record the last sync time
|
||||
Qbo.update_time_stamp
|
||||
end
|
||||
ActiveRecord::Base.connection.close
|
||||
end
|
||||
|
||||
QboSyncDispatcher.full_sync!
|
||||
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
||||
end
|
||||
|
||||
# Endpoint to receive QuickBooks webhook notifications. Validates the request and processes the payload to sync relevant data to Redmine. Responds with appropriate HTTP status codes based on success or failure of processing.
|
||||
def webhook
|
||||
QboWebhookProcessor.process!(request: request)
|
||||
head :ok
|
||||
|
||||
rescue StandardError => e
|
||||
log "Webhook failure: #{e.message}"
|
||||
head :unauthorized
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Constructs the OAuth callback URL based on the application's settings and routes. This URL is used during the OAuth flow to redirect users back to the application after authentication with QuickBooks.
|
||||
def callback_url
|
||||
"#{Setting.protocol}://#{Setting.host_name}#{qbo_oauth_callback_path}"
|
||||
end
|
||||
|
||||
# Logs messages with a consistent prefix for easier debugging and monitoring.
|
||||
def log(msg)
|
||||
Rails.logger.info "[QboController] #{msg}"
|
||||
end
|
||||
end
|
||||
112
app/jobs/bill_issue_time_job.rb
Normal file
@@ -0,0 +1,112 @@
|
||||
#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 BillIssueTimeJob < ActiveJob::Base
|
||||
queue_as :default
|
||||
retry_on StandardError, wait: 5.minutes, attempts: 5
|
||||
|
||||
# Perform billing of unbilled time entries for a given issue by creating corresponding TimeActivity records in QuickBooks Online, and then marking those entries as billed in Redmine. This job is typically triggered after an invoice is created or updated to ensure all relevant time is captured for billing.
|
||||
def perform(issue_id)
|
||||
issue = Issue.find(issue_id)
|
||||
|
||||
log "Starting billing for issue ##{issue.id}"
|
||||
issue.with_lock do
|
||||
unbilled_entries = issue.time_entries.where(billed: [false, nil]).lock
|
||||
return if unbilled_entries.blank?
|
||||
|
||||
totals = aggregate_hours(unbilled_entries)
|
||||
return if totals.blank?
|
||||
log "Aggregated hours for billing: #{totals.inspect}"
|
||||
|
||||
qbo = QboConnectionService.current!
|
||||
qbo.perform_authenticated_request do |access_token|
|
||||
create_time_activities(issue, totals, access_token, qbo)
|
||||
end
|
||||
|
||||
# Only mark billed AFTER successful QBO creation
|
||||
unbilled_entries.update_all(billed: true)
|
||||
end
|
||||
|
||||
log "Completed billing for issue ##{issue.id}"
|
||||
Qbo.update_time_stamp
|
||||
rescue => e
|
||||
log "Billing failed for issue ##{issue_id} - #{e.message}"
|
||||
raise e
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Aggregate time entries by activity name and sum their hours
|
||||
def aggregate_hours(entries)
|
||||
entries.includes(:activity)
|
||||
.group_by { |e| e.activity&.name }
|
||||
.transform_values { |rows| rows.sum(&:hours) }
|
||||
.compact
|
||||
end
|
||||
|
||||
# Create TimeActivity records in QBO for each activity type with the appropriate hours and link them to the issue's assigned employee and customer
|
||||
def create_time_activities(issue, totals, access_token, qbo)
|
||||
log "Creating TimeActivity records in QBO for issue ##{issue.id}"
|
||||
|
||||
time_service = Quickbooks::Service::TimeActivity.new( company_id: qbo.realm_id, access_token: access_token)
|
||||
item_service = Quickbooks::Service::Item.new( company_id: qbo.realm_id, access_token: access_token )
|
||||
|
||||
totals.each do |activity_name, hours_float|
|
||||
next if activity_name.blank?
|
||||
next if hours_float.to_f <= 0
|
||||
|
||||
item = find_item(item_service, activity_name)
|
||||
next unless item
|
||||
|
||||
hours, minutes = convert_hours(hours_float)
|
||||
|
||||
time_entry = Quickbooks::Model::TimeActivity.new
|
||||
time_entry.description = build_description(issue)
|
||||
time_entry.employee_id = issue.assigned_to.employee_id
|
||||
time_entry.customer_id = issue.customer_id
|
||||
time_entry.billable_status = "Billable"
|
||||
time_entry.hours = hours
|
||||
time_entry.minutes = minutes
|
||||
time_entry.name_of = "Employee"
|
||||
time_entry.txn_date = Date.today
|
||||
time_entry.hourly_rate = item.unit_price
|
||||
time_entry.item_id = item.id
|
||||
|
||||
log "Creating TimeActivity for #{activity_name} (#{hours}h #{minutes}m)"
|
||||
|
||||
time_service.create(time_entry)
|
||||
end
|
||||
end
|
||||
|
||||
# Convert a decimal hours float into separate hours and minutes components for QBO TimeActivity
|
||||
def convert_hours(hours_float)
|
||||
total_minutes = (hours_float.to_f * 60).round
|
||||
hours = total_minutes / 60
|
||||
minutes = total_minutes % 60
|
||||
[hours, minutes]
|
||||
end
|
||||
|
||||
# Build a descriptive string for the TimeActivity based on the issue's tracker, ID, subject, and completion status
|
||||
def build_description(issue)
|
||||
base = "#{issue.tracker} ##{issue.id}: #{issue.subject}"
|
||||
return base if issue.closed?
|
||||
"#{base} (Partial @ #{issue.done_ratio}%)"
|
||||
end
|
||||
|
||||
# Find an item in QBO by name, escaping single quotes to prevent query issues. Returns nil if not found.
|
||||
def find_item(item_service, name)
|
||||
safe = name.gsub("'", "\\\\'")
|
||||
item_service.query("SELECT * FROM Item WHERE Name = '#{safe}'").first
|
||||
end
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[BillIssueTimeJob] #{msg}"
|
||||
end
|
||||
end
|
||||
36
app/jobs/customer_sync_job.rb
Normal file
@@ -0,0 +1,36 @@
|
||||
#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 CustomerSyncJob < ApplicationJob
|
||||
queue_as :default
|
||||
retry_on StandardError, wait: 5.minutes, attempts: 5
|
||||
|
||||
# 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
|
||||
|
||||
log "Starting #{full_sync ? 'full' : 'incremental'} sync for customer ##{id || 'all'}..."
|
||||
|
||||
service = CustomerSyncService.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 "[CustomerSyncJob] #{msg}"
|
||||
end
|
||||
end
|
||||
36
app/jobs/employee_sync_job.rb
Normal file
@@ -0,0 +1,36 @@
|
||||
#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
|
||||
38
app/jobs/estimate_sync_job.rb
Normal file
@@ -0,0 +1,38 @@
|
||||
#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 EstimateSyncJob < 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
|
||||
|
||||
log "Starting #{full_sync ? 'full' : 'incremental'} sync for estimate ##{id || doc_number || 'all'}..."
|
||||
|
||||
service = EstimateSyncService.new(qbo: qbo)
|
||||
|
||||
if id.present?
|
||||
service.sync_by_id(id)
|
||||
elsif doc_number.present?
|
||||
service.sync_by_doc(doc_number)
|
||||
else
|
||||
service.sync(full_sync: full_sync)
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[EstimateSyncJob] #{msg}"
|
||||
end
|
||||
end
|
||||
36
app/jobs/invoice_sync_job.rb
Normal file
@@ -0,0 +1,36 @@
|
||||
#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
|
||||
41
app/jobs/qbo_sync_dispatcher.rb
Normal file
@@ -0,0 +1,41 @@
|
||||
#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 QboSyncDispatcher
|
||||
|
||||
SYNC_JOBS = [
|
||||
CustomerSyncJob,
|
||||
EstimateSyncJob,
|
||||
InvoiceSyncJob,
|
||||
EmployeeSyncJob
|
||||
].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!
|
||||
|
||||
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}"
|
||||
end
|
||||
|
||||
jobs.each { |job| job.perform_later(full_sync: true) }
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def self.log(msg)
|
||||
Rails.logger.info "[QboSyncDispatcher] #{msg}"
|
||||
end
|
||||
|
||||
end
|
||||
42
app/jobs/qbo_webhook_processor.rb
Normal file
@@ -0,0 +1,42 @@
|
||||
#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 QboWebhookProcessor
|
||||
|
||||
# Processes the incoming QuickBooks webhook request by validating the signature and enqueuing a background job to handle the webhook payload. Raises an error if the signature is invalid.
|
||||
def self.process!(request:)
|
||||
body = request.raw_post
|
||||
signature = request.headers['intuit-signature']
|
||||
secret = Setting.plugin_redmine_qbo['settingsWebhookToken']
|
||||
|
||||
raise "Invalid signature" unless valid_signature?(body, signature, secret)
|
||||
|
||||
WebhookProcessJob.perform_later(body)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Validates the QuickBooks webhook request by computing the HMAC signature and comparing it to the provided signature. Returns false if either the signature or secret is blank, or if the computed signature does not match the provided signature.
|
||||
def self.valid_signature?(body, signature, secret)
|
||||
return false if signature.blank? || secret.blank?
|
||||
log "Validating signature"
|
||||
|
||||
digest = OpenSSL::Digest.new('sha256')
|
||||
computed = Base64.strict_encode64(
|
||||
OpenSSL::HMAC.digest(digest, secret, body)
|
||||
)
|
||||
|
||||
ActiveSupport::SecurityUtils.secure_compare(computed, signature)
|
||||
end
|
||||
|
||||
def self.log(msg)
|
||||
Rails.logger.info "[QboWebhookProcessor] #{msg}"
|
||||
end
|
||||
end
|
||||
75
app/jobs/webhook_process_job.rb
Normal file
@@ -0,0 +1,75 @@
|
||||
#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 WebhookProcessJob < ActiveJob::Base
|
||||
queue_as :default
|
||||
retry_on StandardError, wait: 5.minutes, attempts: 5
|
||||
|
||||
ALLOWED_ENTITIES = %w[
|
||||
Customer
|
||||
Invoice
|
||||
Estimate
|
||||
Employee
|
||||
].freeze
|
||||
|
||||
# Process incoming QBO webhook notifications and sync relevant data to Redmine
|
||||
def perform(raw_body)
|
||||
log "Received webhook: #{raw_body}"
|
||||
data = JSON.parse(raw_body)
|
||||
|
||||
data.fetch('eventNotifications', []).each do |notification|
|
||||
entities = notification.dig('dataChangeEvent', 'entities') || []
|
||||
|
||||
entities.each do |entity|
|
||||
process_entity(entity)
|
||||
end
|
||||
end
|
||||
|
||||
Qbo.update_time_stamp
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Process a single entity from the webhook payload and sync it to Redmine if it's an allowed type
|
||||
def process_entity(entity)
|
||||
log "Processing entity: #{entity}"
|
||||
name = entity['name']
|
||||
id = entity['id']&.to_i
|
||||
|
||||
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
|
||||
entities.push context
|
||||
log "Added additional QBO entities: #{context}"
|
||||
end
|
||||
return unless entities.include?(name)
|
||||
|
||||
model = name.safe_constantize
|
||||
return unless model
|
||||
|
||||
if entity['deletedId']
|
||||
model.delete(entity['deletedId'])
|
||||
return
|
||||
end
|
||||
|
||||
if entity['operation'] == "Delete"
|
||||
model.delete(id)
|
||||
else
|
||||
model.sync_by_id(id)
|
||||
end
|
||||
rescue => e
|
||||
log "#{e.message}"
|
||||
end
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[WebhookProcessJob] #{msg}"
|
||||
end
|
||||
end
|
||||
@@ -13,12 +13,13 @@ module QuickbooksOauth
|
||||
|
||||
#== Instance Methods
|
||||
|
||||
# This method will attempt to execute the block and if it encounters an OAuth2::Error or Quickbooks::AuthorizationFailure it will attempt to refresh the token and retry the block. It will try this up to 3 times before giving up and raising an exception.
|
||||
def perform_authenticated_request(&block)
|
||||
attempts = 0
|
||||
begin
|
||||
yield oauth_access_token
|
||||
rescue OAuth2::Error, Quickbooks::AuthorizationFailure => ex
|
||||
Rails.logger.error("QuickbooksOauth.perform: #{ex.message}")
|
||||
log "perform_authenticated_request: #{ex.message}"
|
||||
|
||||
# to prevent an infinite loop here keep a counter and bail out after N times...
|
||||
attempts += 1
|
||||
@@ -32,8 +33,9 @@ module QuickbooksOauth
|
||||
end
|
||||
end
|
||||
|
||||
# This method will attempt to refresh the access token and update the record with the new access token, refresh token and their respective expiration times. If the refresh token expires in more than 0 seconds then we will set the refresh token expiration time to that value, otherwise we will set it to 100 days from now.
|
||||
def refresh_token!
|
||||
Rails.logger.info("QuickbooksOauth.refresh_token!")
|
||||
log "refresh_token!"
|
||||
t = oauth_access_token
|
||||
refreshed = t.refresh!
|
||||
|
||||
@@ -43,7 +45,7 @@ module QuickbooksOauth
|
||||
oauth2_refresh_token_expires_at = 100.days.from_now
|
||||
end
|
||||
|
||||
Rails.logger.info("QuickbooksOauth.refresh_token!: #{oauth2_refresh_token_expires_at}")
|
||||
log "refresh_token!: #{oauth2_refresh_token_expires_at}"
|
||||
|
||||
update!(
|
||||
oauth2_access_token: refreshed.token,
|
||||
@@ -53,20 +55,24 @@ module QuickbooksOauth
|
||||
)
|
||||
end
|
||||
|
||||
# This method will 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.
|
||||
def oauth_client
|
||||
self.class.construct_oauth2_client
|
||||
end
|
||||
|
||||
# This method will return an instance of the OAuth2::AccessToken class that is configured with the current access token, refresh token and the OAuth2 client. This access token can be used to make authenticated requests to the Intuit API.
|
||||
def oauth_access_token
|
||||
OAuth2::AccessToken.new(oauth_client, oauth2_access_token, refresh_token: oauth2_refresh_token)
|
||||
end
|
||||
|
||||
# This method is an alias for the oauth_access_token method and is used to provide a more intuitive name for the access token when making authenticated requests.
|
||||
def consumer
|
||||
oauth_access_token
|
||||
end
|
||||
|
||||
module ClassMethods
|
||||
|
||||
# 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']
|
||||
@@ -74,7 +80,7 @@ module QuickbooksOauth
|
||||
|
||||
# Are we are playing in the sandbox?
|
||||
Quickbooks.sandbox_mode = Setting.plugin_redmine_qbo[:sandbox] ? true : false
|
||||
logger.info "Sandbox mode: #{Quickbooks.sandbox_mode}"
|
||||
log "Sandbox mode: #{Quickbooks.sandbox_mode}"
|
||||
|
||||
options = {
|
||||
site: "https://appcenter.intuit.com/connect/oauth2",
|
||||
@@ -85,4 +91,11 @@ module QuickbooksOauth
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
|
||||
private
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[QuickbooksOauth] #{msg}"
|
||||
end
|
||||
end
|
||||
|
||||
@@ -8,231 +8,118 @@
|
||||
#
|
||||
#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
|
||||
|
||||
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
|
||||
|
||||
# returns a human readable string
|
||||
def to_s
|
||||
return "#{self[:name]} - #{phone_number.split(//).last(4).join unless phone_number.nil?}"
|
||||
end
|
||||
acts_as_searchable columns: %w[name phone_number mobile_phone_number ],
|
||||
scope: ->(_context) { left_joins(:project) },
|
||||
date_column: :updated_at
|
||||
|
||||
# Convenience Method
|
||||
# returns the customer's email
|
||||
acts_as_event :title => Proc.new {|o| "#{o}"},
|
||||
:url => Proc.new {|o| { :controller => 'customers', :action => 'show', :id => o.id} },
|
||||
:type => :to_s,
|
||||
: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 customer's email address
|
||||
def email
|
||||
pull unless @details
|
||||
begin
|
||||
return @details.email_address.address
|
||||
rescue
|
||||
return nil
|
||||
end
|
||||
details
|
||||
return @details&.email_address&.address
|
||||
end
|
||||
|
||||
# Convenience Method
|
||||
# Sets the email
|
||||
# Updates the customer's email address
|
||||
def email=(s)
|
||||
pull unless @details
|
||||
details
|
||||
@details.email_address = s
|
||||
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
|
||||
# Customers are not bound by a project
|
||||
# but we need to implement this method for the Redmine::Acts::Searchable interface
|
||||
def project
|
||||
nil
|
||||
end
|
||||
|
||||
# Convenience Method
|
||||
# Updates the customer's primary phone number
|
||||
def primary_phone=(n)
|
||||
pull unless @details
|
||||
pn = Quickbooks::Model::TelephoneNumber.new
|
||||
pn.free_form_number = n
|
||||
@details.primary_phone = pn
|
||||
#update our locally stored number too
|
||||
update_phone_number
|
||||
end
|
||||
|
||||
# Convenience Method
|
||||
# returns the customer's mobile phone
|
||||
def mobile_phone
|
||||
pull unless @details
|
||||
begin
|
||||
return @details.mobile_phone.free_form_number
|
||||
rescue
|
||||
return nil
|
||||
end
|
||||
details
|
||||
return @details&.mobile_phone&.free_form_number
|
||||
end
|
||||
|
||||
# Convenience Method
|
||||
# Updates the custome's mobile phone number
|
||||
def mobile_phone=(n)
|
||||
pull unless @details
|
||||
details
|
||||
pn = Quickbooks::Model::TelephoneNumber.new
|
||||
pn.free_form_number = n
|
||||
@details.mobile_phone = pn
|
||||
#update our locally stored number too
|
||||
update_mobile_phone_number
|
||||
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
|
||||
def name=(s)
|
||||
pull unless @details
|
||||
details
|
||||
@details.display_name = s
|
||||
super
|
||||
end
|
||||
|
||||
# Magic Method
|
||||
# Maps Get/Set methods to QBO customer object
|
||||
def method_missing(sym, *arguments)
|
||||
# Check to see if the method exists
|
||||
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
|
||||
# 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.
|
||||
def normalize_phone_numbers
|
||||
self.phone_number = phone_number.to_s.gsub(/\D/, '') if phone_number.present?
|
||||
self.mobile_phone_number = mobile_phone_number.to_s.gsub(/\D/, '') if mobile_phone_number.present?
|
||||
end
|
||||
|
||||
# proforms a bruteforce sync operation
|
||||
# This needs to be simplified
|
||||
def self.sync
|
||||
# Sync ALL customers if the database is empty
|
||||
qbo = Qbo.first
|
||||
customers = qbo.perform_authenticated_request do |access_token|
|
||||
service = Quickbooks::Service::Customer.new(company_id: qbo.realm_id, access_token: access_token)
|
||||
service.all
|
||||
end
|
||||
|
||||
return unless customers
|
||||
|
||||
customers.each do |c|
|
||||
logger.info "Processing customer #{c.id}"
|
||||
customer = Customer.find_or_create_by(id: c.id)
|
||||
if c.active?
|
||||
#if not customer.name.eql? c.display_name
|
||||
customer.name = c.display_name
|
||||
customer.id = c.id
|
||||
customer.phone_number = c.primary_phone.free_form_number.tr('^0-9', '') unless c.primary_phone.nil?
|
||||
customer.mobile_phone_number = c.mobile_phone.free_form_number.tr('^0-9', '') unless c.mobile_phone.nil?
|
||||
customer.save_without_push
|
||||
#end
|
||||
else
|
||||
if not c.new_record?
|
||||
customer.delete
|
||||
end
|
||||
end
|
||||
end
|
||||
# Sets the notes for the customer
|
||||
def notes=(s)
|
||||
details
|
||||
@details.notes = s
|
||||
end
|
||||
|
||||
# Searchs the database for a customer by name or phone number with out special chars
|
||||
# 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
|
||||
|
||||
# Seach for customers by name or phone number
|
||||
def self.search(search)
|
||||
customers = where("name LIKE ? OR phone_number LIKE ? OR mobile_phone_number LIKE ?", "%#{search}%", "%#{search}%", "%#{search}%")
|
||||
return customers.order(:name)
|
||||
#return none if search.blank?
|
||||
search = sanitize_sql_like(search)
|
||||
where("name LIKE ? OR phone_number LIKE ? OR mobile_phone_number LIKE ?", "%#{search}%", "%#{search}%", "%#{search}%")
|
||||
end
|
||||
|
||||
# proforms a bruteforce sync operation
|
||||
# This needs to be simplified
|
||||
def self.sync_by_id(id)
|
||||
qbo = Qbo.first
|
||||
c = 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)
|
||||
# Override the defult redmine seach method to rank results by id
|
||||
def self.search_result_ranks_and_ids(tokens, user, project = nil, options = {})
|
||||
return {} if tokens.blank?
|
||||
|
||||
scope = self.all
|
||||
|
||||
tokens.each do |token|
|
||||
scope = scope.search(token)
|
||||
end
|
||||
|
||||
return unless c
|
||||
|
||||
customer = Customer.find_or_create_by(id: c.id)
|
||||
if c.active?
|
||||
#if not customer.name.eql? c.display_name
|
||||
customer.name = c.display_name
|
||||
customer.id = c.id
|
||||
customer.phone_number = c.primary_phone.free_form_number.tr('^0-9', '') unless c.primary_phone.nil?
|
||||
customer.mobile_phone_number = c.mobile_phone.free_form_number.tr('^0-9', '') unless c.mobile_phone.nil?
|
||||
customer.save_without_push
|
||||
#end
|
||||
else
|
||||
if not customer.new_record?
|
||||
customer.delete
|
||||
end
|
||||
end
|
||||
ids = scope.distinct.limit(options[:limit] || 100).pluck(:id)
|
||||
ids.index_with { |id| id }
|
||||
end
|
||||
|
||||
# Push the updates
|
||||
def save_with_push
|
||||
begin
|
||||
qbo = Qbo.first
|
||||
@details = qbo.perform_authenticated_request do |access_token|
|
||||
service = Quickbooks::Service::Customer.new(company_id: qbo.realm_id, access_token: access_token)
|
||||
service.update(@details)
|
||||
end
|
||||
#raise "QBO Fault" if @details.fault?
|
||||
self.id = @details.id
|
||||
rescue Exception => e
|
||||
errors.add(e.message)
|
||||
end
|
||||
save_without_push
|
||||
end
|
||||
|
||||
alias_method :save_without_push, :save
|
||||
alias_method :save, :save_with_push
|
||||
|
||||
private
|
||||
|
||||
# pull the details
|
||||
def pull
|
||||
begin
|
||||
raise Exception unless self.id
|
||||
qbo = Qbo.first
|
||||
@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
|
||||
@details = Quickbooks::Model::Customer.new
|
||||
end
|
||||
# returns a human readable string
|
||||
def to_s
|
||||
last4 = phone_number&.last(4)
|
||||
last4.present? ? "#{name} - #{last4}" : name.to_s
|
||||
end
|
||||
|
||||
end
|
||||
@@ -8,54 +8,49 @@
|
||||
#
|
||||
#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 CustomerToken < ActiveRecord::Base
|
||||
class CustomerToken < ApplicationRecord
|
||||
belongs_to :issue
|
||||
|
||||
has_many :issues
|
||||
validates_presence_of :issue_id
|
||||
before_create :generate_token, :generate_expire_date
|
||||
attr_accessor :destroyed
|
||||
after_destroy :mark_as_destroyed
|
||||
validates :issue_id, presence: true
|
||||
validates :token, presence: true, uniqueness: true
|
||||
|
||||
OAUTH_CONSUMER_SECRET = Setting.plugin_redmine_qbo['settingsOAuthConsumerSecret'] || 'CONFIGURE__' + SecureRandom.uuid
|
||||
before_validation :generate_token, on: :create
|
||||
before_validation :generate_expire_date, on: :create
|
||||
|
||||
# generates a random token using the plugin setting settingsOAuthConsumerSecret for salt
|
||||
def generate_token
|
||||
self.token = SecureRandom.base64(15).tr('+/=lIO0', OAUTH_CONSUMER_SECRET)
|
||||
end
|
||||
scope :active, -> { where("expires_at > ?", Time.current) }
|
||||
|
||||
# generates an expiring date
|
||||
def generate_expire_date
|
||||
self.expires_at = Time.now + 1.month
|
||||
end
|
||||
TOKEN_EXPIRATION = 1.month
|
||||
|
||||
# set destroyed flag
|
||||
def mark_as_destroyed
|
||||
self.destroyed = true
|
||||
end
|
||||
|
||||
# purge expired tokens
|
||||
def self.remove_expired_tokens
|
||||
where("expires_at < ?", Time.now).destroy_all
|
||||
end
|
||||
|
||||
# has the token expired?
|
||||
# Check if the token has expired
|
||||
def expired?
|
||||
self.expires_at < Time.now
|
||||
expires_at.present? && expires_at <= Time.current
|
||||
end
|
||||
|
||||
# Getter convenience method for tokens
|
||||
# Remove expired tokens from the database
|
||||
def self.remove_expired_tokens
|
||||
where("expires_at <= ?", Time.current).delete_all
|
||||
end
|
||||
|
||||
# Get or create a token for the given issue
|
||||
def self.get_token(issue)
|
||||
return unless issue
|
||||
return unless User.current.allowed_to?(:view_issues, issue.project)
|
||||
|
||||
# check to see if token exists & if it is expired
|
||||
token = find_by_issue_id issue.id
|
||||
unless token.nil?
|
||||
return token unless token.expired?
|
||||
# remove expired tokens
|
||||
token.destroy
|
||||
end
|
||||
token = active.find_by(issue_id: issue.id)
|
||||
return token if token
|
||||
|
||||
# only create new token if we have an issue to attach it to
|
||||
return create(issue_id: issue.id) if User.current.logged?
|
||||
create!(issue: issue)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Generate a unique token for the customer
|
||||
def generate_token
|
||||
self.token ||= SecureRandom.urlsafe_base64(32)
|
||||
end
|
||||
|
||||
# Generate an expiration date for the token
|
||||
def generate_expire_date
|
||||
self.expires_at ||= Time.current + TOKEN_EXPIRATION
|
||||
end
|
||||
end
|
||||
@@ -8,42 +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.
|
||||
|
||||
class Employee < ActiveRecord::Base
|
||||
class Employee < QboBaseModel
|
||||
|
||||
has_many :users
|
||||
validates_presence_of :id, :name
|
||||
self.primary_key = :id
|
||||
|
||||
def self.sync
|
||||
qbo = Qbo.first
|
||||
employees = qbo.perform_authenticated_request do |access_token|
|
||||
service = Quickbooks::Service::Employee.new(company_id: qbo.realm_id, access_token: access_token)
|
||||
service.all
|
||||
end
|
||||
|
||||
return unless employees
|
||||
|
||||
transaction do
|
||||
employees.each { |e|
|
||||
logger.info "Processing employee #{e.id}"
|
||||
employee = find_or_create_by(id: e.id)
|
||||
employee.name = e.display_name
|
||||
employee.id = e.id
|
||||
employee.save!
|
||||
}
|
||||
end
|
||||
end
|
||||
|
||||
def self.sync_by_id(id)
|
||||
qbo = Qbo.first
|
||||
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.name = employee.display_name
|
||||
employee.id = employee.id
|
||||
employee.save!
|
||||
end
|
||||
end
|
||||
@@ -8,7 +8,7 @@
|
||||
#
|
||||
#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
|
||||
class Estimate < QboBaseModel
|
||||
|
||||
has_and_belongs_to_many :issues
|
||||
belongs_to :customer
|
||||
@@ -20,114 +20,9 @@ class Estimate < ActiveRecord::Base
|
||||
return self[:doc_number]
|
||||
end
|
||||
|
||||
# sync all estimates
|
||||
def self.sync
|
||||
logger.info "Syncing ALL estimates"
|
||||
qbo = Qbo.first
|
||||
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|
|
||||
process_estimate(estimate)
|
||||
}
|
||||
|
||||
#remove deleted estimates
|
||||
where.not(estimates.map(&:id)).destroy_all
|
||||
end
|
||||
|
||||
# sync only one estimate
|
||||
def self.sync_by_id(id)
|
||||
logger.info "Syncing estimate #{id}"
|
||||
qbo = Qbo.first
|
||||
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
|
||||
|
||||
# sync only one estimate
|
||||
def self.sync_by_doc_number(number)
|
||||
logger.info "Syncing estimate by doc number #{number}"
|
||||
qbo = Qbo.first
|
||||
qbo.perform_authenticated_request do |access_token|
|
||||
service = Quickbooks::Service::Estimate.new(company_id: qbo.realm_id, access_token: access_token)
|
||||
process_estimate(service.find_by( :doc_number, number).first)
|
||||
end
|
||||
end
|
||||
|
||||
# update an estimate
|
||||
def self.update(id)
|
||||
qbo = Qbo.first
|
||||
estimate = qbo.perform_authenticated_request do |access_token|
|
||||
service = Quickbooks::Service::Estimate.new(company_id: qbo.realm_id, access_token: access_token)
|
||||
service.fetch_by_id(id)
|
||||
end
|
||||
|
||||
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
|
||||
|
||||
# process an estimate into the database
|
||||
def self.process_estimate(qbo_estimate)
|
||||
logger.info "Processing estimate #{qbo_estimate.id}"
|
||||
estimate = find_or_create_by(id: qbo_estimate.id)
|
||||
estimate.doc_number = qbo_estimate.doc_number
|
||||
estimate.customer_id = qbo_estimate.customer_ref.value
|
||||
estimate.id = qbo_estimate.id
|
||||
estimate.txn_date = qbo_estimate.txn_date
|
||||
estimate.save!
|
||||
end
|
||||
|
||||
# download the pdf from quickbooks
|
||||
def pdf
|
||||
qbo = Qbo.first
|
||||
qbo.perform_authenticated_request do |access_token|
|
||||
service = Quickbooks::Service::Estimate.new(company_id: qbo.realm_id, access_token: access_token)
|
||||
estimate = service.fetch_by_id(id)
|
||||
service.pdf(estimate)
|
||||
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
|
||||
|
||||
# pull the details
|
||||
def pull
|
||||
begin
|
||||
raise Exception unless self.id
|
||||
qbo = Qbo.first
|
||||
@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
|
||||
EstimateSyncJob.perform_later(doc_number: number)
|
||||
end
|
||||
|
||||
end
|
||||
@@ -8,201 +8,17 @@
|
||||
#
|
||||
#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 < QboBaseModel
|
||||
|
||||
has_and_belongs_to_many :issues
|
||||
belongs_to :customer
|
||||
validates_presence_of :doc_number, :id, :customer_id, :txn_date
|
||||
validates :id, presence: true, uniqueness: true
|
||||
validates :doc_number, :txn_date, presence: true
|
||||
self.primary_key = :id
|
||||
|
||||
# returns a human readable string
|
||||
# Return the invoice's document number as its string representation
|
||||
def to_s
|
||||
return self[:doc_number]
|
||||
end
|
||||
|
||||
# sync ALL the invoices
|
||||
def self.sync
|
||||
logger.info "Syncing all invoices"
|
||||
last = Qbo.first.last_sync
|
||||
|
||||
query = "SELECT Id, DocNumber FROM Invoice"
|
||||
query << " WHERE Metadata.LastUpdatedTime >= '#{last.iso8601}' " if last
|
||||
|
||||
# TODO actually do something with the above query
|
||||
# .all() is never called since count is never initialized
|
||||
qbo = Qbo.first
|
||||
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 |
|
||||
process_invoice invoice
|
||||
}
|
||||
end
|
||||
|
||||
#sync by invoice ID
|
||||
def self.sync_by_id(id)
|
||||
logger.info "Syncing invoice #{id}"
|
||||
qbo = Qbo.first
|
||||
qbo.perform_authenticated_request do |access_token|
|
||||
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
|
||||
|
||||
private
|
||||
|
||||
# Attach the invoice to the issue
|
||||
def self.attach_to_issue(issue, invoice)
|
||||
return if issue.nil?
|
||||
|
||||
# skip this issue if the issue customer is not the same as the invoice customer
|
||||
return if issue.customer_id != invoice.customer_ref.value.to_i
|
||||
|
||||
logger.info "Attaching invoice #{invoice.id} to issue #{issue.id}"
|
||||
|
||||
invoice = Invoice.find_or_create_by(id: invoice.id)
|
||||
|
||||
unless issue.invoices.include?(invoice)
|
||||
issue.invoices << invoice
|
||||
issue.save!
|
||||
end
|
||||
|
||||
compare_custom_fields(issue, invoice)
|
||||
end
|
||||
|
||||
# processes the invoice into the database
|
||||
def self.process_invoice(i)
|
||||
logger.info "Processing invoice #{i.id}"
|
||||
|
||||
# Load the invoice into the database
|
||||
invoice = Invoice.find_or_create_by(id: i.id)
|
||||
invoice.doc_number = i.doc_number
|
||||
invoice.id = i.id
|
||||
invoice.customer_id = i.customer_ref
|
||||
invoice.txn_date = i.txn_date
|
||||
invoice.save!
|
||||
|
||||
# Scan the private notes for hashtags and attach to the applicable issues
|
||||
if not i.private_note.nil?
|
||||
i.private_note.scan(/#(\w+)/).flatten.each { |issue|
|
||||
attach_to_issue(Issue.find_by_id(issue.to_i), invoice)
|
||||
}
|
||||
end
|
||||
|
||||
# Scan the line items for hashtags and attach to the applicable issues
|
||||
i.line_items.each { |line|
|
||||
if line.description
|
||||
line.description.scan(/#(\w+)/).flatten.each { |issue|
|
||||
attach_to_issue(Issue.find_by_id(issue.to_i), invoice)
|
||||
}
|
||||
end
|
||||
}
|
||||
end
|
||||
|
||||
# compares the custome fields on invoices & issues and updates the invoice as needed
|
||||
#
|
||||
# the issue here is when two or more issues share an invoice with the same custom field, but diffrent values
|
||||
# this condions causes an infinite loop as the webhook is called when an invoice is updated
|
||||
# TODO maybe add a cf_sync_confict flag to invoices
|
||||
def self.compare_custom_fields(issue, invoice)
|
||||
logger.info "Comparing custom fields"
|
||||
# TODO break if Invoice.find(invoice.id).cf_sync_confict
|
||||
is_changed = false
|
||||
|
||||
logger.debug "Calling :process_invoice_custom_fields hook"
|
||||
context = Redmine::Hook.call_hook :process_invoice_custom_fields, { issue: issue, invoice: invoice }
|
||||
|
||||
# Process updates from the hooks
|
||||
context.each do |c|
|
||||
unless c.nil?
|
||||
logger.debug "Invoice.compare_custom_fields: We have a responce from a hook"
|
||||
push_updates c[:invoice] if c[:is_changed]
|
||||
end
|
||||
end
|
||||
|
||||
# Process Issue Custom Values
|
||||
begin
|
||||
value = issue.custom_values.find_by(custom_field_id: CustomField.find_by_name(cf.name).id)
|
||||
|
||||
# Check to see if the value is blank...
|
||||
if not value.value.to_s.blank?
|
||||
# Check to see if the value is diffrent
|
||||
if not cf.string_value.to_s.eql? value.value.to_s
|
||||
# update the custom field on the invoice
|
||||
cf.string_value = value.value.to_s
|
||||
is_changed = true
|
||||
end
|
||||
end
|
||||
rescue
|
||||
# Nothing to do here, there is no match
|
||||
end
|
||||
|
||||
push_updates invoice if is_changed
|
||||
end
|
||||
|
||||
# pushes invoice updates
|
||||
def self.push_updates(invoice)
|
||||
begin
|
||||
logger.info "Invoice.push_updates"
|
||||
qbo = Qbo.first
|
||||
qbo.perform_authenticated_request do |access_token|
|
||||
service = Quickbooks::Service::Invoice.new(company_id: qbo.realm_id, access_token: access_token)
|
||||
service.update invoice
|
||||
end
|
||||
rescue
|
||||
# Do nothing, probaly custome field sync confict on the invoice.
|
||||
# This is a problem with how it's billed
|
||||
# TODO Add notes in memo area
|
||||
# TODO flag Invoice.cf_sync_confict here
|
||||
logger.error "Failed to update invoice"
|
||||
end
|
||||
end
|
||||
|
||||
# download the pdf from quickbooks
|
||||
def pdf
|
||||
qbo = Qbo.first
|
||||
qbo.perform_authenticated_request do |access_token|
|
||||
service = Quickbooks::Service::Invoice.new(company_id: qbo.realm_id, access_token: access_token)
|
||||
invoice = service.fetch_by_id(id)
|
||||
return service.pdf(invoice)
|
||||
end
|
||||
end
|
||||
|
||||
# Magic Method
|
||||
# Maps Get/Set methods to QBO invoice object
|
||||
def method_missing(sym, *arguments)
|
||||
# Check to see if the method exists
|
||||
if Quickbooks::Model::Invoice.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
|
||||
|
||||
# pull the details from quickbooks
|
||||
def pull
|
||||
begin
|
||||
raise Exception unless self.id
|
||||
qbo = Qbo.first
|
||||
@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
|
||||
@details = Quickbooks::Model::Invoice.new
|
||||
end
|
||||
doc_number
|
||||
end
|
||||
|
||||
end
|
||||
@@ -13,16 +13,34 @@ class Qbo < ActiveRecord::Base
|
||||
include QuickbooksOauth
|
||||
include Redmine::I18n
|
||||
|
||||
validate :single_record_only, on: :create
|
||||
|
||||
# Updates last sync time stamp
|
||||
def self.update_time_stamp
|
||||
date = DateTime.now
|
||||
logger.info "Updating QBO timestamp to #{date}"
|
||||
qbo = Qbo.first
|
||||
log "Updating QBO timestamp to #{date}"
|
||||
qbo = QboConnectionService.current!
|
||||
qbo.last_sync = date
|
||||
qbo.save
|
||||
end
|
||||
|
||||
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
|
||||
def self.last_sync
|
||||
format_time(Qbo.first.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.
|
||||
def self.log(msg)
|
||||
logger.info "[QBO] #{msg}"
|
||||
end
|
||||
|
||||
# Validates that only one QBO connection record exists in the database. Adds an error if a record already exists.
|
||||
def single_record_only
|
||||
errors.add(:base, "Only one QBO connection allowed") if Qbo.exists?
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
109
app/models/qbo_base_model.rb
Normal file
@@ -0,0 +1,109 @@
|
||||
#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
|
||||
|
||||
attr_accessor :skip_qbo_push
|
||||
before_validation :push_to_qbo, on: :create
|
||||
after_commit :push_to_qbo, on: :update, unless: :skip_qbo_push?
|
||||
|
||||
# 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
|
||||
|
||||
# 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 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
|
||||
job = "#{model_name.name}SyncJob".constantize
|
||||
job.perform_later(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)
|
||||
job = "#{model_name.name}SyncJob".constantize
|
||||
job.perform_later(id: id)
|
||||
end
|
||||
|
||||
def skip_qbo_push?
|
||||
!!skip_qbo_push
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
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..."
|
||||
qbo = QboConnectionService.current!
|
||||
service_class.new(qbo: qbo, local: self).pull()
|
||||
end
|
||||
|
||||
def push_to_qbo
|
||||
log "Starting push for #{model_name.name} ##{id}..."
|
||||
qbo = QboConnectionService.current!
|
||||
reslut = service_class.new(qbo: qbo, local: self).push
|
||||
Rails.cache.delete(details_cache_key)
|
||||
return reslut
|
||||
end
|
||||
|
||||
def qbo_model_class
|
||||
@qbo_model_class ||= "Quickbooks::Model::#{model_name.name}".constantize
|
||||
end
|
||||
|
||||
def service_class
|
||||
@service_class ||= "#{model_name.name}Service".constantize
|
||||
end
|
||||
|
||||
end
|
||||
20
app/services/customer_service.rb
Normal file
@@ -0,0 +1,20 @@
|
||||
#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 < ServiceBase
|
||||
|
||||
private
|
||||
|
||||
def build_qbo_remote
|
||||
log "Building new QBO Customer"
|
||||
Quickbooks::Model::Customer.new
|
||||
end
|
||||
|
||||
end
|
||||
32
app/services/customer_sync_service.rb
Normal file
@@ -0,0 +1,32 @@
|
||||
#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 CustomerSyncService < SyncServiceBase
|
||||
|
||||
private
|
||||
|
||||
# Specify the local model this service syncs
|
||||
def self.model_class
|
||||
Customer
|
||||
end
|
||||
|
||||
# Determine if the remote entity should be deleted locally (e.g. if it's marked inactive in QBO)
|
||||
def destroy_remote?(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
|
||||
|
||||
end
|
||||
30
app/services/employee_sync_service.rb
Normal file
@@ -0,0 +1,30 @@
|
||||
#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 EmployeeSyncService < SyncServiceBase
|
||||
|
||||
private
|
||||
|
||||
# Specify the local model this service syncs
|
||||
def self.model_class
|
||||
Employee
|
||||
end
|
||||
|
||||
# Determine if the remote entity should be deleted locally (e.g. if it's marked inactive in QBO)
|
||||
def destroy_remote?(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
|
||||
|
||||
end
|
||||
16
app/services/estimate_pdf_service.rb
Normal file
@@ -0,0 +1,16 @@
|
||||
#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 EstimatePdfService < PdfServiceBase
|
||||
|
||||
def self.model_class
|
||||
Estimate
|
||||
end
|
||||
|
||||
end
|
||||
27
app/services/estimate_sync_service.rb
Normal file
@@ -0,0 +1,27 @@
|
||||
#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 EstimateSyncService < SyncServiceBase
|
||||
|
||||
private
|
||||
|
||||
# Specify the local model this service syncs
|
||||
def self.model_class
|
||||
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
|
||||
|
||||
end
|
||||
62
app/services/invoice_attachment_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 InvoiceAttachmentService
|
||||
|
||||
def initialize(invoice, remote)
|
||||
@invoice = invoice
|
||||
@remote = remote
|
||||
end
|
||||
|
||||
# Attach invoice to issues based on issue IDs found in the invoice's private note and line descriptions
|
||||
def attach
|
||||
extract_issue_ids.each do |issue_id|
|
||||
log "Processing issue ##{issue_id} for invoice ##{@invoice.doc_number}"
|
||||
|
||||
issue = Issue.find_by(id: issue_id)
|
||||
next unless issue
|
||||
next unless issue.customer&.id == @invoice.customer&.id
|
||||
|
||||
unless issue.invoices.exists?(@invoice.id)
|
||||
issue.invoices << @invoice
|
||||
issue.save! if issue.changed?
|
||||
log "Attached invoice ##{@invoice.id} to issue ##{issue.id}"
|
||||
end
|
||||
|
||||
InvoiceCustomFieldSyncService.new(issue, @invoice, @remote).sync
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Extract issue IDs from the invoice's private note and line descriptions
|
||||
def extract_issue_ids
|
||||
ids = []
|
||||
|
||||
if @remote.private_note.present?
|
||||
ids += scan(@remote.private_note)
|
||||
end
|
||||
|
||||
Array(@remote.line_items).each do |line|
|
||||
ids += scan(line.description.to_s)
|
||||
end
|
||||
|
||||
ids.uniq
|
||||
end
|
||||
|
||||
# Scan text for issue IDs in the format #123
|
||||
def scan(text)
|
||||
text.scan(/#(\d+)/).flatten.map(&:to_i)
|
||||
end
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[InvoiceAttachmentService] #{msg}"
|
||||
end
|
||||
end
|
||||
69
app/services/invoice_custom_field_sync_service.rb
Normal file
@@ -0,0 +1,69 @@
|
||||
#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 InvoiceCustomFieldSyncService
|
||||
|
||||
def initialize(issue, invoice, remote)
|
||||
@issue = issue
|
||||
@invoice = invoice
|
||||
@remote = remote
|
||||
end
|
||||
|
||||
# Sync custom fields on the issue based on the invoice data, then push changes to QBO if any fields were updated
|
||||
def sync
|
||||
return if @invoice.qbo_sync_locked?
|
||||
|
||||
log "Syncing custom fields for issue ##{@issue.id} based on invoice ##{@invoice.doc_number}"
|
||||
|
||||
changed = false
|
||||
|
||||
# Process Invoice Custom Fields via Hooks
|
||||
Redmine::Hook.call_hook(
|
||||
:process_invoice_custom_fields,
|
||||
issue: @issue,
|
||||
invoice: @remote
|
||||
).each do |context|
|
||||
next unless context
|
||||
changed ||= context[:is_changed]
|
||||
log "Custom fields updated by hook, marking invoice for push to QBO" if context[:is_changed]
|
||||
end
|
||||
|
||||
# Process Issue Custom Values from any issue custom fields that match the invoice custom fields
|
||||
begin
|
||||
value = @issue.custom_values.find_by(custom_field_id: CustomField.find_by_name(cf.name).id)
|
||||
|
||||
# Check to see if the value is blank...
|
||||
if not value.value.to_s.blank?
|
||||
# Check to see if the value is diffrent
|
||||
if not cf.string_value.to_s.eql? value.value.to_s
|
||||
# update the custom field on the invoice
|
||||
cf.string_value = value.value.to_s
|
||||
is_changed = true
|
||||
end
|
||||
end
|
||||
rescue
|
||||
# Nothing to do here, there is no match
|
||||
end
|
||||
|
||||
push_if_changed if changed
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# If any custom fields were changed during the sync process, this method will trigger a push of the invoice data to QuickBooks Online to ensure that the remote data stays in sync with the local changes. It uses the InvoicePushService to handle the actual communication with QBO.
|
||||
def push_if_changed
|
||||
InvoicePushService.new(@invoice).push
|
||||
end
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[InvoiceCustomFieldSyncService] #{msg}"
|
||||
end
|
||||
|
||||
end
|
||||
16
app/services/invoice_pdf_service.rb
Normal file
@@ -0,0 +1,16 @@
|
||||
#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
|
||||
47
app/services/invoice_push_service.rb
Normal file
@@ -0,0 +1,47 @@
|
||||
#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 InvoicePushService
|
||||
|
||||
def initialize(invoice)
|
||||
@invoice = invoice
|
||||
end
|
||||
|
||||
# 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 = service.fetch_by_id(@invoice.id)
|
||||
|
||||
# modify remote object here if needed
|
||||
|
||||
service.update(remote)
|
||||
end
|
||||
rescue => e
|
||||
Rails.logger.error "[InvoicePushService] #{e.message}"
|
||||
ensure
|
||||
@invoice.update_column(:qbo_sync_locked, false)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[InvoicePushService] #{msg}"
|
||||
end
|
||||
end
|
||||
35
app/services/invoice_sync_service.rb
Normal file
@@ -0,0 +1,35 @@
|
||||
#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 InvoiceSyncService < SyncServiceBase
|
||||
|
||||
private
|
||||
|
||||
# Specify the local model this service syncs
|
||||
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
|
||||
end
|
||||
66
app/services/pdf_service_base.rb
Normal file
@@ -0,0 +1,66 @@
|
||||
#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 PdfServiceBase
|
||||
|
||||
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
|
||||
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)
|
||||
|
||||
return single_pdf(service, doc_ids.first) if doc_ids.size == 1
|
||||
|
||||
combined_pdf(service, doc_ids)
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Fetches a single PDF for the given invoice ID.
|
||||
def single_pdf(service, id)
|
||||
log "Fetching PDF for #{@entity} ID: #{id}"
|
||||
entity = service.fetch_by_id(id)
|
||||
[service.pdf(entity), entity.doc_number]
|
||||
end
|
||||
|
||||
# Combines PDFs for multiple entity IDs into a single PDF document and returns it along with a reference string.
|
||||
def combined_pdf(service, ids)
|
||||
log "Combining PDFs for #{@entity} IDs: #{ids.join(', ')}"
|
||||
pdf = CombinePDF.new
|
||||
ref = []
|
||||
|
||||
ids.each do |id|
|
||||
entity = service.fetch_by_id(id)
|
||||
ref << entity.doc_number
|
||||
pdf << CombinePDF.parse(service.pdf(entity))
|
||||
end
|
||||
|
||||
[pdf.to_pdf, ref.join(" ")]
|
||||
end
|
||||
|
||||
# Logs messages with a consistent prefix for easier debugging.
|
||||
def log(msg)
|
||||
Rails.logger.info "[#{@entity}PdfService] #{msg}"
|
||||
end
|
||||
end
|
||||
32
app/services/qbo_connection_service.rb
Normal file
@@ -0,0 +1,32 @@
|
||||
#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 QboConnectionService
|
||||
|
||||
# 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
|
||||
Qbo.destroy_all
|
||||
qbo = Qbo.create!(
|
||||
oauth2_access_token: token,
|
||||
oauth2_refresh_token: refresh_token,
|
||||
realm_id: realm_id
|
||||
)
|
||||
qbo.refresh_token!
|
||||
qbo
|
||||
end
|
||||
end
|
||||
|
||||
# Returns the current QBO connection record. Raises an error if no connection exists.
|
||||
def self.current!
|
||||
Qbo.first || raise("QBO not connected")
|
||||
end
|
||||
|
||||
end
|
||||
33
app/services/qbo_oauth_service.rb
Normal file
@@ -0,0 +1,33 @@
|
||||
#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 QboOauthService
|
||||
|
||||
# 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,
|
||||
response_type: "code",
|
||||
state: SecureRandom.hex(12),
|
||||
scope: "com.intuit.quickbooks.accounting"
|
||||
)
|
||||
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.
|
||||
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 )
|
||||
end
|
||||
|
||||
# Constructs and returns an OAuth2 client instance configured with the application's credentials and settings.
|
||||
def self.client
|
||||
Qbo.construct_oauth2_client
|
||||
end
|
||||
end
|
||||
82
app/services/service_base.rb
Normal file
@@ -0,0 +1,82 @@
|
||||
#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(qbo:, local: nil)
|
||||
raise "No QBO configuration found" unless qbo
|
||||
raise "#{@entity} record is required for push operation" unless local
|
||||
@qbo = qbo
|
||||
@entity = local.class.name
|
||||
@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..."
|
||||
qbo = QboConnectionService.current!
|
||||
qbo.perform_authenticated_request do |access_token|
|
||||
service_class = "Quickbooks::Service::#{@entity}".constantize
|
||||
service = service_class.new(
|
||||
company_id: qbo.realm_id,
|
||||
access_token: access_token
|
||||
)
|
||||
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 = @qbo.perform_authenticated_request do |access_token|
|
||||
service_class = "Quickbooks::Service::#{@entity}".constantize
|
||||
service = service_class.new(
|
||||
company_id: @qbo.realm_id,
|
||||
access_token: access_token
|
||||
)
|
||||
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."
|
||||
return @local
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Log messages with the entity type for better traceability
|
||||
def log(msg)
|
||||
Rails.logger.info "[#{@entity}Service] #{msg}"
|
||||
end
|
||||
|
||||
end
|
||||
127
app/services/sync_service_base.rb
Normal file
@@ -0,0 +1,127 @@
|
||||
#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 SyncServiceBase
|
||||
PAGE_SIZE = 1000
|
||||
|
||||
# Subclasses should initialize with a QBO client instance
|
||||
def initialize(qbo:)
|
||||
raise "No QBO configuration found" unless qbo
|
||||
@qbo = qbo
|
||||
@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)
|
||||
def self.model_class
|
||||
raise NotImplementedError
|
||||
end
|
||||
|
||||
# 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 with page size of: #{@page_size}"
|
||||
|
||||
@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: @page_size) do |batch|
|
||||
entries = Array(batch)
|
||||
log "Processing batch of #{entries.size} #{@entity.name}"
|
||||
|
||||
entries.each do |remote|
|
||||
persist(remote)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
log "#{@entity.name} sync complete"
|
||||
end
|
||||
|
||||
# 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)
|
||||
remote = service.fetch_by_id(id)
|
||||
persist(remote)
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Builds a QBO query for retrieving entities
|
||||
def build_query(full_sync)
|
||||
if full_sync
|
||||
"SELECT * FROM #{@entity.name} ORDER BY Id"
|
||||
else
|
||||
last_update = @entity.maximum(:updated_at) || 1.year.ago
|
||||
|
||||
<<~SQL.squish
|
||||
SELECT * FROM #{@entity.name}
|
||||
WHERE MetaData.LastUpdatedTime > '#{last_update.utc.iso8601}'
|
||||
ORDER BY MetaData.LastUpdatedTime
|
||||
SQL
|
||||
end
|
||||
end
|
||||
|
||||
def attach_documents(local, remote)
|
||||
# Override in subclasses if the entity has attachments (e.g. Invoice)
|
||||
end
|
||||
|
||||
# Determine if a remote entity should be deleted locally (e.g. if it's marked inactive in QBO)
|
||||
def destroy_remote?(remote)
|
||||
false
|
||||
end
|
||||
|
||||
# Log messages with the entity type for better traceability
|
||||
def log(msg)
|
||||
Rails.logger.info "[#{@entity.name}SyncService] #{msg}"
|
||||
end
|
||||
|
||||
# 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 local.persisted?
|
||||
local.destroy
|
||||
log "Deleted #{@entity.name} #{remote.id}"
|
||||
end
|
||||
return
|
||||
end
|
||||
|
||||
process_attributes(local, remote)
|
||||
|
||||
if local.changed?
|
||||
local.skip_qbo_push = true
|
||||
local.save
|
||||
log "Updated #{@entity.name} #{remote.id}"
|
||||
attach_documents(local, remote)
|
||||
end
|
||||
|
||||
rescue => e
|
||||
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
|
||||
def process_attributes(local, remote)
|
||||
raise NotImplementedError, "Subclasses must implement process_attributes"
|
||||
end
|
||||
end
|
||||
@@ -13,22 +13,22 @@
|
||||
|
||||
<tr>
|
||||
<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>
|
||||
<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>
|
||||
<th><%=t(:label_billing_address)%></th>
|
||||
<td><%= @billing_address %></td>
|
||||
<td><pre><%= @billing_address %></pre></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_shipping_address)%></th>
|
||||
<td><%= @shipping_address %></td>
|
||||
<td><pre><%= @shipping_address %></pre></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
<%= form_tag(customers_path, method: "get", id: "search-form") do %>
|
||||
<%= form_tag(customers_path, method: "get", id: "customer-search-form") do %>
|
||||
<%= text_field_tag :search, params[:search], placeholder: t(:label_search_customers), autocomplete: "off" %>
|
||||
<%= submit_tag t(:label_search) %>
|
||||
<% end %>
|
||||
|
||||
@@ -46,8 +46,8 @@
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<h3><%=@issues.open.count%> <%=t(:label_open_issues)%> - <%=@hours.round(1)%> <%=t(:label_hours)%></h3>
|
||||
<%= render partial: 'issues/list_simple', locals: {issues: @issues.open} %>
|
||||
<h3><%=@open_issues.count%> <%=t(:label_open_issues)%> - <%=@hours.round(1)%> <%=t(:label_hours)%></h3>
|
||||
<%= 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>
|
||||
<%= render partial: 'issues/list_simple', locals: {issues: @closed_issues} %>
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
<% estimates.sort.reverse.each do |estimate| %>
|
||||
<div class="row">
|
||||
<%= check_box_tag "estimate_ids[]", estimate.id, false, onchange: "updateLink()", class: "estimate-checkbox" %>
|
||||
<%= check_box_tag "estimate_ids[]", estimate.id, false, onchange: "updateLink()", data: { url: estimate_path(estimate), text: "Estimate ##{estimate.to_s}" }, class: "estimate-checkbox appointment" %>
|
||||
<b><%= link_to "##{estimate.doc_number}", estimate_path(estimate), target: :_blank %></b> <%= estimate.txn_date %>
|
||||
</div>
|
||||
<% end %>
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
<%= form_tag(estimate_doc_path, method: "get") do %>
|
||||
<%= form_tag(estimate_doc_path, method: "get", id: "estimate-search-form") do %>
|
||||
<%= text_field_tag :search, params[:search], placeholder: t(:label_search_estimates), autocomplete: "off" %>
|
||||
<%= submit_tag t(:label_search), formtarget: "_blank" %>
|
||||
<% end %>
|
||||
|
||||
@@ -12,7 +12,7 @@
|
||||
|
||||
<% invoices.sort.reverse.each do |invoice| %>
|
||||
<div class="row">
|
||||
<%= check_box_tag "invoice_ids[]", invoice.id, false, onchange: "updateLink()", class: "invoice-checkbox" if invoices.count > 1 %>
|
||||
<%= check_box_tag "invoice_ids[]", invoice.id, false, onchange: "updateLink()", data: { url: invoice_path(invoice), text: "Invoice ##{invoice.to_s}" }, class: "invoice-checkbox appointment" if invoices.count > 1 %>
|
||||
<b><%= link_to "##{invoice.doc_number}", invoice_path(invoice), target: :_blank %></b> <%= invoice.txn_date %>
|
||||
</div>
|
||||
<% end %>
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
"<div id='footer' align='center'>
|
||||
<b><%=I18n.translate(:label_last_sync)%>: </b> <%=Qbo.last_sync if Qbo.exists?%>
|
||||
</div>"
|
||||
<div id='footer' align='center'>
|
||||
<%= render partial: 'qbo/last_sync' %>
|
||||
</div>
|
||||
@@ -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>
|
||||
<th><%=t(:label_oauth_expires)%></th>
|
||||
<td><%= if Qbo.exists? then Qbo.first.oauth2_access_token_expires_at end %>
|
||||
<td><%= QboConnectionService.current!&.oauth2_access_token_expires_at %>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_oauth2_refresh_token_expires_at)%></th>
|
||||
<td><%= if Qbo.exists? then Qbo.first.oauth2_refresh_token_expires_at end %>
|
||||
<td><%= QboConnectionService.current!&.oauth2_refresh_token_expires_at %>
|
||||
</tr>
|
||||
|
||||
</tbody>
|
||||
@@ -89,19 +89,19 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
|
||||
<br/>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_customer_count)%>:</b> <%= Customer.count%>
|
||||
<b><%=t(:label_customer_count)%>:</b> <%= Customer.count%> @ <%= Customer.last_sync %>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_employee_count)%>:</b> <%= Employee.count %>
|
||||
<b><%=t(:label_employee_count)%>:</b> <%= Employee.count %> @ <%= Employee.last_sync %>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_invoice_count)%>:</b> <%= Invoice.count %>
|
||||
<b><%=t(:label_invoice_count)%>:</b> <%= Invoice.count %> @ <%= Invoice.last_sync%>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_estimate_count)%>:</b> <%= Estimate.count %>
|
||||
<b><%=t(:label_estimate_count)%>:</b> <%= Estimate.count %> @ <%= Estimate.last_sync %>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
||||
@@ -1,31 +1,20 @@
|
||||
function updateLink() {
|
||||
console.log("updateLink called");
|
||||
const linkElement = document.getElementById("appointment_link");
|
||||
const regex = /((?:<br\/>|%3Cbr\/?%3E))([\s\S]*?)(&dates)/gi;
|
||||
linkElement.href = linkElement.href.replace(regex, `$1${getSelectedDocs()}$3`);
|
||||
}
|
||||
|
||||
function getSelectedDocs() {
|
||||
const invoices = document.querySelectorAll('.invoice-checkbox');
|
||||
const estimates = document.querySelectorAll('.estimate-checkbox');
|
||||
|
||||
const invoiceIds = Array.from(invoices)
|
||||
.filter(checkbox => checkbox.checked)
|
||||
.map(checkbox => checkbox.value);
|
||||
|
||||
const estimateIds = Array.from(estimates)
|
||||
.filter(checkbox => checkbox.checked)
|
||||
.map(checkbox => checkbox.value);
|
||||
const appointent_extras = document.querySelectorAll('.appointment');
|
||||
|
||||
let output = '';
|
||||
|
||||
for (const value of invoiceIds) {
|
||||
output += `%0A<a href="${window.location.origin}/invoices/${value}">Invoice:%20${value}</a>%0A`;
|
||||
for (const item of appointent_extras) {
|
||||
if (item.checked) {
|
||||
console.log(`Checked item: ${item.dataset.text} with URL: ${item.dataset.url}`);
|
||||
output += `%0A`+ encodeURIComponent(`<a href="${window.location.origin}${item.dataset.url}">${item.dataset.text}</a>`) +`%0A`;
|
||||
}
|
||||
}
|
||||
|
||||
for (const value of estimateIds) {
|
||||
output += `%0A<a href="${window.location.origin}/estimates/${value}">Estimate:%20${value}</a>%0A`;
|
||||
}
|
||||
|
||||
// You can return the array or use it as needed
|
||||
return output;
|
||||
}
|
||||
|
||||
@@ -11,94 +11,99 @@
|
||||
# English strings go here for Rails i18n
|
||||
# Usage I18n.t(:label)
|
||||
en:
|
||||
field_customer: "Customer"
|
||||
field_employee: "Employee"
|
||||
field_invoice: "Invoice"
|
||||
field_estimate: "Estimate"
|
||||
field_notes: "Notes"
|
||||
button_bulk_pdf: "Bulk PDF"
|
||||
customer_details: "Customer Details"
|
||||
field_billed: "Billed"
|
||||
label_week: "Week"
|
||||
label_search_estimates: "Search Estimates"
|
||||
label_search: "Search"
|
||||
label_estimates: "Estimates"
|
||||
warn_ru_sure: "You sure?"
|
||||
label_delete: "Delete"
|
||||
label_edit: "Edit"
|
||||
label_year: "Year"
|
||||
label_make: " Make"
|
||||
label_model: "Model"
|
||||
label_no_customers: "There are no customers containing the term(s)"
|
||||
label_matching: "Matching "
|
||||
label_open_issues: "Open Issues"
|
||||
label_closed_issues: "Closed Issues"
|
||||
label_sync: "Sync"
|
||||
label_new_customer: "New Customer"
|
||||
label_search_customers: "Search Customers"
|
||||
label_customers: "Customers"
|
||||
label_edit_customer: "Edit Customer"
|
||||
label_email: "Email"
|
||||
label_primary_phone: "Primary Phone"
|
||||
label_mobile_phone: "Mobile Phone"
|
||||
label_billing_address: "Billing Address"
|
||||
label_shipping_address: "Shipping Address"
|
||||
field_customer: "Customer"
|
||||
field_customers: "Customers"
|
||||
field_employee: "Employee"
|
||||
field_estimate: "Estimate"
|
||||
field_invoice: "Invoice"
|
||||
field_notes: "Notes"
|
||||
label_account_balance: "Account Balance"
|
||||
label_balance_with_jobs: "Balance With Jobs"
|
||||
label_display_name: "Display Name"
|
||||
label_details: "Details"
|
||||
label_customer_link_expires: "This customer link expires in"
|
||||
label_actions: "Actions"
|
||||
label_amount: "Amount"
|
||||
label_deposit_into: "Deposit to Account"
|
||||
label_last_sync: "Last Sync"
|
||||
label_redmine_qbo: "Redmine Quickbooks"
|
||||
label_customer_count: "Customer Count"
|
||||
label_invoice_count: "Invoice Count"
|
||||
label_estimate_count: "Estimate Count"
|
||||
label_employee_count: "Employee Count"
|
||||
label_appointment: "Add Appointment"
|
||||
label_balance_with_jobs: "Balance With Jobs"
|
||||
label_bill_time: "Bill Time"
|
||||
label_billing_address: "Billing Address"
|
||||
label_billing_enqueued: "Billing has been enqueued for issue"
|
||||
label_billed_success: "Successfully billed "
|
||||
label_client_id: "Intuit QBO OAuth2 Client ID"
|
||||
label_client_secret: "Intuit QBO OAuth2 Client Secret"
|
||||
label_webhook_token: "Intuit QBO Webhook Token"
|
||||
label_oauth_expires: "OAuth2 Access Token Expires At"
|
||||
label_oauth_note: "Note: You need to authenticate with Quickbooks after saving your key and secret above"
|
||||
field_customers: "Customers"
|
||||
label_closed_issues: "Closed Issues"
|
||||
label_connected: "Successfully connected to QuickBooks"
|
||||
label_create_estimate: "Create Estimate"
|
||||
label_customer_count: "Customer Count"
|
||||
label_customer_link_expires: "This customer link expires in"
|
||||
label_customers: "Customers"
|
||||
label_delete: "Delete"
|
||||
label_deposit_into: "Deposit to Account"
|
||||
label_details: "Details"
|
||||
label_display_name: "Display Name"
|
||||
label_door: "Door"
|
||||
label_edit: "Edit"
|
||||
label_edit_customer: "Edit Customer"
|
||||
label_email: "Email"
|
||||
label_employee_count: "Employee Count"
|
||||
label_error: "Error"
|
||||
label_estimate_404: "Estimate not found"
|
||||
label_estimate_count: "Estimate Count"
|
||||
label_estimates: "Estimates"
|
||||
label_hours: "Hours"
|
||||
label_invoice_404: "Invoice not found"
|
||||
label_invoice_count: "Invoice Count"
|
||||
label_invoices: "Invoices"
|
||||
label_last_sync: "Last Sync"
|
||||
label_load_customer: "Load Customer"
|
||||
label_make: "Make"
|
||||
label_matching: "Matching"
|
||||
label_mobile_phone: "Mobile Phone"
|
||||
label_model: "Model"
|
||||
label_name: "Name"
|
||||
label_new_customer: "New Customer"
|
||||
label_qbo_never_synced: "Never Synced"
|
||||
label_no_customers: "There are no customers matching the search term(s)."
|
||||
label_no_estimates: "No Estimates"
|
||||
label_no_invoices: "No Invoices"
|
||||
label_invoices: "Invoices"
|
||||
label_load_customer: "Load Customer"
|
||||
label_door: "Door"
|
||||
label_trim: "Trim"
|
||||
label_bill_time: "Bill Time"
|
||||
label_share: "Share"
|
||||
label_sync_now: "Sync Now"
|
||||
label_invoice_404: "Invoice not found"
|
||||
label_estimate_404: "Estimate not found"
|
||||
label_connected: "Successfully connected to Quickbooks"
|
||||
label_error: "Error"
|
||||
label_billed_success: "Successfully Billed "
|
||||
label_billing_error: "Cannot bill without a customer assigned"
|
||||
label_qbo_sync_success: "Successfully synced to Quickbooks"
|
||||
label_hours: "Hours"
|
||||
label_oauth2_refresh_token_expires_at: "Refresh Token Expires At"
|
||||
label_name: "Name"
|
||||
label_appointment: "Add Appointment"
|
||||
label_actions: "Actions"
|
||||
label_create_estimate: "Create Estimate"
|
||||
label_syncing: "Syncing Quickbooks"
|
||||
label_oauth_expires: "OAuth2 Access Token Expires At"
|
||||
label_oauth_note: "Note: You need to authenticate with QuickBooks after saving your key and secret above."
|
||||
label_open_issues: "Open Issues"
|
||||
label_primary_phone: "Primary Phone"
|
||||
label_qbo_sync_success: "Successfully synced to QuickBooks"
|
||||
label_redmine_qbo: "Redmine QuickBooks"
|
||||
label_sandbox: "Sandbox"
|
||||
button_bulk_pdf: "Bulk PDF"
|
||||
label_search: "Search"
|
||||
label_search_customers: "Search Customers"
|
||||
label_search_estimates: "Search Estimates"
|
||||
label_select_all: "Select All"
|
||||
notice_customer_created: "Customer created in Quickbooks"
|
||||
notice_customer_updated: "Customer updated in Quickbooks"
|
||||
notice_customer_not_found: "Customer not found in Quickbooks"
|
||||
notice_customer_not_deleted: "Customer could not be deleted in Quickbooks"
|
||||
notice_customer_deleted: "Customer deleted in Quickbooks"
|
||||
notice_estimate_created: "Estimate created in Quickbooks"
|
||||
notice_estimate_updated: "Estimate updated in Quickbooks"
|
||||
notice_estimate_not_found: "Estimate not found"
|
||||
notice_invoice_created: "Invoice created in Quickbooks"
|
||||
notice_invoice_updated: "Invoice updated in Quickbooks"
|
||||
label_share: "Share"
|
||||
label_shipping_address: "Shipping Address"
|
||||
label_sync: "Sync"
|
||||
label_sync_now: "Sync Now"
|
||||
label_syncing: "Syncing QuickBooks"
|
||||
label_trim: "Trim"
|
||||
label_webhook_token: "Intuit QBO Webhook Token"
|
||||
label_week: "Week"
|
||||
label_year: "Year"
|
||||
notice_billing_error_no_customer: "Cannot bill without an assigned customer."
|
||||
notice_billing_error_no_employee: "Cannot bill without an assigned employee."
|
||||
notice_billing_error_no_qbo: "Cannot bill without a QuickBooks connection. Please connect to QuickBooks and try again."
|
||||
notice_customer_created: "Customer created in QuickBooks"
|
||||
notice_customer_deleted: "Customer deleted in QuickBooks"
|
||||
notice_customer_not_deleted: "Customer could not be deleted in QuickBooks"
|
||||
notice_customer_not_found: "Customer not found in QuickBooks"
|
||||
notice_customer_updated: "Customer updated in QuickBooks"
|
||||
notice_error_issue_not_found: "The issue could not be found. Please check the issue and try again."
|
||||
notice_error_project_nil: "The issue's project is nil. Set project to:"
|
||||
notice_error_tracker_nil: "The issue's tracker is nil. Set tracker to:"
|
||||
notice_estimate_created: "Estimate created in QuickBooks"
|
||||
notice_estimate_not_found: "Estimate not found, we are syncing with QuickBooks to find it. Please check back shortly."
|
||||
notice_estimate_updated: "Estimate updated in QuickBooks"
|
||||
notice_forbidden: "You do not have permission to access this resource."
|
||||
notice_invoice_created: "Invoice created in QuickBooks"
|
||||
notice_invoice_not_found: "Invoice not found"
|
||||
notice_forbidden: "You do not have permission to access this resource"
|
||||
notice_invoice_updated: "Invoice updated in QuickBooks"
|
||||
notice_issue_not_found: "Issue not found"
|
||||
customer_details: "Customer Details"
|
||||
notice_error_project_nil: "The issue's project is nil, set project to: "
|
||||
notice_error_tracker_nil: "The issue's tracker is nil, set tracker to: "
|
||||
warn_ru_sure: "Are you sure?"
|
||||
@@ -11,45 +11,8 @@
|
||||
class AddTxnDates < ActiveRecord::Migration[5.1]
|
||||
|
||||
def change
|
||||
begin
|
||||
add_column :qbo_invoices, :txn_date, :date
|
||||
add_column :qbo_estimates, :txn_date, :date
|
||||
|
||||
reversible do |direction|
|
||||
direction.up {
|
||||
break unless Qbo.first
|
||||
|
||||
QboEstimate.reset_column_information
|
||||
QboInvoice.reset_column_information
|
||||
|
||||
say "Sync Estimates"
|
||||
|
||||
QboEstimate.sync
|
||||
|
||||
say "Sync Invoices"
|
||||
|
||||
qbo = Qbo.first
|
||||
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|
|
||||
# Load the invoice into the database
|
||||
qbo_invoice = QboInvoice.find_or_create_by(id: invoice.id)
|
||||
qbo_invoice.doc_number = invoice.doc_number
|
||||
qbo_invoice.id = invoice.id
|
||||
qbo_invoice.customer_id = invoice.customer_ref
|
||||
qbo_invoice.txn_date = invoice.txn_date
|
||||
qbo_invoice.save!
|
||||
}
|
||||
}
|
||||
end
|
||||
rescue
|
||||
logger.error "AddTxnDates Failed"
|
||||
end
|
||||
add_column :qbo_invoices, :txn_date, :date
|
||||
add_column :qbo_estimates, :txn_date, :date
|
||||
end
|
||||
|
||||
end
|
||||
15
db/migrate/038_add_customers_timestamp.rb
Normal file
@@ -0,0 +1,15 @@
|
||||
#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 AddCustomersTimestamp < ActiveRecord::Migration[5.1]
|
||||
def change
|
||||
add_timestamps(:customers, null: true)
|
||||
end
|
||||
end
|
||||
16
db/migrate/039_add_full_text_index_to_customers.rb
Normal file
@@ -0,0 +1,16 @@
|
||||
#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 AddFullTextIndexToCustomers < ActiveRecord::Migration[7.0]
|
||||
def change
|
||||
# This creates a combined index for name and phone fields
|
||||
add_index :customers, [:name, :phone_number, :mobile_phone_number], type: :fulltext, name: 'ft_search_idx'
|
||||
end
|
||||
end
|
||||
16
db/migrate/040_add_doc_timestamp.rb
Normal file
@@ -0,0 +1,16 @@
|
||||
#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 AddDocTimestamp < ActiveRecord::Migration[5.1]
|
||||
def change
|
||||
add_timestamps(:invoices, null: true)
|
||||
add_timestamps(:estimates, null: true)
|
||||
end
|
||||
end
|
||||
24
db/migrate/041_add_invoice_fields.rb
Normal file
@@ -0,0 +1,24 @@
|
||||
#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 AddInvoiceFields < ActiveRecord::Migration[7.0]
|
||||
def change
|
||||
change_table :invoices, bulk: true do |t|
|
||||
t.date :due_date
|
||||
t.decimal :total_amount, precision: 15, scale: 2
|
||||
t.decimal :balance, precision: 15, scale: 2
|
||||
t.datetime :qbo_updated_at
|
||||
t.boolean :qbo_sync_locked, null: false, default: false
|
||||
end
|
||||
|
||||
add_index :invoices, :qbo_updated_at
|
||||
add_index :invoices, :qbo_sync_locked
|
||||
end
|
||||
end
|
||||
15
db/migrate/042_add_employee_timestamp.rb
Normal file
@@ -0,0 +1,15 @@
|
||||
#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 AddEmployeeTimestamp < ActiveRecord::Migration[7.0]
|
||||
def change
|
||||
add_timestamps(:employees, null: true)
|
||||
end
|
||||
end
|
||||
6
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.2.4'
|
||||
version '2026.3.6'
|
||||
url 'https://github.com/rickbarrette/redmine_qbo'
|
||||
author_url 'https://barrettefabrication.com'
|
||||
settings default: {empty: true}, partial: 'qbo/settings'
|
||||
@@ -37,6 +37,10 @@ Redmine::Plugin.register :redmine_qbo do
|
||||
# Register top menu items
|
||||
menu :top_menu, :customers, { controller: :customers, action: :index }, caption: :label_customers, if: Proc.new {User.current.logged?}
|
||||
|
||||
Redmine::Search.map do |search|
|
||||
search.register :customers
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
# Dynamically load all Hooks & Patches recursively
|
||||
|
||||
@@ -14,30 +14,13 @@ module RedmineQbo
|
||||
|
||||
include IssuesHelper
|
||||
|
||||
# Check the new issue form for a valid project.
|
||||
# This is added to help prevent 422 unprocessable entity errors when creating an issue
|
||||
# See https://github.com/redmine/redmine/blob/84483d63828d0cb2efbf5bd786a2f0d22e34c93d/app/controllers/issues_controller.rb#L179
|
||||
def controller_issues_new_before_save(context={})
|
||||
if context[:issue].project.nil?
|
||||
context[:issue].project = projects_for_select(context[:issue]).first
|
||||
Rails.logger.error I18n.t(:notice_error_project_nil) + context[:issue].project.to_s
|
||||
context[:controller].flash[:error] = I18n.t(:notice_error_project_nil) + context[:issue].project.to_s
|
||||
end
|
||||
|
||||
if context[:issue].tracker.nil?
|
||||
context[:issue].tracker = trackers_for_select(context[:issue]).first
|
||||
Rails.logger.error I18n.t(:notice_error_tracker_nil) + context[:issue].tracker.to_s
|
||||
context[:controller].flash[:error] = I18n.t(:notice_error_tracker_nil) + context[:issue].tracker.to_s
|
||||
end
|
||||
|
||||
return context
|
||||
end
|
||||
|
||||
# Edit Issue Form
|
||||
# Here we build the required form components before passing them to a partial view formatting.
|
||||
def view_issues_form_details_bottom(context={})
|
||||
log "view_issues_form_details_bottom: Building form components for quickbooks customer, estimate, and invoice data"
|
||||
f = context[:form]
|
||||
issue = context[:issue]
|
||||
project = context[:project]
|
||||
|
||||
# Customer Name Text Box with database backed autocomplete
|
||||
# onchange event will update the hidden customer_id field
|
||||
@@ -49,11 +32,23 @@ module RedmineQbo
|
||||
value: '#issue_customer'
|
||||
}
|
||||
|
||||
# We need to handle 3 cases for the onchange event of the customer name field:
|
||||
# 1. New issue Withough project: /issues/new.js
|
||||
# 2. New issue With project: /projects/rmt/issues/new.js
|
||||
# 3. Existing issue: /issues/<ID>/edit.js
|
||||
# The built in helper update_issue_form_path requires a project object to determine the correct path for new vs existing issues,
|
||||
# but it doesn't work for issue.project when creating new issues not in a project i.e. http://redmine.domain.com/issues/new .
|
||||
# So we need to figure out how to get a the @project from the controller calling the hook.
|
||||
#
|
||||
# If this is not handled correctly, it leads to a 422 error when creating a new issue and selecting a customer.
|
||||
js_path = "updateIssueFrom('#{escape_javascript update_issue_form_path(project, issue)}', this)"
|
||||
log js_path
|
||||
|
||||
# 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",
|
||||
onchange: "updateIssueFrom('#{escape_javascript update_issue_form_path(issue.project, issue)}', this)".html_safe
|
||||
onchange: js_path.html_safe
|
||||
|
||||
# Generate the drop down list of quickbooks estimates owned by the selected customer
|
||||
select_estimate = f.select :estimate_id,
|
||||
@@ -97,6 +92,12 @@ module RedmineQbo
|
||||
})
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[IssuesHookListener] #{msg}"
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
end
|
||||
@@ -20,7 +20,7 @@ module RedmineQbo
|
||||
#Employee.update_all
|
||||
|
||||
# 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
|
||||
return "<p>#{context[:form].select :employee_id, Employee.all.pluck(:name, :id), selected: @selected, include_blank: true}</p>"
|
||||
|
||||
@@ -15,10 +15,11 @@ module RedmineQbo
|
||||
|
||||
# Load the javascript to support the autocomplete forms
|
||||
def view_layouts_base_html_head(context = {})
|
||||
js = javascript_include_tag 'application.js', plugin: :redmine_qbo
|
||||
js += javascript_include_tag 'autocomplete-rails.js', plugin: :redmine_qbo
|
||||
js += javascript_include_tag 'checkbox_controller.js', plugin: :redmine_qbo
|
||||
return js
|
||||
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)
|
||||
])
|
||||
end
|
||||
|
||||
render_on :view_layouts_base_sidebar, partial: "qbo/sidebar"
|
||||
|
||||
@@ -12,25 +12,20 @@ require_dependency 'issue'
|
||||
|
||||
module RedmineQbo
|
||||
module Patches
|
||||
|
||||
# Patches Redmine's Issues dynamically.
|
||||
# Adds relationships for customers, estimates, invoices, customer_tokens
|
||||
# Adds before and after save hooks
|
||||
module IssuePatch
|
||||
|
||||
def self.included(base) # :nodoc:
|
||||
def self.included(base)
|
||||
base.extend(ClassMethods)
|
||||
|
||||
base.send(:include, InstanceMethods)
|
||||
|
||||
# Same as typing in the class
|
||||
base.class_eval do
|
||||
belongs_to :customer, primary_key: :id
|
||||
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_save :bill_time
|
||||
after_commit :enqueue_billing, on: :update
|
||||
end
|
||||
|
||||
end
|
||||
@@ -41,94 +36,43 @@ module RedmineQbo
|
||||
|
||||
module InstanceMethods
|
||||
|
||||
# Create billable time entries
|
||||
def bill_time
|
||||
logger.debug "QBO: Billing time for issue ##{id}"
|
||||
return unless status.is_closed?
|
||||
return if assigned_to.nil?
|
||||
return unless Qbo.first
|
||||
return unless customer
|
||||
# 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?
|
||||
|
||||
Thread.new do
|
||||
spent_time = time_entries.where(billed: [false, nil])
|
||||
spent_hours ||= spent_time.sum(:hours) || 0
|
||||
log "Enqueuing billing for issue ##{id}"
|
||||
BillIssueTimeJob.perform_later(id)
|
||||
end
|
||||
|
||||
if spent_hours > 0 then
|
||||
# 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}"
|
||||
|
||||
# Prepare to create a new Time Activity
|
||||
qbo = Qbo.first
|
||||
qbo.perform_authenticated_request do |access_token|
|
||||
time_service = Quickbooks::Service::TimeActivity.new(company_id: qbo.realm_id, access_token: access_token)
|
||||
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.
|
||||
# This will simpify the invoicing with a single billable time entry per time activity
|
||||
h = Hash.new(0)
|
||||
spent_time.each do |entry|
|
||||
h[entry.activity.name] += entry.hours
|
||||
# update time entries billed status
|
||||
entry.billed = true
|
||||
entry.save
|
||||
end
|
||||
|
||||
# Now letes upload our totals for each activity as their own billable time entry
|
||||
h.each do |key, val|
|
||||
|
||||
# Convert float spent time to hours and minutes
|
||||
hours = val.to_i
|
||||
minutesDecimal = (( val - hours) * 60)
|
||||
minutes = minutesDecimal.to_i
|
||||
|
||||
# Lets match the activity to an qbo item
|
||||
item = item_service.query("SELECT * FROM Item WHERE Name = '#{key}' ").first
|
||||
next if item.nil?
|
||||
|
||||
# Create the new billable time entry and upload it
|
||||
time_entry.description = "#{tracker} ##{id}: #{subject} #{"(Partial @ #{done_ratio}%)" if not closed?}"
|
||||
time_entry.employee_id = assigned_to.employee_id
|
||||
time_entry.customer_id = customer_id
|
||||
time_entry.billable_status = "Billable"
|
||||
time_entry.hours = hours
|
||||
time_entry.minutes = minutes
|
||||
time_entry.name_of = "Employee"
|
||||
time_entry.txn_date = Date.today
|
||||
time_entry.hourly_rate = item.unit_price
|
||||
time_entry.item_id = item.id
|
||||
time_entry.start_time = start_date
|
||||
time_entry.end_time = Time.now
|
||||
time_service.create(time_entry)
|
||||
end
|
||||
end
|
||||
self.subject = subject.split(/\s+/).map do |word|
|
||||
if word =~ /[A-Z]/ && word =~ /[0-9]/
|
||||
word
|
||||
else
|
||||
word.capitalize
|
||||
end
|
||||
end
|
||||
end.join(' ')
|
||||
end
|
||||
end
|
||||
|
||||
# Create a shareable link for a customer
|
||||
# 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.
|
||||
def share_token
|
||||
CustomerToken.get_token self
|
||||
CustomerToken.get_token(self)
|
||||
end
|
||||
|
||||
# Titleize the subject before save , but keep words containing numbers mixed with letters capitalized
|
||||
def titlize_subject
|
||||
logger.debug "QBO: Titlizing subject for issue ##{self.id}"
|
||||
self.subject = self.subject.split(/\s+/).map do |word|
|
||||
# If word is NOT purely alphanumeric (contains special chars),
|
||||
# or is all upper/lower, we can handle it.
|
||||
# excluding alphanumeric strings with mixed case and numbers (e.g., "ID555ABC") from being altered.
|
||||
if word =~ /[A-Z]/ && word =~ /[0-9]/
|
||||
word
|
||||
else
|
||||
word.downcase
|
||||
word.capitalize
|
||||
end
|
||||
end.join(' ')
|
||||
private
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[IssuePatch] #{msg}"
|
||||
end
|
||||
end
|
||||
|
||||
# Add module to Issue
|
||||
Issue.send(:include, IssuePatch)
|
||||
|
||||
end
|
||||
end
|
||||
@@ -58,7 +58,7 @@ module RedmineQbo
|
||||
#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)
|
||||
|
||||
logger.debug "Calling :pdf_left hook"
|
||||
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|
|
||||
@@ -73,7 +73,7 @@ module RedmineQbo
|
||||
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)
|
||||
|
||||
logger.debug "Calling :pdf_right hook"
|
||||
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|
|
||||
@@ -260,8 +260,9 @@ module RedmineQbo
|
||||
|
||||
# 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(issue.estimate.pdf)
|
||||
pdf << CombinePDF.parse(e_pdf)
|
||||
return pdf.to_pdf
|
||||
end
|
||||
|
||||
@@ -269,6 +270,13 @@ module RedmineQbo
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[PdfPatch] #{msg}"
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
Redmine::Export::PDF::IssuesPdfHelper.send(:include, PdfPatch)
|
||||
|
||||
@@ -14,6 +14,20 @@ module RedmineQbo
|
||||
module Patches
|
||||
module QueryPatch
|
||||
|
||||
def base_scope
|
||||
scope = super
|
||||
|
||||
if filters['customer_name'].present?
|
||||
scope = scope.left_outer_joins(:customer)
|
||||
end
|
||||
|
||||
if has_column?(:customer) || filters['customer_name'].present?
|
||||
scope = scope.includes(:customer)
|
||||
end
|
||||
|
||||
scope
|
||||
end
|
||||
|
||||
# Add qbo options to the aviable columns
|
||||
def available_columns
|
||||
unless @available_columns
|
||||
@@ -26,10 +40,27 @@ module RedmineQbo
|
||||
|
||||
# Add customers to filters
|
||||
def initialize_available_filters
|
||||
#add_available_filter "customer", type: :text
|
||||
#add_available_filter "customer_id", type: :list, name: l(:field_customer), :values => lambda {Customer.pluck(:name, :id).map {|name, id| [name, id.to_s]}}
|
||||
add_available_filter( 'customer_name', type: :text, name: l(:field_customer))
|
||||
super
|
||||
end
|
||||
|
||||
def sql_for_customer_name_field(field, operator, value)
|
||||
pattern = "%#{value.first}%"
|
||||
|
||||
sql = case operator
|
||||
when '~'
|
||||
"#{Customer.table_name}.name LIKE ?"
|
||||
when '!~'
|
||||
"#{Customer.table_name}.name NOT LIKE ?"
|
||||
else
|
||||
return nil
|
||||
end
|
||||
|
||||
Issue.joins(:customer).sanitize_sql_for_conditions([sql, pattern])
|
||||
end
|
||||
|
||||
|
||||
end
|
||||
|
||||
# Add module to Issue
|
||||
|
||||