Cutlery/invoiceninja
1
0
Fork 0
mirror of https://github.com/invoiceninja/invoiceninja.git synced 2025-07-09 03:14:30 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fixes for QB pr

Browse Source
This commit is contained in:
David Bomba 2024-08-21 13:04:09 +10:00
parent ed84689ca0
commit 9c225458c6
12 changed files with 149 additions and 266 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
app/Factory/QuickbooksSDKFactory.php
View File

@ -1,63 +0,0 @@
<?php
namespace App\Factory;
use App\Libraries\MultiDB;
use Illuminate\Support\Str;
use Illuminate\Support\Facades\DB;
use Illuminate\Support\Facades\Auth;
use Illuminate\Support\Facades\Cache;
use QuickBooksOnline\API\DataService\DataService;
use App\Services\Import\Quickbooks\Repositories\CompanyTokensRepository;
class QuickbooksSDKFactory
{
public static function create()
{
$tokens = [];
// Ensure the user is authenticated
if(($user = Auth::user()))
{
$company = $user->company();
$token_store = (new CompanyTokensRepository($company->company_key));
$tokens = array_filter($token_store->get());
if(!empty($tokens)) {
$keys = ['refreshTokenKey','QBORealmID'];
if(array_key_exists('access_token', $tokens)) {
$keys = array_merge(['accessTokenKey'] ,$keys);
}
$tokens = array_combine($keys, array_values($tokens));
}
}
$config = $tokens + config('services.quickbooks.settings') + [
'state' => Str::random(12)
];
$sdk = DataService::Configure($config);
if (env('APP_DEBUG')) {
$sdk->setLogLocation(storage_path("logs/quickbooks.log"));
$sdk->enableLog();
}
$sdk->setMinorVersion("73");
$sdk->throwExceptionOnError(true);
if(array_key_exists('refreshTokenKey', $config) && !array_key_exists('accessTokenKey', $config))
{
$tokens = ($sdk->getOAuth2LoginHelper())->refreshToken();
$sdk = $sdk->updateOAuth2Token($tokens);
$tokens = ($sdk->getOAuth2LoginHelper())->getAccessToken();
$access_token = $tokens->getAccessToken();
$realm = $tokens->getRealmID();
$refresh_token = $tokens->getRefreshToken();
$access_token_expires = $tokens->getAccessTokenExpiresAt();
$refresh_token_expires = $tokens->getRefreshTokenExpiresAt();
$tokens = compact('access_token', 'refresh_token','access_token_expires', 'refresh_token_expires','realm');
$token_store->save($tokens);
}
return $sdk;
}
}

158
app/Http/Controllers/ImportQuickbooksController.php
View File

