Added Tests / Example projects to show the usage of the API in a WinForms application and Console Application.

Author: CallumCarmicheal

docs/Todo.md

@@ -7,11 +7,14 @@ OAuth
 Code
 - [ ] Flesh out the structure of the code to make it simpler to read
 - [ ] Trap responses in a try catch etc.
+- [ ] Write comments documentation
+- [ ] Write xml documentation
 
 .Net Wrapper 
 - [ ] A simpler way of handling everything
 - [ ] Store token for usage later, less calls to api and less database storage requirement
- 
+- [ ] Asynchronous methods with callbacks for gui implementations
+
 PHP Server
 - [ ] Flesh out authentication
 - [ ] Find and fix any exploits

src/database.sql renamed to res/database.sql

@@ -5,9 +5,11 @@ VisualStudioVersion = 14.0.25420.1
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "LiveCoding.TV .NET API Wrapper", "LiveCodingTV\LiveCoding.TV .NET API Wrapper.csproj", "{36C8BF1D-9F44-4461-870E-6951DFA43DD8}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "LiveCoding.Net", "..\old\src\LiveCoding.Net\LiveCoding.Net.csproj", "{65186984-815A-4260-B55D-63BFE3E34608}"
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Console -GetUserInformation", "Tests\Console_GetUserInformation\Console -GetUserInformation.csproj", "{3FBDD3A0-0020-4FEA-BB02-BD32CBEDB2AB}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestApplication", "TestApplication\TestApplication.csproj", "{3FBDD3A0-0020-4FEA-BB02-BD32CBEDB2AB}"
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Tests", "Tests", "{2938F69F-DDF4-4A54-8055-E388FCAB8B28}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WinForms - Implementing A GUI", "WinForms_GetUserInformation\WinForms - Implementing A GUI.csproj", "{5BC09953-B2B7-4200-A8B2-EDBD36BAD770}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -19,16 +21,20 @@ Global
 		{36C8BF1D-9F44-4461-870E-6951DFA43DD8}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{36C8BF1D-9F44-4461-870E-6951DFA43DD8}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{36C8BF1D-9F44-4461-870E-6951DFA43DD8}.Release|Any CPU.Build.0 = Release|Any CPU
