From 616ee137250a764f30e312ce3834b03eafe78d4f Mon Sep 17 00:00:00 2001 From: Claude Date: Sat, 31 Oct 2026 08:11:27 -0400 Subject: [PATCH] Tidy the plugin settings page - Three sections: QuickBooks connection, Synchronization and Billing. - Synchronization is one table of every synced type (customers, employees, estimates, invoices, payments, items, accounts) with its count, last sync and a Sync link, plus Sync changes and Full sync. The separate billing stats and management boxes are folded into it. - New payments sync (admin only). - Sync links return to the page they were clicked on instead of the home page. - Remove locale strings nothing uses any more. Co-Authored-By: Claude Opus 5.5 Claude-Session: https://claude.ai/code/session_01BiwYMjhoQvL7XsKKfRz4pM --- README.md | 6 ++ app/controllers/accounts_controller.rb | 2 +- app/controllers/customers_controller.rb | 2 +- app/controllers/employees_controller.rb | 2 +- app/controllers/estimates_controller.rb | 2 +- app/controllers/invoices_controller.rb | 2 +- app/controllers/items_controller.rb | 2 +- app/controllers/qbo_controller.rb | 2 +- app/controllers/qbo_payments_controller.rb | 9 +- app/views/qbo/_billing_settings.html.erb | 41 -------- app/views/qbo/_settings.html.erb | 108 ++++++++++++--------- config/locales/en.yml | 22 ++--- config/routes.rb | 1 + 13 files changed, 90 insertions(+), 111 deletions(-) diff --git a/README.md b/README.md index 2b95fe1..c5557c4 100644 --- a/README.md +++ b/README.md @@ -308,6 +308,12 @@ Administration → Plugins → Configure Once authentication succeeds, the plugin performs an **initial synchronization**. +The settings page has three sections: + +* **QuickBooks connection**: client ID and secret, webhook token, sandbox, when the access token expires, and Connect to QuickBooks. +* **Synchronization**: customers, employees, estimates, invoices, payments, products/services (items) and accounts, with how many of each are stored, when each last synced and a **Sync** link for each (it re-reads every record of that type). **Sync changes** reads only what changed since the last sync; **Full sync** re-reads everything. The default income account for new products/services is shown here too. +* **Billing**: estimate expiration, "Replaced by imported time" and the issues-from-estimates settings. + --- # User Mapping diff --git a/app/controllers/accounts_controller.rb b/app/controllers/accounts_controller.rb index 1945ed2..f0c7eb8 100644 --- a/app/controllers/accounts_controller.rb +++ b/app/controllers/accounts_controller.rb @@ -32,6 +32,6 @@ class AccountsController < ApplicationController def sync Account.sync - redirect_to :home, flash: { notice: I18n.t(:label_syncing) } + redirect_back fallback_location: home_path, flash: { notice: I18n.t(:label_syncing) } end end \ No newline at end of file diff --git a/app/controllers/customers_controller.rb b/app/controllers/customers_controller.rb index 67ac373..9f85932 100644 --- a/app/controllers/customers_controller.rb +++ b/app/controllers/customers_controller.rb @@ -213,7 +213,7 @@ class CustomersController < ApplicationController def sync Customer.sync - redirect_to :home, flash: { notice: I18n.t(:label_syncing) } + redirect_back fallback_location: home_path, flash: { notice: I18n.t(:label_syncing) } end def update diff --git a/app/controllers/employees_controller.rb b/app/controllers/employees_controller.rb index 373be34..e2e82e9 100644 --- a/app/controllers/employees_controller.rb +++ b/app/controllers/employees_controller.rb @@ -15,7 +15,7 @@ class EmployeesController < ApplicationController def sync Employee.sync - redirect_to :home, flash: { notice: I18n.t(:label_syncing) } + redirect_back fallback_location: home_path, flash: { notice: I18n.t(:label_syncing) } end private diff --git a/app/controllers/estimates_controller.rb b/app/controllers/estimates_controller.rb index 3fa7dc7..3ae33aa 100644 --- a/app/controllers/estimates_controller.rb +++ b/app/controllers/estimates_controller.rb @@ -31,7 +31,7 @@ class EstimatesController < ApplicationController def sync Estimate.sync - redirect_to :home, flash: { notice: I18n.t(:label_syncing) } + redirect_back fallback_location: home_path, flash: { notice: I18n.t(:label_syncing) } end private diff --git a/app/controllers/invoices_controller.rb b/app/controllers/invoices_controller.rb index 5f47c54..afc7908 100644 --- a/app/controllers/invoices_controller.rb +++ b/app/controllers/invoices_controller.rb @@ -34,7 +34,7 @@ class InvoicesController < ApplicationController def sync Invoice.sync - redirect_to :home, flash: { notice: I18n.t(:label_syncing) } + redirect_back fallback_location: home_path, flash: { notice: I18n.t(:label_syncing) } end private diff --git a/app/controllers/items_controller.rb b/app/controllers/items_controller.rb index 89de0a9..5248cd3 100644 --- a/app/controllers/items_controller.rb +++ b/app/controllers/items_controller.rb @@ -76,7 +76,7 @@ class ItemsController < ApplicationController def sync Item.sync - redirect_to :home, flash: { notice: I18n.t(:label_syncing) } + redirect_back fallback_location: home_path, flash: { notice: I18n.t(:label_syncing) } end def update diff --git a/app/controllers/qbo_controller.rb b/app/controllers/qbo_controller.rb index 99821c0..632569f 100644 --- a/app/controllers/qbo_controller.rb +++ b/app/controllers/qbo_controller.rb @@ -70,7 +70,7 @@ class QboController < ApplicationController full_sync = ActiveModel::Type::Boolean.new.cast(params[:full_sync]) QboSyncDispatcher.sync!(full_sync: full_sync) - redirect_to :home, flash: { notice: I18n.t(:label_syncing) } + redirect_back fallback_location: home_path, flash: { notice: I18n.t(:label_syncing) } end # Endpoint to receive QuickBooks webhook notifications. Validates the request and processes the payload to sync relevant data to Redmine. Responds with appropriate HTTP status codes based on success or failure of processing. diff --git a/app/controllers/qbo_payments_controller.rb b/app/controllers/qbo_payments_controller.rb index c43f760..493eb49 100644 --- a/app/controllers/qbo_payments_controller.rb +++ b/app/controllers/qbo_payments_controller.rb @@ -13,10 +13,17 @@ # listed on their payments page. class QboPaymentsController < ApplicationController - before_action :authorize_global + before_action :authorize_global, except: :sync + before_action :require_admin, only: :sync QBO_ERRORS = QboEstimatesController::QBO_ERRORS + # Re-reads every payment from QuickBooks into the local cache (admin, from the plugin settings) + def sync + Payment.sync + redirect_back fallback_location: home_path, flash: { notice: I18n.t(:label_syncing) } + end + # The customer's payments, newest first, read from QuickBooks def index @customer = Customer.find_by(id: params[:customer_id]) diff --git a/app/views/qbo/_billing_settings.html.erb b/app/views/qbo/_billing_settings.html.erb index 27d79cd..9ca563a 100644 --- a/app/views/qbo/_billing_settings.html.erb +++ b/app/views/qbo/_billing_settings.html.erb @@ -40,44 +40,3 @@ <%= l(:text_default_tracker_info) %>

