Merge pull request #517 from karlomikus/develop

minor release

Author: karlomikus

.dockerignore

@@ -16,6 +16,7 @@ tests
 .editorconfig
 pint.json
 .spectral.yml
+.todo
 
 Dockerfile
 Dockerfile.dev
@@ -29,4 +30,4 @@ README.md
 ecs.php
 
 SECURITY.md
-CONTRIBUTING.md
+CONTRIBUTING.md

.gitignore

@@ -19,4 +19,5 @@ notes.sql
 composer.phar
 .phpunit.cache
 /resources/data
-litestream.yml
+litestream.yml
+.todo

CHANGELOG.md

@@ -1,3 +1,18 @@
+# v5.7.0
+## New
+- Import parent cocktails via datapack
+- Added `is_public` property to `Bar` schema
+    - If set to `true`, bar will expose public endpoints `/public/{barId}/*`
+    - New public endpoints are still being documented
+- Added optional `html_content` to scrape request schema
+    - This allows you to send raw HTML content to scrape endpoint, instead of server making a request to the URL
+- Scraping now respects `robots.txt` rules
+- Scraping is now done with identifiable user agent
+
+# v5.6.1
+## Fixes
+- Fixed `parent_cocktail_id` type error when importing data via datapack
+
 # v5.6.0
 ## New
 - Added cocktail recipe parent ID tracking

README.md

@@ -24,8 +24,8 @@ This repository only contains the API server, if you are looking for easy to use
 </p>
 
 ## Features
