Merge pull request #53 from bookboon/hotfix/v1-ns

Hotfix/v1 ns
bookboon · Apr 28, 2020 · 3066c35 · 3066c35
2 parents 528c66f + 22bbba5
commit 3066c35
Show file tree

Hide file tree

Showing 21 changed files with 71 additions and 64 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -18,7 +18,7 @@ jobs:
     - stage: "Tests"
       name: "Unit Tests"
       script: vendor/bin/phpunit -c . --coverage-clover build/logs/clover.xml
-    - script: vendor/bin/phpstan analyse src/ --level 6 --no-progress
+    - script: vendor/bin/phpstan analyse src/ --level 5 --no-progress
       name: "Static Analyser"
 
 before_script:

diff --git a/phpstan.neon b/phpstan.neon
@@ -0,0 +1,3 @@
+parameters:
+    ignoreErrors:
+        - '#Unsafe usage of new static().#'
diff --git a/src/Client/BasicAuthClient.php b/src/Client/BasicAuthClient.php
@@ -40,6 +40,7 @@ class BasicAuthClient implements ClientInterface
      * @param Headers $headers
      * @param CacheInterface|null $cache
      * @param string|null $apiUri
+     * @param LoggerInterface|null $logger
      * @throws UsageException
      */
     public function __construct(
@@ -48,8 +49,8 @@ public function __construct(
         Headers $headers,
         CacheInterface $cache = null,
         $apiUri = null,
-        LoggerInterface $logger = null)
-    {
+        LoggerInterface $logger = null
+    ) {
         if (empty($apiId) || empty($apiSecret)) {
             throw new UsageException("Key and secret are required");
         }

diff --git a/src/Client/BookboonResponse.php b/src/Client/BookboonResponse.php
@@ -113,7 +113,7 @@ public function serialize()
      */
     public function unserialize($serialized)
     {
-        $data = unserialize($serialized, ['']);
+        $data = unserialize($serialized, ['allowed_classes' => [BookboonResponse::class]]);
         $this->body = $data['body'];
         $this->status = $data['status'];
         $this->headers = $data['headers'];

diff --git a/src/Client/ClientInterface.php b/src/Client/ClientInterface.php
@@ -23,7 +23,7 @@ interface ClientInterface
     const API_HOST = 'bookboon.com';
     const API_PATH = '/api';
 
-    const VERSION = 'Bookboon-PHP/3.2';
+    const VERSION = 'Bookboon-PHP/3.3';
 
     /**
      * Prepares the call to the api and if enabled tries cache provider first for GET calls.

diff --git a/src/Client/ResponseTrait.php b/src/Client/ResponseTrait.php
@@ -28,7 +28,7 @@ protected function handleErrorResponse(string $body, array $headers, int $status
             case 400:
             case 405:
                 $returnArray = json_decode($body, true);
-                throw new ApiSyntaxException($returnArray['message']);
+                throw new ApiSyntaxException($returnArray['message'] ?? '');
             case 401:
             case 403:
                 $returnArray = json_decode($body, true);
@@ -42,7 +42,6 @@ protected function handleErrorResponse(string $body, array $headers, int $status
             case 410:
             case 404:
                 throw new ApiNotFoundException($url);
-                break;
             default:
                 $returnArray = json_decode($body, true);
                 throw new ApiGeneralException($this->generalExceptionMessage($returnArray ?? [], $headers));
@@ -86,4 +85,4 @@ protected function getResponseHeader(array $headers, string $name) : string
     {
         return $headers[$name] ?? '';
     }
-}
+}
diff --git a/src/Entity/Author.php b/src/Entity/Author.php
@@ -22,12 +22,12 @@ public static function get(Bookboon $bookboon, string $authorId) : BookboonRespo
             throw new BadUUIDException();
         }
 
-        $bResponse = $bookboon->rawRequest("/authors/$authorId");
+        $bResponse = $bookboon->rawRequest("/v1/authors/$authorId");
 
         $bResponse->setEntityStore(
             new EntityStore(
                 [
-                    new static($bResponse->getReturnArray())
+                    new self($bResponse->getReturnArray())
                 ]
             )
         );
@@ -43,7 +43,7 @@ public static function get(Bookboon $bookboon, string $authorId) : BookboonRespo
      */
     public static function getAll(Bookboon $bookboon)
     {
-        $bResponse = $bookboon->rawRequest("/authors");
+        $bResponse = $bookboon->rawRequest('/v1/authors');
 
         $bResponse->setEntityStore(
             new EntityStore(static::getEntitiesFromArray($bResponse->getReturnArray()))
@@ -63,7 +63,7 @@ public static function getAll(Bookboon $bookboon)
      */
     public static function getByBookId(Bookboon $bookboon, string $bookId) : BookboonResponse
     {
-        $bResponse = $bookboon->rawRequest("/books/$bookId/authors");
+        $bResponse = $bookboon->rawRequest("/v1/books/$bookId/authors");
 
         $bResponse->setEntityStore(
             new EntityStore(static::getEntitiesFromArray($bResponse->getReturnArray()))

diff --git a/src/Entity/Book.php b/src/Entity/Book.php
@@ -32,7 +32,7 @@ abstract class Book extends Entity
      */
     public static function get(Bookboon $bookboon, string $bookId, bool $extendedMetadata = false) : BookboonResponse
     {
-        $bResponse = $bookboon->rawRequest("/books/$bookId", ['extendedMetadata' => $extendedMetadata ? 'true' : 'false']);
+        $bResponse = $bookboon->rawRequest("/v1/books/$bookId", ['extendedMetadata' => $extendedMetadata ? 'true' : 'false']);
 
         $bResponse->setEntityStore(
             new EntityStore(
@@ -69,7 +69,7 @@ public static function getMultiple(
             'extendedMetadata' => $extendedMetadata ? 'true' : 'false'
         ];
 
-        $bResponse = $bookboon->rawRequest("/books", $variables);
+        $bResponse = $bookboon->rawRequest('/v1/books', $variables);
 
         $bResponse->setEntityStore(
             new EntityStore(static::getEntitiesFromArray($bResponse->getReturnArray()))
@@ -99,7 +99,7 @@ public static function getAll(
             'extendedMetadata' => $extendedMetadata ? 'true' : 'false'
         ];
 
-        $bResponse = $bookboon->rawRequest("/books", $variables);
+        $bResponse = $bookboon->rawRequest('/v1/books', $variables);
 
         $bResponse->setEntityStore(
             new EntityStore(static::getEntitiesFromArray($bResponse->getReturnArray()))
@@ -157,7 +157,7 @@ public static function getDownloadUrl(
     ) : string {
         $variables['format'] = $format;
 
-        $bResponse = $bookboon->rawRequest("/books/$bookId/download", $variables, ClientInterface::HTTP_POST);
+        $bResponse = $bookboon->rawRequest("/v1/books/$bookId/download", $variables, ClientInterface::HTTP_POST);
 
         return $bResponse->getReturnArray()['url'];
     }
@@ -181,7 +181,7 @@ public static function search(
         int $offset = 0,
          array $bookTypes = ['pdf']
     ) : BookboonResponse {
-        $bResponse = $bookboon->rawRequest('/search', ['q' => $query, 'limit' => $limit, 'offset' => $offset, 'bookType' => join(',', $bookTypes)]);
+        $bResponse = $bookboon->rawRequest('/v1/search', ['q' => $query, 'limit' => $limit, 'offset' => $offset, 'bookType' => join(',', $bookTypes)]);
 
         $bResponse->setEntityStore(
             new EntityStore(Book::getEntitiesFromArray($bResponse->getReturnArray()))
@@ -206,7 +206,7 @@ public static function recommendations(
         int $limit = 5,
         array $bookTypes = ['pdf']
     ) : BookboonResponse {
-        $bResponse = $bookboon->rawRequest('/recommendations', ['limit' => $limit, 'books' => $bookIds, 'bookType' => join(',', $bookTypes)]);
+        $bResponse = $bookboon->rawRequest('/v1/recommendations', ['limit' => $limit, 'books' => $bookIds, 'bookType' => join(',', $bookTypes)]);
 
         $bResponse->setEntityStore(
             new EntityStore(Book::getEntitiesFromArray($bResponse->getReturnArray()))

diff --git a/src/Entity/Category.php b/src/Entity/Category.php
@@ -8,9 +8,6 @@
 
 class Category extends Entity
 {
-    const TEXTBOOKS = 'd1fabb36-4eff-4760-a80d-a15700efa9ae';
-    const BUSINESS = '82403e77-ccbf-4e10-875c-a15700ef8a56';
-
     /**
      * Get Category.
      *
@@ -24,12 +21,12 @@ class Category extends Entity
      */
     public static function get(Bookboon $bookboon, string $categoryId, array $bookTypes = ['pdf']) : BookboonResponse
     {
-        $bResponse = $bookboon->rawRequest("/categories/$categoryId", ['bookType' => join(',', $bookTypes)]);
+        $bResponse = $bookboon->rawRequest("/v1/categories/$categoryId", ['bookType' => join(',', $bookTypes)]);
 
         $bResponse->setEntityStore(
             new EntityStore(
                 [
-                    new static($bResponse->getReturnArray())
+                    new self($bResponse->getReturnArray())
                 ]
             )
         );
@@ -51,7 +48,7 @@ public static function getTree(
         array $blacklistedCategoryIds = [],
         int $depth = 2
     ) : BookboonResponse {
-        $bResponse = $bookboon->rawRequest('/categories', ['depth' => $depth]);
+        $bResponse = $bookboon->rawRequest('/v1/categories');
 
         $categories = $bResponse->getReturnArray();
 
@@ -60,7 +57,7 @@ public static function getTree(
         }
 
         $bResponse->setEntityStore(
-            new EntityStore(Category::getEntitiesFromArray($categories))
+            new EntityStore(self::getEntitiesFromArray($categories))
         );
 
         return $bResponse;
@@ -100,7 +97,7 @@ private static function recursiveBlacklist(array &$categories, array $blackliste
      */
     public static function getDownloadUrl(Bookboon $bookboon, string $categoryId, array $variables) : string
     {
-        $bResponse = $bookboon->rawRequest("/categories/$categoryId/download", $variables, ClientInterface::HTTP_POST);
+        $bResponse = $bookboon->rawRequest("/v1/categories/$categoryId/download", $variables, ClientInterface::HTTP_POST);
 
         return $bResponse->getReturnArray()['url'];
     }

diff --git a/src/Entity/Exam.php b/src/Entity/Exam.php
@@ -25,12 +25,12 @@ public static function get(Bookboon $bookboon, string $examId) : BookboonRespons
             throw new BadUUIDException();
         }
 
-        $bResponse = $bookboon->rawRequest("/exams/$examId");
+        $bResponse = $bookboon->rawRequest("/v1/exams/$examId");
 
         $bResponse->setEntityStore(
             new EntityStore(
                 [
-                    new static($bResponse->getReturnArray())
+                    new self($bResponse->getReturnArray())
                 ]
             )
         );
@@ -46,7 +46,7 @@ public static function get(Bookboon $bookboon, string $examId) : BookboonRespons
      */
     public static function getByBookId(Bookboon $bookboon, string $bookId) : BookboonResponse
     {
-        $bResponse = $bookboon->rawRequest("/books/$bookId/exams");
+        $bResponse = $bookboon->rawRequest("/v1/books/$bookId/exams");
 
         $bResponse->setEntityStore(
             new EntityStore(Exam::getEntitiesFromArray($bResponse->getReturnArray()))
@@ -64,7 +64,7 @@ public static function getByBookId(Bookboon $bookboon, string $bookId) : Bookboo
      */
     public static function getAll(Bookboon $bookboon) : BookboonResponse
     {
-        $bResponse = $bookboon->rawRequest("/exams");
+        $bResponse = $bookboon->rawRequest("/v1/exams");
 
         $bResponse->setEntityStore(
             new EntityStore(static::getEntitiesFromArray($bResponse->getReturnArray()))
@@ -75,12 +75,12 @@ public static function getAll(Bookboon $bookboon) : BookboonResponse
 
     public static function start(Bookboon $bookboon, $examId)
     {
-        return $bookboon->rawRequest("/exams/$examId", [], ClientInterface::HTTP_POST)->getReturnArray();
+        return $bookboon->rawRequest("/v1/exams/$examId", [], ClientInterface::HTTP_POST)->getReturnArray();
     }
 
     public static function finish(Bookboon $bookboon, $examId, $postVars)
     {
-        return $bookboon->rawRequest("/exams/$examId/submit", $postVars, ClientInterface::HTTP_POST)->getReturnArray();
+        return $bookboon->rawRequest("/v1/exams/$examId/submit", $postVars, ClientInterface::HTTP_POST)->getReturnArray();
     }
 
     /**
@@ -141,4 +141,4 @@ public function getQuestions()
     {
         return ExamQuestion::getEntitiesFromArray($this->safeGet('questions'));
     }
-}
+}
diff --git a/src/Entity/Frontpage.php b/src/Entity/Frontpage.php
@@ -24,10 +24,10 @@ class Frontpage extends Entity
      */
     public static function get(Bookboon $bookboon, array $bookTypes = ['pdf']) : BookboonResponse
     {
-        $bResponse = $bookboon->rawRequest('/frontpage', ['bookType' => implode(',', $bookTypes)]);
+        $bResponse = $bookboon->rawRequest('/v1/frontpage', ['bookType' => implode(',', $bookTypes)]);
 
         $bResponse->setEntityStore(
-            new EntityStore(Frontpage::getEntitiesFromArray($bResponse->getReturnArray()))
+            new EntityStore(self::getEntitiesFromArray($bResponse->getReturnArray()))
         );
 
         return $bResponse;
@@ -46,14 +46,12 @@ public static function get(Bookboon $bookboon, array $bookTypes = ['pdf']) : Boo
      */
     public static function getBySlug(Bookboon $bookboon, string $slug, array $bookTypes = ['pdf']) : BookboonResponse
     {
-
-        /** @var Frontpage[] $frontpageArray */
-        $bResponse = $bookboon->rawRequest("/frontpage/$slug", ['bookType' => join(',', $bookTypes)]);
+        $bResponse = $bookboon->rawRequest("/v1/frontpage/$slug", ['bookType' => join(',', $bookTypes)]);
 
         $bResponse->setEntityStore(
             new EntityStore(
                 [
-                    new static($bResponse->getReturnArray())
+                    new self($bResponse->getReturnArray())
                 ]
             )
         );

diff --git a/src/Entity/Journey.php b/src/Entity/Journey.php
@@ -18,9 +18,9 @@ class Journey extends Entity
      */
     public static function get(Bookboon $bookboon, string $journeyId) : BookboonResponse
     {
-        $bResponse = $bookboon->rawRequest("/journeys/$journeyId");
+        $bResponse = $bookboon->rawRequest("/v1/journeys/$journeyId");
 
-        $journeyEntity = new static($bResponse->getReturnArray());
+        $journeyEntity = new self($bResponse->getReturnArray());
 
         if (count($journeyEntity->getBookIds()) > 0) {
             $books = Book::getMultiple($bookboon, $journeyEntity->getBookIds(), false);
@@ -49,7 +49,7 @@ public static function get(Bookboon $bookboon, string $journeyId) : BookboonResp
      */
     public static function getAll(Bookboon $bookboon, array $bookTypes = ['pdf']) : BookboonResponse
     {
-        $bResponse = $bookboon->rawRequest('/journeys');
+        $bResponse = $bookboon->rawRequest('/v1/journeys');
 
         $bResponse->setEntityStore(
             new EntityStore(Journey::getEntitiesFromArray($bResponse->getReturnArray()))

diff --git a/src/Entity/Language.php b/src/Entity/Language.php
@@ -19,7 +19,7 @@ class Language extends Entity
      */
     public static function get(Bookboon $bookboon, array $bookTypes = ['pdf']) : BookboonResponse
     {
-        $bResponse = $bookboon->rawRequest('/languages');
+        $bResponse = $bookboon->rawRequest('/v1/languages');
 
         $bResponse->setEntityStore(
             new EntityStore(Language::getEntitiesFromArray($bResponse->getReturnArray()))

diff --git a/src/Entity/Question.php b/src/Entity/Question.php
@@ -22,7 +22,7 @@ public static function get(
         array $answerIds = [],
         string $rootSegmentId = ''
     ) : BookboonResponse {
-        $url = $rootSegmentId == '' ? '/questions' : '/questions/' . $rootSegmentId;
+        $url = $rootSegmentId == '' ? '/v1/questions' : '/v1/questions/' . $rootSegmentId;
         $bResponse =  $bookboon->rawRequest($url, ['answer' => $answerIds]);
 
         $bResponse->setEntityStore(
@@ -46,7 +46,7 @@ public static function send(
         array $variables = [],
         string $rootSegmentId = ''
     ) : BookboonResponse {
-        $url = $rootSegmentId == '' ? '/questions' : '/questions/' . $rootSegmentId;
+        $url = $rootSegmentId == '' ? '/v1/questions' : '/v1/questions/' . $rootSegmentId;
         $bResponse = $bookboon->rawRequest($url, $variables, ClientInterface::HTTP_POST);
         return $bResponse;
     }

diff --git a/src/Entity/Review.php b/src/Entity/Review.php
@@ -25,23 +25,23 @@ public static function getByBookId(Bookboon $bookboon, string $bookId) : Bookboo
             throw new BadUUIDException();
         }
 
-        $bResponse = $bookboon->rawRequest("/books/$bookId/review");
+        $bResponse = $bookboon->rawRequest("/v1/books/$bookId/reviews");
 
         $bResponse->setEntityStore(
-            new EntityStore(Review::getEntitiesFromArray($bResponse->getReturnArray()))
+            new EntityStore(self::getEntitiesFromArray($bResponse->getReturnArray()))
         );
 
         return $bResponse;
     }
 
     /**
      * @param array $review
-     * @return static
+     * @return Review
      * @throws \Bookboon\Api\Exception\EntityDataException
      */
     public static function create(array $review = []) : Review
     {
-        return new static($review);
+        return new self($review);
     }
 
 
@@ -57,7 +57,7 @@ public static function create(array $review = []) : Review
     public function submit(Bookboon $bookboon, string $bookId) : void
     {
         if (Entity::isValidUUID($bookId)) {
-            $bookboon->rawRequest("/books/$bookId/review", $this->getData(), ClientInterface::HTTP_POST);
+            $bookboon->rawRequest("/v1/books/$bookId/reviews", $this->getData(), ClientInterface::HTTP_POST);
         }
     }