paystack 0.1.3 → 0.1.10

data/Rakefile

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

data/lib/paystack.rb

@@ -1,84 +1,58 @@
-require 'rest-client'
-require 'paystack/modules/tokenmanager.rb'
-require 'paystack/error.rb'
-require 'paystack/utils/utils.rb'
-
-require 'paystack/objects/card.rb'
-require 'paystack/objects/customers.rb'
-require 'paystack/objects/plans.rb'
-require 'paystack/objects/transactions.rb'
-
-
-class Paystack
-	attr_reader :public_key, :private_key
-
-	def initialize paystack_public_key=nil, paystack_private_key=nil
-		if(paystack_public_key.nil?)
-			@public_key = ENV['PAYSTACK_PUBLIC_KEY']
-			
-		else
-			@public_key = paystack_public_key
-		end			
-
-		if(paystack_private_key.nil?)
-			@private_key = ENV['PAYSTACK_PRIVATE_KEY']
-		else
-			@private_key = paystack_private_key
-		end
-
-		unless !@public_key.nil?
-				raise PaystackBadKeyError, "No public key supplied and couldn't find any in environment variables. Make sure to set public key as an environment variable PAYSTACK_PUBLIC_KEY"
-		end
-		unless @public_key[0..2] == 'pk_'
-				raise PaystackBadKeyError, "Invalid public key #{@public_key}"
-		end
-
-		unless !@private_key.nil?
-				raise PaystackBadKeyError, "No private key supplied and couldn't find any in environment variables. Make sure to set private key as an environment variable PAYSTACK_PRIVATE_KEY"
-		end
-		unless @private_key[0..2] == 'sk_'
-				raise PaystackBadKeyError, "Invalid private key #{@private_key}"
-		end
-
-
-	end
-
-	def getToken card
-		return TokenManager.create(card, @public_key)
-	end
-
-	def setPublicKey public_key
-		@public_key = public_key
-	end
-
-	def setPrivateKey public_key
-		@public_key = public_key
-	end
-
-#	def chargeToken(token, amount,args = {})
-#		token = token;
-#		amount = amount
-#		email = args[:email]
-#		reference = args[:reference]
-#		result = nil;
-#		
-#		begin
-#			response =  RestClient.post "#{API::BASE_URL}#{API::TRANSACTION_PATH}/charge_token", {:token => token, :amount => amount, :email => email, :reference => reference}.to_json, :Authorization  => "Bearer #{@private_key}", :content_type => :json, :accept => :json
-#			unless (response.code == 200 || response.code == 201)
-#					raise PaystackServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
-#			end
-#			result = JSON.parse(response.body)
-#			unless(result['status'] != 0 )
-#				raise PaystackServerError.new(response), "Server Message: #{result['message']}"
-#			end
-#
-#		rescue JSON::ParserError => jsonerr
-#			raise PaystackServerError.new(response) , "Invalid result data. Could not parse JSON response body \n #{jsonerr.message}"
-#
-#		rescue PaystackServerError => e
-#			Utils.serverErrorHandler(e)
-#		end	
-#		return result
-#	end
-
-end
+require 'rest-client'
+require 'paystack/error.rb'
+require 'paystack/modules/api.rb'
+require 'paystack/utils/utils.rb'
+require 'paystack/objects/card.rb'
+require 'paystack/objects/customers.rb'
+require 'paystack/objects/plans.rb'
+require 'paystack/objects/subscriptions.rb'
+require 'paystack/objects/transactions.rb'
+require 'paystack/objects/banks.rb'
+require 'paystack/objects/balance.rb'
+require 'paystack/objects/settlements.rb'
+require 'paystack/objects/recipients.rb'
+require 'paystack/objects/transfers.rb'
+require 'paystack/objects/subaccounts.rb'
+
+
+class Paystack
+  attr_reader :public_key, :private_key
+
+  def initialize paystack_public_key=nil, paystack_private_key=nil
+    if (paystack_public_key.nil?)
+      @public_key = ENV['PAYSTACK_PUBLIC_KEY']
+    else
+      @public_key = paystack_public_key
+    end
+
+    if (paystack_private_key.nil?)
+      @private_key = ENV['PAYSTACK_PRIVATE_KEY']
+    else
+      @private_key = paystack_private_key
+    end
+
+    unless !@public_key.nil?
+      raise PaystackBadKeyError, "No public key supplied and couldn't find any in environment variables. Make sure to set public key as an environment variable PAYSTACK_PUBLIC_KEY"
+    end
+    unless @public_key[0..2] == 'pk_'
+      raise PaystackBadKeyError, "Invalid public key #{@public_key}"
+    end
+
+    unless !@private_key.nil?
+      raise PaystackBadKeyError, "No private key supplied and couldn't find any in environment variables. Make sure to set private key as an environment variable PAYSTACK_PRIVATE_KEY"
+    end
+    unless @private_key[0..2] == 'sk_'
+      raise PaystackBadKeyError, "Invalid private key #{@private_key}"
+    end
+  end
+
+  #TODO delete if not used
+  def setPublicKey public_key
+    @public_key = public_key
+  end
+
+  def setPrivateKey public_key
+    @public_key = public_key
+  end
+
+end

