Merge pull request #76 from phiHero/patch

fix: URI encode user-inputted string

Author: jasonbosco

src/Alias.php

@@ -41,7 +41,7 @@ public function __construct(string $name, ApiCall $apiCall)
      */
     public function endPointPath(): string
     {
-        return sprintf('%s/%s', Aliases::RESOURCE_PATH, $this->name);
+        return sprintf('%s/%s', Aliases::RESOURCE_PATH, encodeURIComponent($this->name));
     }
 
     /**

src/Aliases.php

@@ -43,7 +43,7 @@ public function __construct(ApiCall $apiCall)
      */
     public function endPointPath(string $aliasName): string
     {
-        return sprintf('%s/%s', static::RESOURCE_PATH, $aliasName);
+        return sprintf('%s/%s', static::RESOURCE_PATH, encodeURIComponent($aliasName));
     }
 
     /**

src/AnalyticsRule.php

@@ -25,6 +25,6 @@ public function delete()
 
     private function endpointPath()
     {
-        return AnalyticsRules::RESOURCE_PATH . '/' . $this->ruleName;
+        return AnalyticsRules::RESOURCE_PATH . '/' . encodeURIComponent($this->ruleName);
     }
 }

src/AnalyticsRules.php

@@ -34,6 +34,6 @@ public function retrieve()
 
     private function endpoint_path($operation = null)
     {
-        return self::RESOURCE_PATH . ($operation === null ? '' : "/$operation");
+        return self::RESOURCE_PATH . ($operation === null ? '' : "/" . encodeURIComponent($operation));
     }
 }

src/Client.php

@@ -5,6 +5,7 @@
 use Typesense\Exceptions\ConfigError;
 use Typesense\Lib\Configuration;
 
+include('utils/utils.php');
 /**
  * Class Client
  *

src/Collection.php

@@ -64,7 +64,7 @@ public function __construct(string $name, ApiCall $apiCall)
      */
     public function endPointPath(): string
     {
-        return sprintf('%s/%s', Collections::RESOURCE_PATH, $this->name);
+        return sprintf('%s/%s', Collections::RESOURCE_PATH, encodeURIComponent($this->name));
     }
 
     /**

src/Conversation.php

@@ -68,6 +68,6 @@ public function delete(): array
      */
     public function endPointPath(): string
     {
-        return sprintf('%s/%s', Conversations::RESOURCE_PATH, $this->id);
+        return sprintf('%s/%s', Conversations::RESOURCE_PATH, encodeURIComponent($this->id));
     }
 }

src/ConversationModel.php

@@ -68,6 +68,6 @@ public function delete(): array
      */
     public function endPointPath(): string
     {
-        return sprintf('%s/%s', ConversationModels::RESOURCE_PATH, $this->id);
+        return sprintf('%s/%s', ConversationModels::RESOURCE_PATH, encodeURIComponent($this->id));
     }
 }

src/Document.php

@@ -51,9 +51,9 @@ private function endpointPath(): string
         return sprintf(
             '%s/%s/%s/%s',
             Collections::RESOURCE_PATH,
-            $this->collectionName,
+            encodeURIComponent($this->collectionName),
             Documents::RESOURCE_PATH,
-            $this->documentId
+            encodeURIComponent($this->documentId)
         );
     }
 

src/Documents.php

@@ -53,7 +53,7 @@ private function endPointPath(string $action = ''): string
         return sprintf(
             '%s/%s/%s/%s',
             Collections::RESOURCE_PATH,
-            $this->collectionName,
+            encodeURIComponent($this->collectionName),
             static::RESOURCE_PATH,
             $action
         );
@@ -125,7 +125,7 @@ public function createMany(array $documents, array $options = []): array
     {
         $this->apiCall->getLogger()->warning(
             "createMany is deprecated and will be removed in a future version. " .
-            "Use import instead, which now takes both an array of documents or a JSONL string of documents"
+                "Use import instead, which now takes both an array of documents or a JSONL string of documents"
         );
         return $this->import($documents, $options);
     }