effective_qb_online 0.6.4 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e972afaa191b14e8348a7efe55ed2f5b21ecb5d39c2fbf5de0a0766c3dec8179
-  data.tar.gz: 99b89c7dc278bce7f6478e0e386c5a0a726df3cf4574888255b875aca0491313
+  metadata.gz: 15867b1dfe0acb70639a0d07a4f772288659f3bbb48161fc95587f13c4709365
+  data.tar.gz: 7836486e1ca0178fb7defd247a5e338a78f9124e1e401fc28e29f1b1da175b0c
 SHA512:
-  metadata.gz: 00dae06cea1f1c336310beba68b5224e8f8ec9f4c6a86fa06fe7d1ae65eaa5977ce69c7b87fa36663b9a13ec848b1b2d20a470c9328935373fe5b88efe1b5bd6
-  data.tar.gz: 81e48c7baa086d9a8b6f86f51df0880f5867ff40540eb95d7f5d2fa06a52093f4e6cbbaa8439f2cdcfee741bc8930987f1553a517325394a667c056cb8cdb5f6
+  metadata.gz: e9876ee172702a699a7892957df6a8f129c2b4045a9a4ce66ab1f0b1162eb6c5bdd2b06339afbb61f13f78bf14c79d0f024a3228070d19b83f6a5aa0104d2bb7
+  data.tar.gz: 6b41207fbf79478358b629fb329521e0b9b7c8c819ff914cf632e82d73d618bf9bd8ef5ccdf2ad088bbb7d1456b80977bf8520fd3abce4797a047e5f14c5728b

data/app/mailers/effective/qb_online_mailer.rb

@@ -0,0 +1,19 @@
+module Effective
+  class QbOnlineMailer < EffectiveQbOnline.parent_mailer_class
+    include EffectiveMailer
+
+    def sync_error(resource, opts = {})
+      raise('expected an Effective::QbReceipt') unless resource.kind_of?(Effective::QbReceipt)
+
+      @qb_receipt = resource
+      @order = resource.order
+
+      to = EffectiveOrders.qb_online_sync_error_recipients.presence || EffectiveOrders.mailer_admin
+      subject = subject_for(__method__, "Quickbooks Sync Error - Order ##{@order.to_param}", resource, opts)
+      headers = headers_for(resource, opts)
+
+      mail(to: to, subject: subject, **headers)
+    end
+
+  end
+end

data/app/models/effective/qb_realm.rb

@@ -14,8 +14,9 @@ module Effective
       refresh_token_expires_at    :datetime
 
       # Set on /admin/quickbooks
-      deposit_to_account_id       :string
-      payment_method_id           :string
+      deposit_to_account_id               :string
+      payment_method_id                   :string
+      order_number_as_transaction_number  :boolean, default: false
 
       timestamps
     end

data/app/models/effective/qb_receipt.rb

@@ -74,7 +74,7 @@ module Effective
         assign_attributes(result: 'completed successfully', sales_receipt_id: sales_receipt.id)
         complete!
       rescue => e
-        result = [e.message, *("(intuit_tid: #{e.intuit_tid})" if e.try(:intuit_tid).present?), e.backtrace.first(15).join("\n\n")].join(' ')
+        result = [e.message, ("(intuit_tid: #{e.intuit_tid})" if e.try(:intuit_tid).present?), e.backtrace.first(15)].compact.flatten.join("\n\n")
         assign_attributes(result: result)
         error!
       end
@@ -93,6 +93,7 @@ module Effective
     def error!
       errored!
       EffectiveLogger.error(result, associated: self) if defined?(EffectiveLogger)
+      EffectiveQbOnline.send_email(:sync_error, self)
 
       false
     end

data/app/models/effective/qb_sales_receipt.rb

@@ -70,12 +70,14 @@ module Effective
         receipt.update!(customer_id: customer.id)
       end
 