data/lib/paystack/error.rb

@@ -1,13 +1,12 @@
-
-class PaystackServerError < StandardError
-	attr_reader :response 
-	def initialize(response=nil)
-		@response = response
-	end
-end
-
-class PaystackCardError < StandardError
-end
-
-class PaystackBadKeyError < StandardError
+class PaystackServerError < StandardError
+	attr_reader :response 
+	def initialize(response=nil)
+		@response = response
+	end
+end
+
+class PaystackCardError < StandardError
+end
+
+class PaystackBadKeyError < StandardError
 end

data/lib/paystack/modules/api.rb

@@ -1,7 +1,14 @@
-module API
-	BASE_URL = "https://api.paystack.co"
-	TOKEN_URL ='https://standard.paystack.co/bosco/createmobiletoken'
-	TRANSACTION_PATH = "/transaction"
-	PLAN_PATH = "/plan"
-	CUSTOMER_PATH = "/customer"
-end
+module API
+	BASE_URL = "https://api.paystack.co"
+	TOKEN_URL ='https://standard.paystack.co/bosco/createmobiletoken'
+	TRANSACTION_PATH = "/transaction"
+	PLAN_PATH = "/plan"
+	CUSTOMER_PATH = "/customer"
+	SUBSCRIPTION_PATH = "/subscription"
+	BANK_PATH = "/bank"
+	SUBACCOUNT_PATH = "/subaccount"
+	BALANCE_PATH = "/balance"
+	RECIPIENT_PATH = "/transferrecipient"
+	TRANSFER_PATH = "/transfer"
+	SETTLEMENT_PATH = "/settlement"
+end

data/lib/paystack/objects/balance.rb

@@ -0,0 +1,12 @@
+require 'paystack/objects/base.rb'
+
+class PaystackBalance < PaystackBaseObject
+	def get
+		return PaystackBalance.get(@paystack)
+	end
+
+
+	def PaystackBalance.get(paystackObj)
+		initGetRequest(paystackObj, "#{API::BALANCE_PATH}")
+	end
+end

data/lib/paystack/objects/banks.rb

@@ -0,0 +1,12 @@
+require 'paystack/objects/base.rb'
+
+class PaystackBanks < PaystackBaseObject
+	def list(page=1)
+		return PaystackBanks.list(@paystack, page)
+	end
+
+
+	def PaystackBanks.list(paystackObj, page=1)
+		initGetRequest(paystackObj, "#{API::BANK_PATH}?page=#{page}")
+	end
+end

data/lib/paystack/objects/base.rb

