paystack 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a22c58ec712f84b5c59aa43d00230bda7da22145
-  data.tar.gz: 5c4d10c1e8996380371eef9d43fa56041fb19b55
+  metadata.gz: 2bfffac1071ccab650bec0e73af7b5caf8ff6f57
+  data.tar.gz: 5c8125e3f70f8321fc66c5d5adeb758c8cad6368
 SHA512:
-  metadata.gz: 9d00658143c04a14ae00a049f241ab268dfe06935a0bc571776c08074cc8a7401afbb39e5ab7f2b09601fe7cd33d16752fce67d08de1aca360bc25f55a1d442d
-  data.tar.gz: f6e94b694b8a998e10c85c960ad94dcf9116507cb2af8a9cb780589f159fb319a8864bfc8d674991f82bf1f2d5173bf2241eb61049742db40fd03a55eed9bd7d
+  metadata.gz: 7d2e673cb05a9bd987450e392138af759619b9e855b56c419d9672bb9855ac5b1dc56af7ff99c877c4ced46c45b38021d2da81ed7ad1c124a00e125e2ebbdd71
+  data.tar.gz: de3ec225ab575e393e03739a916c1b6ed5d32d1d2cebfb9f24f4f30dfba489c0f798ca8004c6604c469befcd8ed5c5630e233b681e7d25da135578103491ad1a

data/README.md

@@ -1,11 +1,8 @@
 # Paystack
 
 
