k2-connect-ruby 3.1.0 → 4.0.0

data/lib/k2-connect-ruby/k2_services/payloads/transactions/outgoing_payment.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 module K2ConnectRuby
   module K2Services
     module Payloads
       module Transactions
         class OutgoingPayment < OutgoingTransaction
           attr_reader :transaction_reference,
-                      :destination
+            :destination
 
           def initialize(payload)
             super

data/lib/k2-connect-ruby/k2_services/payloads/transactions/payment_link.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module K2ConnectRuby
+  module K2Services
+    module Payloads
+      module Transactions
+        # Parsed attributes of payment link result callback
+        class PaymentLink
+          include ActiveModel::Validations
+
+          attr_reader :id, :type, :status, :created_at, :till_name, :currency, :amount, :payment_reference, :note,
+            :payment_link, :request_errors, :metadata, :callback_url, :links_self
+
+          validates :id, :type, :status, :created_at, :till_name, :currency, :amount, :callback_url, :links_self,
+            presence: :true
+          validates :type, comparison: { equal_to: "payment_link" }
+
+          def initialize(payload)
+            @id = payload.dig("data", "id")
+            @type = payload.dig("data", "type")
+            @status = payload.dig("data", "attributes", "status")
+            @created_at = payload.dig("data", "attributes", "created_at")
+            @till_name = payload.dig("data", "attributes", "till_name")
+            @currency = payload.dig("data", "attributes", "currency")
+            @amount = payload.dig("data", "attributes", "amount")
+            @payment_reference = payload.dig("data", "attributes", "payment_reference")
+            @note = payload.dig("data", "attributes", "note")
+            @payment_link = payload.dig("data", "attributes", "payment_link")&.deep_symbolize_keys
+            @metadata = payload.dig("data", "attributes", "metadata")&.deep_symbolize_keys
+            @request_errors = payload.dig("data", "attributes", "errors")
+            @callback_url = payload.dig("data", "attributes", "_links", "callback_url")
+            @links_self = payload.dig("data", "attributes", "_links", "self")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/k2-connect-ruby/k2_services/payloads/transactions/reversal.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module K2ConnectRuby
+  module K2Services
+    module Payloads
+      module Transactions
+        # Parsed attributes of reversal result callback
+        class Reversal
+          include ActiveModel::Validations
+
+          attr_reader :id, :type, :transaction_reference, :reason, :status, :created_at, :reversal_bulk_payment,
+            :request_errors, :metadata, :callback_url, :links_self
+
+          validates :id, :type, :transaction_reference, :reason, :status, :created_at, :callback_url, :links_self,
+            presence: true
+          validates :type, comparison: { equal_to: "reversal" }
+
+          def initialize(payload)
+            @id = payload.dig("data", "id")
+            @type = payload.dig("data", "type")
+            @transaction_reference = payload.dig("data", "attributes", "transaction_reference")
+            @status = payload.dig("data", "attributes", "status")
+            @created_at = payload.dig("data", "attributes", "created_at")
+            @reason = payload.dig("data", "attributes", "reason")
+            @reversal_bulk_payment = payload.dig("data", "attributes", "reversal_bulk_payment")&.deep_symbolize_keys
+            @metadata = payload.dig("data", "attributes", "metadata")&.deep_symbolize_keys
+            @request_errors = payload.dig("data", "attributes", "errors")
+            @links_self = payload.dig("data", "attributes", "_links", "self")
+            @callback_url = payload.dig("data", "attributes", "_links", "callback_url")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/k2-connect-ruby/k2_services/payloads/transactions/send_money_payment.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module K2ConnectRuby
+  module K2Services
+    module Payloads
+      module Transactions
+        class SendMoneyPayment < OutgoingTransaction
+          attr_reader :transaction_reference,
+            :destination
+
+          def initialize(payload)
+            super
+          end
+
+          private
+
+          def valid_payment_type
+            raise ArgumentError, "Wrong Payment Type" unless @type.eql?("send_money")
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/k2-connect-ruby/k2_services/payloads/transactions/transfer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module K2ConnectRuby
   module K2Services
     module Payloads

data/lib/k2-connect-ruby/k2_services/payloads/webhooks/b2b_transaction_received.rb

