paystack 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2bfffac1071ccab650bec0e73af7b5caf8ff6f57
-  data.tar.gz: 5c8125e3f70f8321fc66c5d5adeb758c8cad6368
+  metadata.gz: ae8e6284abf3217caed4431540242dcc7ec79fac
+  data.tar.gz: ff9e3e54dcf80cd650cf1315ee307a9eac5a84d6
 SHA512:
-  metadata.gz: 7d2e673cb05a9bd987450e392138af759619b9e855b56c419d9672bb9855ac5b1dc56af7ff99c877c4ced46c45b38021d2da81ed7ad1c124a00e125e2ebbdd71
-  data.tar.gz: de3ec225ab575e393e03739a916c1b6ed5d32d1d2cebfb9f24f4f30dfba489c0f798ca8004c6604c469befcd8ed5c5630e233b681e7d25da135578103491ad1a
+  metadata.gz: fa1c3e4e8ac03be75742784b883bad76cb2c9c570c59dfcf6f9371c9017688727cfc1468f8ca86bbe23bc08c9a03732d9b1ceeeb99fa8f2c579bf9b97aa0d73e
+  data.tar.gz: 231967b9e5724e016da55b3c1db6618d6184e9c8415c508963da8286eee2be83de8ac360f27ac1fa12b0946837ac0068482dc745c96fcd04a0462861df0d1088

data/.rspec

@@ -1,2 +1,2 @@
---color
---require spec_helper
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,16 @@
+sudo: required
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler
+cache:
+  directories:
+   - vendor/bundle
+
+script:
+  - rspec
+  
+deploy:
+  provider: rubygems
+  api_key: "bcc5d3ff98af614e950b21a2df77af20"
+  gem: paystack

data/README.md

@@ -1,7 +1,8 @@
 # Paystack
 
+[![Build Status](https://travis-ci.org/IkoroVictor/paystack-ruby.svg?branch=master)](https://travis-ci.org/IkoroVictor/paystack-ruby) [![Gem Version](https://badge.fury.io/rb/paystack.svg)](https://badge.fury.io/rb/paystack)
 
-A ruby gem for easy integration of [Paystack](https://paystack.co/).
+A ruby gem for easy integration of [Paystack](https://paystack.co/).  
 
 
 ## Installation
@@ -43,23 +44,6 @@ It throws a `PaystackBadKeyError` when either of the keys are invalid or cannot
 
 
 
-### Instantiate a Card object
-
-```ruby
-	card = new PaystackCard(
-		:number => "304402040400400022", 
-		:cvc => "888", 
-		: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
@@ -70,7 +54,7 @@ All card values/fields should be String literals.
 		:amount => 300000,
 		:email => "xxxxxx@gmail.com",
 		)
-	auth_url = results['data']['authorization_url']
+	auth_url = result['data']['authorization_url']
 ```
 NOTE: Amount is in kobo i.e. `100000 = 100000 kobo = 1000 naira`
 
@@ -108,7 +92,7 @@ NOTE: Amount is in kobo i.e. `100000 = 100000 kobo = 1000 naira`
 
 ```ruby
 
-	transaction_id = ""123456778""
+	transaction_id = "123456778"
 	transactions = PaystackTransactions.new(paystackObj)
 	result = transactions.get(transaction_id) 
 
@@ -233,7 +217,7 @@ 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,
@@ -245,8 +229,60 @@ NOTE: Amount is in kobo i.e. `100000 = 100000 kobo = 1000 naira`
 ```
 
 
+## Subscriptions
+
+### Create new subscription 
+
+```ruby
+
+	subscriptions = PaystackSubscriptions.new(paystackObj)
+	result = subscriptions.create(
+
+				:customer => "customer@email.com",
+				:plan => "123557", #plan id
+				:amount => 30000 #in KOBO
+			)
+
+```
+
+### Get subscription detail
+
+```ruby
+	
+	subscription_id = "123456778"
+	subscriptions = PaystackSubscriptions.new(paystackObj)
+	result = subscriptions.get(subscription_id) 
+	subscription =  result['data']
+
+```
+
+### Enable subscription
+
+```ruby
+
+	subscriptions = PaystackSubscriptions.new(paystackObj)
+	result = subscriptions.enable(
+				:code => "12328833",
+				:token => "EWFWKFJWE" #user email token
+			)
+
+```
+
+### Disable subscription
+
+```ruby
+
+	subscriptions = PaystackSubscriptions.new(paystackObj)
+	result = subscriptions.disable(
+				:code => "12328833",
+				:token => "EWFWKFJWE" #user email token
+			)
+
+```
+
+
 ## 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
+`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
 
 
 ```ruby

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,54 +1,55 @@
-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/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 setPublicKey public_key
-		@public_key = public_key
-	end
-
-	def setPrivateKey public_key
-		@public_key = public_key
-	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'
+
+
+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,8 @@
-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"
+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