VeeFriends.LinkShortener 5.0.13

VeeFriends.LinkShortener 📎✨

VeeFriends.LinkShortener is a modern, production-ready .NET 9 library and service for creating, managing, and tracking short links. It features robust analytics, QR code generation, and seamless integration with Azure Table Storage, Cloudinary, and Link Preview APIs. Designed for extensibility and testability, it supports dependency injection and is fully covered by automated tests.

Features

• Short Link Creation: Generate branded, expiring, and analytics-enabled short URLs.
• Analytics Tracking: Collects and stores detailed analytics for each link visit, including IP, user agent, geo, and device info.
• QR Code Generation: Automatically generates QR codes for each short link.
• Link Preview Integration: Fetches and stores link preview metadata (title, description, image).
• Cloudinary Support: Stores and serves QR codes and images via Cloudinary.
• Azure Table Storage: Fast, scalable, and cost-effective storage for links and analytics.
• Extensible & Testable: Built for dependency injection and easy extension.
• .NET 9 & C# 13: Uses the latest .NET and C# features.

Installation

Install the VeeFriends.LinkShortener NuGet package in your project:

dotnet add package VeeFriends.LinkShortener

Usage

1. Configuration

Configure the necessary services in your Startup.cs or Program.cs file:

using Microsoft.Extensions.DependencyInjection; 
using VeeFriends.LinkShortener;

var services = new ServiceCollection(); 

services.AddLinkShortener(options => { 
    options.AzureTableConnectionString = "your-azure-table-connection-string"; 
    options.CloudinaryApiSecret = "your-cloudinary-api-secret"; 
    options.CloudinaryApiKey = "your-cloudinary-api-key"; 
    options.CloudinaryCloudName = "your-cloudinary-cloud-name"; 
    options.LinkPreviewApiKey = "your-link-preview-api-key"; 
    options.HostUrl = "https://your-shortener-domain.com"; 
});

2. Creating and Managing Links

Inject the LinkService and use its methods to create, update, delete, and retrieve links:

public class MyLinkService 
{ 
    private readonly LinkService _linkService;

    public MyLinkService(LinkService linkService)
    {
        _linkService = linkService;
    }

    public async Task CreateAndTrackAsync()
    {
        // Create a new short link
        var link = await _linkService.CreateLink(
            "My Campaign",
            "https://veefriends.com",
            slug: null,
            expiresAt: DateTime.UtcNow.AddDays(7),
            CancellationToken.None
        );

        // Retrieve by slug
        var retrieved = await _linkService.GetLinkBySlug("your-slug", CancellationToken.None);

        // Track a view (analytics)
        var request = new HttpRequestMessage(HttpMethod.Get, link.ShortUrl);
        await _linkService.TrackViewBySlug("your-slug", request, CancellationToken.None);

        // Get analytics
        var analytics = await _linkService.GetAnalyticsBySlug("your-slug", CancellationToken.None);
    }
}

3. Analytics

Analytics are automatically tracked for each link visit, including:

• Request method and URL
• IP address and geo lookup (country, region, city)
• User agent, device type, OS, and browser
• Referrer

Retrieve analytics for a link:

var analytics = await linkService.GetAnalyticsBySlug("your-slug", CancellationToken.None); 

foreach (var entry in analytics) 
{ 
    Console.WriteLine($"{entry.Timestamp}: {entry.IpAddress} - {entry.UserAgent}"); 
}

License

This project is licensed under the MIT License. See the LICENSE file for more details.