Compare commits

...

130 Commits
js ... 2026.3.6

Author SHA1 Message Date
da0f7ffc56 2026.3.6
Refactored models and services to use a base class
2026-03-12 11:21:42 -04:00
4fa8be856a Refactored models to use base model 2026-03-12 11:14:45 -04:00
ffd8dc6332 Refactored Customer service to use a service base class 2026-03-12 09:48:36 -04:00
cd219a0c00 fixed spelling entities 2026-03-11 20:01:14 -04:00
cd88ce6217 2026.3.5 2026-03-09 08:22:26 -04:00
b10665355d Allow Subclasses to override the page size 2026-03-08 23:34:37 -04:00
17ac19e435 2026.3.4 2026-03-08 21:59:47 -04:00
ef5089438c Fixed query_in_batches 2026-03-08 21:51:31 -04:00
1f64e36892 2026.3.3 2026-03-08 15:22:20 -04:00
643b15391b Added support for adding other QBO entities from othe plugins 2026-03-08 15:04:57 -04:00
d8a26f98c0 updaed readme 2026-03-07 13:28:31 -05:00
8fc01cd8fb Updated Readme 2026-03-06 23:05:43 -05:00
fe3da8c452 removed redundant exception 2026-03-05 22:03:22 -05:00
c4c02f8d27 2026.3.2 2026-03-05 21:34:20 -05:00
00b1baa1f3 Fixed create new customer 2026-03-05 21:33:49 -05:00
2520892e2c 2026.3.1 2026-03-04 20:14:16 -05:00
b96678a2e9 fixed accident deleteion details_cache_key 2026-03-04 20:09:13 -05:00
bccfcd9dbc cache qbo details to reduce api calls 2026-03-04 20:06:22 -05:00
8ba99b7db2 Fixed eager loading issues 2026-03-04 19:18:06 -05:00
aff7d0c48e removed uneeded logging of issue and project contents. 2026-03-04 18:37:30 -05:00
e9b3b1c838 Merge branch 'master' into dev 2026-03-04 17:42:42 -05:00
2fc2f94cd1 Fixed combining of estimate pdf 2026-03-04 13:23:59 -05:00
9f9810686f removed logging 2026-03-03 20:36:23 -05:00
f041e1bce4 Added logging for completed pull 2026-03-03 20:05:19 -05:00
d44d5e2fb7 Fixed log prefix 2026-03-03 19:54:50 -05:00
4403267abb Moved QBO fetch from customer model into service 2026-03-03 19:49:36 -05:00
be400c2b2a Added logging for errors when editing 2026-03-03 19:22:15 -05:00
23e565a304 raise exceptions if not initialized properly 2026-03-02 22:57:13 -05:00
2e2b17fac3 log should be private 2026-03-02 22:54:26 -05:00
28db5cb8c8 removed unused code 2026-03-02 22:50:43 -05:00
0df15693d2 removed unused begin 2026-03-02 22:49:53 -05:00
f8b1c72394 show all customer when search is blank 2026-03-02 22:49:18 -05:00
899237c5ab Reduced blanket rescues, added respond_to_missing?, and extracted push into CustomerPushService 2026-03-02 22:41:22 -05:00
f02b50ae26 Added time stamps to each qbo entity model 2026-03-02 07:10:13 -05:00
485a977d1a Use Safe Navigation Operator &. 2026-03-01 21:31:28 -05:00
03d5a5d148 Always show sync status 2026-03-01 21:25:07 -05:00
0deab9dbd3 2026.3.0 2026-03-01 19:35:55 -05:00
899c9878c4 Fix: only attach invoices if document is updated 2026-03-01 19:27:23 -05:00
b95a3b6623 Refactor: Update billing error messages in locale for consistency and clarity 2026-03-01 12:35:54 -05:00
ef3f00c445 Refactor: Replace BillingValidator with inline validations in bill method and update error messages in locale 2026-03-01 12:29:20 -05:00
46f06df995 Removed unused service 2026-03-01 12:14:53 -05:00
b15b88f48d Fix: Correct I18n reference in last_sync method for proper translation 2026-03-01 01:07:43 -05:00
7b7b07b5fa fixed file name 2026-03-01 01:01:26 -05:00
16ca1caabc Refactor: Enhance QboWebhookProcessor with logging for signature validation 2026-03-01 00:58:46 -05:00
69d266bdca formatting 2026-03-01 00:45:27 -05:00
3728ec2a12 Refactor: Improve address formatting in CustomersController and enhance HTML rendering for billing and shipping addresses 2026-03-01 00:40:11 -05:00
cefa36c880 Removed unsued Customer destroy method 2026-03-01 00:28:57 -05:00
ed111fefe7 Refactor: Update QBO connection handling to use QboConnectionService for consistency across services and controllers 2026-03-01 00:27:06 -05:00
5a662f67b8 Removed sync from migration 2026-02-28 23:45:55 -05:00
6e90548dbb Removed unused method 2026-02-28 22:56:03 -05:00
f921f227e2 Refactor: Introduce PdfServiceBase for shared PDF fetching functionality and update Invoice/Estimate controllers to utilize new services 2026-02-28 21:59:01 -05:00
a34ae46358 Refactor: Simplify invoice PDF fetching and introduce InvoicePdfService for better organization 2026-02-28 21:36:16 -05:00
e4cfb0674e Refactor: Enhance estimate loading and syncing logic in EstimateController 2026-02-28 21:20:35 -05:00
348c521491 Added comments 2026-02-28 20:03:19 -05:00
6cee8c1d81 Fix: Remove logging of fetched page information in SyncServiceBase 2026-02-28 19:59:50 -05:00
d4a0aa1db5 Refactor: Introduce SyncServiceBase for shared functionality across sync services 2026-02-28 19:47:45 -05:00
12884a211e Added comments 2026-02-28 18:04:38 -05:00
4ed71f5667 Fix: Remove unnecessary QBO configuration check in billing enqueue method 2026-02-28 18:01:32 -05:00
8303dec501 Fix: Raise error if no QBO configuration is found in sync jobs 2026-02-28 17:58:11 -05:00
9b07ae7073 Fix: Ensure retry_on configuration specifies wait time and attempts for error handling 2026-02-28 17:51:48 -05:00
baf321d4d6 Fix: Update retry_on configuration to specify wait time for error handling 2026-02-28 17:51:31 -05:00
0a2d38a927 Update plugin version to 2026.2.16
Updated to use active jobs & services for all background work
2026-02-28 09:29:50 -05:00
b80dbaa015 Fix: Update last_update query to use correct timestamp field for customer sync 2026-02-28 09:11:01 -05:00
9e399b934b Fix: Update last_update query to use correct timestamp field for employee sync 2026-02-28 09:10:55 -05:00
cc6fd07435 Update notice for missing estimate to include syncing information with QuickBooks 2026-02-28 08:53:46 -05:00
7a50df24d9 Add logging to get_estimate method for better debugging 2026-02-28 08:53:38 -05:00
ca02ead9f9 Use delete not destroy 2026-02-28 08:35:51 -05:00
9089adaba0 removed uneeded comments 2026-02-28 08:35:35 -05:00
dc6eba8566 Refactor logging in PdfPatch to use custom log method for better clarity and consistency 2026-02-28 08:29:10 -05:00
19911b7940 Refactor EstimateSyncJob to support syncing by ID and document number; add EstimateSyncService for handling estimate synchronization 2026-02-28 08:24:25 -05:00
a80f59cc45 Refactor sync_by_id method in Estimate model to use EstimateSyncJob for syncing 2026-02-28 07:50:23 -05:00
eee99e4d83 Implement CustomerSyncService for customer synchronization and update CustomerSyncJob to support syncing by ID 2026-02-28 07:50:07 -05:00
b3f01bd372 Refactor persist method in InvoiceSyncService to use 'local' variable for clarity and add logging for updates 2026-02-28 07:41:22 -05:00
d1ba93d61a Refactor persist method in EmployeeSyncService to use 'local' variable for clarity 2026-02-28 07:41:05 -05:00
9a688c4841 Set primary_key 2026-02-27 23:39:34 -05:00
e94352e2c4 Added comment 2026-02-27 23:19:44 -05:00
ea0f42b68e Added comment 2026-02-27 23:18:40 -05:00
5a31c194a5 Added comments 2026-02-27 23:15:37 -05:00
6f8af9bba8 Implement Employee synchronization; add EmployeeSyncJob and EmployeeSyncService for improved background processing and logging 2026-02-27 23:07:12 -05:00
03109d5775 Refactor invoice processing and synchronization; implement InvoiceSyncJob and related services for improved background processing and logging 2026-02-27 22:33:04 -05:00
a1cbf9a0a9 Refactor logging in CustomerSyncJob to use a centralized log method; enhance consistency and readability of log messages 2026-02-27 22:32:42 -05:00
9c0f153518 Refactor logging across controllers and jobs to use a centralized log method; improve consistency and readability of log messages 2026-02-27 22:32:07 -05:00
f32b48296d Refactor estimate synchronization to use EstimateSyncJob; remove direct sync logic from Estimate model for improved background processing 2026-02-27 08:29:52 -05:00
3d37f01bff Added timestamps to estiamtes and invoices 2026-02-27 08:08:39 -05:00
889e9bf31f Refactor customer synchronization to use CustomerSyncJob; remove direct sync logic from Customer model for improved background processing 2026-02-27 08:00:38 -05:00
208e839e6a Refactor CustomerToken model for improved token management; streamline token generation and expiration handling, and enhance association with issues 2026-02-26 21:05:02 -05:00
4f55751500 Refactor QuickBooks webhook handling to use ActiveJob for processing; improve security with signature verification and streamline entity processing 2026-02-26 20:30:20 -05:00
a64016eb95 Refactor QBO billing to use ActiveJob; remove threaded billing and add manual job enqueue support 2026-02-26 19:48:29 -05:00
5d858ae186 Enhance customer search functionality by ordering results and refining search method 2026-02-25 22:05:52 -05:00
b38f850df3 2026.2.15 2026-02-25 21:13:55 -05:00
138e55933b Fixed creation of new customers. 2026-02-25 15:32:45 -05:00
5fbc169ade Restored old search 2026-02-25 08:08:02 -05:00
d6737a6747 2026.2.14 2026-02-22 19:11:14 -05:00
65db8f00a8 Improve customer search with Full-Text index and phonetic matching 2026-02-22 19:07:20 -05:00
0197dc2a30 removed unused method 2026-02-22 13:34:23 -05:00
cd1caa502d Merge branch 'master' into dev 2026-02-22 13:32:01 -05:00
4b45d24a75 Enhance Customer model with redmine's built in searchable and event capabilities 2026-02-22 13:31:28 -05:00
64a4526aa4 2026.2.13 2026-02-21 19:08:32 -05:00
3514401808 Add unique IDs to search forms for customers and estimates 2026-02-21 19:07:40 -05:00
3deafd8a6d Fixed search event_url 2026-02-21 11:35:15 -05:00
a54de28db5 Extending customers to Redmine's built in search 2026-02-21 11:20:20 -05:00
6434eea906 2026.2.12 2026-02-21 08:24:36 -05:00
9b656534ae Sanitize search, no little bobby tables 2026-02-21 08:23:58 -05:00
659a1fbcf0 2026.2.11 2026-02-20 19:11:31 -05:00
4dc1f5d0bd Enhance billing functionality in IssuePatch with detailed logging and self-references 2026-02-20 09:47:47 -05:00
02f34582f4 2026.2.10
Addressed the Bullet (the N+1 query detector) warning to include customers
2026-02-16 18:56:09 -05:00
2f9ef6304f scope.includes(:customer) 2026-02-16 18:53:29 -05:00
886d5f4ace 2026.2.9 2026-02-16 08:15:46 -05:00
1ade938eb3 Fixed Querying issues by customer name 2026-02-16 08:13:57 -05:00
3111f391f3 Filter by customer works now 2026-02-15 21:34:22 -05:00
d2b9113914 2026.2.8 2026-02-14 18:57:22 -05:00
447e048819 updated screensots 2026-02-14 09:32:40 -05:00
e7dfc3f2ad added sync estimates by id 2026-02-14 08:25:02 -05:00
139f5dd618 render partial on footer 2026-02-13 22:39:54 -05:00
9c11704d03 Added label_create_estimate 2026-02-13 20:45:59 -05:00
2ae53adf08 added needed trailing space 2026-02-13 20:37:42 -05:00
877c1b78a5 removed old comment 2026-02-13 18:38:42 -05:00
1d47703206 fixed indentiation 2026-02-13 18:37:12 -05:00
a069556ed9 Alphabetized: All keys are now in A-Z order for easier maintenance.
Branding: Changed "Quickbooks" to QuickBooks (capitalized B) to match official branding.

