Merge branch 'release/0.3.0'

Author: JC5

.env.example

@@ -118,26 +118,31 @@ ASSET_URL=
 #
 ENABLE_MAIL_REPORT=false
 
+#
+# Force Firefly III URL to be secure?
+#
+#
+EXPECT_SECURE_URL=false
+
 # If enabled, define which mailer you want to use.
 # Options include: smtp, mailgun, postmark, sendmail, log, array
 # Amazon SES is not supported.
 # log = drop mails in the logs instead of sending them
 # array = debug mailer that does nothing.
-MAIL_DESTINATION=YOUR_OWN_EMAIL@example.com
+MAIL_MAILER=
 
-#
-# Force Firefly III URL to be secure?
-#
-#
-EXPECT_SECURE_URL=false
 
-MAIL_MAILER=smtp
-MAIL_HOST=example.com
-MAIL_PORT=25
-MAIL_ENCRYPTION=tls
-MAIL_USERNAME=username
-MAIL_PASSWORD=secret
+# where to send the report?
+MAIL_DESTINATION=
+
+# other mail settings
 MAIL_FROM_ADDRESS=noreply@example.com
+MAIL_DRIVER=smtp
+MAIL_HOST=smtp.mailtrap.io
+MAIL_PORT=2525
+MAIL_USERNAME=563136238357725d5
+MAIL_PASSWORD=0405093edbe475
+MAIL_ENCRYPTION=null
 
 # Extra settings depending on your mail configuration above.
 MAILGUN_DOMAIN=
@@ -169,7 +174,7 @@ TRACKER_SITE_ID=
 TRACKER_URL=
 
 
-APP_NAME=CSVImporter
+APP_NAME=DataImporter
 
 #
 # The APP_URL environment variable is NOT used anywhere.

app/Console/AutoImports.php

@@ -24,10 +24,11 @@
 
 namespace App\Console;
 
+use App\Events\ImportedTransactions;
 use App\Exceptions\ImporterErrorException;
-use App\Services\CSV\Configuration\Configuration;
 use App\Services\CSV\Conversion\RoutineManager as CSVRoutineManager;
 use App\Services\Nordigen\Conversion\RoutineManager as NordigenRoutineManager;
+use App\Services\Shared\Configuration\Configuration;
 use App\Services\Shared\Conversion\ConversionStatus;
 use App\Services\Shared\Conversion\RoutineStatusManager;
 use App\Services\Shared\Import\Routine\RoutineManager;
@@ -36,7 +37,6 @@
 use App\Services\Spectre\Conversion\RoutineManager as SpectreRoutineManager;
 use Illuminate\Contracts\Filesystem\FileNotFoundException;
 use JsonException;
