ledger_sync-quickbooks_online 0.1.1

data/lib/ledger_sync/quickbooks_online/resources/journal_entry_line_detail.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative 'account'
+require_relative 'department'
+require_relative 'ledger_class'
+
+module LedgerSync
+  module QuickBooksOnline
+    class JournalEntryLineDetail < QuickBooksOnline::Resource
+      TYPES = {
+        'debit' => 'Debit',
+        'credit' => 'Credit'
+      }.freeze
+
+      references_one :Account, to: Account
+      references_one :Department, to: Department
+      references_one :Class, to: LedgerClass
+      attribute :PostingType, type: Type::StringFromSet.new(values: TYPES.keys)
+
+      def name
+        "#{self.PostingType} #{self.Account.try(:name)}"
+      end
+    end
+  end
+end

data/lib/ledger_sync/quickbooks_online/resources/ledger_class.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module QuickBooksOnline
+    class LedgerClass < QuickBooksOnline::Resource
+      attribute :Name, type: Type::String
+      attribute :FullyQualifiedName, type: Type::String
+      attribute :Active, type: Type::Boolean
+      attribute :SubClass, type: Type::Boolean
+
+      references_one :Parent, to: LedgerClass
+
+      def name
+        self.Name
+      end
+    end
+  end
+end

data/lib/ledger_sync/quickbooks_online/resources/payment.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'account'
+require_relative 'currency'
+require_relative 'customer'
+require_relative 'payment_line'
+
+module LedgerSync
+  module QuickBooksOnline
+    class Payment < QuickBooksOnline::Resource
+      attribute :TotalAmt, type: Type::Integer
+      attribute :PrivateNote, type: Type::String
+      attribute :TxnDate, type: Type::Date
+      attribute :ExchangeRate, type: Type::Float
+      attribute :PaymentRefNum, type: Type::String
+
+      references_one :Customer, to: Customer
+      references_one :DepositToAccount, to: Account
+      references_one :ARAccount, to: Account
+      references_one :Currency, to: Currency
+
+      references_many :Line, to: PaymentLine
+
+      def name
+        "Payment: #{self.TotalAmt} #{self.Currency}"
+      end
+    end
+  end
+end

data/lib/ledger_sync/quickbooks_online/resources/payment_line.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'invoice'
+
+module LedgerSync
+  module QuickBooksOnline
+    class PaymentLine < QuickBooksOnline::Resource
+      attribute :Amount, type: Type::Integer
+
+      references_many :LinkedTxn, to: [Invoice]
+
+      def name
+        self.Amount
+      end
+    end
+  end
+end

data/lib/ledger_sync/quickbooks_online/resources/preferences.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module QuickBooksOnline
+    class Preferences < QuickBooksOnline::Resource
+      attribute :AccountingInfoPrefs, type: Type::Hash
+      attribute :ProductAndServicesPrefs, type: Type::Hash
+      attribute :SalesFormsPrefs, type: Type::Hash
+      attribute :EmailMessagesPrefs, type: Type::Hash
+      attribute :VendorAndPurchasesPrefs, type: Type::Hash
+      attribute :TimeTrackingPrefs, type: Type::Hash
+      attribute :TaxPrefs, type: Type::Hash
+      attribute :CurrencyPrefs, type: Type::Hash
+      attribute :ReportPrefs, type: Type::Hash
+      attribute :OtherPrefs, type: Type::Hash
+
+      def name
+        'Preference'
+      end
+    end
+  end
+end

data/lib/ledger_sync/quickbooks_online/resources/primary_email_addr.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module QuickBooksOnline
+    class PrimaryEmailAddr < QuickBooksOnline::Resource
+      attribute :Address, type: LedgerSync::Type::String
+    end
+  end
+end

data/lib/ledger_sync/quickbooks_online/resources/primary_phone.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module QuickBooksOnline
+    class PrimaryPhone < QuickBooksOnline::Resource
+      attribute :FreeFormNumber, type: LedgerSync::Type::String
+    end
+  end
+end

