flutterwave_sdk 0.1.0

data/lib/flutterwave_sdk/flutterwave_objects/payment_plan.rb

@@ -0,0 +1,42 @@
+require_relative "base/base.rb"
+require 'json'
+
+class PaymentPlan < Base
+
+    # method to create a payment plan
+    def create_payment_plan(data)
+        base_url = flutterwave_object.base_url 
+        required_parameters = ["amount", "name", "interval"]
+        check_passed_parameters(required_parameters, data)
+        payload = data.to_json
+        response = post_request("#{base_url}/payment-plans", payload) 
+        return response
+    end 
+
+    def get_payment_plans
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/payment-plans")
+        return response
+    end 
+
+    def get_a_payment_plan(id)
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/payment-plans/#{id}")
+        return response
+    end 
+
+    def update_payment_plan(id, data)
+        base_url = flutterwave_object.base_url 
+        payload = data.to_json
+        response = put_request("#{base_url}/payment-plans/#{id}",payload)
+        return response
+    end
+
+    def cancel_payment_plan(id)
+        base_url = flutterwave_object.base_url
+        payload = {}
+        payload = payload.to_json
+        response = put_request("#{base_url}/payment-plans/#{id}/cancel",payload)
+        return response
+    end
+end

data/lib/flutterwave_sdk/flutterwave_objects/preauthorise.rb

@@ -0,0 +1,26 @@
+require_relative "base/base.rb"
+require 'json'
+
+class Preauth < Base
+
+    def capture_preauth(flw_ref, data)
+        base_url = flutterwave_object.base_url 
+        payload = data.to_json
+        response = post_request("#{base_url}/charges/#{flw_ref}/capture", payload) 
+        return response
+    end
+
+    def void_preauth(flw_ref)
+        base_url = flutterwave_object.base_url 
+        payload = payload.to_json
+        response = post_request("#{base_url}/charges/#{flw_ref}/void", payload) 
+        return response
+    end
+
+    def refund_preauth(flw_ref, data)
+        base_url = flutterwave_object.base_url 
+        payload = data.to_json
+        response = post_request("#{base_url}/charges/#{flw_ref}/refund", payload) 
+        return response
+    end
+end

data/lib/flutterwave_sdk/flutterwave_objects/qr.rb

@@ -0,0 +1,28 @@
+require_relative "base/base.rb"
+require 'json'
+
+class QR < Base
+    def initiate_charge(data)
+        base_url = flutterwave_object.base_url        
+        # only update the payload with the transaction reference if it isn't already added to the payload
+        if !data.key?("tx_ref")
+            data.merge!({"tx_ref" => Util.transaction_reference_generator})
+        end
+        # check the currency to determine the type and the required parameters 
+        required_parameters = ["amount", "fullname", "email", "phone_number", "tx_ref", "currency"]
+
+        check_passed_parameters(required_parameters, data)
+        type = "qr"
+        payload = data.to_json
+
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::CHARGE_ENDPOINT}?type=#{type}", payload) 
+        return response
+    end
+
+    # mthod to verify transaction
+    def verify_charge(id)
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/transactions/#{id}/verify")
+        return response
+    end
+end

data/lib/flutterwave_sdk/flutterwave_objects/settlements.rb

@@ -0,0 +1,17 @@
+require_relative "base/base.rb"
+require 'json'
+
+class Settlements < Base
+
+    def get_settlements
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/settlements") 
+        return response
+    end
+
+    def get_settlement(id)
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/settlements/#{id}") 
+        return response
+    end
+end

data/lib/flutterwave_sdk/flutterwave_objects/subaccount.rb