-- [Includes over 300 cocktail recipes with detailed information](https://github.com/bar-assistant/data)
-- Includes over 150 base ingredients with categories
+- [Includes over 500 cocktail recipes with detailed information](https://github.com/bar-assistant/data)
+- Includes over 250 base ingredients with categories
 - Add and manage multiple bars and bar members
 - Fine-grained user control with user roles
 - Endpoints for managing and filtering ingredients and cocktails
@@ -39,6 +39,7 @@ This repository only contains the API server, if you are looking for easy to use
 - Support for glass types, utensils, tags, ingredient categories and more
 - Cocktail recipe importing via URL, JSON, YAML or custom collections
 - Support for cocktail ratings
+- Support for cocktail variations
 - Create user-specific cocktail collections for easy referencing and sharing
 - Support for cocktail and ingredient notes
 - Supports sharing recipes by public links, custom recipe images and printing
@@ -48,6 +49,7 @@ This repository only contains the API server, if you are looking for easy to use
 - Data export support in various formats
 - Support for multiple ingredient prices
 - Automatic cocktail price calculation based on ingredients
+- SSO Support
 
 ## Container images
 

app/Console/Commands/BarExportRecipes.php

@@ -8,6 +8,9 @@
 use Kami\Cocktail\Models\Bar;
 use Illuminate\Console\Command;
 use Kami\Cocktail\Models\Export;
+
+use function Laravel\Prompts\spin;
+
 use Illuminate\Support\Facades\DB;
 
 use function Laravel\Prompts\search;
@@ -24,14 +27,16 @@ class BarExportRecipes extends Command
      *
      * @var string
      */
-    protected $signature = 'bar:export-recipes {barId?} {--t|type=datapack : Export type} {--u|units= : Force unit conversion when possible (none, ml, oz, cl)}';
+    protected $signature = 'bar:export-recipes {barId?} {--t|type=datapack : Export type (datapack, schema, md, json-ld, xml, yaml)} {--u|units= : Force unit conversion when possible (none, ml, oz, cl)}';
 
     /**
      * The console command description.
      *
      * @var string
      */
-    protected $description = 'Export data from a single bar. Available export types: datapack, schema, markdown, json-ld, xml, yaml';
+    protected $description = 'Export data from a single bar';
+
+    protected $help = 'This command allows you to export data from a single bar in various formats. You can specify the bar ID as an argument, or search for it interactively if not provided.';
 
     public function __construct(private readonly ToDataPack $datapackExporter, private readonly ToRecipeType $recipeExporter)
     {
@@ -44,6 +49,14 @@ public function __construct(private readonly ToDataPack $datapackExporter, priva
     public function handle(): int
     {
         $barId = (int) $this->argument('barId');
+        $type = ExportTypeEnum::tryFrom($this->option('type') ?? 'datapack');
+        $units = ForceUnitConvertEnum::tryFrom($this->option('units') ?? 'none');
+
+        $this->newLine();
+        $this->line('Exporting data from a bar');
+        $this->newLine();
+        $this->line('Selected export type: ' . ($type->value ?? 'datapack'));
+        $this->line('Selected unit conversion: ' . ($units->value ?? 'none'));
 
         if ($barId === 0) {
             $barId = search(
@@ -56,9 +69,6 @@ public function handle(): int
             );
         }
 
-        $type = ExportTypeEnum::tryFrom($this->option('type') ?? 'datapack');
-        $units = ForceUnitConvertEnum::tryFrom($this->option('units') ?? 'none');
-
         try {
             $bar = Bar::findOrFail($barId);
         } catch (Throwable $e) {
@@ -67,13 +77,20 @@ public function handle(): int
             return Command::FAILURE;
         }
 
-        $this->line(sprintf('Starting new export (%s | %s) from bar: %s - "%s"', $type->value, $units->value, $bar->id, $bar->name));
+        $this->line(sprintf('Starting new %s export from bar: [%s] %s', $type->value, $bar->id, $bar->name));
 
-        if ($type === ExportTypeEnum::Datapack) {
-            $filename = $this->datapackExporter->process($bar->id, Export::generateFilename('datapack'), $units);
-        } else {
-            $filename = $this->recipeExporter->process($bar->id, Export::generateFilename($type->getFilenameContext()), $type, $units);
-        }
+        $filename = spin(
+            callback: function () use ($bar, $type, $units) {
+                if ($type === ExportTypeEnum::Datapack) {
+                    $filename = $this->datapackExporter->process($bar->id, Export::generateFilename('datapack'), $units);
+                } else {
+                    $filename = $this->recipeExporter->process($bar->id, Export::generateFilename($type->getFilenameContext()), $type, $units);
+                }
+
+                return $filename;
+            },
+            message: 'Generating...'
+        );
 
         $this->output->success('Data exported to file: ' . $filename);
 

app/External/Export/ToDataPack.php

@@ -88,7 +88,8 @@ private function dumpCocktails(int $barId, ZipArchive &$zip, ?Units $toUnits = n
             'glass',
             'method',
             'tags',
-            'utensils'
+            'utensils',
+            'parentCocktail',
         )->where('bar_id', $barId)->get();
 
         /** @var Cocktail $cocktail */
@@ -98,7 +99,7 @@ private function dumpCocktails(int $barId, ZipArchive &$zip, ?Units $toUnits = n
             /** @var \Kami\Cocktail\Models\Image $img */
             foreach ($cocktail->images as $img) {
                 try {
-                    $zip->addFile($img->getPath(), 'cocktails/' . $cocktail->getExternalId() . '/' . $img->getFileName());
+                    $zip->addFile($img->getPath(), 'cocktails/' . $cocktail->getExternalId() . '/' . $img->getExternalId());
                 } catch (ImageFileNotFoundException $e) {
                     Log::warning($e->getMessage());
                 }
@@ -120,7 +121,7 @@ private function dumpIngredients(int $barId, ZipArchive &$zip): void
 
             /** @var \Kami\Cocktail\Models\Image $img */
             foreach ($ingredient->images as $img) {
-                $zip->addFile($img->getPath(), 'ingredients/' . $ingredient->getExternalId() . '/' . $img->getFileName());
+                $zip->addFile($img->getPath(), 'ingredients/' . $ingredient->getExternalId() . '/' . $img->getExternalId());
             }
 
             $ingredientExportData = $this->prepareDataOutput($data->toDataPackArray());

app/External/Import/FromDataPack.php

@@ -162,6 +162,8 @@ private function importCalculators(string $filepath, int $barId): void
 
     private function importIngredients(Filesystem $dataDisk, Bar $bar, User $user): void
     {
+        $timerStart = microtime(true);
+
         $existingIngredients = DB::table('ingredients')->select('id', 'name')->where('bar_id', $bar->id)->get()->keyBy(function ($ingredient) {
             return Str::slug($ingredient->name);
         });
@@ -173,6 +175,7 @@ private function importIngredients(Filesystem $dataDisk, Bar $bar, User $user):
         $barImagesDir = $bar->getIngredientsDirectory();
         $this->uploadsDisk->makeDirectory($barImagesDir);
 
+        $imagesTimer = 0.0;
         foreach ($this->getDataFromDir('ingredients', $dataDisk) as $fromYield) {
             [$externalIngredient, $filePath] = $fromYield;
             $externalIngredient = IngredientExternal::fromDataPackArray($externalIngredient);
@@ -208,6 +211,7 @@ private function importIngredients(Filesystem $dataDisk, Bar $bar, User $user):
             }
 
             // For performance, manually copy the files and create image references
+            $imagesTimerStart = microtime(true);
             foreach ($externalIngredient->images as $image) {
                 $baseSrcImagePath = $filePath . $image->getLocalFilePath();
                 $fileExtension = File::extension($dataDisk->path($baseSrcImagePath));
@@ -226,8 +230,12 @@ private function importIngredients(Filesystem $dataDisk, Bar $bar, User $user):
                     'updated_at' => null,
                 ];
             }
+            $imageTimerEnd = microtime(true);
+            $imagesTimer += ($imageTimerEnd - $imagesTimerStart);
         }
 
+        Log::debug(sprintf('Ingredient image copy completed in %d ms', $imagesTimer * 1000));
+
         // Start inserting
         DB::beginTransaction();
 
@@ -280,10 +288,15 @@ private function importIngredients(Filesystem $dataDisk, Bar $bar, User $user):
         DB::commit();
 
         $this->ingredientRepository->rebuildMaterializedPath($bar->id);
+
+        $timerEnd = microtime(true);
+        Log::debug(sprintf('Ingredients import completed in %d ms', ($timerEnd - $timerStart) * 1000));
     }
 
     private function importBaseCocktails(Filesystem $dataDisk, Bar $bar, User $user): void
     {
+        $timerStart = microtime(true);
+
         $dbIngredients = DB::table('ingredients')->select('id', DB::raw('LOWER(name) AS name'))->where('bar_id', $bar->id)->get()->keyBy('name')->map(fn ($row) => $row->id)->toArray();
         $dbGlasses = DB::table('glasses')->select('id', DB::raw('LOWER(name) AS name'))->where('bar_id', $bar->id)->get()->keyBy('name')->map(fn ($row) => $row->id)->toArray();
         $dbMethods = DB::table('cocktail_methods')->select('id', DB::raw('LOWER(name) AS name'))->where('bar_id', $bar->id)->get()->keyBy('name')->map(fn ($row) => $row->id)->toArray();
@@ -298,9 +311,11 @@ private function importBaseCocktails(Filesystem $dataDisk, Bar $bar, User $user)
         $newCocktailIngredients = [];
         $newCocktailSubstituteIngredients = [];
         $cocktailUtensilsMap = [];
+        $cocktailParentMap = [];
         $barImagesDir = 'cocktails/' . $bar->id . '/';
         $this->uploadsDisk->makeDirectory($barImagesDir);
 
+        $imagesTimer = 0.0;
         foreach ($this->getDataFromDir('cocktails', $dataDisk) as $fromYield) {
             [$cocktail, $filePath] = $fromYield;
 
@@ -328,6 +343,10 @@ private function importBaseCocktails(Filesystem $dataDisk, Bar $bar, User $user)
                 'updated_at' => $externalCocktail->updatedAt,
             ];
 
+            if ($externalCocktail->parentCocktailId) {
+                $cocktailParentMap[$slug] = $externalCocktail->parentCocktailId . '-' . $bar->id;
+            }
+
             foreach ($externalCocktail->tags as $tag) {
                 $tag = trim($tag);
                 if (!in_array($tag, $uniqueTags)) {
@@ -380,6 +399,7 @@ private function importBaseCocktails(Filesystem $dataDisk, Bar $bar, User $user)
             }
 
             // For performance, manually copy the files and create image references
+            $imagesTimerStart = microtime(true);
             foreach ($externalCocktail->images as $image) {
                 $baseSrcImagePath = $filePath . $image->getLocalFilePath();
                 $fileExtension = File::extension($dataDisk->path($baseSrcImagePath));
@@ -399,8 +419,12 @@ private function importBaseCocktails(Filesystem $dataDisk, Bar $bar, User $user)
                     'updated_at' => null,
                 ];
             }
+            $imageTimerEnd = microtime(true);
+            $imagesTimer += ($imageTimerEnd - $imagesTimerStart);
         }
 
+        Log::debug(sprintf('Cocktail image copy completed in %d ms', $imagesTimer * 1000));
+
         DB::beginTransaction();
 
         $tagsToInsert = [];
@@ -453,6 +477,15 @@ private function importBaseCocktails(Filesystem $dataDisk, Bar $bar, User $user)
 
                 $cocktailIngredientsToInsert = array_merge($cocktailIngredientsWithAssignedCocktail, $cocktailIngredientsToInsert);
             }
+
+            // Add parent cocktail id
+            if (isset($cocktailParentMap[$cocktail->slug])) {
+                $parentSlug = $cocktailParentMap[$cocktail->slug];
+                $parentCocktailId = $cocktails->firstWhere('slug', $parentSlug);
+                if (isset($parentCocktailId->id)) {
+                    DB::table('cocktails')->where('slug', $cocktail->slug)->where('bar_id', $bar->id)->update(['parent_cocktail_id' => $parentCocktailId->id]);
+                }
+            }
         }
         DB::table('cocktail_ingredients')->insert($cocktailIngredientsToInsert);
         DB::table('cocktail_tag')->insert($cocktailTagsToInsert);
@@ -482,6 +515,9 @@ private function importBaseCocktails(Filesystem $dataDisk, Bar $bar, User $user)
         DB::table('images')->insert($imagesToInsert);
 
         DB::commit();
+
+        $timerEnd = microtime(true);
+        Log::debug(sprintf('Cocktails import completed in %d ms', ($timerEnd - $timerStart) * 1000));
     }
 
     private function copyResourceImage(Filesystem $dataDisk, string $baseSrcImagePath, string $targetImagePath): void

app/External/Model/Cocktail.php

@@ -69,7 +69,7 @@ public static function fromModel(CocktailModel $model, bool $useFileURI = false,
             $model->utensils->pluck('name')->toArray(),
             $images,
             $ingredients,
-            $model->parent_cocktail_id !== null ? (string) $model->parent_cocktail_id : null,
+            $model->parentCocktail?->getExternalId(),
             $model->year,
         );
     }

app/Http/Controllers/AuthController.php

@@ -57,6 +57,7 @@ public function authenticate(Request $request): JsonResource
         if (!$user || !Hash::check($request->password, $user->password)) {
             Log::warning('User tried to login with invalid credentials', [
                 'email' => $request->email,
+                'is_verified' => $user?->hasVerifiedEmail(),
             ]);
 
             if (config('bar-assistant.mail_require_confirmation') === true) {