hamrocdn/sdk

SDK for HamroCDN - A CDN service provider

v1.1.1 2025-10-28 20:34 UTC

Requires

• php: >=8.0
• guzzlehttp/guzzle: ^7.10
• nesbot/carbon: ^3.10

Requires (Dev)

• laravel/pint: ^1.25
• pestphp/pest: ^4.1
• phpstan/phpstan: ^2.1
• rector/rector: ^2.2

MIT

• achyutkneupane

• php
• sdk
• cdn
• laravel
• hamrocdn

README

Official PHP SDK for HamroCDN — a simple, typed, and framework-agnostic way to upload, fetch, and manage files from your HamroCDN account.

📦 Installation

Install via Composer:

composer require hamrocdn/sdk

Requirements

• PHP 8.0+
• GuzzleHTTP 7.10+

That’s it.
No Laravel dependencies, no magic — just pure PHP.

⚙️ Configuration

You can pass your API key directly, or rely on environment/config values if available.

use HamroCDN\HamroCDN;

$cdn = new HamroCDN('your-api-key');

Alternatively, if your environment has them:

export HAMROCDN_API_KEY="your-api-key"

the SDK automatically detects and uses them.

⚡ Quick Start

Here’s a quick example showing upload and fetch in action:

use HamroCDN\HamroCDN;

$cdn = new HamroCDN('your-api-key');

// Upload a file
$upload = $cdn->upload('/path/to/image.jpg');

echo "Uploaded: " . $upload->getOriginal()->getUrl() . PHP_EOL;

// Fetch it again
$fetched = $cdn->fetch($upload->getNanoId());

echo "Fetched: " . $fetched->getOriginal()->getUrl() . PHP_EOL;

🚀 Usage

This SDK make use of public API provided by HamroCDN. To get your API key, sign up at hamrocdn.com and navigate to Edit Profile page in your dashboard.

1. List Uploads

1.1 Paginated

The index() method returns paginated results.
You can provide pagination parameters such as page and per_page:

$uploads = $cdn->index(page: 1, per_page: 10);

foreach ($uploads->all() as $upload) {
    echo $upload->getNanoId() . ' - ' . $upload->getOriginal()->getUrl() . PHP_EOL;
}

Returns an object containing data (array of Upload models) and meta (pagination info).

Example of returned metadata:

{
  "meta": {
    "total": 120,
    "per_page": 10,
    "page": 1
  }
}

1.2 All Uploads

To fetch all uploads without pagination, use the all() method:

$uploads = $cdn->all();
foreach ($uploads as $upload) {
    echo $upload->getNanoId() . ' - ' . $upload->getOriginal()->getUrl() . PHP_EOL;
}

Returns an array of Upload models.

2. Fetch a Single Upload

$upload = $cdn->fetch('abc123');

echo $upload->getOriginal()->getUrl(); // https://hamrocdn.com/abc123/original

3. Upload a File

$upload = $cdn->upload('/path/to/image.png');

echo $upload->getNanoId(); // nano ID of the uploaded file

To delete the file after a certain time, use the deleteAfter parameter (in seconds):

$upload = $cdn->upload('/path/to/image.png', deleteAfter: 3600); // Deletes after 1 hour

This will set the deleteAt property on the returned Upload model.

4. Upload by Remote URL

$upload = $cdn->uploadByURL('https://example.com/image.png');

echo $upload->getOriginal()->getUrl();

Also supports the deleteAfter parameter.

🧱 Models

🗂 HamroCDN\Models\Upload

Property	Type	Description
nanoId	string	Unique identifier of the upload
user	User or null	Owner of the file (if authenticated)
deleteAt	Carbon or null	Deletion timestamp if temporary
original	File	File information (URL, size)

Methods

• getNanoId(): string
• getUser(): ?User
• getDeleteAt(): ?Carbon
• getOriginal(): File
• toArray(): array

👤 HamroCDN\Models\User

Property	Type	Description
name	string	Name of the uploader
email	string	Email of the uploader

Methods

• getName(): string
• getEmail(): string
• toArray(): array

🧾 HamroCDN\Models\File

Property	Type	Description
url	string	Public CDN URL
size	int	File size in bytes

Methods

• getUrl(): string
• getSize(): int
• toArray(): array

⚡ Error Handling

All SDK errors extend HamroCDN\Exceptions\HamroCDNException.

Example:

use HamroCDN\Exceptions\HamroCDNException;

try {
    $cdn->upload('/invalid/path.jpg');
} catch (HamroCDNException $e) {
    echo 'Upload failed: ' . $e->getMessage();
}

The SDK automatically wraps:

• Network issues (GuzzleException)
• Invalid JSON responses
• Missing API key or misconfiguration

🧪 Testing

This SDK is built with Pest and supports real API integration tests.
A dedicated testing environment is configured within the HamroCDN infrastructure, ensuring safe, production-like validations.

Run tests locally:

composer test

🪄 Framework Integrations

This SDK is framework-agnostic. If you’re using Laravel, check out the companion package:

👉 hamrocdn/laravel

It provides service providers, configuration publishing, and automatic Facade binding.

🧩 Type Safety / Static Analysis

• Fully typed with PHPStan annotations
• 100% PHP 8.0+ compatible
• Pint with laravel preset for code style
• Rector for automated refactoring
• SonarCloud integration for code quality

📄 License

This package is open-sourced software licensed under the MIT license.

🤝 Contributing

Contributions are welcome! Please create a pull request or open an issue if you find any bugs or have feature requests.

⭐ Support

If you find this package useful, please consider starring the repository on GitHub to show your support.