Compare commits
466 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 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 | |||
| 2520892e2c | |||
| b96678a2e9 | |||
| bccfcd9dbc | |||
| 8ba99b7db2 | |||
| aff7d0c48e | |||
| e9b3b1c838 | |||
| 2fc2f94cd1 | |||
| 9f9810686f | |||
| f041e1bce4 | |||
| d44d5e2fb7 | |||
| 4403267abb | |||
| be400c2b2a | |||
| 23e565a304 | |||
| 2e2b17fac3 | |||
| 28db5cb8c8 | |||
| 0df15693d2 | |||
| f8b1c72394 | |||
| 899237c5ab | |||
| f02b50ae26 | |||
| 485a977d1a | |||
| 03d5a5d148 | |||
| 0deab9dbd3 | |||
| 899c9878c4 | |||
| b95a3b6623 | |||
| ef3f00c445 | |||
| 46f06df995 | |||
| b15b88f48d | |||
| 7b7b07b5fa | |||
| 16ca1caabc | |||
| 69d266bdca | |||
| 3728ec2a12 | |||
| cefa36c880 | |||
| ed111fefe7 | |||
| 5a662f67b8 | |||
| 6e90548dbb | |||
| f921f227e2 | |||
| a34ae46358 | |||
| e4cfb0674e | |||
| 348c521491 | |||
| 6cee8c1d81 | |||
| d4a0aa1db5 | |||
| 12884a211e | |||
| 4ed71f5667 | |||
| 8303dec501 | |||
| 9b07ae7073 | |||
| baf321d4d6 | |||
| 0a2d38a927 | |||
| b80dbaa015 | |||
| 9e399b934b | |||
| cc6fd07435 | |||
| 7a50df24d9 | |||
| ca02ead9f9 | |||
| 9089adaba0 | |||
| dc6eba8566 | |||
| 19911b7940 | |||
| a80f59cc45 | |||
| eee99e4d83 | |||
| b3f01bd372 | |||
| d1ba93d61a | |||
| 9a688c4841 | |||
| e94352e2c4 | |||
| ea0f42b68e | |||
| 5a31c194a5 | |||
| 6f8af9bba8 | |||
| 03109d5775 | |||
| a1cbf9a0a9 | |||
| 9c0f153518 | |||
| f32b48296d | |||
| 3d37f01bff | |||
| 889e9bf31f | |||
| 208e839e6a | |||
| 4f55751500 | |||
| a64016eb95 | |||
| 5d858ae186 | |||
| b38f850df3 | |||
| 138e55933b | |||
| 5fbc169ade | |||
| d6737a6747 | |||
| 65db8f00a8 | |||
| 0197dc2a30 | |||
| cd1caa502d | |||
| 4b45d24a75 | |||
| 64a4526aa4 | |||
| 3514401808 | |||
| 3deafd8a6d | |||
| a54de28db5 | |||
| 6434eea906 | |||
| 9b656534ae | |||
| 659a1fbcf0 | |||
| 4dc1f5d0bd | |||
| 02f34582f4 | |||
| 2f9ef6304f | |||
| 886d5f4ace | |||
| 1ade938eb3 | |||
| 3111f391f3 | |||
| d2b9113914 | |||
| 447e048819 | |||
| e7dfc3f2ad | |||
| 139f5dd618 | |||
| 9c11704d03 | |||
| 2ae53adf08 | |||
| 877c1b78a5 | |||
| 1d47703206 | |||
| a069556ed9 | |||
| 359c582e22 | |||
| e63b9e4217 | |||
| 6fd355d8cc | |||
| e6b57392d1 | |||
| 331c1eabeb | |||
| 167385bb99 | |||
| 11b9876d4f | |||
| 9cf72821b0 | |||
| 57adcce431 | |||
| 7fdb15f7e8 | |||
| 6e11e05a24 | |||
| a6751d3f41 | |||
| 8944e92ffc | |||
| f0c0a42c96 | |||
| a4b51457bb | |||
| fb4a883b43 | |||
| c24ec93335 | |||
| df49964bf9 | |||
| 502ba94465 | |||
| ff038fe5ae | |||
| 3eed122598 | |||
| d8d34540a9 | |||
| c01cc5ca97 | |||
| 6a2f7a1146 | |||
| f4c844f097 | |||
| 1135c69e1b | |||
| ef86d222cb | |||
| be88a601ae | |||
| e6c4e81df2 | |||
| f4a979672f | |||
| 8a4d64ffc0 | |||
| ac05d38763 | |||
| 548dc4fba8 | |||
| 7a73b7e8a9 | |||
| b38bd951f7 | |||
| 0e3318efdd | |||
| d063494bd2 | |||
| e35a2148eb | |||
| c8f115ae02 | |||
| d59e52b111 | |||
| 2c3548d1ac | |||
| d80007bc84 | |||
| 5d7d9a81bb | |||
| b030f85b74 | |||
| 2f0ee6a6d6 | |||
| 637cfa89b4 | |||
| c36f4c905b | |||
| 83fb20044d | |||
| 928e632dd3 | |||
| 8b9cf5066e | |||
| 45bfce87d8 | |||
| 6f33e9d23d | |||
| 92460392b9 | |||
| f1bdf59697 | |||
| 60e2f1d2b0 | |||
| 6c9ae82f81 | |||
| 42e4494f6e | |||
| 7e0b2c9d09 | |||
| 5ca68b01b6 | |||
| ebd4fa7363 | |||
| e6818958ae | |||
| 5b31459629 | |||
| 92de2928f6 | |||
| a8af180de2 | |||
| e621dc9e3a | |||
| c3d7c1c867 | |||
| defeec7f8e | |||
| 37c302e274 | |||
| 006e907b35 | |||
| f1f77a8022 | |||
| ff358d806e | |||
| b80e1d4e28 | |||
| f24128ef75 | |||
| d3a8c05f50 | |||
| f023cd246d | |||
| b7e18a3c3f | |||
| 67f2dbf4d8 | |||
| 924aa7657b | |||
| 16fe07f177 | |||
| 9257b2f938 | |||
| 0227681e92 | |||
| c034696810 | |||
| ffdabccd84 | |||
| 1f03908040 | |||
| 43a5317b4e | |||
| 4c49ec6890 | |||
| ef7faee685 | |||
| 02b48d2de4 | |||
| e670d99766 | |||
| 241dd594d0 | |||
| b603cb634a | |||
| 1308a05011 | |||
| 334ed60bf7 | |||
| d63bf809f2 | |||
| 31406af681 | |||
| 479be461a6 | |||
| c1af031d22 | |||
| a741cd0217 | |||
| 4ae9374401 | |||
| b096244454 | |||
| 4983cd661c | |||
| 5f6fb4af27 | |||
| 2f2c74403f | |||
| 43579d73e5 | |||
| a90d6b839f | |||
| e76f977ca8 | |||
| 7f821d241c | |||
| 1bc9227c7f | |||
| 3c2f1d0edd | |||
| 35e303d54b | |||
| 2aeb3fa028 | |||
| c85e45b544 | |||
| 6cd7825430 | |||
| 14f411c2e1 | |||
| 623510b474 | |||
| 20d9f0a84e | |||
| f741ce5dc9 | |||
| 72ec89292f | |||
| b54eb86b7f | |||
| f74f3ad72e | |||
| 0647b7708f | |||
| 7d644f0619 | |||
| b712c328ba | |||
| 5649ba05cd | |||
| bcdd515cf1 | |||
| 704dff2a72 | |||
| 55d00f9005 | |||
| eba3f529f8 | |||
| f0a3b0193c | |||
| 19733c3f8c | |||
| f22795ac90 | |||
| 166a9ee31b | |||
| 4d85c24872 | |||
| 43c7374c42 | |||
| 60857e9dca | |||
| d38f0d6ac1 | |||
| f6da031e72 | |||
| 9779437c00 | |||
| 1a37926628 | |||
| dac9a7c756 | |||
| 9ac1261ed0 | |||
| 9b69d3f728 | |||
| a5de879260 | |||
| 6464e1cbc6 | |||
| 7f3a94229a | |||
| 395e0117fb | |||
| e04d363e42 | |||
| 3b6c0d4a70 | |||
| d1f6ccd9cb | |||
| 74f7ba41df | |||
| 4fb424faa8 | |||
| 63218e7f42 | |||
| 7f0bb3cae7 | |||
| ad7417c233 | |||
| cf0be2336b | |||
| 6e08746611 | |||
| 7eb26facaf | |||
| 9115cc662c | |||
| 9e7c1dbfb2 | |||
| e99f5d2e52 | |||
| 039d1ca993 | |||
| dd9ac3c481 | |||
| 4f789080e7 | |||
| 80fc858a35 | |||
| 6f8d280657 | |||
| 5782cbc166 | |||
| 0729d2ac41 | |||
| 6c6de0ba86 | |||
| 11dbcaf80c | |||
| 95592e542f | |||
| 472bdec4fa | |||
| c7a313e9ed | |||
| c14b590083 | |||
| 040c920481 | |||
| 8c63817950 | |||
| e2f43d398f | |||
| 7ba4829066 | |||
| 938999db91 | |||
| 0b60a8e41b | |||
| 817a43e849 | |||
| 047296329e | |||
| c8cb74f3d4 | |||
| aceb6cb6b5 | |||
| b531076c18 | |||
| 9e342ced28 | |||
| 9fd1bc9dff | |||
| 0537d9bd86 | |||
| 04391f1c6e | |||
| e2bf42e66b | |||
| 0c72ca9294 | |||
| 2985fad77c | |||
| 02b5fb4d0e | |||
| bf417c163c | |||
| b35974e455 | |||
| 6d0abf865e | |||
| 275af9be82 | |||
| f4e44a1975 | |||
| 81f322b616 | |||
| f094ef57ec | |||
| 2e32d8f6e5 | |||
| 3e352f270d | |||
| 45056e8ff4 | |||
| b13abe51bf | |||
| c3513427de | |||
| 7a6b6882d2 | |||
| d6ec34cef9 | |||
| 84dfdd707a | |||
| 517a239485 | |||
| 47868051f8 | |||
| 96e4e9df66 | |||
| 7d510e4028 | |||
| 6760b29148 | |||
| 122063b1d5 | |||
| b304c3a175 | |||
| 5b89d73c20 | |||
| 8380dda25a | |||
| 7839116134 | |||
| b3a809ab1c | |||
| 3a0e58c3da | |||
| 26433c9020 | |||
| a531ef4f87 | |||
| 6dbf84f401 | |||
| 3220ff728f | |||
| 1fae647381 | |||
| d1764e2203 | |||
| d8d1942673 | |||
| 8e329b2dd2 | |||
| 3622f8cad7 | |||
| f830881883 | |||
| fb87e8a33a | |||
| 8bdec410c4 | |||
| dec9eee90b | |||
| 0513763607 | |||
| b7e3ea9e3d | |||
| 3ea2cd14d1 | |||
| 7b7875991f | |||
| b1a106d4d8 | |||
| 0281d86f1a | |||
| 2231156873 | |||
| 2745ecf242 | |||
| 13472c3b3a | |||
| b686110145 | |||
| d91e7892c3 | |||
| f26224de56 | |||
| ecc8930bec | |||
| 5814740a5d | |||
| 25159c760a | |||
| 3ff9132acb | |||
| b5f00f254c | |||
| 70f2c473d5 | |||
| b3b11d726d | |||
| f97d5bc731 | |||
| 49507d06c7 | |||
| 5d928c486f | |||
| 0485e9d64c | |||
| cc0839204e | |||
| 760a85a1da | |||
| c821774e9b | |||
| 47a19a7e77 | |||
| a75f1abd71 | |||
| 09c497ff96 | |||
| cae1d9de02 | |||
| 1050a4f6a7 | |||
| be4ef44c13 | |||
| 89e4132fc1 | |||
| 8d8201822b | |||
| 726eb4632e | |||
| ffcb2ee608 | |||
| 24f8be6e80 | |||
| 08fa4aefc4 | |||
| 13bbd5dfc1 | |||
| 8e6eeab680 | |||
| 70d9d5063a | |||
| 374429f161 | |||
| c69666e747 | |||
| 7dc04b4a07 | |||
| 7b5e54aaba | |||
| 30b704c90f | |||
| 2f98b5afaa | |||
| 3c3b43cfc5 | |||
| 09f2a534be | |||
| 7b5b673ebf | |||
| c72d0a83ca | |||
| 3159289ac0 | |||
| a9cc5fac73 | |||
| fe06fccacd | |||
| 8b4a46f7eb | |||
| cf362caaf2 | |||
| de1be7d296 | |||
| d8e3e1a72f | |||
| 64a7ad844f | |||
| 9201c4ca96 | |||
| dab6b6f723 | |||
| 495243d177 |
2
.gitignore
vendored
@@ -1,3 +1,5 @@
|
||||
.bundle
|
||||
.config
|
||||
.dockerrc
|
||||
.vscode
|
||||
Gemfile.lock
|
||||
|
||||
11
Gemfile
@@ -1,13 +1,8 @@
|
||||
source 'https://rubygems.org'
|
||||
|
||||
gem 'quickbooks-ruby'
|
||||
gem 'oauth2', '1.4.7'
|
||||
gem 'oauth2'
|
||||
gem 'roxml'
|
||||
gem 'nhtsa_vin'
|
||||
gem 'will_paginate'
|
||||
gem 'rails-jquery-autocomplete'
|
||||
gem 'jquery-ui-rails'
|
||||
|
||||
group :assets do
|
||||
gem 'coffee-rails'
|
||||
end
|
||||
gem 'rexml'
|
||||
gem 'combine_pdf'
|
||||
|
||||
2
LICENSE
@@ -1,6 +1,6 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2022 Rick Barrette
|
||||
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
|
||||
|
||||
312
README.md
@@ -1,83 +1,275 @@
|
||||
# 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 completed work 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 heavy development. I am still working on refining everthing and adding other features. Tags should be stable
|
||||
# Disclaimer
|
||||
|
||||
Use tags Version 1.0.0 & up for Redmine 4+ and Version 0.8.1 for Redine 3
|
||||
The core functionality is implemented, but the project is **under active development**.
|
||||
|
||||
#### Features
|
||||
* Issues can be assigned to a `Customer` via drop down in the edit Issue form
|
||||
* The `Employee` for the Issue is assigned via the assigned Redmine User
|
||||
- This is set via a drop down in the user admistration page.
|
||||
* IF an `Issue` has been assined a `Customer` when an Issue is closed the following will happen:
|
||||
- A new `Time Activity` will be billed agaist the `Customer` assinged to the issue for each Redmine Time Entery.
|
||||
+ Time Entries will be totalled up by Activity name. This will allow billing for diffrent activities without having to create seperate Issues.
|
||||
+ The Time Activity names are used to lookup `Items` in Quickbooks.
|
||||
+ IF there isn'tany Items that match the Activity name it will be skipped, and will not be billed to the `Customer`
|
||||
- Labor Rates are set by the `Item` in Quickbooks
|
||||
* `Payments` Can be created via the Redmine application menu
|
||||
* `Customers` Can be created via the Redmine application menu
|
||||
- `Customers` can be searched
|
||||
- Basic information for the `Customer` can be viewed/edit via the Customer page
|
||||
* Webhook Support
|
||||
- `Invoices` are automaticly attached to an Issue if a line item has a hashtag number in a `Line Item`
|
||||
+ `Invoice` Custom Fields are matched Issue Custom Fileds and are automaticly updated in Quickbooks. For example, this is usefull for extracting the Mileage In / Out from the Issue and updating the Invoice with the information.
|
||||
- `Customers` are automaticly updated in local database
|
||||
The `master` branch may contain unstable changes.
|
||||
For production deployments, **use a tagged release**.
|
||||
|
||||
## Prerequisites
|
||||
---
|
||||
|
||||
* Sign up to become a developer for Intuit https://developer.intuit.com/
|
||||
* Create your own aplication to obtain your API keys
|
||||
* Set up webhook service to https://redmine.yourdomain.com/qbo/webhook
|
||||
- See https://developer.intuit.com/docs/0100_accounting/0300_developer_guides/webhooks
|
||||
# Compatibility
|
||||
|
||||
## The Install
|
||||
| Plugin Version | Redmine Version |
|
||||
| :--- | :--- |
|
||||
| Version 2026.1.0+ | Redmine 6.1 |
|
||||
| Version 2.0.0+ | Redmine 5 |
|
||||
| Version 1.0.0+ | Redmine 4 |
|
||||
| Version 0.8.1 | Redmine 3 |
|
||||
|
||||
1. To install, clone this repo into your plugin folder
|
||||
---
|
||||
|
||||
`git clone git@github.com:rickbarrette/redmine_qbo.git`
|
||||
# Features
|
||||
|
||||
2. Migrate your database
|
||||
## Issue Billing Integration
|
||||
|
||||
`rake redmine:plugins:migrate RAILS_ENV=production`
|
||||
* Assign a **QuickBooks Customer** to a Redmine Issue.
|
||||
|
||||
3. Navigate to the plugin configuration page and suppy your own OAuth key & secret.
|
||||
* Optionally associate a **QuickBooks Estimate** with the Issue.
|
||||
|
||||
4. After saving your key & secret, you need to click on the Authenticate link on the plugin configuration page to authenticate with QBO.
|
||||
* Automatically associates a **QuickBooks Invoice** with the Issue.
|
||||
|
||||
5. Assign an Employee to each of your users via the User Administration Page
|
||||
|
||||
## Usage
|
||||
---
|
||||
|
||||
To enable automatic `Time Activity` entries for an Issue , you need only to assign a `Customer` to an Issue via drop downs in the issue creation/update form.
|
||||
## Automatic Time Activity Creation
|
||||
|
||||
Note: After the inital synchronization, this plugin will recieve push notifications via Intuit's webhook service.
|
||||
When an Issue with an assigned Customer is closed:
|
||||
|
||||
## TODO
|
||||
* Abiltiy to add line items to a ticket in a dynamic table so they can be added to the invoice upon closing of the issue
|
||||
* Customer Deletion
|
||||
* Email Customer updates, provding a link that would: bypass the login page, go directly to the issue directing them to, and allow them to view only that issue.
|
||||
* Add Setting for Sandbox Mode
|
||||
* Refactor Models prefixed with Qbo...
|
||||
* Seperate Vehicles into a seperate plugin
|
||||
* Make HTML Pretty
|
||||
* Intergrate Customer Search into Redmine Search
|
||||
* Fix Issue sort by Customer
|
||||
* MORE Stuff...
|
||||
* A **Time Activity** is created in QuickBooks for each relevant Redmine Time Entry.
|
||||
|
||||
* Time Entries are **grouped by Activity name**.
|
||||
|
||||
* Activity names are used to **dynamically match Items in QuickBooks**.
|
||||
|
||||
* If no matching Item exists, the activity is **skipped**.
|
||||
|
||||
* **Labor rates** are determined by the associated QuickBooks Item.
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Employee Mapping
|
||||
|
||||
Redmine Users can be mapped to **QuickBooks Employees** through the **User Administration** page.
|
||||
|
||||
This ensures Time Activities are recorded under the correct employee in QuickBooks.
|
||||
|
||||
---
|
||||
|
||||
## Customer Management
|
||||
|
||||
The plugin provides basic Customer management:
|
||||
|
||||
* Create Customers directly from Redmine
|
||||
|
||||
* Search Customers by **name or phone number**
|
||||
|
||||
* View and edit Customer information
|
||||
|
||||
|
||||
Customers are synchronized with QuickBooks.
|
||||
|
||||
---
|
||||
|
||||
## Webhook Support
|
||||
|
||||
The plugin listens for **QuickBooks webhook events**.
|
||||
|
||||
Supported automation:
|
||||
|
||||
### Invoice Linking
|
||||
|
||||
Invoices containing an Issue reference (e.g. `#123`) automatically attach to the corresponding Issue.
|
||||
|
||||
### Custom Field Synchronization
|
||||
|
||||
Invoice custom fields can be mapped to Issue custom fields.
|
||||
|
||||
Example use case:
|
||||
|
||||
* Mileage In/Out recorded in Redmine
|
||||
|
||||
* Automatically synchronized to the QuickBooks invoice.
|
||||
|
||||
|
||||
### Customer Synchronization
|
||||
|
||||
Customer records are automatically updated in the local database when changes occur in QuickBooks.
|
||||
|
||||
---
|
||||
|
||||
## Plugin Hooks
|
||||
|
||||
The plugin exposes several hooks for extending functionality through companion plugins.
|
||||
|
||||
Example:
|
||||
|
||||
`redmine_qbo_vehicles`
|
||||
Adds support for tracking **customer vehicles** associated with Issues.
|
||||
|
||||
Available hooks:
|
||||
|
||||
|Type|Hook|Note
|
||||
|--|--|--|
|
||||
View Hook|:pdf_left, { issue: issue } | Used to add text to left side of PDF
|
||||
View Hook|:pdf_right, { issue: issue } | Used to add text to right side of PDF
|
||||
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
|
||||
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2022 rick barrette
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
|
||||
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 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.
|
||||
BIN
Screenshots/issue.png
Normal file
|
After Width: | Height: | Size: 724 KiB |
BIN
Screenshots/issue_form.png
Normal file
|
After Width: | Height: | Size: 520 KiB |
|
Before Width: | Height: | Size: 346 KiB After Width: | Height: | Size: 269 KiB |
|
Before Width: | Height: | Size: 303 KiB After Width: | Height: | Size: 538 KiB |
|
Before Width: | Height: | Size: 240 KiB |
|
Before Width: | Height: | Size: 512 KiB |
@@ -1,6 +1,6 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2022 rick barrette
|
||||
#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:
|
||||
#
|
||||
@@ -10,7 +10,6 @@
|
||||
|
||||
# This controller class will handle map management
|
||||
class CustomersController < ApplicationController
|
||||
unloadable
|
||||
|
||||
include AuthHelper
|
||||
helper :issues
|
||||
@@ -27,127 +26,94 @@ class CustomersController < ApplicationController
|
||||
include SortHelper
|
||||
helper :timelog
|
||||
|
||||
before_action :add_customer, :only => :new
|
||||
before_action :view_customer, :except => [:new, :view]
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, :only => [:view]
|
||||
before_action :add_customer, only: :new
|
||||
before_action :view_customer, except: [:new, :view]
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, only: [:view]
|
||||
|
||||
default_search_scope :names
|
||||
def address_to_s(address)
|
||||
return if address.nil?
|
||||
|
||||
autocomplete :customer, :name, :full => true, :extra_data => [:id]
|
||||
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
|
||||
params.require(:customer).permit(:name, :email, :primary_phone, :mobile_phone, :phone_number)
|
||||
params.require(:customer).permit(:name, :email, :primary_phone, :mobile_phone, :phone_number, :notes)
|
||||
end
|
||||
|
||||
# getter method for a customer's vehicles
|
||||
# used for customer autocomplete field / issue form
|
||||
def filter_vehicles_by_customer
|
||||
@filtered_vehicles = Vehicle.all.where(customer_id: params[:selected_customer])
|
||||
# Used for autocomplete form
|
||||
def autocomplete
|
||||
term = ActiveRecord::Base.sanitize_sql_like(params[:q].to_s)
|
||||
|
||||
items = Customer.where("name LIKE :t OR phone_number LIKE :t OR mobile_phone_number LIKE :t", t: "%#{term}%")
|
||||
.order(:name)
|
||||
.limit(20)
|
||||
|
||||
render json: items.map { |i|
|
||||
{ id: i.id, name: i.name, phone_number: i.phone_number, mobile_phone_number: i.mobile_phone_number }
|
||||
}
|
||||
end
|
||||
|
||||
# getter method for a customer's invoices
|
||||
# used for customer autocomplete field / issue form
|
||||
def filter_invoices_by_customer
|
||||
@filtered_invoices = QboInvoice.all.where(customer_id: params[:selected_customer])
|
||||
def create
|
||||
@customer = Customer.new(allowed_params)
|
||||
@customer.save
|
||||
log "Customer ##{@customer.id} created successfully."
|
||||
flash[:notice] = t :notice_customer_created
|
||||
redirect_to @customer
|
||||
rescue => e
|
||||
log "Failed to create customer: #{e.message}"
|
||||
flash[:error] = e.message
|
||||
redirect_to new_customer_path
|
||||
end
|
||||
|
||||
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
|
||||
|
||||
# getter method for a customer's estimates
|
||||
# used for customer autocomplete field / issue form
|
||||
def filter_estimates_by_customer
|
||||
@filtered_estimates = QboEstimate.all.where(customer_id: params[:selected_customer])
|
||||
@filtered_estimates = Estimate.all.where(customer_id: params[:selected_customer])
|
||||
end
|
||||
|
||||
def filter_invoices_by_customer
|
||||
@filtered_invoices = Invoice.all.where(customer_id: params[:selected_customer])
|
||||
end
|
||||
|
||||
# display a list of all customers
|
||||
def index
|
||||
if params[:search]
|
||||
@customers = Customer.search(params[:search]).paginate(:page => params[:page])
|
||||
@customers = Customer.search(params[:search]).order(:name).paginate(page: params[:page])
|
||||
if only_one_non_zero?(@customers)
|
||||
redirect_to @customers.first
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# initialize a new customer
|
||||
def new
|
||||
@customer = Customer.new
|
||||
end
|
||||
def load_issue_data
|
||||
@journals = @issue.journals.preload(:details).preload(user: :email_address).reorder(:created_on, :id).to_a
|
||||
|
||||
# create a new customer
|
||||
def create
|
||||
@customer = Customer.new(allowed_params)
|
||||
if @customer.save
|
||||
flash[:notice] = "New Customer Created"
|
||||
redirect_to @customer
|
||||
else
|
||||
flash[:error] = @customer.errors.full_messages.to_sentence
|
||||
redirect_to new_customer_path
|
||||
end
|
||||
end
|
||||
|
||||
# display a specific customer
|
||||
def show
|
||||
begin
|
||||
@customer = Customer.find_by_id(params[:id])
|
||||
@vehicles = @customer.vehicles.paginate(:page => params[:page])
|
||||
@issues = @customer.issues.order(id: :desc)
|
||||
@billing_address = address_to_s(@customer.billing_address)
|
||||
@shipping_address = address_to_s(@customer.shipping_address)
|
||||
@closed_issues = (@issues - @issues.open)
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
render_404
|
||||
end
|
||||
end
|
||||
|
||||
# return an HTML form for editing a customer
|
||||
def edit
|
||||
begin
|
||||
@customer = Customer.find_by_id(params[:id])
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
render_404
|
||||
end
|
||||
end
|
||||
|
||||
# update a specific customer
|
||||
def update
|
||||
begin
|
||||
@customer = Customer.find_by_id(params[:id])
|
||||
if @customer.update_attributes(allowed_params)
|
||||
flash[:notice] = "Customer updated"
|
||||
redirect_to @customer
|
||||
else
|
||||
redirect_to edit_customer_path
|
||||
flash[:error] = @customer.errors.full_messages.to_sentence if @customer.errors
|
||||
end
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
render_404
|
||||
end
|
||||
end
|
||||
|
||||
# delete a customer
|
||||
def destroy
|
||||
begin
|
||||
Customer.find_by_id(params[:id]).destroy
|
||||
flash[:notice] = "Customer deleted successfully"
|
||||
redirect_to action: :index
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
render_404
|
||||
end
|
||||
end
|
||||
|
||||
# displays an issue for a customer with a provided security CustomerToken
|
||||
def view
|
||||
|
||||
User.current = User.find_by lastname: 'Anonymous'
|
||||
|
||||
@token = CustomerToken.where("token = ? and expires_at > ?", params[:token], Time.now)
|
||||
@token = @token.first
|
||||
if @token
|
||||
session[:token] = @token.token
|
||||
@issue = Issue.find @token.issue_id
|
||||
@journals = @issue.journals.
|
||||
preload(:details).
|
||||
preload(:user => :email_address).
|
||||
reorder(:created_on, :id).to_a
|
||||
@journals.each_with_index { |j, i| j.indice = i + 1 }
|
||||
@journals.reject!(&:private_notes?) unless User.current.allowed_to?(:view_private_notes, @issue.project)
|
||||
Journal.preload_journals_details_custom_fields(@journals)
|
||||
@@ -157,30 +123,21 @@ class CustomersController < ApplicationController
|
||||
@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) && r.other_issue(@issue).visible? }
|
||||
@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)
|
||||
@time_entry = TimeEntry.new(issue: @issue, project: @issue.project)
|
||||
@relation = IssueRelation.new
|
||||
else
|
||||
render_403
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# redmine permission - add customers
|
||||
def add_customer
|
||||
global_check_permission(:add_customers)
|
||||
def log(msg)
|
||||
Rails.logger.info "[CustomersController] #{msg}"
|
||||
end
|
||||
|
||||
# redmine permission - view customers
|
||||
def view_customer
|
||||
global_check_permission(:view_customers)
|
||||
def new
|
||||
@customer = Customer.new
|
||||
end
|
||||
|
||||
# checks to see if there is only one item in an array
|
||||
# @return true if array only has one item
|
||||
def only_one_non_zero?(array)
|
||||
found_non_zero = false
|
||||
array.each do |val|
|
||||
@@ -192,18 +149,78 @@ class CustomersController < ApplicationController
|
||||
found_non_zero
|
||||
end
|
||||
|
||||
# format a quickbooks address to a human readable string
|
||||
def address_to_s (address)
|
||||
return if address.nil?
|
||||
string = address.line1
|
||||
string << "\n" + address.line2 if address.line2
|
||||
string << "\n" + address.line3 if address.line3
|
||||
string << "\n" + address.line4 if address.line4
|
||||
string << "\n" + address.line5 if address.line5
|
||||
string << " " + address.city
|
||||
string << ", " + address.country_sub_division_code
|
||||
string << " " + address.postal_code
|
||||
return string
|
||||
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
|
||||
|
||||
def show
|
||||
@customer = Customer.find_by_id(params[:id])
|
||||
return render_404 unless @customer
|
||||
|
||||
@open_issues = @customer.issues
|
||||
.joins(:status)
|
||||
.includes(:status, :project, :tracker, :priority)
|
||||
.where(issue_statuses: { is_closed: false })
|
||||
.order(id: :desc)
|
||||
|
||||
@closed_issues = @customer.issues
|
||||
.joins(:status)
|
||||
.includes(:status, :project, :tracker, :priority)
|
||||
.where(issue_statuses: { is_closed: true })
|
||||
.order(id: :desc)
|
||||
|
||||
@hours = TimeEntry
|
||||
.joins(:issue)
|
||||
.where(issues: { id: @open_issues.select(:id) })
|
||||
.sum(:hours)
|
||||
|
||||
@closed_hours = TimeEntry
|
||||
.joins(:issue)
|
||||
.where(issues: { id: @closed_issues.select(:id) })
|
||||
.sum(:hours)
|
||||
|
||||
rescue => e
|
||||
Rails.logger.error "Failed to load customer ##{params[:id]}: #{e.message}\n#{e.backtrace.join("\n")}"
|
||||
flash[:error] = e.message
|
||||
render_404
|
||||
end
|
||||
|
||||
def sync
|
||||
Customer.sync
|
||||
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
||||
end
|
||||
|
||||
def update
|
||||
@customer = Customer.find_by_id(params[:id])
|
||||
@customer.update(allowed_params)
|
||||
flash[:notice] = t :notice_customer_updated
|
||||
redirect_to @customer
|
||||
rescue => e
|
||||
log "Failed to update customer: #{e.message}"
|
||||
flash[:error] = e.message
|
||||
redirect_to edit_customer_path
|
||||
end
|
||||
|
||||
def view
|
||||
User.current = User.anonymous
|
||||
@token = CustomerToken.active.find_by(token: params[:token])
|
||||
return render_403 unless @token
|
||||
@issue = @token.issue
|
||||
return render_403 unless @issue
|
||||
return render_403 unless @issue.customer_id == @token.issue.customer_id
|
||||
session[:token] = @token.token
|
||||
load_issue_data
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
render_403
|
||||
end
|
||||
|
||||
def view_customer
|
||||
global_check_permission(:view_customers)
|
||||
end
|
||||
|
||||
end
|
||||
@@ -1,25 +1,26 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2017 rick barrette
|
||||
#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 EmployeesController < ApplicationController
|
||||
include AuthHelper
|
||||
|
||||
class IssuesSaveHookListener < Redmine::Hook::ViewListener
|
||||
before_action :require_user, unless: -> { session[:token].nil? }
|
||||
|
||||
# Called Before Issue Saved
|
||||
def controller_issues_edit_before_save(context={})
|
||||
issue = context[:issue]
|
||||
issue.subject = issue.subject.titleize
|
||||
def sync
|
||||
Employee.sync
|
||||
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
||||
end
|
||||
|
||||
# Called After Issue Saved
|
||||
def controller_issues_edit_after_save(context={})
|
||||
issue = context[:issue]
|
||||
issue.bill_time if issue.status.is_closed?
|
||||
end
|
||||
private
|
||||
|
||||
# Logs messages with a consistent prefix for easier debugging.
|
||||
def log(msg)
|
||||
Rails.logger.info "[EmployeeController] #{msg}"
|
||||
end
|
||||
end
|
||||
@@ -1,45 +0,0 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2022 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#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 EstimateController < ApplicationController
|
||||
unloadable
|
||||
|
||||
include AuthHelper
|
||||
|
||||
before_action :require_user
|
||||
|
||||
#
|
||||
# Downloads and forwards the estimate pdf
|
||||
#
|
||||
def show
|
||||
e = QboEstimate.find_by_id(params[:id]) if params[:id]
|
||||
e = QboEstimate.find_by_doc_number(params[:search]) if params[:search]
|
||||
|
||||
begin
|
||||
send_data e.pdf, filename: "estimate #{e.doc_number}.pdf", :disposition => 'inline', :type => "application/pdf"
|
||||
rescue
|
||||
redirect_to :back, :flash => { :error => "Estimate not found" }
|
||||
end
|
||||
end
|
||||
|
||||
#
|
||||
# Downloads estimate by document number
|
||||
#
|
||||
def doc
|
||||
e = QboEstimate.find_by_doc_number(params[:id]) if params[:id]
|
||||
e = QboEstimate.find_by_doc_number(params[:search]) if params[:search]
|
||||
|
||||
begin
|
||||
send_data e.pdf, filename: "estimate #{e.doc_number}.pdf", :disposition => 'inline', :type => "application/pdf"
|
||||
rescue
|
||||
redirect_to :back, :flash => { :error => "Estimate not found" }
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
84
app/controllers/estimates_controller.rb
Normal file
@@ -0,0 +1,84 @@
|
||||
#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 EstimatesController < ApplicationController
|
||||
include AuthHelper
|
||||
|
||||
before_action :require_user, unless: -> { session[:token].nil? }
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: -> { session[:token].nil? }
|
||||
before_action :load_estimate, only: [:show, :doc]
|
||||
|
||||
# Displays the estimate PDF in the browser or redirects with an error if not found.
|
||||
def doc
|
||||
render_pdf(@estimate)
|
||||
end
|
||||
|
||||
# Displays the estimate PDF in the browser or redirects with an error if not found.
|
||||
def show
|
||||
render_pdf(@estimate)
|
||||
end
|
||||
|
||||
def sync
|
||||
Estimate.sync
|
||||
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Loads the estimate based on ID or doc number, with a fallback to sync if not found locally.
|
||||
def load_estimate
|
||||
log "Attempting to load Estimate with params: #{params.inspect}"
|
||||
@estimate = find_estimate || sync_and_find_estimate
|
||||
|
||||
unless @estimate
|
||||
redirect_back fallback_location: root_path, flash: { error: I18n.t(:notice_estimate_not_found) }
|
||||
end
|
||||
end
|
||||
|
||||
# Attempts to find the estimate locally by ID or doc number.
|
||||
def find_estimate
|
||||
return Estimate.find_by(doc_number: params[:search]) if params[:search].present?
|
||||
return Estimate.find_by(id: params[:id]) if params[:id].present?
|
||||
end
|
||||
|
||||
# If the estimate is not found locally, attempts to sync it from the source and find it again.
|
||||
def sync_and_find_estimate
|
||||
|
||||
if params[:search].present?
|
||||
log "Estimate #{params[:search]} not found locally. Syncing by doc number."
|
||||
Estimate.sync_by_doc_number(params[:search])
|
||||
return Estimate.find_by(doc_number: params[:search])
|
||||
end
|
||||
|
||||
if params[:id].present?
|
||||
log "Estimate #{params[:id]} not found locally. Syncing by ID."
|
||||
Estimate.sync_by_id(params[:id])
|
||||
return Estimate.find_by(id: params[:id])
|
||||
end
|
||||
|
||||
nil
|
||||
rescue StandardError => e
|
||||
log "Estimate sync failed: #{e.message}"
|
||||
nil
|
||||
end
|
||||
|
||||
# Renders the estimate PDF or redirects with an error if rendering fails.
|
||||
def render_pdf(estimate)
|
||||
pdf, ref = PdfService.new(entity: Estimate).fetch_pdf(doc_ids: [estimate.id])
|
||||
send_data( pdf, filename: "estimate #{ref}.pdf", disposition: :inline, type: "application/pdf" )
|
||||
rescue StandardError => e
|
||||
log "PDF render failed for Estimate #{estimate&.id}: #{e.message}"
|
||||
redirect_back fallback_location: root_path, flash: { error: I18n.t(:notice_estimate_not_found) }
|
||||
end
|
||||
|
||||
# Logs messages with a consistent prefix for easier debugging.
|
||||
def log(msg)
|
||||
Rails.logger.info "[EstimateController] #{msg}"
|
||||
end
|
||||
end
|
||||
@@ -1,27 +1,41 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2022 rick barrette
|
||||
#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 InvoiceController < ApplicationController
|
||||
unloadable
|
||||
|
||||
class InvoicesController < ApplicationController
|
||||
include AuthHelper
|
||||
|
||||
before_action :require_user, :unless => proc {|c| session[:token].nil? }
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, :unless => proc {|c| session[:token].nil? }
|
||||
before_action :require_user, unless: -> { session[:token].nil? }
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, unless: -> { session[:token].nil? }
|
||||
|
||||
#
|
||||
# Downloads and forwards the invoice pdf
|
||||
#
|
||||
# Displays the invoice PDF in the browser or redirects with an error if not found.
|
||||
def show
|
||||
base = QboInvoice.get_base
|
||||
invoice = base.fetch_by_id(params[:id])
|
||||
@pdf = base.pdf(invoice)
|
||||
send_data @pdf, filename: "invoice #{invoice.doc_number}.pdf", :disposition => 'inline', :type => "application/pdf"
|
||||
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)
|
||||
|
||||
send_data pdf, filename: "invoice #{ref}.pdf", disposition: :inline, type: "application/pdf"
|
||||
|
||||
rescue StandardError => e
|
||||
log "Invoice PDF failure: #{e.message}"
|
||||
redirect_back fallback_location: root_path, flash: { error: I18n.t(:notice_invoice_not_found) }
|
||||
end
|
||||
|
||||
def sync
|
||||
Invoice.sync
|
||||
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Logs messages with a consistent prefix for easier debugging.
|
||||
def log(msg)
|
||||
Rails.logger.info "[InvoiceController] #{msg}"
|
||||
end
|
||||
end
|
||||
@@ -1,94 +0,0 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2022 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#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.
|
||||
|
||||
# This controller class will handle map management
|
||||
class LineItemsController < ApplicationController
|
||||
unloadable
|
||||
|
||||
include AuthHelper
|
||||
|
||||
before_action :require_user
|
||||
|
||||
# display all line items for an issue
|
||||
def index
|
||||
if params[:issue_id]
|
||||
begin
|
||||
@line_items = Issue.find_by_id(params[:issue_id]).line_items
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
render_404
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# return an HTML form for creating a new line item
|
||||
def new
|
||||
@line_item = LineItem.new
|
||||
end
|
||||
|
||||
# create a new line item
|
||||
def create
|
||||
@line_item = LineItem.new(params[:line_item])
|
||||
if @line_item.save
|
||||
flash[:notice] = "New Line Item Created"
|
||||
redirect_to @line_item.issue
|
||||
else
|
||||
flash[:error] = @line_item.errors.full_messages.to_sentence
|
||||
redirect_to new_line_item_path
|
||||
end
|
||||
end
|
||||
|
||||
# display a specific line item
|
||||
def show
|
||||
begin
|
||||
@line_item = LineItem.find_by_id(params[:id])
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
render_404
|
||||
end
|
||||
end
|
||||
|
||||
# return an HTML form for editing a line item
|
||||
def edit
|
||||
begin
|
||||
@line_item = LineItem.find_by_id(params[:id])
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
render_404
|
||||
end
|
||||
end
|
||||
|
||||
# update a specific line item
|
||||
def update
|
||||
begin
|
||||
@line_item = LineItem.find_by_id(params[:id])
|
||||
if @line_item.update_attributes(params[:line_item])
|
||||
flash[:notice] = "Line Item updated"
|
||||
redirect_to @line_item
|
||||
else
|
||||
flash[:error] = @line_item.errors.full_messages.to_sentence if @line_item.errors
|
||||
redirect_to edit_line_item_path
|
||||
end
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
render_404
|
||||
end
|
||||
end
|
||||
|
||||
# delete a specific line item
|
||||
def destroy
|
||||
begin
|
||||
line_item = LineItem.find_by_id(params[:id])
|
||||
issue = line_item.issue
|
||||
line_item.destroy
|
||||
flash[:notice] = "Line Item deleted successfully"
|
||||
redirect_to issue
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
render_404
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
@@ -1,57 +0,0 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2022 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#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 PaymentsController < ApplicationController
|
||||
unloadable
|
||||
|
||||
include AuthHelper
|
||||
|
||||
before_action :check_permissions
|
||||
|
||||
def new
|
||||
@payment = Payment.new
|
||||
|
||||
@customers = Customer.all.sort_by &:name
|
||||
|
||||
@accounts = Qbo.get_base(:account).query("SELECT Id, Name FROM Account WHERE AccountType = 'Bank' Order By Name")
|
||||
|
||||
@payment_methods = Qbo.get_base(:payment_method).all
|
||||
end
|
||||
|
||||
def create
|
||||
@payment = Payment.new(params[:payment])
|
||||
if @payment.save
|
||||
flash[:notice] = "Payment Saved"
|
||||
redirect_to Customer.find_by_id(@payment.customer_id)
|
||||
else
|
||||
flash[:error] = @payment.errors.full_messages.to_sentence
|
||||
redirect_to new_customer_path
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def check_permissions
|
||||
if !allowed_to?(:add_payments)
|
||||
render :file => "public/401.html.erb", :status => :unauthorized, :layout =>true
|
||||
end
|
||||
end
|
||||
|
||||
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
|
||||
|
||||
end
|
||||
@@ -1,6 +1,6 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2022 rick barrette
|
||||
#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:
|
||||
#
|
||||
@@ -9,169 +9,72 @@
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class QboController < ApplicationController
|
||||
unloadable
|
||||
|
||||
require 'openssl'
|
||||
|
||||
include AuthHelper
|
||||
|
||||
before_action :require_user, :except => :qbo_webhook
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, :only => [:qbo_webhook]
|
||||
before_action :require_user, except: :webhook
|
||||
skip_before_action :verify_authenticity_token, :check_if_login_required, only: :webhook
|
||||
|
||||
def allowed_params
|
||||
params.permit(:code, :state, :realmId, :id)
|
||||
end
|
||||
|
||||
#
|
||||
# Called when the QBO Top Menu us shown
|
||||
#
|
||||
def index
|
||||
@qbo = Qbo.first
|
||||
@customer_count = Customer.count
|
||||
@qbo_item_count = QboItem.count
|
||||
@qbo_employee_count = QboEmployee.count
|
||||
@qbo_invoice_count = QboInvoice.count
|
||||
@qbo_estimate_count = QboEstimate.count
|
||||
end
|
||||
|
||||
#
|
||||
# Called when the user requests that Redmine to connect to QBO
|
||||
#
|
||||
# Initiates the OAuth authentication process by redirecting the user to the QuickBooks authorization URL. The callback URL is generated based on the application's settings and routes.
|
||||
def authenticate
|
||||
oauth2_client = Qbo.get_client
|
||||
callback = Setting.host_name + "/qbo/oauth_callback/"
|
||||
#callback = qbo_oauth_callback_url
|
||||
grant_url = oauth2_client.auth_code.authorize_url(redirect_uri: callback, response_type: "code", state: SecureRandom.hex(12), scope: "com.intuit.quickbooks.accounting")
|
||||
redirect_to grant_url
|
||||
redirect_to QboOauthService.authorization_url(callback_url: callback_url)
|
||||
end
|
||||
|
||||
#
|
||||
# Called by QBO after authentication has been processed
|
||||
#
|
||||
# Handles the OAuth callback from QuickBooks. Exchanges the authorization code for access and refresh tokens, saves the connection details, and redirects to the sync page with a success notice. If any error occurs during the process, logs the error and redirects back to the plugin settings page with an error message.
|
||||
def oauth_callback
|
||||
if params[:state].present?
|
||||
oauth2_client = Qbo.get_client
|
||||
# use the state value to retrieve from your backend any information you need to identify the customer in your system
|
||||
#redirect_uri = qbo_oauth_callback_url
|
||||
redirect_uri = Setting.host_name + "/qbo/oauth_callback/"
|
||||
if resp = oauth2_client.auth_code.get_token(params[:code], redirect_uri: redirect_uri)
|
||||
QboOauthService.exchange!(code: params[:code], callback_url: callback_url, realm_id: params[:realmId])
|
||||
|
||||
# Remove the last authentication information
|
||||
Qbo.delete_all
|
||||
redirect_to qbo_sync_path, flash: { notice: I18n.t(:label_connected) }
|
||||
|
||||
# Save the authentication information
|
||||
qbo = Qbo.new
|
||||
qbo.company_id = params[:realmId]
|
||||
|
||||
# Generate Access Token & Serialize it into the database
|
||||
access_token = OAuth2::AccessToken.new(oauth2_client, resp.token, refresh_token: resp.refresh_token)
|
||||
qbo.token = access_token.to_hash
|
||||
qbo.expire = 1.hour.from_now.utc
|
||||
|
||||
if qbo.save!
|
||||
redirect_to qbo_sync_path, :flash => { :notice => "Successfully connected to Quickbooks" }
|
||||
else
|
||||
redirect_to plugin_settings_path(:redmine_qbo), :flash => { :error => "Error" }
|
||||
rescue StandardError => e
|
||||
log "OAuth failure: #{e.message}"
|
||||
redirect_to plugin_settings_path(:redmine_qbo), flash: { error: I18n.t(:label_error) }
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# Manual Billing
|
||||
# Manual billing endpoint to trigger the billing process for a specific issue. Validates the issue and its associations, enqueues a job to bill the issue's time entries, and redirects back to the issue with a notice. If validation fails, redirects back with an error message.
|
||||
def bill
|
||||
i = Issue.find_by_id params[:id]
|
||||
if i.customer
|
||||
i.bill_time
|
||||
redirect_to i, :flash => { :notice => "Successfully Billed #{i.customer.name}" }
|
||||
else
|
||||
redirect_to i, :flash => { :error => "Cannot bill without a customer assigned" }
|
||||
end
|
||||
issue = Issue.find_by(id: params[:id])
|
||||
raise I18n.t(:notice_error_issue_not_found) unless issue
|
||||
raise I18n.t(:notice_billing_error_no_customer) unless issue.customer
|
||||
raise I18n.t(:notice_billing_error_no_employee) unless issue.assigned_to&.employee_id.present?
|
||||
raise I18n.t(:notice_billing_error_no_qbo) unless Qbo.exists?
|
||||
|
||||
BillIssueTimeJob.perform_later(issue.id)
|
||||
|
||||
redirect_to issue, flash: { notice: "#{I18n.t(:label_billing_enqueued)} #{issue.customer.name}"}
|
||||
|
||||
rescue StandardError => e
|
||||
redirect_to issue || root_path, flash: { error: e.message }
|
||||
end
|
||||
|
||||
# Quickbooks Webhook Callback
|
||||
def qbo_webhook
|
||||
|
||||
logger.info "Quickbooks is calling webhook"
|
||||
|
||||
# check the payload
|
||||
signature = request.headers['intuit-signature']
|
||||
key = Setting.plugin_redmine_qbo['settingsWebhookToken']
|
||||
data = request.body.read
|
||||
hash = Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::Digest.new('sha256'), key, data)).strip()
|
||||
|
||||
# proceed if the request is good
|
||||
if hash.eql? signature
|
||||
if request.headers['content-type'] == 'application/json'
|
||||
data = JSON.parse(data)
|
||||
else
|
||||
# application/x-www-form-urlencoded
|
||||
data = params.as_json
|
||||
end
|
||||
# Process the information
|
||||
entities = data['eventNotifications'][0]['dataChangeEvent']['entities']
|
||||
entities.each do |entity|
|
||||
id = entity['id'].to_i
|
||||
name = entity['name']
|
||||
|
||||
# TODO rename all other models!
|
||||
name.prepend("Qbo") if not name.eql? "Customer"
|
||||
|
||||
logger.debug "Casting #{name.constantize} to obj"
|
||||
|
||||
# Magicly initialize the correct class
|
||||
obj = name.constantize
|
||||
|
||||
# for merge events
|
||||
obj.destroy(entity['deletedId']) if entity['deletedId']
|
||||
|
||||
#Check to see if we are deleting a record
|
||||
if entity['operation'].eql? "Delete"
|
||||
obj.destroy(id)
|
||||
#if not then update!
|
||||
else
|
||||
begin
|
||||
obj.sync_by_id(id)
|
||||
rescue => e
|
||||
logger.error "Failed to call sync_by_id on obj"
|
||||
logger.error e.message
|
||||
logger.error e.backtrace.join("\n")
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# Record that last time we updated
|
||||
Qbo.update_time_stamp
|
||||
|
||||
# The webhook doesn't require a response but let's make sure we don't send anything
|
||||
render :nothing => true
|
||||
else
|
||||
render nothing: true, status: 400
|
||||
end
|
||||
|
||||
logger.info "Quickbooks webhook complete"
|
||||
end
|
||||
|
||||
#
|
||||
# Synchronizes the QboCustomer table with QBO
|
||||
#
|
||||
# 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
|
||||
logger.info "Syncing EVERYTHING"
|
||||
# Update info in background
|
||||
Thread.new do
|
||||
if Qbo.exists?
|
||||
Customer.sync
|
||||
QboInvoice.sync
|
||||
QboItem.sync
|
||||
QboEmployee.sync
|
||||
QboEstimate.sync
|
||||
full_sync = ActiveModel::Type::Boolean.new.cast(params[:full_sync])
|
||||
QboSyncDispatcher.sync!(full_sync: full_sync)
|
||||
|
||||
# Record the last sync time
|
||||
Qbo.update_time_stamp
|
||||
end
|
||||
ActiveRecord::Base.connection.close
|
||||
redirect_to :home, flash: { notice: I18n.t(:label_syncing) }
|
||||
end
|
||||
|
||||
redirect_to :home, :flash => { :notice => "Successfully synced to Quickbooks" }
|
||||
# Endpoint to receive QuickBooks webhook notifications. Validates the request and processes the payload to sync relevant data to Redmine. Responds with appropriate HTTP status codes based on success or failure of processing.
|
||||
def webhook
|
||||
QboWebhookProcessor.process!(request: request)
|
||||
head :ok
|
||||
|
||||
rescue StandardError => e
|
||||
log "Webhook failure: #{e.message}"
|
||||
head :unauthorized
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Constructs the OAuth callback URL based on the application's settings and routes. This URL is used during the OAuth flow to redirect users back to the application after authentication with QuickBooks.
|
||||
def callback_url
|
||||
"#{Setting.protocol}://#{Setting.host_name}#{qbo_oauth_callback_path}"
|
||||
end
|
||||
|
||||
# Logs messages with a consistent prefix for easier debugging and monitoring.
|
||||
def log(msg)
|
||||
Rails.logger.info "[QboController] #{msg}"
|
||||
end
|
||||
end
|
||||
@@ -1,126 +0,0 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2022 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#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.
|
||||
|
||||
# This controller class will handle map management
|
||||
class VehiclesController < ApplicationController
|
||||
unloadable
|
||||
|
||||
include AuthHelper
|
||||
|
||||
before_action :require_user
|
||||
|
||||
def allowed_params
|
||||
params.require(:vehicle).permit(:year, :make, :model, :customer_id, :notes, :vin)
|
||||
end
|
||||
|
||||
# display a list of all vehicles
|
||||
def index
|
||||
if params[:customer_id]
|
||||
begin
|
||||
@vehicles = Customer.find_by_id(params[:customer_id]).vehicles.paginate(:page => params[:page])
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
render_404
|
||||
end
|
||||
end
|
||||
|
||||
# search for a vehicle by vin
|
||||
if params[:search]
|
||||
@vehicles = Vehicle.search(params[:search]).paginate(:page => params[:page])
|
||||
if only_one_non_zero?(@vehicles)
|
||||
redirect_to @vehicles.first
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# return an HTML form for creating a new vehicle
|
||||
def new
|
||||
@vehicle = Vehicle.new
|
||||
@customer = Customer.find_by_id(params[:customer_id]) if params[:customer_id]
|
||||
end
|
||||
|
||||
# create a new vehicle
|
||||
def create
|
||||
@vehicle = Vehicle.new(allowed_params)
|
||||
if @vehicle.save
|
||||
flash[:notice] = "New Vehicle Created"
|
||||
redirect_to @vehicle
|
||||
else
|
||||
flash[:error] = @vehicle.errors.full_messages.to_sentence
|
||||
redirect_to Vehicle.find_by_vin @vehicle.vin
|
||||
end
|
||||
end
|
||||
|
||||
# display a specific vehicle
|
||||
def show
|
||||
begin
|
||||
@vehicle = Vehicle.find_by_id(params[:id])
|
||||
@vin = @vehicle.vin.scan(/.{1,9}/) if @vehicle.vin
|
||||
@issues = @vehicle.issues.order(id: :desc)
|
||||
@closed_issues = (@issues - @issues.open)
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
render_404
|
||||
end
|
||||
end
|
||||
|
||||
# return an HTML form for editing a vehicle
|
||||
def edit
|
||||
begin
|
||||
@vehicle = Vehicle.find_by_id(params[:id])
|
||||
@customer = @vehicle.customer
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
render_404
|
||||
end
|
||||
end
|
||||
|
||||
# update a specific vehicle
|
||||
def update
|
||||
@customer = params[:customer]
|
||||
begin
|
||||
@vehicle = Vehicle.find_by_id(params[:id])
|
||||
if @vehicle.update_attributes(allowed_params)
|
||||
flash[:notice] = "Vehicle updated"
|
||||
redirect_to @vehicle
|
||||
else
|
||||
redirect_to edit_vehicle_path
|
||||
end
|
||||
#show any errors anyways
|
||||
flash[:error] = @vehicle.errors.full_messages.to_sentence unless @vehicle.errors.empty?
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
render_404
|
||||
end
|
||||
end
|
||||
|
||||
# delete a specific vehicle
|
||||
def destroy
|
||||
begin
|
||||
Vehicle.find_by_id(params[:id]).destroy
|
||||
flash[:notice] = "Vehicle deleted successfully"
|
||||
redirect_to action: :index
|
||||
rescue ActiveRecord::RecordNotFound
|
||||
render_404
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# checks to see if there is only one item in an array
|
||||
# @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
|
||||
|
||||
end
|
||||
@@ -1,6 +1,6 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2017 rick barrette
|
||||
#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:
|
||||
#
|
||||
@@ -13,7 +13,8 @@ module AuthHelper
|
||||
def require_user
|
||||
return unless session[:token].nil?
|
||||
if !User.current.logged?
|
||||
render :file => "public/401.html.erb", :status => :unauthorized, :layout =>true
|
||||
flash[:error] = t :notice_forbidden
|
||||
render_403
|
||||
end
|
||||
end
|
||||
|
||||
@@ -27,14 +28,16 @@ module AuthHelper
|
||||
|
||||
def check_permission(permission)
|
||||
if !allowed_to?(permission)
|
||||
render :file => "public/401.html.erb", :status => :unauthorized, :layout =>true
|
||||
flash[:error] = t :notice_forbidden
|
||||
render_403
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
def global_check_permission(permission)
|
||||
if !globaly_allowed_to?(permission)
|
||||
render :file => "public/401.html.erb", :status => :unauthorized, :layout =>true
|
||||
flash[:error] = t :notice_forbidden
|
||||
render_403
|
||||
end
|
||||
end
|
||||
|
||||
|
||||
112
app/jobs/bill_issue_time_job.rb
Normal file
@@ -0,0 +1,112 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class BillIssueTimeJob < ActiveJob::Base
|
||||
queue_as :default
|
||||
retry_on StandardError, wait: 5.minutes, attempts: 5
|
||||
|
||||
# Perform billing of unbilled time entries for a given issue by creating corresponding TimeActivity records in QuickBooks Online, and then marking those entries as billed in Redmine. This job is typically triggered after an invoice is created or updated to ensure all relevant time is captured for billing.
|
||||
def perform(issue_id)
|
||||
issue = Issue.find(issue_id)
|
||||
|
||||
log "Starting billing for issue ##{issue.id}"
|
||||
issue.with_lock do
|
||||
unbilled_entries = issue.time_entries.where(billed: [false, nil]).lock
|
||||
return if unbilled_entries.blank?
|
||||
|
||||
totals = aggregate_hours(unbilled_entries)
|
||||
return if totals.blank?
|
||||
log "Aggregated hours for billing: #{totals.inspect}"
|
||||
|
||||
qbo = QboConnectionService.current!
|
||||
qbo.perform_authenticated_request do |access_token|
|
||||
create_time_activities(issue, totals, access_token, qbo)
|
||||
end
|
||||
|
||||
# Only mark billed AFTER successful QBO creation
|
||||
unbilled_entries.update_all(billed: true)
|
||||
end
|
||||
|
||||
log "Completed billing for issue ##{issue.id}"
|
||||
Qbo.update_time_stamp
|
||||
rescue => e
|
||||
log "Billing failed for issue ##{issue_id} - #{e.message}"
|
||||
raise e
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Aggregate time entries by activity name and sum their hours
|
||||
def aggregate_hours(entries)
|
||||
entries.includes(:activity)
|
||||
.group_by { |e| e.activity&.name }
|
||||
.transform_values { |rows| rows.sum(&:hours) }
|
||||
.compact
|
||||
end
|
||||
|
||||
# Create TimeActivity records in QBO for each activity type with the appropriate hours and link them to the issue's assigned employee and customer
|
||||
def create_time_activities(issue, totals, access_token, qbo)
|
||||
log "Creating TimeActivity records in QBO for issue ##{issue.id}"
|
||||
|
||||
time_service = Quickbooks::Service::TimeActivity.new( company_id: qbo.realm_id, access_token: access_token)
|
||||
item_service = Quickbooks::Service::Item.new( company_id: qbo.realm_id, access_token: access_token )
|
||||
|
||||
totals.each do |activity_name, hours_float|
|
||||
next if activity_name.blank?
|
||||
next if hours_float.to_f <= 0
|
||||
|
||||
item = find_item(item_service, activity_name)
|
||||
next unless item
|
||||
|
||||
hours, minutes = convert_hours(hours_float)
|
||||
|
||||
time_entry = Quickbooks::Model::TimeActivity.new
|
||||
time_entry.description = build_description(issue)
|
||||
time_entry.employee_id = issue.assigned_to.employee_id
|
||||
time_entry.customer_id = issue.customer_id
|
||||
time_entry.billable_status = "Billable"
|
||||
time_entry.hours = hours
|
||||
time_entry.minutes = minutes
|
||||
time_entry.name_of = "Employee"
|
||||
time_entry.txn_date = Date.today
|
||||
time_entry.hourly_rate = item.unit_price
|
||||
time_entry.item_id = item.id
|
||||
|
||||
log "Creating TimeActivity for #{activity_name} (#{hours}h #{minutes}m)"
|
||||
|
||||
time_service.create(time_entry)
|
||||
end
|
||||
end
|
||||
|
||||
# Convert a decimal hours float into separate hours and minutes components for QBO TimeActivity
|
||||
def convert_hours(hours_float)
|
||||
total_minutes = (hours_float.to_f * 60).round
|
||||
hours = total_minutes / 60
|
||||
minutes = total_minutes % 60
|
||||
[hours, minutes]
|
||||
end
|
||||
|
||||
# Build a descriptive string for the TimeActivity based on the issue's tracker, ID, subject, and completion status
|
||||
def build_description(issue)
|
||||
base = "#{issue.tracker} ##{issue.id}: #{issue.subject}"
|
||||
return base if issue.closed?
|
||||
"#{base} (Partial @ #{issue.done_ratio}%)"
|
||||
end
|
||||
|
||||
# Find an item in QBO by name, escaping single quotes to prevent query issues. Returns nil if not found.
|
||||
def find_item(item_service, name)
|
||||
safe = name.gsub("'", "\\\\'")
|
||||
item_service.query("SELECT * FROM Item WHERE Name = '#{safe}'").first
|
||||
end
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[BillIssueTimeJob] #{msg}"
|
||||
end
|
||||
end
|
||||
@@ -1,6 +1,6 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2022 rick barrette
|
||||
#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:
|
||||
#
|
||||
@@ -8,35 +8,42 @@
|
||||
#
|
||||
#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 QboEmployee < ActiveRecord::Base
|
||||
unloadable
|
||||
has_many :users
|
||||
#attr_accessible :name
|
||||
validates_presence_of :id, :name
|
||||
class QboSyncDispatcher
|
||||
|
||||
def self.get_base
|
||||
Qbo.get_base(:employee)
|
||||
SYNC_JOBS = [
|
||||
Customer,
|
||||
Estimate,
|
||||
Invoice,
|
||||
Employee
|
||||
].freeze
|
||||
|
||||
# Dispatches all synchronization jobs to perform a full sync of QuickBooks entities with the local database.
|
||||
# Each job is enqueued with the `full_sync` flag set to true.
|
||||
def self.sync!(full_sync: false)
|
||||
log "Manual Sync initated for #{full_sync ? "full sync" : "incremental sync"}"
|
||||
enque_jobs full_sync: full_sync
|
||||
end
|
||||
|
||||
def self.sync
|
||||
employees = get_base.all
|
||||
private
|
||||
|
||||
transaction do
|
||||
# Update the item table
|
||||
employees.each { |employee|
|
||||
qbo_employee = find_or_create_by(id: employee.id)
|
||||
qbo_employee.name = employee.display_name
|
||||
qbo_employee.id = employee.id
|
||||
qbo_employee.save!
|
||||
}
|
||||
# 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
|
||||
|
||||
def self.sync_by_id(id)
|
||||
employee = get_base.fetch_by_id(id)
|
||||
qbo_employee = find_or_create_by(id: employee.id)
|
||||
qbo_employee.name = employee.display_name
|
||||
qbo_employee.id = employee.id
|
||||
qbo_employee.save!
|
||||
jobs.each { |job| QboSyncJob.perform_later(entity: job, full_sync: full_sync) }
|
||||
end
|
||||
|
||||
def self.log(msg)
|
||||
Rails.logger.info "[QboSyncDispatcher] #{msg}"
|
||||
end
|
||||
|
||||
end
|
||||
@@ -1,6 +1,6 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2022 rick barrette
|
||||
#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:
|
||||
#
|
||||
@@ -8,40 +8,31 @@
|
||||
#
|
||||
#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 QboItem < ActiveRecord::Base
|
||||
unloadable
|
||||
has_many :issues
|
||||
#attr_accessible :name
|
||||
validates_presence_of :id, :name
|
||||
class QboSyncJob < ApplicationJob
|
||||
queue_as :default
|
||||
retry_on StandardError, wait: 5.minutes, attempts: 5
|
||||
|
||||
self.primary_key = :id
|
||||
# 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, entity: nil, doc_number: nil)
|
||||
raise "An entity to sync is required" unless entity
|
||||
@entity = entity
|
||||
|
||||
def self.get_base
|
||||
Qbo.get_base(:item)
|
||||
end
|
||||
log "Starting #{full_sync ? 'full' : 'incremental'} sync for #{entity} ##{id || doc_number || 'all'}..."
|
||||
service = "#{entity}SyncService".constantize.new
|
||||
|
||||
def self.sync
|
||||
last = Qbo.first.last_sync
|
||||
|
||||
query = "SELECT Id, Name FROM Item WHERE Type = 'Service' "
|
||||
query << " AND Metadata.LastUpdatedTime >= '#{last.iso8601}' " if last
|
||||
|
||||
if count == 0
|
||||
items = get_base.all
|
||||
if id.present?
|
||||
service.sync_by_id(id)
|
||||
elsif doc_number.present?
|
||||
service.sync_by_doc_number(doc_number)
|
||||
else
|
||||
items = get_base.query(query)
|
||||
service.sync(full_sync: full_sync)
|
||||
end
|
||||
end
|
||||
|
||||
unless items.count = 0
|
||||
items.find_by(:type, "Service").each { |i|
|
||||
qbo_item = QboItem.find_or_create_by(id: i.id)
|
||||
qbo_item.name = i.name
|
||||
qbo_item.id = i.id
|
||||
qbo_item.save
|
||||
}
|
||||
end
|
||||
private
|
||||
|
||||
# QboItem.where.not(items.map(&:id)).destroy_all
|
||||
# Log messages with the entity type for better traceability
|
||||
def log(msg)
|
||||
Rails.logger.info "[#{@entity}SyncJob] #{msg}"
|
||||
end
|
||||
|
||||
end
|
||||
42
app/jobs/qbo_webhook_processor.rb
Normal file
@@ -0,0 +1,42 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class QboWebhookProcessor
|
||||
|
||||
# Processes the incoming QuickBooks webhook request by validating the signature and enqueuing a background job to handle the webhook payload. Raises an error if the signature is invalid.
|
||||
def self.process!(request:)
|
||||
body = request.raw_post
|
||||
signature = request.headers['intuit-signature']
|
||||
secret = RedmineQbo.webhook_token_secret
|
||||
|
||||
raise "Invalid signature" unless valid_signature?(body, signature, secret)
|
||||
|
||||
WebhookProcessJob.perform_later(body)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Validates the QuickBooks webhook request by computing the HMAC signature and comparing it to the provided signature. Returns false if either the signature or secret is blank, or if the computed signature does not match the provided signature.
|
||||
def self.valid_signature?(body, signature, secret)
|
||||
return false if signature.blank? || secret.blank?
|
||||
log "Validating signature"
|
||||
|
||||
digest = OpenSSL::Digest.new('sha256')
|
||||
computed = Base64.strict_encode64(
|
||||
OpenSSL::HMAC.digest(digest, secret, body)
|
||||
)
|
||||
|
||||
ActiveSupport::SecurityUtils.secure_compare(computed, signature)
|
||||
end
|
||||
|
||||
def self.log(msg)
|
||||
Rails.logger.info "[QboWebhookProcessor] #{msg}"
|
||||
end
|
||||
end
|
||||
77
app/jobs/webhook_process_job.rb
Normal file
@@ -0,0 +1,77 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class WebhookProcessJob < ActiveJob::Base
|
||||
queue_as :default
|
||||
retry_on StandardError, wait: 5.minutes, attempts: 5
|
||||
|
||||
ALLOWED_ENTITIES = %w[
|
||||
Customer
|
||||
Invoice
|
||||
Estimate
|
||||
Employee
|
||||
].freeze
|
||||
|
||||
# Process incoming QBO webhook notifications and sync relevant data to Redmine
|
||||
def perform(raw_body)
|
||||
log "Received webhook: #{raw_body}"
|
||||
data = JSON.parse(raw_body)
|
||||
|
||||
data.fetch('eventNotifications', []).each do |notification|
|
||||
entities = notification.dig('dataChangeEvent', 'entities') || []
|
||||
|
||||
entities.each do |entity|
|
||||
process_entity(entity)
|
||||
end
|
||||
end
|
||||
|
||||
Qbo.update_time_stamp
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Process a single entity from the webhook payload and sync it to Redmine if it's an allowed type
|
||||
def process_entity(entity)
|
||||
log "Processing entity: #{entity}"
|
||||
name = entity['name']
|
||||
id = entity['id']&.to_i
|
||||
|
||||
entities = ALLOWED_ENTITIES.dup
|
||||
# Allow other plugins to add addtional qbo entities via Hooks
|
||||
Redmine::Hook.call_hook( :qbo_additional_entities ).each do |context|
|
||||
next unless context
|
||||
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
|
||||
return unless model
|
||||
|
||||
if entity['deletedId']
|
||||
model.delete(entity['deletedId'])
|
||||
return
|
||||
end
|
||||
|
||||
if entity['operation'] == "Delete"
|
||||
model.delete(id)
|
||||
else
|
||||
model.sync_by_id(id)
|
||||
end
|
||||
rescue => e
|
||||
log "#{e.message}"
|
||||
end
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[WebhookProcessJob] #{msg}"
|
||||
end
|
||||
end
|
||||
98
app/models/concerns/quickbooks_oauth.rb
Normal file
@@ -0,0 +1,98 @@
|
||||
#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.
|
||||
|
||||
module QuickbooksOauth
|
||||
extend ActiveSupport::Concern
|
||||
|
||||
#== Instance Methods
|
||||
|
||||
# This method will attempt to execute the block and if it encounters an OAuth2::Error or Quickbooks::AuthorizationFailure it will attempt to refresh the token and retry the block. It will try this up to 3 times before giving up and raising an exception.
|
||||
def perform_authenticated_request(&block)
|
||||
attempts = 0
|
||||
begin
|
||||
yield oauth_access_token
|
||||
rescue OAuth2::Error, Quickbooks::AuthorizationFailure => ex
|
||||
log "perform_authenticated_request: #{ex.message}"
|
||||
|
||||
# to prevent an infinite loop here keep a counter and bail out after N times...
|
||||
attempts += 1
|
||||
|
||||
raise "QuickbooksOauth:ExceededAuthAttempts" if attempts >= 3
|
||||
|
||||
# check if its an invalid_grant first, but assume it is for now
|
||||
refresh_token!
|
||||
|
||||
retry
|
||||
end
|
||||
end
|
||||
|
||||
# This method will attempt to refresh the access token and update the record with the new access token, refresh token and their respective expiration times. If the refresh token expires in more than 0 seconds then we will set the refresh token expiration time to that value, otherwise we will set it to 100 days from now.
|
||||
def refresh_token!
|
||||
log "refresh_token!"
|
||||
t = oauth_access_token
|
||||
refreshed = t.refresh!
|
||||
|
||||
if refreshed.params['x_refresh_token_expires_in'].to_i > 0
|
||||
oauth2_refresh_token_expires_at = Time.now + refreshed.params['x_refresh_token_expires_in'].to_i.seconds
|
||||
else
|
||||
oauth2_refresh_token_expires_at = 100.days.from_now
|
||||
end
|
||||
|
||||
log "refresh_token!: #{oauth2_refresh_token_expires_at}"
|
||||
|
||||
update!(
|
||||
oauth2_access_token: refreshed.token,
|
||||
oauth2_access_token_expires_at: Time.at(refreshed.expires_at),
|
||||
oauth2_refresh_token: refreshed.refresh_token,
|
||||
oauth2_refresh_token_expires_at: oauth2_refresh_token_expires_at
|
||||
)
|
||||
end
|
||||
|
||||
# This method will return an instance of the OAuth2::Client class that is configured with the consumer key, consumer secret and the appropriate URLs for the Intuit OAuth2 service. It will also set the sandbox mode based on the plugin settings.
|
||||
def oauth_client
|
||||
self.class.construct_oauth2_client
|
||||
end
|
||||
|
||||
# This method will return an instance of the OAuth2::AccessToken class that is configured with the current access token, refresh token and the OAuth2 client. This access token can be used to make authenticated requests to the Intuit API.
|
||||
def oauth_access_token
|
||||
OAuth2::AccessToken.new(oauth_client, oauth2_access_token, refresh_token: oauth2_refresh_token)
|
||||
end
|
||||
|
||||
# This method is an alias for the oauth_access_token method and is used to provide a more intuitive name for the access token when making authenticated requests.
|
||||
def consumer
|
||||
oauth_access_token
|
||||
end
|
||||
|
||||
module ClassMethods
|
||||
|
||||
# This method will construct and return an instance of the OAuth2::Client class that is configured with the consumer key, consumer secret and the appropriate URLs for the Intuit OAuth2 service. It will also set the sandbox mode based on the plugin settings. This method is used by the instance method oauth_client to create a new OAuth2 client for each instance of the model that includes this concern.
|
||||
def construct_oauth2_client
|
||||
|
||||
# Are we are playing in the sandbox?
|
||||
Quickbooks.sandbox_mode = RedmineQbo.sandbox_mode?
|
||||
log "Sandbox mode: #{Quickbooks.sandbox_mode}"
|
||||
|
||||
options = {
|
||||
site: "https://appcenter.intuit.com/connect/oauth2",
|
||||
authorize_url: "https://appcenter.intuit.com/connect/oauth2",
|
||||
token_url: "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer"
|
||||
}
|
||||
OAuth2::Client.new(RedmineQbo.oauth_consumer_key, RedmineQbo.oauth_consumer_secret, options)
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
|
||||
private
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[QuickbooksOauth] #{msg}"
|
||||
end
|
||||
end
|
||||
@@ -1,6 +1,6 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2022 rick barrette
|
||||
#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:
|
||||
#
|
||||
@@ -8,213 +8,111 @@
|
||||
#
|
||||
#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
|
||||
unloadable
|
||||
class Customer < QboBaseModel
|
||||
|
||||
include Redmine::Acts::Searchable
|
||||
include Redmine::Acts::Event
|
||||
|
||||
has_many :issues
|
||||
has_many :qbo_purchases
|
||||
has_many :qbo_invoices
|
||||
has_many :qbo_estimates
|
||||
has_many :vehicles
|
||||
|
||||
#attr_accessible :name, :notes, :email, :primary_phone, :mobile_phone, :phone_number
|
||||
validates_presence_of :id, :name
|
||||
|
||||
has_many :invoices
|
||||
has_many :estimates
|
||||
validates_presence_of :name
|
||||
before_validation :normalize_phone_numbers
|
||||
self.primary_key = :id
|
||||
qbo_sync push: true
|
||||
|
||||
# returns a human readable string
|
||||
def to_s
|
||||
return name
|
||||
end
|
||||
acts_as_searchable columns: %w[name phone_number mobile_phone_number ],
|
||||
scope: ->(_context) { left_joins(:project) },
|
||||
date_column: :updated_at
|
||||
|
||||
# Convenience Method
|
||||
# returns the customer's email
|
||||
acts_as_event :title => Proc.new {|o| "#{o}"},
|
||||
:url => Proc.new {|o| { :controller => 'customers', :action => 'show', :id => o.id} },
|
||||
:type => :to_s,
|
||||
:description => Proc.new {|o| "#{I18n.t :label_primary_phone}: #{o.phone_number} #{I18n.t:label_mobile_phone}: #{o.mobile_phone_number}"},
|
||||
:datetime => Proc.new {|o| o.updated_at || o.created_at}
|
||||
|
||||
# Returns the customer's email address
|
||||
def email
|
||||
pull unless @details
|
||||
begin
|
||||
return @details.email_address.address
|
||||
rescue
|
||||
return nil
|
||||
end
|
||||
return details&.email_address&.address
|
||||
end
|
||||
|
||||
# Convenience Method
|
||||
# Sets the email
|
||||
# Updates the customer's email address
|
||||
def email=(s)
|
||||
pull unless @details
|
||||
@details.email_address = s
|
||||
details.email_address = s
|
||||
end
|
||||
|
||||
# Convenience Method
|
||||
# returns the customer's primary phone
|
||||
def primary_phone
|
||||
pull unless @details
|
||||
begin
|
||||
return @details.primary_phone.free_form_number
|
||||
rescue
|
||||
return nil
|
||||
end
|
||||
# Customers are not bound by a project
|
||||
# but we need to implement this method for the Redmine::Acts::Searchable interface
|
||||
def project
|
||||
nil
|
||||
end
|
||||
|
||||
# Convenience Method
|
||||
# Updates the customer's primary phone number
|
||||
def primary_phone=(n)
|
||||
pull unless @details
|
||||
pn = Quickbooks::Model::TelephoneNumber.new
|
||||
pn.free_form_number = n
|
||||
@details.primary_phone = pn
|
||||
#update our locally stored number too
|
||||
update_phone_number
|
||||
end
|
||||
|
||||
# Convenience Method
|
||||
# returns the customer's mobile phone
|
||||
def mobile_phone
|
||||
pull unless @details
|
||||
begin
|
||||
return @details.mobile_phone.free_form_number
|
||||
rescue
|
||||
return nil
|
||||
end
|
||||
return details&.mobile_phone&.free_form_number
|
||||
end
|
||||
|
||||
# Convenience Method
|
||||
# Updates the custome's mobile phone number
|
||||
def mobile_phone=(n)
|
||||
pull unless @details
|
||||
pn = Quickbooks::Model::TelephoneNumber.new
|
||||
pn.free_form_number = n
|
||||
@details.mobile_phone = pn
|
||||
#update our locally stored number too
|
||||
update_mobile_phone_number
|
||||
details.mobile_phone = pn
|
||||
end
|
||||
|
||||
# update the localy stored phone number as a plain string with no special chars
|
||||
def update_phone_number
|
||||
begin
|
||||
self.phone_number = self.primary_phone.tr('^0-9', '')
|
||||
rescue
|
||||
return nil
|
||||
end
|
||||
end
|
||||
|
||||
# update the localy stored phone number as a plain string with no special chars
|
||||
def update_mobile_phone_number
|
||||
begin
|
||||
self.mobile_phone_number = self.mobile_phone.tr('^0-9', '')
|
||||
rescue
|
||||
return nil
|
||||
end
|
||||
end
|
||||
|
||||
# Convenience Method
|
||||
# Updates Both local DB name & QBO display_name
|
||||
def name=(s)
|
||||
pull unless @details
|
||||
@details.display_name = s
|
||||
details.display_name = s
|
||||
super
|
||||
end
|
||||
|
||||
# Magic Method
|
||||
# Maps Get/Set methods to QBO customer object
|
||||
def method_missing(sym, *arguments)
|
||||
# Check to see if the method exists
|
||||
if Quickbooks::Model::Customer.method_defined?(sym)
|
||||
# download details if required
|
||||
pull unless @details
|
||||
method_name = sym.to_s
|
||||
# Setter
|
||||
if method_name[-1, 1] == "="
|
||||
@details.method(method_name).call(arguments[0])
|
||||
# Getter
|
||||
else
|
||||
return @details.method(method_name).call
|
||||
end
|
||||
end
|
||||
# Normalizes phone numbers by removing non-digit characters. This method is called before validation to ensure that phone numbers are stored in a consistent format, which can help with searching and integration with external systems like QuickBooks Online.
|
||||
def normalize_phone_numbers
|
||||
self.phone_number = phone_number.to_s.gsub(/\D/, '') if phone_number.present?
|
||||
self.mobile_phone_number = mobile_phone_number.to_s.gsub(/\D/, '') if mobile_phone_number.present?
|
||||
end
|
||||
|
||||
# proforms a bruteforce sync operation
|
||||
# This needs to be simplified
|
||||
def self.sync
|
||||
service = Qbo.get_base(:customer)
|
||||
|
||||
# Sync ALL customers if the database is empty
|
||||
#if count == 0
|
||||
customers = service.all
|
||||
#else
|
||||
# last = Qbo.first.last_sync
|
||||
# query = "Select Id, DisplayName From Customer"
|
||||
# query << " Where Metadata.LastUpdatedTime >= '#{last.iso8601}' " if last
|
||||
# customers = service.query(query)
|
||||
#end
|
||||
|
||||
customers.each do |customer|
|
||||
qbo_customer = Customer.find_or_create_by(id: customer.id)
|
||||
if customer.active?
|
||||
if not qbo_customer.name.eql? customer.display_name
|
||||
qbo_customer.name = customer.display_name
|
||||
qbo_customer.id = customer.id
|
||||
qbo_customer.save_without_push
|
||||
end
|
||||
else
|
||||
if not qbo_customer.new_record?
|
||||
qbo_customer.delete
|
||||
end
|
||||
end
|
||||
end
|
||||
# Sets the notes for the customer
|
||||
def notes=(s)
|
||||
details.notes = s
|
||||
end
|
||||
|
||||
# Searchs the database for a customer by name or phone number with out special chars
|
||||
# returns the customer's primary phone
|
||||
def primary_phone
|
||||
return details&.primary_phone&.free_form_number
|
||||
end
|
||||
|
||||
# Updates the customer's primary phone number
|
||||
def primary_phone=(n)
|
||||
pn = Quickbooks::Model::TelephoneNumber.new
|
||||
pn.free_form_number = n
|
||||
details.primary_phone = pn
|
||||
end
|
||||
|
||||
# Seach for customers by name or phone number
|
||||
def self.search(search)
|
||||
customers = where("name LIKE ? OR phone_number LIKE ? OR mobile_phone_number LIKE ?", "%#{search}%", "%#{search}%", "%#{search}%")
|
||||
return customers.order(:name)
|
||||
#return none if search.blank?
|
||||
search = sanitize_sql_like(search)
|
||||
where("name LIKE ? OR phone_number LIKE ? OR mobile_phone_number LIKE ?", "%#{search}%", "%#{search}%", "%#{search}%")
|
||||
end
|
||||
|
||||
# proforms a bruteforce sync operation
|
||||
# This needs to be simplified
|
||||
def self.sync_by_id(id)
|
||||
service = Qbo.get_base(:customer)
|
||||
# Override the defult redmine seach method to rank results by id
|
||||
def self.search_result_ranks_and_ids(tokens, user, project = nil, options = {})
|
||||
return {} if tokens.blank?
|
||||
|
||||
customer = service.fetch_by_id(id)
|
||||
qbo_customer = Customer.find_or_create_by(id: customer.id)
|
||||
if customer.active?
|
||||
if not qbo_customer.name.eql? customer.display_name
|
||||
qbo_customer.name = customer.display_name
|
||||
qbo_customer.id = customer.id
|
||||
qbo_customer.save_without_push
|
||||
end
|
||||
else
|
||||
if not qbo_customer.new_record?
|
||||
qbo_customer.delete
|
||||
end
|
||||
end
|
||||
scope = self.all
|
||||
|
||||
tokens.each do |token|
|
||||
scope = scope.search(token)
|
||||
end
|
||||
|
||||
# Push the updates
|
||||
def save_with_push
|
||||
begin
|
||||
@details = Qbo.get_base(:customer).update(@details)
|
||||
#raise "QBO Fault" if @details.fault?
|
||||
self.id = @details.id
|
||||
rescue Exception => e
|
||||
errors.add(e.message)
|
||||
end
|
||||
save_without_push
|
||||
ids = scope.distinct.limit(options[:limit] || 100).pluck(:id)
|
||||
ids.index_with { |id| id }
|
||||
end
|
||||
|
||||
alias_method :save_without_push, :save
|
||||
alias_method :save, :save_with_push
|
||||
|
||||
private
|
||||
|
||||
# pull the details
|
||||
def pull
|
||||
begin
|
||||
raise Exception unless self.id
|
||||
@details = Qbo.get_base(:customer).fetch_by_id(self.id)
|
||||
rescue Exception => e
|
||||
@details = Quickbooks::Model::Customer.new
|
||||
end
|
||||
# returns a human readable string
|
||||
def to_s
|
||||
last4 = phone_number&.last(4)
|
||||
last4.present? ? "#{name} - #{last4}" : name.to_s
|
||||
end
|
||||
|
||||
end
|
||||
@@ -1,6 +1,6 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2022 rick barrette
|
||||
#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:
|
||||
#
|
||||
@@ -8,16 +8,49 @@
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class CustomerToken < ActiveRecord::Base
|
||||
unloadable
|
||||
has_many :issues
|
||||
#attr_accessible :token, :expires_at, :issue_id
|
||||
validates_presence_of :expires_at, :issue_id
|
||||
before_create :generate_token
|
||||
class CustomerToken < ApplicationRecord
|
||||
belongs_to :issue
|
||||
|
||||
OAUTH_CONSUMER_SECRET = Setting.plugin_redmine_qbo['settingsOAuthConsumerSecret'] || 'CONFIGURE_QBO__' + SecureRandom.uuid
|
||||
validates :issue_id, presence: true
|
||||
validates :token, presence: true, uniqueness: true
|
||||
|
||||
before_validation :generate_token, on: :create
|
||||
before_validation :generate_expire_date, on: :create
|
||||
|
||||
scope :active, -> { where("expires_at > ?", Time.current) }
|
||||
|
||||
TOKEN_EXPIRATION = 1.month
|
||||
|
||||
# Check if the token has expired
|
||||
def expired?
|
||||
expires_at.present? && expires_at <= Time.current
|
||||
end
|
||||
|
||||
# Remove expired tokens from the database
|
||||
def self.remove_expired_tokens
|
||||
where("expires_at <= ?", Time.current).delete_all
|
||||
end
|
||||
|
||||
# Get or create a token for the given issue
|
||||
def self.get_token(issue)
|
||||
return unless issue
|
||||
return unless User.current.allowed_to?(:view_issues, issue.project)
|
||||
|
||||
token = active.find_by(issue_id: issue.id)
|
||||
return token if token
|
||||
|
||||
create!(issue: issue)
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Generate a unique token for the customer
|
||||
def generate_token
|
||||
self.token = SecureRandom.base64(15).tr('+/=lIO0', OAUTH_CONSUMER_SECRET)
|
||||
self.token ||= SecureRandom.urlsafe_base64(32)
|
||||
end
|
||||
|
||||
# Generate an expiration date for the token
|
||||
def generate_expire_date
|
||||
self.expires_at ||= Time.current + TOKEN_EXPIRATION
|
||||
end
|
||||
end
|
||||
18
app/models/employee.rb
Normal file
@@ -0,0 +1,18 @@
|
||||
#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 Employee < QboBaseModel
|
||||
|
||||
has_many :users
|
||||
validates_presence_of :id, :name
|
||||
self.primary_key = :id
|
||||
qbo_sync push: false
|
||||
|
||||
end
|
||||
@@ -1,6 +1,6 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2022 rick barrette
|
||||
#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:
|
||||
#
|
||||
@@ -8,17 +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.
|
||||
|
||||
class CreateVehicles < ActiveRecord::Migration[5.1]
|
||||
class Estimate < QboBaseModel
|
||||
|
||||
def change
|
||||
create_table :vehicles do |t|
|
||||
t.integer :year
|
||||
t.string :make
|
||||
t.string :model
|
||||
t.string :vin
|
||||
t.text :notes
|
||||
has_and_belongs_to_many :issues
|
||||
belongs_to :customer
|
||||
validates_presence_of :doc_number, :id
|
||||
self.primary_key = :id
|
||||
qbo_sync push: false
|
||||
|
||||
# returns a human readable string
|
||||
def to_s
|
||||
return self[:doc_number]
|
||||
end
|
||||
|
||||
add_reference :vehicles, :qbo_customer, index: true
|
||||
# sync only one estimate by document number
|
||||
def self.sync_by_doc_number(number)
|
||||
QboSyncJob.perform_later(entity: model_name.name, doc_number: number)
|
||||
end
|
||||
|
||||
end
|
||||
25
app/models/invoice.rb
Normal file
@@ -0,0 +1,25 @@
|
||||
#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 Invoice < QboBaseModel
|
||||
|
||||
has_and_belongs_to_many :issues
|
||||
belongs_to :customer
|
||||
validates :id, presence: true, uniqueness: true
|
||||
validates :doc_number, :txn_date, presence: true
|
||||
self.primary_key = :id
|
||||
qbo_sync push: false
|
||||
|
||||
# Return the invoice's document number as its string representation
|
||||
def to_s
|
||||
doc_number
|
||||
end
|
||||
|
||||
end
|
||||
@@ -1,34 +0,0 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2022 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#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 LineItem < ActiveRecord::Base
|
||||
|
||||
unloadable
|
||||
|
||||
belongs_to :issue
|
||||
|
||||
#attr_accessible :amount, :description, :unit_price, :quantity, :item_id
|
||||
validates_presence_of :amount, :description, :unit_price, :quantity
|
||||
|
||||
def add_to_invoice(invoice)
|
||||
line_item = Quickbooks::Model::InvoiceLineItem.new
|
||||
line_item.amount = amount
|
||||
line_item.description = description
|
||||
line_item.sales_item! do |detail|
|
||||
detail.unit_price = unit_price
|
||||
detail.quantity = quantity
|
||||
detail.item_id = item_id # Item ID here... Where do i get this???
|
||||
end
|
||||
|
||||
invoice.line_items << line_item
|
||||
|
||||
return invoice
|
||||
end
|
||||
end
|
||||
@@ -1,6 +1,6 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2020 rick barrette
|
||||
#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:
|
||||
#
|
||||
@@ -9,92 +9,51 @@
|
||||
#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 Qbo < ActiveRecord::Base
|
||||
unloadable
|
||||
#validates_presence_of :qb_token, :qb_secret, :company_id, :token_expires_at, :reconnect_token_at
|
||||
validates_presence_of :token, :company_id, :expire
|
||||
serialize :token
|
||||
|
||||
OAUTH_CONSUMER_KEY = Setting.plugin_redmine_qbo['settingsOAuthConsumerKey']
|
||||
OAUTH_CONSUMER_SECRET = Setting.plugin_redmine_qbo['settingsOAuthConsumerSecret']
|
||||
include QuickbooksOauth
|
||||
include Redmine::I18n
|
||||
|
||||
#
|
||||
# Getter for quickbooks OAuth2 client
|
||||
#
|
||||
def self.get_client
|
||||
oauth_params = {
|
||||
site: "https://appcenter.intuit.com/connect/oauth2",
|
||||
authorize_url: "https://appcenter.intuit.com/connect/oauth2",
|
||||
token_url: "https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer"
|
||||
}
|
||||
return OAuth2::Client.new(OAUTH_CONSUMER_KEY, OAUTH_CONSUMER_SECRET, oauth_params)
|
||||
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
|
||||
|
||||
|
||||
#
|
||||
# Getter for oauth consumer
|
||||
#
|
||||
def self.get_oauth_consumer
|
||||
# Quickbooks Config Info
|
||||
return $qb_oauth_consumer
|
||||
def self.oauth2_access_token_expires_at
|
||||
QboConnectionService.current!.oauth2_access_token_expires_at
|
||||
rescue
|
||||
return I18n.t(:label_qbo_never_synced)
|
||||
end
|
||||
|
||||
#
|
||||
# Get a quickbooks base service object for type
|
||||
# @params type of base
|
||||
#
|
||||
def self.get_base(type)
|
||||
# lets getnourbold access token from the database
|
||||
oauth2_client = get_client
|
||||
qbo = self.first
|
||||
access_token = OAuth2::AccessToken.from_hash(oauth2_client, qbo.token)
|
||||
|
||||
# check to see if we need to refresh the acesstoken
|
||||
if qbo.expire.to_time.utc.past?
|
||||
puts "Updating access token"
|
||||
new_access_token_object = access_token.refresh!
|
||||
qbo.token = new_access_token_object.to_hash
|
||||
qbo.expire = 1.hour.from_now.utc
|
||||
qbo.save!
|
||||
access_token = new_access_token_object
|
||||
else
|
||||
puts "Using current token"
|
||||
end
|
||||
|
||||
# build the reqiested service
|
||||
case type
|
||||
when :item
|
||||
return Quickbooks::Service::Item.new(:company_id => qbo.company_id, :access_token => access_token)
|
||||
when :time_activity
|
||||
return Quickbooks::Service::TimeActivity.new(:company_id => qbo.company_id, :access_token => access_token)
|
||||
when :customer
|
||||
return Quickbooks::Service::Customer.new(:company_id => qbo.company_id, :access_token => access_token)
|
||||
when :invoice
|
||||
return Quickbooks::Service::Invoice.new(:company_id => qbo.company_id, :access_token => access_token)
|
||||
when :estimate
|
||||
return Quickbooks::Service::Estimate.new(:company_id => qbo.company_id, :access_token => access_token)
|
||||
when :account
|
||||
return Quickbooks::Service::Account.new(:company_id => qbo.company_id, :access_token => access_token)
|
||||
when :employee
|
||||
return Quickbooks::Service:: Employee.new(:company_id => qbo.company_id, :access_token => access_token)
|
||||
else
|
||||
return access_token
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
# Get the QBO account
|
||||
def self.get_account
|
||||
first
|
||||
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
|
||||
def self.update_time_stamp
|
||||
qbo = Qbo.first
|
||||
qbo.last_sync = DateTime.now
|
||||
date = DateTime.now
|
||||
log "Updating QBO timestamp to #{date}"
|
||||
qbo = QboConnectionService.current!
|
||||
qbo.last_sync = date
|
||||
qbo.save
|
||||
end
|
||||
|
||||
def self.last_sync
|
||||
format_time(Qbo.first.last_sync)
|
||||
private
|
||||
|
||||
# Logs a message with a QBO-specific prefix for easier identification in the logs.
|
||||
def self.log(msg)
|
||||
logger.info "[QBO] #{msg}"
|
||||
end
|
||||
|
||||
# Validates that only one QBO connection record exists in the database. Adds an error if a record already exists.
|
||||
def single_record_only
|
||||
errors.add(:base, "Only one QBO connection allowed") if Qbo.exists?
|
||||
end
|
||||
|
||||
end
|
||||
|
||||
122
app/models/qbo_base_model.rb
Normal file
@@ -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
|
||||
@@ -1,101 +0,0 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2022 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#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 QboEstimate < ActiveRecord::Base
|
||||
unloadable
|
||||
|
||||
has_and_belongs_to_many :issues
|
||||
belongs_to :customer
|
||||
#attr_accessible :doc_number, :id
|
||||
validates_presence_of :doc_number, :id
|
||||
self.primary_key = :id
|
||||
|
||||
# return the QBO Estimate service
|
||||
def self.get_base
|
||||
Qbo.get_base(:estimate)
|
||||
end
|
||||
|
||||
# sync all estimates
|
||||
def self.sync
|
||||
logger.debug "Syncing ALL estimates"
|
||||
estimates = get_base.all
|
||||
estimates.each { |estimate|
|
||||
process_estimate(estimate)
|
||||
}
|
||||
|
||||
#remove deleted estimates
|
||||
where.not(estimates.map(&:id)).destroy_all
|
||||
end
|
||||
|
||||
# sync only one estimate
|
||||
def self.sync_by_id(id)
|
||||
logger.debug "Syncing estimate #{id}"
|
||||
process_estimate(get_base.fetch_by_id(id))
|
||||
end
|
||||
|
||||
# update an estimate
|
||||
def self.update(id)
|
||||
# Update the item table
|
||||
estimate = get_base.fetch_by_id(id)
|
||||
qbo_estimate = find_or_create_by(id: id)
|
||||
qbo_estimate.doc_number = estimate.doc_number
|
||||
qbo_estimate.txn_date = estimate.txn_date
|
||||
qbo_estimate.save!
|
||||
end
|
||||
|
||||
# process an estimate into the database
|
||||
def self.process_estimate(estimate)
|
||||
logger.info "Processing estimate #{estimate.id}"
|
||||
qbo_estimate = find_or_create_by(id: estimate.id)
|
||||
qbo_estimate.doc_number = estimate.doc_number
|
||||
qbo_estimate.customer_id = estimate.customer_ref.value
|
||||
qbo_estimate.id = estimate.id
|
||||
qbo_estimate.txn_date = estimate.txn_date
|
||||
qbo_estimate.save!
|
||||
end
|
||||
|
||||
# download the pdf from quickbooks
|
||||
def pdf
|
||||
base = QboEstimate.get_base
|
||||
estimate = base.fetch_by_id(id)
|
||||
return base.pdf(estimate)
|
||||
end
|
||||
|
||||
# Magic Method
|
||||
# Maps Get/Set methods to QBO estimate object
|
||||
def method_missing(sym, *arguments)
|
||||
# Check to see if the method exists
|
||||
if Quickbooks::Model::Estimate.method_defined?(sym)
|
||||
# download details if required
|
||||
pull unless @details
|
||||
method_name = sym.to_s
|
||||
# Setter
|
||||
if method_name[-1, 1] == "="
|
||||
@details.method(method_name).call(arguments[0])
|
||||
# Getter
|
||||
else
|
||||
return @details.method(method_name).call
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# pull the details
|
||||
def pull
|
||||
begin
|
||||
raise Exception unless self.id
|
||||
@details = Qbo.get_base(:estimate).fetch_by_id(self.id)
|
||||
rescue Exception => e
|
||||
@details = Quickbooks::Model::Estimate.new
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
@@ -1,196 +0,0 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2022 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#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 QboInvoice < ActiveRecord::Base
|
||||
unloadable
|
||||
has_and_belongs_to_many :issues
|
||||
belongs_to :customer
|
||||
validates_presence_of :doc_number, :id, :customer_id, :txn_date
|
||||
self.primary_key = :id
|
||||
|
||||
# Get the quickbooks-ruby base for invoice
|
||||
def self.get_base
|
||||
Qbo.get_base(:invoice)
|
||||
end
|
||||
|
||||
# sync ALL the invoices
|
||||
def self.sync
|
||||
logger.debug "Syncing all invoices"
|
||||
last = Qbo.first.last_sync
|
||||
|
||||
query = "SELECT Id, DocNumber FROM Invoice"
|
||||
query << " WHERE Metadata.LastUpdatedTime >= '#{last.iso8601}' " if last
|
||||
|
||||
# TODO actually do something with the above query
|
||||
# .all() is never called since count is never initialized
|
||||
if count == 0
|
||||
invoices = get_base.all
|
||||
else
|
||||
invoices = get_base.query()
|
||||
end
|
||||
|
||||
invoices.each { | invoice |
|
||||
process_invoice invoice
|
||||
}
|
||||
end
|
||||
|
||||
#sync by invoice ID
|
||||
def self.sync_by_id(id)
|
||||
logger.debug "Syncing invoice #{id}"
|
||||
invoice = get_base.fetch_by_id(id)
|
||||
process_invoice invoice
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Attach the invoice to the issue
|
||||
def self.attach_to_issue(issue, invoice)
|
||||
return if issue.nil?
|
||||
|
||||
# skip this issue if the issue customer is not the same as the invoice customer
|
||||
return if issue.customer_id != invoice.customer_ref.value.to_i
|
||||
|
||||
logger.debug "Attaching invoice #{invoice.id} to issue #{issue.id}"
|
||||
|
||||
qbo_invoice = QboInvoice.find_or_create_by(id: invoice.id)
|
||||
|
||||
unless issue.qbo_invoices.include?(qbo_invoice)
|
||||
issue.qbo_invoices << qbo_invoice
|
||||
issue.save!
|
||||
end
|
||||
|
||||
compare_custom_fields(issue, invoice)
|
||||
end
|
||||
|
||||
# processes the invoice into the database
|
||||
def self.process_invoice(invoice)
|
||||
logger.info "Processing invoice #{invoice.id}"
|
||||
|
||||
# Load the invoice into the database
|
||||
qbo_invoice = QboInvoice.find_or_create_by(id: invoice.id)
|
||||
qbo_invoice.doc_number = invoice.doc_number
|
||||
qbo_invoice.id = invoice.id
|
||||
qbo_invoice.customer_id = invoice.customer_ref
|
||||
qbo_invoice.txn_date = invoice.txn_date
|
||||
qbo_invoice.save!
|
||||
|
||||
# Scan the private notes for hashtags and attach to the applicable issues
|
||||
if not invoice.private_note.nil?
|
||||
invoice.private_note.scan(/#(\w+)/).flatten.each { |issue|
|
||||
attach_to_issue(Issue.find_by_id(issue.to_i), invoice)
|
||||
}
|
||||
end
|
||||
|
||||
# Scan the line items for hashtags and attach to the applicable issues
|
||||
invoice.line_items.each { |line|
|
||||
if line.description
|
||||
line.description.scan(/#(\w+)/).flatten.each { |issue|
|
||||
attach_to_issue(Issue.find_by_id(issue.to_i), invoice)
|
||||
}
|
||||
end
|
||||
}
|
||||
end
|
||||
|
||||
# compares the custome fields on invoices & issues and updates the invoice as needed
|
||||
#
|
||||
# the issue here is when two or more issues share an invoice with the same custom field, but diffrent values
|
||||
# this condions causes an infinite loop as the webhook is called when an invoice is updated
|
||||
# TODO maybe add a cf_sync_confict flag to invoices
|
||||
def self.compare_custom_fields(issue, invoice)
|
||||
logger.debug "Comparing custom fields"
|
||||
# TODO break if QboInvoice.find(invoice.id).cf_sync_confict
|
||||
is_changed = false
|
||||
|
||||
# update the invoive custom fields with infomation from the issue if available
|
||||
invoice.custom_fields.each { |cf|
|
||||
|
||||
# VIN from the attached vehicle
|
||||
# TODO move this into seperate plugin
|
||||
# TODO create hook for seperate plugin
|
||||
begin
|
||||
if cf.name.eql? "VIN"
|
||||
# Only update if blank to prevent infite loops
|
||||
# TODO check cf_sync_confict flag once implemented
|
||||
if cf.string_value.to_s.blank?
|
||||
logger.debug " VIN was blank, updating the invoice vin in quickbooks"
|
||||
vin = Vehicle.find(issue.vehicles_id).vin
|
||||
break if vin.nil?
|
||||
if not cf.string_value.to_s.eql? vin
|
||||
cf.string_value = vin.to_s
|
||||
logger.debug "VIN has changed"
|
||||
is_changed = true
|
||||
end
|
||||
|
||||
end
|
||||
end
|
||||
rescue
|
||||
#do nothing
|
||||
end
|
||||
|
||||
# Custom Values
|
||||
begin
|
||||
value = issue.custom_values.find_by(custom_field_id: CustomField.find_by_name(cf.name).id)
|
||||
|
||||
# Check to see if the value is blank...
|
||||
if not value.value.to_s.blank?
|
||||
# Check to see if the value is diffrent
|
||||
if not cf.string_value.to_s.eql? value.value.to_s
|
||||
# update the custom field on the invoice
|
||||
cf.string_value = value.value.to_s
|
||||
is_changed = true
|
||||
end
|
||||
end
|
||||
rescue
|
||||
# Nothing to do here, there is no match
|
||||
end
|
||||
}
|
||||
|
||||
# Push updates
|
||||
begin
|
||||
logger.debug "Trying to update invoice"
|
||||
get_base.update(invoice) if is_changed
|
||||
rescue
|
||||
# Do nothing, probaly custome field sync confict on the invoice.
|
||||
# This is a problem with how it's billed
|
||||
# TODO Add notes in memo area
|
||||
# TODO flag QboInvoice.cf_sync_confict here
|
||||
logger.error "Failed to update invoice"
|
||||
end
|
||||
end
|
||||
|
||||
# Magic Method
|
||||
# Maps Get/Set methods to QBO invoice object
|
||||
def method_missing(sym, *arguments)
|
||||
# Check to see if the method exists
|
||||
if Quickbooks::Model::Invoice.method_defined?(sym)
|
||||
# download details if required
|
||||
pull unless @details
|
||||
method_name = sym.to_s
|
||||
# Setter
|
||||
if method_name[-1, 1] == "="
|
||||
@details.method(method_name).call(arguments[0])
|
||||
# Getter
|
||||
else
|
||||
return @details.method(method_name).call
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
# pull the details from quickbooks
|
||||
def pull
|
||||
begin
|
||||
raise Exception unless self.id
|
||||
@details = Qbo.get_base(:invoice).fetch_by_id(self.id)
|
||||
rescue Exception => e
|
||||
@details = Quickbooks::Model::Invoice.new
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
@@ -1,47 +0,0 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2022 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#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 QboPurchase < ActiveRecord::Base
|
||||
unloadable
|
||||
belongs_to :issues
|
||||
belongs_to :qbo_customer
|
||||
#attr_accessible :description
|
||||
validates_presence_of :id, :line_id, :description, :qbo_customer_id
|
||||
|
||||
def self.get_base
|
||||
Qbo.get_base(:purchase)
|
||||
end
|
||||
|
||||
def get_purchase(id)
|
||||
get_base.find_by_id(id)
|
||||
end
|
||||
|
||||
def self.sync
|
||||
QboPurchase.get_base.all.each { |purchase|
|
||||
|
||||
purchase.line_items.all? { |line_item|
|
||||
|
||||
detail = line_item.account_based_expense_line_detail ? line_item.account_based_expense_line_detail : line_item.item_based_expense_line_detail
|
||||
|
||||
if detail.billable_status = "Billable"
|
||||
qbo_purchase = find_or_create_by(id: purchase.id)
|
||||
qbo_purchase.line_id = line_item.id
|
||||
qbo_purchase.description = line_item.description
|
||||
qbo_purchase.qbo_customer_id = detail.customer_ref
|
||||
|
||||
#TODO attach to issues
|
||||
#qbo_purchase.issue_id = Issue.find_by_invoice()
|
||||
|
||||
qbo_purchase.save
|
||||
end
|
||||
}
|
||||
}
|
||||
end
|
||||
end
|
||||
@@ -1,125 +0,0 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2022 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#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 Vehicle < ActiveRecord::Base
|
||||
|
||||
unloadable
|
||||
|
||||
belongs_to :customer
|
||||
has_many :issues, :foreign_key => 'vehicles_id'
|
||||
|
||||
#attr_accessible :year, :make, :model, :customer_id, :notes, :vin
|
||||
|
||||
validates_presence_of :customer
|
||||
validates :vin, uniqueness: true
|
||||
before_save :decode_vin
|
||||
#after_find :get_details
|
||||
|
||||
self.primary_key = :id
|
||||
|
||||
# returns a human readable string
|
||||
def to_s
|
||||
if year.nil? or make.nil? or model.nil?
|
||||
return "#{vin}"
|
||||
else
|
||||
split_vin = vin.scan(/.{1,9}/)
|
||||
return "#{year} #{make} #{model} - #{split_vin[1]}"
|
||||
end
|
||||
end
|
||||
|
||||
# returns the raw JSON details from EMUNDS
|
||||
def details
|
||||
get_details if @details.nil?
|
||||
return @details
|
||||
end
|
||||
|
||||
# returns the style of the vehicle
|
||||
def style
|
||||
get_details if @details.nil?
|
||||
begin
|
||||
return @details.trim if @details
|
||||
rescue
|
||||
return nil
|
||||
end
|
||||
end
|
||||
|
||||
# returns the drive of the vehicle i.e. 2 wheel, 4 wheel, ect.
|
||||
def drive
|
||||
#todo fix this
|
||||
#return @details.drive_type if @details
|
||||
return nil
|
||||
end
|
||||
|
||||
# returns the number of doors of the vehicle
|
||||
def doors
|
||||
get_details if @details.nil?
|
||||
return @details.doors if @details
|
||||
end
|
||||
|
||||
# Force Upper Case for make numbers
|
||||
def make=(val)
|
||||
# The to_s is in case you get nil/non-string
|
||||
write_attribute(:make, val.to_s.titleize)
|
||||
end
|
||||
|
||||
# Force Upper Case for model numbers
|
||||
def model=(val)
|
||||
# The to_s is in case you get nil/non-string
|
||||
write_attribute(:model, val.to_s.titleize)
|
||||
end
|
||||
|
||||
# Force Upper Case for VIN numbers
|
||||
def vin=(val)
|
||||
#strip VIN of all illegal chars (for barcode scanner)
|
||||
val = val.to_s.upcase.gsub(/[^A-HJ-NPR-Za-hj-npr-z\d]+/,"")
|
||||
write_attribute(:vin, val)
|
||||
end
|
||||
|
||||
# search for a vin
|
||||
def self.search(search)
|
||||
where("vin LIKE ?", "%#{search}%")
|
||||
end
|
||||
|
||||
# decodes a vin and updates self
|
||||
def decode_vin
|
||||
get_details
|
||||
if @details
|
||||
begin
|
||||
self.year = @details.year unless @details.year.nil?
|
||||
self.make = @details.make unless @details.make.nil?
|
||||
self.model = @details.model unless @details.model.nil?
|
||||
rescue Exception => e
|
||||
errors.add(:vin, e.message)
|
||||
end
|
||||
end
|
||||
self.name = to_s
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# init method to pull JSON details from Edmunds
|
||||
def get_details
|
||||
if self.vin?
|
||||
#validate the vin before calling a remote server
|
||||
validation = NhtsaVin.validate(self.vin)
|
||||
begin
|
||||
#if the vin validation failed, raise an exception and exit
|
||||
raise RuntimeError, validation.error unless validation.valid?
|
||||
# query NHTSA for details on the vin
|
||||
query = NhtsaVin.get(self.vin)
|
||||
raise RuntimeError, query.error unless query.valid?
|
||||
@details = query.response
|
||||
rescue Exception => e
|
||||
errors.add(:vin, e.message)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
end
|
||||
@@ -1,6 +1,6 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 rick barrette
|
||||
#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:
|
||||
#
|
||||
@@ -8,12 +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.
|
||||
|
||||
require File.expand_path('../../test_helper', __FILE__)
|
||||
class CustomerService < ServiceBase
|
||||
|
||||
class QboTest < ActiveSupport::TestCase
|
||||
private
|
||||
|
||||
# Replace this with your real tests.
|
||||
def test_truth
|
||||
assert true
|
||||
def build_qbo_remote
|
||||
log "Building new QBO Customer"
|
||||
Quickbooks::Model::Customer.new
|
||||
end
|
||||
|
||||
end
|
||||
29
app/services/customer_sync_service.rb
Normal file
@@ -0,0 +1,29 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class CustomerSyncService < SyncServiceBase
|
||||
|
||||
private
|
||||
|
||||
# Specify the local model this service syncs
|
||||
def self.model_class
|
||||
Customer
|
||||
end
|
||||
|
||||
# Determine if the local entity should be deleted (e.g. if it's marked inactive in QBO)
|
||||
def destroy_local?(remote)
|
||||
!remote.active?
|
||||
end
|
||||
|
||||
map_attribute :name, :display_name
|
||||
map_phone :phone_number, :primary_phone
|
||||
map_phone :mobile_phone_number, :mobile_phone
|
||||
|
||||
end
|
||||
@@ -1,19 +1,27 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2017 rick barrette
|
||||
#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 HeaderFooterHookListener < Redmine::Hook::ViewListener
|
||||
|
||||
def view_layouts_base_html_head(context = {})
|
||||
#nothing
|
||||
class EmployeeSyncService < SyncServiceBase
|
||||
|
||||
private
|
||||
|
||||
# Specify the local model this service syncs
|
||||
def self.model_class
|
||||
Employee
|
||||
end
|
||||
|
||||
def view_layouts_base_body_bottom(context = {})
|
||||
return "<div id='qbo_footer' align='center'><b>#{I18n.translate(:label_last_sync)}: </b> #{Qbo.last_sync if Qbo.exists?}</div>"
|
||||
# Determine if the local entity should be deleted (e.g. if it's marked inactive in QBO)
|
||||
def destroy_local?(remote)
|
||||
!remote.active?
|
||||
end
|
||||
|
||||
map_attribute :name, :display_name
|
||||
|
||||
end
|
||||
31
app/services/estimate_sync_service.rb
Normal file
@@ -0,0 +1,31 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class EstimateSyncService < SyncServiceBase
|
||||
|
||||
# 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
|
||||
|
||||
# Specify the local model this service syncs
|
||||
def self.model_class
|
||||
Estimate
|
||||
end
|
||||
|
||||
map_attributes :doc_number, :txn_date
|
||||
map_belongs_to :customer
|
||||
|
||||
end
|
||||
60
app/services/invoice_attachment_service.rb
Normal file
@@ -0,0 +1,60 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class InvoiceAttachmentService
|
||||
|
||||
def initialize(invoice, remote)
|
||||
@invoice = invoice
|
||||
@remote = remote
|
||||
end
|
||||
|
||||
# Attach invoice to issues based on issue IDs found in the invoice's private note and line descriptions
|
||||
def attach
|
||||
extract_issue_ids.each do |issue_id|
|
||||
log "Processing issue ##{issue_id} for invoice ##{@invoice.doc_number}"
|
||||
|
||||
issue = Issue.find_by(id: issue_id)
|
||||
next unless issue
|
||||
next unless issue.customer&.id == @invoice.customer&.id
|
||||
|
||||
unless issue.invoices.exists?(@invoice.id)
|
||||
issue.invoices << @invoice
|
||||
issue.save! if issue.changed?
|
||||
log "Attached invoice ##{@invoice.id} to issue ##{issue.id}"
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Extract issue IDs from the invoice's private note and line descriptions
|
||||
def extract_issue_ids
|
||||
ids = []
|
||||
|
||||
if @remote.private_note.present?
|
||||
ids += scan(@remote.private_note)
|
||||
end
|
||||
|
||||
Array(@remote.line_items).each do |line|
|
||||
ids += scan(line.description.to_s)
|
||||
end
|
||||
|
||||
ids.uniq
|
||||
end
|
||||
|
||||
# Scan text for issue IDs in the format #123
|
||||
def scan(text)
|
||||
text.scan(/#(\d+)/).flatten.map(&:to_i)
|
||||
end
|
||||
|
||||
def log(msg)
|
||||
Rails.logger.info "[InvoiceAttachmentService] #{msg}"
|
||||
end
|
||||
end
|
||||
30
app/services/invoice_sync_service.rb
Normal file
@@ -0,0 +1,30 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class InvoiceSyncService < SyncServiceBase
|
||||
|
||||
private
|
||||
|
||||
# Specify the local model this service syncs
|
||||
def self.model_class
|
||||
Invoice
|
||||
end
|
||||
|
||||
# Attach QBO Invoices to the local Issues
|
||||
def attach_documents(local, remote)
|
||||
InvoiceAttachmentService.new(local, remote).attach
|
||||
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
|
||||
57
app/services/pdf_service.rb
Normal file
@@ -0,0 +1,57 @@
|
||||
#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 PdfService
|
||||
|
||||
require 'combine_pdf'
|
||||
|
||||
# Subclasses should initialize with a QBO client instance
|
||||
def initialize(entity: entity)
|
||||
raise "An entity to sync is required" unless entity
|
||||
@entity = entity
|
||||
end
|
||||
|
||||
# Fetches the PDF for the given entity IDs. If multiple IDs are provided, their PDFs are combined into a single document.
|
||||
def fetch_pdf(doc_ids:)
|
||||
log "Fetching PDFs for #{@entity} IDs: #{doc_ids.join(', ')}"
|
||||
QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||
return single_pdf(service, doc_ids.first) if doc_ids.size == 1
|
||||
combined_pdf(service, doc_ids)
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
# Fetches a single PDF for the given invoice ID.
|
||||
def single_pdf(service, id)
|
||||
log "Fetching PDF for #{@entity} ID: #{id}"
|
||||
entity = service.fetch_by_id(id)
|
||||
[service.pdf(entity), entity.doc_number]
|
||||
end
|
||||
|
||||
# Combines PDFs for multiple entity IDs into a single PDF document and returns it along with a reference string.
|
||||
def combined_pdf(service, ids)
|
||||
log "Combining PDFs for #{@entity} IDs: #{ids.join(', ')}"
|
||||
pdf = CombinePDF.new
|
||||
ref = []
|
||||
|
||||
ids.each do |id|
|
||||
entity = service.fetch_by_id(id)
|
||||
ref << entity.doc_number
|
||||
pdf << CombinePDF.parse(service.pdf(entity))
|
||||
end
|
||||
|
||||
[pdf.to_pdf, ref.join(" ")]
|
||||
end
|
||||
|
||||
# Logs messages with a consistent prefix for easier debugging.
|
||||
def log(msg)
|
||||
Rails.logger.info "[#{@entity}PdfService] #{msg}"
|
||||
end
|
||||
end
|
||||
42
app/services/qbo_connection_service.rb
Normal file
@@ -0,0 +1,42 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class 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.
|
||||
def self.replace!(token:, refresh_token:, realm_id:)
|
||||
Qbo.transaction do
|
||||
Qbo.destroy_all
|
||||
qbo = Qbo.create!(
|
||||
oauth2_access_token: token,
|
||||
oauth2_refresh_token: refresh_token,
|
||||
realm_id: realm_id
|
||||
)
|
||||
qbo.refresh_token!
|
||||
qbo
|
||||
end
|
||||
end
|
||||
|
||||
# Performs authenticaed requests with QBO service
|
||||
def self.with_qbo_service(entity: nil)
|
||||
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
|
||||
@@ -1,6 +1,6 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2020 rick barrette
|
||||
#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:
|
||||
#
|
||||
@@ -8,30 +8,28 @@
|
||||
#
|
||||
#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 Payment
|
||||
unloadable
|
||||
class QboOauthService
|
||||
|
||||
include ActiveModel::Model
|
||||
|
||||
attr_accessor :errors, :customer_id, :account_id, :payment_method_id, :total_amount
|
||||
validates_presence_of :customer_id, :account_id, :payment_method_id, :total_amount
|
||||
validates :total_amount, numericality: true
|
||||
|
||||
def save
|
||||
payment = Quickbooks::Model::Payment.new
|
||||
payment.customer_id = @customer_id.to_i
|
||||
payment.deposit_to_account_id = @account_id.to_i
|
||||
payment.payment_method_id = @payment_method_id.to_i
|
||||
payment.total = @total_amount
|
||||
Qbo.get_base(:payment).update(payment)
|
||||
# Generates the QuickBooks OAuth authorization URL with the specified callback URL.
|
||||
# The URL includes necessary parameters such as response type, state, and scope.
|
||||
def self.authorization_url(callback_url:)
|
||||
client.auth_code.authorize_url(
|
||||
redirect_uri: callback_url,
|
||||
response_type: "code",
|
||||
state: SecureRandom.hex(12),
|
||||
scope: "com.intuit.quickbooks.accounting"
|
||||
)
|
||||
end
|
||||
|
||||
def save!
|
||||
save
|
||||
# Exchanges the authorization code for access and refresh tokens.
|
||||
# Creates or replaces the QBO connection record with the new credentials and refreshes the token immediately after creation.
|
||||
def self.exchange!(code:, callback_url:, realm_id:)
|
||||
resp = client.auth_code.get_token(code, redirect_uri: callback_url)
|
||||
QboConnectionService.replace!( token: resp.token, refresh_token: resp.refresh_token, realm_id: realm_id )
|
||||
end
|
||||
|
||||
# Dummy stub to make validtions happy.
|
||||
def update_attribute
|
||||
# Constructs and returns an OAuth2 client instance configured with the application's credentials and settings.
|
||||
def self.client
|
||||
Qbo.construct_oauth2_client
|
||||
end
|
||||
|
||||
end
|
||||
67
app/services/service_base.rb
Normal file
@@ -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
|
||||
241
app/services/sync_service_base.rb
Normal file
@@ -0,0 +1,241 @@
|
||||
#The MIT License (MIT)
|
||||
#
|
||||
#Copyright (c) 2016 - 2026 rick barrette
|
||||
#
|
||||
#Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
|
||||
#
|
||||
#The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||
#
|
||||
#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||
|
||||
class SyncServiceBase
|
||||
PAGE_SIZE = 1000
|
||||
|
||||
# Subclasses should initialize with a QBO client instance
|
||||
def initialize()
|
||||
@entity = self.class.model_class
|
||||
@page_size = self.class.page_size
|
||||
end
|
||||
|
||||
# Subclasses can implement this to overide the default page size
|
||||
def self.page_size
|
||||
@page_size = PAGE_SIZE
|
||||
end
|
||||
|
||||
# Subclasses must implement this to specify which local model they sync (e.g. Customer, Invoice)
|
||||
def self.model_class
|
||||
raise NotImplementedError
|
||||
end
|
||||
|
||||
# Sync all entities, or only those updated since the last sync
|
||||
def sync(full_sync: false)
|
||||
log "Starting #{full_sync ? 'full' : 'incremental'} #{@entity.name} sync with page size of: #{@page_size}"
|
||||
QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||
query = build_query(full_sync)
|
||||
service.query_in_batches(query, per_page: @page_size) do |batch|
|
||||
entries = Array(batch)
|
||||
log "Processing batch of #{entries.size} #{@entity.name}"
|
||||
entries.each do |remote|
|
||||
persist(remote)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
log "#{@entity.name} sync complete"
|
||||
end
|
||||
|
||||
# Sync a single entity by its QBO ID (webhook usage)
|
||||
def sync_by_id(id)
|
||||
log "Syncing #{@entity.name} with ID #{id}"
|
||||
QboConnectionService.with_qbo_service(entity: @entity) do |service|
|
||||
remote = service.fetch_by_id(id)
|
||||
persist(remote)
|
||||
end
|
||||
end
|
||||
|
||||
private
|
||||
|
||||
def attach_documents(local, remote)
|
||||
# Override in subclasses if the entity has attachments (e.g. Invoice)
|
||||
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)
|
||||
def destroy_local?(remote)
|
||||
false
|
||||
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
|
||||
def log(msg)
|
||||
Rails.logger.info "[#{@entity.name}SyncService] #{msg}"
|
||||
end
|
||||
|
||||
# Create or update a local entity record based on the QBO remote data
|
||||
def persist(remote)
|
||||
local = @entity.find_or_initialize_by(id: remote.id)
|
||||
|
||||
if destroy_local?(remote)
|
||||
if local.persisted?
|
||||
local.destroy
|
||||
log "Deleted #{@entity.name} #{remote.id}"
|
||||
end
|
||||
return
|
||||
end
|
||||
|
||||
process_attributes(local, remote)
|
||||
|
||||
if local.new_record? || local.changed?
|
||||
was_new = local.new_record?
|
||||
local.skip_qbo_push = true
|
||||
local.save!
|
||||
log "#{was_new ? 'Created' : 'Updated'} #{@entity.name} #{remote.id}"
|
||||
attach_documents(local, remote)
|
||||
end
|
||||
|
||||
rescue => e
|
||||
log "Failed to sync #{@entity.name} #{remote.id}: #{e.message}"
|
||||
end
|
||||
|
||||
# Maps remote attributes to local model
|
||||
def process_attributes(local, remote)
|
||||
log "Processing #{@entity} ##{remote.id}"
|
||||
|
||||
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
|
||||
11
app/views/customers/_actions.html.erb
Normal file
@@ -0,0 +1,11 @@
|
||||
<%= 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 %>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
<%= link_to t(:label_create_estimate), "https://qbo.intuit.com/app/estimate?nameId=#{@customer.id}", target: :_blank %>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
<%= button_to t(:label_edit_customer), edit_customer_path(@customer), method: :get%>
|
||||
@@ -1,5 +1,11 @@
|
||||
<table>
|
||||
<tbody>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_name)%></th>
|
||||
<td><%= customer.name %></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_email)%></th>
|
||||
<td><%= customer.email %></td>
|
||||
@@ -7,22 +13,22 @@
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_primary_phone)%></th>
|
||||
<td><%= number_to_phone(customer.primary_phone.gsub(/[^\d]/, '').to_i, area_code: true) if customer.primary_phone %></td>
|
||||
<td><%= number_to_phone(customer&.primary_phone&.gsub(/[^\d]/, '').to_i, area_code: true) %></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_mobile_phone)%></th>
|
||||
<td><%= number_to_phone(customer.mobile_phone.gsub(/[^\d]/, '').to_i, area_code: true) if customer.mobile_phone %></td>
|
||||
<td><%= number_to_phone(customer&.mobile_phone&.gsub(/[^\d]/, '').to_i, area_code: true) %></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_billing_address)%></th>
|
||||
<td><%= @billing_address %></td>
|
||||
<td><pre><%= @billing_address %></pre></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_shipping_address)%></th>
|
||||
<td><%= @shipping_address %></td>
|
||||
<td><pre><%= @shipping_address %></pre></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
@@ -31,14 +37,24 @@
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:field_notes)%></th>
|
||||
<td><%= customer.notes %></td>
|
||||
<th colspan="2"><h4><%=t(:field_notes)%></hr></th>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
<%= button_to t(:label_edit_customer), edit_customer_path(customer), method: :get%>
|
||||
<td colspan="2">
|
||||
<pre id="note-display" style="text-align: left; white-space: pre-wrap; font-family: inherit;">
|
||||
<%= customer.notes %>
|
||||
</pre>
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
<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>
|
||||
</table>
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
@@ -7,28 +7,28 @@
|
||||
<div class="clearfix">
|
||||
<%=t(:label_display_name)%>
|
||||
<div class="input">
|
||||
<%= f.text_field :name, :required => true, :autocomplete => "off" %>
|
||||
<%= f.text_field :name, required: true, class: "customer-name", autocomplete: "off", data: { autocomplete_url: "/customers/autocomplete" } %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="clearfix">
|
||||
<%=t(:label_primary_phone)%>
|
||||
<div class="input">
|
||||
<%= f.telephone_field :primary_phone, :autocomplete => "off" %>
|
||||
<%= 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" %>
|
||||
<%= f.telephone_field :mobile_phone, autocomplete: "off" %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="clearfix">
|
||||
<%=t(:label_email)%>:
|
||||
<div class="input">
|
||||
<%= f.email_field :email, :autocomplete => "off" %>
|
||||
<%= f.email_field :email, autocomplete: "off" %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -36,17 +36,16 @@
|
||||
<%=t(:field_notes)%>:
|
||||
<div class="input">
|
||||
<p>
|
||||
<%= link_to_function content_tag(:span, l(:button_edit), :class => 'icon icon-edit'), '$(this).hide(); $("#issue_description_and_toolbar").show()' unless @customer.new_record? %>
|
||||
<%= content_tag 'span', :id => "issue_description_and_toolbar", :style => (@customer.new_record? ? nil : 'display:none') do %>
|
||||
<%= 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 %>
|
||||
cols: 60,
|
||||
rows: 10,
|
||||
accesskey: accesskey(:edit),
|
||||
class: 'wiki-edit',
|
||||
no_label: true %>
|
||||
<% end %>
|
||||
</p>
|
||||
<%= wikitoolbar_for 'issue_description' %>
|
||||
<%= wikitoolbar_for :issue_description %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
<%= form_tag(customers_path, :method => "get", id: "search-form") do %>
|
||||
<%= text_field_tag :search, params[:search], placeholder: t(:label_search_customers), :autocomplete => "off" %>
|
||||
<%= form_tag(customers_path, method: "get", id: "customer-search-form") do %>
|
||||
<%= 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) %>
|
||||
<% end %>
|
||||
<%= button_to t(:label_new_customer), new_customer_path, method: :get%>
|
||||
<%= button_to t(:label_sync), qbo_sync_path, method: :get%>
|
||||
<%= button_to(t(:label_sync), qbo_sync_path, method: :get) if User.current.admin?%>
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
<h3><%=t(:label_customers)%></h3>
|
||||
<%= render :partial => 'customers/search' %>
|
||||
<%= render partial: 'customers/search' %>
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
<h1><%=t(:label_edit_customer)%></h1>
|
||||
<br/>
|
||||
<%= render :partial => 'customers/form' %>
|
||||
<%= render partial: 'customers/form' %>
|
||||
|
||||
@@ -1 +1 @@
|
||||
$('select#issue_qbo_estimate_id').html('<%= j content_tag(:option,'',:value=>"")+options_from_collection_for_select(@filtered_estimates, :id, :doc_number) %>');
|
||||
$('select#issue_estimate_id').html('<%= j content_tag(:option,'',value:"")+options_from_collection_for_select(@filtered_estimates, :id, :doc_number) %>');
|
||||
|
||||
@@ -1 +0,0 @@
|
||||
$('select#issue_vehicles_id').html('<%= j content_tag(:option,'',:value=>"")+options_from_collection_for_select(@filtered_vehicles, :id, :to_s) %>');
|
||||
@@ -1,4 +1,4 @@
|
||||
<h2><%=t(:field_customers)%> <span style="float:right"> <%= render :partial => 'customers/search' %> </span> </h2>
|
||||
<h2><%=t(:field_customers)%> <span style="float:right"> <%= render partial: 'customers/search' %> </span> </h2>
|
||||
<% if @customers.present? %>
|
||||
<br/>
|
||||
<% @customers.each do |c| %>
|
||||
@@ -20,5 +20,5 @@
|
||||
<% end %>
|
||||
|
||||
<div>
|
||||
<%= render :partial => 'qbo/stats' %>
|
||||
<%= render partial: 'qbo/stats' %>
|
||||
</div>
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
<h2><%=t(:label_new_customer)%></h2>
|
||||
<br/>
|
||||
<%= render :partial => 'customers/form' %>
|
||||
<%= render partial: 'customers/form' %>
|
||||
|
||||
@@ -1,43 +1,53 @@
|
||||
<h2><%=t(:field_customer)%> #<%= @customer.id %> - <%= @customer.name %> </h2>
|
||||
<br/>
|
||||
|
||||
<div class="subject">
|
||||
<div><h4><%=t(:label_details)%>:</h4></div>
|
||||
</div>
|
||||
|
||||
<div class="attributes">
|
||||
<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="splitcontent">
|
||||
|
||||
<div class="splitcontentleft">
|
||||
<%= render :partial => 'customers/details', locals: {customer: @customer} %>
|
||||
|
||||
<h4><%=t(:label_details)%>:</h4>
|
||||
|
||||
<!-- Customer Info -->
|
||||
|
||||
<div class="splitcontent">
|
||||
<div class="splitcontentleft">
|
||||
<h4><%=t(:field_customer)%>:</h4>
|
||||
<%= render partial: 'customers/details', locals: {customer: @customer} %>
|
||||
</div>
|
||||
|
||||
<div class="splitcontentleft">
|
||||
<h4><%=t(:label_actions)%>:</h4>
|
||||
<%= render partial: 'customers/actions', locals: {customer: @customer} %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<!-- QBO Info -->
|
||||
|
||||
<div class="splitcontent">
|
||||
<div class="splitcontentleft">
|
||||
<h4><%=t(:estimates)%>:</h4>
|
||||
<%= render :partial => 'estimates/list', locals: {customer: @customer} %>
|
||||
<%= render partial: 'estimates/list', locals: {estimates: @customer.estimates} %>
|
||||
</div>
|
||||
|
||||
<div class="splitcontentleft">
|
||||
<h4><%=t(:label_invoices)%>:</h4>
|
||||
<%= render :partial => 'invoices/list', locals: {customer: @customer} %>
|
||||
<%= render partial: 'invoices/list', locals: {invoices: @customer.invoices} %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<div class="splitcontentleft">
|
||||
<h4><%=t(:field_vehicles)%>:</h4>
|
||||
<%= render :partial => 'vehicles/list' %>
|
||||
<%= button_to "New Vehicle", new_customer_vehicle_path(@customer), method: :get %>
|
||||
<%= call_hook :show_customer_view_right, {customer: @customer} %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
<h2><%=@issues.open.count%> <%=t(:label_open_issues)%>:</h2>
|
||||
<%= render :partial => 'issues/list_simple', locals: {issues: @issues.open} %>
|
||||
<h3><%=@open_issues.count%> <%=t(:label_open_issues)%> - <%=@hours.round(1)%> <%=t(:label_hours)%></h3>
|
||||
<%= render partial: 'issues/list_simple', locals: {issues: @open_issues.open} %>
|
||||
|
||||
<h2><%=@closed_issues.count%> <%=t(:label_closed_issues)%>:</h2>
|
||||
<%= render :partial => 'issues/list_simple', locals: {issues: @closed_issues} %>
|
||||
|
||||
</div>
|
||||
<h3><%=@closed_issues.count%> <%=t(:label_closed_issues)%> - <%= @closed_hours.round(1)%> <%=t(:label_hours)%></h3>
|
||||
<%= render partial: 'issues/list_simple', locals: {issues: @closed_issues} %>
|
||||
|
||||
@@ -1,8 +1,10 @@
|
||||
<p style="float: right;"> <%= copy_object_url_link(request.url) %> </p>
|
||||
|
||||
<h2><%= issue_heading(@issue) %></h2>
|
||||
|
||||
<div class="<%= @issue.css_classes %> details">
|
||||
|
||||
<%= avatar(@issue.author, :size => "50") %>
|
||||
<%= avatar(@issue.author, size: "50") %>
|
||||
|
||||
<div class="subject">
|
||||
<%= render_issue_subject_with_tree(@issue) %>
|
||||
@@ -17,39 +19,39 @@
|
||||
|
||||
<div class="attributes">
|
||||
<%= issue_fields_rows do |rows|
|
||||
rows.left l(:field_status), @issue.status.name, :class => 'status'
|
||||
rows.left l(:field_priority), @issue.priority.name, :class => 'priority'
|
||||
unless @issue.disabled_core_fields.include?('assigned_to_id')
|
||||
rows.left l(:field_assigned_to), avatar(@issue.assigned_to, :size => "14").to_s.html_safe + (@issue.assigned_to ? link_to_user(@issue.assigned_to) : "-"), :class => 'assigned-to'
|
||||
rows.left l(:field_status), @issue.status.name, class: :status
|
||||
rows.left l(:field_priority), @issue.priority.name, class: :priority
|
||||
# unless @issue.disabled_core_fields.include?(:assigned_to_id)
|
||||
# rows.left l(:field_assigned_to), avatar(@issue.assigned_to, size: "14").to_s.html_safe + (@issue.assigned_to ? @issue.assigned_to : "-"), class: 'assigned-to'
|
||||
# end
|
||||
unless @issue.disabled_core_fields.include?(:category_id) || (@issue.category.nil? && @issue.project.issue_categories.none?)
|
||||
rows.left l(:field_category), (@issue.category ? @issue.category.name : "-"), class: :category
|
||||
end
|
||||
unless @issue.disabled_core_fields.include?('category_id') || (@issue.category.nil? && @issue.project.issue_categories.none?)
|
||||
rows.left l(:field_category), (@issue.category ? @issue.category.name : "-"), :class => 'category'
|
||||
unless @issue.disabled_core_fields.include?(:fixed_version_id) || (@issue.fixed_version.nil? && @issue.assignable_versions.none?)
|
||||
rows.left l(:field_fixed_version), (@issue.fixed_version ? @issue.fixed_version : "-"), class: 'fixed-version'
|
||||
end
|
||||
unless @issue.disabled_core_fields.include?('fixed_version_id') || (@issue.fixed_version.nil? && @issue.assignable_versions.none?)
|
||||
rows.left l(:field_fixed_version), (@issue.fixed_version ? link_to_version(@issue.fixed_version) : "-"), :class => 'fixed-version'
|
||||
unless @issue.disabled_core_fields.include?(:start_date)
|
||||
rows.right l(:field_start_date), format_date(@issue.start_date), class: 'start-date'
|
||||
end
|
||||
unless @issue.disabled_core_fields.include?('start_date')
|
||||
rows.right l(:field_start_date), format_date(@issue.start_date), :class => 'start-date'
|
||||
unless @issue.disabled_core_fields.include?(:due_date)
|
||||
rows.right l(:field_due_date), format_date(@issue.due_date), class: 'due-date'
|
||||
end
|
||||
unless @issue.disabled_core_fields.include?('due_date')
|
||||
rows.right l(:field_due_date), format_date(@issue.due_date), :class => 'due-date'
|
||||
unless @issue.disabled_core_fields.include?(:done_ratio)
|
||||
rows.right l(:field_done_ratio), progress_bar(@issue.done_ratio, legend: "#{@issue.done_ratio}%"), class: :progress
|
||||
end
|
||||
unless @issue.disabled_core_fields.include?('done_ratio')
|
||||
rows.right l(:field_done_ratio), progress_bar(@issue.done_ratio, :legend => "#{@issue.done_ratio}%"), :class => 'progress'
|
||||
end
|
||||
unless @issue.disabled_core_fields.include?('estimated_hours')
|
||||
unless @issue.disabled_core_fields.include?(:estimated_hours)
|
||||
if @issue.estimated_hours.present? || @issue.total_estimated_hours.to_f > 0
|
||||
rows.right l(:field_estimated_hours), issue_estimated_hours_details(@issue), :class => 'estimated-hours'
|
||||
rows.right l(:field_estimated_hours), issue_estimated_hours_details(@issue), class: 'estimated-hours'
|
||||
end
|
||||
end
|
||||
#if User.current.allowed_to_view_all_time_entries?(@project)
|
||||
if @issue.total_spent_hours > 0
|
||||
rows.right l(:label_spent_time), issue_spent_hours_details(@issue), :class => 'spent-time'
|
||||
rows.right l(:label_spent_time), issue_spent_hours_details(@issue), class: 'spent-time'
|
||||
end
|
||||
#end
|
||||
end %>
|
||||
<%= render_full_width_custom_fields_rows(@issue) %>
|
||||
<%= call_hook(:view_issues_show_details_bottom, :issue => @issue) %>
|
||||
<%= call_hook(:view_issues_show_details_bottom, issue: @issue) %>
|
||||
</div>
|
||||
|
||||
<% if @issue.description? || @issue.attachments.any? -%>
|
||||
@@ -57,19 +59,19 @@ end %>
|
||||
<% if @issue.description? %>
|
||||
<div class="description">
|
||||
<div class="contextual">
|
||||
<%= link_to l(:button_quote), quoted_issue_path(@issue), :remote => true, :method => 'post', :class => 'icon icon-comment' if @issue.notes_addable? %>
|
||||
<%= link_to l(:button_quote), quoted_issue_path(@issue), remote: true, method: :post, class: 'icon icon-comment' if @issue.notes_addable? %>
|
||||
</div>
|
||||
|
||||
<p><strong><%=l(:field_description)%></strong></p>
|
||||
<div class="wiki">
|
||||
<%= textilizable @issue, :description, :attachments => @issue.attachments %>
|
||||
<%= textilizable @issue, :description, attachments: @issue.attachments %>
|
||||
</div>
|
||||
</div>
|
||||
<% end %>
|
||||
<%= link_to_attachments @issue, :thumbnails => true %>
|
||||
<%= link_to_attachments @issue, thumbnails: true %>
|
||||
<% end -%>
|
||||
|
||||
<%= call_hook(:view_issues_show_description_bottom, :issue => @issue) %>
|
||||
<%= call_hook(:view_issues_show_description_bottom, issue: @issue) %>
|
||||
|
||||
<% if !@issue.leaf? || User.current.allowed_to?(:manage_subtasks, @project) %>
|
||||
<hr />
|
||||
@@ -85,7 +87,7 @@ end %>
|
||||
<% if @relations.present? || User.current.allowed_to?(:manage_issue_relations, @project) %>
|
||||
<hr />
|
||||
<div id="relations">
|
||||
<%= render :partial => 'issues/relations' %>
|
||||
<%= render partial: 'issues/relations' %>
|
||||
</div>
|
||||
<% end %>
|
||||
|
||||
@@ -94,14 +96,14 @@ end %>
|
||||
<% if @changesets.present? %>
|
||||
<div id="issue-changesets">
|
||||
<h3><%=l(:label_associated_revisions)%></h3>
|
||||
<%= render :partial => 'issues/changesets', :locals => { :changesets => @changesets} %>
|
||||
<%= render partial: 'issues/changesets', locals: { changesets: @changesets} %>
|
||||
</div>
|
||||
<% end %>
|
||||
|
||||
<% if @journals.present? %>
|
||||
<div id="history">
|
||||
<h3><%=l(:label_history)%></h3>
|
||||
<%= render :partial => 'issues/history', :locals => { :issue => @issue, :journals => @journals } %>
|
||||
<%= render partial: 'issues/history', locals: { issue: @issue, journals: @journals } %>
|
||||
</div>
|
||||
<% end %>
|
||||
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
<% if @customer.present? %>
|
||||
<% unless estimates.empty? %>
|
||||
|
||||
<% @customer.qbo_estimates.order(doc_number: :desc).each do |estimate| %>
|
||||
<% estimates.sort.reverse.each do |estimate| %>
|
||||
<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" %>
|
||||
<b><%= link_to "##{estimate.doc_number}", estimate_path(estimate), target: :_blank %></b> <%= estimate.txn_date %>
|
||||
</div>
|
||||
<% end %>
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
<%= form_tag("/qbo/estimate/doc", :method => "get", id: "est-search-form") do %>
|
||||
<%= text_field_tag :search, params[:search], placeholder: t(:label_search_estimates), :autocomplete => "off" %>
|
||||
<%= submit_tag t(:label_search), :formtarget => "_blank" %>
|
||||
<%= form_tag(estimate_doc_path, method: "get", id: "estimate-search-form") do %>
|
||||
<%= text_field_tag :search, params[:search], placeholder: t(:label_search_estimates), autocomplete: "off" %>
|
||||
<%= submit_tag t(:label_search), formtarget: "_blank" %>
|
||||
<% end %>
|
||||
|
||||
@@ -1,2 +1,2 @@
|
||||
<h3><%=t(:label_estimates) %></h3>
|
||||
<%= render :partial => 'estimates/search' %>
|
||||
<%= render partial: 'estimates/search' %>
|
||||
|
||||
@@ -1,11 +1,27 @@
|
||||
<% if @customer.present? %>
|
||||
<% unless invoices.empty? %>
|
||||
|
||||
<% @customer.qbo_invoices.order(doc_number: :desc).each do |invoice| %>
|
||||
<%= form_with(url: invoice_path, method: :get) do |form| %>
|
||||
|
||||
<% if invoices.count > 1 %>
|
||||
<div class="form-check">
|
||||
<%= check_box_tag "select-all-invoices", "1", false, id: "select-all-invoices" %>
|
||||
<%= label_tag "select-all-invoices", t(:label_select_all) %>
|
||||
</div>
|
||||
<hr>
|
||||
<% end %>
|
||||
|
||||
<% invoices.sort.reverse.each do |invoice| %>
|
||||
<div class="row">
|
||||
<%= check_box_tag "invoice_ids[]", invoice.id, false, onchange: "updateLink()", data: { url: invoice_path(invoice), text: "Invoice ##{invoice.to_s}" }, class: "invoice-checkbox appointment" if invoices.count > 1 %>
|
||||
<b><%= link_to "##{invoice.doc_number}", invoice_path(invoice), target: :_blank %></b> <%= invoice.txn_date %>
|
||||
</div>
|
||||
<% end %>
|
||||
|
||||
<% if invoices.count > 1 %>
|
||||
<%= form.submit t(:button_bulk_pdf) %>
|
||||
<% end %>
|
||||
<% end %>
|
||||
|
||||
<% else %>
|
||||
<p><%=t(:label_no_invoices)%>.</p>
|
||||
<% end %>
|
||||
|
||||
9
app/views/issues/_form_hook.html.erb
Normal file
@@ -0,0 +1,9 @@
|
||||
<p>
|
||||
<label for="issue_customer"><%= t(:customer) %></label>
|
||||
<%= search_customer %>
|
||||
<%= customer_id %>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<%= select_estimate %>
|
||||
</p>
|
||||
@@ -3,12 +3,12 @@
|
||||
<div id="change-<%= journal.id %>" class="<%= journal.css_classes %>">
|
||||
<div id="note-<%= journal.indice %>">
|
||||
<div class="contextual">
|
||||
<span class="journal-actions"><%= render_journal_actions(issue, journal, :reply_links => reply_links) %></span>
|
||||
<span class="journal-actions"><%= render_journal_actions(issue, journal, reply_links: reply_links) %></span>
|
||||
<a href="#note-<%= journal.indice %>" class="journal-link">#<%= journal.indice %></a>
|
||||
</div>
|
||||
<h4>
|
||||
<%= avatar(journal.user, :size => "24") %>
|
||||
<%= authoring journal.created_on, journal.user, :label => :label_updated_time_by %>
|
||||
<%= avatar(journal.user, size: "24") %>
|
||||
<%= authoring journal.created_on, journal.user, label: :label_updated_time_by %>
|
||||
<%= render_private_notes_indicator(journal) %>
|
||||
</h4>
|
||||
|
||||
@@ -26,10 +26,10 @@
|
||||
</div>
|
||||
<% end %>
|
||||
<% end %>
|
||||
<%= render_notes(issue, journal, :reply_links => reply_links) unless journal.notes.blank? %>
|
||||
<%= render_notes(issue, journal, reply_links: reply_links) unless journal.notes.blank? %>
|
||||
</div>
|
||||
</div>
|
||||
<%= call_hook(:view_issues_history_journal_bottom, { :journal => journal }) %>
|
||||
<%= call_hook(:view_issues_history_journal_bottom, { journal: journal }) %>
|
||||
<% end %>
|
||||
|
||||
<% heads_for_wiki_formatter if User.current.allowed_to?(:edit_issue_notes, issue.project) || User.current.allowed_to?(:edit_own_issue_notes, issue.project) %>
|
||||
@@ -9,9 +9,9 @@
|
||||
</tr></thead>
|
||||
<tbody>
|
||||
<% for issue in issues %>
|
||||
<tr id="issue-<%= h(issue.id) %>" class="hascontextmenu <%= cycle('odd', 'even') %> <%= issue.css_classes %>">
|
||||
<tr id="issue-<%= h(issue.id) %>" class="hascontextmenu <%= cycle(:odd, :even) %> <%= issue.css_classes %>">
|
||||
<td class="id">
|
||||
<%= check_box_tag("ids[]", issue.id, false, :style => 'display:none;', :id => nil) %>
|
||||
<%= check_box_tag("ids[]", issue.id, false, style: 'display:none;', id: nil) %>
|
||||
<%= link_to(issue.id, issue_path(issue)) %>
|
||||
</td>
|
||||
<td class="project"><%= link_to_project(issue.project) %></td>
|
||||
|
||||
22
app/views/issues/_show_details.html.erb
Normal file
@@ -0,0 +1,22 @@
|
||||
<div class="splitcontent">
|
||||
<div class="splitcontentleft">
|
||||
<div class="customer_id attribute">
|
||||
<div class="label"><span><%=t(:field_customer)%></span>:</div>
|
||||
<div class="value"><%= customer %></div>
|
||||
</div>
|
||||
|
||||
<div class="estimate_id attribute">
|
||||
<div class="label"><span><%=t(:field_estimate)%></span>:</div>
|
||||
<div class="value"><%= estimate_link %></div>
|
||||
</div>
|
||||
|
||||
<div class="invoice_id attribute">
|
||||
<div class="label"><span><%=t(:field_invoice)%></span>:</div>
|
||||
<div class="value"><%= invoice_link %></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="splitcontentleft">
|
||||
<%= call_hook :show_issue_view_right, {issue: issue} %>
|
||||
</div>
|
||||
</div>
|
||||
@@ -1,42 +0,0 @@
|
||||
<div class="row">
|
||||
<div class="span6 columns">
|
||||
<fieldset>
|
||||
|
||||
<%= form_for @payment do |f| %>
|
||||
|
||||
<div class="clearfix">
|
||||
<%=t(:field_customer)%>:
|
||||
<div class="input">
|
||||
<%= f.collection_select :customer_id, @customers, :id, :name, include_blank: true, :selected => @customer, :required => true%>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="clearfix">
|
||||
<%=t(:label_deposit_into)%>:
|
||||
<div class="input">
|
||||
<%= f.collection_select :account_id, @accounts, :id, :name, include_blank: true, :selected => @account, :required => true%>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="clearfix">
|
||||
<%=t(:label_payment_method)%>:
|
||||
<div class="input">
|
||||
<%= f.collection_select :payment_method_id, @payment_methods, :id, :name, include_blank: true, :selected => @payment_method, :required => true%>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="clearfix">
|
||||
<%=t(:label_amount)%>:
|
||||
<div class="input">
|
||||
<%= f.number_field :total_amount %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="actions">
|
||||
<%= f.submit %>
|
||||
</div>
|
||||
<% end %>
|
||||
|
||||
</fieldset>
|
||||
</div>
|
||||
</div>
|
||||
@@ -1,3 +0,0 @@
|
||||
<h1><%=t(:label_new_payment)%></h1>
|
||||
<br/>
|
||||
<%= render :partial => 'payments/form' %>
|
||||
@@ -1 +0,0 @@
|
||||
<%= flash.now[:error] = t(:label_401) %>
|
||||
3
app/views/qbo/_footer.html.erb
Normal file
@@ -0,0 +1,3 @@
|
||||
<div id='footer' align='center'>
|
||||
<%= render partial: 'qbo/last_sync' %>
|
||||
</div>
|
||||
@@ -1,35 +0,0 @@
|
||||
<div class="splitcontent">
|
||||
<div class="splitcontentleft">
|
||||
<div class="customer_id attribute">
|
||||
<div class="label"><span><%=t(:field_customer)%></span>:</div>
|
||||
<div class="value"><%= customer %></div>
|
||||
</div>
|
||||
|
||||
<div class="qbo_estimate_id attribute">
|
||||
<div class="label"><span><%=t(:field_qbo_estimate)%></span>:</div>
|
||||
<div class="value"><%= estimate_link %></div>
|
||||
</div>
|
||||
|
||||
<div class="qbo_invoice_id attribute">
|
||||
<div class="label"><span><%=t(:field_qbo_invoice)%></span>:</div>
|
||||
<div class="value"><%= invoice_link %></div>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="splitcontentleft">
|
||||
<div class="vehicle attribute">
|
||||
<div class="label"><span><%=t(:field_vehicle)%></span>:</div>
|
||||
<div class="value"><%= vehicle %></div>
|
||||
</div>
|
||||
|
||||
<div class="vehicle_vin attribute">
|
||||
<div class="label"><span><%=t(:field_vin)%></span>:</div>
|
||||
<div class="value"><%=split_vin[0] if split_vin%><b><%=split_vin[1] if split_vin%></b></div>
|
||||
</div>
|
||||
|
||||
<div class="vehicle_notes attribute">
|
||||
<div class="label"><span><%=t(:field_notes)%></span>:</div>
|
||||
<div class="value"><%=notes%></div>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
@@ -1 +1 @@
|
||||
<b><%=t(:label_last_sync)%>: </b> <%= Qbo.last_sync if Qbo.exists? %>
|
||||
<b><%=t(:label_last_sync)%>: </b> <%= Qbo.last_sync %>
|
||||
|
||||
@@ -1,94 +1,79 @@
|
||||
<!--
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2020 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>
|
||||
|
||||
<!-- configure the Intuit object: 'grantUrl' is a URL in your application which kicks off the flow, see below -->
|
||||
<script>
|
||||
intuit.ipp.anywhere.setup({menuProxy: '/path/to/blue-dot', grantUrl: '<%= Setting.host_name %>/qbo/authenticate'});
|
||||
intuit.ipp.anywhere.setup({menuProxy: '/path/to/blue-dot', grantUrl: '<%= qbo_authenticate_path %>'});
|
||||
</script>
|
||||
|
||||
<table >
|
||||
<tbody>
|
||||
<div class="box tabular">
|
||||
<p>
|
||||
<label><%= t(:label_client_id) %></label>
|
||||
<%= text_field_tag 'settings[oauth_consumer_key]', settings[:oauth_consumer_key], size: 50 %>
|
||||
</p>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_client_id)%></th>
|
||||
<td>
|
||||
<input type="text" style="width:350px" id="settingsOAuthConsumerKey"
|
||||
value="<%= settings['settingsOAuthConsumerKey'] %>"
|
||||
name="settings[settingsOAuthConsumerKey]" >
|
||||
</td>
|
||||
</tr>
|
||||
<p>
|
||||
<label><%= t(:label_client_secret) %></label>
|
||||
<%= password_field_tag 'settings[oauth_consumer_secret]', settings[:oauth_consumer_secret], size: 50 %>
|
||||
</p>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_client_secret)%></th>
|
||||
<td>
|
||||
<input type="text" style="width:350px" id="settingsOAuthConsumerSecret"
|
||||
value="<%= settings['settingsOAuthConsumerSecret'] %>"
|
||||
name="settings[settingsOAuthConsumerSecret]" >
|
||||
</td>
|
||||
</tr>
|
||||
<p>
|
||||
<label><%= t(:label_webhook_token) %></label>
|
||||
<%= text_field_tag 'settings[webhook_token]', settings[:webhook_token], size: 50 %>
|
||||
</p>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_webhook_token)%></th>
|
||||
<td>
|
||||
<input type="text" style="width:350px" id="settingsWebhookToken"
|
||||
value="<%= settings['settingsWebhookToken'] %>"
|
||||
name="settings[settingsWebhookToken]" >
|
||||
</td>
|
||||
</tr>
|
||||
<p>
|
||||
<label><%= t(:label_sandbox) %></label>
|
||||
<%= check_box_tag 'settings[sandbox]', 1, settings[:sandbox] %>
|
||||
</p>
|
||||
|
||||
<tr>
|
||||
<th><%=t(:label_oauth_expires)%></th>
|
||||
<td><%= if Qbo.exists? then Qbo.first.expire end %>
|
||||
</tr>
|
||||
<hr />
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
<p>
|
||||
<label><%= t(:label_oauth_expires) %></label>
|
||||
<span class="icon <%= Qbo.oauth2_access_token_expires_at&.future? ? 'icon-ok' : 'icon-warning' %>">
|
||||
<%= Qbo.oauth2_access_token_expires_at || 'N/A' %>
|
||||
</span>
|
||||
</p>
|
||||
|
||||
<br/>
|
||||
<%=t(:label_oauth_note)%>
|
||||
<br/>
|
||||
<br/>
|
||||
<p>
|
||||
<label><%= t(:label_customer_count) %></label>
|
||||
<%= Customer.count %>
|
||||
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Customer.last_sync %>)</em>
|
||||
</p>
|
||||
|
||||
<!-- this will display a button that the user clicks to start the flow -->
|
||||
<p>
|
||||
<label><%= t(:label_employee_count) %></label>
|
||||
<%= Employee.count %>
|
||||
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Employee.last_sync %>)</em>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<label><%= t(:label_invoice_count) %></label>
|
||||
<%= Invoice.count %>
|
||||
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Item.last_sync %>)</em>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<label><%= t(:label_estimate_count) %></label>
|
||||
<%= Estimate.count %>
|
||||
<em style="color: #777; font-size: 0.9em; margin-left: 8px;">(@ <%= Account.last_sync %>)</em>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
<label><%= t(:label_last_sync) %> (QBO)</label>
|
||||
<%= Qbo.exists? ? Qbo.last_sync : 'Never synced' %>
|
||||
</p>
|
||||
</div>
|
||||
|
||||
<fieldset class="box">
|
||||
<legend>Management & Synchronization</legend>
|
||||
|
||||
<div style="margin-bottom: 20px;">
|
||||
<ipp:connectToIntuit></ipp:connectToIntuit>
|
||||
|
||||
<br/>
|
||||
<br/>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_customer_count)%>:</b> <%= Customer.count%>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_item_count)%>:</b> <%= QboItem.count %>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_employee_count)%>:</b> <%= QboEmployee.count %>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_invoice_count)%>:</b> <%= QboInvoice.count %>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_estimate_count)%>:</b> <%= QboEstimate.count %>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_last_sync)%> </b> <%= Qbo.last_sync if Qbo.exists? %> <%= link_to " Sync Now", qbo_sync_path %>
|
||||
<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,6 @@
|
||||
<% if User.current.logged? %>
|
||||
|
||||
<%= render :partial => 'customers/sidebar' %>
|
||||
<%= render :partial => 'estimates/sidebar' %>
|
||||
<%= render partial: 'customers/sidebar' %>
|
||||
<%= render partial: 'estimates/sidebar' %>
|
||||
|
||||
<% end %>
|
||||
|
||||
@@ -1 +1 @@
|
||||
<%= Customer.count %> <%=t(:field_customers)%> - <%= render :partial => 'qbo/last_sync' %>
|
||||
<%= Customer.count %> <%=t(:field_customers)%> - <%= render partial: 'qbo/last_sync' %>
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!--
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2016 rick barrette
|
||||
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:
|
||||
|
||||
@@ -30,4 +30,3 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
|
||||
intuit.ipp.anywhere.setup({menuProxy: '/path/to/blue-dot', grantUrl: '<%= authenticate_vendors_url %>'});
|
||||
</script>
|
||||
</body>
|
||||
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
<!--
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2016 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.
|
||||
-->
|
||||
|
||||
<body>
|
||||
<h1><%=t(:label_redmine_qbo)%></h1>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_customer_count)%>:</b> <%= @customer_count.to_s%>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_item_count)%>:</b> <%= @qbo_item_count.to_s %>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_employee_count)%>:</b> <%= @qbo_employee_count.to_s %>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_invoice_count)%>:</b> <%= @qbo_invoice_count.to_s %>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_estimate_count)%>:</b> <%= @qbo_estimate_count.to_s %>
|
||||
</div>
|
||||
|
||||
<br/>
|
||||
|
||||
<div>
|
||||
<b><%=t(:label_last_sync)%>: </b> <%= Qbo.last_sync if Qbo.exists? %>
|
||||
</div>
|
||||
|
||||
</body>
|
||||
@@ -1,7 +1,7 @@
|
||||
<!--
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2016 rick barrette
|
||||
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:
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
<!--
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2016 rick barrette
|
||||
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:
|
||||
|
||||
@@ -10,8 +10,4 @@ The above copyright notice and this permission notice shall be included in all c
|
||||
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.
|
||||
-->
|
||||
|
||||
<body>
|
||||
|
||||
<h2>QboController#sync</h2>
|
||||
|
||||
</body>
|
||||
<h2>QboController#webhook</h2>
|
||||
@@ -1,31 +0,0 @@
|
||||
<table>
|
||||
<tbody>
|
||||
|
||||
<tr>
|
||||
<th><%= t(:field_customer)%></th>
|
||||
<td><%= link_to vehicle.customer.name, customer_path(vehicle.customer) %></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><%= t(:field_vehicle) %></th>
|
||||
<td><%= vehicle.to_s %></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><%= t(:field_vin) %></th>
|
||||
<td><%= @vin[0] if @vin %><b><%=@vin[1] if @vin%></b></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<th><%= t(:field_notes) %></th>
|
||||
<td><%= vehicle.notes %></td>
|
||||
</tr>
|
||||
|
||||
<tr>
|
||||
<td>
|
||||
<%= button_to t(:label_edit), edit_vehicle_path(vehicle), method: :get%>
|
||||
<%= button_to t(:label_delete), vehicle, method: :delete, data: {confirm: t(:warn_ru_sure)} %>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
@@ -1,56 +0,0 @@
|
||||
<div class="row">
|
||||
<div class="span6 columns">
|
||||
<fieldset>
|
||||
|
||||
<%= form_for @vehicle do |f| %>
|
||||
<div class="clearfix">
|
||||
<%=t(:field_customer)%>:
|
||||
<div class="input">
|
||||
<%= f.autocomplete_field :customer, autocomplete_customer_name_customers_path, :value => @customer.name, :update_elements => {:id => '#customer_id', :value => '#issue_customer'}, :required => true %>
|
||||
<%= f.hidden_field :customer_id, :id => "customer_id", :value => @customer.id %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="clearfix">
|
||||
<%=t(:label_year)%>:
|
||||
<div class="input">
|
||||
<%= f.number_field :year, :autocomplete => "off" %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="clearfix">
|
||||
<%=t(:label_make)%>:
|
||||
<div class="input">
|
||||
<%= f.text_field :make, :autocomplete => "off" %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="clearfix">
|
||||
<%=t(:label_model)%>:
|
||||
<div class="input">
|
||||
<%= f.text_field :model, :autocomplete => "off" %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="clearfix">
|
||||
<%=t(:field_vin)%>:
|
||||
<div class="input">
|
||||
<%= f.text_field :vin , :autofocus => true %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="clearfix">
|
||||
<%=t(:field_notes)%>:
|
||||
<div class="input">
|
||||
<%= f.text_area :notes, :cols => 60, :rows => 10, :no_label => true %>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div class="actions">
|
||||
<%= f.submit %>
|
||||
</div>
|
||||
<% end %>
|
||||
|
||||
</fieldset>
|
||||
</div>
|
||||
</div>
|
||||
@@ -1,28 +0,0 @@
|
||||
<% if @vehicles.present? %>
|
||||
|
||||
<% @vehicles.each do |vehicle| %>
|
||||
<div class="row">
|
||||
<div>
|
||||
<b><%= link_to "##{vehicle.id}", vehicle_path(vehicle) %> </b>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<%= vehicle.to_s %>
|
||||
<br/>
|
||||
<%= vehicle.customer %>
|
||||
<br/>
|
||||
<%= vehicle.vin %>
|
||||
</div>
|
||||
</div>
|
||||
<br/>
|
||||
<% end %>
|
||||
|
||||
<div class="actions">
|
||||
<%= will_paginate @vehicles %>
|
||||
</div>
|
||||
|
||||
<p><%=t(:label_matching)%> <%=@vehicles.count%> <%=t(:field_vehicles) %> </p>
|
||||
|
||||
<% else %>
|
||||
<p><%=t(:label_no_vehicles)%> <%= params[:search] %>.</p>
|
||||
<% end %>
|
||||
@@ -1,4 +0,0 @@
|
||||
<%= form_tag(vehicles_path, :method => "get", id: "search-form") do %>
|
||||
<%= text_field_tag :search, params[:search], placeholder: t(:label_search_vin), :autocomplete => "off" %>
|
||||
<%= submit_tag t(:label_search) %>
|
||||
<% end %>
|
||||
@@ -1 +0,0 @@
|
||||
<option value="<%= vehicle.id %>"><%= vehicle.to_s.titleize %></option>
|
||||
@@ -1,3 +0,0 @@
|
||||
<h1><%=t(:label_edit_customer_vehicle)%></h1>
|
||||
<br/>
|
||||
<%= render :partial => 'vehicles/form' %>
|
||||
@@ -1,4 +0,0 @@
|
||||
<h2><%=t(:label_cusomer_vehicles)%> <span style="float:right"> <%= render :partial => 'vehicles/search' %> </span> </h2>
|
||||
<br/>
|
||||
|
||||
<%= render :partial => 'vehicles/list' %>
|
||||
@@ -1,3 +0,0 @@
|
||||
<h2><%=t(:label_new_vehicle)%></h2>
|
||||
<br/>
|
||||
<%= render :partial => 'vehicles/form' %>
|
||||
@@ -1,14 +0,0 @@
|
||||
<h2><%=t(:field_vehicle)%> #<%=@vehicle.id%> <span style="float:right"> <%= render :partial => 'customers/search' %> </span> </h2>
|
||||
<br/>
|
||||
|
||||
<div style="text-align: left; width:90%;">
|
||||
<%= render :partial => 'vehicles/details', locals: {vehicle: @vehicle} %>
|
||||
|
||||
<p><b><%=@issues.open.count%> <%=t(:label_open_issues)%> </b> </p>
|
||||
|
||||
<%= render :partial => 'issues/list_simple', locals: {issues: @issues.open} %>
|
||||
|
||||
<p><b><%=@closed_issues.count%> <%=t(:label_closed_issues)%> </b> </p>
|
||||
|
||||
<%= render :partial => 'issues/list_simple', locals: {issues: (@closed_issues)} %>
|
||||
</div>
|
||||
@@ -1,23 +1,20 @@
|
||||
$(function() {
|
||||
$("input#issue_customer_id").on("change", function() {
|
||||
$.ajax({
|
||||
url: "/filter_vehicles_by_customer",
|
||||
type: "GET",
|
||||
data: { selected_customer: $("input#issue_customer_id").val() }
|
||||
});
|
||||
function updateLink() {
|
||||
console.log("updateLink called");
|
||||
const linkElement = document.getElementById("appointment_link");
|
||||
const regex = /((?:<br\/>|%3Cbr\/?%3E))([\s\S]*?)(&dates)/gi;
|
||||
linkElement.href = linkElement.href.replace(regex, `$1${getSelectedDocs()}$3`);
|
||||
}
|
||||
|
||||
$.ajax({
|
||||
url: "/filter_estimates_by_customer",
|
||||
type: "GET",
|
||||
data: { selected_customer: $("input#issue_customer_id").val() }
|
||||
});
|
||||
});
|
||||
function getSelectedDocs() {
|
||||
const appointent_extras = document.querySelectorAll('.appointment');
|
||||
|
||||
$("input#project_customer_id").on("change", function() {
|
||||
$.ajax({
|
||||
url: "/filter_vehicles_by_customer",
|
||||
type: "GET",
|
||||
data: { selected_customer: $("input#project_customer_id").val() }
|
||||
});
|
||||
});
|
||||
});
|
||||
let output = '';
|
||||
for (const item of appointent_extras) {
|
||||
if (item.checked) {
|
||||
console.log(`Checked item: ${item.dataset.text} with URL: ${item.dataset.url}`);
|
||||
output += `%0A`+ encodeURIComponent(`<a href="${window.location.origin}${item.dataset.url}">${item.dataset.text}</a>`) +`%0A`;
|
||||
}
|
||||
}
|
||||
|
||||
return output;
|
||||
}
|
||||
|
||||
@@ -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);
|
||||
102
assets/javascripts/autocomplete.js
Normal file
@@ -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);
|
||||
});
|
||||
|
||||
})();
|
||||
17
assets/javascripts/checkbox_controller.js
Normal file
@@ -0,0 +1,17 @@
|
||||
document.addEventListener('DOMContentLoaded', () => {
|
||||
const select_all_invoice = document.getElementById('select-all-invoices');
|
||||
const invoices = document.querySelectorAll('.invoice-checkbox');
|
||||
|
||||
if (select_all_invoice) {
|
||||
select_all_invoice.addEventListener('change', (e) => {
|
||||
invoices.forEach(item => item.checked = e.target.checked);
|
||||
});
|
||||
}
|
||||
|
||||
invoices.forEach(item => {
|
||||
item.addEventListener('change', () => {
|
||||
const allChecked = Array.from(invoices).every(i => i.checked);
|
||||
select_all_invoice.checked = allChecked;
|
||||
});
|
||||
});
|
||||
});
|
||||
5
assets/stylesheets/autocomplete.css
Normal file
@@ -0,0 +1,5 @@
|
||||
/* Keep Redmine default look, just enhance metadata */
|
||||
.ui-autocomplete .autocomplete-meta {
|
||||
color: #888;
|
||||
font-size: 0.9em;
|
||||
}
|
||||