@@ -1,15 +1,21 @@
+# frozen_string_literal: true
+
 module K2ConnectRuby
   module K2Services
     module Payloads
       module Webhooks
         class B2bTransactionReceived < K2CommonEvents
+          include ActiveModel::Validations
+
+          validates :topic, comparison: { equal_to: "b2b_transaction_received" }
+
           attr_reader :sending_till,
-                      :till_number
+            :till_number
 
           def initialize(payload)
             super
-            @till_number = payload.dig('event', 'resource', 'till_number')
-            @sending_till = payload.dig('event', 'resource', 'sending_till')
+            @till_number = payload.dig("event", "resource", "till_number")
+            @sending_till = payload.dig("event", "resource", "sending_till")
           end
         end
       end

data/lib/k2-connect-ruby/k2_services/payloads/webhooks/b2b_transaction_reversed.rb

@@ -0,0 +1,22 @@
+module K2ConnectRuby
+  module K2Services
+    module Payloads
+      module Webhooks
+        class B2bTransactionReversed < K2CommonEvents
+          include ActiveModel::Validations
+
+          validates :topic, comparison: { equal_to: "b2b_transaction_reversed" }
+
+          attr_reader :sending_till,
+            :till_number
+
+          def initialize(payload)
+            super
+            @till_number = payload.dig("event", "resource", "till_number")
+            @sending_till = payload.dig("event", "resource", "sending_till")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/k2-connect-ruby/k2_services/payloads/webhooks/buygoods_transaction_received.rb

@@ -1,8 +1,14 @@
+# frozen_string_literal: true
+
 module K2ConnectRuby
   module K2Services
     module Payloads
       module Webhooks
         class BuygoodsTransactionReceived < Buygoods
+          include ActiveModel::Validations
+
+          validates :topic, comparison: { equal_to: "buygoods_transaction_received" }
+
           def initialize(payload)
             super
           end

data/lib/k2-connect-ruby/k2_services/payloads/webhooks/buygoods_transaction_reversed.rb

@@ -3,6 +3,10 @@ module K2ConnectRuby
     module Payloads
       module Webhooks
         class BuygoodsTransactionReversed < Buygoods
+          include ActiveModel::Validations
+
+          validates :topic, comparison: { equal_to: "buygoods_transaction_reversed" }
+
           def initialize(payload)
             super
           end

data/lib/k2-connect-ruby/k2_services/payloads/webhooks/card_transaction_received.rb

@@ -0,0 +1,18 @@
+module K2ConnectRuby
+  module K2Services
+    module Payloads
+      module Webhooks
+        class CardTransactionReceived < K2CommonEvents
+          attr_reader :settled, :till_number, :customer_cc_number
+
+          def initialize(payload)
+            super
+            @customer_cc_number = payload.dig("event", "resource", "customer_cc_number")
+            @till_number = payload.dig("event", "resource", "till_number")
+            @settled = payload.dig("event", "resource", "settled")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/k2-connect-ruby/k2_services/payloads/webhooks/card_transaction_reversed.rb

@@ -0,0 +1,17 @@
+module K2ConnectRuby
+  module K2Services
+    module Payloads
+      module Webhooks
+        class CardTransactionReversed < K2CommonEvents
+          attr_reader :till_number, :customer_cc_number
+
+          def initialize(payload)
+            super
+            @customer_cc_number = payload.dig("event", "resource", "customer_cc_number")
+            @till_number = payload.dig("event", "resource", "till_number")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/k2-connect-ruby/k2_services/payloads/webhooks/card_transaction_voided.rb

@@ -0,0 +1,17 @@
+module K2ConnectRuby
+  module K2Services
+    module Payloads
+      module Webhooks
+        class CardTransactionVoided < K2CommonEvents
+          attr_reader :till_number, :customer_cc_number
+
+          def initialize(payload)
+            super
+            @customer_cc_number = payload.dig("event", "resource", "customer_cc_number")
+            @till_number = payload.dig("event", "resource", "till_number")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/k2-connect-ruby/k2_services/payloads/webhooks/customer_created.rb

