Merge pull request #10 from FreshMail/feature-APPDEV-5347

New version of API Client V3

Author: grzesiekgorczyca

README.md

@@ -1,38 +1,119 @@
 # FreshMail
 
-A php library which implements the functionality of FreshMail REST API.
+A php library which implements connection to FreshMail REST API.
 
 This API client covers all functions of API V2 such as:
  - subscribers management
  - list management
  - campaign management
  - sending transactional SMS messages
- - sending transactional mail messages (in a legacy way)
 
 If You want to send transactional messages in rich format please use new [API V3 client](https://github.com/FreshMail/php-api-client).
 
-## Installation via composer
+## Installation via composer (compatible with PHP >=7.0)
 
-Add to `composer.json` file:
+Add via composer:
+    
+    composer require freshmail/rest-api:^3.0
 
-    {
-        "require": {
-            "freshmail/rest-api": "dev-master"
-        }
-    }
+## Installation of old version of library (compatible with PHP >=5.3)
 
-Use in php project:
+Add via composer:
+    
+    composer require freshmail/rest-api:^2.0
 
-    use FreshMail\RestApi as FmRestApi;
+## Usage
 
-## Installation by hand
+Below some simple examples, for whole API function see [full API V2 doc](https://freshmail.pl/developer-api/jak-zaczac/)
 
-    require_once 'class.rest.php';
-    require_once 'config.php';
+#### Test connection
+    
+    use \FreshMail\ApiV2\Client;
+    
+    $token = 'MY_APP_TOKEN';
+    $apiClient = new Client($token);
+    
+    $apiClient->doRequest('ping');
+    
+#### Create subscribers list
 
-## Examples
+    use \FreshMail\ApiV2\Client;
+    
+    $token = 'MY_APP_TOKEN';
+    $apiClient = new Client($token);
+    
+    $data = [
+        'name' => 'List with subscribers from my website'
+    ];
+    
+    $apiClient->doRequest('subscribers_list/create', $data);
+    
+#### Add subscriber to list
 
-All samples included in samples directory.
+    use \FreshMail\ApiV2\Client;
+        
+    $token = 'MY_APP_TOKEN';
+    $apiClient = new Client($token);
+    
+    $data = [
+        'email' => 'example@email.address',
+        'list' => 'list_hash'
+    ];
+    
+    $apiClient->doRequest('subscriber/add', $data);
 
-## Thanks to
-@adam187 
+## Proxy setup
+
+To use proxy You can pass Your own GuzzleHttp Client:
+
+    use \FreshMail\ApiV2\Client;
+    
+    $guzzleClient = new \GuzzleHttp\Client(
+        [
+            'proxy' => 'my proxy url'
+        ]
+    );
+        
+    $token = 'MY_APP_TOKEN';
+    $apiClient = new Client($token);
+    $apiClient->setGuzzleHttpClient($guzzleClient);
+
+## Debugging
+
+#### PSR-3 Logger Interface
+
+You can use any library that implements [PSR-3](https://www.php-fig.org/psr/psr-3/) `Psr\Log\LoggerInterface`, example with Monolog below:
+
+    use \FreshMail\ApiV2\Client;  
+    
+    $logger = new \Monolog\Logger('myCustomLogger');
+    $logger->pushHandler(new \Monolog\Handler\StreamHandler('php://stderr', \Monolog\Logger::DEBUG));
+        
+    $token = 'MY_APP_TOKEN';
+    $apiClient = new Client($token);
+    $apiClient->setLogger($monolog);
+
+#### Using Guzzle
+
+You can also pass Your own GuzzleHttp Client with proper configuration:
+
+
+    use \FreshMail\ApiV2\Client;
+    
+    $stack = \GuzzleHttp\HandlerStack::create();
+    $stack->push(
+        \GuzzleHttp\Middleware::log(
+            new \Monolog\Logger('Logger'),
+            new \GuzzleHttp\MessageFormatter(\GuzzleHttp\MessageFormatter::DEBUG)
+        )
+    );
+    
+    $guzzleClient = new \GuzzleHttp\Client(
+        [
+            'handler' => $stack,
+        ]
+    );
+        
+    $token = 'MY_APP_TOKEN';
+    $apiClient = new Client($token);
+    $apiClient->setGuzzleHttpClient($guzzleClient);

class.rest.php

@@ -31,13 +31,16 @@
         }
     ],
     "require": {
-        "php": ">=5.3.0",
+        "php": ">=7.0",
         "ext-curl": "*",
-        "ext-json": "*"
+        "ext-json": "*",
+        "psr/log": "^1.1",
+        "monolog/monolog": "^1.25",
+        "guzzlehttp/guzzle": "^6.5"
     },
     "autoload": {
-        "psr-0": {
-            "FreshMail": "src/"
+        "psr-4": {
+            "FreshMail\\ApiV2\\": "src/FreshMail/"
         }
     }
 }