16 Commits

Author SHA1 Message Date
Jonathan Martz
b0a0cf6f1f continue on collection create logic 2025-01-27 20:09:15 +01:00
Jonathan Martz
d90cda9613 remove php docs from collection, add methods for token url collection 2025-01-26 22:50:10 +01:00
Jonathan Martz
0d7255d77e start with create collection item test 2025-01-26 22:46:57 +01:00
Jonathan Martz
40db76d3ed refactoring code, add doRequest via httpClient 2025-01-26 21:54:56 +01:00
Jonathan Martz
f9911ffc29 refactoring collection a little bit, adjust token from collection manual,write some test for the simple logic, fixing superusers authAdmin 2025-01-21 23:52:11 +01:00
Jonathan Martz
28df3f28e7 Merge pull request #2 from antharuu/master
allow to manually define the auth token for client and settings
2025-01-21 22:18:40 +01:00
Anthony Bellancourt
9b1ded7968 allow to manually define the auth token for client and settings 2025-01-21 17:21:53 +01:00
Jonathan Martz
7c2253c896 fix mailer go 2025-01-12 19:22:11 +01:00
Jonathan Martz
d92bff0357 add message id 2025-01-12 19:18:52 +01:00
Jonathan Martz
75354764d8 add failimng test 2025-01-12 19:05:51 +01:00
Jonathan Martz
59a4edd7a5 send mail when failed is bigger then 0 2025-01-12 19:03:44 +01:00
Jonathan Martz
f3f4e84688 workflow one time per day 2025-01-12 18:55:44 +01:00
Jonathan Martz
e2f2ee4be0 update README.md 2025-01-12 13:09:15 +01:00
Jonathan Martz
d733fda627 add tests for simple user and users with filter by name 2025-01-12 13:06:21 +01:00
Jonathan Martz
cbd0438d22 remove output debug 2025-01-12 12:33:13 +01:00
Jonathan Martz
9625de8b52 change date format 2025-01-12 12:32:43 +01:00
21 changed files with 1100 additions and 143 deletions

View File

@@ -6,7 +6,7 @@ on:
pull_request:
branches: [master]
schedule:
- cron: '0 * * * *'
- cron: '0 17 * * *'
jobs:
run-mailer:

View File

@@ -4,6 +4,12 @@
##### This Repository are in active Development
***
***
### Gitlab is the one for Packagist, but they should both be up to Date.
##### Github: https://github.com/jonathan-martz/pocketbase-php-sdk/
##### Gitlab: https://gitlab.jonathan-martz.de/softwareentwicklung/pocketbase-php-sdk
***
``` bash
composer require jonathan-martz/pocketbase-php-sdk
```
@@ -11,8 +17,8 @@ composer require jonathan-martz/pocketbase-php-sdk
``` php
// Example init and use
use \Pb\Client as pb;
$pb = new pb('https://backend-shop.mkay.dev');
var_dump($pb->collection('countries')->getList());
$pb = new pb('https://admin.pocketbase.dev');
var_dump($pb->collection('users')->getList());
```
***

View File

