paystack 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb366e37dbe506cf360fd40f6cb062d666ea7f2a
-  data.tar.gz: 9dc2efb61e565d8b186bfb475e5c04fd8ff97b5f
+  metadata.gz: ca84ed9325f45d81dc3f39a20e84e36e22c90508
+  data.tar.gz: 4452868879b2ce83f18a7527b9a42c2f6521ec8a
 SHA512:
-  metadata.gz: 5680617e95a07aa69db0285af5022a10f90ade70dd64eb6a33f3d98616d2ca7292b3a5bf7bbead4bde8a62f5d26104e26db9e2ffb7f1b87add86c9bbbfc76b5f
-  data.tar.gz: cc8141ba0e7c4ea5e97de5fb1f869acd0bde317a1c0bb2a49d70490809890bf80bdc881305d280e1220237c534b76f471002d930a41185db7b7b9d4a81d558d6
+  metadata.gz: b28d0e7368e94554f9b475ee99c4958e73ecf7e2b935dba844de895de44061684aa82cc2b9bf7306af0f075f3e5c2849b5b2ba747107003a380415504c09bfeb
+  data.tar.gz: 47742d3ea7681517f016445cdd355700817232f92f37333515e29b0d48783e2c13290a9bc0ba8ce791a047b18c4dfb8420a10bd98e98750b87f3cc22aa9bac10

data/README.md

@@ -44,7 +44,7 @@ It throws a `PaystackBadKeyError` when either of the keys are invalid or cannot
 
 
 
-### Initialize transaction and get Authorization URL 
+### Initialize transaction and get Authorization URL
 
 ```ruby
 
@@ -84,7 +84,7 @@ NOTE: Amount is in kobo i.e. `100000 = 100000 kobo = 1000 naira`
 
 	page_number = 1
 	transactions = PaystackTransactions.new(paystackObj)
-	result = transactions.list(page_number) 	#Optional `page_number` parameter 
+	result = transactions.list(page_number) 	#Optional `page_number` parameter
 
 ```
 
@@ -94,7 +94,7 @@ NOTE: Amount is in kobo i.e. `100000 = 100000 kobo = 1000 naira`
 
 	transaction_id = "123456778"
 	transactions = PaystackTransactions.new(paystackObj)
-	result = transactions.get(transaction_id) 
+	result = transactions.get(transaction_id)
 
 ```
 
@@ -104,7 +104,7 @@ NOTE: Amount is in kobo i.e. `100000 = 100000 kobo = 1000 naira`
 
 	transaction_reference = "blablablabla-YOUR-VALID-UNIQUE-REFERENCE-HERE"
 	transactions = PaystackTransactions.new(paystackObj)
-	result = transactions.verify(transaction_reference) 
+	result = transactions.verify(transaction_reference)
 
 ```
 
@@ -114,7 +114,7 @@ NOTE: Amount is in kobo i.e. `100000 = 100000 kobo = 1000 naira`
 ```ruby
 
 	transactions = PaystackTransactions.new(paystackObj)
-	result = transactions.totals() 
+	result = transactions.totals()
 
 ```
 
@@ -128,7 +128,7 @@ NOTE: Amount is in kobo i.e. `100000 = 100000 kobo = 1000 naira`
 
 	page_number = 1
 	customers = PaystackCustomers.new(paystackObj)
-	result = customers.list(page_number) 	#Optional `page_number` parameter,  50 items per page 
+	result = customers.list(page_number) 	#Optional `page_number` parameter,  50 items per page
 	customers_list = result['data']
 
 ```
@@ -139,7 +139,7 @@ NOTE: Amount is in kobo i.e. `100000 = 100000 kobo = 1000 naira`
 
 	customer_id = "123456778"
 	customers = PaystackCustomers.new(paystackObj)
-	result = customers.get(customer_id) 
+	result = customers.get(customer_id)
 	customer =  result['data']
 
 ```
@@ -169,7 +169,7 @@ NOTE: Amount is in kobo i.e. `100000 = 100000 kobo = 1000 naira`
 		customer_id,
 		:last_name => "Ikorodu",
 		:email => "xxxxx-modified@gmail.com"
-	) 
+	)
 
 ```
 
@@ -181,7 +181,7 @@ NOTE: Amount is in kobo i.e. `100000 = 100000 kobo = 1000 naira`
 
 	page_number = 1
 	plans = PaystackPlans.new(paystackObj)
-	result = plans.list(page_number) 	#Optional `page_number` parameter,  50 items per page 
+	result = plans.list(page_number) 	#Optional `page_number` parameter,  50 items per page
 	plans_list = result['data']
 
 ```
