Git Product home page Git Product logo

a-patel / litexsms Goto Github PK

View Code? Open in Web Editor NEW
4.0 4.0 1.0 106 KB

LiteXSms is simple yet powerful and very high-performance sms mechanism and incorporating both synchronous and asynchronous usage with some advanced usages which can help us to handle sending sms more easier!

License: MIT License

sms sms-api sms-gateway twilio asp-net-core aspnetcore aspnet-core netcore csharp message

litexsms's Introduction

LiteXSms

LiteXSms is simple yet powerful and very high-performance sms sending mechanism and incorporating both synchronous and asynchronous usage with some advanced usages which can help us to handle sending sms more easier!

Provide sms service for ASP.NET Core (2.0 and later) applications.

Small library to abstract sms functionalities. Quick setup for any sms provider and very simple wrapper for the widely used sms providers. LiteXSms uses the least common denominator of functionality between the supported providers to send sms solution. Abstract interface to implement any kind of basic sms services. Having a default/generic implementation to wrap the Twilio, Plivo, Nexmo, Sinch. A sms abstraction.

Very simple configuration in advanced ways. Purpose of this package is to bring a new level of ease to the developers who deal with different sms provider integration with their system and implements many advanced features. You can also write your own and extend it also extend existing providers. Easily migrate or switch between one to another provider with no code breaking changes.

LiteXSms is an interface to unify the programming model for various sms providers. The Core library contains all base interfaces and tools. One should install at least one other LiteXSms package to get sms implementation.

Cache Providers ๐Ÿ“š

Features ๐Ÿ“Ÿ

  • Async compatible
  • Thread safe, concurrency ready
  • Multiple provider support (using provider factory)
  • Obsolete sync methods
  • Interface based API to support the test driven development and dependency injection
  • Leverages a provider model on top of ILiteXSmsSender under the hood and can be extended with your own implementation
  • Voice Sms

Basic Usage ๐Ÿ“„

Step 1 : Install the package ๐Ÿ“ฆ

Choose one kinds of sms provider type that you needs and install it via Nuget. To install LiteXSms, run the following command in the Package Manager Console

PM> Install-Package LiteX.Sms.Twilio
PM> Install-Package LiteX.Sms.Plivo
PM> Install-Package LiteX.Sms.Nexmo
PM> Install-Package LiteX.Sms.Sinch

Step 2 : Configuration ๐Ÿ”จ

Different types of sms provider have their own way to config. Here are samples that show you how to config.

