k2-connect-ruby 2.0.0 → 3.0.0

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

@@ -1,46 +1,54 @@
-class IncomingPayments < CommonPayment
-  attr_reader :event,
-              :event_type,
-              :transaction_reference,
-              :origination_time,
-              :sender_phone_number,
-              :amount,
-              :currency,
-              :till_number,
-              :system,
-              :resource_id,
-              :resource_status,
-              :sender_first_name,
-              :sender_middle_name,
-              :sender_last_name,
-              :errors
+module K2ConnectRuby
+  module K2Services
+    module Payloads
+      module Transactions
+        class IncomingPayment < CommonPayment
+          attr_reader :event,
+                      :event_type,
+                      :transaction_reference,
+                      :origination_time,
+                      :sender_phone_number,
+                      :amount,
+                      :currency,
+                      :till_number,
+                      :system,
+                      :resource_id,
+                      :resource_status,
+                      :sender_first_name,
+                      :sender_middle_name,
+                      :sender_last_name,
+                      :errors
 
-  def initialize(payload)
-    super
-    # Event details
-    @event = payload.dig('data', 'attributes', 'event')
-    @event_type = payload.dig('data', 'attributes', 'event', 'type')
-    # Resource details
-    @resource_id = payload.dig('data', 'attributes', 'event', 'resource', 'id')
-    @transaction_reference = payload.dig('data', 'attributes', 'event', 'resource', 'reference')
-    @origination_time = payload.dig('data', 'attributes', 'event', 'resource', 'origination_time')
-    @sender_phone_number = payload.dig('data', 'attributes', 'event', 'resource', 'sender_phone_number')
-    @amount = payload.dig('data', 'attributes', 'event', 'resource', 'amount')
-    @currency = payload.dig('data', 'attributes', 'event', 'resource', 'currency')
-    @till_number = payload.dig('data', 'attributes', 'event', 'resource', 'till_number')
-    @system = payload.dig('data', 'attributes', 'event', 'resource', 'system')
-    @resource_status = payload.dig('data', 'attributes', 'event', 'resource', 'status')
-    @sender_first_name = payload.dig('data', 'attributes', 'event', 'resource', 'sender_first_name')
-    @sender_middle_name = payload.dig('data', 'attributes', 'event', 'resource', 'sender_middle_name')
-    @sender_last_name = payload.dig('data', 'attributes', 'event', 'resource', 'sender_last_name')
-    # Errors
-    @errors = payload.dig('data', 'attributes', 'event', 'errors')
-  end
+          def initialize(payload)
+            super
+            # Event details
+            @event = payload.dig('data', 'attributes', 'event')
+            @event_type = payload.dig('data', 'attributes', 'event', 'type')
+            # Resource details
+            @resource_id = payload.dig('data', 'attributes', 'event', 'resource', 'id')
+            @transaction_reference = payload.dig('data', 'attributes', 'event', 'resource', 'reference')
+            @origination_time = payload.dig('data', 'attributes', 'event', 'resource', 'origination_time')
+            @sender_phone_number = payload.dig('data', 'attributes', 'event', 'resource', 'sender_phone_number')
+            @amount = payload.dig('data', 'attributes', 'event', 'resource', 'amount')
+            @currency = payload.dig('data', 'attributes', 'event', 'resource', 'currency')
+            @till_number = payload.dig('data', 'attributes', 'event', 'resource', 'till_number')
+            @system = payload.dig('data', 'attributes', 'event', 'resource', 'system')
+            @resource_status = payload.dig('data', 'attributes', 'event', 'resource', 'status')
+            @sender_first_name = payload.dig('data', 'attributes', 'event', 'resource', 'sender_first_name')
+            @sender_middle_name = payload.dig('data', 'attributes', 'event', 'resource', 'sender_middle_name')
+            @sender_last_name = payload.dig('data', 'attributes', 'event', 'resource', 'sender_last_name')
+            # Errors
+            @errors = payload.dig('data', 'attributes', 'event', 'errors')
+          end
 
-  private
+          private
 
-  def valid_payment_type
-    raise ArgumentError, "Wrong Payment Type" unless @type.eql?("incoming_payment")
-  end
+          def valid_payment_type
+            raise ArgumentError, "Wrong Payment Type" unless @type.eql?("incoming_payment")
+          end
 
-end
+        end
+      end
+    end
+  end
+end

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

@@ -1,15 +1,23 @@
-class OutgoingPayment < OutgoingTransaction
-  attr_reader :transaction_reference,
-              :destination
+module K2ConnectRuby
+  module K2Services
+    module Payloads
+      module Transactions
+        class OutgoingPayment < OutgoingTransaction
+          attr_reader :transaction_reference,
+                      :destination
 