@@ -192,12 +192,12 @@ NOTE: Amount is in kobo i.e. `100000 = 100000 kobo = 1000 naira`
 
 	plan_id = "123456778"
 	plans = PaystackPlans.new(paystackObj)
-	result = plans.get(plan_id) 
+	result = plans.get(plan_id)
 	plan =  result['data']
 
 ```
 
-### Create new plan 
+### Create new plan
 
 ```ruby
 
@@ -205,9 +205,9 @@ NOTE: Amount is in kobo i.e. `100000 = 100000 kobo = 1000 naira`
 	result = plans.create(
 
 				:name => "Test Plan",
-				:description => "Dev Test Plan", 
+				:description => "Dev Test Plan",
 				:amount => 30000, #in KOBO
-				:interval => "monthly", #monthly, yearly, quarterly, weekly etc 
+				:interval => "monthly", #monthly, yearly, quarterly, weekly etc
 				:currency => "NGN"
 			)
 
@@ -217,13 +217,13 @@ NOTE: Amount is in kobo i.e. `100000 = 100000 kobo = 1000 naira`
 
 ```ruby
 
-	plan_id = ""123456778"
+	plan_id = "123456778"
 	plans = PaystackPlans.new(paystackObj)
 	result = plans.update(
 			plan_id,
 			:name => "Test Plan Updated",
 			:amount => 500000, #in KOBO
-			:interval => "weekly" 
+			:interval => "weekly"
 			)
 
 ```
@@ -231,7 +231,7 @@ NOTE: Amount is in kobo i.e. `100000 = 100000 kobo = 1000 naira`
 
 ## Subscriptions
 
-### Create new subscription 
+### Create new subscription
 
 ```ruby
 
@@ -248,10 +248,10 @@ NOTE: Amount is in kobo i.e. `100000 = 100000 kobo = 1000 naira`
 ### Get subscription detail
 
 ```ruby
-	
+
 	subscription_id = "123456778"
 	subscriptions = PaystackSubscriptions.new(paystackObj)
-	result = subscriptions.get(subscription_id) 
+	result = subscriptions.get(subscription_id)
 	subscription =  result['data']
 
 ```
@@ -281,8 +281,229 @@ NOTE: Amount is in kobo i.e. `100000 = 100000 kobo = 1000 naira`
 ```
 
 