2.1 : AppSettings
{
  //LiteX Twilio Sms settings
  "TwilioConfig": {
    "AccountSid": "--- REPLACE WITH YOUR Twilio SID ---",
    "AuthToken": "--- REPLACE WITH YOUR Twilio Auth Token ---",
    "FromNumber": "--- REPLACE WITH Twilio From Number ---",
    "EnableLogging": true
  },

  //LiteX Plivo Sms settings
  "PlivoConfig": {
    "AuthId": "--- REPLACE WITH YOUR Plivo Account SID ---",
    "AuthToken": "--- REPLACE WITH YOUR Plivo Auth Token ---",
    "FromNumber": "--- REPLACE WITH Plivo From Number ---",
    "EnableLogging": true
  },

  //LiteX Nexmo Sms settings
  "NexmoConfig": {
    "ApiKey": "--- REPLACE WITH YOUR Nexmo ApiKey ---",
    "ApiSecret": "--- REPLACE WITH YOUR Nexmo ApiSecret ---",
    "ApplicationId": "--- REPLACE WITH YOUR Nexmo ApplicationId ---",
    "ApplicationKey": "--- REPLACE WITH YOUR Nexmo ApplicationKey ---",
    "FromNumber": "--- REPLACE WITH Nexmo From Number ---",
    "EnableLogging": true
  },

  //LiteX Sinch Sms settings
  "SinchConfig": {
    "ApiKey": "--- REPLACE WITH YOUR Sinch ApiKey ---",
    "ApiSecret": "--- REPLACE WITH YOUR Sinch ApiSecret ---",
    "FromNumber": "--- REPLACE WITH Sinch From Number ---",
    "EnableLogging": true
  }
}
2.2 : Configure Startup Class
public class Startup
{
    public void ConfigureServices(IServiceCollection services)
    {
        #region LiteX Sms (Twilio)

        // 1. Use default configuration from appsettings.json's 'TwilioConfig'
        services.AddLiteXTwilioSms();

        //OR
        // 2. Load configuration settings using options.
        services.AddLiteXTwilioSms(option =>
        {
            option.AccountSid = "";
            option.AuthToken = "";
            option.FromNumber = "";
            option.EnableLogging = true;
        });

        //OR
        // 3. Load configuration settings on your own.
        // (e.g. appsettings, database, hardcoded)
        var twilioConfig = new TwilioConfig()
        {
            AccountSid = "",
            AuthToken = "",
            FromNumber = "",
            EnableLogging = true
        };
        services.AddLiteXTwilioSms(twilioConfig);

        #endregion

        #region LiteX Sms (Plivo)

        // 1. Use default configuration from appsettings.json's 'PlivoConfig'
        services.AddLiteXPlivoSms();

        //OR
        // 2. Load configuration settings using options.
        services.AddLiteXPlivoSms(option =>
        {
            option.AuthId = "";
            option.AuthToken = "";
            option.FromNumber = "";
            option.EnableLogging = true;
        });

        //OR
        // 3. Load configuration settings on your own.
        // (e.g. appsettings, database, hardcoded)
        var plivoConfig = new PlivoConfig()
        {
            AuthId = "",
            AuthToken = "",
            FromNumber = "",
            EnableLogging = true
        };
        services.AddLiteXPlivoSms(plivoConfig);

        #endregion

        #region LiteX Sms (Nexmo)

        // 1. Use default configuration from appsettings.json's 'NexmoConfig'
        services.AddLiteXNexmoSms();

        //OR
        // 2. Load configuration settings using options.
        services.AddLiteXNexmoSms(option =>
        {
            option.ApiKey = "";
            option.ApiSecret = "";
            option.ApplicationId = "";
            option.ApplicationKey = "";
            option.FromNumber = "";
            option.EnableLogging = true;
        });

        //OR
        // 3. Load configuration settings on your own.
        // (e.g. appsettings, database, hardcoded)
        var nexmoConfig = new NexmoConfig()
        {
            ApiKey = "",
            ApiSecret = "",
            ApplicationId = "",
            ApplicationKey = "",
            FromNumber = "",
            EnableLogging = true
        };
        services.AddLiteXNexmoSms(nexmoConfig);

        #endregion

        #region LiteX Sms (Sinch)

        // 1. Use default configuration from appsettings.json's 'SinchConfig'
        services.AddLiteXSinchSms();

        //OR
        // 2. Load configuration settings using options.
        services.AddLiteXSinchSms(option =>
        {
            option.ApiKey = "";
            option.ApiSecret = "";
            option.FromNumber = "";
            option.EnableLogging = true;
        });

        //OR
        // 3. Load configuration settings on your own.
        // (e.g. appsettings, database, hardcoded)
        var sinchConfig = new SinchConfig()
        {
            ApiKey = "",
            ApiSecret = "",
            FromNumber = "",
            EnableLogging = true
        };
        services.AddLiteXSinchSms(sinchConfig);

        #endregion


        // add logging (optional)
        services.AddLiteXLogging();
    }
}

Step 3 : Use in Controller or Business layer ๐Ÿ“

/// <summary>
/// Customer controller
/// </summary>
[Route("api/[controller]")]
public class CustomerController : Controller
{
    #region Fields

    private readonly ILiteXSmsSender _smsSender;

    #endregion

    #region Ctor