Grammar:

warn_ru_sure: Changed "You sure?" to "Are you sure?"

label_no_customers: Refined to "There are no customers matching the search term(s)."

label_billing_error: Added punctuation and clarified the phrasing.

Cleanup: Removed unnecessary spaces inside quotes (e.g., " Make" and "Matching ").
2026-02-13 18:33:48 -05:00
359c582e22 Fixed partial billing and added flash messages 2026-02-13 18:25:07 -05:00
e63b9e4217 use safe_join 2026-02-13 07:32:20 -05:00
6fd355d8cc 2026.2.7 2026-02-12 19:00:55 -05:00
e6b57392d1 Merge branch '422' 2026-02-12 18:59:32 -05:00
331c1eabeb seems to work without overiding the main issues _form 2026-02-11 19:59:41 -05:00
167385bb99 override issues form to add passing @project to issues hook 2026-02-11 19:31:01 -05:00
11b9876d4f Removed unused controller_issues_new_before_save that was used for finding the 422 error 2026-02-11 08:09:00 -05:00
9cf72821b0 2026.2.6 2026-02-11 08:05:28 -05:00
57adcce431 Refactor JavaScript path handling for issue form updates to help prevent 422 errors on new issue creation 2026-02-11 07:59:18 -05:00
7fdb15f7e8 more logging 2026-02-10 22:09:16 -05:00
6e11e05a24 2026.2.5 2026-02-09 21:54:01 -05:00
64 changed files with 2172 additions and 1230 deletions

320
README.md
View File

