flutterwave_sdk 0.1.0

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flutterwave_sdk"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/flutterwave_sdk.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/flutterwave_sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "flutterwave_sdk"
+  spec.version       = FlutterwaveSdk::VERSION
+  spec.authors       = ["Flutterwave Developers"]
+  spec.email         = ["developers@flutterwavego.com"]
+
+spec.date        = '2020-05-10'
+  spec.summary       = %q{Official Ruby Gem For Flutterwave APIs.}
+  spec.description   = %q{This is the official Ruby Gem For Flutterwave Payments which includes Card, Account, Transfer, Subaccount, Subscription, Mpesa, Ghana Mobile Money, Ussd, Payment Plans, and Transfer payment methods.}
+  spec.homepage      = "https://github.com/Flutterwave/Flutterwave-Ruby-v3."
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/flutterwave_sdk/error.rb

@@ -0,0 +1,15 @@
+class FlutterwaveServerError < StandardError
+	attr_reader :response
+	def initialize(response=nil)
+		@response = response
+	end
+end
+
+class FlutterwaveBadKeyError < StandardError
+end
+
+class IncompleteParameterError < StandardError
+end
+
+class SuggestedAuthError < StandardError
+end

data/lib/flutterwave_sdk/flutterwave_modules/base_endpoints.rb

@@ -0,0 +1,5 @@
+module BASE_ENDPOINTS
+    FLUTTERWAVE_LIVE_URL = "https://api.flutterwave.com/v3"
+    FLUTTERWAVE_SANDBOX_URL = "https://api.flutterwave.com/v3"
+    CHARGE_ENDPOINT = "/charges"
+end

data/lib/flutterwave_sdk/flutterwave_modules/util.rb

@@ -0,0 +1,26 @@
+
+require "digest"
+require "openssl"
+require "base64"
+require 'json'
+require 'securerandom'
+
+module Util
+
+    # method to generate merchants transaction reference
+    def self.transaction_reference_generator
+      transaction_ref = "MC-" + SecureRandom.hex
+      return transaction_ref
+    end
+
+    # method for encryption algorithm
+    def self.encrypt(key, data)
+      cipher = OpenSSL::Cipher.new("des-ede3")
+      cipher.encrypt # Call this before setting key
+      cipher.key = key
+      data = data.to_json
+      ciphertext = cipher.update(data)
+      ciphertext << cipher.final
+      return Base64.encode64(ciphertext)
+    end
+  end

data/lib/flutterwave_sdk/flutterwave_objects/account_payment.rb

@@ -0,0 +1,55 @@
+require_relative "base/base.rb"
+require 'json'
+
+class AccountPayment < 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 
+        currency = data["currency"]
+        if currency == "NGN"
+            required_parameters =  [ "amount", "email", "account_bank", "account_number", "tx_ref", "currency"]
+            type = "debit_ng_account"
+        elsif currency  == "GBP"
+            required_parameters =  [ "amount", "email", "account_bank", "account_number", "tx_ref", "currency"]
+            type = "debit_uk_account"
+        elsif currency == "USD" || "ZAR"
+            required_parameters = [ "amount", "email", "country", "tx_ref", "currency"]
+            type = "ach_payment"
+        else
+            return "pass a valid currency"
+        end
+
+        check_passed_parameters(required_parameters, data)
+        type = type
+        payload = data.to_json
+
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::CHARGE_ENDPOINT}?type=#{type}", payload) 
+        return response
+    end
+
+    def validate_charge(flw_ref, otp) 
+        base_url = flutterwave_object.base_url       
+        
+        payload = {
+            "otp" => otp,
+            "flw_ref" => flw_ref
+        }
+
+        payload = payload.to_json
+
+        response = post_request("#{base_url}/validate-charge", payload)
+        return response
+    end
+
+    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/bank.rb

@@ -0,0 +1,17 @@
+require_relative "base/base.rb"
+require 'json'
+
+class Bank < Base
+
+    def get_all_banks(country)
+        base_url = flutterwave_object.base_url
+        response = get_request("#{base_url}/banks/#{country}")
+        return response
+    end
+
+    def get_bank_branch(id)
+        base_url = flutterwave_object.base_url
+        response = get_request("#{base_url}/banks/#{id}/branches")
+        return response
+    end
+end

data/lib/flutterwave_sdk/flutterwave_objects/bank_transfer.rb

@@ -0,0 +1,30 @@
+require_relative "base/base.rb"
+require 'json'
+
+class BankTransfer < 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", "duration", "email", "phone_number", "frequency", "narration", "is_permanent", "tx_ref", "currency"]
+
+        check_passed_parameters(required_parameters, data)
+        type = "bank_transfer"
+        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/base/base.rb

