Merge branch 'development' of https://github.com/MajMcCloud/TelegramBotFramework into development

TelegramBotBase/Builder/BotBaseBuilder.cs

@@ -0,0 +1,324 @@
+using System;
+using System.Collections.Generic;
+using System.Net.Http;
+using System.Text;
+using Telegram.Bot;
+using Telegram.Bot.Types;
+using TelegramBotBase.Base;
+using TelegramBotBase.Builder.Interfaces;
+using TelegramBotBase.Commands;
+using TelegramBotBase.Form;
+using TelegramBotBase.Interfaces;
+using TelegramBotBase.Localizations;
+using TelegramBotBase.States;
+
+namespace TelegramBotBase.Builder
+{
+    public class BotBaseBuilder : IAPIKeySelectionStage, IMessageLoopSelectionStage, IStartFormSelectionStage, IBuildingStage, INetworkingSelectionStage, IBotCommandsStage, ISessionSerializationStage, ILanguageSelectionStage
+    {
+
+        String _apiKey = null;
+
+        IStartFormFactory _factory = null;
+
+        MessageClient _client = null;
+
+        List<BotCommand> _botcommands = new List<BotCommand>();
+
+        IStateMachine _statemachine = null;
+
+        IMessageLoopFactory _messageloopfactory = null;
+
+        private BotBaseBuilder()
+        {
+
+        }
+
+        public static IAPIKeySelectionStage Create()
+        {
+            return new BotBaseBuilder();
+        }
+
+        #region "Step 1 (Basic Stuff)"
+
+        public IMessageLoopSelectionStage WithAPIKey(string apiKey)
+        {
+            this._apiKey = apiKey;
+            return this;
+        }
+
+
+        public IBuildingStage QuickStart(string apiKey, Type StartForm)
+        {
+            this._apiKey = apiKey;
+            this._factory = new Factories.DefaultStartFormFactory(StartForm);
+
+            DefaultMessageLoop();
+
+            NoProxy();
+
+            OnlyStart();
+
+            NoSerialization();
+
+            DefaultLanguage();
+
+            return this;
+        }
+
+
+        public IBuildingStage QuickStart<T>(string apiKey)
+            where T : FormBase
+        {
+            this._apiKey = apiKey;
+            this._factory = new Factories.DefaultStartFormFactory(typeof(T));
+
+            DefaultMessageLoop();
+
+            NoProxy();
+
+            OnlyStart();
+
+            NoSerialization();
+
+            DefaultLanguage();
+
+            return this;
+        }
+
+        public IBuildingStage QuickStart(string apiKey, IStartFormFactory StartFormFactory)
+        {
+            this._apiKey = apiKey;
+            this._factory = StartFormFactory;
+
+            DefaultMessageLoop();
+
+            NoProxy();
+
+            OnlyStart();
+
+            NoSerialization();
+
+            DefaultLanguage();
+
+            return this;
+        }
+
+        #endregion
+
+
+        #region "Step 2 (Message Loop)"
+
+        public IStartFormSelectionStage DefaultMessageLoop()
+        {
+            _messageloopfactory = new Factories.MessageLoops.FormBaseMessageLoop();
+
+            return this;
+        }
+
+        public IStartFormSelectionStage CustomMessageLoop(IMessageLoopFactory messageLoopClass)
+        {
+            _messageloopfactory = messageLoopClass;
+
+            return this;
+        }
+
+        public IStartFormSelectionStage CustomMessageLoop<T>()
+            where T : class, new()
+        {
+            _messageloopfactory = typeof(T).GetConstructor(new Type[] { })?.Invoke(new object[] { }) as IMessageLoopFactory;
+
+            return this;
+        }
+
+        #endregion
+
+
+        #region "Step 3 (Start Form/Factory)" 
+
+        public INetworkingSelectionStage WithStartForm(Type startFormClass)
+        {
+            this._factory = new Factories.DefaultStartFormFactory(startFormClass);
+            return this;
+        }
+
+        public INetworkingSelectionStage WithStartForm<T>()
+            where T : FormBase, new()
+        {
+            this._factory = new Factories.DefaultStartFormFactory(typeof(T));
+            return this;
+        }
+
+        public INetworkingSelectionStage WithStartFormFactory(IStartFormFactory factory)
+        {
+            this._factory = factory;
+            return this;
+        }
+
+        #endregion
+
+
+        #region "Step 4 (Network Settings)"
+
+        public IBotCommandsStage WithProxy(string proxyAddress)
+        {
+            var url = new Uri(proxyAddress);
+            _client = new MessageClient(_apiKey, url);
+            _client.TelegramClient.Timeout = new TimeSpan(0, 1, 0);
+            return this;
+        }
+
+
+        public IBotCommandsStage NoProxy()
+        {
+            _client = new MessageClient(_apiKey);
+            _client.TelegramClient.Timeout = new TimeSpan(0, 1, 0);
+            return this;
+        }
+
+
+        public IBotCommandsStage WithBotClient(TelegramBotClient tgclient)
+        {
+            _client = new MessageClient(_apiKey, tgclient);
+            _client.TelegramClient.Timeout = new TimeSpan(0, 1, 0);
+            return this;
+        }
+
+
+        public IBotCommandsStage WithHostAndPort(string proxyHost, int proxyPort)
+        {
+            _client = new MessageClient(_apiKey, proxyHost, proxyPort);
+            _client.TelegramClient.Timeout = new TimeSpan(0, 1, 0);
+            return this;
+        }
+
+        public IBotCommandsStage WithHttpClient(HttpClient tgclient)
+        {
+            _client = new MessageClient(_apiKey, tgclient);
+            _client.TelegramClient.Timeout = new TimeSpan(0, 1, 0);
+            return this;
+        }
+
+
+        #endregion
+
+
+        #region "Step 5 (Bot Commands)"
+
+        public ISessionSerializationStage NoCommands()
+        {
+            return this;
+        }
+
+        public ISessionSerializationStage OnlyStart()
+        {
+            _botcommands.Start("Starts the bot");
+
+            return this;
+
+        }
+
+        public ISessionSerializationStage DefaultCommands()
+        {
+            _botcommands.Start("Starts the bot");
+            _botcommands.Help("Should show you some help");
+            _botcommands.Settings("Should show you some settings");
+            return this;
+        }
+
+        public ISessionSerializationStage CustomCommands(Action<List<BotCommand>> action)
+        {
+            action?.Invoke(_botcommands);
+            return this;
+        }
+
+        #endregion
+
+
+        #region "Step 6 (Serialization)"
+
+        public ILanguageSelectionStage NoSerialization()
+        {
+            return this;
+        }
+
+        public ILanguageSelectionStage UseSerialization(IStateMachine machine)
+        {
+            this._statemachine = machine;
+            return this;
+        }
+
+
+        public ILanguageSelectionStage UseJSON(string path)
+        {
+            this._statemachine = new JSONStateMachine(path);
+            return this;
+        }
+
+        public ILanguageSelectionStage UseSimpleJSON(string path)
+        {
+            this._statemachine = new SimpleJSONStateMachine(path);
+            return this;
+        }
+
+        public ILanguageSelectionStage UseXML(string path)
+        {
+            this._statemachine = new XMLStateMachine(path);
+            return this;
+        }
+
+        #endregion
+
+
+        #region "Step 7 (Language)"
+
+        public IBuildingStage DefaultLanguage()
+        {
+            return this;
+        }
+
+        public IBuildingStage UseEnglish()
+        {
+            Localizations.Default.Language = new Localizations.English();
+            return this;
+        }
+
+        public IBuildingStage UseGerman()
+        {
+            Localizations.Default.Language = new Localizations.German();
+            return this;
+        }
+
+        public IBuildingStage Custom(Localization language)
+        {
+            Localizations.Default.Language = language;
+            return this;
+        }
+
+        #endregion
+
+
+        public BotBase Build()
+        {
+            var bb = new BotBase();
+
+            bb.APIKey = _apiKey;
+            bb.StartFormFactory = _factory;
+
+            bb.Client = _client;
+
+            bb.Sessions.Client = bb.Client;
+
+            bb.BotCommands = _botcommands;
+
+            bb.StateMachine = _statemachine;
+
+            bb.MessageLoopFactory = _messageloopfactory;
+
+            bb.MessageLoopFactory.UnhandledCall += bb.MessageLoopFactory_UnhandledCall;
+
+            return bb;
+        }
+
+    }
+}