@@ -0,0 +1,40 @@
+require_relative "base/base.rb"
+require 'json'
+
+class Subaccount < Base
+    def create_subaccount(data)
+        base_url = flutterwave_object.base_url 
+        required_parameters = ["account_bank", "account_number", "business_name", "business_contact", "country", "split_value", "business_mobile"]
+        check_passed_parameters(required_parameters, data)
+        payload = data.to_json
+        response = post_request("#{base_url}/subaccounts", payload) 
+        return response
+    end
+
+    def fetch_subaccounts
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/subaccounts") 
+        return response
+    end
+
+    def fetch_subaccount(id)
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/subaccounts/#{id}") 
+        return response
+    end
+
+    def update_subaccount(id, data)
+        base_url = flutterwave_object.base_url 
+        payload = data.to_json
+        response = put_request("#{base_url}/subaccounts/#{id}", payload)
+        return response
+    end
+
+    def delete_subaccount(id)
+        base_url = flutterwave_object.base_url 
+        payload = {}
+        payload = payload.to_json
+        response = delete_request("#{base_url}/subaccounts/#{id}", payload) 
+        return response
+    end
+end

data/lib/flutterwave_sdk/flutterwave_objects/subscriptions.rb

@@ -0,0 +1,25 @@
+require_relative "base/base.rb"
+require 'json'
+
+class Subscriptions < Base
+
+    def get_all_subscriptions
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/subscriptions")
+        return response
+    end
+
+    def cancel_subscription(id)
+        base_url = flutterwave_object.base_url
+        payload = {}
+        payload = payload.to_json
+        response = put_request("#{base_url}/subscriptions/#{id}/cancel", payload) 
+    end
+
+    def activate_subscription(id)
+        base_url = flutterwave_object.base_url
+        payload = {}
+        payload = payload.to_json
+        response = put_request("#{base_url}/subscriptions/#{id}/activate", payload) 
+    end
+end

data/lib/flutterwave_sdk/flutterwave_objects/tokenized_charge.rb

@@ -0,0 +1,61 @@
+require_relative "base/base.rb"
+require 'json'
+
+class TokenizedCharge < Base
+
+    # method to charge with token 
+    def tokenized_charge(data)
+        base_url = flutterwave_object.base_url 
+        # only update the payload with the transaction reference if it isn't already added to the payload
+        if !data.key?("tx_ref")
+            data.merge!({"tx_ref" => Util.transaction_reference_generator})
+        end
+
+        required_parameters = [ "token", "currency", "country", "amount", "tx_ref", "email"]
+        check_passed_parameters(required_parameters, data)
+
+        response = post_request("#{base_url}/tokenized-charges", data.to_json) 
+ 
+        return response
+
+    end
+
+    def verify_tokenized_charge(id)
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/transactions/#{id}/verify")
+        return response
+    end
+
+    # method for updating token detials
+    def update_token(data, token)
+        base_url = flutterwave_object.base_url 
+        response = put_request("#{base_url}/tokens/#{token}", data.to_json)
+        return response
+    end
+
+    # method to create bulk tokenized charges
+    def bulk_tokenized_charge(data)
+        base_url = flutterwave_object.base_url 
+        required_parameters = ["title", "retry_strategy", "bulk_data"]
+        check_passed_parameters(required_parameters, data)
+
+        payload = data.to_json
+
+        response = post_request("#{base_url}/bulk-tokenized-charges/", payload)
+        return response
+    end
+
+    #method to get status of a bulk tokenized charges
+    def bulk_tokenized_charge_status(bulk_id)
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/bulk-tokenized-charges/#{bulk_id}")
+        return response
+    end
+
+    #method to get all the bulk tokenized transactions
+    def bulk_tokenized_charge_transactions(bulk_id)
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/bulk-tokenized-charges/#{bulk_id}/transactions")
+        return response
+    end
+end

data/lib/flutterwave_sdk/flutterwave_objects/transactions.rb

@@ -0,0 +1,47 @@
+require_relative "base/base.rb"
+require 'json'
+
+class Transactions < Base
+    def transaction_fee(currency, amount)
+        base_url = flutterwave_object.base_url
+        required_parameters = ["amount", "currency"]
+        check_passed_parameters(required_parameters, data)
+        response = get_request("#{base_url}/transactions/fee?&amount=#{amount}&currency=#{currency}")
+        return response
+    end
+
+    def get_transactions
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/transactions")
+        return response
+
+    end
+
+    def verify_transaction(id)
+        base_url = flutterwave_object.base_url
+        response = get_request("#{base_url}/transactions/#{id}/verify")
+        return response
+    end
+
+    def transactions_events(id)
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/transactions/#{id}/events")
+        return response
+    end
+
+    def initiate_a_refund(data, id)
+        base_url = flutterwave_object.base_url 
+        payload = data.to_json
+        response = post_request("#{base_url}/transactions/#{id}/refund", payload)
+        return response
+    end
+
+    #resend transaction webhook
+
+    def resend_transaction_webhook(payload)
+        base_url = flutterwave_object.base_url 
+        response = post_request("#{base_url}/transactions/resend-hook", payload.to_json)
+        return response
+    end
+
+end

