kenmirrors/firefly-iii
1
0
Fork 0
mirror of https://github.com/firefly-iii/firefly-iii.git synced 2025-10-26 13:36:15 +00:00
Code Issues Projects Releases Wiki Activity

Clean up API code and fix test code.

Browse Source
This commit is contained in:
James Cole
2019-09-04 17:39:39 +02:00
parent f52584d46b
commit f9f1fa0fcb
60 changed files with 812 additions and 1191 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
app/Api/V1/Requests/AccountStoreRequest.php
View File

@@ -28,6 +28,7 @@ use FireflyIII\Rules\IsBoolean;
/**
* Class AccountStoreRequest
*
* @codeCoverageIgnore
*/
class AccountStoreRequest extends Request

23
app/Api/V1/Requests/AccountUpdateRequest.php
View File

@@ -28,11 +28,23 @@ use FireflyIII\Rules\IsBoolean;
/**
* Class AccountUpdateRequest
*
* @codeCoverageIgnore
*/
class AccountUpdateRequest extends Request
{
/**
* Authorize logged in users.
*
* @return bool
*/
public function authorize(): bool
{
// Only allow authenticated users
return auth()->check();
}
/**
* @return array
*/
@@ -79,17 +91,6 @@ class AccountUpdateRequest extends Request
return $data;
}
/**
* Authorize logged in users.
*
* @return bool
*/
public function authorize(): bool
{
// Only allow authenticated users
return auth()->check();
}
/**
* The rules that the incoming request must be matched against.
*

2
app/Api/V1/Requests/AttachmentStoreRequest.php
View File

@@ -30,6 +30,7 @@ use FireflyIII\Rules\IsValidAttachmentModel;
/**
* Class AttachmentStoreRequest
*
* @codeCoverageIgnore
*/
class AttachmentStoreRequest extends Request
@@ -77,6 +78,7 @@ class AttachmentStoreRequest extends Request
]
);
$model = $this->string('model');
return [
'filename' => 'required|between:1,255',
'title' => 'between:1,255',

1
app/Api/V1/Requests/BudgetRequest.php
View File

@@ -28,6 +28,7 @@ use FireflyIII\Rules\IsBoolean;
/**
* Class BudgetRequest
*
* @codeCoverageIgnore
* TODO AFTER 4.8,0: split this into two request classes.
*/

1
app/Api/V1/Requests/CategoryRequest.php
View File

@@ -27,6 +27,7 @@ use FireflyIII\Models\Category;
/**
* Class CategoryRequest
*
* @codeCoverageIgnore
* TODO AFTER 4.8,0: split this into two request classes.
*/

1
app/Api/V1/Requests/ConfigurationRequest.php
View File

@@ -28,6 +28,7 @@ use FireflyIII\Rules\IsBoolean;
/**
* Class ConfigurationRequest
*
* @codeCoverageIgnore
*/
class ConfigurationRequest extends Request

1
app/Api/V1/Requests/CurrencyRequest.php
View File

@@ -28,6 +28,7 @@ use FireflyIII\Rules\IsBoolean;
/**
* Class CurrencyRequest
*
* @codeCoverageIgnore
* TODO AFTER 4.8,0: split this into two request classes.
*/

1
app/Api/V1/Requests/LinkTypeRequest.php
View File

@@ -29,6 +29,7 @@ use Illuminate\Validation\Rule;
/**
*
* Class LinkTypeRequest
*
* @codeCoverageIgnore
* TODO AFTER 4.8,0: split this into two request classes.
*/

1
app/Api/V1/Requests/PiggyBankRequest.php
View File

@@ -31,6 +31,7 @@ use FireflyIII\Rules\ZeroOrMore;
/**
*
* Class PiggyBankRequest
*
* @codeCoverageIgnore
* TODO AFTER 4.8,0: split this into two request classes.
*/

1
app/Api/V1/Requests/PreferenceRequest.php
View File

@@ -26,6 +26,7 @@ namespace FireflyIII\Api\V1\Requests;
/**
*
* Class PreferenceRequest
*
* @codeCoverageIgnore
*/
class PreferenceRequest extends Request

24
app/Api/V1/Requests/RecurrenceUpdateRequest.php
View File

@@ -93,18 +93,18 @@ class RecurrenceUpdateRequest extends Request
$recurrence = $this->route()->parameter('recurrence');
return [
'type' => 'in:withdrawal,transfer,deposit',
'title' => sprintf('between:1,255|uniqueObjectForUser:recurrences,title,%d', $recurrence->id),
'description' => 'between:1,65000',
'first_date' => 'date',
'apply_rules' => [new IsBoolean],
'active' => [new IsBoolean],
'repeat_until' => 'date',
'nr_of_repetitions' => 'numeric|between:1,31',
'repetitions.*.type' => 'in:daily,weekly,ndom,monthly,yearly',
'repetitions.*.moment' => 'between:0,10',
'repetitions.*.skip' => 'required|numeric|between:0,31',
'repetitions.*.weekend' => 'required|numeric|min:1|max:4',
'type' => 'in:withdrawal,transfer,deposit',
'title' => sprintf('between:1,255|uniqueObjectForUser:recurrences,title,%d', $recurrence->id),
'description' => 'between:1,65000',
'first_date' => 'date',
'apply_rules' => [new IsBoolean],
'active' => [new IsBoolean],
'repeat_until' => 'date',
'nr_of_repetitions' => 'numeric|between:1,31',
'repetitions.*.type' => 'in:daily,weekly,ndom,monthly,yearly',
'repetitions.*.moment' => 'between:0,10',
'repetitions.*.skip' => 'required|numeric|between:0,31',
'repetitions.*.weekend' => 'required|numeric|min:1|max:4',
'transactions.*.description' => 'required|between:1,255',
'transactions.*.amount' => 'required|numeric|more:0',

50
app/Api/V1/Requests/RuleGroupTestRequest.php
View File

@@ -75,8 +75,33 @@ class RuleGroupTestRequest extends Request
return [];
}
/**
* @return Collection
*/
private function getAccounts(): Collection
{
$accountList = '' === (string)$this->query('accounts') ? [] : explode(',', $this->query('accounts'));
$accounts = new Collection;
/** @var AccountRepositoryInterface $accountRepository */
$accountRepository = app(AccountRepositoryInterface::class);
foreach ($accountList as $accountId) {
Log::debug(sprintf('Searching for asset account with id "%s"', $accountId));
$account = $accountRepository->findNull((int)$accountId);
if ($this->validAccount($account)) {
/** @noinspection NullPointerExceptionInspection */
Log::debug(sprintf('Found account #%d ("%s") and its an asset account', $account->id, $account->name));
$accounts->push($account);
}
}
return $accounts;
}
/**
* @param string $field
*
* @return Carbon|null
*/
private function getDate(string $field): ?Carbon
@@ -112,32 +137,9 @@ class RuleGroupTestRequest extends Request
return 0 === (int)$this->query('triggered_limit') ? (int)config('firefly.test-triggers.range') : (int)$this->query('triggered_limit');
}
/**
* @return Collection
*/
private function getAccounts(): Collection
{
$accountList = '' === (string)$this->query('accounts') ? [] : explode(',', $this->query('accounts'));
$accounts = new Collection;
/** @var AccountRepositoryInterface $accountRepository */
$accountRepository = app(AccountRepositoryInterface::class);
foreach ($accountList as $accountId) {
Log::debug(sprintf('Searching for asset account with id "%s"', $accountId));
$account = $accountRepository->findNull((int)$accountId);
if ($this->validAccount($account)) {
/** @noinspection NullPointerExceptionInspection */
Log::debug(sprintf('Found account #%d ("%s") and its an asset account', $account->id, $account->name));
$accounts->push($account);
}
}
return $accounts;
}
/**
* @param Account|null $account
*
* @return bool
*/
private function validAccount(?Account $account): bool