TelegramBotBase/Builder/Interfaces/IAPIKeySelectionStage.cs

@@ -0,0 +1,45 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using TelegramBotBase.Form;
+using TelegramBotBase.Interfaces;
+
+namespace TelegramBotBase.Builder.Interfaces
+{
+    public interface IAPIKeySelectionStage
+    {
+        /// <summary>
+        /// Sets the API Key which will be used by the telegram bot client.
+        /// </summary>
+        /// <param name="apiKey"></param>
+        /// <returns></returns>
+        IMessageLoopSelectionStage WithAPIKey(String apiKey);
+
+
+        /// <summary>
+        /// Quick and easy way to create a BotBase instance.
+        /// Uses: DefaultMessageLoop, NoProxy, OnlyStart, NoSerialization, DefaultLanguage
+        /// </summary>
+        /// <param name="apiKey"></param>
+        /// <param name="StartForm"></param>
+        /// <returns></returns>
+        IBuildingStage QuickStart(String apiKey, Type StartForm);
+
+        /// <summary>
+        /// Quick and easy way to create a BotBase instance.
+        /// Uses: DefaultMessageLoop, NoProxy, OnlyStart, NoSerialization, DefaultLanguage
+        /// </summary>
+        /// <param name="apiKey"></param>
+        /// <returns></returns>
+        IBuildingStage QuickStart<T>(String apiKey) where T : FormBase;
+
+        /// <summary>
+        /// Quick and easy way to create a BotBase instance.
+        /// Uses: DefaultMessageLoop, NoProxy, OnlyStart, NoSerialization, DefaultLanguage
+        /// </summary>
+        /// <param name="apiKey"></param>
+        /// <param name="StartFormFactory"></param>
+        /// <returns></returns>
+        IBuildingStage QuickStart(String apiKey, IStartFormFactory StartFormFactory);
+    }
+}