-  def initialize(payload)
-    super
-  end
+          def initialize(payload)
+            super
+          end
 
-  private
+          private
 
-  def valid_payment_type
-    raise ArgumentError, "Wrong Payment Type" unless @type.eql?("payment")
-  end
+          def valid_payment_type
+            raise ArgumentError, "Wrong Payment Type" unless @type.eql?("payment")
+          end
 
-end
+        end
+      end
+    end
+  end
+end

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

@@ -1,12 +1,20 @@
-class Transfer < OutgoingTransaction
+module K2ConnectRuby
+  module K2Services
+    module Payloads
+      module Transactions
+        class Transfer < OutgoingTransaction
 
-  def initialize(payload)
-    super
-  end
+          def initialize(payload)
+            super
+          end
 
-  private
+          private
 
-  def valid_payment_type
-    raise ArgumentError, "Wrong Payment Type" unless @type.eql?("settlement_transfer")
+          def valid_payment_type
+            raise ArgumentError, "Wrong Payment Type" unless @type.eql?("settlement_transfer")
+          end
+        end
+      end
+    end
   end
-end
+end

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

@@ -0,0 +1,18 @@
+module K2ConnectRuby
+  module K2Services
+    module Payloads
+      module Webhooks
+        class B2bTransactionReceived < K2CommonEvents
+          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

@@ -0,0 +1,13 @@
+module K2ConnectRuby
+  module K2Services
+    module Payloads
+      module Webhooks
+        class BuygoodsTransactionReceived < Buygoods
+          def initialize(payload)
+            super
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+module K2ConnectRuby
+  module K2Services
+    module Payloads
+      module Webhooks
+        class BuygoodsTransactionReversed < Buygoods
+          def initialize(payload)
+            super
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,14 +1,22 @@
-class CustomerCreated < Webhook
-  attr_reader :resource_first_name,
-              :resource_middle_name,
-              :resource_last_name,
-              :resource_phone_number
+module K2ConnectRuby
+  module K2Services
+    module Payloads
+      module Webhooks
+        class CustomerCreated < K2Webhooks
+          attr_reader :resource_first_name,
+                      :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')
+          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')
+          end
+        end
+      end
+    end
   end
-end
+end

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

@@ -1,36 +1,44 @@
-class SettlementWebhook < K2CommonEvents
-  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_settlement_method
+module K2ConnectRuby
+  module K2Services
+    module Payloads
+      module Webhooks
+        class SettlementWebhook < K2CommonEvents
+          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_settlement_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 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_settlement_method = payload.dig('event', 'resource', 'destination', 'resource', 'settlement_method')
+          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_settlement_method = payload.dig('event', 'resource', 'destination', 'resource', 'settlement_method')
+            end
+          end
+        end
+      end
     end
   end
-end
+end

data/lib/k2-connect-ruby/k2_utilities/config/k2_config.rb

@@ -1,51 +1,54 @@
-# TODO: try to see if you can implement Environment variables
-module K2Config
-  @config = YAML.load_file(File.join(File.dirname(__FILE__), 'k2_config.yml')).with_indifferent_access
-
-  class << self
-    # Set the Host Url
-    def set_base_url(base_url)
-      raise ArgumentError, 'Invalid URL Format.' unless base_url =~ /\A#{URI.regexp(%w[http https])}\z/
-      @config[:base_url] = base_url
-      File.open("lib/k2-connect-ruby/k2_utilities/config/k2_config.yml", 'w') { |f| YAML.dump(@config, f) }
-    end
-
-    # TODO: Versioning
-    def set_version(version_number)
-      raise ArgumentError, 'Invalid Format: Version Number input should be Numeric' unless version_number.is_a?(Numeric)
-      @config[:version] = "v#{version_number}"
-      File.open("lib/k2-connect-ruby/k2_utilities/config/k2_config.yml", 'w') { |f| YAML.dump(@config, f) }
-    end
-
-    def version
-      @config[:version]
-    end
+module K2ConnectRuby
+  module K2Utilities
+    module Config
+      module K2Config
+        @config = YAML.load_file(File.join(File.dirname(__FILE__), 'k2_config.yml'), permitted_classes: [ActiveSupport::HashWithIndifferentAccess]).with_indifferent_access
+
+        class << self
+          # Set the Host Url
+          def set_base_url(base_url)
+            raise ArgumentError, 'Invalid URL Format.' unless base_url =~ /\A#{URI.regexp(%w[http https])}\z/
+            @config[:base_url] = base_url
+            File.open(File.join(File.dirname(__FILE__), 'k2_config.yml'), 'w') { |f| YAML.dump(@config, f) }
+          end
+
+          def set_version(version_number)
+            raise ArgumentError, 'Invalid Format: Version Number input should be Numeric' unless version_number.is_a?(Numeric)
+            @config[:version] = "v#{version_number}"
+            File.open(File.join(File.dirname(__FILE__), 'k2_config.yml'), 'w') { |f| YAML.dump(@config, f) }
+          end
+
+          def version
+            @config[:version]
+          end
+
+          def path_endpoint(key)
+            unless key.include?('token')
+              return "api/#{version}/#{@config[:endpoints][:"#{key}"]}"
+            end
+            @config[:endpoints][:"#{key}"]
+          end
+
+          def path_endpoints
+            @config[:endpoints]
+          end
+
+          def path_url(key)
+            base_url + path_endpoint(key)
+          end
+
+          def network_operators
+            @config[:network_operators]
+          end
+
+          private
+
+          def base_url
+            @config[:base_url]
+          end
+        end
 
