ledger_sync 1.3.3 → 1.4.2

data/lib/ledger_sync/{adaptors → ledgers}/quickbooks_online/bill/searcher.rb

@@ -3,9 +3,9 @@
 require_relative '../searcher'
 
 module LedgerSync
-  module Adaptors
+  module Ledgers
     module QuickBooksOnline
-      module Bill
+      class Bill
         class Searcher < QuickBooksOnline::Searcher
         end
       end

data/lib/ledger_sync/ledgers/quickbooks_online/bill/serializer.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative '../bill_line_item/serializer'
+require_relative '../currency/serializer'
+
+module LedgerSync
+  module Ledgers
+    module QuickBooksOnline
+      class Bill
+        class Serializer < QuickBooksOnline::Serializer
+          id
+
+          references_one :CurrencyRef,
+                         resource_attribute: :currency,
+                         serializer: Currency::Serializer
+
+          date 'DueDate',
+               resource_attribute: :due_date
+
+          attribute 'PrivateNote', resource_attribute: :memo
+
+          date 'TxnDate',
+               resource_attribute: :transaction_date
+
+          attribute 'VendorRef.value',
+                    resource_attribute: 'vendor.ledger_id'
+
+          attribute 'APAccountRef.value',
+                    resource_attribute: 'account.ledger_id'
+
+          attribute 'DepartmentRef.value',
+                    resource_attribute: 'department.ledger_id'
+
+          attribute 'DocNumber',
+                    resource_attribute: :reference_number
+
+          references_many 'Line',
+                          resource_attribute: :line_items,
+                          serializer: BillLineItem::Serializer
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/ledgers/quickbooks_online/bill_line_item/deserializer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module QuickBooksOnline
+      class BillLineItem
+        class Deserializer < QuickBooksOnline::Deserializer
+          id
+
+          attribute 'account.ledger_id',
+                    hash_attribute: 'AccountBasedExpenseLineDetail.AccountRef.value'
+
+          attribute 'ledger_class.ledger_id',
+                    hash_attribute: 'AccountBasedExpenseLineDetail.ClassRef.value'
+
+          amount :amount,
+                 hash_attribute: 'Amount'
+
+          attribute :description,
+                    hash_attribute: 'Description'
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/ledgers/quickbooks_online/bill_line_item/serializer.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module QuickBooksOnline
+      class BillLineItem
+        class Serializer < QuickBooksOnline::Serializer
+          id
+
+          attribute 'DetailType' do
+            'AccountBasedExpenseLineDetail'
+          end
+
+          attribute 'AccountBasedExpenseLineDetail.AccountRef.value',
+                    resource_attribute: 'account.ledger_id'
+
+          attribute 'AccountBasedExpenseLineDetail.ClassRef.value',
+                    resource_attribute: 'ledger_class.ledger_id'
+
+          amount 'Amount',
+                 resource_attribute: :amount
+
+          attribute 'Description',
+                    resource_attribute: :description
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/ledgers/quickbooks_online/bill_payment/deserializer.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative '../currency/deserializer'
+require_relative '../department/deserializer'
+require_relative '../bill_payment_line_item/deserializer'
+
+module LedgerSync
+  module Ledgers
+    module QuickBooksOnline
+      class BillPayment
+        class Deserializer < QuickBooksOnline::Deserializer
+          id
+
+          amount :amount,
+                 hash_attribute: 'TotalAmt'
+
+          references_one :currency,
+                         hash_attribute: :CurrencyRef,
+                         deserializer: Currency::Deserializer
+
+          attribute 'vendor.ledger_id',
+                    hash_attribute: 'VendorRef.value'
+
+          attribute 'department.ledger_id',
+                    hash_attribute: 'DepartmentRef.value'
+
+          attribute 'account.ledger_id',
+                    hash_attribute: 'APAccountRef.value'
+
+          attribute :reference_number,
+                    hash_attribute: 'DocNumber'
+
+          attribute :memo,
+                    hash_attribute: 'PrivateNote'
+
+          attribute :exchange_rate,
+                    hash_attribute: 'ExchangeRate'
+
+          date :transaction_date,
+               hash_attribute: 'TxnDate'
+
+          mapping :payment_type,
+                  hash_attribute: 'PayType',
+                  hash: BillPayment::PAYMENT_TYPES.invert
+
+          attribute 'credit_card_account.ledger_id',
+                    hash_attribute: 'CreditCardPayment.CCAccountRef.value'
+
+          attribute 'bank_account.ledger_id',
+                    hash_attribute: 'CheckPayment.BankAccountRef.value'
+
+          references_many :line_items,
+                          hash_attribute: 'Line',
+                          deserializer: BillPaymentLineItem::Deserializer
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/ledgers/quickbooks_online/bill_payment/operations/create.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module QuickBooksOnline
+      class BillPayment
+        module Operations
+          class Create < Operation::Create
+            class Contract < LedgerSync::Ledgers::Contract
+              params do
+                required(:external_id).maybe(:string)
+                optional(:account).hash(Types::Reference)
+                required(:amount).filled(:integer)
+                optional(:bank_account).maybe(Types::Reference)
+                optional(:credit_card_account).maybe(Types::Reference)
+                required(:currency).filled(:hash, Types::Reference)
+                required(:department).hash(Types::Reference)
+                optional(:exchange_rate).maybe(:float)
+                required(:ledger_id).value(:nil)
+                required(:line_items).array(Types::Reference)
+                optional(:memo).filled(:string)
+                required(:payment_type).filled(:string)
+                optional(:reference_number).maybe(:string)
+                optional(:transaction_date).filled(:date?)
+                required(:vendor).hash(Types::Reference)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/ledgers/quickbooks_online/bill_payment/operations/find.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module QuickBooksOnline
+      class BillPayment
+        module Operations
+          class Find < Operation::Find
+            class Contract < LedgerSync::Ledgers::Contract
+              schema do
+                required(:external_id).maybe(:string)
+                optional(:account).hash(Types::Reference)
+                optional(:amount).maybe(:integer)
+                optional(:bank_account).maybe(Types::Reference)
+                optional(:credit_card_account).maybe(Types::Reference)
+                required(:currency).maybe(:hash, Types::Reference)
+                optional(:department).hash(Types::Reference)
+                optional(:exchange_rate).maybe(:float)
+                required(:ledger_id).filled(:string)
+                optional(:line_items).array(Types::Reference)
+                optional(:memo).maybe(:string)
+                optional(:payment_type).maybe(:string)
+                optional(:reference_number).maybe(:string)
+                optional(:transaction_date).maybe(:date?)
+                optional(:vendor).hash(Types::Reference)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/ledgers/quickbooks_online/bill_payment/operations/update.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module QuickBooksOnline
+      class BillPayment
+        module Operations
+          class Update < Operation::FullUpdate
+            class Contract < LedgerSync::Ledgers::Contract
+              schema do
+                required(:external_id).maybe(:string)
+                optional(:account).hash(Types::Reference)
+                required(:amount).filled(:integer)
+                optional(:bank_account).maybe(Types::Reference)
+                optional(:credit_card_account).maybe(Types::Reference)
+                required(:currency).filled(:hash, Types::Reference)
+                required(:department).hash(Types::Reference)
+                optional(:exchange_rate).maybe(:float)
+                required(:ledger_id).filled(:string)
+                required(:line_items).array(Types::Reference)
+                optional(:memo).filled(:string)
+                required(:payment_type).filled(:string)
+                optional(:reference_number).maybe(:string)
+                optional(:transaction_date).filled(:date?)
+                required(:vendor).hash(Types::Reference)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/ledgers/quickbooks_online/bill_payment/serializer.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative '../currency/serializer'
+require_relative '../department/serializer'
+require_relative '../bill_payment_line_item/serializer'
+
+module LedgerSync
+  module Ledgers
+    module QuickBooksOnline
+      class BillPayment
+        class Serializer < QuickBooksOnline::Serializer
+          id
+
+          amount 'TotalAmt',
+                 resource_attribute: :amount
+
+          references_one :CurrencyRef,
+                         resource_attribute: :currency,
+                         serializer: Currency::Serializer
+
+          attribute 'VendorRef.value',
+                    resource_attribute: 'vendor.ledger_id'
+
+          attribute 'DepartmentRef.value',
+                    resource_attribute: 'department.ledger_id'
+
+          attribute 'APAccountRef.value',
+                    resource_attribute: 'account.ledger_id'
+
+          attribute 'DocNumber',
+                    resource_attribute: :reference_number
+
+          attribute 'PrivateNote',
+                    resource_attribute: :memo
+
+          attribute 'ExchangeRate',
+                    resource_attribute: :exchange_rate
+
+          date 'TxnDate',
+               resource_attribute: :transaction_date
+
+          mapping 'PayType',
+                  resource_attribute: :payment_type,
+                  hash: BillPayment::PAYMENT_TYPES
+
+          attribute 'CreditCardPayment' do |args = {}|
+            resource = args.fetch(:resource)
+
+            if resource.credit_card_account
+              {
+                'CCAccountRef' => {
+                  'value' => resource.credit_card_account.ledger_id
+                }
+              }
+            end
+          end
+
+          attribute 'CheckPayment' do |args = {}|
+            resource = args.fetch(:resource)
+
+            if resource.bank_account
+              {
+                'BankAccountRef' => {
+                  'value' => resource.bank_account.ledger_id
+                }
+              }
+            end
+          end
+
+          references_many 'Line',
+                          resource_attribute: :line_items,
+                          serializer: BillPaymentLineItem::Serializer
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/ledgers/quickbooks_online/bill_payment_line_item/deserializer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module QuickBooksOnline
+      class BillPaymentLineItem
+        class Deserializer < QuickBooksOnline::Deserializer
+          amount :amount,
+                 hash_attribute: 'Amount'
+
+          attribute :ledger_transactions,
+                    hash_attribute: 'LinkedTxn',
+                    type: Serialization::Type::DeserializeTransactionReferenceType.new
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/ledgers/quickbooks_online/bill_payment_line_item/serializer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module QuickBooksOnline
+      class BillPaymentLineItem
+        class Serializer < QuickBooksOnline::Serializer
+          amount 'Amount',
+                 resource_attribute: :amount
+
+          attribute 'LinkedTxn',
+                    resource_attribute: :ledger_transactions,
+                    type: Serialization::Type::SerializeTransactionReferenceType.new
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/{adaptors/quickbooks_online/adaptor.rb → ledgers/quickbooks_online/client.rb}

