Made things public, readme fixes, Renamed Driver -> CloudCMSDriver

mibewh · mibewh · commit 9c6e92cc9d2f · 2019-01-17T15:13:54.000-05:00
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ The [Cloud CMS](https://www.cloudcms.com/) C# driver is a .NET core client libra
 Command Line:
 
 ````
-dotnet add cloudcms
+dotnet add package cloudcms
 ````
 
 Visual Studio:
@@ -18,7 +18,7 @@ Install-Package cloudcms
 
 ## Connecting to Cloud CMS
 
-To connect to Cloud CMS, use the static `CloudCMS.ConnectAsync` method. This takes either a file path to a `gitana.json` file, a JObject json object, dictionary, or ConnectionObject.
+To connect to Cloud CMS, use the static `CloudCMSDriver.ConnectAsync` method. This takes either a file path to a `gitana.json` file, a JObject json object, dictionary, or ConnectionObject.
 
 The required API key properties for this are:
 
@@ -32,16 +32,16 @@ Connection examples:
 
 ````csharp
 string path = "gitana.json";
-IPlatform platform1 = await CloudCMS.ConnectAsync(path);
+IPlatform platform1 = await CloudCMSDriver.ConnectAsync(path);
 
 JObject configObj = ...;
-IPlatform platform2 = await CloudCMS.ConnectAsync(configObj);
+IPlatform platform2 = await CloudCMSDriver.ConnectAsync(configObj);
 
 IDictionary<string, string> configDict = ...;
-IPlatform platform3 = await CloudCMS.ConnectAsync(configDict);
+IPlatform platform3 = await CloudCMSDriver.ConnectAsync(configDict);
 
 ConnectionConfig config = ...;
-IPlatform platform4 = await CloudCMS.ConnectAsync(config);
+IPlatform platform4 = await CloudCMSDriver.ConnectAsync(config);
 ````
 
 ## Examples
@@ -51,7 +51,7 @@ Below are some examples of how you might use this driver:
 ````csharp
 // Connect to Cloud CMS
 string path = "gitana.json";
-IPlatform platform = await CloudCMS.ConnectAsync(path);
+IPlatform platform = await CloudCMSDriver.ConnectAsync(path);
 
 // Read repository
 IRepository repository = await platform.ReadRepositoryAsync("<repositoryId>");
diff --git a/cloudcms-csharp-driver.csproj b/cloudcms-csharp-driver.csproj
@@ -6,12 +6,12 @@
     <RootNamespace>CloudCMS</RootNamespace>
 
     <PackageId>cloudcms</PackageId>
-    <PackageVersion>1.0.0</PackageVersion>
+    <PackageVersion>1.0.2</PackageVersion>
     <Title>CloudCMS Driver</Title>
     <Description>C# .NET driver for CloudCMS</Description>
     <Summary>C# .NET driver for CloudCMS</Summary>
     <PackageTags>cloudcms;cms;</PackageTags>
-    <Authors>cloudcms</Authors>
+    <Authors>Michael Whitman</Authors>
     <RepositoryUrl>https://github.com/gitana/cloudcms-csharp-driver</RepositoryUrl>
     <PackageIconUrl>https://github.com/gitana/cloudcms-csharp-driver/blob/master/icon.png?raw=true</PackageIconUrl>
     <PackageLicenseFile>LICENSE</PackageLicenseFile>
diff --git a/src/CloudCMS.cs b/src/CloudCMS.cs
diff --git a/src/CloudCMSDriver.cs b/src/CloudCMSDriver.cs
@@ -13,19 +13,53 @@
 
 namespace CloudCMS
 {
-    class Driver
+    public class CloudCMSDriver
     {
+        // Static connection methods
+
+        public static async Task<IPlatform> ConnectAsync(string configPath)
+        {
+            using (StreamReader file = File.OpenText(configPath))
+            using (JsonTextReader reader = new JsonTextReader(file))
+            {
+                JObject json = (JObject)JToken.ReadFrom(reader);
+                ConnectionConfig config = json.ToObject<ConnectionConfig>();
+                
+                return await ConnectAsync(config);
+            }
+        }
+
+        public static async Task<IPlatform> ConnectAsync(IDictionary<string, string> configDict)
+        {
+            JObject configObject = JObject.FromObject(configDict);
+            return await ConnectAsync(configObject);
+        }
+
+        public static async Task<IPlatform> ConnectAsync(JObject configObject)
+        {
+            ConnectionConfig config = configObject.ToObject<ConnectionConfig>();
+            return await ConnectAsync(config);
+        }
+
+        public static async Task<IPlatform> ConnectAsync(ConnectionConfig config)
+        {
+            CloudCMSDriver driver = new CloudCMSDriver();
+            return await driver.doConnectAsync(config);
+        }
+
+        // Instance methods
+
         private static string TOKEN_URI = "/oauth/token";
 
         private ConnectionConfig Config;
-        private Token token;
+        private OAuthToken token;
 
-        public Driver()
+        protected CloudCMSDriver()
         {
             
         }
 
-        public async Task<IPlatform> ConnectAsync(ConnectionConfig config)
+        private async Task<IPlatform> doConnectAsync(ConnectionConfig config)
         {
             if (config.clientKey == null)
             {
@@ -47,7 +81,7 @@ public async Task<IPlatform> ConnectAsync(ConnectionConfig config)
             {
                 throw new OAuthException("Missing required config property baseURL");                
             }
-            
+
             this.Config = config;
             await GetTokenAsync();
             return await ReadPlatformAsync();
@@ -152,7 +186,7 @@ private async Task GetTokenAsync()
                 HttpResponseMessage response = await client.PostAsync(Config.baseURL + TOKEN_URI, requestBody);
                 string responseBody = await response.Content.ReadAsStringAsync();
 
-                token = JsonConvert.DeserializeObject<Token>(responseBody);
+                token = JsonConvert.DeserializeObject<OAuthToken>(responseBody);
                 token.expireTime = DateTime.UtcNow.AddSeconds(token.expires_in);
             }
         }
@@ -175,7 +209,7 @@ private async Task RefreshTokenAsync()
                 HttpResponseMessage response = await client.PostAsync(Config.baseURL + TOKEN_URI, requestBody);
                 string responseBody = await response.Content.ReadAsStringAsync();
 
-                token = JsonConvert.DeserializeObject<Token>(responseBody);
+                token = JsonConvert.DeserializeObject<OAuthToken>(responseBody);
                 token.expireTime = DateTime.UtcNow.AddSeconds(token.expires_in);
             }
         }
diff --git a/src/ConnectionConfig.cs b/src/ConnectionConfig.cs
@@ -1,6 +1,6 @@
 namespace CloudCMS
 {
-    class ConnectionConfig
+    public class ConnectionConfig
     {
         public string clientKey { get; set; }
         public string clientSecret { get; set; }
diff --git a/src/OAuthToken.cs b/src/OAuthToken.cs
@@ -2,7 +2,7 @@
 
 namespace CloudCMS
 {
-    class Token
+    public class OAuthToken
     {
         public string access_token { get; set; }
         public string refresh_token { get; set; }
diff --git a/src/branches/Branch.cs b/src/branches/Branch.cs
@@ -8,7 +8,7 @@
 
 namespace CloudCMS.Branches
 {
-    class Branch : AbstractRepositoryDocument,
+    public class Branch : AbstractRepositoryDocument,
                     IBranch
     {
         public Branch(IRepository repository, JObject obj) : base(repository, obj)
diff --git a/src/branches/IBranch.cs b/src/branches/IBranch.cs
@@ -6,7 +6,7 @@
 
 namespace CloudCMS.Branches
 {
-    interface IBranch : IRepositoryDocument
+    public interface IBranch : IRepositoryDocument
     {
         Task<INode> ReadNodeAsync(string nodeId);
 
diff --git a/src/documents/AbstractDocument.cs b/src/documents/AbstractDocument.cs
@@ -4,17 +4,17 @@
 
 namespace CloudCMS.Documents
 {
-    abstract class AbstractDocument : IDocument
+    public abstract class AbstractDocument : IDocument
     {
         public string Id { get; set; }
 
         public JObject Data { get; set; }
 
         public abstract string URI { get; }
 
-        public Driver Driver { get; }
+        public CloudCMSDriver Driver { get; }
 
-        protected AbstractDocument(Driver driver, JObject obj)
+        protected AbstractDocument(CloudCMSDriver driver, JObject obj)
         {
             this.Driver = driver;
             this.Id = obj.GetValue("_doc").ToString();
diff --git a/src/documents/IDocument.cs b/src/documents/IDocument.cs
@@ -3,13 +3,13 @@
 
 namespace CloudCMS.Documents
 {
-    interface IDocument
+    public interface IDocument
     {
         string Id { get; set; }
 
         JObject Data { get; set; }
 
-        Driver Driver { get; }
+        CloudCMSDriver Driver { get; }
 
         string URI { get; }
 
diff --git a/src/exceptions/CloudCMSRequestException.cs b/src/exceptions/CloudCMSRequestException.cs
@@ -3,7 +3,7 @@
 
 namespace CloudCMS.Exceptions
 {
-    class CloudCMSRequestException : SystemException
+    public class CloudCMSRequestException : SystemException
     {
         public CloudCMSRequestException(string message) : base(message)
         {
diff --git a/src/exceptions/OAuthException.cs b/src/exceptions/OAuthException.cs
@@ -2,7 +2,7 @@
 
 namespace CloudCMS.Exceptions
 {
-    class OAuthException : SystemException
+    public class OAuthException : SystemException
     {
         public OAuthException(string message) : base(message)
         {
diff --git a/src/nodes/INode.cs b/src/nodes/INode.cs
@@ -3,7 +3,7 @@
 
 namespace CloudCMS.Nodes
 {
-    interface INode : IRepositoryDocument
+    public interface INode : IRepositoryDocument
     {
         IBranch Branch { get; }
 
diff --git a/src/nodes/Node.cs b/src/nodes/Node.cs
@@ -6,7 +6,7 @@
 
 namespace CloudCMS.Nodes
 {
-    class Node : AbstractRepositoryDocument,
+    public class Node : AbstractRepositoryDocument,
                 INode
     {
         public IBranch Branch { get; }
diff --git a/src/nodes/NodeUtil.cs b/src/nodes/NodeUtil.cs
@@ -4,7 +4,7 @@
 
 namespace CloudCMS.Nodes
 {
-    class NodeUtil
+    public class NodeUtil
     {
         public static List<INode> NodeList(JArray nodeArray, IBranch branch)
         {
diff --git a/src/platforms/IPlatform.cs b/src/platforms/IPlatform.cs
@@ -5,7 +5,7 @@
 
 namespace CloudCMS.Platforms
 {
-    interface IPlatform : IDocument
+    public interface IPlatform : IDocument
     {
         Task<List<IRepository>> ListRepositoriesAsync();
 
diff --git a/src/platforms/Platform.cs b/src/platforms/Platform.cs
@@ -9,7 +9,7 @@ namespace CloudCMS.Platforms
     class Platform : AbstractDocument,
                      IPlatform
     {
-        public Platform(Driver driver, JObject obj) : base(driver, obj)
+        public Platform(CloudCMSDriver driver, JObject obj) : base(driver, obj)
         {
 
         }
diff --git a/src/repositories/AbstractRepositoryDocument.cs b/src/repositories/AbstractRepositoryDocument.cs
@@ -3,7 +3,7 @@
 
 namespace CloudCMS.Repositories
 {
-    abstract class AbstractRepositoryDocument : AbstractDocument,
+    public abstract class AbstractRepositoryDocument : AbstractDocument,
                                                 IRepositoryDocument
     {
         public IRepository Repository { get; }
diff --git a/src/repositories/IRepository.cs b/src/repositories/IRepository.cs
@@ -5,7 +5,7 @@
 
 namespace CloudCMS.Repositories
 {
-    interface IRepository : IDocument
+    public interface IRepository : IDocument
     {
         Task<List<IBranch>> ListBranchesAsync();
 
diff --git a/src/repositories/IRepositoryDocument.cs b/src/repositories/IRepositoryDocument.cs
@@ -2,7 +2,7 @@
 
 namespace CloudCMS.Repositories
 {
-    interface IRepositoryDocument : IDocument
+    public interface IRepositoryDocument : IDocument
     {
         IRepository Repository { get; }
 
diff --git a/src/repositories/Repository.cs b/src/repositories/Repository.cs
@@ -11,7 +11,7 @@ class Repository : AbstractDocument,
     {
         public string PlatformId { get; }
 
-        public Repository(Driver driver, JObject obj) : base(driver, obj)
+        public Repository(CloudCMSDriver driver, JObject obj) : base(driver, obj)
         {
             this.PlatformId = obj.SelectToken("platformId").ToString();
         }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`namespace CloudCMS`
`2`	`2`	`{`
`3`		`- class ConnectionConfig`
	`3`	`+ public class ConnectionConfig`
`4`	`4`	`{`
`5`	`5`	`public string clientKey { get; set; }`
`6`	`6`	`public string clientSecret { get; set; }`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace CloudCMS`
`4`	`4`	`{`
`5`		`- class Token`
	`5`	`+ public class OAuthToken`
`6`	`6`	`{`
`7`	`7`	`public string access_token { get; set; }`
`8`	`8`	`public string refresh_token { get; set; }`
Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@`
`8`	`8`
`9`	`9`	`namespace CloudCMS.Branches`
`10`	`10`	`{`
`11`		`- class Branch : AbstractRepositoryDocument,`
	`11`	`+ public class Branch : AbstractRepositoryDocument,`
`12`	`12`	`IBranch`
`13`	`13`	`{`
`14`	`14`	`public Branch(IRepository repository, JObject obj) : base(repository, obj)`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`
`7`	`7`	`namespace CloudCMS.Branches`
`8`	`8`	`{`
`9`		`- interface IBranch : IRepositoryDocument`
	`9`	`+ public interface IBranch : IRepositoryDocument`
`10`	`10`	`{`
`11`	`11`	`Task<INode> ReadNodeAsync(string nodeId);`
`12`	`12`
Original file line number	Diff line number	Diff line change
`@@ -4,17 +4,17 @@`
`4`	`4`
`5`	`5`	`namespace CloudCMS.Documents`
`6`	`6`	`{`
`7`		`- abstract class AbstractDocument : IDocument`
	`7`	`+ public abstract class AbstractDocument : IDocument`
`8`	`8`	`{`
`9`	`9`	`public string Id { get; set; }`
`10`	`10`
`11`	`11`	`public JObject Data { get; set; }`
`12`	`12`
`13`	`13`	`public abstract string URI { get; }`
`14`	`14`
`15`		`- public Driver Driver { get; }`
	`15`	`+ public CloudCMSDriver Driver { get; }`
`16`	`16`
`17`		`- protected AbstractDocument(Driver driver, JObject obj)`
	`17`	`+ protected AbstractDocument(CloudCMSDriver driver, JObject obj)`
`18`	`18`	`{`
`19`	`19`	`this.Driver = driver;`
`20`	`20`	`this.Id = obj.GetValue("_doc").ToString();`
Original file line number	Diff line number	Diff line change
`@@ -3,13 +3,13 @@`
`3`	`3`
`4`	`4`	`namespace CloudCMS.Documents`
`5`	`5`	`{`
`6`		`- interface IDocument`
	`6`	`+ public interface IDocument`
`7`	`7`	`{`
`8`	`8`	`string Id { get; set; }`
`9`	`9`
`10`	`10`	`JObject Data { get; set; }`
`11`	`11`
`12`		`- Driver Driver { get; }`
	`12`	`+ CloudCMSDriver Driver { get; }`
`13`	`13`
`14`	`14`	`string URI { get; }`
`15`	`15`