@ -5,18 +5,21 @@ namespace App\Http\Controllers;
use \Closure; use \Closure;
use App\Utils\Ninja; use App\Utils\Ninja;
use App\Models\Company; use App\Models\Company;
use App\Libraries\MultiDB;
use Illuminate\Support\Str; use Illuminate\Support\Str;
use Illuminate\Http\Request; use Illuminate\Http\Request;
use Illuminate\Http\Response; use Illuminate\Http\Response;
use App\Utils\Traits\MakesHash; use App\Utils\Traits\MakesHash;
use Illuminate\Support\Facades\Cache;
use App\Jobs\Import\QuickbooksIngest; use App\Jobs\Import\QuickbooksIngest;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\Facades\Validator; use Illuminate\Support\Facades\Validator;
use App\Services\Import\Quickbooks\Service as QuickbooksService; use App\Http\Requests\Quickbooks\AuthQuickbooksRequest;
use App\Services\Import\Quickbooks\QuickbooksService;
class ImportQuickbooksController extends BaseController class ImportQuickbooksController extends BaseController
{ {
protected QuickbooksService $service; // protected QuickbooksService $service;
private $import_entities = [ private $import_entities = [
'client' => 'Customer', 'client' => 'Customer',
'invoice' => 'Invoice', 'invoice' => 'Invoice',
@ -24,79 +27,79 @@ class ImportQuickbooksController extends BaseController
'payment' => 'Payment' 'payment' => 'Payment'
]; ];
public function __construct(QuickbooksService $service) { // public function __construct(QuickbooksService $service) {
parent::__construct(); // parent::__construct();
$this->service = $service; // $this->service = $service;
$this->middleware( // $this->middleware(
function (Request $request, Closure $next) { // function (Request $request, Closure $next) {
// Check for the required query parameters // // Check for the required query parameters
if (!$request->has(['code', 'state', 'realmId'])) { // if (!$request->has(['code', 'state', 'realmId'])) {
return abort(400,'Unauthorized'); // return abort(400,'Unauthorized');
} // }
$rules = [ // $rules = [
'state' => [ // 'state' => [
'required', // 'required',
'valid' => function ($attribute, $value, $fail) { // 'valid' => function ($attribute, $value, $fail) {
if (!Cache::has($value)) { // if (!Cache::has($value)) {
$fail('The state is invalid.'); // $fail('The state is invalid.');
} // }
}, // },
] // ]
]; // ];
// Custom error messages // // Custom error messages
$messages = [ // $messages = [
'state.required' => 'The state is required.', // 'state.required' => 'The state is required.',
'state.valid' => 'state token not valid' // 'state.valid' => 'state token not valid'
]; // ];
// Perform the validation // // Perform the validation
$validator = Validator::make($request->all(), $rules, $messages); // $validator = Validator::make($request->all(), $rules, $messages);
if ($validator->fails()) { // if ($validator->fails()) {
// If validation fails, redirect back with errors and input // // If validation fails, redirect back with errors and input
return redirect('/') // return redirect('/')
->withErrors($validator) // ->withErrors($validator)
->withInput(); // ->withInput();
} // }
$token = Cache::pull($request->state); // $token = Cache::pull($request->state);
$request->merge(['company' => Cache::get($token) ]); // $request->merge(['company' => Cache::get($token) ]);
return $next($request); // return $next($request);
} // }
)->only('onAuthorized'); // )->only('onAuthorized');
$this->middleware( // $this->middleware(
function ( Request $request, Closure $next) { // function ( Request $request, Closure $next) {
$rules = [ // $rules = [
'token' => [ // 'token' => [
'required', // 'required',
'valid' => function ($attribute, $value, $fail) { // 'valid' => function ($attribute, $value, $fail) {
if (!Cache::has($value) || (!Company::where('company_key', (Cache::get($value))['company_key'])->exists() )) { // if (!Cache::has($value) || (!Company::where('company_key', (Cache::get($value))['company_key'])->exists() )) {
$fail('The company is invalid.'); // $fail('The company is invalid.');
} // }
}, // },
] // ]
]; // ];
// Custom error messages // // Custom error messages
$messages = [ // $messages = [
'token.required' => 'The token is required.', // 'token.required' => 'The token is required.',
'token.valid' => 'Token note valid!' // 'token.valid' => 'Token note valid!'
]; // ];
// Perform the validation // // Perform the validation
$validator = Validator::make(['token' => $request->token ], $rules, $messages); // $validator = Validator::make(['token' => $request->token ], $rules, $messages);
if ($validator->fails()) { // if ($validator->fails()) {
return redirect() // return redirect()
->back() // ->back()
->withErrors($validator) // ->withErrors($validator)
->withInput(); // ->withInput();
} // }
//If validation passes, proceed to the next middleware/controller // //If validation passes, proceed to the next middleware/controller
return $next($request); // return $next($request);
} // }
)->only('authorizeQuickbooks'); // )->only('authorizeQuickbooks');
} // }
public function onAuthorized(Request $request) public function onAuthorized(Request $request)
{ {
@ -114,12 +117,15 @@ class ImportQuickbooksController extends BaseController
* *
* @return bool * @return bool
*/ */
public function authorizeQuickbooks(Request $request) public function authorizeQuickbooks(AuthQuickbooksRequest $request, string $token)
{ {
$token = $request->token;
$auth = $this->service->getOAuth(); MultiDB::findAndSetDbByCompanyKey($request->getTokenContent()['company_key']);
$authorizationUrl = $auth->getAuthorizationUrl(); $company = $request->getCompany();
$state = $auth->getState(); $qb = new QuickbooksService($company);
$authorizationUrl = $qb->getAuth()->getAuthorizationUrl();
$state = $qb->getAuth()->getState();
Cache::put($state, $token, 190); Cache::put($state, $token, 190);
@ -186,7 +192,7 @@ class ImportQuickbooksController extends BaseController
$this->preimport($type, $hash); $this->preimport($type, $hash);
} }
/** @var \App\Models\User $user */ /** @var \App\Models\User $user */
$user = auth()->user() ?? Auth::loginUsingId(60); // $user = auth()->user() ?? Auth::loginUsingId(60);
$data = ['import_types' => $request->input('import_types') ] + compact('hash'); $data = ['import_types' => $request->input('import_types') ] + compact('hash');
if (Ninja::isHosted()) { if (Ninja::isHosted()) {
QuickbooksIngest::dispatch( $data , $user->company() ); QuickbooksIngest::dispatch( $data , $user->company() );

2
app/Models/Company.php
View File

@ -118,6 +118,7 @@ use Laracasts\Presenter\PresentableTrait;
* @property string|null $smtp_port * @property string|null $smtp_port
* @property string|null $smtp_encryption * @property string|null $smtp_encryption
* @property string|null $smtp_local_domain * @property string|null $smtp_local_domain
* @property string|null $quickbooks
* @property boolean $smtp_verify_peer * @property boolean $smtp_verify_peer
* @property-read \App\Models\Account $account * @property-read \App\Models\Account $account
* @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\Activity> $activities * @property-read \Illuminate\Database\Eloquent\Collection<int, \App\Models\Activity> $activities
@ -390,6 +391,7 @@ class Company extends BaseModel
'smtp_username' => 'encrypted', 'smtp_username' => 'encrypted',
'smtp_password' => 'encrypted', 'smtp_password' => 'encrypted',
'e_invoice' => 'object', 'e_invoice' => 'object',
'quickbooks' => 'object',
]; ];
protected $with = []; protected $with = [];

84
app/Providers/QuickbooksServiceProvider.php
View File

@ -1,84 +0,0 @@
<?php
namespace App\Providers;
use Illuminate\Support\Str;
use Illuminate\Support\Facades\Route;
use App\Factory\QuickbooksSDKFactory;
use Illuminate\Support\ServiceProvider;
use App\Http\Controllers\ImportQuickbooksController;
use App\Services\Import\Quickbooks\Service as QuickbooksService;
use App\Repositories\Import\Quickcbooks\Contracts\RepositoryInterface;
use App\Services\Import\Quickbooks\SdkWrapper as QuickbooksSDKWrapper;
use App\Services\Import\Quickbooks\Contracts\SdkInterface as QuickbooksInterface;
use App\Services\Import\Quickbooks\Transformers\Transformer as QuickbooksTransformer;
class QuickbooksServiceProvider extends ServiceProvider
{
/**
* Register services.
*
* @return void
*/
public function register()
{
$this->app->bind(QuickbooksInterface::class, function ($app) {
return new QuickbooksSDKWrapper(QuickbooksSDKFactory::create());
});
// Register SDKWrapper with DataService dependency
$this->app->singleton(QuickbooksService::class, function ($app) {
return new QuickbooksService($app->make(QuickbooksInterface::class));
});
$this->app->singleton(QuickbooksTransformer::class,QuickbooksTransformer::class);
}
/**
* Bootstrap services.
*
* @return void
*/
public function boot()
{
$this->registerRoutes();
$this->registerConfig();
}
protected function registerConfig() {
config()->set( 'services.quickbooks' ,
['settings' => [
'auth_mode' => 'oauth2',
'ClientID' => env('QUICKBOOKS_CLIENT_ID', false),
'ClientSecret' => env('QUICKBOOKS_CLIENT_SECRET', false),
// TODO use env('QUICKBOOKS_REDIRECT_URI') or route()/ url()
'RedirectURI' => url("/quickbooks/authorized"),
'scope' => "com.intuit.quickbooks.accounting",
'baseUrl' => ucfirst(env('APP_ENV'))
],
'debug' => env('APP_DEBUG') || env('APP_ENV')
]
);
}
/**
* Register custom routes.
*
* @return void
*/
protected function registerRoutes()
{
Route::middleware('web')
->namespace($this->app->getNamespace() . 'Http\Controllers')
->group(function () {
Route::get('quickbooks/authorize/{token}', [ImportQuickbooksController::class, 'authorizeQuickbooks'])->name('authorize.quickbooks');
Route::get('quickbooks/authorized', [ImportQuickbooksController::class, 'onAuthorized'])->name('authorized.quickbooks');
});
Route::prefix('api/v1')
->middleware('api')
->namespace($this->app->getNamespace() . 'Http\Controllers')
->group(function () {
Route::post('import/quickbooks', [ImportQuickbooksController::class, 'import'])->name('import.quickbooks');
});
}
}

68
app/Services/Import/Quickbooks/Auth.php
View File

@ -1,66 +1,72 @@
<?php <?php
/**
* Invoice Ninja (https://invoiceninja.com).
*
* @link https://github.com/invoiceninja/invoiceninja source repository
*
* @copyright Copyright (c) 2024. Invoice Ninja LLC (https://invoiceninja.com)
*
* @license https://www.elastic.co/licensing/elastic-license
*/
namespace App\Services\Import\Quickbooks; namespace App\Services\Import\Quickbooks;
use Illuminate\Support\Collection; use QuickBooksOnline\API\DataService\DataService;
use Illuminate\Support\Facades\Cache;
use App\Services\Import\Quickbooks\Repositories\CompanyTokensRepository;
use App\Services\Import\QuickBooks\Contracts\SDKInterface as QuickbooksInterface;
final class Auth final class Auth
{ {
private QuickbooksInterface $sdk; public function __construct(private DataService $sdk)
{
public function __construct(QuickbooksInterface $quickbooks) {
$this->sdk = $quickbooks;
} }
public function accessToken(string $code, string $realm ) : array public function accessToken(string $code, string $realm): array
{ {
// TODO: Get or put token in Cache or DB? // TODO: Get or put token in Cache or DB?
return $this->sdk->accessToken($code, $realm); return $this->sdk->accessToken($code, $realm);
} }
public function refreshToken() : array public function refreshToken(): array
{ {
// TODO: Get or put token in Cache or DB? // TODO: Get or put token in Cache or DB?
return $this->sdk->refreshToken(); return $this->sdk->refreshToken();
} }
public function getAuthorizationUrl(): string public function getAuthorizationUrl(): string
{ {
return $this->sdk->getAuthorizationUrl(); return $this->sdk->getAuthorizationUrl();
} }
public function getState() : string public function getState(): string
{ {
return $this->sdk->getState(); return $this->sdk->getState();
} }
public function saveTokens($key, $tokens) public function saveTokens($key, $tokens)
{ {
$token_store = new CompanyTokensRepository($key); // $token_store = new CompanyTokensRepository($key);
$token_store->save($tokens); // $token_store->save($tokens);
} }
public function getAccessToken() : array public function getAccessToken(): array
{ {
$token_store = new CompanyTokensRepository(); $tokens = [];
$tokens = $token_store->get(); // $token_store = new CompanyTokensRepository();
if(empty($tokens)) { // $tokens = $token_store->get();
$token = $this->sdk->getAccessToken(); // if(empty($tokens)) {
$access_token = $token->getAccessToken(); // $token = $this->sdk->getAccessToken();
$realm = $token->getRealmID(); // $access_token = $token->getAccessToken();
$refresh_token = $token->getRefreshToken(); // $realm = $token->getRealmID();
$access_token_expires = $token->getAccessTokenExpiresAt(); // $refresh_token = $token->getRefreshToken();
$refresh_token_expires = $token->getRefreshTokenExpiresAt(); // $access_token_expires = $token->getAccessTokenExpiresAt();
$tokens = compact('access_token', 'refresh_token','access_token_expires', 'refresh_token_expires','realm'); // $refresh_token_expires = $token->getRefreshTokenExpiresAt();
} // $tokens = compact('access_token', 'refresh_token','access_token_expires', 'refresh_token_expires','realm');
// }
return $tokens; return $tokens;
} }
public function getRefreshToken() : array public function getRefreshToken(): array
{ {
return $this->getAccessToken(); return $this->getAccessToken();
} }
} }

1
app/Transformers/CompanyTransformer.php
View File

@ -212,6 +212,7 @@ class CompanyTransformer extends EntityTransformer
'smtp_local_domain' => (string)$company->smtp_local_domain ?? '', 'smtp_local_domain' => (string)$company->smtp_local_domain ?? '',
'smtp_verify_peer' => (bool)$company->smtp_verify_peer, 'smtp_verify_peer' => (bool)$company->smtp_verify_peer,
'e_invoice' => $company->e_invoice ?: new \stdClass(), 'e_invoice' => $company->e_invoice ?: new \stdClass(),
'quickbooks' => $company->quickbooks ?: new \stdClass(),
]; ];
} }