data/lib/flutterwave_sdk/flutterwave_objects/transfer.rb

@@ -0,0 +1,46 @@
+require_relative "base/base.rb"
+require 'json'
+
+class Transfer < Base
+
+    def transfer_fee(currency,amount)
+        base_url = flutterwave_object.base_url
+        response = get_request("#{base_url}/transfers/fee?currency=#{currency}&amount=#{amount}")
+        return response
+    end
+
+    def initiate_transfer(data)
+        base_url = flutterwave_object.base_url      
+        # only update the payload with the transaction reference if it isn't already added to the payload
+        if !data.key?("tx_ref")
+            data.merge!({"tx_ref" => Util.transaction_reference_generator})
+        end
+
+        required_parameters = ["amount", "currency", "account_bank", "account_number"]
+        check_passed_parameters(required_parameters, data)
+        payload = data.to_json
+        response = post_request("#{base_url}/transfers", payload)
+        return response
+    end
+
+    def initiate_bulk_transfer(data)
+        base_url = flutterwave_object.base_url 
+        required_parameters = ["title", "bulk_data"]
+        check_passed_parameters(required_parameters, data)   
+        payload = data.to_json
+        response = post_request("#{base_url}/bulk-transfers", payload) 
+        return response
+    end
+
+    def get_all_transfers
+        base_url = flutterwave_object.base_url
+        response = get_request("#{base_url}/transfers")
+        return response
+    end
+
+    def get_a_transfer(id)
+        base_url = flutterwave_object.base_url
+        response = get_request("#{base_url}/transfers/#{id}")
+        return response
+    end
+end

data/lib/flutterwave_sdk/flutterwave_objects/ussd_payment.rb

@@ -0,0 +1,27 @@
+require_relative "base/base.rb"
+require 'json'
+
+class USSD < Base
+    def initiate_charge(data)
+        base_url = flutterwave_object.base_url 
+        # only update the payload with the transaction reference if it isn't already added to the payload
+        if !data.key?("tx_ref")
+            data.merge!({"tx_ref" => Util.transaction_reference_generator})
+        end
+        # check the currency to determine the type and the required parameters 
+        required_parameters = ["amount", "account_bank", "email", "phone_number", "tx_ref", "currency"]
+
+        check_passed_parameters(required_parameters, data)
+        type = "ussd"
+        payload = data.to_json
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::CHARGE_ENDPOINT}?type=#{type}", payload) 
+        return response
+    end
+
+    # mthod to verify transaction
+    def verify_charge(id)
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/transactions/#{id}/verify")
+        return response
+end
+end

data/lib/flutterwave_sdk/flutterwave_objects/virtual_account_number.rb

@@ -0,0 +1,34 @@
+require_relative "base/base.rb"
+require 'json'
+
+class VirtualAccountNumber < Base
+
+    def create_virtual_account_number(data)
+        base_url = flutterwave_object.base_url 
+        required_parameters = ["email", "duration", "frequency", "tx_ref"]
+        check_passed_parameters(required_parameters, data)
+        payload = data.to_json
+        response = post_request("#{base_url}/virtual-account-numbers", payload) 
+        return response
+    end
+
+    def create_bulk_virtual_account_number(data)
+        base_url = flutterwave_object.base_url 
+        payload = data.to_json
+        response = post_request("#{base_url}/bulk-virtual-account-numbers", payload) 
+        return response
+    end
+
+    def get_bulk_virtual_account_number(batch_id)
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/bulk-virtual-account-numbers/#{batch_id}") 
+        return response
+    end
+
+    def get_virtual_account_number(order_ref)
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/virtual-account-numbers/#{order_ref}") 
+        return response
+    end
+
+end

