tinker-pay-ruby-sdk 0.1.0 → 0.6.0

data/lib/tinker/model/dto/managed_checkout.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Model
+    module Dto
+      # Exact integer minor-unit prices for managed recurring billing.
+      class ManagedCheckout
+        def initialize(external_customer_id:, email:, name:, currency:, unit_amount:, quantity:,
+                       interval:, return_url:, idempotency_key:, trial_days: 0, trial_end: nil)
+          @payload = {
+            external_customer_id: external_customer_id, email: email, name: name, currency: currency,
+            unit_amount: unit_amount, quantity: quantity, interval: interval, return_url: return_url,
+            idempotency_key: idempotency_key
+          }
+          @payload[:trial_days] = trial_days if trial_days.positive?
+          @payload[:trial_end] = trial_end.to_i if trial_end
+        end
+
+        def to_hash
+          @payload.dup
+        end
+      end
+    end
+  end
+end

data/lib/tinker/model/dto/payout_request.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Model
+    module Dto
+      class PayoutRequest
+        def initialize(payout_method_id:, amount:, currency:, expected_fee_amount:)
+          @payload = { payout_method_id: payout_method_id, amount: amount, currency: currency,
+                       expected_fee_amount: expected_fee_amount }
+        end
+
+        def to_hash
+          @payload.dup
+        end
+      end
+    end
+  end
+end

data/lib/tinker/model/dto/query_data_dto.rb

@@ -4,22 +4,18 @@ module Tinker
   module Model
     module Dto
       class QueryDataDto
-        attr_reader :id, :status, :reference, :amount, :currency, :paid_at, :created_at, :channel
+        attr_reader :id, :status, :reference, :amount, :currency, :paid_at, :created_at, :channel, :country
 
         def initialize(data)
           @id = data['id']
-          status_value = data['status'] || 'pending'
-          @status = begin
-            Tinker::Enum::PaymentStatus.const_get(status_value.upcase)
-          rescue NameError
-            Tinker::Enum::PaymentStatus::PENDING
-          end
+          @status = Tinker::Enum::PaymentStatus.parse(data['status'])
           @reference = data['reference']
           @amount = data['amount'].to_f
           @currency = data['currency']
           @paid_at = data['paid_at']
           @created_at = data['created_at']
           @channel = data['channel']
+          @country = data['country']
         end
 
         def to_hash
@@ -32,7 +28,7 @@ module Tinker
             paid_at: @paid_at,
             created_at: @created_at,
             channel: @channel
-          }
+          }.merge(@country ? { country: @country } : {})
         end
       end
     end

data/lib/tinker/model/dto/query_payment_request_dto.rb

@@ -15,7 +15,7 @@ module Tinker
           gateway_value = @gateway.is_a?(String) ? @gateway : @gateway.to_s
 
           {
-            payment_reference: @payment_reference,
+            reference: @payment_reference,
             gateway: gateway_value
           }
         end

data/lib/tinker/model/dto/refund_request.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Model
+    module Dto
+      class RefundRequest
+        def initialize(reason:, amount: nil, note: nil)
+          @payload = { reason: reason, amount: amount, note: note }.compact
+        end
+
+        def to_hash
+          @payload.dup
+        end
+      end
+    end
+  end
+end

data/lib/tinker/model/dto/subscription_customer_dto.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Model
+    module Dto
+      class SubscriptionCustomerDto
+        def initialize(external_customer_id:, name:, email: nil, phone: nil, metadata: nil)
+          @external_customer_id = external_customer_id
+          @name = name
+          @email = email
+          @phone = phone
+          @metadata = metadata
+        end
+
+        def to_hash
+          payload = {
+            external_customer_id: @external_customer_id,
+            name: @name
+          }
+          payload[:email] = @email if @email
+          payload[:phone] = @phone if @phone
+          payload[:metadata] = @metadata if @metadata
+          payload
+        end
+      end
+    end
+  end
+end