@@ -3,17 +3,21 @@ module K2ConnectRuby
     module Payloads
       module Webhooks
         class CustomerCreated < K2Webhooks
+          include ActiveModel::Validations
+
+          validates :topic, comparison: { equal_to: "customer_created" }
+
           attr_reader :resource_first_name,
-                      :resource_middle_name,
-                      :resource_last_name,
-                      :resource_phone_number
+            :resource_middle_name,
+            :resource_last_name,
+            :resource_phone_number
 
           def initialize(payload)
             super
-            @resource_first_name = payload.dig('event', 'resource', 'first_name')
-            @resource_middle_name = payload.dig('event', 'resource', 'middle_name')
-            @resource_last_name = payload.dig('event', 'resource', 'last_name')
-            @resource_phone_number = payload.dig('event', 'resource', 'phone_number')
+            @resource_first_name = payload.dig("event", "resource", "first_name")
+            @resource_middle_name = payload.dig("event", "resource", "middle_name")
+            @resource_last_name = payload.dig("event", "resource", "last_name")
+            @resource_phone_number = payload.dig("event", "resource", "phone_number")
           end
         end
       end

data/lib/k2-connect-ruby/k2_services/payloads/webhooks/transfer_webhook.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module K2ConnectRuby
+  module K2Services
+    module Payloads
+      module Webhooks
+        class TransferWebhook < K2CommonEvents
+          include ActiveModel::Validations
+
+          validates :topic, comparison: { equal_to: "settlement_transfer_completed" }
+
+          attr_reader :disbursements,
+            :destination_type,
+            :destination_network,
+            :destination_reference,
+            :destination_last_name,
+            :destination_first_name,
+            :destination_account_name,
+            :destination_phone_number,
+            :destination_account_number,
+            :destination_bank_branch_ref,
+            :destination_transfer_method
+
+          def initialize(payload)
+            super
+            # Destination
+            @disbursements = payload.dig("event", "resource", "disbursements")
+            @destination_type = payload.dig("event", "resource", "destination", "type")
+            @destination_reference = payload.dig("event", "resource", "destination", "resource", "reference")
+            destination_assets(payload)
+          end
+
+          def destination_assets(payload)
+            if @destination_type.eql?("Mobile Wallet")
+              @destination_network = payload.dig("event", "resource", "destination", "resource", "network")
+              @destination_last_name = payload.dig("event", "resource", "destination", "resource", "last_name")
+              @destination_first_name = payload.dig("event", "resource", "destination", "resource", "first_name")
+              @destination_phone_number = payload.dig("event", "resource", "destination", "resource", "phone_number")
+            elsif @destination_type.eql?("Bank Account")
+              @destination_account_name = payload.dig("event", "resource", "destination", "resource", "account_name")
+              @destination_account_number = payload.dig("event", "resource", "destination", "resource", "account_number")
+              @destination_bank_branch_ref = payload.dig("event", "resource", "destination", "resource", "bank_branch_ref")
+              @destination_transfer_method = payload.dig("event", "resource", "destination", "resource", "transfer_method")
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/k2-connect-ruby/k2_services/send_introspect_token_request_service.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module K2ConnectRuby
+  module K2Services
+    class SendIntrospectTokenRequestService < BaseService
+      include K2ConnectRuby::K2Utilities::K2ConnectionHelper
+
+      attr_reader :client_id, :client_secret, :access_token
+
+      def initialize(client_id, client_secret, access_token)
+        super()
+        @client_id = client_id
+        @client_secret = client_secret
+        @access_token = access_token
+      end
+
+      def execute
+        send_request
+      end
+
+      private
+
+      def send_request
+        response = K2ConnectRuby::HttpClient.post(
+          endpoint,
+          payload: params.to_json,
+          headers: request_headers
+        )
+
+        CallResult.success(
+          {
+            response_code: response.code,
+            response_headers: response_headers(response.headers),
+            response_body: response_body(response.body),
+          },
+        )
+      end
+
+      def endpoint
+        K2ConnectRuby::K2Utilities::Config::K2Config.endpoint("introspect_token")
+      end
+
+      def params
+        {
+          client_id: client_id,
+          client_secret: client_secret,
+          token: access_token,
+        }
+      end
+
+      def request_headers
+        { "Content-Type" => "application/json", "Accept" => "application/json", "User-Agent" => "Kopokopo-Ruby-SDK" }
+      end
+    end
+  end
+end