TelegramBotBase/Builder/Interfaces/IBotCommandsStage.cs

@@ -0,0 +1,39 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using Telegram.Bot.Types;
+
+namespace TelegramBotBase.Builder.Interfaces
+{
+    public interface IBotCommandsStage
+    {
+        /// <summary>
+        /// Does not create any commands.
+        /// </summary>
+        /// <returns></returns>
+        ISessionSerializationStage NoCommands();
+
+
+        /// <summary>
+        /// Creates default commands for start, help and settings.
+        /// </summary>
+        /// <returns></returns>
+        ISessionSerializationStage DefaultCommands();
+
+
+        /// <summary>
+        /// Only adds the start command.
+        /// </summary>
+        /// <returns></returns>
+        ISessionSerializationStage OnlyStart();
+
+
+        /// <summary>
+        /// Gives you the ability to add custom commands.
+        /// </summary>
+        /// <param name="action"></param>
+        /// <returns></returns>
+        ISessionSerializationStage CustomCommands(Action<List<BotCommand>> action);
+
+    }
+}

TelegramBotBase/Builder/Interfaces/IBuildingStage.cs

@@ -0,0 +1,11 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace TelegramBotBase.Builder.Interfaces
+{
+    public interface IBuildingStage
+    {
+        BotBase Build();
+    }
+}

TelegramBotBase/Builder/Interfaces/ILanguageSelectionStage.cs

@@ -0,0 +1,36 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using TelegramBotBase.Localizations;
+
+namespace TelegramBotBase.Builder.Interfaces
+{
+    public interface ILanguageSelectionStage
+    {
+
+        /// <summary>
+        /// Selects the default language for control usage. (English)
+        /// </summary>
+        /// <returns></returns>
+        IBuildingStage DefaultLanguage();
+
+        /// <summary>
+        /// Selects english as the default language for control labels.
+        /// </summary>
+        /// <returns></returns>
+        IBuildingStage UseEnglish();
+
+        /// <summary>
+        /// Selects german as the default language for control labels.
+        /// </summary>
+        /// <returns></returns>
+        IBuildingStage UseGerman();
+
+        /// <summary>
+        /// Selects a custom language as the default language for control labels.
+        /// </summary>
+        /// <returns></returns>
+        IBuildingStage Custom(Localization language);
+
+    }
+}

