effective_qb_online 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1a31723c72961dc0ba5993baddd7ac885b7ecd7af18faeafdfb013b9a7e5b7c9
-  data.tar.gz: 4b7b95d44a3781909dcf3c37cab321e4d9a1f0cafb4955e72427dfc48e2062a2
+  metadata.gz: f968250054d40c75ee2bc796e410de19045376c8f08677ee687f3490c9e6112b
+  data.tar.gz: 653edff54bf9a9a1eaace903f2b60097c472de077e6617dacf1dd68cf85035da
 SHA512:
-  metadata.gz: 7836b7fe029d1235578a0eaa8c5baf2585a32af0c506a212ddbd14a8a57b6b02e35515de488249045876227489e3a128979609cf03a9de77780936f71b035c6c
-  data.tar.gz: 4dea0b635bfd1fcb76f2b31ceab639bb721dabbf661d73a4e24eeb553b615fac1720f19491be26d1eef0536ada3da07fa9d74a11f08c01c0ea4f69e937edc463
+  metadata.gz: af13a7eb3903c75dedbcc8cdf234208393fe8f79438321bd7fc9f524c9d3d8c0ba91eb163c494f0919a1127197a0a4d5cf94e18f1417fc6cb7aa4fbd50523213
+  data.tar.gz: 359c596ffac483d5c1599b6008e590a0e58c8127be3ab468a6aab64bcb356035db2dde2de0cb8388bc17f0a5cb4849cac5f6b1424505ea5e5f4c771c1e2ae35f

data/README.md

@@ -1,6 +1,6 @@
-# Effective Quickbooks Online
+# Effective QuickBooks Online
 
-Create Quickbooks Online SalesReceipts for purchased effective orders.
+Create QuickBooks Online SalesReceipts for purchased effective orders. This is an unofficial integration that is not supported by or affiliated with Intuit.
 
 ## Getting Started
 
@@ -44,7 +44,7 @@ Add a link to the admin menu:
 
 ```haml
 - if can? :admin, :effective_qb_online
-  = nav_link_to 'Quickbooks Online', effective_qb_online.admin_quickbooks_path
+  = nav_link_to 'QuickBooks Online', effective_qb_online.admin_quickbooks_path
 ```
 
 and visit `/admin/quickbooks`.
