Add personalization (#33)

Author: ferhatelmas

README.md

@@ -84,15 +84,15 @@ var activities = await client.Batch.GetActivities(ids)
 var foreignIDTimes = new ForeignIDTime[] {new ForeignIDTime("fid-1", DateTime.Parse("2000-08-19T16:32:32")), new Stream.ForeignIDTime("fid-2",  DateTime.Parse("2000-08-21T16:32:32"))};
 var activities = await client.Batch.GetActivities(null, foreignIDTimes)
 
-//Partially update an activity
+// Partially update an activity
 var set = new GenericData();
 set.SetData("custom_field", "new value");
 var unset = new string[]{"field to remove"};
 
-//by id
+// by id
 await client.ActivityPartialUpdate("e561de8f-00f1-11e4-b400-0cc47a024be0", null, set, unset);
 
-//by foreign id and time
+// by foreign id and time
 var fidTime = new ForeignIDTime("fid-1", DateTime.Parse("2000-08-19T16:32:32"));
 await client.ActivityPartialUpdate(null, fidTime, set, unset);
 
@@ -106,10 +106,10 @@ var activity = await userFeed1.AddActivity(activity);
 
 var r = await client.Reactions.Add("comment", activity.Id, "john");
 
-//add a reaction to a reaction
+// add a reaction to a reaction
 var child = await client.Reactions.AddChild(r.ID, "upvote", activity.Id, "john");
 
-//enrich feed results
+// enrich feed results
 var userData = new Dictionary<string, object>()
 {
 	{"is_admin", true},
@@ -121,7 +121,7 @@ var userRef = u.Ref();
 var a = new Stream.Activity(uRef, "add", "post");
 var plainActivity = await userFeed1.AddActivity(a);
 
-//plainActivity.Actor is just a plain string containing the user ref
+// plainActivity.Actor is just a plain string containing the user ref
 
 var enriched = await this._user1.GetEnrichedFlatActivities();
 var actor = enriched.Results.First();
@@ -133,7 +133,7 @@ if (actor.IsEnriched)
 }
 
 
-//enrich feed results with reactions
+// enrich feed results with reactions
 
 var activityData = new Activity("bob", "cook", "burger")
 {
@@ -161,6 +161,16 @@ Console.WriteLine(enrichedActivity.OwnReactions["comment"]); // is the $comment
 
 // all reactions enrichment can be selected
 var enriched = await this._user1.GetEnrichedFlatActivities(GetOptions.Default.WithReaction(ReactionOption.With().Counts().Own().Recent()));
+
+// Personalization
+var input = new Dictionary<string, object>()
+{
+    {"feed_slug", "my_personalized_feed"},
+    {"user_id", "john"},
+    {"limit", 20},
+    {"ranking", "my_ranking"}
+};
+var response = await client.Personalization.Get("my_endpoint", input);
 ```
 
 ### Copyright and License Information

src/stream-net-tests/IntegrationTests.cs

@@ -1875,10 +1875,6 @@ public async Task TestBatchPartialUpdate()
 
             Assert.IsNull(updatedActs[0].GetData<string>("custom_thing3"));
             var extraData = updatedActs[2].GetData<Dictionary<string, string>>("details");
-            if (extraData == null)
-            {
-                Console.WriteLine("IT'S NULL   " + updatedActs[2].ForeignId);
-            }
             Assert.AreEqual("nowhere", extraData["address"]);
 
             //ID
@@ -2410,5 +2406,34 @@ public async Task TestEnrich()
             Assert.True(enrichedAct.ReactionCounts.ContainsKey(reaction.Kind));
             Assert.AreEqual(1, enrichedAct.ReactionCounts[reaction.Kind]);
         }
+
+        [Test]
+        [Ignore("Not always needed, set credentials to run when needed")]
+        public async Task ReadPersonalization()
+        {
+            var _p = new Stream.StreamClient(
+                "some_key",
+                "some_secret",
+                new Stream.StreamClientOptions()
+                {
+                    Location = Stream.StreamApiLocation.Dublin,
+                    PersonalizationLocation = Stream.StreamApiLocation.USEast,
+                    Timeout = 10000,
+                    PersonalizationTimeout = 10000
+                });
+
+            var response = await _p.Personalization.Get("etoro_newsfeed", new Dictionary<string, object>()
+                {
+                    {"feed_slug", "newsfeed"},
+                    {"user_id", "crembo"},
+                    {"limit", 20},
+                    {"ranking", "etoro"}
+                });
+
+            var d = new Dictionary<string, object>(response);
+            Assert.AreEqual(41021, d["app_id"]);
+            Assert.True(d.ContainsKey("duration"));
+            Assert.True(d.ContainsKey("results"));
+        }
     }
 }

src/stream-net/Personalization.cs

@@ -0,0 +1,60 @@
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using Stream.Rest;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading.Tasks;
+
+namespace Stream
+{
+    public class Personalization
+    {
+        readonly StreamClient _client;
+
+        internal Personalization(StreamClient client)
+        {
+            _client = client;
+        }
+
+        public async Task<IDictionary<string, object>> Get(string endpoint, IDictionary<string, object> data)
+        {
+            var request = this._client.BuildPersonalizationRequest(endpoint + "/", HttpMethod.GET);
+            foreach(KeyValuePair<string, object> entry in data)
+            {
+                request.AddQueryParameter(entry.Key, Convert.ToString(entry.Value));
+            }
+
+            var response = await this._client.MakeRequest(request);
+            if ((int)response.StatusCode < 300)
+                return JsonConvert.DeserializeObject<Dictionary<string, object>>(response.Content);
+
+            throw StreamException.FromResponse(response);
+        }
+
+        public async Task<IDictionary<string, object>> Post(string endpoint, IDictionary<string, object> data)
+        {
+            var request = this._client.BuildJWTAppRequest(endpoint + "/", HttpMethod.POST);
+            request.SetJsonBody(JsonConvert.SerializeObject(data));
+
+            var response = await this._client.MakeRequest(request);
+            if ((int)response.StatusCode < 300)
+                return JsonConvert.DeserializeObject<Dictionary<string, object>>(response.Content);
+
+            throw StreamException.FromResponse(response);
+        }
+
+        public async Task Delete(string endpoint, IDictionary<string, object> data)
+        {
+            var request = this._client.BuildJWTAppRequest(endpoint + "/", HttpMethod.DELETE);
+            foreach(KeyValuePair<string, object> entry in data)
+            {
+                request.AddQueryParameter(entry.Key, Convert.ToString(entry.Value));
+            }
+
+            var response = await this._client.MakeRequest(request);
+            if ((int)response.StatusCode >= 300)
+                throw StreamException.FromResponse(response);
+        }
+    };
+}

src/stream-net/Rest/RestRequest.cs

@@ -25,7 +25,7 @@ internal RestRequest(string resource, HttpMethod method)
         public string Resource { get; private set; }
 
         public string JsonBody { get; private set; }
-        
+
         public void AddHeader(string name, string value)
         {
             _headers[name] = value;

src/stream-net/Rest/RestResponse.cs

@@ -24,7 +24,7 @@ internal static async Task<RestResponse> FromResponseMessage(HttpResponseMessage
             {
                 StatusCode = message.StatusCode
             };
-            
+
             response.Content = await message.Content.ReadAsStringAsync();
 
             return response;

src/stream-net/StreamClient.cs

@@ -13,6 +13,8 @@ public class StreamClient : IStreamClient
     {
         internal const string BaseUrlFormat = "https://{0}-api.stream-io-api.com";
         internal const string BaseUrlPath = "/api/v1.0/";
+        internal const string BasePersonalizationUrlFormat = "https://{0}-personalization.stream-io-api.com";
+        internal const string BasePersonalizationUrlPath = "/personalization/v1.0/";
         internal const string ActivitiesUrlPath = "activities/";
         internal const int ActivityCopyLimitDefault = 300;
         internal const int ActivityCopyLimitMax = 1000;
@@ -38,9 +40,23 @@ public StreamClient(string apiKey, string apiSecret, StreamClientOptions options
             _apiKey = apiKey;
             _apiSecret = apiSecret;
             _options = options ?? StreamClientOptions.Default;
-            _client = new RestClient(GetBaseUrl(), TimeSpan.FromMilliseconds(_options.Timeout));
+            _client = new RestClient(GetBaseUrl(_options.Location), TimeSpan.FromMilliseconds(_options.Timeout));
         }
 
+        private StreamClient(string apiKey, string apiSecret, RestClient client, StreamClientOptions options = null)
+        {
+            if (string.IsNullOrWhiteSpace(apiKey))
+                throw new ArgumentNullException("apiKey", "Must have an apiKey");
+            if (string.IsNullOrWhiteSpace(apiSecret))
+                throw new ArgumentNullException("apiSecret", "Must have an apiSecret");
+
+            _apiKey = apiKey;
+            _apiSecret = apiSecret;
+            _options = options ?? StreamClientOptions.Default;
+            _client = client;
+        }
+
+
         /// <summary>
         /// Get a feed
         /// </summary>
@@ -124,39 +140,50 @@ public Users Users
             }
         }
 
-        private Uri GetBaseUrl()
+        public Personalization Personalization
         {
-            string region = "";
-            switch (_options.Location)
+            get
+            {
+                var _personalization = new RestClient(GetBasePersonalizationUrl(_options.PersonalizationLocation), TimeSpan.FromMilliseconds(_options.PersonalizationTimeout));
+                return new Personalization(new StreamClient(_apiKey, _apiSecret, _personalization, _options));
+            }
+        }
+
+        private Uri GetBaseUrl(StreamApiLocation location)
+        {
+            return new Uri(string.Format(BaseUrlFormat, GetRegion(_options.Location)));
+        }
+
+        private Uri GetBasePersonalizationUrl(StreamApiLocation location)
+        {
+            return new Uri(string.Format(BasePersonalizationUrlFormat, GetRegion(_options.PersonalizationLocation)));
+        }
+
+        private string GetRegion(StreamApiLocation location)
+        {
+            switch (location)
             {
                 case StreamApiLocation.USEast:
-                    region = "us-east";
-                    break;
+                    return "us-east";
                 case StreamApiLocation.Tokyo:
-                    region = "tokyo";
-                    break;
+                    return "tokyo";
                 case StreamApiLocation.Dublin:
-                    region = "dublin";
-                    break;
+                    return "dublin";
                 case StreamApiLocation.Singapore:
-                    region = "singapore";
-                    break;
+                    return "singapore";
                 case StreamApiLocation.USWest:
-                    region = "us-west";
-                    break;
+                    return "us-west";
                 case StreamApiLocation.EUCentral:
-                    region = "eu-central";
-                    break;
+                    return "eu-central";
                 default:
-                    break;
+                    return "us-east";
             }
-            return new Uri(string.Format(BaseUrlFormat, region));
         }
 
-        private RestRequest BuildRestRequest(string fullPath, HttpMethod method)
+        private RestRequest BuildRestRequest(string fullPath, HttpMethod method, string userID = null)
         {
             var request = new RestRequest(fullPath, method);
-            request.AddHeader("Authorization", JWToken("*"));
+            request.AddHeader("Authorization", JWToken("*", userID));
             request.AddHeader("stream-auth-type", "jwt");
             request.AddQueryParameter("api_key", _apiKey);
             return request;
@@ -189,6 +216,11 @@ internal RestRequest BuildAppRequest(string path, HttpMethod method)
             return request;
         }
 
+        internal RestRequest BuildPersonalizationRequest(string path, HttpMethod method)
+        {
+            return BuildRestRequest(BasePersonalizationUrlPath + path, method, "*");
+        }
+
         internal void SignRequest(RestRequest request)
         {
             // make signature
@@ -237,14 +269,18 @@ internal string Sign256(string feedId)
             return Convert.ToBase64String(hmac.ComputeHash(encoding.GetBytes(feedId)));
         }
 
-        internal string JWToken(string feedId)
+        internal string JWToken(string feedId, string userID = null)
         {
-            var payload = new
+            var payload = new Dictionary<string, string>()
             {
-                resource = "*",
-                action = "*",
-                feed_id = feedId
+                {"resource", "*"},
+                {"action", "*"},
+                {"feed_id", feedId}
             };
+            if (userID != null)
+            {
+                payload["user_id"] = userID;
+            }
             return this.JWToken(payload);
         }
 

src/stream-net/StreamClientOptions.cs

@@ -25,15 +25,25 @@ public class StreamClientOptions
         /// <remarks>Default is 3000</remarks>
         public int Timeout { get; set; }
 
+        /// <summary>
+        /// Number of milliseconds to wait on requests to personalization
+        /// </summary>
+        /// <remarks>Default is 3000</remarks>
+        public int PersonalizationTimeout { get; set; }
+
         public StreamApiLocation Location { get; set; }
 
+        public StreamApiLocation PersonalizationLocation { get; set; }
+
         public bool ExpireTokens { get; set; }
 
         public StreamClientOptions()
         {
             ExpireTokens = false;
             Location = StreamApiLocation.USEast;
             Timeout = 3000;
+            PersonalizationTimeout = 3000;
+            PersonalizationLocation = StreamApiLocation.USEast;
         }
     }
 }

src/stream-net/StreamException.cs

@@ -13,7 +13,7 @@ public class StreamException : Exception
         internal StreamException(ExceptionState state)
             : base(message: state.Detail)
         {
-        
+
         }
 
         internal class ExceptionState
@@ -30,7 +30,7 @@ internal class ExceptionState
 
         internal static StreamException FromResponse(RestResponse response)
         {
-            //If we get an error response from getstream.io with the following structure then use it to populate the exception details, 
+            //If we get an error response from getstream.io with the following structure then use it to populate the exception details,
             //otherwise fill in the properties from the response, the most likely case being when we get a timeout.
             //{"code": 6, "detail": "The following feeds are not configured: 'secret'", "duration": "4ms", "exception": "FeedConfigException", "status_code": 400}