rave_ruby 0.1.1

data/lib/rave_ruby/rave_objects/preauth.rb

@@ -0,0 +1,111 @@
+require_relative "base/preauth_base.rb"
+require 'json'
+
+class Preauth < PreauthBase
+
+    # method to initiate preauth transaction
+    def initiate_charge(data)
+
+        base_url = rave_object.base_url
+        secret_key = rave_object.secret_key.dup
+        hashed_secret_key = get_hashed_key
+        public_key = rave_object.public_key
+
+        required_parameters = ["country", "amount", "currency", "email"]
+        check_passed_parameters(required_parameters, data)
+
+
+        # 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, "charge_type" => "preauth"})
+
+        # only update the payload with the transaction reference if it isn't already added to the payload
+        if data.key?("token")
+            data.merge!({"SECKEY" => secret_key})
+            payload = data.to_json
+            response = post_request("#{base_url}#{BASE_ENDPOINTS::PREAUTH_CHARGE_ENDPOINT}", payload) 
+            return handle_charge_response(response)
+        else
+            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
+    end
+
+    # method to capture transaction
+    def capture(flwRef, amount=nil)
+        base_url = rave_object.base_url
+
+        payload = {
+            "flwRef" => flwRef,
+            "SECKEY" => rave_object.secret_key.dup,
+            "amount" => amount
+        }
+
+        payload = payload.to_json
+
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::CAPTURE_ENDPOINT}", payload)
+        return handle_capture_response(response)
+    end
+
+    # method to refund a transaction
+    def refund(flwRef)
+        base_url = rave_object.base_url
+
+        payload = {
+            "ref" => flwRef,
+            "action" => "refund",
+            "SECKEY" => rave_object.secret_key.dup,
+        }
+
+        payload = payload.to_json
+
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::REFUND_VOID_ENDPOINT}", payload)
+        return handle_refund_void_response(response)
+    end
+
+     # method to void a transaction
+     def void(flwRef)
+        base_url = rave_object.base_url
+
+        payload = {
+            "ref" => flwRef,
+            "action" => "void",
+            "SECKEY" => rave_object.secret_key.dup,
+        }
+
+        payload = payload.to_json
+
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::REFUND_VOID_ENDPOINT}", payload)
+        return handle_refund_void_response(response)
+    end
+
+    # method to verify preauth transaction
+    def verify_preauth(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/sub_account.rb

@@ -0,0 +1,55 @@
+require_relative "base/sub_account_base.rb"
+require 'json'
+
+class SubAccount < SubAccountBase
+
+    # method to create subaccount 
+    def create_subaccount(data)
+        base_url = rave_object.base_url
+
+        data.merge!({"seckey" => rave_object.secret_key.dup})
+
+        required_parameters = ["account_bank", "account_number", "business_name", "business_email", "business_contact", "business_contact_mobile", "business_mobile", "split_type", "split_value"]
+        check_passed_parameters(required_parameters, data)
+
+        payload = data.to_json
+
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::SUBACCOUNT_ENDPOINT}/create", payload) 
+
+        return handle_create_response(response)
+    end
+
+    # method to list all subaccounts
+    def list_subaccounts
+        base_url = rave_object.base_url
+
+        response = get_request("#{base_url}#{BASE_ENDPOINTS::SUBACCOUNT_ENDPOINT}", {"seckey" => rave_object.secret_key.dup}) 
+
+        return handle_subaccount_response(response)
+    end
+    
+    # method to fetch a subaccount
+    def fetch_subaccount(subaccount_id)
+        base_url = rave_object.base_url
+
+        response = get_request("#{base_url}#{BASE_ENDPOINTS::SUBACCOUNT_ENDPOINT}/get/#{subaccount_id}", {"seckey" => rave_object.secret_key.dup}) 
+
+        return handle_subaccount_response(response)
+    end
+
+
+    # method to delete a subaccount
+    def delete_subaccount(subaccount_id)
+        base_url = rave_object.base_url
+
+        payload = {
+            "seckey" => rave_object.secret_key.dup,
+            "id" => subaccount_id
+        }
+
+        payload = payload.to_json
+
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::SUBACCOUNT_ENDPOINT}/delete", payload)
+        return handle_subaccount_response(response)
+    end
+end

data/lib/rave_ruby/rave_objects/subscription.rb

