Media Controller code refactor and set config variable for authorizat…

…ion (#16)

* Add Media Gallery Package

- Add Media Gallery Package
- Remove image column from the User model
- Remove Media Helper Package (It's Already included in media gallery package)
- Remove Cache Controler
- Add Avatar attribute in user model and return user image
- Add Gravatar API for default image in user model

* Feature/media gallery (#15)
 
 ---------

Co-authored-by: anisAronno <[email protected]>

.env.example

@@ -11,7 +11,7 @@ LOG_LEVEL=debug
 DB_CONNECTION=mysql
 DB_HOST=127.0.0.1
 DB_PORT=3306
-DB_DATABASE=laravel
+DB_DATABASE=laravel-starter
 DB_USERNAME=root
 DB_PASSWORD=
 

.github/workflows/php-cs-fixer.yml

@@ -26,5 +26,5 @@ jobs:
       - name: Commit changes
         uses: stefanzweifel/git-auto-commit-action@v4
         with:
-          commit_message: Fix styling
+          commit_message: Fix styling by bot
           branch: ${{ github.head_ref }}

.gitignore

@@ -18,3 +18,5 @@ yarn-error.log
 /.idea
 /.vscode
 .DS_Store
+/media
+media

README.md

@@ -4,19 +4,19 @@ Welcome to the Laravel Starter Project! This repository provides a kickstart set
 
 ## Table of Contents
 
-- [Laravel Starter Project (Version 10)](#laravel-starter-project-version-10)
-  - [Table of Contents](#table-of-contents)
-  - [Uses Packages](#uses-packages)
-  - [Other Uses](#other-uses)
-  - [Features](#features)
-  - [Getting Started](#getting-started)
-    - [Installation](#installation)
-    - [Starting with Docker](#starting-with-docker)
-  - [Deploy via FTP with CI/CD](#deploy-via-ftp-with-cicd)
-      - [GitFlow for Merge Requests](#gitflow-for-merge-requests)
-      - [FTP Deployment Process](#ftp-deployment-process)
-  - [Contribution Guide](#contribution-guide)
-  - [License](#license)
+-   [Laravel Starter Project (Version 10)](#laravel-starter-project-version-10)
+    -   [Table of Contents](#table-of-contents)
+    -   [Uses Packages](#uses-packages)
+    -   [Other Uses](#other-uses)
+    -   [Features](#features)
+    -   [Getting Started](#getting-started)
+        -   [Installation](#installation)
+        -   [Starting with Docker](#starting-with-docker)
+    -   [Deploy via FTP with CI/CD](#deploy-via-ftp-with-cicd)
+        -   [GitFlow for Merge Requests](#gitflow-for-merge-requests)
+        -   [FTP Deployment Process](#ftp-deployment-process)
+    -   [Contribution Guide](#contribution-guide)
+    -   [License](#license)
 
 ## Uses Packages
 
@@ -27,7 +27,7 @@ Welcome to the Laravel Starter Project! This repository provides a kickstart set
 -   Laravel [Horizon](https://laravel.com/docs/10.x/horizon) (Job And Queue manage)
 -   Laravel [Debugbar](https://github.com/barryvdh/laravel-debugbar) (Monitoring every request)
 -   Laravel [Settings](https://github.com/anisAronno/laravel-settings) (Personal Package for application settings)
--   Laravel [Media Uploader](https://github.com/anisAronno/Laravel-Media-Helper) (Personal Package for file management)
+-   Laravel [Media Gallery](https://github.com/anisAronno/laravel-media-gallery) (Personal Package for file management)
 -   Laravel [Activity Log](https://github.com/spatie/laravel-activitylog) (Track User Activity)
 -   Beautiful [Log Viewer](https://github.com/opcodesio/log-viewer) for local and production
 -   [Flowbite](https://flowbite.com/) For Tailwind Component
@@ -179,4 +179,4 @@ For guidelines on contributing to this project, refer to the [Contribution Guide
 
 ## License
 
-This application is open-source software licensed under the [MIT license](https://opensource.org/licenses/MIT).
+This application is open-source software licensed under the [MIT license](https://opensource.org/licenses/MIT).

app/Http/Controllers/Admin/NotificationController.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace App\Http\Controllers\Admin;
+
+use App\Http\Controllers\Controller;
+use Illuminate\Http\Request;
+
+class NotificationController extends Controller
+{
+    public function markNotification(Request $request)
+    {
+        auth()->user()
+            ->unreadNotifications
+            ->when($request->input('id'), function ($query) use ($request)
+            {
+                return $query->where('id', $request->input('id'));
+            })
+            ->markAsRead();
+
+        return response()->noContent();
+    }
+}

app/Http/Resources/UserResource.php

@@ -2,8 +2,12 @@
 
 namespace App\Http\Resources;
 
+use App\Http\Resources\AddressResource;
+use App\Http\Resources\PermissionResource;
+use App\Http\Resources\RoleResource;
 use Illuminate\Http\Request;
 use Illuminate\Http\Resources\Json\JsonResource;
+use Illuminate\Support\Carbon;
 
 class UserResource extends JsonResource
 {
@@ -14,6 +18,33 @@ class UserResource extends JsonResource
      */
     public function toArray(Request $request): array
     {
-        return parent::toArray($request);
+        return [
+           'id'                  => $this->id,
+           'name'                => $this->name,
+           'username'            => $this->username,
+           'email'               => $this->email,
+           'avatar'              => $this->avatar,
+           'gender'              => $this->gender,
+           'email_verified_at'   => $this->email_verified_at,
+           'ip'                  => $this->ip,
+           'latitude'            => $this->latitude,
+           'longitude'           => $this->longitude,
+           'time_zone'           => $this->time_zone,
+           'language'            => $this->language,
+           'status'              => $this->status,
+           'is_deletable'        => $this->is_deletable,
+           'is_editable'         => $this->is_editable,
+           'unreadNotifications' => $this->whenLoaded('unreadNotifications'),
+           'roles'               => $this->whenLoaded('roles', function ()
+           {
+               return RoleResource::collection($this->roles)->pluck('name');
+           }),
+           'permissions' => $this->whenLoaded('permissions', function ()
+           {
+               return PermissionResource::collection($this->getAllPermissions())->pluck('name');
+           }),
+           'addresses'  => AddressResource::collection($this->whenLoaded('addresses')),
+           'created_at' => Carbon::parse($this->created_at)->diffForHumans(),
+        ];
     }
 }

app/Models/User.php

@@ -2,6 +2,7 @@
 
 namespace App\Models;
 
+use AnisAronno\MediaGallery\Traits\HasMedia;
 use App\Enums\UserStatus;
 use App\Helpers\UniqueSlug;
 use App\Notifications\ResetPasswordNotification;
@@ -26,6 +27,7 @@ class User extends Authenticatable implements MustVerifyEmail
     use LogsActivity;
     use Notifiable;
     use SoftDeletes;
+    use HasMedia;
 
     /**
      * The attributes that are mass assignable.
@@ -37,7 +39,6 @@ class User extends Authenticatable implements MustVerifyEmail
         'email',
         'password',
         'phone',
-        'image',
         'api_token',
         'status',
         'gender',
@@ -73,7 +74,7 @@ class User extends Authenticatable implements MustVerifyEmail
     public function getActivitylogOptions(): LogOptions
     {
         return LogOptions::defaults()
-            ->logOnly(['name', 'email', 'password', 'image', 'status',  'api_token'])
+            ->logOnly(['name', 'email', 'password', 'status',  'api_token'])
             ->logOnlyDirty()
             ->dontSubmitEmptyLogs();
     }
@@ -138,4 +139,11 @@ public function hasAdministrativeRole(): bool
     {
         return $this->hasRole(['superadmin', 'admin']);
     }
+
+    protected $appends = ['avatar'];
+
+    public function getAvatarAttribute() : string
+    {
+        return $this->image[0]?->url ?? 'https://www.gravatar.com/avatar/'.md5(strtolower(trim($this->email)));
+    }
 }

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "anisaronno/laravel-starter",
     "type": "project",
-    "version": "0.0.2",
+    "version": "0.0.3",
     "description": "A perfect laravel starter project for any kind of project.",
     "keywords": [
         "laravel",
@@ -19,7 +19,7 @@
     ],
     "require": {
         "php": "^8.1",
-        "anisaronno/laravel-media-helper": "^0.1.1",
+        "anisaronno/laravel-media-gallery": "0.3.0",
         "anisaronno/laravel-settings": "1.0.0",
         "guzzlehttp/guzzle": "^7.2",
         "laravel/framework": "^10.10",

config/gallery.php

@@ -0,0 +1,8 @@
+<?php
+
+return [
+    'cache_expiry_time'     => 1440,
+    'guard'                 => ['auth:api'],
+    'batch_delete_secret'   => '1a463c2c-81b0-441e-9e4f-04691a7e5e0f',
+    'view_all_media_anyone' => false,
+];

database/factories/ImageFactory.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Database\Factories;
+
+use AnisAronno\MediaGallery\Models\Image;
+use App\Models\User;
+use Illuminate\Database\Eloquent\Factories\Factory;
+
+/**
+ * @extends \Illuminate\Database\Eloquent\Factories\Factory<\AnisAronno\MediaGallery\Models\Image>
+ */
+class ImageFactory extends Factory
+{
+    protected $model = Image::class;
+
+    /**
+     * Define the model's default state.
+     *
+     * @return array<string, mixed>
+     */
+    public function definition()
+    {
+        return [
+            'title'      => $this->faker->name(),
+            'url'        => $this->faker->imageUrl(),
+            'mimes'      => 'images/png',
+            'type'       => 'images/png',
+            'size'       => '3 MB',
+            'directory'  => 'images',
+            'owner_id'   => User::factory(),
+            'owner_type' => User::class,
+        ];
+    }
+}

database/factories/UserFactory.php

@@ -31,7 +31,6 @@ public function definition(): array
             'email_verified_at' => now(),
             'password'          => static::$password ??= Hash::make('password'),
             'remember_token'    => Str::random(10),
-            'image'             => Media::getDefaultAvatar(),
             'phone'             => fake()->phoneNumber,
             'gender'            => fake()->randomElement(UserGender::values()),
         ];

database/migrations/2014_10_12_000000_create_users_table.php

@@ -18,7 +18,6 @@ public function up(): void
             $table->string('name');
             $table->string('username', 100)->unique();
             $table->string('phone', 50)->unique()->nullable();
-            $table->string('image')->nullable();
             $table->string('email', 100)->unique();
             $table->timestamp('email_verified_at')->nullable();
             $table->string('api_token', 100)->unique();