Tweaks and typo fixes

Author: jasonbosco

README.md

@@ -2,19 +2,17 @@
 
 PHP client for the Typesense API: https://github.com/typesense/typesense
 
-Follows the Typesense [API specification](https://github.com/typesense/typesense-api-spec).
-
 ## Installation
 
 ```
-$ composer require devloopsnet/typesens-php
+$ composer require typesense/typesense-php
 ```
 
-You can also add `devloopsnet/typesense-php` to your project's `composer.json`.
+You can also add `typesense/typesense-php` to your project's `composer.json`.
 
 ## Usage
 
-You can find some examples [here](https://github.com/devloopsnet/typesense-php/blob/master/examples/collection_operations.php).
+You can find some examples [here](https://github.com/typesense/typesense-php/blob/master/examples/collection_operations.php).
 
 See detailed [API documentation](https://typesense.org/api).
 
@@ -28,14 +26,11 @@ See detailed [API documentation](https://typesense.org/api).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at [https://github.com/devloopsnet/typesense-php].
-
-## Author
-
-[Abdullah Al-Faqeir](https://github.org/abdullahfaqeir)
-
-## License
+Bug reports and pull requests are welcome on GitHub at [https://github.com/typesense/typesense-php].
 
-`typesense-php` is distributed under the Apache 2 license.
+## Credits
 
+This client was originally developed by [Abdullah Al-Faqeir](https://github.org/abdullahfaqeir) and was 
+[adopted](https://github.com/devloopsnet/typesense-php/issues/4) as the official PHP client library for Typesense in Oct 2020.
 
+Ongoing development and support is now provided by Typesense, in addition to our collaborators.

composer.json

@@ -1,26 +1,40 @@
 {
-  "name": "devloopsnet/typesens-php",
+  "name": "typesense/typesense-php",
   "description": "PHP client for Typesense https://github.com/typesense/typesense",
   "type": "library",
-  "homepage": "https://www.devloops.net",
+  "homepage": "https://github.com/typesense/typesense-php",
   "license": "Apache-2.0",
   "authors": [
+    {
+      "name": "Typesense",
+      "email": "contact@typesense.org",
+      "homepage": "https://typesense.org",
+      "role": "Developer"
+    },
     {
       "name": "Abdullah Al-Faqeir",
       "email": "abdullah@devloops.net",
       "homepage": "https://www.devloops.net",
       "role": "Developer"
     }
   ],
+  "support": {
+    "docs": "https://typesense.org/api",
+    "source": "https://github.com/typesense/typesense-php",
+    "issues": "https://github.com/typesense/typesense-php/issues"
+  },
   "minimum-stability": "stable",
   "autoload": {
     "psr-4": {
-      "Typesence\\": "src/"
+      "Typesense\\": "src/"
     }
   },
   "require": {
-    "php/php": ">7.4.*",
+    "php": ">=7.4",
     "guzzlehttp/guzzle": "^7.0",
     "ext-json": "*"
+  },
+  "scripts": {
+    "typesenseServer": "docker run -i -p 8108:8108 -v/tmp/typesense-server-data-1c/:/data typesense/typesense:0.15.0 --data-dir /data --api-key=xyz --listen-port 8108 --enable-cors"
   }
 }

examples/README.md

@@ -0,0 +1,14 @@
+### Running the examples
+
+Start a local typesense server via docker:
+
+```shell script
+composer run-script typesenseServer
+```
+
+Then:
+
+```shell script 
+cd examples
+php <example_name>.php
+```

examples/alias_operations.php

@@ -2,12 +2,12 @@
 
 include '../vendor/autoload.php';
 
-use \Typesence\Client;
+use \Typesense\Client;
 
 try {
     $client = new Client(
       [
-        'api_key'         => 'abcd',
+        'api_key'         => 'xyz',
         'nodes'           => [
           [
             'host'     => 'localhost',
@@ -19,6 +19,16 @@
       ]
     );
     echo '<pre>';
+    try {
+        print_r($client->aliases['books']->delete());
+    } catch (Exception $e) {
+        // Don't error out if the collection was not found
+    }
+    try {
+        print_r($client->collections['books_january']->delete());
+    } catch (Exception $e) {
+        // Don't error out if the collection was not found
+    }
     echo "--------Create Collection-------\n";
     print_r(
       $client->collections->create(

examples/collection_operations.php

@@ -2,12 +2,12 @@
 
 include '../vendor/autoload.php';
 
-use \Typesence\Client;
+use \Typesense\Client;
 
 try {
     $client = new Client(
       [
-        'api_key'         => 'abcd',
+        'api_key'         => 'xyz',
         'nodes'           => [
           [
             'host'     => 'localhost',
@@ -19,7 +19,13 @@
       ]
     );
     echo '<pre>';
-    //print_r($client->collections['books']->delete());
+
+    try {
+        print_r($client->collections['books']->delete());
+    } catch (Exception $e) {
+        // Don't error out if the collection was not found
+    }
+
     echo "--------Create Collection-------\n";
     print_r(
       $client->collections->create(
@@ -125,7 +131,8 @@
     echo "\n";
     echo "--------Import Documents-------\n";
     $docsToImport = [];
-    foreach ($exportedDocStrs as $exportedDocStr) {
+    $exportedDocStrsArray = explode('\n', $exportedDocStrs);
+    foreach ($exportedDocStrsArray as $exportedDocStr) {
         $docsToImport[] = json_decode($exportedDocStr, true);
     }
     $importRes =

examples/curation_operations.php

@@ -2,12 +2,12 @@
 
 include '../vendor/autoload.php';
 
-use \Typesence\Client;
+use \Typesense\Client;
 
 try {
     $client = new Client(
       [
-        'api_key'         => 'abcd',
+        'api_key'         => 'xyz',
         'nodes'           => [
           [
             'host'     => 'localhost',
@@ -19,6 +19,11 @@
       ]
     );
     echo '<pre>';
+    try {
+        print_r($client->collections['books']->delete());
+    } catch (Exception $e) {
+        // Don't error out if the collection was not found
+    }
     echo "--------Create Collection-------\n";
     print_r(
       $client->collections->create(

src/Alias.php

@@ -1,21 +1,21 @@
 <?php
 
-namespace Typesence;
+namespace Typesense;
 
-use \Typesence\Lib\Configuration;
+use \Typesense\Lib\Configuration;
 
 /**
  * Class Alias
  *
- * @package \Typesence
+ * @package \Typesense
  * @date    4/5/20
  * @author  Abdullah Al-Faqeir <abdullah@devloops.net>
  */
 class Alias
 {
 
     /**
-     * @var \Typesence\Lib\Configuration
+     * @var \Typesense\Lib\Configuration
      */
     private Configuration $config;
 
@@ -25,14 +25,14 @@ class Alias
     private string $name;
 
     /**
-     * @var \Typesence\ApiCall
+     * @var \Typesense\ApiCall
      */
     private ApiCall $apiCall;
 
     /**
      * Alias constructor.
      *
-     * @param  \Typesence\Lib\Configuration  $config
+     * @param  \Typesense\Lib\Configuration  $config
      * @param  string  $name
      */
     public function __construct(Configuration $config, string $name)
@@ -52,7 +52,7 @@ public function endPointPath(): string
 
     /**
      * @return array
-     * @throws \Typesence\Exceptions\TypesenseClientError|\GuzzleHttp\Exception\GuzzleException
+     * @throws \Typesense\Exceptions\TypesenseClientError|\GuzzleHttp\Exception\GuzzleException
      */
     public function retrieve(): array
     {
@@ -61,7 +61,7 @@ public function retrieve(): array
 
     /**
      * @return array
-     * @throws \Typesence\Exceptions\TypesenseClientError|\GuzzleHttp\Exception\GuzzleException
+     * @throws \Typesense\Exceptions\TypesenseClientError|\GuzzleHttp\Exception\GuzzleException
      */
     public function delete(): array
     {

src/Aliases.php

@@ -1,13 +1,13 @@
 <?php
 
-namespace Typesence;
+namespace Typesense;
 
-use \Typesence\Lib\Configuration;
+use \Typesense\Lib\Configuration;
 
 /**
  * Class Aliases
  *
- * @package \Typesence
+ * @package \Typesense
  * @date    4/5/20
  * @author  Abdullah Al-Faqeir <abdullah@devloops.net>
  */
@@ -17,12 +17,12 @@ class Aliases implements \ArrayAccess
     public const RESOURCE_PATH = '/aliases';
 
     /**
-     * @var \Typesence\Lib\Configuration
+     * @var \Typesense\Lib\Configuration
      */
     private Configuration $config;
 
     /**
-     * @var \Typesence\ApiCall
+     * @var \Typesense\ApiCall
      */
     private ApiCall $apiCall;
 
@@ -34,7 +34,7 @@ class Aliases implements \ArrayAccess
     /**
      * Aliases constructor.
      *
-     * @param  \Typesence\Lib\Configuration  $config
+     * @param  \Typesense\Lib\Configuration  $config
      */
     public function __construct(Configuration $config)
     {
@@ -57,7 +57,7 @@ public function endPointPath(string $aliasName): string
      * @param  array  $mapping
      *
      * @return array
-     * @throws \Typesence\Exceptions\TypesenseClientError|\GuzzleHttp\Exception\GuzzleException
+     * @throws \Typesense\Exceptions\TypesenseClientError|\GuzzleHttp\Exception\GuzzleException
      */
     public function upsert(string $name, array $mapping): array
     {
@@ -66,11 +66,11 @@ public function upsert(string $name, array $mapping): array
 
     /**
      * @return array
-     * @throws \Typesence\Exceptions\TypesenseClientError|\GuzzleHttp\Exception\GuzzleException
+     * @throws \Typesense\Exceptions\TypesenseClientError|\GuzzleHttp\Exception\GuzzleException
      */
     public function retrieve(): array
     {
-        return $this->apiCall->get($this->endPointPath(self::RESOURCE_PATH), []);
+        return $this->apiCall->get(self::RESOURCE_PATH, []);
     }
 
     /**