@@ -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 | | 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 1.0.0+ | Redmine 4 |
| Version 0.8.1 | Redmine 3 | | Version 0.8.1 | Redmine 3 |
## Features ---
* **Customer Assignment:** Issues can be assigned to a Customer via a dropdown in the edit Issue form. # Features
* 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
## Prerequisites ## Issue Billing Integration
* Sign up to become a developer for Intuit: https://developer.intuit.com/ * Assign a **QuickBooks Customer** to a Redmine Issue.
* Create your own application to obtain your API keys.
* Set up the webhook service to `https://redmine.yourdomain.com/qbo/webhook`
## Installation
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 * Optionally associate a **QuickBooks Estimate** with the Issue.
```
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**.
## Usage * Automatically associates a **QuickBooks Invoice** with the Issue.
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. ---
**Note:** After the initial synchronization, this plugin will receive push notifications via Intuit's webhook service. ## Automatic Time Activity Creation
## Companion Plugin Hooks When an Issue with an assigned Customer is closed:
* :pdf_left, { issue: issue }
* :pdf_right, { issue: issue } * A **Time Activity** is created in QuickBooks for each relevant Redmine Time Entry.
* :process_invoice_custom_fields, { issue: issue, invoice: invoice }
* :show_customer_view_right, {customer: @customer} * 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 ## License

BIN
Screenshots/issue.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 724 KiB

BIN
Screenshots/issue_form.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 520 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 346 KiB

After

Width:  |  Height:  |  Size: 672 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 303 KiB

After

Width:  |  Height:  |  Size: 538 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 240 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 512 KiB

View File

@@ -30,8 +30,6 @@ class CustomersController < ApplicationController
before_action :view_customer, except: [:new, :view] before_action :view_customer, except: [:new, :view]
skip_before_action :verify_authenticity_token, :check_if_login_required, only: [: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] autocomplete :customer, :name, full: true, extra_data: [:id]
def allowed_params def allowed_params
@@ -53,7 +51,7 @@ class CustomersController < ApplicationController
# display a list of all customers # display a list of all customers
def index def index
if params[:search] 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) if only_one_non_zero?(@customers)
redirect_to @customers.first redirect_to @customers.first
end end
@@ -68,128 +66,125 @@ class CustomersController < ApplicationController
# create a new customer # create a new customer
def create def create
@customer = Customer.new(allowed_params) @customer = Customer.new(allowed_params)
if @customer.save @customer.save
flash[:notice] = t :notice_customer_created log "Customer ##{@customer.id} created successfully."
redirect_to @customer flash[:notice] = t :notice_customer_created
else redirect_to @customer
flash[:error] = @customer.errors.full_messages.to_sentence rescue => e
redirect_to new_customer_path log "Failed to create customer: #{e.message}"
end flash[:error] = e.message
redirect_to new_customer_path
end end
# display a specific customer # display a specific customer
def show def show
begin @customer = Customer.find_by_id(params[:id])
@customer = Customer.find_by_id(params[:id]) return render_404 unless @customer
@issues = @customer.issues.order(id: :desc)
@billing_address = address_to_s(@customer.billing_address) @open_issues = @customer.issues
@shipping_address = address_to_s(@customer.shipping_address) .joins(:status)
@closed_issues = (@issues - @issues.open) .includes(:status, :project, :tracker, :priority)
@hours = 0 .where(issue_statuses: { is_closed: false })
@closed_hours = 0 .order(id: :desc)
@issues.open.each { |i| @hours+= i.total_spent_hours }
@closed_issues.each { |i| @closed_hours+= i.total_spent_hours } @closed_issues = @customer.issues
rescue .joins(:status)
flash[:error] = t :notice_customer_not_found .includes(:status, :project, :tracker, :priority)
render_404 .where(issue_statuses: { is_closed: true })
end .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 end
# return an HTML form for editing a customer # return an HTML form for editing a customer
def edit def edit
begin @customer = Customer.find_by_id(params[:id])
@customer = Customer.find_by_id(params[:id]) return render_404 unless @customer
rescue rescue => e
flash[:error] = t :notice_customer_not_found log "Failed to edit customer"
render_404 flash[:error] = e.message
end render_404
end end
# update a specific customer # update a specific customer
def update def update
begin @customer = Customer.find_by_id(params[:id])
@customer = Customer.find_by_id(params[:id]) @customer.update(allowed_params)
if @customer.update(allowed_params) flash[:notice] = t :notice_customer_updated
flash[:notice] = t :notice_customer_updated redirect_to @customer
redirect_to @customer rescue => e
else log "Failed to update customer: #{e.message}"
redirect_to edit_customer_path flash[:error] = e.message
flash[:error] = @customer.errors.full_messages.to_sentence if @customer.errors redirect_to edit_customer_path
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
end end
# creates new customer view tokens, removes expired tokens & redirects to newly created customer view with new token. # creates new customer view tokens, removes expired tokens & redirects to newly created customer view with new token.
def share def share
issue = Issue.find(params[:id])
Thread.new do token = issue.share_token
logger.info "Removing expired customer tokens" redirect_to view_path(token.token)
CustomerToken.remove_expired_tokens rescue ActiveRecord::RecordNotFound
ActiveRecord::Base.connection.close flash[:error] = t(:notice_issue_not_found)
end render_404
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
end end
# displays an issue for a customer with a provided security CustomerToken # displays an issue for a customer with a provided security CustomerToken
def view 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] # Load associated issue
begin @issue = @token.issue
@token.destroy if @token.expired? return render_403 unless @issue
raise "Token Expired" if @token.destroyed
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?
@changesets = @issue.changesets.visible.preload(:repository, :user).to_a # Optional: enforce token belongs to the issue's customer
@changesets.reverse! if User.current.wants_comments_in_reverse_order? return render_403 unless @issue.customer_id == @token.issue.customer_id
@relations = @issue.relations.select {|r| r.other_issue(@issue) && r.other_issue(@issue).visible? } # Store token in session for subsequent requests if needed
@allowed_statuses = @issue.new_statuses_allowed_to(User.current) session[:token] = @token.token
@priorities = IssuePriority.active
@time_entry = TimeEntry.new(issue: @issue, project: @issue.project) load_issue_data
@relation = IssueRelation.new rescue ActiveRecord::RecordNotFound
rescue render_403
flash[:error] = t :notice_forbidden
render_403
end
end end
private 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 # redmine permission - add customers
def add_customer def add_customer
global_check_permission(:add_customers) global_check_permission(:add_customers)
@@ -214,17 +209,30 @@ class CustomersController < ApplicationController
end end
# format a quickbooks address to a human readable string # format a quickbooks address to a human readable string
def address_to_s (address) def address_to_s(address)
return if address.nil? return if address.nil?
string = address.line1 if address.line1
string << "\n" + address.line2 if address.line2 lines = [
string << "\n" + address.line3 if address.line3 address.line1,
string << "\n" + address.line4 if address.line4 address.line2,
string << "\n" + address.line5 if address.line5 address.line3,
string << " " + address.city if address.city address.line4,
string << ", " + address.country_sub_division_code if address.country_sub_division_code address.line5
string << " " + address.postal_code if address.postal_code ].compact_blank
return string
city_line = [
address.city,
address.country_sub_division_code,
address.postal_code
].compact_blank.join(" ")
lines << city_line unless city_line.blank?
lines.join("\n")
end
def log(msg)
Rails.logger.info "[CustomersController] #{msg}"
end end
end end

View File

@@ -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. #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
class EstimateController < ApplicationController class EstimateController < ApplicationController
include AuthHelper include AuthHelper
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]
before_action :require_user, unless: proc {|c| session[:token].nil? } # Displays the estimate PDF in the browser or redirects with an error if not found.
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: proc {|c| session[:token].nil? }
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
#
def doc 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" # Displays the estimate PDF in the browser or redirects with an error if not found.
rescue def show
redirect_to :back, flash: { error: I18n.t(:notice_estimate_not_found) } 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
end 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

View File

@@ -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. #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
class InvoiceController < ApplicationController class InvoiceController < ApplicationController
include AuthHelper include AuthHelper
require 'combine_pdf'
before_action :require_user, 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: proc {|c| session[:token].nil? } skip_before_action :verify_authenticity_token, :check_if_login_required, unless: -> { session[:token].nil? }
# # Displays the invoice PDF in the browser or redirects with an error if not found.
# Downloads and forwards the invoice pdf
#
def show def show
logger.info("Processing request for URL: #{request.original_url}") log "Processing request for #{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)
# 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
send_data @pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf" invoice_ids = Array(params[:invoice_ids] || params[:id])
end pdf, ref = InvoicePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: invoice_ids)
rescue
redirect_to :back, flash: { error: I18n.t(:notice_invoice_not_found) } send_data pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf"
end
rescue StandardError => e
log "Invoice PDF failure: #{e.message}"
redirect_back fallback_location: root_path, flash: { error: I18n.t(:notice_invoice_not_found) }
end end
end
private
# Logs messages with a consistent prefix for easier debugging.
def log(msg)
Rails.logger.info "[InvoiceController] #{msg}"
end
end

View File

@@ -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. #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 class QboController < ApplicationController
require 'openssl'
include AuthHelper include AuthHelper
before_action :require_user, except: :webhook 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 # 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.
params.permit(:code, :state, :realmId, :id)
end
#
# Called when the user requests that Redmine to connect to QBO
#
def authenticate def authenticate
redirect_uri = "#{Setting.protocol}://#{Setting.host_name + qbo_oauth_callback_path}" redirect_to QboOauthService.authorization_url(callback_url: callback_url)
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
end end
# # 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.
# Called by QBO after authentication has been processed
#
def oauth_callback def oauth_callback
if params[:state].present? QboOauthService.exchange!(code: params[:code], callback_url: callback_url, realm_id: params[:realmId])
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_to qbo_sync_path, flash: { notice: I18n.t(:label_connected) }
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) rescue StandardError => e
log "OAuth failure: #{e.message}"
# Remove the last authentication information redirect_to plugin_settings_path(:redmine_qbo), flash: { error: I18n.t(:label_error) }
Qbo.delete_all
# 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
end 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 def bill
i = Issue.find_by_id params[:id] issue = Issue.find_by(id: params[:id])
if i.customer raise I18n.t(:notice_error_issue_not_found) unless issue
i.bill_time raise I18n.t(:notice_billing_error_no_customer) unless issue.customer
redirect_to i, flash: { notice: I18n.t(:label_billed_success) + i.customer.name } raise I18n.t(:notice_billing_error_no_employee) unless issue.assigned_to&.employee_id.present?
else raise I18n.t(:notice_billing_error_no_qbo) unless Qbo.exists?
redirect_to i, flash: { error: I18n.t(:label_billing_error) }
end
end
# Quickbooks Webhook Callback
def webhook
logger.info "Quickbooks is calling webhook" BillIssueTimeJob.perform_later(issue.id)
# 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 redirect_to issue, flash: { notice: "#{I18n.t(:label_billing_enqueued)} #{issue.customer.name}"}
obj = name.constantize
# for merge events rescue StandardError => e
obj.destroy(entity['deletedId']) if entity['deletedId'] redirect_to issue || root_path, flash: { error: e.message }
#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 end
# # Manual sync endpoint to trigger a full synchronization of QuickBooks entities with the local database. Enqueues all relevant sync jobs and redirects to the home page with a notice that syncing has started.
# Synchronizes the QboCustomer table with QBO
#
def sync def sync
logger.info "Syncing EVERYTHING" QboSyncDispatcher.full_sync!
# 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
redirect_to :home, flash: { notice: I18n.t(:label_syncing) } redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
end end
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

View 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

View 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

View 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

View 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

View 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

View 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

View 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

View 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

View File

@@ -13,12 +13,13 @@ module QuickbooksOauth
#== Instance Methods #== 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) def perform_authenticated_request(&block)
attempts = 0 attempts = 0
begin begin
yield oauth_access_token yield oauth_access_token
rescue OAuth2::Error, Quickbooks::AuthorizationFailure => ex 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... # to prevent an infinite loop here keep a counter and bail out after N times...
attempts += 1 attempts += 1
@@ -32,8 +33,9 @@ module QuickbooksOauth
end end
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! def refresh_token!
Rails.logger.info("QuickbooksOauth.refresh_token!") log "refresh_token!"
t = oauth_access_token t = oauth_access_token
refreshed = t.refresh! refreshed = t.refresh!
@@ -43,7 +45,7 @@ module QuickbooksOauth
oauth2_refresh_token_expires_at = 100.days.from_now oauth2_refresh_token_expires_at = 100.days.from_now
end end
Rails.logger.info("QuickbooksOauth.refresh_token!: #{oauth2_refresh_token_expires_at}") log "refresh_token!: #{oauth2_refresh_token_expires_at}"
update!( update!(
oauth2_access_token: refreshed.token, oauth2_access_token: refreshed.token,
@@ -53,20 +55,24 @@ module QuickbooksOauth
) )
end 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 def oauth_client
self.class.construct_oauth2_client self.class.construct_oauth2_client
end 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 def oauth_access_token
OAuth2::AccessToken.new(oauth_client, oauth2_access_token, refresh_token: oauth2_refresh_token) OAuth2::AccessToken.new(oauth_client, oauth2_access_token, refresh_token: oauth2_refresh_token)
end 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 def consumer
oauth_access_token oauth_access_token
end end
module ClassMethods 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 def construct_oauth2_client
oauth_consumer_key = Setting.plugin_redmine_qbo['settingsOAuthConsumerKey'] oauth_consumer_key = Setting.plugin_redmine_qbo['settingsOAuthConsumerKey']
@@ -74,7 +80,7 @@ module QuickbooksOauth
# Are we are playing in the sandbox? # Are we are playing in the sandbox?
Quickbooks.sandbox_mode = Setting.plugin_redmine_qbo[:sandbox] ? true : false Quickbooks.sandbox_mode = Setting.plugin_redmine_qbo[:sandbox] ? true : false
logger.info "Sandbox mode: #{Quickbooks.sandbox_mode}" log "Sandbox mode: #{Quickbooks.sandbox_mode}"
options = { options = {
site: "https://appcenter.intuit.com/connect/oauth2", site: "https://appcenter.intuit.com/connect/oauth2",
@@ -85,4 +91,11 @@ module QuickbooksOauth
end end
end end
private
def log(msg)
Rails.logger.info "[QuickbooksOauth] #{msg}"
end
end end

View File

@@ -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. #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 :issues
has_many :invoices has_many :invoices
has_many :estimates has_many :estimates
validates_presence_of :name
validates_presence_of :id, :name before_validation :normalize_phone_numbers
self.primary_key = :id self.primary_key = :id
# returns a human readable string acts_as_searchable columns: %w[name phone_number mobile_phone_number ],
def to_s scope: ->(_context) { left_joins(:project) },
return "#{self[:name]} - #{phone_number.split(//).last(4).join unless phone_number.nil?}" date_column: :updated_at
end
acts_as_event :title => Proc.new {|o| "#{o}"},
# Convenience Method :url => Proc.new {|o| { :controller => 'customers', :action => 'show', :id => o.id} },
# returns the customer's email :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 def email
pull unless @details details
begin return @details&.email_address&.address
return @details.email_address.address
rescue
return nil
end
end end
# Convenience Method # Updates the customer's email address
# Sets the email
def email=(s) def email=(s)
pull unless @details details
@details.email_address = s @details.email_address = s
end end
# Convenience Method # Customers are not bound by a project
# returns the customer's primary phone # but we need to implement this method for the Redmine::Acts::Searchable interface
def primary_phone def project
pull unless @details nil
begin
return @details.primary_phone.free_form_number
rescue
return nil
end
end 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 # returns the customer's mobile phone
def mobile_phone def mobile_phone
pull unless @details details
begin return @details&.mobile_phone&.free_form_number
return @details.mobile_phone.free_form_number
rescue
return nil
end
end end
# Convenience Method
# Updates the custome's mobile phone number # Updates the custome's mobile phone number
def mobile_phone=(n) def mobile_phone=(n)
pull unless @details details
pn = Quickbooks::Model::TelephoneNumber.new pn = Quickbooks::Model::TelephoneNumber.new
pn.free_form_number = n pn.free_form_number = n
@details.mobile_phone = pn @details.mobile_phone = pn
#update our locally stored number too
update_mobile_phone_number
end end
# Convenience Method
# Sets the notes
def notes=(s)
pull unless @details
@details.notes = s
end
# update the localy stored phone number as a plain string with no special chars
def update_phone_number
begin
self.phone_number = self.primary_phone.tr('^0-9', '')
rescue
return nil
end
end
# update the localy stored phone number as a plain string with no special chars
def update_mobile_phone_number
begin
self.mobile_phone_number = self.mobile_phone.tr('^0-9', '')
rescue
return nil
end
end
# Convenience Method
# Updates Both local DB name & QBO display_name # Updates Both local DB name & QBO display_name
def name=(s) def name=(s)
pull unless @details details
@details.display_name = s @details.display_name = s
super super
end end
# Magic Method # Normalizes phone numbers by removing non-digit characters. This method is called before validation to ensure that phone numbers are stored in a consistent format, which can help with searching and integration with external systems like QuickBooks Online.
# Maps Get/Set methods to QBO customer object def normalize_phone_numbers
def method_missing(sym, *arguments) self.phone_number = phone_number.to_s.gsub(/\D/, '') if phone_number.present?
# Check to see if the method exists self.mobile_phone_number = mobile_phone_number.to_s.gsub(/\D/, '') if mobile_phone_number.present?
if Quickbooks::Model::Customer.method_defined?(sym) end
# download details if required
pull unless @details # Sets the notes for the customer
method_name = sym.to_s def notes=(s)
# Setter details
if method_name[-1, 1] == "=" @details.notes = s
@details.method(method_name).call(arguments[0]) end
# Getter
else # returns the customer's primary phone
return @details.method(method_name).call def primary_phone
end details
end return @details&.primary_phone&.free_form_number
end end
# proforms a bruteforce sync operation # Updates the customer's primary phone number
# This needs to be simplified def primary_phone=(n)
def self.sync details
# Sync ALL customers if the database is empty pn = Quickbooks::Model::TelephoneNumber.new
qbo = Qbo.first pn.free_form_number = n
customers = qbo.perform_authenticated_request do |access_token| @details.primary_phone = pn
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
end end
# Searchs the database for a customer by name or phone number with out special chars # Seach for customers by name or phone number
def self.search(search) def self.search(search)
customers = where("name LIKE ? OR phone_number LIKE ? OR mobile_phone_number LIKE ?", "%#{search}%", "%#{search}%", "%#{search}%") #return none if search.blank?
return customers.order(:name) search = sanitize_sql_like(search)
where("name LIKE ? OR phone_number LIKE ? OR mobile_phone_number LIKE ?", "%#{search}%", "%#{search}%", "%#{search}%")
end end
# proforms a bruteforce sync operation # Override the defult redmine seach method to rank results by id
# This needs to be simplified def self.search_result_ranks_and_ids(tokens, user, project = nil, options = {})
def self.sync_by_id(id) return {} if tokens.blank?
qbo = Qbo.first
c = qbo.perform_authenticated_request do |access_token| scope = self.all
service = Quickbooks::Service::Customer.new(company_id: qbo.realm_id, access_token: access_token)
service.fetch_by_id(id) tokens.each do |token|
scope = scope.search(token)
end end
return unless c ids = scope.distinct.limit(options[:limit] || 100).pluck(:id)
ids.index_with { |id| 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 customer.new_record?
customer.delete
end
end
end end
# Push the updates # returns a human readable string
def save_with_push def to_s
begin last4 = phone_number&.last(4)
qbo = Qbo.first last4.present? ? "#{name} - #{last4}" : name.to_s
@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 end
alias_method :save_without_push, :save end
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
end
end

View File

@@ -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. #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
OAUTH_CONSUMER_SECRET = Setting.plugin_redmine_qbo['settingsOAuthConsumerSecret'] || 'CONFIGURE__' + SecureRandom.uuid validates :issue_id, presence: true
validates :token, presence: true, uniqueness: true
# 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
# generates an expiring date before_validation :generate_token, on: :create
def generate_expire_date before_validation :generate_expire_date, on: :create
self.expires_at = Time.now + 1.month
end
# set destroyed flag scope :active, -> { where("expires_at > ?", Time.current) }
def mark_as_destroyed
self.destroyed = true
end
# purge expired tokens TOKEN_EXPIRATION = 1.month
def self.remove_expired_tokens
where("expires_at < ?", Time.now).destroy_all # Check if the token has expired
end
# has the token expired?
def expired? def expired?
self.expires_at < Time.now expires_at.present? && expires_at <= Time.current
end 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) def self.get_token(issue)
return unless issue
# check to see if token exists & if it is expired return unless User.current.allowed_to?(:view_issues, issue.project)
token = find_by_issue_id issue.id
unless token.nil?
return token unless token.expired?
# remove expired tokens
token.destroy
end
# only create new token if we have an issue to attach it to token = active.find_by(issue_id: issue.id)
return create(issue_id: issue.id) if User.current.logged? return token if token
create!(issue: issue)
end end
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

View File

@@ -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. #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 has_many :users
validates_presence_of :id, :name validates_presence_of :id, :name
self.primary_key = :id
def self.sync end
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

View File

@@ -8,8 +8,8 @@
# #
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. #THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
class Estimate < ActiveRecord::Base class Estimate < QboBaseModel
has_and_belongs_to_many :issues has_and_belongs_to_many :issues
belongs_to :customer belongs_to :customer
validates_presence_of :doc_number, :id validates_presence_of :doc_number, :id
@@ -19,115 +19,10 @@ class Estimate < ActiveRecord::Base
def to_s def to_s
return self[:doc_number] return self[:doc_number]
end 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 # sync only one estimate
def self.sync_by_doc_number(number) def self.sync_by_doc_number(number)
logger.info "Syncing estimate by doc number #{number}" EstimateSyncJob.perform_later(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 end
# update an estimate end
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
end
end

View File

@@ -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. #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 has_and_belongs_to_many :issues
belongs_to :customer 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 self.primary_key = :id
# returns a human readable string # Return the invoice's document number as its string representation
def to_s def to_s
return self[:doc_number] 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 end
# pushes invoice updates end
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
end
end

View File

@@ -12,17 +12,35 @@ class Qbo < ActiveRecord::Base
include QuickbooksOauth include QuickbooksOauth
include Redmine::I18n include Redmine::I18n
validate :single_record_only, on: :create
# Updates last sync time stamp # Updates last sync time stamp
def self.update_time_stamp def self.update_time_stamp
date = DateTime.now date = DateTime.now
logger.info "Updating QBO timestamp to #{date}" log "Updating QBO timestamp to #{date}"
qbo = Qbo.first qbo = QboConnectionService.current!
qbo.last_sync = date qbo.last_sync = date
qbo.save qbo.save
end end
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
def self.last_sync 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 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 end

View File

@@ -0,0 +1,103 @@
#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
# 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
model_class = "Quickbooks::Model::#{model_name.name}".constantize
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)
model_class = "Quickbooks::Model::#{model_name.name}".constantize
if 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)
model_class = "Quickbooks::Model::#{model_name.name}".constantize
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
# Push the updates
def save_with_push
log "Starting push for #{model_name.name} ##{self.id}..."
qbo = QboConnectionService.current!
service = "#{model_name.name}Service".constantize
service.new(qbo: qbo, remote: self).push()
Rails.cache.delete(details_cache_key)
save_without_push
end
alias_method :save_without_push, :save
alias_method :save, :save_with_push
private
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 = "#{model_name.name}Service".constantize
service_class.new(qbo: qbo, remote: self).pull()
end
end

View 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

View 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

View 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

View 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

View 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

View 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

View 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

View 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

View 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

View 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

View 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

View 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

View 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

View 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 an optional remote 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 remote is provided, the service will not perform any operations.
def initialize(qbo:, remote: nil)
raise "No QBO configuration found" unless qbo
raise "#{@entity} record is required for push operation" unless remote
@qbo = qbo
@entity = remote.class.name
@remote = remote
end
# # Subclasses must implement this to specify which local model they sync (e.g. Customer, Invoice)
# def self.model_class
# raise NotImplementedError
# 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 @remote.present?
return build_qbo_remote unless @remote.id
log "Fetching details for #{@entity} ##{@remote.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(@remote.id)
end
rescue => e
log "Fetch failed for #{@remote.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} ##{@remote.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 @remote.id.present?
service.update(@remote.details)
else
service.create(@remote.details)
end
end
@remote.id = remote.id unless @remote.persisted?
log "Push for remote ##{@remote.id} completed."
return @remote
end
private
# Log messages with the entity type for better traceability
def log(msg)
Rails.logger.info "[#{@entity}Service] #{msg}"
end
end

View 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.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

View File

@@ -13,22 +13,22 @@
<tr> <tr>
<th><%=t(:label_primary_phone)%></th> <th><%=t(:label_primary_phone)%></th>
<td><%= number_to_phone(customer.primary_phone.gsub(/[^\d]/, '').to_i, area_code: true) if customer.primary_phone %></td> <td><%= number_to_phone(customer&.primary_phone&.gsub(/[^\d]/, '').to_i, area_code: true) %></td>
</tr> </tr>
<tr> <tr>
<th><%=t(:label_mobile_phone)%></th> <th><%=t(:label_mobile_phone)%></th>
<td><%= number_to_phone(customer.mobile_phone.gsub(/[^\d]/, '').to_i, area_code: true) if customer.mobile_phone %></td> <td><%= number_to_phone(customer&.mobile_phone&.gsub(/[^\d]/, '').to_i, area_code: true) %></td>
</tr> </tr>
<tr> <tr>
<th><%=t(:label_billing_address)%></th> <th><%=t(:label_billing_address)%></th>
<td><%= @billing_address %></td> <td><pre><%= @billing_address %></pre></td>
</tr> </tr>
<tr> <tr>
<th><%=t(:label_shipping_address)%></th> <th><%=t(:label_shipping_address)%></th>
<td><%= @shipping_address %></td> <td><pre><%= @shipping_address %></pre></td>
</tr> </tr>
<tr> <tr>

View File

@@ -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" %> <%= text_field_tag :search, params[:search], placeholder: t(:label_search_customers), autocomplete: "off" %>
<%= submit_tag t(:label_search) %> <%= submit_tag t(:label_search) %>
<% end %> <% end %>

View File

@@ -46,8 +46,8 @@
</div> </div>
<br/> <br/>
<h3><%=@issues.open.count%> <%=t(:label_open_issues)%> - <%=@hours.round(1)%> <%=t(:label_hours)%></h3> <h3><%=@open_issues.count%> <%=t(:label_open_issues)%> - <%=@hours.round(1)%> <%=t(:label_hours)%></h3>
<%= render partial: 'issues/list_simple', locals: {issues: @issues.open} %> <%= render partial: 'issues/list_simple', locals: {issues: @open_issues.open} %>
<h3><%=@closed_issues.count%> <%=t(:label_closed_issues)%> - <%= @closed_hours.round(1)%> <%=t(:label_hours)%></h3> <h3><%=@closed_issues.count%> <%=t(:label_closed_issues)%> - <%= @closed_hours.round(1)%> <%=t(:label_hours)%></h3>
<%= render partial: 'issues/list_simple', locals: {issues: @closed_issues} %> <%= render partial: 'issues/list_simple', locals: {issues: @closed_issues} %>

View File

@@ -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" %> <%= text_field_tag :search, params[:search], placeholder: t(:label_search_estimates), autocomplete: "off" %>
<%= submit_tag t(:label_search), formtarget: "_blank" %> <%= submit_tag t(:label_search), formtarget: "_blank" %>
<% end %> <% end %>

View File

@@ -1,3 +1,3 @@
"<div id='footer' align='center'> <div id='footer' align='center'>
<b><%=I18n.translate(:label_last_sync)%>: </b> <%=Qbo.last_sync if Qbo.exists?%> <%= render partial: 'qbo/last_sync' %>
</div>" </div>

View File

@@ -1 +1 @@
<b><%=t(:label_last_sync)%>: </b> <%= Qbo.last_sync if Qbo.exists? %> <b><%=t(:label_last_sync)%>: </b> <%= Qbo.last_sync %>

View File

@@ -66,12 +66,12 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
<tr> <tr>
<th><%=t(:label_oauth_expires)%></th> <th><%=t(:label_oauth_expires)%></th>
<td><%= if Qbo.exists? then Qbo.first.oauth2_access_token_expires_at end %> <td><%= QboConnectionService.current!&.oauth2_access_token_expires_at %>
</tr> </tr>
<tr> <tr>
<th><%=t(:label_oauth2_refresh_token_expires_at)%></th> <th><%=t(:label_oauth2_refresh_token_expires_at)%></th>
<td><%= if Qbo.exists? then Qbo.first.oauth2_refresh_token_expires_at end %> <td><%= QboConnectionService.current!&.oauth2_refresh_token_expires_at %>
</tr> </tr>
</tbody> </tbody>
@@ -89,19 +89,19 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
<br/> <br/>
<div> <div>
<b><%=t(:label_customer_count)%>:</b> <%= Customer.count%> <b><%=t(:label_customer_count)%>:</b> <%= Customer.count%> @ <%= Customer.last_sync %>
</div> </div>
<div> <div>
<b><%=t(:label_employee_count)%>:</b> <%= Employee.count %> <b><%=t(:label_employee_count)%>:</b> <%= Employee.count %> @ <%= Employee.last_sync %>
</div> </div>
<div> <div>
<b><%=t(:label_invoice_count)%>:</b> <%= Invoice.count %> <b><%=t(:label_invoice_count)%>:</b> <%= Invoice.count %> @ <%= Invoice.last_sync%>
</div> </div>
<div> <div>
<b><%=t(:label_estimate_count)%>:</b> <%= Estimate.count %> <b><%=t(:label_estimate_count)%>:</b> <%= Estimate.count %> @ <%= Estimate.last_sync %>
</div> </div>
<br/> <br/>

View File

@@ -9,14 +9,12 @@ function getSelectedDocs() {
const appointent_extras = document.querySelectorAll('.appointment'); const appointent_extras = document.querySelectorAll('.appointment');
let output = ''; let output = '';
for (const item of appointent_extras) { for (const item of appointent_extras) {
if (item.checked) { if (item.checked) {
console.log(`Checked item: ${item.dataset.text} with URL: ${item.dataset.url}`); 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`; output += `%0A`+ encodeURIComponent(`<a href="${window.location.origin}${item.dataset.url}">${item.dataset.text}</a>`) +`%0A`;
} }
} }
// You can return the array or use it as needed
return output; return output;
} }

