Merge pull request #82 from SocksM/model-generator/feature/ClientCredentialsLoginFlow

Model Generator: Client Credentials Login Flow

Author: anthonyreilly

src/NetCoreForce.Client/Models/AuthInfo.cs

@@ -31,6 +31,19 @@ public class AuthInfo
         [JsonProperty(PropertyName = "password")]
         public string Password { get; set; }
 
+        /// <summary>
+        /// Current supported auth methods
+        /// </summary>
+        public enum AuthMethodType {
+            UsernamePassword = 1,
+            ClientCredentials = 2,
+        }
+        /// <summary>
+        /// Auth type
+        /// </summary>
+        [JsonProperty(PropertyName = "authMethod")]
+        public AuthMethodType? AuthMethod { get; set; }
+
         /// <summary>
         /// Salesforce API version
         /// </summary>

src/NetCoreForce.ModelGenerator/GenConfig.cs

@@ -1,5 +1,6 @@
 using System.Collections.Generic;
 using NetCoreForce.Client.Models;
+using Newtonsoft.Json;
 
 namespace NetCoreForce.ModelGenerator
 {
@@ -15,10 +16,13 @@ public class GenConfig
         public bool IncludeCustom { get; set; }
         public bool IncludeReferences { get; set; }
 
+        [JsonIgnore]
+        public const string DefaultTokenRequestEndpoint = "https://login.salesforce.com/services/oauth2/token";
+
         public GenConfig()
         {
             this.AuthInfo = new AuthInfo(){
-                TokenRequestEndpoint = "https://login.salesforce.com/services/oauth2/token",
+                TokenRequestEndpoint = DefaultTokenRequestEndpoint,
                 ApiVersion = "v64.0"
             };
         }

src/NetCoreForce.ModelGenerator/Program.cs

@@ -1,7 +1,5 @@
 using System;
 using System.Collections.Generic;
-using System.Diagnostics;
-using System.Dynamic;
 using System.Reflection;
 using System.IO;
 using System.Linq;
@@ -17,6 +15,15 @@ namespace NetCoreForce.ModelGenerator
 {
     class Program
     {
+        /// <summary>
+        /// Gets a human-readable string for which value maps to which auth method type
+        /// </summary>
+        /// <returns>
+        /// For example: <c>1 = UsernamePassword, 2 = ClientCredentials</c>
+        /// </returns>>
+        private static string ValidAuthTypesInputString =>
+            string.Join(", ", Enum.GetValues(typeof(AuthInfo.AuthMethodType)).Cast<AuthInfo.AuthMethodType>().Select(v => $"{(int)v} = {v}"));
+
         const string defaultConfigFilename = "modelgenerator_config.json";
 
         static void Main(string[] args)
@@ -45,7 +52,7 @@ static void Main(string[] args)
                 "You can supply the API credentials either in the config file, the command parameters, or wait to be prompted for that information." + Environment.NewLine +
                 "If you choose to save the config file, be careful with it as it may contain your API credentials.";
 
-                //Authentication
+                //Authentication options
                 var clientIdOption = command.Option("--client-id",
                     "API Client ID, a.k.a. Consumer Key",
                     CommandOptionType.SingleValue);
@@ -62,6 +69,15 @@ static void Main(string[] args)
                     "API Password",
                     CommandOptionType.SingleValue);
 
+                var authMethodOption = command.Option("--auth-method",
+                    $"Auth Method, Valid inputs: {ValidAuthTypesInputString}",
+                    CommandOptionType.SingleValue);
+
+                var tokenRequestEndpointOption = command.Option("--token-request-endpoint",
+                    $"Token Request endpoint default: {GenConfig.DefaultTokenRequestEndpoint}",
+                    CommandOptionType.SingleValue);
+
+                //Config options
                 var configFileOption = command.Option("--config-file",
                     "Config file path",
                     CommandOptionType.SingleValue);
@@ -130,6 +146,22 @@ static void Main(string[] args)
                         config.AuthInfo.Password = passwordOption.Value();
                     }
 
+                    if (authMethodOption.HasValue())
+                    {
+                        if (Enum.TryParse(authMethodOption.Value(), ignoreCase: true, out AuthInfo.AuthMethodType authMethod))
+                            config.AuthInfo.AuthMethod = authMethod;
+                        else
+                        {
+                            Console.WriteLine($"Invalid auth method input, valid inputs: {ValidAuthTypesInputString}");
+                            return -1;
+                        }
+                    }
+
+                    if (tokenRequestEndpointOption.HasValue())
+                    {
+                        config.AuthInfo.TokenRequestEndpoint = tokenRequestEndpointOption.Value();
+                    }
+
                     if (customOption.HasValue())
                     {
                         config.IncludeCustom = customOption.HasValue();
@@ -209,6 +241,30 @@ static void Main(string[] args)
         private static GenConfig CheckOptions(GenConfig config)
         {
             //check required auth options
+            while (config.AuthInfo.AuthMethod == null)
+            {
+                Console.WriteLine("Enter Auth Method:");
+                string consoleReadLine = Console.ReadLine();
+
+                if (Enum.TryParse(consoleReadLine, ignoreCase: true, out AuthInfo.AuthMethodType authMethod))
+                    config.AuthInfo.AuthMethod = authMethod;
+                else
+                    Console.WriteLine($"Invalid input, valid inputs: {ValidAuthTypesInputString}");
+
+                Console.WriteLine();
+            }
+
+            while ((
+                       string.IsNullOrEmpty(config.AuthInfo.TokenRequestEndpoint) ||
+                       config.AuthInfo.TokenRequestEndpoint == GenConfig.DefaultTokenRequestEndpoint
+                   ) &&
+                   config.AuthInfo.AuthMethod == AuthInfo.AuthMethodType.ClientCredentials)
+            {
+                Console.WriteLine("Enter Token Request Endpoint:");
+                config.AuthInfo.TokenRequestEndpoint = Console.ReadLine();
+                Console.WriteLine();
+            }
+
             while (string.IsNullOrEmpty(config.AuthInfo.ClientId))
             {
                 Console.WriteLine("Enter API Client ID:");
@@ -223,14 +279,14 @@ private static GenConfig CheckOptions(GenConfig config)
                 Console.WriteLine();
             }
 
-            while (string.IsNullOrEmpty(config.AuthInfo.Username))
+            while (string.IsNullOrEmpty(config.AuthInfo.Username) && config.AuthInfo.AuthMethod == AuthInfo.AuthMethodType.UsernamePassword)
             {
                 Console.WriteLine("Enter API username:");
                 config.AuthInfo.Username = Console.ReadLine();
                 Console.WriteLine();
             }
 
-            while (string.IsNullOrEmpty(config.AuthInfo.Password))
+            while (string.IsNullOrEmpty(config.AuthInfo.Password) && config.AuthInfo.AuthMethod == AuthInfo.AuthMethodType.UsernamePassword)
             {
                 Console.WriteLine("Enter API password:");
                 config.AuthInfo.Password = Console.ReadLine();
@@ -338,8 +394,19 @@ private static async Task<ForceClient> Login(GenConfig config)
             AuthenticationClient auth = new AuthenticationClient(config.AuthInfo.ApiVersion);
             try
             {
-                await auth.UsernamePasswordAsync(config.AuthInfo.ClientId, config.AuthInfo.ClientSecret,
-                    config.AuthInfo.Username, config.AuthInfo.Password, config.AuthInfo.TokenRequestEndpoint);
+                switch (config.AuthInfo.AuthMethod)
+                {
+                    case AuthInfo.AuthMethodType.UsernamePassword:
+                        await auth.UsernamePasswordAsync(config.AuthInfo.ClientId, config.AuthInfo.ClientSecret,
+                            config.AuthInfo.Username, config.AuthInfo.Password, config.AuthInfo.TokenRequestEndpoint);
+                        break;
+                    case AuthInfo.AuthMethodType.ClientCredentials:
+                        await auth.ClientCredentialsAsync(config.AuthInfo.ClientId, config.AuthInfo.ClientSecret,
+                            config.AuthInfo.TokenRequestEndpoint);
+                        break;
+                    default:
+                        throw new ArgumentOutOfRangeException(nameof(config.AuthInfo.AuthMethod), $"authMethodInt is out of range, value: {(int)config.AuthInfo.AuthMethod}");
+                }
 
                 Console.WriteLine("Connected to Salesforce");
             }
@@ -499,7 +566,7 @@ public static async Task<string> GenClass(ForceClient client, string objectName,
                     if (field.Custom && !config.IncludeCustom)
                     {
                         continue;
-                    }                    
+                    }
 
                     gen.AppendLine("\t\t///<summary>");
                     gen.AppendLine("\t\t/// " + WebUtility.HtmlEncode(field.Label));

src/NetCoreForce.ModelGenerator/README.md

@@ -1,6 +1,6 @@
 # NetCoreForce.ModelGenerator  
 
-Generates model classes according to your enviroment, optionally including any custom objects or fields. One file per class, named [ClassName].cs
+Generates model classes according to your environment, optionally including any custom objects or fields. One file per class, named [ClassName].cs
 
 This is packaged as a custom .NET CLI tool. You can add it via
 ```
@@ -69,15 +69,16 @@ However, if you choose to save the config file, be careful with it as it does co
 ```json
 {
   "comment": "Example config file - Make a copy of this file named modegenerator_config.json with your login info",
-  "AuthInfo": {    
+  "AuthInfo": {
     "clientId": "your_client_id",
     "clientSecret": "your_client_secret",
     "username": "username",
     "password": "password",
-    "apiVersion": "v57.0",
+    "apiVersion": "v64.0",
     "authorizationEndpoint": "https://login.salesforce.com/services/oauth2/authorize",
     "tokenRequestEndpoint": "https://login.salesforce.com/services/oauth2/token",
-    "tokenRevocationEndpoint": "https://login.salesforce.com/services/oauth2/revoke"
+    "tokenRevocationEndpoint": "https://login.salesforce.com/services/oauth2/revoke",
+    "authMethod": 1
   },
   "OutputDirectory": null,
   "Objects": [