ledger_sync 1.1.1 → 1.1.2

data/lib/ledger_sync/adaptors/ledger_serializer_type/references_many_type.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Adaptors
+    module LedgerSerializerType
+      class ReferencesManyType < ValueType
+        def convert_from_ledger(resource_class: nil, serializer:, value:)
+          resource_class ||= serializer._inferred_resource_class
+          return [] if value.nil?
+
+          value.map do |one_value|
+            serializer.new(resource: resource_class.new).deserialize(hash: one_value)
+          end
+        end
+
+        def convert_from_local(serializer:, value:)
+          value.map do |one_value|
+            serializer.new(resource: one_value).to_ledger_hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/ledger_serializer_type/value_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Adaptors
+    module LedgerSerializerType
+      class ValueType
+        def convert_from_ledger(value:)
+          value
+        end
+
+        def convert_from_local(value:)
+          value
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/adaptors/operation.rb

@@ -48,6 +48,7 @@ module LedgerSync
                     :before_operations,
                     :operations,
                     :resource,
+                    :resource_before_perform,
                     :root_operation,
                     :result,
                     :response,
@@ -64,6 +65,7 @@ module LedgerSync
           @before_operations = []
           @operations = []
           @resource = resource
+          @resource_before_perform = resource.dup
           @result = nil
           @root_operation = nil
         end
@@ -104,12 +106,21 @@ module LedgerSync
           @performed == true
         end
 
+        def ledger_serializer
+          @ledger_serializer ||= begin
+            modules = self.class.name.split('::Operations::').first
+            Object.const_get("#{modules}::LedgerSerializer").new(resource: resource)
+          end
+        end
+
         # Results
 
-        def failure(error)
+        def failure(error, resource: nil)
+          @response = error
           @result = LedgerSync::OperationResult.Failure(
             error,
             operation: self,
+            resource: resource,
             response: error
           )
         end
@@ -118,10 +129,12 @@ module LedgerSync
           result.failure?
         end
 
-        def success(response:)
+        def success(resource:, response:)
+          @response = response
           @result = LedgerSync::OperationResult.Success(
             self,
             operation: self,
+            resource: resource,
             response: response
           )
         end
@@ -176,13 +189,6 @@ module LedgerSync
           end
         end
 
-        def merge_into(from:, to:)
-          case to
-          when *(Resource::PRIMITIVES | [Array]) then from
-          else to.merge!(from) { |_key, new_value, old_value| merge_into(from: old_value, to: new_value) } if to && from
-          end
-        end
-
         private
 
         def operate

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Adaptors
+    module QuickBooksOnline
+      module Account
+        class LedgerSerializer < QuickBooksOnline::LedgerSerializer
+          attribute ledger_attribute: 'Id', resource_attribute: :ledger_id
+          attribute ledger_attribute: 'Name', resource_attribute: :name
+          attribute ledger_attribute: 'AccountType', resource_attribute: :account_type, type: LedgerSerializerType::AccountType
+          attribute ledger_attribute: 'AccountSubType', resource_attribute: :account_sub_type, type: LedgerSerializerType::AccountSubType
+          attribute ledger_attribute: 'AcctNum', resource_attribute: :number
+          attribute ledger_attribute: 'CurrencyRef.value', resource_attribute: :currency
+          attribute ledger_attribute: 'Classification', resource_attribute: :classification, type: LedgerSerializerType::ClassificationType
+          attribute ledger_attribute: 'Description', resource_attribute: :description
+          attribute ledger_attribute: 'Active', resource_attribute: :active
+        end
+      end
+    end
+  end
+end

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

@@ -1,51 +1,23 @@
-require 'ledger_sync/adaptors/quickbooks_online/account/mapping'
-
 module LedgerSync
   module Adaptors
     module QuickBooksOnline
       module Account
         module Operations
-          class Create < Operation::Create
+          class Create < QuickBooksOnline::Operation::Create
             class Contract < LedgerSync::Adaptors::Contract
               params do
-                required(:ledger_id).value(:nil)
-                required(:name).filled(:string)
-                required(:classification).filled(:string)
-                required(:account_type).filled(:string)
+                required(:external_id).maybe(:string)
                 required(:account_sub_type).filled(:string)
-                required(:number).maybe(:integer)
+                required(:account_type).filled(:string)
+                required(:active).maybe(:bool)
+                required(:classification).filled(:string)
                 required(:currency).maybe(:string)
                 required(:description).maybe(:string)
