feat: support for EU region (#36) (#41)

printu · May 7, 2021 · 1b0019b · 1b0019b
1 parent 36f0f31
commit 1b0019b
Show file tree

Hide file tree

Showing 22 changed files with 325 additions and 74 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 PHP bindings for the Customer.io API.
 
-[API Documentation](https://learn.customer.io/api/)
+[API Documentation](https://customer.io/docs/api/)
 
 [![Build Status](https://travis-ci.org/printu/customerio.svg?branch=master)](https://travis-ci.org/printu/customerio)
 [![Code Climate](https://codeclimate.com/github/printu/customerio/badges/gpa.svg)](https://codeclimate.com/github/printu/customerio)
@@ -72,6 +72,17 @@ $client->setAppAPIKey('APP_KEY');
 ?>
 ```
 
+Change region to EU
+
+```php
+<?php
+use Customerio\Client;
+
+$client = new Client('YOUR_API_KEY', 'YOUR_SITE_ID', ['region' => 'eu']);
+
+?>
+```
+
 ### Local Testing
 
 Run `phpunit` from the project root to start all tests.

diff --git a/src/Client.php b/src/Client.php
@@ -4,6 +4,7 @@
 
 namespace Customerio;
 
+use Customerio\Region\RegionInterface;
 use GuzzleHttp\Client as BaseClient;
 use GuzzleHttp\Exception\GuzzleException;
 use GuzzleHttp\Psr7\Utils;
@@ -12,10 +13,6 @@
 
 class Client
 {
-    const API_ENDPOINT_TRACK = 'https://track.customer.io/api/v1/';
-    const API_ENDPOINT = 'https://api.customer.io/v1/';
-    const API_ENDPOINT_BETA = 'https://beta-api.customer.io/v1/api/';
-
     /** @var BaseClient $httpClient */
     private $httpClient;
 
@@ -28,6 +25,9 @@ class Client
     /** @var string App API key */
     protected $appKey;
 
+    /** @var RegionInterface */
+    protected $region;
+
     /** @var bool Assoc mode for response */
     protected $assocResponse;
 
@@ -71,8 +71,9 @@ class Client
      * Client constructor.
      * @param string $apiKey Api Key
      * @param string $siteId Site ID.
+     * @param array $options client options
      */
-    public function __construct(string $apiKey, string $siteId)
+    public function __construct(string $apiKey, string $siteId, array $options = [])
     {
         $this->setDefaultClient();
         $this->events = new Endpoint\Events($this);
@@ -91,6 +92,8 @@ public function __construct(string $apiKey, string $siteId)
         $this->apiKey = $apiKey;
         $this->siteId = $siteId;
         $this->assocResponse = false;
+
+        $this->region = Region::factory($options['region'] ?? 'us');
     }
 
     /**
@@ -109,6 +112,22 @@ public function setSiteId(string $siteId): void
         $this->siteId = $siteId;
     }
 
+    /**
+     * @param string $region
+     */
+    public function setRegion(string $region): void
+    {
+        $this->region = Region::factory($region);
+    }
+
+    /**
+     * @return RegionInterface
+     */
+    public function getRegion(): RegionInterface
+    {
+        return $this->region;
+    }
+
     /**
      * @param bool $assoc
      */
@@ -143,12 +162,14 @@ public function setClient(BaseClient $client): void
      */
     public function get(string $endpoint, array $params = [])
     {
-        $options = $this->getDefaultParams(self::API_ENDPOINT_BETA);
+        $apiEndpoint = $this->getRegion()->betaUri();
+
+        $options = $this->getDefaultParams($apiEndpoint);
         if (!empty($params)) {
             $options['query'] = $params;
         }
 
-        $response = $this->httpClient->request('GET', self::API_ENDPOINT_BETA.$endpoint, $options);
+        $response = $this->httpClient->request('GET', $apiEndpoint.$endpoint, $options);
 
         return $this->handleResponse($response);
     }
@@ -204,7 +225,7 @@ public function put(string $endpoint, array $json)
      */
     protected function request(string $method, string $path, array $json): ResponseInterface
     {
-        $apiEndpoint = self::API_ENDPOINT_TRACK;
+        $apiEndpoint = $this->region->trackUri();
 
         if (isset($json['endpoint'])) {
             $apiEndpoint = $json['endpoint'];
@@ -259,8 +280,8 @@ private function handleResponse(ResponseInterface $response)
     protected function getDefaultParams($endpoint): array
     {
         switch ($endpoint) {
-            case self::API_ENDPOINT_BETA:
-            case self::API_ENDPOINT:
+            case $this->region->apiUri():
+            case $this->region->betaUri():
                 return [
                     'headers' => [
                         'Authorization' => 'Bearer '.$this->getToken(),

diff --git a/src/Endpoint/Activities.php b/src/Endpoint/Activities.php
@@ -2,15 +2,15 @@
 
 namespace Customerio\Endpoint;
 
-use Customerio\Client;
+use GuzzleHttp\Exception\GuzzleException;
 
 class Activities extends Base
 {
     /**
      * Get data about activities
      * @param array $options
      * @return mixed
-     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws GuzzleException
      */
     public function search(array $options)
     {

diff --git a/src/Endpoint/Base.php b/src/Endpoint/Base.php
@@ -5,6 +5,7 @@
 use Customerio\Client;
 use GuzzleHttp\Exception\RequestException;
 use GuzzleHttp\Psr7\Request;
+use Psr\Http\Client\RequestExceptionInterface;
 
 class Base
 {
@@ -25,7 +26,7 @@ public function __construct($client)
      * @param array $extra
      * @return string
      */
-    protected function customerPath($id = null, array $extra = [])
+    protected function customerPath($id = null, array $extra = []): string
     {
         return $this->generatePath('customers', $id, $extra);
     }
@@ -35,7 +36,7 @@ protected function customerPath($id = null, array $extra = [])
      * @param array $extra
      * @return string
      */
-    protected function campaignPath($id = null, array $extra = [])
+    protected function campaignPath($id = null, array $extra = []): string
     {
         return $this->generatePath('campaigns', $id, $extra);
     }
@@ -45,7 +46,7 @@ protected function campaignPath($id = null, array $extra = [])
      * @param array $extra
      * @return string
      */
-    protected function messagesPath($id = null, array $extra = [])
+    protected function messagesPath($id = null, array $extra = []): string
     {
         return $this->generatePath('messages', $id, $extra);
     }
@@ -55,7 +56,7 @@ protected function messagesPath($id = null, array $extra = [])
      * @param array $extra
      * @return string
      */
-    protected function messagesTemplatesPath($id, array $extra = [])
+    protected function messagesTemplatesPath($id, array $extra = []): string
     {
         return $this->generatePath('msg_templates', $id, $extra);
     }
@@ -65,7 +66,7 @@ protected function messagesTemplatesPath($id, array $extra = [])
      * @param array $extra
      * @return string
      */
-    protected function newslettersPath($id = null, array $extra = [])
+    protected function newslettersPath($id = null, array $extra = []): string
     {
         return $this->generatePath('newsletters', $id, $extra);
     }
@@ -75,7 +76,7 @@ protected function newslettersPath($id = null, array $extra = [])
      * @param array $extra
      * @return string
      */
-    protected function segmentsPath($id = null, array $extra = [])
+    protected function segmentsPath($id = null, array $extra = []): string
     {
         return $this->generatePath('segments', $id, $extra);
     }
@@ -85,7 +86,7 @@ protected function segmentsPath($id = null, array $extra = [])
      * @param array $extra
      * @return string
      */
-    protected function exportsPath($id = null, array $extra = [])
+    protected function exportsPath($id = null, array $extra = []): string
     {
         return $this->generatePath('exports', $id, $extra);
     }
@@ -95,7 +96,7 @@ protected function exportsPath($id = null, array $extra = [])
      * @param array $extra
      * @return string
      */
-    protected function activitiesPath($id = null, array $extra = [])
+    protected function activitiesPath($id = null, array $extra = []): string
     {
         return $this->generatePath('activities', $id, $extra);
     }
@@ -105,7 +106,7 @@ protected function activitiesPath($id = null, array $extra = [])
      * @param array $extra
      * @return string
      */
-    protected function senderIdentitiesPath($id = null, array $extra = [])
+    protected function senderIdentitiesPath($id = null, array $extra = []): string
     {
         return $this->generatePath('sender_identities', $id, $extra);
     }
@@ -114,7 +115,7 @@ protected function senderIdentitiesPath($id = null, array $extra = [])
      * @param $message
      * @param $method
      */
-    protected function mockException($message, $method)
+    protected function mockException($message, $method): RequestExceptionInterface
     {
         throw new RequestException($message, (new Request($method, '/')));
     }
@@ -125,7 +126,7 @@ protected function mockException($message, $method)
      * @param array $extra
      * @return string
      */
-    private function generatePath($prefix, $id = null, array $extra = [])
+    private function generatePath($prefix, $id = null, array $extra = []): string
     {
         $path = [
             $prefix,

diff --git a/src/Endpoint/Campaigns.php b/src/Endpoint/Campaigns.php
@@ -2,7 +2,7 @@
 
 namespace Customerio\Endpoint;
 
-use Customerio\Client;
+use GuzzleHttp\Exception\GuzzleException;
 
 class Campaigns extends Base
 {
@@ -11,7 +11,7 @@ class Campaigns extends Base
      * @see https://learn.customer.io/api/#apibeta-apicampaignscampaigns_list
      * @param array $options
      * @return mixed
-     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws GuzzleException
      */
     public function search(array $options)
     {
@@ -25,7 +25,7 @@ public function search(array $options)
      * @see https://learn.customer.io/api/#apibeta-apicampaignscampaigns_get
      * @param array $options
      * @return mixed
-     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws GuzzleException
      */
     public function get(array $options)
     {
@@ -45,7 +45,7 @@ public function get(array $options)
      * @see https://learn.customer.io/api/#apibeta-apicampaignscampaigns_get_triggers_metrics
      * @param array $options
      * @return mixed
-     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws GuzzleException
      */
     public function metrics(array $options)
     {
@@ -71,7 +71,7 @@ public function metrics(array $options)
      * @see https://learn.customer.io/api/#apibeta-apicampaignscampaigns_get_triggers
      * @param array $options
      * @return mixed
-     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws GuzzleException
      */
     public function triggers(array $options)
     {
@@ -91,7 +91,7 @@ public function triggers(array $options)
      * @see https://learn.customer.io/documentation/api-triggered-data-format.html
      * @param array $options
      * @return mixed
-     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws GuzzleException
      */
     public function trigger(array $options)
     {
@@ -102,7 +102,7 @@ public function trigger(array $options)
         $path = $this->campaignPath($options['id'], ['triggers']);
         unset($options['id']);
 
-        $options['endpoint'] = Client::API_ENDPOINT;
+        $options['endpoint'] = $this->client->getRegion()->apiUri();
 
         return $this->client->post($path, $options);
     }
@@ -112,7 +112,7 @@ public function trigger(array $options)
      * @see https://learn.customer.io/api/#apibeta-apicampaignscampaigns_messages
      * @param array $options
      * @return mixed
-     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws GuzzleException
      */
     public function messages(array $options)
     {
@@ -131,7 +131,7 @@ public function messages(array $options)
      * @see https://customer.io/docs/api/#apibeta-apicampaignscampaigns_index_actions
      * @param array $options
      * @return mixed
-     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws GuzzleException
      */
     public function actions(array $options)
     {
@@ -150,7 +150,7 @@ public function actions(array $options)
      * @see https://customer.io/docs/api/#apibeta-apicampaignscampaigns_get_action
      * @param array $options
      * @return mixed
-     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws GuzzleException
      */
     public function getAction(array $options)
     {
@@ -174,7 +174,7 @@ public function getAction(array $options)
      * @see https://customer.io/docs/api/#apibeta-apicampaignscampaign_action_metrics
      * @param array $options
      * @return mixed
-     * @throws \GuzzleHttp\Exception\GuzzleException
+     * @throws GuzzleException
      */
     public function getActionMetrics(array $options)
     {

diff --git a/src/Endpoint/Customers.php b/src/Endpoint/Customers.php
@@ -2,7 +2,6 @@
 
 namespace Customerio\Endpoint;
 
-use Customerio\Client;
 use GuzzleHttp\Exception\GuzzleException;
 
 class Customers extends Base
@@ -114,7 +113,7 @@ public function search(array $options)
         } // @codeCoverageIgnore
 
         $path = $this->customerPath();
-        $options['endpoint'] = Client::API_ENDPOINT_BETA;
+        $options['endpoint'] = $this->client->getRegion()->betaUri();
 
         return $this->client->post($path, $options);
     }