From 80f130b7f9d8e5373c8327f3e80a4cd8f32cf689 Mon Sep 17 00:00:00 2001
From: Olivier Delbruyere <odelbruyere@moondayapp.com>
Date: Fri, 11 Oct 2019 11:03:24 +0200
Subject: [PATCH] Add `FeedInterface`, `BaseFeedInterface`, and
 `ClientInterface`

---
 lib/GetStream/Stream/Activities.php           |   4 +-
 .../Stream/ActivityUpdateOperation.php        |   4 +-
 lib/GetStream/Stream/Analytics.php            |   4 +-
 lib/GetStream/Stream/BaseFeed.php             |   8 +-
 lib/GetStream/Stream/BaseFeedInterface.php    | 140 ++++++++++++++++++
 lib/GetStream/Stream/Batcher.php              |   4 +-
 lib/GetStream/Stream/Client.php               |   6 +-
 lib/GetStream/Stream/ClientInterface.php      | 101 +++++++++++++
 lib/GetStream/Stream/Collections.php          |   7 +-
 lib/GetStream/Stream/Feed.php                 |   2 +-
 lib/GetStream/Stream/FeedInterface.php        |  30 ++++
 lib/GetStream/Stream/Personalization.php      |   7 +-
 lib/GetStream/Stream/Reactions.php            |   5 +-
 lib/GetStream/Stream/Users.php                |   7 +-
 14 files changed, 298 insertions(+), 31 deletions(-)
 create mode 100644 lib/GetStream/Stream/BaseFeedInterface.php
 create mode 100644 lib/GetStream/Stream/ClientInterface.php
 create mode 100644 lib/GetStream/Stream/FeedInterface.php

diff --git a/lib/GetStream/Stream/Activities.php b/lib/GetStream/Stream/Activities.php
index 97b208e..39d084e 100644
--- a/lib/GetStream/Stream/Activities.php
+++ b/lib/GetStream/Stream/Activities.php
@@ -10,11 +10,11 @@ class Activities extends Feed
     protected $token;
 
     /**
-     * @param Client $client
+     * @param ClientInterface $client
      * @param string $api_key
      * @param string $token
      */