@@ -1,102 +1,103 @@
-class PaystackBaseObject
-
-	attr_reader :paystack
-
-	def initialize(paystackObj)
-		unless !paystackObj.nil?
-			raise ArgumentError, "Paystack object cannot be nil!!"
-		end
-		@paystack = paystackObj
-	end
-
-	protected
-	# =>Static methods
-	def self.initGetRequest(paystackObj, url) 
-		result = nil
-		begin
-			response =  RestClient.get "#{API::BASE_URL}#{url}" , :Authorization  => "Bearer #{paystackObj.private_key}", :content_type => :json, :accept => :json
-			unless (response.code == 200 || response.code == 201)
-					raise PaystackServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
-			end
-			result = JSON.parse(response.body)
-			unless(result['status'] != 0 )
-				raise PaystackServerError.new(response), "Server Message: #{result['message']}"
-			end
-
-		rescue JSON::ParserError => jsonerr
-			raise PaystackServerError.new(response) , "Invalid result data. Could not parse JSON response body \n #{jsonerr.message}"
-
-		rescue PayStackServerError => e
-			Utils.serverErrorHandler(e)
-		end	
-		return result
-	end
-
-	def self.initPostRequest(paystackObj, url, data = {}, json=false ) 
-		result = nil
-		begin
-			if !json
-				response =  RestClient.post "#{API::BASE_URL}#{url}" , data,  :Authorization  => "Bearer #{paystackObj.private_key}"
-			else
-				response =  RestClient.post "#{API::BASE_URL}#{url}" , data.to_json,  :Authorization  => "Bearer #{paystackObj.private_key}", :content_type => :json, :accept => :json
-		
-			end
-			unless (response.code == 200 || response.code == 201)
-					raise PaystackServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
-			end
-			result = JSON.parse(response.body)
-			unless(result['status'] != 0 )
-				raise PaystackServerError.new(response), "Server Message: #{result['message']}"
-			end
-
-		rescue JSON::ParserError => jsonerr
-			raise PaystackServerError.new(response) , "Invalid result data. Could not parse JSON response body \n #{jsonerr.message}"
-
-		rescue PayStackServerError => e
-			Utils.serverErrorHandler(e)
-		end	
-		return result
-	end
-
-	def self.initPutRequest(paystackObj, url, data = {} ) 
-		result = nil
-		begin
-			response =  RestClient.put "#{API::BASE_URL}#{url}" , data,  :Authorization  => "Bearer #{paystackObj.private_key}"
-			unless (response.code == 200 || response.code == 201)
-					raise PaystackServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
-			end
-			result = JSON.parse(response.body)
-			unless(result['status'] != 0 )
-				raise PaystackServerError.new(response), "Server Message: #{result['message']}"
-			end
-
-		rescue JSON::ParserError => jsonerr
-			raise PaystackServerError.new(response) , "Invalid result data. Could not parse JSON response body \n #{jsonerr.message}"
-
-		rescue PayStackServerError => e
-			Utils.serverErrorHandler(e)
-		end	
-		return result
-	end
-
-	def self.initDeleteRequest(paystackObj, url) 
-		result = nil
-		begin
-			response =  RestClient.delete "#{API::BASE_URL}#{url}" ,  :Authorization  => "Bearer #{paystackObj.private_key}"
-			unless (response.code == 200 || response.code == 201)
-					raise PaystackServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
-			end
-			result = JSON.parse(response.body)
-			unless(result['status'] != 0 )
-				raise PaystackServerError.new(response), "Server Message: #{result['message']}"
-			end
-
-		rescue JSON::ParserError => jsonerr
-			raise PaystackServerError.new(response) , "Invalid result data. Could not parse JSON response body \n #{jsonerr.message}"
-
-		rescue PayStackServerError => e
-			Utils.serverErrorHandler(e)
-		end	
-		return result
-	end
-end
+class PaystackBaseObject
+	require 'json'
+
+	attr_reader :paystack
+
+	def initialize(paystackObj)
+		unless !paystackObj.nil?
+			raise ArgumentError, "Paystack object cannot be nil!!"
+		end
+		@paystack = paystackObj
+	end
+
+	protected
+	# =>Static methods
+	def self.initGetRequest(paystackObj, url) 
+		result = nil
+		begin
+			response = RestClient.get "#{API::BASE_URL}#{url}" , :Authorization  => "Bearer #{paystackObj.private_key}", :content_type => :json, :accept => :json
+			unless (response.code == 200 || response.code == 201)
+					raise PaystackServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
+			end
+			result = JSON.parse(response.body)
+			unless(result['status'] != 0 )
+				raise PaystackServerError.new(response), "Server Message: #{result['message']}"
+			end
+
+		rescue JSON::ParserError => jsonerr
+			raise PaystackServerError.new(response) , "Invalid result data. Could not parse JSON response body \n #{jsonerr.message}"
+
+		rescue PaystackServerError => e
+			Utils.serverErrorHandler(e)
+		end	
+		return result
+	end
+
+	def self.initPostRequest(paystackObj, url, data = {}, json=false ) 
+		result = nil
+    begin
+			if !json
+				response =  RestClient.post "#{API::BASE_URL}#{url}" , data,  :authorization  => "Bearer #{paystackObj.private_key}"
+			else
+				response =  RestClient.post "#{API::BASE_URL}#{url}" , data.to_json,  :authorization  => "Bearer #{paystackObj.private_key}", :content_type => :json, :accept => :json
+		
+			end
+			unless (response.code == 200 || response.code == 201)
+					raise PaystackServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
+			end
+			result = JSON.parse(response.body)
+			unless(result['status'] != 0 )
+				raise PaystackServerError.new(response), "Server Message: #{result['message']}"
+			end
+
+		rescue JSON::ParserError => jsonerr
+			raise PaystackServerError.new(response) , "Invalid result data. Could not parse JSON response body \n #{jsonerr.message}"
+
+		rescue PaystackServerError => e
+			Utils.serverErrorHandler(e)
+		end	
+		return result
+	end
+
+	def self.initPutRequest(paystackObj, url, data = {} ) 
+		result = nil
+		begin
+			response =  RestClient.put "#{API::BASE_URL}#{url}" , data,  :Authorization  => "Bearer #{paystackObj.private_key}"
+			unless (response.code == 200 || response.code == 201)
+					raise PaystackServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
+			end
+			result = JSON.parse(response.body)
+			unless(result['status'] != 0 )
+				raise PaystackServerError.new(response), "Server Message: #{result['message']}"
+			end
+
+		rescue JSON::ParserError => jsonerr
+			raise PaystackServerError.new(response) , "Invalid result data. Could not parse JSON response body \n #{jsonerr.message}"
+
+		rescue PaystackServerError => e
+			Utils.serverErrorHandler(e)
+		end	
+		return result
+	end
+
+	def self.initDeleteRequest(paystackObj, url) 
+		result = nil
+		begin
+			response =  RestClient.delete "#{API::BASE_URL}#{url}" ,  :Authorization  => "Bearer #{paystackObj.private_key}"
+			unless (response.code == 200 || response.code == 201)
+					raise PaystackServerError.new(response), "HTTP Code #{response.code}: #{response.body}"
+			end
+			result = JSON.parse(response.body)
+			unless(result['status'] != 0 )
+				raise PaystackServerError.new(response), "Server Message: #{result['message']}"
+			end
+
+		rescue JSON::ParserError => jsonerr
+			raise PaystackServerError.new(response) , "Invalid result data. Could not parse JSON response body \n #{jsonerr.message}"
+
+		rescue PaystackServerError => e
+			Utils.serverErrorHandler(e)
+		end	
+		return result
+	end
+end

