rave_ruby 0.1.1

data/lib/rave_ruby/rave_objects/base/preauth_base.rb

@@ -0,0 +1,84 @@
+require_relative "base.rb"
+
+class PreauthBase < Base
+
+    # method to handle preauth charge response
+    def handle_charge_response(response)
+        charge_response = response
+        flwRef = charge_response["data"]["flwRef"]
+        txRef = charge_response["data"]["txRef"]
+        status = charge_response["data"]["status"]
+        amount = charge_response["data"]["amount"]
+        message = charge_response["message"]
+        charged_amount = charge_response["data"]["charged_amount"]
+        currency = charge_response["data"]["currency"]
+        payment_type = charge_response["data"]["paymentType"]
+        charge_response_code = charge_response["data"]["chargeResponseCode"]
+        charge_response_message = charge_response["data"]["chargeResponseMessage"]
+        validation_instruction = charge_response["data"]["validateInstruction"]
+
+
+        if charge_response_code == "02"
+            res = {"error": false, "status": status, "message": message, "validation_required": true, "txRef": txRef, "flwRef": flwRef, "validateInstruction": validation_instruction, "amount": amount, "currency": currency, "paymentType": payment_type}
+            return JSON.parse(res.to_json)
+        else
+            res = {"error": false, "status": status, "message": message, "validation_required": false, "txRef": txRef, "flwRef": flwRef, "amount": amount, "currency": currency, "paymentType": payment_type}
+            return JSON.parse(res.to_json)
+        end
+    end
+
+
+    # method to handle capture response
+    def handle_capture_response(response)
+        capture_response = response
+        flwRef = capture_response["data"]["flwRef"]
+        txRef = capture_response["data"]["txRef"]
+        status = capture_response["data"]["status"]
+        message = capture_response["message"]
+        payment_type = capture_response["data"]["paymentType"]
+        amount = capture_response["data"]["amount"]
+        charge_response_code = capture_response["data"]["chargeResponseCode"]
+        charge_response_message = capture_response["data"]["chargeResponseMessage"]
+        currency = capture_response["data"]["currency"]
+
+        if charge_response_code == "02"
+            res = {"error": false, "status": status, "validation_required": true, "txRef": txRef, "flwRef": flwRef, "amount": amount, "currency": currency, "chargeResponseCode": charge_response_code, "chargeResponseMessage": charge_response_message, "paymentType": payment_type}
+            return JSON.parse(res.to_json)
+        else
+            res = {"error": false, "status": status, "message": message, "validation_required": false, "txRef": txRef, "flwRef": flwRef, "amount": amount, "currency": currency, "chargeResponseCode": charge_response_code, "chargeResponseMessage": charge_response_message, "paymentType": payment_type}
+            return JSON.parse(res.to_json)
+        end
+    end
+
+
+    # method to handle refund or void response
+    def handle_refund_void_response(response)
+        refund_void_response = response
+        status = refund_void_response["data"]["status"]
+        charge_response_code = refund_void_response["data"]["chargeResponseCode"]
+
+        if charge_response_code == "02"
+            res = {"error": false, "status": status, "data": refund_void_response["data"]}
+            return JSON.parse(res.to_json)
+        else
+            res = {"error": false, "status": status, "data": refund_void_response["data"]}
+            return JSON.parse(res.to_json)
+        end
+    end
+
+
+    # method to handle verify preauth response
+    def handle_verify_response(response)
+        verify_response = response
+        status = verify_response["data"]["status"]
+        charge_code = verify_response["data"]["chargecode"]
+
+        if charge_code == "00" && status == "successful"
+            res = {"error": false, "transaction_complete": true, "data": verify_response["data"]}
+            return JSON.parse(res.to_json)
+        else
+            res = {"error": false, "transaction_complete": true, "data": verify_response["data"]}
+            return JSON.parse(res.to_json)
+        end
+    end
+end

data/lib/rave_ruby/rave_objects/base/sub_account_base.rb

@@ -0,0 +1,34 @@
+require_relative "base.rb"
+
+class SubAccountBase < Base
+
+    # method to handle subaccount creation response
+    def handle_create_response(response)
+
+        initiate_response = response
+        status = initiate_response["status"]
+        id = initiate_response["data"]["id"]
+
+        if status == "success"
+            response = {"error": false, "id": id, "data": initiate_response["data"]}
+            return JSON.parse(response.to_json)
+        else
+            response = {"error": true, "data": initiate_response["data"]}
+            raise InitiateTransferError, JSON.parse(response.to_json)
+        end
+    end
+
+    # method to list subaccounts response
+    def handle_subaccount_response(response)
+        
+        subaccount_response = response
+
+        if subaccount_response.code == 200
+            response = {"error" => false, "data" => JSON.parse(subaccount_response.body)}
+            return response
+        else
+            response = {"error" => true, "data" => JSON.parse(subaccount_response.body)}
+            raise InitiateTransferError, response
+        end
+    end
+end