1
config/app.php
View File

@ -201,7 +201,6 @@ return [
App\Providers\ClientPortalServiceProvider::class, App\Providers\ClientPortalServiceProvider::class,
App\Providers\NinjaTranslationServiceProvider::class, App\Providers\NinjaTranslationServiceProvider::class,
App\Providers\StaticServiceProvider::class, App\Providers\StaticServiceProvider::class,
App\Providers\QuickbooksServiceProvider::class
], ],
/* /*

14
config/services.php
View File

@ -120,5 +120,17 @@ return [
'chorus' => [ 'chorus' => [
'client_id' => env('CHORUS_CLIENT_ID', false), 'client_id' => env('CHORUS_CLIENT_ID', false),
'secret' => env('CHORUS_SECRET', false), 'secret' => env('CHORUS_SECRET', false),
] ],
'quickbooks' => [
// 'auth_mode' => 'oauth2',
'client_id' => env('QUICKBOOKS_CLIENT_ID', false),
'client_secret' => env('QUICKBOOKS_CLIENT_SECRET', false),
// 'ClientID' => env('QUICKBOOKS_CLIENT_ID', false),
// 'ClientSecret' => env('QUICKBOOKS_CLIENT_SECRET', false),
// TODO use env('QUICKBOOKS_REDIRECT_URI') or route()/ url()
// 'RedirectURI' => url("/quickbooks/authorized"),
// 'scope' => "com.intuit.quickbooks.accounting",
// 'baseUrl' => ucfirst(env('APP_URL'))
'debug' => env('APP_DEBUG',false)
],
]; ];

10
database/migrations/2024_08_02_144614_alter_companies_quickbooks.php
View File

@ -12,11 +12,9 @@ return new class extends Migration
* @return void * @return void
*/ */
public function up() public function up()
{ {
Schema::table('companies', function (Blueprint $table) { Schema::table('companies', function (Blueprint $table) {
$table->string('quickbooks_realm_id')->nullable(); $table->text('quickbooks')->nullable();
$table->string('quickbooks_refresh_token')->nullable();
$table->dateTime('quickbooks_refresh_expires')->nullable();
}); });
} }
@ -27,8 +25,6 @@ return new class extends Migration
*/ */
public function down() public function down()
{ {
Schema::table('companies', function (Blueprint $table) {
$table->dropColumn(['quickbooks_realm_id', 'quickbooks_refresh_token','quickbooks_refresh_expires']);
});
} }
}; };

