tinker-pay-ruby-sdk 0.1.0

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Model
+    module Dto
+      class CallbackDataDto
+        attr_reader :id, :status, :reference, :amount, :currency, :paid_at, :created_at, :channel
+
+        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
+          @reference = data['reference']
+          @amount = data['amount'].to_f
+          @currency = data['currency']
+          @paid_at = data['paid_at']
+          @created_at = data['created_at']
+          @channel = data['channel']
+        end
+
+        def to_hash
+          {
+            id: @id,
+            status: @status,
+            reference: @reference,
+            amount: @amount,
+            currency: @currency,
+            paid_at: @paid_at,
+            created_at: @created_at,
+            channel: @channel
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Model
+    module Dto
+      class InitiatePaymentRequestDto
+        attr_reader :amount, :currency, :gateway, :merchant_reference, :return_url,
+                    :customer_phone, :customer_email, :transaction_desc, :metadata
+
+        def initialize(amount:, currency:, gateway:, merchant_reference:, return_url:,
+                       customer_phone: nil, customer_email: nil, transaction_desc: nil, metadata: nil)
+          @amount = amount
+          @currency = currency
+          @gateway = gateway
+          @merchant_reference = merchant_reference
+          @return_url = return_url
+          @customer_phone = customer_phone
+          @customer_email = customer_email
+          @transaction_desc = transaction_desc
+          @metadata = metadata
+        end
+
+        def to_hash
+          gateway_value = @gateway.is_a?(String) ? @gateway : @gateway.to_s
+
+          payload = {
+            amount: @amount,
+            currency: @currency,
+            gateway: gateway_value,
+            merchantReference: @merchant_reference,
+            returnUrl: @return_url
+          }
+
+          payload[:customerPhone] = @customer_phone if @customer_phone
+          payload[:customerEmail] = @customer_email if @customer_email
+          payload[:transactionDesc] = @transaction_desc if @transaction_desc
+          payload[:metadata] = @metadata if @metadata
+
+          payload
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Model
+    module Dto
+      class InitiationDataDto
+        attr_reader :payment_reference, :status, :authorization_url
+
+        def initialize(data)
+          @payment_reference = data['payment_reference']
+          status_value = data['status'] || 'pending'
+          @status = begin
+            Tinker::Enum::PaymentStatus.const_get(status_value.upcase)
+          rescue NameError
+            Tinker::Enum::PaymentStatus::PENDING
+          end
+          @authorization_url = data['authorization_url']
+        end
+
+        def to_hash
+          {
+            payment_reference: @payment_reference,
+            status: @status,
+            authorization_url: @authorization_url
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Model
+    module Dto
+      class QueryDataDto
+        attr_reader :id, :status, :reference, :amount, :currency, :paid_at, :created_at, :channel
+
+        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
+          @reference = data['reference']
+          @amount = data['amount'].to_f
+          @currency = data['currency']
+          @paid_at = data['paid_at']
+          @created_at = data['created_at']
+          @channel = data['channel']
+        end
+
+        def to_hash
+          {
+            id: @id,
+            status: @status,
+            reference: @reference,
+            amount: @amount,
+            currency: @currency,
+            paid_at: @paid_at,
+            created_at: @created_at,
+            channel: @channel
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Model
+    module Dto
+      class QueryPaymentRequestDto
+        attr_reader :payment_reference, :gateway
+
+        def initialize(payment_reference:, gateway:)
+          @payment_reference = payment_reference
+          @gateway = gateway
+        end
+
+        def to_hash
+          gateway_value = @gateway.is_a?(String) ? @gateway : @gateway.to_s
+
+          {
+            payment_reference: @payment_reference,
+            gateway: gateway_value
+          }
+        end
+      end
+    end
+  end
+end

data/lib/tinker/model/transaction.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Model
+    class Transaction
+      attr_reader :status, :initiation_data, :query_data, :callback_data
+
+      def initialize(data)
+        if data['payment_reference'] && !data['id']
+          @initiation_data = Dto::InitiationDataDto.new(data)
+          @query_data = nil
+          @callback_data = nil
+          @status = @initiation_data.status
+        elsif data['id'] && data['reference']
+          @initiation_data = nil
+          @query_data = Dto::QueryDataDto.new(data)
+          @callback_data = Dto::CallbackDataDto.new(data)
+          @status = @query_data.status
+        else
+          @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
+        end
+      end
+
+      def successful?
+        @status == Enum::PaymentStatus::SUCCESS
+      end
+
+      def pending?
+        @status == Enum::PaymentStatus::PENDING
+      end
+
+      def cancelled?
+        @status == Enum::PaymentStatus::CANCELLED
+      end
+
+      def failed?
+        @status == Enum::PaymentStatus::FAILED
+      end
+    end
+  end
+end

data/lib/tinker/payments.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'version'
+require_relative 'config/configuration'
+require_relative 'config/endpoints'
+require_relative 'http/http_client'
+require_relative 'auth/authentication_manager'
+require_relative 'api/base_manager'
+require_relative 'api/transaction_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)
+      @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
+      @transactions ||= Api::TransactionManager.new(
+        config: @config,
+        http_client: @http_client,
+        auth_manager: @auth_manager
+      )
+    end
+
+    def webhooks
+      @webhooks ||= Webhook::WebhookHandler.new
+    end
+  end
+end

data/lib/tinker/version.rb

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

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Webhook
+    module Dto
+      class InvoiceEventDataDto
+        attr_reader :id, :status, :invoice_number, :amount, :currency, :subscription_id, :created_at, :paid_at
+
+        def initialize(data)
+          @id = data['id']
+          @status = data['status']
+          @invoice_number = data['invoice_number'] || ''
+          @amount = data['amount'].to_f
+          @currency = data['currency']
+          @subscription_id = data['subscription_id'] || ''
+          @created_at = data['created_at'] || ''
+          @paid_at = data['paid_at']
+        end
+
+        def to_hash
+          {
+            id: @id,
+            status: @status,
+            invoice_number: @invoice_number,
+            amount: @amount,
+            currency: @currency,
+            subscription_id: @subscription_id,
+            created_at: @created_at,
+            paid_at: @paid_at
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Webhook
+    module Dto
+      class PaymentEventDataDto
+        attr_reader :id, :status, :reference, :amount, :currency, :channel, :created_at, :paid_at
+
+        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
+          @reference = data['reference']
+          @amount = data['amount'].to_f
+          @currency = data['currency']
+          @channel = data['channel']
+          @created_at = data['created_at']
+          @paid_at = data['paid_at']
+        end
+
+        def to_hash
+          {
+            'id' => @id,
+            'status' => @status.to_s,
+            'reference' => @reference,
+            'amount' => @amount,
+            'currency' => @currency,
+            'channel' => @channel,
+            'created_at' => @created_at,
+            'paid_at' => @paid_at
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Webhook
+    module Dto
+      class SettlementEventDataDto
+        attr_reader :id, :status, :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']
+          @settlement_date = data['settlement_date'] || ''
+          @created_at = data['created_at'] || ''
+          @processed_at = data['processed_at']
+        end
+
+        def to_hash
+          {
+            id: @id,
+            status: @status,
+            amount: @amount,
+            currency: @currency,
+            settlement_date: @settlement_date,
+            created_at: @created_at,
+            processed_at: @processed_at
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Webhook
+    module Dto
+      class SubscriptionEventDataDto
+        attr_reader :id, :status, :plan_id, :customer_id, :created_at, :cancelled_at, :paused_at, :reactivated_at
+
+        def initialize(data)
+          @id = data['id']
+          @status = data['status']
+          @plan_id = data['plan_id'] || ''
+          @customer_id = data['customer_id'] || ''
+          @created_at = data['created_at'] || ''
+          @cancelled_at = data['cancelled_at']
+          @paused_at = data['paused_at']
+          @reactivated_at = data['reactivated_at']
+        end
+
+        def to_hash
+          {
+            id: @id,
+            status: @status,
+            plan_id: @plan_id,
+            customer_id: @customer_id,
+            created_at: @created_at,
+            cancelled_at: @cancelled_at,
+            paused_at: @paused_at,
+            reactivated_at: @reactivated_at
+          }
+        end
+      end
+    end
+  end
+end

data/lib/tinker/webhook/webhook_event.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Webhook
+    class WebhookEvent
+      attr_reader :id, :type, :source, :timestamp, :data, :meta, :security
+
+      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'] || {})
+        @security = WebhookSecurity.new(payload['security'] || {})
+      end
+
+      def payment_event?
+        @source == 'payment'
+      end
+
+      def subscription_event?
+        @source == 'subscription'
+      end
+
+      def invoice_event?
+        @source == 'invoice'
+      end
+
+      def settlement_event?
+        @source == 'settlement'
+      end
+
+      def payment_data
+        @data.is_a?(Dto::PaymentEventDataDto) ? @data : nil
+      end
+
+      def subscription_data
+        @data.is_a?(Dto::SubscriptionEventDataDto) ? @data : nil
+      end
+
+      def invoice_data
+        @data.is_a?(Dto::InvoiceEventDataDto) ? @data : nil
+      end
+
+      def settlement_data
+        @data.is_a?(Dto::SettlementEventDataDto) ? @data : nil
+      end
+
+      def to_transaction
+        return nil unless payment_event?
+        return nil unless @data.is_a?(Dto::PaymentEventDataDto)
+
+        Model::Transaction.new(@data.to_hash)
+      end
+
+      private
+
+      def create_event_data(data, source)
+        case source
+        when 'payment'
+          Dto::PaymentEventDataDto.new(data)
+        when 'subscription'
+          Dto::SubscriptionEventDataDto.new(data)
+        when 'invoice'
+          Dto::InvoiceEventDataDto.new(data)
+        when 'settlement'
+          Dto::SettlementEventDataDto.new(data)
+        else
+          raise Exception::InvalidPayloadException.new("Unknown webhook source: #{source}", Exception::ExceptionCode::INVALID_PAYLOAD)
+        end
+      end
+    end
+  end
+end

data/lib/tinker/webhook/webhook_handler.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Tinker
+  module Webhook
+    class WebhookHandler
+      def handle(payload)
+        data = if payload.is_a?(String)
+                 JSON.parse(payload)
+               else
+                 payload
+               end
+
+        raise Exception::InvalidPayloadException, 'Webhook payload must be a hash' unless data.is_a?(Hash)
+
+        WebhookEvent.new(data)
+      rescue JSON::ParserError => e
+        raise Exception::InvalidPayloadException, "Invalid JSON payload: #{e.message}"
+      end
+
+      def handle_from_request(request_body = nil)
+        payload = request_body || $stdin.read
+        raise Exception::WebhookException, 'Unable to read request body' if payload.nil? || payload.empty?
+
+        handle(payload)
+      end
+
+      def handle_as_transaction(payload)
+        event = handle(payload)
+        event.to_transaction
+      end
+    end
+  end
+end

data/lib/tinker/webhook/webhook_meta.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Webhook
+    class WebhookMeta
+      attr_reader :version, :app_id, :gateway
+
+      def initialize(meta = {})
+        @version = meta['version'] || '1.0'
+        @app_id = meta['app_id'] || ''
+        @gateway = meta['gateway']
+      end
+    end
+  end
+end

data/lib/tinker/webhook/webhook_security.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Tinker
+  module Webhook
+    class WebhookSecurity
+      attr_reader :signature, :algorithm
+
+      def initialize(security = {})
+        @signature = security['signature'] || ''
+        @algorithm = security['algorithm'] || 'HMAC-SHA256'
+      end
+    end
+  end
+end

data/lib/tinker.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative 'tinker/version'
+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/network_exception'
+require_relative 'tinker/exception/authentication_exception'
+require_relative 'tinker/exception/invalid_payload_exception'
+require_relative 'tinker/exception/webhook_exception'
+require_relative 'tinker/exception/client_exception'
+require_relative 'tinker/enum/gateway'
+require_relative 'tinker/enum/payment_status'
+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/model/dto/initiate_payment_request_dto'
+require_relative 'tinker/model/dto/query_payment_request_dto'
+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/transaction'
+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'
+require_relative 'tinker/webhook/dto/settlement_event_data_dto'
+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/payments'