data/lib/rave_ruby/rave_objects/base/subscription_base.rb

@@ -0,0 +1,78 @@
+require_relative "base.rb"
+
+class SubscriptionBase < Base
+    
+     # method to handle list subscription
+
+     def handle_list_all_subscription(response)
+
+        list_all_subscription = response
+        status = list_all_subscription["status"]
+        message = list_all_subscription["message"]
+       data = list_all_subscription["data"]
+       plansubscriptions =list_all_subscription["data"]["plansubscriptions"]
+
+        if status == "success"
+            response = {"error": false, "status": status,"message": message, "data": data, "plansubscriptions": plansubscriptions}
+            return JSON.parse(response.to_json)
+        else
+            response = {"error": true, "data": create_response["data"]}
+            raise ListSubscriptionError, JSON.parse(response.to_json)
+        end
+
+     end
+
+     #method to handle fetch subscription
+
+     def handle_fetch_subscription_response(response)
+        fetch_subscription_response = response
+        status = fetch_subscription_response["status"]
+        message = fetch_subscription_response["message"]
+        data = fetch_subscription_response["data"]
+    
+        if status == "success"
+            response = {"error": false, "status": status,"message": message, "data": data}
+            return JSON.parse(response.to_json)
+        else
+            response = {"error": true, "data": create_response["data"]}
+            raise FetchSubscriptionError, JSON.parse(response.to_json)
+        end
+    
+    end
+
+    #method to handle cancel subscription
+
+    def handle_cancel_subscription_response(response)
+        cancel_subscription_response = response
+        status = cancel_subscription_response["status"]
+        message = cancel_subscription_response["message"]
+        data = cancel_subscription_response["data"]
+    
+        if status == "success"
+            response = {"error": false, "status": status,"message": message, "data": data}
+            return JSON.parse(response.to_json)
+        else
+            response = {"error": true, "data": create_response["data"]}
+            raise CancelSubscriptionError, JSON.parse(response.to_json)
+        end
+    end
+
+    #method to handle activate subscription
+
+    def handle_activate_subscription_response(response)
+        handle_activate_subscription_response = response
+        status = handle_activate_subscription_response["status"]
+        message = handle_activate_subscription_response["message"]
+        data = handle_activate_subscription_response["data"]
+    
+        if status == "success"
+            response = {"error": false, "status": status,"message": message, "data": data}
+            return JSON.parse(response.to_json)
+        else
+            response = {"error": true, "data": create_response["data"]}
+            raise ActivateSubscriptionError, JSON.parse(response.to_json)
+        end
+    end
+    
+
+end 

data/lib/rave_ruby/rave_objects/base/transfer_base.rb

@@ -0,0 +1,80 @@
+require_relative "base.rb"
+
+class TransferBase < Base
+
+    # method to handle single transfer response
+    def handle_initiate_response(response)
+
+        initiate_response = response
+        status = initiate_response["status"]
+        id = initiate_response["data"]["id"]
+
+        if status == "success"
+            response = {"error": false, "id": id, "data": initiate_response["data"]}
+            return JSON.parse(response.to_json)
+        else
+            response = {"error": true, "data": initiate_response["data"]}
+            raise InitiateTransferError, JSON.parse(response.to_json)
+        end
+    end
+
+    # method to handle bulk transfer response
+    def handle_bulk_response(response)
+
+        bulk_response = response
+        status = bulk_response["status"]
+        id = bulk_response["data"]["id"]
+
+        if status == "success"
+            response = {"error": false, "status": status, "message": bulk_response["message"], "id": id, "data": bulk_response["data"]}
+            return JSON.parse(response.to_json)
+        else
+            response = {"error": true, "data": initiate_response["data"]}
+            raise InitiateTransferError, JSON.parse(response.to_json)
+        end
+    end
+
+    # method to handle get fee response
+    def handle_transfer_status(response)
+        
+        transfer_status = response
+
+        if transfer_status.code == 200
+            response = {"error" => false, "data" => JSON.parse(transfer_status.body)}
+            return response
+        else
+            response = {"error" => true, "data" => JSON.parse(transfer_status.body)}
+            raise InitiateTransferError, response
+        end
+    end
+
+    # method to handle get balance response
+    def handle_balance_status(response)
+        
+        balance_status = response
+        status = balance_status["status"]
+
+        if status == "success"
+            response = {"error" => false, "returned_data" => JSON.parse(balance_status.body)}
+            return response
+        else
+            response = {"error" => true, "returned_data" => JSON.parse(balance_status.body)}
+            raise InitiateTransferError, response
+        end
+    end
+
+    # method to handle fetch account response
+    def handle_fetch_status(response)
+
+        fetch_status = response
+
+        if fetch_status.code == 200
+            response = {"error" => false, "returned_data" => JSON.parse(fetch_status.body)}
+            return response
+        else
+            response = {"error" => true, "returned_data" => JSON.parse(fetch_status.body)}
+            raise InitiateTransferError, response
+        end
+    end
+
+end