-		{65186984-815A-4260-B55D-63BFE3E34608}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{65186984-815A-4260-B55D-63BFE3E34608}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{65186984-815A-4260-B55D-63BFE3E34608}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{65186984-815A-4260-B55D-63BFE3E34608}.Release|Any CPU.Build.0 = Release|Any CPU
 		{3FBDD3A0-0020-4FEA-BB02-BD32CBEDB2AB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{3FBDD3A0-0020-4FEA-BB02-BD32CBEDB2AB}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{3FBDD3A0-0020-4FEA-BB02-BD32CBEDB2AB}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{3FBDD3A0-0020-4FEA-BB02-BD32CBEDB2AB}.Release|Any CPU.Build.0 = Release|Any CPU
+		{5BC09953-B2B7-4200-A8B2-EDBD36BAD770}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{5BC09953-B2B7-4200-A8B2-EDBD36BAD770}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{5BC09953-B2B7-4200-A8B2-EDBD36BAD770}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{5BC09953-B2B7-4200-A8B2-EDBD36BAD770}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
+	GlobalSection(NestedProjects) = preSolution
+		{3FBDD3A0-0020-4FEA-BB02-BD32CBEDB2AB} = {2938F69F-DDF4-4A54-8055-E388FCAB8B28}
+		{5BC09953-B2B7-4200-A8B2-EDBD36BAD770} = {2938F69F-DDF4-4A54-8055-E388FCAB8B28}
+	EndGlobalSection
 EndGlobal

res/images/logo-white-alt.png

@@ -15,16 +15,18 @@ private static string FormatJson(string json) {
         }
 
         public string getAPIJson(string apiReqURL, oAuthAuth oaCreds, bool formatted = false) {
-            HttpWebRequest timeLineRequest =
+            HttpWebRequest apiRequest =
                 (HttpWebRequest)WebRequest.Create(apiReqURL);
 
             var apiReqHeaders = "{0} {1}";
-            timeLineRequest.Headers.Add("Authorization",
+            apiRequest.Headers.Add("Authorization",
                 string.Format(apiReqHeaders, oaCreds.token_type, oaCreds.access_token));
 
-            timeLineRequest.Method = "Get";
+            apiRequest.Method = "Get";
 
-            WebResponse response = timeLineRequest.GetResponse();
+
+
+            WebResponse response = apiRequest.GetResponse();
             var responseJSON = string.Empty;
             using (response)
             using (var reader = new StreamReader(response.GetResponseStream()))

src/.vs/LiveCoding.TV .NET API Wrapper/v14/.suo

@@ -27,6 +27,8 @@ public static string
             UserVideos          = User          + "livestreams/videos/",
             UserVideosLatest    = User          + "livestreams/videos/latest/",
 
+            Users               = APIBasePath + "users/",
+
             PublicUserInfo      = APIBasePath   + "users/",
             Videos              = APIBasePath   + "videos/";
 

src/LiveCoding.TV .NET API Wrapper.sln

@@ -3,6 +3,8 @@
 using System.Linq;
 using System.Text;
 using System.Threading.Tasks;
+using LiveCodingTV.API.Wrappers;
+using LiveCodingTV.API.Wrappers.Models;
 
 namespace LiveCodingTV.API {
 
@@ -48,16 +50,53 @@ public enum APICall {
     }
 
     public class Engine {
-        private Server.Request req;
+        APIRequestHandler aReq = new APIRequestHandler();
+        oAuthAuth         oaCreds;
+        Serializer        ser = new Serializer();
 
+        public Engine(oAuthAuth token) {
+            this.oaCreds = token;
+        }
+
+
+        public IUser getCurrentUser() {
+            var jsonString = aReq.getAPIJson(APIResources.User, oaCreds, true);
+
+            IUser obj;
+            var state      = ser.toUser(jsonString, out obj);
+            if (state.Error)
+                 return null;
+            else return obj;
+        }
+
+        public IUser getUser(string user) {
+            var jsonString = aReq.getAPIJson($"{APIResources.Users}{user}/", oaCreds, true);
 
-        public Engine(Server.Request request) {
-            this.req = request;
+            IUser obj;
+            var state = ser.toUser(jsonString, out obj);
+            if (state.Error)
+                 return null;
+            else return obj;
         }
 
+        public ILivestreamList getLivestreamsFromURL(string url) {
+            var jsonString = aReq.getAPIJson(url, oaCreds, true);
+
+            ILivestreamList obj;
+            var state = ser.toLivestreams(jsonString, out obj);
+            if (state.Error)
+                 return null;
+            else return obj;
+        }
 
-        public void CreateAPICall(APICall request) {
+        public ILivestreamList getLivestreamsOnAIR() {
+            var jsonString = aReq.getAPIJson(APIResources.LivestreamsOA, oaCreds, true);
 
+            ILivestreamList obj;
+            var state = ser.toLivestreams(jsonString, out obj);
+            if (state.Error)
+                 return null;
+            else return obj;
         }
     }
 }

src/LiveCodingTV/API/APIRequestHandler.cs

@@ -0,0 +1,45 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Newtonsoft.Json.Linq;
+
+namespace LiveCodingTV.API.Wrappers {
+    public enum HTTPResponse {
+        Success         = 200,
+        Unauthorised    = 403,
+        Error           = 500,
+
+        NoResponse      = 0 // Request recieved no response!
+    }
+
+    public enum ResponseState {
+        Success,
+        Error
+    }
+
+    public abstract class IAPIResponse {
+        protected string               detail;
+
+        public string ErrorDetails  { get { return detail; } }
+
+        public bool                 Valid {
+            get { return (detail == null); }
+        }
+    }
+
+    public abstract class IAPIResponseList {
+        protected Serializer sz = new Serializer();
+
+        // API RESPONSES
+        protected int               count;
+        protected string            next,  previous;
+        protected JToken            results; // This should be serialized into the required list of objects
+
+
+        public int Count            { get { return this.count; } }
+        public string URLNext       { get { return this.next; } }
+        public string URLPrevious   { get { return this.previous; } }
+    }
+}

src/LiveCodingTV/API/APIResources.cs

@@ -0,0 +1,71 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Newtonsoft.Json;
+using static LiveCodingTV.API.Wrappers.Serializer;
+
+namespace LiveCodingTV.API.Wrappers.Models {
+    /**
+
+        JSON Schema:
+            ICodingCategory {
+                url (string),
+                name (string),
+                sort (integer)
+            }
+
+        JSON Result:
+            {
+              "url": "",
+              "name": "",
+              "sort": 0
+            }
+
+        Description:
+            URL     - Url link to the coding category 
+            Name    - Name of the coding category
+            Sort    - ????
+     */
+    public class ICodingCategory {
+        public string
+            url,
+            name;
+        public int
+            sort;
+    }
+
+    /**
+        JSON Schema:
+            ICodingCategoryList {
+                count       (string),
+                next        (string),
+                previous    (string),
+                results     (array : ICodingCategory)
+            }
+
+        JSON Results: {
+              "count":      0,
+              "next":       "",
+              "previous":   "",
+              "results":    []
+            }
+
+        Description:
+            Count       - This is the total count of coding categories
+            Next        - The link to query the next set of categories
+            Previous    - The link to query the previous set of categories
+            Results     - A array of the cateogies used on LiveCoding.tv
+     */
+    public class ICodingCategoryList : IAPIResponseList {
+        public ICodingCategory[] Categories {
+            get {
+                string json = results.ToString();
+                var set = new JsonSerializerSettings() { ContractResolver = new MyContractResolver() };
+                var objs = JsonConvert.DeserializeObject<ICodingCategory[]>(json, set);
+                return objs;
+            }
+        }
+    }
+}