- -<%# QuickBooks product/service list and income accounts (moved from redmine_qbo_lineitems) %> -
-

- - <%= Item.count %> - - (@ <%= Item.last_sync %>) - -

-

- - <%= Account.count %> - - (@ <%= Account.last_sync %>) - -

-

- - <%= Qbo.exists? ? Qbo.last_sync : l(:label_never_synced) %> -

-

- - <%= Account.get_default %> -

-
- -
- <%= l(:label_management_and_sync) %> - -
- <%= link_to t(:label_sync_now_items), sync_items_path, class: 'button icon icon-reload' %> - <%= link_to t(:label_sync_now_accounts), sync_accounts_path, class: 'button icon icon-reload' %> -
- -
- <%= link_to t(:label_items), items_path, class: 'icon icon-list' %> - | - <%= link_to t(:label_accounts), accounts_path, class: 'icon icon-list' %> -
-
\ No newline at end of file diff --git a/app/views/qbo/_settings.html.erb b/app/views/qbo/_settings.html.erb index 1a8d9b2..c68a4d2 100644 --- a/app/views/qbo/_settings.html.erb +++ b/app/views/qbo/_settings.html.erb @@ -3,81 +3,93 @@ intuit.ipp.anywhere.setup({menuProxy: '/path/to/blue-dot', grantUrl: '<%= qbo_authenticate_path %>'}); +<%# QuickBooks connection: app keys, webhook token, sandbox, and the OAuth connection %> +

<%= l(:label_qbo_connection) %>

<%= text_field_tag 'settings[oauth_consumer_key]', settings[:oauth_consumer_key], size: 50 %>

-

<%= password_field_tag 'settings[oauth_consumer_secret]', settings[:oauth_consumer_secret], size: 50 %>

-

<%= text_field_tag 'settings[webhook_token]', settings[:webhook_token], size: 50 %>

-

<%= check_box_tag 'settings[sandbox]', 1, settings[:sandbox] %>

- -
-

- <%= Qbo.oauth2_access_token_expires_at || 'N/A' %> + <%= Qbo.oauth2_access_token_expires_at ? format_time(Qbo.oauth2_access_token_expires_at) : 'N/A' %>

-

- - <%= Customer.count %> - (@ <%= Customer.last_sync %>) -

- -

- - <%= Employee.count %> - (@ <%= Employee.last_sync %>) -

- -

- - <%= Invoice.count %> - (@ <%= Invoice.last_sync %>) -

- -

- - <%= Estimate.count %> - (@ <%= Estimate.last_sync %>) -

- -

- - <%= Qbo.exists? ? Qbo.last_sync : 'Never synced' %> + +

