ledger_sync 1.0.10 → 1.1.1

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

@@ -0,0 +1,38 @@
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      module Account
+        module Operations
+          class Find < Operation::Find
+            class Contract < LedgerSync::Adaptors::Contract
+              params do
+                required(:ledger_id).filled(:string)
+                required(:name).maybe(:string)
+                required(:classification).maybe(:string)
+                required(:account_type).maybe(:string)
+                required(:account_sub_type).maybe(:string)
+                required(:number).maybe(:integer)
+                required(:currency).maybe(:string)
+                required(:description).maybe(:string)
+                required(:active).maybe(:bool)
+              end
+            end
+
+            private
+
+            def operate
+              return failure(nil) if resource.ledger_id.nil?
+
+              response = adaptor.find(
+                resource: 'account',
+                id: resource.ledger_id
+              )
+
+              success(response: response)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'ledger_sync/adaptors/quickbooks_online/account/mapping'
+
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      module Account
+        module Operations
+          class Update < Operation::Update
+            class Contract < LedgerSync::Adaptors::Contract
+              params do
+                required(:ledger_id).filled(:string)
+                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 operate
+              ledger_resource_data = adaptor.find(
+                resource: 'account',
+                id: resource.ledger_id
+              )
+
+              response = adaptor.post(
+                resource: 'account',
+                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
+              {
+                'Name' => resource.name,
+                'Classification' => Mapping::ACCOUNT_CLASSIFICATIONS[resource.classification],
+                'AccountType' => Mapping::ACCOUNT_TYPES[resource.account_type],
+                'AccountSubType' => Mapping::ACCOUNT_SUB_TYPES[resource.account_sub_type],
+                'AcctNum' => resource.number,
+                'CurrencyRef' => {
+                  'value' => resource.currency,
+                },
+                'Description' => resource.description,
+                'Active' => resource.active
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,67 @@
+require 'ledger_sync/adaptors/quickbooks_online/account/mapping'
+
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      module Account
+        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: 'account',
+                  query: "Name LIKE '%#{query}%'",
+                  limit: limit,
+                  offset: offset
+                )
+                .map do |c|
+                  LedgerSync::Account.new(
+                    ledger_id: c.fetch('Id'),
+                    name: c.fetch('Name'),
+                    classification: Mapping::ACCOUNT_CLASSIFICATIONS.invert[c.fetch('Classification')] || c.fetch('Classification'),
+                    account_type: Mapping::ACCOUNT_TYPES.invert[c.fetch('AccountType')] || c.fetch('AccountType'),
+                    account_sub_type: Mapping::ACCOUNT_SUB_TYPES.invert[c.fetch('AccountSubType')] || c.fetch('AccountSubType')
+                  )
+                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/quickbooks_online/adaptor.rb

@@ -19,6 +19,7 @@ module LedgerSync
                     :previous_refresh_tokens,
                     :realm_id,
                     :refresh_token,
+                    :refresh_token_expires_at,
                     :root_uri,
                     :test
 
@@ -43,10 +44,10 @@ module LedgerSync
         end
 
         def find(resource:, id:)
-          url = "#{oauth_base_uri}/#{underscore(resource)}/#{id}"
+          url = "#{oauth_base_uri}/#{resourcify(resource)}/#{id}"
 
           response = request(:get, url, headers: OAUTH_HEADERS.dup)
-          JSON.parse(response.body).dig(resource.capitalize)
+          JSON.parse(response.body).dig(resource.classify)
         end
 
         def parse_operation_error(error:, operation:)
@@ -58,12 +59,19 @@ module LedgerSync
           ).parse
         end
 
+        def post(resource:, payload:)
+          url = "#{oauth_base_uri}/#{resourcify(resource)}"
+
+          response = request(:post, url, headers: OAUTH_HEADERS.dup, body: payload.to_json)
+          JSON.parse(response.body).dig(resource.classify)
+        end
+
         def query(resource:, query:, limit: 10, offset: 1)
-          full_query = "SELECT * FROM #{resource.capitalize} WHERE #{query} STARTPOSITION #{offset} MAXRESULTS #{limit}"
+          full_query = "SELECT * FROM #{resource.classify} WHERE #{query} STARTPOSITION #{offset} MAXRESULTS #{limit}"
           url = "#{oauth_base_uri}/query?query=#{CGI.escape(full_query)}"
 
           response = request(:get, url, headers: OAUTH_HEADERS.dup)
-          JSON.parse(response.body).dig('QueryResponse', resource.capitalize) || []
+          JSON.parse(response.body).dig('QueryResponse', resource.classify) || []
         end
 
         def refresh!
@@ -73,6 +81,7 @@ module LedgerSync
           @access_token = refreshed.token
 
           @expires_at = Time&.at(refreshed.expires_at.to_i)&.to_datetime
+          @refresh_token_expires_at = Time&.at(Time.now.to_i + refreshed.params['x_refresh_token_expires_in'])&.to_datetime unless refreshed.params['x_refresh_token_expires_in'].nil?
 
           @previous_refresh_tokens << refresh_token
           @refresh_token = refreshed.refresh_token
@@ -84,15 +93,8 @@ module LedgerSync
           raise parse_error(error: e)
         end
 
-        def upsert(resource:, payload:)
-          url = "#{oauth_base_uri}/#{underscore(resource)}"
-
-          response = request(:post, url, headers: OAUTH_HEADERS.dup, body: payload.to_json)
-          JSON.parse(response.body).dig(resource.capitalize)
-        end
-
         def self.ledger_attributes_to_save