data/lib/rave_ruby/rave_objects/base/ussd_base.rb

@@ -0,0 +1,60 @@
+require_relative "base.rb"
+
+class UssdBase < Base
+
+    # method to handle ussd charge response
+    def handle_charge_response(response, request)
+        charge_response = response
+        flwRef = charge_response["data"]["flwRef"]
+        txRef = charge_response["data"]["txRef"]
+        status = charge_response["data"]["status"]
+        amount = charge_response["data"]["amount"]
+        charged_amount = charge_response["data"]["charged_amount"]
+        currency = charge_response["data"]["currency"]
+        payment_type = charge_response["data"]["paymentType"]
+        charge_response_code = charge_response["data"]["chargeResponseCode"]
+        charge_response_message = charge_response["data"]["chargeResponseMessage"]
+        validation_instruction = charge_response["data"]["validateInstructions"]
+
+        bank_list = {"gtb" => "058", "zenith" => "057"}
+        gtb_response_text = "To complete this transaction, please dial *737*50*#{charged_amount.ceil}*159#"
+
+
+        if charge_response_code == "02"
+            if request["accountbank"] == bank_list["gtb"]
+                res = {"error": false, "status": status, "validation_required": true, "txRef": txRef, "flwRef": flwRef, "validateInstruction": gtb_response_text, "amount": amount, "currency": currency, "paymentType": payment_type}
+                return JSON.parse(res.to_json)
+            else
+                res = {"error": false, "status": status, "validation_required": true, "txRef": txRef, "flwRef": flwRef, "validateInstruction": validation_instruction, "amount": amount, "currency": currency, "paymentType": payment_type}
+                return JSON.parse(res.to_json)
+            end
+        else
+            res = {"error": false, "status": status, "validation_required": false, "txRef": txRef, "flwRef": flwRef, "amount": amount, "currency": currency, "paymentType": payment_type}
+            return JSON.parse(res.to_json)
+        end
+    end
+
+
+    # method to handle ussd verify response
+    def handle_verify_response(response)
+        verify_response = response
+        flwref = verify_response["data"]["flwref"]
+        txref = verify_response["data"]["txref"]
+        status = verify_response["data"]["status"]
+        charged_amount = verify_response["data"]["chargedamount"]
+        amount = verify_response["data"]["amount"]
+        vbvmessage = verify_response["data"]["vbvmessage"]
+        vbvcode = verify_response["data"]["vbvcode"]
+        currency = verify_response["data"]["currency"]
+        charge_code = verify_response["data"]["chargecode"]
+        charge_message = verify_response["data"]["chargemessage"]
+
+        if charge_code == "00" && status == "successful"
+            res = {"error": false, "status": status, "transaction_complete": true, "txref": txref, "flwref": flwref, "amount": amount, "chargedamount": charged_amount, "vbvmessage": vbvmessage, "vbvcode": vbvcode, "currency": currency, "chargecode": charge_code, "chargemessage": charge_message}
+            return JSON.parse(res.to_json)
+        else
+            res = {"error": false, "status": status, "transaction_complete": false, "txref": txref, "flwef": flwref, "amount": amount, "chargedamount": charged_amount, "vbvmessage": vbvmessage, "vbvcode": vbvcode, "currency": currency, "charge_code": charge_code, "chargemessage": charge_message}
+            return JSON.parse(res.to_json)
+        end
+    end
+end

data/lib/rave_ruby/rave_objects/card.rb