@@ -66,11 +66,11 @@ if user.admin?
 end
 ```
 
-## Configuring Quickbooks Company
+## Configuring QuickBooks Company
 
-This gem has only been tested with a Canadian Quickbooks Online store.
+This gem has only been tested with Canadian Quickbooks Online stores.
 
-It has GST, HST and Tax Exempt tax codes and rates set up ahead of time by Quickbooks.
+It has GST, HST and Tax Exempt tax codes and rates set up ahead of time by QuickBooks.
 
 ## License
 

data/app/controllers/admin/qb_online_controller.rb

@@ -7,7 +7,7 @@ module Admin
 
     # /admin/quickbooks
     def index
-      @page_title = 'Quickbooks Online'
+      @page_title = 'QuickBooks Online'
     end
 
   end

data/app/controllers/effective/qb_oauth_controller.rb

@@ -4,7 +4,7 @@ module Effective
   class QbOauthController < ApplicationController
     before_action(:authenticate_user!) if defined?(Devise)
 
-    # Any user that has priviledges with the Quickbooks Online company could authenticate
+    # Any user that has priviledges with the QuickBooks Online company could authenticate
     # But we assume this user also has admin priviledges on our site
     # This should only be done once anyway
     before_action { EffectiveResources.authorize!(self, :admin, :effective_qb_online) }
@@ -20,7 +20,7 @@ module Effective
       redirect_to(grant_url)
     end
 
-    # This matches the Quickbooks Redirect URI and we have to set it up ahead of time.
+    # This matches the QuickBooks Redirect URI and we have to set it up ahead of time.
     def callback
       return unless params[:code].present? && params[:realmId].present? && params[:state].present?
 
@@ -37,7 +37,7 @@ module Effective
         refresh_token_expires_at: (Time.at(token.expires_at) + 100.days)
       )
 
-      flash[:success] = 'Successfully connected with Quickbooks Online'
+      flash[:success] = 'Successfully connected with QuickBooks Online'
 
       redirect_to(effective_qb_online.admin_quickbooks_path)
     end
@@ -53,7 +53,7 @@ module Effective
       response = token.post('/o/oauth2/revoke', params: { token: realm.refresh_token })
 
       if response.status == 200
-        flash[:success] = 'Successfully revoked from Quickbooks Online'
+        flash[:success] = 'Successfully revoked from QuickBooks Online'
         realm.destroy!
       else
         flash[:danger] = 'Unable to revoke'

data/app/models/effective/qb_api.rb

@@ -1,4 +1,4 @@
-# The Quickbooks namespace comes from quickbooks-ruby gem
+# The QuickBooks namespace comes from quickbooks-ruby gem
 # https://github.com/ruckus/quickbooks-ruby
 
 module Effective
@@ -135,8 +135,8 @@ module Effective
       with_service('TaxRate') { |service| service.all }
     end
 
-    # Returns a Hash of BigNumeral Tax Rate => TaxCode Object
-    # { 0.0 => Quickbooks::Model::TaxCode }
+    # Returns a Hash of BigDecimal.to_s String Tax Rate => TaxCode Object
+    # { '0.0' => 'Quickbooks::Model::TaxCode(Exempt)', '5.0' => 'Quickbooks::Model::TaxCode(GST)' }
     def taxes_collection
       rates = tax_rates()
       codes = tax_codes()
@@ -180,10 +180,10 @@ module Effective
         token = OAuth2::AccessToken.new(EffectiveQbOnline.oauth2_client, realm.access_token, refresh_token: realm.refresh_token)
         yield(token)
       rescue OAuth2::Error, Quickbooks::AuthorizationFailure => e
-        puts "Quickbooks OAuth Error: #{e.message}"
+        puts "QuickBooks OAuth Error: #{e.message}"
 
         attempts += 1
-        raise "unable to refresh Quickbooks OAuth2 token" if attempts >= max_attempts
+        raise "unable to refresh QuickBooks OAuth2 token" if attempts >= max_attempts
 
         # Refresh
         refreshed = token.refresh!

data/app/models/effective/qb_realm.rb

@@ -1,10 +1,10 @@
-# One Quickbooks Realm / Company
+# One QuickBooks Realm / Company
 
 module Effective
   class QbRealm < ActiveRecord::Base
 
     effective_resource do
-      # As per Quickbooks oAuth
+      # As per QuickBooks oAuth
       realm_id                    :string
 
       access_token                :text
@@ -30,7 +30,7 @@ module Effective
     validates :refresh_token_expires_at, presence: true
 
     def to_s
-      'Quickbooks Online Settings'
+      'QuickBooks Online Settings'
     end
 
   end

data/app/models/effective/qb_receipt.rb

@@ -13,7 +13,7 @@ module Effective
       # QuickBooks Customer
       customer_id               :string
 
-      # Quickbooks Online SalesReceipt id, once sync'd
+      # QuickBooks Online SalesReceipt id, once sync'd
       sales_receipt_id          :string
 
       # Any error message from our sync
@@ -57,7 +57,7 @@ module Effective
     end
 
     def sync!(force: false)
-      raise('Already created SalesReceipt with Quickbooks Online') if sales_receipt_id.present? && !force
+      raise('Already created SalesReceipt with QuickBooks Online') if sales_receipt_id.present? && !force
       save!
 
       api = EffectiveQbOnline.api
@@ -68,13 +68,14 @@ module Effective
 
         # Sanity check
         if (expected = api.price_to_amount(order.total)) != sales_receipt.total
-          raise("A Quickbooks Online Sales Receipt has been created with an unexpected total. Quickbooks total is #{sales_receipt.total} but we expected #{expected}. Please adjust the Sales Receipt on Quickbooks")
+          raise("A QuickBooks Online Sales Receipt has been created with an unexpected total. QuickBooks total is #{sales_receipt.total} but we expected #{expected}. Please adjust the Sales Receipt on QuickBooks")
         end
 
         assign_attributes(result: 'completed successfully', sales_receipt_id: sales_receipt.id)
         complete!
       rescue => e
-        assign_attributes(result: e.message)
+        result = [e.message, *("(intuit_tid: #{e.intuit_tid})" if e.try(:intuit_tid).present?)].join(' ')
+        assign_attributes(result: result)
         error!
       end
 

data/app/models/effective/qb_sales_receipt.rb

@@ -1,12 +1,12 @@
 module Effective
   class QbSalesReceipt
 
-    # Build the Quickbooks SalesReceipt from a QbReceipt
+    # Build the QuickBooks SalesReceipt from a QbReceipt
     def self.build_from_receipt!(receipt, api: nil)
       raise('Expected a persisted Effective::QbReceipt') unless receipt.kind_of?(Effective::QbReceipt) && receipt.persisted?
 
       api ||= EffectiveQbOnline.api
-      raise('Expected a connected Quickbooks API') unless api.present?
+      raise('Expected a connected QuickBooks API') unless api.present?
 
       order = receipt.order
       raise('Expected a purchased Effective::Order') unless order.purchased?
@@ -39,7 +39,7 @@ module Effective
         end
 
         if item.blank?
-          raise("Unknown Quickbooks Item for #{purchasable} (#{purchasable.class.name} ##{purchasable.id})")
+          raise("Unknown QuickBooks Item for #{purchasable} (#{purchasable.class.name} ##{purchasable.id})")
         end
 
         receipt_item.update!(item_id: item.id)
@@ -54,7 +54,7 @@ module Effective
       # 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 hte SalesReceipt to be deposited to
+        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
         payment_ref_number: order.to_param,                       # Optional payment reference number/string
         txn_date: order.purchased_at.to_date,
@@ -64,7 +64,7 @@ module Effective
         email_status: 'EmailSent'
       )
 
-      # Allows Quickbooks to auto-generate the transaction number
+      # Allows QuickBooks to auto-generate the transaction number
       sales_receipt.auto_doc_number!
 
       # Addresses

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

@@ -11,9 +11,9 @@
       %td= company_info.country
 
     %tr
-      %td Quickbooks Online
+      %td QuickBooks Online
       %td
-        = link_to('Revoke Access and Disconnect', effective_qb_online.revoke_quickbooks_oauth_path, class: 'btn btn-sm btn-danger', 'data-method': 'delete', 'data-confirm': 'Really disconnect from Quickbooks Online?')
+        = link_to('Revoke Access and Disconnect', effective_qb_online.revoke_quickbooks_oauth_path, class: 'btn btn-sm btn-danger', 'data-method': 'delete', 'data-confirm': 'Really disconnect from QuickBooks Online?')
 
     %tr
       %td Deposit to Account

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

@@ -1,5 +1,5 @@
 %p Welcome!
-%p Please click below to connect this website with your Quickbooks Online company.
+%p Please click below to connect this website with your QuickBooks Online company.
 
 %p
   = link_to(effective_qb_online.quickbooks_oauth_path) do
@@ -7,11 +7,11 @@
 
 %p
   If it's not connecting, make sure the
-  Quickbooks Application has the correct Redirect URI.
+  QuickBooks Application has the correct Redirect URI.
 
 %ul
   %li The url is: #{effective_qb_online.quickbooks_oauth_callback_url}
 
 %p
-  Once connected, a Quickbooks Online Sales Receipt
+  Once connected, a QuickBooks Online Sales Receipt
   will be created when an order is purchased.

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

@@ -3,7 +3,7 @@
 - api = EffectiveQbOnline.api
 
 - if api.blank?
-  = card('Connect to Quickbooks Online') do
+  = card('Connect to QuickBooks Online') do
     = render('connect')
 
 - if api.present?

data/app/views/admin/qb_receipts/_form.html.haml

@@ -11,7 +11,7 @@
     = f.static_field :updated_at
 
     = f.static_field :status
-    = f.static_field :result, label: 'Quickbooks Online Result'
+    = f.static_field :result, label: 'QuickBooks Online Result'
 
     %table.table.table-sm
       %thead
@@ -19,7 +19,7 @@
           %th Id
           %th Order Item
           %th Existing Name
-          %th Quickbooks Online Item
+          %th QuickBooks Online Item
 
       %tbody
         - items_collection = EffectiveQbOnline.api.items_collection

data/config/effective_qb_online.rb

@@ -7,12 +7,12 @@ EffectiveQbOnline.setup do |config|
   # Configure the Layout per controller, or all at once
   # config.layout = { application: 'application', admin: 'admin' }
 
-  # Quickbooks Online Application
+  # QuickBooks Online Application
   # Client and Seceret
   config.oauth_client_id = ENV['QUICKBOOKS_ONLINE_OAUTH_CLIENT_ID']
   config.oauth_client_secret = ENV['QUICKBOOKS_ONLINE_OAUTH_CLIENT_SECRET']
 
-  # Quickbooks API
+  # QuickBooks API
   # https://github.com/ruckus/quickbooks-ruby
   Quickbooks.sandbox_mode = (ENV['QUICKBOOKS_ONLINE_SANDBOX'].to_s == 'true')
 

data/lib/effective_qb_online/version.rb

@@ -1,3 +1,3 @@
 module EffectiveQbOnline
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_qb_online
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Code and Effect
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-18 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -192,7 +192,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Create Quickbooks Online SalesReceipts for purchased effective orders
+description: Create QuickBooks Online SalesReceipts for purchased effective orders
 email:
 - info@codeandeffect.com
 executables: []
@@ -259,5 +259,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
-summary: Create Quickbooks Online SalesReceipts for purchased effective orders
+summary: Create QuickBooks Online SalesReceipts for purchased effective orders
 test_files: []