mirror of
https://github.com/anikeen-com/id.git
synced 2026-03-14 06:06:18 +00:00
Compare commits
31 Commits
1.0.0-alph
...
1.0.0-rc.6
| Author | SHA1 | Date | |
|---|---|---|---|
| 30ac4ae4f9 | |||
| e1a6af11a3 | |||
| bb5df7f115 | |||
| 297404b05d | |||
| 5ab57dcdfe | |||
| 0f14fa1b4c | |||
| 437e78770c | |||
| 0dbb27fc94 | |||
|
63e3f0a4a2
|
|||
|
1d2119a32b
|
|||
|
1725ec68de
|
|||
|
dcda4b990e
|
|||
|
937fde603b
|
|||
|
80b1f003b2
|
|||
|
aff901de4e
|
|||
|
92eadcca08
|
|||
|
8b874f540c
|
|||
|
3bcebd9d45
|
|||
|
71663bffd8
|
|||
|
5b2b3c72cc
|
|||
|
235918f0c0
|
|||
|
4b23f6ddbb
|
|||
|
85702fcb2c
|
|||
|
65d4b12006
|
|||
|
5d621b7cdc
|
|||
|
4d6fe7c325
|
|||
|
d447a88430
|
|||
|
d9a330222b
|
|||
|
21946e3a22
|
|||
|
1b96b87e1d
|
|||
|
7f908f4e6a
|
318
README.md
318
README.md
@@ -4,13 +4,13 @@
|
||||
[](https://packagist.org/packages/anikeen/id)
|
||||
[](https://packagist.org/packages/anikeen/id)
|
||||
|
||||
PHP Anikeen ID API Client for Laravel 10+
|
||||
PHP Anikeen ID API Client for Laravel 11+
|
||||
|
||||
## Table of contents
|
||||
|
||||
1. [Installation](#installation)
|
||||
2. [Event Listener](#event-listener)
|
||||
3. [Configuration](#configuration)
|
||||
2. [Configuration](#configuration)
|
||||
3. [General](#general)
|
||||
4. [Examples](#examples)
|
||||
5. [Documentation](#documentation)
|
||||
6. [Development](#Development)
|
||||
@@ -21,78 +21,110 @@ PHP Anikeen ID API Client for Laravel 10+
|
||||
composer require anikeen/id
|
||||
```
|
||||
|
||||
## Event Listener
|
||||
|
||||
- Add `SocialiteProviders\Manager\SocialiteWasCalled` event to your `listen[]` array in `app/Providers/EventServiceProvider`.
|
||||
- Add your listeners (i.e. the ones from the providers) to the `SocialiteProviders\Manager\SocialiteWasCalled[]` that you just created.
|
||||
- The listener that you add for this provider is `'Anikeen\\Id\\Socialite\\AnikeenIdExtendSocialite@handle',`.
|
||||
- Note: You do not need to add anything for the built-in socialite providers unless you override them with your own providers.
|
||||
|
||||
```
|
||||
/**
|
||||
* The event handler mappings for the application.
|
||||
*
|
||||
* @var array
|
||||
*/
|
||||
protected $listen = [
|
||||
\SocialiteProviders\Manager\SocialiteWasCalled::class => [
|
||||
// add your listeners (aka providers) here
|
||||
'Anikeen\\Id\\Socialite\\AnikeenIdExtendSocialite@handle',
|
||||
],
|
||||
];
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
Copy configuration to config folder:
|
||||
|
||||
```
|
||||
$ php artisan vendor:publish --provider="Anikeen\Id\Providers\AnikeenIdServiceProvider"
|
||||
```
|
||||
|
||||
Add environmental variables to your `.env`
|
||||
Add environmental variables to your `.env` file:
|
||||
|
||||
```
|
||||
ANIKEEN_ID_KEY=
|
||||
ANIKEEN_ID_SECRET=
|
||||
ANIKEEN_ID_REDIRECT_URI=http://localhost
|
||||
ANIKEEN_ID_CALLBACK_URL=http://localhost/auth/callback
|
||||
```
|
||||
|
||||
To switch from `production` to `staging` use following variable:
|
||||
|
||||
```
|
||||
ANIKEEN_ID_MODE=staging
|
||||
```
|
||||
|
||||
You will need to add an entry to the services configuration file so that after config files are cached for usage in production environment (Laravel command `artisan config:cache`) all config is still available.
|
||||
|
||||
**Add to `config/services.php`:**
|
||||
Add to `config/services.php` file:
|
||||
|
||||
```php
|
||||
'anikeen-id' => [
|
||||
'anikeen' => [
|
||||
'mode' => env('ANIKEEN_ID_MODE'),
|
||||
'client_id' => env('ANIKEEN_ID_KEY'),
|
||||
'client_secret' => env('ANIKEEN_ID_SECRET'),
|
||||
'redirect' => env('ANIKEEN_ID_REDIRECT_URI')
|
||||
'redirect' => env('ANIKEEN_ID_CALLBACK_URL'),
|
||||
'base_url' => env('ANIKEEN_ID_BASE_URL'),
|
||||
],
|
||||
```
|
||||
|
||||
## Implementing Auth
|
||||
### Event Listener
|
||||
|
||||
This method should typically be called in the `boot` method of your `AuthServiceProvider` class:
|
||||
In Laravel 11, the default EventServiceProvider provider was removed. Instead, add the listener using the listen method on the Event facade, in your `AppServiceProvider` boot method:
|
||||
|
||||
```php
|
||||
public function boot(): void
|
||||
{
|
||||
Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
|
||||
$event->extendSocialite('anikeen', \Anikeen\Id\Socialite\Provider::class);
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
### Registering Middleware
|
||||
|
||||
Append it to the global middleware stack in your application's `bootstrap/app.php` file:
|
||||
|
||||
```php
|
||||
->withMiddleware(function (Middleware $middleware) {
|
||||
$middleware->web(append: [
|
||||
\Anikeen\Id\Http\Middleware\CreateFreshApiToken::class,
|
||||
]);
|
||||
})
|
||||
```
|
||||
|
||||
### Implementing Billable
|
||||
|
||||
To implement the `Billable` trait, you need to add the `Billable` trait to your user model.
|
||||
|
||||
```php
|
||||
use Anikeen\Id\Billable;
|
||||
|
||||
class User extends Authenticatable
|
||||
{
|
||||
use Billable;
|
||||
|
||||
// Your model code...
|
||||
}
|
||||
```
|
||||
|
||||
then, you can use the `Billable` trait methods in your user model.
|
||||
|
||||
### Change the default access token / refresh token field name
|
||||
|
||||
If you access / refresh token fields differs from the default `anikeen_id_access_token` / `anikeen_id_refresh_token`, you can specify the field name in the `AppServiceProvider` boot method:
|
||||
|
||||
```php
|
||||
use Anikeen\Id\AnikeenId;
|
||||
use Anikeen\Id\Providers\AnikeenIdSsoUserProvider;
|
||||
use Illuminate\Http\Request;
|
||||
|
||||
/**
|
||||
* Register any authentication / authorization services.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function boot()
|
||||
public function boot(): void
|
||||
{
|
||||
Auth::provider('sso-users', function ($app, array $config) {
|
||||
return new AnikeenIdSsoUserProvider(
|
||||
AnikeenId::useAccessTokenField('anikeen_id_access_token');
|
||||
AnikeenId::useRefreshTokenField('anikeen_id_refresh_token');
|
||||
}
|
||||
```
|
||||
|
||||
### Implementing Auth
|
||||
|
||||
This method should typically be called in the `boot` method of your `AppServiceProvider` class:
|
||||
|
||||
```php
|
||||
use Anikeen\Id\AnikeenId;
|
||||
use Anikeen\Id\Providers\AnikeenIdUserProvider;
|
||||
use Illuminate\Http\Request;
|
||||
use Illuminate\Support\Facades\Auth;
|
||||
|
||||
public function boot(): void
|
||||
{
|
||||
Auth::provider('anikeen', function ($app, array $config) {
|
||||
return new AnikeenIdUserProvider(
|
||||
$app->make(AnikeenId::class),
|
||||
$app->make(Request::class),
|
||||
$config['model'],
|
||||
$config['fields'] ?? [],
|
||||
$config['access_token_field'] ?? null
|
||||
);
|
||||
});
|
||||
}
|
||||
@@ -108,8 +140,8 @@ reference the guard in the `guards` configuration of your `auth.php` configurati
|
||||
],
|
||||
|
||||
'api' => [
|
||||
'driver' => 'anikeen-id',
|
||||
'provider' => 'sso-users',
|
||||
'driver' => 'anikeen',
|
||||
'provider' => 'anikeen',
|
||||
],
|
||||
],
|
||||
```
|
||||
@@ -123,39 +155,17 @@ reference the provider in the `providers` configuration of your `auth.php` confi
|
||||
'model' => App\Models\User::class,
|
||||
],
|
||||
|
||||
'sso-users' => [
|
||||
'driver' => 'sso-users',
|
||||
'anikeen' => [
|
||||
'driver' => 'anikeen',
|
||||
'model' => App\Models\User::class,
|
||||
'fields' => ['first_name', 'last_name', 'email'],
|
||||
'access_token_field' => 'sso_access_token',
|
||||
],
|
||||
],
|
||||
```
|
||||
|
||||
## Examples
|
||||
## General
|
||||
|
||||
#### Basic
|
||||
|
||||
```php
|
||||
$anikeenId = new Anikeen\IdAnikeenId();
|
||||
|
||||
$anikeenId->setClientId('abc123');
|
||||
|
||||
// Get SSH Key by User ID
|
||||
$result = $anikeenId->getSshKeysByUserId(38);
|
||||
|
||||
// Check, if the query was successfull
|
||||
if ( ! $result->success()) {
|
||||
die('Ooops: ' . $result->error());
|
||||
}
|
||||
|
||||
// Shift result to get single key data
|
||||
$sshKey = $result->shift();
|
||||
|
||||
echo $sshKey->name;
|
||||
```
|
||||
|
||||
#### Setters
|
||||
#### Setters and Getters
|
||||
|
||||
```php
|
||||
$anikeenId = new Anikeen\Id\AnikeenId();
|
||||
@@ -169,6 +179,72 @@ $anikeenId = $anikeenId->withClientSecret('abc123');
|
||||
$anikeenId = $anikeenId->withToken('abcdef123456');
|
||||
```
|
||||
|
||||
#### Error handling for an unsuccessful query:
|
||||
|
||||
```php
|
||||
$result = $anikeenId->sshKeysByUserId('someInvalidId');
|
||||
|
||||
// Check, if the query was successfully
|
||||
if (!$result->success()) {
|
||||
die('Ooops: ' . $result->error());
|
||||
}
|
||||
```
|
||||
|
||||
#### Shift result to get single key data:
|
||||
|
||||
```php
|
||||
$result = $anikeenId->sshKeysByUserId('someValidId');
|
||||
|
||||
$sshKey = $result->shift();
|
||||
|
||||
echo $sshKey->name;
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
#### Get User SSH Key
|
||||
|
||||
```php
|
||||
$anikeenId = new Anikeen\IdAnikeenId();
|
||||
|
||||
$anikeenId->setClientId('abc123');
|
||||
|
||||
// Get SSH Key by User ID
|
||||
$result = $anikeenId->sshKeysByUserId('someValidId');
|
||||
|
||||
// Check, if the query was successfully
|
||||
if (!$result->success()) {
|
||||
die('Ooops: ' . $result->error());
|
||||
}
|
||||
|
||||
// Shift result to get single key data
|
||||
$sshKey = $result->shift();
|
||||
|
||||
echo $sshKey->name;
|
||||
```
|
||||
|
||||
#### Create Order Preview
|
||||
|
||||
```php
|
||||
$anikeenId = new \Anikeen\Id\AnikeenId();
|
||||
|
||||
// Create new Order Preview
|
||||
$result = $anikeenId->createOrderPreview([
|
||||
'country_iso' => 'de',
|
||||
'items' => [
|
||||
[
|
||||
'type' => 'physical',
|
||||
'name' => 'Test',
|
||||
'price' => 2.99,
|
||||
'unit' => 'onetime',
|
||||
'units' => 1,
|
||||
]
|
||||
]
|
||||
])->shift();
|
||||
|
||||
echo $preview->gross_total;
|
||||
```
|
||||
|
||||
#### OAuth Tokens
|
||||
|
||||
```php
|
||||
@@ -202,52 +278,108 @@ AnikeenId::withClientId('abc123')->withToken('abcdef123456')->getAuthedUser();
|
||||
|
||||
## Documentation
|
||||
|
||||
## AnikeenId
|
||||
|
||||
### Oauth
|
||||
|
||||
```php
|
||||
public function retrievingToken(string $grantType, array $attributes)
|
||||
public function retrievingToken(string $grantType, array $attributes): Result
|
||||
```
|
||||
|
||||
### SshKeys
|
||||
### ManagesPricing
|
||||
|
||||
```php
|
||||
public function getSshKeysByUserId(int $id)
|
||||
public function createSshKey(string $publicKey, string $name = NULL)
|
||||
public function deleteSshKey(int $id)
|
||||
public function createOrderPreview(array $attributes = []): Result
|
||||
```
|
||||
|
||||
### Users
|
||||
### ManagesSshKeys
|
||||
|
||||
```php
|
||||
public function getAuthedUser()
|
||||
public function createUser(array $parameters)
|
||||
public function isEmailExisting(string $email)
|
||||
public function sshKeysByUserId(string $sskKeyId): SshKeys
|
||||
```
|
||||
|
||||
### Delete
|
||||
### ManagesUsers
|
||||
|
||||
```php
|
||||
|
||||
public function getAuthedUser(): Result
|
||||
public function createUser(array $attributes): Result
|
||||
public function isEmailExisting(string $email): Result
|
||||
public function setParent(?mixed $parent): self
|
||||
public function getParent()
|
||||
```
|
||||
|
||||
### Get
|
||||
|
||||
## Billable
|
||||
|
||||
### ManagesAddresses
|
||||
|
||||
```php
|
||||
|
||||
public function addresses(): Addresses
|
||||
public function hasDefaultBillingAddress(): bool
|
||||
```
|
||||
|
||||
### Post
|
||||
### ManagesBalance
|
||||
|
||||
```php
|
||||
|
||||
public function balance(): float
|
||||
public function charges(): float
|
||||
public function charge(float $amount, string $paymentMethodId, array $options = []): Transaction
|
||||
```
|
||||
|
||||
### Put
|
||||
### ManagesCountries
|
||||
|
||||
```php
|
||||
|
||||
public function countries(): Countries
|
||||
```
|
||||
|
||||
### ManagesInvoices
|
||||
|
||||
```php
|
||||
public function invoices(array $parameters = []): Invoices
|
||||
```
|
||||
|
||||
### ManagesOrders
|
||||
|
||||
```php
|
||||
public function orders(array $parameters = []): Orders
|
||||
```
|
||||
|
||||
### ManagesPaymentMethods
|
||||
|
||||
```php
|
||||
public function paymentMethods(): PaymentMethods
|
||||
public function hasPaymentMethod(): ?PaymentMethod
|
||||
public function defaultPaymentMethod(): ?PaymentMethod
|
||||
public function hasDefaultPaymentMethod(): bool
|
||||
public function billingPortalUrl(?string $returnUrl = null, array $options = []): string
|
||||
public function createSetupIntent(array $options = []): Result
|
||||
```
|
||||
|
||||
### ManagesProfile
|
||||
|
||||
```php
|
||||
public function profilePortalUrl(?string $returnUrl = null, array $options = []): string
|
||||
```
|
||||
|
||||
### ManagesSubscriptions
|
||||
|
||||
```php
|
||||
public function subscriptions(): Subscriptions
|
||||
```
|
||||
|
||||
### ManagesTaxation
|
||||
|
||||
```php
|
||||
public function vat(): float
|
||||
```
|
||||
|
||||
### ManagesTransactions
|
||||
|
||||
```php
|
||||
public function transactions(): Transactions
|
||||
```
|
||||
|
||||
|
||||
[**OAuth Scopes Enums**](https://github.com/anikeen-com/id/blob/main/src/Enums/Scope.php)
|
||||
|
||||
## Development
|
||||
|
||||
215
README.stub
215
README.stub
@@ -9,8 +9,8 @@ PHP Anikeen ID API Client for Laravel 11+
|
||||
## Table of contents
|
||||
|
||||
1. [Installation](#installation)
|
||||
2. [Event Listener](#event-listener)
|
||||
3. [Configuration](#configuration)
|
||||
2. [Configuration](#configuration)
|
||||
3. [General](#general)
|
||||
4. [Examples](#examples)
|
||||
5. [Documentation](#documentation)
|
||||
6. [Development](#Development)
|
||||
@@ -21,67 +21,110 @@ PHP Anikeen ID API Client for Laravel 11+
|
||||
composer require anikeen/id
|
||||
```
|
||||
|
||||
## Event Listener
|
||||
|
||||
In Laravel 11, the default EventServiceProvider provider was removed. Instead, add the listener using the listen method on the Event facade, in your `AppServiceProvider`
|
||||
|
||||
```
|
||||
Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
|
||||
$event->extendSocialite('anikeen-id', \Anikeen\Id\Socialite\Provider::class);
|
||||
});
|
||||
```
|
||||
|
||||
## Configuration
|
||||
|
||||
Copy configuration to config folder:
|
||||
|
||||
```
|
||||
$ php artisan vendor:publish --provider="Anikeen\Id\Providers\AnikeenIdServiceProvider"
|
||||
```
|
||||
|
||||
Add environmental variables to your `.env`
|
||||
Add environmental variables to your `.env` file:
|
||||
|
||||
```
|
||||
ANIKEEN_ID_KEY=
|
||||
ANIKEEN_ID_SECRET=
|
||||
ANIKEEN_ID_REDIRECT_URI=http://localhost
|
||||
ANIKEEN_ID_CALLBACK_URL=http://localhost/auth/callback
|
||||
```
|
||||
|
||||
To switch from `production` to `staging` use following variable:
|
||||
|
||||
```
|
||||
ANIKEEN_ID_MODE=staging
|
||||
```
|
||||
|
||||
You will need to add an entry to the services configuration file so that after config files are cached for usage in production environment (Laravel command `artisan config:cache`) all config is still available.
|
||||
|
||||
**Add to `config/services.php`:**
|
||||
Add to `config/services.php` file:
|
||||
|
||||
```php
|
||||
'anikeen-id' => [
|
||||
'anikeen' => [
|
||||
'mode' => env('ANIKEEN_ID_MODE'),
|
||||
'client_id' => env('ANIKEEN_ID_KEY'),
|
||||
'client_secret' => env('ANIKEEN_ID_SECRET'),
|
||||
'redirect' => env('ANIKEEN_ID_REDIRECT_URI')
|
||||
'redirect' => env('ANIKEEN_ID_CALLBACK_URL'),
|
||||
'base_url' => env('ANIKEEN_ID_BASE_URL'),
|
||||
],
|
||||
```
|
||||
|
||||
## Implementing Auth
|
||||
### Event Listener
|
||||
|
||||
This method should typically be called in the `boot` method of your `AuthServiceProvider` class:
|
||||
In Laravel 11, the default EventServiceProvider provider was removed. Instead, add the listener using the listen method on the Event facade, in your `AppServiceProvider` boot method:
|
||||
|
||||
```php
|
||||
public function boot(): void
|
||||
{
|
||||
Event::listen(function (\SocialiteProviders\Manager\SocialiteWasCalled $event) {
|
||||
$event->extendSocialite('anikeen', \Anikeen\Id\Socialite\Provider::class);
|
||||
});
|
||||
}
|
||||
```
|
||||
|
||||
### Registering Middleware
|
||||
|
||||
Append it to the global middleware stack in your application's `bootstrap/app.php` file:
|
||||
|
||||
```php
|
||||
->withMiddleware(function (Middleware $middleware) {
|
||||
$middleware->web(append: [
|
||||
\Anikeen\Id\Http\Middleware\CreateFreshApiToken::class,
|
||||
]);
|
||||
})
|
||||
```
|
||||
|
||||
### Implementing Billable
|
||||
|
||||
To implement the `Billable` trait, you need to add the `Billable` trait to your user model.
|
||||
|
||||
```php
|
||||
use Anikeen\Id\Billable;
|
||||
|
||||
class User extends Authenticatable
|
||||
{
|
||||
use Billable;
|
||||
|
||||
// Your model code...
|
||||
}
|
||||
```
|
||||
|
||||
then, you can use the `Billable` trait methods in your user model.
|
||||
|
||||
### Change the default access token / refresh token field name
|
||||
|
||||
If you access / refresh token fields differs from the default `anikeen_id_access_token` / `anikeen_id_refresh_token`, you can specify the field name in the `AppServiceProvider` boot method:
|
||||
|
||||
```php
|
||||
use Anikeen\Id\AnikeenId;
|
||||
use Anikeen\Id\Providers\AnikeenIdSsoUserProvider;
|
||||
use Illuminate\Http\Request;
|
||||
|
||||
/**
|
||||
* Register any authentication / authorization services.
|
||||
*
|
||||
* @return void
|
||||
*/
|
||||
public function boot()
|
||||
public function boot(): void
|
||||
{
|
||||
Auth::provider('sso-users', function ($app, array $config) {
|
||||
return new AnikeenIdSsoUserProvider(
|
||||
AnikeenId::useAccessTokenField('anikeen_id_access_token');
|
||||
AnikeenId::useRefreshTokenField('anikeen_id_refresh_token');
|
||||
}
|
||||
```
|
||||
|
||||
### Implementing Auth
|
||||
|
||||
This method should typically be called in the `boot` method of your `AppServiceProvider` class:
|
||||
|
||||
```php
|
||||
use Anikeen\Id\AnikeenId;
|
||||
use Anikeen\Id\Providers\AnikeenIdUserProvider;
|
||||
use Illuminate\Http\Request;
|
||||
use Illuminate\Support\Facades\Auth;
|
||||
|
||||
public function boot(): void
|
||||
{
|
||||
Auth::provider('anikeen', function ($app, array $config) {
|
||||
return new AnikeenIdUserProvider(
|
||||
$app->make(AnikeenId::class),
|
||||
$app->make(Request::class),
|
||||
$config['model'],
|
||||
$config['fields'] ?? [],
|
||||
$config['access_token_field'] ?? null
|
||||
);
|
||||
});
|
||||
}
|
||||
@@ -97,8 +140,8 @@ reference the guard in the `guards` configuration of your `auth.php` configurati
|
||||
],
|
||||
|
||||
'api' => [
|
||||
'driver' => 'anikeen-id',
|
||||
'provider' => 'sso-users',
|
||||
'driver' => 'anikeen',
|
||||
'provider' => 'anikeen',
|
||||
],
|
||||
],
|
||||
```
|
||||
@@ -112,39 +155,17 @@ reference the provider in the `providers` configuration of your `auth.php` confi
|
||||
'model' => App\Models\User::class,
|
||||
],
|
||||
|
||||
'sso-users' => [
|
||||
'driver' => 'sso-users',
|
||||
'anikeen' => [
|
||||
'driver' => 'anikeen',
|
||||
'model' => App\Models\User::class,
|
||||
'fields' => ['first_name', 'last_name', 'email'],
|
||||
'access_token_field' => 'sso_access_token',
|
||||
],
|
||||
],
|
||||
```
|
||||
|
||||
## Examples
|
||||
## General
|
||||
|
||||
#### Basic
|
||||
|
||||
```php
|
||||
$anikeenId = new Anikeen\IdAnikeenId();
|
||||
|
||||
$anikeenId->setClientId('abc123');
|
||||
|
||||
// Get SSH Key by User ID
|
||||
$result = $anikeenId->getSshKeysByUserId(38);
|
||||
|
||||
// Check, if the query was successfull
|
||||
if ( ! $result->success()) {
|
||||
die('Ooops: ' . $result->error());
|
||||
}
|
||||
|
||||
// Shift result to get single key data
|
||||
$sshKey = $result->shift();
|
||||
|
||||
echo $sshKey->name;
|
||||
```
|
||||
|
||||
#### Setters
|
||||
#### Setters and Getters
|
||||
|
||||
```php
|
||||
$anikeenId = new Anikeen\Id\AnikeenId();
|
||||
@@ -158,6 +179,72 @@ $anikeenId = $anikeenId->withClientSecret('abc123');
|
||||
$anikeenId = $anikeenId->withToken('abcdef123456');
|
||||
```
|
||||
|
||||
#### Error handling for an unsuccessful query:
|
||||
|
||||
```php
|
||||
$result = $anikeenId->sshKeysByUserId('someInvalidId');
|
||||
|
||||
// Check, if the query was successfully
|
||||
if (!$result->success()) {
|
||||
die('Ooops: ' . $result->error());
|
||||
}
|
||||
```
|
||||
|
||||
#### Shift result to get single key data:
|
||||
|
||||
```php
|
||||
$result = $anikeenId->sshKeysByUserId('someValidId');
|
||||
|
||||
$sshKey = $result->shift();
|
||||
|
||||
echo $sshKey->name;
|
||||
```
|
||||
|
||||
## Examples
|
||||
|
||||
#### Get User SSH Key
|
||||
|
||||
```php
|
||||
$anikeenId = new Anikeen\IdAnikeenId();
|
||||
|
||||
$anikeenId->setClientId('abc123');
|
||||
|
||||
// Get SSH Key by User ID
|
||||
$result = $anikeenId->sshKeysByUserId('someValidId');
|
||||
|
||||
// Check, if the query was successfully
|
||||
if (!$result->success()) {
|
||||
die('Ooops: ' . $result->error());
|
||||
}
|
||||
|
||||
// Shift result to get single key data
|
||||
$sshKey = $result->shift();
|
||||
|
||||
echo $sshKey->name;
|
||||
```
|
||||
|
||||
#### Create Order Preview
|
||||
|
||||
```php
|
||||
$anikeenId = new \Anikeen\Id\AnikeenId();
|
||||
|
||||
// Create new Order Preview
|
||||
$result = $anikeenId->createOrderPreview([
|
||||
'country_iso' => 'de',
|
||||
'items' => [
|
||||
[
|
||||
'type' => 'physical',
|
||||
'name' => 'Test',
|
||||
'price' => 2.99,
|
||||
'unit' => 'onetime',
|
||||
'units' => 1,
|
||||
]
|
||||
]
|
||||
])->shift();
|
||||
|
||||
echo $preview->gross_total;
|
||||
```
|
||||
|
||||
#### OAuth Tokens
|
||||
|
||||
```php
|
||||
|
||||
@@ -13,7 +13,7 @@
|
||||
}
|
||||
],
|
||||
"require": {
|
||||
"php": "^8.0",
|
||||
"php": "^8.1",
|
||||
"ext-json": "*",
|
||||
"illuminate/support": "^11.0|^12.0",
|
||||
"illuminate/console": "^11.0|^12.0",
|
||||
|
||||
@@ -1,8 +0,0 @@
|
||||
<?php
|
||||
|
||||
return [
|
||||
'client_key' => env('ANIKEEN_ID_KEY'),
|
||||
'client_secret' => env('ANIKEEN_ID_SECRET'),
|
||||
'redirect_url' => env('ANIKEEN_ID_REDIRECT_URI'),
|
||||
'base_url' => env('ANIKEEN_ID_BASE_URL'),
|
||||
];
|
||||
@@ -1,85 +1,111 @@
|
||||
<?php
|
||||
|
||||
require __DIR__ . '/../vendor/autoload.php';
|
||||
|
||||
use Anikeen\Id\AnikeenId;
|
||||
use Illuminate\Support\Arr;
|
||||
|
||||
$markdown = collect(class_uses(AnikeenId::class))
|
||||
->map(function ($trait) {
|
||||
|
||||
$title = str_replace('Trait', '', Arr::last(explode('\\', $trait)));
|
||||
|
||||
$methods = [];
|
||||
|
||||
$reflection = new ReflectionClass($trait);
|
||||
|
||||
collect($reflection->getMethods())
|
||||
->reject(function (ReflectionMethod $method) {
|
||||
return $method->isAbstract();
|
||||
})
|
||||
->reject(function (ReflectionMethod $method) {
|
||||
return $method->isPrivate() || $method->isProtected();
|
||||
})
|
||||
->reject(function (ReflectionMethod $method) {
|
||||
return $method->isConstructor();
|
||||
})
|
||||
->each(function (ReflectionMethod $method) use (&$methods, $title, $trait) {
|
||||
|
||||
$declaration = collect($method->getModifiers())->map(function (int $modifier) {
|
||||
return $modifier == ReflectionMethod::IS_PUBLIC ? 'public ' : '';
|
||||
})->join(' ');
|
||||
|
||||
$declaration .= 'function ';
|
||||
$declaration .= $method->getName();
|
||||
$declaration .= '(';
|
||||
|
||||
$declaration .= collect($method->getParameters())->map(function (ReflectionParameter $parameter) {
|
||||
|
||||
$parameterString = Arr::last(explode('\\', $parameter->getType()->getName()));
|
||||
$parameterString .= ' ';
|
||||
$parameterString .= '$';
|
||||
$parameterString .= $parameter->getName();
|
||||
|
||||
if ($parameter->isDefaultValueAvailable()) {
|
||||
$parameterString .= ' = ';
|
||||
$parameterString .= str_replace(PHP_EOL, '', var_export($parameter->getDefaultValue(), true));
|
||||
}
|
||||
|
||||
return $parameterString;
|
||||
|
||||
})->join(', ');
|
||||
|
||||
$declaration .= ')';
|
||||
|
||||
$methods[] = $declaration;
|
||||
});
|
||||
|
||||
return [$title, $methods];
|
||||
})
|
||||
->map(function ($args) {
|
||||
|
||||
list($title, $methods) = $args;
|
||||
|
||||
$markdown = '### ' . $title;
|
||||
$markdown .= PHP_EOL . PHP_EOL;
|
||||
$markdown .= '```php';
|
||||
$markdown .= PHP_EOL;
|
||||
|
||||
$markdown .= collect($methods)->each(function ($method) {
|
||||
return $method;
|
||||
})->implode(PHP_EOL);
|
||||
|
||||
$markdown .= PHP_EOL;
|
||||
$markdown .= '```';
|
||||
|
||||
return $markdown;
|
||||
})->join(PHP_EOL . PHP_EOL);
|
||||
|
||||
$markdown = str_replace("array (\n)", '[]', $markdown);
|
||||
|
||||
$content = file_get_contents(__DIR__ . '/../README.stub');
|
||||
|
||||
$content = str_replace('<!-- GENERATED-DOCS -->', $markdown, $content);
|
||||
|
||||
file_put_contents(__DIR__ . '/../README.md', $content);
|
||||
<?php
|
||||
|
||||
require __DIR__ . '/../vendor/autoload.php';
|
||||
|
||||
use Anikeen\Id\AnikeenId;
|
||||
use Anikeen\Id\Billable;
|
||||
use Illuminate\Support\Arr;
|
||||
use Illuminate\Support\Str;
|
||||
|
||||
// Liste der Klassen, die ausgewertet werden sollen
|
||||
$classes = [
|
||||
AnikeenId::class,
|
||||
Billable::class,
|
||||
];
|
||||
|
||||
$allMarkdown = collect($classes)
|
||||
->map(function (string $class) {
|
||||
$className = Arr::last(explode('\\', $class));
|
||||
$markdown = "## {$className}\n\n";
|
||||
|
||||
// alle Traits der Klasse, außer denen aus ApiOperations
|
||||
$traits = collect(class_uses($class) ?: [])
|
||||
->reject(function (string $trait) {
|
||||
return Str::contains($trait, 'ApiOperations\\');
|
||||
})
|
||||
->all();
|
||||
|
||||
if (empty($traits)) {
|
||||
$markdown .= '_Keine Traits gefunden._';
|
||||
return $markdown;
|
||||
}
|
||||
|
||||
// für jeden Trait die Methoden extrahieren
|
||||
$markdown .= collect($traits)
|
||||
->map(function (string $trait) {
|
||||
$title = str_replace('Trait', '', Arr::last(explode('\\', $trait)));
|
||||
$reflection = new ReflectionClass($trait);
|
||||
|
||||
$methods = collect($reflection->getMethods())
|
||||
->reject->isAbstract()
|
||||
->reject->isPrivate()
|
||||
->reject->isProtected()
|
||||
->reject->isConstructor()
|
||||
->map(function (ReflectionMethod $method) {
|
||||
// Methodendeklaration starten
|
||||
$decl = 'public function ' . $method->getName() . '(';
|
||||
|
||||
// Parameter-Typen und Default-Werte
|
||||
$decl .= collect($method->getParameters())
|
||||
->map(function (ReflectionParameter $p) {
|
||||
// Typ-Hint
|
||||
$typeHint = '';
|
||||
if ($p->hasType()) {
|
||||
$type = $p->getType();
|
||||
$nullable = $type->allowsNull() ? '?' : '';
|
||||
$name = Arr::last(explode('\\', $type->getName()));
|
||||
$typeHint = $nullable . $name . ' ';
|
||||
}
|
||||
|
||||
// Parameter-Name
|
||||
$param = $typeHint . '$' . $p->getName();
|
||||
|
||||
// Default-Wert
|
||||
if ($p->isDefaultValueAvailable()) {
|
||||
$default = $p->getDefaultValue();
|
||||
if (is_array($default) && empty($default)) {
|
||||
// leeres Array → Short-Syntax
|
||||
$param .= ' = []';
|
||||
} elseif ($default === null) {
|
||||
// NULL → null (kleingeschrieben)
|
||||
$param .= ' = null';
|
||||
} else {
|
||||
// sonst var_export, Newlines entfernen
|
||||
$def = var_export($default, true);
|
||||
$param .= ' = ' . str_replace(PHP_EOL, '', $def);
|
||||
}
|
||||
}
|
||||
|
||||
return $param;
|
||||
})
|
||||
->implode(', ');
|
||||
|
||||
$decl .= ')';
|
||||
|
||||
// Rückgabetyp, falls vorhanden
|
||||
if ($method->hasReturnType()) {
|
||||
$retType = $method->getReturnType();
|
||||
$nullable = $retType->allowsNull() ? '?' : '';
|
||||
$typeName = Arr::last(explode('\\', $retType->getName()));
|
||||
$decl .= ': ' . $nullable . $typeName;
|
||||
}
|
||||
|
||||
return $decl;
|
||||
})
|
||||
->all();
|
||||
|
||||
// Markdown-Block für diesen Trait
|
||||
$md = "### {$title}\n\n```php\n";
|
||||
$md .= implode("\n", $methods) . "\n```\n";
|
||||
return $md;
|
||||
})
|
||||
->implode("\n");
|
||||
|
||||
return $markdown;
|
||||
})
|
||||
->implode("\n\n");
|
||||
|
||||
// README zusammenbauen und schreiben
|
||||
$stub = file_get_contents(__DIR__ . '/../README.stub');
|
||||
$content = str_replace('<!-- GENERATED-DOCS -->', $allMarkdown, $stub);
|
||||
file_put_contents(__DIR__ . '/../README.md', $content);
|
||||
|
||||
14
oauth-public.staging.key
Normal file
14
oauth-public.staging.key
Normal file
@@ -0,0 +1,14 @@
|
||||
-----BEGIN PUBLIC KEY-----
|
||||
MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAi4Ta8r01zKaGSnGi1EiD
|
||||
uMFWRXBlK4y/ZIfWBpElmS2ygv4mGeP3hT4Flm696Z2UMy56KC+c7CC/PQCiutLk
|
||||
5NUphyX/t+0QS5Dqpw6FB33fLTNNY7GqSmGIUE4os8XYZRSyDQRgtOgq3R3vJkoV
|
||||
7zoavTJmSCQlG5Qf0T//iMmzQ+b+6VZm1CJSz5nGx94u1DuXNyP5Epkk0wuHrtwy
|
||||
kADR2lmydNodJzqpSD+8yQqnAhOZNtNF4qwQ3g13fRvHycBp3G2nlCfOn2g5PmYD
|
||||
KYBKqvTq4PQH4E+K3pbbMz6zf/T6Dw7zTfksqHR4hqMgN6byRRxmwuBczIumcu9b
|
||||
y7xbgoIGIVZXgJliALPFi+zTPTN7c8MedFs/xCBHCmzWYTCZfHgr8RPRewD19tCG
|
||||
NSny5R0vlArpuZCTTgedPESDeGU4eNEddg4yXFzKlpE2nNuvzZ1Ohruc5ETOSU19
|
||||
RTCBUBkjeL6ESZRd/yKGjbVx4dEYxZdIz4yBl+hZ2ZOIyG7L3zPrccAWrPpG56xr
|
||||
E5IDBXxLFhaJ5LlyEAGQehB0ShEuCdkr88Xz7ba9PHpGqY83l4//ULrqPIZPAa4Z
|
||||
E3AWHT1ZtXNPeA4SzZ9Y9Oij4M3chyHxqM0lL3kYP+dstZehTujStfElDIx2Ni10
|
||||
73tILu4edYS0FxsL19m8gbsCAwEAAQ==
|
||||
-----END PUBLIC KEY-----
|
||||
@@ -23,7 +23,7 @@
|
||||
<php>
|
||||
<env name="ANIKEEN_ID_KEY" value="38"/>
|
||||
<env name="ANIKEEN_ID_SECRET" value="2goNRF8x37HPVZVaa28ySZGVXJuksvxnxM7TcGzM"/>
|
||||
<env name="ANIKEEN_ID_BASE_URL" value="https://id.anikeen.com/api/v1/"/>
|
||||
<env name="ANIKEEN_ID_BASE_URL" value="https://id.anikeen.com/api/"/>
|
||||
<env name="CLIENT_ACCESS_TOKEN" value="eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiIxNSIsImp0aSI6IjAxN2QxZDg0Y2MxNjAyZTYxOGZkNjYwZGViZWVjMDY4MTk2YmYzMDk1OGMzY2RiYzBjZmJkZWFjZjFhOTUxODQzZDU1YTk3OGY2YWIxY2YzIiwiaWF0IjoxNjY0NjIzMzA4LjQyODI4MSwibmJmIjoxNjY0NjIzMzA4LjQyODI4NCwiZXhwIjoxNjgwMzQ4MTA4LjQxNjc4MSwic3ViIjoiMzkiLCJzY29wZXMiOlsiYXBpIiwicmVhZF91c2VyIl0sImNsaWVudCI6eyJ0cnVzdGVkIjpmYWxzZX19.vxnzCaU4PpOrNVHa5AnGSS6gX_RCvxIERAnHFhjTrUzRafV9mr2Cvwd-BDVYoUr10wHvxa_TJSYfnAdDuhE-MEyDv13O3dL2XGTtJNa_Rg6L6CQ0JvC3wL-lWPvGPFax9pu-_lqbA3jm5B08hc3-7tq3f2nXcxjhtkqT6TTJv1-RCAppb2HCXiUDAqANzbhyInDjOH2WvFj1OGC_AI03J3W2KRWyeFLtUne8XKPFyr9XGcPuTrqogcuuXLeUt2kcf2bXbuIV1OlgIECrDiP1Ee0F2AzPs27ZVJ2z0R0JbT6AubKhGl5_Qi27cwjOH7hT2dmjcF1mLjzpN1uChLIdSnGSoStH8VzYHnHE2I8G-owW_aadG2UmGdnRY143q6g_28f3WIZNSucBSXkwFeS_t4fylsvpxhpjYJusf5qiEU_X3YbeawYMUCFUkSD2XTIypAqMJLNZQAeJ52eyL-9fln-Bv7n9v7K9G6ieR6Tm0tsJ1PRnaQi7rA1NTFwHoQmIOW9tfMycLzT7bgSoz3ra6Ez2J7ZNuWBZNKS0O-0YfSrAWyWK5U8YRfQuSVzP2VrIU63K6RGU2c284PfQGy11kgKUNQPykirb8p7MDQ8PwrxKaylBnD6hhDgjqEh2bfsr_43DfJA0R58L1HK3BmQnxgap0C77wK1e0yNlABpN28Q"/>
|
||||
</php>
|
||||
</phpunit>
|
||||
@@ -2,6 +2,9 @@
|
||||
|
||||
namespace Anikeen\Id;
|
||||
|
||||
use Anikeen\Id\Concerns\ManagesPricing;
|
||||
use Anikeen\Id\Concerns\ManagesSshKeys;
|
||||
use Anikeen\Id\Concerns\ManagesUsers;
|
||||
use Anikeen\Id\Exceptions\RequestRequiresAuthenticationException;
|
||||
use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
|
||||
use Anikeen\Id\Exceptions\RequestRequiresRedirectUriException;
|
||||
@@ -15,14 +18,16 @@ use Illuminate\Contracts\Auth\Authenticatable;
|
||||
|
||||
class AnikeenId
|
||||
{
|
||||
use Traits\OauthTrait;
|
||||
use Traits\SshKeysTrait;
|
||||
use Traits\UsersTrait;
|
||||
use OauthTrait;
|
||||
use ManagesPricing;
|
||||
use ManagesSshKeys;
|
||||
use ManagesUsers;
|
||||
|
||||
use ApiOperations\Delete;
|
||||
use ApiOperations\Get;
|
||||
use ApiOperations\Post;
|
||||
use ApiOperations\Put;
|
||||
use ApiOperations\Request;
|
||||
|
||||
/**
|
||||
* The name for API token cookies.
|
||||
@@ -41,7 +46,15 @@ class AnikeenId
|
||||
*/
|
||||
public static bool $unserializesCookies = false;
|
||||
|
||||
private static string $baseUrl = 'https://id.anikeen.com/api/';
|
||||
/**
|
||||
* The key for the access token.
|
||||
*/
|
||||
private static string $accessTokenField = 'anikeen_id_access_token';
|
||||
|
||||
/**
|
||||
* The key for the access token.
|
||||
*/
|
||||
private static string $refreshTokenField = 'anikeen_id_refresh_token';
|
||||
|
||||
/**
|
||||
* Guzzle is used to make http requests.
|
||||
@@ -55,13 +68,11 @@ class AnikeenId
|
||||
|
||||
/**
|
||||
* Anikeen ID OAuth token.
|
||||
*
|
||||
*/
|
||||
protected ?string $token = null;
|
||||
|
||||
/**
|
||||
* Anikeen ID client id.
|
||||
*
|
||||
*/
|
||||
protected ?string $clientId = null;
|
||||
|
||||
@@ -75,36 +86,74 @@ class AnikeenId
|
||||
*/
|
||||
protected ?string $redirectUri = null;
|
||||
|
||||
/**
|
||||
* The base URL for Anikeen ID.
|
||||
*/
|
||||
protected string $baseUrl = 'https://id.anikeen.com';
|
||||
|
||||
/**
|
||||
* The staging base URL for Anikeen ID.
|
||||
*/
|
||||
protected string $stagingBaseUrl = 'https://staging.id.anikeen.com';
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*/
|
||||
public function __construct()
|
||||
{
|
||||
if ($clientId = config('anikeen_id.client_id')) {
|
||||
if ($clientId = config('services.anikeen.client_id')) {
|
||||
$this->setClientId($clientId);
|
||||
}
|
||||
if ($clientSecret = config('anikeen_id.client_secret')) {
|
||||
if ($clientSecret = config('services.anikeen.client_secret')) {
|
||||
$this->setClientSecret($clientSecret);
|
||||
}
|
||||
if ($redirectUri = config('anikeen_id.redirect_url')) {
|
||||
if ($redirectUri = config('services.anikeen.redirect')) {
|
||||
$this->setRedirectUri($redirectUri);
|
||||
}
|
||||
if ($redirectUri = config('anikeen_id.base_url')) {
|
||||
self::setBaseUrl($redirectUri);
|
||||
if (self::getMode() === 'staging' && !config('services.anikeen.base_url')) {
|
||||
self::setBaseUrl($this->stagingBaseUrl);
|
||||
}
|
||||
if ($baseUrl = config('services.anikeen.base_url')) {
|
||||
self::setBaseUrl($baseUrl);
|
||||
}
|
||||
$this->client = new Client([
|
||||
'base_uri' => self::$baseUrl,
|
||||
'base_uri' => $this->baseUrl,
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $baseUrl
|
||||
*
|
||||
* @internal only for internal and debug purposes.
|
||||
*/
|
||||
public static function setBaseUrl(string $baseUrl): void
|
||||
protected function setBaseUrl(string $baseUrl): void
|
||||
{
|
||||
self::$baseUrl = $baseUrl;
|
||||
$this->baseUrl = $baseUrl;
|
||||
}
|
||||
|
||||
public function getBaseUrl(): string
|
||||
{
|
||||
return rtrim($this->baseUrl, '/');
|
||||
}
|
||||
|
||||
public static function useAccessTokenField(string $accessTokenField): void
|
||||
{
|
||||
self::$accessTokenField = $accessTokenField;
|
||||
}
|
||||
|
||||
public static function getAccessTokenField(): string
|
||||
{
|
||||
return self::$accessTokenField;
|
||||
}
|
||||
|
||||
public static function getMode(): string
|
||||
{
|
||||
return config('services.anikeen.mode') ?: 'production';
|
||||
}
|
||||
|
||||
public static function useRefreshTokenField(string $refreshTokenField): void
|
||||
{
|
||||
self::$refreshTokenField = $refreshTokenField;
|
||||
}
|
||||
|
||||
public static function getRefreshTokenField(): string
|
||||
{
|
||||
return self::$refreshTokenField;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -113,7 +162,7 @@ class AnikeenId
|
||||
* @param string|null $cookie
|
||||
* @return string|static
|
||||
*/
|
||||
public static function cookie(string $cookie = null)
|
||||
public static function cookie(?string $cookie = null): string|static
|
||||
{
|
||||
if (is_null($cookie)) {
|
||||
return static::$cookie;
|
||||
@@ -127,7 +176,7 @@ class AnikeenId
|
||||
/**
|
||||
* Set the current user for the application with the given scopes.
|
||||
*/
|
||||
public static function actingAs(Authenticatable|Traits\HasAnikeenTokens $user, array $scopes = [], string $guard = 'api'): Authenticatable
|
||||
public static function actingAs(Authenticatable|HasAnikeenTokens $user, array $scopes = [], string $guard = 'api'): Authenticatable
|
||||
{
|
||||
$user->withAnikeenAccessToken((object)[
|
||||
'scopes' => $scopes
|
||||
@@ -251,12 +300,25 @@ class AnikeenId
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws GuzzleException
|
||||
* Get client id.
|
||||
*
|
||||
* @throws RequestRequiresClientIdException
|
||||
*/
|
||||
public function get(string $path = '', array $parameters = [], Paginator $paginator = null): Result
|
||||
public function getClientId(): string
|
||||
{
|
||||
return $this->query('GET', $path, $parameters, $paginator);
|
||||
if (!$this->clientId) {
|
||||
throw new RequestRequiresClientIdException;
|
||||
}
|
||||
|
||||
return $this->clientId;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set client id.
|
||||
*/
|
||||
public function setClientId(string $clientId): void
|
||||
{
|
||||
$this->clientId = $clientId;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -265,23 +327,23 @@ class AnikeenId
|
||||
* @throws GuzzleException
|
||||
* @throws RequestRequiresClientIdException
|
||||
*/
|
||||
public function query(string $method = 'GET', string $path = '', array $parameters = [], Paginator $paginator = null, mixed $jsonBody = null): Result
|
||||
public function request(string $method, string $path, null|array $payload = null, array $parameters = [], ?Paginator $paginator = null): Result
|
||||
{
|
||||
/** @noinspection DuplicatedCode */
|
||||
if ($paginator !== null) {
|
||||
$parameters[$paginator->action] = $paginator->cursor();
|
||||
}
|
||||
|
||||
try {
|
||||
$response = $this->client->request($method, $path, [
|
||||
'headers' => $this->buildHeaders((bool)$jsonBody),
|
||||
'headers' => $this->buildHeaders((bool)$payload),
|
||||
'query' => Query::build($parameters),
|
||||
'json' => $jsonBody ?: null,
|
||||
'json' => $payload ?: null,
|
||||
]);
|
||||
$result = new Result($response, null, $paginator);
|
||||
|
||||
$result = new Result($response, null, $this);
|
||||
} catch (RequestException $exception) {
|
||||
$result = new Result($exception->getResponse(), $exception, $paginator);
|
||||
$result = new Result($exception->getResponse(), $exception, $this);
|
||||
}
|
||||
$result->anikeenId = $this;
|
||||
|
||||
return $result;
|
||||
}
|
||||
@@ -308,64 +370,38 @@ class AnikeenId
|
||||
}
|
||||
|
||||
/**
|
||||
* Get client id.
|
||||
*
|
||||
* @throws GuzzleException
|
||||
* @throws RequestRequiresClientIdException
|
||||
*/
|
||||
public function getClientId(): string
|
||||
public function get(string $path, array $parameters = [], ?Paginator $paginator = null): Result
|
||||
{
|
||||
if (!$this->clientId) {
|
||||
throw new RequestRequiresClientIdException;
|
||||
}
|
||||
|
||||
return $this->clientId;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set client id.
|
||||
*/
|
||||
public function setClientId(string $clientId): void
|
||||
{
|
||||
$this->clientId = $clientId;
|
||||
return $this->request('GET', $path, null, $parameters, $paginator);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws GuzzleException
|
||||
* @throws RequestRequiresClientIdException
|
||||
*/
|
||||
public function post(string $path = '', array $parameters = [], Paginator $paginator = null): Result
|
||||
public function post(string $path, array $payload = [], array $parameters = [], ?Paginator $paginator = null): Result
|
||||
{
|
||||
return $this->query('POST', $path, $parameters, $paginator);
|
||||
return $this->request('POST', $path, $payload, $parameters, $paginator);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws GuzzleException
|
||||
* @throws RequestRequiresClientIdException
|
||||
*/
|
||||
public function delete(string $path = '', array $parameters = [], Paginator $paginator = null): Result
|
||||
public function put(string $path, array $payload = [], array $parameters = [], ?Paginator $paginator = null): Result
|
||||
{
|
||||
return $this->query('DELETE', $path, $parameters, $paginator);
|
||||
return $this->request('PUT', $path, $payload, $parameters, $paginator);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws GuzzleException
|
||||
* @throws RequestRequiresClientIdException
|
||||
*/
|
||||
public function put(string $path = '', array $parameters = [], Paginator $paginator = null): Result
|
||||
public function delete(string $path, array $payload = [], array $parameters = [], ?Paginator $paginator = null): Result
|
||||
{
|
||||
return $this->query('PUT', $path, $parameters, $paginator);
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws GuzzleException
|
||||
* @throws RequestRequiresClientIdException
|
||||
*/
|
||||
public function json(string $method, string $path = '', array $body = null): Result
|
||||
{
|
||||
if ($body) {
|
||||
$body = json_encode(['data' => $body]);
|
||||
}
|
||||
|
||||
return $this->query($method, $path, [], null, $body);
|
||||
return $this->request('DELETE', $path, $payload, $parameters, $paginator);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,10 +2,18 @@
|
||||
|
||||
namespace Anikeen\Id\ApiOperations;
|
||||
|
||||
use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
|
||||
use Anikeen\Id\Helpers\Paginator;
|
||||
use Anikeen\Id\Result;
|
||||
use GuzzleHttp\Exception\GuzzleException;
|
||||
|
||||
trait Delete
|
||||
{
|
||||
abstract public function delete(string $path = '', array $parameters = [], Paginator $paginator = null): Result;
|
||||
/**
|
||||
* Delete a resource from the API.
|
||||
*
|
||||
* @throws RequestRequiresClientIdException
|
||||
* @throws GuzzleException
|
||||
*/
|
||||
abstract public function delete(string $path, array $payload = [], array $parameters = [], ?Paginator $paginator = null): Result;
|
||||
}
|
||||
@@ -2,10 +2,18 @@
|
||||
|
||||
namespace Anikeen\Id\ApiOperations;
|
||||
|
||||
use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
|
||||
use Anikeen\Id\Helpers\Paginator;
|
||||
use Anikeen\Id\Result;
|
||||
use GuzzleHttp\Exception\GuzzleException;
|
||||
|
||||
trait Get
|
||||
{
|
||||
abstract public function get(string $path = '', array $parameters = [], Paginator $paginator = null): Result;
|
||||
/**
|
||||
* Get a resource from the API.
|
||||
*
|
||||
* @throws RequestRequiresClientIdException
|
||||
* @throws GuzzleException
|
||||
*/
|
||||
abstract public function get(string $path, array $parameters = [], ?Paginator $paginator = null): Result;
|
||||
}
|
||||
@@ -2,10 +2,18 @@
|
||||
|
||||
namespace Anikeen\Id\ApiOperations;
|
||||
|
||||
use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
|
||||
use Anikeen\Id\Helpers\Paginator;
|
||||
use Anikeen\Id\Result;
|
||||
use GuzzleHttp\Exception\GuzzleException;
|
||||
|
||||
trait Post
|
||||
{
|
||||
abstract public function post(string $path = '', array $parameters = [], Paginator $paginator = null): Result;
|
||||
/**
|
||||
* Make a POST request to the API.
|
||||
*
|
||||
* @throws RequestRequiresClientIdException
|
||||
* @throws GuzzleException
|
||||
*/
|
||||
abstract public function post(string $path, array $payload = [], array $parameters = [], ?Paginator $paginator = null): Result;
|
||||
}
|
||||
@@ -2,10 +2,18 @@
|
||||
|
||||
namespace Anikeen\Id\ApiOperations;
|
||||
|
||||
use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
|
||||
use Anikeen\Id\Helpers\Paginator;
|
||||
use Anikeen\Id\Result;
|
||||
use GuzzleHttp\Exception\GuzzleException;
|
||||
|
||||
trait Put
|
||||
{
|
||||
abstract public function put(string $path = '', array $parameters = [], Paginator $paginator = null): Result;
|
||||
/**
|
||||
* Make a PUT request to the API.
|
||||
*
|
||||
* @throws RequestRequiresClientIdException
|
||||
* @throws GuzzleException
|
||||
*/
|
||||
abstract public function put(string $path, array $payload = [], array $parameters = [], ?Paginator $paginator = null): Result;
|
||||
}
|
||||
19
src/Id/ApiOperations/Request.php
Normal file
19
src/Id/ApiOperations/Request.php
Normal file
@@ -0,0 +1,19 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\ApiOperations;
|
||||
|
||||
use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
|
||||
use Anikeen\Id\Helpers\Paginator;
|
||||
use Anikeen\Id\Result;
|
||||
use GuzzleHttp\Exception\GuzzleException;
|
||||
|
||||
trait Request
|
||||
{
|
||||
/**
|
||||
* Make a request to the API.
|
||||
*
|
||||
* @throws RequestRequiresClientIdException
|
||||
* @throws GuzzleException
|
||||
*/
|
||||
abstract public function request(string $method, string $path, null|array $payload = null, array $parameters = [], ?Paginator $paginator = null): Result;
|
||||
}
|
||||
@@ -10,7 +10,7 @@ trait Validation
|
||||
/**
|
||||
* @throws RequestRequiresMissingParametersException
|
||||
*/
|
||||
public function validateRequired(array $parameters, array $required)
|
||||
public function validateRequired(array $parameters, array $required): void
|
||||
{
|
||||
if (!Arr::has($parameters, $required)) {
|
||||
throw RequestRequiresMissingParametersException::fromValidateRequired($parameters, $required);
|
||||
|
||||
@@ -25,7 +25,7 @@ class ApiTokenCookieFactory
|
||||
{
|
||||
$config = $this->config->get('session');
|
||||
|
||||
$expiration = Carbon::now()->addMinutes($config['lifetime']);
|
||||
$expiration = Carbon::now()->addMinutes((int)$config['lifetime']);
|
||||
|
||||
return new Cookie(
|
||||
AnikeenId::cookie(),
|
||||
|
||||
@@ -3,8 +3,8 @@
|
||||
namespace Anikeen\Id\Auth;
|
||||
|
||||
use Anikeen\Id\AnikeenId;
|
||||
use Anikeen\Id\HasAnikeenTokens;
|
||||
use Anikeen\Id\Helpers\JwtParser;
|
||||
use Anikeen\Id\Traits\HasAnikeenTokens;
|
||||
use Exception;
|
||||
use Firebase\JWT\JWT;
|
||||
use Firebase\JWT\Key;
|
||||
|
||||
@@ -62,4 +62,9 @@ class UserProvider implements Base
|
||||
{
|
||||
return $this->providerName;
|
||||
}
|
||||
|
||||
public function rehashPasswordIfRequired(Authenticatable $user, #[\SensitiveParameter] array $credentials, bool $force = false)
|
||||
{
|
||||
// TODO: Implement rehashPasswordIfRequired() method.
|
||||
}
|
||||
}
|
||||
|
||||
59
src/Id/Billable.php
Normal file
59
src/Id/Billable.php
Normal file
@@ -0,0 +1,59 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id;
|
||||
|
||||
use Anikeen\Id\ApiOperations\Request;
|
||||
use Anikeen\Id\Concerns\ManagesAddresses;
|
||||
use Anikeen\Id\Concerns\ManagesBalance;
|
||||
use Anikeen\Id\Concerns\ManagesCountries;
|
||||
use Anikeen\Id\Concerns\ManagesInvoices;
|
||||
use Anikeen\Id\Concerns\ManagesOrders;
|
||||
use Anikeen\Id\Concerns\ManagesPaymentMethods;
|
||||
use Anikeen\Id\Concerns\ManagesProfile;
|
||||
use Anikeen\Id\Concerns\ManagesSubscriptions;
|
||||
use Anikeen\Id\Concerns\ManagesTaxation;
|
||||
use Anikeen\Id\Concerns\ManagesTransactions;
|
||||
use Anikeen\Id\Helpers\Paginator;
|
||||
use stdClass;
|
||||
use Throwable;
|
||||
|
||||
trait Billable
|
||||
{
|
||||
use ManagesAddresses;
|
||||
use ManagesBalance;
|
||||
use ManagesCountries;
|
||||
use ManagesInvoices;
|
||||
use ManagesOrders;
|
||||
use ManagesPaymentMethods;
|
||||
use ManagesProfile;
|
||||
use ManagesSubscriptions;
|
||||
use ManagesTaxation;
|
||||
use ManagesTransactions;
|
||||
use Request;
|
||||
|
||||
/**
|
||||
* Get the currently authenticated user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function getUserData(): stdClass
|
||||
{
|
||||
if (!isset($this->userDataCache)) {
|
||||
$this->userDataCache = $this->request('GET', 'v1/user')->data;
|
||||
}
|
||||
return $this->userDataCache;
|
||||
}
|
||||
|
||||
/**
|
||||
* Make a request to the Anikeen API.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function request(string $method, string $path, null|array $payload = null, array $parameters = [], ?Paginator $paginator = null): Result
|
||||
{
|
||||
$anikeenId = new AnikeenId();
|
||||
$anikeenId->withToken($this->{AnikeenId::getAccessTokenField()});
|
||||
|
||||
return $anikeenId->request($method, $path, $payload, $parameters, $paginator);
|
||||
}
|
||||
}
|
||||
20
src/Id/Concerns/HasBillable.php
Normal file
20
src/Id/Concerns/HasBillable.php
Normal file
@@ -0,0 +1,20 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Concerns;
|
||||
|
||||
trait HasBillable
|
||||
{
|
||||
public mixed $billable;
|
||||
|
||||
public function setBillable(mixed $billable): self
|
||||
{
|
||||
$this->billable = $billable;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getBillable(): mixed
|
||||
{
|
||||
return $this->billable;
|
||||
}
|
||||
}
|
||||
20
src/Id/Concerns/HasParent.php
Normal file
20
src/Id/Concerns/HasParent.php
Normal file
@@ -0,0 +1,20 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Concerns;
|
||||
|
||||
trait HasParent
|
||||
{
|
||||
protected mixed $parent;
|
||||
|
||||
public function setParent(mixed $parent): self
|
||||
{
|
||||
$this->parent = $parent;
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
public function getParent()
|
||||
{
|
||||
return $this->parent;
|
||||
}
|
||||
}
|
||||
39
src/Id/Concerns/ManagesAddresses.php
Normal file
39
src/Id/Concerns/ManagesAddresses.php
Normal file
@@ -0,0 +1,39 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Concerns;
|
||||
|
||||
use Anikeen\Id\ApiOperations\Request;
|
||||
use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
|
||||
use Anikeen\Id\Resources\Addresses;
|
||||
use Throwable;
|
||||
|
||||
trait ManagesAddresses
|
||||
{
|
||||
use Request;
|
||||
|
||||
/**
|
||||
* Get addresses from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function addresses(): Addresses
|
||||
{
|
||||
if (!isset($this->addressesCache)) {
|
||||
$this->addressesCache = Addresses::builder(fn() => $this->request('GET', 'v1/addresses'))
|
||||
->setBillable($this);
|
||||
}
|
||||
|
||||
return $this->addressesCache;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the current user has a default billing address.
|
||||
*
|
||||
* @see \Anikeen\Id\Resources\Addresses::hasDefaultBillingAddress()
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function hasDefaultBillingAddress(): bool
|
||||
{
|
||||
return $this->addresses()->hasDefaultBillingAddress();
|
||||
}
|
||||
}
|
||||
49
src/Id/Concerns/ManagesBalance.php
Normal file
49
src/Id/Concerns/ManagesBalance.php
Normal file
@@ -0,0 +1,49 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Concerns;
|
||||
|
||||
use Anikeen\Id\ApiOperations\Request;
|
||||
use Anikeen\Id\Resources\Transaction;
|
||||
use Throwable;
|
||||
|
||||
trait ManagesBalance
|
||||
{
|
||||
use Request;
|
||||
|
||||
/**
|
||||
* Get balance from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function balance(): float
|
||||
{
|
||||
return $this->getUserData()->current_balance;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get charges from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function charges(): float
|
||||
{
|
||||
return $this->getUserData()->current_charges;
|
||||
}
|
||||
|
||||
/**
|
||||
* Charge given amount from bank to current user.
|
||||
*
|
||||
* @param float $amount Amount to charge in euros.
|
||||
* @param string $paymentMethodId Payment method ID.
|
||||
* @param array $options Additional options for the charge.
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function charge(float $amount, string $paymentMethodId, array $options = []): Transaction
|
||||
{
|
||||
return new Transaction(fn() => $this->request('POST', 'billing/charge', [
|
||||
'amount' => $amount,
|
||||
'payment_method_id' => $paymentMethodId,
|
||||
'options' => $options,
|
||||
]));
|
||||
}
|
||||
}
|
||||
28
src/Id/Concerns/ManagesCountries.php
Normal file
28
src/Id/Concerns/ManagesCountries.php
Normal file
@@ -0,0 +1,28 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Concerns;
|
||||
|
||||
use Anikeen\Id\ApiOperations\Request;
|
||||
use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
|
||||
use Anikeen\Id\Resources\Countries;
|
||||
use Throwable;
|
||||
|
||||
trait ManagesCountries
|
||||
{
|
||||
use Request;
|
||||
|
||||
/**
|
||||
* Get available countries for the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function countries(): Countries
|
||||
{
|
||||
if (!isset($this->countriesCache)) {
|
||||
$this->countriesCache = Countries::builder(fn() => $this->request('GET', 'v1/countries'))
|
||||
->setBillable($this);
|
||||
}
|
||||
|
||||
return $this->countriesCache;
|
||||
}
|
||||
}
|
||||
28
src/Id/Concerns/ManagesInvoices.php
Normal file
28
src/Id/Concerns/ManagesInvoices.php
Normal file
@@ -0,0 +1,28 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Concerns;
|
||||
|
||||
use Anikeen\Id\ApiOperations\Request;
|
||||
use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
|
||||
use Anikeen\Id\Resources\Invoices;
|
||||
use Throwable;
|
||||
|
||||
trait ManagesInvoices
|
||||
{
|
||||
use Request;
|
||||
|
||||
/**
|
||||
* Get invoices from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function invoices(array $parameters = []): Invoices
|
||||
{
|
||||
if (!isset($this->invoicesCache)) {
|
||||
$this->invoicesCache = Invoices::builder(fn() => $this->request('GET', 'v1/invoices', [], $parameters))
|
||||
->setBillable($this);
|
||||
}
|
||||
|
||||
return $this->invoicesCache;
|
||||
}
|
||||
}
|
||||
29
src/Id/Concerns/ManagesOrders.php
Normal file
29
src/Id/Concerns/ManagesOrders.php
Normal file
@@ -0,0 +1,29 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Concerns;
|
||||
|
||||
use Anikeen\Id\ApiOperations\Request;
|
||||
use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
|
||||
use Anikeen\Id\Resources\Orders;
|
||||
use Anikeen\Id\Result;
|
||||
use Throwable;
|
||||
|
||||
trait ManagesOrders
|
||||
{
|
||||
use Request;
|
||||
|
||||
/**
|
||||
* Get orders from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function orders(array $parameters = []): Orders
|
||||
{
|
||||
if (!isset($this->ordersCache)) {
|
||||
$this->ordersCache = Orders::builder(fn() => $this->request('GET', 'v1/orders', [], $parameters))
|
||||
->setBillable($this);
|
||||
}
|
||||
|
||||
return $this->ordersCache;
|
||||
}
|
||||
}
|
||||
92
src/Id/Concerns/ManagesPaymentMethods.php
Normal file
92
src/Id/Concerns/ManagesPaymentMethods.php
Normal file
@@ -0,0 +1,92 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Concerns;
|
||||
|
||||
use Anikeen\Id\ApiOperations\Request;
|
||||
use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
|
||||
use Anikeen\Id\Resources\PaymentMethod;
|
||||
use Anikeen\Id\Resources\PaymentMethods;
|
||||
use Anikeen\Id\Result;
|
||||
use Throwable;
|
||||
|
||||
trait ManagesPaymentMethods
|
||||
{
|
||||
use Request;
|
||||
|
||||
/**
|
||||
* Get payment methods from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function paymentMethods(): PaymentMethods
|
||||
{
|
||||
if (!isset($this->paymentMethodsCache)) {;
|
||||
$this->paymentMethodsCache = PaymentMethods::builder(
|
||||
fn() => $this->request('GET', 'v1/payment-methods')
|
||||
)->setBillable($this);
|
||||
}
|
||||
|
||||
return $this->paymentMethodsCache;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if current user has at least one payment method.
|
||||
*
|
||||
* @see \Anikeen\Id\Resources\PaymentMethods::hasPaymentMethod()
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function hasPaymentMethod(): ?PaymentMethod
|
||||
{
|
||||
return $this->paymentMethods()->hasPaymentMethod();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get default payment method from the current user.
|
||||
*
|
||||
* @see \Anikeen\Id\Resources\PaymentMethods::defaultPaymentMethod()
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function defaultPaymentMethod(): ?PaymentMethod
|
||||
{
|
||||
return $this->paymentMethods()->defaultPaymentMethod();
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the current user has a default payment method.
|
||||
*
|
||||
* @see \Anikeen\Id\Resources\PaymentMethods::hasDefaultPaymentMethod()
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function hasDefaultPaymentMethod(): bool
|
||||
{
|
||||
return $this->paymentMethods()->hasDefaultPaymentMethod();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get billing portal URL for the current user.
|
||||
*
|
||||
* @param string|null $returnUrl The URL to redirect to after the user has finished in the billing portal.
|
||||
* @param array $options Additional options for the billing portal.
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function billingPortalUrl(?string $returnUrl = null, array $options = []): string
|
||||
{
|
||||
return $this->request('POST', 'v1/billing/portal', [
|
||||
'return_url' => $returnUrl,
|
||||
'options' => $options,
|
||||
])->data->url;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new setup intent.
|
||||
*
|
||||
* @param array $options Additional options for the setup intent.
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function createSetupIntent(array $options = []): Result
|
||||
{
|
||||
return $this->request('POST', 'v1/payment-methods', [
|
||||
'options' => $options,
|
||||
]);
|
||||
}
|
||||
}
|
||||
38
src/Id/Concerns/ManagesPricing.php
Normal file
38
src/Id/Concerns/ManagesPricing.php
Normal file
@@ -0,0 +1,38 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Concerns;
|
||||
|
||||
use Anikeen\Id\ApiOperations\Post;
|
||||
use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
|
||||
use Anikeen\Id\Result;
|
||||
use Throwable;
|
||||
|
||||
trait ManagesPricing
|
||||
{
|
||||
use Post;
|
||||
|
||||
/**
|
||||
* Make a new order preview (will not be stored into the database).
|
||||
*
|
||||
* VAT is calculated based on the billing address and shown in the order response.
|
||||
*
|
||||
* @param array{
|
||||
* country_iso: string,
|
||||
* items: array<array{
|
||||
* type: string,
|
||||
* name: string,
|
||||
* description: string,
|
||||
* price: float|int,
|
||||
* unit: string,
|
||||
* units: int
|
||||
* }>
|
||||
* } $attributes The order data:
|
||||
* - country_iso: ISO 3166-1 alpha-2 country code
|
||||
* - items: Array of order items (each with type, name, price, unit, units, and quantity)
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function createOrderPreview(array $attributes = []): Result
|
||||
{
|
||||
return $this->post('v1/orders/preview', $attributes);
|
||||
}
|
||||
}
|
||||
29
src/Id/Concerns/ManagesProfile.php
Normal file
29
src/Id/Concerns/ManagesProfile.php
Normal file
@@ -0,0 +1,29 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Concerns;
|
||||
|
||||
use Anikeen\Id\ApiOperations\Request;
|
||||
use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
|
||||
use Anikeen\Id\Result;
|
||||
use Throwable;
|
||||
|
||||
trait ManagesProfile
|
||||
{
|
||||
use Request;
|
||||
|
||||
/**
|
||||
* Get the profile url for the current user.
|
||||
*
|
||||
* @param string|null $returnUrl The URL to redirect to after the user has completed their profile.
|
||||
* @param array $options Additional options for the profile URL.
|
||||
* @return string
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function profilePortalUrl(?string $returnUrl = null, array $options = []): string
|
||||
{
|
||||
return $this->request('POST', 'v1/user/profile', [
|
||||
'return_url' => $returnUrl,
|
||||
'options' => $options,
|
||||
])->data->url;
|
||||
}
|
||||
}
|
||||
29
src/Id/Concerns/ManagesSshKeys.php
Normal file
29
src/Id/Concerns/ManagesSshKeys.php
Normal file
@@ -0,0 +1,29 @@
|
||||
<?php
|
||||
|
||||
|
||||
namespace Anikeen\Id\Concerns;
|
||||
|
||||
use Anikeen\Id\ApiOperations\Get;
|
||||
use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
|
||||
use Anikeen\Id\Resources\SshKeys;
|
||||
use Throwable;
|
||||
|
||||
trait ManagesSshKeys
|
||||
{
|
||||
use Get;
|
||||
|
||||
/**
|
||||
* Get currently authed user with Bearer Token.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function sshKeysByUserId(string $sskKeyId): SshKeys
|
||||
{
|
||||
if (!isset($this->sshKeysCache)) {
|
||||
$this->sshKeysCache = SshKeys::builder(fn() => $this->get(sprintf('v1/users/%s/ssh-keys/json', $sskKeyId)))
|
||||
->setParent($this);
|
||||
}
|
||||
|
||||
return $this->sshKeysCache;
|
||||
}
|
||||
}
|
||||
28
src/Id/Concerns/ManagesSubscriptions.php
Normal file
28
src/Id/Concerns/ManagesSubscriptions.php
Normal file
@@ -0,0 +1,28 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Concerns;
|
||||
|
||||
use Anikeen\Id\ApiOperations\Request;
|
||||
use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
|
||||
use Anikeen\Id\Resources\Subscriptions;
|
||||
use Throwable;
|
||||
|
||||
trait ManagesSubscriptions
|
||||
{
|
||||
use Request;
|
||||
|
||||
/**
|
||||
* Get subscriptions from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function subscriptions(): Subscriptions
|
||||
{
|
||||
if (!isset($this->subscriptionsCache)) {
|
||||
$this->subscriptionsCache = Subscriptions::builder(fn() => $this->request('GET', 'v1/subscriptions'))
|
||||
->setBillable($this);
|
||||
}
|
||||
|
||||
return $this->subscriptionsCache;
|
||||
}
|
||||
}
|
||||
22
src/Id/Concerns/ManagesTaxation.php
Normal file
22
src/Id/Concerns/ManagesTaxation.php
Normal file
@@ -0,0 +1,22 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Concerns;
|
||||
|
||||
use Anikeen\Id\ApiOperations\Request;
|
||||
use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
|
||||
use Throwable;
|
||||
|
||||
trait ManagesTaxation
|
||||
{
|
||||
use Request;
|
||||
|
||||
/**
|
||||
* Get VAT for the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function vatRate(): float
|
||||
{
|
||||
return $this->getUserData()->vat_rate;
|
||||
}
|
||||
}
|
||||
29
src/Id/Concerns/ManagesTransactions.php
Normal file
29
src/Id/Concerns/ManagesTransactions.php
Normal file
@@ -0,0 +1,29 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Concerns;
|
||||
|
||||
use Anikeen\Id\ApiOperations\Request;
|
||||
use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
|
||||
use Anikeen\Id\Resources\Transactions;
|
||||
use Anikeen\Id\Result;
|
||||
use Throwable;
|
||||
|
||||
trait ManagesTransactions
|
||||
{
|
||||
use Request;
|
||||
|
||||
/**
|
||||
* Get transactions from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function transactions(): Transactions
|
||||
{
|
||||
if (!isset($this->transactionsCache)) {
|
||||
$this->transactionsCache = Transactions::builder(fn() => $this->request('GET', 'v1/transactions'))
|
||||
->setBillable($this);
|
||||
}
|
||||
|
||||
return $this->transactionsCache;
|
||||
}
|
||||
}
|
||||
75
src/Id/Concerns/ManagesUsers.php
Normal file
75
src/Id/Concerns/ManagesUsers.php
Normal file
@@ -0,0 +1,75 @@
|
||||
<?php
|
||||
|
||||
|
||||
namespace Anikeen\Id\Concerns;
|
||||
|
||||
use Anikeen\Id\ApiOperations\Get;
|
||||
use Anikeen\Id\ApiOperations\Post;
|
||||
use Anikeen\Id\Exceptions\RequestRequiresClientIdException;
|
||||
use Anikeen\Id\Result;
|
||||
use Throwable;
|
||||
|
||||
trait ManagesUsers
|
||||
{
|
||||
use Get, Post;
|
||||
use HasParent;
|
||||
|
||||
/**
|
||||
* Get currently authed user with Bearer Token
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function getAuthedUser(): Result
|
||||
{
|
||||
return $this->get('v1/user');
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new user on behalf of the current user.
|
||||
*
|
||||
* @param array{
|
||||
* first_name: null|string,
|
||||
* last_name: null|string,
|
||||
* username: null|string,
|
||||
* email: string,
|
||||
* password: null|string
|
||||
* } $attributes The user data
|
||||
* - first_name: The first name (optional)
|
||||
* - last_name: The last name (optional)
|
||||
* - username: The username (optional)
|
||||
* - email: The email (required)
|
||||
* - password: The password (optional, can be reset by the user if not provided)
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function createUser(array $attributes): Result
|
||||
{
|
||||
return $this->post('v1/users', $attributes);
|
||||
}
|
||||
|
||||
/**
|
||||
* Refreshes the access token using the refresh token.
|
||||
*/
|
||||
public function refreshToken(string $storedRefreshToken, string $scope = ''): Result
|
||||
{
|
||||
return $this->post('../oauth/token', [
|
||||
'grant_type' => 'refresh_token',
|
||||
'refresh_token' => $storedRefreshToken,
|
||||
'client_id' => $this->clientId,
|
||||
'client_secret' => $this->clientSecret,
|
||||
'scope' => $scope,
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the given email exists.
|
||||
*
|
||||
* @param string $email The email to check.
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function isEmailExisting(string $email): Result
|
||||
{
|
||||
return $this->post('v1/users/check', [
|
||||
'email' => $email,
|
||||
]);
|
||||
}
|
||||
}
|
||||
@@ -6,11 +6,35 @@ class Scope
|
||||
{
|
||||
const USER = 'user';
|
||||
const USER_READ = 'user:read';
|
||||
const ORDERS = 'orders';
|
||||
const ORDERS_READ = 'orders:read';
|
||||
const PRODUCTS = 'products';
|
||||
const PRODUCTS_READ = 'products:read';
|
||||
|
||||
const ADDRESSES = 'addresses';
|
||||
const ADDRESSES_READ = 'addresses:read';
|
||||
|
||||
const BILLING = 'billing';
|
||||
const BILLING_READ = 'billing:read';
|
||||
const BILLING_CLIENT = 'billing:client';
|
||||
|
||||
const INVOICES = 'invoices';
|
||||
const INVOICES_READ = 'invoices:read';
|
||||
const INVOICES_CLIENT = 'invoices:client';
|
||||
|
||||
const ORDERS = 'orders';
|
||||
const ORDERS_READ = 'orders:read';
|
||||
const ORDERS_CLIENT = 'orders:client';
|
||||
|
||||
const PAYMENT_METHODS = 'payment-methods';
|
||||
const PAYMENT_METHODS_READ = 'payment-methods:read';
|
||||
|
||||
const SUBSCRIPTIONS = 'subscriptions';
|
||||
const SUBSCRIPTIONS_READ = 'subscriptions:read';
|
||||
const SUBSCRIPTIONS_CLIENT = 'subscriptions:client';
|
||||
|
||||
const TRANSACTIONS = 'transactions';
|
||||
const TRANSACTIONS_READ = 'transactions:read';
|
||||
const TRANSACTIONS_CLIENT = 'transactions:client';
|
||||
|
||||
const SSH_KEYS = 'ssh-keys';
|
||||
const SSH_KEYS_READ = 'ssh-keys:read';
|
||||
|
||||
const ADMIN = 'admin';
|
||||
}
|
||||
|
||||
11
src/Id/Exceptions/CollectionException.php
Normal file
11
src/Id/Exceptions/CollectionException.php
Normal file
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Exceptions;
|
||||
|
||||
use Anikeen\Id\Result;
|
||||
use Exception;
|
||||
|
||||
class CollectionException extends Exception
|
||||
{
|
||||
|
||||
}
|
||||
11
src/Id/Exceptions/ResourceException.php
Normal file
11
src/Id/Exceptions/ResourceException.php
Normal file
@@ -0,0 +1,11 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Exceptions;
|
||||
|
||||
use Anikeen\Id\Result;
|
||||
use Exception;
|
||||
|
||||
class ResourceException extends Exception
|
||||
{
|
||||
//
|
||||
}
|
||||
@@ -1,6 +1,6 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Traits;
|
||||
namespace Anikeen\Id;
|
||||
|
||||
use stdClass;
|
||||
|
||||
@@ -9,7 +9,7 @@ trait HasAnikeenTokens
|
||||
/**
|
||||
* The current access token for the authentication user.
|
||||
*/
|
||||
protected ?stdClass $accessToken;
|
||||
protected ?stdClass $accessToken = null;
|
||||
|
||||
/**
|
||||
* Get the current access token being used by the user.
|
||||
@@ -2,6 +2,7 @@
|
||||
|
||||
namespace Anikeen\Id\Helpers;
|
||||
|
||||
use Anikeen\Id\AnikeenId;
|
||||
use Firebase\JWT\JWT;
|
||||
use Firebase\JWT\Key;
|
||||
use Illuminate\Auth\AuthenticationException;
|
||||
@@ -30,6 +31,8 @@ class JwtParser
|
||||
|
||||
private function getOauthPublicKey(): bool|string
|
||||
{
|
||||
return file_get_contents(dirname(__DIR__, 3) . '/oauth-public.key');
|
||||
return AnikeenId::getMode() === 'staging'
|
||||
? file_get_contents(dirname(__DIR__, 3) . '/oauth-public.staging.key')
|
||||
: file_get_contents(dirname(__DIR__, 3) . '/oauth-public.key');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -7,70 +7,120 @@ use stdClass;
|
||||
|
||||
class Paginator
|
||||
{
|
||||
|
||||
/**
|
||||
* Next desired action (first, after, before).
|
||||
* Next desired action: 'first', 'after', 'before'.
|
||||
*
|
||||
* @var string|null
|
||||
*/
|
||||
public ?string $action = null;
|
||||
|
||||
/**
|
||||
* AnikeenId response pagination cursor.
|
||||
* Raw pagination links from API ('first','last','prev','next').
|
||||
*
|
||||
* @var stdClass|null
|
||||
*/
|
||||
private ?stdClass $pagination;
|
||||
private ?stdClass $links;
|
||||
|
||||
/**
|
||||
* Raw pagination meta from API (current_page, last_page, etc.).
|
||||
*
|
||||
* @var stdClass|null
|
||||
*/
|
||||
private ?stdClass $meta;
|
||||
|
||||
/**
|
||||
* Constructor.
|
||||
*
|
||||
* @param null|stdClass $pagination AnikeenId response pagination cursor
|
||||
* @param stdClass|null $links Pagination links object
|
||||
* @param stdClass|null $meta Pagination meta object
|
||||
*/
|
||||
public function __construct(?stdClass $pagination = null)
|
||||
public function __construct(?stdClass $links = null, ?stdClass $meta = null)
|
||||
{
|
||||
$this->pagination = $pagination;
|
||||
$this->links = $links;
|
||||
$this->meta = $meta;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create Paginator from Result object.
|
||||
* Create Paginator from a Result instance.
|
||||
*/
|
||||
public static function from(Result $result): self
|
||||
{
|
||||
return new self($result->pagination);
|
||||
return new self($result->links, $result->meta);
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the current active cursor.
|
||||
* Return the cursor value (page number) based on the last set action.
|
||||
*/
|
||||
public function cursor(): string
|
||||
{
|
||||
return $this->pagination->cursor;
|
||||
switch ($this->action) {
|
||||
case 'first':
|
||||
return '1';
|
||||
|
||||
case 'after':
|
||||
// Try parsing from 'next' link
|
||||
if ($this->links && !empty($this->links->next)) {
|
||||
return $this->parsePageFromUrl($this->links->next);
|
||||
}
|
||||
// Fallback to current_page + 1
|
||||
return isset($this->meta->current_page)
|
||||
? (string)($this->meta->current_page + 1)
|
||||
: '1';
|
||||
|
||||
case 'before':
|
||||
if ($this->links && !empty($this->links->prev)) {
|
||||
return $this->parsePageFromUrl($this->links->prev);
|
||||
}
|
||||
// Fallback to current_page - 1
|
||||
return isset($this->meta->current_page)
|
||||
? (string)($this->meta->current_page - 1)
|
||||
: '1';
|
||||
|
||||
default:
|
||||
// Default to current page
|
||||
return isset($this->meta->current_page)
|
||||
? (string)$this->meta->current_page
|
||||
: '1';
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the Paginator to fetch the next set of results.
|
||||
* Parse the 'page' query parameter from a URL.
|
||||
*/
|
||||
private function parsePageFromUrl(string $url): string
|
||||
{
|
||||
$parts = parse_url($url);
|
||||
if (empty($parts['query'])) {
|
||||
return '1';
|
||||
}
|
||||
parse_str($parts['query'], $vars);
|
||||
return $vars['page'] ?? '1';
|
||||
}
|
||||
|
||||
/**
|
||||
* Fetch the first page.
|
||||
*/
|
||||
public function first(): self
|
||||
{
|
||||
$this->action = 'first';
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the Paginator to fetch the first set of results.
|
||||
* Fetch the next page (after).
|
||||
*/
|
||||
public function next(): self
|
||||
{
|
||||
$this->action = 'after';
|
||||
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the Paginator to fetch the last set of results.
|
||||
* Fetch the previous page (before).
|
||||
*/
|
||||
public function back(): self
|
||||
{
|
||||
$this->action = 'before';
|
||||
|
||||
return $this;
|
||||
}
|
||||
}
|
||||
@@ -2,35 +2,62 @@
|
||||
|
||||
namespace Anikeen\Id\Http\Middleware;
|
||||
|
||||
use Anikeen\Id\AnikeenId;
|
||||
use Anikeen\Id\ApiTokenCookieFactory;
|
||||
use Anikeen\Id\Facades\AnikeenId;
|
||||
use Closure;
|
||||
use Illuminate\Http\JsonResponse;
|
||||
use Illuminate\Http\Request;
|
||||
use Illuminate\Http\Response;
|
||||
|
||||
class CreateFreshApiToken
|
||||
{
|
||||
/**
|
||||
* The API token cookie factory instance.
|
||||
*
|
||||
* @var ApiTokenCookieFactory
|
||||
*/
|
||||
protected $cookieFactory;
|
||||
|
||||
/**
|
||||
* The authentication guard.
|
||||
*
|
||||
* @var string
|
||||
*/
|
||||
protected string $guard;
|
||||
protected $guard;
|
||||
|
||||
/**
|
||||
* Create a new middleware instance.
|
||||
*
|
||||
* @param ApiTokenCookieFactory $cookieFactory
|
||||
* @return void
|
||||
*/
|
||||
public function __construct(protected ApiTokenCookieFactory $cookieFactory)
|
||||
public function __construct(ApiTokenCookieFactory $cookieFactory)
|
||||
{
|
||||
//
|
||||
$this->cookieFactory = $cookieFactory;
|
||||
}
|
||||
|
||||
/**
|
||||
* Specify the guard for the middleware.
|
||||
*
|
||||
* @param string|null $guard
|
||||
* @return string
|
||||
*/
|
||||
public static function using($guard = null)
|
||||
{
|
||||
$guard = is_null($guard) ? '' : ':' . $guard;
|
||||
|
||||
return static::class . $guard;
|
||||
}
|
||||
|
||||
/**
|
||||
* Handle an incoming request.
|
||||
*
|
||||
* @param Request $request
|
||||
* @param Closure $next
|
||||
* @param string|null $guard
|
||||
* @return mixed
|
||||
*/
|
||||
public function handle(Request $request, Closure $next, string $guard = null): mixed
|
||||
public function handle($request, Closure $next, $guard = null)
|
||||
{
|
||||
$this->guard = $guard;
|
||||
|
||||
@@ -47,8 +74,12 @@ class CreateFreshApiToken
|
||||
|
||||
/**
|
||||
* Determine if the given request should receive a fresh token.
|
||||
*
|
||||
* @param Request $request
|
||||
* @param Response $response
|
||||
* @return bool
|
||||
*/
|
||||
protected function shouldReceiveFreshToken(Request $request, Response $response): bool
|
||||
protected function shouldReceiveFreshToken($request, $response)
|
||||
{
|
||||
return $this->requestShouldReceiveFreshToken($request) &&
|
||||
$this->responseShouldReceiveFreshToken($response);
|
||||
@@ -56,25 +87,37 @@ class CreateFreshApiToken
|
||||
|
||||
/**
|
||||
* Determine if the request should receive a fresh token.
|
||||
*
|
||||
* @param Request $request
|
||||
* @return bool
|
||||
*/
|
||||
protected function requestShouldReceiveFreshToken(Request $request): bool
|
||||
protected function requestShouldReceiveFreshToken($request)
|
||||
{
|
||||
return $request->isMethod('GET') && $request->user($this->guard);
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine if the response should receive a fresh token.
|
||||
*
|
||||
* @param Response $response
|
||||
* @return bool
|
||||
*/
|
||||
protected function responseShouldReceiveFreshToken(Response $response): bool
|
||||
protected function responseShouldReceiveFreshToken($response)
|
||||
{
|
||||
return !$this->alreadyContainsToken($response);
|
||||
return ($response instanceof Response ||
|
||||
$response instanceof JsonResponse) &&
|
||||
!$this->alreadyContainsToken($response);
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine if the given response already contains an API token.
|
||||
*
|
||||
* This avoids us overwriting a just "refreshed" token.
|
||||
*
|
||||
* @param Response $response
|
||||
* @return bool
|
||||
*/
|
||||
protected function alreadyContainsToken(Response $response): bool
|
||||
protected function alreadyContainsToken($response)
|
||||
{
|
||||
foreach ($response->headers->getCookies() as $cookie) {
|
||||
if ($cookie->getName() === AnikeenId::cookie()) {
|
||||
@@ -84,4 +127,4 @@ class CreateFreshApiToken
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,9 +1,8 @@
|
||||
<?php
|
||||
|
||||
|
||||
namespace Anikeen\Id\Traits;
|
||||
namespace Anikeen\Id;
|
||||
|
||||
use Anikeen\Id\Result;
|
||||
use GuzzleHttp\Exception\RequestException;
|
||||
|
||||
|
||||
@@ -21,9 +21,7 @@ class AnikeenIdServiceProvider extends ServiceProvider
|
||||
*/
|
||||
public function boot()
|
||||
{
|
||||
$this->publishes([
|
||||
dirname(__DIR__, 3) . '/config/anikeen-id.php' => config_path('anikeen-id.php'),
|
||||
], 'config');
|
||||
//
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -31,7 +29,6 @@ class AnikeenIdServiceProvider extends ServiceProvider
|
||||
*/
|
||||
public function register(): void
|
||||
{
|
||||
$this->mergeConfigFrom(dirname(__DIR__, 3) . '/config/anikeen-id.php', 'anikeen-id');
|
||||
$this->app->singleton(Contracts\AppTokenRepository::class, Repository\AppTokenRepository::class);
|
||||
$this->app->singleton(AnikeenId::class, function () {
|
||||
return new AnikeenId;
|
||||
@@ -46,7 +43,7 @@ class AnikeenIdServiceProvider extends ServiceProvider
|
||||
protected function registerGuard(): void
|
||||
{
|
||||
Auth::resolved(function ($auth) {
|
||||
$auth->extend('anikeen-id', function ($app, $name, array $config) {
|
||||
$auth->extend('anikeen', function ($app, $name, array $config) {
|
||||
return tap($this->makeGuard($config), function ($guard) {
|
||||
$this->app->refresh('request', $guard, 'setRequest');
|
||||
});
|
||||
|
||||
@@ -1,117 +0,0 @@
|
||||
<?php
|
||||
|
||||
|
||||
namespace Anikeen\Id\Providers;
|
||||
|
||||
use Anikeen\Id\AnikeenId;
|
||||
use Illuminate\Contracts\Auth\Authenticatable;
|
||||
use Illuminate\Contracts\Auth\UserProvider;
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Http\Request;
|
||||
use Illuminate\Support\Arr;
|
||||
|
||||
class AnikeenIdSsoUserProvider implements UserProvider
|
||||
{
|
||||
private AnikeenId $anikeenId;
|
||||
private ?string $accessTokenField = null;
|
||||
private array $fields;
|
||||
private string $model;
|
||||
private Request $request;
|
||||
|
||||
public function __construct(
|
||||
AnikeenId $anikeenId,
|
||||
Request $request,
|
||||
string $model,
|
||||
array $fields,
|
||||
?string $accessTokenField = null
|
||||
)
|
||||
{
|
||||
$this->request = $request;
|
||||
$this->model = $model;
|
||||
$this->fields = $fields;
|
||||
$this->accessTokenField = $accessTokenField;
|
||||
$this->anikeenId = $anikeenId;
|
||||
}
|
||||
|
||||
public function retrieveById(mixed $identifier): Builder|Model|null
|
||||
{
|
||||
$model = $this->createModel();
|
||||
$token = $this->request->bearerToken();
|
||||
|
||||
$user = $this->newModelQuery($model)
|
||||
->where($model->getAuthIdentifierName(), $identifier)
|
||||
->first();
|
||||
|
||||
// Return user when found
|
||||
if ($user) {
|
||||
// Update access token when updated
|
||||
if ($this->accessTokenField) {
|
||||
$user[$this->accessTokenField] = $token;
|
||||
|
||||
if ($user->isDirty()) {
|
||||
$user->save();
|
||||
}
|
||||
}
|
||||
|
||||
return $user;
|
||||
}
|
||||
|
||||
// Create new user
|
||||
$this->anikeenId->setToken($token);
|
||||
$result = $this->anikeenId->getAuthedUser();
|
||||
|
||||
if (!$result->success()) {
|
||||
return null;
|
||||
}
|
||||
|
||||
$attributes = Arr::only((array)$result->data(), $this->fields);
|
||||
$attributes[$model->getAuthIdentifierName()] = $result->data->id;
|
||||
|
||||
if ($this->accessTokenField) {
|
||||
$attributes[$this->accessTokenField] = $token;
|
||||
}
|
||||
|
||||
return $this->newModelQuery($model)->create($attributes);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a new instance of the model.
|
||||
*/
|
||||
public function createModel(): Model
|
||||
{
|
||||
$class = '\\' . ltrim($this->model, '\\');
|
||||
|
||||
return new $class;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get a new query builder for the model instance.
|
||||
*/
|
||||
protected function newModelQuery(?Model $model = null): Builder
|
||||
{
|
||||
return is_null($model)
|
||||
? $this->createModel()->newQuery()
|
||||
: $model->newQuery();
|
||||
}
|
||||
|
||||
public function retrieveByToken($identifier, $token)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
public function updateRememberToken(Authenticatable $user, $token)
|
||||
{
|
||||
// void
|
||||
}
|
||||
|
||||
public function retrieveByCredentials(array $credentials)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
public function validateCredentials(Authenticatable $user, array $credentials): bool
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
124
src/Id/Providers/AnikeenIdUserProvider.php
Normal file
124
src/Id/Providers/AnikeenIdUserProvider.php
Normal file
@@ -0,0 +1,124 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Providers;
|
||||
|
||||
use Anikeen\Id\AnikeenId;
|
||||
use Illuminate\Contracts\Auth\Authenticatable;
|
||||
use Illuminate\Contracts\Auth\UserProvider;
|
||||
use Illuminate\Database\Eloquent\Builder;
|
||||
use Illuminate\Database\Eloquent\Model;
|
||||
use Illuminate\Http\Request;
|
||||
use Illuminate\Support\Arr;
|
||||
|
||||
class AnikeenIdUserProvider implements UserProvider
|
||||
{
|
||||
private ?string $accessTokenField;
|
||||
|
||||
public function __construct(
|
||||
private AnikeenId $anikeenId,
|
||||
private Request $request,
|
||||
private string $model,
|
||||
private array $fields = []
|
||||
) {
|
||||
$this->accessTokenField = AnikeenId::getAccessTokenField();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function retrieveByToken($identifier, $token): ?Authenticatable
|
||||
{
|
||||
// Token from request (if not already pass from $token):
|
||||
$token = $token ?: $this->request->bearerToken();
|
||||
if (! $token) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// Set token in SSO client and request user info
|
||||
$this->anikeenId->setToken($token);
|
||||
$result = $this->anikeenId->getAuthedUser();
|
||||
if (! $result->success()) {
|
||||
return null;
|
||||
}
|
||||
|
||||
// Only the desired fields
|
||||
$data = Arr::only((array)$result->data(), $this->fields);
|
||||
// Primary key (e.g. $user->id)
|
||||
$pk = $this->createModel()->getAuthIdentifierName();
|
||||
$data[$pk] = $result->data->id;
|
||||
|
||||
// Fill in access token field, if available
|
||||
if ($this->accessTokenField) {
|
||||
$data[$this->accessTokenField] = $token;
|
||||
}
|
||||
|
||||
// Local eloquent model: either find or create a new one
|
||||
/** @var Model $modelInstance */
|
||||
$modelInstance = $this->newModelQuery()
|
||||
->firstOrNew([$pk => $data[$pk]]);
|
||||
|
||||
$modelInstance->fill($data);
|
||||
$modelInstance->save();
|
||||
|
||||
return $modelInstance;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function updateRememberToken(Authenticatable $user, $token): void
|
||||
{
|
||||
// no-op
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function retrieveByCredentials(array $credentials): ?Authenticatable
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function validateCredentials(Authenticatable $user, array $credentials): bool
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function retrieveById($identifier): ?Authenticatable
|
||||
{
|
||||
return $this->newModelQuery()
|
||||
->where($this->createModel()->getAuthIdentifierName(), $identifier)
|
||||
->first();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function rehashPasswordIfRequired(Authenticatable $user, #[\SensitiveParameter] array $credentials, bool $force = false): void
|
||||
{
|
||||
// no-op
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Model
|
||||
*/
|
||||
protected function createModel(): Model
|
||||
{
|
||||
$class = '\\' . ltrim($this->model, '\\');
|
||||
return new $class;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return Builder
|
||||
*/
|
||||
protected function newModelQuery(): Builder
|
||||
{
|
||||
return $this->createModel()->newQuery();
|
||||
}
|
||||
}
|
||||
81
src/Id/Resources/Address.php
Normal file
81
src/Id/Resources/Address.php
Normal file
@@ -0,0 +1,81 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\Concerns\HasBillable;
|
||||
use Throwable;
|
||||
|
||||
/**
|
||||
* @property string $id
|
||||
* @property null|string $company_name
|
||||
* @property null|string $first_name
|
||||
* @property null|string $last_name
|
||||
* @property null|string $address_2
|
||||
* @property null|string $address
|
||||
* @property null|string $house_number
|
||||
* @property null|string $postal_code
|
||||
* @property null|string $city
|
||||
* @property null|string $state
|
||||
* @property string $country_iso
|
||||
* @property null|string $phone_number
|
||||
* @property null|string $email
|
||||
* @property bool $primary
|
||||
* @property bool $primary_billing_address
|
||||
*/
|
||||
class Address extends BaseResource
|
||||
{
|
||||
use HasBillable;
|
||||
|
||||
/**
|
||||
* Update given address from the current user.
|
||||
*
|
||||
* VAT is calculated based on the billing address and shown in the address response.
|
||||
*
|
||||
* @param array{
|
||||
* company_name: null|string,
|
||||
* first_name: string,
|
||||
* last_name: string,
|
||||
* address_2: null|string,
|
||||
* address: string,
|
||||
* house_number: null|string,
|
||||
* postal_code: string,
|
||||
* city: string,
|
||||
* state: null|string,
|
||||
* country_iso: string,
|
||||
* phone_number: null|string,
|
||||
* email: null|string,
|
||||
* primary: bool,
|
||||
* primary_billing_address: bool
|
||||
* } $attributes The address data:
|
||||
* - company_name: Company name (optional)
|
||||
* - first_name: First name (required when set)
|
||||
* - last_name: Last name (required when set)
|
||||
* - address: Address line 1 (e.g. street address, P.O. Box, etc.)
|
||||
* - address_2: Address line 2 (optional, e.g. apartment number, c/o, etc.)
|
||||
* - house_number: House number (optional)
|
||||
* - postal_code: Postal code (required when set)
|
||||
* - city: City (required when set)
|
||||
* - state: State (optional, e.g. province, region, etc.)
|
||||
* - country_iso: Country ISO code (required when set, e.g. US, CA, etc.)
|
||||
* - phone_number: Phone number (optional)
|
||||
* - email: Email address (optional, e.g. for delivery notifications)
|
||||
* - primary: Whether this address should be the primary address (optional)
|
||||
* - primary_billing_address: Whether this address should be the primary billing address (optional)
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function update(array $attributes = []): self
|
||||
{
|
||||
return (new self(fn() => $this->billable->request('PUT', sprintf('v1/addresses/%s', $this->id), $attributes)))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete given address from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function delete(): bool
|
||||
{
|
||||
return $this->billable->request('DELETE', sprintf('v1/addresses/%s', $this->id))->success();
|
||||
}
|
||||
}
|
||||
82
src/Id/Resources/Addresses.php
Normal file
82
src/Id/Resources/Addresses.php
Normal file
@@ -0,0 +1,82 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\Concerns\HasBillable;
|
||||
use Throwable;
|
||||
|
||||
class Addresses extends BaseCollection
|
||||
{
|
||||
use HasBillable;
|
||||
|
||||
/**
|
||||
* Creates a new address for the current user.
|
||||
*
|
||||
* @param array{
|
||||
* company_name: null|string,
|
||||
* first_name: string,
|
||||
* last_name: string,
|
||||
* address: string,
|
||||
* address_2: null|string,
|
||||
* house_number: null|string,
|
||||
* postal_code: string,
|
||||
* city: string,
|
||||
* state: null|string,
|
||||
* country_iso: string,
|
||||
* phone_number: null|string,
|
||||
* email: null|string,
|
||||
* primary: bool,
|
||||
* primary_billing_address: bool
|
||||
* } $attributes The address data:
|
||||
* - company_name: Company name (optional)
|
||||
* - first_name: First name
|
||||
* - last_name: Last name
|
||||
* - address: Address line 1 (e.g. street address, P.O. Box, etc.)
|
||||
* - address_2: Address line 2 (optional, e.g. apartment number, c/o, etc.)
|
||||
* - house_number: House number (optional)
|
||||
* - postal_code: Postal code
|
||||
* - city: City
|
||||
* - state: State (optional, e.g. province, region, etc.)
|
||||
* - country_iso: Country ISO code (e.g. US, CA, etc.)
|
||||
* - phone_number: Phone number (optional)
|
||||
* - email: Email address (optional, e.g. for delivery notifications)
|
||||
* - primary: Whether this address should be the primary address (optional)
|
||||
* - primary_billing_address: Whether this address should be the primary billing address (optional)
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function create(array $attributes = []): Address
|
||||
{
|
||||
return (new Address(fn() => $this->billable->request('POST', 'v1/addresses', $attributes)))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function find(string $id): ?Address
|
||||
{
|
||||
return (new Address(fn() => $this->billable->request('GET', sprintf('v1/addresses/%s', $id))))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get default address from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function defaultBillingAddress(): Address
|
||||
{
|
||||
return (new Address(fn() => $this->billable->request('GET', sprintf('v1/addresses/%s', $this->billable->getUserData()->billing_address_id))))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the current user has a default billing address.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function hasDefaultBillingAddress(): bool
|
||||
{
|
||||
return $this->billable->getUserData()->billing_address_id !== null;
|
||||
}
|
||||
}
|
||||
91
src/Id/Resources/BaseCollection.php
Normal file
91
src/Id/Resources/BaseCollection.php
Normal file
@@ -0,0 +1,91 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\AnikeenId;
|
||||
use Anikeen\Id\Exceptions\CollectionException;
|
||||
use Anikeen\Id\Exceptions\ResourceException;
|
||||
use Anikeen\Id\Helpers\Paginator;
|
||||
use Anikeen\Id\Result;
|
||||
use Closure;
|
||||
use GuzzleHttp\Psr7\Response;
|
||||
use JsonSerializable;
|
||||
use Throwable;
|
||||
|
||||
/**
|
||||
* @property bool $success
|
||||
* @property mixed $data
|
||||
* @property int $total
|
||||
* @property int $status
|
||||
* @property null|array $links
|
||||
* @property null|array $meta
|
||||
* @property null|Paginator $paginator
|
||||
* @property AnikeenId $anikeenId
|
||||
* @property Response $response
|
||||
* @property null|Throwable $exception
|
||||
*/
|
||||
#[\AllowDynamicProperties]
|
||||
abstract class BaseCollection implements JsonSerializable
|
||||
{
|
||||
private Closure $callable;
|
||||
public ?Result $result = null;
|
||||
|
||||
/**
|
||||
* @throws CollectionException
|
||||
*/
|
||||
protected function __construct(callable $callable)
|
||||
{
|
||||
$this->result = $callable();
|
||||
|
||||
if (!$this->result->success()) {
|
||||
throw new CollectionException(sprintf('%s for collection [%s]', rtrim($this->result->data->message, '.'), get_called_class()), $this->result->response->getStatusCode());
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @throws CollectionException
|
||||
*/
|
||||
public static function builder(callable $callable): static
|
||||
{
|
||||
return new static($callable, false);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the collection of resources as an array.
|
||||
*/
|
||||
public function toArray(): array
|
||||
{
|
||||
return (array)$this->result->data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the collection of resources as a JSON string.
|
||||
*/
|
||||
public function jsonSerialize(): array
|
||||
{
|
||||
return $this->toArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the collection of resources.
|
||||
*/
|
||||
public function paginate(): Result
|
||||
{
|
||||
return $this->result;
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the Resource based on the ID.
|
||||
*/
|
||||
abstract public function find(string $id): ?BaseResource;
|
||||
|
||||
public function __get(string $name)
|
||||
{
|
||||
return $this->result->{$name} ?? null;
|
||||
}
|
||||
|
||||
public function __isset(string $name): bool
|
||||
{
|
||||
return isset($this->result->{$name});
|
||||
}
|
||||
}
|
||||
57
src/Id/Resources/BaseResource.php
Normal file
57
src/Id/Resources/BaseResource.php
Normal file
@@ -0,0 +1,57 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\Exceptions\ResourceException;
|
||||
use Anikeen\Id\Result;
|
||||
use JsonSerializable;
|
||||
|
||||
#[\AllowDynamicProperties]
|
||||
abstract class BaseResource implements JsonSerializable
|
||||
{
|
||||
public Result $result;
|
||||
|
||||
/**
|
||||
* @throws ResourceException
|
||||
*/
|
||||
public function __construct(callable $callable)
|
||||
{
|
||||
$this->result = $callable();
|
||||
|
||||
if (!$this->result->success()) {
|
||||
throw new ResourceException(sprintf('%s for resource [%s]', rtrim($this->result->data->message, '.'), get_called_class()), $this->result->response->getStatusCode());
|
||||
}
|
||||
|
||||
foreach ($this->result->data as $key => $value) {
|
||||
if (!property_exists($this, $key)) {
|
||||
$this->{$key} = $value;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the collection of resources as a JSON string.
|
||||
*/
|
||||
public function jsonSerialize(): array
|
||||
{
|
||||
return $this->toArray();
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the collection of resources as an array.
|
||||
*/
|
||||
public function toArray(): array
|
||||
{
|
||||
return (array)$this->result->data;
|
||||
}
|
||||
|
||||
public function __get(string $name)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
public function __isset(string $name): bool
|
||||
{
|
||||
return false;
|
||||
}
|
||||
}
|
||||
18
src/Id/Resources/Countries.php
Normal file
18
src/Id/Resources/Countries.php
Normal file
@@ -0,0 +1,18 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\Concerns\HasBillable;
|
||||
|
||||
class Countries extends BaseCollection
|
||||
{
|
||||
use HasBillable;
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function find(string $id): ?BaseResource
|
||||
{
|
||||
return null;
|
||||
}
|
||||
}
|
||||
24
src/Id/Resources/Invoice.php
Normal file
24
src/Id/Resources/Invoice.php
Normal file
@@ -0,0 +1,24 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\Concerns\HasBillable;
|
||||
use Throwable;
|
||||
|
||||
/**
|
||||
* @property string $id
|
||||
*/
|
||||
class Invoice extends BaseResource
|
||||
{
|
||||
use HasBillable;
|
||||
|
||||
/**
|
||||
* Get temporary download url from given invoice.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function getInvoiceTemporaryUrl(): string
|
||||
{
|
||||
return $this->billable->request('PUT', sprintf('v1/invoices/%s', $this->id))->data->temporary_url;
|
||||
}
|
||||
}
|
||||
19
src/Id/Resources/Invoices.php
Normal file
19
src/Id/Resources/Invoices.php
Normal file
@@ -0,0 +1,19 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\Concerns\HasBillable;
|
||||
|
||||
class Invoices extends BaseCollection
|
||||
{
|
||||
use HasBillable;
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function find(string $id): ?Invoice
|
||||
{
|
||||
return (new Invoice(fn() => $this->billable->request('GET', sprintf('v1/invoices/%s', $id))))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
}
|
||||
108
src/Id/Resources/Order.php
Normal file
108
src/Id/Resources/Order.php
Normal file
@@ -0,0 +1,108 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\Concerns\HasBillable;
|
||||
use Throwable;
|
||||
|
||||
/**
|
||||
* @property string $id
|
||||
*/
|
||||
class Order extends BaseResource
|
||||
{
|
||||
use HasBillable;
|
||||
|
||||
/**
|
||||
* Update given order from the current user.
|
||||
*
|
||||
* VAT is calculated based on the billing address and shown in the order response.
|
||||
*
|
||||
* The billing and shipping addresses are each persisted as standalone Address entities
|
||||
* in the database, but are also embedded (deep-copied) into the Order object itself
|
||||
* rather than merely referenced. This guarantees that the order retains its own snapshot
|
||||
* of both addresses for future reference.
|
||||
*
|
||||
* @param array{
|
||||
* billing_address: array{
|
||||
* company_name: null|string,
|
||||
* first_name: null|string,
|
||||
* last_name: null|string,
|
||||
* address: null|string,
|
||||
* address_2: null|string,
|
||||
* house_number: null|string,
|
||||
* city: null|string,
|
||||
* state: null|string,
|
||||
* postal_code: null|string,
|
||||
* country_iso: string,
|
||||
* phone_number: null|string,
|
||||
* email: null|string
|
||||
* },
|
||||
* shipping_address: null|array{
|
||||
* company_name: null|string,
|
||||
* first_name: string,
|
||||
* last_name: string,
|
||||
* address: null|string,
|
||||
* address_2: string,
|
||||
* house_number: null|string,
|
||||
* city: string,
|
||||
* state: string,
|
||||
* postal_code: string,
|
||||
* country_iso: string,
|
||||
* phone_number: null|string,
|
||||
* email: null|string
|
||||
* }
|
||||
* } $attributes The order data:
|
||||
* - billing_address: Billing address (ISO 3166-1 alpha-2 country code)
|
||||
* - shipping_address: Shipping address (first name, last name, ISO 3166-1 alpha-2 country code)
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function update(array $attributes = []): self
|
||||
{
|
||||
return (new self(fn() => $this->billable->request('PUT', sprintf('v1/orders/%s', $this->id), $attributes)))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checkout given order from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function checkout(): self
|
||||
{
|
||||
return (new self(fn() => $this->billable->request('PUT', sprintf('v1/orders/%s/checkout', $this->id))))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
|
||||
/**
|
||||
* Revoke given order from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function revoke(): self
|
||||
{
|
||||
return (new self(fn() => $this->billable->request('PUT', sprintf('v1/orders/%s/revoke', $this->id))))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete given order from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function delete(): bool
|
||||
{
|
||||
return $this->billable->request('DELETE', sprintf('v1/orders/%s', $this->id))->success();
|
||||
}
|
||||
|
||||
/**
|
||||
* Get order items from given order.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function orderItems(array $parameters = []): OrderItems
|
||||
{
|
||||
return OrderItems::builder(fn() => $this->billable->request('GET', sprintf('v1/orders/%s/items', $this->id), [], $parameters))
|
||||
->setBillable($this->billable)
|
||||
->setParent($this);
|
||||
}
|
||||
}
|
||||
51
src/Id/Resources/OrderItem.php
Normal file
51
src/Id/Resources/OrderItem.php
Normal file
@@ -0,0 +1,51 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\Concerns\HasBillable;
|
||||
use Anikeen\Id\Concerns\HasParent;
|
||||
use Throwable;
|
||||
|
||||
/**
|
||||
* @property string $id
|
||||
*/
|
||||
class OrderItem extends BaseResource
|
||||
{
|
||||
use HasBillable;
|
||||
use HasParent;
|
||||
|
||||
/**
|
||||
* Update given order item from given order.
|
||||
*
|
||||
* VAT is calculated based on the billing address and shown in the order item response.
|
||||
*
|
||||
* @param array{
|
||||
* items: array<array{
|
||||
* type: string,
|
||||
* name: string,
|
||||
* description: string,
|
||||
* price: float|int,
|
||||
* unit: string,
|
||||
* units: int
|
||||
* }>
|
||||
* } $attributes The order data:
|
||||
* - items: Array of order items, each with type, name, description, price, unit, and quantity
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function update(array $attributes = []): self
|
||||
{
|
||||
return (new self(fn() => $this->billable->request('PUT', sprintf('v1/orders/%s/items/%s', $this->parent->id, $this->id), $attributes)))
|
||||
->setBillable($this->billable)
|
||||
->setParent($this->parent);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete given order item from given order.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function delete(): bool
|
||||
{
|
||||
return $this->billable->request('DELETE', sprintf('v1/orders/%s/items/%s', $this->parent->id, $this->id))->success();
|
||||
}
|
||||
}
|
||||
50
src/Id/Resources/OrderItems.php
Normal file
50
src/Id/Resources/OrderItems.php
Normal file
@@ -0,0 +1,50 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\Concerns\HasBillable;
|
||||
use Anikeen\Id\Concerns\HasParent;
|
||||
use Anikeen\Id\Result;
|
||||
use Throwable;
|
||||
|
||||
class OrderItems extends BaseCollection
|
||||
{
|
||||
use HasBillable;
|
||||
use HasParent;
|
||||
|
||||
/**
|
||||
* Create a new order item for given order.
|
||||
*
|
||||
* VAT is calculated based on the billing address and shown in the order item response.
|
||||
*
|
||||
* @param string $orderId The order ID.
|
||||
* @param array{
|
||||
* items: array<array{
|
||||
* type: string,
|
||||
* name: string,
|
||||
* description: string,
|
||||
* price: float|int,
|
||||
* unit: string,
|
||||
* units: int
|
||||
* }>
|
||||
* } $attributes The order data:
|
||||
* - items: Array of order items, each with type, name, description, price, unit, and quantity
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function create(string $orderId, array $attributes = []): OrderItem
|
||||
{
|
||||
return (new OrderItem(fn() => $this->billable->request('POST', sprintf('v1/orders/%s', $orderId), $attributes)))
|
||||
->setBillable($this->billable)
|
||||
->setParent($this->parent);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function find(string $id): ?OrderItem
|
||||
{
|
||||
return (new OrderItem(fn() => $this->parent->request('GET', sprintf('v1/orders/%s/items/%s', $this->parent->id, $id))))
|
||||
->setBillable($this->billable)
|
||||
->setParent($this->parent);
|
||||
}
|
||||
}
|
||||
82
src/Id/Resources/Orders.php
Normal file
82
src/Id/Resources/Orders.php
Normal file
@@ -0,0 +1,82 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\Concerns\HasBillable;
|
||||
use Anikeen\Id\Result;
|
||||
use Throwable;
|
||||
|
||||
class Orders extends BaseCollection
|
||||
{
|
||||
use HasBillable;
|
||||
|
||||
/**
|
||||
* Creates a new order for the current user.
|
||||
*
|
||||
* VAT is calculated based on the billing address and shown in the order response.
|
||||
*
|
||||
* The billing and shipping addresses are each persisted as standalone Address entities
|
||||
* in the database, but are also embedded (deep-copied) into the Order object itself
|
||||
* rather than merely referenced. This guarantees that the order retains its own snapshot
|
||||
* of both addresses for future reference.
|
||||
*
|
||||
* @param array{
|
||||
* billing_address: array{
|
||||
* company_name: null|string,
|
||||
* first_name: null|string,
|
||||
* last_name: null|string,
|
||||
* address: null|string,
|
||||
* address_2: null|string,
|
||||
* house_number: null|string,
|
||||
* city: null|string,
|
||||
* state: null|string,
|
||||
* postal_code: null|string,
|
||||
* country_iso: string,
|
||||
* phone_number: null|string,
|
||||
* email: null|string
|
||||
* },
|
||||
* shipping_address: null|array{
|
||||
* company_name: null|string,
|
||||
* first_name: string,
|
||||
* last_name: string,
|
||||
* address: null|string,
|
||||
* address_2: string,
|
||||
* house_number: null|string,
|
||||
* city: string,
|
||||
* state: string,
|
||||
* postal_code: string,
|
||||
* country_iso: string,
|
||||
* phone_number: null|string,
|
||||
* email: null|string
|
||||
* },
|
||||
* items: array<array{
|
||||
* type: string,
|
||||
* name: string,
|
||||
* description: string,
|
||||
* price: float|int,
|
||||
* unit: string,
|
||||
* units: int
|
||||
* }>
|
||||
* } $attributes The order data:
|
||||
* - billing_address: Billing address (ISO 3166-1 alpha-2 country code)
|
||||
* - shipping_address: Shipping address (first name, last name, ISO 3166-1 alpha-2 country code)
|
||||
* - items: Array of order items (each with type, name, price, unit, units, and quantity)
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function create(array $attributes = []): Order
|
||||
{
|
||||
return (new Order(fn() => $this->billable->request('POST', 'v1/orders', $attributes)))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
|
||||
/**
|
||||
* Get given order from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function find(string $id): ?Order
|
||||
{
|
||||
return (new Order(fn() => $this->billable->request('GET', sprintf('v1/orders/%s', $id))))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
}
|
||||
13
src/Id/Resources/PaymentMethod.php
Normal file
13
src/Id/Resources/PaymentMethod.php
Normal file
@@ -0,0 +1,13 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\Concerns\HasBillable;
|
||||
|
||||
/**
|
||||
* @property string $id
|
||||
*/
|
||||
class PaymentMethod extends BaseResource
|
||||
{
|
||||
use HasBillable;
|
||||
}
|
||||
55
src/Id/Resources/PaymentMethods.php
Normal file
55
src/Id/Resources/PaymentMethods.php
Normal file
@@ -0,0 +1,55 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\Concerns\HasBillable;
|
||||
use Throwable;
|
||||
|
||||
class PaymentMethods extends BaseCollection
|
||||
{
|
||||
use HasBillable;
|
||||
|
||||
/**
|
||||
* Check if current user has at least one payment method.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function hasPaymentMethod(): bool
|
||||
{
|
||||
return $this->result->count() > 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Check if the current user has a default payment method.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function hasDefaultPaymentMethod(): bool
|
||||
{
|
||||
return $this->defaultPaymentMethod()?->id !== null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get default payment method from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function defaultPaymentMethod(): PaymentMethod
|
||||
{
|
||||
if (!isset($this->defaultPaymentMethodCache)) {
|
||||
$this->defaultPaymentMethodCache = (new PaymentMethod(fn() => $this->billable->request('GET', 'v1/payment-methods/default')))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
|
||||
return $this->defaultPaymentMethodCache;
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function find(string $id): ?PaymentMethod
|
||||
{
|
||||
return (new PaymentMethod(fn() => $this->billable->request('GET', sprintf('v1/payment-methods/%s', $id))))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
}
|
||||
24
src/Id/Resources/SshKey.php
Normal file
24
src/Id/Resources/SshKey.php
Normal file
@@ -0,0 +1,24 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\Concerns\HasParent;
|
||||
use Throwable;
|
||||
|
||||
/**
|
||||
* @property string $id
|
||||
*/
|
||||
class SshKey extends BaseResource
|
||||
{
|
||||
use HasParent;
|
||||
|
||||
/**
|
||||
* Deletes a given ssh key for the currently authed user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function delete(): bool
|
||||
{
|
||||
return $this->parent->delete(sprintf('v1/ssh-keys/%s', $this->id))->success();
|
||||
}
|
||||
}
|
||||
35
src/Id/Resources/SshKeys.php
Normal file
35
src/Id/Resources/SshKeys.php
Normal file
@@ -0,0 +1,35 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\Concerns\HasParent;
|
||||
use Anikeen\Id\Result;
|
||||
use Throwable;
|
||||
|
||||
class SshKeys extends BaseCollection
|
||||
{
|
||||
use HasParent;
|
||||
|
||||
/**
|
||||
* Creates ssh key for the currently authed user.
|
||||
*
|
||||
* @param string $publicKey The public key to be added
|
||||
* @param string|null $name The name of the key (optional)
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function create(string $publicKey, ?string $name = null): SshKey
|
||||
{
|
||||
return (new SshKey(fn() => $this->parent->post('v1/ssh-keys', [
|
||||
'public_key' => $publicKey,
|
||||
'name' => $name,
|
||||
])))->setParent($this->parent);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function find(string $id): ?SshKey
|
||||
{
|
||||
return (new SshKey(fn() => $this->parent->get(sprintf('v1/ssh-keys/%s', $id))));
|
||||
}
|
||||
}
|
||||
110
src/Id/Resources/Subscription.php
Normal file
110
src/Id/Resources/Subscription.php
Normal file
@@ -0,0 +1,110 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\Concerns\HasBillable;
|
||||
use Throwable;
|
||||
|
||||
/**
|
||||
* @property string $id
|
||||
* @property string $name
|
||||
* @property string $description
|
||||
* @property string $unit
|
||||
* @property float $price
|
||||
* @property float $vat_rate
|
||||
* @property array $payload
|
||||
* @property string $ends_at
|
||||
* @property string $webhook_url
|
||||
* @property string $webhook_secret
|
||||
*/
|
||||
class Subscription extends BaseResource
|
||||
{
|
||||
use HasBillable;
|
||||
|
||||
/**
|
||||
* Update a given subscription from the current user.
|
||||
*
|
||||
* @param array{
|
||||
* group: string,
|
||||
* name: string,
|
||||
* description: null|string,
|
||||
* unit: string,
|
||||
* price: float,
|
||||
* vat_rate: float,
|
||||
* payload: null|array,
|
||||
* ends_at: null|string,
|
||||
* webhook_url: null|string,
|
||||
* webhook_secret: null|string
|
||||
* } $attributes The subscription data:
|
||||
* - group: The group (optional)
|
||||
* - name: The name (required when set)
|
||||
* - description: The description (optional)
|
||||
* - unit: The unit (required when set, e.g. "hour", "day", "week", "month", "year")
|
||||
* - price: The price per unit (required when set)
|
||||
* - vat_rate: The VAT rate (required when set)
|
||||
* - payload: The payload (optional)
|
||||
* - ends_at: The end date (optional)
|
||||
* - webhook_url: The webhook URL (optional)
|
||||
* - webhook_secret: The webhook secret (optional)
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function update(array $attributes): self
|
||||
{
|
||||
return (new self(fn() => $this->billable->request('PUT', sprintf('v1/subscriptions/%s', $this->id), $attributes)))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
|
||||
/**
|
||||
* Force given subscription to check out (trusted apps only).
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function checkout(): self
|
||||
{
|
||||
return (new self(fn() => $this->billable->request('PUT', sprintf('v1/subscriptions/%s/checkout', $this->id))))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
|
||||
/**
|
||||
* Revoke a given running subscription from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function revoke(): self
|
||||
{
|
||||
return (new self(fn() => $this->billable->request('PUT', sprintf('v1/subscriptions/%s/revoke', $this->id))))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
|
||||
/**
|
||||
* Pause a given running subscription from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function pause(): self
|
||||
{
|
||||
return (new self(fn() => $this->billable->request('PUT', sprintf('v1/subscriptions/%s/pause', $this->id))))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
|
||||
/**
|
||||
* Resume a given running subscription from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function resume(): self
|
||||
{
|
||||
return (new self(fn() => $this->billable->request('PUT', sprintf('v1/subscriptions/%s/resume', $this->id))))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete a given subscription from the current user.
|
||||
*
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function delete(): bool
|
||||
{
|
||||
return $this->billable->request('DELETE', sprintf('v1/subscriptions/%s', $this->id))->success();
|
||||
}
|
||||
}
|
||||
53
src/Id/Resources/Subscriptions.php
Normal file
53
src/Id/Resources/Subscriptions.php
Normal file
@@ -0,0 +1,53 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\Concerns\HasBillable;
|
||||
use Throwable;
|
||||
|
||||
class Subscriptions extends BaseCollection
|
||||
{
|
||||
use HasBillable;
|
||||
|
||||
/**
|
||||
* Create a new subscription for the current user.
|
||||
*
|
||||
* @param array{
|
||||
* group: null|string,
|
||||
* name: string,
|
||||
* description: null|string,
|
||||
* unit: string,
|
||||
* price: float,
|
||||
* vat_rate: float,
|
||||
* payload: null|array,
|
||||
* ends_at: null|string,
|
||||
* webhook_url: null|string,
|
||||
* webhook_secret: null|string
|
||||
* } $attributes The subscription data:
|
||||
* - group: The group (optional)
|
||||
* - name: The name
|
||||
* - description: The description (optional)
|
||||
* - unit: The unit (e.g. "hour", "day", "week", "month", "year")
|
||||
* - price: The price per unit
|
||||
* - vat_rate: The VAT rate (required when set)
|
||||
* - payload: The payload (optional)
|
||||
* - ends_at: The end date (optional)
|
||||
* - webhook_url: The webhook URL (optional)
|
||||
* - webhook_secret: The webhook secret (optional)
|
||||
* @throws Throwable
|
||||
*/
|
||||
public function create(array $attributes): Subscription
|
||||
{
|
||||
return (new Subscription(fn() => $this->billable->request('POST', 'v1/subscriptions', $attributes)))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function find(string $id): ?Subscription
|
||||
{
|
||||
return (new Subscription(fn() => $this->billable->request('GET', sprintf('v1/subscriptions/%s', $id))))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
}
|
||||
10
src/Id/Resources/Transaction.php
Normal file
10
src/Id/Resources/Transaction.php
Normal file
@@ -0,0 +1,10 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\Concerns\HasBillable;
|
||||
|
||||
class Transaction extends BaseResource
|
||||
{
|
||||
use HasBillable;
|
||||
}
|
||||
21
src/Id/Resources/Transactions.php
Normal file
21
src/Id/Resources/Transactions.php
Normal file
@@ -0,0 +1,21 @@
|
||||
<?php
|
||||
|
||||
namespace Anikeen\Id\Resources;
|
||||
|
||||
use Anikeen\Id\Concerns\HasBillable;
|
||||
use Anikeen\Id\Exceptions\ResourceException;
|
||||
use Throwable;
|
||||
|
||||
class Transactions extends BaseCollection
|
||||
{
|
||||
use HasBillable;
|
||||
|
||||
/**
|
||||
* {@inheritDoc}
|
||||
*/
|
||||
public function find(string $id): ?Transaction
|
||||
{
|
||||
return (new Transaction(fn() => $this->billable->request('GET', sprintf('v1/transactions/%s', $id))))
|
||||
->setBillable($this->billable);
|
||||
}
|
||||
}
|
||||
@@ -9,67 +9,112 @@ use stdClass;
|
||||
|
||||
class Result
|
||||
{
|
||||
|
||||
/**
|
||||
* Query successful.
|
||||
* Was the API call successful?
|
||||
*/
|
||||
public bool $success = false;
|
||||
|
||||
/**
|
||||
* Query result data.
|
||||
* Response data: either an array of items (paginated) or a single object (non-paginated)
|
||||
*/
|
||||
public array $data = [];
|
||||
public mixed $data = [];
|
||||
|
||||
/**
|
||||
* Total amount of result data.
|
||||
* Total number of items: uses meta.total, root total, or falls back to count/data existence
|
||||
*/
|
||||
public int $total = 0;
|
||||
|
||||
/**
|
||||
* Status Code.
|
||||
* HTTP status code
|
||||
*/
|
||||
public int $status = 0;
|
||||
|
||||
/**
|
||||
* AnikeenId response pagination cursor.
|
||||
* Pagination links (first, last, prev, next) as stdClass or null
|
||||
*/
|
||||
public ?stdClass $pagination;
|
||||
public ?stdClass $links = null;
|
||||
|
||||
/**
|
||||
* Original AnikeenId instance.
|
||||
*
|
||||
* @var AnikeenId
|
||||
* Pagination meta (current_page, last_page etc.) as stdClass or null
|
||||
*/
|
||||
public ?stdClass $meta = null;
|
||||
|
||||
/**
|
||||
* Paginator helper to retrieve next/prev pages
|
||||
*/
|
||||
public ?Paginator $paginator = null;
|
||||
|
||||
/**
|
||||
* Reference to the original AnikeenId client
|
||||
*/
|
||||
public AnikeenId $anikeenId;
|
||||
|
||||
public function __construct(public ?ResponseInterface $response, public ?Exception $exception = null, public ?Paginator $paginator = null)
|
||||
{
|
||||
/**
|
||||
* Constructor
|
||||
*
|
||||
* @param ResponseInterface|null $response
|
||||
* @param Exception|null $exception
|
||||
* @param AnikeenId $anikeenId
|
||||
*/
|
||||
public function __construct(
|
||||
public ?ResponseInterface $response,
|
||||
public ?Exception $exception,
|
||||
AnikeenId $anikeenId
|
||||
) {
|
||||
$this->anikeenId = $anikeenId;
|
||||
$this->success = $exception === null;
|
||||
$this->status = $response ? $response->getStatusCode() : 500;
|
||||
$jsonResponse = $response ? @json_decode($response->getBody()->getContents(), false) : null;
|
||||
if ($jsonResponse !== null) {
|
||||
$this->setProperty($jsonResponse, 'data');
|
||||
$this->setProperty($jsonResponse, 'total');
|
||||
$this->setProperty($jsonResponse, 'pagination');
|
||||
$this->paginator = Paginator::from($this);
|
||||
|
||||
$raw = $response ? (string) $response->getBody() : null;
|
||||
$json = $raw ? @json_decode($raw, false) : null;
|
||||
|
||||
if ($json !== null) {
|
||||
// Pagination info
|
||||
$this->links = $json->links ?? null;
|
||||
$this->meta = $json->meta ?? null;
|
||||
|
||||
// Determine data shape
|
||||
if (isset($json->data)) {
|
||||
if ($this->links !== null || $this->meta !== null) {
|
||||
// Paginated: always array
|
||||
$this->data = is_array($json->data) ? $json->data : [$json->data];
|
||||
} else {
|
||||
// Non-paginated: single object
|
||||
$this->data = $json->data;
|
||||
}
|
||||
} else {
|
||||
// No 'data' key: treat entire payload
|
||||
if ($this->links !== null || $this->meta !== null) {
|
||||
// Paginated but missing data key: fallback to empty array
|
||||
$this->data = [];
|
||||
} else {
|
||||
$this->data = $json;
|
||||
}
|
||||
}
|
||||
|
||||
// Total items
|
||||
if (isset($json->meta->total)) {
|
||||
$this->total = (int) $json->meta->total;
|
||||
} elseif (isset($json->total)) {
|
||||
$this->total = (int) $json->total;
|
||||
} else {
|
||||
// count array or single object
|
||||
if (is_array($this->data)) {
|
||||
$this->total = count($this->data);
|
||||
} elseif ($this->data !== null) {
|
||||
$this->total = 1;
|
||||
}
|
||||
}
|
||||
|
||||
// Initialize paginator only if pagination present
|
||||
if ($this->links !== null || $this->meta !== null) {
|
||||
$this->paginator = Paginator::from($this);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets a class attribute by given JSON Response Body.
|
||||
*/
|
||||
private function setProperty(stdClass $jsonResponse, string $responseProperty, string $attribute = null): void
|
||||
{
|
||||
$classAttribute = $attribute ?? $responseProperty;
|
||||
if (property_exists($jsonResponse, $responseProperty)) {
|
||||
$this->{$classAttribute} = $jsonResponse->{$responseProperty};
|
||||
} elseif ($responseProperty === 'data') {
|
||||
$this->{$classAttribute} = $jsonResponse;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns whether the query was successfully.
|
||||
* Was the request successful?
|
||||
*/
|
||||
public function success(): bool
|
||||
{
|
||||
@@ -77,47 +122,46 @@ class Result
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the last HTTP or API error.
|
||||
* Get last error message
|
||||
*/
|
||||
public function error(): string
|
||||
{
|
||||
// TODO Switch Exception response parsing to this->data
|
||||
if ($this->exception === null || !$this->exception->hasResponse()) {
|
||||
if ($this->exception === null || !method_exists($this->exception, 'getResponse')) {
|
||||
return 'Anikeen ID API Unavailable';
|
||||
}
|
||||
$exception = (string)$this->exception->getResponse()->getBody();
|
||||
$exception = @json_decode($exception);
|
||||
if (property_exists($exception, 'message') && !empty($exception->message)) {
|
||||
return $exception->message;
|
||||
$resp = $this->exception->getResponse();
|
||||
$body = $resp ? (string) $resp->getBody() : null;
|
||||
$err = $body ? @json_decode($body) : null;
|
||||
if (isset($err->message) && $err->message !== '') {
|
||||
return $err->message;
|
||||
}
|
||||
|
||||
return $this->exception->getMessage();
|
||||
}
|
||||
|
||||
/**
|
||||
* Shifts the current result (Use for single user/video etc. query).
|
||||
* For paginated data: shift first element; for single object: return it
|
||||
*/
|
||||
public function shift(): mixed
|
||||
{
|
||||
if (!empty($this->data)) {
|
||||
$data = $this->data;
|
||||
|
||||
return array_shift($data);
|
||||
if (is_array($this->data)) {
|
||||
return array_shift($this->data);
|
||||
}
|
||||
|
||||
return null;
|
||||
return $this->data;
|
||||
}
|
||||
|
||||
/**
|
||||
* Return the current count of items in dataset.
|
||||
* Count of items in data
|
||||
*/
|
||||
public function count(): int
|
||||
{
|
||||
return count($this->data);
|
||||
if (is_array($this->data)) {
|
||||
return count($this->data);
|
||||
}
|
||||
return $this->data !== null ? 1 : 0;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the Paginator to fetch the next set of results.
|
||||
* Fetch next page paginator
|
||||
*/
|
||||
public function next(): ?Paginator
|
||||
{
|
||||
@@ -125,7 +169,7 @@ class Result
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the Paginator to fetch the last set of results.
|
||||
* Fetch previous page paginator
|
||||
*/
|
||||
public function back(): ?Paginator
|
||||
{
|
||||
@@ -133,71 +177,62 @@ class Result
|
||||
}
|
||||
|
||||
/**
|
||||
* Get rate limit information.
|
||||
* Rate limit info from headers
|
||||
*/
|
||||
public function rateLimit(string $key = null): array|int|string|null
|
||||
public function rateLimit(?string $key = null): array|int|string|null
|
||||
{
|
||||
if (!$this->response) {
|
||||
return null;
|
||||
}
|
||||
$rateLimit = [
|
||||
'limit' => (int)$this->response->getHeaderLine('X-RateLimit-Limit'),
|
||||
'remaining' => (int)$this->response->getHeaderLine('X-RateLimit-Remaining'),
|
||||
'reset' => (int)$this->response->getHeaderLine('Retry-After'),
|
||||
$info = [
|
||||
'limit' => (int) $this->response->getHeaderLine('X-RateLimit-Limit'),
|
||||
'remaining' => (int) $this->response->getHeaderLine('X-RateLimit-Remaining'),
|
||||
'reset' => (int) $this->response->getHeaderLine('Retry-After'),
|
||||
];
|
||||
if ($key === null) {
|
||||
return $rateLimit;
|
||||
}
|
||||
|
||||
return $rateLimit[$key];
|
||||
return $key ? ($info[$key] ?? null) : $info;
|
||||
}
|
||||
|
||||
/**
|
||||
* Insert users in data response.
|
||||
* Insert related users into each data item (for arrays)
|
||||
*/
|
||||
public function insertUsers(string $identifierAttribute = 'user_id', string $insertTo = 'user'): self
|
||||
{
|
||||
$data = $this->data;
|
||||
$userIds = collect($data)->map(function ($item) use ($identifierAttribute) {
|
||||
return $item->{$identifierAttribute};
|
||||
})->toArray();
|
||||
if (count($userIds) === 0) {
|
||||
if (!is_array($this->data)) {
|
||||
return $this;
|
||||
}
|
||||
$users = collect($this->anikeenId->getUsersByIds($userIds)->data);
|
||||
$dataWithUsers = collect($data)->map(function ($item) use ($users, $identifierAttribute, $insertTo) {
|
||||
$item->$insertTo = $users->where('id', $item->{$identifierAttribute})->first();
|
||||
|
||||
return $item;
|
||||
});
|
||||
$this->data = $dataWithUsers->toArray();
|
||||
|
||||
$ids = array_map(fn($item) => $item->{$identifierAttribute} ?? null, $this->data);
|
||||
$ids = array_filter($ids);
|
||||
if (empty($ids)) {
|
||||
return $this;
|
||||
}
|
||||
$users = $this->anikeenId->getUsersByIds($ids)->data;
|
||||
foreach ($this->data as &$item) {
|
||||
$item->{$insertTo} = collect($users)->firstWhere('id', $item->{$identifierAttribute});
|
||||
}
|
||||
return $this;
|
||||
}
|
||||
|
||||
/**
|
||||
* Set the Paginator to fetch the first set of results.
|
||||
* Fetch first page paginator
|
||||
*/
|
||||
public function first(): ?Paginator
|
||||
{
|
||||
return $this->paginator?->first();
|
||||
}
|
||||
|
||||
/**
|
||||
* Original response
|
||||
*/
|
||||
public function response(): ?ResponseInterface
|
||||
{
|
||||
return $this->response;
|
||||
}
|
||||
|
||||
public function dump(): void
|
||||
{
|
||||
dump($this->data());
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the response data, also available as public attribute.
|
||||
* Access raw data
|
||||
*/
|
||||
public function data(): array
|
||||
public function data(): mixed
|
||||
{
|
||||
return $this->data;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -8,6 +8,6 @@ class AnikeenIdExtendSocialite
|
||||
{
|
||||
public function handle(SocialiteWasCalled $socialiteWasCalled): void
|
||||
{
|
||||
$socialiteWasCalled->extendSocialite('anikeen-id', Provider::class);
|
||||
$socialiteWasCalled->extendSocialite('anikeen', Provider::class);
|
||||
}
|
||||
}
|
||||
@@ -2,8 +2,10 @@
|
||||
|
||||
namespace Anikeen\Id\Socialite;
|
||||
|
||||
use Anikeen\Id\AnikeenId;
|
||||
use Anikeen\Id\Enums\Scope;
|
||||
use GuzzleHttp\Exception\GuzzleException;
|
||||
use Illuminate\Http\Request;
|
||||
use Illuminate\Support\Arr;
|
||||
use Laravel\Socialite\Two\ProviderInterface;
|
||||
use SocialiteProviders\Manager\OAuth2\AbstractProvider;
|
||||
@@ -14,7 +16,7 @@ class Provider extends AbstractProvider implements ProviderInterface
|
||||
/**
|
||||
* Unique Provider Identifier.
|
||||
*/
|
||||
const IDENTIFIER = 'ANIKEEN_ID';
|
||||
const IDENTIFIER = 'ANIKEEN';
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
@@ -26,13 +28,21 @@ class Provider extends AbstractProvider implements ProviderInterface
|
||||
*/
|
||||
protected $scopeSeparator = ' ';
|
||||
|
||||
/**
|
||||
* Get the base URL for the API.
|
||||
*/
|
||||
protected function getBaseUrl(): string
|
||||
{
|
||||
return app(AnikeenId::class)->getBaseUrl();
|
||||
}
|
||||
|
||||
/**
|
||||
* {@inheritdoc}
|
||||
*/
|
||||
protected function getAuthUrl($state): string
|
||||
{
|
||||
return $this->buildAuthUrlFromBase(
|
||||
'https://id.anikeen.com/oauth/authorize', $state
|
||||
$this->getBaseUrl() . '/oauth/authorize', $state
|
||||
);
|
||||
}
|
||||
|
||||
@@ -41,7 +51,7 @@ class Provider extends AbstractProvider implements ProviderInterface
|
||||
*/
|
||||
protected function getTokenUrl(): string
|
||||
{
|
||||
return 'https://id.anikeen.com/oauth/token';
|
||||
return $this->getBaseUrl() . '/oauth/token';
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -52,7 +62,7 @@ class Provider extends AbstractProvider implements ProviderInterface
|
||||
protected function getUserByToken($token)
|
||||
{
|
||||
$response = $this->getHttpClient()->get(
|
||||
'https://id.anikeen.com/api/v1/user', [
|
||||
$this->getBaseUrl() . '/api/v1/user', [
|
||||
'headers' => [
|
||||
'Accept' => 'application/json',
|
||||
'Authorization' => 'Bearer ' . $token,
|
||||
@@ -85,4 +95,12 @@ class Provider extends AbstractProvider implements ProviderInterface
|
||||
'grant_type' => 'authorization_code',
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the user logout url for the provider.
|
||||
*/
|
||||
public function getLogoutUrl(string $redirect = null): string
|
||||
{
|
||||
return app(AnikeenId::class)->getBaseUrl() . '/logout?redirect=' . urlencode($redirect ?: '/');
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,42 +0,0 @@
|
||||
<?php
|
||||
|
||||
|
||||
namespace Anikeen\Id\Traits;
|
||||
|
||||
use Anikeen\Id\ApiOperations\Delete;
|
||||
use Anikeen\Id\ApiOperations\Get;
|
||||
use Anikeen\Id\ApiOperations\Post;
|
||||
use Anikeen\Id\Result;
|
||||
|
||||
trait SshKeysTrait
|
||||
{
|
||||
|
||||
use Get, Post, Delete;
|
||||
|
||||
/**
|
||||
* Get currently authed user with Bearer Token
|
||||
*/
|
||||
public function getSshKeysByUserId(int $id): Result
|
||||
{
|
||||
return $this->get("v1/users/$id/ssh-keys/json", [], null);
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates ssh key for the currently authed user
|
||||
*/
|
||||
public function createSshKey(string $publicKey, string $name = null): Result
|
||||
{
|
||||
return $this->post('v1/ssh-keys', [
|
||||
'public_key' => $publicKey,
|
||||
'name' => $name,
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Deletes a given ssh key for the currently authed user
|
||||
*/
|
||||
public function deleteSshKey(int $id): Result
|
||||
{
|
||||
return $this->delete("v1/ssh-keys/$id", []);
|
||||
}
|
||||
}
|
||||
@@ -1,39 +0,0 @@
|
||||
<?php
|
||||
|
||||
|
||||
namespace Anikeen\Id\Traits;
|
||||
|
||||
use Anikeen\Id\ApiOperations\Get;
|
||||
use Anikeen\Id\Result;
|
||||
|
||||
trait UsersTrait
|
||||
{
|
||||
|
||||
use Get;
|
||||
|
||||
/**
|
||||
* Get currently authed user with Bearer Token
|
||||
*/
|
||||
public function getAuthedUser(): Result
|
||||
{
|
||||
return $this->get('v1/user');
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates a new user on behalf of the current user.
|
||||
*/
|
||||
public function createUser(array $parameters): Result
|
||||
{
|
||||
return $this->post('v1/users', $parameters);
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if the given email exists.
|
||||
*/
|
||||
public function isEmailExisting(string $email): Result
|
||||
{
|
||||
return $this->post('v1/users/check', [
|
||||
'email' => $email,
|
||||
]);
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user