View File

@@ -11,94 +11,99 @@
# English strings go here for Rails i18n # English strings go here for Rails i18n
# Usage I18n.t(:label) # Usage I18n.t(:label)
en: en:
field_customer: "Customer" button_bulk_pdf: "Bulk PDF"
field_employee: "Employee" customer_details: "Customer Details"
field_invoice: "Invoice"
field_estimate: "Estimate"
field_notes: "Notes"
field_billed: "Billed" field_billed: "Billed"
label_week: "Week" field_customer: "Customer"
label_search_estimates: "Search Estimates" field_customers: "Customers"
label_search: "Search" field_employee: "Employee"
label_estimates: "Estimates" field_estimate: "Estimate"
warn_ru_sure: "You sure?" field_invoice: "Invoice"
label_delete: "Delete" field_notes: "Notes"
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"
label_account_balance: "Account Balance" label_account_balance: "Account Balance"
label_balance_with_jobs: "Balance With Jobs" label_actions: "Actions"
label_display_name: "Display Name"
label_details: "Details"
label_customer_link_expires: "This customer link expires in"
label_amount: "Amount" label_amount: "Amount"
label_deposit_into: "Deposit to Account" label_appointment: "Add Appointment"
label_last_sync: "Last Sync" label_balance_with_jobs: "Balance With Jobs"
label_redmine_qbo: "Redmine Quickbooks" label_bill_time: "Bill Time"
label_customer_count: "Customer Count" label_billing_address: "Billing Address"
label_invoice_count: "Invoice Count" label_billing_enqueued: "Billing has been enqueued for issue"
label_estimate_count: "Estimate Count" label_billed_success: "Successfully billed "
label_employee_count: "Employee Count"
label_client_id: "Intuit QBO OAuth2 Client ID" label_client_id: "Intuit QBO OAuth2 Client ID"
label_client_secret: "Intuit QBO OAuth2 Client Secret" label_client_secret: "Intuit QBO OAuth2 Client Secret"
label_webhook_token: "Intuit QBO Webhook Token" label_closed_issues: "Closed Issues"
label_oauth_expires: "OAuth2 Access Token Expires At" label_connected: "Successfully connected to QuickBooks"
label_oauth_note: "Note: You need to authenticate with Quickbooks after saving your key and secret above" label_create_estimate: "Create Estimate"
field_customers: "Customers" 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_estimates: "No Estimates"
label_no_invoices: "No Invoices" 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_oauth2_refresh_token_expires_at: "Refresh Token Expires At"
label_name: "Name" label_oauth_expires: "OAuth2 Access Token Expires At"
label_appointment: "Add Appointment" label_oauth_note: "Note: You need to authenticate with QuickBooks after saving your key and secret above."
label_actions: "Actions" label_open_issues: "Open Issues"
label_create_estimate: "Create Estimate" label_primary_phone: "Primary Phone"
label_syncing: "Syncing Quickbooks" label_qbo_sync_success: "Successfully synced to QuickBooks"
label_redmine_qbo: "Redmine QuickBooks"
label_sandbox: "Sandbox" 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" label_select_all: "Select All"
notice_customer_created: "Customer created in Quickbooks" label_share: "Share"
notice_customer_updated: "Customer updated in Quickbooks" label_shipping_address: "Shipping Address"
notice_customer_not_found: "Customer not found in Quickbooks" label_sync: "Sync"
notice_customer_not_deleted: "Customer could not be deleted in Quickbooks" label_sync_now: "Sync Now"
notice_customer_deleted: "Customer deleted in Quickbooks" label_syncing: "Syncing QuickBooks"
notice_estimate_created: "Estimate created in Quickbooks" label_trim: "Trim"
notice_estimate_updated: "Estimate updated in Quickbooks" label_webhook_token: "Intuit QBO Webhook Token"
notice_estimate_not_found: "Estimate not found" label_week: "Week"
notice_invoice_created: "Invoice created in Quickbooks" label_year: "Year"
notice_invoice_updated: "Invoice updated in Quickbooks" 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_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" notice_issue_not_found: "Issue not found"
customer_details: "Customer Details" warn_ru_sure: "Are you sure?"
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: "