@@ -0,0 +1,51 @@
+require_relative "base/subscription_base.rb"
+require 'json'
+
+class Subscription < SubscriptionBase
+
+    #method to list subscriptions
+
+    def list_all_subscription
+        base_url = rave_object.base_url
+        response = get_request("#{base_url}#{BASE_ENDPOINTS::SUBSCRIPTIONS_ENDPOINT}/query",{"seckey" => rave_object.secret_key.dup})
+        return handle_list_all_subscription(response)
+    end 
+
+    #method to fetch a subscription
+
+    def fetch_subscription(id, email)
+        base_url = rave_object.base_url
+        secret_key = rave_object.secret_key.dup
+
+        response = get_request("#{base_url}#{BASE_ENDPOINTS::SUBSCRIPTIONS_ENDPOINT}/query",{"seckey" => rave_object.secret_key.dup, "id" => id, "email": email})
+        return handle_fetch_subscription_response(response)
+    end 
+
+    def cancel_subscription(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::SUBSCRIPTIONS_ENDPOINT}/#{id}/cancel",payload)
+        return handle_cancel_response(response)
+    end
+
+    def activate_subscription(id)
+
+        base_url = rave_object.base_url
+        secret_key = rave_object.secret_key.dup
+
+        # data.merge!({"seckey" => secret_key.dup})
+
+        payload = {
+            "seckey" => secret_key,
+        }
+        payload = payload.to_json
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::SUBSCRIPTIONS_ENDPOINT}/#{id}/activate",payload)
+        return handle_activate_subscription_response(response)
+    end
+end

data/lib/rave_ruby/rave_objects/transactions.rb

@@ -0,0 +1,24 @@
+require './rave_ruby/objects/base'
+
+  class RaveTransactions < RaveBaseObject
+
+      #encrpt the data
+
+      def encrypt(key, data)
+        key = key
+        data = data
+        client_data = encrypt(key, data)
+      end
+
+    #Card payment
+    def chargeCards(client_data )
+          payload = {
+            "PBFPubKey" => self.PBFPubKey,
+            "client" => client_data,
+            "alg" => "3DES-24"
+          }
+          perform_post("#{BASE::CHARGE_ENDPOINT}/charge", payload)
+    end
+
+
+  end

data/lib/rave_ruby/rave_objects/transfer.rb

@@ -0,0 +1,79 @@
+require_relative "base/transfer_base.rb"
+require 'json'
+
+class Transfer < TransferBase
+
+    # method to initiate single transfer
+    def initiate_transfer(data)
+        base_url = rave_object.base_url
+        
+        # only update the payload with the transaction reference if it isn't already added to the payload
+        if !data.key?("reference")
+            data.merge!({"reference" => Util.transaction_reference_generator})
+        end
+
+        data.merge!({"seckey" => rave_object.secret_key.dup})
+
+        required_parameters = ["amount", "currency"]
+        check_passed_parameters(required_parameters, data)
+
+        payload = data.to_json
+
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::TRANSFER_ENDPOINT}/create", payload) 
+
+        return handle_initiate_response(response)
+    end
+
+    # method to perform bulk transfer request
+    def bulk_transfer(data)
+        base_url = rave_object.base_url
+
+        data.merge!({"seckey" => rave_object.secret_key.dup})
+
+        required_parameters = ["title", "bulk_data"]
+        check_passed_parameters(required_parameters, data)
+
+        payload = data.to_json
+
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::TRANSFER_ENDPOINT}/create_bulk", payload) 
+
+        return handle_bulk_response(response)
+    end
+    
+    # method to perform get fee request
+    def get_fee(currency)
+        base_url = rave_object.base_url
+        response = get_request("#{base_url}#{BASE_ENDPOINTS::GET_FEE_ENDPOINT}", {"seckey" => rave_object.secret_key.dup, "currency" => currency})
+        return handle_transfer_status(response)
+    end
+
+    # method to perform get balance request
+    def get_balance(currency)
+        base_url = rave_object.base_url
+
+        payload = {
+            "seckey" => rave_object.secret_key.dup,
+            "currency" => currency
+        }
+
+        payload = payload.to_json
+
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::GET_BALANCE_ENDPOINT}", payload)
+        return handle_balance_status(response)
+    end
+
+
+    # method to fetch a single transfer
+    def fetch(reference)
+        base_url = rave_object.base_url
+        response = get_request("#{base_url}#{BASE_ENDPOINTS::FETCH_ENDPOINT}", {"seckey" => rave_object.secret_key.dup, "reference" => reference})
+        return handle_fetch_status(response)
+    end
+
+    # method to fetch all transfers
+    def fetch_all_transfers
+        base_url = rave_object.base_url
+        response = get_request("#{base_url}#{BASE_ENDPOINTS::FETCH_ENDPOINT}", {"seckey" => rave_object.secret_key.dup})
+        return handle_fetch_status(response)
+    end
+end

data/lib/rave_ruby/rave_objects/uganda_mobile_money.rb

@@ -0,0 +1,58 @@
+require_relative "base/mobile_money_base.rb"
+require 'json'
+
+class UgandaMobileMoney < MobileMoneyBase
+    # method to initiate uganda 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" => "mobilemoneyuganda", "country" => "NG", "is_mobile_money_ug"=> 1, "currency" => "UGX"})
+
+        required_parameters = ["amount", "email", "phonenumber", "network", "IP"]
+        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 uganda 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/ussd.rb