data/lib/k2-connect-ruby/k2_services/send_k2_connect_get_request_service.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module K2ConnectRuby
+  module K2Services
+    class SendK2ConnectGetRequestService < BaseService
+      include K2ConnectRuby::K2Utilities::K2ConnectionHelper
+
+      attr_reader :access_token, :endpoint, :request_body
+
+      def initialize(access_token, endpoint)
+        super()
+        @access_token = access_token
+        @endpoint = endpoint
+      end
+
+      def execute
+        send_request
+      end
+
+      private
+
+      def send_request
+        response = K2ConnectRuby::HttpClient.get(
+          endpoint,
+          headers: request_headers
+        )
+
+        CallResult.success(
+          {
+            response_code: response.code,
+            response_headers: response_headers(response.headers),
+            response_body: response_body(response.body),
+          },
+        )
+      end
+
+      def request_headers
+        { "Content-Type" => "application/json", "Accept" => "application/json", Authorization: "Bearer #{access_token}", "User-Agent" => "Kopokopo-Ruby-SDK" }
+      end
+    end
+  end
+end

data/lib/k2-connect-ruby/k2_services/send_k2_connect_post_request_service.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module K2ConnectRuby
+  module K2Services
+    class SendK2ConnectPostRequestService < BaseService
+      include K2ConnectRuby::K2Utilities::K2ConnectionHelper
+
+      attr_reader :access_token, :endpoint, :request_body
+
+      def initialize(access_token, endpoint, request_body)
+        super()
+        @access_token = access_token
+        @endpoint = endpoint
+        @request_body = request_body
+      end
+
+      def execute
+        send_request
+      end
+
+      private
+
+      def send_request
+        response = K2ConnectRuby::HttpClient.post(
+          endpoint,
+          payload: request_body.to_json,
+          headers: request_headers
+        )
+
+        CallResult.success(
+          {
+            response_code: response.code,
+            response_headers: response_headers(response.headers),
+            response_body: response_body(response.body),
+          },
+        )
+      end
+
+      def request_headers
+        { "Content-Type" => "application/json", "Accept" => "application/json", Authorization: "Bearer #{access_token}", "User-Agent" => "Kopokopo-Ruby-SDK" }
+      end
+    end
+  end
+end

data/lib/k2-connect-ruby/k2_services/send_request_token_request_service.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module K2ConnectRuby
+  module K2Services
+    class SendRequestTokenRequestService < BaseService
+      include K2ConnectRuby::K2Utilities::K2ConnectionHelper
+
+      attr_reader :client_id, :client_secret
+
+      def initialize(client_id, client_secret)
+        super()
+        @client_id = client_id
+        @client_secret = client_secret
+      end
+
+      def execute
+        send_request
+      end
+
+      private
+
+      def send_request
+        response = K2ConnectRuby::HttpClient.post(
+          endpoint,
+          payload: request_body_json,
+          headers: request_headers
+        )
+
+        CallResult.success(
+          {
+            response_code: response.code,
+            response_headers: response_headers(response.headers),
+            response_body: response_body(response.body),
+          },
+        )
+      end
+
+      def endpoint
+        K2ConnectRuby::K2Utilities::Config::K2Config.endpoint("oauth_token")
+      end
+
+      def request_headers
+        { "Content-Type" => "application/json", "Accept" => "application/json", "User-Agent" => "Kopokopo-Ruby-SDK" }
+      end
+
+      def request_body_json
+        {
+          client_id: client_id,
+          client_secret: client_secret,
+          grant_type: "client_credentials",
+        }.to_json
+      end
+    end
+  end
+end