@@ -0,0 +1,91 @@
+require_relative "base/charge_base.rb"
+require 'json'
+
+class Card < ChargeBase
+
+    # method to initiate card charge 
+    def initiate_charge(data)
+        base_url = rave_object.base_url
+        hashed_secret_key = get_hashed_key
+        public_key = rave_object.public_key
+        
+        # only update the payload with the transaction reference if it isn't already added to the payload
+        if !data.key?("txRef")
+            data.merge!({"txRef" => Util.transaction_reference_generator})
+        end
+
+        data.merge!({"PBFPubKey" => public_key})
+
+        required_parameters = ["PBFPubKey", "cardno", "cvv", "expirymonth", "expiryyear", "amount", "txRef", "email"]
+        check_passed_parameters(required_parameters, data)
+
+        encrypt_data = Util.encrypt(hashed_secret_key, data)
+
+        payload = {
+            "PBFPubKey" => public_key,
+            "client" => encrypt_data,
+            "alg" => "3DES-24"
+        }
+
+        payload = payload.to_json
+
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::CHARGE_ENDPOINT}", payload) 
+
+        return handle_charge_response(response)
+    end
+
+    # method to initiate card charge 
+    def tokenized_charge(data)
+        base_url = rave_object.base_url
+        hashed_secret_key = get_hashed_key
+        public_key = rave_object.public_key
+        
+        # only update the payload with the transaction reference if it isn't already added to the payload
+        if !data.key?("txRef")
+            data.merge!({"txRef" => Util.transaction_reference_generator})
+        end
+
+        data.merge!({"SECKEY" => rave_object.secret_key.dup})
+
+        required_parameters = ["SECKEY", "amount", "currency", "country", "token", "txRef", "email"]
+        check_passed_parameters(required_parameters, data)
+
+        payload = data.to_json
+
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::TOKENISED_CHARGE_ENDPOINT}", payload) 
+
+        return handle_charge_response(response)
+    end
+
+    def validate_charge(flwRef, otp)
+        base_url = rave_object.base_url
+        public_key = rave_object.public_key
+        
+        
+        payload = {
+            "PBFPubKey" => public_key,
+            "transactionreference" => flwRef,
+            "transaction_reference" => flwRef,
+            "otp" => otp,
+        }
+
+        payload = payload.to_json
+
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::CARD_VALIDATE_ENDPOINT}", payload)
+        return handle_validate_response(response)
+    end
+
+    def verify_charge(txref)
+        base_url = rave_object.base_url
+
+        payload = {
+            "txref" => txref,
+            "SECKEY" => rave_object.secret_key.dup,
+        }
+
+        payload = payload.to_json
+
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::VERIFY_ENDPOINT}", payload)
+        return handle_verify_response(response)
+    end
+end

data/lib/rave_ruby/rave_objects/list_banks.rb

@@ -0,0 +1,18 @@
+require_relative "base/base.rb"
+
+class ListBanks < Base
+
+    attr_reader :rave_object
+
+    # method to initialize the object
+    def initialize(rave_object)
+        @rave_object = rave_object
+    end
+
+    # method to fetch the list of banks using the list bank endpoint
+    def fetch_banks
+        base_url = rave_object.base_url
+        response = get_request("#{base_url}#{BASE_ENDPOINTS::BANKS_ENDPOINT}", {:json => 1})
+        return handle_list_bank(response)
+    end
+end

data/lib/rave_ruby/rave_objects/mobile_money.rb

@@ -0,0 +1,58 @@
+require_relative "base/mobile_money_base.rb"
+require 'json'
+
+class MobileMoney < MobileMoneyBase
+    # method to initiate mobile money transaction
+    def initiate_charge(data)
+
+        base_url = rave_object.base_url
+        hashed_secret_key = get_hashed_key
+        public_key = rave_object.public_key
+
+
+        # only update the payload with the transaction reference if it isn't already added to the payload
+        if !data.key?("txRef")
+            data.merge!({"txRef" => Util.transaction_reference_generator})
+        end
+
+        # only update the payload with the order reference if it isn't already added to the payload
+        if !data.key?("orderRef")
+            data.merge!({"orderRef" => Util.transaction_reference_generator})
+        end
+
+        data.merge!({"PBFPubKey" => public_key, "payment_type" => "mobilemoneygh", "country" => "GH", "is_mobile_money_gh"=> 1, "currency" => "GHS"})
+
+        required_parameters = ["amount", "email", "phonenumber", "network"]
+        check_passed_parameters(required_parameters, data)
+
+        encrypt_data = Util.encrypt(hashed_secret_key, data)
+
+        payload = {
+            "PBFPubKey" => public_key,
+            "client" => encrypt_data,
+            "alg" => "3DES-24"
+        }
+
+        payload = payload.to_json
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::CHARGE_ENDPOINT}", payload) 
+
+        return handle_charge_response(response)
+
+    end
+
+    # method to verify mobile money transaction
+    def verify_charge(txref)
+        base_url = rave_object.base_url
+
+        payload = {
+            "txref" => txref,
+            "SECKEY" => rave_object.secret_key.dup,
+        }
+
+        payload = payload.to_json
+
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::VERIFY_ENDPOINT}", payload)
+        return handle_verify_response(response)
+    end
+
+end

