├── .gitignore
├── lib
    └── Paystack
    │   ├── Interfaces
    │       ├── IResource.php
    │       ├── IResponse.php
    │       ├── Http
    │       │   └── IClient.php
    │       └── IRequest.php
    │   ├── Subscription.php
    │   ├── Customer.php
    │   ├── Plan.php
    │   ├── Response.php
    │   ├── Paystack.php
    │   ├── Http
    │       └── HttpClient.php
    │   ├── Transaction.php
    │   ├── Request.php
    │   └── Traits
    │       └── ResourceTrait.php
├── tests
    ├── TestCase.php
    ├── CustomerTest.php
    └── PaystackTest.php
├── .travis.yml
├── phpunit.xml
├── example
    └── index.php
├── composer.json
└── README.md


/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor/
2 | .idea
3 | composer.lock
4 | 


--------------------------------------------------------------------------------
/lib/Paystack/Interfaces/IResource.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Paystack\Interfaces;
 4 | 
 5 | 
 6 | interface IResource
 7 | {
 8 | 
 9 | }
10 | 
11 | ?>


--------------------------------------------------------------------------------
/lib/Paystack/Subscription.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Paystack;
 4 | 
 5 | use Paystack\Interfaces\IResource;
 6 | 
 7 | class Subscription implements IResource
 8 | {
 9 | 
10 | }
11 | 
12 | ?>


--------------------------------------------------------------------------------
/tests/TestCase.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: perfectmak
 5 |  * Date: 2/12/16
 6 |  * Time: 4:14 PM
 7 |  */
 8 | 
 9 | namespace PaystackTest;
10 | 
11 | 
12 | use PHPUnit_Framework_TestCase;
13 | 
14 | class TestCase extends PHPUnit_Framework_TestCase
15 | {
16 | 
17 | }


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | language: php
 2 | 
 3 | php:
 4 |   - '5.5'
 5 |   - '5.6'
 6 |   - '7.0'
 7 |   - hhvm
 8 | 
 9 | matrix:
10 |     allow_failures:
11 |         - php: hhvm
12 | 
13 | install: composer install --no-interaction --prefer-source
14 |   
15 | script:
16 |   - php vendor/bin/phpunit -c phpunit.xml
17 | 


--------------------------------------------------------------------------------
/tests/CustomerTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: perfectmak
 5 |  * Date: 2/12/16
 6 |  * Time: 4:12 PM
 7 |  */
 8 | 
 9 | namespace PaystackTest;
10 | 
11 | 
12 | class CustomerTest extends TestCase
13 | {
14 |     public function testCustomerCreation()
15 |     {
16 |         $this->assertEquals(true,true);
17 |     }
18 | }


--------------------------------------------------------------------------------
/phpunit.xml:
--------------------------------------------------------------------------------
 1 | <phpunit bootstrap="vendor/autoload.php" colors="true">
 2 |     <testsuites>
 3 |         <testsuite name="paystack-php Test Suite">
 4 |             <directory suffix="Test.php">tests</directory>
 5 |         </testsuite>
 6 |     </testsuites>
 7 |     <filter>
 8 |         <whitelist>
 9 |             <directory suffix=".php">src/</directory>
10 |         </whitelist>
11 |     </filter>
12 | </phpunit>
13 | 


--------------------------------------------------------------------------------
/lib/Paystack/Interfaces/IResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: perfectmak
 5 |  * Date: 2/12/16
 6 |  * Time: 5:54 PM
 7 |  */
 8 | 
 9 | namespace Paystack\Interfaces;
10 | 
11 | 
12 | interface IResponse
13 | {
14 |     const CODE_OK = 200;
15 |     const CODE_VALIDATION_ERROR = 400;
16 |     const CODE_NOT_FOUND = 404;
17 | 
18 |     public function getCode();
19 | 
20 |     public function getBody();
21 | }


--------------------------------------------------------------------------------
/lib/Paystack/Interfaces/Http/IClient.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: perfectmak
 5 |  * Date: 2/12/16
 6 |  * Time: 3:46 PM
 7 |  */
 8 | 
 9 | namespace Paystack\Interfaces\Http;
10 | 
11 | 
12 | use Paystack\Interfaces\IRequest;
13 | use Paystack\Interfaces\IResponse;
14 | use Paystack\Response;
15 | 
16 | interface IClient
17 | {
18 |     /**
19 |      * @param IRequest $request
20 |      * @return IResponse
21 |      */
22 |     public function sendRequest(IRequest $request);
23 | }


