Download the PHP package palpalani/baylinks-laravel without Composer

About

This Laravel package provides an elegant, fluent interface to the BayLinks API - a powerful URL shortening and management platform for modern businesses. Built on top of Saloon PHP, this SDK offers type-safe request/response handling, robust error management, and seamless Laravel integration.

Features

• 🎯 Type-Safe: Full PHP 8.3+ type safety with PHPStan level 4 analysis
• 🚀 Modern Architecture: Built on Saloon PHP for elegant HTTP client abstraction
• 🔒 Secure: Per-request API key authentication with built-in error handling
• 🧪 Well-Tested: Comprehensive test suite with Pest PHP
• 📦 Laravel Native: First-class Laravel integration with service provider and facade
• 🔄 Bulk Operations: Support for bulk URL creation and management
• 📊 Analytics: Track URL visit records and performance metrics
• 🎨 PSR Compliant: Follows PSR-1, PSR-2, and PSR-12 coding standards

Requirements

• PHP 8.3 or higher
• Laravel 10.x, 11.x, or 12.x
• Composer 2.x

Installation

Install the package via Composer:

Configuration

Publish the configuration file:

This creates config/baylinks-laravel.php with the following structure:

Update your .env file:

Usage

Basic Examples

Retrieve Account Information

Create a Single Short URL

Create Multiple Short URLs (Bulk)

Advanced Usage

Update Short URL Status

Retrieve Visit Records

Using Dependency Injection

Error Handling

API Reference

Client Initialization

Available Methods

Account Operations

URL Operations

Request Payload Schemas

Create Short URL

Create Bulk URLs

Testing

Run the full test suite with Pest:

Run tests with coverage:

Run specific test file:

Run tests with filtering:

Code Quality

Run PHPStan static analysis:

Format code with Laravel Pint:

Development

Architecture

This package uses Saloon PHP for HTTP client abstraction:

• Factory: Main connector extending Saloon\Http\Connector
• Resources: Group related API endpoints (AccountResource, CreateShortURLResource)
• Requests: Individual API requests extending Saloon\Http\Request
• Responses: Transform API responses to DTOs
• Objects: Immutable data transfer objects

Adding New Endpoints

1. Create a new Request class in src/Requests/{Category}/
2. Create a corresponding Response class in src/Responses/{Category}/
3. Add a Resource method or create new Resource in src/Resources/
4. Update the Factory with a new resource method if needed
5. Write tests in tests/

See CLAUDE.md for detailed development guidelines.

Continuous Integration

This package uses GitHub Actions for automated testing and quality checks:

All workflows use Composer caching for faster builds and concurrency controls to prevent redundant runs.

Troubleshooting

Common Issues

"Class 'BayLinks' not found"

Make sure you've published the service provider:

Authentication Errors

Verify your API key is correct and active:

SSL Certificate Issues

If you encounter SSL errors in development:

Changelog

Please see CHANGELOG for recent changes and version history.

Contributing

We welcome contributions! Here's how you can help:

Getting Started

1. Fork the repository
2. Create a feature branch: git checkout -b feature/my-new-feature
3. Make your changes and commit: git commit -am 'Add new feature'
4. Push to the branch: git push origin feature/my-new-feature
5. Submit a pull request

Development Guidelines

• Follow PSR-1, PSR-2, and PSR-12 coding standards
• Write tests for new features (we use Pest)
• Ensure PHPStan passes at level 4: composer analyse
• Format code with Pint: composer format
• Update documentation for API changes
• Add entries to CHANGELOG.md

Running Tests

Pull Request Checklist

• [ ] Tests pass (composer test)
• [ ] Static analysis passes (composer analyse)
• [ ] Code is formatted (composer format)
• [ ] Documentation is updated
• [ ] CHANGELOG.md is updated

Security

If you discover any security-related issues, please email [email protected] instead of using the issue tracker. All security vulnerabilities will be promptly addressed.

Credits

• palPalani - Creator & Maintainer
• Prasanth - Core Developer
• All Contributors - Community Contributors

License

The MIT License (MIT). Please see License File for more information.