CURL default SSL version TLSv1.2

This is to match requirement by Paystack servers
Update Requirements for Curl, OpenSSL and PHP
define CURL_SSLVERSION_TLSv1_2 as 6 if not found, to avoid not defined error

Author: ibrahimlawal

CHANGELOG.md

@@ -4,10 +4,12 @@ All Notable changes to `paystack-php` will be documented in this file.
 
 Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
 
-## NEXT - YYYY-MM-DD
+## 1.0.2 - 2016-03-10
 
-### Added
-- Nothing
+### Added usage of TLSv1.2
+CURL default SSL version TLSv1.2
+Update Requirements for Curl, OpenSSL and PHP
+define `CURL_SSLVERSION_TLSv1_2` as 6 if not found, to avoid not defined error
 
 ### Deprecated
 - Nothing

README.md

@@ -11,6 +11,11 @@ A PHP API wrapper for [Paystack](https://paystack.co/).
 
 [![Paystack](img/paystack.png?raw=true "Paystack")](https://paystack.co/)
 
+## Requirements
+- Curl 7.34.0 or more recent (Unless using Guzzle)
+- PHP 5.4.0 or more recent
+- OpenSSL v1.0.1 or more recent
+
 ## Install
 
 ### Via Composer
@@ -32,7 +37,7 @@ require 'path/to/src/Paystack.php';
 
 Check [ibrahimlawal/paystack-php-sample](https://github.com/ibrahimlawal/paystack-php-sample) for a sample donation page that uses this library
 
-###Default: Uses curl for requests
+### Default: Uses curl for requests
 ``` php
 $paystack = new \YabaCon\Paystack('secret_key');
 

composer.json

@@ -50,7 +50,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.0.7-dev"
+            "dev-master": "1.0.8-dev"
         }
     }
 }

src/Paystack.php

@@ -14,31 +14,32 @@ class Paystack
     private $routes;
     public $use_guzzle = false;
 
- /**
+    /**
  * Creates a new Paystack object
+  *
  * @param string $secret_key - Secret key for your account with Paystack
  */
     public function __construct($secret_key)
     {
 
         if (!is_string($secret_key) || !(substr($secret_key, 0, 3)==='sk_')) {
-        // Should never get here
+            // Should never get here
             throw new \InvalidArgumentException('A Valid Paystack Secret Key must start with \'sk_\'.');
 
         }
          $this->secret_key = $secret_key;
          $this->routes = $this->definedRoutes();
     }
 
- /**
+    /**
  * Router uses Guzzle for calls if GuzzleHttp is found
  */
     public function useGuzzle()
     {
          $this->use_guzzle = true;
     }
 
- /**
+    /**
  * definedRoutes
  * gets routes defined in the YabaCon\Paystack\Routes namespace
  * since we are using PSR-4. It is safe to assume that all php
@@ -47,8 +48,8 @@ public function useGuzzle()
  * @return the list of defined Routes
  *
  * @access private
- * @see YabaCon\Paystack\Routes\Router
- * @since 1.0
+ * @see    YabaCon\Paystack\Routes\Router
+ * @since  1.0
  */
     private function definedRoutes()
     {
@@ -61,7 +62,7 @@ private function definedRoutes()
         }
         return $routes;
     }
- /**
+    /**
  * __call
  * Magic Method for getOne on routes
  *
@@ -73,36 +74,40 @@ private function definedRoutes()
  * @return the result of calling /{route}/get on the api
  *
  * @access public
- * @see YabaCon\Paystack\Routes\Router
- * @since 1.0
+ * @see    YabaCon\Paystack\Routes\Router
+ * @since  1.0
  */
     public function __call($method, $args)
     {
-   /*
-   attempt to call getOne when the route is called directly
-  translates to /{root}/{get}/{id}
-  */
+        /*
+        attempt to call getOne when the route is called directly
+        translates to /{root}/{get}/{id}
+        */
         if (in_array($method, $this->routes, true)) {
             $route = new Router($method, $this);
 
             if (count($args) === 1 && is_integer($args[0])) {
-           // no params, just one arg... the id
+                // no params, just one arg... the id
                 $args = [[], [ Router::ID_KEY => $args[0] ] ];
                 return $route->__call('getOne', $args);
             } elseif (count($args) === 2 && is_integer($args[0]) && is_array($args[1])) {
-           // there are params, and just one arg... the id
+                // there are params, and just one arg... the id
                 $args = [$args[1], [ Router::ID_KEY => $args[0] ] ];
                 return $route->__call('getOne', $args);
             }
         }
-   // Should never get here
-        throw new \InvalidArgumentException('Route "' .
-        $method .
-         '" only accepts an integer id and an optional array of paging arguments.');
+        // Should never get here
+        throw new \InvalidArgumentException(
+            'Route "' .
+            $method .
+            '" only accepts an integer id and an optional array of paging arguments.'
+        );
     }
 
- /**
- * Call this function to register the custom auto loader for Paystack. * Required only if not using composer. */
+    /**
+    * Call this function to register the custom auto loader for Paystack.
+    * Required only if not using composer.
+    */
     public static function registerAutoloader()
     {
         spl_autoload_register(
@@ -118,7 +123,7 @@ function ($class_name) {
         );
     }
 
- /**
+    /**
  * __get
  * Insert description here
  *

src/Paystack/Helpers/Router.php

@@ -35,7 +35,7 @@ class Router
     const HTTP_CODE_KEY = 'httpcode';
     const BODY_KEY = 'body';
 
- /**
+    /**
  * moveArgsToSentargs
  * Insert description here
  *
@@ -58,14 +58,14 @@ private function moveArgsToSentargs(
 
 
 
-    // check if interface supports args
+        // check if interface supports args
         if (array_key_exists(RouteInterface:: ARGS_KEY, $interface)) {
-        // to allow args to be specified in the payload, filter them out and put them in sentargs
+            // to allow args to be specified in the payload, filter them out and put them in sentargs
             $sentargs = (!$sentargs) ? [ ] : $sentargs; // Make sure $sentargs is not null
             $args = $interface[RouteInterface::ARGS_KEY];
             while (list($key, $value) = each($payload)) {
-            // check that a value was specified
-            // with a key that was expected as an arg
+                // check that a value was specified
+                // with a key that was expected as an arg
                 if (in_array($key, $args)) {
                     $sentargs[$key] = $value;
                     unset($payload[$key]);
@@ -74,7 +74,7 @@ private function moveArgsToSentargs(
         }
     }
 
- /**
+    /**
  * putArgsIntoEndpoint
  * Insert description here
  *
@@ -90,13 +90,13 @@ private function moveArgsToSentargs(
  */
     private function putArgsIntoEndpoint(&$endpoint, $sentargs)
     {
-    // substitute sentargs in endpoint
+        // substitute sentargs in endpoint
         while (list($key, $value) = each($sentargs)) {
             $endpoint = str_replace('{' . $key . '}', $value, $endpoint);
         }
     }
 
- /**
+    /**
  * callViaCurl
  * Insert description here
  *
@@ -123,14 +123,15 @@ private function callViaCurl($interface, $payload = [ ], $sentargs = [ ])
 
         $headers = ["Authorization"=>"Bearer " . $this->secret_key ];
         $body = '';
-        if (($method === RouteInterface::POST_METHOD)||
-        ($method === RouteInterface::PUT_METHOD)) {
+        if (($method === RouteInterface::POST_METHOD)
+            || ($method === RouteInterface::PUT_METHOD)
+        ) {
             $headers["Content-Type"] = "application/json";
             $body = json_encode($payload);
         } elseif ($method === RouteInterface::GET_METHOD) {
             $endpoint = $endpoint . '?' . http_build_query($payload);
         }
-    // Use Guzzle if found, else use Curl
+        // Use Guzzle if found, else use Curl
         if ($this->use_guzzle && class_exists('\\GuzzleHttp\\Client') && class_exists('\\GuzzleHttp\\Psr7\\Request')) {
             $request = new \GuzzleHttp\Psr7\Request(strtoupper($method), $endpoint, $headers, $body);
             $client = new \GuzzleHttp\Client();
@@ -146,10 +147,10 @@ private function callViaCurl($interface, $payload = [ ], $sentargs = [ ])
             return $response;
 
         } else {
-        //open connection
+            //open connection
 
             $ch = \curl_init();
-        // set url
+            // set url
             \curl_setopt($ch, \CURLOPT_URL, $endpoint);
 
             if ($method === RouteInterface::POST_METHOD || $method === RouteInterface::PUT_METHOD) {
@@ -158,34 +159,43 @@ private function callViaCurl($interface, $payload = [ ], $sentargs = [ ])
 
                 \curl_setopt($ch, \CURLOPT_POSTFIELDS, $body);
             }
-        //flatten the headers
+            //flatten the headers
             $flattened_headers = [];
             while (list($key, $value) = each($headers)) {
                 $flattened_headers[] = $key . ": " . $value;
             }
             \curl_setopt($ch, \CURLOPT_HTTPHEADER, $flattened_headers);
             \curl_setopt($ch, \CURLOPT_RETURNTRANSFER, 1);
             \curl_setopt($ch, \CURLOPT_HEADER, 1);
+            
+            // Make sure CURL_SSLVERSION_TLSv1_2 is defined as 6
+            // Curl must be able to use TLSv1.2 to connect
+            // to Paystack servers
+            
+            if (!defined('CURL_SSLVERSION_TLSV1_2')) {
+                define('CURL_SSLVERSION_TLSV1_2', 6);
+            }
+            curl_setopt($ch, CURLOPT_SSLVERSION, CURL_SSLVERSION_TLSV1_2);
 
             $response = \curl_exec($ch);
 
             if (\curl_errno($ch)) {   // should be 0
-            // curl ended with an error
+                // curl ended with an error
                 \curl_close($ch);
                 return [[],[],0];
             }
 
             $code = \curl_getinfo($ch, \CURLINFO_HTTP_CODE);
 
-        // Then, after your \curl_exec call:
+            // Then, after your \curl_exec call:
             $header_size = \curl_getinfo($ch, \CURLINFO_HEADER_SIZE);
             $header = substr($response, 0, $header_size);
             $header = $this->headersFromLines(explode("\n", trim($header)));
             $body = substr($response, $header_size);
             $body = json_decode($body, true);
 
 
-        //close connection
+            //close connection
             \curl_close($ch);
 
             return [
@@ -208,7 +218,7 @@ private function headersFromLines($lines)
         return $headers;
     }
 
- /**
+    /**
  * __call
  * Insert description here
  *
@@ -228,12 +238,12 @@ public function __call($methd, $sentargs)
         if (array_key_exists($method, $this->methods) && is_callable($this->methods[$method])) {
             return call_user_func_array($this->methods[$method], $sentargs);
         } else {
-        // User attempted to call a function that does not exist
+            // User attempted to call a function that does not exist
             throw new \Exception('Function "' . $method . '" does not exist for "' . $this->route . "'.");
         }
     }
 
- /**
+    /**
  * A magic resource object that can make method calls to API
  *
  * @param $route
@@ -247,13 +257,13 @@ public function __construct($route, $paystackObj)
         $this->use_guzzle = $paystackObj->use_guzzle;
 
         $mets = get_class_methods($this->route_class);
-    // add methods to this object per method, except root
+        // add methods to this object per method, except root
         foreach ($mets as $mtd) {
             if ($mtd === 'root') {
-            // skip root method
+                // skip root method
                 continue;
             }
-        /**
+            /**
  * array
  * Insert description here
  *
@@ -273,7 +283,7 @@ public function __construct($route, $paystackObj)
                 array $sentargs = [ ]
             ) use ($mtd) {
                 $interface = call_user_func($this->route_class . '::' . $mtd);
-            // TODO: validate params and sentargs against definitions
+                // TODO: validate params and sentargs against definitions
                 return $this->callViaCurl($interface, $params, $sentargs);
             };
             $this->methods[$mtd] = \Closure::bind($mtdFunc, $this, get_class());

src/Paystack/Routes/Plan.php

@@ -36,7 +36,6 @@ public static function root()
      * create
      * Insert description here
      *
-     *
      * @return
      *
      * @access
@@ -69,7 +68,6 @@ public static function create()
      * getOne
      * Insert description here
      *
-     *
      * @return
      *
      * @access
@@ -91,7 +89,6 @@ public static function getOne()
      * getList
      * Insert description here
      *
-     *
      * @return
      *
      * @access
@@ -112,7 +109,6 @@ public static function getList()
      * update
      * Insert description here
      *
-     *
      * @return
      *
      * @access