upgraded Laravel to 6.0 and other dependencies too while trying to improve code to handle options and errors more gracefully (see #7)(see #8)(see #9)

Author: ryancwalsh

README.md

@@ -5,13 +5,16 @@ Allows you to export JSON files of your most important data (questions, answers,
 
  1. I think this project requires PHP 7.3 or later, so be sure that your system complies.
  1. Sign up at https://stackapps.com/apps/oauth/register to receive a Client ID, Client Secret, and Key. (It's free, easy, and fast.)
- 1. Create a Laravel project, and make sure that it works: https://laravel.com/docs/5.8/installation#installing-laravel
- 1. Add this package into your Laravel project: `vagrant@vboxHomestead:~/Code/MyLaravelProject$ composer require ryancwalsh/stack-exchange-backup-laravel:dev-master --prefer-source`
+ 1. Create a Laravel project, and make sure that it works: https://laravel.com/docs/6.0/installation
+ 1. Add this package into your Laravel project: `vagrant@vboxHomestead:~/Code/MyLaravelProject$ composer require ryancwalsh/stack-exchange-backup-laravel:^2.0.0`
  1. Run `php artisan vendor:publish`, and if it gives you a choice, choose to publish from this package.
  1. Edit your Laravel project's `.env` file to have your own StackApps values. A non-working sample is below.
- 1. Run `php artisan exportStackExchange`. (Note that `php artisan exportStackExchange --flushCache` is an available option to clear the cached access code value.)
+ 1. Run `php artisan exportStackExchange`. There are also these options available:
+     1. `php artisan exportStackExchange --forgetCache` is an available option to clear the cached access code value.
+     1. `php artisan exportStackExchange --code=YOUR_CODE` is an available option to provide a code that you've already retrieved from StackExchange.
+     1. `php artisan exportStackExchange --S3=false` is an available option to skip uploading to Amazon S3.
  1. Following the instructions in the terminal, you'll use your browser to visit a URL that will provide you with a temporary access token to paste into the terminal.
- 1. Finished! The JSON files will appear in your `/storage/app/StackExchange` folder.
+ 1. Finished! The JSON files will appear in your `/storage/app/StackExchange` folder, and a zip of those files will appear in S3.
 
 ```
 # These are sample .env values:

composer.json

@@ -2,11 +2,14 @@
     "name": "ryancwalsh/stack-exchange-backup-laravel",
     "description": "My aim is to back up all of my questions and answers and anything else valuable in my accounts across all of the StackExchange sites (StackOverflow, SuperUser, https://apple.stackexchange.com/, https://askubuntu.com/, etc).",
     "type": "package",
+    "version": "2.0.0",
     "require": {
         "guzzlehttp/guzzle": "^6.3",
-        "php": "^7.2",
-        "laravel/framework": "^5.6",
-        "league/flysystem-aws-s3-v3": "^1.0"
+        "php": "^7.3",
+        "laravel/framework": "6.0.*",
+        "laravel/helpers": "^1.1",
+        "league/flysystem-aws-s3-v3": "^1.0",
+        "spatie/laravel-backup": "^6.4"
     },
     "autoload": {
         "psr-4": {

src/ExportStackExchangeCommand.php

@@ -5,18 +5,20 @@
 use Cache;
 use Carbon\Carbon;
 use Illuminate\Console\Command;
+use Log;
 
 class ExportStackExchangeCommand extends Command {
 
     const CODE_CACHE_KEY = 'stackAppsCode';
-    const FILENAME_SAFE_FORMAT = "Y-m-d_His_T";
+    const ENDPOINTS = ['answers' => 'activity', 'questions' => 'activity', 'comments' => 'creation', 'mentioned' => 'creation', 'favorites' => 'creation'];
+    const SE_URL_BEGINNING = 'https://stackexchange.com/oauth/login_success?code=';
 
     /**
      * The name and signature of the console command.
      *
      * @var string
      */
-    protected $signature = 'exportStackExchange {--code=} {--flushCache}';
+    protected $signature = 'exportStackExchange {--code=} {--S3=true} {--forgetCache}';
 
     /**
      * The console command description.
@@ -28,7 +30,7 @@ class ExportStackExchangeCommand extends Command {
 
     public function __construct() {
         parent::__construct();
-        $this->exportStackExchangeHelper = new ExportStackExchangeHelper();        
+        $this->exportStackExchangeHelper = new ExportStackExchangeHelper();
     }
 
     /**
@@ -38,26 +40,48 @@ public function __construct() {
      */
     public function handle() {
         $this->exportStackExchangeHelper->setConsoleOutput($this->getOutput());
-        if ($this->option('flushCache')) {
-            Cache::flush();
+        $this->handleForgetCacheOption();
+        try {
+            $this->handleStackExchangeCode();
+            $this->info(Carbon::now() . ' Starting.');
+            $this->exportStackExchangeHelper->setMomentString(Carbon::now()->format(\App\Helpers\ExtraTools::FILENAME_SAFE_FORMAT));
+            $mySites = $this->exportStackExchangeHelper->getMyAssociatedSites();
+            $this->showListOfMySites($mySites);
+            $this->info('===');
+            $this->exportEachSite($mySites);
+            if ($this->option('S3') === 'true') {//https://stackoverflow.com/a/7336873/470749
+                $this->exportStackExchangeHelper->archiveToS3();
+            } else {
+                $this->info('(Skipping S3 upload due to S3=false option.)');
+            }
+        } catch (\Exception $e) {
+            Log::error(__CLASS__ . ' ' . __FUNCTION__ . ' ' . $e);
+            $this->error('Error. Check the Laravel log (probably at /storage/logs/laravel.log).');
         }
+        $this->info(Carbon::now() . ' Finished.');
+    }
+
+    public function handleForgetCacheOption() {
+        if ($this->option('forgetCache')) {
+            Cache::forget(self::CODE_CACHE_KEY);
+            Cache::forget($this->exportStackExchangeHelper::ACCESS_TOKEN_CACHE_KEY);
+            $this->info('Cleared cache values.');
+        }
+    }
+
+    public function handleStackExchangeCode() {
         $code = $this->option('code') ?? Cache::get(self::CODE_CACHE_KEY);
-        if (!$code) {
+        if (!$code) {//If code wasn't provided via option and wasn't available from cache, explain the process for fetching a code in the browser.
             $url = $this->exportStackExchangeHelper->getOauthUrl();
             $this->info('Visit ' . $url);
-            $code = $this->ask('Then, the browser will bounce to a new URL, which will contain a `code` parameter at the end. Copy the value of just the `code` parameter from the URL. Paste it here:');
+            $codePasted = $this->ask('Then, the browser will bounce to a new URL. Copy the value of the `code` parameter in the URL. Paste it here:');
+            $code = str_replace(self::SE_URL_BEGINNING, '', $codePasted); //just in case the user accidentally pasted the entire URL instead of just the `code` parameter.
+            Log::debug('$code=' . $code);
             Cache::put(self::CODE_CACHE_KEY, $code, $this->exportStackExchangeHelper::SESSION_MINS);
             Cache::forget($this->exportStackExchangeHelper::ACCESS_TOKEN_CACHE_KEY);
             $this->info('Code now saved to cache for ' . $this->exportStackExchangeHelper::SESSION_MINS . ' minutes: ' . Cache::get(self::CODE_CACHE_KEY));
         }
         $this->exportStackExchangeHelper->setCode($code);
-        $this->info(Carbon::now() . ' Starting.');
-        $this->exportStackExchangeHelper->setFilenamePrefix('StackExchange/' . Carbon::now()->format(self::FILENAME_SAFE_FORMAT) . '/');
-        $mySites = $this->exportStackExchangeHelper->getMyAssociatedSites();
-        $this->showListOfMySites($mySites);
-        $this->info('===');
-        $this->exportEachSite($mySites);
-        $this->info(Carbon::now() . ' Finished.');
     }
 
     /**
@@ -71,15 +95,19 @@ public function handle() {
      * @param array $mySites
      */
     public function exportEachSite($mySites) {
+        $bar = $this->output->createProgressBar(count($mySites)); //https://laravel.com/docs/6.0/artisan#writing-output
+        $bar->start();
         foreach ($mySites as $site) {
             $this->showDetailsOfThisSite($site);
             $sitesToExclude = []; //['Stack Overflow', 'Server Fault', 'Super User'];
-            if (!in_array($site['site_name'], $sitesToExclude)) {
-                foreach (['answers' => 'activity', 'questions' => 'activity', 'comments' => 'creation', 'mentioned' => 'creation', 'favorites' => 'creation'] as $endpoint => $sort) {
+            if (!in_array($site['site_name'], $sitesToExclude)) {            
+                foreach (self::ENDPOINTS as $endpoint => $sort) {
                     $this->exportStackExchangeHelper->saveJsonFromApi($endpoint, $site, $sort);
                 }
             }
+            $bar->advance();
         }
+        $bar->finish();
     }
 
     /**