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

Handle different account types #1443

Browse Source
This commit is contained in:
James Cole
2018-05-25 17:31:41 +02:00
parent 0a1b6c7793
commit d693d382b9
2 changed files with 459 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

154
app/Support/Import/Routine/Bunq/StageNewHandler.php
View File

@@ -23,8 +23,12 @@ declare(strict_types=1);
namespace FireflyIII\Support\Import\Routine\Bunq; namespace FireflyIII\Support\Import\Routine\Bunq;
use bunq\exception\BunqException;
use bunq\Model\Generated\Endpoint\MonetaryAccount as BunqMonetaryAccount; use bunq\Model\Generated\Endpoint\MonetaryAccount as BunqMonetaryAccount;
use bunq\Model\Generated\Endpoint\MonetaryAccountBank; use bunq\Model\Generated\Endpoint\MonetaryAccountBank;
use bunq\Model\Generated\Endpoint\MonetaryAccountJoint;
use bunq\Model\Generated\Endpoint\MonetaryAccountLight;
use bunq\Model\Generated\Object\CoOwner;
use bunq\Model\Generated\Object\Pointer; use bunq\Model\Generated\Object\Pointer;
use FireflyIII\Exceptions\FireflyException; use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\ImportJob; use FireflyIII\Models\ImportJob;
@@ -32,6 +36,7 @@ use FireflyIII\Models\Preference;
use FireflyIII\Repositories\ImportJob\ImportJobRepositoryInterface; use FireflyIII\Repositories\ImportJob\ImportJobRepositoryInterface;
use FireflyIII\Services\Bunq\ApiContext; use FireflyIII\Services\Bunq\ApiContext;
use FireflyIII\Services\Bunq\MonetaryAccount; use FireflyIII\Services\Bunq\MonetaryAccount;
use Log;
/** /**
* Class StageNewHandler * Class StageNewHandler
@@ -66,8 +71,8 @@ class StageNewHandler
return; return;
} }
throw new FireflyException('The bunq API context is unexpectedly empty.'); throw new FireflyException('The bunq API context is unexpectedly empty.'); // @codeCoverageIgnore
} } // @codeCoverageIgnore
/** /**
* @param ImportJob $importJob * @param ImportJob $importJob
@@ -94,10 +99,36 @@ class StageNewHandler
/** @var BunqMonetaryAccount $monetaryAccount */ /** @var BunqMonetaryAccount $monetaryAccount */
foreach ($result->getValue() as $monetaryAccount) { foreach ($result->getValue() as $monetaryAccount) {
$mab = $monetaryAccount->getMonetaryAccountBank(); try {
if (null !== $mab) { $object = $monetaryAccount->getReferencedObject();
$array = $this->processMab($mab); // @codeCoverageIgnoreStart
$accounts[] = $array; } catch (BunqException $e) {
throw new FireflyException($e->getMessage());
}
// @codeCoverageIgnoreEnd
if (null !== $object) {
$array = null;
switch (\get_class($object)) {
case MonetaryAccountBank::class:
/** @var MonetaryAccountBank $object */
$array = $this->processMab($object);
break;
case MonetaryAccountJoint::class:
/** @var MonetaryAccountJoint $object */
$array = $this->processMaj($object);
break;
case MonetaryAccountLight::class:
/** @var MonetaryAccountLight $object */
$array = $this->processMal($object);
break;
default:
// @codeCoverageIgnoreStart
throw new FireflyException(sprintf('Bunq import routine cannot handle account of type "%s".', \get_class($object)));
// @codeCoverageIgnoreEnd
}
if (null !== $array) {
$accounts[] = $array;
}
} }
} }
@@ -118,6 +149,7 @@ class StageNewHandler
'description' => $mab->getDescription(), 'description' => $mab->getDescription(),
'balance' => $mab->getBalance(), 'balance' => $mab->getBalance(),
'status' => $mab->getStatus(), 'status' => $mab->getStatus(),
'type' => 'MonetaryAccountBank',
'aliases' => [], 'aliases' => [],
]; ];
@@ -128,13 +160,111 @@ class StageNewHandler
'restriction_chat' => $mab->getSetting()->getRestrictionChat(), 'restriction_chat' => $mab->getSetting()->getRestrictionChat(),
]; ];
} }
/** @var Pointer $alias */ if (null !== $mab->getAlias()) {
foreach ($mab->getAlias() as $alias) { /** @var Pointer $alias */
$return['aliases'][] = [ foreach ($mab->getAlias() as $alias) {
'type' => $alias->getType(), $return['aliases'][] = [
'name' => $alias->getName(), 'type' => $alias->getType(),
'value' => $alias->getValue(), 'name' => $alias->getName(),
'value' => $alias->getValue(),
];
}
}
return $return;
}
/**
* @param MonetaryAccountJoint $maj
*
* @return array
*/
private function processMaj(MonetaryAccountJoint $maj): array
{
Log::debug('Now processing a MAJ');
$setting = $maj->getSetting();
$return = [
'id' => $maj->getId(),
'currency_code' => $maj->getCurrency(),
'description' => $maj->getDescription(),
'balance' => $maj->getBalance(),
'status' => $maj->getStatus(),
'type' => 'MonetaryAccountJoint',
'co-owners' => [],
'aliases' => [],
];
if (null !== $setting) {
$return['settings'] = [
'color' => $maj->getSetting()->getColor(),
'default_avatar_status' => $maj->getSetting()->getDefaultAvatarStatus(),
'restriction_chat' => $maj->getSetting()->getRestrictionChat(),
]; ];
Log::debug('Setting is not null.');
}
if (null !== $maj->getAlias()) {
Log::debug(sprintf('Alias is not NULL. Count is %d', \count($maj->getAlias())));
/** @var Pointer $alias */
foreach ($maj->getAlias() as $alias) {
$return['aliases'][] = [
'type' => $alias->getType(),
'name' => $alias->getName(),
'value' => $alias->getValue(),
];
}
}
$coOwners = $maj->getAllCoOwner() ?? [];
Log::debug(sprintf('Count of getAllCoOwner is %d', \count($coOwners)));
/** @var CoOwner $coOwner */
foreach ($coOwners as $coOwner) {
$alias = $coOwner->getAlias();
if (null !== $alias) {
Log::debug('Alias is not NULL');
$name = (string)$alias->getDisplayName();
Log::debug(sprintf('Name is "%s"', $name));
if ('' !== $name) {
$return['co-owners'][] = $name;
}
}
}
return $return;
}
/**
* @param MonetaryAccountLight $mal
*
* @return array
*/
private function processMal(MonetaryAccountLight $mal): array
{
$setting = $mal->getSetting();
$return = [
'id' => $mal->getId(),
'currency_code' => $mal->getCurrency(),
'description' => $mal->getDescription(),
'balance' => $mal->getBalance(),
'status' => $mal->getStatus(),
'type' => 'MonetaryAccountLight',
'aliases' => [],
];
if (null !== $setting) {
$return['settings'] = [
'color' => $mal->getSetting()->getColor(),
'default_avatar_status' => $mal->getSetting()->getDefaultAvatarStatus(),
'restriction_chat' => $mal->getSetting()->getRestrictionChat(),
];
}
if (null !== $mal->getAlias()) {
/** @var Pointer $alias */
foreach ($mal->getAlias() as $alias) {
$return['aliases'][] = [
'type' => $alias->getType(),
'name' => $alias->getName(),
'value' => $alias->getValue(),
];
}
} }
return $return; return $return;