+## Split Payments
+
+This Gem is also aware of the API calls that allow you to perform split payments on Paystack. The [Paystack documentation on split payments](https://developers.paystack.co/docs/split-payments-overview) can get you started. Below are some sample calls for [subaccounts](https://developers.paystack.co/docs/create-subaccount) and [banks](https://developers.paystack.co/docs/list-banks).
+
+## Banks
+
+### List Banks
+
+```ruby
+
+	page_number = 1
+	banks = PaystackBanks.new(paystackObj)
+	result = banks.list(page_number) 	#Optional `page_number` parameter,  50 items per page
+	banks_list = result['data']
+
+```
+
+## Subaccounts
+
+### List Subaccounts
+
+```ruby
+
+	page_number = 1
+	subaccounts = PaystackSubaccounts.new(paystackObj)
+	result = subaccounts.list(page_number) 	#Optional `page_number` parameter,  50 items per page
+	subaccounts_list = result['data']
+
+```
+
+### Get a subaccount
+
+```ruby
+
+	subaccount_id = "123456778"
+	subaccounts = PaystackSubaccounts.new(paystackObj)
+	result = subaccounts.get(subaccount_id)
+	subaccount =  result['data']
+
+```
+
+### Create new subaccount
+
+```ruby
+
+	subaccounts = PaystackSubaccounts.new(paystackObj)
+	result = subaccounts.create(
+		:business_name => "Madam Ikoro Holdings",
+		:settlement_bank => "Providus Bank",
+		:account_number => "1170766666"
+		:percentage_charge => 3.2
+	)
+
+```
+
+### Update subaccount details
+
+```ruby
+
+	subaccount_id = "123456778"
+	subaccounts = PaystackSubaccounts.new(paystackObj)
+	# Updating primary contact name and email of subaccount
+	result = subaccounts.update(
+		subaccount_id,
+		:primary_contact_name => "Victoria Ikorodu",
+		:primary_contact_email => "xxxxx-modified@gmail.com"
+	)
+
+```
+
+## Settlements  
+Fetch settlements made to your bank accounts and the bank accounts for your subaccounts
+
+### List settlements
+
+```ruby
+
+	settlements = PaystackSettlements.new(paystackObj)
+	results = settlements.list
+	settlements_list = result['data']
+
+```
+
+## Transfers
+
+The funds transfers feature enables you send money directly from your paystack balance to any Nigerian Bank account. The [Paystack documentation on transfers](https://developers.paystack.co/docs/funds_transfers) can get you started. 
+
+## Balance
+
+### Check Paystack Balance
+
+```ruby
+	
+	balance = PaystackBalance.new(paystackObj)
+	result = balance.get 	
+	account_balance = result['data']
+
+```
+
+## Transfers
+
+### Initialize a transfer
+
+```ruby
+	
+	transfer = PaystackTransfers.new(paystackObj)
+	results = transfers.initializeTransfer(
+		:source => "balance", # Must be balance
+		:reason => "Your reason",
+		:amount => 30000, # Amount in kobo
+		:recipient =>  recipient_code, # Unique recipient code
+		)
+
+```
+
+### List transfers
+
+```ruby
+
+	page_number = 1
+	transactions = PaystackTransfers.new(paystackObj)
+	result = transfers.list(page_number) 	#Optional `page_number` parameter
+
+```
+
+### Get a transfer
+
+```ruby
+
+	transfer_code = "TRF_uniquecode"
+	transactions = PaystackTransfers.new(paystackObj)
+	result = transactions.get(transaction_code)
+
+```
+
+### Finalize a transfer
+
+```ruby
+	
+	transfer = PaystackTransfers.new(paystackObj)
+	results = transfer.authorize(
+		:transfer_code => "TRF_blablabla", # Must be balance
+		:otp => "12350",
+		)
+
+```
+
+
+## Transfer Recipients
+
+### Create new recipient
+
+```ruby
+
+	recipient = PaystackRecipients.new(paystackObj)
+	result = recipients.create(
+		:type => "nuban", #Must be nuban
+		:name => "Test Plan",
+		:description => "Bla-bla-bla", 
+		:account_number => 0123456789, #10 digit account number
+		:bank_code => "044", #monthly, yearly, quarterly, weekly etc 
+		:currency => "NGN",
+
+	)
+	
+```
+
+### List transfer recipients
+
+```ruby
+	page_number = 1
+	recipients = PaystackRecipients.new(paystackObj)
+	result = recipients.list(page_number) #Optional `page_number` parameter,  50 items per page
+	recipients_list =  result['data']
+
+```
+
+## Transfer Control
+
+### Resend OTP
+
+```ruby
+	transfer_code = "TRF_asdfghjkl"	#A unique Transfer code is generated when transfer is created
+	transfer = PaystackTransfers.new(paystackObj)
+	result = transfer.resendOtp(transfer_code) 	
+	
+
+```
+
+### Disable OTP for transfers
+
+```ruby
+
+	transfer = PaystackTransfers.new(paystackObj)
+	result = transfer.disableOtp  
+	#OTP is sent to the registered phone number of the account
+
+```
+
+### Confirm disabling of OTP for transfers
+
+```ruby
+
+	otp = "12345"
+	transfer = PaystackTransfers.new(paystackObj)
+	# Updating primary contact name and email of subaccount
+	result = transfer.confirmDisableOtp(
+		:otp => otp, #Must be valid OTP sent to the registered phone number
+	)
+
+```
+
+### Enable OTP for transfers
+
+```ruby
+
+	transfer = PaystackTransfers.new(paystackObj)
+	result = transfer.enableOtp
+
+```
+
 ## Static methods
-`PaystackTransactions`, `PaystackCustomers`, `PaystackPlans` and `PaystackSubscriptions` methods can be called statically, You just need to pass the paystack object as the first parameter  e.g. `verify` method in `PaystackTransactions` can be called like this
+`PaystackTransactions`, `PaystackCustomers`, `PaystackPlans`, `PaystackSubaccounts`, `PaystackBanks` , `PaystackSubscriptions` , `PaystackSettlements`, `PaystackBalance`, and `PaystackTransfers` methods can be called statically, You just need to pass the paystack object as the first parameter  e.g. `verify` method in `PaystackTransactions` can be called like this
 
 
 ```ruby
@@ -304,4 +525,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/IkoroV
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/paystack.rb

@@ -8,6 +8,10 @@ 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'
 
 
 class Paystack
@@ -39,8 +43,6 @@ class Paystack
     unless @private_key[0..2] == 'sk_'
       raise PaystackBadKeyError, "Invalid private key #{@private_key}"
     end
-
-
   end
 
   #TODO delete if not used

data/lib/paystack/modules/api.rb

@@ -7,4 +7,8 @@ module API
 	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/recipients.rb

@@ -0,0 +1,26 @@
+require 'paystack/objects/base.rb'
+
+
+class PaystackRecipients < PaystackBaseObject
+
+  def create(data={})
+    return PaystackRecipients.create(@paystack, data)
+  end
+
+  def list(page=1)
+    return PaystackRecipients.list(@paystack, page)
+  end
+
+
+  def PaystackRecipients.create(paystackObj, data={})
+    initPostRequest(paystackObj, "#{API::RECIPIENT_PATH}", data, true)
+  end
+
+  def PaystackRecipients.list(paystackObj, page=1)
+    initGetRequest(paystackObj, "#{API::RECIPIENT_PATH}/?page=#{page}")
+  end
+
+
+
+
+end

data/lib/paystack/objects/settlements.rb

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

data/lib/paystack/objects/transfers.rb

@@ -0,0 +1,75 @@
+require 'paystack/objects/base.rb'
+
+class PaystackTransfers < PaystackBaseObject
+	
+	def initializeTransfer(args={})
+		return PaystackTransfers.initializeTransfer(@paystack, args)
+	end
+
+	def list(page=1)
+		return PaystackTransfers.list(@paystack, page)
+	end
+
+	def get(transfer_code)
+		return PaystackTransfers.get(@paystack, transfer_code)
+	end
+
+	def authorize(data={})
+		return PaystackTransfers.authorize(@paystack,data)
+	end
+
+	def  resendOtp(data={})
+		return PaystackTransfers.resendOtp(@paystack,data)
+	end
+
+	def  disableOtp 
+		return PaystackTransfers.disableOtp(@paystack)
+	end
+
+	def  confirmDisableOtp(data={})
+		return PaystackTransfers.confirmDisableOTP(@paystack,otp)
+	end
+
+	def  enableOtp 
+		return PaystackTransfers.enableOtp(@paystack)
+	end
+
+# => Public Static methods
+
+	def PaystackTransfers.initializeTransfer(paystackObj, args)
+		initPostRequest(paystackObj,"#{API::TRANSFER_PATH}", args,true)
+	end
+
+	def PaystackTransfers.list(paystackObj, page=1)		
+		initGetRequest(paystackObj, "#{API::TRANSFER_PATH}?page=#{page}")
+	end
+
+	def PaystackTransfers.get(paystackObj, transfer_code)
+	 	initGetRequest(paystackObj, "#{API::TRANSFER_PATH}/#{transfer_code}")
+	end
+
+	def PaystackTransfers.authorize(paystackObj, data={})
+		initPostRequest(paystackObj, "#{API::TRANSFER_PATH}/finalize_transfer/",data)
+	end
+
+	def PaystackTransfers.resendOtp(paystackObj, data={})
+		initPostRequest(paystackObj, "#{API::TRANSFER_PATH}/resend_otp",data)
+	end
+
+	def PaystackTransfers.disableOtp(paystackObj)
+		initPostRequest(paystackObj, "#{API::TRANSFER_PATH}/disable_otp")
+	end
+
+	def PaystackTransfers.confirmDisableOtp(paystackObj, data={})
+		initPostRequest(paystackObj, "#{API::TRANSFER_PATH}/disable_otp_finalize",data)
+	end
+
+	def PaystackTransfers.enableOtp(paystackObj)
+		initPostRequest(paystackObj, "#{API::TRANSFER_PATH}/enable_otp")
+	end
+
+
+
+ 
+
+end

data/lib/paystack/version.rb

@@ -1,3 +1,3 @@
-module Paystack
-  VERSION = "0.1.6"
+class Paystack
+  VERSION = "0.1.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paystack
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Victor Ikoro
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-11-01 00:00:00.000000000 Z
+date: 2017-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,14 +86,18 @@ files:
 - lib/paystack.rb
 - lib/paystack/error.rb
 - lib/paystack/modules/api.rb
+- lib/paystack/objects/balance.rb
 - lib/paystack/objects/banks.rb
 - lib/paystack/objects/base.rb
 - lib/paystack/objects/card.rb
 - lib/paystack/objects/customers.rb
 - lib/paystack/objects/plans.rb
+- lib/paystack/objects/recipients.rb
+- lib/paystack/objects/settlements.rb
 - lib/paystack/objects/subaccounts.rb
 - lib/paystack/objects/subscriptions.rb
 - lib/paystack/objects/transactions.rb
+- lib/paystack/objects/transfers.rb
 - lib/paystack/utils/utils.rb
 - lib/paystack/version.rb
 - paystack.gemspec
@@ -117,7 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: PayStack.co gem for Ruby/Rails