mirror of
https://github.com/jonathan-martz/pocketbase-php-sdk.git
synced 2026-04-03 15:27:44 +00:00
Compare commits
4 Commits
master
...
testdriven
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
b0a0cf6f1f | ||
|
|
d90cda9613 | ||
|
|
0d7255d77e | ||
|
|
40db76d3ed |
@@ -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",
|
||||
|
||||
882
composer.lock
generated
882
composer.lock
generated
File diff suppressed because it is too large
Load Diff
@@ -1,46 +0,0 @@
|
||||
<?php
|
||||
|
||||
namespace Pb;
|
||||
|
||||
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
|
||||
{
|
||||
$actual = $this->collection->authAsUser('support@jonathan-martz.de', 'rockt');
|
||||
$expected = '{"data":{},"message":"Failed to authenticate.","status":400}';
|
||||
|
||||
$this->assertEquals($expected, trim($actual, PHP_EOL));
|
||||
}
|
||||
|
||||
public function testAuthSuperUser(): void
|
||||
{
|
||||
$this->collection = new Collection($this->url, '_superusers');
|
||||
$actual = $this->collection->authAsAdmin('admin@jonathan-martz.de', 'rockt');
|
||||
$expected = '{"data":{},"message":"Failed to authenticate.","status":400}';
|
||||
|
||||
$this->assertEquals($expected, trim($actual, PHP_EOL));
|
||||
}
|
||||
|
||||
public function testAuthSuperUser2(): void
|
||||
{
|
||||
$this->collection = new Collection($this->url, '_superusers');
|
||||
|
||||
$actual = $this->collection->authAsAdmin('admin@jonathan-martz.de', 'rockt');
|
||||
|
||||
$data = json_decode($actual,true);
|
||||
$this->assertArrayHasKey('record',$data);
|
||||
$this->assertArrayHasKey('token',$data);
|
||||
$this->assertCount(8,$data['record']);
|
||||
}
|
||||
}
|
||||
@@ -2,6 +2,8 @@
|
||||
|
||||
namespace Pb;
|
||||
|
||||
use GuzzleHttp\Exception\GuzzleException;
|
||||
|
||||
/**
|
||||
*
|
||||
*/
|
||||
@@ -27,7 +29,10 @@ class Collection
|
||||
* @param string $collection
|
||||
* @param string $token
|
||||
*/
|
||||
public function __construct(string $url, string $collection, string $token = '')
|
||||
public function __construct(string $url,
|
||||
string $collection,
|
||||
string $token = ''
|
||||
)
|
||||
{
|
||||
$this->url = $url;
|
||||
$this->collection = $collection;
|
||||
@@ -36,12 +41,6 @@ class Collection
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @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;
|
||||
@@ -51,12 +50,6 @@ 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);
|
||||
@@ -76,25 +69,16 @@ class Collection
|
||||
$response = curl_exec($ch);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $email
|
||||
* @param string $password
|
||||
* @return void
|
||||
*/
|
||||
public function authAsUser(string $email, string $password): string
|
||||
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];
|
||||
@@ -104,104 +88,72 @@ class Collection
|
||||
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
|
||||
{
|
||||
// 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', $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
|
||||
{
|
||||
// TODO move doRequestIntoService ?
|
||||
// TODO replace curl with HttpClient
|
||||
$ch = curl_init();
|
||||
$tmp = $bodyParams;
|
||||
$bodyParams = [];
|
||||
$bodyParams['json'] = $tmp;
|
||||
$bodyParams['headers']['Content-Type'] = 'application/json';
|
||||
|
||||
if (self::$token != '') {
|
||||
$headers = array(
|
||||
'Authorization: ' . self::$token
|
||||
);
|
||||
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
|
||||
$bodyParams['headers']['Authorization'] = 'Bearer ' . self::$token;
|
||||
}
|
||||
|
||||
if ($bodyParams) {
|
||||
curl_setopt($ch, CURLOPT_POSTFIELDS, $bodyParams);
|
||||
$client = new \GuzzleHttp\Client();
|
||||
$response = $client->request($method, $url, $bodyParams);
|
||||
return $response->getBody()->getContents() ?? '';
|
||||
}
|
||||
|
||||
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;
|
||||
}
|
||||
|
||||
/**
|
||||
* @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): string
|
||||
{
|
||||
$bodyParams['identity'] = $email;
|
||||
$bodyParams['password'] = $password;
|
||||
$output = $this->doRequest($this->url . "/api/collections/_superusers/auth-with-password", 'POST', $bodyParams);
|
||||
|
||||
$token = json_decode($output, true)['token'];
|
||||
if ($token) {
|
||||
self::$token = $token;
|
||||
@@ -209,4 +161,36 @@ class Collection
|
||||
|
||||
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;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -41,6 +41,7 @@ class Settings
|
||||
|
||||
if (self::$token != '') {
|
||||
$headers = array(
|
||||
'Content-Type:application/json',
|
||||
'Authorization: ' . self::$token
|
||||
);
|
||||
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);
|
||||
|
||||
14
src/exception/FirstListItemNotFoundException.php
Normal file
14
src/exception/FirstListItemNotFoundException.php
Normal file
@@ -0,0 +1,14 @@
|
||||
<?php
|
||||
|
||||
namespace Pb\Exception;
|
||||
|
||||
class FirstListItemNotFoundException extends \Exception
|
||||
{
|
||||
|
||||
/**
|
||||
* @param string $string
|
||||
*/
|
||||
public function __construct(string $string)
|
||||
{
|
||||
}
|
||||
}
|
||||
38
tests/AuthTest.php
Normal file
38
tests/AuthTest.php
Normal 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?!');
|
||||
}
|
||||
}
|
||||
35
tests/CollectionCreateTest.php
Normal file
35
tests/CollectionCreateTest.php
Normal 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());
|
||||
}
|
||||
}
|
||||
@@ -1,6 +1,7 @@
|
||||
<?php
|
||||
|
||||
use Pb\Collection;
|
||||
use Pb\Exception\FirstListItemNotFoundException;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
final class CollectionGetFirstListItemTest extends TestCase
|
||||
@@ -13,43 +14,22 @@ final class CollectionGetFirstListItemTest extends TestCase
|
||||
$this->collection = new Collection($url, 'users');
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws FirstListItemNotFoundException
|
||||
*/
|
||||
public function test_getOne(): void
|
||||
{
|
||||
$id = '6588yk36406qqv1';
|
||||
$actual = $this->collection->getFirstListItem('id="'.$id.'"');
|
||||
$expected = [
|
||||
'avatar' => '',
|
||||
'collectionId' => '_pb_users_auth_',
|
||||
'collectionName' => 'users',
|
||||
'created' => '2025-01-21 21:22:47.002Z',
|
||||
'emailVisibility' => false,
|
||||
'id' => '6588yk36406qqv1',
|
||||
'name' => 'Jonathan Martz',
|
||||
'updated' => '2025-01-21 21:22:47.002Z',
|
||||
'verified' => true
|
||||
];
|
||||
|
||||
$this->assertEquals($expected, $actual);
|
||||
$this->assertEquals($id, $actual['id']);
|
||||
$this->assertCount(9, $actual);
|
||||
}
|
||||
|
||||
public function test_getOneWrongId(): void
|
||||
{
|
||||
$id = '6588yk36406qqva';
|
||||
$actual = $this->collection->getFirstListItem('id="'.$id.'"');
|
||||
$expected = [
|
||||
'avatar' => '',
|
||||
'collectionId' => '_pb_users_auth_',
|
||||
'collectionName' => 'users',
|
||||
'created' => '2025-01-21 21:22:47.002Z',
|
||||
'emailVisibility' => false,
|
||||
'id' => '6588yk36406qqv1',
|
||||
'name' => 'Jonathan Martz',
|
||||
'updated' => '2025-01-21 21:22:47.002Z',
|
||||
'verified' => true
|
||||
];
|
||||
|
||||
$this->assertEquals($expected, $actual);
|
||||
$this->assertCount(9,$actual);
|
||||
$id = '6588yk36406qqvb';
|
||||
$this->expectException(FirstListItemNotFoundException::class);
|
||||
$this->collection->getFirstListItem('id="'.$id.'"');
|
||||
}
|
||||
}
|
||||
@@ -1,5 +1,6 @@
|
||||
<?php
|
||||
|
||||
use GuzzleHttp\Exception\ClientException;
|
||||
use Pb\Collection;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
@@ -18,33 +19,15 @@ final class CollectionGetOneTest extends TestCase
|
||||
{
|
||||
$id = '6588yk36406qqv1';
|
||||
$actual = $this->collection->getOne($id);
|
||||
$expected = [
|
||||
'avatar' => '',
|
||||
'collectionId' => '_pb_users_auth_',
|
||||
'collectionName' => 'users',
|
||||
'created' => '2025-01-21 21:22:47.002Z',
|
||||
'emailVisibility' => false,
|
||||
'id' => '6588yk36406qqv1',
|
||||
'name' => 'Jonathan Martz',
|
||||
'updated' => '2025-01-21 21:22:47.002Z',
|
||||
'verified' => true
|
||||
];
|
||||
|
||||
$this->assertEquals($expected, $actual);
|
||||
$this->assertEquals($id, $actual['id']);
|
||||
$this->assertCount(9, $actual);
|
||||
}
|
||||
|
||||
public function test_getOneWrongId(): void
|
||||
{
|
||||
$id = '6588yk36406qqva';
|
||||
$actual = $this->collection->getOne($id);
|
||||
$expected = [
|
||||
'data' => [],
|
||||
'message' => "The requested resource wasn't found.",
|
||||
'status' => 404,
|
||||
];
|
||||
|
||||
$this->assertEquals($expected, $actual);
|
||||
$this->assertCount(3,$actual);
|
||||
$this->expectException(ClientException::class);
|
||||
$this->collection->getOne($id);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user