26
app/Api/V1/Requests/RuleGroupTriggerRequest.php
View File

@@ -75,18 +75,6 @@ class RuleGroupTriggerRequest extends Request
];
}
/**
* @param string $field
* @return Carbon|null
*/
private function getDate(string $field): ?Carbon
{
/** @var Carbon $result */
$result = null === $this->query($field) ? null : Carbon::createFromFormat('Y-m-d', $this->query($field));
return $result;
}
/**
* @return Collection
*/
@@ -111,8 +99,22 @@ class RuleGroupTriggerRequest extends Request
return $accounts;
}
/**
* @param string $field
*
* @return Carbon|null
*/
private function getDate(string $field): ?Carbon
{
/** @var Carbon $result */
$result = null === $this->query($field) ? null : Carbon::createFromFormat('Y-m-d', $this->query($field));
return $result;
}
/**
* @param Account|null $account
*
* @return bool
*/
private function validAccount(?Account $account): bool

60
app/Api/V1/Requests/RuleStoreRequest.php
View File

@@ -133,21 +133,6 @@ class RuleStoreRequest extends Request
);
}
/**
* Adds an error to the validator when there are no repetitions in the array of data.
*
* @param Validator $validator
*/
protected function atLeastOneTrigger(Validator $validator): void
{
$data = $validator->getData();
$triggers = $data['triggers'] ?? [];
// need at least one trigger
if (0 === count($triggers)) {
$validator->errors()->add('title', (string)trans('validation.at_least_one_trigger'));
}
}
/**
* Adds an error to the validator when there are no repetitions in the array of data.
*
@@ -164,24 +149,18 @@ class RuleStoreRequest extends Request
}
/**
* @return array
* Adds an error to the validator when there are no repetitions in the array of data.
*
* @param Validator $validator
*/
private function getRuleTriggers(): array
protected function atLeastOneTrigger(Validator $validator): void
{
$triggers = $this->get('triggers');
$return = [];
if (is_array($triggers)) {
foreach ($triggers as $trigger) {
$return[] = [
'type' => $trigger['type'],
'value' => $trigger['value'],
'active' => $this->convertBoolean((string)($trigger['active'] ?? 'false')),
'stop_processing' => $this->convertBoolean((string)($trigger['stop_processing'] ?? 'false')),
];
}
$data = $validator->getData();
$triggers = $data['triggers'] ?? [];
// need at least one trigger
if (0 === count($triggers)) {
$validator->errors()->add('title', (string)trans('validation.at_least_one_trigger'));
}
return $return;
}
/**
@@ -204,4 +183,25 @@ class RuleStoreRequest extends Request
return $return;
}
/**
* @return array
*/
private function getRuleTriggers(): array
{
$triggers = $this->get('triggers');
$return = [];
if (is_array($triggers)) {
foreach ($triggers as $trigger) {
$return[] = [
'type' => $trigger['type'],
'value' => $trigger['value'],
'active' => $this->convertBoolean((string)($trigger['active'] ?? 'false')),
'stop_processing' => $this->convertBoolean((string)($trigger['stop_processing'] ?? 'false')),
];
}
}
return $return;
}
}