data/lib/rave_ruby/rave_objects/mpesa.rb

@@ -0,0 +1,59 @@
+require_relative "base/mpesa_base.rb"
+require 'json'
+
+class Mpesa < MpesaBase
+
+    # method to initiate mpesa transaction
+    def initiate_charge(data)
+
+        base_url = rave_object.base_url
+        hashed_secret_key = get_hashed_key
+        public_key = rave_object.public_key
+
+
+        # only update the payload with the transaction reference if it isn't already added to the payload
+        if !data.key?("txRef")
+            data.merge!({"txRef" => Util.transaction_reference_generator})
+        end
+
+        # only update the payload with the order reference if it isn't already added to the payload
+        if !data.key?("orderRef")
+            data.merge!({"orderRef" => Util.transaction_reference_generator})
+        end
+
+        data.merge!({"PBFPubKey" => public_key, "payment_type" => "mpesa", "country" => "KE", "is_mpesa" => "1", "is_mpesa_lipa" => true, "currency" => "KES"})
+
+        required_parameters = ["amount", "email", "phonenumber"]
+        check_passed_parameters(required_parameters, data)
+
+        encrypt_data = Util.encrypt(hashed_secret_key, data)
+
+        payload = {
+            "PBFPubKey" => public_key,
+            "client" => encrypt_data,
+            "alg" => "3DES-24"
+        }
+
+        payload = payload.to_json
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::CHARGE_ENDPOINT}", payload) 
+
+        return handle_charge_response(response)
+
+    end
+
+    # method to verify mpesa transaction
+    def verify_charge(txref)
+        base_url = rave_object.base_url
+
+        payload = {
+            "txref" => txref,
+            "SECKEY" => rave_object.secret_key.dup,
+        }
+
+        payload = payload.to_json
+
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::VERIFY_ENDPOINT}", payload)
+        return handle_verify_response(response)
+    end
+
+end

data/lib/rave_ruby/rave_objects/payment_plan.rb

@@ -0,0 +1,61 @@
+require_relative "base/payment_plan_base.rb"
+require 'json'
+
+class PaymentPlan < PaymentPlanBase
+
+    # method to create a payment plan
+
+    def create_payment_plan(data)
+        base_url = rave_object.base_url
+        secret_key = rave_object.secret_key.dup
+
+        data.merge!({"seckey" => secret_key.dup})
+
+        required_parameters = ["amount", "name", "interval"]
+        check_passed_parameters(required_parameters, data)
+
+        payload = data.to_json
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::PAYMENT_PLANS_ENDPOINT}/create", payload) 
+
+        return handle_create_response(response)
+    end 
+
+    def list_payment_plans
+        base_url = rave_object.base_url
+        response = get_request("#{base_url}#{BASE_ENDPOINTS::PAYMENT_PLANS_ENDPOINT}/query",{"seckey" => rave_object.secret_key.dup})
+        return handle_list_response(response)
+    end 
+
+    def fetch_payment_plan(id,q=nil )
+        base_url = rave_object.base_url
+        secret_key = rave_object.secret_key.dup
+
+        response = get_request("#{base_url}#{BASE_ENDPOINTS::PAYMENT_PLANS_ENDPOINT}/query",{"seckey" => rave_object.secret_key.dup, "id" => id, "q": q})
+        return handle_fetch_response(response)
+    end 
+
+    def cancel_payment_plan(id)
+        base_url = rave_object.base_url
+        secret_key = rave_object.secret_key.dup
+
+        payload = {
+            "seckey" => secret_key,
+        }
+
+        payload = payload.to_json
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::PAYMENT_PLANS_ENDPOINT}/#{id}/cancel",payload)
+        return handle_cancel_response(response)
+    end
+
+    def edit_payment_plan(id, data)
+
+        base_url = rave_object.base_url
+        secret_key = rave_object.secret_key.dup
+
+        data.merge!({"seckey" => secret_key.dup})
+
+        payload = data.to_json
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::PAYMENT_PLANS_ENDPOINT}/#{id}/edit",payload)
+        return handle_edit_response(response)
+    end
+end