Merge branch 'release/2.0.0-beta.2'

Author: lindyhopchris

.travis.yml

@@ -2,21 +2,20 @@ language: php
 dist: trusty
 sudo: false
 
-env:
-  global:
-    - PHPUNIT_VERSION=^8.0
-
 matrix:
   include:
     - php: "7.2"
       env:
         - LARAVEL_VERSION=^7.0
+        - PHPUNIT_VERSION=^8.0
     - php: "7.3"
       env:
         - LARAVEL_VERSION=^7.0
+        - PHPUNIT_VERSION=^9.0
     - php: "7.4"
       env:
         - LARAVEL_VERSION=^7.0
+        - PHPUNIT_VERSION=^9.0
 
 install:
   - composer require "laravel/framework:${LARAVEL_VERSION}" --no-update -n

CHANGELOG.md

@@ -2,6 +2,17 @@
 All notable changes to this project will be documented in this file. This project adheres to
 [Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/).
 
+## [2.0.0-beta.2] - 2020-04-12
+
+### Changed
+- Refactored API configuration to reduce constructor arguments in the API class.
+- Updated UUID dependency so that version 3 and 4 are allowed.
+
+### Fixed
+- [#498](https://github.com/cloudcreativity/laravel-json-api/issues/498)
+Update exception parser interface to type-hint a `Throwable` instance instead of an
+`Exception`.
+
 ## [2.0.0-beta.1] - 2020-03-04
 
 ### Added

composer.json

@@ -33,17 +33,17 @@
         "illuminate/support": "^7.0",
         "neomerx/json-api": "^1.0.3",
         "nyholm/psr7": "^1.2",
-        "ramsey/uuid": "^3.0",
+        "ramsey/uuid": "^3.0|^4.0",
         "symfony/psr-http-message-bridge": "^2.0"
     },
     "require-dev": {
         "ext-sqlite3": "*",
-        "cloudcreativity/json-api-testing": "^2.1",
+        "cloudcreativity/json-api-testing": "^3.0",
         "guzzlehttp/guzzle": "^6.3",
         "laravel/ui": "^2.0",
         "mockery/mockery": "^1.1",
         "orchestra/testbench": "^5.0",
-        "phpunit/phpunit": "^8.0"
+        "phpunit/phpunit": "^9.0"
     },
     "suggest": {
         "cloudcreativity/json-api-testing": "Required to use the test helpers."

docs/index.md

@@ -1,6 +1,6 @@
 # Introduction
 
-Add [jsonapi.org](http://jsonapi.org) compliant APIs to your Laravel 5 application.
+Add [jsonapi.org](http://jsonapi.org) compliant APIs to your Laravel application.
 Based on the framework agnostic packages [neomerx/json-api](https://github.com/neomerx/json-api) and
 [cloudcreativity/json-api](https://github.com/cloudcreativity/json-api).
 

docs/installation.md

@@ -4,16 +4,19 @@ Install using [Composer](http://getcomposer.org):
 
 ```bash
 $ composer require cloudcreativity/laravel-json-api
-$ composer require --dev "cloudcreativity/json-api-testing:^1.2|^2.0"
+$ composer require --dev "cloudcreativity/json-api-testing"
 ```
 
 This package's service provider and facade will be automatically added using package discovery. You will
 then need to check your API route prefix and update your Exception handler as follows...
 
+Please find a compatibility matrix between Laravel and Laravel JSON API version in
+[project's readme on GitHub](https://github.com/cloudcreativity/laravel-json-api#laravel-versions).
+
 ## Route Prefixes
 
 The default Laravel installation has an `api` prefix for API routes. If you want to register your JSON API
-routes in your `routes/api.php` file, you will need to remove the prefix from the `mapApiRoutes()` method in your 
+routes in your `routes/api.php` file, you will need to remove the prefix from the `mapApiRoutes()` method in your
 `RouteServiceProvider`.
 
 For example, change this:
@@ -99,7 +102,7 @@ class Handler extends ExceptionHandler
 
     // do standard exception rendering here...
   }
-  
+
   protected function prepareException(Exception $e)
   {
       if ($e instanceof JsonApiException) {

src/Api/Api.php

@@ -60,34 +60,24 @@ class Api
     private $name;
 
     /**
-     * @var EncodingList
-     */
-    private $encodings;
-
-    /**
-     * @var DecodingList
-     */
-    private $decodings;
-
-    /**
-     * @var bool
+     * @var Url
      */
-    private $useEloquent;
+    private $url;
 
     /**
-     * @var Url
+     * @var Config
      */
-    private $url;
+    private $config;
 
     /**
-     * @var Jobs
+     * @var EncodingList|null
      */
-    private $jobs;
+    private $encodings;
 
     /**
-     * @var string|null
+     * @var DecodingList|null
      */
-    private $supportedExt;
+    private $decodings;
 
     /**
      * @var ContainerInterface|null
@@ -104,71 +94,27 @@ class Api
      */
     private $responses;
 
-    /**
-     * @var array
-     */
-    private $providers;
-
-    /**
-     * @var string|null
-     */
-    private $connection;
-
-    /**
-     * @var bool
-     */
-    private $transactions;
-
-    /**
-     * @var string|null
-     */
-    private $modelNamespace;
-
     /**
      * Api constructor.
      *
      * @param Factory $factory
      * @param AggregateResolver $resolver
-     * @param $apiName
-     * @param EncodingList $encodings
-     * @param DecodingList $decodings
+     * @param string $name
      * @param Url $url
-     * @param Jobs $jobs
-     * @param bool $useEloquent
-     * @param string|null $supportedExt
-     * @param array $providers
-     * @param string|null $connection
-     * @param bool $transactions
-     * @param string|null $modelNamespace
+     * @param Config $config
      */
     public function __construct(
         Factory $factory,
         AggregateResolver $resolver,
-        $apiName,
-        EncodingList $encodings,
-        DecodingList $decodings,
+        string $name,
         Url $url,
-        Jobs $jobs,
-        $useEloquent = true,
-        $supportedExt = null,
-        array $providers = [],
-        string $connection = null,
-        bool $transactions = true,
-        string $modelNamespace = null
+        Config $config
     ) {
         $this->factory = $factory;
         $this->resolver = $resolver;
-        $this->name = $apiName;
-        $this->encodings = $encodings;
-        $this->decodings = $decodings;
+        $this->name = $name;
         $this->url = $url;
-        $this->jobs = $jobs;
-        $this->useEloquent = $useEloquent;
-        $this->supportedExt = $supportedExt;
-        $this->providers = $providers;
-        $this->connection = $connection;
-        $this->transactions = $transactions;
-        $this->modelNamespace = $modelNamespace;
+        $this->config = $config;
     }
 
     /**
@@ -223,7 +169,7 @@ public function getName()
      */
     public function isEloquent()
     {
-        return $this->useEloquent;
+        return $this->config->useEloquent();
     }
 
     /**
@@ -239,7 +185,7 @@ public function getUrl()
      */
     public function getJobs()
     {
-        return $this->jobs;
+        return Jobs::fromArray($this->config->jobs());
     }
 
     /**
@@ -271,27 +217,38 @@ public function getStore()
      */
     public function getSupportedExtensions()
     {
-        if (!$this->supportedExt) {
-            return null;
+        if ($ext = $this->config->supportedExt()) {
+            return $this->factory->createSupportedExtensions($ext);
         }
 
-        return $this->factory->createSupportedExtensions($this->supportedExt);
+        return null;
     }
 
     /**
      * @return EncodingList
      */
     public function getEncodings(): EncodingList
     {
-        return $this->encodings;
+        if ($this->encodings) {
+            return $this->encodings;
+        }
+
+        return $this->encodings = EncodingList::fromArray(
+            $this->config->encoding(),
+            $this->url->toString()
+        );
     }
 
     /**
      * @return DecodingList
      */
     public function getDecodings(): DecodingList
     {
-        return $this->decodings;
+        if ($this->decodings) {
+            return $this->decodings;
+        }
+
+        return $this->decodings = DecodingList::fromArray($this->config->decoding());
     }
 
     /**
@@ -303,8 +260,8 @@ public function getDefaultCodec(): Codec
     {
         return $this->factory->createCodec(
             $this->getContainer(),
-            $this->encodings->find(MediaTypeInterface::JSON_API_MEDIA_TYPE) ?: Encoding::jsonApi(),
-            $this->decodings->find(MediaTypeInterface::JSON_API_MEDIA_TYPE)
+            $this->getEncodings()->find(MediaTypeInterface::JSON_API_MEDIA_TYPE) ?: Encoding::jsonApi(),
+            $this->getDecodings()->find(MediaTypeInterface::JSON_API_MEDIA_TYPE)
         );
     }
 
@@ -329,7 +286,7 @@ public function getResponses()
      */
     public function getConnection(): ?string
     {
-        return $this->connection;
+        return $this->config->dbConnection();
     }
 
     /**
@@ -339,7 +296,7 @@ public function getConnection(): ?string
      */
     public function hasTransactions(): bool
     {
-        return $this->transactions;
+        return $this->config->dbTransactions();
     }
 
     /**
@@ -356,7 +313,7 @@ public function exceptions(): ExceptionParserInterface
      */
     public function getModelNamespace(): ?string
     {
-        return $this->modelNamespace;
+        return $this->config->modelNamespace();
     }
 
     /**
@@ -438,7 +395,7 @@ public function providers(): ResourceProviders
     {
         return new ResourceProviders(
             $this->factory,
-            $this->providers
+            $this->config->providers()
         );
     }