50
app/Api/V1/Requests/RuleTestRequest.php
View File

@@ -75,8 +75,33 @@ class RuleTestRequest extends Request
return [];
}
/**
* @return Collection
*/
private function getAccounts(): Collection
{
$accountList = '' === (string)$this->query('accounts') ? [] : explode(',', $this->query('accounts'));
$accounts = new Collection;
/** @var AccountRepositoryInterface $accountRepository */
$accountRepository = app(AccountRepositoryInterface::class);
foreach ($accountList as $accountId) {
Log::debug(sprintf('Searching for asset account with id "%s"', $accountId));
$account = $accountRepository->findNull((int)$accountId);
if ($this->validAccount($account)) {
/** @noinspection NullPointerExceptionInspection */
Log::debug(sprintf('Found account #%d ("%s") and its an asset account', $account->id, $account->name));
$accounts->push($account);
}
}
return $accounts;
}
/**
* @param string $field
*
* @return Carbon|null
*/
private function getDate(string $field): ?Carbon
@@ -112,32 +137,9 @@ class RuleTestRequest extends Request
return 0 === (int)$this->query('triggered_limit') ? (int)config('firefly.test-triggers.range') : (int)$this->query('triggered_limit');
}
/**
* @return Collection
*/
private function getAccounts(): Collection
{
$accountList = '' === (string)$this->query('accounts') ? [] : explode(',', $this->query('accounts'));
$accounts = new Collection;
/** @var AccountRepositoryInterface $accountRepository */
$accountRepository = app(AccountRepositoryInterface::class);
foreach ($accountList as $accountId) {
Log::debug(sprintf('Searching for asset account with id "%s"', $accountId));
$account = $accountRepository->findNull((int)$accountId);
if ($this->validAccount($account)) {
/** @noinspection NullPointerExceptionInspection */
Log::debug(sprintf('Found account #%d ("%s") and its an asset account', $account->id, $account->name));
$accounts->push($account);
}
}
return $accounts;
}
/**
* @param Account|null $account
*
* @return bool
*/
private function validAccount(?Account $account): bool

