Add a helper class for creating filters

Author: jswift

src/BigCommerce/Api/AttributeFilter.php

@@ -0,0 +1,73 @@
+<?php
+
+
+namespace BigCommerce\ApiV3\Api;
+
+
+class AttributeFilter
+{
+    public const GREATER_THAN_OR_EQUAL = 'min';
+    public const LESS_THAN_OR_EQUAL = 'max';
+    public const GREATER_THAN = 'greater';
+    public const LESS_THAN = 'less';
+    public const LIKE = 'like';
+    public const IN = 'in';
+    public const NOT_IN = 'not_in';
+
+    private static $validFilters = [
+        self::GREATER_THAN_OR_EQUAL,
+        self::LESS_THAN_OR_EQUAL,
+        self::GREATER_THAN,
+        self::LESS_THAN,
+        self::LIKE,
+        self::IN,
+        self::NOT_IN,
+    ];
+
+    public static function in(string $attribute, array $values): array
+    {
+        return self::createFilterForMultiple($attribute, $values, self::IN);
+    }
+
+    public static function greaterThanOrEqual(string $attribute, float $value): array
+    {
+        return self::createFilter($attribute, $value, self::GREATER_THAN_OR_EQUAL);
+    }
+
+    public static function lessThanOrEqual(string $attribute, float $value): array
+    {
+        return self::createFilter($attribute, $value, self::LESS_THAN_OR_EQUAL);
+    }
+
+    public static function greaterThan(string $attribute, float $value): array
+    {
+        return self::createFilter($attribute, $value, self::GREATER_THAN);
+    }
+
+    public static function lessThan(string $attribute, float $value): array
+    {
+        return self::createFilter($attribute, $value, self::LESS_THAN);
+    }
+
+    public static function like(string $attribute, string $value): array
+    {
+        return self::createFilter($attribute, $value, self::LIKE);
+    }
+
+    public static function createFilter(string $attribute, string $value, string $filterType): array
+    {
+        if (!self::isValidFilter($filterType)) throw new \InvalidArgumentException("");
+
+        return ["$attribute:$filterType" => $value];
+    }
+
+    public static function createFilterForMultiple(string $attribute, array $values, string $filterType): array
+    {
+        return self::createFilter($attribute, implode(',', $values), $filterType);
+    }
+
+    private static function isValidFilter(string $filterType): bool
+    {
+        return in_array($filterType, self::$validFilters);
+    }
+}

src/BigCommerce/Catalog/ProductsApi.php

@@ -2,6 +2,7 @@
 
 namespace BigCommerce\ApiV3\Catalog;
 
+use BigCommerce\ApiV3\Api\AttributeFilter;
 use BigCommerce\ApiV3\Api\ResourceWithBatchUpdateApi;
 use BigCommerce\ApiV3\Catalog\Products\ProductsSubResourceApi;
 use BigCommerce\ApiV3\ResourceModels\Catalog\Product\Product;
@@ -76,7 +77,7 @@ public function batchDelete(array $productIds): bool
             $this->getClient()->getRestClient()->delete(
                 $this->multipleResourcesEndpoint(),
                 [
-                    RequestOptions::QUERY => ['id:in' => implode(',', $productIds)],
+                    RequestOptions::QUERY => AttributeFilter::in('id', $productIds),
                 ]
             );
 

tests/BigCommerce/Api/AttributeFilterTest.php

@@ -0,0 +1,52 @@
+<?php
+
+namespace BigCommerce\Tests\Api;
+
+use BigCommerce\ApiV3\Api\AttributeFilter;
+use PHPUnit\Framework\TestCase;
+
+class AttributeFilterTest extends TestCase
+{
+    public function testCanBuildInFilter(): void
+    {
+        $filter = AttributeFilter::in('id', [1,2,3]);
+        $this->assertEquals(['id:in' => '1,2,3'], $filter);
+    }
+
+    public function testCanBuildGreaterThanOrEqualFilter(): void
+    {
+        $filter = AttributeFilter::greaterThanOrEqual('price', 100);
+        $this->assertEquals(['price:min' => 100], $filter);
+    }
+
+    public function testCanBuildLessThanOrEqualFilter(): void
+    {
+        $filter = AttributeFilter::lessThanOrEqual('price', 100);
+        $this->assertEquals(['price:max' => 100], $filter);
+    }
+
+    public function testCanBuildLessThanFilter(): void
+    {
+        $filter = AttributeFilter::lessThan('price', 100);
+        $this->assertEquals(['price:less' => 100], $filter);
+    }
+
+    public function testCanBuildGreaterThanFilter(): void
+    {
+        $filter = AttributeFilter::greaterThan('price', 100);
+        $this->assertEquals(['price:greater' => 100], $filter);
+    }
+
+    public function testCanBuildLikeFilter(): void
+    {
+        $filter = AttributeFilter::like('sku', 'abc');
+        $this->assertEquals(['sku:like' => 'abc'], $filter);
+    }
+
+    public function testCannotBuildInvalidFilter(): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+
+        AttributeFilter::createFilter('something', '', 'somewhere');
+    }
+}

tests/BigCommerce/Catalog/ProductsApiTest.php

@@ -41,4 +41,18 @@ public function testCanGetAllPagesForProducts(): void
         $productsResponse = $this->getApi()->catalog()->products()->getAllPages();
         $this->assertEquals(2, $productsResponse->getPagination()->total);
     }
+
+    public function testCanBatchDeleteProducts(): void
+    {
+        $this->setReturnData('blank.json', 204);
+        $response = $this->getApi()->catalog()->products()->batchDelete([1,2,3]);
+        $this->assertTrue($response);
+    }
+
+    public function testCanFailToDeleteBatchDeleteProducts(): void
+    {
+        $this->setReturnData(self::EMPTY_RESPONSE, 400);
+        $response = $this->getApi()->catalog()->products()->batchDelete([1,2,3]);
+        $this->assertFalse($response);
+    }
 }