--------------------------------------------------------------------------------
/tests/PaystackTest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: perfectmak
 5 |  * Date: 2/12/16
 6 |  * Time: 5:58 PM
 7 |  */
 8 | 
 9 | namespace PaystackTest;
10 | 
11 | 
12 | use \Paystack\Paystack;
13 | 
14 | class PaystackTest extends TestCase
15 | {
16 |     public function testApiKey()
17 |     {
18 |         $expectedApiKey = "sk_tst_111";
19 | 
20 |         Paystack::setApiKey($expectedApiKey);
21 | 
22 |         $actualApiKey = Paystack::getApiKey();
23 | 
24 |         $this->assertEquals($actualApiKey, $expectedApiKey);
25 |     }
26 | }


--------------------------------------------------------------------------------
/lib/Paystack/Customer.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Paystack;
 4 | 
 5 | use Paystack\Interfaces\IResource;
 6 | use Paystack\Traits\ResourceTrait;
 7 | 
 8 | class Customer implements IResource
 9 | {
10 |     use ResourceTrait;
11 | 
12 |     protected static $resourceUrl = '/customer';
13 | 
14 |     public static function create(array $param)
15 |     {
16 |         return self::_create(self::url(), $param);
17 |     }
18 | 
19 |     public static function get($id)
20 |     {
21 |         return self::_get(self::url('/'.$id));
22 |     }
23 | 
24 |     public static function all()
25 |     {
26 |         throw new \Exception();
27 |     }
28 | 
29 |     public function save()
30 |     {
31 |         throw new \Exception();
32 |     }
33 | }
34 | 
35 | ?>


--------------------------------------------------------------------------------
/lib/Paystack/Plan.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Paystack;
 4 | 
 5 | 
 6 | use Paystack\Interfaces\IResource;
 7 | use Paystack\Traits\ResourceTrait;
 8 | 
 9 | class Customer implements IResource
10 | {
11 |     use ResourceTrait;
12 | 
13 |     protected static $resourceUrl = '/plan';
14 | 
15 |     public static function create(array $params)
16 |     {
17 |         return self::_create(self::url('/create'), $params);
18 |     }
19 | 
20 |     public static function get($id)
21 |     {
22 |         return self::_get(self::url('/'.$id));
23 |     }
24 | 
25 |     public static function all()
26 |     {
27 |         throw new \Exception();
28 |     }
29 | 
30 |     public function save()
31 |     {
32 |         throw new \Exception();
33 |     }
34 | }
35 | ?>


--------------------------------------------------------------------------------
/example/index.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | require('../vendor/autoload.php');
 4 | 
 5 | 
 6 | \Paystack\Paystack::init('sk_test_19f3325a5a0abe546b508cd5926f3d6223d4e4d8');
 7 | 
 8 | try {
 9 | //    $customer = \Paystack\Customer::create([
10 | //        'email' => 'damiperfect@yahoo.com',
11 | //        'first_name' => 'Perfecto',
12 | //        'last_name' => 'Makanjuo',
13 | //        'phone' => '08064474572'
14 | //    ]);
15 | //
16 | //    echo 'Customer\'s first name is: '.$customer->first_name;
17 | 
18 | //    $payment = \Paystack\Transaction::initialize([
19 | //        'email' => 'damiperfect@gmail.com',
20 | //        'amount' => '3000'
21 | //    ]);
22 | 
23 |     $transaction = \Paystack\Transaction::verify('3beczdakli');
24 |     echo $transaction->amount;
25 | }
26 | catch(Exception $e)
27 | {
28 |     echo $e->getMessage();
29 | }
30 | 
31 | ?>


--------------------------------------------------------------------------------
/lib/Paystack/Response.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: perfectmak
 5 |  * Date: 2/12/16
 6 |  * Time: 5:54 PM
 7 |  */
 8 | 
 9 | namespace Paystack;
