Add backend API CRUD for a new domain object - "Gigad"

Gigad (an ad for a gig) is a public posting from Organizations; that
they're willing to pick up offers for gigs of a certain type. This allows
companies to hire performers.

Ref #21

Author: anroots

src/app/Http/Controllers/Api/V1/GigadController.php

@@ -0,0 +1,116 @@
+<?php
+
+namespace App\Http\Controllers\Api\V1;
+
+use App\Http\Controllers\Controller;
+use App\Http\Requests\Gigad\DeleteGigadRequest;
+use App\Http\Requests\Gigad\StoreGigadRequest;
+use App\Http\Requests\Gigad\UpdateGigadRequest;
+use App\Http\Resources\V1\GigadResource;
+use App\Orm\Gigad;
+use App\Orm\Organization;
+use Illuminate\Http\Request;
+use Illuminate\Http\Resources\Json\JsonResource;
+use Spatie\QueryBuilder\AllowedFilter;
+use Spatie\QueryBuilder\QueryBuilder;
+
+/**
+ * @group Gigads
+ */
+class GigadController extends Controller
+{
+
+
+    /**
+     * Show Gigad details
+     *
+     * @param Gigad $gigad
+     * @return JsonResource
+     */
+    public function show(Gigad $gigad): JsonResource
+    {
+        return new GigadResource($gigad);
+    }
+
+    /**
+     * List all Gigads
+     *
+     * @param Request $request
+     * @return \Illuminate\Contracts\Routing\ResponseFactory|\Illuminate\Http\Resources\Json\AnonymousResourceCollection|\Illuminate\Http\Response
+     */
+    public function index(Request $request)
+    {
+
+        $gigads = QueryBuilder::for(Gigad::class)
+            ->allowedFilters(AllowedFilter::exact('is_public'))
+            ->orderBy('id', 'asc')
+            ->onlyMine($request->input('onlyMine', false))
+            ->paginate(15);
+
+        return GigadResource::collection($gigads);
+    }
+
+    /**
+     * Create a new Gigad
+     *
+     * @param StoreGigadRequest $request
+     * @return GigadResource
+     * @authenticated
+     * @bodyParam description string Long (markdown-enabled) description of the organization
+     * @bodyParam is_public boolean Whether or not to show this publicly
+     * @bodyParam link string Link to "read more"
+     * @bodyParam int gig_category_id Numeric category ID
+     * @bodyParam string organization_uid Organization who owns this
+     */
+    public function store(StoreGigadRequest $request)
+    {
+
+        $gigad = new Gigad;
+        $gigad->link = $request->input('link');
+        $gigad->description = $request->input('description');
+        $gigad->organization_id = Organization::where('uid', $request->input('organization_uid'))->first()->id;
+        $gigad->gig_category_id = $request->input('gig_category_id');
+        $gigad->setToken();
+        $gigad->save();
+
+        return new GigadResource($gigad);
+    }
+
+    /**
+     * Update an ad
+     *
+     * @param Gigad $gigad
+     * @param UpdateGigadRequest $request
+     * @return GigadResource
+     * @bodyParam description string Long (markdown-enabled) description of the organization
+     * @bodyParam is_public boolean Whether or not to show this publicly
+     * @bodyParam link string Link to "read more"
+     * @bodyParam int gig_category_id Numeric category ID
+     * @bodyParam string organization_uid Organization who owns this
+     * @authenticated
+     */
+    public function update(Gigad $gigad, UpdateGigadRequest $request)
+    {
+        $gigad->link = $request->input('link');
+        $gigad->description = $request->input('description');
+        $gigad->organization_id = Organization::where('uid', $request->input('organization_uid'))->first()->id;
+        $gigad->gig_category_id = $request->input('gig_category_id');
+        $gigad->save();
+
+        return new GigadResource($gigad);
+    }
+
+
+    /**
+     * Delete a Gigad
+     *
+     * @param Gigad $gigad
+     * @param DeleteGigadRequest $request
+     * @throws \Exception
+     * @authenticated
+     */
+    public function destroy(Gigad $gigad, DeleteGigadRequest $request)
+    {
+        $gigad->delete();
+    }
+}