@@ -12,11 +12,16 @@
"src/Client.php",
"src/Settings.php",
"src/Collection.php"
]
],
"psr-4": {
"Pb\\": "src/",
"Pb\\Exception\\": "src/exception"
}
},
"require": {
"php": "^8.1|^8.2",
"ext-curl": "*"
"ext-curl": "*",
"guzzlehttp/guzzle": "^7.9"
},
"require-dev": {
"phpunit/phpunit": "^11.5",

601
composer.lock generated
View File

@@ -4,8 +4,605 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically"
],
"content-hash": "e3ef1b1407a46f944e79ec18eb6f6a9b",
"packages": [],
"content-hash": "31d1044e8ec00497f8c8aba87b9118b1",
"packages": [
{
"name": "guzzlehttp/guzzle",
"version": "7.9.2",
"source": {
"type": "git",
"url": "https://github.com/guzzle/guzzle.git",
"reference": "d281ed313b989f213357e3be1a179f02196ac99b"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/guzzle/guzzle/zipball/d281ed313b989f213357e3be1a179f02196ac99b",
"reference": "d281ed313b989f213357e3be1a179f02196ac99b",
"shasum": ""
},
"require": {
"ext-json": "*",
"guzzlehttp/promises": "^1.5.3 || ^2.0.3",
"guzzlehttp/psr7": "^2.7.0",
"php": "^7.2.5 || ^8.0",
"psr/http-client": "^1.0",
"symfony/deprecation-contracts": "^2.2 || ^3.0"
},
"provide": {
"psr/http-client-implementation": "1.0"
},
"require-dev": {
"bamarni/composer-bin-plugin": "^1.8.2",
"ext-curl": "*",
"guzzle/client-integration-tests": "3.0.2",
"php-http/message-factory": "^1.1",
"phpunit/phpunit": "^8.5.39 || ^9.6.20",
"psr/log": "^1.1 || ^2.0 || ^3.0"
},
"suggest": {
"ext-curl": "Required for CURL handler support",
"ext-intl": "Required for Internationalized Domain Name (IDN) support",
"psr/log": "Required for using the Log middleware"
},
"type": "library",
"extra": {
"bamarni-bin": {
"bin-links": true,
"forward-command": false
}
},
"autoload": {
"files": [
"src/functions_include.php"
],
"psr-4": {
"GuzzleHttp\\": "src/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Graham Campbell",
"email": "hello@gjcampbell.co.uk",
"homepage": "https://github.com/GrahamCampbell"
},
{
"name": "Michael Dowling",
"email": "mtdowling@gmail.com",
"homepage": "https://github.com/mtdowling"
},
{
"name": "Jeremy Lindblom",
"email": "jeremeamia@gmail.com",
"homepage": "https://github.com/jeremeamia"
},
{
"name": "George Mponos",
"email": "gmponos@gmail.com",
"homepage": "https://github.com/gmponos"
},
{
"name": "Tobias Nyholm",
"email": "tobias.nyholm@gmail.com",
"homepage": "https://github.com/Nyholm"
},
{
"name": "Márk Sági-Kazár",
"email": "mark.sagikazar@gmail.com",
"homepage": "https://github.com/sagikazarmark"
},
{
"name": "Tobias Schultze",
"email": "webmaster@tubo-world.de",
"homepage": "https://github.com/Tobion"
}
],
"description": "Guzzle is a PHP HTTP client library",
"keywords": [
"client",
"curl",
"framework",
"http",
"http client",
"psr-18",
"psr-7",
"rest",
"web service"
],
"support": {
"issues": "https://github.com/guzzle/guzzle/issues",
"source": "https://github.com/guzzle/guzzle/tree/7.9.2"
},
"funding": [
{
"url": "https://github.com/GrahamCampbell",
"type": "github"
},
{
"url": "https://github.com/Nyholm",
"type": "github"
},
{
"url": "https://tidelift.com/funding/github/packagist/guzzlehttp/guzzle",
"type": "tidelift"
}
],
"time": "2024-07-24T11:22:20+00:00"
},
{
"name": "guzzlehttp/promises",
"version": "2.0.4",
"source": {
"type": "git",
"url": "https://github.com/guzzle/promises.git",
"reference": "f9c436286ab2892c7db7be8c8da4ef61ccf7b455"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/guzzle/promises/zipball/f9c436286ab2892c7db7be8c8da4ef61ccf7b455",
"reference": "f9c436286ab2892c7db7be8c8da4ef61ccf7b455",
"shasum": ""
},
"require": {
"php": "^7.2.5 || ^8.0"
},
"require-dev": {
"bamarni/composer-bin-plugin": "^1.8.2",
"phpunit/phpunit": "^8.5.39 || ^9.6.20"
},
"type": "library",
"extra": {
"bamarni-bin": {
"bin-links": true,
"forward-command": false
}
},
"autoload": {
"psr-4": {
"GuzzleHttp\\Promise\\": "src/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Graham Campbell",
"email": "hello@gjcampbell.co.uk",
"homepage": "https://github.com/GrahamCampbell"
},
{
"name": "Michael Dowling",
"email": "mtdowling@gmail.com",
"homepage": "https://github.com/mtdowling"
},
{
"name": "Tobias Nyholm",
"email": "tobias.nyholm@gmail.com",
"homepage": "https://github.com/Nyholm"
},
{
"name": "Tobias Schultze",
"email": "webmaster@tubo-world.de",
"homepage": "https://github.com/Tobion"
}
],
"description": "Guzzle promises library",
"keywords": [
"promise"
],
"support": {
"issues": "https://github.com/guzzle/promises/issues",
"source": "https://github.com/guzzle/promises/tree/2.0.4"
},
"funding": [
{
"url": "https://github.com/GrahamCampbell",
"type": "github"
},
{
"url": "https://github.com/Nyholm",
"type": "github"
},
{
"url": "https://tidelift.com/funding/github/packagist/guzzlehttp/promises",
"type": "tidelift"
}
],
"time": "2024-10-17T10:06:22+00:00"
},
{
"name": "guzzlehttp/psr7",
"version": "2.7.0",
"source": {
"type": "git",
"url": "https://github.com/guzzle/psr7.git",
"reference": "a70f5c95fb43bc83f07c9c948baa0dc1829bf201"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/guzzle/psr7/zipball/a70f5c95fb43bc83f07c9c948baa0dc1829bf201",
"reference": "a70f5c95fb43bc83f07c9c948baa0dc1829bf201",
"shasum": ""
},
"require": {
"php": "^7.2.5 || ^8.0",
"psr/http-factory": "^1.0",
"psr/http-message": "^1.1 || ^2.0",
"ralouphie/getallheaders": "^3.0"
},
"provide": {
"psr/http-factory-implementation": "1.0",
"psr/http-message-implementation": "1.0"
},
"require-dev": {
"bamarni/composer-bin-plugin": "^1.8.2",
"http-interop/http-factory-tests": "0.9.0",
"phpunit/phpunit": "^8.5.39 || ^9.6.20"
},
"suggest": {
"laminas/laminas-httphandlerrunner": "Emit PSR-7 responses"
},
"type": "library",
"extra": {
"bamarni-bin": {
"bin-links": true,
"forward-command": false
}
},
"autoload": {
"psr-4": {
"GuzzleHttp\\Psr7\\": "src/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Graham Campbell",
"email": "hello@gjcampbell.co.uk",
"homepage": "https://github.com/GrahamCampbell"
},
{
"name": "Michael Dowling",
"email": "mtdowling@gmail.com",
"homepage": "https://github.com/mtdowling"
},
{
"name": "George Mponos",
"email": "gmponos@gmail.com",
"homepage": "https://github.com/gmponos"
},
{
"name": "Tobias Nyholm",
"email": "tobias.nyholm@gmail.com",
"homepage": "https://github.com/Nyholm"
},
{
"name": "Márk Sági-Kazár",
"email": "mark.sagikazar@gmail.com",
"homepage": "https://github.com/sagikazarmark"
},
{
"name": "Tobias Schultze",
"email": "webmaster@tubo-world.de",
"homepage": "https://github.com/Tobion"
},
{
"name": "Márk Sági-Kazár",
"email": "mark.sagikazar@gmail.com",
"homepage": "https://sagikazarmark.hu"
}
],
"description": "PSR-7 message implementation that also provides common utility methods",
"keywords": [
"http",
"message",
"psr-7",
"request",
"response",
"stream",
"uri",
"url"
],
"support": {
"issues": "https://github.com/guzzle/psr7/issues",
"source": "https://github.com/guzzle/psr7/tree/2.7.0"
},
"funding": [
{
"url": "https://github.com/GrahamCampbell",
"type": "github"
},
{
"url": "https://github.com/Nyholm",
"type": "github"
},
{
"url": "https://tidelift.com/funding/github/packagist/guzzlehttp/psr7",
"type": "tidelift"
}
],
"time": "2024-07-18T11:15:46+00:00"
},
{
"name": "psr/http-client",
"version": "1.0.3",
"source": {
"type": "git",
"url": "https://github.com/php-fig/http-client.git",
"reference": "bb5906edc1c324c9a05aa0873d40117941e5fa90"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/php-fig/http-client/zipball/bb5906edc1c324c9a05aa0873d40117941e5fa90",
"reference": "bb5906edc1c324c9a05aa0873d40117941e5fa90",
"shasum": ""
},
"require": {
"php": "^7.0 || ^8.0",
"psr/http-message": "^1.0 || ^2.0"
},
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "1.0.x-dev"
}
},
"autoload": {
"psr-4": {
"Psr\\Http\\Client\\": "src/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "PHP-FIG",
"homepage": "https://www.php-fig.org/"
}
],
"description": "Common interface for HTTP clients",
"homepage": "https://github.com/php-fig/http-client",
"keywords": [
"http",
"http-client",
"psr",
"psr-18"
],
"support": {
"source": "https://github.com/php-fig/http-client"
},
"time": "2023-09-23T14:17:50+00:00"
},
{
"name": "psr/http-factory",
"version": "1.1.0",
"source": {
"type": "git",
"url": "https://github.com/php-fig/http-factory.git",
"reference": "2b4765fddfe3b508ac62f829e852b1501d3f6e8a"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/php-fig/http-factory/zipball/2b4765fddfe3b508ac62f829e852b1501d3f6e8a",
"reference": "2b4765fddfe3b508ac62f829e852b1501d3f6e8a",
"shasum": ""
},
"require": {
"php": ">=7.1",
"psr/http-message": "^1.0 || ^2.0"
},
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "1.0.x-dev"
}
},
"autoload": {
"psr-4": {
"Psr\\Http\\Message\\": "src/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "PHP-FIG",
"homepage": "https://www.php-fig.org/"
}
],
"description": "PSR-17: Common interfaces for PSR-7 HTTP message factories",
"keywords": [
"factory",
"http",
"message",
"psr",
"psr-17",
"psr-7",
"request",
"response"
],
"support": {
"source": "https://github.com/php-fig/http-factory"
},
"time": "2024-04-15T12:06:14+00:00"
},
{
"name": "psr/http-message",
"version": "2.0",
"source": {
"type": "git",
"url": "https://github.com/php-fig/http-message.git",
"reference": "402d35bcb92c70c026d1a6a9883f06b2ead23d71"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/php-fig/http-message/zipball/402d35bcb92c70c026d1a6a9883f06b2ead23d71",
"reference": "402d35bcb92c70c026d1a6a9883f06b2ead23d71",
"shasum": ""
},
"require": {
"php": "^7.2 || ^8.0"
},
"type": "library",
"extra": {
"branch-alias": {
"dev-master": "2.0.x-dev"
}
},
"autoload": {
"psr-4": {
"Psr\\Http\\Message\\": "src/"
}
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "PHP-FIG",
"homepage": "https://www.php-fig.org/"
}
],
"description": "Common interface for HTTP messages",
"homepage": "https://github.com/php-fig/http-message",
"keywords": [
"http",
"http-message",
"psr",
"psr-7",
"request",
"response"
],
"support": {
"source": "https://github.com/php-fig/http-message/tree/2.0"
},
"time": "2023-04-04T09:54:51+00:00"
},
{
"name": "ralouphie/getallheaders",
"version": "3.0.3",
"source": {
"type": "git",
"url": "https://github.com/ralouphie/getallheaders.git",
"reference": "120b605dfeb996808c31b6477290a714d356e822"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/ralouphie/getallheaders/zipball/120b605dfeb996808c31b6477290a714d356e822",
"reference": "120b605dfeb996808c31b6477290a714d356e822",
"shasum": ""
},
"require": {
"php": ">=5.6"
},
"require-dev": {
"php-coveralls/php-coveralls": "^2.1",
"phpunit/phpunit": "^5 || ^6.5"
},
"type": "library",
"autoload": {
"files": [
"src/getallheaders.php"
]
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Ralph Khattar",
"email": "ralph.khattar@gmail.com"
}
],
"description": "A polyfill for getallheaders.",
"support": {
"issues": "https://github.com/ralouphie/getallheaders/issues",
"source": "https://github.com/ralouphie/getallheaders/tree/develop"
},
"time": "2019-03-08T08:55:37+00:00"
},
{
"name": "symfony/deprecation-contracts",
"version": "v3.5.1",
"source": {
"type": "git",
"url": "https://github.com/symfony/deprecation-contracts.git",
"reference": "74c71c939a79f7d5bf3c1ce9f5ea37ba0114c6f6"
},
"dist": {
"type": "zip",
"url": "https://api.github.com/repos/symfony/deprecation-contracts/zipball/74c71c939a79f7d5bf3c1ce9f5ea37ba0114c6f6",
"reference": "74c71c939a79f7d5bf3c1ce9f5ea37ba0114c6f6",
"shasum": ""
},
"require": {
"php": ">=8.1"
},
"type": "library",
"extra": {
"thanks": {
"url": "https://github.com/symfony/contracts",
"name": "symfony/contracts"
},
"branch-alias": {
"dev-main": "3.5-dev"
}
},
"autoload": {
"files": [
"function.php"
]
},
"notification-url": "https://packagist.org/downloads/",
"license": [
"MIT"
],
"authors": [
{
"name": "Nicolas Grekas",
"email": "p@tchwork.com"
},
{
"name": "Symfony Community",
"homepage": "https://symfony.com/contributors"
}
],
"description": "A generic function and convention to trigger deprecation notices",
"homepage": "https://symfony.com",
"support": {
"source": "https://github.com/symfony/deprecation-contracts/tree/v3.5.1"
},
"funding": [
{
"url": "https://symfony.com/sponsor",
"type": "custom"
},
{
"url": "https://github.com/fabpot",
"type": "github"
},
{
"url": "https://tidelift.com/funding/github/packagist/symfony/symfony",
"type": "tidelift"
}
],
"time": "2024-09-25T14:20:29+00:00"
}
],
"packages-dev": [
{
"name": "myclabs/deep-copy",

View File

@@ -34,7 +34,7 @@ func main() {
}
// Format the date as YYYY-MM-DD
currentDate := now.Format("01-02-2006")
currentDate := now.Format("01.02.2006")
recipient := "support@jonathan-martz.de"
subject := "PHPUnit - PocketBase PHP SDK - " + currentDate
@@ -56,8 +56,6 @@ func main() {
log.Fatal("PHPUnit output is empty. Please check your configuration.")
}
fmt.Println(output.String())
// Parse the JSON output
var result map[string]interface{}
if err := json.Unmarshal(output.Bytes(), &result); err != nil {
@@ -70,27 +68,37 @@ fmt.Println(output.String())
log.Fatal("Counts field not found in PHPUnit output.")
}
// Serialize the counts field to JSON for the email body
countsJSON, err := json.MarshalIndent(counts, "", " ")
if err != nil {
log.Fatalf("Failed to serialize counts to JSON: %v", err)
// Check if 'fails' is greater than 0
failed, ok := counts["failed"].(float64)
if !ok {
log.Fatal("'fails' field not found in counts.")
}
// Prepare the email body
emailBody := fmt.Sprintf("Subject: %s\r\n\r\n%s", subject, string(countsJSON))
if failed > 0 {
// Serialize the counts field to JSON for the email body
countsJSON, err := json.MarshalIndent(counts, "", " ")
if err != nil {
log.Fatalf("Failed to serialize counts to JSON: %v", err)
}
// Connect to the SMTP server
auth := smtp.PlainAuth("", *smtpUser, *smtpPass, smtpHost)
err = smtp.SendMail(
smtpHost+":"+smtpPort,
auth,
*sender,
[]string{recipient},
[]byte(emailBody),
)
if err != nil {
log.Fatalf("Failed to send email: %v", err)
// Prepare the email body
emailBody := fmt.Sprintf("Subject: %s\r\n\r\n%s", subject, string(countsJSON))
// Connect to the SMTP server
auth := smtp.PlainAuth("", *smtpUser, *smtpPass, smtpHost)
err = smtp.SendMail(
smtpHost+":"+smtpPort,
auth,
*sender,
[]string{recipient},
[]byte(emailBody),
)
if err != nil {
log.Fatalf("Failed to send email: %v", err)
}
log.Println("Test results sent to", recipient)
} else {
log.Println("No failures detected. No email sent.")
}
log.Println("Test results sent to", recipient)
}

View File

@@ -5,6 +5,7 @@ namespace Pb;
class Client
{
private string $url;
public string $token = '';
public function __construct(string $url)
{
@@ -13,11 +14,21 @@ class Client
public function collection(string $collection): Collection
{
return new Collection($this->url ,$collection);
return new Collection($this->url ,$collection, $this->token);
}
public function settings(): Settings
{
return new Settings($this->url);
return new Settings($this->url, $this->token);
}
public function setAuthToken(string $token): void
{
$this->token = $token;
}
public function getAuthToken(): string
{
return $this->token;
}
}

View File

@@ -2,6 +2,8 @@
namespace Pb;
use GuzzleHttp\Exception\GuzzleException;
/**
*
*/
@@ -25,19 +27,20 @@ class Collection
/**
* @param string $url
* @param string $collection
* @param string $token
*/
public function __construct(string $url, string $collection)
public function __construct(string $url,
string $collection,
string $token = ''
)
{
$this->url = $url;
$this->collection = $collection;
if (!empty($token)) {
self::$token = $token;
}
}
/**
* @param int $start
* @param int $end
* @param array $queryParams
* @return array
*/
public function getList(int $start = 1, int $end = 50, array $queryParams = []): array
{
$queryParams['perPage'] = $end;
@@ -47,15 +50,9 @@ class Collection
return json_decode($response, JSON_FORCE_OBJECT);
}
/**
* @param string $recordId
* @param string $field
* @param string $filepath
* @return void
*/
public function upload(string $recordId, string $field, string $filepath): void
{
$ch = curl_init($this->url . "/api/collections/".$this->collection."/records/" . $recordId);
$ch = curl_init($this->url . "/api/collections/" . $this->collection . "/records/" . $recordId);
curl_setopt_array($ch, array(
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_POSTFIELDS => array(
@@ -72,130 +69,128 @@ class Collection
$response = curl_exec($ch);
}
/**
* @param string $email
* @param string $password
* @return void
*/
public function authAsUser(string $email, string $password)
public function authAsUser(string $email, string $password): array
{
$result = $this->doRequest($this->url . "/api/collections/users/auth-with-password", 'POST', ['identity' => $email, 'password' => $password]);
$result = json_decode($result, JSON_FORCE_OBJECT);
if (!empty($result['token'])) {
self::$token = $result['token'];
}
return $result;
}
/**
* @param int $batch
* @param array $queryParams
* @return array
*/
public function getFullList(array $queryParams, int $batch = 200): array
{
$queryParams = [... $queryParams, 'perPage'=> $batch];
$queryParams = [... $queryParams, 'perPage' => $batch];
$getParams = !empty($queryParams) ? http_build_query($queryParams) : "";
$response = $this->doRequest($this->url . "/api/collections/" . $this->collection . "/records?" . $getParams, 'GET');
return json_decode($response, JSON_FORCE_OBJECT);
}
/**
* @param string $filter
* @param array $queryParams
* @return array
*/
public function getFirstListItem(string $filter, array $queryParams = []): array
{
// TODO filter
$queryParams['perPage'] = 1;
$queryParams['filter'] = $filter;
$getParams = !empty($queryParams) ? http_build_query($queryParams) : "";
$response = $this->doRequest($this->url . "/api/collections/" . $this->collection . "/records?" . $getParams, 'GET');
return json_decode($response, JSON_FORCE_OBJECT)['items'][0];
$data = json_decode($response, JSON_FORCE_OBJECT);
if (empty($data['items']) || count($data['items']) < 1) {
throw new exception\FirstListItemNotFoundException('First doesnt exists');
}
return $data['items'][0] ?? [];
}
/**
* @param array $bodyParams
* @param array $queryParams
* @return void
*/
public function create(array $bodyParams = [], array $queryParams = []): string
{
return $this->doRequest($this->url . "/api/collections/" . $this->collection . "/records", 'POST', json_encode($bodyParams));
// TODO query params ?
return $this->doRequest($this->url . "/api/collections/" . $this->collection . "/records", 'POST', $bodyParams);
}
/**
* @param string $recordId
* @param array $bodyParams
* @param array $queryParams
* @return void
*/
public function update(string $recordId, array $bodyParams = [], array $queryParams = []): void
{
// Todo bodyParams equals json, currently workaround
$this->doRequest($this->url . "/api/collections/" . $this->collection . "/records/" . $recordId, 'PATCH', json_encode($bodyParams));
$this->doRequest($this->url . "/api/collections/" . $this->collection . "/records/" . $recordId, 'PATCH', $bodyParams);
}
/**
* @param string $recordId
* @param array $queryParams
* @return void
*/
public function delete(string $recordId, array $queryParams = []): void
{
// TODO params ?
$this->doRequest($this->url . "/api/collections/" . $this->collection . "/records/" . $recordId, 'DELETE');
}
/**
* @param string $recordId
* @param string $url
* @param string $method
* @return bool|string
* @throws GuzzleException
*/
public function doRequest(string $url, string $method, $bodyParams = []): string
{
$ch = curl_init();
$tmp = $bodyParams;
$bodyParams = [];
$bodyParams['json'] = $tmp;
$bodyParams['headers']['Content-Type'] = 'application/json';
if (self::$token != '') {
$headers = array(
'Content-Type:application/json',
'Authorization: ' . self::$token
);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
$bodyParams['headers']['Authorization'] = 'Bearer ' . self::$token;
}
if ($bodyParams) {
curl_setopt($ch, CURLOPT_POSTFIELDS, $bodyParams);
}
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
$output = curl_exec($ch);
curl_close($ch);
return $output;
$client = new \GuzzleHttp\Client();
$response = $client->request($method, $url, $bodyParams);
return $response->getBody()->getContents() ?? '';
}
/**
* @param string $recordId
* @param array $queryParams
* @return mixed
*/
public function getOne(string $recordId, array $queryParams = []): array
{
// TODO params ?
$output = $this->doRequest($this->url . "/api/collections/" . $this->collection . "/records/" . $recordId, 'GET');
return json_decode($output, JSON_FORCE_OBJECT);
}
/**
* @param string $email
* @param string $password
* @return void
*/
public function authAsAdmin(string $email, string $password): void
public function authAsAdmin(string $email, string $password): string
{
$bodyParams['identity'] = $email;
$bodyParams['password'] = $password;
$output = $this->doRequest($this->url . "/api/admins/auth-with-password", 'POST', $bodyParams);
self::$token = json_decode($output, true)['token'];
$output = $this->doRequest($this->url . "/api/collections/_superusers/auth-with-password", 'POST', $bodyParams);
$token = json_decode($output, true)['token'];
if ($token) {
self::$token = $token;
}
return $output;
}
public static function getAuthToken(): string
{
return self::$token;
}
public static function setAuthToken(string $token): void
{
self::$token = $token;
}
public function getUrl(): string
{
return $this->url;
}
public function setUrl(string $url): Collection
{
$this->url = $url;
return $this;
}
public function getCollection(): string
{
return $this->collection;
}
public function setCollection(string $collection): Collection
{
$this->collection = $collection;
return $this;
}
}

View File

@@ -19,27 +19,22 @@ class Settings
/**
* @param string $url
* @param string $collection
* @param string $token
*/
public function __construct(string $url)
public function __construct(string $url, string $token = '')
{
$this->url = $url;
self::$token = $token;
}
public function authAsAdmin(string $email, string $password): void
{
$bodyParams['identity'] = $email;
$bodyParams['password'] = $password;
$output = $this->doRequest($this->url . "/api/admins/auth-with-password", 'POST', $bodyParams);
$output = $this->doRequest($this->url . "/api/collections/_superusers/auth-with-password", 'POST', $bodyParams);
self::$token = json_decode($output, true)['token'];
}
/**
* @param string $recordId
* @param string $url
* @param string $method
* @return bool|string
*/
public function doRequest(string $url, string $method, $bodyParams = []): string
{
$ch = curl_init();
@@ -65,9 +60,6 @@ class Settings
return $output;
}
/**
* @return void
*/
public function getAll():array
{
return json_decode($this->doRequest($this->url . '/api/settings', 'GET', []), true);

8
src/SuperUser.php Normal file
View File

@@ -0,0 +1,8 @@
<?php
namespace Pb;
class SuperUser
{
}

18
src/User.php Normal file
View File

@@ -0,0 +1,18 @@
<?php
namespace Pb;
use DateTime;
class User
{
public string $avatar;
public string $collectionName;
public string $collectionId;
public bool $emailVisibility;
public DateTime $created;
public string $id;
public string $name;
public DateTime $updated;
public bool $verified;
}

View File

@@ -0,0 +1,14 @@
<?php
namespace Pb\Exception;
class FirstListItemNotFoundException extends \Exception
{
/**
* @param string $string
*/
public function __construct(string $string)
{
}
}

View File

@@ -0,0 +1,14 @@
<?php
namespace Pb\viewModels;
use DateTime;
class CollectionItem
{
public string $collectionName;
public string $collectionId;
public DateTime $created;
public string $id;
public DateTime $updated;
}

View File

@@ -0,0 +1,12 @@
<?php
namespace Pb\viewModels;
class CollectionResponse
{
public array $items;
public int $page;
public int $perPage;
public int $totalItems;
public int $totalPages;
}

38
tests/AuthTest.php Normal file
View File

@@ -0,0 +1,38 @@
<?php
use GuzzleHttp\Exception\ClientException;
use Pb\Collection;
use PHPUnit\Framework\TestCase;
final class AuthTest extends TestCase
{
private Collection $collection;
private ?string $url;
protected function setUp(): void
{
$this->url = getenv('POCKETBASE_URL') ?: 'https://admin.pocketbase.dev';
$this->collection = new Collection($this->url, 'users');
}
public function testAuthUser(): void
{
$this->expectException(ClientException::class);
$this->collection->authAsUser('support@jonathan-martz.de', 'rockt');
}
public function testAuthSuperUser(): void
{
$this->collection = new Collection($this->url, '_superusers');
$this->expectException(ClientException::class);
$this->collection->authAsAdmin('admin@jonathan-martz.de', 'rockt');
}
public function testAuthSuperUser2(): void
{
$this->collection = new Collection($this->url, '_superusers');
$this->expectException(ClientException::class);
$this->collection->authAsAdmin('admin@jmartz.de', 'rockt123?!');
}
}

48
tests/ClientTest.php Normal file
View File

@@ -0,0 +1,48 @@
<?php
use Pb\Client;
use Pb\Collection;
use Pb\Settings;
use PHPUnit\Framework\TestCase;
final class ClientTest extends TestCase
{
private Collection $collection;
private ?string $url;
protected function setUp(): void
{
$this->url = getenv('POCKETBASE_URL') ?: 'https://admin.pocketbase.dev';
$this->collection = new Collection($this->url, 'users');
}
public function test_collection(): void
{
$pb = new Client($this->url);
$actual = $pb->collection('users');
$this->assertEquals($actual, $this->collection);
}
public function test_settings(): void
{
$pb = new Client($this->url);
$actual = $pb->settings();
$this->assertEquals($actual, new Settings($this->url));
}
public function test_setToken(){
$token = 'test123';
$pb = new Client($this->url);
$pb->setAuthToken($token);
$this->assertEquals($token, $pb->getAuthToken());
$this->assertEquals($token, $pb->token);
$pb->token = 'test456';
$this->assertEquals('test456', $pb->getAuthToken());
}
}

View File

@@ -0,0 +1,35 @@
<?php
use GuzzleHttp\Exception\ClientException;
use Pb\Collection;
use PHPUnit\Framework\TestCase;
class CollectionCreateTest extends TestCase
{
private string $url;
private Collection $collection;
protected function setUp(): void
{
$this->url = getenv('POCKETBASE_URL') ?: 'https://admin.pocketbase.dev';
$this->collection = new Collection($this->url, 'users');
}
public function testCreateCollectionItem(){
$this->expectException(ClientException::class);
$this->expectExceptionCode(403);
$this->collection->create(['name' => 'Hallo Welt']);
}
public function testCreateCollectionItemAuthed(){
$this->collection->authAsUser('admin@jmartz.de', 'rockt123?!');#
self::assertNotEmpty($this->collection->getAuthToken());
}
public function testCreateCollectionItemAuthedAdmin(){
$this->collection->authAsAdmin('admin@jonathan-martz.de', 'rockt123?!');
$response = $this->collection->create(['email' => 'test@jonathan-martz.de','password' => 'rockt123?!','passwordConfirm' => 'rockt123?!']);
var_dump($response);
self::assertNotEmpty($this->collection->getAuthToken());
}
}

View File

@@ -0,0 +1,35 @@
<?php
use Pb\Collection;
use Pb\Exception\FirstListItemNotFoundException;
use PHPUnit\Framework\TestCase;
final class CollectionGetFirstListItemTest extends TestCase
{
private Collection $collection;
protected function setUp(): void
{
$url = getenv('POCKETBASE_URL') ?: 'https://admin.pocketbase.dev';
$this->collection = new Collection($url, 'users');
}
/**
* @throws FirstListItemNotFoundException
*/
public function test_getOne(): void
{
$id = '6588yk36406qqv1';
$actual = $this->collection->getFirstListItem('id="'.$id.'"');
$this->assertEquals($id, $actual['id']);
$this->assertCount(9, $actual);
}
public function test_getOneWrongId(): void
{
$id = '6588yk36406qqvb';
$this->expectException(FirstListItemNotFoundException::class);
$this->collection->getFirstListItem('id="'.$id.'"');
}
}

View File

@@ -0,0 +1,28 @@
<?php
use Pb\Collection;
use PHPUnit\Framework\TestCase;
final class CollectionGetFullListTest extends TestCase
{
private string $url;
private Collection $collection;
protected function setUp(): void
{
$this->url = getenv('POCKETBASE_URL') ?: 'https://admin.pocketbase.dev';
$this->collection = new Collection($this->url, 'users');
}
public function test_getFullList_gettingArrayWithOneUser(): void
{
$actual = $this->collection->getFullList([],100);
$this->assertArrayHasKey('items', $actual, 'Key "items" does not exist in the response.');
$this->assertArrayHasKey('page', $actual, 'Key "page" does not exist in the response.');
$this->assertArrayHasKey('perPage', $actual, 'Key "perPage" does not exist in the response.');
$this->assertArrayHasKey('totalItems', $actual, 'Key "totalItems" does not exist in the response.');
$this->assertArrayHasKey('totalPages', $actual, 'Key "totalPages" does not exist in the response.');
$this->assertCount(1, $actual['items'], 'Expected no items in the response.');
}
}

View File

@@ -0,0 +1,76 @@
<?php declare(strict_types=1);
use Pb\Collection;
use PHPUnit\Framework\TestCase;
final class CollectionGetListTest extends TestCase
{
private string $url;
private Collection $collection;
protected function setUp(): void
{
$this->url = getenv('POCKETBASE_URL') ?: 'https://admin.pocketbase.dev';
$this->collection = new Collection($this->url, 'users');
}
public function test_getList_gettingArrayWithOneItem(): void
{
$actual = $this->collection->getList(1, 10);
$this->assertArrayHasKey('items', $actual, 'Key "items" does not exist in the response.');
$this->assertArrayHasKey('page', $actual, 'Key "page" does not exist in the response.');
$this->assertArrayHasKey('perPage', $actual, 'Key "perPage" does not exist in the response.');
$this->assertArrayHasKey('totalItems', $actual, 'Key "totalItems" does not exist in the response.');
$this->assertArrayHasKey('totalPages', $actual, 'Key "totalPages" does not exist in the response.');
$this->assertCount(1, $actual['items'], 'Expected no items in the response.');
}
public function test_getListWithContainsMartz(): void
{
$actual = $this->collection->getList(1, 10, ['filter'=>'name~"%Martz%"']);
$this->assertArrayHasKey('items', $actual, 'Key "items" does not exist in the response.');
$this->assertArrayHasKey('page', $actual, 'Key "page" does not exist in the response.');
$this->assertArrayHasKey('perPage', $actual, 'Key "perPage" does not exist in the response.');
$this->assertArrayHasKey('totalItems', $actual, 'Key "totalItems" does not exist in the response.');
$this->assertArrayHasKey('totalPages', $actual, 'Key "totalPages" does not exist in the response.');
$this->assertCount(1, $actual['items'], 'Expected no items in the response.');
}
public function test_getListStartsWithMartz(): void
{
$actual = $this->collection->getList(1, 10, ['filter'=>'name~"Martz%"']);
$this->assertArrayHasKey('items', $actual, 'Key "items" does not exist in the response.');
$this->assertArrayHasKey('page', $actual, 'Key "page" does not exist in the response.');
$this->assertArrayHasKey('perPage', $actual, 'Key "perPage" does not exist in the response.');
$this->assertArrayHasKey('totalItems', $actual, 'Key "totalItems" does not exist in the response.');
$this->assertArrayHasKey('totalPages', $actual, 'Key "totalPages" does not exist in the response.');
$this->assertCount(0, $actual['items'], 'Expected no items in the response.');
}
public function test_getListStartWithJonathan(): void
{
$actual = $this->collection->getList(1, 10, ['filter'=>'name~"Jonathan%"']);
$this->assertArrayHasKey('items', $actual, 'Key "items" does not exist in the response.');
$this->assertArrayHasKey('page', $actual, 'Key "page" does not exist in the response.');
$this->assertArrayHasKey('perPage', $actual, 'Key "perPage" does not exist in the response.');
$this->assertArrayHasKey('totalItems', $actual, 'Key "totalItems" does not exist in the response.');
$this->assertArrayHasKey('totalPages', $actual, 'Key "totalPages" does not exist in the response.');
$this->assertCount(1, $actual['items'], 'Expected no items in the response.');
}
public function test_getListCheckingDifferentName(): void
{
$actual = $this->collection->getList(1, 10, ['filter'=>'name~"%Sibylle%"']);
$this->assertArrayHasKey('items', $actual, 'Key "items" does not exist in the response.');
$this->assertArrayHasKey('page', $actual, 'Key "page" does not exist in the response.');
$this->assertArrayHasKey('perPage', $actual, 'Key "perPage" does not exist in the response.');
$this->assertArrayHasKey('totalItems', $actual, 'Key "totalItems" does not exist in the response.');
$this->assertArrayHasKey('totalPages', $actual, 'Key "totalPages" does not exist in the response.');
$this->assertCount(0, $actual['items'], 'Expected no items in the response.');
}
}

View File

@@ -0,0 +1,33 @@
<?php
use GuzzleHttp\Exception\ClientException;
use Pb\Collection;
use PHPUnit\Framework\TestCase;
final class CollectionGetOneTest extends TestCase
{
private string $url;
private Collection $collection;
protected function setUp(): void
{
$this->url = getenv('POCKETBASE_URL') ?: 'https://admin.pocketbase.dev';
$this->collection = new Collection($this->url, 'users');
}
public function test_getOne(): void
{
$id = '6588yk36406qqv1';
$actual = $this->collection->getOne($id);
$this->assertEquals($id, $actual['id']);
$this->assertCount(9, $actual);
}
public function test_getOneWrongId(): void
{
$id = '6588yk36406qqva';
$this->expectException(ClientException::class);
$this->collection->getOne($id);
}
}

View File

@@ -1,16 +0,0 @@
<?php declare(strict_types=1);
use PHPUnit\Framework\TestCase;
final class CollectionTest extends TestCase
{
public function test(): void
{
$expected = [];
$url = 'https://admin.pocketbase.dev';
$collection = new \Pb\Collection($url, 'users');
$actual = $collection->getList(1,10);
$this->assertSame($expected, $actual);
}
}