[Feature] Get an encoder for a named API

An encoder can now be obtained for a named API using the
JSON API service's `encoder` method.

This contributes towards Issue #36

Author: lindyhopchris

CHANGELOG.md

@@ -4,6 +4,9 @@ All notable changes to this project will be documented in this file. This projec
 
 ## Unreleased
 
+### Added
+- An encoder can now be obtained for a named API via the JSON API service `encoder` method.
+
 ### Removed
 - Removed the validator error factory interface from this library as the one provided by `cloudcreativity/json-api`
 has the additional methods on it.

src/Api/Repository.php

@@ -19,10 +19,12 @@
 namespace CloudCreativity\LaravelJsonApi\Api;
 
 use CloudCreativity\JsonApi\Contracts\Http\ApiInterface;
+use CloudCreativity\JsonApi\Encoder\Encoder;
 use CloudCreativity\JsonApi\Exceptions\RuntimeException;
 use CloudCreativity\LaravelJsonApi\Factories\Factory;
 use Illuminate\Contracts\Config\Repository as Config;
 use Illuminate\Support\Arr;
+use Neomerx\JsonApi\Encoder\EncoderOptions;
 
 /**
  * Class Repository
@@ -97,6 +99,22 @@ public function retrieveDefinition($apiName)
         return $this->definitions[$apiName] = $definition;
     }
 
+    /**
+     * @param $apiName
+     * @param string|null $host
+     * @param int $options
+     * @param int $depth
+     * @return Encoder
+     */
+    public function retrieveEncoder($apiName, $host = null, $options = 0, $depth = 512)
+    {
+        $definition = $this->retrieveDefinition($apiName);
+        $schemas = $this->factory->createContainer($definition->getResources()->getSchemas());
+        $url = $this->mergeHostAndUrlPrefix($host, $definition->getUrlPrefix());
+
+        return $this->factory->createEncoder($schemas, new EncoderOptions($options, $url, $depth));
+    }
+
     /**
      * @param $apiName
      * @return ResourceProviders

src/Services/JsonApiService.php

@@ -24,7 +24,9 @@
 use CloudCreativity\JsonApi\Contracts\Http\Requests\RequestInterpreterInterface;
 use CloudCreativity\JsonApi\Contracts\Http\Responses\ErrorResponseInterface;
 use CloudCreativity\JsonApi\Contracts\Utils\ErrorReporterInterface;
+use CloudCreativity\JsonApi\Encoder\Encoder;
 use CloudCreativity\JsonApi\Exceptions\RuntimeException;
+use CloudCreativity\LaravelJsonApi\Api\Repository;
 use CloudCreativity\LaravelJsonApi\Routing\ResourceRegistrar;
 use Exception;
 use Illuminate\Contracts\Container\Container;
@@ -65,6 +67,21 @@ public function api($apiName, array $options, Closure $routes)
         $registrar->api($apiName, $options, $routes);
     }
 
+    /**
+     * @param $apiName
+     * @param string|null $host
+     * @param int $options
+     * @param int $depth
+     * @return Encoder
+     */
+    public function encoder($apiName, $host = null, $options = 0, $depth = 512)
+    {
+        /** @var Repository $repository */
+        $repository = $this->container->make(Repository::class);
+
+        return $repository->retrieveEncoder($apiName, $host, $options, $depth);
+    }
+
     /**
      * @inheritdoc
      */