data/lib/tinker/model/lifecycle_resource.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Model
+    # Keep provider-independent status and all additive response fields.
+    class LifecycleResource
+      def initialize(data)
+        @data = data.dup
+      end
+
+      def id
+        @data['id']
+      end
+
+      def status
+        @data['status']
+      end
+
+      def [](key)
+        @data[key.to_s]
+      end
+
+      def to_hash
+        @data.dup
+      end
+    end
+  end
+end

data/lib/tinker/model/payout.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Model
+    class Payout < LifecycleResource
+    end
+  end
+end

data/lib/tinker/model/payout_result.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Model
+    class PayoutResult
+      attr_reader :withdrawal, :replayed
+
+      def initialize(data)
+        @withdrawal = Payout.new(data.fetch('withdrawal'))
+        @replayed = data['replayed'] == true
+      end
+    end
+  end
+end

data/lib/tinker/model/refund.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Model
+    class Refund < LifecycleResource
+    end
+  end
+end

data/lib/tinker/model/refund_result.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Model
+    class RefundResult
+      attr_reader :refund, :replayed, :payment
+
+      def initialize(data)
+        @refund = Refund.new(data.fetch('refund'))
+        @replayed = data['replayed'] == true
+        @payment = data.fetch('payment', {})
+      end
+    end
+  end
+end

data/lib/tinker/model/transaction.rb

@@ -6,7 +6,7 @@ module Tinker
       attr_reader :status, :initiation_data, :query_data, :callback_data
 
       def initialize(data)
-        if data['payment_reference'] && !data['id']
+        if (data['paymentReference'] || data['payment_reference']) && !data['id']
           @initiation_data = Dto::InitiationDataDto.new(data)
           @query_data = nil
           @callback_data = nil
@@ -20,12 +20,7 @@ module Tinker
           @initiation_data = nil
           @query_data = nil
           @callback_data = nil
-          status_value = data['status'] || 'pending'
-          @status = begin
-            Enum::PaymentStatus.const_get(status_value.upcase)
-          rescue NameError
-            Enum::PaymentStatus::PENDING
-          end
+          @status = Enum::PaymentStatus.parse(data['status'])
         end
       end
 

data/lib/tinker/payments.rb

@@ -7,16 +7,17 @@ require_relative 'http/http_client'
 require_relative 'auth/authentication_manager'
 require_relative 'api/base_manager'
 require_relative 'api/transaction_manager'
+require_relative 'api/subscription_manager'
+require_relative 'api/payout_manager'
 require_relative 'webhook/webhook_handler'
 
 module Tinker
   class Payments
-    def initialize(api_public_key:, api_secret_key:, http_client: nil)
-      @config = Config::Configuration.new(api_public_key: api_public_key, api_secret_key: api_secret_key)
+    def initialize(api_public_key:, api_secret_key:, http_client: nil, base_url: nil)
+      @config = Config::Configuration.new(api_public_key: api_public_key, api_secret_key: api_secret_key,
+                                          base_url: base_url)
       @http_client = http_client || Http::HttpClient.new
       @auth_manager = Auth::AuthenticationManager.new(config: @config, http_client: @http_client)
-      @transactions_manager = nil
-      @webhook_handler = nil
     end
 
     def transactions
@@ -27,8 +28,24 @@ module Tinker
       )
     end
 
+    def subscriptions
+      @subscriptions ||= Api::SubscriptionManager.new(
+        config: @config,
+        http_client: @http_client,
+        auth_manager: @auth_manager
+      )
+    end
+
+    def payouts
+      @payouts ||= Api::PayoutManager.new(config: @config, http_client: @http_client, auth_manager: @auth_manager)
+    end
+
     def webhooks
       @webhooks ||= Webhook::WebhookHandler.new
     end
+
+    def last_auth_meta
+      @auth_manager.last_meta
+    end
   end
 end

data/lib/tinker/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tinker
-  VERSION = '0.1.0'
+  VERSION = '0.6.0'
 end

data/lib/tinker/webhook/dto/invoice_event_data_dto.rb

@@ -7,11 +7,11 @@ module Tinker
         attr_reader :id, :status, :invoice_number, :amount, :currency, :subscription_id, :created_at, :paid_at
 
         def initialize(data)