+      doc_number = (order.to_param if api.realm.order_number_as_transaction_number?)
+
       # Receipt
       sales_receipt = Quickbooks::Model::SalesReceipt.new(
         customer_id: receipt.customer_id,
         deposit_to_account_id: api.realm.deposit_to_account_id,   # The ID of the Account Entity you want the SalesReceipt to be deposited to
         payment_method_id: api.realm.payment_method_id,           # The ID of the PaymentMethod Entity
-        doc_number: order.to_param,                               # This is the transaction # field
+        doc_number: doc_number,                                   # This is the transaction # field
         payment_ref_number: order.to_param,                       # Optional payment reference number/string
         txn_date: order.purchased_at.to_date,
         customer_memo: order.note_to_buyer,
@@ -84,6 +86,9 @@ module Effective
         email_status: 'EmailSent'
       )
 
+      # Allows QuickBooks to auto-generate the transaction number
+      sales_receipt.auto_doc_number! if doc_number.blank?
+
       # Addresses
       sales_receipt.bill_address = api.build_address(order.billing_address) if order.billing_address.present?
       sales_receipt.ship_address = api.build_address(order.shipping_address) if order.shipping_address.present?

data/app/views/admin/qb_online/_company.html.haml

@@ -32,6 +32,15 @@
               .col= f.select :payment_method_id, api.payment_methods_collection, label: false
               .col= f.save
 
+      %tr
+        %td Transaction Number
+        %td
+          = effective_form_with(model: [:admin, api.realm], engine: true) do |f|
+            .row
+              - collection = [["Use our order receipt number", true], ["Use QuickBooks auto-generated number", false]]
+              .col= f.select :order_number_as_transaction_number, collection, label: false
+              .col= f.save
+
       %tr
         %td Items
         %td= link_to 'Quickbooks Items', effective_qb_online.admin_quickbooks_items_path

data/app/views/effective/qb_online_mailer/sync_error.html.haml

@@ -0,0 +1,44 @@
+%p An error occurred while synchronizing Order ##{@order.to_param} to Quickbooks Online
+
+%div
+  %strong Error Message
+= simple_format(@qb_receipt.result)
+
+%div
+  %strong= "Order ##{@order.to_param}"
+  %br
+  = @order.created_at
+  %br
+  = @order.billing_name
+%p
+  - @order.order_items.each do |oi|
+    = "#{oi.name} (#{oi.try(:qb_item_name)})"
+    %br
+
+%p
+  %strong Resolution Steps
+  %br
+
+  - if @qb_receipt.result.to_s.include?('Duplicate Name Exists')
+    %ul
+      %li This customer could not be created because they share a name with an existing Item Name. This could be as a Vendor, Product, or Service.
+      %li Search QuickBooks for the non-customer item name and rename it. Ex: rename "John Doe" to "John Doe (Vendor)"
+      %li Re-run the QuickBooks Sync
+  - elsif @qb_receipt.result.to_s.include?('Unknown Item')
+    %ul
+      %li Confirm the QuickBooks Item Names for this Order within QuickBooks
+      %li If this Item Name does not exist, add it to QuickBooks
+      %li Otherwise, #{link_to('click here', effective_qb_online.edit_admin_qb_receipt_url(@qb_receipt))} to assign the correct Item Name to this Order
+      %li Re-run the QuickBooks Sync
+  - else
+    %ul
+      %li This is an error without a predefined resolution.
+      %li Please contact support.
+
+%hr
+
+%p{style: "text-align: center;"}
+  = link_to "View Quickbooks Sales Receipts", effective_qb_online.admin_quickbooks_url
+
+%p{style: "text-align: center;"}
+  = link_to "View Order ##{@order.to_param}", effective_orders.admin_order_url(@order)

data/config/effective_qb_online.rb

@@ -12,8 +12,18 @@ EffectiveQbOnline.setup do |config|
   # https://github.com/ruckus/quickbooks-ruby
   Quickbooks.sandbox_mode = (ENV['QUICKBOOKS_ONLINE_SANDBOX'].to_s == 'true')
 
