Company gateway Filters

app/Filters/CompanyGatewayFilters.php

@@ -0,0 +1,115 @@
+<?php
+/**
+ * Invoice Ninja (https://invoiceninja.com).
+ *
+ * @link https://github.com/invoiceninja/invoiceninja source repository
+ *
+ * @copyright Copyright (c) 2021. Invoice Ninja LLC (https://invoiceninja.com)
+ *
+ * @license https://www.elastic.co/licensing/elastic-license
+ */
+
+namespace App\Filters;
+
+use App\Models\User;
+use Illuminate\Database\Eloquent\Builder;
+
+/**
+ * CompanyGatewayFilters.
+ */
+class CompanyGatewayFilters extends QueryFilters
+{
+    /**
+     * Filter based on search text.
+     *
+     * @param string query filter
+     * @return Builder
+     * @deprecated
+     */
+    public function filter(string $filter = '') : Builder
+    {
+        if (strlen($filter) == 0) {
+            return $this->builder;
+        }
+
+        return  $this->builder->where(function ($query) use ($filter) {
+            $query->where('company_gateways.label', 'like', '%'.$filter.'%');
+        });
+
+    }
+
+    /**
+     * Filters the list based on the status
+     * archived, active, deleted.
+     *
+     * @param string filter
+     * @return Builder
+     */
+    public function status(string $filter = '') : Builder
+    {
+        if (strlen($filter) == 0) {
+            return $this->builder;
+        }
+
+        $table = 'company_gateways';
+        $filters = explode(',', $filter);
+
+        return $this->builder->where(function ($query) use ($filters, $table) {
+            $query->whereNull($table.'.id');
+
+            if (in_array(parent::STATUS_ACTIVE, $filters)) {
+                $query->orWhereNull($table.'.deleted_at');
+            }
+
+            if (in_array(parent::STATUS_ARCHIVED, $filters)) {
+                $query->orWhere(function ($query) use ($table) {
+                    $query->whereNotNull($table.'.deleted_at');
+
+                    if (! in_array($table, ['users'])) {
+                        $query->where($table.'.is_deleted', '=', 0);
+                    }
+                });
+            }
+
+            if (in_array(parent::STATUS_DELETED, $filters)) {
+                $query->orWhere($table.'.is_deleted', '=', 1);
+            }
+        });
+    }
+
+    /**
+     * Sorts the list based on $sort.
+     *
+     * @param string sort formatted as column|asc
+     * @return Builder
+     */
+    public function sort(string $sort) : Builder
+    {
+        $sort_col = explode('|', $sort);
+
+        return $this->builder->orderBy($sort_col[0], $sort_col[1]);
+    }
+
+    /**
+     * Returns the base query.
+     *
+     * @param int company_id
+     * @param User $user
+     * @return Builder
+     * @deprecated
+     */
+    public function baseQuery(int $company_id, User $user) : Builder
+    {
+        return $this->builder;
+    }
+
+    /**
+     * Filters the query by the users company ID.
+     *
+     * @return Illuminate\Database\Query\Builder
+     */
+    public function entityFilter()
+    {
+        return $this->builder->company();
+    }
+}

app/Filters/TaskStatusFilters.php

