Coject.Core.Helper v1.0.37 — nugetz
Coject/ Coject.Core.Helper v1.0.37 .NET 8.0
A comprehensive .NET 8.0 helper library providing production-ready utilities for enterprise applications. Coject.Core.Helper streamlines common development tasks with robust implementations for file management, email services, data processing, security, and cloud integration.
Key Features:
- File Management: Multi-provider support (AWS S3, FTP, Local) with upload, download, and file signature validation
- Email Services: Full-featured SMTP integration using MailKit with template support and signature generation
- Security: Data encryption, JWT token handling, and barcode generation with ZXing
- Data Utilities: JSON processing, date/time helpers, string manipulation, and image handling
- Cloud Integration: Seamless AWS S3 operations with configurable storage solutions
- API Integration: Helper classes for external service communication
Perfect for applications requiring reliable file storage, secure email delivery, data encryption, and cloud service integration. Built with extensibility and performance in mind, this library reduces boilerplate code and accelerates development cycles.
Dependencies include MailKit, MimeKit, AWSSDK.S3, System.IdentityModel.Tokens.Jwt, and ZXing.Net.Mobile for comprehensive functionality.
Get Started dotnet CLI PackageReference Package Manager
$ dotnet add package Coject.Core.HelperReadme Coject.Core.Helper
A comprehensive .NET helper library providing essential utilities for file management, email operations, SMS services, data handling, encryption, and integration with cloud services.
Overview
Coject.Core.Helper is a production-ready utility library designed to streamline common development tasks in .NET applications. It offers robust implementations for file operations, email services, SMS integration, data manipulation, security features, and multiple storage provider support.
Features
📁 File Management
Multiple Storage Providers : Support for AWS S3, FTP, and local file systemsFile Operations : Upload, download, delete, and manage files across different storage backendsDigital Signatures : Generate and validate file signaturesFormat Support : Handle various file formats with dedicated helpersShared Links : Generate temporary shared links with configurable expiry times
📧 Email Services
SMTP Integration : Send emails using MailKit with advanced configurationTemplate Support : Professional email signature generationAttachment Handling : Easy attachment managementHTML/Plain Text : Support for both email formats
📱 SMS Integration
Multi-Provider Support : Configurable SMS provider integrationOTP Messages : Built-in support for one-time password deliveryFlexible Response Handling : JSON or string-based success/error detectionCustom Parameters : Configurable parameter names for different SMS gatewaysURL Encoding : Optional parameter encoding for compatibility
🔐 Security & Encryption
Data Encryption : Secure encryption and decryption utilities with IV key support
JWT Tokens : Token generation and validation
Barcode Generation : Create barcodes using ZXing.Net
Shared Link Security : Time-based expiry for secure file sharing
📊 Data Utilities
JSON Processing : Advanced JSON serialization and deserialization helpersDate Handling : Comprehensive date and time utilitiesString Operations : String manipulation and formatting toolsImage Processing : Image handling and conversion utilitiesMap Data : Geographic data processing helpers
☁️ Cloud Integration
AWS S3 : Full support for Amazon S3 operationsFTP : Traditional FTP server integrationConfigurable : Easy configuration for different storage providers
Installation Install via NuGet Package Manager:
dotnet add package Coject.Core.Helper
Or via Package Manager Console:
Install-Package Coject.Core.Helper
Requirements
.NET 8.0 or higher
Dependencies are automatically installed via NuGet
Configuration
Application Settings Structure Add the following configuration to your appsettings.json:
{
"AttachmentSettings": {
"StorageType": "FTP",
"SharedLinkExpiryMinutes": 60,
"EXPIRY_IV_KEY": "ByDz579cdbMMZq8cbzMhtA==",
"AWS": {
"Key": "your-aws-access-key",
"SecretKey": "your-aws-secret-key",
"BucketName": "your-bucket-name"
},
"FTP": {
"Server": "ftp://your-ftp-server.com",
"Username": "ftp-username",
"Password": "ftp-password"
},
"SmsSettings": {
"Provider": "sms-provider-name",
"BaseUrl": "https://sms-gateway.com/",
"SendPath": "api/send",
"UsernameParameter": "username",
"PasswordParameter": "password",
"SenderParameter": "Sender",
"TextParameter": "Text",
"NumberParameter": "number",
"Username": "your-sms-username",
"Password": "your-sms-password",
"Sender": "YourAppName",
"TimeoutSeconds": 30,
"UrlEncodeParameters": true,
"SuccessString": "",
"SuccessCriteria": {
"Type": "json",
"SuccessProperty": "Status",
"SuccessValue": "0"
},
"ErrorCriteria": {
"Type": "string",
"ErrorKeyword": "Error Code"
},
"OTPMessage": "Use the code {0} to log in."
}
}
}
Configuration Parameters
Storage Settings Parameter Type Description StorageTypestring Storage provider to use: "AWS", "FTP", or "Local" SharedLinkExpiryMinutesinteger Duration in minutes before shared links expire EXPIRY_IV_KEYstring Base64 encoded initialization vector for encryption
AWS S3 Settings Parameter Type Description Keystring AWS access key ID SecretKeystring AWS secret access key BucketNamestring S3 bucket name for file storage
FTP Settings Parameter Type Description Serverstring FTP server URL (include ftp:// or ftps://) Usernamestring FTP account username Passwordstring FTP account password
SMS Settings Parameter Type Description Providerstring Name/identifier of the SMS provider BaseUrlstring Base URL of the SMS gateway API SendPathstring API endpoint path for sending SMS UsernameParameterstring Parameter name for username in API request PasswordParameterstring Parameter name for password in API request SenderParameterstring Parameter name for sender ID in API request TextParameterstring Parameter name for message text in API request NumberParameterstring Parameter name for recipient number in API request Usernamestring Your SMS gateway account username Passwordstring Your SMS gateway account password Senderstring Default sender name/ID for outgoing messages TimeoutSecondsinteger Request timeout duration (default: 30) UrlEncodeParametersboolean Whether to URL encode parameters (default: true) SuccessStringstring Optional string to match for success (legacy) OTPMessagestring Template for OTP messages. Use {0} for code placeholder
SMS Success Criteria Parameter Type Description Typestring Response format: "json" or "string" SuccessPropertystring JSON property name to check for success (json type only) SuccessValuestring Expected value indicating success
SMS Error Criteria Parameter Type Description Typestring Error detection format: "json" or "string" ErrorKeywordstring Keyword/property indicating an error occurred
Configuration Examples
Using AWS S3 Storage {
"AttachmentSettings": {
"StorageType": "AWS",
"AWS": {
"Key": "AKIAIOSFODNN7EXAMPLE",
"SecretKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
"BucketName": "my-application-files"
}
}
}
Using FTP Storage {
"AttachmentSettings": {
"StorageType": "FTP",
"FTP": {
"Server": "ftp://files.company.com",
"Username": "fileadmin",
"Password": "SecureP@ssw0rd"
}
}
}
SMS with JSON Response {
"AttachmentSettings": {
"SmsSettings": {
"SuccessCriteria": {
"Type": "json",
"SuccessProperty": "Status",
"SuccessValue": "0"
}
}
}
}
{
"Status": "0",
"Message": "SMS sent successfully"
}
SMS with String Response {
"AttachmentSettings": {
"SmsSettings": {
"SuccessCriteria": {
"Type": "string",
"SuccessValue": "SUCCESS"
},
"ErrorCriteria": {
"Type": "string",
"ErrorKeyword": "ERROR"
}
}
}
}
Expected API response: "SUCCESS: Message delivered"
Usage Scenarios
File Storage Operations The library automatically uses the configured storage provider based on the StorageType setting:
Upload a file : Files are automatically routed to AWS S3, FTP, or local storage based on configuration
Download a file : Retrieve files from the configured storage provider
Generate shared link : Create temporary links with automatic expiry based on SharedLinkExpiryMinutes
Delete a file : Remove files from the configured storage backend
SMS Operations Send OTP : The library uses the OTPMessage template to format one-time passwords
Send notifications : Send SMS messages through the configured provider
Custom parameters : The library maps your provider's parameter names using the configuration settings
Response validation : Automatically validates success/failure based on SuccessCriteria and ErrorCriteria
Email Operations Send emails : SMTP integration with attachment support
Generate signatures : Professional email signature generation
HTML/Plain text : Support for both formats with template support
Encryption & Security Encrypt data : Uses the configured EXPIRY_IV_KEY for secure encryption
Generate tokens : JWT token generation with configurable expiry
Shared links : Time-based security for temporary file access
Project Structure CojectCore.Helper/
├── API/
│ └── APIHelper.cs
├── EmailManager/
│ ├── Entity/
│ ├── Interface/
│ └── Service/
├── FileSignatures/
│ ├── Abstract/
│ ├── Formats/
│ ├── Interface/
│ └── Service/
├── FilesManager/
│ ├── Entity/
│ ├── Interface/
│ └── Service/
│ ├── CojectFileControllerHelper.cs
│ ├── CojectFileManager.cs
│ ├── CojectFileManagerAWS.cs
│ ├── CojectFileManagerFTP.cs
│ └── CojectFileManagerHelper.cs
├── BarcodeHelper.cs
├── DateHelper.cs
├── EncryptionHelper.cs
├── FileHelper.cs
├── ImageHelper.cs
├── JsonHelper.cs
├── MapDataHelper.cs
├── SmsHelper.cs
└── StringHelper.cs
Dependencies This package includes the following key dependencies:
AWSSDK.S3 (v3.7.406.2) - Amazon S3 integrationMailKit (v4.8.0) - Email operationsMimeKit (v4.8.0) - MIME message handlingNewtonsoft.Json (v13.0.3) - JSON serializationSystem.IdentityModel.Tokens.Jwt (v8.2.1) - JWT token handlingZXing.Net.Mobile (v2.4.1) - Barcode generationSystem.Drawing.Common (v9.0.0) - Image processingSystem.Data.SQLite (v1.0.119) - Database operationsCoject.Core.Controller - Core controller functionalityCoject.Core.Model - Data models
Best Practices
Security
Never hardcode credentials : Always use configuration files or environment variablesSecure configuration : Encrypt sensitive sections in production using .NET configuration encryptionIV Key rotation : Regularly rotate the EXPIRY_IV_KEY for enhanced securityShared link expiry : Set appropriate SharedLinkExpiryMinutes based on your security requirements
Storage Configuration
Choose the right provider : AWS S3 for scalability, FTP for legacy systems, Local for developmentTest connectivity : Verify storage provider credentials before deploymentBackup strategy : Implement proper backup procedures for your chosen storage type
SMS Configuration
Provider compatibility : Ensure parameter names match your SMS gateway's APIResponse validation : Test both success and error scenarios with your providerURL encoding : Enable UrlEncodeParameters if your provider requires encoded valuesTimeout settings : Adjust TimeoutSeconds based on provider response timesMessage templates : Customize OTPMessage to match your application's branding
Performance
Async operations : The library uses async methods for all I/O operationsConnection pooling : Reuse connections when possibleError handling : Implement proper try-catch blocks for network operationsResource disposal : Ensure proper disposal of streams and connections
Troubleshooting
Storage Issues
Verify Key and SecretKey are correct
Ensure bucket exists and has proper permissions
Check IAM policies for S3 access
Verify server URL includes protocol (ftp:// or ftps://)
Check username and password
Ensure firewall allows FTP connections
SMS Issues
Verify BaseUrl and SendPath are correct
Check SMS provider credentials
Ensure parameter names match provider's API
Success/Error Not Detected
Review provider's response format
Adjust SuccessCriteria.Type to match response (json/string)
Verify property names and values are correct
Shared Link Issues
Increase SharedLinkExpiryMinutes value
Check server time synchronization
Ensure EXPIRY_IV_KEY is valid Base64 string
Verify key hasn't been modified or corrupted
Versioning This package follows Semantic Versioning (SemVer). Current version: 1.0.36
Support For issues, feature requests, or contributions, please contact the development team at Akwad Arabia.
License Copyright © Akwad Al-Arabia 2024. All rights reserved.
See LICENSE.txt for detailed license information.
Authors Developed and maintained by Akwad Arabia
Part of the Coject Core ecosystem