first release

Author: hellobertrand

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "composer"
+    directory: "/"
+    schedule:
+      interval: "monthly"

.github/workflows/publish.yml

@@ -0,0 +1,21 @@
+name: Publish Package
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.1'
+      - run: composer install --no-dev --prefer-dist
+      
+      - uses: packagist/action@v1
+        with:
+          package_name: screenshotmax/sdk
+          api_token: ${{ secrets.PACKAGIST_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,19 @@
+name: Tests
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  php:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.1'
+          tools: phpunit
+      - run: composer install --no-interaction --working-dir=.
+      - run: phpunit -c phpunit.xml

README.md

@@ -1,2 +1,102 @@
-# php-sdk
-Official PHP SDK for the ScreenshotMAX.com API
+# ScreenshotMAX PHP SDK
+
+[![test](https://github.com/screenshotmax/php-sdk/actions/workflows/test.yml/badge.svg)](https://github.com/screenshotmax/php-sdk/actions/workflows/test.yml)
+
+This is the official PHP SDK for the [ScreenshotMAX API](https://screenshotmax.com/).
+
+It allows you to easily capture high-quality screenshots of any URL directly from your applications.
+The SDK handles authentication, request signing, and provides a simple interface to integrate ScreenshotMAX’s powerful screenshot services into your Python projects.
+
+Get started in minutes. Just [sign up](https://screenshotmax.com) to receive your access and secret keys, import the client, and you’re ready to capture screenshots.”
+
+The SDK client is synchronized with the latest [ScreenshotMAX API options](https://docs.screenshotmax.com/guides/start/introduction).
+
+## Installation
+```bash
+composer require screenshotmax/sdk
+```
+
+## Usage
+
+Use the SDK to generate signed or unsigned URLs for screenshots, PDFs, web scraping, or animated screenshot—without executing the request. Or fetch and download the result directly. You have full control over when and how each capture runs.
+
+### Screenshot example
+```php
+use ScreenshotMax\SDK;
+use ScreenshotMax\Options\ScreenshotOptions;
+
+$sdk = new SDK('<ACCESS_KEY>', '<SECRET_KEY>');
+
+$opts = new ScreenshotOptions();
+$opts->url = 'https://example.com';
+$opts->format = 'png';
+
+$sdk->screenshot->setOptions($opts);
+
+$url = $sdk->screenshot->getUrl();
+$result = $sdk->screenshot->fetch();
+file_put_contents('screenshot.png', $result['data']);
+```
+
+### Web scraping example
+```php
+use ScreenshotMax\SDK;
+use ScreenshotMax\Options\ScrapeOptions;
+
+$sdk = new SDK('<ACCESS_KEY>', '<SECRET_KEY>');
+
+$opts = new ScrapeOptions();
+$opts->url = 'https://example.com';
+$opts->format = 'html';
+
+$sdk->scrape->setOptions($opts);
+
+$url = $sdk->scrape->getUrl();
+$result = $sdk->scrape->fetch();
+file_put_contents('scrape.html', $result['data']);
+```
+
+### PDF generation example
+```php
+use ScreenshotMax\SDK;
+use ScreenshotMax\Options\PDFOptions;
+
+$sdk = new SDK('<ACCESS_KEY>', '<SECRET_KEY>');
+
+$opts = new PDFOptions();
+$opts->url = 'https://example.com';
+$opts->pdf_paper_format = 'a4';
+
+$sdk->pdf->setOptions($opts);
+
+$url = $sdk->pdf->getUrl();
+$result = $sdk->pdf->fetch();
+file_put_contents('pdf.pdf', $result['data']);
+```
+
+### Scheduled task example
+```php
+use ScreenshotMax\SDK;
+
+$sdk = new SDK('<ACCESS_KEY>', '<SECRET_KEY>');
+
+# get all tasks from account
+$tasks = $sdk->task->get_tasks()
+# {"tasks":[{
+# "id":5678133109850112,
+# "name":"Test CRON",
+# "api":"screenshot",
+# "query":
+# "url=https%3A%2F%2Fexample.com",
+# "frequency":"every_day",
+# "crontab":"25 13 * * *",
+# "timezone":"Etc/UTC",
+# "enabled":true,
+# "created":1747229104,
+# "last_run":1748611516,
+# "runs":18}]}
+```
+
+## License
+
+`screenshotmax/sdk` is released under [the MIT license](LICENSE).

composer.json

@@ -0,0 +1,13 @@
+{
+  "name": "screenshotmax/sdk",
+  "description": "Official PHP SDK for the ScreenshotMAX API",
+  "type": "library",
+  "require": {
+    "php": ">=8.0"
+  },
+  "autoload": {
+    "psr-4": {
+      "ScreenshotMax\\": "src/"
+    }
+  }
+}

phpunit.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit colors="true" bootstrap="vendor/autoload.php">
+  <testsuites>
+    <testsuite name="SDK Tests">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+</phpunit>

src/ApiClient.php

@@ -0,0 +1,116 @@
+<?php
+namespace ScreenshotMax;
+
+class ApiClient
+{
+    private string $baseUrl = 'https://api.screenshotmax.com';
+    private string $accessKey;
+    private string $secretKey;
+
+    public function __construct(string $accessKey, string $secretKey)
+    {
+        if (empty($accessKey) || empty($secretKey)) {
+            throw new \InvalidArgumentException('Access and secret keys must both be provided and non-empty.');
+        }
+        $this->accessKey = $accessKey;
+        $this->secretKey = $secretKey;
+    }
+
+    private function signRequest(string $str): string
+    {
+        return hash_hmac('sha256', $str, $this->secretKey);
+    }
+
+    private function computeQuery(array $obj): string
+    {
+        $filtered = array_filter($obj, fn($v) => $v !== null);
+        return http_build_query($filtered);
+    }
+
+    public function generateUrl(string $path, array $params = []): string
+    {
+        $query = $this->computeQuery(array_merge($params, ['access_key' => $this->accessKey]));
+        return $this->baseUrl . $path . '?' . $query;
+    }
+
+    public function generateSignedUrl(string $path, array $params = []): string
+    {
+        $query = $this->computeQuery(array_merge($params, ['access_key' => $this->accessKey]));
+        $signature = $this->signRequest($query);
+        return $this->baseUrl . $path . '?' . $query . '&signature=' . $signature;
+    }
+
+    private function exec(string $method, string $url, array $options = [], array $headers = []): array
+    {
+        $ch = curl_init($url);
+        curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
+        curl_setopt($ch, CURLOPT_HEADER, true);
+
+        if ($method === 'POST') {
+            curl_setopt($ch, CURLOPT_POST, true);
+            curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($options));
+        } elseif ($method === 'PATCH' || $method === 'DELETE') {
+            curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
+            if ($method === 'PATCH') {
+                curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($options));
+            }
+        }
+
+        if ($headers) {
+            curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
+        }
+
+        $response = curl_exec($ch);
+        if ($response === false) {
+            $err = curl_error($ch);
+            curl_close($ch);
+            throw new \RuntimeException($err);
+        }
+
+        $headerSize = curl_getinfo($ch, CURLINFO_HEADER_SIZE);
+        $headerString = substr($response, 0, $headerSize);
+        $body = substr($response, $headerSize);
+        $parsedHeaders = [];
+        foreach (explode("\r\n", trim($headerString)) as $line) {
+            if (strpos($line, ':') !== false) {
+                [$k, $v] = explode(':', $line, 2);
+                $parsedHeaders[trim($k)] = trim($v);
+            }
+        }
+        curl_close($ch);
+
+        return ['data' => $body, 'headers' => $parsedHeaders];
+    }
+
+    public function get(string $path, array $options = [], bool $signed = false): array
+    {
+        $url = $signed ? $this->generateSignedUrl($path, $options) : $this->generateUrl($path, $options);
+        return $this->exec('GET', $url);
+    }
+
+    public function post(string $path, array $options = []): array
+    {
+        $url = $this->baseUrl . $path;
+        return $this->exec('POST', $url, $options, [
+            'Content-Type: application/json',
+            'X-Access-Key: ' . $this->accessKey,
+        ]);
+    }
+
+    public function delete(string $path): void
+    {
+        $url = $this->baseUrl . $path;
+        $this->exec('DELETE', $url, [], [
+            'X-Access-Key: ' . $this->accessKey,
+        ]);
+    }
+
+    public function patch(string $path, array $options = []): array
+    {
+        $url = $this->baseUrl . $path;
+        return $this->exec('PATCH', $url, $options, [
+            'Content-Type: application/json',
+            'X-Access-Key: ' . $this->accessKey,
+        ]);
+    }
+}

src/Options/PDFOptions.php

@@ -0,0 +1,9 @@
+<?php
+namespace ScreenshotMax\Options;
+
+class PDFOptions extends ScreenshotOptions
+{
+    public ?string $pdf_paper_format = null;
+    public ?bool $pdf_landscape = null;
+    public ?bool $pdf_print_background = null;
+}

src/Options/ScrapeOptions.php

@@ -0,0 +1,6 @@
+<?php
+namespace ScreenshotMax\Options;
+
+class ScrapeOptions extends ScreenshotOptions
+{
+}

src/Options/ScreencastOptions.php

@@ -0,0 +1,14 @@
+<?php
+namespace ScreenshotMax\Options;
+
+class ScreencastOptions extends ScreenshotOptions
+{
+    public ?int $duration = null;
+    public ?string $scenario = null;
+    public ?int $scroll_by_amount = null;
+    public ?int $scroll_by_delay = null;
+    public ?int $scroll_by_duration = null;
+    public ?bool $scroll_back = null;
+    public ?int $scroll_back_delay = null;
+    public ?string $scroll_easing = null;
+}