-                required(:active).maybe(:bool)
+                required(:ledger_id).value(:nil)
+                required(:name).filled(:string)
+                required(:number).maybe(:integer)
               end
             end
-
-            private
-
-            def operate
-              response = adaptor.post(
-                resource: 'account',
-                payload: local_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

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

@@ -6,6 +6,7 @@ module LedgerSync
           class Find < Operation::Find
             class Contract < LedgerSync::Adaptors::Contract
               params do
+                required(:external_id).maybe(:string)
                 required(:ledger_id).filled(:string)
                 required(:name).maybe(:string)
                 required(:classification).maybe(:string)
@@ -17,19 +18,6 @@ module LedgerSync
                 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

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

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
-require 'ledger_sync/adaptors/quickbooks_online/account/mapping'
-
+# https://developer.intuit.com/app/developer/qbo/docs/api/accounting/all-entities/account
+# Requires full update
 module LedgerSync
   module Adaptors
     module QuickBooksOnline
       module Account
         module Operations
-          class Update < Operation::Update
+          class Update < Operation::FullUpdate
             class Contract < LedgerSync::Adaptors::Contract
               params do
+                required(:external_id).maybe(:string)
                 required(:ledger_id).filled(:string)
                 required(:name).filled(:string)
                 required(:classification).filled(:string)
@@ -21,38 +22,6 @@ module LedgerSync
                 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

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

@@ -1,20 +1,10 @@
-require 'ledger_sync/adaptors/quickbooks_online/account/mapping'
+# frozen_string_literal: true
 
 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
-
+        class Searcher < QuickBooksOnline::Searcher
           def resources
             @resources ||= begin
               adaptor
@@ -25,41 +15,10 @@ module LedgerSync
                   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')
-                  )
+                  LedgerSerializer.new(resource: LedgerSync::Account.new).deserialize(hash: c)
                 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

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

@@ -1,15 +1,17 @@
+# frozen_string_literal: true
+
 require 'oauth2'
 
 module LedgerSync
   module Adaptors
     module QuickBooksOnline
       class Adaptor < LedgerSync::Adaptors::Adaptor
-        AUTHORIZE_URL     = 'https://appcenter.intuit.com/connect/oauth2'.freeze
+        AUTHORIZE_URL     = 'https://appcenter.intuit.com/connect/oauth2'
         OAUTH_HEADERS     = { 'Accept' => 'application/json', 'Content-Type' => 'application/json' }.freeze
-        ROOT_URI          = 'https://quickbooks.api.intuit.com'.freeze
-        ROOT_SANDBOX_URI  = 'https://sandbox-quickbooks.api.intuit.com'.freeze
-        SITE_URL          = 'https://appcenter.intuit.com/connect/oauth2'.freeze
-        TOKEN_URL         = 'https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer'.freeze
+        ROOT_URI          = 'https://quickbooks.api.intuit.com'
+        ROOT_SANDBOX_URI  = 'https://sandbox-quickbooks.api.intuit.com'
+        SITE_URL          = 'https://appcenter.intuit.com/connect/oauth2'
+        TOKEN_URL         = 'https://oauth.platform.intuit.com/oauth2/v1/tokens/bearer'
 
         attr_reader :access_token,
                     :client_id,
@@ -43,7 +45,17 @@ module LedgerSync
           @root_uri = (test ? ROOT_SANDBOX_URI : ROOT_URI)
         end
 
+        def authorization_url(redirect_uri:)
+          oauth_client.auth_code.authorize_url(
+            redirect_uri: redirect_uri,
+            response_type: 'code',
+            state: SecureRandom.hex(12),
+            scope: 'com.intuit.quickbooks.accounting'
+          )
+        end
+
         def find(resource:, id:)
+          resource = resource.to_s
           url = "#{oauth_base_uri}/#{resourcify(resource)}/#{id}"
 
           response = request(:get, url, headers: OAUTH_HEADERS.dup)
@@ -51,7 +63,7 @@ module LedgerSync
         end
 
         def parse_operation_error(error:, operation:)