317
tests/Unit/Support/Import/Routine/Bunq/StageNewHandlerTest.php Normal file
View File

@@ -0,0 +1,317 @@
<?php
/**
* StageNewHandlerTest.php
* Copyright (c) 2018 thegrumpydictator@gmail.com
*
* This file is part of Firefly III.
*
* Firefly III is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Firefly III is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Firefly III. If not, see <http://www.gnu.org/licenses/>.
*/
declare(strict_types=1);
namespace tests\Unit\Support\Import\Routine\Bunq;
use bunq\Model\Generated\Endpoint\BunqResponseMonetaryAccountList;
use bunq\Model\Generated\Endpoint\MonetaryAccount as BunqMonetaryAccount;
use bunq\Model\Generated\Endpoint\MonetaryAccountBank as BunqMonetaryAccountBank;
use bunq\Model\Generated\Endpoint\MonetaryAccountJoint;
use bunq\Model\Generated\Endpoint\MonetaryAccountLight;
use bunq\Model\Generated\Object\CoOwner;
use bunq\Model\Generated\Object\LabelUser;
use bunq\Model\Generated\Object\MonetaryAccountSetting;
use bunq\Model\Generated\Object\Pointer;
use FireflyIII\Exceptions\FireflyException;
use FireflyIII\Models\ImportJob;
use FireflyIII\Models\Preference;
use FireflyIII\Repositories\ImportJob\ImportJobRepositoryInterface;
use FireflyIII\Services\Bunq\ApiContext;
use FireflyIII\Services\Bunq\MonetaryAccount;
use FireflyIII\Support\Import\Routine\Bunq\StageNewHandler;
use Mockery;
use Preferences;
use Tests\Object\FakeApiContext;
use Tests\TestCase;
/**
* Class StageNewHandlerTest
*/
class StageNewHandlerTest extends TestCase
{
/**
* @covers \FireflyIII\Support\Import\Routine\Bunq\StageNewHandler
*/
public function testRun(): void
{
$job = new ImportJob;
$job->user_id = $this->user()->id;
$job->key = 'snh_bunq_' . random_int(1, 1000);
$job->status = 'new';
$job->stage = 'new';
$job->provider = 'bunq';
$job->file_type = '';
$job->configuration = [];
$job->save();
$pref = new Preference;
$pref->name = 'some-name';
$pref->data = '{"a": "b"}';
// create fake bunq object:
$setting = new MonetaryAccountSetting(null, null, null);
$mab = new BunqMonetaryAccountBank('EUR', 'Some descr', null, null, null, null, null, null, null, null);
$ma = new BunqMonetaryAccount;
$alias = new Pointer('a', 'b', null);
// dont care about deprecation.
$alias->setType('IBAN');
$alias->setName('Somebody');
$alias->setValue('SM72C9584723533916792029340');
$setting->setColor('FFFFFF');
$mab->setSetting($setting);
$mab->setAlias([$alias]);
$ma->setMonetaryAccountBank($mab);
// response list.
$list = new BunqResponseMonetaryAccountList([$ma], []);
$expectedConfig = [
'accounts' => [
0 => [
'id' => null,
'currency_code' => null,
'description' => null,
'balance' => null,
'status' => null,
'type' => 'MonetaryAccountBank',
'aliases' => [
[
'name' => $alias->getName(),
'type' => $alias->getType(),
'value' => $alias->getValue(),
],
],
'settings' => [
'color' => $setting->getColor(),
'default_avatar_status' => null,
'restriction_chat' => null,
],
],
],
];
// mock classes
$apiContext = $this->mock(ApiContext::class);
$repository = $this->mock(ImportJobRepositoryInterface::class);
$mAccount = $this->mock(MonetaryAccount::class);
// mock calls
Preferences::shouldReceive('getForUser')->withArgs([Mockery::any(), 'bunq_api_context', null])->once()->andReturn($pref);
$apiContext->shouldReceive('fromJson')->withArgs(['{"a": "b"}'])->once()->andReturn(new FakeApiContext);
$repository->shouldReceive('setUser')->once();
$mAccount->shouldReceive('listing')->andReturn($list)->once();
$repository->shouldReceive('getConfiguration')->once()->andReturn([]);
$repository->shouldReceive('setConfiguration')->once()->withArgs([Mockery::any(), $expectedConfig]);
$handler = new StageNewHandler;
$handler->setImportJob($job);
try {
$handler->run();
} catch (FireflyException $e) {
$this->assertFalse(true, $e->getMessage());
}
}
/**
* @covers \FireflyIII\Support\Import\Routine\Bunq\StageNewHandler
*/
public function testRunMaj(): void
{
$job = new ImportJob;
$job->user_id = $this->user()->id;
$job->key = 'snha_bunq_' . random_int(1, 1000);
$job->status = 'new';
$job->stage = 'new';
$job->provider = 'bunq';
$job->file_type = '';
$job->configuration = [];
$job->save();
$pref = new Preference;
$pref->name = 'some-name';
$pref->data = '{"a": "b"}';
// create fake bunq object:
$setting = new MonetaryAccountSetting(null, null, null);
$maj = new MonetaryAccountJoint('EUR', [], 'Some descr', null, null, null, null, null, null, null, null);
$ma = new BunqMonetaryAccount;
$alias = new Pointer('a', 'b', null);
$labelUser = new LabelUser('x', 'James', 'NL');
$coOwner = new CoOwner($alias);
// dont care about deprecation.
$alias->setType('IBAN');
$alias->setName('Somebody');
$alias->setValue('SM72C9584723533916792029340');
$labelUser->setDisplayName('James');
$setting->setColor('FFFFFF');
$maj->setSetting($setting);
$maj->setAlias([$alias]);
$maj->setAllCoOwner([$coOwner]);
$ma->setMonetaryAccountJoint($maj);
$coOwner->setAlias($labelUser);
// response list.
$list = new BunqResponseMonetaryAccountList([$ma], []);
$expectedConfig = [
'accounts' => [
0 => [
'id' => null,
'currency_code' => null,
'description' => null,
'balance' => null,
'status' => null,
'type' => 'MonetaryAccountJoint',
'co-owners' => ['James'],
'aliases' => [
[
'name' => $alias->getName(),
'type' => $alias->getType(),
'value' => $alias->getValue(),
],
],
'settings' => [
'color' => $setting->getColor(),
'default_avatar_status' => null,
'restriction_chat' => null,
],
],
],
];
// mock classes
$apiContext = $this->mock(ApiContext::class);
$repository = $this->mock(ImportJobRepositoryInterface::class);
$mAccount = $this->mock(MonetaryAccount::class);
// mock calls
Preferences::shouldReceive('getForUser')->withArgs([Mockery::any(), 'bunq_api_context', null])->once()->andReturn($pref);
$apiContext->shouldReceive('fromJson')->withArgs(['{"a": "b"}'])->once()->andReturn(new FakeApiContext);
$repository->shouldReceive('setUser')->once();
$mAccount->shouldReceive('listing')->andReturn($list)->once();
$repository->shouldReceive('getConfiguration')->once()->andReturn([]);
$repository->shouldReceive('setConfiguration')->once()->withArgs([Mockery::any(), $expectedConfig]);
$handler = new StageNewHandler;
$handler->setImportJob($job);
try {
$handler->run();
} catch (FireflyException $e) {
$this->assertFalse(true, $e->getMessage());
}
}
/**
* @covers \FireflyIII\Support\Import\Routine\Bunq\StageNewHandler
*/
public function testRunMal(): void
{
$job = new ImportJob;
$job->user_id = $this->user()->id;
$job->key = 'snh_bbunq_' . random_int(1, 1000);
$job->status = 'new';
$job->stage = 'new';
$job->provider = 'bunq';
$job->file_type = '';
$job->configuration = [];
$job->save();
$pref = new Preference;
$pref->name = 'some-name';
$pref->data = '{"a": "b"}';
// create fake bunq object:
$setting = new MonetaryAccountSetting(null, null, null);
$mal = new MonetaryAccountLight('EUR', 'Some descr', null, null, null, null, null, null, null, null);
$ma = new BunqMonetaryAccount;
$alias = new Pointer('a', 'b', null);
// dont care about deprecation.
$alias->setType('IBAN');
$alias->setName('Somebody');
$alias->setValue('SM72C9584723533916792029340');
$setting->setColor('FFFFFF');
$mal->setSetting($setting);
$mal->setAlias([$alias]);
$ma->setMonetaryAccountLight($mal);
// response list.
$list = new BunqResponseMonetaryAccountList([$ma], []);
$expectedConfig = [
'accounts' => [
0 => [
'id' => null,
'currency_code' => null,
'description' => null,
'balance' => null,
'status' => null,
'type' => 'MonetaryAccountLight',
'aliases' => [
[
'name' => $alias->getName(),
'type' => $alias->getType(),
'value' => $alias->getValue(),
],
],
'settings' => [
'color' => $setting->getColor(),
'default_avatar_status' => null,
'restriction_chat' => null,
],
],
],
];
// mock classes
$apiContext = $this->mock(ApiContext::class);
$repository = $this->mock(ImportJobRepositoryInterface::class);
$mAccount = $this->mock(MonetaryAccount::class);
// mock calls
Preferences::shouldReceive('getForUser')->withArgs([Mockery::any(), 'bunq_api_context', null])->once()->andReturn($pref);
$apiContext->shouldReceive('fromJson')->withArgs(['{"a": "b"}'])->once()->andReturn(new FakeApiContext);
$repository->shouldReceive('setUser')->once();
$mAccount->shouldReceive('listing')->andReturn($list)->once();
$repository->shouldReceive('getConfiguration')->once()->andReturn([]);
$repository->shouldReceive('setConfiguration')->once()->withArgs([Mockery::any(), $expectedConfig]);
$handler = new StageNewHandler;
$handler->setImportJob($job);
try {
$handler->run();
} catch (FireflyException $e) {
$this->assertFalse(true, $e->getMessage());
}
}
}