-    def path_endpoint(key)
-      unless key.include?('token')
-        return "api/#{version}/#{@config[:endpoints][:"#{key}"]}"
       end
-      @config[:endpoints][:"#{key}"]
-    end
-
-    def path_endpoints
-      @config[:endpoints]
-    end
-
-    def path_url(key)
-      # TODO: Custom error/exception message
-      base_url + path_endpoint(key)
-    end
-
-    def network_operators
-      @config[:network_operators]
-    end
-
-    private
-
-    def base_url
-      @config[:base_url]
     end
   end
-
 end

data/lib/k2-connect-ruby/k2_utilities/k2_authenticator.rb

@@ -0,0 +1,19 @@
+require 'openssl'
+require 'active_support/security_utils'
+
+module K2ConnectRuby
+  module K2Utilities
+    module K2Authenticator
+      extend self
+
+      def authenticate(body, api_secret_key, signature)
+        raise ArgumentError, "Nil Authentication Argument!\n Check whether your Input is Empty" if body.blank? || api_secret_key.blank? || signature.blank?
+
+        digest = OpenSSL::Digest.new('sha256')
+        hmac = OpenSSL::HMAC.hexdigest(digest, api_secret_key, body.to_json)
+        raise ArgumentError, "Invalid Details Given!\n Ensure that your the Arguments Given are correct, namely:\n\t- The Response Body\n\t- Secret Key\n\t- Signature" unless ActiveSupport::SecurityUtils.secure_compare(hmac, signature)
+        true
+      end
+    end
+  end
+end

data/lib/k2-connect-ruby/k2_utilities/k2_connection.rb

@@ -1,41 +1,48 @@
-module K2Connect
-  # Method for sending the request to K2 sandbox or Mock Server
-  def self.make_request(connection_hash)
-    access_token = connection_hash[:access_token]
-    class_type = connection_hash[:class_type]
-    path_url = connection_hash[:path_url]
-    request_type = connection_hash[:request_type]
+module K2ConnectRuby
+  module K2Utilities
+    module K2Connection
+      extend self
+      # Method for sending the request to K2 sandbox or Mock Server
+      def make_request(connection_hash)
+        access_token = connection_hash[:access_token]
+        class_type = connection_hash[:class_type]
+        path_url = connection_hash[:path_url]
+        request_type = connection_hash[:request_type]
+        requires_token = connection_hash[:requires_token]
 
-    unless class_type.eql?('Access Token') || access_token.present?
-      raise ArgumentError, 'No Access Token in Arguments!'
-    end
+        unless class_type.eql?('Access Token') || access_token.present?
+          raise ArgumentError, 'No Access Token in Arguments!'
+        end
 
-    # Set up Headers
-    headers = { 'Content-Type': 'application/json', Accept: 'application/json', Authorization: "Bearer #{access_token}" }
-    # For access token request
-    if path_url.include?('oauth/token/info')
-      headers = { 'Content-Type': 'application/json', Accept: 'application/json', Authorization: "Bearer #{access_token}" }
-    elsif path_url.include?('oauth/')
-      headers = { 'Content-Type': 'application/json' }
-    end
+        # Set up Headers
+        headers = if requires_token
+          { 'Content-Type': 'application/json', Accept: 'application/json', Authorization: "Bearer #{access_token}" }
+        else
+          { 'Content-Type': 'application/json' }
+        end
 
-    k2_response = RestClient::Request.execute(method: request_type, url: path_url, headers: headers, payload: connection_hash[:params].to_json)
+        k2_response = RestClient::Request.execute(
+          method: request_type,
+          url: path_url,
+          headers: headers,
+          payload: connection_hash[:params].to_json
+        )
 
