From b877c252347132e6db618a71a91bff4ed98af6da Mon Sep 17 00:00:00 2001 From: Addison Beck Date: Fri, 4 Dec 2020 12:05:16 -0500 Subject: [PATCH] Implemented tax collection for subscriptions (#1017) * Implemented tax collection for subscriptions * Cleanup for Sales Tax * Cleanup for Sales Tax * Changes a constraint to an index for checking purposes * Added and implemented a ReadById method for TaxRate * Code review fixes for Tax Rate implementation * Code review fixes for Tax Rate implementation * Made the SalesTax migration script rerunnable --- src/Admin/Controllers/ToolsController.cs | 106 +++++- src/Admin/Models/TaxRateAddEditModel.cs | 11 + src/Admin/Models/TaxRatesModel.cs | 9 + src/Admin/Views/Shared/_Layout.cshtml | 3 + src/Admin/Views/Tools/TaxRate.cshtml | 96 +++++ src/Admin/Views/Tools/TaxRateAddEdit.cshtml | 356 ++++++++++++++++++ src/Api/Controllers/PlansController.cs | 16 + .../OrganizationUpgradeRequestModel.cs | 9 +- .../Api/Response/TaxRateResponseModel.cs | 29 ++ .../Models/Business/OrganizationUpgrade.cs | 1 + .../Business/SubscriptionCreateOptions.cs | 85 +++++ src/Core/Models/Business/TaxInfo.cs | 1 + src/Core/Models/Table/TaxRate.cs | 18 + src/Core/Repositories/ITaxRateRepository.cs | 14 + .../SqlServer/TaxRateRepository.cs | 70 ++++ src/Core/Services/IPaymentService.cs | 5 +- .../Implementations/OrganizationService.cs | 2 +- .../Implementations/StripePaymentService.cs | 163 ++++---- .../Utilities/ServiceCollectionExtensions.cs | 1 + .../dbo/Stored Procedures/TaxRate_Archive.sql | 13 + .../dbo/Stored Procedures/TaxRate_Create.sql | 30 ++ .../TaxRate_ReadAllActive.sql | 9 + .../Stored Procedures/TaxRate_ReadById.sql | 9 + .../TaxRate_ReadByLocation.sql | 12 + .../dbo/Stored Procedures/TaxRate_Search.sql | 14 + src/Sql/dbo/Tables/TaxRate.sql | 14 + .../DbScripts/2020-11-16_00_SalesTax.sql | 149 ++++++++ 27 files changed, 1157 insertions(+), 88 deletions(-) create mode 100644 src/Admin/Models/TaxRateAddEditModel.cs create mode 100644 src/Admin/Models/TaxRatesModel.cs create mode 100644 src/Admin/Views/Tools/TaxRate.cshtml create mode 100644 src/Admin/Views/Tools/TaxRateAddEdit.cshtml create mode 100644 src/Core/Models/Api/Response/TaxRateResponseModel.cs create mode 100644 src/Core/Models/Business/SubscriptionCreateOptions.cs create mode 100644 src/Core/Models/Table/TaxRate.cs create mode 100644 src/Core/Repositories/ITaxRateRepository.cs create mode 100644 src/Core/Repositories/SqlServer/TaxRateRepository.cs create mode 100644 src/Sql/dbo/Stored Procedures/TaxRate_Archive.sql create mode 100644 src/Sql/dbo/Stored Procedures/TaxRate_Create.sql create mode 100644 src/Sql/dbo/Stored Procedures/TaxRate_ReadAllActive.sql create mode 100644 src/Sql/dbo/Stored Procedures/TaxRate_ReadById.sql create mode 100644 src/Sql/dbo/Stored Procedures/TaxRate_ReadByLocation.sql create mode 100644 src/Sql/dbo/Stored Procedures/TaxRate_Search.sql create mode 100644 src/Sql/dbo/Tables/TaxRate.sql create mode 100644 util/Migrator/DbScripts/2020-11-16_00_SalesTax.sql diff --git a/src/Admin/Controllers/ToolsController.cs b/src/Admin/Controllers/ToolsController.cs index 951d533e9b..8a5da7355c 100644 --- a/src/Admin/Controllers/ToolsController.cs +++ b/src/Admin/Controllers/ToolsController.cs @@ -26,6 +26,8 @@ namespace Bit.Admin.Controllers private readonly ITransactionRepository _transactionRepository; private readonly IInstallationRepository _installationRepository; private readonly IOrganizationUserRepository _organizationUserRepository; + private readonly IPaymentService _paymentService; + private readonly ITaxRateRepository _taxRateRepository; public ToolsController( GlobalSettings globalSettings, @@ -34,7 +36,9 @@ namespace Bit.Admin.Controllers IUserService userService, ITransactionRepository transactionRepository, IInstallationRepository installationRepository, - IOrganizationUserRepository organizationUserRepository) + IOrganizationUserRepository organizationUserRepository, + ITaxRateRepository taxRateRepository, + IPaymentService paymentService) { _globalSettings = globalSettings; _organizationRepository = organizationRepository; @@ -43,6 +47,8 @@ namespace Bit.Admin.Controllers _transactionRepository = transactionRepository; _installationRepository = installationRepository; _organizationUserRepository = organizationUserRepository; + _taxRateRepository = taxRateRepository; + _paymentService = paymentService; } public IActionResult ChargeBraintree() @@ -264,5 +270,103 @@ namespace Bit.Admin.Controllers throw new Exception("No license to generate."); } } + + public async Task TaxRate(int page = 1, int count = 25) + { + if (page < 1) + { + page = 1; + } + + if (count < 1) + { + count = 1; + } + + var skip = (page - 1) * count; + var rates = await _taxRateRepository.SearchAsync(skip, count); + return View(new TaxRatesModel + { + Items = rates.ToList(), + Page = page, + Count = count + }); + } + + public async Task TaxRateAddEdit(string stripeTaxRateId = null) + { + if (string.IsNullOrWhiteSpace(stripeTaxRateId)) + { + return View(new TaxRateAddEditModel()); + } + + var rate = await _taxRateRepository.GetByIdAsync(stripeTaxRateId); + var model = new TaxRateAddEditModel() + { + StripeTaxRateId = stripeTaxRateId, + Country = rate.Country, + State = rate.State, + PostalCode = rate.PostalCode, + Rate = rate.Rate + }; + + return View(model); + } + + [HttpPost] + public async Task TaxRateAddEdit(TaxRateAddEditModel model) + { + var existingRateCheck = await _taxRateRepository.GetByLocationAsync(new TaxRate() { Country = model.Country, PostalCode = model.PostalCode }); + if (existingRateCheck.Any()) + { + ModelState.AddModelError(nameof(model.PostalCode), "A tax rate already exists for this Country/Postal Code combination."); + } + + if (!ModelState.IsValid) + { + return View(model); + } + + var taxRate = new TaxRate() + { + Id = model.StripeTaxRateId, + Country = model.Country, + State = model.State, + PostalCode = model.PostalCode, + Rate = model.Rate + }; + + if (!string.IsNullOrWhiteSpace(model.StripeTaxRateId)) + { + await _paymentService.UpdateTaxRateAsync(taxRate); + } + else + { + await _paymentService.CreateTaxRateAsync(taxRate); + } + + return RedirectToAction("TaxRate"); + } + + [HttpPost] + public async Task TaxRateUpdate(TaxRate model) + { + if (!string.IsNullOrWhiteSpace(model.Id)) + { + await _paymentService.UpdateTaxRateAsync(model); + } + + return RedirectToAction("TaxRate"); + } + + public async Task TaxRateArchive(string stripeTaxRateId) + { + if (!string.IsNullOrWhiteSpace(stripeTaxRateId)) + { + await _paymentService.ArchiveTaxRateAsync(new TaxRate() { Id = stripeTaxRateId }); + } + + return RedirectToAction("TaxRate"); + } } } diff --git a/src/Admin/Models/TaxRateAddEditModel.cs b/src/Admin/Models/TaxRateAddEditModel.cs new file mode 100644 index 0000000000..7d098cd863 --- /dev/null +++ b/src/Admin/Models/TaxRateAddEditModel.cs @@ -0,0 +1,11 @@ +namespace Bit.Admin.Models +{ + public class TaxRateAddEditModel + { + public string StripeTaxRateId { get; set; } + public string Country { get; set; } + public string State { get; set; } + public string PostalCode { get; set; } + public decimal Rate { get; set; } + } +} diff --git a/src/Admin/Models/TaxRatesModel.cs b/src/Admin/Models/TaxRatesModel.cs new file mode 100644 index 0000000000..4af8540fa7 --- /dev/null +++ b/src/Admin/Models/TaxRatesModel.cs @@ -0,0 +1,9 @@ +using Bit.Core.Models.Table; + +namespace Bit.Admin.Models +{ + public class TaxRatesModel: PagedModel + { + public string Message { get; set; } + } +} diff --git a/src/Admin/Views/Shared/_Layout.cshtml b/src/Admin/Views/Shared/_Layout.cshtml index aaa4079ffb..cf56fafa65 100644 --- a/src/Admin/Views/Shared/_Layout.cshtml +++ b/src/Admin/Views/Shared/_Layout.cshtml @@ -58,6 +58,9 @@ Generate License + + Manage Tax Rates +
  • diff --git a/src/Admin/Views/Tools/TaxRate.cshtml b/src/Admin/Views/Tools/TaxRate.cshtml new file mode 100644 index 0000000000..8d951fa0f4 --- /dev/null +++ b/src/Admin/Views/Tools/TaxRate.cshtml @@ -0,0 +1,96 @@ +@using Bit.Core.Models.Table + +@model TaxRatesModel +@{ + ViewData["Title"] = "Tax Rates"; +} + +

    Manage Tax Rates

    + +Add a Rate +
    + + + + + + + + + + + + + @if(!Model.Items.Any()) + { + + + + } + else + { + @foreach(var rate in Model.Items) + { + + + + + + + + + } + } + +
    IdCountryStatePostal CodeTax Rate
    No results to list.
    + @{ + var taxRateToEdit = new Dictionary + { + { "id", rate.Id }, + { "stripeTaxRateId", rate.Id } + }; + } + @rate.Id + + @rate.Country + + @rate.State + + @rate.PostalCode + + @rate.Rate% + + + + +
    +
    + + diff --git a/src/Admin/Views/Tools/TaxRateAddEdit.cshtml b/src/Admin/Views/Tools/TaxRateAddEdit.cshtml new file mode 100644 index 0000000000..c72f9337f0 --- /dev/null +++ b/src/Admin/Views/Tools/TaxRateAddEdit.cshtml @@ -0,0 +1,356 @@ +@model TaxRateAddEditModel +@{ + ViewData["Title"] = "Add/Edit Tax Rate"; +} + + +

    @(string.IsNullOrWhiteSpace(Model.StripeTaxRateId) ? "Create" : "Edit") Tax Rate

    + +@if (!string.IsNullOrWhiteSpace(Model.StripeTaxRateId)) +{ +

    Note: Updating a Tax Rate archives the currently selected rate and creates a new rate with a new ID. The previous data still exists in a disabled state.

    +} + +
    +
    + +
    +
    +
    + + +
    +
    +
    +
    + + +
    +
    +
    +
    +
    +
    + + +
    +
    +
    +
    + +
    + +
    + % +
    +
    +
    +
    +
    + +
    diff --git a/src/Api/Controllers/PlansController.cs b/src/Api/Controllers/PlansController.cs index d3108c5bd3..45c7c6eb97 100644 --- a/src/Api/Controllers/PlansController.cs +++ b/src/Api/Controllers/PlansController.cs @@ -3,6 +3,8 @@ using Microsoft.AspNetCore.Mvc; using Bit.Core.Utilities; using Bit.Core.Models.Api; using System.Linq; +using Bit.Core.Repositories; +using System.Threading.Tasks; namespace Bit.Api.Controllers { @@ -10,6 +12,12 @@ namespace Bit.Api.Controllers [Authorize("Web")] public class PlansController : Controller { + private readonly ITaxRateRepository _taxRateRepository; + public PlansController(ITaxRateRepository taxRateRepository) + { + _taxRateRepository = taxRateRepository; + } + [HttpGet("")] public ListResponseModel Get() { @@ -17,5 +25,13 @@ namespace Bit.Api.Controllers var responses = data.Select(plan => new PlanResponseModel(plan)); return new ListResponseModel(responses); } + + [HttpGet("sales-tax-rates")] + public async Task> GetTaxRates() + { + var data = await _taxRateRepository.GetAllActiveAsync(); + var responses = data.Select(x => new TaxRateResponseModel(x)); + return new ListResponseModel(responses); + } } } diff --git a/src/Core/Models/Api/Request/Organizations/OrganizationUpgradeRequestModel.cs b/src/Core/Models/Api/Request/Organizations/OrganizationUpgradeRequestModel.cs index d1d95c3a95..f11fff0cc5 100644 --- a/src/Core/Models/Api/Request/Organizations/OrganizationUpgradeRequestModel.cs +++ b/src/Core/Models/Api/Request/Organizations/OrganizationUpgradeRequestModel.cs @@ -14,6 +14,8 @@ namespace Bit.Core.Models.Api [Range(0, 99)] public short? AdditionalStorageGb { get; set; } public bool PremiumAccessAddon { get; set; } + public string BillingAddressCountry { get; set; } + public string BillingAddressPostalCode { get; set; } public OrganizationUpgrade ToOrganizationUpgrade() { @@ -23,7 +25,12 @@ namespace Bit.Core.Models.Api AdditionalStorageGb = AdditionalStorageGb.GetValueOrDefault(), BusinessName = BusinessName, Plan = PlanType, - PremiumAccessAddon = PremiumAccessAddon + PremiumAccessAddon = PremiumAccessAddon, + TaxInfo = new TaxInfo() + { + BillingAddressCountry = BillingAddressCountry, + BillingAddressPostalCode = BillingAddressPostalCode + } }; } } diff --git a/src/Core/Models/Api/Response/TaxRateResponseModel.cs b/src/Core/Models/Api/Response/TaxRateResponseModel.cs new file mode 100644 index 0000000000..a298ab959a --- /dev/null +++ b/src/Core/Models/Api/Response/TaxRateResponseModel.cs @@ -0,0 +1,29 @@ +using System; +using Bit.Core.Models.Table; + +namespace Bit.Core.Models.Api +{ + public class TaxRateResponseModel : ResponseModel + { + public TaxRateResponseModel(TaxRate taxRate) + : base("profile") + { + if (taxRate == null) + { + throw new ArgumentNullException(nameof(taxRate)); + } + + Id = taxRate.Id; + Country = taxRate.Country; + State = taxRate.State; + PostalCode = taxRate.PostalCode; + Rate = taxRate.Rate; + } + + public string Id { get; set; } + public string Country { get; set; } + public string State { get; set; } + public string PostalCode { get; set; } + public decimal Rate { get; set; } + } +} diff --git a/src/Core/Models/Business/OrganizationUpgrade.cs b/src/Core/Models/Business/OrganizationUpgrade.cs index 07e7b98f96..9eed8240f8 100644 --- a/src/Core/Models/Business/OrganizationUpgrade.cs +++ b/src/Core/Models/Business/OrganizationUpgrade.cs @@ -9,5 +9,6 @@ namespace Bit.Core.Models.Business public short AdditionalSeats { get; set; } public short AdditionalStorageGb { get; set; } public bool PremiumAccessAddon { get; set; } + public TaxInfo TaxInfo { get; set; } } } diff --git a/src/Core/Models/Business/SubscriptionCreateOptions.cs b/src/Core/Models/Business/SubscriptionCreateOptions.cs new file mode 100644 index 0000000000..43f5cc3672 --- /dev/null +++ b/src/Core/Models/Business/SubscriptionCreateOptions.cs @@ -0,0 +1,85 @@ +using Bit.Core.Models.Table; +using Stripe; +using System.Collections.Generic; + +namespace Bit.Core.Models.Business +{ + public class OrganizationSubscriptionOptionsBase : Stripe.SubscriptionCreateOptions + { + public OrganizationSubscriptionOptionsBase(Organization org, StaticStore.Plan plan, TaxInfo taxInfo, int additionalSeats, int additionalStorageGb, bool premiumAccessAddon) + { + Items = new List(); + Metadata = new Dictionary + { + [org.GatewayIdField()] = org.Id.ToString() + }; + + if (plan.StripePlanId != null) + { + Items.Add(new SubscriptionItemOptions + { + Plan = plan.StripePlanId, + Quantity = 1 + }); + } + + if (additionalSeats > 0 && plan.StripeSeatPlanId != null) + { + Items.Add(new SubscriptionItemOptions + { + Plan = plan.StripeSeatPlanId, + Quantity = additionalSeats + }); + } + + if (additionalStorageGb > 0) + { + Items.Add(new SubscriptionItemOptions + { + Plan = plan.StripeStoragePlanId, + Quantity = additionalStorageGb + }); + } + + if (premiumAccessAddon && plan.StripePremiumAccessPlanId != null) + { + Items.Add(new SubscriptionItemOptions + { + Plan = plan.StripePremiumAccessPlanId, + Quantity = 1 + }); + } + + if (!string.IsNullOrWhiteSpace(taxInfo?.StripeTaxRateId)) + { + DefaultTaxRates = new List{ taxInfo.StripeTaxRateId }; + } + } + } + + public class OrganizationPurchaseSubscriptionOptions : OrganizationSubscriptionOptionsBase + { + public OrganizationPurchaseSubscriptionOptions( + Organization org, StaticStore.Plan plan, + TaxInfo taxInfo, int additionalSeats = 0, + int additionalStorageGb = 0, bool premiumAccessAddon = false) : + base(org, plan, taxInfo, additionalSeats, additionalStorageGb, premiumAccessAddon) + { + OffSession = true; + TrialPeriodDays = plan.TrialPeriodDays; + } + } + + public class OrganizationUpgradeSubscriptionOptions : OrganizationSubscriptionOptionsBase + { + public OrganizationUpgradeSubscriptionOptions( + string customerId, Organization org, + StaticStore.Plan plan, TaxInfo taxInfo, + int additionalSeats = 0, int additionalStorageGb = 0, + bool premiumAccessAddon = false) : + base(org, plan, taxInfo, additionalSeats, additionalStorageGb, premiumAccessAddon) + { + Customer = customerId; + } + } +} diff --git a/src/Core/Models/Business/TaxInfo.cs b/src/Core/Models/Business/TaxInfo.cs index 5f493be178..03a7df5626 100644 --- a/src/Core/Models/Business/TaxInfo.cs +++ b/src/Core/Models/Business/TaxInfo.cs @@ -14,6 +14,7 @@ _taxIdType = null; } } + public string StripeTaxRateId { get; set; } public string BillingAddressLine1 { get; set; } public string BillingAddressLine2 { get; set; } public string BillingAddressCity { get; set; } diff --git a/src/Core/Models/Table/TaxRate.cs b/src/Core/Models/Table/TaxRate.cs new file mode 100644 index 0000000000..195465efda --- /dev/null +++ b/src/Core/Models/Table/TaxRate.cs @@ -0,0 +1,18 @@ +namespace Bit.Core.Models.Table +{ + public class TaxRate: ITableObject + { + public string Id { get; set; } + public string Country { get; set; } + public string State { get; set; } + public string PostalCode { get; set; } + public decimal Rate { get; set; } + public bool Active { get; set; } + + public void SetNewId() + { + // Id is created by Stripe, should exist before this gets called + return; + } + } +} diff --git a/src/Core/Repositories/ITaxRateRepository.cs b/src/Core/Repositories/ITaxRateRepository.cs new file mode 100644 index 0000000000..b507e3b313 --- /dev/null +++ b/src/Core/Repositories/ITaxRateRepository.cs @@ -0,0 +1,14 @@ +using Bit.Core.Models.Table; +using System.Collections.Generic; +using System.Threading.Tasks; + +namespace Bit.Core.Repositories +{ + public interface ITaxRateRepository : IRepository + { + Task> SearchAsync(int skip, int count); + Task> GetAllActiveAsync(); + Task ArchiveAsync(TaxRate model); + Task> GetByLocationAsync(TaxRate taxRate); + } +} diff --git a/src/Core/Repositories/SqlServer/TaxRateRepository.cs b/src/Core/Repositories/SqlServer/TaxRateRepository.cs new file mode 100644 index 0000000000..c9e03bf67d --- /dev/null +++ b/src/Core/Repositories/SqlServer/TaxRateRepository.cs @@ -0,0 +1,70 @@ +using Bit.Core.Models.Table; +using System.Threading.Tasks; +using System.Collections.Generic; +using System.Data; +using System.Data.SqlClient; +using Dapper; +using System.Linq; + +namespace Bit.Core.Repositories.SqlServer +{ + public class TaxRateRepository : Repository, ITaxRateRepository + { + public TaxRateRepository(GlobalSettings globalSettings) + : this(globalSettings.SqlServer.ConnectionString, globalSettings.SqlServer.ReadOnlyConnectionString) + { } + + public TaxRateRepository(string connectionString, string readOnlyConnectionString) + : base(connectionString, readOnlyConnectionString) + { } + + public async Task> SearchAsync(int skip, int count) + { + using (var connection = new SqlConnection(ConnectionString)) + { + var results = await connection.QueryAsync( + $"[{Schema}].[TaxRate_Search]", + new { Skip = skip, Count = count }, + commandType: CommandType.StoredProcedure); + + return results.ToList(); + } + } + + public async Task> GetAllActiveAsync() + { + using (var connection = new SqlConnection(ConnectionString)) + { + var results = await connection.QueryAsync( + $"[{Schema}].[TaxRate_ReadAllActive]", + commandType: CommandType.StoredProcedure); + + return results.ToList(); + } + } + + public async Task ArchiveAsync(TaxRate model) + { + using (var connection = new SqlConnection(ConnectionString)) + { + var results = await connection.ExecuteAsync( + $"[{Schema}].[TaxRate_Archive]", + new { Id = model.Id }, + commandType: CommandType.StoredProcedure); + } + } + + public async Task> GetByLocationAsync(TaxRate model) + { + using (var connection = new SqlConnection(ConnectionString)) + { + var results = await connection.QueryAsync( + $"[{Schema}].[TaxRate_ReadByLocation]", + new { Country = model.Country, PostalCode = model.PostalCode }, + commandType: CommandType.StoredProcedure); + + return results.ToList(); + } + } + } +} diff --git a/src/Core/Services/IPaymentService.cs b/src/Core/Services/IPaymentService.cs index b9b688ff09..70d7a8d90b 100644 --- a/src/Core/Services/IPaymentService.cs +++ b/src/Core/Services/IPaymentService.cs @@ -12,7 +12,7 @@ namespace Bit.Core.Services string paymentToken, Models.StaticStore.Plan plan, short additionalStorageGb, short additionalSeats, bool premiumAccessAddon, TaxInfo taxInfo); Task UpgradeFreeOrganizationAsync(Organization org, Models.StaticStore.Plan plan, - short additionalStorageGb, short additionalSeats, bool premiumAccessAddon); + short additionalStorageGb, short additionalSeats, bool premiumAccessAddon, TaxInfo taxInfo); Task PurchasePremiumAsync(User user, PaymentMethodType paymentMethodType, string paymentToken, short additionalStorageGb, TaxInfo taxInfo); Task AdjustStorageAsync(IStorableSubscriber storableSubscriber, int additionalStorage, string storagePlanId); @@ -26,5 +26,8 @@ namespace Bit.Core.Services Task GetSubscriptionAsync(ISubscriber subscriber); Task GetTaxInfoAsync(ISubscriber subscriber); Task SaveTaxInfoAsync(ISubscriber subscriber, TaxInfo taxInfo); + Task CreateTaxRateAsync(TaxRate taxRate); + Task UpdateTaxRateAsync(TaxRate taxRate); + Task ArchiveTaxRateAsync(TaxRate taxRate); } } diff --git a/src/Core/Services/Implementations/OrganizationService.cs b/src/Core/Services/Implementations/OrganizationService.cs index ebf9f1706f..593eebc963 100644 --- a/src/Core/Services/Implementations/OrganizationService.cs +++ b/src/Core/Services/Implementations/OrganizationService.cs @@ -240,7 +240,7 @@ namespace Bit.Core.Services if (string.IsNullOrWhiteSpace(organization.GatewaySubscriptionId)) { paymentIntentClientSecret = await _paymentService.UpgradeFreeOrganizationAsync(organization, newPlan, - upgrade.AdditionalStorageGb, upgrade.AdditionalSeats, upgrade.PremiumAccessAddon); + upgrade.AdditionalStorageGb, upgrade.AdditionalSeats, upgrade.PremiumAccessAddon, upgrade.TaxInfo); success = string.IsNullOrWhiteSpace(paymentIntentClientSecret); } else diff --git a/src/Core/Services/Implementations/StripePaymentService.cs b/src/Core/Services/Implementations/StripePaymentService.cs index c78c365c4f..e1b254dd5d 100644 --- a/src/Core/Services/Implementations/StripePaymentService.cs +++ b/src/Core/Services/Implementations/StripePaymentService.cs @@ -10,6 +10,8 @@ using Bit.Core.Enums; using Bit.Core.Repositories; using Microsoft.Extensions.Logging; using Bit.Billing.Models; +using StripeTaxRate = Stripe.TaxRate; +using TaxRate = Bit.Core.Models.Table.TaxRate; namespace Bit.Core.Services { @@ -25,13 +27,15 @@ namespace Bit.Core.Services private readonly IAppleIapService _appleIapService; private readonly ILogger _logger; private readonly Braintree.BraintreeGateway _btGateway; + private readonly ITaxRateRepository _taxRateRepository; public StripePaymentService( ITransactionRepository transactionRepository, IUserRepository userRepository, GlobalSettings globalSettings, IAppleIapService appleIapService, - ILogger logger) + ILogger logger, + ITaxRateRepository taxRateRepository) { _btGateway = new Braintree.BraintreeGateway { @@ -45,6 +49,7 @@ namespace Bit.Core.Services _userRepository = userRepository; _appleIapService = appleIapService; _logger = logger; + _taxRateRepository = taxRateRepository; } public async Task PurchaseOrganizationAsync(Organization org, PaymentMethodType paymentMethodType, @@ -98,52 +103,24 @@ namespace Bit.Core.Services throw new GatewayException("Payment method is not supported at this time."); } - var subCreateOptions = new SubscriptionCreateOptions + if (taxInfo != null && !string.IsNullOrWhiteSpace(taxInfo.BillingAddressCountry) && !string.IsNullOrWhiteSpace(taxInfo.BillingAddressPostalCode)) { - OffSession = true, - TrialPeriodDays = plan.TrialPeriodDays, - Items = new List(), - Metadata = new Dictionary + var taxRateSearch = new TaxRate() { - [org.GatewayIdField()] = org.Id.ToString() + Country = taxInfo.BillingAddressCountry, + PostalCode = taxInfo.BillingAddressPostalCode + }; + var taxRates = await _taxRateRepository.GetByLocationAsync(taxRateSearch); + + // should only be one tax rate per country/zip combo + var taxRate = taxRates.FirstOrDefault(); + if (taxRate != null) + { + taxInfo.StripeTaxRateId = taxRate.Id; } - }; - - if (plan.StripePlanId != null) - { - subCreateOptions.Items.Add(new SubscriptionItemOptions - { - Plan = plan.StripePlanId, - Quantity = 1 - }); } - if (additionalSeats > 0 && plan.StripeSeatPlanId != null) - { - subCreateOptions.Items.Add(new SubscriptionItemOptions - { - Plan = plan.StripeSeatPlanId, - Quantity = additionalSeats - }); - } - - if (additionalStorageGb > 0) - { - subCreateOptions.Items.Add(new SubscriptionItemOptions - { - Plan = plan.StripeStoragePlanId, - Quantity = additionalStorageGb - }); - } - - if (premiumAccessAddon && plan.StripePremiumAccessPlanId != null) - { - subCreateOptions.Items.Add(new SubscriptionItemOptions - { - Plan = plan.StripePremiumAccessPlanId, - Quantity = 1 - }); - } + var subCreateOptions = new OrganizationPurchaseSubscriptionOptions(org, plan, taxInfo, additionalSeats, additionalStorageGb, premiumAccessAddon); Customer customer = null; Subscription subscription; @@ -224,7 +201,7 @@ namespace Bit.Core.Services } public async Task UpgradeFreeOrganizationAsync(Organization org, Models.StaticStore.Plan plan, - short additionalStorageGb, short additionalSeats, bool premiumAccessAddon) + short additionalStorageGb, short additionalSeats, bool premiumAccessAddon, TaxInfo taxInfo) { if (!string.IsNullOrWhiteSpace(org.GatewaySubscriptionId)) { @@ -241,52 +218,24 @@ namespace Bit.Core.Services throw new GatewayException("Could not find customer payment profile."); } - var subCreateOptions = new SubscriptionCreateOptions + if (taxInfo != null && !string.IsNullOrWhiteSpace(taxInfo.BillingAddressCountry) && !string.IsNullOrWhiteSpace(taxInfo.BillingAddressPostalCode)) { - Customer = customer.Id, - Items = new List(), - Metadata = new Dictionary + var taxRateSearch = new TaxRate() { - [org.GatewayIdField()] = org.Id.ToString() + Country = taxInfo.BillingAddressCountry, + PostalCode = taxInfo.BillingAddressPostalCode + }; + var taxRates = await _taxRateRepository.GetByLocationAsync(taxRateSearch); + + // should only be one tax rate per country/zip combo + var taxRate = taxRates.FirstOrDefault(); + if (taxRate != null) + { + taxInfo.StripeTaxRateId = taxRate.Id; } - }; - - if (plan.StripePlanId != null) - { - subCreateOptions.Items.Add(new SubscriptionItemOptions - { - Plan = plan.StripePlanId, - Quantity = 1 - }); - } - - if (additionalSeats > 0 && plan.StripeSeatPlanId != null) - { - subCreateOptions.Items.Add(new SubscriptionItemOptions - { - Plan = plan.StripeSeatPlanId, - Quantity = additionalSeats - }); - } - - if (additionalStorageGb > 0) - { - subCreateOptions.Items.Add(new SubscriptionItemOptions - { - Plan = plan.StripeStoragePlanId, - Quantity = additionalStorageGb - }); - } - - if (premiumAccessAddon && plan.StripePremiumAccessPlanId != null) - { - subCreateOptions.Items.Add(new SubscriptionItemOptions - { - Plan = plan.StripePremiumAccessPlanId, - Quantity = 1 - }); } + var subCreateOptions = new OrganizationUpgradeSubscriptionOptions(customer.Id, org, plan, taxInfo, additionalSeats, additionalStorageGb, premiumAccessAddon); var stripePaymentMethod = false; var paymentMethodType = PaymentMethodType.Credit; var hasBtCustomerId = customer.Metadata.ContainsKey("btCustomerId"); @@ -1632,6 +1581,52 @@ namespace Bit.Core.Services } } + public async Task CreateTaxRateAsync(TaxRate taxRate) + { + var stripeTaxRateOptions = new TaxRateCreateOptions() + { + DisplayName = $"{taxRate.Country} - {taxRate.PostalCode}", + Inclusive = false, + Percentage = taxRate.Rate, + Active = true + }; + var taxRateService = new TaxRateService(); + var stripeTaxRate = taxRateService.Create(stripeTaxRateOptions); + taxRate.Id = stripeTaxRate.Id; + await _taxRateRepository.CreateAsync(taxRate); + return taxRate; + } + + public async Task UpdateTaxRateAsync(TaxRate taxRate) + { + if (string.IsNullOrWhiteSpace(taxRate.Id)) + { + return; + } + + await ArchiveTaxRateAsync(taxRate); + await CreateTaxRateAsync(taxRate); + } + + public async Task ArchiveTaxRateAsync(TaxRate taxRate) + { + if (string.IsNullOrWhiteSpace(taxRate.Id)) + { + return; + } + + var stripeTaxRateService = new TaxRateService(); + var updatedStripeTaxRate = await stripeTaxRateService.UpdateAsync( + taxRate.Id, + new TaxRateUpdateOptions() { Active = false } + ); + if (!updatedStripeTaxRate.Active) + { + taxRate.Active = false; + await _taxRateRepository.ArchiveAsync(taxRate); + } + } + private PaymentMethod GetLatestCardPaymentMethod(string customerId) { var paymentMethodService = new PaymentMethodService(); diff --git a/src/Core/Utilities/ServiceCollectionExtensions.cs b/src/Core/Utilities/ServiceCollectionExtensions.cs index c549c571ff..d81d6ac50b 100644 --- a/src/Core/Utilities/ServiceCollectionExtensions.cs +++ b/src/Core/Utilities/ServiceCollectionExtensions.cs @@ -79,6 +79,7 @@ namespace Bit.Core.Utilities services.AddSingleton(); services.AddSingleton(); services.AddSingleton(); + services.AddSingleton(); } if (globalSettings.SelfHosted) diff --git a/src/Sql/dbo/Stored Procedures/TaxRate_Archive.sql b/src/Sql/dbo/Stored Procedures/TaxRate_Archive.sql new file mode 100644 index 0000000000..ccae31a746 --- /dev/null +++ b/src/Sql/dbo/Stored Procedures/TaxRate_Archive.sql @@ -0,0 +1,13 @@ +CREATE PROCEDURE [dbo].[TaxRate_Archive] + @Id VARCHAR(40) +AS +BEGIN + SET NOCOUNT ON + + UPDATE + [dbo].[TaxRate] + SET + [Active] = 0 + WHERE + [Id] = @Id +END diff --git a/src/Sql/dbo/Stored Procedures/TaxRate_Create.sql b/src/Sql/dbo/Stored Procedures/TaxRate_Create.sql new file mode 100644 index 0000000000..5dc6a186b0 --- /dev/null +++ b/src/Sql/dbo/Stored Procedures/TaxRate_Create.sql @@ -0,0 +1,30 @@ +CREATE PROCEDURE [dbo].[TaxRate_Create] + @Id VARCHAR(40), + @Country VARCHAR(50), + @State VARCHAR(2), + @PostalCode VARCHAR(10), + @Rate DECIMAL(5,2), + @Active BIT +AS +BEGIN + SET NOCOUNT ON + + INSERT INTO [dbo].[TaxRate] + ( + [Id], + [Country], + [State], + [PostalCode], + [Rate], + [Active] + ) + VALUES + ( + @Id, + @Country, + @State, + @PostalCode, + @Rate, + 1 + ) +END diff --git a/src/Sql/dbo/Stored Procedures/TaxRate_ReadAllActive.sql b/src/Sql/dbo/Stored Procedures/TaxRate_ReadAllActive.sql new file mode 100644 index 0000000000..4d212c8fce --- /dev/null +++ b/src/Sql/dbo/Stored Procedures/TaxRate_ReadAllActive.sql @@ -0,0 +1,9 @@ +CREATE PROCEDURE [dbo].[TaxRate_ReadAllActive] +AS +BEGIN + SET NOCOUNT ON + + SELECT * FROM [dbo].[TaxRate] + WHERE Active = 1 +END +GO diff --git a/src/Sql/dbo/Stored Procedures/TaxRate_ReadById.sql b/src/Sql/dbo/Stored Procedures/TaxRate_ReadById.sql new file mode 100644 index 0000000000..9838ff92d7 --- /dev/null +++ b/src/Sql/dbo/Stored Procedures/TaxRate_ReadById.sql @@ -0,0 +1,9 @@ +CREATE PROCEDURE [dbo].[TaxRate_ReadById] + @Id VARCHAR(40) +AS +BEGIN + SET NOCOUNT ON + + SELECT * FROM [dbo].[TaxRate] + WHERE Id = @Id +END \ No newline at end of file diff --git a/src/Sql/dbo/Stored Procedures/TaxRate_ReadByLocation.sql b/src/Sql/dbo/Stored Procedures/TaxRate_ReadByLocation.sql new file mode 100644 index 0000000000..d8097cbbc6 --- /dev/null +++ b/src/Sql/dbo/Stored Procedures/TaxRate_ReadByLocation.sql @@ -0,0 +1,12 @@ +CREATE PROCEDURE [dbo].[TaxRate_ReadByLocation] + @Country VARCHAR(50), + @PostalCode VARCHAR(10) +AS +BEGIN + SET NOCOUNT ON + + SELECT * FROM [dbo].[TaxRate] + WHERE Active = 1 + AND [Country] = @Country + AND [PostalCode] = @PostalCode +END diff --git a/src/Sql/dbo/Stored Procedures/TaxRate_Search.sql b/src/Sql/dbo/Stored Procedures/TaxRate_Search.sql new file mode 100644 index 0000000000..a7539683af --- /dev/null +++ b/src/Sql/dbo/Stored Procedures/TaxRate_Search.sql @@ -0,0 +1,14 @@ +CREATE PROCEDURE [dbo].[TaxRate_Search] + @Skip INT = 0, + @Count INT = 25 +AS +BEGIN + SET NOCOUNT ON + + SELECT * FROM [dbo].[TaxRate] + WHERE Active = 1 + ORDER BY Country, PostalCode DESC + OFFSET @Skip ROWS + FETCH NEXT @Count ROWS ONLY +END +GO diff --git a/src/Sql/dbo/Tables/TaxRate.sql b/src/Sql/dbo/Tables/TaxRate.sql new file mode 100644 index 0000000000..ea2ba41ae3 --- /dev/null +++ b/src/Sql/dbo/Tables/TaxRate.sql @@ -0,0 +1,14 @@ +CREATE TABLE [dbo].[TaxRate] ( + [Id] VARCHAR(40) NOT NULL, + [Country] VARCHAR(50) NOT NULL, + [State] VARCHAR(2) NULL, + [PostalCode] VARCHAR(10) NOT NULL, + [Rate] DECIMAL(5,2) NOT NULL, + [Active] BIT NOT NULL, + CONSTRAINT [PK_TaxRate] PRIMARY KEY CLUSTERED ([Id] ASC) +); +GO + +CREATE UNIQUE INDEX [IX_TaxRate_Country_PostalCode_Active_Uniqueness] +ON [dbo].[TaxRate](Country, PostalCode) +WHERE Active = 1; diff --git a/util/Migrator/DbScripts/2020-11-16_00_SalesTax.sql b/util/Migrator/DbScripts/2020-11-16_00_SalesTax.sql new file mode 100644 index 0000000000..54c8d9f66b --- /dev/null +++ b/util/Migrator/DbScripts/2020-11-16_00_SalesTax.sql @@ -0,0 +1,149 @@ +IF OBJECT_ID('[dbo].[Policy]') IS NULL +BEGIN + CREATE TABLE [dbo].[TaxRate] ( + [Id] VARCHAR(40) NOT NULL, + [Country] VARCHAR(50) NOT NULL, + [State] VARCHAR(2) NULL, + [PostalCode] VARCHAR(10) NOT NULL, + [Rate] DECIMAL(5,2) NOT NULL, + [Active] BIT NOT NULL, + CONSTRAINT [PK_TaxRate] PRIMARY KEY CLUSTERED ([Id] ASC) + ); + + CREATE UNIQUE INDEX [IX_TaxRate_Country_PostalCode_Active_Uniqueness] + ON [dbo].[TaxRate](Country, PostalCode) + WHERE Active = 1; +END +GO + +IF OBJECT_ID('[dbo].[TaxRate_ReadById]') IS NOT NULL +BEGIN + DROP PROCEDURE [dbo].[TaxRate_ReadById] +END +GO + +CREATE PROCEDURE [dbo].[TaxRate_ReadById] + @Id VARCHAR(40) +AS +BEGIN + SET NOCOUNT ON + + SELECT * FROM [dbo].[TaxRate] + WHERE Id = @Id +END +GO + +IF OBJECT_ID('[dbo].[TaxRate_Search]') IS NOT NULL +BEGIN + DROP PROCEDURE [dbo].[TaxRate_Search] +END +GO + +CREATE PROCEDURE [dbo].[TaxRate_Search] + @Skip INT = 0, + @Count INT = 25 +AS +BEGIN + SET NOCOUNT ON + + SELECT * FROM [dbo].[TaxRate] + WHERE Active = 1 + ORDER BY Country, PostalCode DESC + OFFSET @Skip ROWS + FETCH NEXT @Count ROWS ONLY +END +GO + +IF OBJECT_ID('[dbo].[TaxRate_ReadAllActive]') IS NOT NULL +BEGIN + DROP PROCEDURE [dbo].[TaxRate_ReadAllActive] +END +GO + +CREATE PROCEDURE [dbo].[TaxRate_ReadAllActive] +AS +BEGIN + SET NOCOUNT ON + + SELECT * FROM [dbo].[TaxRate] + WHERE Active = 1 +END +GO + +IF OBJECT_ID('[dbo].[TaxRate_ReadByLocation]') IS NOT NULL +BEGIN + DROP PROCEDURE [dbo].[TaxRate_ReadByLocation] +END +GO + +CREATE PROCEDURE [dbo].[TaxRate_ReadByLocation] + @Country VARCHAR(50), + @PostalCode VARCHAR(10) +AS +BEGIN + SET NOCOUNT ON + + SELECT * FROM [dbo].[TaxRate] + WHERE Active = 1 + AND [Country] = @Country + AND [PostalCode] = @PostalCode +END +GO + +IF OBJECT_ID('[dbo].[TaxRate_Create]') IS NOT NULL +BEGIN + DROP PROCEDURE [dbo].[TaxRate_Create] +END +GO + +CREATE PROCEDURE [dbo].[TaxRate_Create] + @Id VARCHAR(40), + @Country VARCHAR(50), + @State VARCHAR(2), + @PostalCode VARCHAR(10), + @Rate DECIMAL(5,2), + @Active BIT +AS +BEGIN + SET NOCOUNT ON + + INSERT INTO [dbo].[TaxRate] + ( + [Id], + [Country], + [State], + [PostalCode], + [Rate], + [Active] + ) + VALUES + ( + @Id, + @Country, + @State, + @PostalCode, + @Rate, + 1 + ) +END +GO + +IF OBJECT_ID('[dbo].[TaxRate_Archive]') IS NOT NULL +BEGIN + DROP PROCEDURE [dbo].[TaxRate_Archive] +END +GO + +CREATE PROCEDURE [dbo].[TaxRate_Archive] + @Id VARCHAR(40) +AS +BEGIN + SET NOCOUNT ON + + UPDATE + [dbo].[TaxRate] + SET + [Active] = 0 + WHERE + [Id] = @Id +END