10 | 
11 | 
12 | use Paystack\Interfaces\IResponse;
13 | 
14 | class Response implements IResponse
15 | {
16 |     private $_code = null;
17 | 
18 |     private $_body = null;
19 | 
20 |     public function __construct($code, $body)
21 |     {
22 |         $this->setCode($code);
23 |         $this->setBody($body);
24 |     }
25 | 
26 |     public function getCode()
27 |     {
28 |         return $this->_code;
29 |     }
30 | 
31 |     public function getBody()
32 |     {
33 |         return $this->_body;
34 |     }
35 | 
36 |     private function setCode($code)
37 |     {
38 |         $this->_code = $code;
39 |     }
40 | 
41 |     private function setBody($body)
42 |     {
43 |         $this->_body = $body;
44 |     }
45 | }


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 | 	"name": "perfectmak/paystack-php",
 3 |     "type": "library",
 4 |     "description": "Paystack Library for PHP",
 5 |     "keywords": ["paystack","payment"],
 6 |     "homepage": "https://github.com/Seldaek/monolog",
 7 |     "license": "MIT",
 8 |     "authors": [
 9 |         {
10 |             "name": "Perfect Makanju",
11 |             "email": "damiperfect@gmail.com",
12 |             "homepage": "http://about.me/perfectmak",
13 |             "role": "Developer"
14 |         }
15 |     ],
16 |     "require": {
17 |         "php": ">=5.5",
18 |         "nategood/httpful": "*"
19 |     },
20 |     "require-dev": {
21 |         "phpunit/phpunit": "~4.0"
22 |     },
23 |     "autoload": {
24 |         "psr-4": {
25 |             "": "lib",
26 |             "PaystackTest\\": "test"
27 |         },
28 |         "classmap": [
29 |             "tests/TestCase.php"
30 |         ]
31 |     }
32 | }


--------------------------------------------------------------------------------
/lib/Paystack/Paystack.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Paystack;
 4 | 
 5 | use Paystack\Http\HttpClient;
 6 | 
 7 | class Paystack
 8 | {
 9 |     private static $apiKey;
10 | 
11 |     const API_URL = 'https://api.paystack.co';
12 | 
13 | 
14 |     public static function init($apiKey)
15 |     {
16 |         //setup API Key
17 |         self::setApiKey($apiKey);
18 | 
19 |         //set default request httpclient
20 |         Request::setClient(new HttpClient());
21 |     }
22 | 
23 |     /**
24 |      * @return mixed
25 |      */
26 |     public static function getApiKey()
27 |     {
28 |         return self::$apiKey;
29 |     }
30 | 
31 |     /**
32 |      * @param mixed $apiKey
33 |      */
34 |     public static function setApiKey($apiKey)
35 |     {
36 |         self::$apiKey = $apiKey;
37 |     }
38 | 
39 |     public static function api($resourceUrl)
40 |     {
41 |         return self::API_URL.$resourceUrl;
42 |     }
43 | 
44 | }
45 | 
46 | 
47 | ?>


--------------------------------------------------------------------------------
/lib/Paystack/Interfaces/IRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: perfectmak
 5 |  * Date: 2/12/16
 6 |  * Time: 5:54 PM
 7 |  */
 8 | 
 9 | namespace Paystack\Interfaces;
10 | 
11 | 
12 | use Paystack\Interfaces\Http\IClient;
13 | 
14 | interface IRequest
15 | {
16 |     const TYPE_POST = 'POST';
17 |     const TYPE_GET = 'GET';
18 |     const TYPE_DELETE = 'DELETE';
19 | 
20 | 
21 |     public static function setClient(IClient $client);
22 | 
23 |     public static function getClient();
24 | 
25 |     public function setUrl($url);
26 | 
27 |     public function getUrl();
28 | 
29 |     public function setType($type);
30 | 
31 |     public function getType();
32 | 
33 |     public function setHeader($key, $value);
34 | 
35 |     public function getHeader($key);
36 | 
37 |     public function getHeaders();
38 | 
39 |     public function setBody($body);
40 | 
41 |     public function getBody();
42 | 
43 |     public function send();
44 | }


--------------------------------------------------------------------------------
/lib/Paystack/Http/HttpClient.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: perfectmak
 5 |  * Date: 2/12/16
 6 |  * Time: 3:46 PM
 7 |  */
 8 | 
 9 | namespace Paystack\Http;
10 | 
11 | 
12 | use Httpful\Http;
13 | use Paystack\Interfaces\Http\IClient;
14 | use Paystack\Interfaces\IRequest;
15 | use Paystack\Interfaces\IResponse;
16 | use Paystack\Paystack;
17 | use Paystack\Response;
18 | 
19 | 
20 | /**
21 |  * This HttpClient uses
22 |  * Class HttpClient
23 |  * @package Paystack\Http
24 |  */
25 | class HttpClient implements IClient
26 | {
27 | 
28 |     /**
29 |      * @param IRequest $request
30 |      * @return IResponse
31 |      */
32 |     public function sendRequest(IRequest $request)
33 |     {
34 |         $response = \Httpful\Request::init()
35 |             ->addHeader('Authorization', 'Bearer '.Paystack::getApiKey())
36 |             ->uri($request->getUrl())
37 |             ->method($request->getType())
38 |             ->addHeaders($request->getHeaders())
39 |             ->body($request->getBody())
40 |             ->sendsJson()
41 |             ->send();
42 | 
43 |         $iResponse = new Response($response->code, $response->body);
44 |         return $iResponse;
45 |     }
46 | }