TelegramBotBase/Builder/Interfaces/INetworkingSelectionStage.cs

@@ -0,0 +1,51 @@
+using System;
+using System.Collections.Generic;
+using System.Net.Http;
+using System.Text;
+using Telegram.Bot;
+
+namespace TelegramBotBase.Builder.Interfaces
+{
+    public interface INetworkingSelectionStage
+    {
+
+        /// <summary>
+        /// Chooses a proxy as network configuration.
+        /// </summary>
+        /// <param name="proxyAddress"></param>
+        /// <returns></returns>
+        IBotCommandsStage WithProxy(String proxyAddress);
+
+        /// <summary>
+        /// Do not choose a proxy as network configuration.
+        /// </summary>
+        /// <returns></returns>
+        IBotCommandsStage NoProxy();
+
+
+        /// <summary>
+        /// Chooses a custom instance of TelegramBotClient.
+        /// </summary>
+        /// <param name="client"></param>
+        /// <returns></returns>
+        IBotCommandsStage WithBotClient(TelegramBotClient client);
+
+
+        /// <summary>
+        /// Sets the custom proxy host and port.
+        /// </summary>
+        /// <param name="proxyHost"></param>
+        /// <param name="Port"></param>
+        /// <returns></returns>
+        IBotCommandsStage WithHostAndPort(String proxyHost, int Port);
+
+        /// <summary>
+        /// Uses a custom http client.
+        /// </summary>
+        /// <param name="client"></param>
+        /// <returns></returns>
+        IBotCommandsStage WithHttpClient(HttpClient client);
+
+
+    }
+}

TelegramBotBase/Builder/Interfaces/ISessionSerializationStage.cs

@@ -0,0 +1,49 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using TelegramBotBase.Interfaces;
+
+namespace TelegramBotBase.Builder.Interfaces
+{
+    public interface ISessionSerializationStage
+    {
+        /// <summary>
+        /// Do not uses serialization.
+        /// </summary>
+        /// <returns></returns>
+        ILanguageSelectionStage NoSerialization();
+
+
+        /// <summary>
+        /// Sets the state machine for serialization.
+        /// </summary>
+        /// <param name="machine"></param>
+        /// <returns></returns>
+        ILanguageSelectionStage UseSerialization(IStateMachine machine);
+
+
+        /// <summary>
+        /// Using the complex version of .Net JSON, which can serialize all objects.
+        /// </summary>
+        /// <param name="path"></param>
+        /// <returns></returns>
+        ILanguageSelectionStage UseJSON(String path);
+
+
+        /// <summary>
+        /// Use the easy version of .Net JSON, which can serialize basic types, but not generics and others.
+        /// </summary>
+        /// <param name="path"></param>
+        /// <returns></returns>
+        ILanguageSelectionStage UseSimpleJSON(String path);
+
+
+        /// <summary>
+        /// Uses the XML serializer for session serialization.
+        /// </summary>
+        /// <param name="path"></param>
+        /// <returns></returns>
+        ILanguageSelectionStage UseXML(String path);
+
+    }
+}

TelegramBotBase/Builder/Interfaces/IStartFormSelectionStage.cs

@@ -0,0 +1,34 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using TelegramBotBase.Form;
+using TelegramBotBase.Interfaces;
+
+namespace TelegramBotBase.Builder.Interfaces
+{
+    public interface IStartFormSelectionStage
+    {
+
+        /// <summary>
+        /// Chooses a start form type which will be used for new sessions.
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <returns></returns>
+        INetworkingSelectionStage WithStartForm(Type startFormClass);
+
+        /// <summary>
+        /// Chooses a generic start form which will be used for new sessions.
+        /// </summary>
+        /// <typeparam name="T"></typeparam>
+        /// <returns></returns>
+        INetworkingSelectionStage WithStartForm<T>() where T : FormBase, new();
+
+        /// <summary>
+        /// Chooses a StartFormFactory which will be use for new sessions.
+        /// </summary>
+        /// <param name="factory"></param>
+        /// <returns></returns>
+        INetworkingSelectionStage WithStartFormFactory(IStartFormFactory factory);
+
+    }
+}