View File

@@ -11,45 +11,8 @@
class AddTxnDates < ActiveRecord::Migration[5.1] class AddTxnDates < ActiveRecord::Migration[5.1]
def change def change
begin add_column :qbo_invoices, :txn_date, :date
add_column :qbo_invoices, :txn_date, :date add_column :qbo_estimates, :txn_date, :date
add_column :qbo_estimates, :txn_date, :date
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
end end
end end

View 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

View 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

View 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

View 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

View 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

View File

@@ -14,7 +14,7 @@ Redmine::Plugin.register :redmine_qbo do
name 'Redmine QBO plugin' name 'Redmine QBO plugin'
author 'Rick Barrette' author 'Rick Barrette'
description 'A pluging for Redmine to connect with QuickBooks Online to create Time Activity Entries for billable hours logged when an Issue is closed' description 'A pluging for Redmine to connect with QuickBooks Online to create Time Activity Entries for billable hours logged when an Issue is closed'
version '2026.2.4' version '2026.3.6'
url 'https://github.com/rickbarrette/redmine_qbo' url 'https://github.com/rickbarrette/redmine_qbo'
author_url 'https://barrettefabrication.com' author_url 'https://barrettefabrication.com'
settings default: {empty: true}, partial: 'qbo/settings' settings default: {empty: true}, partial: 'qbo/settings'
@@ -37,6 +37,10 @@ Redmine::Plugin.register :redmine_qbo do
# Register top menu items # Register top menu items
menu :top_menu, :customers, { controller: :customers, action: :index }, caption: :label_customers, if: Proc.new {User.current.logged?} 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 end
# Dynamically load all Hooks & Patches recursively # Dynamically load all Hooks & Patches recursively