@@ -0,0 +1,109 @@
+require 'httparty'
+require_relative "../../flutterwave_modules/base_endpoints"
+require "json"
+require_relative "../../error"
+
+class Base
+
+  attr_reader :flutterwave_object
+
+  # method to initialize this class
+  
+  def initialize(flutterwave_object=nil)
+    unless !flutterwave_object.nil?
+      raise ArgumentError, "Flutterwave Object is required!!!"
+    end
+    @flutterwave_object = flutterwave_object
+  end
+
+
+  # method to make a get request
+  def get_request(endpoint)
+    # headers = {
+    #     "Authorization" => "Bearer #{flutterwave_object.secret_key}"
+    # }
+    begin
+      response = HTTParty.get(endpoint, :headers => { "Authorization" => "Bearer #{flutterwave_object.secret_key}" })
+      unless (response.code == 200 || response.code == 201)
+        raise FlutterwaveServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
+      end
+
+      return response
+
+      unless(response.code != 0 )
+        raise FlutterwaveServerError.new(response), "Server Message: #{response.message}"
+      end
+
+      rescue JSON::ParserError => jsonerr
+        raise FlutterwaveServerError.new(response) , "Invalid result data. Could not parse JSON response body \n #{jsonerr.message}"
+        return response
+      end
+  end
+
+  # method to make a post request
+  def post_request(endpoint, data)
+    begin
+      response = HTTParty.post(endpoint, {
+        body: data,
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" =>  "Bearer #{flutterwave_object.secret_key}"
+        }
+      })
+
+      unless (response.code == 200 || response.code == 201)
+        raise FlutterwaveServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
+      end
+      return response
+    end
+
+  end
+  # method to make a put request
+  def put_request(endpoint, data)
+    begin
+      response = HTTParty.put(endpoint, {
+        body: data,
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" =>  "Bearer #{flutterwave_object.secret_key}"
+        }
+      })
+
+      unless (response.code == 200 || response.code == 201)
+        raise FlutterwaveServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
+      end
+      return response
+  end
+end
+
+  # method to make a delete request
+  def delete_request(endpoint, data)
+    begin
+      response = HTTParty.delete(endpoint, {
+        body: data,
+        headers: {
+          "Content-Type" => "application/json",
+          "Authorization" =>  "Bearer #{flutterwave_object.secret_key}"
+        }
+      })
+
+      unless (response.code == 200 || response.code == 201)
+        raise FlutterwaveServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
+      end
+      return response
+  end
+end
+
+  # method to check if the passed parameters is equal to the expected parameters
+  def check_passed_parameters(required_params, passed_params)
+
+    # This is used to check if the passed authorization parameters matches the required parameters
+    required_params.each do |k, v|
+      if !passed_params.key?(k)
+        raise IncompleteParameterError, "Parameters Incomplete, Missing Parameter: #{k}, Please pass in the complete parameter."
+      end
+    end
+  end
+
+end
+

data/lib/flutterwave_sdk/flutterwave_objects/base/card_base.rb

@@ -0,0 +1,49 @@
+require_relative "base.rb"
+
+class CardBase < Base
+
+    # method to the passed suggested auth to the corresponding value in the available hash
+  def get_auth_type(suggested_auth)
+    auth_map = {"pin" => :pin, "avs_vbvsecurecode" => :address, "noauth_international" => :address, "avs_noauth" => :address}
+
+    # Raise Error if the right authorization type is not passed
+    unless !auth_map.has_key? auth_map[suggested_auth]
+      raise RequiredAuthError, "Required suggested authorization type not available."
+    end
+    return auth_map[suggested_auth]
+  end
+
+
+  # method to update payload
+  def update_payload(suggested_auth, payload, **keyword_args)
+    auth_type = get_auth_type(suggested_auth)
+    
+    # Error is raised if the expected suggested auth is not found in the keyword arguments
+    if !keyword_args.key?(auth_type)
+      raise SuggestedAuthError, "Please pass the suggested auth."
+    end
+
+    # if the authorization type is equal to address symbol, update with the required parameters
+    if auth_type == :address
+      required_parameters = ["city", "address", "state", "country", "zipcode"]
+      check_passed_parameters(required_parameters, keyword_args[auth_type])
+      authorization = {}
+      authorization.merge!({"mode" => suggested_auth})
+      # puts authorization
+      authorization.merge!(keyword_args[auth_type])
+      payload["authorization"]= authorization
+      return payload
+    end
+
+
+    # return this updated payload if the passed authorization type isn't address symbol
+    authorization = {}
+    #  authorization.merge!({"mode" => suggested_auth, "fields" => keyword_args[auth_type]})
+    authorization.merge!({"mode" => suggested_auth})
+     puts authorization
+     authorization.merge!(keyword_args[auth_type])
+     payload["authorization"]= authorization
+    return payload
+
+  end
+end 