--------------------------------------------------------------------------------
/lib/Paystack/Transaction.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Paystack;
 4 | 
 5 | use Paystack\Interfaces\IResource;
 6 | use Paystack\Traits\ResourceTrait;
 7 | 
 8 | class Transaction implements IResource
 9 | {
10 |     use ResourceTrait;
11 | 
12 |     protected static $resourceUrl = '/transaction';
13 | 
14 |     public static function initialize(array $params)
15 |     {
16 |         return self::_create(self::url('/initialize'), $params);
17 |     }
18 | 
19 |     public static function chargeCode(array $params)
20 |     {
21 |         return self::_create(self::url('/charge_authorization'), $params);
22 |     }
23 | 
24 |     public static function chargeToken(array $params)
25 |     {
26 |         return self::_create(self::url('/charge_token'), $params);
27 |     }
28 | 
29 |     public static function verify($reference)
30 |     {
31 |         $url = self::url('/verify/'.$reference);
32 |         return self::_get($url, []);
33 |     }
34 | 
35 |     public static function totals()
36 |     {
37 |         $transaction = self::_get(self::url('/totals'));
38 |         return $transaction->_attributes;
39 |     }
40 | 
41 |     public static function get($id)
42 |     {
43 |         return self::_get(self::url('/'.$id));
44 |     }
45 | 
46 |     public static function all()
47 |     {
48 |         throw new \Exception();
49 |     }
50 | }
51 | ?>


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Paystack PHP
 2 | 
 3 | [![Build Status](https://secure.travis-ci.org/perfectmak/paystack-php.png?branch=master)](http://travis-ci.org/perfectmak/paystack-php)
 4 | 
 5 | Paystack PHP is a library for using the [Paystack](http://paystack.com) API from PHP.
 6 | 
 7 | While there are other PHP libraries for Paystack, this library is designed to make it less cumbersome to implement a 
 8 | payment flow on the Paystack payment platform.
 9 | 
10 | ## Installation
11 | 
12 | To install using composer
13 | ```
14 | composer install perfectmak/paystack-php
15 | ```
16 | 
17 | ## Usage
18 | First you initialize the library with your secret key
19 | 
20 | ```php
21 | \Paystack\Paystack::init('__secret_key_here__');
22 | ```
23 | 
24 | ### Transaction
25 | 
26 | #### Initialize a transaction
27 | ```php
28 |     $payment = \Paystack\Transaction::initialize([
29 |         'email' => 'jame@gosling.com',
30 |         'amount' => '3000'
31 |     ]);
32 | ```
33 | 
34 | ### Customer
35 | 
36 | #### Create Customer
37 | ```php
38 |     $customer = \Paystack\Customer::create([
39 |         'email' => 'google@gosling.com',
40 |         'first_name' => 'Perfect',
41 |         'last_name' => 'Makanju',
42 |         'phone' => 'xxxxxxx'
43 |     ]);
44 | 
45 |     echo 'Customer\'s first name is: '.$customer->first_name;
46 | ```
47 | 
48 | ## Todo
49 | This library is far from complete and not yet stable. So I don't advice using it yet.
50 | 
51 | - Finish up all the resources
52 | - Tests for each Resource
53 | - Fix travis build script


--------------------------------------------------------------------------------
/lib/Paystack/Request.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /**
  3 |  * Created by PhpStorm.
  4 |  * User: perfectmak
  5 |  * Date: 2/12/16
  6 |  * Time: 5:53 PM
  7 |  */
  8 | 
  9 | namespace Paystack;
 10 | 
 11 | 
 12 | use Paystack\Interfaces\Http\IClient;
 13 | use Paystack\Interfaces\IRequest;
 14 | 
 15 | class Request implements  IRequest
 16 | {
 17 |     private $_type = false;
 18 | 
 19 |     private $_headers = [];
 20 | 
 21 |     private $_body = '';
 22 | 
 23 |     private $_url = '';
 24 | 
 25 |     /**
 26 |      * @var IClient
 27 |      */
 28 |     private static $_httpClient = null;
 29 | 
 30 |     public function setHeader($key, $value)
 31 |     {
 32 |         $this->_headers[$key] = $value;
 33 | 
 34 |         return $this;
 35 |     }
 36 | 
 37 |     public function getHeader($key)
 38 |     {
 39 |         return $this->_headers[$key];
 40 |     }
 41 | 
 42 |     public function getHeaders()
 43 |     {
 44 |         return $this->_headers;
 45 |     }
 46 | 
 47 |     public function setBody($body)
 48 |     {
 49 |         $this->_body = $body;
 50 | 
 51 |         return $this;
 52 |     }
 53 | 
 54 |     public function getBody()
 55 |     {
 56 |         return $this->_body;
 57 |     }
 58 | 
 59 |     public function setUrl($url)
 60 |     {
 61 |         $this->_url = $url;
 62 | 
 63 |         return $this;
 64 |     }
 65 | 
 66 |     public function getUrl()
 67 |     {
 68 |         return $this->_url;
 69 |     }
 70 | 
 71 |     public function setType($type)
 72 |     {
 73 |         $this->_type = $type;
 74 | 
 75 |         return $this;
 76 |     }
 77 | 
 78 |     public function getType()
 79 |     {
 80 |         return $this->_type;
 81 |     }
 82 | 
 83 | 
 84 |     public static function setClient(IClient $client)
 85 |     {
 86 |         self::$_httpClient = $client;
 87 |     }
 88 | 
 89 |     public static function getClient()
 90 |     {
 91 |         return self::$_httpClient;
 92 |     }
 93 | 
 94 |     public function send()
 95 |     {
 96 |         if(!is_null(self::$_httpClient))
 97 |             return self::$_httpClient->sendRequest($this);
 98 | 
 99 |         throw new \Exception('No HttpClient specified for requests');
100 |     }
101 | }


--------------------------------------------------------------------------------
/lib/Paystack/Traits/ResourceTrait.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Created by PhpStorm.
 4 |  * User: perfectmak
 5 |  * Date: 2/12/16
 6 |  * Time: 4:01 PM
 7 |  */
 8 | 
 9 | namespace Paystack\Traits;
10 | 
11 | 
12 | use Paystack\Interfaces\IRequest;
13 | use Paystack\Interfaces\IResponse;
14 | use Paystack\Paystack;
15 | use Paystack\Request;
16 | 
17 | trait ResourceTrait
18 | {
19 |     protected $_attributes = [];
20 |     protected function __construct($params)
21 |     {
22 |         if(is_array($params))
23 |             $this->_attributes = $params;
24 |         else{
25 |             $this->_attributes = json_decode(json_encode($params), true);
26 |         }
27 |     }
28 | 
29 | 
30 |     /**
31 |      * @param $url
32 |      * @param array $params
33 |      * @return static
34 |      * @throws \Exception
35 |      */
36 |     protected static function _create($url, array $params)
37 |     {
38 |         $response = (new Request())
39 |             ->setUrl(Paystack::api($url))
40 |             ->setType(IRequest::TYPE_POST)
41 |             ->setBody(json_encode($params))
42 |             ->send();
43 | 
44 | 
45 |         if($response->getCode() === IResponse::CODE_VALIDATION_ERROR)
46 |             throw new \Exception($response->getBody()->message);
47 | 
48 |         return new static($response->getBody()->data);
49 |     }
50 | 
51 |     protected static function _get($url)
52 |     {
53 |         $response = (new Request())
54 |             ->setUrl(Paystack::api($url))
55 |             ->setType(IRequest::TYPE_GET)
56 |             ->send();
57 | 
58 | 
59 |         if($response->getCode() === IResponse::CODE_VALIDATION_ERROR)
60 |             throw new \Exception($response->getBody()->message);
61 | 
62 |         return new static($response->getBody()->data);
63 |     }
64 | 
65 |     public function __get($key)
66 |     {
67 |         if(array_key_exists($key, $this->_attributes))
68 |         {
69 |             return $this->_attributes[$key];
70 |         }
71 |         else
72 |             return null;
73 |     }
74 | 
75 |     /**
76 |      * @param $key
77 |      * @param $value
78 |      * @todo Should check in a list of properties defined in Resource class
79 |      */
80 |     public function __set($key, $value)
81 |     {
82 |         $this->_attributes[$key] = $value;
83 |     }
84 | 
85 |     protected static function url($path = ''){
86 |         return rtrim(self::$resourceUrl, '/').'/'
87 |             .ltrim($path, '/');
88 |     }
89 | }


--------------------------------------------------------------------------------