    /// <summary>
    /// Ctor
    /// </summary>
    /// <param name="smsSender"></param>
    public CustomerController(ILiteXSmsSender smsSender)
    {
        _smsSender = smsSender;
    }

    #endregion

    #region Methods

    /// <summary>
    /// Get Sms Provider Type
    /// </summary>
    /// <returns></returns>
    [HttpGet]
    [Route("get-sms-provider-type")]
    public IActionResult GetSmsProviderType()
    {
        return Ok(_smsSender.SmsProviderType.ToString());
    }

    /// <summary>
    /// Send sms
    /// </summary>
    /// <param name="toPhoneNumber">To phone number</param>
    /// <param name="messageText">message text</param>
    /// <returns></returns>
    [HttpPost]
    [Route("send-sms")]
    public async Task<IActionResult> SendSms(string toPhoneNumber, string messageText)
    {
        toPhoneNumber = toPhoneNumber ?? "+919426432254";
        messageText = messageText ?? "I am LiteX Sms!";

        // async
        var result = await _smsSender.SendSmsAsync(toPhoneNumber, messageText);

        // sync
        //var result = _smsSender.SendSms(toPhoneNumber, messageText);

        return Ok(result);
    }

    #endregion
}

Todo List ๐Ÿ“‹

Sms Providers

  • Twilio
  • Plivo
  • Nexmo
  • Sinch

Basic Sms API

  • Send Sms
  • [] Voice Sms
  • [] Send Bulk Sms

Coming soon

  • .NET Standard 2.1 support
  • .NET 5.0 support
  • Remove sync methods
  • Bulk Sms

Give a Star! โญ

Feel free to request an issue on github if you find bugs or request a new feature. Your valuable feedback is much appreciated to better improve this project. If you find this useful, please give it a star to show your support for this project.

Support โ˜Ž๏ธ

Reach out to me at one of the following places!

Author ๐Ÿ‘ฆ

Connect with me
Linkedin Website Medium NuGet GitHub Microsoft Facebook Twitter Instagram Tumblr
linkedin website medium nuget github microsoft facebook twitter instagram tumblr

Donate ๐Ÿ’ต

If you find this project useful โ€” or just feeling generous, consider buying me a beer or a coffee. Cheers! ๐Ÿป โ˜•

PayPal BMC Patreon
PayPal Buy Me A Coffee Patreon

License ๐Ÿ”’

This project is licensed under the MIT License - see the LICENSE file for details.

litexsms's People

Contributors

a-patel avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

codefork

litexsms's Issues

Upgrade to .NET Core 3.x

Upgrade all LiteX Sms packages to .NET Core 3.x
Upgrade all dependent Microsoft packages to .NET Core 3.x
Upgrade all dependent packages (SDKs) to the latest version

Invalid URI: The hostname could not be parsed.

`
builder.Services _

.AddTransient(Of LiteX.Sms.Core.ILiteXSmsSender, LiteX.Sms.Sinch.SinchSmsSender)(Function(provider As IServiceProvider)

                                                                                                         Dim vault = provider.GetRequiredService(Of Domain.Security.MyVault)              
                                                                                                                                       
                                                                                                         Dim key = vault.Secret("sinchKey")
                                                                                                         
                                                                                                         Dim secret = vault.Secret("sinchSecret")
                                                                                                         
                                                                                                         Dim config = New SinchConfig() With {
                                                                                                            .ApiKey = key,
                                                                                                            .ApiSecret = secret,
                                                                                                            .FromNumber = "*********",
                                                                                                            .EnableLogging = True
                                                                                                            }
                                                                                                            
                                                                                                         Return New SinchSmsSender(config)
                                                                                                     End Function)`

Not sure if I caused this to happen with my configuration. Once the SinchSmsSender gets the configuration it throws this error.

Error happens with either versions 6.1.0 or 7.0.0. My project is .net 7.0.

I would appreciate any guidance.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.