data/lib/flutterwave_sdk/flutterwave_objects/beneficiaries.rb

@@ -0,0 +1,34 @@
+require_relative "base/base.rb"
+require 'json'
+
+class Beneficiaries < Base
+
+    def create_beneficiary(data)
+        base_url = flutterwave_object.base_url 
+        required_parameters = ["account_number", "account_bank"]
+        check_passed_parameters(required_parameters, data)
+        payload = data.to_json
+        response = post_request("#{base_url}/beneficiaries", payload) 
+        return response
+    end
+
+    def list_beneficiaries
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/beneficiaries")
+        return response
+    end
+
+    def fetch_beneficiary(id)
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/beneficiaries/#{id}")
+        return response
+    end
+
+    def delete_beneficiary(id)
+        base_url = flutterwave_object.base_url 
+        payload = {}
+        payload = payload.to_json
+        response = delete_request("#{base_url}/beneficiaries/#{id}", payload)
+        return response
+    end
+end

data/lib/flutterwave_sdk/flutterwave_objects/bills.rb

@@ -0,0 +1,86 @@
+require_relative "base/base.rb"
+require 'json'
+
+class Bills < Base
+
+    def create_bill_payment(data)
+        base_url = flutterwave_object.base_url 
+        required_parameters = ["country", "customer", "amount", "recurrence", "type"]
+        check_passed_parameters(required_parameters, data)
+        payload = data.to_json
+        response = post_request("#{base_url}/bills", payload) 
+        return response
+    end
+
+    def create_bulk_bill_payments(data)
+        base_url = flutterwave_object.base_url 
+        required_parameters = ["bulk_reference", "callback_url", "bulk_data"]
+        check_passed_parameters(required_parameters, data)
+        payload = data.to_json
+        response = post_request("#{base_url}/bulk-bills", payload) 
+        return response
+    end
+
+    def get_status_of_a_bill_payment(reference)
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/bills/#{reference}") 
+        return response
+    end
+
+    def update_bills_order(reference, data)
+        base_url = flutterwave_object.base_url 
+        required_parameters = ["bulk_reference", "callback_url", "bulk_data"]
+        check_passed_parameters(required_parameters, data)
+        payload = data.to_json
+        response = post_request("#{base_url}/product-orders/#{reference}", payload) 
+        return response
+    end
+
+    def validate_bill_service(item_code, data)
+        base_url = flutterwave_object.base_url 
+        required_parameters = ["code", "customer"]
+        check_passed_parameters(required_parameters, data)
+        payload = data.to_json
+        response = post_request("#{base_url}/bill-items/#{item_code}/validate", payload) 
+        return response
+    end
+
+    def get_bill_categories
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/bill-categories")
+        return response
+    end
+
+    def get_bill_payment_agencies
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/billers")
+        return response
+    end
+
+    def get_amount_for_a_product(id, product_id)
+        base_url = flutterwave_object.base_url 
+        response = get_request("#{base_url}/billers/#{id}/products/#{product_id}")
+        return response
+    end
+
+    def get_bill_payments(data)
+        base_url = flutterwave_object.base_url
+        payload = data.to_json
+        response = get_request("#{base_url}/bills", payload)
+        return response
+    end
+
+    def get_products_under_an_agency(id)
+        base_url = flutterwave_object.base_url
+        response = get_request("#{base_url}/billers/#{id}/products")
+        return response
+    end
+
+    def create_order_using_billing_code_and_productid(id, product_id, data)
+        base_url = flutterwave_object.base_url 
+        payload = data.to_json
+        response = post_request("#{base_url}/biller/#{id}/products/#{product_id}/orders", payload) 
+        return response
+    end
+    
+end

data/lib/flutterwave_sdk/flutterwave_objects/card.rb