-          @id = data['id']
-          @status = data['status']
+          @id = data['invoice_id'] || data['id']
+          @status = data['status'] || ''
           @invoice_number = data['invoice_number'] || ''
-          @amount = data['amount'].to_f
-          @currency = data['currency']
+          @amount = (data['amount'] || 0).to_f
+          @currency = data['currency'] || ''
           @subscription_id = data['subscription_id'] || ''
           @created_at = data['created_at'] || ''
           @paid_at = data['paid_at']
@@ -20,6 +20,7 @@ module Tinker
         def to_hash
           {
             id: @id,
+            invoice_id: @id,
             status: @status,
             invoice_number: @invoice_number,
             amount: @amount,

data/lib/tinker/webhook/dto/onboarding_event_data_dto.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Webhook
+    module Dto
+      class OnboardingEventDataDto
+        attr_reader :message
+
+        def initialize(data)
+          @message = data.fetch('message', '').to_s
+        end
+
+        def to_hash
+          { 'message' => @message }
+        end
+      end
+    end
+  end
+end

data/lib/tinker/webhook/dto/payment_event_data_dto.rb

@@ -4,22 +4,18 @@ module Tinker
   module Webhook
     module Dto
       class PaymentEventDataDto
-        attr_reader :id, :status, :reference, :amount, :currency, :channel, :created_at, :paid_at
+        attr_reader :id, :status, :reference, :amount, :currency, :channel, :created_at, :paid_at, :country
 
         def initialize(data)
           @id = data['id']
-          status_value = data['status'] || 'pending'
-          @status = begin
-            Tinker::Enum::PaymentStatus.const_get(status_value.upcase)
-          rescue NameError
-            Tinker::Enum::PaymentStatus::PENDING
-          end
+          @status = Tinker::Enum::PaymentStatus.parse(data['status'])
           @reference = data['reference']
           @amount = data['amount'].to_f
           @currency = data['currency']
           @channel = data['channel']
           @created_at = data['created_at']
           @paid_at = data['paid_at']
+          @country = data['country']
         end
 
         def to_hash
@@ -32,7 +28,7 @@ module Tinker
             'channel' => @channel,
             'created_at' => @created_at,
             'paid_at' => @paid_at
-          }
+          }.merge(@country ? { 'country' => @country } : {})
         end
       end
     end

data/lib/tinker/webhook/dto/settlement_event_data_dto.rb

@@ -4,13 +4,14 @@ module Tinker
   module Webhook
     module Dto
       class SettlementEventDataDto
-        attr_reader :id, :status, :amount, :currency, :settlement_date, :created_at, :processed_at
+        attr_reader :id, :status, :amount, :net_amount, :currency, :settlement_date, :created_at, :processed_at
 
         def initialize(data)
-          @id = data['id']
-          @status = data['status']
-          @amount = data['amount'].to_f
-          @currency = data['currency']
+          @id = data['settlement_id'] || data['id']
+          @status = data['status'] || ''
+          @amount = (data['amount'] || 0).to_f
+          @net_amount = data['net_amount']&.to_f
+          @currency = data['currency'] || ''
           @settlement_date = data['settlement_date'] || ''
           @created_at = data['created_at'] || ''
           @processed_at = data['processed_at']