View File

@@ -14,30 +14,13 @@ module RedmineQbo
include IssuesHelper 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 # Edit Issue Form
# Here we build the required form components before passing them to a partial view formatting. # Here we build the required form components before passing them to a partial view formatting.
def view_issues_form_details_bottom(context={}) 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] f = context[:form]
issue = context[:issue] issue = context[:issue]
project = context[:project]
# Customer Name Text Box with database backed autocomplete # Customer Name Text Box with database backed autocomplete
# onchange event will update the hidden customer_id field # onchange event will update the hidden customer_id field
@@ -49,11 +32,23 @@ module RedmineQbo
value: '#issue_customer' 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 # 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 # the onchange event will reload the issue form via ajax to update the available estimates
customer_id = f.hidden_field :customer_id, customer_id = f.hidden_field :customer_id,
id: "issue_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 # Generate the drop down list of quickbooks estimates owned by the selected customer
select_estimate = f.select :estimate_id, select_estimate = f.select :estimate_id,
@@ -96,6 +91,12 @@ module RedmineQbo
} }
}) })
end end
private
def log(msg)
Rails.logger.info "[IssuesHookListener] #{msg}"
end
end end
end end

View File

@@ -20,7 +20,7 @@ module RedmineQbo
#Employee.update_all #Employee.update_all
# Check to see if there is a quickbooks user attached to the issue # Check to see if there is a quickbooks user attached to the issue
@selected = context[:user].employee.id if context[:user].employee @selected = context[:user]&.employee&.id
# Generate the drop down list of quickbooks contacts # Generate the drop down list of quickbooks contacts
return "<p>#{context[:form].select :employee_id, Employee.all.pluck(:name, :id), selected: @selected, include_blank: true}</p>" return "<p>#{context[:form].select :employee_id, Employee.all.pluck(:name, :id), selected: @selected, include_blank: true}</p>"

