Merged in HSDK-7 (pull request #7)

HSDK-7

Approved-by: David Francos <davidfrancos@sipay.es>
Approved-by: Darcy Zerpa <darcyzerpa@sipay.es>

Author: ivancalle-sipay

README.md

@@ -3,10 +3,55 @@
 
 # Instalación
 
+Podemos instalarlo de forma manual (Ver "Extracción de código") o utilizando Composer (Ver "Composer").
+
+## Extracción de código
+
+Este paso se omite si se utiliza la instalación via composer.
+
   ```bash
-    $ git clone https://github.com/sipay/php-sdk
+    $ git clone https://github.com/sipay/php-sdk.git
   ```
 
+Entonces establecemos la variable "path_autoload" a "<directorio_de_descarga_de_php-sdk>/autoload.php":
+
+```php
+$path_autoload = "<directorio_de_descarga_de_php-sdk>/autoload.php";
+```
+
+
+## Composer
+
+Este paso se omite si se utiliza el metodo manual.
+
+Crear archivo composer.json o añadir estos parametros:
+
+```json
+  {
+    "repositories": [
+      {
+        "type": "vcs",
+        "url": "https://github.com/sipay/php-sdk.git"
+      }
+    ],
+    "require": {
+      "sipay/php-sdk": "*"
+    }
+  }
+```
+y realizar los siguientes pasos
+
+```bash
+$ php -r "readfile('https://getcomposer.org/installer');" | php
+$ php composer.phar install
+```
+
+Entonces establecemos la variable "path_autoload" a "vendor/autoload.php":
+
+```php
+$path_autoload = "vendor/autoload.php";
+```
+
 
 # Quickstart
 

composer.json

@@ -0,0 +1,19 @@
+{
+    "name": "sipay/php-sdk",
+    "description": "SDK on PHP of operations in Sipay.",
+    "keywords": ["sipay", "php", "sdk"],
+    "license": "LLL",
+    "authors": [
+        {
+            "name": "Sipay",
+            "email": "desarrollo@sipay.es"
+        }
+    ],
+    "type": "project",
+    "require": {
+  		"php": ">=7"
+    },
+    "autoload": {
+          "files": ["src/autoload.php"]
+      }
+}

src/Ecommerce.php

@@ -48,7 +48,7 @@ public function setKey($key)
             throw new \Exception('$key must be a string.');
         }
         if(!preg_match("/^[\w-]{6,32}$/", $key)) {
-            throw new \Exception('$key don\'t match with pattern.');
+            throw new \Exception('Invalid key provided: wrong format.');
         }
         $this->key = $key;
     }
@@ -64,7 +64,7 @@ public function setSecret($secret)
             throw new \Exception('$secret must be a string.');
         }
         if(!preg_match("/^[\w-]{6,32}$/", $secret)) {
-            throw new \Exception('$secret don\'t match with pattern.');
+            throw new \Exception('Invalid secret provided: wrong format.');
         }
         $this->secret = $secret;
     }
@@ -80,7 +80,7 @@ public function setResource($resource)
             throw new \Exception('$resource must be a string.');
         }
         if(!preg_match("/^[\w-]{6,32}$/", $resource)) {
-            throw new \Exception('$resource don\'t match with pattern.');
+            throw new \Exception('Invalid resource provided: wrong format.');
         }
         $this->resource = $resource;
     }
@@ -145,7 +145,7 @@ public function setTimeout($timeout)
         }
         $timeout = intval($timeout);
         if($timeout <= 0) {
-            throw new \Exception('$timeout must be geater than 0.');
+            throw new \Exception('$timeout must be greater than 0.');
         }
         $this->timeout = $timeout;
     }
@@ -159,26 +159,27 @@ private function send($payload, $endpoint)
 
         $url = 'https://'.$this->environment.'.sipay.es/mdwr/'.$this->version.'/'.$endpoint;
         $data = array(
-        'key' => $this->key,
-        'nonce' => "".time(),
-        'mode' => $this->mode,
-        'resource' => $this->resource,
-        'payload' => $payload
+            'key' => $this->key,
+            'nonce' => "".time(),
+            'mode' => $this->mode,
+            'resource' => $this->resource,
+            'payload' => $payload
         );
 
         $body = json_encode($data);
         $signature = hash_hmac($this->mode, $body, $this->secret);
 
         $options = array(
-        'http' => array(
-        'header'  => "Content-type: application/json\r\nContent-Signature: ".$signature."\r\n",
-        'method'  => 'POST',
-        'content' => $body,
-        'timeout' => $this->timeout,
-        'ignore_errors' => true
-        ),
+            'http' => array(
+                'header'  => "Content-type: application/json\r\nContent-Signature: ".$signature."\r\n",
+                'method'  => 'POST',
+                'content' => $body,
+                'timeout' => $this->timeout,
+                'ignore_errors' => true
+            ),
         );