@@ -19,8 +20,10 @@ module Tinker
         def to_hash
           {
             id: @id,
+            settlement_id: @id,
             status: @status,
             amount: @amount,
+            net_amount: @net_amount,
             currency: @currency,
             settlement_date: @settlement_date,
             created_at: @created_at,

data/lib/tinker/webhook/dto/subscription_event_data_dto.rb

@@ -4,14 +4,17 @@ module Tinker
   module Webhook
     module Dto
       class SubscriptionEventDataDto
-        attr_reader :id, :status, :plan_id, :customer_id, :created_at, :cancelled_at, :paused_at, :reactivated_at
+        attr_reader :id, :status, :plan_id, :account_id, :current_period_start, :current_period_end, :created_at,
+                    :cancelled_at, :paused_at, :reactivated_at
 
         def initialize(data)
-          @id = data['id']
-          @status = data['status']
+          @id = data['subscription_id'] || data['id']
+          @status = data['status'] || ''
           @plan_id = data['plan_id'] || ''
-          @customer_id = data['customer_id'] || ''
-          @created_at = data['created_at'] || ''
+          @account_id = data['account_id'] || data['customer_id'] || ''
+          @current_period_start = data['current_period_start']
+          @current_period_end = data['current_period_end']
+          @created_at = data['created_at'] || @current_period_start || ''
           @cancelled_at = data['cancelled_at']
           @paused_at = data['paused_at']
           @reactivated_at = data['reactivated_at']
@@ -20,9 +23,12 @@ module Tinker
         def to_hash
           {
             id: @id,
+            subscription_id: @id,
             status: @status,
             plan_id: @plan_id,
-            customer_id: @customer_id,
+            account_id: @account_id,
+            current_period_start: @current_period_start,
+            current_period_end: @current_period_end,
             created_at: @created_at,
             cancelled_at: @cancelled_at,
             paused_at: @paused_at,

data/lib/tinker/webhook/webhook_event.rb

@@ -3,18 +3,45 @@
 module Tinker
   module Webhook
     class WebhookEvent
-      attr_reader :id, :type, :source, :timestamp, :data, :meta, :security
+      attr_reader :id, :type, :source, :timestamp, :data, :meta, :security, :raw_data, :raw_meta
 
       def initialize(payload)
         @id = payload['id']
         @type = payload['type']
         @source = payload['source']
         @timestamp = payload['timestamp']
-        @data = create_event_data(payload['data'], @source)
-        @meta = WebhookMeta.new(payload['meta'] || {})
+        @raw_data = payload['data'].is_a?(Hash) ? payload['data'] : {}
+        @raw_meta = payload['meta'].is_a?(Hash) ? payload['meta'] : {}
+        @data = create_event_data(@raw_data, @source)
+        @meta = WebhookMeta.new(@raw_meta)
         @security = WebhookSecurity.new(payload['security'] || {})
       end
 
+      def onboarding_event?
+        @source == 'onboarding'
+      end
+
+      # Verify the signature before acknowledging a setup test.
+      def setup_test?
+        onboarding_event? && @type == 'setup.webhook_test'
+      end
+
+      def onboarding_data
+        @data.is_a?(Dto::OnboardingEventDataDto) ? @data : nil
+      end
+
+      def cancellation_data
+        @data.is_a?(Model::CheckoutCancellation) ? @data : nil
+      end
+
+      def refund_data
+        @data.is_a?(Model::Refund) ? @data : nil
+      end
+
+      def payout_data
+        @data.is_a?(Model::Payout) ? @data : nil
+      end
+
       def payment_event?
         @source == 'payment'
       end
@@ -57,7 +84,21 @@ module Tinker
       private
 
       def create_event_data(data, source)
+        resource_types = {
+          'checkout.cancellation.updated' => Model::CheckoutCancellation,
+          'refund.updated' => Model::Refund,
+          'withdrawal.updated' => Model::Payout
+        }
+        resource_type = resource_types[@type.to_s.sub(/\.v[^.]+\z/, '')] if source == 'payment'
+        return resource_type.new(data.fetch('resource', {})) if resource_type
+
+        source_event_data(data, source)
+      end
+
+      def source_event_data(data, source)
         case source
+        when 'onboarding'
+          Dto::OnboardingEventDataDto.new(data)
         when 'payment'
           Dto::PaymentEventDataDto.new(data)
         when 'subscription'

data/lib/tinker/webhook/webhook_handler.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'json'
+require 'openssl'
 
 module Tinker
   module Webhook
@@ -30,6 +31,47 @@ module Tinker
         event = handle(payload)
         event.to_transaction
       end
+
+      def verify_signature(payload_or_event, webhook_secret)
+        return false if webhook_secret.nil? || webhook_secret.empty?
+
+        event = payload_or_event.is_a?(WebhookEvent) ? payload_or_event : handle(payload_or_event)
+        signature = event.security.signature
+        return false unless event.security.algorithm == 'HMAC-SHA256' && signature&.start_with?('sha256=')
+
+        computed = computed_signature(event, webhook_secret)
+        return false unless signature.bytesize == computed.bytesize
+
+        OpenSSL.fixed_length_secure_compare(signature, computed)
+      end
+
+      private
+
+      def sort_maps(value)
+        case value
+        when Hash
+          value.keys.sort.to_h { |key| [key, sort_maps(value[key])] }
+        when Array
+          value.map { |item| sort_maps(item) }
+        else
+          value
+        end
+      end
+
+      def computed_signature(event, webhook_secret)
+        payload_without_security = {
+          id: event.id,
+          type: event.type,
+          source: event.source,
+          timestamp: event.timestamp,
+          data: sort_maps(event.raw_data),
+          meta: sort_maps(event.raw_meta)
+        }
+
+        encoded = JSON.generate(payload_without_security)
+        encoded = encoded.gsub(/[<>&\u2028\u2029]/) { |char| format('\\u%04x', char.ord) }
+        "sha256=#{OpenSSL::HMAC.hexdigest('SHA256', webhook_secret, encoded)}"
+      end
     end
   end
 end

data/lib/tinker.rb

@@ -5,6 +5,7 @@ require_relative 'tinker/config/configuration'
 require_relative 'tinker/config/endpoints'
 require_relative 'tinker/exception/exception_code'
 require_relative 'tinker/exception/api_exception'
+require_relative 'tinker/exception/feature_not_supported_exception'
 require_relative 'tinker/exception/network_exception'
 require_relative 'tinker/exception/authentication_exception'
 require_relative 'tinker/exception/invalid_payload_exception'
@@ -16,12 +17,19 @@ require_relative 'tinker/http/http_client'
 require_relative 'tinker/auth/authentication_manager'
 require_relative 'tinker/api/base_manager'
 require_relative 'tinker/api/transaction_manager'
+require_relative 'tinker/api/subscription_manager'
 require_relative 'tinker/model/dto/initiate_payment_request_dto'
 require_relative 'tinker/model/dto/query_payment_request_dto'
+require_relative 'tinker/model/dto/create_subscription_plan_request_dto'
+require_relative 'tinker/model/dto/subscription_customer_dto'
+require_relative 'tinker/model/dto/create_subscription_request_dto'
+require_relative 'tinker/model/dto/managed_checkout'
 require_relative 'tinker/model/dto/initiation_data_dto'
 require_relative 'tinker/model/dto/query_data_dto'
 require_relative 'tinker/model/dto/callback_data_dto'
+require_relative 'tinker/model/api_meta'
 require_relative 'tinker/model/transaction'
+require_relative 'tinker/webhook/dto/onboarding_event_data_dto'
 require_relative 'tinker/webhook/dto/payment_event_data_dto'
 require_relative 'tinker/webhook/dto/subscription_event_data_dto'
 require_relative 'tinker/webhook/dto/invoice_event_data_dto'
@@ -30,4 +38,15 @@ require_relative 'tinker/webhook/webhook_meta'
 require_relative 'tinker/webhook/webhook_security'
 require_relative 'tinker/webhook/webhook_event'
 require_relative 'tinker/webhook/webhook_handler'
+require_relative 'tinker/model/lifecycle_resource'
+require_relative 'tinker/model/refund'
+require_relative 'tinker/model/payout'
+require_relative 'tinker/model/checkout_cancellation'
+require_relative 'tinker/model/refund_result'
+require_relative 'tinker/model/payout_result'
+require_relative 'tinker/model/cancellation_result'
+require_relative 'tinker/model/dto/refund_request'
+require_relative 'tinker/model/dto/payout_request'
+require_relative 'tinker/model/dto/cancellation_request'
+require_relative 'tinker/api/payout_manager'
 require_relative 'tinker/payments'