Merge school endpoints

readme.md

@@ -44,6 +44,54 @@ foreach ($client->schools->all() as $school) {
     // Display school name
     echo $school->name . PHP_EOL;
 }
+
+```
+
+### Pending Schools
+
+```php
+$client = new \Wonde\Client('TOKEN_GOES_HERE');
+
+foreach ($client->schools->pending() as $school) {
+    // Display school name
+    echo $school->name . PHP_EOL;
+}
+```
+
+### Search Schools
+
+```php
+$client = new \Wonde\Client('TOKEN_GOES_HERE');
+
+// Search for schools with a postcode starting CB21
+foreach ($client->schools->search(['postcode' => 'CB21']) as $school) {
+    // Display school name
+    echo $school->name . PHP_EOL;
+}
+
+// Search for schools with the establishment number = 6006
+foreach ($client->schools->search(['establishment_number' => '6006']) as $school) {
+    // Display school name
+    echo $school->name . PHP_EOL;
+}
+```
+
+### Request Access
+
+Provide the school ID to request access to a school's data.
+
+```php
+$client = new \Wonde\Client('TOKEN_GOES_HERE');
+$client->requestAccess('A0000000000');
+```
+
+### Revoke Access
+
+Provide the school ID to access already approve or pending approval.
+
+```php
+$client = new \Wonde\Client('TOKEN_GOES_HERE');
+$client->revokeAccess('A0000000000');
 ```
 
 ### Students

src/Client.php

@@ -23,7 +23,7 @@ class Client
     /**
      * @var string
      */
-    const version = '1.1.0';
+    const version = '1.2.0';
 
     /**
      * Client constructor.
@@ -49,5 +49,35 @@ public function school($id)
     {
         return new Schools($this->token, $id);
     }
+
+    /**
+     * Request access to the current school
+     *
+     * @return array
+     */
+    public function requestAccess($schoolId)
+    {
+        $this->uri = $this->uri . $schoolId . '/request-access';
+
+        /** @var array $response */
+        $response = $this->post();
+
+        return $response;
+    }
+
+    /**
+     * Revoke access to the current school
+     *
+     * @return array
+     */
+    public function revokeAccess($schoolId)
+    {
+        $this->uri = $this->uri . $schoolId . '/revoke-access';
+
+        /** @var array $response */
+        $response = $this->post();
+
+        return $response;
+    }
 }
 

src/Endpoints/BootstrapEndpoint.php

@@ -33,29 +33,24 @@ public function __construct($token, $uri = false)
     }
 
     /**
-     * Get the default guzzle client
+     * Get all of resource
      *
-     * @return Client
+     * @param array $includes
+     * @param array $parameters
+     * @return mixed|\Psr\Http\Message\ResponseInterface
      */
-    private function client()
+    public function all($includes = [], $parameters = [])
     {
-        if ((float) Client::VERSION >= 6) {
-            return new Client([
-                'headers' => [
-                    'Authorization' => 'Basic ' . base64_encode($this->token . ':'),
-                    'User-Agent'    => 'wonde-php-client-' . \Wonde\Client::version
-                ]
-            ]);
-        } else {
-            return new Client([
-                'defaults' => [
-                    'headers' => [
-                        'Authorization' => 'Basic ' . base64_encode($this->token . ':'),
-                        'User-Agent'    => 'wonde-php-client-' . \Wonde\Client::version
-                    ]
-                ]
-            ]);
+        if ( ! empty($includes)) {
+            $parameters['include'] = implode(',', $includes);
         }
+
+        $uri = ! empty($parameters) ? $this->uri . '?' . http_build_query($parameters) : $this->uri;
+
+        $response = $this->getRequest($uri)->getBody()->getContents();
+        $decoded  = json_decode($response);
+
+        return new ResultIterator($decoded, $this->token);
     }
 
     /**
@@ -81,24 +76,29 @@ public function getUrl($url)
     }
 
     /**
-     * Get all of resource
+     * Get the default guzzle client
      *
-     * @param array $includes
-     * @param array $parameters
-     * @return mixed|\Psr\Http\Message\ResponseInterface
+     * @return Client
      */
-    public function all($includes = [], $parameters = [])
+    private function client()
     {
-        if ( ! empty($includes)) {
-            $parameters['include'] = implode(',', $includes);
+        if ((float) Client::VERSION >= 6) {
+            return new Client([
+                'headers' => [
+                    'Authorization' => 'Basic ' . base64_encode($this->token . ':'),
+                    'User-Agent'    => 'wonde-php-client-' . \Wonde\Client::version
+                ]
+            ]);
+        } else {
+            return new Client([
+                'defaults' => [
+                    'headers' => [
+                        'Authorization' => 'Basic ' . base64_encode($this->token . ':'),
+                        'User-Agent'    => 'wonde-php-client-' . \Wonde\Client::version
+                    ]
+                ]
+            ]);
         }
-
-        $uri = ! empty($parameters) ? $this->uri . '?' . http_build_query($parameters) : $this->uri;
-
-        $response = $this->getRequest($uri)->getBody()->getContents();
-        $decoded  = json_decode($response);
-
-        return new ResultIterator($decoded, $this->token);
     }
 
     /**
@@ -120,4 +120,31 @@ public function get($id, $includes = [], $parameters = [])
 
         return $decoded->data;
     }
+
+    /**
+     * Make a post request
+     *
+     * @param array $body
+     * @return array
+     */
+    public function post($body = [])
+    {
+        return $this->postRequest($this->uri);
+    }
+
+    /**
+     * Make a post request and decode the response
+     *
+     * @param       $endpoint
+     * @param array $body
+     * @return array
+     */
+    private function postRequest($endpoint, $body = [])
+    {
+        $response = $this->client()->post(self::endpoint . $endpoint);
+        /** @var string $content */
+        $content = $response->getBody()->getContents();
+        /** @var array $decoded */
+        return json_decode($content);
+    }
 }

src/Endpoints/Schools.php

@@ -1,5 +1,8 @@
 <?php namespace Wonde\Endpoints;
 
+use GuzzleHttp\Psr7\Response;
+use Wonde\Exceptions\InvalidInputException;
+
 class Schools extends BootstrapEndpoint
 {
     /**
@@ -140,4 +143,30 @@ public function __construct($token, $id = false)
         $this->students          = new Students($token, $this->uri);
         $this->subjects          = new Subjects($token, $this->uri);
     }
+
+    /**
+     * Return all pending schools
+     *
+     * @param array $includes
+     * @param array $parameters
+     * @return mixed|\Psr\Http\Message\ResponseInterface
+     */
+    public function pending($includes = [], $parameters = [])
+    {
+        $this->uri = $this->uri . 'pending/';
+        return $this->all($includes, $parameters);
+    }
+
+    /**
+     * Search available schools
+     *
+     * @param array $includes
+     * @param array $parameters
+     * @return mixed|\Psr\Http\Message\ResponseInterface
+     */
+    public function search($includes = [], $parameters = [])
+    {
+        $this->uri = $this->uri . 'all/';
+        return $this->all($includes, $parameters);
+    }
 }