ledger_sync 1.0.10 → 1.1.1

data/lib/ledger_sync/adaptors/quickbooks_online/searcher.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      class Searcher < Adaptors::Searcher
+        def next_searcher
+          paginate(limit: limit, offset: offset + limit)
+        end
+
+        def previous_searcher
+          return nil if offset <= 1
+
+          paginate(limit: limit, offset: offset - limit)
+        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 limit
+          pagination.fetch(:limit, 10).to_i
+        end
+
+        def offset
+          pagination.fetch(:offset, 1).to_i
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/quickbooks_online/transfer/operations/create.rb

@@ -0,0 +1,52 @@
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      module Transfer
+        module Operations
+          class Create < Operation::Create
+            class Contract < LedgerSync::Adaptors::Contract
+              params do
+                required(:ledger_id).value(:nil)
+                required(:from_account).hash(Types::Reference)
+                required(:to_account).hash(Types::Reference)
+                required(:amount).filled(:integer)
+                required(:currency).filled(:string)
+                required(:memo).filled(:string)
+                required(:transaction_date).filled(:date?)
+              end
+            end
+
+            private
+
+            def operate
+              response = adaptor.post(
+                resource: 'transfer',
+                payload: local_resource_data
+              )
+
+              resource.ledger_id = response.dig('Id')
+              success(response: response)
+            end
+
+            def local_resource_data
+              {
+                'CurrencyRef' => {
+                  'value' => resource.currency,
+                },
+                'Amount' => resource.amount,
+                'TxnDate' => resource.transaction_date.to_s, # Format: YYYY-MM-DD
+                'PrivateNote' => resource.memo,
+                'FromAccountRef' => {
+                  'value' => resource.from_account.ledger_id
+                },
+                'ToAccountRef' => {
+                  'value' => resource.to_account.ledger_id
+                }
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/quickbooks_online/transfer/operations/find.rb

@@ -0,0 +1,36 @@
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      module Transfer
+        module Operations
+          class Find < Operation::Find
+            class Contract < LedgerSync::Adaptors::Contract
+              schema do
+                required(:ledger_id).filled(:string)
+                required(:from_account).hash(Types::Reference)
+                required(:to_account).hash(Types::Reference)
+                required(:amount).maybe(:integer)
+                required(:currency).maybe(:string)
+                required(:memo).maybe(:string)
+                required(:transaction_date).maybe(:date?)
+              end
+            end
+
+            private
+
+            def operate
+              return failure(nil) if resource.ledger_id.nil?
+
+              response = adaptor.find(
+                resource: 'transfer',
+                id: resource.ledger_id
+              )
+
+              success(response: response)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/quickbooks_online/transfer/operations/update.rb

@@ -0,0 +1,57 @@
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      module Transfer
+        module Operations
+          class Update < Operation::Update
+            class Contract < LedgerSync::Adaptors::Contract
+              schema do
+                required(:ledger_id).filled(:string)
+                required(:from_account).hash(Types::Reference)
+                required(:to_account).hash(Types::Reference)
+                required(:amount).filled(:integer)
+                required(:currency).filled(:string)
+                required(:memo).filled(:string)
+                required(:transaction_date).filled(:date?)
+              end
+            end
+
+            private
+
+            def operate
+              ledger_resource_data = adaptor.find(
+                resource: 'transfer',
+                id: resource.ledger_id
+              )
+              response = adaptor.post(
+                resource: 'transfer',
+                payload: merge_into(from: local_resource_data, to: ledger_resource_data)
+              )
+
+              resource.ledger_id = response.dig('Id')
+              success(response: response)
+            end
+
+            def local_resource_data
+              {
+                'CurrencyRef' => {
+                  'value' => resource.currency,
+                },
+                'Amount' => resource.amount,
+                'TxnDate' => resource.transaction_date.to_s, # Format: YYYY-MM-DD
+                'PrivateNote' => resource.memo,
+                'FromAccountRef' => {
+                  'value' => resource.from_account.ledger_id
+                },
+                'ToAccountRef' => {
+                  'value' => resource.to_account.ledger_id
+                }
+              }
+
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/quickbooks_online/vendor/operations/create.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      module Vendor
+        module Operations
+          class Create < Operation::Create
+            class Contract < LedgerSync::Adaptors::Contract
+              params do
+                required(:ledger_id).value(:nil)
+                optional(:display_name).maybe(:string)
+                optional(:first_name).maybe(:string)
+                optional(:last_name).maybe(:string)
+                optional(:email).maybe(:string)
+              end
+            end
+
+            private
+
+            def operate
+              response = adaptor.post(
+                resource: 'vendor',
+                payload: local_resource_data
+              )
+
+              resource.ledger_id = response.dig('Id')
+              success(response: response)
+            end
+
+            def local_resource_data
+              {
+                'DisplayName' => resource.display_name,
+                'GivenName' => resource.first_name,
+                'FamilyName' => resource.last_name,
+                'PrimaryEmailAddr' => {
+                  'Address' => resource.email
+                }
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/quickbooks_online/vendor/operations/find.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      module Vendor
+        module Operations
+          class Find < Operation::Find
+            class Contract < LedgerSync::Adaptors::Contract
+              params do
+                required(:ledger_id).filled(:string)
+                required(:display_name).maybe(:string)
+                required(:first_name).maybe(:string)
+                required(:last_name).maybe(:string)
+                optional(:email).maybe(:string)
+              end
+            end
+
+            private
+
+            def operate
+              return failure(nil) if resource.ledger_id.nil?
+
+              response = adaptor.find(
+                resource: 'vendor',
+                id: resource.ledger_id
+              )
+
+              success(response: response)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/quickbooks_online/vendor/operations/update.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      module Vendor
+        module Operations
+          class Update < Operation::Update
+            class Contract < LedgerSync::Adaptors::Contract
+              params do
+                required(:ledger_id).filled(:string)
+                optional(:display_name).maybe(:string)
+                optional(:first_name).maybe(:string)
+                optional(:last_name).maybe(:string)
+                optional(:email).maybe(:string)
+              end
+            end
+
+            private
+
+            def operate
+              ledger_resource_data = adaptor.find(
+                resource: 'vendor',
+                id: resource.ledger_id
+              )
+
+              response = adaptor.post(
+                resource: 'vendor',
+                payload: merge_into(from: local_resource_data, to: ledger_resource_data)
+              )
+
+              resource.ledger_id = response.dig('Id')
+              success(response: response)
+            end
+
+            def local_resource_data
+              {
+                'DisplayName' => resource.display_name,
+                'GivenName' => resource.first_name,
+                'FamilyName' => resource.last_name,
+                'PrimaryEmailAddr' => {
+                  'Address' => resource.email
+                }
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/quickbooks_online/vendor/searcher.rb

@@ -0,0 +1,64 @@
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      module Vendor
+        class Searcher < LedgerSync::Adaptors::Searcher
+          def next_searcher
+            paginate(limit: limit, offset: offset + limit)
+          end
+
+          def previous_searcher
+            return nil if offset <= 1
+
+            paginate(limit: limit, offset: offset - limit)
+          end
+
+          def resources
+            @resources ||= begin
+              adaptor
+                .query(
+                  resource: 'vendor',
+                  query: "DisplayName LIKE '%#{query}%'",
+                  limit: limit,
+                  offset: offset
+                )
+                .map do |c|
+                  LedgerSync::Vendor.new(
+                    ledger_id: c.fetch('Id'),
+                    display_name: c.fetch('DisplayName'),
+                    first_name: c.dig('GivenName'),
+                    last_name: c.dig('FamilyName')
+                  )
+                end
+            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 limit
+            pagination.fetch(:limit, 10).to_i
+          end
+
+          def offset
+            pagination.fetch(:offset, 1).to_i
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/searcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LedgerSync
   module Adaptors
     class Searcher
@@ -61,4 +63,4 @@ module LedgerSync
       end
     end
   end
-end
+end

data/lib/ledger_sync/adaptors/test/account/operations/create.rb

@@ -0,0 +1,53 @@
+module LedgerSync
+  module Adaptors
+    module Test
+      module Account
+        module Operations
+          class Create < Operation::Create
+            class Contract < LedgerSync::Adaptors::Contract
+              schema do
+                required(:ledger_id).value(:nil)
+                required(:name).filled(:string)
+                required(:classification).filled(:string)
+                required(:account_type).filled(:string)
+                required(:account_sub_type).filled(:string)
+                required(:number).maybe(:integer)
+                required(:currency).maybe(:string)
+                required(:description).maybe(:string)
+                required(:active).maybe(:bool)
+              end
+            end
+
+            private
+
+            def id
+              SecureRandom.uuid
+            end
+
+            def local_resource_data
+              {
+                'name' => resource.name,
+                'classification' => resource.classification,
+                'account_type' => resource.account_type,
+                'account_sub_type' => resource.account_sub_type
+              }
+            end
+
+            def operate
+              response = adaptor.post(
+                resource: 'account',
+                payload: local_resource_data.merge(
+                  'id' => id
+                )
+              )
+
+              resource.ledger_id = response.dig('id')
+
+              success(response: response)
+            end
+          end
+        end
+      end
+    end
+  end
+end