Can I just die already?

Author: ObsidianMinor

src/Gfycat.Net.Analytics/CameraDirection.cs

@@ -1,11 +1,9 @@
-using System;
-using System.Collections.Generic;
-using System.Text;
-
+#pragma warning disable CS1591
 namespace Gfycat.Analytics
 {
     public enum CameraDirection
     {
+        None,
         Front,
         Back
     }

src/Gfycat.Net.Analytics/Gfycat.Net.Analytics.csproj

@@ -16,6 +16,10 @@
     <Description>An unofficial wrapper around the Gfycat analytics API</Description>
   </PropertyGroup>
 
+  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Debug|AnyCPU'">
+    <DocumentationFile>bin\Debug\netstandard1.2\.xml</DocumentationFile>
+  </PropertyGroup>
+
   <ItemGroup>
     <ProjectReference Include="..\Gfycat.Net\Gfycat.Net.csproj" />
   </ItemGroup>

src/Gfycat.Net.Analytics/GfycatAnalyticsClient.cs

@@ -5,20 +5,40 @@
 using System.Net;
 using System.Linq;
 
+[assembly: CLSCompliant(true)]
+
 namespace Gfycat.Analytics
 {
+    /// <summary>
+    /// Represents a client for communicating with the Gfycat analytics API. See https://developers.gfycat.com/analytics for info on when to use this client
+    /// </summary>
     public class GfycatAnalyticsClient
     {
         internal GfycatAnalyticsClientConfig Config { get; }
 
+        /// <summary>
+        /// Gets the current user's tracking cookie
+        /// </summary>
         public string CurrentUserTrackingCookie { get; private set; } = GfycatAnalyticsClientConfig.GenerateCookie();
 
+        /// <summary>
+        /// Creates a new client using the specified app name, app Id, app version, and user tracking cookie
+        /// </summary>
+        /// <param name="appName"></param>
+        /// <param name="appId"></param>
+        /// <param name="appVersion"></param>
+        /// <param name="userTrackingCookie"></param>
         public GfycatAnalyticsClient(string appName, string appId, Version appVersion, string userTrackingCookie)
         {
             Config = new GfycatAnalyticsClientConfig(appName, appId, appVersion);
             CurrentUserTrackingCookie = userTrackingCookie;
         }
 
+        /// <summary>
+        /// Creates a new client using the specified config and user tracking cookie
+        /// </summary>
+        /// <param name="config"></param>
+        /// <param name="userTrackingCookie"></param>
         public GfycatAnalyticsClient(GfycatAnalyticsClientConfig config, string userTrackingCookie)
         {
             Config = config;
@@ -58,7 +78,7 @@ private async Task<RestResponse> SendImpressionInternalAsync(Impression impressi
             if (impression == null)
                 throw new ArgumentNullException(nameof(impression), "The provided impression can't be null!");
 
-            return await SendInternalAsync("POST", GfycatAnalyticsClientConfig.BaseImpressionsUrl + impression.CreateQuery(), options);
+            return await SendInternalAsync("POST", GfycatAnalyticsClientConfig.BaseImpressionsUrl + impression.CreateQuery(this), options);
         }
 
         private async Task<RestResponse> SendImpressionsBulkInternalAsync(IEnumerable<Impression> impressions, RequestOptions options)
@@ -68,30 +88,48 @@ private async Task<RestResponse> SendImpressionsBulkInternalAsync(IEnumerable<Im
             if (impressions.Count() == 0)
                 throw new ArgumentException("You can't post an impression for nothing!");
 
-            return await SendInternalAsync("POST", GfycatAnalyticsClientConfig.BaseImpressionsUrl + impressions.CreateQuery(), options);
+            return await SendInternalAsync("POST", GfycatAnalyticsClientConfig.BaseImpressionsUrl + impressions.CreateQuery(this), options);
         }
 
+        /// <summary>
+        /// Sends an impression using the specified gfy, context, flow, view tag, and keyword
+        /// </summary>
+        /// <param name="gfy"></param>
+        /// <param name="context"></param>
+        /// <param name="flow"></param>
+        /// <param name="viewTag"></param>
+        /// <param name="keyword"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         public async Task SendImpressionAsync(Gfy gfy, ImpressionContext context = ImpressionContext.None, ImpressionFlow flow = ImpressionFlow.None, string viewTag = null, string keyword = null, RequestOptions options = null)
         {
             await SendImpressionAsync(new Impression
             {
-                AppId = Config.AppId,
-                Version = Config.AppVersion.ToString(),
-                SessionTrackingCookie = Config.SessionId,
-                UserTrackingCookie = CurrentUserTrackingCookie,
-                GfycatId = gfy.Id,
-                Context = (context == ImpressionContext.None ? null : context.ToString()),
-                Flow = (flow == ImpressionFlow.None ? null : flow.ToString()),
+                Gfycat = gfy,
+                Context = context,
+                Flow = flow,
                 Keyword = keyword,
                 ViewTag = viewTag
             }, options);
         }
 
+        /// <summary>
+        /// Sends one impression to Gfycat impressions
+        /// </summary>
+        /// <param name="impression"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         public async Task SendImpressionAsync(Impression impression, RequestOptions options = null)
         {
             await SendImpressionInternalAsync(impression, options);
         }
 
+        /// <summary>
+        /// Sends multiple impressions to Gfycat impressions
+        /// </summary>
+        /// <param name="impressions"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         public async Task SendImpressionsBulkAsync(IEnumerable<Impression> impressions, RequestOptions options = null)
         {
             await SendImpressionsBulkInternalAsync(impressions, options);
@@ -128,33 +166,59 @@ private async Task<RestResponse> SendAnalyticsInternalAsync(AnalyticsEvent aEven
                 }.Concat(data).ToArray()
                 ), options);
         }
-
+        /// <summary>
+        /// Sends a first launch event to Gfycat analytics
+        /// </summary>
+        /// <param name="options"></param>
+        /// <returns></returns>
         public async Task SendAppFirstLaunchEventAsync(RequestOptions options = null)
         {
             await SendAnalyticsInternalAsync(AnalyticsEvent.AppFirstLaunch, options, ("utc", CurrentUserTrackingCookie));
         }
-
+        /// <summary>
+        /// Sends a video share event to Gfycat analytics
+        /// </summary>
+        /// <param name="gfy"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         public async Task SendShareVideoEventAsync(Gfy gfy, RequestOptions options = null)
         {
             if (gfy == null)
                 throw new ArgumentNullException("The provided Gfy was null");
 
             await SendAnalyticsInternalAsync(AnalyticsEvent.ShareGfy, options, ("utc", CurrentUserTrackingCookie), ("gfyid", gfy.Id));
         }
-
+        /// <summary>
+        /// Sends a tap category event to Gfycat analytics
+        /// </summary>
+        /// <param name="keyword"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         public async Task SendTapCategoryEventAsync(string keyword, RequestOptions options = null)
         {
             if (string.IsNullOrWhiteSpace(keyword))
                 throw new ArgumentException("The provided keyword is invalid!");
 
             await SendAnalyticsInternalAsync(AnalyticsEvent.SelectCategory, options, ("utc", CurrentUserTrackingCookie), ("keyword", keyword));
         }
-
+        /// <summary>
+        /// Sends a video creation event to Gfycat analytics
+        /// </summary>
+        /// <param name="videoLengthMilliseconds"></param>
+        /// <param name="cameraDirection"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         public async Task SendCreateVideoEventAsync(int? videoLengthMilliseconds = null, CameraDirection? cameraDirection = null, RequestOptions options = null)
         {
-            await SendAnalyticsInternalAsync(AnalyticsEvent.CreateVideo, options, ("utc", CurrentUserTrackingCookie), ("length", videoLengthMilliseconds), ("context", cameraDirection));
+            await SendAnalyticsInternalAsync(AnalyticsEvent.CreateVideo, options, ("utc", CurrentUserTrackingCookie), ("length", videoLengthMilliseconds), ("context", cameraDirection == CameraDirection.None ? null : cameraDirection));
         }
 
+        /// <summary>
+        /// Sends a search videos event to Gfycat analytics
+        /// </summary>
+        /// <param name="keyword"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         public async Task SendSearchVideosEventAsync(string keyword, RequestOptions options = null)
         {
             if (string.IsNullOrWhiteSpace(keyword))
@@ -163,16 +227,36 @@ public async Task SendSearchVideosEventAsync(string keyword, RequestOptions opti
             await SendAnalyticsInternalAsync(AnalyticsEvent.SearchVideo, options, ("utc", CurrentUserTrackingCookie), ("keyword", keyword));
         }
 
+        /// <summary>
+        /// Sends a scoll in categories event to Gfycat analytics
+        /// </summary>
+        /// <param name="count"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         public async Task SendScrollInCategoriesEventAsync(int count, RequestOptions options = null)
         {
             await SendAnalyticsInternalAsync(AnalyticsEvent.ScrollInCategories, options, ("utc", CurrentUserTrackingCookie), ("count", count));
         }
 
+        /// <summary>
+        /// Sends a scroll in videos event to Gfycat analytics
+        /// </summary>
+        /// <param name="count"></param>
+        /// <param name="context"></param>
+        /// <param name="keyword"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         public async Task SendScrollInVideosEventAsync(int count, ImpressionContext context = ImpressionContext.None, string keyword = null, RequestOptions options = null)
         {
             await SendAnalyticsInternalAsync(AnalyticsEvent.ScrollInVideos, options, ("utc", CurrentUserTrackingCookie), ("count", count), ("context", (context == ImpressionContext.None ? null : context.ToString())), ("keyword", keyword));
         }
 
+        /// <summary>
+        /// Sends a video caption event to Gfycat analytics
+        /// </summary>
+        /// <param name="captionText"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         public async Task SendCaptionVideoEventAsync(string captionText, RequestOptions options = null)
         {
             if (captionText == null)
@@ -181,6 +265,12 @@ public async Task SendCaptionVideoEventAsync(string captionText, RequestOptions
             await SendAnalyticsInternalAsync(AnalyticsEvent.CaptionVideos, options, ("utc", CurrentUserTrackingCookie), ("text", captionText));
         }
 
+        /// <summary>
+        /// Sends a copy link event to Gfycat analytics
+        /// </summary>
+        /// <param name="gfy"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         public async Task SendCopyLinkEventAsync(Gfy gfy, RequestOptions options = null)
         {
             if (gfy == null)
@@ -189,6 +279,12 @@ public async Task SendCopyLinkEventAsync(Gfy gfy, RequestOptions options = null)
             await SendAnalyticsInternalAsync(AnalyticsEvent.CopyLink, options, ("utc", CurrentUserTrackingCookie), ("gfyid", gfy.Id));
         }
 
+        /// <summary>
+        /// Sends a download video event to Gfycat analytics
+        /// </summary>
+        /// <param name="gfy"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         public async Task SendDownloadVideoEventAsync(Gfy gfy, RequestOptions options = null)
         {
             if (gfy == null)
@@ -197,6 +293,12 @@ public async Task SendDownloadVideoEventAsync(Gfy gfy, RequestOptions options =
             await SendAnalyticsInternalAsync(AnalyticsEvent.DownloadVideo, options, ("utc", CurrentUserTrackingCookie), ("gfyid", gfy.Id));
         }
 
+        /// <summary>
+        /// Sends a bookmark video event to Gfycat analytics
+        /// </summary>
+        /// <param name="gfy"></param>
+        /// <param name="options"></param>
+        /// <returns></returns>
         public async Task SendBookmarkVideoEventAsync(Gfy gfy, RequestOptions options = null)
         {
             if (gfy == null)

src/Gfycat.Net.Analytics/GfycatAnalyticsClientConfig.cs

@@ -4,14 +4,35 @@
 
 namespace Gfycat.Analytics
 {
+    /// <summary>
+    /// Represents a configuration for a <see cref="GfycatAnalyticsClient"/>
+    /// </summary>
     public class GfycatAnalyticsClientConfig
     {
+        /// <summary>
+        /// Gets the base impressions url
+        /// </summary>
         public const string BaseImpressionsUrl = "https://px.gfycat.com/px.gif";
+        /// <summary>
+        /// Gets the base analytics url
+        /// </summary>
         public const string BaseAnalyticsUrl = "https://metrics.gfycat.com";
 
+        /// <summary>
+        /// Gets the app Id for this config
+        /// </summary>
         public string AppId { get; }
+        /// <summary>
+        /// Gets the app name for this config
+        /// </summary>
         public string AppName { get; }
+        /// <summary>
+        /// Gets the app version for this config
+        /// </summary>
         public Version AppVersion { get; }
+        /// <summary>
+        /// Gets the session Id for this config
+        /// </summary>
         public string SessionId { get; }
 
         /// <summary>
@@ -29,8 +50,21 @@ public class GfycatAnalyticsClientConfig
         /// </summary>
         public int DefaultTimeout { get; set; } = -1;
 
+        /// <summary>
+        /// Creates a new config using the specified app name, id, and version
+        /// </summary>
+        /// <param name="appName"></param>
+        /// <param name="appId"></param>
+        /// <param name="appVersion"></param>
         public GfycatAnalyticsClientConfig(string appName, string appId, Version appVersion) : this(appName, appId, appVersion, GenerateCookie()) { }
 
+        /// <summary>
+        /// Creates a new config using the specified app name, id, version, and session Id
+        /// </summary>
+        /// <param name="appName"></param>
+        /// <param name="appId"></param>
+        /// <param name="appVersion"></param>
+        /// <param name="sessionId"></param>
         public GfycatAnalyticsClientConfig(string appName, string appId, Version appVersion, string sessionId)
         {
             AppId = appId;

src/Gfycat.Net.Analytics/Impression.cs

@@ -1,15 +1,29 @@
 namespace Gfycat.Analytics
 {
+    /// <summary>
+    /// Represents an gfy impression
+    /// </summary>
     public class Impression
     {
-        public string AppId { get; set; }
-        public string Version { get; set; }
-        public string UserTrackingCookie { get; set; }
-        public string SessionTrackingCookie { get; set; }
-        public string GfycatId { get; set; }
-        public string Context { get; set; }
+        /// <summary>
+        /// Sets the gfy this impression is for
+        /// </summary>
+        public Gfy Gfycat { get; set; }
+        /// <summary>
+        /// Sets the context of this impression
+        /// </summary>
+        public ImpressionContext Context { get; set; }
+        /// <summary>
+        /// Sets the keyword of this impression
+        /// </summary>
         public string Keyword { get; set; }
-        public string Flow { get; set; }
+        /// <summary>
+        /// Sets the flow of this impression
+        /// </summary>
+        public ImpressionFlow Flow { get; set; }
+        /// <summary>
+        /// Sets the view tag of this impression
+        /// </summary>
         public string ViewTag { get; set; }
     }
 }

src/Gfycat.Net.Analytics/ImpressionContext.cs

@@ -1,4 +1,5 @@
-namespace Gfycat.Analytics
+#pragma warning disable CS1591
+namespace Gfycat.Analytics
 {
     public enum ImpressionContext
     {

src/Gfycat.Net.Analytics/ImpressionFlow.cs

@@ -1,4 +1,5 @@
-namespace Gfycat.Analytics
+#pragma warning disable CS1591
+namespace Gfycat.Analytics
 {
     public enum ImpressionFlow
     {