Split repository into traits

Closes #91

Author: JaZo

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+### Changed
+
+* The `Repository` is split up into one trait per action [#91](https://github.com/swisnl/json-api-client/issues/91). This allows you to build your own repository by extending the `BaseRepository` and including just the actions/traits you need. See the (updated) readme for usage instructions. The `Repository` now uses these new traits and should be fully backwards compatible.
+
 ### Fixed
 
 * Fix ParamNameMismatch issue [#96](https://github.com/swisnl/json-api-client/issues/96).

README.md

@@ -255,6 +255,21 @@ class BlogRepository extends \Swis\JsonApi\Client\Repository
 }
 ```
 
+The above repository will have a method for all CRUD-actions. If you work with a read-only API and don't want to have all actions, you can build your own repository by extending `\Swis\JsonApi\Client\BaseRepository` and including just the actions/traits you need.
+
+``` php
+use Swis\JsonApi\Client\Actions\FetchMany;
+use Swis\JsonApi\Client\Actions\FetchOne;
+
+class BlogRepository extends \Swis\JsonApi\Client\BaseRepository
+{
+    use FetchMany;
+    use FetchOne;
+    
+    protected $endpoint = 'blogs';
+}
+```
+
 If this repository (pattern) doesn't fit your needs, you can create your own implementation using the [clients](#clients) provided by this package.
 
 ### Request parameters

src/Actions/Create.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Swis\JsonApi\Client\Actions;
+
+use Swis\JsonApi\Client\Interfaces\ItemInterface;
+
+trait Create
+{
+    /**
+     * @param \Swis\JsonApi\Client\Interfaces\ItemInterface $item
+     * @param array                                         $parameters
+     *
+     * @return \Swis\JsonApi\Client\Interfaces\DocumentInterface
+     */
+    public function create(ItemInterface $item, array $parameters = [])
+    {
+        return $this->getClient()->post(
+            $this->getEndpoint().'?'.http_build_query($parameters),
+            $this->documentFactory->make($item)
+        );
+    }
+}

src/Actions/Delete.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Swis\JsonApi\Client\Actions;
+
+trait Delete
+{
+    /**
+     * @param string $id
+     * @param array  $parameters
+     *
+     * @return \Swis\JsonApi\Client\Interfaces\DocumentInterface
+     */
+    public function delete(string $id, array $parameters = [])
+    {
+        return $this->getClient()->delete($this->getEndpoint().'/'.urlencode($id).'?'.http_build_query($parameters));
+    }
+}

src/Actions/FetchMany.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Swis\JsonApi\Client\Actions;
+
+trait FetchMany
+{
+    /**
+     * @param array $parameters
+     *
+     * @return \Swis\JsonApi\Client\Interfaces\DocumentInterface
+     */
+    public function all(array $parameters = [])
+    {
+        return $this->getClient()->get($this->getEndpoint().'?'.http_build_query($parameters));
+    }
+}

src/Actions/FetchOne.php

@@ -0,0 +1,19 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Swis\JsonApi\Client\Actions;
+
+trait FetchOne
+{
+    /**
+     * @param string $id
+     * @param array  $parameters
+     *
+     * @return \Swis\JsonApi\Client\Interfaces\DocumentInterface
+     */
+    public function find(string $id, array $parameters = [])
+    {
+        return $this->getClient()->get($this->getEndpoint().'/'.urlencode($id).'?'.http_build_query($parameters));
+    }
+}

src/Actions/Save.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Swis\JsonApi\Client\Actions;
+
+use Swis\JsonApi\Client\Interfaces\ItemInterface;
+
+trait Save
+{
+    use Create { create as protected saveNew; }
+    use Update { update as protected saveExisting; }
+
+    /**
+     * @param \Swis\JsonApi\Client\Interfaces\ItemInterface $item
+     * @param array                                         $parameters
+     *
+     * @return \Swis\JsonApi\Client\Interfaces\DocumentInterface
+     */
+    public function save(ItemInterface $item, array $parameters = [])
+    {
+        if ($item->isNew()) {
+            return $this->saveNew($item, $parameters);
+        }
+
+        return $this->saveExisting($item, $parameters);
+    }
+}

src/Actions/TakeOne.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Swis\JsonApi\Client\Actions;
+
+trait TakeOne
+{
+    /**
+     * @param array $parameters
+     *
+     * @return \Swis\JsonApi\Client\Interfaces\DocumentInterface
+     */
+    public function take(array $parameters = [])
+    {
+        return $this->getClient()->get($this->getEndpoint().'?'.http_build_query($parameters));
+    }
+}

src/Actions/Update.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Swis\JsonApi\Client\Actions;
+
+use Swis\JsonApi\Client\Interfaces\ItemInterface;
+
+trait Update
+{
+    /**
+     * @param \Swis\JsonApi\Client\Interfaces\ItemInterface $item
+     * @param array                                         $parameters
+     *
+     * @return \Swis\JsonApi\Client\Interfaces\DocumentInterface
+     */
+    public function update(ItemInterface $item, array $parameters = [])
+    {
+        return $this->getClient()->patch(
+            $this->getEndpoint().'/'.urlencode($item->getId()).'?'.http_build_query($parameters),
+            $this->documentFactory->make($item)
+        );
+    }
+}

src/BaseRepository.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Swis\JsonApi\Client;
+
+use Swis\JsonApi\Client\Interfaces\DocumentClientInterface;
+
+abstract class BaseRepository
+{
+    /**
+     * @var \Swis\JsonApi\Client\Interfaces\DocumentClientInterface
+     */
+    protected $client;
+
+    /**
+     * @var \Swis\JsonApi\Client\DocumentFactory
+     */
+    protected $documentFactory;
+
+    /**
+     * @var string
+     */
+    protected $endpoint = '';
+
+    /**
+     * @param \Swis\JsonApi\Client\Interfaces\DocumentClientInterface $client
+     * @param \Swis\JsonApi\Client\DocumentFactory                    $documentFactory
+     */
+    public function __construct(DocumentClientInterface $client, DocumentFactory $documentFactory)
+    {
+        $this->client = $client;
+        $this->documentFactory = $documentFactory;
+    }
+
+    /**
+     * @return \Swis\JsonApi\Client\Interfaces\DocumentClientInterface
+     */
+    public function getClient()
+    {
+        return $this->client;
+    }
+
+    /**
+     * @return string
+     */
+    public function getEndpoint()
+    {
+        return $this->endpoint;
+    }
+}