ledger_sync 1.4.4 → 1.5.0

data/lib/ledger_sync/ledgers/quickbooks_online/util/operation_error_parser.rb

@@ -75,7 +75,7 @@ module LedgerSync
 
           attr_reader :operation
 
-          def initialize(operation: nil, error:)
+          def initialize(error:, operation: nil)
             @operation = operation
             super(error: error)
           end

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

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require_relative '../primary_phone/deserializer'
+require_relative '../primary_email_addr/deserializer'
+
 module LedgerSync
   module Ledgers
     module QuickBooksOnline
@@ -7,17 +10,16 @@ module LedgerSync
         class Deserializer < QuickBooksOnline::Deserializer
           id
 
-          attribute :display_name,
-                    hash_attribute: 'DisplayName'
-
-          attribute :first_name,
-                    hash_attribute: 'GivenName'
-
-          attribute :last_name,
-                    hash_attribute: 'FamilyName'
+          attribute :DisplayName
+          attribute :GivenName
+          attribute :MiddleName
+          attribute :FamilyName
+          attribute :CompanyName
 
-          attribute :email,
-                    hash_attribute: 'PrimaryEmailAddr.Address'
+          references_one :PrimaryPhone,
+                         deserializer: PrimaryPhone::Deserializer
+          references_one :PrimaryEmailAddr,
+                         deserializer: PrimaryEmailAddr::Deserializer
         end
       end
     end

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

@@ -10,13 +10,13 @@ module LedgerSync
               params do
                 required(:external_id).maybe(:string)
                 required(:ledger_id).value(:nil)
-                optional(:display_name).maybe(:string)
-                optional(:first_name).maybe(:string)
-                optional(:last_name).maybe(:string)
-                optional(:email).maybe(:string)
-                optional(:company_name).maybe(:string)
-                optional(:phone_number).maybe(:string)
-                optional(:subsidiary).maybe(:hash, Types::Reference)
+                optional(:CompanyName).maybe(:string)
+                optional(:DisplayName).maybe(:string)
+                optional(:FamilyName).maybe(:string)
+                optional(:GivenName).maybe(:string)
+                optional(:MiddleName).maybe(:string)
+                required(:PrimaryPhone).maybe(:hash, Types::Reference)
+                required(:PrimaryEmailAddr).maybe(:hash, Types::Reference)
               end
             end
           end

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

@@ -10,13 +10,13 @@ module LedgerSync
               params do
                 required(:external_id).maybe(:string)
                 required(:ledger_id).filled(:string)
-                required(:display_name).maybe(:string)
-                required(:first_name).maybe(:string)
-                required(:last_name).maybe(:string)
-                required(:email).maybe(:string)
-                optional(:company_name).maybe(:string)
-                optional(:phone_number).maybe(:string)
-                optional(:subsidiary).maybe(:hash, Types::Reference)
+                optional(:CompanyName).maybe(:string)
+                optional(:DisplayName).maybe(:string)
+                optional(:FamilyName).maybe(:string)
+                optional(:GivenName).maybe(:string)
+                optional(:MiddleName).maybe(:string)
+                optional(:PrimaryPhone).maybe(:hash, Types::Reference)
+                optional(:PrimaryEmailAddr).maybe(:hash, Types::Reference)
               end
             end
           end

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

@@ -10,13 +10,13 @@ module LedgerSync
               params do
                 required(:external_id).maybe(:string)
                 required(:ledger_id).filled(:string)
-                optional(:display_name).maybe(:string)
-                optional(:first_name).maybe(:string)
-                optional(:last_name).maybe(:string)
-                optional(:email).maybe(:string)
-                optional(:company_name).maybe(:string)
-                optional(:phone_number).maybe(:string)
-                optional(:subsidiary).maybe(:hash, Types::Reference)
+                optional(:CompanyName).maybe(:string)
+                optional(:DisplayName).maybe(:string)
+                optional(:FamilyName).maybe(:string)
+                optional(:GivenName).maybe(:string)
+                optional(:MiddleName).maybe(:string)
+                required(:PrimaryPhone).maybe(:hash, Types::Reference)
+                required(:PrimaryEmailAddr).maybe(:hash, Types::Reference)
               end
             end
           end

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

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require_relative '../primary_phone/serializer'
+require_relative '../primary_email_addr/serializer'
+
 module LedgerSync
   module Ledgers
     module QuickBooksOnline
@@ -7,17 +10,16 @@ module LedgerSync
         class Serializer < QuickBooksOnline::Serializer
           id
 
-          attribute 'DisplayName',
-                    resource_attribute: :display_name
-
-          attribute 'GivenName',
-                    resource_attribute: :first_name
-
-          attribute 'FamilyName',
-                    resource_attribute: :last_name
+          attribute :DisplayName
+          attribute :GivenName
+          attribute :MiddleName
+          attribute :FamilyName
+          attribute :CompanyName
 