data/lib/paystack/objects/card.rb

@@ -1,106 +1,106 @@
-require 'paystack/utils/utils.rb'
-
-class PaystackCard
-	attr_reader :name, :number,:cvc,:expiryMonth,:expiryYear, :addressLine1,:addressLine2, :addressLine3, :addressLine4, :addressCountry, :addressPostalCode, :email, :cardCountry, :cardIssuer
-
-	MAX_DINERS_CARD_LENGTH  = 14
-	MAX_AMERICAN_EXPRESS_CARD_LENGTH  = 15
-	MAX_NORMAL_CARD_LENGTH  = 16
-
-	PATTERN_VISA = /^4[0-9]{6,}$/                             
-	PATTERN_MASTERCARD = /^5[1-5][0-9]{5,}$/                  
-	PATTERN_AMERICAN_EXPRESS = /^3[47][0-9]{5,}$/             
-	PATTERN_DINERS_CLUB = /^3(?:0[0-5]|[68][0-9])[0-9]{4,}$/ 
-	PATTERN_DISCOVER = /^6(?:011|5[0-9]{2})[0-9]{3,}$/       
-	PATTERN_JCB = /^(?:2131|1800|35[0-9]{3})[0-9]{3,}/       
-	
-	def initialize(args = {})
-		@name = Utils.nullifyString(args[:name])
-		@number = Utils.nullifyString(args[:number])
-		@cvc = Utils.nullifyString(args[:cvc])
-		@expiryMonth =  Utils.nullifyString(args[:expiryMonth])
-		@expiryYear = Utils.nullifyString(args[:expiryYear])
-		@cardIssuer = PaystackCard.getCardType(@number)
-	end
-
-	def isValidCard()
-    	if (@cvc != nil) 
-      		return isValidNumber() && isValidExpiryDate() && isValidCVC()
-    	else 
-      		return isValidNumber() && isValidExpiryDate()
-      	end
-    
-	end
-
-	def PaystackCard.getCardType(number)
-		if(number == nil)
-			return 'invalid'
-		end
-		if(number =~ PATTERN_VISA) != nil
-			return 'visa'
-		end
-
-		if(number =~ PATTERN_MASTERCARD) != nil
-			return 'mastercard'
-		end
-
-		if(number =~ PATTERN_AMERICAN_EXPRESS) != nil
-			return 'american_express'
-		end
-
-		if(number =~ PATTERN_DINERS_CLUB)
-			return 'diners'
-		end
-		if(number =~ PATTERN_DISCOVER)
-			return 'discover'
-		end
-		if(number =~ PATTERN_JCB)
-			return 'jcb'
-		end
-		return 'unknown'		
-	end
-
-
-
-
-	
-
-	def isValidNumber
-		if(Utils.isEmpty(@number)) 
-			return false
-		end
-		formatted_number = @number.gsub(/\s+|-/) {|s| '' }.strip
-		
-		if(Utils.isEmpty(formatted_number) || !Utils.isWholePositiveNumber(formatted_number) || !Utils.isLuthValidNumber(formatted_number))
-	
-			return false
-		end
-		if PaystackCard.getCardType(formatted_number).eql?('diners') 
-			return (formatted_number.length == MAX_DINERS_CARD_LENGTH)
-		end
-
-		if PaystackCard.getCardType(formatted_number).eql?('american_express') 
-			return (formatted_number.length == MAX_AMERICAN_EXPRESS_CARD_LENGTH)
-		end
-
-		return (formatted_number.length == MAX_NORMAL_CARD_LENGTH)
-
-	end
-
-	def isValidCVC
-		if(@cvc.eql?(""))
-			return false
-		end
-		cvc = @cvc.strip
-		cvc_len = cvc.length
-
-		validLength = ((cvc_len >= 3 && cvc_len <= 4) || (@cardIssuer.eql?('american_express') && cvc_len == 4) ||(!@cardIssuer.eql?('american_express') && cvc_len == 3))
-
-	end
-
-	def isValidExpiryDate()
-		return !(@expiryMonth == nil || @expiryYear == nil) && Utils.hasCardExpired(@expiryYear, @expiryMonth);
-	end
-
-
+require 'paystack/utils/utils.rb'
+
+class PaystackCard
+	attr_reader :name, :number,:cvc,:expiryMonth,:expiryYear, :addressLine1,:addressLine2, :addressLine3, :addressLine4, :addressCountry, :addressPostalCode, :email, :cardCountry, :cardIssuer
+
+	MAX_DINERS_CARD_LENGTH  = 14
+	MAX_AMERICAN_EXPRESS_CARD_LENGTH  = 15
+	MAX_NORMAL_CARD_LENGTH  = 16
+
+	PATTERN_VISA = /^4[0-9]{6,}$/                             
+	PATTERN_MASTERCARD = /^5[1-5][0-9]{5,}$/                  
+	PATTERN_AMERICAN_EXPRESS = /^3[47][0-9]{5,}$/             
+	PATTERN_DINERS_CLUB = /^3(?:0[0-5]|[68][0-9])[0-9]{4,}$/ 
+	PATTERN_DISCOVER = /^6(?:011|5[0-9]{2})[0-9]{3,}$/       
+	PATTERN_JCB = /^(?:2131|1800|35[0-9]{3})[0-9]{3,}/       
+	
+	def initialize(args = {})
+		@name = Utils.nullifyString(args[:name])
+		@number = Utils.nullifyString(args[:number])
+		@cvc = Utils.nullifyString(args[:cvc])
+		@expiryMonth =  Utils.nullifyString(args[:expiryMonth])
+		@expiryYear = Utils.nullifyString(args[:expiryYear])
+		@cardIssuer = PaystackCard.getCardType(@number)
+	end
+
+	def isValidCard()
+    	if (@cvc != nil) 
+      		return isValidNumber() && isValidExpiryDate() && isValidCVC()
+    	else 
+      		return isValidNumber() && isValidExpiryDate()
+      	end
+    
+	end
+
+	def PaystackCard.getCardType(number)
+		if(number == nil)
+			return 'invalid'
+		end
+		if(number =~ PATTERN_VISA) != nil
+			return 'visa'
+		end
+
+		if(number =~ PATTERN_MASTERCARD) != nil
+			return 'mastercard'
+		end
+
+		if(number =~ PATTERN_AMERICAN_EXPRESS) != nil
+			return 'american_express'
+		end
+
+		if(number =~ PATTERN_DINERS_CLUB)
+			return 'diners'
+		end
+		if(number =~ PATTERN_DISCOVER)
+			return 'discover'
+		end
+		if(number =~ PATTERN_JCB)
+			return 'jcb'
+		end
+		return 'unknown'		
+	end
+
+
+
+
+	
+
+	def isValidNumber
+		if(Utils.isEmpty(@number)) 
+			return false
+		end
+		formatted_number = @number.gsub(/\s+|-/) {|s| '' }.strip
+		
+		if(Utils.isEmpty(formatted_number) || !Utils.isWholePositiveNumber(formatted_number) || !Utils.isLuhnValidNumber(formatted_number))
+	
+			return false
+		end
+		if PaystackCard.getCardType(formatted_number).eql?('diners') 
+			return (formatted_number.length == MAX_DINERS_CARD_LENGTH)
+		end
+
+		if PaystackCard.getCardType(formatted_number).eql?('american_express') 
+			return (formatted_number.length == MAX_AMERICAN_EXPRESS_CARD_LENGTH)
+		end
+
+		return (formatted_number.length == MAX_NORMAL_CARD_LENGTH)
+
+	end
+
+	def isValidCVC
+		if(@cvc.eql?(""))
+			return false
+		end
+		cvc = @cvc.strip
+		cvc_len = cvc.length
+
+		validLength = ((cvc_len >= 3 && cvc_len <= 4) || (@cardIssuer.eql?('american_express') && cvc_len == 4) ||(!@cardIssuer.eql?('american_express') && cvc_len == 3))
+
+	end
+
+	def isValidExpiryDate()
+		return !(@expiryMonth == nil || @expiryYear == nil) && Utils.hasCardExpired(@expiryYear, @expiryMonth);
+	end
+
+
 end