-
- Management & Synchronization - -
- -
+<%# Everything kept in step with QuickBooks: how many records there are, when each last changed, and a sync + button for each. A type's sync re-reads all of its records from QuickBooks. %> +<% sync_rows = [ + [l(:label_customers), Customer, sync_customers_path, customers_path], + [l(:label_employee_plural), Employee, employees_sync_path, nil], + [l(:label_estimates), Estimate, estimates_sync_path, nil], + [l(:label_invoices), Invoice, invoices_sync_path, nil], + [l(:label_payments), Payment, sync_qbo_payments_path, nil], + [l(:label_items), Item, sync_items_path, items_path], + [l(:label_accounts), Account, sync_accounts_path, accounts_path] + ] %> +

<%= l(:label_management_and_sync) %>

+
+ + + + + + + + + + + <% sync_rows.each do |label, model, sync_path, list_path| %> + + + + + + + <% end %> + +
<%= l(:label_qbo_records) %><%= l(:label_last_sync) %>
<%= list_path ? link_to(label, list_path) : label %><%= model.count %><%= model.last_sync %><%= link_to sprite_icon('reload', l(:label_sync)), sync_path, class: 'icon icon-reload' %>
-
- <%= 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' %> -
-
+ -<%# Billing: estimates, issues from estimates, invoices, the product/service list and accounts %> +

+ <%= t(:label_last_sync) %> (QBO): <%= Qbo.exists? ? Qbo.last_sync : l(:label_never_synced) %> + <%= link_to sprite_icon('reload', l(:label_sync_changes)), qbo_sync_path, class: 'button icon icon-reload' %> + <%= link_to sprite_icon('reload', l(:label_full_sync)), qbo_sync_path(full_sync: true), class: 'button icon icon-reload' %> +

+ <%= l(:text_qbo_sync_info) %> + + + + +<%# Billing: estimates, issues from estimates and invoices %>

<%= l(:label_billing_settings) %>

<%= render partial: 'qbo/billing_settings', locals: { settings: settings } %> diff --git a/config/locales/en.yml b/config/locales/en.yml index a771d93..24c33c1 100644 --- a/config/locales/en.yml +++ b/config/locales/en.yml @@ -37,7 +37,6 @@ en: label_closed_issues: "Closed Issues" label_connected: "Successfully connected to QuickBooks" label_create_estimate: "Create Estimate" - label_customer_count: "Customer Count" label_customer_link_expires: "This customer link expires in" label_customer: "Customer" label_customers: "Customers" @@ -49,15 +48,12 @@ en: label_edit: "Edit" label_edit_customer: "Edit Customer" label_email: "Email" - label_employee_count: "Employee Count" label_error: "Error" label_estimate_404: "Estimate not found" - label_estimate_count: "Estimate Count" label_estimate: "Estimate" label_estimates: "Estimates" label_hours: "Hours" label_invoice_404: "Invoice not found" - label_invoice_count: "Invoice Count" label_invoices: "Invoices" label_last_sync: "Last Sync" label_load_customer: "Load Customer" @@ -87,11 +83,6 @@ en: label_share: "Share" label_shipping_address: "Shipping Address" label_sync: "Sync" - label_sync_now: "Sync Now" - label_sync_now_customers: "Sync Customers" - label_sync_now_employees: "Sync Employees" - label_sync_now_invoices: "Sync Invoices" - label_sync_now_estimate: "Sync Estimates" label_syncing: "Syncing QuickBooks" label_trim: "Trim" label_webhook_token: "Intuit QBO Webhook Token" @@ -206,20 +197,23 @@ en: label_active: "Active" label_account: "Account" label_accounts: "Accounts" - label_account_count: "Number of Accounts:" label_back: "Back" label_default_account: "Default Item Income Account" label_description: "Description" label_edit_item: "Edit Item" label_item: "Item" - label_item_count: "Item Count:" label_item_new: "New Item" label_items: "Items" - label_management_and_sync: "Management & Synchronization" + label_management_and_sync: "Synchronization" + label_qbo_connection: "QuickBooks connection" + label_qbo_records: "Records" + label_employee_plural: "Employees" + label_sync_changes: "Sync changes" + label_full_sync: "Full sync" + text_qbo_sync_info: "Sync changes reads what changed in QuickBooks since the last sync; Full sync and each type's Sync re-read every record (e.g. after changing \"Replaced by imported time\", sync estimates and invoices). Webhooks keep things current in between." + text_default_account_info: "New products/services go in this income account; set it on the Accounts page." label_never_synced: "Never synced" label_no: "No" - label_sync_now_accounts: "Sync Accounts" - label_sync_now_items: "Sync Items" label_type: "Type" label_yes: "Yes" error_default_account_not_selected: "Select an account to make it the default." diff --git a/config/routes.rb b/config/routes.rb index 5546e1b..78becfc 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -74,6 +74,7 @@ resources :qbo_payments, only: [:index, :new, :create, :show] do get :pdf end collection do + get :sync get :open_invoices end end