data/lib/flutterwave_sdk/flutterwave_objects/virtual_card.rb

@@ -0,0 +1,66 @@
+require_relative "base/base.rb"
+require 'json'
+
+class VirtualCard < Base
+
+    def create_virtual_card(data)
+        base_url = flutterwave_object.base_url 
+        required_parameters = ["currency", "amount", "billing_name"]
+        check_passed_parameters(required_parameters, data)
+        payload = data.to_json
+        response = post_request("#{base_url}/virtual-cards", payload) 
+        return response
+    end
+
+    def get_all_virtual_cards
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/virtual-cards")
+        return response
+    end
+
+    def get_virtual_card(id)
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/virtual-cards/#{id}")
+        return response
+    end
+
+    def fund_virtual_card(id, data)
+        base_url = flutterwave_object.base_url 
+        required_parameters = [ "amount"]
+        check_passed_parameters(required_parameters, data)
+        payload = data.to_json
+        response = post_request("#{base_url}/virtual-cards/#{id}/fund", payload) 
+        return response
+    end
+
+    def terminate_virtual_card(id)
+        base_url = flutterwave_object.base_url 
+        payload = {}
+        payload = payload.to_json
+        response = put_request("#{base_url}/virtual-cards/#{id}/terminate", payload) 
+        return response
+    end
+
+    def get_virtual_card_transactions(id, from, to, index, size)
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/virtual-cards/#{id}/transactions", {"from" => from, "to" => to, "index" => index, "size" => size})
+        return response
+    end
+
+    def withdraw_from_virtual_card(id, data)
+        base_url = flutterwave_object.base_url 
+        required_parameters = [ "amount"]
+        check_passed_parameters(required_parameters, data)
+        payload = data.to_json
+        response = post_request("#{base_url}/virtual-cards/#{id}/withdraw", payload) 
+        return response
+    end
+
+    def block_unblock_virtual_card(id, status_action)
+        base_url = flutterwave_object.base_url 
+        payload = {}
+        payload = payload.to_json
+        response = put_request("#{base_url}/virtual-cards/#{id}/status/#{status_action}", payload) 
+        return response
+    end
+end

data/lib/flutterwave_sdk/version.rb

@@ -0,0 +1,3 @@
+module FlutterwaveSdk
+  VERSION = "0.1.0"
+end

data/lib/flutterwave_sdk.rb