6
routes/api.php
View File

@ -427,6 +427,9 @@ Route::group(['middleware' => ['throttle:api', 'api_db', 'token_auth', 'locale']
Route::post('yodlee/status/{account_number}', [YodleeController::class, 'accountStatus']); // @todo @turbo124 check route-path?! Route::post('yodlee/status/{account_number}', [YodleeController::class, 'accountStatus']); // @todo @turbo124 check route-path?!
Route::get('nordigen/institutions', [NordigenController::class, 'institutions'])->name('nordigen.institutions'); Route::get('nordigen/institutions', [NordigenController::class, 'institutions'])->name('nordigen.institutions');
Route::post('import/quickbooks', [ImportQuickbooksController::class, 'import'])->name('import.quickbooks');
}); });
Route::post('api/v1/sms_reset', [TwilioController::class, 'generate2faResetCode'])->name('sms_reset.generate')->middleware('throttle:3,1'); Route::post('api/v1/sms_reset', [TwilioController::class, 'generate2faResetCode'])->name('sms_reset.generate')->middleware('throttle:3,1');
@ -460,4 +463,7 @@ Route::post('api/v1/yodlee/balance', [YodleeController::class, 'balanceWebhook']
Route::get('api/v1/protected_download/{hash}', [ProtectedDownloadController::class, 'index'])->name('protected_download')->middleware('throttle:300,1'); Route::get('api/v1/protected_download/{hash}', [ProtectedDownloadController::class, 'index'])->name('protected_download')->middleware('throttle:300,1');
Route::post('api/v1/ppcp/webhook', [PayPalPPCPPaymentDriver::class, 'processWebhookRequest'])->middleware('throttle:1000,1'); Route::post('api/v1/ppcp/webhook', [PayPalPPCPPaymentDriver::class, 'processWebhookRequest'])->middleware('throttle:1000,1');
Route::get('quickbooks/authorize/{token}', [ImportQuickbooksController::class, 'authorizeQuickbooks'])->name('quickbooks.authorize');
Route::get('quickbooks/authorized', [ImportQuickbooksController::class, 'onAuthorized'])->name('quickbooks.authorized');
Route::fallback([BaseController::class, 'notFound'])->middleware('throttle:404'); Route::fallback([BaseController::class, 'notFound'])->middleware('throttle:404');

3
routes/web.php
View File

@ -51,4 +51,5 @@ Route::get('mollie/3ds_redirect/{company_key}/{company_gateway_id}/{hash}', [Mol
Route::get('gocardless/ibp_redirect/{company_key}/{company_gateway_id}/{hash}', [GoCardlessController::class, 'ibpRedirect'])->middleware('domain_db')->name('gocardless.ibp_redirect'); Route::get('gocardless/ibp_redirect/{company_key}/{company_gateway_id}/{hash}', [GoCardlessController::class, 'ibpRedirect'])->middleware('domain_db')->name('gocardless.ibp_redirect');
Route::get('.well-known/apple-developer-merchantid-domain-association', [ApplePayDomainController::class, 'showAppleMerchantId']); Route::get('.well-known/apple-developer-merchantid-domain-association', [ApplePayDomainController::class, 'showAppleMerchantId']);
Broadcast::routes(['middleware' => ['token_auth']]);
\Illuminate\Support\Facades\Broadcast::routes(['middleware' => ['token_auth']]);

5
tests/Unit/Services/Import/Quickbooks/SdkWrapperTest.php
View File

@ -18,10 +18,11 @@ class SdkWrapperTest extends TestCase
{ {
parent::setUp(); parent::setUp();
$this->sdkMock = Mockery::mock(sdtClass::class);
$this->sdkMock = Mockery::mock(\stdClass::class);
$this->sdk = new QuickbookSDK($this->sdkMock); $this->sdk = new QuickbookSDK($this->sdkMock);
$this->markTestSkipped('no resource');
} }
function testIsInstanceOf() { function testIsInstanceOf() {