-          attribute 'PrimaryEmailAddr.Address',
-                    resource_attribute: :email
+          references_one :PrimaryPhone,
+                         serializer: PrimaryPhone::Serializer
+          references_one :PrimaryEmailAddr,
+                         serializer: PrimaryEmailAddr::Serializer
         end
       end
     end

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

@@ -15,7 +15,7 @@ module LedgerSync
           @original_payload = payload
           @payload = payload.is_a?(String) ? JSON.parse(payload) : payload
 
-          event_notifications_payload = @payload.dig('eventNotifications')
+          event_notifications_payload = @payload['eventNotifications']
           raise 'Invalid payload: Could not find eventNotifications' unless event_notifications_payload.is_a?(Array)
 
           @notifications = []

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

@@ -19,20 +19,20 @@ module LedgerSync
           @original_payload = payload
           @payload = payload.is_a?(String) ? JSON.parse(payload) : payload
 
-          @deleted_id = @payload.dig('deletedId')
+          @deleted_id = @payload['deletedId']
 
-          @event_operation = @payload.dig('operation')
+          @event_operation = @payload['operation']
           raise 'Invalid payload: Could not find operation' if @event_operation.blank?
 
-          @last_updated_at = @payload.dig('lastUpdated')
+          @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.dig('id')
+          @ledger_id = @payload['id']
           raise 'Invalid payload: Could not find id' if @ledger_id.blank?
 
-          @quickbooks_online_resource_type = @payload.dig('name')
+          @quickbooks_online_resource_type = @payload['name']
           raise 'Invalid payload: Could not find name' if @quickbooks_online_resource_type.blank?
 
           @webhook_notification = webhook_notification
@@ -51,7 +51,7 @@ module LedgerSync
         end
 
         def find_operation_class(client:)
-          client.class.base_operation_module_for(resource_class: resource_class)::Find
+          client.class.base_operations_module_for(resource_class: resource_class)::Find
         end
 
         def local_resource_type

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

@@ -18,7 +18,7 @@ module LedgerSync
           @webhook          = args.fetch(:webhook, nil)
           @payload          = original_payload.is_a?(String) ? JSON.parse(original_payload) : original_payload
 
-          @realm_id = @payload.dig('realmId')
+          @realm_id = @payload['realmId']
           raise 'Invalid payload: Could not find realmId' if @realm_id.blank?
 
           events_payload = @payload.dig('dataChangeEvent', 'entities')

data/lib/ledger_sync/ledgers/response.rb

@@ -9,7 +9,7 @@ module LedgerSync
                   :request,
                   :status
 
-      def initialize(body: nil, headers: {}, raw: nil, request:, status:)
+      def initialize(request:, status:, body: nil, headers: {}, raw: nil)
         @body = parse_json(body)
         @headers = headers
         @raw = raw

data/lib/ledger_sync/ledgers/stripe/client.rb

@@ -5,13 +5,17 @@ require 'oauth2'
 module LedgerSync
   module Ledgers
     module Stripe
-      class Client < Ledgers::Client
+      class Client
+        include Ledgers::Client::Mixin
+
         attr_reader :api_key
 
         def initialize(
           api_key:
         )
           @api_key = api_key
+
+          super()
         end
 
         def url_for(resource:)

data/lib/ledger_sync/resource.rb

@@ -13,7 +13,7 @@ module LedgerSync
     include ResourceAttribute::Reference::One::Mixin
     include ResourceAttribute::Reference::Many::Mixin
     include Util::Mixins::DupableMixin