-          %i[access_token expires_at refresh_token]
+          %i[access_token expires_at refresh_token refresh_token_expires_at]
         end
 
         # def self.url_for(resource:)
@@ -108,10 +110,6 @@ module LedgerSync
           @oauth_base_uri ||= "#{root_uri}/v3/company/#{realm_id}"
         end
 
-        def underscore(str)
-          LedgerSync::Util::StringHelpers.underscore(str)
-        end
-
         def oauth(force: false)
           if @oauth.nil? || force
             @oauth = OAuth2::AccessToken.new(
@@ -154,6 +152,10 @@ module LedgerSync
             adaptor: self
           ).parse
         end
+
+        def resourcify(str)
+          str.tr('_', '')
+        end
       end
     end
   end

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

@@ -0,0 +1,65 @@
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      module Bill
+        module Operations
+          class Create < Operation::Create
+            class Contract < LedgerSync::Adaptors::Contract
+              params do
+                required(:ledger_id).value(:nil)
+                required(:vendor).hash(Types::Reference)
+                required(:account).hash(Types::Reference)
+                required(:currency).filled(:string)
+                required(:memo).maybe(:string)
+                required(:transaction_date).maybe(:date?)
+                required(:due_date).maybe(:date?)
+                required(:line_items).array(Types::Reference)
+              end
+            end
+
+            private
+
+            def operate
+              response = adaptor.post(
+                resource: 'bill',
+                payload: local_resource_data
+              )
+
+              resource.ledger_id = response.dig('Id')
+              success(response: response)
+            end
+
+            def local_resource_data
+              {
+                'CurrencyRef' => {
+                  'value' => resource.currency,
+                },
+                'TxnDate' => resource.transaction_date.to_s, # Format: YYYY-MM-DD
+                'DueDate' => resource.due_date.to_s, # Format: YYYY-MM-DD
+                'PrivateNote' => resource.memo,
+                'VendorRef' => {
+                  'value' => resource.vendor.ledger_id,
+                },
+                'APAccountRef' => {
+                  'value' => resource.account.ledger_id
+                },
+                'Line' => resource.line_items.map do |line_item|
+                  {
+                    'DetailType' => 'AccountBasedExpenseLineDetail',
+                    'AccountBasedExpenseLineDetail' => {
+                      'AccountRef' => {
+                        'value' => line_item.account&.ledger_id
+                      }
+                    },
+                    'Amount' => line_item.amount / 100.0,
+                    'Description' => line_item.description
+                  }
+                end
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      module Bill
+        module Operations
+          class Find < Operation::Find
+            class Contract < LedgerSync::Adaptors::Contract
+              schema do
+                required(:ledger_id).filled(:string)
+                required(:vendor).hash(Types::Reference)
+                required(:account).hash(Types::Reference)
+                required(:currency).maybe(:string)
+                required(:memo).maybe(:string)
+                required(:transaction_date).maybe(:date?)
+                required(:due_date).maybe(:date?)
+                required(:line_items).array(Types::Reference)
+              end
+            end
+
+            private
+
+            def operate
+              return failure(nil) if resource.ledger_id.nil?
+
+              response = adaptor.find(
+                resource: 'bill',
+                id: resource.ledger_id
+              )
+
+              success(response: response)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      module Bill
+        module Operations
+          class Update < Operation::Update
+            class Contract < LedgerSync::Adaptors::Contract
+              schema do
+                required(:ledger_id).filled(:string)
+                required(:vendor).hash(Types::Reference)
+                required(:account).hash(Types::Reference)
+                required(:currency).filled(:string)
+                required(:memo).maybe(:string)
+                required(:transaction_date).maybe(:date?)
+                required(:due_date).maybe(:date?)
+                required(:line_items).array(Types::Reference)
+              end
+            end
+
+            private
+
+            def operate
+              ledger_resource_data = adaptor.find(
+                resource: 'bill',
+                id: resource.ledger_id
+              )
+              response = adaptor.post(
+                resource: 'bill',
+                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,
+                },
+                'TxnDate' => resource.transaction_date.to_s, # Format: YYYY-MM-DD
+                'DueDate' => resource.due_date.to_s, # Format: YYYY-MM-DD
+                'PrivateNote' => resource.memo,
+                'VendorRef' => {
+                  'value' => resource.vendor.ledger_id,
+                },
+                'APAccountRef' => {
+                  'value' => resource.account.ledger_id
+                },
+                'Line' => resource.line_items.map do |line_item|
+                  {
+                    'DetailType' => 'AccountBasedExpenseLineDetail',
+                    'AccountBasedExpenseLineDetail' => {
+                      'AccountRef' => {
+                        'value' => line_item.account&.ledger_id
+                      }
+                    },
+                    'Amount' => line_item.amount / 100.0,
+                    'Description' => line_item.description
+                  }
+                end
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+require_relative '../searcher'
+
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      module Bill
+        class Searcher < QuickBooksOnline::Searcher
+          def resources
+            @resources ||= begin
+              adaptor
+                .query(
+                  resource: 'bill',
+                  limit: limit,
+                  offset: offset
+                )
+                .map do |c|
+                  LedgerSync::Bill.new(
+                    ledger_id: c.fetch('Id')
+                  )
+                end
+            end
+          end
+        end
+      end
+    end
+  end
+end