-use Log;
 use Storage;
 
 /**
@@ -173,6 +173,8 @@ private function importFile(string $directory, string $file): void
             return;
         }
         $configuration = Configuration::fromArray(json_decode(file_get_contents($jsonFile), true));
+        $configuration->updateDateRange();
+
 
         $this->line(sprintf('Going to convert from file %s using configuration %s and flow "%s".', $csvFile, $jsonFile, $configuration->getFlow()));
 
@@ -185,7 +187,12 @@ private function importFile(string $directory, string $file): void
         $this->reportImport();
 
         $this->line('Done!');
-        // TODO send mail using event handler:
+        event(new ImportedTransactions(
+                  array_merge($this->conversionMessages, $this->importMessages),
+                  array_merge($this->conversionWarnings, $this->importWarnings),
+                  array_merge($this->conversionErrors, $this->importErrors)
+              )
+        );
 
     }
 
@@ -202,7 +209,7 @@ private function startConversion(Configuration $configuration, ?string $csvFile)
         $this->conversionWarnings = [];
         $this->conversionErrors   = [];
 
-        Log::debug(sprintf('Now in %s', __METHOD__));
+        app('log')->debug(sprintf('Now in %s', __METHOD__));
 
         switch ($configuration->getFlow()) {
             default:
@@ -233,14 +240,14 @@ private function startConversion(Configuration $configuration, ?string $csvFile)
         try {
             $transactions = $manager->start();
         } catch (ImporterErrorException $e) {
-            Log::error($e->getMessage());
+            app('log')->error($e->getMessage());
             RoutineStatusManager::setConversionStatus(ConversionStatus::CONVERSION_ERRORED, $this->identifier);
             $this->conversionMessages = $manager->getAllMessages();
             $this->conversionWarnings = $manager->getAllWarnings();
             $this->conversionErrors   = $manager->getAllErrors();
         }
         if (0 === count($transactions)) {
-            Log::error('Zero transactions!');
+            app('log')->error('Zero transactions!');
             RoutineStatusManager::setConversionStatus(ConversionStatus::CONVERSION_ERRORED, $this->identifier);
             $this->conversionMessages = $manager->getAllMessages();
             $this->conversionWarnings = $manager->getAllWarnings();
@@ -252,7 +259,7 @@ private function startConversion(Configuration $configuration, ?string $csvFile)
         try {
             $disk->put(sprintf('%s.json', $this->identifier), json_encode($transactions, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR));
         } catch (JsonException $e) {
-            Log::error(sprintf('JSON exception: %s', $e->getMessage()));
+            app('log')->error(sprintf('JSON exception: %s', $e->getMessage()));
             RoutineStatusManager::setConversionStatus(ConversionStatus::CONVERSION_ERRORED, $this->identifier);
             $this->conversionMessages = $manager->getAllMessages();
             $this->conversionWarnings = $manager->getAllWarnings();
@@ -300,7 +307,7 @@ private function reportConversion(): void
      */
     private function startImport(Configuration $configuration): void
     {
-        Log::debug(sprintf('Now at %s', __METHOD__));
+        app('log')->debug(sprintf('Now at %s', __METHOD__));
         $routine = new RoutineManager($this->identifier);
         SubmissionStatusManager::startOrFindSubmission($this->identifier);
         $disk     = Storage::disk('jobs');
@@ -322,7 +329,7 @@ private function startImport(Configuration $configuration): void
         try {
             $json         = $disk->get($fileName);
             $transactions = json_decode($json, true, 512, JSON_THROW_ON_ERROR);
-            Log::debug(sprintf('Found %d transactions on the drive.', count($transactions)));
+            app('log')->debug(sprintf('Found %d transactions on the drive.', count($transactions)));
         } catch (FileNotFoundException | JsonException $e) {
             SubmissionStatusManager::setSubmissionStatus(SubmissionStatus::SUBMISSION_ERRORED, $this->identifier);
             $message = sprintf('File "%s" could not be decoded, cannot continue..', $fileName);
@@ -343,7 +350,7 @@ private function startImport(Configuration $configuration): void
         try {
             $routine->start();
         } catch (ImporterErrorException $e) {
-            Log::error($e->getMessage());
+            app('log')->error($e->getMessage());
             SubmissionStatusManager::setSubmissionStatus(SubmissionStatus::SUBMISSION_ERRORED, $this->identifier);
             SubmissionStatusManager::addError($this->identifier, 0, $e->getMessage());
             $this->importMessages = $routine->getAllMessages();
@@ -357,9 +364,6 @@ private function startImport(Configuration $configuration): void
         $this->importMessages = $routine->getAllMessages();
         $this->importWarnings = $routine->getAllWarnings();
         $this->importErrors   = $routine->getAllErrors();
-
-        // TODO make event handler and send email message
-
     }
 
     /**

app/Console/Commands/AutoImport.php

@@ -29,7 +29,6 @@
 use App\Console\VerifyJSON;
 use App\Exceptions\ImporterErrorException;
 use Illuminate\Console\Command;
-use Log;
 
 /**
  * Class AutoImport
@@ -81,7 +80,7 @@ public function handle(): int
         try {
             $this->importFiles($directory, $files);
         } catch (ImporterErrorException $e) {
-            Log::error($e->getMessage());
+            app('log')->error($e->getMessage());
             $this->error(sprintf('Import exception (see the logs): %s', $e->getMessage()));
         }
 

app/Console/Commands/Import.php

@@ -27,10 +27,10 @@
 use App\Console\AutoImports;
 use App\Console\HaveAccess;
 use App\Console\VerifyJSON;
+use App\Events\ImportedTransactions;
 use App\Exceptions\ImporterErrorException;
-use App\Services\CSV\Configuration\Configuration;
+use App\Services\Shared\Configuration\Configuration;
 use Illuminate\Console\Command;
-use Log;
 
 /**
  * Class Import
@@ -71,14 +71,14 @@ public function handle(): int
         }
 
         $this->info(sprintf('Welcome to the Firefly III data importer, v%s', config('importer.version')));
-        Log::debug(sprintf('Now in %s', __METHOD__));
+        app('log')->debug(sprintf('Now in %s', __METHOD__));
         $file   = (string) $this->argument('file');
         $config = (string) $this->argument('config');
 
         if (!file_exists($config) || (file_exists($config) && !is_file($config))) {
             $message = sprintf('The importer can\'t import: configuration file "%s" does not exist or could not be read.', $config);
             $this->error($message);
-            Log::error($message);
+            app('log')->error($message);
 
             return 1;
         }
@@ -95,7 +95,7 @@ public function handle(): int
         if ('csv' === $configuration->getFlow() && (!file_exists($file) || (file_exists($file) && !is_file($file)))) {
             $message = sprintf('The importer can\'t import: CSV file "%s" does not exist or could not be read.', $file);
             $this->error($message);
-            Log::error($message);
+            app('log')->error($message);
 
             return 1;
         }
@@ -115,7 +115,8 @@ public function handle(): int
         $this->reportImport();
 
         $this->line('Done!');
-        // TODO send mail using event handler:
+
+        event(new ImportedTransactions($this->importMessages, $this->importWarnings, $this->importErrors));
         return 0;
 
     }

app/Console/VerifyJSON.php

@@ -26,7 +26,6 @@
 
 use Exception;
 use JsonException;
-use Log;
 
 /**
  * Trait VerifyJSON
@@ -46,7 +45,7 @@ private function verifyJSON(string $file): bool
             json_decode($json, true, 512, JSON_THROW_ON_ERROR);
         } catch (Exception | JsonException $e) {
             $message = sprintf('The importer can\'t import: could not decode the JSON in the config file: %s', $e->getMessage());
-            Log::error($message);
+            app('log')->error($message);
 
             return false;
 

app/Events/ImportedTransactions.php

@@ -0,0 +1,53 @@
+<?php
+declare(strict_types=1);
+/*
+ * ImportedTransactions.php
+ * Copyright (c) 2021 james@firefly-iii.org
+ *
+ * This file is part of the Firefly III Data Importer
+ * (https://github.com/firefly-iii/data-importer).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace App\Events;
+
+use Illuminate\Queue\SerializesModels;
+
+
+/**
+ * Class ImportedTransactions
+ */
+class ImportedTransactions
+{
+    use SerializesModels;
+
+    public array $messages;
+    public array $warnings;
+    public array $errors;
+
+    /**
+     * @param array $messages
+     * @param array $warnings
+     * @param array $errors
+     */
+    public function __construct(array $messages, array $warnings, array $errors)
+    {
+        app('log')->debug('Created event ImportedTransactions');
+        $this->messages = $messages;
+        $this->warnings = $warnings;
+        $this->errors   = $errors;
+
+    }
+}

app/Handlers/Events/ImportedTransactionsEventHandler.php

@@ -0,0 +1,61 @@
+<?php
+declare(strict_types=1);
+/*
+ * ImportedTransactionsEventHandler.php
+ * Copyright (c) 2021 james@firefly-iii.org
+ *
+ * This file is part of the Firefly III Data Importer
+ * (https://github.com/firefly-iii/data-importer).
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program 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 Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+namespace App\Handlers\Events;
+
+use App\Events\ImportedTransactions;
+use App\Mail\ImportReportMail;
+use Illuminate\Support\Facades\Mail;
+
+class ImportedTransactionsEventHandler
+{
+    /**
+     * @param ImportedTransactions $event
+     */
+    public function sendReportOverMail(ImportedTransactions $event): void
+    {
+        app('log')->debug('Now in sendReportOverMail');
+
+        $mailer = config('mail.default');
+        $receiver = config('mail.destination');
+        if('' === $mailer) {
+            app('log')->info('No mailer configured, will not mail.');
+            return;
+        }
+        if('' === $receiver) {
+            app('log')->info('No mail receiver configured, will not mail.');
+            return;
+        }
+
+        $log  =[
+            'messages' => $event->messages,
+            'warnings' => $event->warnings,
+            'errors' => $event->errors,
+        ];
+        app('log')->info('Will send report message.');
+        app('log')->debug('If no error below this line, mail was sent!');
+        Mail::to(config('mail.destination'))->send(new ImportReportMail($log));
+        app('log')->debug('If no error above this line, mail was sent!');
+    }
+
+}

app/Http/Controllers/DebugController.php

@@ -25,9 +25,7 @@
 
 namespace App\Http\Controllers;
 
-use Artisan;
 use Carbon\Carbon;
-use DB;
 use Exception;
 use Illuminate\Contracts\View\Factory;
 use Illuminate\Http\Request;
@@ -44,7 +42,6 @@ class DebugController extends Controller
      * @param Request $request
      *
      * @return Factory|View
-     * @throws FireflyException
      */
     public function index(Request $request)
     {