@@ -0,0 +1,126 @@
+require_relative "flutterwave_sdk/version"
+require_relative "flutterwave_sdk/flutterwave_modules/base_endpoints"
+require_relative "flutterwave_sdk/flutterwave_objects/base/base"
+require_relative "flutterwave_sdk/flutterwave_modules/util"
+require_relative "flutterwave_sdk/flutterwave_objects/card"
+require_relative "flutterwave_sdk/flutterwave_objects/mobile_money"
+require_relative "flutterwave_sdk/flutterwave_objects/account_payment"
+require_relative "flutterwave_sdk/flutterwave_objects/bank_transfer"
+require_relative "flutterwave_sdk/flutterwave_objects/ussd_payment"
+require_relative "flutterwave_sdk/flutterwave_objects/qr"
+require_relative "flutterwave_sdk/flutterwave_objects/tokenized_charge"
+require_relative "flutterwave_sdk/flutterwave_objects/transactions"
+require_relative "flutterwave_sdk/flutterwave_objects/transfer"
+require_relative "flutterwave_sdk/flutterwave_objects/bank"
+require_relative "flutterwave_sdk/flutterwave_objects/misc"
+require_relative "flutterwave_sdk/flutterwave_objects/payment_plan"
+require_relative "flutterwave_sdk/flutterwave_objects/beneficiaries"
+require_relative "flutterwave_sdk/flutterwave_objects/subscriptions"
+require_relative "flutterwave_sdk/flutterwave_objects/virtual_card"
+require_relative "flutterwave_sdk/flutterwave_objects/subaccount"
+require_relative "flutterwave_sdk/flutterwave_objects/settlements"
+require_relative "flutterwave_sdk/flutterwave_objects/otp"
+require_relative "flutterwave_sdk/flutterwave_objects/virtual_account_number"
+require_relative "flutterwave_sdk/flutterwave_objects/bills"
+require_relative "flutterwave_sdk/flutterwave_objects/preauthorise"
+require_relative "flutterwave_sdk/error"
+
+class Flutterwave
+
+  attr_accessor :public_key, :secret_key, :encryption_key, :production, :url
+
+        # method to initialize flutterwave object
+  def initialize(public_key=nil, secret_key=nil, encryption_key=nil, production=false)
+    @public_key = public_key
+    @secret_key = secret_key
+    @production = production
+    @encryption_key = encryption_key
+    flutterwave_sandbox_url = BASE_ENDPOINTS::FLUTTERWAVE_SANDBOX_URL
+    flutterwave_live_url = BASE_ENDPOINTS::FLUTTERWAVE_LIVE_URL
+
+    # set rave url to sandbox or live if we are in production or development
+    if production == false
+        @url =  flutterwave_sandbox_url
+    else
+        @url = flutterwave_live_url
+    end
+
+  def base_url
+  return url
+  end
+
+   # check if we set our public , secret  and encryption keys to the environment variable
+   if (public_key.nil?)
+    @public_key = ENV['FLUTTERWAVE_PUBLIC_KEY']
+   else 
+    @public_key = public_key
+   end
+
+   if (secret_key.nil?)
+    @secret_key = ENV['FLUTTERWAVE_SECRET_KEY']
+   else
+    @secret_key = secret_key
+   end
+
+   if (encryption_key.nil?)
+    @encryption_key = ENV['FLUTTERWAVE_ENCRYPTION_KEY']
+   else
+    @encryption_key = encryption_key
+   end
+    warn "Warning: To ensure your rave account api keys are safe, It is best to always set your keys in the environment variable"
+
+  # raise this error if no public key is passed
+  unless !@public_key.nil?
+    raise FlutterwaveBadKeyError, "No public key supplied and couldn't find any in environment variables. Make sure to set public key as an environment variable FLUTTERWAVE_PUBLIC_KEY"
+  end
+  # raise this error if invalid public key is passed
+  unless @public_key[0..7] == 'FLWPUBK-' || @public_key[0..11] == 'FLWPUBK_TEST'
+    raise FlutterwaveBadKeyError, "Invalid public key #{@public_key}"
+  end
+  
+  # raise this error if no secret key is passed
+  unless !@secret_key.nil?
+    raise FlutterwaveBadKeyError, "No secret key supplied and couldn't find any in environment variables. Make sure to set secret key as an environment variable FLUTTERWAVE_SECRET_KEY"
+  end
+  # raise this error if invalid secret key is passed
+  unless @secret_key[0..7] == 'FLWSECK-' || @secret_key[0..11] == 'FLWSECK_TEST'
+    raise FlutterwaveBadKeyError, "Invalid secret key #{@secret_key}"
+  end
+
+  # raise this error if no encryption key is passed
+  unless !@encryption_key.nil?
+    raise FlutterwaveBadKeyError, "No encryption key supplied and couldn't find any in environment variables. Make sure to set encryption key as an environment variable FLUTTERWAVE_ENCRYPTION_KEY"
+  end
+end
+
+  #tracking activities
+  def flutterwave_tracking 
+    endpoint = "https://kgelfdz7mf.execute-api.us-east-1.amazonaws.com/staging/sendevent"
+      public_key = @public_key
+          
+          
+        payload = {
+          "PBFPubKey" => public_key,
+          "language" => "Ruby",
+          "version" => "1.0",
+          "title" => "test message",
+          "message" => "test is done"
+          }
+          data = payload.to_json
+  
+          response = HTTParty.post(endpoint, {
+            body: data,
+            headers: {
+              'Content-Type' => 'application/json'
+            }
+          })
+    
+          unless (response.code == 200 || response.code == 201)
+            raise RaveServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
+          end 
+          return response
+    end
+
+end
+
+