@@ -4,18 +4,15 @@ require_relative 'oauth_client'
 require_relative 'dashboard_url_helper'
 
 module LedgerSync
-  module Adaptors
+  module Ledgers
     module QuickBooksOnline
-      class Adaptor < LedgerSync::Adaptors::Adaptor
+      class Client < Ledgers::Client
         OAUTH_HEADERS     = { 'Accept' => 'application/json', 'Content-Type' => 'application/json' }.freeze
         ROOT_URI          = 'https://quickbooks.api.intuit.com'
         REVOKE_TOKEN_URI  = 'https://developer.api.intuit.com/v2/oauth2/tokens/revoke'
         ROOT_SANDBOX_URI  = 'https://sandbox-quickbooks.api.intuit.com'
-        API_RESOURCE_MAPPING_OVERRIDE = {
-          LedgerSync::Expense => 'purchase',
-          LedgerSync::LedgerClass => 'class'
-        }
-        API_RESOURCE_MAPPING_OVERRIDE_REVERSE = API_RESOURCE_MAPPING_OVERRIDE.invert
+        PRODUCTION_APP_URL_BASE = 'https://qbo.intuit.com/app'
+        SANDBOX_APP_URL_BASE    = 'https://app.sandbox.qbo.intuit.com/app'
 
         attr_reader :access_token,
                     :client_id,