-    public function __construct($client, $api_key, $token)
+    public function __construct(ClientInterface $client, $api_key, $token)
     {
         $this->client = $client;
         $this->api_key = $api_key;
diff --git a/lib/GetStream/Stream/ActivityUpdateOperation.php b/lib/GetStream/Stream/ActivityUpdateOperation.php
index c4023db..5e6ad3c 100644
--- a/lib/GetStream/Stream/ActivityUpdateOperation.php
+++ b/lib/GetStream/Stream/ActivityUpdateOperation.php
@@ -10,11 +10,11 @@ class ActivityUpdateOperation extends Feed
     protected $token;
 
     /**
-     * @param Client $client
+     * @param ClientInterface $client
      * @param string $api_key
      * @param string $token
      */
-    public function __construct($client, $api_key, $token)
+    public function __construct(ClientInterface $client, $api_key, $token)
     {
         $this->client = $client;
         $this->api_key = $api_key;
diff --git a/lib/GetStream/Stream/Analytics.php b/lib/GetStream/Stream/Analytics.php
index 9ba6bbc..0916dc2 100644
--- a/lib/GetStream/Stream/Analytics.php
+++ b/lib/GetStream/Stream/Analytics.php
@@ -12,11 +12,11 @@ class Analytics extends Feed
     protected $token;
 
     /**
-     * @param Client $client
+     * @param ClientInterface  $client
      * @param string $api_key
      * @param string $token
      */
-    public function __construct($client, $api_key, $token)
+    public function __construct(ClientInterface $client, $api_key, $token)
     {
         $this->client = $client;
         $this->api_key = $api_key;
diff --git a/lib/GetStream/Stream/BaseFeed.php b/lib/GetStream/Stream/BaseFeed.php
index 1186d79..7072bbc 100644
--- a/lib/GetStream/Stream/BaseFeed.php
+++ b/lib/GetStream/Stream/BaseFeed.php
@@ -2,7 +2,7 @@
 
 namespace GetStream\Stream;
 
-class BaseFeed
+class BaseFeed implements BaseFeedInterface
 {
     /**
      * @var string
@@ -35,12 +35,12 @@ class BaseFeed
     protected $api_key;
 
     /**
-     * @var Client
+     * @var ClientInterface
      */
     protected $client;
 
     /**
-     * @param Client $client
+     * @param ClientInterface $client
      * @param string $feed_slug
      * @param string $user_id
      * @param string $api_key
@@ -48,7 +48,7 @@ class BaseFeed
      *
      * @throws StreamFeedException
      */
-    public function __construct($client, $feed_slug, $user_id, $api_key, $token)
+    public function __construct(ClientInterface $client, $feed_slug, $user_id, $api_key, $token)
     {
         if (!$this->validFeedSlug($feed_slug)) {
             throw new StreamFeedException('feed_slug can only contain alphanumeric characters or underscores');
diff --git a/lib/GetStream/Stream/BaseFeedInterface.php b/lib/GetStream/Stream/BaseFeedInterface.php
new file mode 100644
index 0000000..2c98595
--- /dev/null
+++ b/lib/GetStream/Stream/BaseFeedInterface.php
@@ -0,0 +1,140 @@
+<?php
+
+namespace GetStream\Stream;
+
+interface BaseFeedInterface
+{
+    /**
+     * @param string $feed_slug
+     *
+     * @return bool
+     */
+    public function validFeedSlug($feed_slug);
+
+    /**
+     * @param string $user_id
+     *
+     * @return bool
+     */
+    public function validUserId($user_id);
+
+    /**
+     * @return string
+     */
+    public function getReadonlyToken();
+
+    /**
+     * @return string
+     */
+    public function getToken();
+
+    /**
+     * @return string
+     */
+    public function getId();
+
+    /**
+     * @return string
+     */
+    public function getSlug();
+
+    /**
+     * @return string
+     */
+    public function getUserId();
+
+    /**
+     * @param array $to
+     *
+     * @return array
+     */
+    public function signToField($to);
+
+    /**
+     * @param array $activity
+     * @return mixed
+     *
+     * @throws StreamFeedException
+     */
+    public function addActivity($activity);
+
+    /**
+     * @param array $activities
+     * @return mixed
+     *
+     * @throws StreamFeedException
+     */
+    public function addActivities($activities);
+
+    /**
+     * @param int $activity_id
+     * @param bool $foreign_id
+     * @return mixed
+     *
+     * @throws StreamFeedException
+     */
+    public function removeActivity($activity_id, $foreign_id = false);
+
+    /**
+     * @param int $offset
+     * @param int $limit
+     * @param array $options
+     * @return mixed
+     *
+     * @throws StreamFeedException
+     */
+    public function getActivities($offset = 0, $limit = 20, $options = [], $enrich = false, $reactions = null);
+
+    /**
+     * @param string $targetFeedSlug
+     * @param string $targetUserId
+     * @param int $activityCopyLimit
+     *
+     * @return mixed
+     *
+     * @throws StreamFeedException
+     */
+    public function follow($targetFeedSlug, $targetUserId, $activityCopyLimit = 300);
+
+    /**
+     * @param int $offset
+     * @param int $limit
+     * @return mixed
+     *
+     * @throws StreamFeedException
+     */
+    public function followers($offset = 0, $limit = 25);
+
+    /**
+     * @param int $offset
+     * @param int $limit
+     * @param array $filter
+     * @return mixed
+     *
+     * @throws StreamFeedException
+     */
+    public function following($offset = 0, $limit = 25, $filter = []);
+
+    /**
+     * @param string $targetFeedSlug
+     * @param string $targetUserId
+     * @param bool $keepHistory
+     *
+     * @return mixed
+     *
+     * @throws StreamFeedException
+     */
+    public function unfollow($targetFeedSlug, $targetUserId, $keepHistory = false);
+
+    /**
+     * @param string $foreign_id
+     * @param string $time
+     * @param array $new_targets
+     * @param array $added_targets
+     * @param array $removed_targets
+     * @return mixed
+     *
+     * @throws StreamFeedException
+     */
+    public function updateActivityToTargets($foreign_id, $time, $new_targets = [], $added_targets = [], $removed_targets = []);
+}
diff --git a/lib/GetStream/Stream/Batcher.php b/lib/GetStream/Stream/Batcher.php
index 194dafa..4ab9fe7 100644
--- a/lib/GetStream/Stream/Batcher.php
+++ b/lib/GetStream/Stream/Batcher.php
@@ -12,11 +12,11 @@ class Batcher extends Feed
     private $signer;
 
     /**
-     * @param Client $client
+     * @param ClientInterface $client
      * @param Signer $signer
      * @param string $api_key
      */
-    public function __construct($client, Signer $signer, $api_key)
+    public function __construct(ClientInterface $client, Signer $signer, $api_key)
     {
         $this->client = $client;
         $this->signer = $signer;
diff --git a/lib/GetStream/Stream/Client.php b/lib/GetStream/Stream/Client.php
index 97ce0f9..d84a4b1 100644
--- a/lib/GetStream/Stream/Client.php
+++ b/lib/GetStream/Stream/Client.php
@@ -6,7 +6,7 @@
 
 const VERSION = '2.6.0';
 
-class Client
+class Client implements ClientInterface
 {
     const API_ENDPOINT = 'stream-io-api.com/api';
 
@@ -131,7 +131,7 @@ public function createUserToken($user_id, array $extra_data=null)
     }
 
     /**
-     * @param  BaseFeed $feed
+     * @param  BaseFeedInterface $feed
      * @param  string $resource
      * @param  string $action
      * @return string
@@ -146,7 +146,7 @@ public function createFeedJWTToken($feed, $resource, $action)
      * @param  string $feed_slug
      * @param  string $user_id
      * @param  string|null $token
-     * @return Feed
+     * @return FeedInterface
      */
     public function feed($feed_slug, $user_id, $token = null)
     {
diff --git a/lib/GetStream/Stream/ClientInterface.php b/lib/GetStream/Stream/ClientInterface.php
new file mode 100644
index 0000000..4b26a74
--- /dev/null
+++ b/lib/GetStream/Stream/ClientInterface.php
@@ -0,0 +1,101 @@
+<?php
+
+namespace GetStream\Stream;
+
+interface ClientInterface
+{
+    /**
+     * @param string $protocol
+     */
+    public function setProtocol($protocol);
+
+    /**
+     * @param string $location
+     */
+    public function setLocation($location);
+
+    /**
+     * @param string $user_id
+     * @param array $extra_data
+     * @return string
+     */
+    public function createUserSessionToken($user_id, array $extra_data = null);
+
+    /**
+     * @param string $user_id
+     * @param array $extra_data
+     * @return string
+     */
+    public function createUserToken($user_id, array $extra_data = null);
+
+    /**
+     * @param BaseFeedInterface $feed
+     * @param string $resource
+     * @param string $action
+     * @return string
+     */
+    public function createFeedJWTToken($feed, $resource, $action);
+
+    /**
+     * @param string $feed_slug
+     * @param string $user_id
+     * @param string|null $token
+     * @return FeedInterface
+     */
+    public function feed($feed_slug, $user_id, $token = null);
+
+    /**
+     * @return Batcher
+     */
+    public function batcher();
+
+    /**
+     * @return Personalization
+     */
+    public function personalization();
+
+    /**
+     * @return Collections
+     */
+    public function collections();
+
+    /**
+     * @return Reactions
+     */
+    public function reactions();
+
+    /**
+     * @return Users
+     */
+    public function users();
+
+    /**
+     * @return string
+     */
+    public function getBaseUrl();
+
+    /**
+     * @param string $uri
+     * @return string
+     */
+    public function buildRequestUrl($uri);
+
+    public function getActivities($ids = null, $foreign_id_times = null);
+
+    public function batchPartialActivityUpdate($data);
+
+    public function doPartialActivityUpdate($id = null, $foreign_id = null, $time = null, $set = null, $unset = null);
+
+    public function updateActivities($activities);
+
+    public function updateActivity($activity);
+
+    /**
+     * Creates a redirect url for tracking the given events in the context of
+     * getstream.io/personalization
+     * @param string $targetUrl
+     * @param array $events
+     * @return string
+     */
+    public function createRedirectUrl($targetUrl, $events);
+}
diff --git a/lib/GetStream/Stream/Collections.php b/lib/GetStream/Stream/Collections.php
index ea28dc9..cf27201 100644
--- a/lib/GetStream/Stream/Collections.php
+++ b/lib/GetStream/Stream/Collections.php
@@ -3,7 +3,6 @@
 namespace GetStream\Stream;
 
 use Firebase\JWT\JWT;
-use GetStream\Stream\Client as StreamClient;
 use GuzzleHttp\Client as GuzzleClient;
 use GuzzleHttp\Exception\ClientException;
 use GuzzleHttp\HandlerStack;
@@ -12,7 +11,7 @@
 class Collections
 {
     /**
-     * @var Client
+     * @var ClientInterface
      */
     private $client;
 
@@ -27,11 +26,11 @@ class Collections
     private $apiSecret;
 
     /**
-     * @param \GetStream\Stream\Client $streamClient
+     * @param ClientInterface $streamClient
      * @param string $apiKey
      * @param string $apiSecret
      */
-    public function __construct(StreamClient $streamClient, $apiKey, $apiSecret)
+    public function __construct(ClientInterface $streamClient, $apiKey, $apiSecret)
     {
         $this->apiKey = $apiKey;
         $this->apiSecret = $apiSecret;
diff --git a/lib/GetStream/Stream/Feed.php b/lib/GetStream/Stream/Feed.php
index ca7f588..df4e27d 100644
--- a/lib/GetStream/Stream/Feed.php
+++ b/lib/GetStream/Stream/Feed.php
@@ -7,7 +7,7 @@
 use GuzzleHttp\HandlerStack;
 use GuzzleHttp\Psr7\Uri;
 
-class Feed extends BaseFeed
+class Feed extends BaseFeed implements FeedInterface
 {
     /**
      * @var string
diff --git a/lib/GetStream/Stream/FeedInterface.php b/lib/GetStream/Stream/FeedInterface.php
new file mode 100644
index 0000000..d665079
--- /dev/null
+++ b/lib/GetStream/Stream/FeedInterface.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace GetStream\Stream;
+
+interface FeedInterface extends BaseFeedInterface
+{
+    /**
+     * @return \GuzzleHttp\HandlerStack
+     */
+    public function getHandlerStack();
+
+    /**
+     * @return \GuzzleHttp\Client
+     */
+    public function getHttpClient();
+
+    public function setGuzzleDefaultOption($option, $value);
+
+    /**
+     * @param string $uri
+     * @param string $method
+     * @param array $data
+     * @param array $query_params
+     * @param string $resource
+     * @param string $action
+     * @return mixed
+     * @throws StreamFeedException
+     */
+    public function makeHttpRequest($uri, $method, $data = [], $query_params = [], $resource = '', $action = '');
+}
diff --git a/lib/GetStream/Stream/Personalization.php b/lib/GetStream/Stream/Personalization.php
index 3238911..c246c62 100644
--- a/lib/GetStream/Stream/Personalization.php
+++ b/lib/GetStream/Stream/Personalization.php
@@ -3,7 +3,6 @@
 namespace GetStream\Stream;
 
 use Firebase\JWT\JWT;
-use GetStream\Stream\Client as StreamClient;
 use GuzzleHttp\Client as GuzzleClient;
 use GuzzleHttp\Exception\ClientException;
 use GuzzleHttp\HandlerStack;
@@ -14,7 +13,7 @@ class Personalization
     const API_ENDPOINT = 'https://personalization.stream-io-api.com/personalization/v1.0/';
 
     /**
-     * @var Client
+     * @var ClientInterface
      */
     private $client;
 
@@ -29,11 +28,11 @@ class Personalization
     private $apiSecret;
 
     /**
-     * @param \GetStream\Stream\Client $streamClient
+     * @param ClientInterface $streamClient
      * @param string $apiKey
      * @param string $apiSecret
      */
-    public function __construct(StreamClient $streamClient, $apiKey, $apiSecret)
+    public function __construct(ClientInterface $streamClient, $apiKey, $apiSecret)
     {
         $this->apiKey = $apiKey;
         $this->apiSecret = $apiSecret;
diff --git a/lib/GetStream/Stream/Reactions.php b/lib/GetStream/Stream/Reactions.php
index 16b4d5a..1a9f067 100644
--- a/lib/GetStream/Stream/Reactions.php
+++ b/lib/GetStream/Stream/Reactions.php
@@ -3,7 +3,6 @@
 namespace GetStream\Stream;
 
 use Firebase\JWT\JWT;
-use GetStream\Stream\Client as StreamClient;
 use GuzzleHttp\Client as GuzzleClient;
 use GuzzleHttp\Exception\ClientException;
 use GuzzleHttp\HandlerStack;
@@ -27,11 +26,11 @@ class Reactions
     private $apiSecret;
 
     /**
-     * @param \GetStream\Stream\Client $streamClient
+     * @param ClientInterface $streamClient
      * @param string $apiKey
      * @param string $apiSecret
      */
-    public function __construct(StreamClient $streamClient, $apiKey, $apiSecret)
+    public function __construct(ClientInterface  $streamClient, $apiKey, $apiSecret)
     {
         $this->apiKey = $apiKey;
         $this->apiSecret = $apiSecret;
diff --git a/lib/GetStream/Stream/Users.php b/lib/GetStream/Stream/Users.php
index ab3373a..5ceb87d 100644
--- a/lib/GetStream/Stream/Users.php
+++ b/lib/GetStream/Stream/Users.php
@@ -3,7 +3,6 @@
 namespace GetStream\Stream;
 
 use Firebase\JWT\JWT;
-use GetStream\Stream\Client as StreamClient;
 use GuzzleHttp\Client as GuzzleClient;
 use GuzzleHttp\Exception\ClientException;
 use GuzzleHttp\HandlerStack;
@@ -12,7 +11,7 @@
 class Users
 {
     /**
-     * @var Client
+     * @var ClientInterface
      */
     private $client;
 
@@ -27,11 +26,11 @@ class Users
     private $apiSecret;
 
     /**
-     * @param \GetStream\Stream\Client $streamClient
+     * @param ClientInterface $streamClient
      * @param string $apiKey
      * @param string $apiSecret
      */
-    public function __construct(StreamClient $streamClient, $apiKey, $apiSecret)
+    public function __construct(ClientInterface $streamClient, $apiKey, $apiSecret)
     {
         $this->apiKey = $apiKey;
         $this->apiSecret = $apiSecret;