-A ruby gem for easy integration of Paystack with your Ruby / Rails application. 
+A ruby gem for easy integration of [Paystack](https://paystack.co/).
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/paystack`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -23,25 +20,30 @@ Or install it yourself as:
 
     $ gem install paystack
 
-## Usage
+## Basic Usage
 
-### 1. Instantiate Paystack Object
 
-    paystack = Paystack.new(public_key, secret_key)
 
-A more secure way is to set your public and private keys as environmental variables `PAYSTACK_PUBLIC_KEY` and `PAYSTACK_PRIVATE_KEY` respectively. Then you instantiate without parameters
+### Instantiate Paystack Object
 
 ```ruby
 
-	paystack =  Paystack.new
+    paystackObj = Paystack.new(public_key, secret_key)
 
 ```
 
-Methods available in the Paystack class include
+A secure way is to set your public and private keys as environmental variables `PAYSTACK_PUBLIC_KEY` and `PAYSTACK_PRIVATE_KEY` respectively. Then you instantiate without parameters
+
+```ruby
 
+	paystackObj =  Paystack.new
 
+```
+It throws a `PaystackBadKeyError` when either of the keys are invalid or cannot be found as environment variables.
 
-### 2. Instantiate a Card object
+
+
+### Instantiate a Card object
 
 ```ruby
 	card = new PaystackCard(
@@ -50,16 +52,213 @@ Methods available in the Paystack class include
 		:expiryMonth => "07",
 		:expiryYear => "19"
 		)
+
+	isvalid = card.isValidCard
+```
+The `isValidCard` method determines validity of the card i.e. Expiry status, Luhn checksum validity etc.
+All card values/fields should be String literals.
+
+
+
+### Initialize transaction and get Authorization URL 
+
+```ruby
+
+	transactions = PaystackTransactions.new(paystackObj)
+	result = transactions.initializeTransaction(
+		:reference => "blablablabla-YOUR-UNIQUE-REFERENCE-HERE",
+		:amount => 300000,
+		:email => "xxxxxx@gmail.com",
+		)
+	auth_url = results['data']['authorization_url']
+```
+NOTE: Amount is in kobo i.e. `100000 = 100000 kobo = 1000 naira`
+
+
+
+### Charge using Authorization code for returning customers
+
+```ruby
+
+	result = transactions.chargeAuthorization(
+		"WwdkojpoAJo", 				# Authorization code
+		"xxxxxx@gmail.com", 		# Customer email
+		2000000, 					# Amount
+		:reference => "blablablabla-YOUR-UNIQUE-REFERENCE-HERE"
+		)
+```
+
+
+
+## Transactions
+
+
+
+### List transactions
+
+```ruby
+
+	page_number = 1
+	transactions = PaystackTransactions.new(paystackObj)
+	result = transactions.list(page_number) 	#Optional `page_number` parameter 
+
+```
+
+### Get a transaction
+
+```ruby
+
+	transaction_id = ""123456778""
+	transactions = PaystackTransactions.new(paystackObj)
+	result = transactions.get(transaction_id) 
+
+```
+
+### Verify a transaction
+
+```ruby
+
+	transaction_reference = "blablablabla-YOUR-VALID-UNIQUE-REFERENCE-HERE"
+	transactions = PaystackTransactions.new(paystackObj)
+	result = transactions.verify(transaction_reference) 
+
+```
+
+
+### Get transaction totals
+
+```ruby
+
+	transactions = PaystackTransactions.new(paystackObj)
+	result = transactions.totals() 
+
 ```
 
 
+## Customers
 
 
-## Development
+### List Customers
+
+```ruby
+
+	page_number = 1
+	customers = PaystackCustomers.new(paystackObj)
+	result = customers.list(page_number) 	#Optional `page_number` parameter,  50 items per page 
+	customers_list = result['data']
+
+```
+
+### Get a customer
+
+```ruby
+
+	customer_id = "123456778"
+	customers = PaystackCustomers.new(paystackObj)
+	result = customers.get(customer_id) 
+	customer =  result['data']
+
+```
+
+### Create new customer
+
+```ruby
+
+	customers = PaystackCustomers.new(paystackObj)
+	result = customers.create(
+		:first_name => "Victor",
+		:last_name => "Ikoro",
+		:phone => "+234707666669"
+		:email => "xxxxx@gmail.com"
+	)
+
+```
+
+### Update customer details
+
+```ruby
+
+	customer_id = "123456778"
+	customers = PaystackCustomers.new(paystackObj)
+	# Updating last name and email of customer
+	result = customers.update(
+		customer_id,
+		:last_name => "Ikorodu",
+		:email => "xxxxx-modified@gmail.com"
+	) 
+
+```
+
+## Plans
+
+### List Plans
+
+```ruby
+
+	page_number = 1
+	plans = PaystackPlans.new(paystackObj)
+	result = plans.list(page_number) 	#Optional `page_number` parameter,  50 items per page 
+	plans_list = result['data']
+
+```
+
+### Get plan detail
+
+```ruby
+
+	plan_id = "123456778"
+	plans = PaystackPlans.new(paystackObj)
+	result = plans.get(plan_id) 
+	plan =  result['data']
+
+```
+
+### Create new plan 
+
+```ruby
+
+	plans = PaystackPlans.new(paystackObj)
+	result = plans.create(
+
+				:name => "Test Plan",
+				:description => "Dev Test Plan", 
+				:amount => 30000, #in KOBO
+				:interval => "monthly", #monthly, yearly, quarterly, weekly etc 
+				:currency => "NGN"
+			)
+
+```
+
+### Update plan details
+
+```ruby
+
+	plan_id = ""123456778""
+	plans = PaystackPlans.new(paystackObj)
+	result = plans.update(
+			plan_id,
+			:name => "Test Plan Updated",
+			:amount => 500000, #in KOBO
+			:interval => "weekly" 
+			)
+
+```
+
+
+## Static methods
+`PaystackTransactions`, `PaystackCustomers` and `PaystackPlans` 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
+
+	transaction_reference = "blablablabla-YOUR-VALID-UNIQUE-REFERENCE-HERE"
+	result = PaystackTransactions.verify(paystackObj, transaction_reference)
+	puts result['message']
+
+```
+
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/lib/paystack.rb

@@ -1,8 +1,7 @@
 require 'rest-client'
-require 'paystack/modules/tokenmanager.rb'
 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'
@@ -43,9 +42,6 @@ class Paystack
 
 	end
 
-	def getToken card
-		return TokenManager.create(card, @public_key)
-	end
 
 	def setPublicKey public_key
 		@public_key = public_key
@@ -55,30 +51,4 @@ class Paystack
 		@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

data/lib/paystack/objects/base.rb

@@ -26,7 +26,7 @@ class PaystackBaseObject
 		rescue JSON::ParserError => jsonerr
 			raise PaystackServerError.new(response) , "Invalid result data. Could not parse JSON response body \n #{jsonerr.message}"
 
-		rescue PayStackServerError => e
+		rescue PaystackServerError => e
 			Utils.serverErrorHandler(e)
 		end	
 		return result
@@ -52,7 +52,7 @@ class PaystackBaseObject
 		rescue JSON::ParserError => jsonerr
 			raise PaystackServerError.new(response) , "Invalid result data. Could not parse JSON response body \n #{jsonerr.message}"
 
-		rescue PayStackServerError => e
+		rescue PaystackServerError => e
 			Utils.serverErrorHandler(e)
 		end	
 		return result
@@ -73,7 +73,7 @@ class PaystackBaseObject
 		rescue JSON::ParserError => jsonerr
 			raise PaystackServerError.new(response) , "Invalid result data. Could not parse JSON response body \n #{jsonerr.message}"
 
-		rescue PayStackServerError => e
+		rescue PaystackServerError => e
 			Utils.serverErrorHandler(e)
 		end	
 		return result
@@ -94,7 +94,7 @@ class PaystackBaseObject
 		rescue JSON::ParserError => jsonerr
 			raise PaystackServerError.new(response) , "Invalid result data. Could not parse JSON response body \n #{jsonerr.message}"
 
-		rescue PayStackServerError => e
+		rescue PaystackServerError => e
 			Utils.serverErrorHandler(e)
 		end	
 		return result

data/lib/paystack/objects/card.rb

@@ -71,7 +71,7 @@ class PaystackCard
 		end
 		formatted_number = @number.gsub(/\s+|-/) {|s| '' }.strip
 		
-		if(Utils.isEmpty(formatted_number) || !Utils.isWholePositiveNumber(formatted_number) || !Utils.isLuthValidNumber(formatted_number))
+		if(Utils.isEmpty(formatted_number) || !Utils.isWholePositiveNumber(formatted_number) || !Utils.isLuhnValidNumber(formatted_number))
 	
 			return false
 		end

data/lib/paystack/objects/transactions.rb

@@ -22,9 +22,6 @@ class PaystackTransactions < PaystackBaseObject
 		return PaystackTransactions.totals(@paystack, page)
 	end
 
-	def  chargeToken(token, amount,args = {})
-		return PaystackTransactions.chargeToken(@paystack,token, amount, args)
-	end
 
 	def  chargeAuthorization(authorization_code, email,  amount,args = {})
 		return PaystackTransactions.chargeAuthorization(@paystack,authorization_code,email, amount, args)
@@ -56,10 +53,6 @@ class PaystackTransactions < PaystackBaseObject
 		initGetRequest(paystackObj, "#{API::TRANSACTION_PATH}/totals?page=#{page}")
 	end
 
-	def PaystackTransactions.chargeToken(paystackObj,token, amount,args = {})
-		hash = {:token => token, :amount => amount}.merge(args)
-		initPostRequest(paystackObj,"#{API::TRANSACTION_PATH}/charge_token",  hash, true)
-	end
 	def PaystackTransactions.chargeAuthorization(paystackObj,authorization_code,email,  amount,args = {})
 		hash = {:authorization_code => authorization_code, :amount => amount, :email => email}.merge(args)
 		initPostRequest(paystackObj,"#{API::TRANSACTION_PATH}/charge_authorization",  hash, true)

data/lib/paystack/utils/utils.rb

@@ -30,7 +30,7 @@ module Utils
 		return true
 	end
 
-	def Utils.isLuthValidNumber(number)
+	def Utils.isLuhnValidNumber(number)
 		sum = 0
 		length = number.strip.length;
 

data/lib/paystack/version.rb

@@ -1,3 +1,3 @@
 module Paystack
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paystack
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Victor
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-10 00:00:00.000000000 Z
+date: 2016-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -86,8 +86,6 @@ files:
 - lib/paystack.rb
 - lib/paystack/error.rb
 - lib/paystack/modules/api.rb
-- lib/paystack/modules/crypto.rb
-- lib/paystack/modules/tokenmanager.rb
 - lib/paystack/objects/base.rb
 - lib/paystack/objects/card.rb
 - lib/paystack/objects/customers.rb

data/lib/paystack/modules/crypto.rb

@@ -1,11 +0,0 @@
-require "Base64"
-require "openssl"
-
-module Crypto
-
-	def Crypto.encrypt_string(message, public_key)
-		
-		rsa = OpenSSL::PKey::RSA.new public_key
-		return Base64::encode64(rsa.public_encrypt(message)).rstrip
-	end
-end

data/lib/paystack/modules/tokenmanager.rb

@@ -1,60 +0,0 @@
-require 'rest-client'
-require 'paystack/modules/crypto.rb'
-require 'paystack/modules/api.rb'
-require 'paystack/objects/card.rb'
-
-module TokenManager
-
-	CONCATENATOR = '*'
-	RSA_PUBLIC_KEY = "-----BEGIN PUBLIC KEY-----\nMFwwDQYJKoZIhvcNAQEBBQADSwAwSAJBANIsL+RHqfkBiKGn/D1y1QnNrMkKzxWP\n2wkeSokw2OJrCI+d6YGJPrHHx+nmb/Qn885/R01Gw6d7M824qofmCvkCAwEAAQ==\n-----END PUBLIC KEY-----\n"
-	
-	def TokenManager.create(card, publishableKey)
-		if(card == nil)
-			raise PayStackCardError, "Card cannot be null"
-		elsif !card.isValidCard()
-			raise PayStackCardError, "Invalid card details"
-		end
-				
-		card_str = concatCardFields(card)
-		enc_card_str = Crypto.encrypt_string(card_str, RSA_PUBLIC_KEY)
-		return createServerToken enc_card_str, publishableKey
-	end	
-
-	def TokenManager.concatCardFields(card)
-		raise PayStackCardError, 'Invalid Card' unless (!card.nil? && card.instance_of?(PaystackCard)) 
-
-		number = Utils.nullifyString(card.number)
-		cvc = card.cvc
-		expiryMonth = card.expiryMonth
-		expiryYear = card.expiryYear
-		
-		raise PayStackCardError, 'Card number cannot be empty or null' unless (!number.nil?)
-
-		return "#{number}#{CONCATENATOR}#{cvc}#{CONCATENATOR}#{expiryMonth}#{CONCATENATOR}#{expiryYear}"
-
-	end
-
-	def TokenManager.createServerToken(encrypted_card, publishableKey)
-		token = nil;
-		begin
-			response = RestClient.post "#{API::TOKEN_URL}", :clientdata => encrypted_card, :publishablekey => publishableKey 
-			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
-			token = {:token => result['token'], :last4 => result['last4']}
-		rescue JSON::ParserError => jsonerr
-			raise PayStackServerError.new(response) , "Invalid result data. Could not parse JSON response body \n #{jsonerr.message}"
-
-		rescue PayStackServerError => e
-			puts e.response.code
-			Utils.serverErrorHandler(e)
-		end
-		return token
-
-	end
-end
-