[STA-6] misc(payment): Migrate to TypedResult

Author: vincent-pochet

app/services/invoices/payments/adyen_service.rb

@@ -5,14 +5,16 @@ module Payments
     class AdyenService < BaseService
       include Lago::Adyen::ErrorHandlable
       include Customers::PaymentProviderFinder
+      include TypedResults
 
       PROVIDER_NAME = "Adyen"
 
-      def initialize(invoice = nil)
-        @invoice = invoice
+      RESULTS = {
+        update_payment_status: BaseResult[:payment, :invoice],
+        generate_payment_url: BaseResult[:payment_url]
+      }.freeze
 
-        super
-      end
+      private
 
       def update_payment_status(provider_payment_id:, status:, amount_cents: nil, metadata: {})
         payment = if metadata[:payment_type] == "one-time"
@@ -43,7 +45,8 @@ def update_payment_status(provider_payment_id:, status:, amount_cents: nil, meta
         result.fail_with_error!(e)
       end
 
-      def generate_payment_url(payment_intent)
+      def generate_payment_url(invoice, payment_intent)
+        @invoice = invoice
         res = client.checkout.payment_links_api.payment_links(
           Lago::Adyen::Params.new(payment_url_params(payment_intent)).to_h,
           headers: {"Idempotency-Key" => payment_intent.id}
@@ -61,8 +64,6 @@ def generate_payment_url(payment_intent)
         result.third_party_failure!(third_party: PROVIDER_NAME, error_code: e.code, error_message: e.msg)
       end
 
-      private
-
       attr_accessor :invoice
 
       delegate :organization, :customer, to: :invoice
@@ -126,6 +127,8 @@ def payment_url_params(payment_intent)
       end
 
       def update_invoice_payment_status(payment_status:, deliver_webhook: true)
+        @invoice = result.invoice
+
         params = {
           payment_status:,
           ready_for_payment_processing: payment_status.to_sym != :succeeded

app/services/invoices/payments/cashfree_service.rb

@@ -4,14 +4,16 @@ module Invoices
   module Payments
     class CashfreeService < BaseService
       include Customers::PaymentProviderFinder
+      include TypedResults
 
       PROVIDER_NAME = "Cashfree"
 
-      def initialize(invoice = nil)
-        @invoice = invoice
+      RESULTS = {
+        update_payment_status: BaseResult[:payment, :invoice],
+        generate_payment_url: BaseResult[:payment_url]
+      }.freeze
 
-        super
-      end
+      private
 
       def update_payment_status(organization_id:, status:, cashfree_payment:, amount_cents: nil)
         payment = if cashfree_payment.metadata[:payment_type] == "one-time"
@@ -42,7 +44,8 @@ def update_payment_status(organization_id:, status:, cashfree_payment:, amount_c
         result.fail_with_error!(e)
       end
 
-      def generate_payment_url(payment_intent)
+      def generate_payment_url(invoice, payment_intent)
+        @invoice = invoice
         payment_link_response = create_payment_link(payment_url_params(payment_intent))
         result.payment_url = JSON.parse(payment_link_response.body)["link_url"]
 
@@ -51,8 +54,6 @@ def generate_payment_url(payment_intent)
         result.third_party_failure!(third_party: PROVIDER_NAME, error_code: e.error_code, error_message: e.error_body)
       end
 
-      private
-
       attr_accessor :invoice
 
       delegate :organization, :customer, to: :invoice

app/services/invoices/payments/flutterwave_service.rb

@@ -4,14 +4,16 @@ module Invoices
   module Payments
     class FlutterwaveService < BaseService
       include Customers::PaymentProviderFinder
+      include TypedResults
 
       PROVIDER_NAME = "Flutterwave"
 
-      def initialize(invoice = nil)
-        @invoice = invoice
+      RESULTS = {
+        update_payment_status: BaseResult[:payment, :invoice],
+        generate_payment_url: BaseResult[:payment_url]
+      }.freeze
 
-        super
-      end
+      private
 
       def update_payment_status(organization_id:, status:, flutterwave_payment:, amount_cents: nil)
         payment = if flutterwave_payment.metadata[:payment_type] == "one-time"
@@ -42,15 +44,14 @@ def update_payment_status(organization_id:, status:, flutterwave_payment:, amoun
         result.fail_with_error!(e)
       end
 
-      def generate_payment_url(payment_intent)
+      def generate_payment_url(invoice, payment_intent)
+        @invoice = invoice
         result.payment_url = payment_url
         result
       rescue LagoHttpClient::HttpError => e
         result.third_party_failure!(third_party: PROVIDER_NAME, error_code: e.error_code, error_message: e.error_body)
       end
 
-      private
-
       attr_accessor :invoice
 
       delegate :organization, :customer, to: :invoice

app/services/invoices/payments/gocardless_service.rb

@@ -4,12 +4,13 @@ module Invoices
   module Payments
     class GocardlessService < BaseService
       include Customers::PaymentProviderFinder
+      include TypedResults
 
-      def initialize(invoice = nil)
-        @invoice = invoice
+      RESULTS = {
+        update_payment_status: BaseResult[:payment, :invoice]
+      }.freeze
 
-        super
-      end
+      private
 
       def update_payment_status(provider_payment_id:, status:)
         payment = Payment.find_by(provider_payment_id:)
@@ -36,8 +37,6 @@ def update_payment_status(provider_payment_id:, status:)
         result.fail_with_error!(e)
       end
 
-      private
-
       attr_accessor :invoice
 
       delegate :organization, :customer, to: :invoice

app/services/invoices/payments/moneyhash_service.rb

@@ -4,12 +4,14 @@ module Invoices
   module Payments
     class MoneyhashService < BaseService
       include Customers::PaymentProviderFinder
+      include TypedResults
 
-      def initialize(invoice = nil)
-        @invoice = invoice
+      RESULTS = {
+        update_payment_status: BaseResult[:payment, :invoice],
+        generate_payment_url: BaseResult[:payment_url]
+      }.freeze
 
-        super(nil)
-      end
+      private
 
       def update_payment_status(organization_id:, provider_payment_id:, status:, amount_cents: nil, metadata: {})
         payment_obj = Payment.find_or_initialize_by(provider_payment_id: provider_payment_id)
@@ -39,7 +41,8 @@ def update_payment_status(organization_id:, provider_payment_id:, status:, amoun
         result.fail_with_error!(e)
       end
 
-      def generate_payment_url(payment_intent)
+      def generate_payment_url(invoice, payment_intent)
+        @invoice = invoice
         return result unless should_process_payment?
 
         response = client.post_with_response(
@@ -58,8 +61,6 @@ def generate_payment_url(payment_intent)
         result.service_failure!(code: e.error_code, message: e.message)
       end
 
-      private
-
       attr_accessor :invoice
 
       delegate :organization, :customer, to: :invoice

app/services/invoices/payments/payment_providers/factory.rb

@@ -4,8 +4,8 @@ module Invoices
   module Payments
     module PaymentProviders
       class Factory
-        def self.new_instance(invoice:)
-          service_class(invoice.customer&.payment_provider).new(invoice)
+        def self.for(invoice)
+          service_class(invoice.customer&.payment_provider)
         end
 
         def self.service_class(payment_provider)

app/services/invoices/payments/stripe_service.rb

@@ -4,14 +4,17 @@ module Invoices
   module Payments
     class StripeService < BaseService
       include Customers::PaymentProviderFinder
+      include TypedResults
 
       PROVIDER_NAME = "Stripe"
 
-      def initialize(invoice = nil)
-        @invoice = invoice
+      RESULTS = {
+        update_payment_status: BaseResult[:payment, :invoice],
+        generate_payment_url: BaseResult[:payment_url, :provider_session_id],
+        expire_payment_url: BaseResult
+      }.freeze
 
-        super
-      end
+      private
 
       def update_payment_status(organization_id:, status:, stripe_payment:, amount_cents: nil)
         payment = Payment.find_by(provider_payment_id: stripe_payment.id)
@@ -60,7 +63,8 @@ def update_payment_status(organization_id:, status:, stripe_payment:, amount_cen
         result.fail_with_error!(e)
       end
 
-      def generate_payment_url(payment_intent)
+      def generate_payment_url(invoice, payment_intent)
+        @invoice = invoice
         res = ::Stripe::Checkout::Session.create(
           payment_url_payload(payment_intent),
           {
@@ -78,7 +82,8 @@ def generate_payment_url(payment_intent)
       end
 
       # NOTE: Expires the hosted Stripe Checkout open Session so it can no longer be paid.
-      def expire_payment_url(payment_intent)
+      def expire_payment_url(invoice, payment_intent)
+        @invoice = invoice
         return result if payment_intent.provider_session_id.blank?
 
         session = ::Stripe::Checkout::Session.retrieve(
@@ -99,8 +104,6 @@ def expire_payment_url(payment_intent)
         result
       end
 
-      private
-
       attr_accessor :invoice
 
       delegate :organization, :customer, to: :invoice

app/services/payment_intents/expire_service.rb

@@ -15,9 +15,8 @@ def call
       payment_intents.find_each do |payment_intent|
         if payment_intent.provider_session_id.present?
           Invoices::Payments::PaymentProviders::Factory
-            .new_instance(invoice:)
-            .expire_payment_url(payment_intent)
-            .raise_if_error!
+            .for(invoice)
+            .call!(:expire_payment_url, invoice, payment_intent)
         end
 
         payment_intent.expired!

app/services/payment_intents/fetch_service.rb

@@ -17,10 +17,8 @@ def call
 
       if payment_intent.payment_url.blank?
         payment_url_result = Invoices::Payments::PaymentProviders::Factory
-          .new_instance(invoice:)
-          .generate_payment_url(payment_intent)
-
-        payment_url_result.raise_if_error!
+          .for(invoice)
+          .call!(:generate_payment_url, invoice, payment_intent)
 
         if payment_url_result.payment_url.blank?
           return result.single_validation_failure!(error_code: "payment_provider_error")

app/services/payment_providers/adyen/handle_event_service.rb

@@ -50,9 +50,16 @@ def call
           return result unless payment
 
           metadata = {lago_payable_type: payment.payable_type}
-          update_result = payment_service_klass(metadata)
-            .new
-            .update_payment_status(provider_payment_id:, status: "Cancelled", metadata:)
+          klass = payment_service_klass(metadata)
+          args = {provider_payment_id:, status: "Cancelled", metadata:}
+
+          # NOTE: Temporary branch until PaymentRequests::Payments services are migrated to
+          #       TypedResults too. Once they are, call `klass.call(:update_payment_status, **args)` directly.
+          update_result = if klass.include?(TypedResults)
+            klass.call(:update_payment_status, **args)
+          else
+            klass.new.update_payment_status(**args)
+          end
           update_result.raise_if_error!
         when "REFUND"
           service = CreditNotes::Refunds::AdyenService.new
@@ -97,12 +104,21 @@ def update_payment_status(payment_type)
           lago_payable_type: event.dig("additionalData", "metadata.lago_payable_type")
         }
 
-        payment_service_klass(metadata).new.update_payment_status(
+        klass = payment_service_klass(metadata)
+        args = {
           provider_payment_id:,
           status:,
           amount_cents: event.dig("amount", "value"),
           metadata:
-        )
+        }
+
+        # NOTE: Temporary branch until PaymentRequests::Payments services are migrated to
+        #       TypedResults too. Once they are, call `klass.call(:update_payment_status, **args)` directly.
+        if klass.include?(TypedResults)
+          klass.call(:update_payment_status, **args)
+        else
+          klass.new.update_payment_status(**args)
+        end
       end
 
       def payment_service_klass(metadata)