ledger_sync 1.3.4 → 1.4.4

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,13 +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'
+        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,
@@ -94,7 +96,8 @@ module LedgerSync
           ledger_resource_type = self.class.ledger_resource_type_for(
             resource_class: resource_class
           ).classify
-          full_query = "SELECT * FROM #{ledger_resource_type} WHERE #{query} STARTPOSITION #{offset} MAXRESULTS #{limit}"
+          full_query = "SELECT * FROM #{ledger_resource_type} WHERE #{query} STARTPOSITION #{offset} MAXRESULTS "\
+                       "#{limit}"
           url = "#{oauth_base_uri}/query?query=#{CGI.escape(full_query)}"
 
           request(
@@ -107,15 +110,17 @@ module LedgerSync
         def refresh!
           set_credentials_from_oauth_token(
             token: Request.new(
-              adaptor: self
+              client: self
             ).refresh!
           )
           self
         end
 
         def revoke_token!
-          headers = OAUTH_HEADERS.dup.merge('Authorization' => 'Basic ' + Base64.strict_encode64(client_id + ':' + client_secret))
-          LedgerSync::Adaptors::Request.new(
+          headers = OAUTH_HEADERS.dup.merge(
+            'Authorization' => 'Basic ' + Base64.strict_encode64(client_id + ':' + client_secret)
+          )
+          LedgerSync::Ledgers::Request.new(
             body: {
               token: access_token
             },
@@ -139,10 +144,10 @@ module LedgerSync
           oauth_token
         end
 
-        def update_secrets_in_dotenv
+        def update_secrets_in_dotenv # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
           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_'
@@ -150,11 +155,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
 
@@ -164,6 +169,7 @@ module LedgerSync
                 tempfile.puts line
               end
             end
+
             tempfile.close
             FileUtils.mv tempfile.path, filename
           end
@@ -172,7 +178,10 @@ 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
@@ -181,9 +190,9 @@ module LedgerSync
 
         def self.ledger_resource_type_overrides
           {
-            LedgerSync::Expense => 'purchase',
-            LedgerSync::LedgerClass => 'class',
-            LedgerSync::Adaptors::QuickBooksOnline::Preferences => 'preferences'
+            Expense => 'purchase',
+            LedgerClass => 'class',
+            Preferences => 'preferences'
           }
         end
 
@@ -225,7 +234,7 @@ module LedgerSync
 
         def request(body: nil, headers: {}, method:, url:)
           Request.new(
-            adaptor: self,
+            client: self,
             body: body,
             headers: headers,
             method: method,
@@ -238,7 +247,11 @@ module LedgerSync
           @access_token = token.token
 
           @expires_at = Time&.at(token.expires_at.to_i)&.to_datetime
-          @refresh_token_expires_at = Time&.at(Time.now.to_i + token.params['x_refresh_token_expires_in'])&.to_datetime unless token.params['x_refresh_token_expires_in'].nil?
+          unless token.params['x_refresh_token_expires_in'].nil?
+            @refresh_token_expires_at = Time&.at(
+              Time.now.to_i + token.params['x_refresh_token_expires_in']
+            )&.to_datetime
+          end
 
           @previous_refresh_tokens << refresh_token if refresh_token.present?
           @refresh_token = token.refresh_token

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-LedgerSync.register_adaptor(:quickbooks_online, module_string: 'QuickBooksOnline') do |config|
+LedgerSync.register_ledger(:quickbooks_online, module_string: 'QuickBooksOnline') do |config|
   config.name = 'QuickBooks Online'
   config.add_alias :qbo
   config.add_alias :quick_books_online

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module QuickBooksOnline
+      class Currency
+        class Deserializer < QuickBooksOnline::Deserializer
+          attribute :symbol,
+                    hash_attribute: :value
+
+          attribute :name,
+                    hash_attribute: :name
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module QuickBooksOnline
+      class Currency
+        class Serializer < QuickBooksOnline::Serializer
+          attribute :value,
+                    resource_attribute: :symbol
+
+          attribute :name
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module QuickBooksOnline
+      class Customer
+        class Deserializer < QuickBooksOnline::Deserializer
+          id
+
+          attribute :DisplayName
+
+          attribute 'PrimaryPhone.FreeFormNumber'
+
+          attribute 'PrimaryEmailAddr.Address'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module QuickBooksOnline
+      class Customer
+        module Operations
+          class Create < QuickBooksOnline::Operation::Create
+            class Contract < LedgerSync::Ledgers::Contract
+              params do
+                required(:external_id).maybe(:string)
+                required(:ledger_id).value(:nil)
+                required(:PrimaryEmailAddr).maybe(:hash, Types::Reference)
+                optional(:DisplayName).filled(:string)
+                optional(:firstName).maybe(:string)
+                optional(:lastName).maybe(:string)
+                required(:PrimaryPhone).maybe(:hash, Types::Reference)
+                required(:subsidiary).maybe(:hash, Types::Reference)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module QuickBooksOnline
+      class Customer
+        module Operations
+          class Find < QuickBooksOnline::Operation::Find
+            class Contract < LedgerSync::Ledgers::Contract
+              params do
+                required(:external_id).maybe(:string)
+                required(:ledger_id).filled(:string)
+                required(:PrimaryEmailAddr).maybe(:hash, Types::Reference)
+                optional(:DisplayName).maybe(:string)
+                optional(:firstName).maybe(:string)
+                optional(:lastName).maybe(:string)
+                required(:PrimaryPhone).maybe(:hash, Types::Reference)
+                required(:subsidiary).maybe(:hash, Types::Reference)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/{adaptors → ledgers}/quickbooks_online/customer/operations/update.rb

@@ -1,18 +1,20 @@
 # frozen_string_literal: true
 
 module LedgerSync
-  module Adaptors
+  module Ledgers
     module QuickBooksOnline
-      module Customer
+      class Customer
         module Operations
           class Update < QuickBooksOnline::Operation::FullUpdate
-            class Contract < LedgerSync::Adaptors::Contract
+            class Contract < LedgerSync::Ledgers::Contract
               params do
                 required(:external_id).maybe(:string)
                 required(:ledger_id).filled(:string)
-                required(:email).maybe(:string)
-                required(:name).filled(:string)
-                required(:phone_number).maybe(:string)
+                required(:PrimaryEmailAddr).maybe(:hash, Types::Reference)
+                optional(:DisplayName).filled(:string)
+                optional(:firstName).maybe(:string)
+                optional(:lastName).maybe(:string)
+                required(:PrimaryPhone).maybe(:hash, Types::Reference)
                 required(:subsidiary).maybe(:hash, Types::Reference)
               end
             end

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module LedgerSync
-  module Adaptors
+  module Ledgers
     module QuickBooksOnline
-      module Customer
-        class Searcher < LedgerSync::Adaptors::QuickBooksOnline::Searcher
+      class Customer
+        class Searcher < LedgerSync::Ledgers::QuickBooksOnline::Searcher
           def query_string
             "DisplayName LIKE '%#{query}%'"
           end

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module QuickBooksOnline
+      class Customer
+        class Serializer < QuickBooksOnline::Serializer
+          id
+
+          attribute :DisplayName
+
+          attribute 'PrimaryPhone.FreeFormNumber'
+
+          attribute 'PrimaryEmailAddr.Address'
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/ledgers/quickbooks_online/dashboard_url_helper.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module QuickBooksOnline
+      class DashboardURLHelper < LedgerSync::Ledgers::DashboardURLHelper
+        def resource_path # rubocop:disable Metrics/CyclomaticComplexity
+          @resource_path = case resource
+                           when QuickBooksOnline::Account
+                             "/register?accountId=#{resource.ledger_id}"
+                           when QuickBooksOnline::Bill
+                             "/bill?txnId=#{resource.ledger_id}"
+                           when QuickBooksOnline::Customer
+                             "/customerdetail?nameId=#{resource.ledger_id}"
+                           when QuickBooksOnline::Deposit
+                             "/deposit?txnId=#{resource.ledger_id}"
+                           when QuickBooksOnline::Expense
+                             "/expense?txnId=#{resource.ledger_id}"
+                           when QuickBooksOnline::JournalEntry
+                             "/journal?txnId=#{resource.ledger_id}"
+                           when QuickBooksOnline::LedgerClass
+                             '/class'
+                           when QuickBooksOnline::Payment
+                             "/recvpayment?txnId=#{resource.ledger_id}"
+                           when QuickBooksOnline::Transfer
+                             "/transfer?txnId=#{resource.ledger_id}"
+                           when QuickBooksOnline::Vendor
+                             "/vendordetail?nameId=#{resource.ledger_id}"
+                           end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module QuickBooksOnline
+      class Department
+        class Deserializer < QuickBooksOnline::Deserializer
+          id
+
+          attribute :name,
+                    hash_attribute: 'Name'
+          attribute :active,
+                    hash_attribute: 'Active'
+          attribute :sub_department,
+                    hash_attribute: 'SubDepartment'
+          attribute :fully_qualified_name,
+                    hash_attribute: 'FullyQualifiedName'
+
+          attribute(:parent) do |args = {}|
+            hash = args.fetch(:hash)
+
+            LedgerSync::QuickBooks::Department.new(ledger_id: hash['ParentRef']) if hash['ParentRef'].nil?
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/{adaptors → ledgers}/quickbooks_online/department/operations/create.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module LedgerSync
-  module Adaptors
+  module Ledgers
     module QuickBooksOnline
-      module Department
+      class Department
         module Operations
           class Create < QuickBooksOnline::Operation::Create
-            class Contract < LedgerSync::Adaptors::Contract
+            class Contract < LedgerSync::Ledgers::Contract
               params do
                 required(:external_id).maybe(:string)
                 required(:ledger_id).value(:nil)

data/lib/ledger_sync/{adaptors → ledgers}/quickbooks_online/department/operations/find.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module LedgerSync
-  module Adaptors
+  module Ledgers
     module QuickBooksOnline
-      module Department
+      class Department
         module Operations
           class Find < QuickBooksOnline::Operation::Find
-            class Contract < LedgerSync::Adaptors::Contract
+            class Contract < LedgerSync::Ledgers::Contract
               params do
                 required(:external_id).maybe(:string)
                 required(:ledger_id).filled(:string)