26
app/Api/V1/Requests/RuleTriggerRequest.php
View File

@@ -74,18 +74,6 @@ class RuleTriggerRequest extends Request
];
}
/**
* @param string $field
* @return Carbon|null
*/
private function getDate(string $field): ?Carbon
{
/** @var Carbon $result */
$result = null === $this->query($field) ? null : Carbon::createFromFormat('Y-m-d', $this->query($field));
return $result;
}
/**
* @return Collection
*/
@@ -110,8 +98,22 @@ class RuleTriggerRequest extends Request
return $accounts;
}
/**
* @param string $field
*
* @return Carbon|null
*/
private function getDate(string $field): ?Carbon
{
/** @var Carbon $result */
$result = null === $this->query($field) ? null : Carbon::createFromFormat('Y-m-d', $this->query($field));
return $result;
}
/**
* @param Account|null $account
*
* @return bool
*/
private function validAccount(?Account $account): bool

16
app/Api/V1/Requests/RuleUpdateRequest.php
View File

@@ -143,11 +143,9 @@ class RuleUpdateRequest extends Request
{
$data = $validator->getData();
$actions = $data['actions'] ?? null;
if (is_array($actions)) {
// need at least one action
if (0 === count($actions)) {
$validator->errors()->add('title', (string)trans('validation.at_least_one_action'));
}
// need at least one action
if (is_array($actions) && 0 === count($actions)) {
$validator->errors()->add('title', (string)trans('validation.at_least_one_action'));
}
}
@@ -160,11 +158,9 @@ class RuleUpdateRequest extends Request
{
$data = $validator->getData();
$triggers = $data['triggers'] ?? null;
if (is_array($triggers)) {
// need at least one trigger
if (0 === count($triggers)) {
$validator->errors()->add('title', (string)trans('validation.at_least_one_trigger'));
}
// need at least one trigger
if (is_array($triggers) && 0 === count($triggers)) {
$validator->errors()->add('title', (string)trans('validation.at_least_one_trigger'));
}
}

2
app/Api/V1/Requests/TransactionStoreRequest.php
View File

@@ -192,7 +192,7 @@ class TransactionStoreRequest extends Request
{
$return = [];
/**
* @var int $index
* @var int $index
* @var array $transaction
*/
foreach ($this->get('transactions') as $index => $transaction) {

2
app/Api/V1/Requests/TransactionUpdateRequest.php
View File

@@ -276,7 +276,7 @@ class TransactionUpdateRequest extends Request
Log::debug('Now in getTransactionData()');
$return = [];
/**
* @var int $index
* @var int $index
* @var array $transaction
*/
foreach ($this->get('transactions') as $index => $transaction) {