@@ -0,0 +1,59 @@
+require_relative "base/ussd_base.rb"
+require 'json'
+
+class Ussd < UssdBase
+
+    # method to initiate ussd 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, "is_ussd" => "1", "payment_type" => "ussd"})
+
+        required_parameters = ["accountbank", "accountnumber", "amount", "email", "phonenumber", "IP"]
+        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, data)
+
+    end
+
+    # method to verify ussd 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/version.rb

@@ -0,0 +1,3 @@
+module RaveRuby
+  VERSION = "0.1.1"
+end

data/lib/rave_ruby.rb

@@ -0,0 +1,74 @@
+require_relative "rave_ruby/rave_modules/base_endpoints"
+require_relative "rave_ruby/rave_objects/base/base"
+require_relative "rave_ruby/rave_modules/util"
+require_relative "rave_ruby/rave_objects/list_banks"
+require_relative "rave_ruby/rave_objects/card"
+require_relative "rave_ruby/rave_objects/account"
+require_relative "rave_ruby/rave_objects/transfer"
+require_relative "rave_ruby/rave_objects/mpesa"
+require_relative "rave_ruby/rave_objects/mobile_money"
+require_relative "rave_ruby/rave_objects/uganda_mobile_money"
+require_relative "rave_ruby/rave_objects/payment_plan"
+require_relative "rave_ruby/rave_objects/subscription"
+require_relative "rave_ruby/rave_objects/ussd"
+require_relative "rave_ruby/rave_objects/preauth"
+require_relative "rave_ruby/rave_objects/sub_account"
+require_relative 'rave_ruby/error'
+
+
+  class RaveRuby
+      
+      attr_accessor :public_key, :secret_key, :production, :url
+
+      # method to initialize rave object
+      
+      def initialize(public_key=nil, secret_key=nil, production=false)
+
+        @public_key = public_key
+        @secret_key = secret_key
+        @production = production
+        rave_sandbox_url = BASE_ENDPOINTS::RAVE_SANDBOX_URL
+        rave_live_url = BASE_ENDPOINTS::RAVE_LIVE_URL
+
+        # set rave url to sandbox or live if we are in production or development
+        if production == false
+            @url =  rave_sandbox_url
+        else
+            @url = rave_live_url
+        end
+
+
+        # check if we set our public and secret keys to the environment variable
+        if (public_key.nil? && secret_key.nil?)
+          @public_key = ENV['RAVE_PUBLIC_KEY']
+          @secret_key = ENV['RAVE_SECRET_KEY']
+        else
+          @public_key = public_key
+          @secret_key = secret_key
+          warn "Warning: To ensure your rave account api keys are safe, It is best to always set your keys in the environment variable"
+        end
+
+        # raise this error if no public key is passed
+        unless !@public_key.nil?
+          raise RaveBadKeyError, "No public key supplied and couldn't find any in environment variables. Make sure to set public key as an environment variable RAVE_PUBLIC_KEY"
+        end
+        # raise this error if invalid public key is passed
+        unless @public_key[0..7] == 'FLWPUBK-'
+          raise RaveBadKeyError, "Invalid public key #{@public_key}"
+        end
+        
+        # raise this error if no secret key is passed
+        unless !@secret_key.nil?
+          raise RaveBadKeyError, "No secret key supplied and couldn't find any in environment variables. Make sure to set secret key as an environment variable RAVE_SECRET_KEY"
+        end
+        # raise this error if invalid secret key is passed
+        unless @secret_key[0..7] == 'FLWSECK-'
+          raise RaveBadKeyError, "Invalid secret key #{@secret_key}"
+        end
+  end
+
+  # method to return the base url
+  def base_url
+    return url
+  end
+end

data/rave_ruby.gemspec

@@ -0,0 +1,46 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rave_ruby/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rave_ruby"
+  spec.version       = RaveRuby::VERSION
+  spec.authors       = ["MaestroJolly"]
+  spec.email         = ["jolaosoyusuf@gmail.com"]
+  spec.date        = '2019-01-19'
+  spec.summary       = %q{Ruby Gem For Rave Payments By Flutterwave.}
+  spec.description   = %q{This is the official Ruby Gem For Rave Payments which includes Card, Account, Transfer, Subaccount, Subscription, Mpesa, Ghana Mobile Money, Ussd, Payment Plans, and Transfer payment methods.}
+  spec.homepage      = "https://github.com/MaestroJolly/rave-ruby"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    spec.metadata["changelog_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+
+  # Dependencies
+  spec.required_ruby_version = ">= 2.5.3"
+  spec.add_runtime_dependency 'httparty', '~> 0.16.3'
+end