data/lib/k2-connect-ruby/k2_services/send_revoke_token_request_service.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module K2ConnectRuby
+  module K2Services
+    class SendRevokeTokenRequestService < BaseService
+      include K2ConnectRuby::K2Utilities::K2ConnectionHelper
+
+      attr_reader :client_id, :client_secret, :access_token
+
+      def initialize(client_id, client_secret, access_token)
+        super()
+        @client_id = client_id
+        @client_secret = client_secret
+        @access_token = access_token
+      end
+
+      def execute
+        send_request
+      end
+
+      private
+
+      def send_request
+        response = K2ConnectRuby::HttpClient.post(
+          endpoint,
+          payload: params.to_json,
+          headers: request_headers
+        )
+
+        CallResult.success(
+          {
+            response_code: response.code,
+            response_headers: response_headers(response.headers),
+            response_body: response_body(response.body),
+          },
+        )
+      end
+
+      def endpoint
+        K2ConnectRuby::K2Utilities::Config::K2Config.endpoint("revoke_token")
+      end
+
+      def params
+        {
+          client_id: client_id,
+          client_secret: client_secret,
+          token: access_token,
+        }
+      end
+
+      def request_headers
+        { "Content-Type" => "application/json", "Accept" => "application/json", "User-Agent" => "Kopokopo-Ruby-SDK" }
+      end
+    end
+  end
+end

data/lib/k2-connect-ruby/k2_services/send_token_info_request_service.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module K2ConnectRuby
+  module K2Services
+    class SendTokenInfoRequestService < BaseService
+      include K2ConnectRuby::K2Utilities::K2ConnectionHelper
+
+      attr_reader :access_token
+
+      def initialize(access_token)
+        super()
+        @access_token = access_token
+      end
+
+      def execute
+        send_request
+      end
+
+      private
+
+      def send_request
+        response = K2ConnectRuby::HttpClient.get(
+          endpoint,
+          headers: request_headers
+        )
+        CallResult.success(
+          {
+            response_code: response.code,
+            response_headers: response_headers(response.headers),
+            response_body: response_body(response.body),
+          },
+        )
+      end
+
+      def endpoint
+        K2ConnectRuby::K2Utilities::Config::K2Config.endpoint("token_info")
+      end
+
+      def request_headers
+        { "Content-Type" => "application/json", "Accept" => "application/json", "Authorization" => "Bearer #{access_token}", "User-Agent" => "Kopokopo-Ruby-SDK" }
+      end
+    end
+  end
+end

data/lib/k2-connect-ruby/k2_services.rb

@@ -0,0 +1,29 @@
+require "k2-connect-ruby/k2_services/k2_client"
+require "k2-connect-ruby/k2_services/base_service"
+require "k2-connect-ruby/k2_services/send_k2_connect_get_request_service"
+require "k2-connect-ruby/k2_services/send_k2_connect_post_request_service"
+require "k2-connect-ruby/k2_services/send_request_token_request_service"
+require "k2-connect-ruby/k2_services/send_revoke_token_request_service"
+require "k2-connect-ruby/k2_services/send_introspect_token_request_service"
+require "k2-connect-ruby/k2_services/send_token_info_request_service"
+
+require "k2-connect-ruby/k2_services/payloads/k2_webhooks"
+require "k2-connect-ruby/k2_services/payloads/webhooks/b2b_transaction_received"
+require "k2-connect-ruby/k2_services/payloads/webhooks/b2b_transaction_reversed"
+require "k2-connect-ruby/k2_services/payloads/webhooks/customer_created"
+require "k2-connect-ruby/k2_services/payloads/webhooks/buygoods_transaction_received"
+require "k2-connect-ruby/k2_services/payloads/webhooks/buygoods_transaction_reversed"
+require "k2-connect-ruby/k2_services/payloads/webhooks/transfer_webhook"
+require "k2-connect-ruby/k2_services/payloads/daraja_webhooks"
+
+require "k2-connect-ruby/k2_services/payloads/k2_transaction"
+require "k2-connect-ruby/k2_services/payloads/transactions/transfer"
+require "k2-connect-ruby/k2_services/payloads/transactions/incoming_payment"
+require "k2-connect-ruby/k2_services/payloads/transactions/outgoing_payment"
+require "k2-connect-ruby/k2_services/payloads/transactions/send_money_payment"
+require "k2-connect-ruby/k2_services/payloads/transactions/reversal"
+require "k2-connect-ruby/k2_services/payloads/transactions/payment_link"
+
+module K2ConnectRuby
+  module K2Services; end
+end