Merge pull request #3 from aligent/feature/add_customer_models

Feature/add customer models

Author: jswift

src/BigCommerce/Customers/CustomersApi.php

@@ -0,0 +1,87 @@
+<?php
+
+namespace BigCommerce\ApiV3\Customers;
+
+use BigCommerce\ApiV3\Api\ResourceApi;
+use BigCommerce\ApiV3\ResponseModels\Customer\CustomerResponse;
+use BigCommerce\ApiV3\ResponseModels\Customer\CustomersResponse;
+use BigCommerce\ApiV3\ResourceModels\Customer\Customer;
+use GuzzleHttp\Exception\GuzzleException;
+use GuzzleHttp\RequestOptions;
+use Psr\Http\Message\ResponseInterface;
+use UnexpectedValueException;
+
+class CustomersApi extends ResourceApi
+{
+    public const RESOURCE_NAME       = 'customers';
+    public const CUSTOMERS_ENDPOINT = 'customers';
+    public const CUSTOMER_ENDPOINT   = 'customer/%d';
+
+
+    public function get(): CustomerResponse
+    {
+        return new CustomerResponse($this->getResource());
+    }
+
+    public function getAll(array $filters = [], int $page = 1, int $limit = 250): CustomersResponse
+    {
+        return new CustomersResponse($this->getAllResources($filters, $page, $limit));
+    }
+
+    public function getByEmail($email): ?Customer
+    {
+        $customers = $this->getAll(['email:in' => $email])->getCustomers();
+
+        if (!$customers[0]) {
+            return null;
+        } elseif (count($customers) > 1) {
+            throw new UnexpectedValueException("There are more than one customer with the email address $email");
+        }
+
+        return $customers[0];
+    }
+
+    /** the Customers API allows us to delete a batch of customers at a time by passing an a query string containing a
+     * list of Customer IDs
+     * @param array $ids
+     * @return ResponseInterface
+     * @throws GuzzleException
+     */
+    public function deleteIn(array $ids): ResponseInterface
+    {
+        $ids = implode(",", $ids);
+        $resource = ["id:in" => $ids];
+
+        return $this->getClient()->getRestClient()->delete(
+            $this->multipleResourcesEndpoint(),
+            [
+                RequestOptions::QUERY => $resource,
+            ]
+        );
+    }
+
+    public function create(Customer $category): CustomerResponse
+    {
+        return new CustomerResponse($this->createResource($category));
+    }
+
+    public function update(Customer $category): CustomerResponse
+    {
+        return new CustomerResponse($this->updateResource($category));
+    }
+
+    protected function singleResourceEndpoint(): string
+    {
+        return self::CUSTOMER_ENDPOINT;
+    }
+
+    protected function multipleResourcesEndpoint(): string
+    {
+        return self::CUSTOMERS_ENDPOINT;
+    }
+
+    protected function resourceName(): string
+    {
+        return self::RESOURCE_NAME;
+    }
+}

src/BigCommerce/ResourceModels/Customer/Customer.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace BigCommerce\ApiV3\ResourceModels\Customer;
+
+use BigCommerce\ApiV3\ResourceModels\ResourceModel;
+
+/**
+ * @package BigCommerce\ApiV3\ResourceModels
+ */
+class Customer extends ResourceModel
+{
+    /**
+     * Typically need either an ID or an email in order to do anything useful with an existing customer
+     */
+    public int $id;
+    public string $email;
+    public string $first_name;
+    public string $last_name;
+    public string $company;
+    public string $street_1;
+    public string $street_2;
+    public string $city;
+    public string $state;
+    public string $zip;
+    public string $country;
+    public string $country_iso2;
+    public string $phone;
+}

src/BigCommerce/ResponseModels/Customer/CustomerResponse.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace BigCommerce\ApiV3\ResponseModels\Customer;
+
+use BigCommerce\ApiV3\ResourceModels\Customer\Customer;
+use BigCommerce\ApiV3\ResponseModels\SingleResourceResponse;
+use stdClass;
+
+class CustomerResponse extends SingleResourceResponse
+{
+    private Customer $customer;
+
+    public function getCustomer(): Customer
+    {
+        return $this->customer;
+    }
+
+    protected function addData(stdClass $rawData): void
+    {
+        $this->customer = new Customer($rawData);
+    }
+}

src/BigCommerce/ResponseModels/Customer/CustomersResponse.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace BigCommerce\ApiV3\ResponseModels\Customer;
+
+use BigCommerce\ApiV3\ResourceModels\Customer\Customer;
+use BigCommerce\ApiV3\ResponseModels\PaginatedResponse;
+use stdClass;
+
+class CustomersResponse extends PaginatedResponse
+{
+    private array $customers;
+
+    /**
+     * @return Customer[]
+     */
+    public function getCustomers(): array
+    {
+        return $this->customers;
+    }
+
+    protected function addData(array $data): void
+    {
+        $this->customers = array_map(function (stdClass $c) {
+            return new Customer($c);
+        }, $data);
+    }
+}

tests/BigCommerce/Customers/CustomersApiTest.php

@@ -0,0 +1,28 @@
+<?php
+
+namespace BigCommerce\Tests\Customers;
+
+use BigCommerce\Tests\BigCommerceApiTest;
+
+class CustomersApiTest extends BigCommerceApiTest
+{
+    public function testCanGetProduct()
+    {
+        $this->markTestIncomplete();
+    }
+
+    public function testCanGetAllProducts()
+    {
+        $this->markTestIncomplete();
+    }
+
+    public function testCanGetCustomerByEmail()
+    {
+        $this->markTestIncomplete();
+    }
+
+    public function testCanDeleteCustomersIn()
+    {
+        $this->markTestIncomplete();
+    }
+}