-  # Effective Orders
-  # Add the following to your config/intializers/effective_orders.rb
-  # config.use_effective_qb_online = true
-
+  # Mailer Settings
+  # Please see config/initializers/effective_resources.rb for default effective_* gem mailer settings
+  #
+  # Configure the class responsible to send e-mails.
+  # config.mailer = 'Effective::QbOnlineMailer'
+  #
+  # Override effective_resource mailer defaults
+  #
+  # config.parent_mailer = nil      # The parent class responsible for sending emails
+  # config.deliver_method = nil     # The deliver method, deliver_later or deliver_now
+  # config.mailer_layout = nil      # Default mailer layout
+  # config.mailer_sender = nil      # Default From value
+  # config.mailer_admin = nil       # Default To value for Admin correspondence
+  # config.mailer_subject = nil     # Proc.new method used to customize Subject
 end

data/db/migrate/101_create_effective_qb_online.rb

@@ -1,10 +1,10 @@
 class CreateEffectiveQbOnline < ActiveRecord::Migration[6.0]
   def change
-    create_table :qb_realms do |t|
+    create_table :qb_realms, if_not_exists: true do |t|
       t.string :realm_id
 
-      t.integer :deposit_to_account_id
-      t.integer :payment_method_id
+      t.string :deposit_to_account_id
+      t.string :payment_method_id
 
       t.text :access_token
       t.datetime :access_token_expires_at
@@ -12,12 +12,16 @@ class CreateEffectiveQbOnline < ActiveRecord::Migration[6.0]
       t.text :refresh_token
       t.datetime :refresh_token_expires_at
 
+      t.boolean :order_number_as_transaction_number, default: false
+
       t.timestamps
     end
 
-    create_table :qb_receipts do |t|
+    create_table :qb_receipts, if_not_exists: true do |t|
       t.integer :order_id
-      t.integer :customer_id
+
+      t.string :customer_id
+      t.string :sales_receipt_id
 
       t.text :result
 
@@ -27,13 +31,13 @@ class CreateEffectiveQbOnline < ActiveRecord::Migration[6.0]
       t.timestamps
     end
 
-    add_index :qb_receipts, :order_id
+    add_index :qb_receipts, :order_id, if_not_exists: true
 
-    create_table :qb_receipt_items_name do |t|
+    create_table :qb_receipt_items, if_not_exists: true do |t|
       t.integer :qb_receipt_id
       t.integer :order_item_id
 
-      t.integer :item_id
+      t.string :item_id
 
       t.timestamps
     end

data/lib/effective_qb_online/version.rb

@@ -1,3 +1,3 @@
 module EffectiveQbOnline
-  VERSION = '0.6.4'.freeze
+  VERSION = '0.7.1'.freeze
 end

data/lib/effective_qb_online.rb

@@ -8,6 +8,7 @@ module EffectiveQbOnline
   def self.config_keys
     [
       :qb_realms_table_name, :qb_receipts_table_name, :qb_receipt_items_table_name,
+      :mailer, :parent_mailer, :deliver_method, :mailer_layout, :mailer_sender, :mailer_admin, :mailer_subject,
       :oauth_client_id, :oauth_client_secret,
       :layout
     ]
@@ -15,6 +16,10 @@ module EffectiveQbOnline
 
   include EffectiveGem
 
+  def self.mailer_class
+    mailer&.constantize || Effective::QbOnlineMailer
+  end
+
   def self.oauth2_client
     OAuth2::Client.new(
       oauth_client_id,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_qb_online
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.7.1
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-04-09 00:00:00.000000000 Z
+date: 2025-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -216,6 +216,7 @@ files:
 - app/datatables/admin/effective_qb_receipts_datatable.rb
 - app/helpers/effective_qb_online_helper.rb
 - app/jobs/qb_sync_order_job.rb
+- app/mailers/effective/qb_online_mailer.rb
 - app/models/effective/qb_api.rb
 - app/models/effective/qb_realm.rb
 - app/models/effective/qb_receipt.rb
@@ -229,6 +230,7 @@ files:
 - app/views/admin/qb_receipts/_form.html.haml
 - app/views/admin/qb_receipts/edit.html.haml
 - app/views/admin/qb_receipts/new.html.haml
+- app/views/effective/qb_online_mailer/sync_error.html.haml
 - config/effective_qb_online.rb
 - config/routes.rb
 - db/migrate/101_create_effective_qb_online.rb