Merge branch 'develop'

README.md

@@ -9,8 +9,17 @@ PHP library allowing you to use the [Strapi](https://strapi.io/) API via various
 
 ## TODO
 - [x] User system (without external provider)
-- [ ] Collection types
-- [ ] Single types
+- Collection types
+  - [x] Get
+  - [x] Get Id
+  - [ ] Post
+  - [ ] Put
+  - [ ] Delete
+- Single types
+  - [x] Get
+  - [ ] Put
+  - [ ] Delete
+  - [ ] Post
 - [ ] Upload
 
 Check this [docs](https://github.com/SimonDevelop/strapi-api/blob/master/docs) for more.

docs/README.md

@@ -2,6 +2,6 @@
 
 - [SimonDevelop\Strapi\Setup](https://github.com/SimonDevelop/strapi-api/blob/master/docs/setup.md)
 - [SimonDevelop\Strapi\Auth](https://github.com/SimonDevelop/strapi-api/blob/master/docs/auth.md)
-- SimonDevelop\Strapi\CollectionTypes
-- SimonDevelop\Strapi\SingleTypes
-- SimonDevelop\Strapi\Upload
+- [SimonDevelop\Strapi\CollectionType](https://github.com/SimonDevelop/strapi-api/blob/master/docs/collection.md)
+- [SimonDevelop\Strapi\SingleType](https://github.com/SimonDevelop/strapi-api/blob/master/docs/single.md)
+- SimonDevelop\Strapi\Upload

docs/collection.md

@@ -0,0 +1,30 @@
+# SimonDevelop\Strapi\CollectionType references
+
+## __constructor(SimonDevelop\Strapi\Setup $setup)
+```php
+$collection = new CollectionType($setup);
+```
+
+## getSetup(): SimonDevelop\Strapi\Setup
+### Get Setup object
+```php
+$setup = $collection->getSetup();
+```
+
+## setSetup(SimonDevelop\Strapi\Setup $setup): self
+### Define Setup object
+```php
+$collection->setSetup($setup);
+```
+
+## get(string $collection): array|string
+### CollectionType data (response strapi) if the request is passed, else information in string
+```php
+$response = $collection->get('users');
+```
+
+## getById(string $collection, int $id): array|string
+### CollectionType data item by id (response strapi) if the request is passed, else information in string
+```php
+$response = $collection->get('users', 1);
+```

docs/single.md

@@ -0,0 +1,24 @@
+# SimonDevelop\Strapi\SingleType references
+
+## __constructor(SimonDevelop\Strapi\Setup $setup)
+```php
+$single = new SingleType($setup);
+```
+
+## getSetup(): SimonDevelop\Strapi\Setup
+### Get Setup object
+```php
+$setup = $single->getSetup();
+```
+
+## setSetup(SimonDevelop\Strapi\Setup $setup): self
+### Define Setup object
+```php
+$single->setSetup($setup);
+```
+
+## get(string $single): array|string
+### SingleType data (response strapi) if the request is passed, else information in string
+```php
+$response = $single->get('homepage');
+```

src/Auth.php

@@ -16,10 +16,6 @@
 use GuzzleHttp\Exception\ClientException;
 use GuzzleHttp\Exception\ConnectException;
 
-/**
- * Class Auth
- * Authentication, register and more function.
- */
 class Auth
 {
     /**
@@ -50,19 +46,19 @@ class Auth
     /**
      * @var Setup
      */
-    private $setup;
+    private Setup $setup;
 
     /**
      * @var Client
      */
-    private $client;
+    private Client $client;
 
     /**
      * @param Setup $setup
      */
     public function __construct(Setup $setup)
     {
-        $this->setup = $setup;
+        $this->setup  = $setup;
         $this->client = new Client();
     }
 
@@ -175,8 +171,8 @@ public function resetPassword(string $code, string $newPassword, string $newPass
             // @codeCoverageIgnoreStart
             $response = $this->client->request('POST', $this->setup->getUrl() . self::RESET_PASSWORD_URL, [
                 'json' => [
-                    'code' => $code,
-                    'password' => $newPassword,
+                    'code'                 => $code,
+                    'password'             => $newPassword,
                     'passwordConfirmation' => $newPasswordConfirm
                 ]
             ]);

src/CollectionType.php

@@ -0,0 +1,115 @@
+<?php
+
+/*
+ * This file is the strapi-api package.
+ *
+ * (c) Simon Micheneau <contact@simon-micheneau.fr>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace SimonDevelop\Strapi;
+
+use SimonDevelop\Strapi\Setup;
+use GuzzleHttp\Client;
+use GuzzleHttp\Exception\ClientException;
+use GuzzleHttp\Exception\ConnectException;
+
+class CollectionType
+{
+    /**
+     * @var Setup
+     */
+    private Setup $setup;
+
+    /**
+     * @var Client
+     */
+    private Client $client;
+
+    /**
+     * @param Setup $setup
+     */
+    public function __construct(Setup $setup)
+    {
+        $this->setup  = $setup;
+        $this->client = new Client();
+    }
+
+    /**
+     * @param string $collection
+     * @return array|string
+     */
+    public function get(string $collection)
+    {
+        // Function tested with mock
+        try {
+            // @codeCoverageIgnoreStart
+            $response = $this->client->request('GET', $this->setup->getUrl() . "/$collection", [
+                'headers' => [
+                    'authorization' => 'Bearer '.$this->setup->getToken()
+                ]
+            ]);
+
+            return json_decode($response->getBody()->getContents(), true);
+            // @codeCoverageIgnoreEnd
+        } catch (ClientException $e) {
+            // @codeCoverageIgnoreStart
+            $json = json_decode($e->getResponse()->getBody()->getContents(), true);
+
+            return $json['error']['message'];
+            // @codeCoverageIgnoreEnd
+        } catch (ConnectException $e) {
+            return $e->getMessage();
+        }
+    }
+
+    /**
+     * @param string $collection
+     * @param int    $id
+     * @return array|string
+     */
+    public function getById(string $collection, int $id)
+    {
+        // Function tested with mock
+        try {
+            // @codeCoverageIgnoreStart
+            $response = $this->client->request('GET', $this->setup->getUrl() . "/$collection/$id", [
+                'headers' => [
+                    'authorization' => 'Bearer '.$this->setup->getToken()
+                ]
+            ]);
+
+            return json_decode($response->getBody()->getContents(), true);
+            // @codeCoverageIgnoreEnd
+        } catch (ClientException $e) {
+            // @codeCoverageIgnoreStart
+            $json = json_decode($e->getResponse()->getBody()->getContents(), true);
+
+            return $json['error']['message'];
+            // @codeCoverageIgnoreEnd
+        } catch (ConnectException $e) {
+            return $e->getMessage();
+        }
+    }
+
+    /**
+     * @return Setup Current setup
+     */
+    public function getSetup(): Setup
+    {
+        return $this->setup;
+    }
+
+    /**
+     * @param Setup $setup
+     * @return CollectionType
+     */
+    public function setSetup(Setup $setup): self
+    {
+        $this->setup = $setup;
+
+        return $this;
+    }
+}

src/Setup.php

@@ -11,10 +11,6 @@
 
 namespace SimonDevelop\Strapi;
 
-/**
- * Class Setup
- * Configure your setup strapi api.
- */
 class Setup
 {
     /**

src/SingleType.php

@@ -0,0 +1,86 @@
+<?php
+
+/*
+ * This file is the strapi-api package.
+ *
+ * (c) Simon Micheneau <contact@simon-micheneau.fr>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace SimonDevelop\Strapi;
+
+use SimonDevelop\Strapi\Setup;
+use GuzzleHttp\Client;
+use GuzzleHttp\Exception\ClientException;
+use GuzzleHttp\Exception\ConnectException;
+
+class SingleType
+{
+    /**
+     * @var Setup
+     */
+    private Setup $setup;
+
+    /**
+     * @var Client
+     */
+    private Client $client;
+
+    /**
+     * @param Setup $setup
+     */
+    public function __construct(Setup $setup)
+    {
+        $this->setup  = $setup;
+        $this->client = new Client();
+    }
+
+    /**
+     * @param string $single
+     * @return array|string
+     */
+    public function get(string $single)
+    {
+        // Function tested with mock
+        try {
+            // @codeCoverageIgnoreStart
+            $response = $this->client->request('GET', $this->setup->getUrl() . "/$single", [
+                'headers' => [
+                    'authorization' => 'Bearer '.$this->setup->getToken()
+                ]
+            ]);
+
+            return json_decode($response->getBody()->getContents(), true);
+            // @codeCoverageIgnoreEnd
+        } catch (ClientException $e) {
+            // @codeCoverageIgnoreStart
+            $json = json_decode($e->getResponse()->getBody()->getContents(), true);
+
+            return $json['error']['message'];
+            // @codeCoverageIgnoreEnd
+        } catch (ConnectException $e) {
+            return $e->getMessage();
+        }
+    }
+
+    /**
+     * @return Setup Current setup
+     */
+    public function getSetup(): Setup
+    {
+        return $this->setup;
+    }
+
+    /**
+     * @param Setup $setup
+     * @return SingleType
+     */
+    public function setSetup(Setup $setup): self
+    {
+        $this->setup = $setup;
+
+        return $this;
+    }
+}