ledger_sync 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19414532e2c552b3e17efa9e8dc0315740809c7bbe74124af62f55dbd4bad2d0
-  data.tar.gz: a8cf13be61f9ce6a738f4bf0d54774da3b676714a6e982394036fd924503a3e0
+  metadata.gz: efcf3cc57a3f68ad9612fde0eb59ac3e06acd8d644a579397c2c1a17046d4be1
+  data.tar.gz: db61863e31a0fc7004e020b1c0672b52a3de117edd7b57a5ff874edf6505e20c
 SHA512:
-  metadata.gz: 97a8377503769687b0f4b765ece61bb4fe9b4689adf493e8d41fe3d77fd58f90f53a0c51f6412d3f69221e697ae6c6633a4bb6edd54013cae86022a0c7b683b0
-  data.tar.gz: 7a6dfcde809c765cee2faad8f063c321f1baa064ff47cb98e5187042631fa13624b91e7954b729e4ded47ccaabef742b95579dcd5e66e9ef200df7a02fbc817e
+  metadata.gz: 777f81a8164db6a0e8d82081bcd70d01bdf34542ace2ae494fa475e632201df1e23211308d6df18f97eab5bf49fe1743bcce52bfc44b0e2aebf8d468ce3b8e21
+  data.tar.gz: 3398a7232feb2f4659061705f7aefe960fcf2459a84f156d6ab86f2be8967f0a28c6a0035b4688780dcca99d6937a23b1f0de38bffc0f2e1031c577056fbcef6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ledger_sync (1.5.0)
+    ledger_sync (1.5.1)
       activemodel
       colorize
       coveralls (~> 0.8.23)

data/lib/ledger_sync/test/support/test_ledger/client.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Client
+        include Ledgers::Client::Mixin
+
+        attr_reader :api_key
+
+        def initialize(args = {})
+          @api_key = args.fetch(:api_key)
+        end
+
+        def self.ledger_attributes_to_save
+          %i[api_key]
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/config.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'client'
+
+args = {
+  base_module: LedgerSync::Ledgers::TestLedger,
+  root_path: File.join(LedgerSync.root, 'lib/ledger_sync/test/support/test_ledger')
+}
+
+LedgerSync.register_ledger(:test_ledger, args) do |config|
+  config.name = 'Test Ledger'
+  config.add_alias :test
+end