View File

@@ -15,10 +15,11 @@ module RedmineQbo
# Load the javascript to support the autocomplete forms # Load the javascript to support the autocomplete forms
def view_layouts_base_html_head(context = {}) def view_layouts_base_html_head(context = {})
js = javascript_include_tag 'application.js', plugin: :redmine_qbo safe_join([
js += javascript_include_tag 'autocomplete-rails.js', plugin: :redmine_qbo javascript_include_tag( 'application.js', plugin: :redmine_qbo),
js += javascript_include_tag 'checkbox_controller.js', plugin: :redmine_qbo javascript_include_tag( 'autocomplete-rails.js', plugin: :redmine_qbo),
return js javascript_include_tag( 'checkbox_controller.js', plugin: :redmine_qbo)
])
end end
render_on :view_layouts_base_sidebar, partial: "qbo/sidebar" render_on :view_layouts_base_sidebar, partial: "qbo/sidebar"

View File

@@ -12,123 +12,67 @@ require_dependency 'issue'
module RedmineQbo module RedmineQbo
module Patches module Patches
# Patches Redmine's Issues dynamically.
# Adds relationships for customers, estimates, invoices, customer_tokens
# Adds before and after save hooks
module IssuePatch module IssuePatch
def self.included(base) # :nodoc: def self.included(base)
base.extend(ClassMethods) base.extend(ClassMethods)
base.send(:include, InstanceMethods) base.send(:include, InstanceMethods)
# Same as typing in the class
base.class_eval do 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 :customer_token, primary_key: :id
belongs_to :estimate, primary_key: :id belongs_to :estimate, primary_key: :id
has_and_belongs_to_many :invoices has_and_belongs_to_many :invoices
before_save :titlize_subject before_save :titlize_subject
after_save :bill_time after_commit :enqueue_billing, on: :update
end end
end end
module ClassMethods module ClassMethods
end end
module InstanceMethods 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
Thread.new do # 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.
spent_time = time_entries.where(billed: [false, nil]) def enqueue_billing
spent_hours ||= spent_time.sum(:hours) || 0 log "Checking if issue needs to be billed for issue ##{id}"
return unless closed?
if spent_hours > 0 then return unless customer.present?
return unless assigned_to&.employee_id.present?
# 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 log "Enqueuing billing for issue ##{id}"
item = item_service.query("SELECT * FROM Item WHERE Name = '#{key}' ").first BillIssueTimeJob.perform_later(id)
next if item.nil? end
# Create the new billable time entry and upload it # Titlize the subject of the issue before saving to ensure consistent formatting for billing descriptions in Quickbooks
time_entry.description = "#{tracker} ##{id}: #{subject} #{"(Partial @ #{done_ratio}%)" if not closed?}" def titlize_subject
time_entry.employee_id = assigned_to.employee_id log "Titlizing subject for issue ##{id}"
time_entry.customer_id = customer_id
time_entry.billable_status = "Billable" self.subject = subject.split(/\s+/).map do |word|
time_entry.hours = hours if word =~ /[A-Z]/ && word =~ /[0-9]/
time_entry.minutes = minutes word
time_entry.name_of = "Employee" else
time_entry.txn_date = Date.today word.capitalize
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
end end
end end.join(' ')
end end
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 def share_token
CustomerToken.get_token self CustomerToken.get_token(self)
end 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(' ')
end
end
# Add module to Issue private
def log(msg)
Rails.logger.info "[IssuePatch] #{msg}"
end
end
Issue.send(:include, IssuePatch) Issue.send(:include, IssuePatch)
end end
end end

View File

@@ -58,7 +58,7 @@ module RedmineQbo
#left << [l(:field_category), issue.category] unless issue.disabled_core_fields.include?(:category_id) #left << [l(:field_category), issue.category] unless issue.disabled_core_fields.include?(:category_id)
#left << [l(:field_fixed_version), issue.fixed_version] unless issue.disabled_core_fields.include?(:fixed_version_id) #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 } left_hook_output = Redmine::Hook.call_hook :pdf_left, { issue: issue }
unless left_hook_output.nil? unless left_hook_output.nil?
left_hook_output.each do |l| 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(: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) 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 } right_hook_output = Redmine::Hook.call_hook :pdf_right, { issue: issue }
unless right_hook_output.nil? unless right_hook_output.nil?
right_hook_output.each do |r| right_hook_output.each do |r|
@@ -260,8 +260,9 @@ module RedmineQbo
# Check to see if there is an estimate attached, then combine them # Check to see if there is an estimate attached, then combine them
if issue.estimate if issue.estimate
e_pdf, ref = EstimatePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: [issue.estimate.id])
pdf = CombinePDF.parse(pdf.output, allow_optional_content: true) pdf = CombinePDF.parse(pdf.output, allow_optional_content: true)
pdf << CombinePDF.parse(issue.estimate.pdf) pdf << CombinePDF.parse(e_pdf)
return pdf.to_pdf return pdf.to_pdf
end end
@@ -269,6 +270,13 @@ module RedmineQbo
end end
end end
private
def log(msg)
Rails.logger.info "[PdfPatch] #{msg}"
end
end end
Redmine::Export::PDF::IssuesPdfHelper.send(:include, PdfPatch) Redmine::Export::PDF::IssuesPdfHelper.send(:include, PdfPatch)

View File

@@ -13,6 +13,20 @@ require_dependency 'issue_query'
module RedmineQbo module RedmineQbo
module Patches module Patches
module QueryPatch 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 # Add qbo options to the aviable columns
def available_columns def available_columns
@@ -26,10 +40,27 @@ module RedmineQbo
# Add customers to filters # Add customers to filters
def initialize_available_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 super
end 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 end
# Add module to Issue # Add module to Issue