src/app/Http/Requests/Gigad/DeleteGigadRequest.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace App\Http\Requests\Gigad;
+
+use Illuminate\Foundation\Http\FormRequest;
+use Illuminate\Support\Facades\Auth;
+
+class DeleteGigadRequest extends FormRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+    public function authorize()
+    {
+
+        $gigadOrganizations = $this->gigad->organization()->get()->pluck('id')->toArray();
+        foreach (Auth::user()->organizations()->get() as $organization) {
+            if (in_array($organization->id, $gigadOrganizations)) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array
+     */
+    public function rules()
+    {
+        return [
+            //
+        ];
+    }
+}

src/app/Http/Requests/Gigad/StoreGigadRequest.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace App\Http\Requests\Gigad;
+
+class StoreGigadRequest extends UpdateGigadRequest
+{
+    /**
+     * Determine if the user is authorized to make this request.
+     *
+     * @return bool
+     */
+    public function authorize()
+    {
+        return true;
+    }
+}

src/app/Http/Requests/Gigad/UpdateGigadRequest.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace App\Http\Requests\Gigad;
+
+use App\Rules\Base64HeaderImage;
+use App\Rules\ContainsMyOrganization;
+
+class UpdateGigadRequest extends DeleteGigadRequest
+{
+
+
+    /**
+     * Get the validation rules that apply to the request.
+     *
+     * @return array
+     */
+    public function rules()
+    {
+        return [
+            'link' => 'max:255|required|min:5|url',
+            'description' => 'max:5000|required',
+            'organization_uid' => ['required', 'exists:organizations,uid', new ContainsMyOrganization],
+            'images.header.content' => ['nullable', new Base64HeaderImage],
+            'is_public' => 'required|bool',
+            'gig_category_id' => ['required', 'int', 'exists:gig_categories,id']
+        ];
+    }
+}

src/app/Http/Resources/V1/GigadResource.php

@@ -0,0 +1,43 @@
+<?php
+
+namespace App\Http\Resources\V1;
+
+use App\Orm\GigCategory;
+use App\Orm\Organization;
+use Illuminate\Http\Resources\Json\JsonResource;
+
+/**
+ * @property Organization $organization
+ * @property GigCategory $category
+ * @package App\Http\Resources\V1
+ */
+class GigadResource extends JsonResource
+{
+
+
+
+    /**
+     * Transform the resource into an array.
+     *
+     * @param \Illuminate\Http\Request $request
+     * @return array
+     */
+    public function toArray($request)
+    {
+
+        return [
+            'uid' => $this['uid'],
+            'category' => [
+                'id' => $this->category->id,
+                'name' => $this->category->name
+            ],
+            'organization' => [
+                'uid' => $this->organization->uid,
+                'name' => $this->organization->name
+            ],
+            'link'=> $this['link'],
+            'description' => $this['description']
+        ];
+    }
+
+}

src/app/Orm/GigCategory.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace App\Orm;
+
+use App\Orm\Traits\HasCoverImage;
+use Dirape\Token\DirapeToken;
+use Illuminate\Database\Eloquent\Factories\HasFactory;
+use Illuminate\Database\Eloquent\Model;
+use Illuminate\Database\Eloquent\SoftDeletes;
+use OwenIt\Auditing\Contracts\Auditable;
+use Spatie\MediaLibrary\HasMedia;
+use Spatie\MediaLibrary\InteractsWithMedia;
+
+/**
+ * @property string $name
+ * @property int $id
+ * @property string $description
+ * @package App\Orm
+ */
+class GigCategory extends Model
+{
+    use HasFactory;
+
+    use \Astrotomic\Translatable\Translatable, SoftDeletes, HasFactory;
+
+    public $translatedAttributes = ['name', 'description'];
+
+    protected $dates = [
+        'created_at',
+        'updated_at',
+        'deleted_at'
+    ];
+
+    protected $fillable = ['description', 'name','locale'];
+    /**
+     * @return \Illuminate\Database\Eloquent\Relations\HasMany
+     */
+    public function gigads()
+    {
+        return $this->hasMany('App\Orm\Gigad', 'gig_category_id');
+    }
+}

src/app/Orm/GigCategoryTranslation.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace App\Orm;
+
+use Illuminate\Database\Eloquent\Model;
+
+/**
+ * @package App\Orm
+ * @property string name
+ * @property string locale
+ * @property string description
+ */
+class GigCategoryTranslation extends Model
+{
+    public $timestamps = false;
+    protected $fillable = ['name', 'description'];
+
+    /**
+     * The attributes that should be cast to native types.
+     *
+     * @var array
+     */
+    protected $casts = [
+        'auto_translated' => 'boolean',
+    ];
+
+    public function setNameAttribute($value)
+    {
+        $this->attributes['name'] = trim($value);
+    }
+
+}