@@ -0,0 +1,55 @@
+require_relative "base/card_base.rb"
+require 'json'
+
+class Card < CardBase
+
+    # method to initiate card charge 
+    def initiate_charge(data)
+        base_url = flutterwave_object.base_url
+        encryption_key = flutterwave_object.encryption_key
+        public_key = flutterwave_object.public_key
+        
+        # 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
+
+        data.merge!({"public_key" => public_key})
+
+            required_parameters = [ "card_number", "cvv", "expiry_month", "expiry_year", "amount", "tx_ref", "currency", "email"]
+        check_passed_parameters(required_parameters, data)
+
+        encrypt_data = Util.encrypt(encryption_key, data)
+
+        payload = {
+            "public_key" => public_key,
+            "client" => encrypt_data,
+            "alg" => "3DES-24"
+        }
+        type = "card"
+        payload = payload.to_json
+
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::CHARGE_ENDPOINT}?type=#{type}", payload) 
+ 
+        return response
+
+    end
+
+    def validate_charge(flw_ref, otp)        
+        base_url = flutterwave_object.base_url
+        payload = {
+            "otp" => otp,
+            "flw_ref" => flw_ref
+        }
+
+        payload = payload.to_json
+        response = post_request("#{base_url}/validate-charge", payload)
+        return response
+    end
+
+    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/misc.rb

@@ -0,0 +1,37 @@
+require_relative "base/base.rb"
+require 'json'
+
+class Misc < Base
+    def get_all_wallet_balance()
+        base_url = flutterwave_object.base_url
+        response = get_request("#{base_url}/balances")
+        return response
+    end
+
+    def get_balance_per_currency(currency)
+        base_url = flutterwave_object.base_url
+        response = get_request("#{base_url}/balances/#{currency}")
+        return response
+    end
+
+    def resolve_account(data)
+        base_url = flutterwave_object.base_url
+        required_parameters = ["account_bank", "account_number"]
+        check_passed_parameters(required_parameters, data)
+        payload = data.to_json
+        response = post_request("#{base_url}/accounts/resolve", payload)
+        return response
+    end
+
+    def resolve_bvn(bvn)
+        base_url = flutterwave_object.base_url
+        response = get_request("#{base_url}/kyc/bvns/#{bvn}")
+        return response
+    end
+
+    def resolve_card_bin(bin)
+        base_url = flutterwave_object.base_url
+        response = get_request("#{base_url}/card-bins/#{bin}")
+        return response
+    end
+end

data/lib/flutterwave_sdk/flutterwave_objects/mobile_money.rb

@@ -0,0 +1,49 @@
+require_relative "base/base.rb"
+require 'json'
+
+class MobileMoney < 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 
+        if data["currency"] == "KES"
+            required_parameters =  [ "amount", "email", "phone_number", "tx_ref", "currency"]
+            type = "mpesa"
+        elsif data["currency"]  == "UGX"
+            required_parameters =  ["amount", "email", "phone_number", "tx_ref", "currency"]
+            type = "mobile_money_uganda"
+        elsif data["currency"]  == "GHS"
+            required_parameters =  ["amount", "email", "phone_number", "tx_ref", "currency"]
+            type = "mobile_money_ghana"
+        elsif data["currency"] == "ZMW"
+            required_parameters =  ["amount", "email", "phone_number","tx_ref", "currency"]
+            type = "mobile_money_zambia"
+        elsif data["currency"] == "RWF" 
+            required_parameters =  ["amount", "email", "phone_number","tx_ref", "currency"]
+            type = "mobile_money_rwanda"
+        elsif data["currency"] == "XAF"  || data["currency"] == "XOF"
+            required_parameters = ["amount", "email", "phone_number", "tx_ref", "currency"]
+            type = "mobile_money_franco"
+        else
+            return "pass a valid currency"
+        end
+
+        check_passed_parameters(required_parameters, data)
+        type = type
+        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)
+
+        response = get_request("#{base_url}/transactions/#{id}/verify")
+        return response
+end
+end

data/lib/flutterwave_sdk/flutterwave_objects/otp.rb

@@ -0,0 +1,22 @@
+require_relative "base/base.rb"
+require 'json'
+
+class OTP < Base
+    def create_otp(data)
+        base_url = flutterwave_object.base_url 
+        required_parameters = ["length", "customer", "sender", "send", "medium"]
+        check_passed_parameters(required_parameters, data)
+        payload = data.to_json
+        response = post_request("#{base_url}/otps", payload) 
+        return response
+    end
+
+    def validate_otp(reference, data)
+        base_url = flutterwave_object.base_url 
+        required_parameters = ["otp"]
+        check_passed_parameters(required_parameters, data)
+        payload = data.to_json
+        response = post_request("#{base_url}/otps/#{reference}/validate", payload) 
+        return response
+    end
+end