@@ -0,0 +1,115 @@
+<?php
+/**
+ * Invoice Ninja (https://invoiceninja.com).
+ *
+ * @link https://github.com/invoiceninja/invoiceninja source repository
+ *
+ * @copyright Copyright (c) 2021. Invoice Ninja LLC (https://invoiceninja.com)
+ *
+ * @license https://www.elastic.co/licensing/elastic-license
+ */
+
+namespace App\Filters;
+
+use App\Models\User;
+use Illuminate\Database\Eloquent\Builder;
+
+/**
+ * TaskStatusFilters.
+ */
+class TaskStatusFilters extends QueryFilters
+{
+    /**
+     * Filter based on search text.
+     *
+     * @param string query filter
+     * @return Builder
+     * @deprecated
+     */
+    public function filter(string $filter = '') : Builder
+    {
+        if (strlen($filter) == 0) {
+            return $this->builder;
+        }
+
+        return  $this->builder->where(function ($query) use ($filter) {
+            $query->where('task_statuses.name', 'like', '%'.$filter.'%');
+        });
+
+    }
+
+    /**
+     * Filters the list based on the status
+     * archived, active, deleted.
+     *
+     * @param string filter
+     * @return Builder
+     */
+    public function status(string $filter = '') : Builder
+    {
+        if (strlen($filter) == 0) {
+            return $this->builder;
+        }
+
+        $table = 'task_statuses';
+        $filters = explode(',', $filter);
+
+        return $this->builder->where(function ($query) use ($filters, $table) {
+            $query->whereNull($table.'.id');
+
+            if (in_array(parent::STATUS_ACTIVE, $filters)) {
+                $query->orWhereNull($table.'.deleted_at');
+            }
+
+            if (in_array(parent::STATUS_ARCHIVED, $filters)) {
+                $query->orWhere(function ($query) use ($table) {
+                    $query->whereNotNull($table.'.deleted_at');
+
+                    if (! in_array($table, ['users'])) {
+                        $query->where($table.'.is_deleted', '=', 0);
+                    }
+                });
+            }
+
+            if (in_array(parent::STATUS_DELETED, $filters)) {
+                $query->orWhere($table.'.is_deleted', '=', 1);
+            }
+        });
+    }
+
+    /**
+     * Sorts the list based on $sort.
+     *
+     * @param string sort formatted as column|asc
+     * @return Builder
+     */
+    public function sort(string $sort) : Builder
+    {
+        $sort_col = explode('|', $sort);
+
+        return $this->builder->orderBy($sort_col[0], $sort_col[1]);
+    }
+
+    /**
+     * Returns the base query.
+     *
+     * @param int company_id
+     * @param User $user
+     * @return Builder
+     * @deprecated
+     */
+    public function baseQuery(int $company_id, User $user) : Builder
+    {
+        return $this->builder;
+    }
+
+    /**
+     * Filters the query by the users company ID.
+     *
+     * @return Illuminate\Database\Query\Builder
+     */
+    public function entityFilter()
+    {
+        return $this->builder->company();
+    }
+}

app/Http/Controllers/CompanyGatewayController.php

@@ -13,6 +13,7 @@ namespace App\Http\Controllers;
 
 use App\DataMapper\FeesAndLimits;
 use App\Factory\CompanyGatewayFactory;
+use App\Filters\CompanyGatewayFilters;
 use App\Http\Requests\CompanyGateway\CreateCompanyGatewayRequest;
 use App\Http\Requests\CompanyGateway\DestroyCompanyGatewayRequest;
 use App\Http\Requests\CompanyGateway\EditCompanyGatewayRequest;
@@ -95,9 +96,9 @@ class CompanyGatewayController extends BaseController
      *       ),
      *     )
      */
-    public function index()
+    public function index(CompanyGatewayFilters $filters)
     {
-        $company_gateways = CompanyGateway::whereCompanyId(auth()->user()->company()->id);
+        $company_gateways = CompanyGateway::filter($filters);
 
         return $this->listResponse($company_gateways);
     }

app/Models/CompanyGateway.php

@@ -11,6 +11,7 @@
 
 namespace App\Models;
 
+use App\Models\Filterable;
 use App\Models\GatewayType;
 use App\Utils\Number;
 use Illuminate\Database\Eloquent\SoftDeletes;
@@ -20,7 +21,8 @@ use stdClass;
 class CompanyGateway extends BaseModel
 {
     use SoftDeletes;
-
+    use Filterable;
+    
     public const GATEWAY_CREDIT = 10000000;
 
     protected $casts = [

tests/Feature/CompanyGatewayApiTest.php

@@ -167,6 +167,21 @@ class CompanyGatewayApiTest extends TestCase
         $cg = $response->json();
 
         $response->assertStatus(200);
+
+        $response = $this->withHeaders([
+            'X-API-SECRET' => config('ninja.api_secret'),
+            'X-API-TOKEN' => $this->token,
+        ])->get('/api/v1/company_gateways');
+
+        $response->assertStatus(200);
+
+        $response = $this->withHeaders([
+            'X-API-SECRET' => config('ninja.api_secret'),
+            'X-API-TOKEN' => $this->token,
+        ])->get('/api/v1/company_gateways?filter=x');
+
+        $response->assertStatus(200);
+
     }
 
     public function testCompanyGatewayFeesAndLimitsFails()