data/lib/ledger_sync/quickbooks_online/resources/sales_item_line_detail.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative 'item'
+require_relative 'ledger_class'
+
+module LedgerSync
+  module QuickBooksOnline
+    class SalesItemLineDetail < QuickBooksOnline::Resource
+      references_one :Item, to: Item
+      references_one :Class, to: LedgerClass
+
+      def name
+        "#{self.Item.try(:name)} #{self.Class.try(:name)}"
+      end
+    end
+  end
+end

data/lib/ledger_sync/quickbooks_online/resources/transfer.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'account'
+require_relative 'currency'
+
+module LedgerSync
+  module QuickBooksOnline
+    class Transfer < QuickBooksOnline::Resource
+      attribute :Amount, type: Type::Integer
+      attribute :PrivateNote, type: Type::String
+      attribute :TxnDate, type: Type::Date
+
+      references_one :FromAccount, to: Account
+      references_one :ToAccount, to: Account
+      references_one :Currency, to: Currency
+
+      def name
+        "Transfer: #{self.Amount} #{self.Currency}"
+      end
+    end
+  end
+end

data/lib/ledger_sync/quickbooks_online/resources/vendor.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative 'primary_phone'
+require_relative 'primary_email_addr'
+
+module LedgerSync
+  module QuickBooksOnline
+    class Vendor < QuickBooksOnline::Resource
+      attribute :DisplayName, type: Type::String
+      attribute :GivenName, type: Type::String
+      attribute :MiddleName, type: Type::String
+      attribute :FamilyName, type: Type::String
+      attribute :CompanyName, type: Type::String
+
+      references_one :PrimaryPhone, to: PrimaryPhone
+      references_one :PrimaryEmailAddr, to: PrimaryEmailAddr
+
+      def name
+        self.DisplayName
+      end
+    end
+  end
+end

data/lib/ledger_sync/quickbooks_online/sales_item_line_detail/deserializer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../reference/deserializer'
+
+module LedgerSync
+  module QuickBooksOnline
+    class SalesItemLineDetail
+      class Deserializer < QuickBooksOnline::Deserializer
+        references_one :Item,
+                       hash_attribute: 'ItemRef',
+                       deserializer: Reference::Deserializer
+
+        references_one :Class,
+                       hash_attribute: 'ClassRef',
+                       deserializer: Reference::Deserializer
+      end
+    end
+  end
+end

data/lib/ledger_sync/quickbooks_online/sales_item_line_detail/serializer.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative '../reference/serializer'
+
+module LedgerSync
+  module QuickBooksOnline
+    class SalesItemLineDetail
+      class Serializer < QuickBooksOnline::Serializer
+        references_one 'ItemRef',
+                       resource_attribute: :Item,
+                       serializer: Reference::Serializer
+
+        references_one 'ClassRef',
+                       resource_attribute: :Class,
+                       serializer: Reference::Serializer
+      end
+    end
+  end
+end

data/lib/ledger_sync/quickbooks_online/searcher.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module QuickBooksOnline
+    class Searcher < Ledgers::Searcher
+      include LedgerSync::Ledgers::Mixins::OffsetAndLimitPaginationSearcherMixin
+
+      def query_string
+        ''
+      end
+
+      def resources
+        resource_class = self.class.inferred_resource_class
+
+        response = client.query(
+          limit: limit,
+          offset: offset,
+          query: query_string,
+          resource_class: resource_class
+        )
+        return [] if response.body.blank?
+
+        (response.body.dig(
+          'QueryResponse',
+          client.class.ledger_resource_type_for(
+            resource_class: resource_class
+          ).classify
+        ) || []).map do |c|
+          self.class.inferred_deserializer_class.new.deserialize(
+            hash: c,
+            resource: resource_class.new
+          )
+        end
+      end
+
+      def search
+        super
+      rescue OAuth2::Error => e
+        @response = e # TODO: Better catch/raise errors as LedgerSync::Error
+        failure
+      end
+
+      private
+
+      # Pagination uses notation of limit and offset
+      # limit: number of results per page
+      #
+      # offset: position of first result in a list.
+      # starts from 1, not 0
+      #
+      # More here:
+      # https://developer.intuit.com/app/developer/qbo/docs/develop/explore-the-quickbooks-online-api/data-queries#pagination
+      def default_offset
+        1
+      end
+    end
+  end
+end