-    # Response Body
-    response_body = Yajl::Parser.parse(k2_response.body)
-    response_headers = Yajl::Parser.parse(k2_response.headers.to_json)
-    response_code = k2_response.code.to_s
-    raise K2ConnectionError.new(response_code) unless response_code[0].eql?(2.to_s)
+        # Response Body
+        response_body = JSON.parse(k2_response.body, symbolize_names: true) if k2_response.body.present?
+        response_headers = JSON.parse(k2_response.headers.to_json, symbolize_names: true)
+        response_code = k2_response.code.to_s
+        raise K2ConnectRuby::K2ConnectionError.new(response_code) unless response_code.starts_with?("2")
 
-    unless request_type.eql?('get')
-      # Returns the access token for authorization
-      return response_body['access_token'] if path_url.include?('oauth/token')
+        if request_type.eql?('get')
+          response_body
+        else
+          # Returns the access token for authorization
+          return response_body[:access_token] if path_url.include?('oauth/token')
 
-      # Return the location url for post Requests
-      return response_headers["location"]
+          response_headers[:location]
+        end
+      end
     end
-
-    # Return the result of the Query
-    return response_body
   end
 end

data/lib/k2-connect-ruby/k2_utilities/k2_process_result.rb

@@ -1,43 +1,48 @@
-# Processes Results
-module K2ProcessResult
-  def self.process(payload, secret_key, signature)
-    raise ArgumentError, 'Empty/Nil Request Body Argument!' if payload.blank?
-    self.check_type(payload) if K2Authenticator.authenticate(payload, secret_key, signature)
-  end
+module K2ConnectRuby
+  module K2Utilities
+    module K2ProcessResult
+      extend self
 
-  # Check the Event Type.
-  def self.check_type(payload)
-    result_type = payload.dig('data', 'type')
-    case result_type
-      # Incoming Payments
-    when 'incoming_payment'
-      incoming_payments = IncomingPayments.new(payload)
-      return incoming_payments
-      # Outgoing Payments
-    when 'payment'
-      outgoing_payments = OutgoingPayment.new(payload)
-      return outgoing_payments
-    when 'settlement_transfer'
-      transfer = Transfer.new(payload)
-      return transfer
-    else
-      raise ArgumentError, 'No Other Specified Payment Type!'
-    end
-  end
+      def process(payload, secret_key, signature)
+        raise ArgumentError, 'Empty/Nil Request Body Argument!' if payload.blank?
+        check_type(payload) if K2ConnectRuby::K2Utilities::K2Authenticator.authenticate(payload, secret_key, signature)
+      end
 
-  # Returns a Hash Object
-  def self.return_obj_hash(instance_hash = HashWithIndifferentAccess.new, obj)
-    obj.instance_variables.each do |value|
-      instance_hash[:"#{value.to_s.tr('@', '')}"] = obj.instance_variable_get(value)
-    end
-    instance_hash.each(&:freeze).freeze
-  end
+      # Check the Event Type.
+      def check_type(payload)
+        result_type = payload.dig('data', 'type')
+        case result_type
+          # Incoming Payments
+        when 'incoming_payment'
+          incoming_payments = K2ConnectRuby::K2Services::Payloads::Transactions::IncomingPayment.new(payload)
+          return incoming_payments
+          # Outgoing Payments
+        when 'payment'
+          outgoing_payments = K2ConnectRuby::K2Services::Payloads::Transactions::OutgoingPayment.new(payload)
+          return outgoing_payments
+        when 'settlement_transfer'
+          transfer = K2ConnectRuby::K2Services::Payloads::Transactions::Transfer.new(payload)
+          return transfer
+        else
+          raise ArgumentError, 'No Other Specified Payment Type!'
+        end
+      end
+
+      # Returns a Hash Object
+      def return_obj_hash(instance_hash = HashWithIndifferentAccess.new, obj)
+        obj.instance_variables.each do |value|
+          instance_hash[:"#{value.to_s.tr('@', '')}"] = obj.instance_variable_get(value)
+        end
+        instance_hash.each(&:freeze).freeze
+      end
 
-  # Returns an Array Object
-  def self.return_obj_array(instance_array = [], obj)
-    obj.instance_variables.each do |value|
-      instance_array << obj.instance_variable_get(value)
+      # Returns an Array Object
+      def return_obj_array(instance_array = [], obj)
+        obj.instance_variables.each do |value|
+          instance_array << obj.instance_variable_get(value)
+        end
+        instance_array.each(&:freeze).freeze
+      end
     end
-    instance_array.each(&:freeze).freeze
   end
 end