FEPBA.Helper 6.0.0

FEPBA.Helper

Espa�ol

Libreria para ejecutar stored procedures en SQL Server

• Tiene la opci�n de modificar el tiempo l�mite antes de que se levante el error de Timeout al ejecutar stored procedures, el par�metro es opcional en los constructores

• Tiene la opci�n de modificar el porcentaje de precision para la comparacion de los nombres de las propiedades, el par�metro es opcional en los constructores

• Tiene la opci�n de ejecutar un stored procedure para usar un Log de todas las ejecuciones. Es necesario usar la sobrecarga del constructor que recibe como par�metros el string de conexi�n, el nombre del stored procedure a ejecutar y un booleano para activar la ejecuci�n del Log

  • El stored procedure de Log debe aceptar como par�metros:
    • string procedureName: nombre del stored procedure ejecutado previo
    • int ExecuteTime: tiempo de ejecuci�n en milisegundos

• Tiene una clase que permite realizar peticiones HTTP a un servidor interno. Es especialmente dise�ado para ser utilizado por FEPBA. Con este paquete, puedes establecer conexiones REST con tu servidor interno y realizar diversas operaciones HTTP.

Resumen

�Gracias por elegir nuestro paquete NuGet! Este archivo README proporcionar� informaci�n esencial sobre la funcionalidad y el uso del paquete.

Funcionalidades Clave

• Conexiones HTTP: Establece conexiones HTTP con servidores internos.
• Peticiones REST: Realiza peticiones REST como GET, POST, PUT, DELETE, etc.
• Interacci�n con datos: Env�a y recibe datos JSON/XML a trav�s de las peticiones.
• Autenticaci�n y seguridad: Admite autenticaci�n y seguridad mediante encabezados de autorizaci�n.

Instalaci�n

Puedes instalar el paquete NuGet FEPBA.HttpRestConnections siguiendo estos pasos:

1. Abre tu proyecto en [Visual Studio/tu IDE preferido].
2. Ve al Administrador de paquetes NuGet.
3. Busca "FEPBA.Helper" en la barra de b�squeda de paquetes.
4. Selecciona la �ltima versi�n del paquete.
5. Haz clic en el bot�n "Instalar" para agregar el paquete a tu proyecto.

Alternativamente, puedes instalar el paquete a trav�s de la Consola del Administrador de paquetes utilizando el siguiente comando:

Install-Package FEPBA.Helper

Uso

Para utilizar las funcionalidades proporcionadas por FEPBA.Helper, sigue estas pautas:

1. Importa el espacio de nombres en tu archivo de c�digo:

using FEPBA.Helper;

2. Crea una instancia de la clase ProxyHttpClient o ProxyHttpClientFactory para establecer la conexi�n con el servidor interno (es recomendable mantener la instancia antes crea crear nuevas):

ProxyHttpClient restHelper;

Ambas clases heredan de la clase abstracta BaseHttpClient, esta misma se puede usar para crear tu propia clases con el manejo del HttpClient preferio

public abstract class BaseHttpClient : IProxyHttpClient
{
    internal abstract HttpClient client { get; }
}

3. Aseg�rate de cargarle la configuraci�n en el constructor de tu controlador:

restHelper = new ProxyHttpClient(configuration);

La configuraci�n se encuentra en appsetings.json, donde cargamos el connectionString y las URL.

{
  "SQLServerLogger": {
    "ConnectionStrings": "User id=LogerUser;Password=App_Log_Password;Server=servidor;Database=LoggerDB;App=NombreAplicacion;TrustServerCertificate=True",
    "IsActive": true,
    "Include200": false,
    "TrackMethods": [],
    "TrackService": [],
	"ForceTrackMethods": [],
    "ForceTrackService": [],
	"IgnoreMethods" : [],
	"IgnoreService" : []
  }
}

Opcionalmente se puede agregar en el archivo appsetings.json una seccion llamada "ErrorHandling" para guardar mensajes predefinidos para los codigos de error http

{
	"ErrorHandling": [
		"404": "Not Found",
		"418": "My teapot"
	]
}

El Proxy utiliza un store procedure con estos campos

ALTER PROCEDURE [dbo].[AddRequestResposeLog] 
	@Username [varchar](100) NULL,
	@RequestMethod [varchar](100) NULL,
	@UrlRequestFrontend [varchar](100) NULL,
	@UrlRequestBackend [varchar](100) = NULL,
	@QueryString [varchar](100) = NULL,
	@RequestHeaders [nvarchar](max) NULL,
	@RequestBody [nvarchar](max) = NULL,
	@FrontendException [nvarchar](max) = NULL,
	@BackendResponse [nvarchar](max) = NULL,
	@StatusCode [int] NULL,
	@new_identity INT = NULL OUTPUT
AS
BEGIN
	-- SET NOCOUNT ON added to prevent extra result sets from
	-- interfering with SELECT statements.
	SET NOCOUNT ON;

    -- Insert statements for procedure here
	 
	 INSERT INTO [dbo].[Logger]
           ([Username]
           ,[RequestMethod]
           ,[UrlRequestFrontend]
           ,[UrlRequestBackend]
           ,[QueryString]
           ,[RequestHeaders]
           ,[RequestBody]
           ,[FrontendException]
           ,[BackendResponse]
           ,[StatusCode])
		   VALUES
           (
				@Username,
				@RequestMethod,
				@UrlRequestFrontend,
				@UrlRequestBackend,
				@QueryString,
				@RequestHeaders,
				@RequestBody,
				@FrontendException,
				@BackendResponse,
				@StatusCode
		);

    SET @new_identity = SCOPE_IDENTITY();
	SELECT	@new_identity as N'New_Identity'
END

4. Utiliza los m�todos proporcionados por ProxyHttpClient para realizar peticiones HTTP:

// Ejemplo de una petici�n GET
var logGetResponse = restHelper.RestCallGet(urilogGet, this);

// Ejemplo de una petici�n POST
// En este ejemplo se hace una petici�n POST para enviar un email
Mail mail = new Mail()
{
    To = "mail@ejemplo.com",
    Subject = "Rellena con tu subject",
    Body = bodyHtml,
    HTML = true,
    From = "no-responder@fepba.gov.ar"
};
var PostResponse = restHelperEnviar.RestCallPost(uri, mail, this);

5. Maneja las respuestas de las peticiones y los errores seg�n tus necesidades. Nuestras respuestas suelen ser JSON con el siguiente formato:

{
  "ok": "STATUS CODE",
  "data = "DATA DE LA RESPUESTA",
  "message" = "MENSAJE DE LA RESPUESTA"
 };

6. Te permite armar la lista de parametros para tus store procedure con codigo más limpio

DbParameter.AddInputParameter(ref parametersList, new Dictionary<string, object>()
{
    { "name", value },
    { "name", "value" },
    { "name", value != null ? value : DBNull.Value }
});

PD: La clase HttpHelperRestConections va a ser eliminada en las versiones de .NET 8 en adelante

Contribuciones

EL equipo de informatica de FEPBA