-    include Ledgers::Mixins::InferClientMixin
+    include Ledgers::Mixins::InferConfigMixin
 
     PRIMITIVES = [
       ActiveModel::Type,
@@ -68,9 +68,11 @@ module LedgerSync
 
       LedgerSync.register_resource(resource: subclass)
 
-      return if subclass.inferred_client_class.nil?
+      return if subclass.inferred_config.nil?
 
-      subclass.inferred_client_class.register_resource(resource: subclass)
+      subclass.inferred_config.client_class.register_resource(resource: subclass)
+
+      super
     end
 
     def self.operations

data/lib/ledger_sync/resource_adaptor.rb

@@ -47,6 +47,8 @@ module LedgerSync
 
     def self.inherited(base)
       base.include(Mixin)
+
+      super
     end
   end
 end

data/lib/ledger_sync/resource_attribute/reference/one.rb

@@ -15,8 +15,8 @@ module LedgerSync
           module ClassMethods
             def references_one(name, to: nil)
               to ||= begin
-                require "ledger_sync/ledgers/#{inferred_client_class.root_key}/resources/#{name}"
-                inferred_client_class.resources[name]
+                require "#{inferred_config.root_path}/resources/#{name}"
+                inferred_config.client_class.resources[name]
               end
 
               resource_attribute = ResourceAttribute::Reference::One.new(

data/lib/ledger_sync/resource_attribute_set.rb

@@ -27,15 +27,16 @@ module LedgerSync
       name = attribute.name
       raise "Attribute #{name} already exists on #{resource.name}." if attributes.key?(name)
 
-      if attribute.is_a?(ResourceAttribute::Reference::One)
+      case attribute
+      when ResourceAttribute::Reference::One
         @attributes[attribute.name] = attribute
         @references << attribute
         @references_one << attribute
-      elsif attribute.is_a?(ResourceAttribute::Reference::Many)
+      when ResourceAttribute::Reference::Many
         @attributes[attribute.name] = attribute
         @references << attribute
         @references_many << attribute
-      elsif attribute.is_a?(ResourceAttribute)
+      when ResourceAttribute
         @attributes[attribute.name] = attribute
       else
         raise 'Unknown attribute class'

data/lib/ledger_sync/serialization/type/deserializer_type.rb

@@ -8,6 +8,8 @@ module LedgerSync
 
         def initialize(args = {})
           @deserializer = args.fetch(:deserializer)
+
+          super()
         end
 
         def cast_value(args = {})

data/lib/ledger_sync/serialization/type/format_date_type.rb

@@ -8,6 +8,8 @@ module LedgerSync
 
         def initialize(args = {})
           @format = args.fetch(:format)
+
+          super()
         end
 
         def cast_value(args = {})

data/lib/ledger_sync/serialization/type/mapping_type.rb

@@ -8,6 +8,8 @@ module LedgerSync
 
         def initialize(args = {})
           @hash = args.fetch(:hash)
+
+          super()
         end
 
         def cast_value(args = {})

data/lib/ledger_sync/serialization/type/parse_date_type.rb

@@ -8,6 +8,8 @@ module LedgerSync
 
         def initialize(args = {})
           @format = args.fetch(:format)
+
+          super()
         end
 
         def cast_value(args = {})

data/lib/ledger_sync/serialization/type/serializer_type.rb

@@ -8,6 +8,8 @@ module LedgerSync
 
         def initialize(args = {})
           @serializer = args.fetch(:serializer)
+
+          super()
         end
 
         def cast_value(args = {})

data/lib/ledger_sync/serializer.rb

@@ -89,8 +89,8 @@ module LedgerSync
         args.fetch(:serializer)
       else
         resource_key = inferred_resource_class.resource_attributes[hash_attribute].type.resource_class.resource_type
-        require "ledger_sync/ledgers/#{inferred_client_class.root_key}/#{resource_key}/serializer"
-        inferred_client_class.resources[resource_key]::Serializer
+        require File.join(inferred_config.root_path, resource_key.to_s, 'serializer')
+        inferred_config.client_class.resources[resource_key]::Serializer
       end
     end
   end

data/lib/ledger_sync/test/support.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+def support(*paths)
+  paths.each do |path|
+    require File.join(LedgerSync.root, 'spec/support/', path.to_s)
+  end
+end
+
+def core_support(*paths)
+  paths.each do |path|
+    require File.join(LedgerSync.root, 'lib/ledger_sync/test/support/', path.to_s)
+  end
+end
+
+def qa_support(*paths)
+  paths.each do |path|
+    require File.join(LedgerSync.root, 'spec/qa/support/', path.to_s)
+  end
+end
+
+module LedgerSync
+  module Test
+    module Support
+      def self.setup(*paths_to_require)
+        require 'webmock/rspec'
+        require 'simplecov'
+        require 'coveralls'
+        Coveralls.wear!
+
+        SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(
+          [
+            Coveralls::SimpleCov::Formatter,
+            SimpleCov::Formatter::HTMLFormatter
+          ]
+        )
+
+        SimpleCov.start do
+          add_filter 'lib/ledger_sync/util/debug.rb'
+        end
+
+        # Set an environment variable to determine when we are testing.  This
+        # prevents things like the QuickBooks Online client overwriting
+        # environment variables with dummy values.
+        ENV['TEST_ENV'] = 'true'
+
+        require 'bundler/setup'
+        require 'ap'
+        require 'byebug'
+
+        paths_to_require.each { |e| require e.to_s }
+
+        # Include test adaptor
+        require File.join(LedgerSync.root, 'spec/support/test_ledger/config')
+
+        core_support :factory_bot
+
+        RSpec.configure do |config|
+          # Enable flags like --only-failures and --next-failure
+          config.example_status_persistence_file_path = 'tmp/rspec_history.txt'
+
+          # Disable RSpec exposing methods globally on `Module` and `main`
+          config.disable_monkey_patching!
+
+          config.expect_with :rspec do |c|
+            c.syntax = :expect
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ledger_sync/test/support/factory_bot.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+require 'factory_bot'
+
+#
+# Override factory registration to work with Resource and its relationships
+# and attribute types.
+#
+def register_factory(args = {}) # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+  prefix         = args.fetch(:prefix)
+  resource_class = args.fetch(:resource_class)
+  key            = "#{prefix}_#{resource_class.resource_type}"
+
+  FactoryBot.define do
+    factory key, class: resource_class do
+      resource_class.resource_attributes.each do |attribute, resource_attribute|
+        case resource_attribute.type
+        when LedgerSync::Type::StringFromSet
+          add_attribute(attribute) { resource_attribute.type.values.first }
+        when LedgerSync::Type::String, LedgerSync::Type::ID
+          case attribute.to_sym
+          when :ledger_id
+            sequence(attribute) { nil }
+          else # when :external_id or something else
+            sequence(attribute) { |n| "#{attribute}-#{rand_id(n)}" }
+          end
+        when LedgerSync::Type::Float
+          add_attribute(attribute) { 1.23 }
+        when LedgerSync::Type::Boolean
+          add_attribute(attribute) { false }
+        when LedgerSync::Type::Date
+          add_attribute(attribute) { Date.today }
+        when LedgerSync::Type::Hash
+          add_attribute(attribute) { {} }
+        when LedgerSync::Type::Integer
+          add_attribute(attribute) { 123 }
+        when LedgerSync::Type::ReferenceOne
+          key_ending = if resource_attribute.type.resource_class.is_a?(Array)
+                         resource_attribute.type.resource_class.first.resource_type
+                       else
+                         resource_attribute.type.resource_class.resource_type
+                       end
+          resource_attribute_key = "#{prefix}_#{key_ending}"
+          next if resource_attribute_key == key
+
+          references_one attribute, factory: resource_attribute_key
+        when LedgerSync::Type::ReferenceMany
+          key_ending = if resource_attribute.type.resource_class.is_a?(Array)
+                         resource_attribute.type.resource_class.first.resource_type
+                       else
+                         resource_attribute.type.resource_class.resource_type
+                       end
+          resource_attribute_key = "#{prefix}_#{key_ending}"
+          next if resource_attribute_key == key
+
+          references_many attribute, factory: resource_attribute_key
+        else
+          raise "Do not know how to default type: #{resource_attribute.type.class.name}"
+        end
+      end
+    end
+  end
+end
+
+def generate_resource_factories
+  LedgerSync.ledgers.each do |ledger_key, ledger|
+    ledger.client_class.resources.each do |resource_key, resource_class|
+      factory_key = "#{ledger_key}_#{resource_key}".to_sym
+      next if FactoryBot.factories.registered?(factory_key)
+
+      register_factory(prefix: ledger_key, resource_class: resource_class)
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include FactoryBot::Syntax::Methods
+  config.before(:suite) do
+    FactoryBot.find_definitions
+    generate_resource_factories
+  end
+  config.after { FactoryBot.rewind_sequences }
+end
+
+FactoryBot.define do
+  skip_create
+  initialize_with { new(attributes) } # Allows initializing read-only attrs
+end
+
+module FactoryBot
+  def self.rand_id(*appends, include_test_run_id: true)
+    ret = ''
+    ret += test_run_id if include_test_run_id
+    ret += (0...8).map { rand(65..90).chr }.join
+    appends.each do |append|
+      ret += "-#{append}"
+    end
+    ret
+  end
+
+  def self.test_run_id(*appends, **keywords)
+    @test_run_id ||= rand_id(
+      *appends,
+      **keywords.merge(include_test_run_id: false)
+    )
+  end
+
+  class DefinitionProxy
+    #
+    # Helper method of our references_one on resources
+    #
+    # @param [String] name
+    # @param [String] factory Defaults to name
+    #
+    # @return [FactoryBot::Declaration]
+    #
+    def references_one(name, factory: nil)
+      add_attribute(name) do
+        factory ||= name
+        FactoryBot.build(factory, **attributes_for(factory))
+      end
+    end
+
+    #
+    # Helper method of our references_many on resources
+    #
+    # @param [String] name
+    # @param [String] factory Defaults to name
+    #
+    # @return [FactoryBot::Declaration]
+    #
+    def references_many(name, count: 0, factory: nil)
+      add_attribute(name) do
+        factory ||= name
+        FactoryBot.build_list(factory, count)
+      end
+    end
+  end
+end
+
+#
+# Used for uniqueness in QuickBooks Online given the unique name requirement
+#
+# @return [String]
+#
+def rand_id(*args)
+  FactoryBot.rand_id(*args)
+end
+
+#
+# Used for uniqueness in QuickBooks Online given the unique name requirement
+#
+# @return [String]
+#
+def test_run_id(*args)
+  @test_run_id ||= FactoryBot.test_run_id(*args)
+end