-          return nil unless error.kind_of?(OAuth2::Error)
+          return nil unless error.is_a?(OAuth2::Error)
 
           Util::OperationErrorParser.new(
             error: error,
@@ -60,6 +72,7 @@ module LedgerSync
         end
 
         def post(resource:, payload:)
+          resource = resource.to_s
           url = "#{oauth_base_uri}/#{resourcify(resource)}"
 
           response = request(:post, url, headers: OAUTH_HEADERS.dup, body: payload.to_json)
@@ -67,6 +80,7 @@ module LedgerSync
         end
 
         def query(resource:, query:, limit: 10, offset: 1)
+          resource = resource.to_s
           full_query = "SELECT * FROM #{resource.classify} WHERE #{query} STARTPOSITION #{offset} MAXRESULTS #{limit}"
           url = "#{oauth_base_uri}/query?query=#{CGI.escape(full_query)}"
 
@@ -75,35 +89,54 @@ module LedgerSync
         end
 
         def refresh!
-          refreshed = oauth.refresh!
+          set_credentials_from_oauth_token(token: oauth.refresh!)
 
-          @previous_access_tokens << access_token
-          @access_token = refreshed.token
+          self
+        rescue OAuth2::Error => e
+          raise parse_error(error: e)
+        end
 
-          @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?
+        def set_credentials_from_oauth_code(code:, redirect_uri:)
+          oauth_token = oauth_client.auth_code.get_token(
+            code,
+            redirect_uri: redirect_uri
+          )
 
-          @previous_refresh_tokens << refresh_token
-          @refresh_token = refreshed.refresh_token
+          set_credentials_from_oauth_token(token: oauth_token)
 
-          oauth(force: true) # Ensure we update the memoized @oauth
+          oauth_token
+        end
 
-          self
-        rescue OAuth2::Error => e
-          raise parse_error(error: e)
+        def url_for(resource:)
+          base_url = test ? 'https://app.sandbox.qbo.intuit.com/app' : 'https://app.qbo.intuit.com/app'
+          resource_path = case resource
+                          when LedgerSync::Account
+                            "/register?accountId=#{resource.ledger_id}"
+                          when LedgerSync::Bill
+                            "/bill?txnId=#{resource.ledger_id}"
+                          when LedgerSync::Customer
+                            "/customerdetail?nameId=#{resource.ledger_id}"
+                          when LedgerSync::Deposit
+                            "/deposit?txnId=#{resource.ledger_id}"
+                          when LedgerSync::Expense
+                            "/expense?txnId=#{resource.ledger_id}"
+                          when LedgerSync::JournalEntry
+                            "/journal?txnId=#{resource.ledger_id}"
+                          when LedgerSync::Payment
+                            "/recvpayment?txnId=#{resource.ledger_id}"
+                          when LedgerSync::Transfer
+                            "/transfer?txnId=#{resource.ledger_id}"
+                          when LedgerSync::Vendor
+                            "/vendordetail?nameId=#{resource.ledger_id}"
+                          end
+
+          base_url + resource_path
         end
 
         def self.ledger_attributes_to_save
           %i[access_token expires_at refresh_token refresh_token_expires_at]
         end
 
-        # def self.url_for(resource:)
-        #   case resource
-        #   when Customer
-        #     # TODO: How can we get the proper URL?  In dev, a random sandbox is used.
-        #   end
-        # end
-
         private
 
         def oauth_base_uri
@@ -135,14 +168,15 @@ module LedgerSync
         def request(method, *args)
           oauth.send(method, *args)
         rescue OAuth2::Error => e
-          error = parse_error(error: e)
-          raise (error || e) unless error.is_a?(Error::AdaptorError::AuthenticationError)
+          error = parse_error(error: e) || parse_operation_error(error: e, operation: nil) || e
+
+          raise error unless error.is_a?(Error::AdaptorError::AuthenticationError)
 
           begin
             refresh!
             oauth.send(method, *args)
-          rescue OAuth2::Error => e2
-            raise parse_error(error: e2) || e2
+          rescue OAuth2::Error => e
+            raise parse_error(error: e) || e
           end
         end
 
@@ -156,6 +190,19 @@ module LedgerSync
         def resourcify(str)
           str.tr('_', '')
         end
+
+        def set_credentials_from_oauth_token(token:)
+          @previous_access_tokens << access_token if access_token.present?
+          @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?
+
+          @previous_refresh_tokens << refresh_token if refresh_token.present?
+          @refresh_token = token.refresh_token
+
+          oauth(force: true) # Ensure we update the memoized @oauth
+        end
       end
     end
   end