data/lib/ledger_sync/test/support/test_ledger/customer/deserializer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Customer
+        class Deserializer < TestLedger::Deserializer
+          id
+
+          attribute :name
+          attribute :email
+          attribute :date
+
+          references_one :subsidiary, deserializer: Subsidiary::Deserializer
+          references_many :subsidiaries, deserializer: Subsidiary::Deserializer
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/customer/operations/create.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Customer
+        module Operations
+          class Create < TestLedger::Operation::Create
+            class Contract < LedgerSync::Ledgers::Contract
+              params do
+                required(:external_id).maybe(:string)
+                required(:ledger_id).value(:nil)
+                optional(:name).filled(:string)
+                optional(:email).maybe(:string)
+                optional(:date).maybe(:string)
+                required(:subsidiaries).maybe(:hash, Types::Reference)
+                required(:subsidiary).maybe(:hash, Types::Reference)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/customer/operations/find.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Customer
+        module Operations
+          class Find < TestLedger::Operation::Find
+            class Contract < LedgerSync::Ledgers::Contract
+              params do
+                required(:name).maybe(:string)
+                required(:email).filled(:string)
+                required(:subsidiary).maybe(:hash, Types::Reference)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/customer/operations/update.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Customer
+        module Operations
+          class Update < TestLedger::Operation::Update
+            class Contract < LedgerSync::Ledgers::Contract
+              params do
+                required(:external_id).maybe(:string)
+                required(:ledger_id).filled(:string)
+                optional(:name).filled(:string)
+                optional(:email).maybe(:string)
+                optional(:date).maybe(:string)
+                required(:subsidiaries).maybe(:hash, Types::Reference)
+                required(:subsidiary).maybe(:hash, Types::Reference)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/customer/searcher.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Customer
+        class Searcher < LedgerSync::Ledgers::TestLedger::Searcher
+          def query_string
+            "DisplayName LIKE '%#{query}%'"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/customer/serializer.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative '../subsidiary/serializer'
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Customer
+        class Serializer < TestLedger::Serializer
+          id
+
+          attribute :name
+          attribute :email
+
+          references_one :subsidiary
+          references_many :subsidiaries
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/deserializer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Gem.find_files('ledger_sync/core/ledgers/test_ledger/serializer_type/**/*.rb').each { |path| require path }
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Deserializer < LedgerSync::Deserializer
+        def self.id
+          attribute(:ledger_id, hash_attribute: 'Id')
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/operation/create.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative '../operation'
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Operation
+        class Create
+          include TestLedger::Operation::Mixin
+
+          private
+
+          def operate
+            success(
+              resource: resource.dup,
+              response: response
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/operation/find.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative '../operation'
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Operation
+        class Find
+          include TestLedger::Operation::Mixin
+
+          private
+
+          def operate
+            response_to_operation_result(
+              response: client.find(
+                path: ledger_resource_path
+              )
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/operation/update.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative '../operation'
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Operation
+        class Update
+          include TestLedger::Operation::Mixin
+
+          private
+
+          def operate
+            success(
+              resource: resource.dup.assign_attributes(name: 'New Name'),
+              response: response
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/operation.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Operation
+        module Mixin
+          def self.included(base)
+            base.include Ledgers::Operation::Mixin
+            base.include InstanceMethods # To ensure these override parent methods
+          end
+
+          module InstanceMethods
+            def deserialized_resource(response:)
+              deserializer.deserialize(
+                hash: response.body[test_ledger_resource_type.to_s.camelize],
+                resource: resource
+              )
+            end
+
+            def ledger_resource_path
+              @ledger_resource_path ||= "#{ledger_resource_type_for_path}/#{resource.ledger_id}"
+            end
+
+            def ledger_resource_type_for_path
+              test_ledger_resource_type.tr('_', '')
+            end
+
+            def response_to_operation_result(response:)
+              if response.success?
+                success(
+                  resource: deserialized_resource(response: response),
+                  response: response
+                )
+              else
+                failure(
+                  Error::OperationError.new(
+                    operation: self,
+                    response: response
+                  )
+                )
+              end
+            end
+
+            def test_ledger_resource_type
+              @test_ledger_resource_type ||= client.class.ledger_resource_type_for(resource_class: resource.class)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/resource.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Resource < LedgerSync::Resource
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/resources/customer.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'subsidiary'
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Customer < TestLedger::Resource
+        attribute :name, type: LedgerSync::Type::String
+        attribute :email, type: LedgerSync::Type::String
+        attribute :date, type: LedgerSync::Type::Date
+
+        references_one :subsidiary, to: Subsidiary
+        references_many :subsidiaries, to: Subsidiary
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/resources/subsidiary.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Subsidiary < TestLedger::Resource
+        attribute :name, type: LedgerSync::Type::String
+        attribute :state, type: LedgerSync::Type::String
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/searcher.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Searcher < Ledgers::Searcher
+        include 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
+end

data/lib/ledger_sync/test/support/test_ledger/serializer.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+# Gem.find_files('ledger_sync/core/ledgers/test_ledger/serializer_type/**/*.rb').each { |path| require path }
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      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
+end

data/lib/ledger_sync/test/support/test_ledger/subsidiary/deserializer.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Subsidiary
+        class Deserializer < TestLedger::Deserializer
+          id
+
+          attribute :name
+
+          attribute :state
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/subsidiary/searcher.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Subsidiary
+        class Searcher < TestLedger::Searcher
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/subsidiary/searcher_deserializer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Subsidiary
+        class SearcherDeserializer < TestLedger::Deserializer
+          id
+
+          attribute :name
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/subsidiary/serializer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Subsidiary
+        class Serializer < TestLedger::Serializer
+          attribute :name
+
+          attribute :state
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/util/error_matcher.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Util
+        class ErrorMatcher
+          attr_reader :error,
+                      :message
+
+          def initialize(error:)
+            @error = error
+            @message = error.message.to_s
+          end
+
+          def body
+            error.response.body
+          rescue NoMethodError
+            nil
+          end
+
+          def error_class
+            raise NotImplementedError
+          end
+
+          def error_message # rubocop:disable Metrics/CyclomaticComplexity
+            return error.message unless body
+
+            parsed_body = JSON.parse(body)
+
+            parsed_body.dig('fault', 'error')&.first&.fetch('message') ||
+              parsed_body.dig('Fault', 'Error')&.first&.fetch('Message') ||
+              parsed_body['error']
+          end
+
+          def detail # rubocop:disable Metrics/CyclomaticComplexity
+            (body && JSON.parse(body).dig('fault', 'error')&.first&.fetch('detail')) ||
+              (body && JSON.parse(body).dig('Fault', 'Error')&.first&.fetch('Detail'))
+          end
+
+          def code # rubocop:disable Metrics/CyclomaticComplexity
+            ((body && JSON.parse(body).dig('fault', 'error')&.first&.fetch('code')) ||
+            (body && JSON.parse(body).dig('Fault', 'Error')&.first&.fetch('code'))).to_i
+          end
+
+          def match?
+            raise NotImplementedError
+          end
+
+          def output_message
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/util/error_parser.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'error_matcher'
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Util
+        class ErrorParser
+          attr_reader :error
+
+          def initialize(error:)
+            @error = error
+          end
+
+          def error_class
+            raise NotImplementedError
+          end
+
+          def parse
+            raise NotImplementedError
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/util/ledger_error_parser.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+require_relative 'error_parser'
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Util
+        class LedgerErrorParser < ErrorParser
+          class ThrottleMatcher < ErrorMatcher
+            def error_class
+              Error::LedgerError::ThrottleError
+            end
+
+            def output_message
+              "Request throttle with: #{error_message}"
+            end
+
+            def match?
+              message.include?('source=throttling policy') ||
+                message.include?('errorcode=003001')
+            end
+          end
+
+          class AuthenticationMatcher < ErrorMatcher
+            def error_class
+              Error::LedgerError::AuthenticationError
+            end
+
+            def output_message
+              "Authentication Failed with: #{error_message}"
+            end
+
+            def match?
+              code == 3200 ||
+                message.include?('authenticationfailed') ||
+                message.include?('errorcode=003200')
+            end
+          end
+
+          class AuthorizationMatcher < ErrorMatcher
+            def error_class
+              Error::LedgerError::AuthorizationError
+            end
+
+            def output_message
+              "Authorization Failed with: #{error_message}"
+            end
+
+            def match?
+              code == 3100 ||
+                message.include?('authorizationfailed') ||
+                message.include?('errorcode=003100')
+            end
+          end
+
+          class ClientMatcher < ErrorMatcher
+            def error_class
+              Error::LedgerError::ConfigurationError
+            end
+
+            def output_message
+              "Missing Configuration: #{error_message}"
+            end
+
+            def match?
+              message.include?('invalid_client') ||
+                message.include?('invalid_grant')
+            end
+          end
+
+          PARSERS = [
+            AuthenticationMatcher,
+            AuthorizationMatcher,
+            ClientMatcher,
+            ThrottleMatcher
+          ].freeze
+
+          attr_reader :client
+
+          def initialize(client:, error:)
+            @client = client
+            super(error: error)
+          end
+
+          def parse
+            PARSERS.map do |parser|
+              matcher = parser.new(error: error)
+              next unless matcher.match?
+
+              return matcher.error_class.new(
+                client: client,
+                message: matcher.output_message,
+                response: error
+              )
+            end
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/util/operation_error_parser.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+require_relative 'error_parser'
+
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Util
+        class OperationErrorParser < ErrorParser
+          class DuplicateNameMatcher < ErrorMatcher
+            def error_class
+              Error::OperationError::DuplicateLedgerResourceError
+            end
+
+            def output_message
+              "Resource with same name already exists: #{error_message}"
+            end
+
+            def match?
+              code == 6240 ||
+                message.include?('the name supplied already exists')
+            end
+          end
+
+          class NotFoundMatcher < ErrorMatcher
+            def error_class
+              Error::OperationError::NotFoundError
+            end
+
+            def output_message
+              "Unable to find in ledger with: #{error_message}"
+            end
+
+            def match?
+              code == 610 ||
+                message.include?('object not found')
+            end
+          end
+
+          class ValidationError < ErrorMatcher
+            def error_class
+              Error::OperationError::LedgerValidationError
+            end
+
+            def output_message
+              "Ledger object is not valid: #{error_message}"
+            end
+
+            def match?
+              code == 6080
+            end
+          end
+
+          class GenericMatcher < ErrorMatcher
+            def error_class
+              Error::OperationError
+            end
+
+            def output_message
+              "Something went wrong: #{error_message}"
+            end
+
+            def match?
+              true
+            end
+          end
+
+          # ! always keep GenericMatcher as last
+          PARSERS = [
+            DuplicateNameMatcher,
+            NotFoundMatcher,
+            ValidationError,
+            GenericMatcher
+          ].freeze
+
+          attr_reader :operation
+
+          def initialize(error:, operation: nil)
+            @operation = operation
+            super(error: error)
+          end
+
+          def parse
+            PARSERS.map do |parser|
+              matcher = parser.new(error: error)
+              next unless matcher.match?
+
+              return matcher.error_class.new(
+                operation: operation,
+                message: matcher.output_message,
+                response: error
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/webhook.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require_relative 'webhook_event'
+
+# ref: https://developer.intuit.com/app/developer/qbo/docs/develop/webhooks/managing-webhooks-notifications#validating-the-notification
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class Webhook
+        attr_reader :notifications,
+                    :original_payload,
+                    :payload
+
+        def initialize(payload:)
+          @original_payload = payload
+          @payload = payload.is_a?(String) ? JSON.parse(payload) : payload
+
+          event_notifications_payload = @payload['eventNotifications']
+          raise 'Invalid payload: Could not find eventNotifications' unless event_notifications_payload.is_a?(Array)
+
+          @notifications = []
+
+          event_notifications_payload.each do |event_notification_payload|
+            @notifications << WebhookNotification.new(
+              payload: event_notification_payload,
+              webhook: self
+            )
+          end
+        end
+
+        def events
+          notifications.map(&:events)
+        end
+
+        def resources
+          @resources ||= notifications.map(&:resources).flatten.compact
+        end
+
+        def valid?(signature:, verification_token:)
+          self.class.valid?(
+            payload: payload.to_json,
+            signature: signature,
+            verification_token: verification_token
+          )
+        end
+
+        def self.valid?(payload:, signature:, verification_token:)
+          raise 'Cannot verify non-String payload' unless payload.is_a?(String)
+
+          digest = OpenSSL::Digest.new('sha256')
+          hmac = OpenSSL::HMAC.digest(digest, verification_token, payload)
+          base64 = Base64.encode64(hmac).strip
+          base64 == signature
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/webhook_event.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+# ref: https://developer.intuit.com/app/developer/qbo/docs/develop/webhooks/managing-webhooks-notifications#validating-the-notification
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class WebhookEvent
+        attr_reader :deleted_id,
+                    :event_operation,
+                    :last_updated_at,
+                    :ledger_id,
+                    :original_payload,
+                    :payload,
+                    :test_ledger_resource_type,
+                    :webhook_notification,
+                    :webhook
+
+        def initialize(payload:, webhook_notification: nil)
+          @original_payload = payload
+          @payload = payload.is_a?(String) ? JSON.parse(payload) : payload
+
+          @deleted_id = @payload['deletedId']
+
+          @event_operation = @payload['operation']
+          raise 'Invalid payload: Could not find operation' if @event_operation.blank?
+
+          @last_updated_at = @payload['lastUpdated']
+          raise 'Invalid payload: Could not find lastUpdated' if @last_updated_at.blank?
+
+          @last_updated_at = Time.parse(@last_updated_at)
+
+          @ledger_id = @payload['id']
+          raise 'Invalid payload: Could not find id' if @ledger_id.blank?
+
+          @test_ledger_resource_type = @payload['name']
+          raise 'Invalid payload: Could not find name' if @test_ledger_resource_type.blank?
+
+          @webhook_notification = webhook_notification
+          @webhook = webhook_notification.try(:webhook)
+        end
+
+        def find(client:)
+          find_operation(client: client).perform
+        end
+
+        def find_operation(client:)
+          find_operation_class(client: client).new(
+            client: client,
+            resource: resource_class.new(ledger_id: ledger_id)
+          )
+        end
+
+        def find_operation_class(client:)
+          client.class.base_operations_module_for(resource_class: resource_class)::Find
+        end
+
+        def local_resource_type
+          @local_resource_type ||= resource_class.resource_type
+        end
+
+        def resource
+          return unless resource_class.present?
+
+          resource_class.new(ledger_id: ledger_id)
+        end
+
+        def resource!
+          if resource.nil?
+            raise "Resource class does not exist for QuickBooks Online object: #{test_ledger_resource_type}"
+          end
+
+          resource
+        end
+
+        def resource_class
+          @resource_class ||= Client.resource_from_ledger_type(type: test_ledger_resource_type.downcase)
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/test_ledger/webhook_notification.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative 'webhook_event'
+
+# ref: https://developer.intuit.com/app/developer/qbo/docs/develop/webhooks/managing-webhooks-notifications#validating-the-notification
+module LedgerSync
+  module Ledgers
+    module TestLedger
+      class WebhookNotification
+        attr_reader :events,
+                    :original_payload,
+                    :payload,
+                    :realm_id,
+                    :webhook
+
+        def initialize(args = {})
+          @original_payload = args.fetch(:payload)
+          @webhook          = args.fetch(:webhook, nil)
+          @payload          = original_payload.is_a?(String) ? JSON.parse(original_payload) : original_payload
+
+          @realm_id = @payload['realmId']
+          raise 'Invalid payload: Could not find realmId' if @realm_id.blank?
+
+          events_payload = @payload.dig('dataChangeEvent', 'entities')
+          raise 'Invalid payload: Could not find dataChangeEvent -> entities' unless events_payload.is_a?(Array)
+
+          @events = []
+
+          events_payload.each do |event_payload|
+            @events << WebhookEvent.new(
+              payload: event_payload,
+              webhook_notification: self
+            )
+          end
+        end
+
+        def resources
+          @resources ||= events.map(&:resource).compact
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support.rb

@@ -50,7 +50,7 @@ module LedgerSync
         paths_to_require.each { |e| require e.to_s }
 
         # Include test adaptor
-        require File.join(LedgerSync.root, 'spec/support/test_ledger/config')
+        core_support 'test_ledger/config'
 
         core_support :factory_bot
 

data/lib/ledger_sync/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module LedgerSync
-  VERSION = '1.5.0'
+  VERSION = '1.5.1'
 
   def self.version
     if !ENV['TRAVIS'] || ENV.fetch('TRAVIS_TAG', '') != ''

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ledger_sync
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Ryan Jackson
@@ -1065,6 +1065,35 @@ files:
 - lib/ledger_sync/serializer.rb
 - lib/ledger_sync/test/support.rb
 - lib/ledger_sync/test/support/factory_bot.rb
+- lib/ledger_sync/test/support/test_ledger/client.rb
+- lib/ledger_sync/test/support/test_ledger/config.rb
+- lib/ledger_sync/test/support/test_ledger/customer/deserializer.rb
+- lib/ledger_sync/test/support/test_ledger/customer/operations/create.rb
+- lib/ledger_sync/test/support/test_ledger/customer/operations/find.rb
+- lib/ledger_sync/test/support/test_ledger/customer/operations/update.rb
+- lib/ledger_sync/test/support/test_ledger/customer/searcher.rb
+- lib/ledger_sync/test/support/test_ledger/customer/serializer.rb
+- lib/ledger_sync/test/support/test_ledger/deserializer.rb
+- lib/ledger_sync/test/support/test_ledger/operation.rb
+- lib/ledger_sync/test/support/test_ledger/operation/create.rb
+- lib/ledger_sync/test/support/test_ledger/operation/find.rb
+- lib/ledger_sync/test/support/test_ledger/operation/update.rb
+- lib/ledger_sync/test/support/test_ledger/resource.rb
+- lib/ledger_sync/test/support/test_ledger/resources/customer.rb
+- lib/ledger_sync/test/support/test_ledger/resources/subsidiary.rb
+- lib/ledger_sync/test/support/test_ledger/searcher.rb
+- lib/ledger_sync/test/support/test_ledger/serializer.rb
+- lib/ledger_sync/test/support/test_ledger/subsidiary/deserializer.rb
+- lib/ledger_sync/test/support/test_ledger/subsidiary/searcher.rb
+- lib/ledger_sync/test/support/test_ledger/subsidiary/searcher_deserializer.rb
+- lib/ledger_sync/test/support/test_ledger/subsidiary/serializer.rb
+- lib/ledger_sync/test/support/test_ledger/util/error_matcher.rb
+- lib/ledger_sync/test/support/test_ledger/util/error_parser.rb
+- lib/ledger_sync/test/support/test_ledger/util/ledger_error_parser.rb
+- lib/ledger_sync/test/support/test_ledger/util/operation_error_parser.rb
+- lib/ledger_sync/test/support/test_ledger/webhook.rb
+- lib/ledger_sync/test/support/test_ledger/webhook_event.rb
+- lib/ledger_sync/test/support/test_ledger/webhook_notification.rb
 - lib/ledger_sync/type/boolean.rb
 - lib/ledger_sync/type/date.rb
 - lib/ledger_sync/type/float.rb