-        $context  = stream_context_create($options);
+
+        $context = stream_context_create($options);
         try {
             $response_body = file_get_contents($url, false, $context);
         } catch (Exception $e) {
@@ -223,12 +224,13 @@ private function send($payload, $endpoint)
         $this->logger->info(
             'sipay.request', 'request.response', 'I-0002', 'Request Response',
             array(
-                           'payload' => $payload,
-                           'endpoint' => $endpoint,
-            'response' => $response_body)
+               'payload' => $payload,
+               'endpoint' => $endpoint,
+               'response' => $response_body
+            )
         );
 
-                         return array($body, $response);
+        return array($body, $response);
     }
 
     private function clean_parameters(array $array_options, array $array_schema)
@@ -243,7 +245,7 @@ private function clean_parameters(array $array_options, array $array_schema)
                 }
 
                 if(is_string($option) && isset($schema['pattern']) && !preg_match($schema['pattern'], $option)) {
-                    throw new \Exception("$name don't match with pattern.");
+                    throw new \Exception('Invalid name provided: wrong format.');
                 }
 
                 $options[$name] = $option;
@@ -299,7 +301,7 @@ public function refund($identificator, Amount $amount, array $array_options = ar
         $is_tx_id = gettype($identificator) == "string" && preg_match('/^[0-9]{6,22}$/', $identificator);
 
         if (!$is_paymethod && !$is_tx_id) {
-            throw new \Exception('incorrect $identificator.');
+            throw new \Exception('Incorrect $identificator.');
         }
 
         $array_schema = array(
@@ -347,11 +349,11 @@ public function register(Paymethods\Paymethod $card, string $token)
     {
 
         if ($card instanceof Paymethods\StoredCard) {
-            throw new \Exception('$card can\'t be StoredCard.');
+            throw new \Exception('$card can\'t be a StoredCard instance.');
         }
 
         if(!preg_match('/^[\w-]{6,128}$/', $token)) {
-            throw new \Exception('$token don\'t match with pattern.');
+            throw new \Exception('Invalid token provided: wrong format.');
         }
 
         $payload = array(
@@ -368,7 +370,7 @@ public function register(Paymethods\Paymethod $card, string $token)
     public function card(string $token)
     {
         if(!preg_match('/^[\w-]{6,128}$/', $token)) {
-            throw new \Exception('$token don\'t match with pattern.');
+            throw new \Exception('Invalid token provided: wrong format.');
         }
 
         $payload = array(
@@ -383,7 +385,7 @@ public function card(string $token)
     public function unregister(string $token)
     {
         if(!preg_match('/^[\w-]{6,128}$/', $token)) {
-            throw new \Exception('$token don\'t match with pattern.');
+            throw new \Exception('Invalid token provided: wrong format.');
         }
 
         $payload = array(
@@ -399,7 +401,7 @@ public function cancellation(string $transaction_id)
     {
 
         if(!preg_match('/^[0-9]{6,22}$/', $transaction_id)) {
-              throw new \Exception('$transaction_id don\'t match with pattern.');
+            throw new \Exception('Invalid transaction_id provided: wrong format.');
         }
 
         $payload = array(

src/paymethods/StoredCard.php

@@ -11,7 +11,7 @@ public function __construct(string $token)
     public function set_token(string $token)
     {
         if(!preg_match("/^[\w-]{6,128}$/", $token)) {
-            throw new \Exception('$token doesn\'t match with pattern.');
+            throw new \Exception('Invalid token provided: wrong format.');
         }
 
         $this->token = $token;

src/responses/Refund.php

@@ -13,7 +13,7 @@ class Refund extends Response
     public $transaction_id;
     public $amount;
 
-    public function __construct($request, $response) 
+    public function __construct($request, $response)
     {
         $payload = $this->set_common($request, $response);
         $this->approval = isset($payload['approval']) ? $payload['approval'] : null;
@@ -24,6 +24,7 @@ public function __construct($request, $response)
         $this->order = isset($payload['order']) ? $payload['order'] : null;
         $this->reference = isset($payload['reconciliation']) ? $payload['reconciliation'] : null;
         $this->transaction_id = isset($payload['transaction_id']) ? $payload['transaction_id'] : null;
+
         if(isset($payload['amount']) && isset($payload['currency'])) {
             $this->amount = new \Sipay\Amount($payload['amount'], $payload['currency']);
         }else{

src/responses/Response.php

@@ -12,7 +12,7 @@ class Response
     public $type;
     public $uuid;
 
-    protected function set_common($request, $response) 
+    protected function set_common($request, $response)
     {
         $this->request = $request;
         $this->response = $response;
@@ -24,7 +24,6 @@ protected function set_common($request, $response)
             $this->type = isset($response['type']) ? $response['type'] : null;
             $this->uuid = isset($response['uuid']) ? $response['uuid'] : null;
 
-
             if($this->code !== "") {
                 $this->code = intval($this->code);
             }