mirror of
https://github.com/rickbarrette/redmine_qbo.git
synced 2026-11-19 10:40:36 -05:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
e61217b719 | ||
|
|
b8ddf1c38b | ||
|
|
f1d81890de | ||
|
|
609ddb098a | ||
|
|
c4ab97b75e | ||
|
|
0523e8dd24 | ||
|
|
aacc2d645d | ||
|
|
cf3342bcc5 | ||
|
|
bab019a152 | ||
|
|
fd91bd6fa2 | ||
|
|
04a0eede5f | ||
|
|
ba40496421 | ||
|
|
57dc8127b0 | ||
|
|
9dc4b79355 | ||
|
|
8ae82f1423 | ||
|
|
b72c82fb2b | ||
|
|
b901e64149 | ||
|
|
7abb1aa06c | ||
|
|
dfd3a641db | ||
|
|
75e5aeb668 | ||
|
|
ea29990cfa | ||
|
|
c31ec82e61 | ||
|
|
938f9d9f3b | ||
|
|
f2b0186ee2 | ||
|
|
9373963c94 | ||
|
|
396a56ceec | ||
|
|
b3c3006b56 | ||
|
|
576ca5a0a9 | ||
|
|
d18a0c180a | ||
|
|
baca0ed6c7 | ||
|
|
6bf84dd61a | ||
|
|
61b02831e3 | ||
|
|
7c79f2388a | ||
|
|
36267893bd | ||
|
|
e681203a45 | ||
|
|
681e7f8047 | ||
|
|
4a6c414d9e | ||
|
|
925cb1d2bc | ||
|
|
1dcccd7b98 | ||
|
|
f73973a4e1 | ||
|
|
7cd388dbd4 | ||
|
|
7149e85d37 | ||
|
|
eacdecd65b | ||
|
|
ee2ab04206 | ||
|
|
8a8c6f5fa0 | ||
|
|
cc36bc16b4 | ||
|
|
874ec7c2dc | ||
|
|
f3fe38cd57 | ||
|
|
977cbfe0e1 | ||
|
|
82712f361c | ||
|
|
4ae7d75478 | ||
|
|
8fb9d74277 | ||
|
|
b0e6236cee | ||
|
|
b367687113 | ||
|
|
460bcd466f | ||
|
|
020ea01d36 | ||
|
|
df079b767c | ||
|
|
7d3908ec41 | ||
|
|
f60e507029 | ||
|
|
3e6650ee65 | ||
|
|
c2d0e5c702 | ||
|
|
a4f461fd4d | ||
|
|
3e81d2840a | ||
|
|
c9a5dc20f9 | ||
|
|
db3c6021c5 | ||
|
|
b8327be5d6 | ||
|
|
c4e1ece82c | ||
|
|
9fd7140e4a | ||
|
|
a6c8923ea9 | ||
|
|
eb1174cf7c | ||
|
|
7993f15441 | ||
|
|
bb57af71ae | ||
|
|
1a10360884 | ||
|
|
cd109f16b5 | ||
|
|
164252cb97 | ||
|
|
fd18205c10 | ||
|
|
6fc8a18e93 | ||
|
|
8abc95c21e | ||
|
|
2bcb1840a4 | ||
|
|
c87e18810b | ||
|
|
eb6954ddf1 | ||
|
|
be1a69217f | ||
|
|
99669f7baa | ||
|
|
29530e2c95 | ||
|
|
beb4a66a93 | ||
|
|
40f7a3335c | ||
|
|
da0f7ffc56 | ||
|
|
4fa8be856a | ||
|
|
ffd8dc6332 | ||
|
|
cd219a0c00 | ||
|
|
cd88ce6217 | ||
|
|
b10665355d | ||
|
|
17ac19e435 | ||
|
|
ef5089438c | ||
|
|
1f64e36892 | ||
|
|
643b15391b | ||
|
|
d8a26f98c0 | ||
|
|
8fc01cd8fb | ||
|
|
fe3da8c452 | ||
|
|
c4c02f8d27 | ||
|
|
00b1baa1f3 |
No files matched your search
@@ -4,11 +4,8 @@ gem 'quickbooks-ruby'
|
|||||||
gem 'oauth2'
|
gem 'oauth2'
|
||||||
gem 'roxml'
|
gem 'roxml'
|
||||||
gem 'will_paginate'
|
gem 'will_paginate'
|
||||||
gem 'rails-jquery-autocomplete'
|
|
||||||
gem 'jquery-ui-rails'
|
|
||||||
gem 'rexml'
|
gem 'rexml'
|
||||||
gem 'combine_pdf'
|
gem 'combine_pdf'
|
||||||
|
|
||||||
group :assets do
|
# Double Metaphone sound-alike matching for customer search (CustomerSearchService)
|
||||||
gem 'coffee-rails'
|
gem 'text', '~> 1.3'
|
||||||
end
|
|
||||||
@@ -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,234 @@ 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.
|
||||||
|
|
||||||
|
### 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|:customer_actions_top, { customer: @customer }| Used to add action links to customer view
|
||||||
|
View Hook|:customer_actions_bottom, { customer: @customer} | Used to add action links to customer view
|
||||||
|
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
|
||||||
|
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
|
||||||
|
|
||||||
|
|||||||
Binary file not shown.
|
Before Width: | Height: | Size: 672 KiB After Width: | Height: | Size: 269 KiB |
@@ -8,7 +8,6 @@
|
|||||||
#
|
#
|
||||||
#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.
|
||||||
|
|
||||||
# This controller class will handle map management
|
|
||||||
class CustomersController < ApplicationController
|
class CustomersController < ApplicationController
|
||||||
|
|
||||||
include AuthHelper
|
include AuthHelper
|
||||||
@@ -26,57 +25,160 @@ class CustomersController < ApplicationController
|
|||||||
include SortHelper
|
include SortHelper
|
||||||
helper :timelog
|
helper :timelog
|
||||||
|
|
||||||
before_action :add_customer, only: :new
|
# This tells Redmine to check global permissions for the current controller/action
|
||||||
before_action :view_customer, except: [:new, :view]
|
# customers#view is the public share-link page: it is authorized by its token, not by Redmine permissions
|
||||||
|
before_action :authorize_global, except: [:view]
|
||||||
|
before_action :add_customer, only: [:new, :create]
|
||||||
|
before_action :view_customer, except: [:new, :create, :view, :share, :sync]
|
||||||
|
before_action :require_admin, only: :sync
|
||||||
skip_before_action :verify_authenticity_token, :check_if_login_required, only: [:view]
|
skip_before_action :verify_authenticity_token, :check_if_login_required, only: [:view]
|
||||||
|
|
||||||
autocomplete :customer, :name, full: true, extra_data: [:id]
|
def address_to_s(address)
|
||||||
|
return if address.nil?
|
||||||
|
|
||||||
|
lines = [
|
||||||
|
address.line1,
|
||||||
|
address.line2,
|
||||||
|
address.line3,
|
||||||
|
address.line4,
|
||||||
|
address.line5
|
||||||
|
].compact_blank
|
||||||
|
|
||||||
|
city_line = [
|
||||||
|
address.city,
|
||||||
|
address.country_sub_division_code,
|
||||||
|
address.postal_code
|
||||||
|
].compact_blank.join(" ")
|
||||||
|
|
||||||
|
lines << city_line unless city_line.blank?
|
||||||
|
|
||||||
|
lines.join("\n")
|
||||||
|
end
|
||||||
|
|
||||||
|
def add_customer
|
||||||
|
global_check_permission(:add_customers)
|
||||||
|
end
|
||||||
|
|
||||||
def allowed_params
|
def allowed_params
|
||||||
params.require(:customer).permit(:name, :email, :primary_phone, :mobile_phone, :phone_number, :notes)
|
params.require(:customer).permit(:name, :email, :primary_phone, :mobile_phone, :phone_number, :notes)
|
||||||
end
|
end
|
||||||
|
|
||||||
# getter method for a customer's invoices
|
# Used for autocomplete forms. Fuzzy matching (nicknames, typos, word order, phone digits) helps
|
||||||
# used for customer autocomplete field / issue form
|
# staff spot an existing customer before creating a duplicate. See CustomerSearchService.
|
||||||
def filter_invoices_by_customer
|
def autocomplete
|
||||||
@filtered_invoices = Invoice.all.where(customer_id: params[:selected_customer])
|
name_query = (params[:name] || params[:q] || params[:term]).to_s.strip
|
||||||
|
items = CustomerSearchService.call(name: name_query, phone: params[:phone])
|
||||||
|
|
||||||
|
render json: items.map { |i|
|
||||||
|
{ id: i.id, name: i.name, phone_number: i.phone_number, mobile_phone_number: i.mobile_phone_number }
|
||||||
|
}
|
||||||
|
end
|
||||||
|
|
||||||
|
def create
|
||||||
|
@customer = Customer.new(allowed_params)
|
||||||
|
|
||||||
|
respond_to do |format|
|
||||||
|
if @customer.save
|
||||||
|
log "Customer ##{@customer.id} created successfully."
|
||||||
|
format.html { redirect_to @customer, notice: l(:notice_successful_create) }
|
||||||
|
format.json { render json: { id: @customer.id, name: @customer.name }, status: :created }
|
||||||
|
else
|
||||||
|
format.html { render :new }
|
||||||
|
format.json { render json: { errors: @customer.errors.full_messages }, status: :unprocessable_entity }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
rescue => e
|
||||||
|
log "Failed to create customer: #{e.message}"
|
||||||
|
respond_to do |format|
|
||||||
|
format.html {
|
||||||
|
flash[:error] = e.message
|
||||||
|
redirect_to new_customer_path
|
||||||
|
}
|
||||||
|
format.json {
|
||||||
|
render json: { errors: [e.message] }, status: :internal_server_error
|
||||||
|
}
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def edit
|
||||||
|
@customer = Customer.find_by_id(params[:id])
|
||||||
|
return render_404 unless @customer
|
||||||
|
rescue => e
|
||||||
|
log "Failed to edit customer"
|
||||||
|
flash[:error] = e.message
|
||||||
|
render_404
|
||||||
end
|
end
|
||||||
|
|
||||||
# getter method for a customer's estimates
|
|
||||||
# used for customer autocomplete field / issue form
|
|
||||||
def filter_estimates_by_customer
|
def filter_estimates_by_customer
|
||||||
@filtered_estimates = Estimate.all.where(customer_id: params[:selected_customer])
|
@filtered_estimates = Estimate.all.where(customer_id: params[:selected_customer])
|
||||||
end
|
end
|
||||||
|
|
||||||
# display a list of all customers
|
def filter_invoices_by_customer
|
||||||
|
@filtered_invoices = Invoice.all.where(customer_id: params[:selected_customer])
|
||||||
|
end
|
||||||
|
|
||||||
def index
|
def index
|
||||||
if params[:search]
|
if params[:search]
|
||||||
@customers = Customer.search(params[:search]).order(:name).paginate(page: params[:page])
|
@customers = CustomerSearchService.call(name: params[:search], limit: 200).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
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# initialize a new customer
|
def load_issue_data
|
||||||
|
@journals = @issue.journals.preload(:details).preload(user: :email_address).reorder(:created_on, :id).to_a
|
||||||
|
|
||||||
|
@journals.each_with_index { |j, i| j.indice = i + 1 }
|
||||||
|
@journals.reject!(&:private_notes?) unless User.current.allowed_to?(:view_private_notes, @issue.project)
|
||||||
|
Journal.preload_journals_details_custom_fields(@journals)
|
||||||
|
@journals.select! { |journal| journal.notes? || journal.visible_details.any? }
|
||||||
|
@journals.reverse! if User.current.wants_comments_in_reverse_order?
|
||||||
|
|
||||||
|
@changesets = @issue.changesets.visible.preload(:repository, :user).to_a
|
||||||
|
@changesets.reverse! if User.current.wants_comments_in_reverse_order?
|
||||||
|
|
||||||
|
@relations = @issue.relations.select { |r| r.other_issue(@issue)&.visible? }
|
||||||
|
@allowed_statuses = @issue.new_statuses_allowed_to(User.current)
|
||||||
|
@priorities = IssuePriority.active
|
||||||
|
@time_entry = TimeEntry.new(issue: @issue, project: @issue.project)
|
||||||
|
@relation = IssueRelation.new
|
||||||
|
end
|
||||||
|
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[CustomersController] #{msg}"
|
||||||
|
end
|
||||||
|
|
||||||
def new
|
def new
|
||||||
@customer = Customer.new
|
@customer = Customer.new
|
||||||
|
|
||||||
|
if request.xhr?
|
||||||
|
render partial: 'form', layout: false, locals: { hide_submit: true, hide_toolbar: true }
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# create a new customer
|
def only_one_non_zero?(array)
|
||||||
def create
|
found_non_zero = false
|
||||||
@customer = Customer.new(allowed_params)
|
array.each do |val|
|
||||||
@customer.save
|
if val != 0
|
||||||
log "Customer ##{@customer.id} created successfully."
|
return false if found_non_zero
|
||||||
flash[:notice] = t :notice_customer_created
|
found_non_zero = true
|
||||||
redirect_to @customer
|
end
|
||||||
rescue => e
|
end
|
||||||
log "Failed to create customer: #{e.message}"
|
found_non_zero
|
||||||
flash[:error] = e.message
|
end
|
||||||
redirect_to new_customer_path
|
|
||||||
|
def share
|
||||||
|
issue = Issue.visible.find(params[:id])
|
||||||
|
token = issue.share_token
|
||||||
|
return render_403 unless token
|
||||||
|
|
||||||
|
redirect_to view_path(token.token)
|
||||||
|
rescue ActiveRecord::RecordNotFound
|
||||||
|
flash[:error] = t(:notice_issue_not_found)
|
||||||
|
render_404
|
||||||
end
|
end
|
||||||
|
|
||||||
# display a specific customer
|
|
||||||
def show
|
def show
|
||||||
@customer = Customer.find_by_id(params[:id])
|
@customer = Customer.find_by_id(params[:id])
|
||||||
return render_404 unless @customer
|
return render_404 unless @customer
|
||||||
@@ -109,130 +211,41 @@ class CustomersController < ApplicationController
|
|||||||
render_404
|
render_404
|
||||||
end
|
end
|
||||||
|
|
||||||
# return an HTML form for editing a customer
|
def sync
|
||||||
def edit
|
Customer.sync
|
||||||
@customer = Customer.find_by_id(params[:id])
|
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
||||||
return render_404 unless @customer
|
|
||||||
rescue => e
|
|
||||||
log "Failed to edit customer"
|
|
||||||
flash[:error] = e.message
|
|
||||||
render_404
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# update a specific customer
|
|
||||||
def update
|
def update
|
||||||
@customer = Customer.find_by_id(params[:id])
|
@customer = Customer.find_by_id(params[:id])
|
||||||
@customer.update(allowed_params)
|
return render_404 unless @customer
|
||||||
flash[:notice] = t :notice_customer_updated
|
|
||||||
redirect_to @customer
|
if @customer.update(allowed_params)
|
||||||
|
flash[:notice] = t :notice_customer_updated
|
||||||
|
redirect_to @customer
|
||||||
|
else
|
||||||
|
render :edit, status: :unprocessable_entity
|
||||||
|
end
|
||||||
rescue => e
|
rescue => e
|
||||||
log "Failed to update customer: #{e.message}"
|
log "Failed to update customer: #{e.message}"
|
||||||
flash[:error] = e.message
|
flash[:error] = e.message
|
||||||
redirect_to edit_customer_path
|
redirect_to edit_customer_path
|
||||||
end
|
end
|
||||||
|
|
||||||
# creates new customer view tokens, removes expired tokens & redirects to newly created customer view with new token.
|
|
||||||
def share
|
|
||||||
issue = Issue.find(params[:id])
|
|
||||||
token = issue.share_token
|
|
||||||
redirect_to view_path(token.token)
|
|
||||||
rescue ActiveRecord::RecordNotFound
|
|
||||||
flash[:error] = t(:notice_issue_not_found)
|
|
||||||
render_404
|
|
||||||
end
|
|
||||||
|
|
||||||
# displays an issue for a customer with a provided security CustomerToken
|
|
||||||
def view
|
def view
|
||||||
User.current = User.anonymous
|
User.current = User.anonymous
|
||||||
|
|
||||||
# Load only active, non-expired token
|
|
||||||
@token = CustomerToken.active.find_by(token: params[:token])
|
@token = CustomerToken.active.find_by(token: params[:token])
|
||||||
return render_403 unless @token
|
return render_403 unless @token
|
||||||
|
|
||||||
# Load associated issue
|
|
||||||
@issue = @token.issue
|
@issue = @token.issue
|
||||||
return render_403 unless @issue
|
return render_403 unless @issue
|
||||||
|
|
||||||
# Optional: enforce token belongs to the issue's customer
|
|
||||||
return render_403 unless @issue.customer_id == @token.issue.customer_id
|
|
||||||
|
|
||||||
# Store token in session for subsequent requests if needed
|
|
||||||
session[:token] = @token.token
|
session[:token] = @token.token
|
||||||
|
|
||||||
load_issue_data
|
load_issue_data
|
||||||
rescue ActiveRecord::RecordNotFound
|
rescue ActiveRecord::RecordNotFound
|
||||||
render_403
|
render_403
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
|
||||||
|
|
||||||
def load_issue_data
|
|
||||||
@journals = @issue.journals.preload(:details).preload(user: :email_address).reorder(:created_on, :id).to_a
|
|
||||||
|
|
||||||
@journals.each_with_index { |j, i| j.indice = i + 1 }
|
|
||||||
@journals.reject!(&:private_notes?) unless User.current.allowed_to?(:view_private_notes, @issue.project)
|
|
||||||
Journal.preload_journals_details_custom_fields(@journals)
|
|
||||||
@journals.select! { |journal| journal.notes? || journal.visible_details.any? }
|
|
||||||
@journals.reverse! if User.current.wants_comments_in_reverse_order?
|
|
||||||
|
|
||||||
@changesets = @issue.changesets.visible.preload(:repository, :user).to_a
|
|
||||||
@changesets.reverse! if User.current.wants_comments_in_reverse_order?
|
|
||||||
|
|
||||||
@relations = @issue.relations.select { |r| r.other_issue(@issue)&.visible? }
|
|
||||||
@allowed_statuses = @issue.new_statuses_allowed_to(User.current)
|
|
||||||
@priorities = IssuePriority.active
|
|
||||||
@time_entry = TimeEntry.new(issue: @issue, project: @issue.project)
|
|
||||||
@relation = IssueRelation.new
|
|
||||||
end
|
|
||||||
|
|
||||||
# redmine permission - add customers
|
|
||||||
def add_customer
|
|
||||||
global_check_permission(:add_customers)
|
|
||||||
end
|
|
||||||
|
|
||||||
# redmine permission - view customers
|
|
||||||
def view_customer
|
def view_customer
|
||||||
global_check_permission(:view_customers)
|
global_check_permission(:view_customers)
|
||||||
end
|
end
|
||||||
|
|
||||||
# checks to see if there is only one item in an array
|
end
|
||||||
# @return true if array only has one item
|
|
||||||
def only_one_non_zero?( array )
|
|
||||||
found_non_zero = false
|
|
||||||
array.each do |val|
|
|
||||||
if val!=0
|
|
||||||
return false if found_non_zero
|
|
||||||
found_non_zero = true
|
|
||||||
end
|
|
||||||
end
|
|
||||||
found_non_zero
|
|
||||||
end
|
|
||||||
|
|
||||||
# format a quickbooks address to a human readable string
|
|
||||||
def address_to_s(address)
|
|
||||||
return if address.nil?
|
|
||||||
|
|
||||||
lines = [
|
|
||||||
address.line1,
|
|
||||||
address.line2,
|
|
||||||
address.line3,
|
|
||||||
address.line4,
|
|
||||||
address.line5
|
|
||||||
].compact_blank
|
|
||||||
|
|
||||||
city_line = [
|
|
||||||
address.city,
|
|
||||||
address.country_sub_division_code,
|
|
||||||
address.postal_code
|
|
||||||
].compact_blank.join(" ")
|
|
||||||
|
|
||||||
lines << city_line unless city_line.blank?
|
|
||||||
|
|
||||||
lines.join("\n")
|
|
||||||
end
|
|
||||||
|
|
||||||
def log(msg)
|
|
||||||
Rails.logger.info "[CustomersController] #{msg}"
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
|
||||||
@@ -7,10 +7,21 @@
|
|||||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
#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.
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
class EstimatePdfService < PdfServiceBase
|
class EmployeesController < ApplicationController
|
||||||
|
include AuthHelper
|
||||||
|
|
||||||
def self.model_class
|
# Syncing is admin-only
|
||||||
Estimate
|
before_action :require_admin
|
||||||
|
|
||||||
|
def sync
|
||||||
|
Employee.sync
|
||||||
|
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
||||||
end
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Logs messages with a consistent prefix for easier debugging.
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[EmployeeController] #{msg}"
|
||||||
|
end
|
||||||
end
|
end
|
||||||
@@ -7,12 +7,17 @@
|
|||||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
#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.
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
class EstimateController < ApplicationController
|
class EstimatesController < ApplicationController
|
||||||
include AuthHelper
|
include AuthHelper
|
||||||
|
|
||||||
before_action :require_user, unless: -> { session[:token].nil? }
|
# PDFs: logged-in users, or a customer with a share link (limited to their issue's estimate).
|
||||||
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: -> { session[:token].nil? }
|
# Redmine's own login check is replaced by require_login_or_customer_token for these actions.
|
||||||
|
skip_before_action :check_if_login_required, only: [:show, :doc]
|
||||||
|
before_action :require_login_or_customer_token, only: [:show, :doc]
|
||||||
before_action :load_estimate, only: [:show, :doc]
|
before_action :load_estimate, only: [:show, :doc]
|
||||||
|
|
||||||
|
# Syncing is admin-only
|
||||||
|
before_action :require_admin, only: :sync
|
||||||
|
|
||||||
# Displays the estimate PDF in the browser or redirects with an error if not found.
|
# Displays the estimate PDF in the browser or redirects with an error if not found.
|
||||||
def doc
|
def doc
|
||||||
@@ -24,11 +29,20 @@ class EstimateController < ApplicationController
|
|||||||
render_pdf(@estimate)
|
render_pdf(@estimate)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def sync
|
||||||
|
Estimate.sync
|
||||||
|
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
# Loads the estimate based on ID or doc number, with a fallback to sync if not found locally.
|
# Loads the estimate based on ID or doc number, with a fallback to sync if not found locally.
|
||||||
def load_estimate
|
def load_estimate
|
||||||
log "Attempting to load Estimate with params: #{params.inspect}"
|
log "Attempting to load Estimate with params: #{params.inspect}"
|
||||||
|
|
||||||
|
# Share-link customers may only open the estimate attached to their issue (checked before any sync)
|
||||||
|
return load_customer_estimate if customer_token_only?
|
||||||
|
|
||||||
@estimate = find_estimate || sync_and_find_estimate
|
@estimate = find_estimate || sync_and_find_estimate
|
||||||
|
|
||||||
unless @estimate
|
unless @estimate
|
||||||
@@ -36,6 +50,21 @@ class EstimateController < ApplicationController
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# For share-link customers: only the estimate attached to the token's issue, by ID or doc number.
|
||||||
|
def load_customer_estimate
|
||||||
|
estimate = customer_token.issue&.estimate
|
||||||
|
requested =
|
||||||
|
if params[:search].present?
|
||||||
|
estimate && estimate.doc_number.to_s == params[:search].to_s
|
||||||
|
else
|
||||||
|
estimate && estimate.id.to_s == params[:id].to_s
|
||||||
|
end
|
||||||
|
|
||||||
|
return render_403 unless requested
|
||||||
|
|
||||||
|
@estimate = estimate
|
||||||
|
end
|
||||||
|
|
||||||
# Attempts to find the estimate locally by ID or doc number.
|
# Attempts to find the estimate locally by ID or doc number.
|
||||||
def find_estimate
|
def find_estimate
|
||||||
return Estimate.find_by(doc_number: params[:search]) if params[:search].present?
|
return Estimate.find_by(doc_number: params[:search]) if params[:search].present?
|
||||||
@@ -65,7 +94,7 @@ class EstimateController < ApplicationController
|
|||||||
|
|
||||||
# Renders the estimate PDF or redirects with an error if rendering fails.
|
# Renders the estimate PDF or redirects with an error if rendering fails.
|
||||||
def render_pdf(estimate)
|
def render_pdf(estimate)
|
||||||
pdf, ref = EstimatePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: [estimate.id])
|
pdf, ref = PdfService.new(entity: Estimate).fetch_pdf(doc_ids: [estimate.id])
|
||||||
send_data( pdf, filename: "estimate #{ref}.pdf", disposition: :inline, type: "application/pdf" )
|
send_data( pdf, filename: "estimate #{ref}.pdf", disposition: :inline, type: "application/pdf" )
|
||||||
rescue StandardError => e
|
rescue StandardError => e
|
||||||
log "PDF render failed for Estimate #{estimate&.id}: #{e.message}"
|
log "PDF render failed for Estimate #{estimate&.id}: #{e.message}"
|
||||||
@@ -7,18 +7,23 @@
|
|||||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
#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.
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
class InvoiceController < ApplicationController
|
class InvoicesController < ApplicationController
|
||||||
include AuthHelper
|
include AuthHelper
|
||||||
|
|
||||||
before_action :require_user, unless: -> { session[:token].nil? }
|
# PDFs: logged-in users, or a customer with a share link (limited to their issue's invoices).
|
||||||
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: -> { session[:token].nil? }
|
# Redmine's own login check is replaced by require_login_or_customer_token for this action.
|
||||||
|
skip_before_action :check_if_login_required, only: :show
|
||||||
|
before_action :require_login_or_customer_token, only: :show
|
||||||
|
before_action :authorize_customer_invoices, only: :show
|
||||||
|
|
||||||
|
# Syncing is admin-only
|
||||||
|
before_action :require_admin, only: :sync
|
||||||
|
|
||||||
# Displays the invoice PDF in the browser or redirects with an error if not found.
|
# Displays the invoice PDF in the browser or redirects with an error if not found.
|
||||||
def show
|
def show
|
||||||
log "Processing request for #{request.original_url}"
|
log "Processing request for #{request.original_url}"
|
||||||
|
|
||||||
invoice_ids = Array(params[:invoice_ids] || params[:id])
|
pdf, ref = PdfService.new(entity: Invoice).fetch_pdf(doc_ids: invoice_ids)
|
||||||
pdf, ref = InvoicePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: invoice_ids)
|
|
||||||
|
|
||||||
send_data pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf"
|
send_data pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf"
|
||||||
|
|
||||||
@@ -27,8 +32,25 @@ class InvoiceController < ApplicationController
|
|||||||
redirect_back fallback_location: root_path, flash: { error: I18n.t(:notice_invoice_not_found) }
|
redirect_back fallback_location: root_path, flash: { error: I18n.t(:notice_invoice_not_found) }
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def sync
|
||||||
|
Invoice.sync
|
||||||
|
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
|
def invoice_ids
|
||||||
|
@invoice_ids ||= Array(params[:invoice_ids] || params[:id]).map(&:to_s).reject(&:blank?)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Share-link customers may only open invoices attached to their issue
|
||||||
|
def authorize_customer_invoices
|
||||||
|
return true unless customer_token_only?
|
||||||
|
|
||||||
|
allowed = customer_token.issue&.invoice_ids.to_a.map(&:to_s)
|
||||||
|
render_403 if invoice_ids.empty? || (invoice_ids - allowed).any?
|
||||||
|
end
|
||||||
|
|
||||||
# Logs messages with a consistent prefix for easier debugging.
|
# Logs messages with a consistent prefix for easier debugging.
|
||||||
def log(msg)
|
def log(msg)
|
||||||
Rails.logger.info "[InvoiceController] #{msg}"
|
Rails.logger.info "[InvoiceController] #{msg}"
|
||||||
Whitespace-only changes.
@@ -11,16 +11,31 @@
|
|||||||
class QboController < ApplicationController
|
class QboController < ApplicationController
|
||||||
include AuthHelper
|
include AuthHelper
|
||||||
|
|
||||||
before_action :require_user, except: :webhook
|
# Connecting to QuickBooks and syncing are admin-only. Billing needs the "Bill issues" permission.
|
||||||
|
# The webhook is called by Intuit, not a user, and is verified by its signature instead.
|
||||||
|
before_action :require_admin, except: [:webhook, :bill]
|
||||||
|
before_action :require_login, only: :bill
|
||||||
skip_before_action :verify_authenticity_token, :check_if_login_required, only: :webhook
|
skip_before_action :verify_authenticity_token, :check_if_login_required, only: :webhook
|
||||||
|
|
||||||
|
# Session key for the OAuth "state" value, which ties the callback to the admin who started connecting
|
||||||
|
OAUTH_STATE_SESSION_KEY = :qbo_oauth_state
|
||||||
|
|
||||||
# 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.
|
# Initiates the OAuth authentication process by redirecting the user to the QuickBooks authorization URL. The callback URL is generated based on the application's settings and routes.
|
||||||
def authenticate
|
def authenticate
|
||||||
redirect_to QboOauthService.authorization_url(callback_url: callback_url)
|
state = SecureRandom.urlsafe_base64(32)
|
||||||
|
session[OAUTH_STATE_SESSION_KEY] = state
|
||||||
|
redirect_to QboOauthService.authorization_url(callback_url: callback_url, state: state), allow_other_host: true
|
||||||
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.
|
# Handles the OAuth callback from QuickBooks. Exchanges the authorization code for access and refresh tokens, saves the connection details, and redirects to the sync page with a success notice. If any error occurs during the process, logs the error and redirects back to the plugin settings page with an error message.
|
||||||
def oauth_callback
|
def oauth_callback
|
||||||
|
# Only accept a callback for a connection this admin started (prevents swapping in another QBO company)
|
||||||
|
expected_state = session.delete(OAUTH_STATE_SESSION_KEY).to_s
|
||||||
|
unless expected_state.present? && ActiveSupport::SecurityUtils.secure_compare(expected_state, params[:state].to_s)
|
||||||
|
log "OAuth callback rejected: state did not match"
|
||||||
|
return redirect_to plugin_settings_path(:redmine_qbo), flash: { error: I18n.t(:notice_qbo_oauth_state_mismatch) }
|
||||||
|
end
|
||||||
|
|
||||||
QboOauthService.exchange!(code: params[:code], callback_url: callback_url, realm_id: params[:realmId])
|
QboOauthService.exchange!(code: params[:code], callback_url: callback_url, realm_id: params[:realmId])
|
||||||
|
|
||||||
redirect_to qbo_sync_path, flash: { notice: I18n.t(:label_connected) }
|
redirect_to qbo_sync_path, flash: { notice: I18n.t(:label_connected) }
|
||||||
@@ -32,8 +47,10 @@ class QboController < ApplicationController
|
|||||||
|
|
||||||
# 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.
|
# 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
|
||||||
issue = Issue.find_by(id: params[:id])
|
issue = Issue.visible.find_by(id: params[:id])
|
||||||
raise I18n.t(:notice_error_issue_not_found) unless issue
|
return render_404 unless issue
|
||||||
|
return deny_access unless User.current.allowed_to?(:bill_issues, issue.project)
|
||||||
|
|
||||||
raise I18n.t(:notice_billing_error_no_customer) unless issue.customer
|
raise I18n.t(:notice_billing_error_no_customer) unless issue.customer
|
||||||
raise I18n.t(:notice_billing_error_no_employee) unless issue.assigned_to&.employee_id.present?
|
raise I18n.t(:notice_billing_error_no_employee) unless issue.assigned_to&.employee_id.present?
|
||||||
raise I18n.t(:notice_billing_error_no_qbo) unless Qbo.exists?
|
raise I18n.t(:notice_billing_error_no_qbo) unless Qbo.exists?
|
||||||
@@ -46,9 +63,13 @@ class QboController < ApplicationController
|
|||||||
redirect_to issue || root_path, flash: { error: e.message }
|
redirect_to issue || root_path, flash: { error: e.message }
|
||||||
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.
|
# Manual sync endpoint to trigger synchronization of QuickBooks entities
|
||||||
|
# with the local database. Supports full or partial sync depending on
|
||||||
|
# the `full_sync` boolean parameter.
|
||||||
def sync
|
def sync
|
||||||
QboSyncDispatcher.full_sync!
|
full_sync = ActiveModel::Type::Boolean.new.cast(params[:full_sync])
|
||||||
|
QboSyncDispatcher.sync!(full_sync: full_sync)
|
||||||
|
|
||||||
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
+37
-23
@@ -10,47 +10,61 @@
|
|||||||
|
|
||||||
module AuthHelper
|
module AuthHelper
|
||||||
|
|
||||||
def require_user
|
# The active customer share token stored in the session by customers#view, if any.
|
||||||
return unless session[:token].nil?
|
def customer_token
|
||||||
if !User.current.logged?
|
return @customer_token if defined?(@customer_token)
|
||||||
flash[:error] = t :notice_forbidden
|
|
||||||
render_403
|
@customer_token = session[:token].present? ? CustomerToken.active.find_by(token: session[:token]) : nil
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# True when the visitor is a customer using a share link rather than a logged-in user.
|
||||||
|
def customer_token_only?
|
||||||
|
!User.current.logged? && customer_token.present?
|
||||||
|
end
|
||||||
|
|
||||||
|
# Logged-in users pass. Customers with an active share link pass too (each controller then limits them
|
||||||
|
# to their own issue's documents). Everyone else is sent to the login page.
|
||||||
|
def require_login_or_customer_token
|
||||||
|
return true if User.current.logged?
|
||||||
|
return true if customer_token
|
||||||
|
|
||||||
|
require_login
|
||||||
|
end
|
||||||
|
|
||||||
|
# Kept for plugins that still call it (e.g. redmine_qbo_vehicles): requires a logged-in user.
|
||||||
|
# The old version effectively never ran; share-link customers use require_login_or_customer_token.
|
||||||
|
def require_user
|
||||||
|
return true if User.current.logged?
|
||||||
|
|
||||||
|
require_login
|
||||||
|
end
|
||||||
|
|
||||||
def allowed_to?(action)
|
def allowed_to?(action)
|
||||||
return false if User.current.nil?
|
return false if User.current.nil?
|
||||||
project = Project.find(params[:project_id])
|
project = Project.find_by(id: params[:project_id])
|
||||||
return false if project.nil?
|
return false if project.nil?
|
||||||
return true if User.current.allowed_to?(action, project)
|
User.current.allowed_to?(action, project)
|
||||||
false
|
|
||||||
end
|
end
|
||||||
|
|
||||||
def check_permission(permission)
|
def check_permission(permission)
|
||||||
if !allowed_to?(permission)
|
if !allowed_to?(permission)
|
||||||
flash[:error] = t :notice_forbidden
|
flash[:error] = t :notice_forbidden
|
||||||
render_403
|
render_403
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
def global_check_permission(permission)
|
def global_check_permission(permission)
|
||||||
if !globaly_allowed_to?(permission)
|
if !globaly_allowed_to?(permission)
|
||||||
flash[:error] = t :notice_forbidden
|
flash[:error] = t :notice_forbidden
|
||||||
render_403
|
render_403
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def globaly_allowed_to?( action)
|
# True if the user has the permission through any of their roles (or is an admin)
|
||||||
|
def globaly_allowed_to?(action)
|
||||||
return false if User.current.nil?
|
return false if User.current.nil?
|
||||||
|
|
||||||
projects = Project.all
|
User.current.allowed_to?(action, nil, global: true)
|
||||||
projects.each { |p|
|
|
||||||
if User.current.allowed_to?(action, p)
|
|
||||||
return true
|
|
||||||
end
|
|
||||||
}
|
|
||||||
false
|
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
@@ -17,27 +17,36 @@ class BillIssueTimeJob < ActiveJob::Base
|
|||||||
issue = Issue.find(issue_id)
|
issue = Issue.find(issue_id)
|
||||||
|
|
||||||
log "Starting billing for issue ##{issue.id}"
|
log "Starting billing for issue ##{issue.id}"
|
||||||
|
failure = nil
|
||||||
|
|
||||||
issue.with_lock do
|
issue.with_lock do
|
||||||
unbilled_entries = issue.time_entries.where(billed: [false, nil]).lock
|
unbilled_entries = issue.time_entries.where(billed: [false, nil]).lock.includes(:activity).to_a
|
||||||
|
|
||||||
return if unbilled_entries.blank?
|
return if unbilled_entries.blank?
|
||||||
|
|
||||||
totals = aggregate_hours(unbilled_entries)
|
totals = aggregate_hours(unbilled_entries)
|
||||||
return if totals.blank?
|
return if totals.blank?
|
||||||
log "Aggregated hours for billing: #{totals.inspect}"
|
log "Aggregated hours for billing: #{totals.inspect}"
|
||||||
|
|
||||||
qbo = QboConnectionService.current!
|
# Activities already sent to QBO (or deliberately skipped) in this run. If QBO fails part way, or the
|
||||||
raise "No QBO configuration found" unless qbo
|
# token refresh re-runs the block, finished activities are not sent again.
|
||||||
|
done = []
|
||||||
qbo.perform_authenticated_request do |access_token|
|
begin
|
||||||
create_time_activities(issue, totals, access_token, qbo)
|
qbo = QboConnectionService.current!
|
||||||
|
qbo.perform_authenticated_request do |access_token|
|
||||||
|
create_time_activities(issue, totals, access_token, qbo, done)
|
||||||
|
end
|
||||||
|
rescue => e
|
||||||
|
failure = e
|
||||||
end
|
end
|
||||||
|
|
||||||
# Only mark billed AFTER successful QBO creation
|
# Mark billed only the entries whose activity was finished, and commit that even if a later
|
||||||
unbilled_entries.update_all(billed: true)
|
# activity failed, so a retry only sends what's left
|
||||||
|
finished = unbilled_entries.select { |entry| done.include?(entry.activity&.name) }
|
||||||
|
TimeEntry.where(id: finished.map(&:id)).update_all(billed: true) if finished.any?
|
||||||
end
|
end
|
||||||
|
|
||||||
|
raise failure if failure
|
||||||
|
|
||||||
log "Completed billing for issue ##{issue.id}"
|
log "Completed billing for issue ##{issue.id}"
|
||||||
Qbo.update_time_stamp
|
Qbo.update_time_stamp
|
||||||
rescue => e
|
rescue => e
|
||||||
@@ -49,25 +58,34 @@ class BillIssueTimeJob < ActiveJob::Base
|
|||||||
|
|
||||||
# Aggregate time entries by activity name and sum their hours
|
# Aggregate time entries by activity name and sum their hours
|
||||||
def aggregate_hours(entries)
|
def aggregate_hours(entries)
|
||||||
entries.includes(:activity)
|
entries.group_by { |e| e.activity&.name }
|
||||||
.group_by { |e| e.activity&.name }
|
|
||||||
.transform_values { |rows| rows.sum(&:hours) }
|
.transform_values { |rows| rows.sum(&:hours) }
|
||||||
.compact
|
.compact
|
||||||
end
|
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
|
# 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)
|
# Adds each activity name to done once it has been created in QBO (or skipped because it can't be billed).
|
||||||
|
def create_time_activities(issue, totals, access_token, qbo, done)
|
||||||
log "Creating TimeActivity records in QBO for issue ##{issue.id}"
|
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)
|
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 )
|
item_service = Quickbooks::Service::Item.new( company_id: qbo.realm_id, access_token: access_token )
|
||||||
|
|
||||||
totals.each do |activity_name, hours_float|
|
totals.each do |activity_name, hours_float|
|
||||||
next if activity_name.blank?
|
next if done.include?(activity_name)
|
||||||
next if hours_float.to_f <= 0
|
|
||||||
|
# Not billable: skipped, and marked billed as before
|
||||||
|
if activity_name.blank? || hours_float.to_f <= 0
|
||||||
|
done << activity_name
|
||||||
|
next
|
||||||
|
end
|
||||||
|
|
||||||
item = find_item(item_service, activity_name)
|
item = find_item(item_service, activity_name)
|
||||||
next unless item
|
unless item
|
||||||
|
log "No QBO item named #{activity_name.inspect}; skipping"
|
||||||
|
done << activity_name
|
||||||
|
next
|
||||||
|
end
|
||||||
|
|
||||||
hours, minutes = convert_hours(hours_float)
|
hours, minutes = convert_hours(hours_float)
|
||||||
|
|
||||||
@@ -86,6 +104,7 @@ class BillIssueTimeJob < ActiveJob::Base
|
|||||||
log "Creating TimeActivity for #{activity_name} (#{hours}h #{minutes}m)"
|
log "Creating TimeActivity for #{activity_name} (#{hours}h #{minutes}m)"
|
||||||
|
|
||||||
time_service.create(time_entry)
|
time_service.create(time_entry)
|
||||||
|
done << activity_name
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -1,36 +0,0 @@
|
|||||||
#The MIT License (MIT)
|
|
||||||
#
|
|
||||||
#Copyright (c) 2016 - 2026 rick barrette
|
|
||||||
#
|
|
||||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
||||||
#
|
|
||||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
||||||
#
|
|
||||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
|
|
||||||
class 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
|
|
||||||
@@ -1,36 +0,0 @@
|
|||||||
#The MIT License (MIT)
|
|
||||||
#
|
|
||||||
#Copyright (c) 2016 - 2026 rick barrette
|
|
||||||
#
|
|
||||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
||||||
#
|
|
||||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
||||||
#
|
|
||||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
|
|
||||||
class EmployeeSyncJob < ApplicationJob
|
|
||||||
queue_as :default
|
|
||||||
retry_on StandardError, wait: 5.minutes, attempts: 5
|
|
||||||
|
|
||||||
# Performs a sync of employees from QuickBooks Online.
|
|
||||||
def perform(full_sync: false, id: nil)
|
|
||||||
qbo = QboConnectionService.current!
|
|
||||||
raise "No QBO configuration found" unless qbo
|
|
||||||
|
|
||||||
log "Starting #{full_sync ? 'full' : 'incremental'} sync for employee ##{id || 'all'}..."
|
|
||||||
|
|
||||||
service = EmployeeSyncService.new(qbo: qbo)
|
|
||||||
|
|
||||||
if id.present?
|
|
||||||
service.sync_by_id(id)
|
|
||||||
else
|
|
||||||
service.sync(full_sync: full_sync)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
private
|
|
||||||
|
|
||||||
def log(msg)
|
|
||||||
Rails.logger.info "[EmployeeSyncJob] #{msg}"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -11,14 +11,39 @@
|
|||||||
class QboSyncDispatcher
|
class QboSyncDispatcher
|
||||||
|
|
||||||
SYNC_JOBS = [
|
SYNC_JOBS = [
|
||||||
CustomerSyncJob,
|
Customer,
|
||||||
EstimateSyncJob,
|
Estimate,
|
||||||
InvoiceSyncJob,
|
Invoice,
|
||||||
EmployeeSyncJob
|
Employee
|
||||||
].freeze
|
].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.
|
# Dispatches all synchronization jobs to perform a full sync of QuickBooks entities with the local database.
|
||||||
def self.full_sync!
|
# Each job is enqueued with the `full_sync` flag set to true.
|
||||||
SYNC_JOBS.each { |job| job.perform_later(full_sync: true) }
|
def self.sync!(full_sync: false)
|
||||||
|
log "Manual Sync initated for #{full_sync ? "full sync" : "incremental sync"}"
|
||||||
|
enque_jobs full_sync: full_sync
|
||||||
end
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Dynamically enques all sync jobs
|
||||||
|
def self.enque_jobs(full_sync: full_sync)
|
||||||
|
jobs = SYNC_JOBS.dup
|
||||||
|
|
||||||
|
# Allow other plugins to add addtional sync jobs via Hooks
|
||||||
|
Redmine::Hook.call_hook( :qbo_full_sync ).each do |context|
|
||||||
|
next unless context
|
||||||
|
Array(context).each do |entity|
|
||||||
|
jobs.push(entity)
|
||||||
|
log "Added additional QBO Sync Job for #{entity.to_s}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
jobs.each { |job| QboSyncJob.perform_later(entity: job, full_sync: full_sync) }
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.log(msg)
|
||||||
|
Rails.logger.info "[QboSyncDispatcher] #{msg}"
|
||||||
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
@@ -8,23 +8,22 @@
|
|||||||
#
|
#
|
||||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
class EstimateSyncJob < ApplicationJob
|
class QboSyncJob < ApplicationJob
|
||||||
queue_as :default
|
queue_as :default
|
||||||
retry_on StandardError, wait: 5.minutes, attempts: 5
|
retry_on StandardError, wait: 5.minutes, attempts: 5
|
||||||
|
|
||||||
# Performs a sync of estimates from QuickBooks Online.
|
# Perform a full sync of all records for the entity, or an incremental sync of only those updated since the last sync
|
||||||
def perform(full_sync: false, id: nil, doc_number: nil)
|
def perform(full_sync: false, id: nil, entity: nil, doc_number: nil)
|
||||||
qbo = QboConnectionService.current!
|
raise "An entity to sync is required" unless entity
|
||||||
raise "No QBO configuration found" unless qbo
|
@entity = entity
|
||||||
|
|
||||||
log "Starting #{full_sync ? 'full' : 'incremental'} sync for estimate ##{id || doc_number || 'all'}..."
|
log "Starting #{full_sync ? 'full' : 'incremental'} sync for #{entity} ##{id || doc_number || 'all'}..."
|
||||||
|
service = "#{entity}SyncService".constantize.new
|
||||||
service = EstimateSyncService.new(qbo: qbo)
|
|
||||||
|
|
||||||
if id.present?
|
if id.present?
|
||||||
service.sync_by_id(id)
|
service.sync_by_id(id)
|
||||||
elsif doc_number.present?
|
elsif doc_number.present?
|
||||||
service.sync_by_doc(doc_number)
|
service.sync_by_doc_number(doc_number)
|
||||||
else
|
else
|
||||||
service.sync(full_sync: full_sync)
|
service.sync(full_sync: full_sync)
|
||||||
end
|
end
|
||||||
@@ -32,7 +31,8 @@ class EstimateSyncJob < ApplicationJob
|
|||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
|
# Log messages with the entity type for better traceability
|
||||||
def log(msg)
|
def log(msg)
|
||||||
Rails.logger.info "[EstimateSyncJob] #{msg}"
|
Rails.logger.info "[#{@entity}SyncJob] #{msg}"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -14,7 +14,7 @@ class QboWebhookProcessor
|
|||||||
def self.process!(request:)
|
def self.process!(request:)
|
||||||
body = request.raw_post
|
body = request.raw_post
|
||||||
signature = request.headers['intuit-signature']
|
signature = request.headers['intuit-signature']
|
||||||
secret = Setting.plugin_redmine_qbo['settingsWebhookToken']
|
secret = RedmineQbo.webhook_token_secret
|
||||||
|
|
||||||
raise "Invalid signature" unless valid_signature?(body, signature, secret)
|
raise "Invalid signature" unless valid_signature?(body, signature, secret)
|
||||||
|
|
||||||
|
|||||||
@@ -43,7 +43,16 @@ class WebhookProcessJob < ActiveJob::Base
|
|||||||
name = entity['name']
|
name = entity['name']
|
||||||
id = entity['id']&.to_i
|
id = entity['id']&.to_i
|
||||||
|
|
||||||
return unless ALLOWED_ENTITIES.include?(name)
|
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
|
||||||
|
Array(context).each do |entity|
|
||||||
|
entities.push(entity)
|
||||||
|
log "Added additional QBO entity #{entity}"
|
||||||
|
end
|
||||||
|
end
|
||||||
|
return unless entities.include?(name)
|
||||||
|
|
||||||
model = name.safe_constantize
|
model = name.safe_constantize
|
||||||
return unless model
|
return unless model
|
||||||
|
|||||||
@@ -75,11 +75,8 @@ module QuickbooksOauth
|
|||||||
# This method will construct and return an instance of the OAuth2::Client class that is configured with the consumer key, consumer secret and the appropriate URLs for the Intuit OAuth2 service. It will also set the sandbox mode based on the plugin settings. This method is used by the instance method oauth_client to create a new OAuth2 client for each instance of the model that includes this concern.
|
# 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_secret = Setting.plugin_redmine_qbo['settingsOAuthConsumerSecret']
|
|
||||||
|
|
||||||
# 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 = RedmineQbo.sandbox_mode?
|
||||||
log "Sandbox mode: #{Quickbooks.sandbox_mode}"
|
log "Sandbox mode: #{Quickbooks.sandbox_mode}"
|
||||||
|
|
||||||
options = {
|
options = {
|
||||||
@@ -87,7 +84,7 @@ module QuickbooksOauth
|
|||||||
authorize_url: "https://appcenter.intuit.com/connect/oauth2",
|
authorize_url: "https://appcenter.intuit.com/connect/oauth2",
|
||||||
token_url: "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer"
|
token_url: "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer"
|
||||||
}
|
}
|
||||||
OAuth2::Client.new(oauth_consumer_key, oauth_consumer_secret, options)
|
OAuth2::Client.new(RedmineQbo.oauth_consumer_key, RedmineQbo.oauth_consumer_secret, options)
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|||||||
+17
-101
@@ -8,21 +8,22 @@
|
|||||||
#
|
#
|
||||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
#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::Searchable
|
||||||
include Redmine::Acts::Event
|
include Redmine::Acts::Event
|
||||||
include Redmine::I18n
|
|
||||||
|
|
||||||
has_many :issues
|
has_many :issues
|
||||||
has_many :invoices
|
has_many :invoices
|
||||||
has_many :estimates
|
has_many :estimates
|
||||||
|
validates_presence_of :name
|
||||||
validates_presence_of :id, :name
|
|
||||||
before_validation :normalize_phone_numbers
|
before_validation :normalize_phone_numbers
|
||||||
|
|
||||||
self.primary_key = :id
|
self.primary_key = :id
|
||||||
|
qbo_sync push: true
|
||||||
|
|
||||||
|
# Normalize the local database column :name (capitalize each word, keep acronyms like LLC as typed)
|
||||||
|
normalizes :name, with: ->(name) { RedmineQbo::TitleCase.call(name.to_s.strip) }
|
||||||
|
|
||||||
acts_as_searchable columns: %w[name phone_number mobile_phone_number ],
|
acts_as_searchable columns: %w[name phone_number mobile_phone_number ],
|
||||||
scope: ->(_context) { left_joins(:project) },
|
scope: ->(_context) { left_joins(:project) },
|
||||||
date_column: :updated_at
|
date_column: :updated_at
|
||||||
@@ -33,41 +34,14 @@ class Customer < ActiveRecord::Base
|
|||||||
:description => Proc.new {|o| "#{I18n.t :label_primary_phone}: #{o.phone_number} #{I18n.t:label_mobile_phone}: #{o.mobile_phone_number}"},
|
:description => Proc.new {|o| "#{I18n.t :label_primary_phone}: #{o.phone_number} #{I18n.t:label_mobile_phone}: #{o.mobile_phone_number}"},
|
||||||
:datetime => Proc.new {|o| o.updated_at || o.created_at}
|
:datetime => Proc.new {|o| o.updated_at || o.created_at}
|
||||||
|
|
||||||
# Returns the details of the customer. If the details have already been fetched, it returns the cached version. Otherwise, it fetches the details from QuickBooks Online and caches them for future use. This method is used to access the customer's information in a way that minimizes unnecessary API calls to QBO, improving performance and reducing latency.
|
|
||||||
def details
|
|
||||||
return Quickbooks::Model::Customer.new unless id.present?
|
|
||||||
|
|
||||||
@details ||= begin
|
|
||||||
xml = Rails.cache.fetch(details_cache_key, expires_in: 10.minutes) do
|
|
||||||
fetch_details.to_xml_ns
|
|
||||||
end
|
|
||||||
|
|
||||||
Quickbooks::Model::Customer.from_xml(xml)
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Generates a unique cache key for storing this customer's QBO details.
|
|
||||||
def details_cache_key
|
|
||||||
"customer:#{id}:qbo_details:#{updated_at.to_i}"
|
|
||||||
end
|
|
||||||
|
|
||||||
# Returns the customer's email address
|
# Returns the customer's email address
|
||||||
def email
|
def email
|
||||||
details
|
return details&.email_address&.address
|
||||||
return @details&.email_address&.address
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Updates the customer's email address
|
# Updates the customer's email address
|
||||||
def email=(s)
|
def email=(s)
|
||||||
details
|
details.email_address = s
|
||||||
@details.email_address = s
|
|
||||||
end
|
|
||||||
|
|
||||||
|
|
||||||
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
|
|
||||||
def self.last_sync
|
|
||||||
return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
|
|
||||||
format_time(maximum(:updated_at))
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Customers are not bound by a project
|
# Customers are not bound by a project
|
||||||
@@ -76,36 +50,23 @@ class Customer < ActiveRecord::Base
|
|||||||
nil
|
nil
|
||||||
end
|
end
|
||||||
|
|
||||||
# Magic Method
|
|
||||||
# Maps Get/Set methods to QBO customer object
|
|
||||||
def method_missing(method_name, *args, &block)
|
|
||||||
if Quickbooks::Model::Customer.method_defined?(method_name)
|
|
||||||
details
|
|
||||||
@details.public_send(method_name, *args, &block)
|
|
||||||
else
|
|
||||||
super
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# returns the customer's mobile phone
|
# returns the customer's mobile phone
|
||||||
def mobile_phone
|
def mobile_phone
|
||||||
details
|
return details&.mobile_phone&.free_form_number
|
||||||
return @details&.mobile_phone&.free_form_number
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Updates the custome's mobile phone number
|
# Updates the custome's mobile phone number
|
||||||
def mobile_phone=(n)
|
def mobile_phone=(n)
|
||||||
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
|
||||||
end
|
end
|
||||||
|
|
||||||
# Updates Both local DB name & QBO display_name
|
# Updates Both local DB name & QBO display_name
|
||||||
def name=(s)
|
def name=(s)
|
||||||
details
|
super(s)
|
||||||
@details.display_name = s
|
# Write the normalized value from Active Record to QBO details
|
||||||
super
|
details.display_name = self.name
|
||||||
end
|
end
|
||||||
|
|
||||||
# Normalizes phone numbers by removing non-digit characters. This method is called before validation to ensure that phone numbers are stored in a consistent format, which can help with searching and integration with external systems like QuickBooks Online.
|
# 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.
|
||||||
@@ -116,27 +77,19 @@ class Customer < ActiveRecord::Base
|
|||||||
|
|
||||||
# Sets the notes for the customer
|
# Sets the notes for the customer
|
||||||
def notes=(s)
|
def notes=(s)
|
||||||
details
|
details.notes = s
|
||||||
@details.notes = s
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# returns the customer's primary phone
|
# returns the customer's primary phone
|
||||||
def primary_phone
|
def primary_phone
|
||||||
details
|
return details&.primary_phone&.free_form_number
|
||||||
return @details&.primary_phone&.free_form_number
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Updates the customer's primary phone number
|
# Updates the customer's primary phone number
|
||||||
def primary_phone=(n)
|
def primary_phone=(n)
|
||||||
details
|
|
||||||
pn = Quickbooks::Model::TelephoneNumber.new
|
pn = Quickbooks::Model::TelephoneNumber.new
|
||||||
pn.free_form_number = n
|
pn.free_form_number = n
|
||||||
@details.primary_phone = pn
|
details.primary_phone = pn
|
||||||
end
|
|
||||||
|
|
||||||
# Repsonds to missing methods by delegating to the QBO customer details object if the method is defined there. This allows for dynamic access to any attributes or methods of the QBO customer without having to explicitly define them in the Customer model, providing flexibility and reducing boilerplate code.
|
|
||||||
def respond_to_missing?(method_name, include_private = false)
|
|
||||||
Quickbooks::Model::Customer.method_defined?(method_name) || super
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Seach for customers by name or phone number
|
# Seach for customers by name or phone number
|
||||||
@@ -160,47 +113,10 @@ class Customer < ActiveRecord::Base
|
|||||||
ids.index_with { |id| id }
|
ids.index_with { |id| id }
|
||||||
end
|
end
|
||||||
|
|
||||||
# performs a sync operation for all customers
|
|
||||||
def self.sync
|
|
||||||
CustomerSyncJob.perform_later(full_sync: false)
|
|
||||||
end
|
|
||||||
|
|
||||||
# performs a sync operation for a specific customer
|
|
||||||
def self.sync_by_id(id)
|
|
||||||
CustomerSyncJob.perform_later(id: id)
|
|
||||||
end
|
|
||||||
|
|
||||||
# returns a human readable string
|
# returns a human readable string
|
||||||
def to_s
|
def to_s
|
||||||
last4 = phone_number&.last(4)
|
last4 = phone_number&.last(4)
|
||||||
last4.present? ? "#{name} - #{last4}" : name.to_s
|
last4.present? ? "#{name} - #{last4}" : name.to_s
|
||||||
end
|
end
|
||||||
|
|
||||||
# Push the updates
|
|
||||||
def save_with_push
|
|
||||||
log "Starting push for customer ##{self.id}..."
|
|
||||||
qbo = QboConnectionService.current!
|
|
||||||
CustomerService.new(qbo: qbo, customer: self).push()
|
|
||||||
Rails.cache.delete(details_cache_key)
|
|
||||||
save_without_push
|
|
||||||
end
|
|
||||||
|
|
||||||
alias_method :save_without_push, :save
|
|
||||||
alias_method :save, :save_with_push
|
|
||||||
|
|
||||||
private
|
end
|
||||||
|
|
||||||
# Fetches the customer's details from QuickBooks Online. If the customer has an ID, it makes an authenticated request to QBO to retrieve the customer's information. If the customer does not have an ID or if there is an error during the fetch, it returns a new instance of Quickbooks::Model::Customer with default values. This method is used to ensure that the customer object has the most up-to-date information from QBO when needed.
|
|
||||||
def fetch_details
|
|
||||||
return Quickbooks::Model::Customer.new unless id.present?
|
|
||||||
log "Fetching details for customer ##{id} from QBO..."
|
|
||||||
qbo = QboConnectionService.current!
|
|
||||||
CustomerService.new(qbo: qbo, customer: self).pull()
|
|
||||||
end
|
|
||||||
|
|
||||||
# Log messages with the entity type for better traceability
|
|
||||||
def log(msg)
|
|
||||||
Rails.logger.info "[Customer] #{msg}"
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
|
||||||
+3
-21
@@ -8,29 +8,11 @@
|
|||||||
#
|
#
|
||||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
#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
|
||||||
|
|
||||||
include Redmine::I18n
|
|
||||||
|
|
||||||
has_many :users
|
has_many :users
|
||||||
validates_presence_of :id, :name
|
validates_presence_of :id, :name
|
||||||
|
|
||||||
self.primary_key = :id
|
self.primary_key = :id
|
||||||
|
qbo_sync push: false
|
||||||
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
|
|
||||||
def self.last_sync
|
|
||||||
return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
|
|
||||||
format_time(maximum(:updated_at))
|
|
||||||
end
|
|
||||||
|
|
||||||
# Sync all employees, typically triggered by a scheduled task or manual sync request
|
end
|
||||||
def self.sync
|
|
||||||
EmployeeSyncJob.perform_later(full_sync: true)
|
|
||||||
end
|
|
||||||
|
|
||||||
# Sync a single employee by ID, typically triggered by a webhook notification or manual sync request
|
|
||||||
def self.sync_by_id(id)
|
|
||||||
EmployeeSyncJob.perform_later(id: id)
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
|
||||||
+8
-27
@@ -8,45 +8,26 @@
|
|||||||
#
|
#
|
||||||
#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
|
||||||
|
|
||||||
include Redmine::I18n
|
|
||||||
|
|
||||||
has_and_belongs_to_many :issues
|
has_many :issues
|
||||||
belongs_to :customer
|
belongs_to :customer
|
||||||
validates_presence_of :doc_number, :id
|
validates_presence_of :doc_number, :id
|
||||||
self.primary_key = :id
|
self.primary_key = :id
|
||||||
|
qbo_sync push: false
|
||||||
|
|
||||||
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
|
def name
|
||||||
def self.last_sync
|
to_s
|
||||||
return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
|
|
||||||
format_time(maximum(:updated_at))
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# returns a human readable string
|
# returns a human readable string
|
||||||
def to_s
|
def to_s
|
||||||
return self[:doc_number]
|
return self[:doc_number]
|
||||||
end
|
end
|
||||||
|
|
||||||
# sync all estimates
|
|
||||||
def self.sync
|
|
||||||
EstimateSyncJob.perform_later(full_sync: false)
|
|
||||||
end
|
|
||||||
|
|
||||||
# sync only one estimate
|
|
||||||
def self.sync_by_id(id)
|
|
||||||
EstimateSyncJob.perform_later(id: id)
|
|
||||||
end
|
|
||||||
|
|
||||||
# sync only one estimate
|
# sync only one estimate by document number
|
||||||
def self.sync_by_doc_number(number)
|
def self.sync_by_doc_number(number)
|
||||||
EstimateSyncJob.perform_later(doc_number: number)
|
QboSyncJob.perform_later(entity: model_name.name, doc_number: number)
|
||||||
end
|
|
||||||
|
|
||||||
private
|
|
||||||
|
|
||||||
def log(msg)
|
|
||||||
Rails.logger.info "[Estimate] #{msg}"
|
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
+2
-21
@@ -8,37 +8,18 @@
|
|||||||
#
|
#
|
||||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
#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
|
||||||
|
|
||||||
include Redmine::I18n
|
|
||||||
|
|
||||||
has_and_belongs_to_many :issues
|
has_and_belongs_to_many :issues
|
||||||
belongs_to :customer
|
belongs_to :customer
|
||||||
|
|
||||||
validates :id, presence: true, uniqueness: true
|
validates :id, presence: true, uniqueness: true
|
||||||
validates :doc_number, :txn_date, presence: true
|
validates :doc_number, :txn_date, presence: true
|
||||||
|
|
||||||
self.primary_key = :id
|
self.primary_key = :id
|
||||||
|
qbo_sync push: false
|
||||||
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
|
|
||||||
def self.last_sync
|
|
||||||
return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
|
|
||||||
format_time(maximum(:updated_at))
|
|
||||||
end
|
|
||||||
|
|
||||||
# Return the invoice's document number as its string representation
|
# Return the invoice's document number as its string representation
|
||||||
def to_s
|
def to_s
|
||||||
doc_number
|
doc_number
|
||||||
end
|
end
|
||||||
|
|
||||||
# Sync all invoices from QuickBooks, typically triggered by a scheduled task or manual sync request
|
|
||||||
def self.sync
|
|
||||||
InvoiceSyncJob.perform_later(full_sync: true)
|
|
||||||
end
|
|
||||||
|
|
||||||
# Sync a single invoice by ID, typically triggered by a webhook notification or manual sync request
|
|
||||||
def self.sync_by_id(id)
|
|
||||||
InvoiceSyncJob.perform_later(id: id)
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
end
|
||||||
@@ -1,7 +0,0 @@
|
|||||||
class LineItem < ApplicationRecord
|
|
||||||
belongs_to :issue
|
|
||||||
|
|
||||||
validates :description, presence: true
|
|
||||||
validates :quantity, numericality: { greater_than: 0 }
|
|
||||||
validates :unit_price, numericality: { greater_than_or_equal_to: 0 }
|
|
||||||
end
|
|
||||||
+20
-7
@@ -14,6 +14,26 @@ class Qbo < ActiveRecord::Base
|
|||||||
include Redmine::I18n
|
include Redmine::I18n
|
||||||
|
|
||||||
validate :single_record_only, on: :create
|
validate :single_record_only, on: :create
|
||||||
|
|
||||||
|
# Returns the last sync time formatted for display. If no sync has occurred, returns a default message.
|
||||||
|
def self.last_sync
|
||||||
|
qbo = QboConnectionService.current!
|
||||||
|
format_time(qbo.last_sync)
|
||||||
|
rescue
|
||||||
|
return I18n.t(:label_qbo_never_synced)
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.oauth2_access_token_expires_at
|
||||||
|
QboConnectionService.current!.oauth2_access_token_expires_at
|
||||||
|
rescue
|
||||||
|
return I18n.t(:label_qbo_never_synced)
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.oauth2_refresh_token_expires_at
|
||||||
|
QboConnectionService.current!.oauth2_refresh_token_expires_at
|
||||||
|
rescue
|
||||||
|
return I18n.t(:label_qbo_never_synced)
|
||||||
|
end
|
||||||
|
|
||||||
# Updates last sync time stamp
|
# Updates last sync time stamp
|
||||||
def self.update_time_stamp
|
def self.update_time_stamp
|
||||||
@@ -24,13 +44,6 @@ class Qbo < ActiveRecord::Base
|
|||||||
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
|
|
||||||
qbo = QboConnectionService.current!
|
|
||||||
return I18n.t(:label_qbo_never_synced) unless qbo&.last_sync
|
|
||||||
format_time(qbo.last_sync)
|
|
||||||
end
|
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
# Logs a message with a QBO-specific prefix for easier identification in the logs.
|
# Logs a message with a QBO-specific prefix for easier identification in the logs.
|
||||||
|
|||||||
@@ -0,0 +1,122 @@
|
|||||||
|
#The MIT License (MIT)
|
||||||
|
#
|
||||||
|
#Copyright (c) 2026 rick barrette
|
||||||
|
#
|
||||||
|
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
#
|
||||||
|
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
#
|
||||||
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
class QboBaseModel < ActiveRecord::Base
|
||||||
|
|
||||||
|
include Redmine::I18n
|
||||||
|
|
||||||
|
self.abstract_class = true
|
||||||
|
validates_presence_of :id
|
||||||
|
class_attribute :qbo_push_enabled, default: true
|
||||||
|
attr_accessor :skip_qbo_push
|
||||||
|
before_validation :push_to_qbo, on: :create, if: :push_to_qbo?
|
||||||
|
after_commit :push_to_qbo, on: :update, if: :push_to_qbo?
|
||||||
|
|
||||||
|
# Returns the details of the entity.
|
||||||
|
# If the details have already been fetched, it returns the cached version.
|
||||||
|
# Otherwise, it fetches the details from QuickBooks Online and caches them for future use.
|
||||||
|
# This method is used to access the entity's information in a way that minimizes unnecessary API calls to QBO, improving performance and reducing latency.
|
||||||
|
def details
|
||||||
|
@details ||= begin
|
||||||
|
xml = Rails.cache.fetch(details_cache_key, expires_in: 10.minutes) do
|
||||||
|
fetch_details.to_xml_ns
|
||||||
|
end
|
||||||
|
qbo_model_class.from_xml(xml)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Generates a unique cache key for storing this customer's QBO details.
|
||||||
|
def details_cache_key
|
||||||
|
"#{model_name.name}:#{id}:qbo_details:#{updated_at.to_i}"
|
||||||
|
end
|
||||||
|
|
||||||
|
# Returns the last sync time formatted for display.
|
||||||
|
# If no sync has occurred, returns a default message.
|
||||||
|
def self.last_sync
|
||||||
|
return I18n.t(:label_qbo_never_synced) unless maximum(:updated_at)
|
||||||
|
format_time(maximum(:updated_at))
|
||||||
|
end
|
||||||
|
|
||||||
|
# Magic Method
|
||||||
|
# Maps Get/Set methods to QBO entity object
|
||||||
|
def method_missing(method_name, *args, &block)
|
||||||
|
if qbo_model_class.method_defined?(method_name)
|
||||||
|
details
|
||||||
|
@details.public_send(method_name, *args, &block)
|
||||||
|
else
|
||||||
|
super
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def push_to_qbo?
|
||||||
|
log "qbo_push_enabled #{self.class.qbo_push_enabled}"
|
||||||
|
log "skip_qbo_push #{skip_qbo_push}"
|
||||||
|
|
||||||
|
self.class.qbo_push_enabled && skip_qbo_push != true
|
||||||
|
end
|
||||||
|
|
||||||
|
# Repsonds to missing methods by delegating to the QBO entity calss if the method is defined there.
|
||||||
|
# This allows for dynamic access to any attributes or methods of the QBO customer without having to explicitly define them in the Subclass model, providing flexibility and reducing boilerplate code.
|
||||||
|
def respond_to_missing?(method_name, include_private = false)
|
||||||
|
qbo_model_class.method_defined?(method_name) || super
|
||||||
|
end
|
||||||
|
|
||||||
|
# Sync all entities, typically triggered by a scheduled task or manual sync request
|
||||||
|
def self.sync
|
||||||
|
QboSyncJob.perform_later(entity: model_name.name, full_sync: true)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Sync a single entity by ID, typically triggered by a webhook notification or manual sync request
|
||||||
|
def self.sync_by_id(id)
|
||||||
|
QboSyncJob.perform_later(entity: model_name.name, id: id)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Flag used to update local without pushing to QBO.
|
||||||
|
# This is used to prevent loops with the webhook
|
||||||
|
def skip_qbo_push?
|
||||||
|
!!skip_qbo_push
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.qbo_sync(push: true)
|
||||||
|
self.qbo_push_enabled = push
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Log messages with a standarized prefix
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[#{model_name.name}] #{msg}"
|
||||||
|
end
|
||||||
|
|
||||||
|
# Fetches the entity's details from QuickBooks Online.
|
||||||
|
def fetch_details
|
||||||
|
log "Fetching details for #{model_name.name} ##{id} from QBO..."
|
||||||
|
service_class.new(local: self).pull()
|
||||||
|
end
|
||||||
|
|
||||||
|
# Pushs the entity's details from QuickBooks Online.
|
||||||
|
def push_to_qbo
|
||||||
|
log "Starting push for #{model_name.name} ##{id}..."
|
||||||
|
reslut = service_class.new(local: self).push
|
||||||
|
Rails.cache.delete(details_cache_key)
|
||||||
|
return reslut
|
||||||
|
end
|
||||||
|
|
||||||
|
# Dynamically get the Quickbooks Model Class
|
||||||
|
def qbo_model_class
|
||||||
|
@qbo_model_class ||= "Quickbooks::Model::#{model_name.name}".constantize
|
||||||
|
end
|
||||||
|
|
||||||
|
# Dynamically get the Service Class
|
||||||
|
def service_class
|
||||||
|
@service_class ||= "#{model_name.name}Service".constantize
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
@@ -0,0 +1,233 @@
|
|||||||
|
#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.
|
||||||
|
|
||||||
|
require 'csv'
|
||||||
|
require 'did_you_mean'
|
||||||
|
require 'text'
|
||||||
|
|
||||||
|
# Finds customers by name and/or phone, tolerant of the ways duplicates sneak in:
|
||||||
|
# - nicknames: "Bill Smith" finds "William Smith", "Bob" finds "Robert" (about 2,800 pairs, see data/nicknames)
|
||||||
|
# - sound-alikes: "Jon" finds "John", "Smyth" finds "Smith", "Cathy" finds "Kathy" (Double Metaphone)
|
||||||
|
# - typos: "Willaim Smtih" finds "William Smith"
|
||||||
|
# - word order: "Smith, William" finds "William Smith"
|
||||||
|
# - partial: "will smi" finds "William Smith" while typing
|
||||||
|
# - phone: any 4+ digits, in any format, matched against both phone numbers
|
||||||
|
#
|
||||||
|
# Results are ranked best match first. Only id, name and phone numbers are loaded, and the prepared
|
||||||
|
# search data is cached until a customer changes, so searching stays fast as the customer list grows.
|
||||||
|
class CustomerSearchService
|
||||||
|
DEFAULT_LIMIT = 20
|
||||||
|
|
||||||
|
# Lowest score (0..1) a customer needs to be returned
|
||||||
|
MIN_SCORE = 0.72
|
||||||
|
|
||||||
|
# Bundled nickname data (Apache 2.0, see data/nicknames/README.md)
|
||||||
|
NICKNAMES_CSV = File.expand_path('../../data/nicknames/names.csv', __dir__)
|
||||||
|
|
||||||
|
# Groups missing from the bundled data. Add more here: every name in a group matches every other.
|
||||||
|
EXTRA_NICKNAME_GROUPS = [
|
||||||
|
%w[william liam],
|
||||||
|
%w[alexander xander],
|
||||||
|
%w[alexandra lexi],
|
||||||
|
%w[theodore theo],
|
||||||
|
%w[christopher kit]
|
||||||
|
].freeze
|
||||||
|
|
||||||
|
# Words that don't help tell customers apart
|
||||||
|
STOP_WORDS = %w[and the llc inc co corp company].freeze
|
||||||
|
|
||||||
|
# Returns matching Customer records, best match first.
|
||||||
|
def self.call(name: nil, phone: nil, limit: DEFAULT_LIMIT)
|
||||||
|
ids = rank(candidates, name: name, phone: phone, limit: limit).map(&:first)
|
||||||
|
return Customer.none if ids.empty?
|
||||||
|
|
||||||
|
Customer.where(id: ids).in_order_of(:id, ids)
|
||||||
|
end
|
||||||
|
|
||||||
|
# Prepared search rows for every customer, cached until any customer changes. Kept in this process's
|
||||||
|
# memory as well, so each keystroke doesn't reload it from the Rails cache.
|
||||||
|
def self.candidates
|
||||||
|
key = ['customer_search_candidates', 2, Customer.count, Customer.maximum(:updated_at).to_i]
|
||||||
|
cached_key, cached_rows = @candidates
|
||||||
|
return cached_rows if cached_key == key
|
||||||
|
|
||||||
|
rows = Rails.cache.fetch(key, expires_in: 12.hours) do
|
||||||
|
prepare(Customer.pluck(:id, :name, :phone_number, :mobile_phone_number))
|
||||||
|
end
|
||||||
|
@candidates = [key, rows]
|
||||||
|
rows
|
||||||
|
end
|
||||||
|
|
||||||
|
# [[id, name, phone, mobile], ...] -> [[id, name, phone_digits, tokens, sound_codes], ...]
|
||||||
|
def self.prepare(rows)
|
||||||
|
rows.map do |id, name, phone_number, mobile_number|
|
||||||
|
words = tokens(name)
|
||||||
|
phones = [phone_number, mobile_number].compact.map { |n| n.to_s.gsub(/\D/, '') }.reject(&:empty?)
|
||||||
|
[id, name.to_s, phones, words, words.map { |w| sound_codes(w) }]
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Pure ranking over prepared rows (no database), so it can be tested on its own.
|
||||||
|
# Returns [[id, score], ...] best first. A query of mostly digits is also treated as a phone number.
|
||||||
|
def self.rank(prepared, name: nil, phone: nil, limit: DEFAULT_LIMIT)
|
||||||
|
name = name.to_s.strip
|
||||||
|
phone_digits = phone.to_s.gsub(/\D/, '')
|
||||||
|
|
||||||
|
# "401-555-1234" typed into the name box is a phone search
|
||||||
|
name_digits = name.gsub(/\D/, '')
|
||||||
|
if phone_digits.empty? && name_digits.length >= 4 && name_digits.length >= name.gsub(/\s/, '').length * 0.7
|
||||||
|
phone_digits = name_digits
|
||||||
|
name = ''
|
||||||
|
end
|
||||||
|
|
||||||
|
query_words = tokens(name)
|
||||||
|
return [] if query_words.empty? && phone_digits.length < 4
|
||||||
|
|
||||||
|
query = query_words.map { |w| [w, sound_codes(w)] }
|
||||||
|
memo = {} # word-pair scores for this search; customer names repeat words a lot ("smith", "john")
|
||||||
|
|
||||||
|
scored = prepared.filter_map do |id, customer_name, phones, words, codes|
|
||||||
|
score = [
|
||||||
|
phone_digits.length >= 4 ? phone_score(phone_digits, phones) : 0.0,
|
||||||
|
query.any? ? name_score(query, words, codes, memo) : 0.0
|
||||||
|
].max
|
||||||
|
[id, score, customer_name] if score >= MIN_SCORE
|
||||||
|
end
|
||||||
|
|
||||||
|
scored.sort_by { |id, score, customer_name| [-score, customer_name.downcase, id] }
|
||||||
|
.first(limit)
|
||||||
|
.map { |id, score, _| [id, score.round(3)] }
|
||||||
|
end
|
||||||
|
|
||||||
|
# Lowercase words with accents and punctuation removed: "O'Brien-Smith, José" -> ["obrien", "smith", "jose"]
|
||||||
|
def self.tokens(text)
|
||||||
|
normalized = text.to_s.unicode_normalize(:nfkd).gsub(/\p{Mn}/, '').downcase
|
||||||
|
normalized = normalized.gsub(/['’]/, '').gsub(/[^a-z0-9]+/, ' ')
|
||||||
|
words = normalized.split
|
||||||
|
meaningful = words - STOP_WORDS
|
||||||
|
meaningful.empty? ? words : meaningful
|
||||||
|
end
|
||||||
|
|
||||||
|
# Double Metaphone codes (primary and alternate) for a word; empty for very short or numeric words
|
||||||
|
def self.sound_codes(word)
|
||||||
|
return [] if word.length < 3 || word.match?(/\d/)
|
||||||
|
|
||||||
|
Text::Metaphone.double_metaphone(word).compact.reject(&:empty?).uniq
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.phone_score(digits, phones)
|
||||||
|
phones.map do |number|
|
||||||
|
if number == digits || number.end_with?(digits) && digits.length >= 7 then 1.0
|
||||||
|
elsif number.include?(digits) then 0.9
|
||||||
|
else 0.0
|
||||||
|
end
|
||||||
|
end.max || 0.0
|
||||||
|
end
|
||||||
|
|
||||||
|
# Each query word is matched to its best word in the customer's name; the score is the average.
|
||||||
|
# A query word with no match at all halves the score, so "bill jones" won't match "william smith".
|
||||||
|
def self.name_score(query, words, codes, memo = {})
|
||||||
|
return 0.0 if words.empty?
|
||||||
|
|
||||||
|
best = query.map do |q_word, q_codes|
|
||||||
|
scores = (memo[q_word] ||= {})
|
||||||
|
words.each_with_index.map do |c_word, i|
|
||||||
|
scores.fetch(c_word) { scores[c_word] = word_score(q_word, q_codes, c_word, codes[i]) }
|
||||||
|
end.max
|
||||||
|
end
|
||||||
|
score = best.sum / best.size
|
||||||
|
score *= 0.5 if best.any?(&:zero?)
|
||||||
|
|
||||||
|
return score if score >= 0.9 # already a strong match; skip the whole-name comparison
|
||||||
|
|
||||||
|
# Also compare the names with spaces removed, for "Mc Donald" vs "McDonald". Only worth it when the
|
||||||
|
# strings could reach the 0.92 bar at all: same first letter and nearly the same length.
|
||||||
|
query_joined = query.map(&:first).join
|
||||||
|
name_joined = words.join
|
||||||
|
return score unless query_joined[0] == name_joined[0] && (query_joined.length - name_joined.length).abs <= 2
|
||||||
|
|
||||||
|
joined = DidYouMean::JaroWinkler.distance(query_joined, name_joined)
|
||||||
|
[score, joined >= 0.92 ? joined * 0.9 : 0.0].max
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.word_score(query, query_codes, candidate, candidate_codes)
|
||||||
|
return 1.0 if query == candidate
|
||||||
|
return 0.95 if nicknames?(query, candidate)
|
||||||
|
return 0.9 if query.length >= 2 && candidate.start_with?(query) # still typing: "wil" -> "william"
|
||||||
|
return 0.85 if query.length >= 2 && nickname_prefix?(query, candidate) # "bil" -> "william" via "bill"
|
||||||
|
|
||||||
|
similarity = DidYouMean::JaroWinkler.distance(query, candidate)
|
||||||
|
|
||||||
|
# Sounds the same ("jon"/"john", "smyth"/"smith"). The similarity check keeps unrelated words that
|
||||||
|
# happen to share a code (e.g. "john" and "ann" via the Spanish-J alternate) from matching.
|
||||||
|
return 0.88 if similarity >= 0.7 && (query_codes & candidate_codes).any?
|
||||||
|
|
||||||
|
return 0.8 if query.length >= 4 && candidate.include?(query) # "donald" in "mcdonald"
|
||||||
|
return 0.7 if query.length == 1 && candidate.start_with?(query) # an initial
|
||||||
|
|
||||||
|
# Typos. Short words need to be closer to count.
|
||||||
|
threshold = [query.length, candidate.length].min <= 4 ? 0.9 : 0.85
|
||||||
|
similarity >= threshold ? similarity * 0.9 : 0.0
|
||||||
|
end
|
||||||
|
|
||||||
|
# Nickname matching treats the data as connections between names (the file lists both directions,
|
||||||
|
# e.g. "william -> bill" and "bill -> william"). Two names match if they are connected directly, or both
|
||||||
|
# connect to a LONGER name they're short for: "bill" and "will" via "william". Requiring the shared
|
||||||
|
# name to be longer stops unrelated full names linking through a short one: "bill" is listed for both
|
||||||
|
# William and Robert, but that doesn't make William match Robert.
|
||||||
|
def self.nicknames?(a, b)
|
||||||
|
related_names(a).include?(b)
|
||||||
|
end
|
||||||
|
|
||||||
|
# A partly typed nickname of the candidate's name, e.g. "bil" for "william" (via "bill")
|
||||||
|
def self.nickname_prefix?(query, candidate)
|
||||||
|
related_names(candidate).any? { |name| name.start_with?(query) }
|
||||||
|
end
|
||||||
|
|
||||||
|
# All names interchangeable with name, cached per process
|
||||||
|
def self.related_names(name)
|
||||||
|
cache = (@related_names_cache ||= {})
|
||||||
|
cache[name] ||= begin
|
||||||
|
graph = nickname_graph
|
||||||
|
direct = graph.fetch(name, EMPTY)
|
||||||
|
through_full_names = direct.select { |full| full.length > name.length }.flat_map do |full|
|
||||||
|
graph.fetch(full, EMPTY).select { |other| other.length < full.length }
|
||||||
|
end
|
||||||
|
((direct + through_full_names).uniq - [name]).freeze
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
EMPTY = [].freeze
|
||||||
|
|
||||||
|
# name => [connected names], built once per process from the bundled data plus EXTRA_NICKNAME_GROUPS
|
||||||
|
def self.nickname_graph
|
||||||
|
@nickname_graph ||= begin
|
||||||
|
graph = Hash.new { |h, k| h[k] = [] }
|
||||||
|
connect = lambda do |a, b|
|
||||||
|
next if a.empty? || b.empty? || a == b
|
||||||
|
|
||||||
|
graph[a] << b
|
||||||
|
graph[b] << a
|
||||||
|
end
|
||||||
|
|
||||||
|
if File.exist?(NICKNAMES_CSV)
|
||||||
|
CSV.foreach(NICKNAMES_CSV, headers: true) do |row|
|
||||||
|
connect.call(row['name1'].to_s.strip.downcase, row['name2'].to_s.strip.downcase)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
EXTRA_NICKNAME_GROUPS.each do |group|
|
||||||
|
group.combination(2) { |a, b| connect.call(a, b) }
|
||||||
|
end
|
||||||
|
|
||||||
|
graph.transform_values { |names| names.uniq.freeze }.to_h.freeze
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -8,55 +8,13 @@
|
|||||||
#
|
#
|
||||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
#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
|
class CustomerService < ServiceBase
|
||||||
|
|
||||||
# Initializes the service with a QBO client and an optional customer record. The QBO client is used to communicate with QuickBooks Online, while the customer record contains the data that needs to be pushed to QBO. If no customer is provided, the service will not perform any operations.
|
|
||||||
def initialize(qbo:, customer: nil)
|
|
||||||
raise "No QBO configuration found" unless qbo
|
|
||||||
raise "Customer record is required for push operation" unless customer
|
|
||||||
@qbo = qbo
|
|
||||||
@customer = customer
|
|
||||||
end
|
|
||||||
|
|
||||||
# Pulls the customer data from QuickBooks Online.
|
|
||||||
def pull
|
|
||||||
return Quickbooks::Model::Customer.new unless @customer.present?
|
|
||||||
log "Fetching details for customer ##{@customer.id} from QBO..."
|
|
||||||
qbo = QboConnectionService.current!
|
|
||||||
qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Customer.new(
|
|
||||||
company_id: qbo.realm_id,
|
|
||||||
access_token: access_token
|
|
||||||
)
|
|
||||||
service.fetch_by_id(@customer.id)
|
|
||||||
end
|
|
||||||
rescue => e
|
|
||||||
log "Fetch failed for #{@customer.id}: #{e.message}"
|
|
||||||
Quickbooks::Model::Customer.new
|
|
||||||
end
|
|
||||||
|
|
||||||
# Pushes the customer data to QuickBooks Online. This method handles the communication with QBO, including authentication and error handling. It uses the QBO client to send the customer data and logs the process for monitoring and debugging purposes. If the push is successful, it returns the customer record; otherwise, it logs the error and returns false.
|
|
||||||
def push
|
|
||||||
log "Pushing customer ##{@customer.id} to QBO..."
|
|
||||||
|
|
||||||
customer = @qbo.perform_authenticated_request do |access_token|
|
|
||||||
service = Quickbooks::Service::Customer.new(
|
|
||||||
company_id: @qbo.realm_id,
|
|
||||||
access_token: access_token
|
|
||||||
)
|
|
||||||
service.update(@customer.details)
|
|
||||||
end
|
|
||||||
|
|
||||||
@customer.id = customer.id unless @customer.persisted?
|
|
||||||
log "Push for customer ##{@customer.id} completed."
|
|
||||||
return @customer
|
|
||||||
end
|
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
# Log messages with the entity type for better traceability
|
def build_qbo_remote
|
||||||
def log(msg)
|
log "Building new QBO Customer"
|
||||||
Rails.logger.info "[CustomerService] #{msg}"
|
Quickbooks::Model::Customer.new
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
@@ -17,16 +17,13 @@ class CustomerSyncService < SyncServiceBase
|
|||||||
Customer
|
Customer
|
||||||
end
|
end
|
||||||
|
|
||||||
# Determine if the remote entity should be deleted locally (e.g. if it's marked inactive in QBO)
|
# Determine if the local entity should be deleted (e.g. if it's marked inactive in QBO)
|
||||||
def destroy_remote?(remote)
|
def destroy_local?(remote)
|
||||||
!remote.active?
|
!remote.active?
|
||||||
end
|
end
|
||||||
|
|
||||||
# Map relevant attributes from the QBO Customer to the local Customer model
|
map_attribute :name, :display_name
|
||||||
def process_attributes(local, remote)
|
map_phone :phone_number, :primary_phone
|
||||||
local.name = remote.display_name
|
map_phone :mobile_phone_number, :mobile_phone
|
||||||
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
|
end
|
||||||
@@ -17,14 +17,11 @@ class EmployeeSyncService < SyncServiceBase
|
|||||||
Employee
|
Employee
|
||||||
end
|
end
|
||||||
|
|
||||||
# Determine if the remote entity should be deleted locally (e.g. if it's marked inactive in QBO)
|
# Determine if the local entity should be deleted (e.g. if it's marked inactive in QBO)
|
||||||
def destroy_remote?(remote)
|
def destroy_local?(remote)
|
||||||
!remote.active?
|
!remote.active?
|
||||||
end
|
end
|
||||||
|
|
||||||
# Map relevant attributes from the QBO Employee to the local Employee model
|
map_attribute :name, :display_name
|
||||||
def process_attributes(local, remote)
|
|
||||||
local.name = remote.display_name
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
end
|
||||||
@@ -7,10 +7,7 @@
|
|||||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
#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.
|
#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
|
class EstimateService < ServiceBase
|
||||||
Invoice
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
end
|
||||||
@@ -9,6 +9,14 @@
|
|||||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
#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
|
class EstimateSyncService < SyncServiceBase
|
||||||
|
|
||||||
|
# sync only one estimate
|
||||||
|
def sync_by_doc_number(number)
|
||||||
|
log "Syncing estimate by doc number #{number}"
|
||||||
|
QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||||
|
persist(service.find_by( :doc_number, number).first)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
@@ -17,11 +25,7 @@ class EstimateSyncService < SyncServiceBase
|
|||||||
Estimate
|
Estimate
|
||||||
end
|
end
|
||||||
|
|
||||||
# Map relevant attributes from the QBO Estimate to the local Estimate model
|
map_attributes :doc_number, :txn_date
|
||||||
def process_attributes(local, remote)
|
map_belongs_to :customer
|
||||||
local.doc_number = remote.doc_number
|
|
||||||
local.txn_date = remote.txn_date
|
|
||||||
local.customer = Customer.find_by(id: remote.customer_ref&.value)
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
end
|
||||||
@@ -29,8 +29,6 @@ class InvoiceAttachmentService
|
|||||||
issue.save! if issue.changed?
|
issue.save! if issue.changed?
|
||||||
log "Attached invoice ##{@invoice.id} to issue ##{issue.id}"
|
log "Attached invoice ##{@invoice.id} to issue ##{issue.id}"
|
||||||
end
|
end
|
||||||
|
|
||||||
InvoiceCustomFieldSyncService.new(issue, @invoice, @remote).sync
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -1,69 +0,0 @@
|
|||||||
#The MIT License (MIT)
|
|
||||||
#
|
|
||||||
#Copyright (c) 2016 - 2026 rick barrette
|
|
||||||
#
|
|
||||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
||||||
#
|
|
||||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
||||||
#
|
|
||||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
|
|
||||||
class 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
|
|
||||||
@@ -1,47 +0,0 @@
|
|||||||
#The MIT License (MIT)
|
|
||||||
#
|
|
||||||
#Copyright (c) 2016 - 2026 rick barrette
|
|
||||||
#
|
|
||||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
||||||
#
|
|
||||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
||||||
#
|
|
||||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
|
|
||||||
class 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
|
|
||||||
@@ -16,20 +16,15 @@ class InvoiceSyncService < SyncServiceBase
|
|||||||
def self.model_class
|
def self.model_class
|
||||||
Invoice
|
Invoice
|
||||||
end
|
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
|
# Attach QBO Invoices to the local Issues
|
||||||
def attach_documents(local, remote)
|
def attach_documents(local, remote)
|
||||||
InvoiceAttachmentService.new(local, remote).attach
|
InvoiceAttachmentService.new(local, remote).attach
|
||||||
end
|
end
|
||||||
|
|
||||||
|
map_attributes :balance, :doc_number, :due_date, :txn_date
|
||||||
|
map_attribute :total_amount, :total
|
||||||
|
map_attribute :qbo_updated_at, "meta_data.last_updated_time"
|
||||||
|
map_belongs_to :customer
|
||||||
|
|
||||||
end
|
end
|
||||||
@@ -7,30 +7,21 @@
|
|||||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
#The 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.
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
class PdfServiceBase
|
class PdfService
|
||||||
|
|
||||||
require 'combine_pdf'
|
require 'combine_pdf'
|
||||||
|
|
||||||
# Subclasses should initialize with a QBO client instance
|
# Subclasses should initialize with a QBO client instance
|
||||||
def initialize(qbo:)
|
def initialize(entity: entity)
|
||||||
@qbo = qbo
|
raise "An entity to sync is required" unless entity
|
||||||
@entity = self.class.model_class
|
@entity = entity
|
||||||
end
|
|
||||||
|
|
||||||
# Subclasses must implement this to specify which document model to download pdf (e.g. Estimate, Invoice)
|
|
||||||
def self.model_class
|
|
||||||
raise NotImplementedError
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Fetches the PDF for the given entity IDs. If multiple IDs are provided, their PDFs are combined into a single document.
|
# 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:)
|
def fetch_pdf(doc_ids:)
|
||||||
log "Fetching PDFs for #{@entity} IDs: #{doc_ids.join(', ')}"
|
log "Fetching PDFs for #{@entity} IDs: #{doc_ids.join(', ')}"
|
||||||
@qbo.perform_authenticated_request do |access_token|
|
QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||||
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
|
return single_pdf(service, doc_ids.first) if doc_ids.size == 1
|
||||||
|
|
||||||
combined_pdf(service, doc_ids)
|
combined_pdf(service, doc_ids)
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -10,6 +10,11 @@
|
|||||||
|
|
||||||
class QboConnectionService
|
class QboConnectionService
|
||||||
|
|
||||||
|
# Returns the current QBO connection record. Raises an error if no connection exists.
|
||||||
|
def self.current!
|
||||||
|
Qbo.first || raise("QBO not connected")
|
||||||
|
end
|
||||||
|
|
||||||
# Replaces the existing QBO connection with new credentials. Deletes all existing records and creates a new one with the provided token, refresh token, and realm ID. Refreshes the token immediately after creation.
|
# 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:)
|
def self.replace!(token:, refresh_token:, realm_id:)
|
||||||
Qbo.transaction do
|
Qbo.transaction do
|
||||||
@@ -24,9 +29,14 @@ class QboConnectionService
|
|||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Returns the current QBO connection record. Raises an error if no connection exists.
|
# Performs authenticaed requests with QBO service
|
||||||
def self.current!
|
def self.with_qbo_service(entity: nil)
|
||||||
Qbo.first || raise("QBO not connected")
|
qbo = current!
|
||||||
|
raise "An entity to sync is required" unless entity
|
||||||
|
service_class ||= "Quickbooks::Service::#{entity}".constantize
|
||||||
|
qbo.perform_authenticated_request do |access_token|
|
||||||
|
service = service_class.new( company_id: qbo.realm_id, access_token: access_token )
|
||||||
|
yield service
|
||||||
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
@@ -10,17 +10,20 @@
|
|||||||
|
|
||||||
class QboOauthService
|
class QboOauthService
|
||||||
|
|
||||||
# Generates the QuickBooks OAuth authorization URL with the specified callback URL. The URL includes necessary parameters such as response type, state, and scope.
|
# Generates the QuickBooks OAuth authorization URL with the specified callback URL.
|
||||||
def self.authorization_url(callback_url:)
|
# The URL includes necessary parameters such as response type, state, and scope.
|
||||||
|
# The state value must be stored by the caller and checked when the callback arrives.
|
||||||
|
def self.authorization_url(callback_url:, state:)
|
||||||
client.auth_code.authorize_url(
|
client.auth_code.authorize_url(
|
||||||
redirect_uri: callback_url,
|
redirect_uri: callback_url,
|
||||||
response_type: "code",
|
response_type: "code",
|
||||||
state: SecureRandom.hex(12),
|
state: state,
|
||||||
scope: "com.intuit.quickbooks.accounting"
|
scope: "com.intuit.quickbooks.accounting"
|
||||||
)
|
)
|
||||||
end
|
end
|
||||||
|
|
||||||
# Exchanges the authorization code for access and refresh tokens. Creates or replaces the QBO connection record with the new credentials and refreshes the token immediately after creation.
|
# Exchanges the authorization code for access and refresh tokens.
|
||||||
|
# Creates or replaces the QBO connection record with the new credentials and refreshes the token immediately after creation.
|
||||||
def self.exchange!(code:, callback_url:, realm_id:)
|
def self.exchange!(code:, callback_url:, realm_id:)
|
||||||
resp = client.auth_code.get_token(code, redirect_uri: callback_url)
|
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 )
|
QboConnectionService.replace!( token: resp.token, refresh_token: resp.refresh_token, realm_id: realm_id )
|
||||||
|
|||||||
@@ -0,0 +1,67 @@
|
|||||||
|
#The MIT License (MIT)
|
||||||
|
#
|
||||||
|
#Copyright (c) 2026 rick barrette
|
||||||
|
#
|
||||||
|
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||||
|
#
|
||||||
|
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
#
|
||||||
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
|
class ServiceBase
|
||||||
|
|
||||||
|
# Subclasses should Initializes the service with a QBO client and a local record.
|
||||||
|
# The QBO client is used to communicate with QuickBooks Online, while the local record contains the data that needs to be pushed to QBO.
|
||||||
|
# If no local is provided, the service will not perform any operations.
|
||||||
|
def initialize(local: nil)
|
||||||
|
@entity = local.class.name
|
||||||
|
raise "#{@entity} record is required for push operation" unless local
|
||||||
|
@local = local
|
||||||
|
end
|
||||||
|
|
||||||
|
# Subclasses must implement this to build a new QBO entity if a remote is not found
|
||||||
|
def build_qbo_remote
|
||||||
|
raise NotImplementedError
|
||||||
|
end
|
||||||
|
|
||||||
|
# Pulls the Item data from QuickBooks Online.
|
||||||
|
def pull
|
||||||
|
return build_qbo_remote unless @local.present?
|
||||||
|
return build_qbo_remote unless @local.id
|
||||||
|
log "Fetching details for #{@entity} ##{@local.id} from QBO..."
|
||||||
|
QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||||
|
service.fetch_by_id(@local.id)
|
||||||
|
end
|
||||||
|
rescue => e
|
||||||
|
log "Fetch failed for #{@local.id}: #{e.message}"
|
||||||
|
build_qbo_remote
|
||||||
|
end
|
||||||
|
|
||||||
|
# Pushes the Item data to QuickBooks Online.
|
||||||
|
# This method handles the communication with QBO, including authentication and error handling.
|
||||||
|
# It uses the QBO client to send the remote data and logs the process for monitoring and debugging purposes.
|
||||||
|
# If the push is successful, it returns the remote record; otherwise, it logs the error and returns false.
|
||||||
|
def push
|
||||||
|
log "Pushing #{@entity} ##{@local.id} to QBO..."
|
||||||
|
remote = QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||||
|
if @local.id.present?
|
||||||
|
log "Updating #{@entity}"
|
||||||
|
service.update(@local.details)
|
||||||
|
else
|
||||||
|
log "Creating #{@entity}"
|
||||||
|
service.create(@local.details)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
@local.id = remote.id unless @local.persisted?
|
||||||
|
log "Push for remote ##{@local.id} completed."
|
||||||
|
@local
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# Log messages with the entity type for better traceability
|
||||||
|
def log(msg)
|
||||||
|
Rails.logger.info "[#{@entity}Service] #{msg}"
|
||||||
|
end
|
||||||
|
|
||||||
|
end
|
||||||
@@ -12,10 +12,14 @@ class SyncServiceBase
|
|||||||
PAGE_SIZE = 1000
|
PAGE_SIZE = 1000
|
||||||
|
|
||||||
# Subclasses should initialize with a QBO client instance
|
# Subclasses should initialize with a QBO client instance
|
||||||
def initialize(qbo:)
|
def initialize()
|
||||||
raise "No QBO configuration found" unless qbo
|
|
||||||
@qbo = qbo
|
|
||||||
@entity = self.class.model_class
|
@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
|
end
|
||||||
|
|
||||||
# Subclasses must implement this to specify which local model they sync (e.g. Customer, Invoice)
|
# Subclasses must implement this to specify which local model they sync (e.g. Customer, Invoice)
|
||||||
@@ -25,34 +29,25 @@ class SyncServiceBase
|
|||||||
|
|
||||||
# Sync all entities, or only those updated since the last sync
|
# Sync all entities, or only those updated since the last sync
|
||||||
def sync(full_sync: false)
|
def sync(full_sync: false)
|
||||||
log "Starting #{full_sync ? 'full' : 'incremental'} #{@entity.name} sync"
|
log "Starting #{full_sync ? 'full' : 'incremental'} #{@entity.name} sync with page size of: #{@page_size}"
|
||||||
|
QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||||
@qbo.perform_authenticated_request do |access_token|
|
query = build_query(full_sync)
|
||||||
service_class = "Quickbooks::Service::#{@entity.name}".constantize
|
service.query_in_batches(query, per_page: @page_size) do |batch|
|
||||||
service = service_class.new(company_id: @qbo.realm_id, access_token: access_token)
|
entries = Array(batch)
|
||||||
|
log "Processing batch of #{entries.size} #{@entity.name}"
|
||||||
page = 1
|
entries.each do |remote|
|
||||||
loop do
|
persist(remote)
|
||||||
collection = fetch_page(service, page, full_sync)
|
end
|
||||||
entries = Array(collection&.entries)
|
|
||||||
break if entries.empty?
|
|
||||||
|
|
||||||
entries.each { |remote| persist(remote) }
|
|
||||||
|
|
||||||
break if entries.size < PAGE_SIZE
|
|
||||||
page += 1
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
log "#{@entity.name} sync complete"
|
log "#{@entity.name} sync complete"
|
||||||
end
|
end
|
||||||
|
|
||||||
# Sync a single entity by its QBO ID, used for webhook updates
|
# Sync a single entity by its QBO ID (webhook usage)
|
||||||
def sync_by_id(id)
|
def sync_by_id(id)
|
||||||
log "Syncing #{@entity.name} with ID #{id}"
|
log "Syncing #{@entity.name} with ID #{id}"
|
||||||
@qbo.perform_authenticated_request do |access_token|
|
QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||||
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)
|
remote = service.fetch_by_id(id)
|
||||||
persist(remote)
|
persist(remote)
|
||||||
end
|
end
|
||||||
@@ -64,39 +59,152 @@ class SyncServiceBase
|
|||||||
# Override in subclasses if the entity has attachments (e.g. Invoice)
|
# Override in subclasses if the entity has attachments (e.g. Invoice)
|
||||||
end
|
end
|
||||||
|
|
||||||
|
# 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
|
||||||
|
|
||||||
# Determine if a remote entity should be deleted locally (e.g. if it's marked inactive in QBO)
|
# Determine if a remote entity should be deleted locally (e.g. if it's marked inactive in QBO)
|
||||||
def destroy_remote?(remote)
|
def destroy_local?(remote)
|
||||||
false
|
false
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def extract_value(remote, remote_attr)
|
||||||
|
case remote_attr
|
||||||
|
when Proc
|
||||||
|
remote_attr.call(remote)
|
||||||
|
else
|
||||||
|
remote.public_send(remote_attr)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
# Attribute Mapping DSL
|
||||||
|
#
|
||||||
|
# This DSL defines how attributes from a QuickBooks Online (QBO) entity
|
||||||
|
# are mapped onto a local ActiveRecord model during synchronization.
|
||||||
|
#
|
||||||
|
# Each mapping registers a lambda in `attribute_map`. When a remote QBO
|
||||||
|
# object is processed, the lambda is executed to extract and transform
|
||||||
|
# the value that will be assigned to the local model attribute.
|
||||||
|
#
|
||||||
|
# The DSL supports several mapping patterns:
|
||||||
|
#
|
||||||
|
# 1. Direct attribute mapping (same name)
|
||||||
|
#
|
||||||
|
# map_attribute :doc_number
|
||||||
|
#
|
||||||
|
# Equivalent to:
|
||||||
|
#
|
||||||
|
# local.doc_number = remote.doc_number
|
||||||
|
#
|
||||||
|
# 2. Renamed attribute mapping
|
||||||
|
#
|
||||||
|
# map_attribute :total_amount, :total
|
||||||
|
#
|
||||||
|
# Equivalent to:
|
||||||
|
#
|
||||||
|
# local.total_amount = remote.total
|
||||||
|
#
|
||||||
|
# 3. Custom transformation logic
|
||||||
|
#
|
||||||
|
# map_attribute :qbo_updated_at do |remote|
|
||||||
|
# remote.meta_data&.last_updated_time
|
||||||
|
# end
|
||||||
|
#
|
||||||
|
# Useful for nested fields or computed values.
|
||||||
|
#
|
||||||
|
# 4. Bulk attribute mapping
|
||||||
|
#
|
||||||
|
# map_attributes :doc_number, :txn_date, :due_date
|
||||||
|
#
|
||||||
|
# Convenience helper that maps multiple attributes with identical names.
|
||||||
|
#
|
||||||
|
# 5. Foreign key / reference mapping
|
||||||
|
#
|
||||||
|
# map_belongs_to :customer
|
||||||
|
#
|
||||||
|
# Resolves a QBO reference object (e.g. `customer_ref.value`) and finds
|
||||||
|
# the associated local ActiveRecord model.
|
||||||
|
#
|
||||||
|
# 6. Specialized helpers
|
||||||
|
#
|
||||||
|
# map_phone :phone_number, :primary_phone
|
||||||
|
#
|
||||||
|
# Extracts and normalizes phone numbers by stripping non-digit characters.
|
||||||
|
#
|
||||||
|
# Internally, the mappings are stored in `attribute_map` and executed by the
|
||||||
|
# SyncService during `process_attributes`, which iterates through each mapping
|
||||||
|
# and assigns the computed value to the local record.
|
||||||
|
#
|
||||||
|
# This design keeps synchronization services declarative, readable, and easy
|
||||||
|
# to extend while centralizing transformation logic in a single DSL.
|
||||||
|
class << self
|
||||||
|
|
||||||
|
def map_attributes(*attrs)
|
||||||
|
attrs.each do |attr|
|
||||||
|
map_attribute(attr)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
def map_attribute(local_attr, remote_attr = nil, &block)
|
||||||
|
attribute_map[local_attr] =
|
||||||
|
if block_given?
|
||||||
|
block
|
||||||
|
elsif remote_attr
|
||||||
|
->(remote) do
|
||||||
|
remote_attr.to_s.split('.').reduce(remote) do |obj, method|
|
||||||
|
obj&.public_send(method)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
else
|
||||||
|
->(remote) { remote.public_send(local_attr) }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def attribute_map
|
||||||
|
@attribute_map ||= {}
|
||||||
|
end
|
||||||
|
|
||||||
|
def map_belongs_to(local_attr, ref: nil, model: nil)
|
||||||
|
ref ||= "#{local_attr}_ref"
|
||||||
|
model ||= local_attr.to_s.classify.constantize
|
||||||
|
|
||||||
|
attribute_map[local_attr] = lambda do |remote|
|
||||||
|
ref_obj = remote.public_send(ref)
|
||||||
|
id = ref_obj&.value
|
||||||
|
id ? model.find_by(id: id) : nil
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def map_phone(local_attr, remote_attr)
|
||||||
|
attribute_map[local_attr] = lambda do |remote|
|
||||||
|
phone = remote.public_send(remote_attr)
|
||||||
|
phone&.free_form_number&.gsub(/\D/, '')
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
# Log messages with the entity type for better traceability
|
# Log messages with the entity type for better traceability
|
||||||
def log(msg)
|
def log(msg)
|
||||||
Rails.logger.info "[#{@entity.name}SyncService] #{msg}"
|
Rails.logger.info "[#{@entity.name}SyncService] #{msg}"
|
||||||
end
|
end
|
||||||
|
|
||||||
# Fetch a page of entities, either all or only those updated since the last sync
|
|
||||||
def fetch_page(service, page, full_sync)
|
|
||||||
log "Fetching page #{page} of #{@entity.name} from QBO (#{full_sync ? 'full' : 'incremental'} sync)"
|
|
||||||
start_position = (page - 1) * PAGE_SIZE + 1
|
|
||||||
|
|
||||||
if full_sync
|
|
||||||
service.query("SELECT * FROM #{@entity.name} STARTPOSITION #{start_position} MAXRESULTS #{PAGE_SIZE}")
|
|
||||||
else
|
|
||||||
last_update = @entity.maximum(:updated_at) || 1.year.ago
|
|
||||||
service.query(<<~SQL.squish)
|
|
||||||
SELECT * FROM #{@entity.name}
|
|
||||||
WHERE MetaData.LastUpdatedTime > '#{last_update.utc.iso8601}'
|
|
||||||
STARTPOSITION #{start_position}
|
|
||||||
MAXRESULTS #{PAGE_SIZE}
|
|
||||||
SQL
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Create or update a local entity record based on the QBO remote data
|
# Create or update a local entity record based on the QBO remote data
|
||||||
def persist(remote)
|
def persist(remote)
|
||||||
local = @entity.find_or_initialize_by(id: remote.id)
|
local = @entity.find_or_initialize_by(id: remote.id)
|
||||||
|
|
||||||
if destroy_remote?(remote)
|
if destroy_local?(remote)
|
||||||
if local.persisted?
|
if local.persisted?
|
||||||
local.destroy
|
local.destroy
|
||||||
log "Deleted #{@entity.name} #{remote.id}"
|
log "Deleted #{@entity.name} #{remote.id}"
|
||||||
@@ -104,24 +212,30 @@ class SyncServiceBase
|
|||||||
return
|
return
|
||||||
end
|
end
|
||||||
|
|
||||||
# Map remote attributes to local model fields, this should be implemented in subclasses
|
|
||||||
process_attributes(local, remote)
|
process_attributes(local, remote)
|
||||||
|
|
||||||
if local.changed?
|
if local.new_record? || local.changed?
|
||||||
|
was_new = local.new_record?
|
||||||
|
local.skip_qbo_push = true
|
||||||
local.save!
|
local.save!
|
||||||
log "Updated #{@entity.name} #{remote.id}"
|
log "#{was_new ? 'Created' : 'Updated'} #{@entity.name} #{remote.id}"
|
||||||
|
attach_documents(local, remote)
|
||||||
# Handle attaching documents if applicable to invoices
|
|
||||||
attach_documents(local, remote)
|
|
||||||
end
|
end
|
||||||
|
|
||||||
rescue => e
|
rescue => e
|
||||||
log "Failed to sync #{@entity.name} #{remote.id}: #{e.message}"
|
log "Failed to sync #{@entity.name} #{remote.id}: #{e.message}"
|
||||||
end
|
end
|
||||||
|
|
||||||
# This method should be implemented in subclasses to map remote attributes to local model
|
# Maps remote attributes to local model
|
||||||
def process_attributes(local, remote)
|
def process_attributes(local, remote)
|
||||||
raise NotImplementedError, "Subclasses must implement process_attributes"
|
log "Processing #{@entity} ##{remote.id}"
|
||||||
end
|
|
||||||
|
|
||||||
|
self.class.attribute_map.each do |local_attr, mapper|
|
||||||
|
value = mapper.call(remote)
|
||||||
|
|
||||||
|
if local.public_send(local_attr) != value
|
||||||
|
local.public_send("#{local_attr}=", value)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
end
|
||||||
end
|
end
|
||||||
@@ -1,11 +1,75 @@
|
|||||||
<%= link_to t(:label_appointment), "https://calendar.google.com/calendar/render?action=TEMPLATE&text=#{@customer.name}+-&details=#{ link_to t(:customer_details), "https://#{Setting.host_name}#{customer_path @customer.id}"}%0A#{@customer.primary_phone}%3Cbr/%3E+&dates=#{Time.now.strftime("%Y%m%d")}T090000/#{Time.now.strftime("%Y%m%d")}T170000", target: :_blank, id: :appointment_link %>
|
<%= call_hook :customer_actions_top, { customer: @customer } %>
|
||||||
|
|
||||||
<br/>
|
<p>
|
||||||
<br/>
|
<%= link_to t(:label_new_issue), new_issue_path(issue: { customer_id: @customer.id }), id: "dynamic-new-issue-link", target: :_blank %>
|
||||||
|
</p>
|
||||||
|
|
||||||
<%= link_to t(:label_create_estimate), "https://qbo.intuit.com/app/estimate?nameId=#{@customer.id}", target: :_blank %>
|
<p>
|
||||||
|
<%= link_to t(:label_create_estimate), "https://qbo.intuit.com/app/estimate?nameId=#{@customer.id}", target: :_blank %>
|
||||||
|
</p>
|
||||||
|
|
||||||
<br/>
|
<p>
|
||||||
<br/>
|
<%= link_to t(:label_create_payment), "https://qbo.intuit.com/app/recvpayment?nameId=#{@customer.id}", target: :_blank %>
|
||||||
|
</p>
|
||||||
|
|
||||||
<%= button_to t(:label_edit_customer), edit_customer_path(@customer), method: :get%>
|
<%= call_hook :customer_actions_bottom, { customer: @customer } %>
|
||||||
|
|
||||||
|
<% if User.current.allowed_to?(:edit_customers, nil, global: true) %>
|
||||||
|
<%= button_to t(:label_edit_customer), edit_customer_path(@customer), method: :get%>
|
||||||
|
<% end %>
|
||||||
|
|
||||||
|
<script>
|
||||||
|
function handleSingleSelect(event, className) {
|
||||||
|
if (event.target.checked) {
|
||||||
|
// Uncheck all other checkboxes of the same type
|
||||||
|
document.querySelectorAll('.' + className).forEach(cb => {
|
||||||
|
if (cb !== event.target) {
|
||||||
|
cb.checked = false;
|
||||||
|
}
|
||||||
|
});
|
||||||
|
}
|
||||||
|
updateLink();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Bind single-select behavior to checkboxes once the DOM is loaded
|
||||||
|
document.addEventListener('DOMContentLoaded', function() {
|
||||||
|
document.querySelectorAll('.estimate-checkbox').forEach(cb => {
|
||||||
|
cb.addEventListener('change', (e) => handleSingleSelect(e, 'estimate-checkbox'));
|
||||||
|
});
|
||||||
|
document.querySelectorAll('.vehicle-checkbox').forEach(cb => {
|
||||||
|
cb.addEventListener('change', (e) => handleSingleSelect(e, 'vehicle-checkbox'));
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
function updateLink() {
|
||||||
|
const link = document.getElementById('dynamic-new-issue-link');
|
||||||
|
if (!link) return;
|
||||||
|
|
||||||
|
// Cache the pristine base URL on first run
|
||||||
|
if (!link.dataset.baseUrl) {
|
||||||
|
link.dataset.baseUrl = link.getAttribute('href');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Build base URL object
|
||||||
|
let url = new URL(link.dataset.baseUrl, window.location.origin);
|
||||||
|
|
||||||
|
// 1. Handle Single Estimate
|
||||||
|
const checkedEstimate = document.querySelector('.estimate-checkbox:checked');
|
||||||
|
if (checkedEstimate) {
|
||||||
|
url.searchParams.set('issue[estimate_id]', checkedEstimate.value);
|
||||||
|
} else {
|
||||||
|
url.searchParams.delete('issue[estimate_id]');
|
||||||
|
}
|
||||||
|
|
||||||
|
// 2. Handle Single Vehicle
|
||||||
|
const checkedVehicle = document.querySelector('.vehicle-checkbox:checked');
|
||||||
|
if (checkedVehicle) {
|
||||||
|
url.searchParams.set('issue[vehicle_id]', checkedVehicle.value);
|
||||||
|
} else {
|
||||||
|
url.searchParams.delete('issue[vehicle_id]');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Update the link's href attribute
|
||||||
|
link.setAttribute('href', url.toString());
|
||||||
|
}
|
||||||
|
</script>
|
||||||
@@ -2,59 +2,55 @@
|
|||||||
<tbody>
|
<tbody>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
<th><%=t(:label_name)%></th>
|
<th><%= t(:label_name) %></th>
|
||||||
<td><%= customer.name %></td>
|
<td><%= customer.name %></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
<th><%=t(:label_email)%></th>
|
<th><%= t(:label_email) %></th>
|
||||||
<td><%= customer.email %></td>
|
<td><%= customer.email %></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<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) %></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) %></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><pre><%= @billing_address %></pre></td>
|
<td><pre><%= @billing_address %></pre></td>
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<th><%=t(:label_shipping_address)%></th>
|
|
||||||
<td><pre><%= @shipping_address %></pre></td>
|
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
<th><%=t(:label_account_balance)%></th>
|
<th><%= t(:label_shipping_address) %></th>
|
||||||
<td>$<%= customer.balance %></td>
|
<td><pre><%= @shipping_address %></pre></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
<th colspan="2"><h4><%=t(:field_notes)%></hr></th>
|
<th><%= t(:label_account_balance) %></th>
|
||||||
|
<td>$<%= customer.balance %></td>
|
||||||
</tr>
|
</tr>
|
||||||
|
|
||||||
|
<% if customer.notes.present? %>
|
||||||
|
<tr>
|
||||||
|
<th colspan="2"><h4><%= t(:field_notes) %></h4></th>
|
||||||
|
</tr>
|
||||||
|
|
||||||
<tr>
|
<tr>
|
||||||
<td colspan="2">
|
<td colspan="2">
|
||||||
<pre id="note-display" style="text-align: left; white-space: pre-wrap; font-family: inherit;">
|
<div class="wiki">
|
||||||
<%= customer.notes %>
|
<%= textilizable(customer, :notes) %>
|
||||||
</pre>
|
</div>
|
||||||
</td>
|
</td>
|
||||||
</tr>
|
</tr>
|
||||||
|
<% end %>
|
||||||
<script>
|
|
||||||
const preElement = document.getElementById('note-display');
|
|
||||||
// This takes the text, trims the edges, and puts it back
|
|
||||||
preElement.textContent = preElement.textContent.trim();
|
|
||||||
</script>
|
|
||||||
|
|
||||||
</tbody>
|
</tbody>
|
||||||
</table>
|
</table>
|
||||||
<br/>
|
<br/>
|
||||||
<br/>
|
<br/>
|
||||||
@@ -1,59 +1,44 @@
|
|||||||
<div class="row">
|
<%= form_for @customer do |f| %>
|
||||||
<div class="span6 columns">
|
<%= error_messages_for 'customer' %>
|
||||||
<fieldset>
|
|
||||||
|
|
||||||
<%= form_for @customer do |f| %>
|
<div class="box tabular">
|
||||||
|
|
||||||
<div class="clearfix">
|
|
||||||
<%=t(:label_display_name)%>
|
|
||||||
<div class="input">
|
|
||||||
<%= f.text_field :name, required: true, autocomplete: "off" %>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="clearfix">
|
|
||||||
<%=t(:label_primary_phone)%>
|
|
||||||
<div class="input">
|
|
||||||
<%= f.telephone_field :primary_phone, autocomplete: "off" %>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="clearfix">
|
|
||||||
<%=t(:label_mobile_phone)%>:
|
|
||||||
<div class="input">
|
|
||||||
<%= f.telephone_field :mobile_phone, autocomplete: "off" %>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="clearfix">
|
|
||||||
<%=t(:label_email)%>:
|
|
||||||
<div class="input">
|
|
||||||
<%= f.email_field :email, autocomplete: "off" %>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="clearfix">
|
|
||||||
<%=t(:field_notes)%>:
|
|
||||||
<div class="input">
|
|
||||||
<p>
|
|
||||||
<%= content_tag :span, id: "issue_description_and_toolbar" do %>
|
|
||||||
<%= f.text_area :notes,
|
|
||||||
cols: 60,
|
|
||||||
rows: 10,
|
|
||||||
accesskey: accesskey(:edit),
|
|
||||||
class: 'wiki-edit',
|
|
||||||
no_label: true %>
|
|
||||||
<% end %>
|
|
||||||
</p>
|
|
||||||
<%= wikitoolbar_for :issue_description %>
|
|
||||||
</div>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div class="actions">
|
|
||||||
<%= f.submit %>
|
|
||||||
</div>
|
|
||||||
<% end %>
|
|
||||||
|
|
||||||
</fieldset>
|
<p>
|
||||||
|
<%= f.label :name, t(:label_display_name) %>
|
||||||
|
<%= f.text_field :name, required: true, class: "customer-name", autocomplete: "off", data: { autocomplete_url: "/customers/autocomplete" } %>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<%= f.label :primary_phone, t(:label_primary_phone) %>
|
||||||
|
<%= f.telephone_field :primary_phone, autocomplete: "off" %>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<%= f.label :mobile_phone, t(:label_mobile_phone) %>
|
||||||
|
<%= f.telephone_field :mobile_phone, autocomplete: "off" %>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<%= f.label :email, t(:label_email) %>
|
||||||
|
<%= f.email_field :email, autocomplete: "off" %>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<%= f.label :notes, t(:field_notes) %>
|
||||||
|
<%= f.text_area :notes,
|
||||||
|
rows: 8,
|
||||||
|
class: 'wiki-edit',
|
||||||
|
style: 'width: 99%;',
|
||||||
|
id: 'customer_notes' %>
|
||||||
|
<% unless local_assigns[:hide_toolbar] %>
|
||||||
|
<%= wikitoolbar_for 'customer_notes' %>
|
||||||
|
<% end %>
|
||||||
|
</p>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
|
||||||
|
<% unless local_assigns[:hide_submit] %>
|
||||||
|
<p class="buttons">
|
||||||
|
<%= submit_tag t(:button_save) %>
|
||||||
|
</p>
|
||||||
|
<% end %>
|
||||||
|
<% end %>
|
||||||
@@ -1,5 +1,8 @@
|
|||||||
<%= form_tag(customers_path, method: "get", id: "customer-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], class: "customer-name", placeholder: t(:label_search_customers), autocomplete: "off", data: { autocomplete_url: "/customers/autocomplete" } %>
|
||||||
<%= submit_tag t(:label_search) %>
|
<%= submit_tag t(:label_search) %>
|
||||||
<% end %>
|
<% end %>
|
||||||
<%= button_to t(:label_new_customer), new_customer_path, method: :get%>
|
<% if User.current.allowed_to?(:add_customers, nil, global: true) %>
|
||||||
|
<%= button_to t(:label_new_customer), new_customer_path, method: :get%>
|
||||||
|
<% end %>
|
||||||
|
<%= button_to(t(:label_sync), qbo_sync_path, method: :get) if User.current.admin?%>
|
||||||
@@ -1,3 +1,2 @@
|
|||||||
<h2><%=t(:label_new_customer)%></h2>
|
<h2><%=t(:label_new_customer)%></h2>
|
||||||
<br/>
|
<%= render partial: 'customers/form' %>
|
||||||
<%= render partial: 'customers/form' %>
|
|
||||||
@@ -1,4 +1,4 @@
|
|||||||
<h2><%=t(:field_customer)%> #<%= @customer.id %> - <%= link_to @customer.to_s, "https://#{Setting.plugin_redmine_qbo[:sandbox] ? "sandbox" : "app"}.qbo.intuit.com/app/customerdetail?nameId=#{@customer.id}", target: :_blank %> </h2>
|
<h2><%=t(:field_customer)%> #<%= @customer.id %> - <%= link_to @customer.to_s, "https://#{RedmineQbo.sandbox_mode? ? "sandbox" : "app"}.qbo.intuit.com/app/customerdetail?nameId=#{@customer.id}", target: :_blank %> </h2>
|
||||||
<div class="issue">
|
<div class="issue">
|
||||||
|
|
||||||
<div class="splitcontent">
|
<div class="splitcontent">
|
||||||
|
|||||||
@@ -2,11 +2,11 @@
|
|||||||
|
|
||||||
<% estimates.sort.reverse.each do |estimate| %>
|
<% estimates.sort.reverse.each do |estimate| %>
|
||||||
<div class="row">
|
<div class="row">
|
||||||
<%= check_box_tag "estimate_ids[]", estimate.id, false, onchange: "updateLink()", data: { url: estimate_path(estimate), text: "Estimate ##{estimate.to_s}" }, class: "estimate-checkbox appointment" %>
|
<%= check_box_tag "estimate_ids[]", estimate.id, false, onchange: "updateLink()", data: { text: "Estimate ##{estimate.doc_number}" }, class: "estimate-checkbox appointment" %>
|
||||||
<b><%= link_to "##{estimate.doc_number}", estimate_path(estimate), target: :_blank %></b> <%= estimate.txn_date %>
|
<b><%= link_to "##{estimate.doc_number}", estimate_path(estimate), target: :_blank %></b> <%= estimate.txn_date %>
|
||||||
</div>
|
</div>
|
||||||
<% end %>
|
<% end %>
|
||||||
|
|
||||||
<% else %>
|
<% else %>
|
||||||
<p><%=t(:label_no_estimates)%>.</p>
|
<p><%=t(:label_no_estimates)%>.</p>
|
||||||
<% end %>
|
<% end %>
|
||||||
@@ -7,6 +7,3 @@
|
|||||||
<p>
|
<p>
|
||||||
<%= select_estimate %>
|
<%= select_estimate %>
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
<%= render "line_items/issue_form", f: f %>
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
<% @issue.line_items.build if @issue.line_items.empty? %>
|
|
||||||
|
|
||||||
<div class="box tabular" data-nested-form data-wrapper-selector=".line-item">
|
|
||||||
<p><strong>Line Items</strong></p>
|
|
||||||
|
|
||||||
<table class="list line-items-table">
|
|
||||||
<thead>
|
|
||||||
<tr>
|
|
||||||
<th>Description</th>
|
|
||||||
<th style="width:120px;">Quantity</th>
|
|
||||||
<th style="width:150px;">Unit Price</th>
|
|
||||||
<th style="width:80px;"></th>
|
|
||||||
</tr>
|
|
||||||
</thead>
|
|
||||||
|
|
||||||
<tbody data-nested-form-container>
|
|
||||||
<%= f.fields_for :line_items do |item_form| %>
|
|
||||||
<%= render "line_items/line_item_fields", f: item_form %>
|
|
||||||
<% end %>
|
|
||||||
</tbody>
|
|
||||||
</table>
|
|
||||||
|
|
||||||
<template data-nested-form-template>
|
|
||||||
<%= f.fields_for :line_items, LineItem.new, child_index: "NEW_RECORD" do |item_form| %>
|
|
||||||
<%= render "line_items/line_item_fields", f: item_form %>
|
|
||||||
<% end %>
|
|
||||||
</template>
|
|
||||||
|
|
||||||
<p>
|
|
||||||
<button type="button" class="icon icon-add" data-nested-form-add>
|
|
||||||
Add Line Item
|
|
||||||
</button>
|
|
||||||
</p>
|
|
||||||
</div>
|
|
||||||
@@ -1,34 +0,0 @@
|
|||||||
<tr class="line-item">
|
|
||||||
<%= f.hidden_field :id %>
|
|
||||||
<%= f.hidden_field :_destroy %>
|
|
||||||
|
|
||||||
<td>
|
|
||||||
<%= f.text_field :description,
|
|
||||||
size: 50,
|
|
||||||
placeholder: "Description",
|
|
||||||
:no_label => true %>
|
|
||||||
</td>
|
|
||||||
|
|
||||||
<td>
|
|
||||||
<%= f.number_field :quantity,
|
|
||||||
step: 1,
|
|
||||||
min: 1,
|
|
||||||
style: "width:90px;",
|
|
||||||
:no_label => true %>
|
|
||||||
</td>
|
|
||||||
|
|
||||||
<td>
|
|
||||||
<%= f.number_field :unit_price,
|
|
||||||
step: 0.01,
|
|
||||||
style: "width:120px;",
|
|
||||||
:no_label => true %>
|
|
||||||
</td>
|
|
||||||
|
|
||||||
<td style="text-align:center;">
|
|
||||||
<button type="button"
|
|
||||||
class="icon-only icon-del"
|
|
||||||
title="Remove"
|
|
||||||
data-nested-form-remove>
|
|
||||||
</button>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
@@ -1,111 +1,79 @@
|
|||||||
<!--
|
|
||||||
The MIT License (MIT)
|
|
||||||
|
|
||||||
Copyright (c) 2016 - 2026 rick barrette
|
|
||||||
|
|
||||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
||||||
|
|
||||||
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
||||||
|
|
||||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
-->
|
|
||||||
|
|
||||||
<!-- somewhere in your document include the Javascript -->
|
|
||||||
<script type="text/javascript" src="https://appcenter.intuit.com/Content/IA/intuit.ipp.anywhere.js"></script>
|
<script type="text/javascript" src="https://appcenter.intuit.com/Content/IA/intuit.ipp.anywhere.js"></script>
|
||||||
|
|
||||||
<!-- configure the Intuit object: 'grantUrl' is a URL in your application which kicks off the flow, see below -->
|
|
||||||
<script>
|
<script>
|
||||||
intuit.ipp.anywhere.setup({menuProxy: '/path/to/blue-dot', grantUrl: '<%= qbo_authenticate_path %>'});
|
intuit.ipp.anywhere.setup({menuProxy: '/path/to/blue-dot', grantUrl: '<%= qbo_authenticate_path %>'});
|
||||||
</script>
|
</script>
|
||||||
|
|
||||||
<table >
|
<div class="box tabular">
|
||||||
<tbody>
|
<p>
|
||||||
|
<label><%= t(:label_client_id) %></label>
|
||||||
|
<%= text_field_tag 'settings[oauth_consumer_key]', settings[:oauth_consumer_key], size: 50 %>
|
||||||
|
</p>
|
||||||
|
|
||||||
|
<p>
|
||||||
|
<label><%= t(:label_client_secret) %></label>
|
||||||
|
<%= password_field_tag 'settings[oauth_consumer_secret]', settings[:oauth_consumer_secret], size: 50 %>
|
||||||
|
</p>
|
||||||
|
|
||||||
<tr>
|
<p>
|
||||||
<th><%=t(:label_client_id)%></th>
|
<label><%= t(:label_webhook_token) %></label>
|
||||||
<td>
|
<%= text_field_tag 'settings[webhook_token]', settings[:webhook_token], size: 50 %>
|
||||||
<input
|
</p>
|
||||||
type="text"
|
|
||||||
style="width:350px"
|
|
||||||
id="settingsOAuthConsumerKey"
|
|
||||||
value="<%= settings['settingsOAuthConsumerKey'] %>"
|
|
||||||
name="settings[settingsOAuthConsumerKey]" >
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
<p>
|
||||||
<th><%=t(:label_client_secret)%></th>
|
<label><%= t(:label_sandbox) %></label>
|
||||||
<td>
|
<%= check_box_tag 'settings[sandbox]', 1, settings[:sandbox] %>
|
||||||
<input
|
</p>
|
||||||
type="text"
|
|
||||||
style="width:350px"
|
|
||||||
id="settingsOAuthConsumerSecret"
|
|
||||||
value="<%= settings['settingsOAuthConsumerSecret'] %>"
|
|
||||||
name="settings[settingsOAuthConsumerSecret]" >
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
|
||||||
<th><%=t(:label_webhook_token)%></th>
|
|
||||||
<td>
|
|
||||||
<input
|
|
||||||
type="text"
|
|
||||||
style="width:350px"
|
|
||||||
id="settingsWebhookToken"
|
|
||||||
value="<%= settings['settingsWebhookToken'] %>"
|
|
||||||
name="settings[settingsWebhookToken]" >
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
<hr />
|
||||||
<th><%=t(:label_sandbox)%></th>
|
|
||||||
<td>
|
|
||||||
<%= check_box_tag 'settings[sandbox]', @settings[:sandbox], @settings[:sandbox] %>
|
|
||||||
</td>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
<tr>
|
<p>
|
||||||
<th><%=t(:label_oauth_expires)%></th>
|
<label><%= t(:label_oauth_expires) %></label>
|
||||||
<td><%= QboConnectionService.current!&.oauth2_access_token_expires_at %>
|
<span class="icon <%= Qbo.oauth2_access_token_expires_at&.future? ? 'icon-ok' : 'icon-warning' %>">
|
||||||
</tr>
|
<%= Qbo.oauth2_access_token_expires_at || 'N/A' %>
|
||||||
|
</span>
|
||||||
<tr>
|
</p>
|
||||||
<th><%=t(:label_oauth2_refresh_token_expires_at)%></th>
|
|
||||||
<td><%= QboConnectionService.current!&.oauth2_refresh_token_expires_at %>
|
|
||||||
</tr>
|
|
||||||
|
|
||||||
</tbody>
|
<p>
|
||||||
</table>
|
<label><%= t(:label_customer_count) %></label>
|
||||||
|
<%= Customer.count %>
|
||||||
|
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Customer.last_sync %>)</em>
|
||||||
|
</p>
|
||||||
|
|
||||||
<br/>
|
<p>
|
||||||
<%=t(:label_oauth_note)%>
|
<label><%= t(:label_employee_count) %></label>
|
||||||
<br/>
|
<%= Employee.count %>
|
||||||
<br/>
|
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Employee.last_sync %>)</em>
|
||||||
|
</p>
|
||||||
|
|
||||||
<!-- this will display a button that the user clicks to start the flow -->
|
<p>
|
||||||
<ipp:connectToIntuit></ipp:connectToIntuit>
|
<label><%= t(:label_invoice_count) %></label>
|
||||||
|
<%= Invoice.count %>
|
||||||
|
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Invoice.last_sync %>)</em>
|
||||||
|
</p>
|
||||||
|
|
||||||
<br/>
|
<p>
|
||||||
<br/>
|
<label><%= t(:label_estimate_count) %></label>
|
||||||
|
<%= Estimate.count %>
|
||||||
|
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Estimate.last_sync %>)</em>
|
||||||
|
</p>
|
||||||
|
|
||||||
<div>
|
<p>
|
||||||
<b><%=t(:label_customer_count)%>:</b> <%= Customer.count%> @ <%= Customer.last_sync %>
|
<label><%= t(:label_last_sync) %> (QBO)</label>
|
||||||
</div>
|
<%= Qbo.exists? ? Qbo.last_sync : 'Never synced' %>
|
||||||
|
</p>
|
||||||
<div>
|
|
||||||
<b><%=t(:label_employee_count)%>:</b> <%= Employee.count %> @ <%= Employee.last_sync %>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div>
|
|
||||||
<b><%=t(:label_invoice_count)%>:</b> <%= Invoice.count %> @ <%= Invoice.last_sync%>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<div>
|
|
||||||
<b><%=t(:label_estimate_count)%>:</b> <%= Estimate.count %> @ <%= Estimate.last_sync %>
|
|
||||||
</div>
|
|
||||||
|
|
||||||
<br/>
|
|
||||||
|
|
||||||
<div>
|
|
||||||
<b><%=t(:label_last_sync)%> </b> <%= Qbo.last_sync if Qbo.exists? %> <%= link_to t(:label_sync_now), qbo_sync_path %>
|
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
<fieldset class="box">
|
||||||
|
<legend>Management & Synchronization</legend>
|
||||||
|
|
||||||
|
<div style="margin-bottom: 20px;">
|
||||||
|
<ipp:connectToIntuit></ipp:connectToIntuit>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
<div style="margin-bottom: 15px;">
|
||||||
|
<%= link_to t(:label_sync_now_customers), sync_customers_path, class: 'button icon icon-reload' %>
|
||||||
|
<%= link_to t(:label_sync_now_employees), employees_sync_path, class: 'button icon icon-reload' %>
|
||||||
|
<%= link_to t(:label_sync_now_invoices), invoices_sync_path, class: 'button icon icon-reload' %>
|
||||||
|
<%= link_to t(:label_sync_now_estimate), estimates_sync_path, class: 'button icon icon-reload' %>
|
||||||
|
</div>
|
||||||
|
</fieldset>
|
||||||
@@ -1,6 +1,9 @@
|
|||||||
<% if User.current.logged? %>
|
<% if User.current.logged? %>
|
||||||
|
|
||||||
<%= render partial: 'customers/sidebar' %>
|
<% if User.current.allowed_to?(:view_customers, nil, global: true) %>
|
||||||
|
<%= render partial: 'customers/sidebar' %>
|
||||||
|
<% end %>
|
||||||
|
|
||||||
<%= render partial: 'estimates/sidebar' %>
|
<%= render partial: 'estimates/sidebar' %>
|
||||||
|
|
||||||
<% end %>
|
<% end %>
|
||||||
@@ -1 +0,0 @@
|
|||||||
!function(t){t.fn.railsAutocomplete=function(e){var a=function(){this.railsAutoCompleter||(this.railsAutoCompleter=new t.railsAutocomplete(this))};if(void 0!==t.fn.on){if(!e)return;return t(document).on("focus",e,a)}return this.live("focus",a)},t.railsAutocomplete=function(t){var e=t;this.init(e)},t.railsAutocomplete.options={showNoMatches:!0,noMatchesLabel:"no existing match"},t.railsAutocomplete.fn=t.railsAutocomplete.prototype={railsAutocomplete:"0.0.1"},t.railsAutocomplete.fn.extend=t.railsAutocomplete.extend=t.extend,t.railsAutocomplete.fn.extend({init:function(e){function a(t){return t.split(e.delimiter)}function i(t){return a(t).pop().replace(/^\s+/,"")}e.delimiter=t(e).attr("data-delimiter")||null,e.min_length=t(e).attr("data-min-length")||t(e).attr("min-length")||2,e.append_to=t(e).attr("data-append-to")||null,e.autoFocus=t(e).attr("data-auto-focus")||!1,t(e).autocomplete({appendTo:e.append_to,autoFocus:e.autoFocus,delay:t(e).attr("delay")||0,source:function(a,r){var n=this.element[0],o={term:i(a.term)};t(e).attr("data-autocomplete-fields")&&t.each(t.parseJSON(t(e).attr("data-autocomplete-fields")),function(e,a){o[e]=t(a).val()}),t.getJSON(t(e).attr("data-autocomplete"),o,function(){var a={};t.extend(a,t.railsAutocomplete.options),t.each(a,function(i,r){if(a.hasOwnProperty(i)){var n=t(e).attr("data-"+i);a[i]=n?n:r}}),0==arguments[0].length&&t.inArray(a.showNoMatches,[!0,"true"])>=0&&(arguments[0]=[],arguments[0][0]={id:"",label:a.noMatchesLabel}),t(arguments[0]).each(function(a,i){var r={};r[i.id]=i,t(e).data(r)}),r.apply(null,arguments),t(n).trigger("railsAutocomplete.source",arguments)})},change:function(e,a){if(t(this).is("[data-id-element]")&&""!==t(t(this).attr("data-id-element")).val()&&(t(t(this).attr("data-id-element")).val(a.item?a.item.id:"").trigger("change"),t(this).attr("data-update-elements"))){var i=t.parseJSON(t(this).attr("data-update-elements")),r=a.item?t(this).data(a.item.id.toString()):{};if(i&&""===t(i.id).val())return;for(var n in i){var o=t(i[n]);o.is(":checkbox")?null!=r[n]&&o.prop("checked",r[n]):o.val(a.item?r[n]:"").trigger("change")}}},search:function(){var t=i(this.value);return t.length<e.min_length?!1:void 0},focus:function(){return!1},select:function(i,r){if(r.item.value=r.item.value.toString(),-1!=r.item.value.toLowerCase().indexOf("no match")||-1!=r.item.value.toLowerCase().indexOf("too many results"))return t(this).trigger("railsAutocomplete.noMatch",r),!1;var n=a(this.value);if(n.pop(),n.push(r.item.value),null!=e.delimiter)n.push(""),this.value=n.join(e.delimiter);else if(this.value=n.join(""),t(this).attr("data-id-element")&&t(t(this).attr("data-id-element")).val(r.item.id).trigger("change"),t(this).attr("data-update-elements")){var o=r.item,l=-1!=r.item.value.indexOf("Create New")?!0:!1,u=t.parseJSON(t(this).attr("data-update-elements"));for(var s in u)"checkbox"===t(u[s]).attr("type")?o[s]===!0||1===o[s]?t(u[s]).attr("checked","checked"):t(u[s]).removeAttr("checked"):l&&o[s]&&-1==o[s].indexOf("Create New")||!l?t(u[s]).val(o[s]).trigger("change"):t(u[s]).val("").trigger("change")}var c=this.value;return t(this).bind("keyup.clearId",function(){t.trim(t(this).val())!=t.trim(c)&&(t(t(this).attr("data-id-element")).val("").trigger("change"),t(this).unbind("keyup.clearId"))}),t(e).trigger("railsAutocomplete.select",r),!1}}),t(e).trigger("railsAutocomplete.init")}}),t(document).ready(function(){t("input[data-autocomplete]").railsAutocomplete("input[data-autocomplete]")})}(jQuery);
|
|
||||||
@@ -0,0 +1,102 @@
|
|||||||
|
(function () {
|
||||||
|
|
||||||
|
// Helper: escape HTML for safety
|
||||||
|
function escapeHtml(str) {
|
||||||
|
return $("<div>").text(str).html();
|
||||||
|
}
|
||||||
|
|
||||||
|
// Helper: highlight all occurrences of term (case-insensitive)
|
||||||
|
function highlightTerm(text, term) {
|
||||||
|
if (!term) return text;
|
||||||
|
const escapedTerm = term.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
|
||||||
|
const regex = new RegExp("(" + escapedTerm + ")", "ig");
|
||||||
|
return text.replace(regex, "<strong>$1</strong>");
|
||||||
|
}
|
||||||
|
|
||||||
|
window.initCustomerAutocomplete = function(context) {
|
||||||
|
let scope = context || document;
|
||||||
|
|
||||||
|
$(scope).find(".customer-name").each(function() {
|
||||||
|
if ($(this).data("autocomplete-initialized")) return;
|
||||||
|
$(this).data("autocomplete-initialized", true);
|
||||||
|
|
||||||
|
let $input = $(this);
|
||||||
|
|
||||||
|
let ac = $input.autocomplete({
|
||||||
|
appendTo: "body", // crucial for Redmine positioning
|
||||||
|
minLength: 2,
|
||||||
|
|
||||||
|
source: function(request, response) {
|
||||||
|
$.getJSON("/customers/autocomplete", { q: request.term })
|
||||||
|
.done(function(data) {
|
||||||
|
response(data.map(function(item) {
|
||||||
|
// combine secondary info
|
||||||
|
let secondary = [];
|
||||||
|
if (item.phone_number) secondary.push(item.phone_number);
|
||||||
|
if (item.mobile_phone_number) secondary.push(item.mobile_phone_number);
|
||||||
|
|
||||||
|
let meta = secondary.length ? " (" + secondary.join(" • ") + ")" : "";
|
||||||
|
|
||||||
|
// escape HTML to avoid XSS
|
||||||
|
let safeText = escapeHtml(item.name + meta);
|
||||||
|
|
||||||
|
return {
|
||||||
|
label: item.name + meta, // plain fallback
|
||||||
|
value: item.name, // goes into input
|
||||||
|
id: item.id,
|
||||||
|
html: highlightTerm(safeText, request.term)
|
||||||
|
};
|
||||||
|
}));
|
||||||
|
})
|
||||||
|
.fail(function() {
|
||||||
|
response([]);
|
||||||
|
});
|
||||||
|
},
|
||||||
|
|
||||||
|
select: function(event, ui) {
|
||||||
|
$input.val(ui.item.value); // visible text
|
||||||
|
$("#customer_id").val(ui.item.id); // hidden ID
|
||||||
|
|
||||||
|
// trigger Redmine form update safely
|
||||||
|
setTimeout(function() {
|
||||||
|
$("#customer_id").trigger("change");
|
||||||
|
}, 0);
|
||||||
|
|
||||||
|
return false;
|
||||||
|
},
|
||||||
|
|
||||||
|
change: function(event, ui) {
|
||||||
|
// clear hidden field if no valid selection
|
||||||
|
if (!ui.item && !$input.val()) {
|
||||||
|
$("#customer_id").val("");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Render item HTML for highlight
|
||||||
|
ac.autocomplete("instance")._renderItem = function(ul, item) {
|
||||||
|
return $("<li>")
|
||||||
|
.append($("<div>").html(item.html))
|
||||||
|
.appendTo(ul);
|
||||||
|
};
|
||||||
|
});
|
||||||
|
};
|
||||||
|
|
||||||
|
// Re-init after Redmine AJAX form updates
|
||||||
|
$(document).on("ajaxComplete", function() {
|
||||||
|
if (window.initCustomerAutocomplete) {
|
||||||
|
window.initCustomerAutocomplete(document);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
// Init on page load
|
||||||
|
$(document).ready(function() {
|
||||||
|
window.initCustomerAutocomplete(document);
|
||||||
|
});
|
||||||
|
|
||||||
|
// Also init on Turbo/Redmine load events
|
||||||
|
document.addEventListener("turbo:load", function() {
|
||||||
|
window.initCustomerAutocomplete(document);
|
||||||
|
});
|
||||||
|
|
||||||
|
})();
|
||||||
@@ -1,53 +0,0 @@
|
|||||||
(function () {
|
|
||||||
function initNestedForms() {
|
|
||||||
document.querySelectorAll("[data-nested-form]").forEach(function (wrapper) {
|
|
||||||
if (wrapper.dataset.initialized === "true") return;
|
|
||||||
wrapper.dataset.initialized = "true";
|
|
||||||
|
|
||||||
const container = wrapper.querySelector("[data-nested-form-container]");
|
|
||||||
const template = wrapper.querySelector("[data-nested-form-template]");
|
|
||||||
|
|
||||||
if (!container || !template) return;
|
|
||||||
|
|
||||||
wrapper.addEventListener("click", function (event) {
|
|
||||||
const addButton = event.target.closest("[data-nested-form-add]");
|
|
||||||
const removeButton = event.target.closest("[data-nested-form-remove]");
|
|
||||||
|
|
||||||
// ADD
|
|
||||||
if (addButton) {
|
|
||||||
event.preventDefault();
|
|
||||||
|
|
||||||
const content = template.innerHTML.replace(
|
|
||||||
/NEW_RECORD/g,
|
|
||||||
Date.now().toString()
|
|
||||||
);
|
|
||||||
|
|
||||||
container.insertAdjacentHTML("beforeend", content);
|
|
||||||
}
|
|
||||||
|
|
||||||
// REMOVE
|
|
||||||
if (removeButton) {
|
|
||||||
event.preventDefault();
|
|
||||||
|
|
||||||
const lineItem = removeButton.closest(wrapper.dataset.wrapperSelector);
|
|
||||||
if (!lineItem) return;
|
|
||||||
|
|
||||||
const destroyField = lineItem.querySelector("input[name*='_destroy']");
|
|
||||||
|
|
||||||
if (destroyField) {
|
|
||||||
destroyField.value = "1";
|
|
||||||
lineItem.style.display = "none";
|
|
||||||
} else {
|
|
||||||
lineItem.remove();
|
|
||||||
}
|
|
||||||
}
|
|
||||||
});
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
// Works for full load
|
|
||||||
document.addEventListener("DOMContentLoaded", initNestedForms);
|
|
||||||
|
|
||||||
// Works for Turbo navigation
|
|
||||||
document.addEventListener("turbo:load", initNestedForms);
|
|
||||||
})();
|
|
||||||
@@ -0,0 +1,5 @@
|
|||||||
|
/* Keep Redmine default look, just enhance metadata */
|
||||||
|
.ui-autocomplete .autocomplete-meta {
|
||||||
|
color: #888;
|
||||||
|
font-size: 0.9em;
|
||||||
|
}
|
||||||
@@ -11,6 +11,9 @@
|
|||||||
# English strings go here for Rails i18n
|
# English strings go here for Rails i18n
|
||||||
# Usage I18n.t(:label)
|
# Usage I18n.t(:label)
|
||||||
en:
|
en:
|
||||||
|
notice_qbo_oauth_state_mismatch: "QuickBooks connection was not completed: the request could not be verified. Please try connecting again."
|
||||||
|
permission_bill_issues: "Bill issue time to QuickBooks"
|
||||||
|
permission_share_issues_with_customers: "Share issues with customers"
|
||||||
button_bulk_pdf: "Bulk PDF"
|
button_bulk_pdf: "Bulk PDF"
|
||||||
customer_details: "Customer Details"
|
customer_details: "Customer Details"
|
||||||
field_billed: "Billed"
|
field_billed: "Billed"
|
||||||
@@ -34,8 +37,10 @@ en:
|
|||||||
label_closed_issues: "Closed Issues"
|
label_closed_issues: "Closed Issues"
|
||||||
label_connected: "Successfully connected to QuickBooks"
|
label_connected: "Successfully connected to QuickBooks"
|
||||||
label_create_estimate: "Create Estimate"
|
label_create_estimate: "Create Estimate"
|
||||||
|
label_create_payment: "Create Payment"
|
||||||
label_customer_count: "Customer Count"
|
label_customer_count: "Customer Count"
|
||||||
label_customer_link_expires: "This customer link expires in"
|
label_customer_link_expires: "This customer link expires in"
|
||||||
|
label_customer: "Customer"
|
||||||
label_customers: "Customers"
|
label_customers: "Customers"
|
||||||
label_delete: "Delete"
|
label_delete: "Delete"
|
||||||
label_deposit_into: "Deposit to Account"
|
label_deposit_into: "Deposit to Account"
|
||||||
@@ -49,6 +54,7 @@ en:
|
|||||||
label_error: "Error"
|
label_error: "Error"
|
||||||
label_estimate_404: "Estimate not found"
|
label_estimate_404: "Estimate not found"
|
||||||
label_estimate_count: "Estimate Count"
|
label_estimate_count: "Estimate Count"
|
||||||
|
label_estimate: "Estimate"
|
||||||
label_estimates: "Estimates"
|
label_estimates: "Estimates"
|
||||||
label_hours: "Hours"
|
label_hours: "Hours"
|
||||||
label_invoice_404: "Invoice not found"
|
label_invoice_404: "Invoice not found"
|
||||||
@@ -62,6 +68,7 @@ en:
|
|||||||
label_model: "Model"
|
label_model: "Model"
|
||||||
label_name: "Name"
|
label_name: "Name"
|
||||||
label_new_customer: "New Customer"
|
label_new_customer: "New Customer"
|
||||||
|
label_new_issue: "New Issue"
|
||||||
label_qbo_never_synced: "Never Synced"
|
label_qbo_never_synced: "Never Synced"
|
||||||
label_no_customers: "There are no customers matching the search term(s)."
|
label_no_customers: "There are no customers matching the search term(s)."
|
||||||
label_no_estimates: "No Estimates"
|
label_no_estimates: "No Estimates"
|
||||||
@@ -82,6 +89,10 @@ en:
|
|||||||
label_shipping_address: "Shipping Address"
|
label_shipping_address: "Shipping Address"
|
||||||
label_sync: "Sync"
|
label_sync: "Sync"
|
||||||
label_sync_now: "Sync Now"
|
label_sync_now: "Sync Now"
|
||||||
|
label_sync_now_customers: "Sync Customers"
|
||||||
|
label_sync_now_employees: "Sync Employees"
|
||||||
|
label_sync_now_invoices: "Sync Invoices"
|
||||||
|
label_sync_now_estimate: "Sync Estimates"
|
||||||
label_syncing: "Syncing QuickBooks"
|
label_syncing: "Syncing QuickBooks"
|
||||||
label_trim: "Trim"
|
label_trim: "Trim"
|
||||||
label_webhook_token: "Intuit QBO Webhook Token"
|
label_webhook_token: "Intuit QBO Webhook Token"
|
||||||
|
|||||||
+12
-6
@@ -14,17 +14,20 @@ get 'qbo/oauth_callback', to: 'qbo#oauth_callback'
|
|||||||
|
|
||||||
#manual sync
|
#manual sync
|
||||||
get 'qbo/sync', to: 'qbo#sync'
|
get 'qbo/sync', to: 'qbo#sync'
|
||||||
|
get 'invoices/sync', to: 'invoices#sync'
|
||||||
|
get 'estimates/sync', to: 'estimates#sync'
|
||||||
|
get 'employees/sync', to: 'employees#sync'
|
||||||
|
|
||||||
#webhook
|
#webhook
|
||||||
post 'qbo/webhook', to: 'qbo#webhook'
|
post 'qbo/webhook', to: 'qbo#webhook'
|
||||||
|
|
||||||
# Estimate & Invoice PDF
|
# Estimate & Invoice PDF
|
||||||
get 'estimates/:id', to: 'estimate#show', as: :estimate
|
get 'estimates/:id', to: 'estimates#show', as: :estimate
|
||||||
get 'estimates/doc/', to: 'estimate#doc', as: :estimate_doc
|
get 'estimates/doc/', to: 'estimates#doc', as: :estimate_doc
|
||||||
get 'invoices/:id', to: 'invoice#show', as: :invoice
|
get 'invoices/:id', to: 'invoices#show', as: :invoice
|
||||||
|
|
||||||
#manual billing
|
#manual billing
|
||||||
get 'bill/:id', to: 'qbo#bill', as: :bill
|
post 'bill/:id', to: 'qbo#bill', as: :bill
|
||||||
|
|
||||||
#customer issue view
|
#customer issue view
|
||||||
get 'customers/view/:token', to: 'customers#view', as: :view
|
get 'customers/view/:token', to: 'customers#view', as: :view
|
||||||
@@ -35,5 +38,8 @@ get 'filter_estimates_by_customer' => 'customers#filter_estimates_by_customer'
|
|||||||
get 'filter_invoices_by_customer' => 'customers#filter_invoices_by_customer'
|
get 'filter_invoices_by_customer' => 'customers#filter_invoices_by_customer'
|
||||||
|
|
||||||
resources :customers do
|
resources :customers do
|
||||||
get :autocomplete_customer_name, on: :collection
|
collection do
|
||||||
end
|
get :autocomplete
|
||||||
|
get :sync
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -0,0 +1,201 @@
|
|||||||
|
Apache License
|
||||||
|
Version 2.0, January 2004
|
||||||
|
http://www.apache.org/licenses/
|
||||||
|
|
||||||
|
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||||
|
|
||||||
|
1. Definitions.
|
||||||
|
|
||||||
|
"License" shall mean the terms and conditions for use, reproduction,
|
||||||
|
and distribution as defined by Sections 1 through 9 of this document.
|
||||||
|
|
||||||
|
"Licensor" shall mean the copyright owner or entity authorized by
|
||||||
|
the copyright owner that is granting the License.
|
||||||
|
|
||||||
|
"Legal Entity" shall mean the union of the acting entity and all
|
||||||
|
other entities that control, are controlled by, or are under common
|
||||||
|
control with that entity. For the purposes of this definition,
|
||||||
|
"control" means (i) the power, direct or indirect, to cause the
|
||||||
|
direction or management of such entity, whether by contract or
|
||||||
|
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||||
|
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||||
|
|
||||||
|
"You" (or "Your") shall mean an individual or Legal Entity
|
||||||
|
exercising permissions granted by this License.
|
||||||
|
|
||||||
|
"Source" form shall mean the preferred form for making modifications,
|
||||||
|
including but not limited to software source code, documentation
|
||||||
|
source, and configuration files.
|
||||||
|
|
||||||
|
"Object" form shall mean any form resulting from mechanical
|
||||||
|
transformation or translation of a Source form, including but
|
||||||
|
not limited to compiled object code, generated documentation,
|
||||||
|
and conversions to other media types.
|
||||||
|
|
||||||
|
"Work" shall mean the work of authorship, whether in Source or
|
||||||
|
Object form, made available under the License, as indicated by a
|
||||||
|
copyright notice that is included in or attached to the work
|
||||||
|
(an example is provided in the Appendix below).
|
||||||
|
|
||||||
|
"Derivative Works" shall mean any work, whether in Source or Object
|
||||||
|
form, that is based on (or derived from) the Work and for which the
|
||||||
|
editorial revisions, annotations, elaborations, or other modifications
|
||||||
|
represent, as a whole, an original work of authorship. For the purposes
|
||||||
|
of this License, Derivative Works shall not include works that remain
|
||||||
|
separable from, or merely link (or bind by name) to the interfaces of,
|
||||||
|
the Work and Derivative Works thereof.
|
||||||
|
|
||||||
|
"Contribution" shall mean any work of authorship, including
|
||||||
|
the original version of the Work and any modifications or additions
|
||||||
|
to that Work or Derivative Works thereof, that is intentionally
|
||||||
|
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||||
|
or by an individual or Legal Entity authorized to submit on behalf of
|
||||||
|
the copyright owner. For the purposes of this definition, "submitted"
|
||||||
|
means any form of electronic, verbal, or written communication sent
|
||||||
|
to the Licensor or its representatives, including but not limited to
|
||||||
|
communication on electronic mailing lists, source code control systems,
|
||||||
|
and issue tracking systems that are managed by, or on behalf of, the
|
||||||
|
Licensor for the purpose of discussing and improving the Work, but
|
||||||
|
excluding communication that is conspicuously marked or otherwise
|
||||||
|
designated in writing by the copyright owner as "Not a Contribution."
|
||||||
|
|
||||||
|
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||||
|
on behalf of whom a Contribution has been received by Licensor and
|
||||||
|
subsequently incorporated within the Work.
|
||||||
|
|
||||||
|
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
copyright license to reproduce, prepare Derivative Works of,
|
||||||
|
publicly display, publicly perform, sublicense, and distribute the
|
||||||
|
Work and such Derivative Works in Source or Object form.
|
||||||
|
|
||||||
|
3. Grant of Patent License. Subject to the terms and conditions of
|
||||||
|
this License, each Contributor hereby grants to You a perpetual,
|
||||||
|
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||||
|
(except as stated in this section) patent license to make, have made,
|
||||||
|
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||||
|
where such license applies only to those patent claims licensable
|
||||||
|
by such Contributor that are necessarily infringed by their
|
||||||
|
Contribution(s) alone or by combination of their Contribution(s)
|
||||||
|
with the Work to which such Contribution(s) was submitted. If You
|
||||||
|
institute patent litigation against any entity (including a
|
||||||
|
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||||
|
or a Contribution incorporated within the Work constitutes direct
|
||||||
|
or contributory patent infringement, then any patent licenses
|
||||||
|
granted to You under this License for that Work shall terminate
|
||||||
|
as of the date such litigation is filed.
|
||||||
|
|
||||||
|
4. Redistribution. You may reproduce and distribute copies of the
|
||||||
|
Work or Derivative Works thereof in any medium, with or without
|
||||||
|
modifications, and in Source or Object form, provided that You
|
||||||
|
meet the following conditions:
|
||||||
|
|
||||||
|
(a) You must give any other recipients of the Work or
|
||||||
|
Derivative Works a copy of this License; and
|
||||||
|
|
||||||
|
(b) You must cause any modified files to carry prominent notices
|
||||||
|
stating that You changed the files; and
|
||||||
|
|
||||||
|
(c) You must retain, in the Source form of any Derivative Works
|
||||||
|
that You distribute, all copyright, patent, trademark, and
|
||||||
|
attribution notices from the Source form of the Work,
|
||||||
|
excluding those notices that do not pertain to any part of
|
||||||
|
the Derivative Works; and
|
||||||
|
|
||||||
|
(d) If the Work includes a "NOTICE" text file as part of its
|
||||||
|
distribution, then any Derivative Works that You distribute must
|
||||||
|
include a readable copy of the attribution notices contained
|
||||||
|
within such NOTICE file, excluding those notices that do not
|
||||||
|
pertain to any part of the Derivative Works, in at least one
|
||||||
|
of the following places: within a NOTICE text file distributed
|
||||||
|
as part of the Derivative Works; within the Source form or
|
||||||
|
documentation, if provided along with the Derivative Works; or,
|
||||||
|
within a display generated by the Derivative Works, if and
|
||||||
|
wherever such third-party notices normally appear. The contents
|
||||||
|
of the NOTICE file are for informational purposes only and
|
||||||
|
do not modify the License. You may add Your own attribution
|
||||||
|
notices within Derivative Works that You distribute, alongside
|
||||||
|
or as an addendum to the NOTICE text from the Work, provided
|
||||||
|
that such additional attribution notices cannot be construed
|
||||||
|
as modifying the License.
|
||||||
|
|
||||||
|
You may add Your own copyright statement to Your modifications and
|
||||||
|
may provide additional or different license terms and conditions
|
||||||
|
for use, reproduction, or distribution of Your modifications, or
|
||||||
|
for any such Derivative Works as a whole, provided Your use,
|
||||||
|
reproduction, and distribution of the Work otherwise complies with
|
||||||
|
the conditions stated in this License.
|
||||||
|
|
||||||
|
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||||
|
any Contribution intentionally submitted for inclusion in the Work
|
||||||
|
by You to the Licensor shall be under the terms and conditions of
|
||||||
|
this License, without any additional terms or conditions.
|
||||||
|
Notwithstanding the above, nothing herein shall supersede or modify
|
||||||
|
the terms of any separate license agreement you may have executed
|
||||||
|
with Licensor regarding such Contributions.
|
||||||
|
|
||||||
|
6. Trademarks. This License does not grant permission to use the trade
|
||||||
|
names, trademarks, service marks, or product names of the Licensor,
|
||||||
|
except as required for reasonable and customary use in describing the
|
||||||
|
origin of the Work and reproducing the content of the NOTICE file.
|
||||||
|
|
||||||
|
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||||
|
agreed to in writing, Licensor provides the Work (and each
|
||||||
|
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||||
|
implied, including, without limitation, any warranties or conditions
|
||||||
|
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||||
|
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||||
|
appropriateness of using or redistributing the Work and assume any
|
||||||
|
risks associated with Your exercise of permissions under this License.
|
||||||
|
|
||||||
|
8. Limitation of Liability. In no event and under no legal theory,
|
||||||
|
whether in tort (including negligence), contract, or otherwise,
|
||||||
|
unless required by applicable law (such as deliberate and grossly
|
||||||
|
negligent acts) or agreed to in writing, shall any Contributor be
|
||||||
|
liable to You for damages, including any direct, indirect, special,
|
||||||
|
incidental, or consequential damages of any character arising as a
|
||||||
|
result of this License or out of the use or inability to use the
|
||||||
|
Work (including but not limited to damages for loss of goodwill,
|
||||||
|
work stoppage, computer failure or malfunction, or any and all
|
||||||
|
other commercial damages or losses), even if such Contributor
|
||||||
|
has been advised of the possibility of such damages.
|
||||||
|
|
||||||
|
9. Accepting Warranty or Additional Liability. While redistributing
|
||||||
|
the Work or Derivative Works thereof, You may choose to offer,
|
||||||
|
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||||
|
or other liability obligations and/or rights consistent with this
|
||||||
|
License. However, in accepting such obligations, You may act only
|
||||||
|
on Your own behalf and on Your sole responsibility, not on behalf
|
||||||
|
of any other Contributor, and only if You agree to indemnify,
|
||||||
|
defend, and hold each Contributor harmless for any liability
|
||||||
|
incurred by, or claims asserted against, such Contributor by reason
|
||||||
|
of your accepting any such warranty or additional liability.
|
||||||
|
|
||||||
|
END OF TERMS AND CONDITIONS
|
||||||
|
|
||||||
|
APPENDIX: How to apply the Apache License to your work.
|
||||||
|
|
||||||
|
To apply the Apache License to your work, attach the following
|
||||||
|
boilerplate notice, with the fields enclosed by brackets "{}"
|
||||||
|
replaced with your own identifying information. (Don't include
|
||||||
|
the brackets!) The text should be enclosed in the appropriate
|
||||||
|
comment syntax for the file format. We also recommend that a
|
||||||
|
file or class name and description of purpose be included on the
|
||||||
|
same "printed page" as the copyright notice for easier
|
||||||
|
identification within third-party archives.
|
||||||
|
|
||||||
|
Copyright {yyyy} {name of copyright owner}
|
||||||
|
|
||||||
|
Licensed under the Apache License, Version 2.0 (the "License");
|
||||||
|
you may not use this file except in compliance with the License.
|
||||||
|
You may obtain a copy of the License at
|
||||||
|
|
||||||
|
http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
|
||||||
|
Unless required by applicable law or agreed to in writing, software
|
||||||
|
distributed under the License is distributed on an "AS IS" BASIS,
|
||||||
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||||
|
See the License for the specific language governing permissions and
|
||||||
|
limitations under the License.
|
||||||
@@ -0,0 +1,9 @@
|
|||||||
|
# Nickname data
|
||||||
|
|
||||||
|
`names.csv` is from the [nicknames](https://github.com/carltonnorthern/nicknames) project by
|
||||||
|
Carlton Northern and contributors (commit `ed160b3`), used under the Apache License 2.0
|
||||||
|
(see `LICENSE.txt`). It is unmodified.
|
||||||
|
|
||||||
|
Each row is `name1,has_nickname,name2`. `CustomerSearchService` uses it so that a search for
|
||||||
|
"Bill Smith" finds "William Smith". To update it, replace `names.csv` with a newer copy from the
|
||||||
|
project; extra name groups can also be added in `CustomerSearchService::EXTRA_NICKNAME_GROUPS`.
|
||||||
File diff suppressed because it is too large.
Load diff
@@ -0,0 +1,26 @@
|
|||||||
|
#The License
|
||||||
|
#
|
||||||
|
#Copyright (c) 2016 - 2026 Rick Barrette - All Rights Reserved
|
||||||
|
#
|
||||||
|
#Unauthorized copying of this software and associated documentation files (the "Software"), via any medium is strictly prohibited.
|
||||||
|
#
|
||||||
|
#Proprietary and confidential
|
||||||
|
#
|
||||||
|
#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 CreateLineItems < ActiveRecord::Migration[5.1]
|
||||||
|
def change
|
||||||
|
create_table :line_items do |t|
|
||||||
|
t.integer :item_id
|
||||||
|
t.float :amount
|
||||||
|
t.string :description
|
||||||
|
t.float :unit_price
|
||||||
|
t.float :quantity
|
||||||
|
t.boolean :billed
|
||||||
|
end
|
||||||
|
|
||||||
|
add_reference :line_items, :issues, index: true
|
||||||
|
end
|
||||||
|
end
|
||||||
@@ -12,5 +12,6 @@ class RemoveQboItems < ActiveRecord::Migration[5.1]
|
|||||||
def change
|
def change
|
||||||
drop_table :qbo_items
|
drop_table :qbo_items
|
||||||
drop_table :qbo_purchases
|
drop_table :qbo_purchases
|
||||||
|
drop_table :line_items
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -1,42 +0,0 @@
|
|||||||
#The MIT License (MIT)
|
|
||||||
#
|
|
||||||
#Copyright (c) 2016 - 2026 rick barrette
|
|
||||||
#
|
|
||||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
|
||||||
#
|
|
||||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
|
||||||
#
|
|
||||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
||||||
|
|
||||||
class CreateLineItems < ActiveRecord::Migration[7.0]
|
|
||||||
def change
|
|
||||||
create_table :line_items do |t|
|
|
||||||
t.integer :issue_id, null: false
|
|
||||||
|
|
||||||
t.text :description, null: false
|
|
||||||
|
|
||||||
t.decimal :quantity,
|
|
||||||
precision: 15,
|
|
||||||
scale: 4,
|
|
||||||
null: false,
|
|
||||||
default: 0
|
|
||||||
|
|
||||||
t.decimal :unit_price,
|
|
||||||
precision: 15,
|
|
||||||
scale: 4,
|
|
||||||
null: false,
|
|
||||||
default: 0
|
|
||||||
|
|
||||||
t.decimal :line_total,
|
|
||||||
precision: 15,
|
|
||||||
scale: 4,
|
|
||||||
null: false,
|
|
||||||
default: 0
|
|
||||||
|
|
||||||
t.timestamps
|
|
||||||
end
|
|
||||||
|
|
||||||
add_index :line_items, :issue_id
|
|
||||||
add_foreign_key :line_items, :issues
|
|
||||||
end
|
|
||||||
end
|
|
||||||
@@ -14,7 +14,7 @@ Redmine::Plugin.register :redmine_qbo do
|
|||||||
name 'Redmine QBO plugin'
|
name 'Redmine QBO plugin'
|
||||||
author 'Rick Barrette'
|
author 'Rick Barrette'
|
||||||
description 'A pluging for Redmine to connect with QuickBooks Online to create Time Activity Entries for billable hours logged when an Issue is closed'
|
description 'A pluging for Redmine to connect with QuickBooks Online to create Time Activity Entries for billable hours logged when an Issue is closed'
|
||||||
version '2026.3.1'
|
version '2026.10.1'
|
||||||
url 'https://github.com/rickbarrette/redmine_qbo'
|
url 'https://github.com/rickbarrette/redmine_qbo'
|
||||||
author_url 'https://barrettefabrication.com'
|
author_url 'https://barrettefabrication.com'
|
||||||
settings default: {empty: true}, partial: 'qbo/settings'
|
settings default: {empty: true}, partial: 'qbo/settings'
|
||||||
@@ -25,18 +25,24 @@ Redmine::Plugin.register :redmine_qbo do
|
|||||||
Issue.safe_attributes :estimate_id
|
Issue.safe_attributes :estimate_id
|
||||||
Issue.safe_attributes :invoice_id
|
Issue.safe_attributes :invoice_id
|
||||||
User.safe_attributes :employee_id
|
User.safe_attributes :employee_id
|
||||||
Issue.safe_attributes :line_items_attributes
|
|
||||||
TimeEntry.safe_attributes :billed
|
TimeEntry.safe_attributes :billed
|
||||||
|
|
||||||
# set per_page globally
|
# set per_page globally
|
||||||
WillPaginate.per_page = 20
|
WillPaginate.per_page = 20
|
||||||
|
|
||||||
# Permissions for security
|
# Global Permissions
|
||||||
permission :view_customers, customers: :index, public: false
|
# autocomplete and the filter_* actions feed the customer, estimate and invoice pickers on issue forms
|
||||||
permission :add_customers, customers: :new, public: false
|
permission :view_customers, { customers: [:index, :show, :autocomplete,
|
||||||
|
:filter_estimates_by_customer, :filter_invoices_by_customer] }, global: true
|
||||||
|
permission :add_customers, { customers: [:new, :create] }, global: true
|
||||||
|
permission :edit_customers, { customers: [:edit, :update] }, global: true
|
||||||
|
permission :share_issues_with_customers, { customers: [:share] }, global: true
|
||||||
|
|
||||||
|
# Project permissions
|
||||||
|
permission :bill_issues, { qbo: [:bill] }
|
||||||
|
|
||||||
# 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.allowed_to?(:view_customers, nil, global: true)}
|
||||||
|
|
||||||
Redmine::Search.map do |search|
|
Redmine::Search.map do |search|
|
||||||
search.register :customers
|
search.register :customers
|
||||||
@@ -44,10 +50,4 @@ Redmine::Plugin.register :redmine_qbo do
|
|||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Dynamically load all Hooks & Patches recursively
|
RedmineQbo.setup
|
||||||
base_dir = File.join(File.dirname(__FILE__), 'lib')
|
|
||||||
|
|
||||||
# '**' looks inside subdirectories, '*.rb' matches Ruby files
|
|
||||||
Dir.glob(File.join(base_dir, '**', '*.rb')).sort.each do |file|
|
|
||||||
require file
|
|
||||||
end
|
|
||||||
@@ -0,0 +1,64 @@
|
|||||||
|
#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.
|
||||||
|
|
||||||
|
module RedmineQbo
|
||||||
|
def self.setup
|
||||||
|
# === Models ===
|
||||||
|
Issue.prepend RedmineQbo::Patches::IssuePatch
|
||||||
|
User.prepend RedmineQbo::Patches::UserPatch
|
||||||
|
|
||||||
|
# === Queries ===
|
||||||
|
IssueQuery.prepend RedmineQbo::Patches::QueryPatch
|
||||||
|
TimeEntryQuery.prepend RedmineQbo::Patches::TimeEntryQueryPatch
|
||||||
|
|
||||||
|
# === Controllers ===
|
||||||
|
RedmineQbo::Patches::IssuesControllerPatch.apply
|
||||||
|
RedmineQbo::Patches::AttachmentsControllerPatch.apply
|
||||||
|
|
||||||
|
# === Helpers / Exports ===
|
||||||
|
Redmine::Export::PDF::IssuesPdfHelper.prepend RedmineQbo::Patches::PdfPatch
|
||||||
|
|
||||||
|
# === Hooks ===
|
||||||
|
RedmineQbo::Hooks::IssuesHookListener
|
||||||
|
RedmineQbo::Hooks::UsersShowHookListener
|
||||||
|
RedmineQbo::Hooks::ViewHookListener
|
||||||
|
|
||||||
|
# If the SubtaskFieldCopier plugin is installed, register our fields
|
||||||
|
if defined?(SubtaskFieldCopier)
|
||||||
|
SubtaskFieldCopier.registered_fields << :customer
|
||||||
|
SubtaskFieldCopier.registered_fields << :estimate
|
||||||
|
|
||||||
|
# Ensure there are no duplicates in case of hot-reloads in development mode
|
||||||
|
SubtaskFieldCopier.registered_fields.uniq!
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.settings
|
||||||
|
Setting.plugin_redmine_qbo
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.oauth_consumer_key
|
||||||
|
settings[:oauth_consumer_key]
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.oauth_consumer_secret
|
||||||
|
settings[:oauth_consumer_secret]
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.sandbox_mode?
|
||||||
|
settings[:sandbox] ? true : false
|
||||||
|
end
|
||||||
|
|
||||||
|
def self.webhook_token_secret
|
||||||
|
settings[:webhook_token]
|
||||||
|
end
|
||||||
|
|
||||||
|
|
||||||
|
end
|
||||||
@@ -23,13 +23,12 @@ module RedmineQbo
|
|||||||
project = context[:project]
|
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
|
||||||
search_customer = f.autocomplete_field :customer,
|
search_customer = f.text_field :customer,
|
||||||
autocomplete_customer_name_customers_path,
|
class: "customer-name",
|
||||||
selected: issue.customer,
|
autocomplete: "off",
|
||||||
update_elements: {
|
data: {
|
||||||
id: '#issue_customer_id',
|
autocomplete_url: "/customers/autocomplete"
|
||||||
value: '#issue_customer'
|
|
||||||
}
|
}
|
||||||
|
|
||||||
# We need to handle 3 cases for the onchange event of the customer name field:
|
# We need to handle 3 cases for the onchange event of the customer name field:
|
||||||
@@ -47,7 +46,7 @@ module RedmineQbo
|
|||||||
# This hidden field is used for the customer ID for the issue
|
# 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: "customer_id",
|
||||||
onchange: js_path.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
|
||||||
@@ -62,8 +61,7 @@ module RedmineQbo
|
|||||||
locals: {
|
locals: {
|
||||||
search_customer: search_customer,
|
search_customer: search_customer,
|
||||||
customer_id: customer_id,
|
customer_id: customer_id,
|
||||||
select_estimate: select_estimate,
|
select_estimate: select_estimate
|
||||||
f: context[:form]
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
|
|||||||
@@ -15,10 +15,7 @@ module RedmineQbo
|
|||||||
|
|
||||||
# View User
|
# View User
|
||||||
def view_users_form(context={})
|
def view_users_form(context={})
|
||||||
|
|
||||||
# Update the users
|
|
||||||
#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
|
@selected = context[:user]&.employee&.id
|
||||||
|
|
||||||
|
|||||||
@@ -17,9 +17,9 @@ module RedmineQbo
|
|||||||
def view_layouts_base_html_head(context = {})
|
def view_layouts_base_html_head(context = {})
|
||||||
safe_join([
|
safe_join([
|
||||||
javascript_include_tag( 'application.js', plugin: :redmine_qbo),
|
javascript_include_tag( 'application.js', plugin: :redmine_qbo),
|
||||||
javascript_include_tag( 'autocomplete-rails.js', plugin: :redmine_qbo),
|
javascript_include_tag( 'autocomplete.js', plugin: :redmine_qbo),
|
||||||
javascript_include_tag( 'checkbox_controller.js', plugin: :redmine_qbo),
|
javascript_include_tag( 'checkbox_controller.js', plugin: :redmine_qbo),
|
||||||
javascript_include_tag( 'nested_form_controller.js', plugin: :redmine_qbo)
|
stylesheet_link_tag( 'autocomplete', plugin: :redmine_qbo)
|
||||||
])
|
])
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|||||||
@@ -8,41 +8,56 @@
|
|||||||
#
|
#
|
||||||
#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.
|
||||||
|
|
||||||
require_dependency 'attachments_controller'
|
|
||||||
|
|
||||||
module RedmineQbo
|
module RedmineQbo
|
||||||
module Patches
|
module Patches
|
||||||
|
|
||||||
module AttachmentsControllerPatch
|
module AttachmentsControllerPatch
|
||||||
|
def self.apply
|
||||||
|
AttachmentsController.class_eval do
|
||||||
|
# 1. PREPEND: Must run before ANY of Redmine's ApplicationController filters
|
||||||
|
prepend_before_action :load_customer_token
|
||||||
|
|
||||||
def self.included(base)
|
# 2. Skip global login redirects if the user holds a valid token for this file
|
||||||
|
skip_before_action :check_if_login_required, if: :valid_customer_token?
|
||||||
|
skip_before_action :check_project_privacy, raise: false, if: :valid_customer_token?
|
||||||
|
|
||||||
base.class_eval do
|
# Note: We do NOT need to skip :read_authorize anymore.
|
||||||
|
# Because we patched Attachment#visible?, read_authorize will pass naturally!
|
||||||
|
|
||||||
# check if login is globally required to access the application
|
private
|
||||||
def check_if_login_required
|
|
||||||
# no check needed if user is already logged in
|
# Kept on the controller instance (one per request) rather than Thread.current, which is reused
|
||||||
return true if User.current.logged?
|
# across requests by the web server and could carry one customer's token into another request.
|
||||||
|
def load_customer_token
|
||||||
# Pull up the attachmet, & verify if we have a valid token for the Issue
|
@customer_token = session[:token].present? ? CustomerToken.active.find_by(token: session[:token]) : nil
|
||||||
attachment = Attachment.find(params[:id])
|
end
|
||||||
token = CustomerToken.where("token = ? and expires_at > ?", session[:token], Time.now)
|
|
||||||
token = token.first
|
def valid_customer_token?
|
||||||
unless token.nil?
|
token = @customer_token
|
||||||
return true if token.issue_id == attachment.container_id
|
return false unless token
|
||||||
|
|
||||||
|
# Handle "Download All" zip requests (object_type=issues, object_id=ID)
|
||||||
|
if params[:action] == 'download_all'
|
||||||
|
return params[:object_type] == 'issues' && params[:object_id].to_i == token.issue_id
|
||||||
|
end
|
||||||
|
|
||||||
|
# Handle normal single attachment requests (show, download, thumbnail)
|
||||||
|
attachment = Attachment.find_by(id: params[:id])
|
||||||
|
return false unless attachment
|
||||||
|
|
||||||
|
# Allow if attachment belongs directly to the Issue
|
||||||
|
if attachment.container_type == 'Issue' && attachment.container_id == token.issue_id
|
||||||
|
return true
|
||||||
end
|
end
|
||||||
|
|
||||||
require_login if Setting.login_required?
|
# Allow if attachment belongs to a Journal (comment) on the Issue
|
||||||
|
if attachment.container_type == 'Journal' && attachment.container.journalized_type == 'Issue' && attachment.container.journalized_id == token.issue_id
|
||||||
|
return true
|
||||||
|
end
|
||||||
|
|
||||||
|
false
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
|
end
|
||||||
end
|
|
||||||
|
|
||||||
# Add module to AttachmentsController
|
|
||||||
AttachmentsController.send(:include, AttachmentsControllerPatch)
|
|
||||||
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -8,62 +8,40 @@
|
|||||||
#
|
#
|
||||||
#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.
|
||||||
|
|
||||||
require_dependency 'issue'
|
|
||||||
|
|
||||||
module RedmineQbo
|
module RedmineQbo
|
||||||
module Patches
|
module Patches
|
||||||
module IssuePatch
|
module IssuePatch
|
||||||
|
extend ActiveSupport::Concern
|
||||||
|
|
||||||
def self.included(base)
|
prepended do
|
||||||
base.extend(ClassMethods)
|
belongs_to :customer
|
||||||
base.send(:include, InstanceMethods)
|
belongs_to :customer_token
|
||||||
|
belongs_to :estimate
|
||||||
|
has_and_belongs_to_many :invoices
|
||||||
|
|
||||||
base.class_eval do
|
before_save :titlize_subject
|
||||||
belongs_to :customer, class_name: 'Customer', foreign_key: :customer_id, optional: true
|
after_commit :enqueue_billing, on: :update
|
||||||
belongs_to :customer_token, primary_key: :id
|
|
||||||
belongs_to :estimate, primary_key: :id
|
|
||||||
has_and_belongs_to_many :invoices
|
|
||||||
has_many :line_items, dependent: :destroy
|
|
||||||
accepts_nested_attributes_for :line_items, allow_destroy: true
|
|
||||||
|
|
||||||
before_save :titlize_subject
|
|
||||||
after_commit :enqueue_billing, on: :update
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
module ClassMethods
|
# Enqueue a background job to bill the time spent on this issue to QuickBooks if the issue is closed and assigned to an employee
|
||||||
|
def enqueue_billing
|
||||||
|
log "Checking if issue needs billing for ##{id}"
|
||||||
|
return unless closed? && customer.present? && assigned_to&.employee_id.present?
|
||||||
|
|
||||||
|
log "Enqueuing billing for issue ##{id}"
|
||||||
|
BillIssueTimeJob.perform_later(id)
|
||||||
end
|
end
|
||||||
|
|
||||||
module InstanceMethods
|
# Capitalize each word of the subject for consistent billing descriptions, without lowercasing
|
||||||
|
# the rest of the word (keeps LED, JL, 4x4 as typed). Only runs when the subject changes.
|
||||||
|
def titlize_subject
|
||||||
|
return unless subject.present? && will_save_change_to_subject?
|
||||||
|
|
||||||
# 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.
|
log "Titlizing subject for issue ##{id}"
|
||||||
def enqueue_billing
|
self.subject = RedmineQbo::TitleCase.call(subject)
|
||||||
log "Checking if issue needs to be billed for issue ##{id}"
|
|
||||||
return unless closed?
|
|
||||||
return unless customer.present?
|
|
||||||
return unless assigned_to&.employee_id.present?
|
|
||||||
|
|
||||||
log "Enqueuing billing for issue ##{id}"
|
|
||||||
BillIssueTimeJob.perform_later(id)
|
|
||||||
end
|
|
||||||
|
|
||||||
# Titlize the subject of the issue before saving to ensure consistent formatting for billing descriptions in Quickbooks
|
|
||||||
def titlize_subject
|
|
||||||
log "Titlizing subject for issue ##{id}"
|
|
||||||
|
|
||||||
self.subject = subject.split(/\s+/).map do |word|
|
|
||||||
if word =~ /[A-Z]/ && word =~ /[0-9]/
|
|
||||||
word
|
|
||||||
else
|
|
||||||
word.capitalize
|
|
||||||
end
|
|
||||||
end.join(' ')
|
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# This method is used to generate a shareable token for the customer associated with this issue, which can be used to link the issue to the corresponding customer in Quickbooks for billing and tracking purposes.
|
# Generate a shareable token linking this issue to the customer for QuickBooks
|
||||||
def share_token
|
def share_token
|
||||||
CustomerToken.get_token(self)
|
CustomerToken.get_token(self)
|
||||||
end
|
end
|
||||||
@@ -71,10 +49,8 @@ module RedmineQbo
|
|||||||
private
|
private
|
||||||
|
|
||||||
def log(msg)
|
def log(msg)
|
||||||
Rails.logger.info "[IssuePatch] #{msg}"
|
Rails.logger.info "[IssuePatch] #{msg}"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
Issue.send(:include, IssuePatch)
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -7,30 +7,36 @@
|
|||||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
#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.
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
require_dependency 'issues_controller'
|
|
||||||
|
|
||||||
module RedmineQbo
|
module RedmineQbo
|
||||||
module Patches
|
module Patches
|
||||||
module IssuesControllerPatch
|
module IssuesControllerPatch
|
||||||
|
|
||||||
module Helper
|
module Helper
|
||||||
|
# Extend the watcher links to include billing and share options
|
||||||
def watcher_link(issue, user)
|
def watcher_link(issue, user)
|
||||||
link = ''
|
links = ''
|
||||||
link = link_to(I18n.t(:label_bill_time), bill_path( issue.id ), method: :get, class: 'icon icon-email-add') if user.admin?
|
|
||||||
link << link_to(I18n.t(:label_share), share_path( issue.id ), method: :get, target: :_blank, class: 'icon icon-shared') if user.logged?
|
# Users with the "Bill issues" permission can bill time (POST, so it can't be triggered by a plain link)
|
||||||
link.html_safe + super
|
if user.allowed_to?(:bill_issues, issue.project)
|
||||||
|
links << link_to(I18n.t(:label_bill_time), bill_path(issue.id), method: :post,
|
||||||
|
data: { confirm: I18n.t(:text_are_you_sure) }, class: 'icon icon-email-add')
|
||||||
|
end
|
||||||
|
|
||||||
|
# Users with the "Share issues with customers" permission can create a customer link
|
||||||
|
if user.allowed_to?(:share_issues_with_customers, nil, global: true)
|
||||||
|
links << link_to(I18n.t(:label_share), share_path(issue.id), method: :get, target: :_blank, class: 'icon icon-shared')
|
||||||
|
end
|
||||||
|
|
||||||
|
# Append to the original watcher links
|
||||||
|
(links.html_safe + super).html_safe
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
def self.included(base)
|
def self.apply
|
||||||
base.class_eval do
|
IssuesController.class_eval do
|
||||||
helper Helper
|
helper Helper
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
# Add module to IssuessController
|
|
||||||
IssuesController.send(:include, IssuesControllerPatch)
|
|
||||||
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -8,278 +8,361 @@
|
|||||||
#
|
#
|
||||||
#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.
|
||||||
|
|
||||||
require_dependency 'redmine/export/pdf'
|
|
||||||
require_dependency 'redmine/export/pdf/issues_pdf_helper'
|
|
||||||
|
|
||||||
module RedmineQbo
|
module RedmineQbo
|
||||||
module Patches
|
module Patches
|
||||||
module PdfPatch
|
module PdfPatch
|
||||||
|
extend ActiveSupport::Concern
|
||||||
|
|
||||||
def self.included(base)
|
# Rows returned by the :pdf_left / :pdf_right hooks are [label, text], or
|
||||||
base.send(:include, InstanceMethods)
|
# [label, text, { html: "..." }] to draw the value as simple HTML (e.g. part of it in <b>).
|
||||||
base.class_eval do
|
# text is still required: it sizes the row. Other plugins can check this constant before
|
||||||
alias_method :issue_to_pdf, :issue_to_pdf_with_patch
|
# sending HTML values, so they keep working with older versions of this plugin.
|
||||||
alias_method :issue_to_pdf_with_patch, :issue_to_pdf
|
PDF_HTML_VALUES = true
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
module InstanceMethods
|
def issue_to_pdf(issue, assoc={})
|
||||||
|
pdf = setup_pdf(issue)
|
||||||
|
|
||||||
def issue_to_pdf_with_patch(issue, assoc={})
|
render_header(pdf, issue)
|
||||||
pdf = ::Redmine::Export::PDF::ITCPDF.new(current_language)
|
render_ancestors_and_subject(pdf, issue)
|
||||||
pdf.set_title("#{issue.project} - #{issue.tracker} ##{issue.id}")
|
|
||||||
pdf.alias_nb_pages
|
left, right = build_issue_attributes(issue)
|
||||||
pdf.footer_date = format_date(Date.today)
|
render_attributes_grid(pdf, left, right)
|
||||||
pdf.add_page
|
|
||||||
pdf.SetFontStyle('B',11)
|
|
||||||
buf = "#{issue.project} - #{issue.tracker} ##{issue.id}"
|
|
||||||
pdf.RDMMultiCell(190, 5, buf)
|
|
||||||
pdf.SetFontStyle('',8)
|
|
||||||
base_x = pdf.get_x
|
|
||||||
i = 1
|
|
||||||
issue.ancestors.visible.each do |ancestor|
|
|
||||||
pdf.set_x(base_x + i)
|
|
||||||
buf = "#{ancestor.tracker} # #{ancestor.id} (#{ancestor.status.to_s}): #{ancestor.subject}"
|
|
||||||
pdf.RDMMultiCell(190 - i, 5, buf)
|
|
||||||
i += 1 if i < 35
|
|
||||||
end
|
|
||||||
pdf.SetFontStyle('B',11)
|
|
||||||
pdf.RDMMultiCell(190 - i, 5, issue.subject.to_s)
|
|
||||||
pdf.SetFontStyle('',8)
|
|
||||||
pdf.RDMMultiCell(190, 5, "#{format_time(issue.created_on)} - #{issue.author}")
|
|
||||||
pdf.ln
|
|
||||||
|
|
||||||
customer = issue.customer.name if issue.customer
|
render_description(pdf, issue)
|
||||||
left = []
|
render_subtasks(pdf, issue)
|
||||||
left << [l(:field_status), issue.status]
|
render_relations(pdf, issue)
|
||||||
left << [l(:field_priority), issue.priority]
|
render_changesets(pdf, issue)
|
||||||
left << [l(:field_customer), customer]
|
render_journals(pdf, issue, assoc)
|
||||||
left << [l(:field_assigned_to), issue.assigned_to] unless issue.disabled_core_fields.include?(:assigned_to_id)
|
render_attachments(pdf, issue)
|
||||||
#left << [l(:field_category), issue.category] unless issue.disabled_core_fields.include?(:category_id)
|
|
||||||
#left << [l(:field_fixed_version), issue.fixed_version] unless issue.disabled_core_fields.include?(:fixed_version_id)
|
|
||||||
|
|
||||||
log "Calling :pdf_left hook"
|
|
||||||
left_hook_output = Redmine::Hook.call_hook :pdf_left, { issue: issue }
|
|
||||||
unless left_hook_output.nil?
|
|
||||||
left_hook_output.each do |l|
|
|
||||||
left.concat l unless l.nil?
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
right = []
|
|
||||||
right << [l(:field_start_date), format_date(issue.start_date)] unless issue.disabled_core_fields.include?(:start_date)
|
|
||||||
right << [l(:field_due_date), format_date(issue.due_date)] unless issue.disabled_core_fields.include?(:due_date)
|
|
||||||
right << [l(:field_done_ratio), "#{issue.done_ratio}%"] unless issue.disabled_core_fields.include?(:done_ratio)
|
|
||||||
right << [l(:field_estimated_hours), l_hours(issue.estimated_hours)] unless issue.disabled_core_fields.include?(:estimated_hours)
|
|
||||||
right << [l(:label_spent_time), l_hours(issue.total_spent_hours)] if User.current.allowed_to?(:view_time_entries, issue.project)
|
|
||||||
|
|
||||||
log "Calling :pdf_right hook"
|
|
||||||
right_hook_output = Redmine::Hook.call_hook :pdf_right, { issue: issue }
|
|
||||||
unless right_hook_output.nil?
|
|
||||||
right_hook_output.each do |r|
|
|
||||||
right.concat r unless r.nil?
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
rows = left.size > right.size ? left.size : right.size
|
|
||||||
while left.size < rows
|
|
||||||
left << nil
|
|
||||||
end
|
|
||||||
while right.size < rows
|
|
||||||
right << nil
|
|
||||||
end
|
|
||||||
|
|
||||||
half = (issue.visible_custom_field_values.size / 2.0).ceil
|
|
||||||
issue.visible_custom_field_values.each_with_index do |custom_value, i|
|
|
||||||
(i < half ? left : right) << [custom_value.custom_field.name, show_value(custom_value, false)]
|
|
||||||
end
|
|
||||||
|
|
||||||
if pdf.get_rtl
|
|
||||||
border_first_top = 'RT'
|
|
||||||
border_last_top = 'LT'
|
|
||||||
border_first = 'R'
|
|
||||||
border_last = 'L'
|
|
||||||
else
|
|
||||||
border_first_top = 'LT'
|
|
||||||
border_last_top = 'RT'
|
|
||||||
border_first = 'L'
|
|
||||||
border_last = 'R'
|
|
||||||
end
|
|
||||||
|
|
||||||
rows = left.size > right.size ? left.size : right.size
|
|
||||||
rows.times do |i|
|
|
||||||
heights = []
|
|
||||||
pdf.SetFontStyle('B',9)
|
|
||||||
item = left[i]
|
|
||||||
heights << pdf.get_string_height(35, item ? "#{item.first}:" : "")
|
|
||||||
item = right[i]
|
|
||||||
heights << pdf.get_string_height(35, item ? "#{item.first}:" : "")
|
|
||||||
pdf.SetFontStyle('',9)
|
|
||||||
item = left[i]
|
|
||||||
heights << pdf.get_string_height(60, item ? item.last.to_s : "")
|
|
||||||
item = right[i]
|
|
||||||
heights << pdf.get_string_height(60, item ? item.last.to_s : "")
|
|
||||||
height = heights.max
|
|
||||||
|
|
||||||
item = left[i]
|
|
||||||
pdf.SetFontStyle('B',9)
|
|
||||||
pdf.RDMMultiCell(35, height, item ? "#{item.first}:" : "", (i == 0 ? border_first_top : border_first), '', 0, 0)
|
|
||||||
pdf.SetFontStyle('',9)
|
|
||||||
pdf.RDMMultiCell(60, height, item ? item.last.to_s : "", (i == 0 ? border_last_top : border_last), '', 0, 0)
|
|
||||||
|
|
||||||
item = right[i]
|
|
||||||
pdf.SetFontStyle('B',9)
|
|
||||||
pdf.RDMMultiCell(35, height, item ? "#{item.first}:" : "", (i == 0 ? border_first_top : border_first), '', 0, 0)
|
|
||||||
pdf.SetFontStyle('',9)
|
|
||||||
pdf.RDMMultiCell(60, height, item ? item.last.to_s : "", (i == 0 ? border_last_top : border_last), '', 0, 2)
|
|
||||||
|
|
||||||
pdf.set_x(base_x)
|
|
||||||
end
|
|
||||||
|
|
||||||
pdf.SetFontStyle('B',9)
|
|
||||||
pdf.RDMCell(35+155, 5, l(:field_description), "LRT", 1)
|
|
||||||
pdf.SetFontStyle('',9)
|
|
||||||
|
|
||||||
# Set resize image scale
|
|
||||||
pdf.set_image_scale(1.6)
|
|
||||||
text = textilizable(issue, :description,
|
|
||||||
only_path: false,
|
|
||||||
edit_section_links: false,
|
|
||||||
headings: false,
|
|
||||||
inline_attachments: false
|
|
||||||
)
|
|
||||||
pdf.RDMwriteFormattedCell(35+155, 5, '', '', text, issue.attachments, "LRB")
|
|
||||||
|
|
||||||
unless issue.leaf?
|
|
||||||
truncate_length = (!is_cjk? ? 90 : 65)
|
|
||||||
pdf.SetFontStyle('B',9)
|
|
||||||
pdf.RDMCell(35+155,5, l(:label_subtask_plural) + ":", "LTR")
|
|
||||||
pdf.ln
|
|
||||||
issue_list(issue.descendants.visible.sort_by(&:lft)) do |child, level|
|
|
||||||
buf = "#{child.tracker} # #{child.id}: #{child.subject}".
|
|
||||||
truncate(truncate_length)
|
|
||||||
level = 10 if level >= 10
|
|
||||||
pdf.SetFontStyle('',8)
|
|
||||||
pdf.RDMCell(35+135,5, (level >=1 ? " " * level : "") + buf, border_first)
|
|
||||||
pdf.SetFontStyle('B',8)
|
|
||||||
pdf.RDMCell(20,5, child.status.to_s, border_last)
|
|
||||||
pdf.ln
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
relations = issue.relations.select { |r| r.other_issue(issue).visible? }
|
|
||||||
unless relations.empty?
|
|
||||||
truncate_length = (!is_cjk? ? 80 : 60)
|
|
||||||
pdf.SetFontStyle('B',9)
|
|
||||||
pdf.RDMCell(35+155,5, l(:label_related_issues) + ":", "LTR")
|
|
||||||
pdf.ln
|
|
||||||
relations.each do |relation|
|
|
||||||
buf = relation.to_s(issue) {|other|
|
|
||||||
text = ""
|
|
||||||
if Setting.cross_project_issue_relations?
|
|
||||||
text += "#{relation.other_issue(issue).project} - "
|
|
||||||
end
|
|
||||||
text += "#{other.tracker} ##{other.id}: #{other.subject}"
|
|
||||||
text
|
|
||||||
}
|
|
||||||
buf = buf.truncate(truncate_length)
|
|
||||||
pdf.SetFontStyle('', 8)
|
|
||||||
pdf.RDMCell(35+155-60, 5, buf, border_first)
|
|
||||||
pdf.SetFontStyle('B',8)
|
|
||||||
pdf.RDMCell(20,5, relation.other_issue(issue).status.to_s, "")
|
|
||||||
pdf.RDMCell(20,5, format_date(relation.other_issue(issue).start_date), "")
|
|
||||||
pdf.RDMCell(20,5, format_date(relation.other_issue(issue).due_date), border_last)
|
|
||||||
pdf.ln
|
|
||||||
end
|
|
||||||
end
|
|
||||||
pdf.RDMCell(190,5, "", "T")
|
|
||||||
pdf.ln
|
|
||||||
|
|
||||||
if issue.changesets.any? &&
|
|
||||||
User.current.allowed_to?(:view_changesets, issue.project)
|
|
||||||
pdf.SetFontStyle('B',9)
|
|
||||||
pdf.RDMCell(190,5, l(:label_associated_revisions), "B")
|
|
||||||
pdf.ln
|
|
||||||
for changeset in issue.changesets
|
|
||||||
pdf.SetFontStyle('B',8)
|
|
||||||
csstr = "#{l(:label_revision)} #{changeset.format_identifier} - "
|
|
||||||
csstr += format_time(changeset.committed_on) + " - " + changeset.author.to_s
|
|
||||||
pdf.RDMCell(190, 5, csstr)
|
|
||||||
pdf.ln
|
|
||||||
unless changeset.comments.blank?
|
|
||||||
pdf.SetFontStyle('',8)
|
|
||||||
pdf.RDMwriteHTMLCell(190,5,'','',
|
|
||||||
changeset.comments.to_s, issue.attachments, "")
|
|
||||||
end
|
|
||||||
pdf.ln
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
if assoc[:journals].present?
|
|
||||||
pdf.SetFontStyle('B',9)
|
|
||||||
pdf.RDMCell(190,5, l(:label_history), "B")
|
|
||||||
pdf.ln
|
|
||||||
assoc[:journals].each do |journal|
|
|
||||||
pdf.SetFontStyle('B',8)
|
|
||||||
title = "##{journal.indice} - #{format_time(journal.created_on)} - #{journal.user}"
|
|
||||||
title << " (#{l(:field_private_notes)})" if journal.private_notes?
|
|
||||||
pdf.RDMCell(190,5, title)
|
|
||||||
pdf.ln
|
|
||||||
pdf.SetFontStyle('I',8)
|
|
||||||
details_to_strings(journal.visible_details, true).each do |string|
|
|
||||||
pdf.RDMMultiCell(190,5, "- " + string)
|
|
||||||
end
|
|
||||||
if journal.notes?
|
|
||||||
pdf.ln unless journal.details.empty?
|
|
||||||
pdf.SetFontStyle('',8)
|
|
||||||
text = textilizable(journal, :notes,
|
|
||||||
only_path: false,
|
|
||||||
edit_section_links: false,
|
|
||||||
headings: false,
|
|
||||||
inline_attachments: false
|
|
||||||
)
|
|
||||||
pdf.RDMwriteFormattedCell(190,5,'','', text, issue.attachments, "")
|
|
||||||
end
|
|
||||||
pdf.ln
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
if issue.attachments.any?
|
|
||||||
pdf.SetFontStyle('B',9)
|
|
||||||
pdf.RDMCell(190,5, l(:label_attachment_plural), "B")
|
|
||||||
pdf.ln
|
|
||||||
for attachment in issue.attachments
|
|
||||||
pdf.SetFontStyle('',8)
|
|
||||||
pdf.RDMCell(80,5, attachment.filename)
|
|
||||||
pdf.RDMCell(20,5, number_to_human_size(attachment.filesize),0,0,"R")
|
|
||||||
pdf.RDMCell(25,5, format_date(attachment.created_on),0,0,"R")
|
|
||||||
pdf.RDMCell(65,5, attachment.author.name,0,0,"R")
|
|
||||||
pdf.ln
|
|
||||||
end
|
|
||||||
end
|
|
||||||
|
|
||||||
# Check to see if there is an estimate attached, then combine them
|
|
||||||
if issue.estimate
|
|
||||||
e_pdf, ref = EstimatePdfService.new(qbo: QboConnectionService.current!).fetch_pdf(doc_ids: [issue.estimate.id])
|
|
||||||
pdf = CombinePDF.parse(pdf.output, allow_optional_content: true)
|
|
||||||
pdf << CombinePDF.parse(e_pdf)
|
|
||||||
return pdf.to_pdf
|
|
||||||
end
|
|
||||||
|
|
||||||
return pdf.output
|
|
||||||
end
|
|
||||||
|
|
||||||
|
merge_estimate_if_present(pdf, issue)
|
||||||
end
|
end
|
||||||
|
|
||||||
private
|
private
|
||||||
|
|
||||||
def log(msg)
|
def log(msg)
|
||||||
Rails.logger.info "[PdfPatch] #{msg}"
|
Rails.logger.info "[PdfPatch] #{msg}"
|
||||||
|
end
|
||||||
|
|
||||||
|
def setup_pdf(issue)
|
||||||
|
pdf = ::Redmine::Export::PDF::ITCPDF.new(current_language)
|
||||||
|
pdf.set_title("#{issue.project} - #{issue.tracker} ##{issue.id}")
|
||||||
|
pdf.alias_nb_pages
|
||||||
|
pdf.footer_date = format_date(Date.today)
|
||||||
|
pdf.add_page
|
||||||
|
pdf
|
||||||
|
end
|
||||||
|
|
||||||
|
def render_header(pdf, issue)
|
||||||
|
pdf.SetFontStyle('B', 11)
|
||||||
|
pdf.RDMMultiCell(190, 5, "#{issue.project} - #{issue.tracker} ##{issue.id}")
|
||||||
|
pdf.SetFontStyle('', 8)
|
||||||
|
end
|
||||||
|
|
||||||
|
def render_ancestors_and_subject(pdf, issue)
|
||||||
|
base_x = pdf.get_x
|
||||||
|
i = 1
|
||||||
|
|
||||||
|
# Render ancestors
|
||||||
|
issue.ancestors.visible.each do |ancestor|
|
||||||
|
pdf.set_x(base_x + i)
|
||||||
|
buf = "#{ancestor.tracker} # #{ancestor.id} (#{ancestor.status}): #{ancestor.subject}"
|
||||||
|
pdf.RDMMultiCell(190 - i, 5, buf)
|
||||||
|
i += 1 if i < 35
|
||||||
|
end
|
||||||
|
|
||||||
|
# Render current issue subject and meta
|
||||||
|
pdf.SetFontStyle('B', 11)
|
||||||
|
pdf.RDMMultiCell(190 - i, 5, issue.subject.to_s)
|
||||||
|
pdf.SetFontStyle('', 8)
|
||||||
|
pdf.RDMMultiCell(190, 5, "#{format_time(issue.created_on)} - #{issue.author}")
|
||||||
|
pdf.ln
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_issue_attributes(issue)
|
||||||
|
left = build_left_attributes(issue)
|
||||||
|
right = build_right_attributes(issue)
|
||||||
|
|
||||||
|
# Pad arrays to equal length
|
||||||
|
rows = [left.size, right.size].max
|
||||||
|
left.fill(nil, left.size...rows)
|
||||||
|
right.fill(nil, right.size...rows)
|
||||||
|
|
||||||
|
# Distribute custom fields evenly
|
||||||
|
half = (issue.visible_custom_field_values.size / 2.0).ceil
|
||||||
|
issue.visible_custom_field_values.each_with_index do |custom_value, i|
|
||||||
|
target_column = i < half ? left : right
|
||||||
|
target_column << [custom_value.custom_field.name, show_value(custom_value, false)]
|
||||||
|
end
|
||||||
|
|
||||||
|
[left, right]
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_left_attributes(issue)
|
||||||
|
left = []
|
||||||
|
left << [l(:field_status), issue.status]
|
||||||
|
left << [l(:field_priority), issue.priority]
|
||||||
|
left << [l(:field_customer), issue.customer&.name]
|
||||||
|
left << [l(:field_assigned_to), issue.assigned_to] unless issue.disabled_core_fields.include?(:assigned_to_id)
|
||||||
|
|
||||||
|
log "Calling :pdf_left hook"
|
||||||
|
left_hook_output = Redmine::Hook.call_hook(:pdf_left, { issue: issue })
|
||||||
|
Array(left_hook_output).compact.each { |l| left.concat(l) }
|
||||||
|
|
||||||
|
left
|
||||||
|
end
|
||||||
|
|
||||||
|
def build_right_attributes(issue)
|
||||||
|
right = []
|
||||||
|
right << [l(:field_start_date), format_date(issue.start_date)] unless issue.disabled_core_fields.include?(:start_date)
|
||||||
|
right << [l(:field_due_date), format_date(issue.due_date)] unless issue.disabled_core_fields.include?(:due_date)
|
||||||
|
right << [l(:field_done_ratio), "#{issue.done_ratio}%"] unless issue.disabled_core_fields.include?(:done_ratio)
|
||||||
|
right << [l(:field_estimated_hours), l_hours(issue.estimated_hours)] unless issue.disabled_core_fields.include?(:estimated_hours)
|
||||||
|
right << [l(:label_spent_time), l_hours(issue.total_spent_hours)] if User.current.allowed_to?(:view_time_entries, issue.project)
|
||||||
|
|
||||||
|
log "Calling :pdf_right hook"
|
||||||
|
right_hook_output = Redmine::Hook.call_hook(:pdf_right, { issue: issue })
|
||||||
|
Array(right_hook_output).compact.each { |r| right.concat(r) }
|
||||||
|
|
||||||
|
right
|
||||||
|
end
|
||||||
|
|
||||||
|
def render_attributes_grid(pdf, left, right)
|
||||||
|
base_x = pdf.get_x
|
||||||
|
borders = determine_borders(pdf.get_rtl)
|
||||||
|
rows = [left.size, right.size].max
|
||||||
|
|
||||||
|
rows.times do |i|
|
||||||
|
item_left = left[i]
|
||||||
|
item_right = right[i]
|
||||||
|
|
||||||
|
# Calculate dynamic row height
|
||||||
|
pdf.SetFontStyle('B', 9)
|
||||||
|
hl1 = pdf.get_string_height(35, item_left ? "#{item_left.first}:" : "")
|
||||||
|
hr1 = pdf.get_string_height(35, item_right ? "#{item_right.first}:" : "")
|
||||||
|
|
||||||
|
pdf.SetFontStyle('', 9)
|
||||||
|
hl2 = pdf.get_string_height(60, item_left ? item_left[1].to_s : "")
|
||||||
|
hr2 = pdf.get_string_height(60, item_right ? item_right[1].to_s : "")
|
||||||
|
|
||||||
|
height = [hl1, hr1, hl2, hr2].max
|
||||||
|
|
||||||
|
# Render cells
|
||||||
|
render_grid_cell(pdf, item_left, height, i == 0 ? borders[:first_top] : borders[:first], i == 0 ? borders[:last_top] : borders[:last], 0)
|
||||||
|
render_grid_cell(pdf, item_right, height, i == 0 ? borders[:first_top] : borders[:first], i == 0 ? borders[:last_top] : borders[:last], 2)
|
||||||
|
|
||||||
|
pdf.set_x(base_x)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def determine_borders(is_rtl)
|
||||||
|
if is_rtl
|
||||||
|
{ first_top: 'RT', last_top: 'LT', first: 'R', last: 'L' }
|
||||||
|
else
|
||||||
|
{ first_top: 'LT', last_top: 'RT', first: 'L', last: 'R' }
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def render_grid_cell(pdf, item, height, border_label, border_val, ln_type)
|
||||||
|
pdf.SetFontStyle('B', 9)
|
||||||
|
pdf.RDMMultiCell(35, height, item ? "#{item.first}:" : "", border_label, '', 0, 0)
|
||||||
|
|
||||||
|
pdf.SetFontStyle('', 9)
|
||||||
|
html = item && item[2].is_a?(Hash) ? item[2][:html].presence : nil
|
||||||
|
if html
|
||||||
|
# Plugin-supplied HTML value, drawn directly (RDMwriteHTMLCell would run wiki formatting on it)
|
||||||
|
pdf.writeHTMLCell(60, height, '', '', html, border_val, ln_type, 0)
|
||||||
|
else
|
||||||
|
pdf.RDMMultiCell(60, height, item ? item[1].to_s : "", border_val, '', 0, ln_type)
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def render_description(pdf, issue)
|
||||||
|
pdf.SetFontStyle('B', 9)
|
||||||
|
pdf.RDMCell(190, 5, l(:field_description), "LRT", 1)
|
||||||
|
pdf.SetFontStyle('', 9)
|
||||||
|
|
||||||
|
pdf.set_image_scale(1.6)
|
||||||
|
text = textilizable(issue, :description,
|
||||||
|
only_path: false,
|
||||||
|
edit_section_links: false,
|
||||||
|
headings: false,
|
||||||
|
inline_attachments: false)
|
||||||
|
|
||||||
|
# Apply the fix here
|
||||||
|
text = sanitize_html_for_pdf(text)
|
||||||
|
|
||||||
|
pdf.RDMwriteFormattedCell(190, 5, '', '', text, issue.attachments, "LRB")
|
||||||
|
end
|
||||||
|
|
||||||
|
def render_subtasks(pdf, issue)
|
||||||
|
return if issue.leaf?
|
||||||
|
|
||||||
|
truncate_length = !is_cjk? ? 90 : 65
|
||||||
|
pdf.SetFontStyle('B', 9)
|
||||||
|
pdf.RDMCell(190, 5, "#{l(:label_subtask_plural)}:", "LTR")
|
||||||
|
pdf.ln
|
||||||
|
|
||||||
|
border_first = pdf.get_rtl ? 'R' : 'L'
|
||||||
|
border_last = pdf.get_rtl ? 'L' : 'R'
|
||||||
|
|
||||||
|
issue_list(issue.descendants.visible.sort_by(&:lft)) do |child, level|
|
||||||
|
buf = "#{child.tracker} # #{child.id}: #{child.subject}".truncate(truncate_length)
|
||||||
|
level = 10 if level >= 10
|
||||||
|
|
||||||
|
pdf.SetFontStyle('', 8)
|
||||||
|
pdf.RDMCell(170, 5, (level >= 1 ? " " * level : "") + buf, border_first)
|
||||||
|
pdf.SetFontStyle('B', 8)
|
||||||
|
pdf.RDMCell(20, 5, child.status.to_s, border_last)
|
||||||
|
pdf.ln
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def render_relations(pdf, issue)
|
||||||
|
relations = issue.relations.select { |r| r.other_issue(issue).visible? }
|
||||||
|
return if relations.empty?
|
||||||
|
|
||||||
|
truncate_length = !is_cjk? ? 80 : 60
|
||||||
|
pdf.SetFontStyle('B', 9)
|
||||||
|
pdf.RDMCell(190, 5, "#{l(:label_related_issues)}:", "LTR")
|
||||||
|
pdf.ln
|
||||||
|
|
||||||
|
border_first = pdf.get_rtl ? 'R' : 'L'
|
||||||
|
border_last = pdf.get_rtl ? 'L' : 'R'
|
||||||
|
|
||||||
|
relations.each do |relation|
|
||||||
|
other = relation.other_issue(issue)
|
||||||
|
text = Setting.cross_project_issue_relations? ? "#{other.project} - " : ""
|
||||||
|
text += "#{other.tracker} ##{other.id}: #{other.subject}"
|
||||||
|
|
||||||
|
pdf.SetFontStyle('', 8)
|
||||||
|
pdf.RDMCell(130, 5, text.truncate(truncate_length), border_first)
|
||||||
|
pdf.SetFontStyle('B', 8)
|
||||||
|
pdf.RDMCell(20, 5, other.status.to_s, "")
|
||||||
|
pdf.RDMCell(20, 5, format_date(other.start_date), "")
|
||||||
|
pdf.RDMCell(20, 5, format_date(other.due_date), border_last)
|
||||||
|
pdf.ln
|
||||||
|
end
|
||||||
|
pdf.RDMCell(190, 5, "", "T")
|
||||||
|
pdf.ln
|
||||||
|
end
|
||||||
|
|
||||||
|
def render_changesets(pdf, issue)
|
||||||
|
return unless issue.changesets.any? && User.current.allowed_to?(:view_changesets, issue.project)
|
||||||
|
|
||||||
|
pdf.SetFontStyle('B', 9)
|
||||||
|
pdf.RDMCell(190, 5, l(:label_associated_revisions), "B")
|
||||||
|
pdf.ln
|
||||||
|
|
||||||
|
issue.changesets.each do |changeset|
|
||||||
|
pdf.SetFontStyle('B', 8)
|
||||||
|
csstr = "#{l(:label_revision)} #{changeset.format_identifier} - #{format_time(changeset.committed_on)} - #{changeset.author}"
|
||||||
|
pdf.RDMCell(190, 5, csstr)
|
||||||
|
pdf.ln
|
||||||
|
|
||||||
|
unless changeset.comments.blank?
|
||||||
|
pdf.SetFontStyle('', 8)
|
||||||
|
pdf.RDMwriteHTMLCell(190, 5, '', '', changeset.comments.to_s, issue.attachments, "")
|
||||||
|
end
|
||||||
|
pdf.ln
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def render_journals(pdf, issue, assoc)
|
||||||
|
return unless assoc[:journals].present?
|
||||||
|
|
||||||
|
pdf.SetFontStyle('B', 9)
|
||||||
|
pdf.RDMCell(190, 5, l(:label_history), "B")
|
||||||
|
pdf.ln
|
||||||
|
|
||||||
|
assoc[:journals].each do |journal|
|
||||||
|
pdf.SetFontStyle('B', 8)
|
||||||
|
title = "##{journal.indice} - #{format_time(journal.created_on)} - #{journal.user}"
|
||||||
|
title << " (#{l(:field_private_notes)})" if journal.private_notes?
|
||||||
|
pdf.RDMCell(190, 5, title)
|
||||||
|
pdf.ln
|
||||||
|
|
||||||
|
pdf.SetFontStyle('I', 8)
|
||||||
|
details_to_strings(journal.visible_details, true).each do |string|
|
||||||
|
pdf.RDMMultiCell(190, 5, "- " + string)
|
||||||
|
end
|
||||||
|
|
||||||
|
if journal.notes?
|
||||||
|
pdf.ln unless journal.details.empty?
|
||||||
|
pdf.SetFontStyle('', 8)
|
||||||
|
text = textilizable(journal, :notes, only_path: false, edit_section_links: false, headings: false, inline_attachments: false)
|
||||||
|
|
||||||
|
# Apply the fix here
|
||||||
|
text = sanitize_html_for_pdf(text)
|
||||||
|
|
||||||
|
pdf.RDMwriteFormattedCell(190, 5, '', '', text, issue.attachments, "")
|
||||||
|
end
|
||||||
|
pdf.ln
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def render_attachments(pdf, issue)
|
||||||
|
return unless issue.attachments.any?
|
||||||
|
|
||||||
|
pdf.SetFontStyle('B', 9)
|
||||||
|
pdf.RDMCell(190, 5, l(:label_attachment_plural), "B")
|
||||||
|
pdf.ln
|
||||||
|
|
||||||
|
issue.attachments.each do |attachment|
|
||||||
|
pdf.SetFontStyle('', 8)
|
||||||
|
pdf.RDMCell(80, 5, attachment.filename)
|
||||||
|
pdf.RDMCell(20, 5, number_to_human_size(attachment.filesize), 0, 0, "R")
|
||||||
|
pdf.RDMCell(25, 5, format_date(attachment.created_on), 0, 0, "R")
|
||||||
|
pdf.RDMCell(65, 5, attachment.author.name, 0, 0, "R")
|
||||||
|
pdf.ln
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
def merge_estimate_if_present(pdf, issue)
|
||||||
|
if issue.estimate
|
||||||
|
e_pdf, _ref = PdfService.new(entity: Estimate).fetch_pdf(doc_ids: [issue.estimate.id])
|
||||||
|
combined = CombinePDF.parse(pdf.output, allow_optional_content: true)
|
||||||
|
combined << CombinePDF.parse(e_pdf)
|
||||||
|
combined.to_pdf
|
||||||
|
else
|
||||||
|
pdf.output
|
||||||
|
end
|
||||||
|
end
|
||||||
|
|
||||||
|
private
|
||||||
|
|
||||||
|
# NEW HELPER: Aggressively cleans up HTML so RBPDF doesn't crash on tables
|
||||||
|
def sanitize_html_for_pdf(text)
|
||||||
|
clean_text = text.to_s.dup
|
||||||
|
|
||||||
|
# 1. RBPDF layout engine hates div wrappers. Strip all opening and closing divs.
|
||||||
|
clean_text.gsub!(/<\/?div[^>]*>/i, '')
|
||||||
|
|
||||||
|
# 2. Rebuild tables into a completely flat, pure HTML structure that TCPDF supports
|
||||||
|
clean_text.gsub!(/<table[^>]*>.*?<\/table>/mi) do |match|
|
||||||
|
table_html = match.dup
|
||||||
|
|
||||||
|
# Strip thead and tbody tags completely
|
||||||
|
table_html.gsub!(/<\/?thead[^>]*>/i, '')
|
||||||
|
table_html.gsub!(/<\/?tbody[^>]*>/i, '')
|
||||||
|
|
||||||
|
# TCPDF cell width calculations crash on <th> tags. Convert them to <td> + bold.
|
||||||
|
table_html.gsub!(/<th([^>]*)>/i, '<td\1><strong>')
|
||||||
|
table_html.gsub!(/<\/th>/i, '</strong></td>')
|
||||||
|
|
||||||
|
# Remove all newlines and spaces between tags to prevent stray text nodes crashing the parser
|
||||||
|
table_html.gsub!(/>\s+</m, '><')
|
||||||
|
table_html.gsub!(/\r?\n/, '')
|
||||||
|
|
||||||
|
# Inject a standardized <table> tag with borders so the table actually renders visibly
|
||||||
|
table_html.sub!(/<table[^>]*>/i, '<table border="1" cellpadding="4" style="border-collapse: collapse;">')
|
||||||
|
|
||||||
|
table_html
|
||||||
|
end
|
||||||
|
|
||||||
|
clean_text
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
Redmine::Export::PDF::IssuesPdfHelper.send(:include, PdfPatch)
|
|
||||||
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -8,11 +8,10 @@
|
|||||||
#
|
#
|
||||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
require_dependency 'issue_query'
|
|
||||||
|
|
||||||
module RedmineQbo
|
module RedmineQbo
|
||||||
module Patches
|
module Patches
|
||||||
module QueryPatch
|
module QueryPatch
|
||||||
|
extend ActiveSupport::Concern
|
||||||
|
|
||||||
def base_scope
|
def base_scope
|
||||||
scope = super
|
scope = super
|
||||||
@@ -59,12 +58,6 @@ module RedmineQbo
|
|||||||
|
|
||||||
Issue.joins(:customer).sanitize_sql_for_conditions([sql, pattern])
|
Issue.joins(:customer).sanitize_sql_for_conditions([sql, pattern])
|
||||||
end
|
end
|
||||||
|
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Add module to Issue
|
|
||||||
IssueQuery.send(:prepend, QueryPatch)
|
|
||||||
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -8,11 +8,10 @@
|
|||||||
#
|
#
|
||||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
require_dependency 'time_entry_query'
|
|
||||||
|
|
||||||
module RedmineQbo
|
module RedmineQbo
|
||||||
module Patches
|
module Patches
|
||||||
module TimeEntryQueryPatch
|
module TimeEntryQueryPatch
|
||||||
|
extend ActiveSupport::Concern
|
||||||
|
|
||||||
# Add QBO options to columns
|
# Add QBO options to columns
|
||||||
def available_columns
|
def available_columns
|
||||||
@@ -28,11 +27,6 @@ module RedmineQbo
|
|||||||
add_available_filter "billed", type: :boolean
|
add_available_filter "billed", type: :boolean
|
||||||
super
|
super
|
||||||
end
|
end
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Add module to TimeEntryQuery
|
|
||||||
TimeEntryQuery.send(:prepend, QueryPatch)
|
|
||||||
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -8,37 +8,14 @@
|
|||||||
#
|
#
|
||||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
|
|
||||||
require_dependency 'user'
|
|
||||||
|
|
||||||
module RedmineQbo
|
module RedmineQbo
|
||||||
module Patches
|
module Patches
|
||||||
|
|
||||||
# Patches Redmine's User dynamically.
|
|
||||||
# Adds a relationships
|
|
||||||
module UserPatch
|
module UserPatch
|
||||||
def self.included(base) # :nodoc:
|
extend ActiveSupport::Concern
|
||||||
base.extend(ClassMethods)
|
|
||||||
|
|
||||||
base.send(:include, InstanceMethods)
|
prepended do
|
||||||
|
|
||||||
# Same as typing in the class
|
|
||||||
base.class_eval do
|
|
||||||
belongs_to :employee, primary_key: :id
|
belongs_to :employee, primary_key: :id
|
||||||
end
|
|
||||||
end
|
end
|
||||||
|
|
||||||
module ClassMethods
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
module InstanceMethods
|
|
||||||
|
|
||||||
end
|
|
||||||
|
|
||||||
end
|
end
|
||||||
|
|
||||||
# Add module to Issue
|
|
||||||
User.send(:include, UserPatch)
|
|
||||||
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
@@ -8,29 +8,20 @@
|
|||||||
#
|
#
|
||||||
#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 InvoiceSyncJob < ApplicationJob
|
module RedmineQbo
|
||||||
queue_as :default
|
# Capitalizes the first letter of every word and leaves the rest of each word exactly as typed,
|
||||||
retry_on StandardError, wait: 5.minutes, attempts: 5
|
# so acronyms and model names survive: "led light bar for JL" -> "Led Light Bar For JL",
|
||||||
|
# "LED" stays "LED", "4x4" stays "4x4", "(front)" -> "(Front)". Runs of whitespace become one space.
|
||||||
|
# (Rails' titleize lowercases the rest of each word, turning "LED" into "Led" and "JL" into "Jl".)
|
||||||
|
module TitleCase
|
||||||
|
module_function
|
||||||
|
|
||||||
# Performs a sync of invoices from QuickBooks Online.
|
def call(text)
|
||||||
def perform(full_sync: false, id: nil)
|
return text if text.nil?
|
||||||
qbo = QboConnectionService.current!
|
|
||||||
raise "No QBO configuration found" unless qbo
|
|
||||||
|
|
||||||
log "Starting #{full_sync ? 'full' : 'incremental'} sync for invoice ##{id || 'all'}..."
|
text.to_s.split(/\s+/).reject(&:empty?).map do |word|
|
||||||
|
word.sub(/\A([^\p{L}\p{N}]*)(\p{Ll})/) { "#{Regexp.last_match(1)}#{Regexp.last_match(2).upcase}" }
|
||||||
service = InvoiceSyncService.new(qbo: qbo)
|
end.join(' ')
|
||||||
|
|
||||||
if id.present?
|
|
||||||
service.sync_by_id(id)
|
|
||||||
else
|
|
||||||
service.sync(full_sync: full_sync)
|
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
end
|
||||||
private
|
|
||||||
|
|
||||||
def log(msg)
|
|
||||||
Rails.logger.info "[InvoiceSyncJob] #{msg}"
|
|
||||||
end
|
|
||||||
end
|
|
||||||
Reference in new issue
Block a user