data/lib/ledger_sync/quickbooks_online/serialization/type/amount_float_to_integer_type.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module QuickBooksOnline
+    module Serialization
+      module Type
+        class AmountFloatToIntegerType < LedgerSync::Type::Value
+          def cast_value(args = {})
+            value = args.fetch(:value)
+
+            return if value.nil?
+
+            (value * 100).to_i
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/quickbooks_online/serialization/type/deserialize_transaction_reference_type.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module QuickBooksOnline
+    module Serialization
+      module Type
+        class DeserializeTransactionReferenceType < LedgerSync::Type::Value
+          def cast_value(value:)
+            return if value.nil?
+
+            raise "Unknown value type.  Array expected.  Given: #{value.class.name}" unless value.is_a?(Array)
+            return if value.empty?
+
+            value.map do |item|
+              resource_class = Client.resource_from_ledger_type(type: item['TxnType'])
+
+              raise "Unknown QuickBooks Online resource type: #{item['TxnType']}" if resource_class.blank?
+
+              resource_class.new(
+                ledger_id: item['TxnId']
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/quickbooks_online/serialization/type/integer_to_amount_float_type.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module QuickBooksOnline
+    module Serialization
+      module Type
+        class IntegerToAmountFloatType < LedgerSync::Type::Value
+          def cast_value(args = {})
+            value = args.fetch(:value)
+
+            return if value.nil?
+
+            value / 100.0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/quickbooks_online/serialization/type/serialize_transaction_reference_type.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module QuickBooksOnline
+    module Serialization
+      module Type
+        class SerializeTransactionReferenceType < LedgerSync::Type::Value
+          def cast_value(value:)
+            return if value.nil?
+            raise "List expected.  Given: #{value.class.name}" unless value.is_a?(Array)
+            unless value.all?(LedgerSync::Resource)
+              raise "Resources expected.  Given: #{value.map { |i| i.class.name }.join(', ')}"
+            end
+
+            value.map do |resource|
+              {
+                'TxnId' => resource.ledger_id,
+                'TxnType' => Client.ledger_resource_type_for(
+                  resource_class: resource.class
+                ).classify
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/quickbooks_online/serializer.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# Gem.find_files('ledger_sync/ledgers/quickbooks_online/serializer_type/**/*.rb').each { |path| require path }
+
+module LedgerSync
+  module QuickBooksOnline
+    class Serializer < LedgerSync::Serializer
+      def serialize(args = {})
+        deep_merge_unmapped_values = args.fetch(:deep_merge_unmapped_values, {})
+        only_changes               = args.fetch(:only_changes, false)
+        resource                   = args.fetch(:resource)
+
+        ret = super(
+          only_changes: only_changes,
+          resource: resource
+        )
+        return ret unless deep_merge_unmapped_values.any?
+
+        deep_merge_if_not_mapped(
+          current_hash: ret,
+          hash_to_search: deep_merge_unmapped_values
+        )
+      end
+
+      def self.amount(hash_attribute, args = {})
+        attribute(
+          hash_attribute,
+          {
+            type: Serialization::Type::IntegerToAmountFloatType.new
+          }.merge(args)
+        )
+      end
+
+      def self.date(hash_attribute, args = {})
+        attribute(
+          hash_attribute,
+          {
+            type: LedgerSync::Serialization::Type::FormatDateType.new(format: '%Y-%m-%d')
+          }.merge(args)
+        )
+      end
+
+      def self.id
+        attribute('Id', resource_attribute: :ledger_id)
+      end
+
+      private
+
+      def deep_merge_if_not_mapped(current_hash:, hash_to_search:)
+        hash_to_search.each do |key, value|
+          current_hash[key] = if current_hash.key?(key)
+                                if value.is_a?(Hash) && current_hash[key].present?
+                                  deep_merge_if_not_mapped(
+                                    current_hash: current_hash[key],
+                                    hash_to_search: value
+                                  )
+                                else
+                                  current_hash[key]
+                                end
+                              else
+                                value
+                              end
+        end
+
+        current_hash
+      end
+    end
+  end
+end