@@ -112,7 +109,7 @@ module LedgerSync
         def refresh!
           set_credentials_from_oauth_token(
             token: Request.new(
-              adaptor: self
+              client: self
             ).refresh!
           )
           self
@@ -120,7 +117,7 @@ module LedgerSync
 
         def revoke_token!
           headers = OAUTH_HEADERS.dup.merge('Authorization' => 'Basic ' + Base64.strict_encode64(client_id + ':' + client_secret))
-          LedgerSync::Adaptors::Request.new(
+          LedgerSync::Ledgers::Request.new(
             body: {
               token: access_token
             },
@@ -147,7 +144,7 @@ module LedgerSync
         def update_secrets_in_dotenv
           return if ENV['TEST_ENV'] && !ENV['USE_DOTENV_ADAPTOR_SECRETS']
 
-          filename = File.join(LedgerSync.root, '.env')
+          filename = File.join(Dir.pwd, '.env')
           return unless File.exist?(filename)
 
           prefix = 'QUICKBOOKS_ONLINE_'
@@ -155,11 +152,11 @@ module LedgerSync
           Tempfile.open(".#{File.basename(filename)}", File.dirname(filename)) do |tempfile|
             File.open(filename).each do |line|
               env_key = line.split('=').first
-              adaptor_method = env_key.split(prefix).last.downcase
+              client_method = env_key.split(prefix).last.downcase
 
-              if line =~ /\A#{prefix}/ && respond_to?(adaptor_method)
+              if line =~ /\A#{prefix}/ && respond_to?(client_method)
                 env_value = ENV[env_key]
-                new_value = send(adaptor_method)
+                new_value = send(client_method)
                 tempfile.puts "#{env_key}=#{new_value}"
                 next if env_value == new_value
 
@@ -177,15 +174,22 @@ module LedgerSync
         end
 
         def url_for(resource:)
-          DashboardURLHelper.new(resource: resource, test: test).url
+          DashboardURLHelper.new(
+            resource: resource,
+            base_url: (test ? SANDBOX_APP_URL_BASE : PRODUCTION_APP_URL_BASE)
+          ).url
         end
 
         def self.ledger_attributes_to_save
           %i[access_token expires_at refresh_token refresh_token_expires_at]
         end
 
-        def self.ledger_resource_type_for(resource_class:)
-          API_RESOURCE_MAPPING_OVERRIDE[resource_class] || resource_class.resource_type.to_s
+        def self.ledger_resource_type_overrides
+          {
+            Expense => 'purchase',
+            LedgerClass => 'class',
+            Preferences => 'preferences'
+          }
         end
 
         def self.new_from_env(**override)
@@ -218,10 +222,6 @@ module LedgerSync
           )
         end
 
-        def self.resource_from_ledger_type(type:)
-          API_RESOURCE_MAPPING_OVERRIDE_REVERSE[type.downcase] || LedgerSync.resources[type.downcase.to_sym]
-        end
-
         private
 
         def oauth_base_uri
@@ -230,7 +230,7 @@ module LedgerSync
 
         def request(body: nil, headers: {}, method:, url:)
           Request.new(
-            adaptor: self,
+            client: self,
             body: body,
             headers: headers,
             method: method,