.github/ISSUE_TEMPLATE/BUG.yml

@@ -16,14 +16,10 @@ body:
     id: version
     attributes:
       label: Version
-      description: What version of Spaces-API is this occuring on? Versions below 3 will not be fixed. Please upgrade.
+      description: What version of Spaces-API is this occuring on?
       options:
-        - 3.5.0
-        - 3.4.0
-        - 3.3.0
-        - 3.2.0
-        - 3.1.0
-        - 3.0.0
+        - 2.0.1
+        - 2.0.0
     validations:
       required: true
   - type: input

README.md

@@ -1,7 +1,6 @@
-# This library is deprecated
-We recommend using the [official SDK](https://github.com/DigitalOceanPHP/Client) or the [Laravel package](https://github.com/GrahamCampbell/Laravel-DigitalOcean)
+![Spaces-API](https://imgur.com/NYNsQyl.png "Devang Srivastava's Spaces-API")
 
-All issues will be closed and new PRs will not be accepted
+PHP library for accessing Digital Ocean spaces
 
 ## Installation
 Install via composer
@@ -33,9 +32,6 @@ $file2url = $file2->getSignedURL("2 hours");
 // Make a copy
 $file3 = $file2->copy('remote-file-3.txt');
 
-// Move or rename a file
-$file2->move('new-filename.txt')
-
 // Make a file public and get the URL
 $file3->makePublic();
 $file3url = $file3->getURL();

SpacesAPI/File.php

@@ -4,8 +4,6 @@ namespace SpacesAPI;
 
 use SpacesAPI\Exceptions\FileDoesntExistException;
 
-use function PHPUnit\Framework\isNull;
-
 /**
  * Represents a single file
  *
@@ -48,21 +46,20 @@ class File
     private $_content_length;
 
     /**
-     * @param \SpacesAPI\Space $space An instance of `\SpacesAPI\Space`
-     * @param string $filename The filename of a file
-     * @param array $info Any information already known about the file (eg content_length, content_type, etc). Default `[]`
-     * @param bool $validate Check that the file exists
+     * @param \SpacesAPI\Space $space
+     * @param string $filename
+     * @param array $info
      *
-     * @throws \SpacesAPI\Exceptions\FileDoesntExistException If validation is `true` and the file doesn't exist
+     * @throws \SpacesAPI\Exceptions\FileDoesntExistException
      */
-    public function __construct(Space $space, string $filename, array $info = [], bool $validate = true)
+    public function __construct(Space $space, string $filename, array $info = [])
     {
         $this->space = $space;
         $this->space_name = $space->getName();
         $this->s3 = $space->getS3Client();
         $this->_filename = $filename;
 
-        if ($validate && !$this->s3->doesObjectExist($this->space_name, $filename)) {
+        if (!$this->s3->doesObjectExist($this->space_name, $filename)) {
             throw new FileDoesntExistException("File $filename doesn't exist");
         }
 
@@ -213,34 +210,19 @@ class File
      *
      * @return \SpacesAPI\File
      */
-    public function copy(string $newFilename): File
+    public function copy(string $newFilename, bool $public = false): File
     {
         $this->s3->copy(
             $this->space_name,
             $this->_filename,
             $this->space_name,
             $newFilename,
-            ($this->isPublic()) ? 'public-read' : 'private'
+            ($public) ? 'public-read' : 'private'
         );
 
         return new self($this->space, $newFilename);
     }
 
-    /**
-     * @param string $newFilename
-     *
-     * @return \SpacesAPI\File
-     */
-    public function move(string $newFilename): File
-    {
-        $this->copy($newFilename);
-        $this->delete();
-        $this->_filename = $newFilename;
-        $this->fetchFileInfo();
-
-        return $this;
-    }
-
     /**
      * Get the public URL
      * This URL will not work if the file is private

SpacesAPI/Space.php

@@ -36,16 +36,15 @@ class Space
      *
      * @param \Aws\S3\S3Client $s3 An authenticated S3Client instance
      * @param string $name Space name
-     * @param bool $validate Check that the space exists
      *
-     * @throws \SpacesAPI\Exceptions\SpaceDoesntExistException If validation is `true` and the space doesn't exist
+     * @throws \SpacesAPI\Exceptions\SpaceDoesntExistException
      */
-    public function __construct(S3Client $s3, string $name, bool $validate = true)
+    public function __construct(S3Client $s3, string $name)
     {
         $this->s3 = $s3;
         $this->name = $name;
 
-        if ($validate && !$this->s3->doesBucketExist($name)) {
+        if (!$this->s3->doesBucketExist($name)) {
             throw new SpaceDoesntExistException("Space '$this->name' does not exist");
         }
     }
@@ -234,29 +233,13 @@ class Space
     /**
      * List all files in the space (recursively)
      *
-     * @param string $directory The directory to list files in. Empty string for root directory
-     *
-     * @return array
-     */
-    public function listFiles(string $directory = ""): array
-    {
-        $rawFiles = $this->rawListFiles($directory);
-        $files = [];
-
-        foreach ($rawFiles as $fileInfo) {
-            $files[$fileInfo['Key']] = new File($this, $fileInfo['Key'], $fileInfo, false);
-        }
-
-        return ['files' => $files];
-    }
-
-    /**
      * @param string $directory The directory to list files in. Empty string for root directory
      * @param string|null $continuationToken Used internally to work around request limits (1000 files per request)
      *
      * @return array
+     * @throws \SpacesAPI\Exceptions\FileDoesntExistException
      */
-    private function rawListFiles(string $directory = "", ?string $continuationToken = null): array
+    public function listFiles(string $directory = "", ?string $continuationToken = null): array
     {
         $data = Result::parse(
             $this->s3->listObjectsV2([
@@ -269,14 +252,20 @@ class Space
                                      ])
         );
 
+        $files = [
+            'files' => [],
+        ];
+
         if (!isset($data['Contents'])) {
-            return [];
+            return $files;
         }
 
-        $files = $data['Contents'];
+        foreach ($data['Contents'] as $fileInfo) {
+            $files['files'][$fileInfo['Key']] = new File($this, $fileInfo['Key'], $fileInfo);
+        }
 
         if (isset($data["NextContinuationToken"]) && $data["NextContinuationToken"] != "") {
-            $files = array_merge($files, $this->rawListFiles($directory, $data["NextContinuationToken"]));
+            $files = array_merge($files['files'], $this->listFiles($directory, $data["NextContinuationToken"])['files']);
         }
 
         return $files;
@@ -288,14 +277,13 @@ class Space
      * @param string $text The text to upload
      * @param string $filename The filepath/name to save to
      * @param array $params Any extra parameters. [See here](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#upload-property)
-     * @param bool $private True for the file to be private, false to allow public access
      *
      * @return \SpacesAPI\File
      */
-    public function uploadText(string $text, string $filename, array $params = [], bool $private = true): File
+    public function uploadText(string $text, string $filename, array $params = []): File
     {
-        $this->s3->upload($this->name, $filename, $text, ($private) ? 'private' : 'public-read', $params);
-        return new File($this, $filename, [], false);
+        $this->s3->upload($this->name, $filename, $text, 'private', $params);
+        return new File($this, $filename);
     }
 
     /**
@@ -303,36 +291,31 @@ class Space
      *
      * @param string $filepath The path to the file, including the filename. Relative and absolute paths are accepted.
      * @param string|null $filename The remote filename. If `null`, the local filename will be used.
-     * @param string|null $mimeType The file mime type to pass as ContentType for the file (e.g. 'image/jpeg').
-     * @param bool $private True for the file to be private, false to allow public access.
      *
      * @return \SpacesAPI\File
      */
-    public function uploadFile(string $filepath, ?string $filename = null, ?string $mimeType = null, bool $private = true): File
+    public function uploadFile(string $filepath, ?string $filename = null): File
     {
         $this->s3->putObject([
                                  'Bucket' => $this->name,
                                  'Key' => ($filename) ?: basename($filepath),
                                  'SourceFile' => $filepath,
-                                 'ContentType' => $mimeType,
-                                 'ACL' => ($private) ? 'private' : 'public-read'
                              ]);
 
-        return new File($this, ($filename) ?: basename($filepath), [], false);
+        return new File($this, ($filename) ?: basename($filepath));
     }
 
     /**
      * Get an instance of \SpacesAPI\File for a given filename
      *
      * @param string $filename
-     * @package bool $validate
      *
      * @return \SpacesAPI\File
      * @throws \SpacesAPI\Exceptions\FileDoesntExistException Thrown if the file doesn't exist
      */
-    public function file(string $filename, bool $validate = true): File
+    public function file(string $filename): File
     {
-        return new File($this, $filename, [], $validate);
+        return new File($this, $filename);
     }
 
     /**

SpacesAPI/Spaces.php

@@ -36,7 +36,7 @@ class Spaces
     {
         $this->s3 = new S3Client([
                                      "version" => "latest",
-                                     "region" => $region,
+                                     "region" => "us-east-1",
                                      "endpoint" => "https://$region.$host",
                                      "credentials" => ["key" => $accessKey, "secret" => $secretKey],
                                      "ua_append" => "SociallyDev-Spaces-API/2",
@@ -61,7 +61,7 @@ class Spaces
         $spaces = [];
 
         foreach (Result::parse($this->s3->listBuckets()['Buckets']) as $bucket) {
-            $spaces[$bucket['Name']] = new Space($this->s3, $bucket['Name'], false);
+            $spaces[$bucket['Name']] = new Space($this->s3, $bucket['Name']);
         }
 
         return $spaces;
@@ -87,7 +87,7 @@ class Spaces
             throw new SpaceExistsException($e->getAwsErrorMessage());
         }
 
-        return new Space($this->s3, $name, false);
+        return new Space($this->s3, $name);
     }
 
     /**

composer.json

@@ -1,7 +1,7 @@
 {
   "name": "sociallydev/spaces-api",
   "description": "Library for accessing Digital Ocean spaces",
-  "version":"3.6.1",
+  "version":"3.1.0",
   "type": "library",
   "license": "MIT",
   "authors": [
@@ -27,7 +27,7 @@
   },
   "require-dev": {
     "clean/phpdoc-md": "^0.19.1",
-    "phpunit/phpunit": "^9.5.13",
-    "vlucas/phpdotenv": "^v5.4.1"
+    "phpunit/phpunit": "^9.5",
+    "vlucas/phpdotenv": "^5.3"
   }
 }

docs/Examples.md

@@ -33,7 +33,7 @@ foreach ($files['files'] as $file) {
 
 ```php
 $space = new Spaces('api-key', 'api-secret')->space('my-space-name');
-$file = $space->uploadFile('./localfile.txt', 'remote-filename.txt');
+$file = $space->uploadFile('./localfile.txt');
 ```
 [API docs for uploading files](Space.md#spaceuploadfile)
 

docs/File.md

@@ -21,16 +21,18 @@ Rather obtain an instance from `\SpacesAPI\Space::list()`, `\SpacesAPI\Spaces::f
 | Name | Description |
 |------|-------------|
 |[__construct](#file__construct)||
+|[__get](#file__get)|Magic getter to make the properties read-only|
 |[copy](#filecopy)|Copy the file on the space|
 |[delete](#filedelete)|Permanently delete this file|
 |[download](#filedownload)|Download the file to a local location|
 |[getContents](#filegetcontents)|Get the file contents as a string|
 |[getSignedURL](#filegetsignedurl)|Get a signed URL, which will work for private files|
-|[getURL](#filegeturl)|Get the public URL. This URL will not work if the file is private|
+|[getURL](#filegeturl)|Get the public URL
+This URL will not work if the file is private|
 |[isPublic](#fileispublic)|Is this file publicly accessible|
 |[makePrivate](#filemakeprivate)|Make file non-publicly accessible|
 |[makePublic](#filemakepublic)|Make file publicly accessible|
-|[move](#filemove)|Move and/or rename file|
+|[pascalCaseToCamelCase](#filepascalcasetocamelcase)||
 
 
 
@@ -40,15 +42,18 @@ Rather obtain an instance from `\SpacesAPI\Space::list()`, `\SpacesAPI\Spaces::f
 **Description**
 
 ```php
- __construct (\SpacesAPI\Space $space, string $filename, array $info = [], bool $validate = true)
+ __construct (\SpacesAPI\Space $space, string $filename, array $info = [])
 ```
 
+
+
+
+
 **Parameters**
 
 * `(\SpacesAPI\Space) $space` : An instance of `\SpacesAPI\Space`
 * `(string) $filename` : The filename of a file
 * `(array) $info` : Any information already known about the file (eg content_length, content_type, etc). Default `[]`
-* `(bool) $validate` : Check that the file exists. Default `true`
 
 **Return Values**
 
@@ -56,7 +61,7 @@ Rather obtain an instance from `\SpacesAPI\Space::list()`, `\SpacesAPI\Spaces::f
 
 **Throws Exceptions**
 
-`\SpacesAPI\Exceptions\FileDoesntExistException` : If validation is `true` and the file doesn't exist
+`\SpacesAPI\Exceptions\FileDoesntExistException` : If the file doesn't exist
 
 
 <hr />
@@ -289,27 +294,4 @@ Make file publicly accessible
 `void`
 
 
-<hr />
-
-
-### File::move
-
-**Description**
-
-```php
-public move (string $newFilename)
-```
-
-Move or rename a file
-The instance of `File` is now the moved object
-
-**Parameters**
-
-* `(string) $newFilename`
-
-**Return Values**
-
-`\SpacesAPI\File` : An instance for the new file
-
-
 <hr />

docs/Space.md

@@ -37,7 +37,7 @@ Rather obtain an instance from `\SpacesAPI\Spaces::space()` or `\SpacesAPI\Space
 **Description**
 
 ```php
-public __construct (\Aws\S3\S3Client $s3, string $name, bool $validate = true)
+public __construct (\Aws\S3\S3Client $s3, string $name)
 ```
 
 Load a space
@@ -51,8 +51,6 @@ rather obtain an instance from `\SpacesAPI\Spaces::space()` or `\SpacesAPI\Space
 : An authenticated S3Client instance
 * `(string) $name`
 : Space name
-* `(bool) $validate`
-: Check that the space exists. Default `true`
 
 **Return Values**
 
@@ -62,7 +60,7 @@ rather obtain an instance from `\SpacesAPI\Spaces::space()` or `\SpacesAPI\Space
 **Throws Exceptions**
 
 
-`\SpacesAPI\Exceptions\SpaceDoesntExistException` : If validation is `true` and the space doesn't exist
+`\SpacesAPI\Exceptions\SpaceDoesntExistException` : If the space doesn't exist
 
 
 <hr />
@@ -180,7 +178,7 @@ Recursively download an entire directory.
 **Description**
 
 ```php
-public file (string $filename, bool $validate = true)
+public file (string $filename)
 ```
 
 Get an instance of \SpacesAPI\File for a given filename
@@ -190,8 +188,6 @@ Get an instance of \SpacesAPI\File for a given filename
 **Parameters**
 
 * `(string) $filename`
-* `(bool) $validate`
-: Whether to validate the file exits. Defaults to `true`
 
 **Return Values**
 
@@ -318,7 +314,7 @@ Is file listing enabled?
 **Description**
 
 ```php
-public listFiles (string $directory = "")
+public listFiles (string $directory, string|null $continuationToken = null)
 ```
 
 List all files in the space (recursively)
@@ -329,6 +325,8 @@ List all files in the space (recursively)
 
 * `(string) $directory`
 : The directory to list files in. Empty string for root directory
+* `(string|null) $continuationToken`
+: Used internally to work around request limits (1000 files per request). Leave this value `null`
 
 **Return Values**
 
@@ -465,7 +463,7 @@ Recursively upload an entire directory
 **Description**
 
 ```php
-public uploadFile (string $filepath, string|null $filename = null, string|null $mimeType = null, bool $private = true)
+public uploadFile (string $filepath, string|null $filename = null)
 ```
 
 Upload a file
@@ -478,10 +476,6 @@ Upload a file
 : The path to the file, including the filename. Relative and absolute paths are accepted.
 * `(string|null) $filename`
 : The remote filename. If `null`, the local filename will be used. Default `null`
-* `(string|null) $mimeType`
-: The files mimeType. If `null` the mimeType is inferred from the file by DigitalOcean Spaces. Default `null`
-* `(bool)` $private
-: If `true` then the file is private, if `false` the file is publicly available. Default `true`
 
 **Return Values**
 
@@ -498,7 +492,7 @@ Upload a file
 **Description**
 
 ```php
-public uploadText (string $text, string $filename, array $params = [], bool $private = true)
+public uploadText (string $text, string $filename, array $params => [])
 ```
 
 Upload a string of text to file
@@ -513,8 +507,6 @@ Upload a string of text to file
 : The filepath/name to save to
 * `(array) $params`
 : Any extra parameters. [See here](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#upload-property)
-* `(bool) $private`
-: True for the file to be private, false to allow public access
 
 **Return Values**
 

tests/FileTest.php

@@ -8,7 +8,6 @@ use SpacesAPI\Spaces;
 
 class FileTest extends TestCase
 {
-    private static $tempSpaceName;
     private static $space;
     private static $file;
 
@@ -20,15 +19,18 @@ class FileTest extends TestCase
 
         $spaces = new Spaces($_ENV['SPACES_KEY'], $_ENV['SPACES_SECRET']);
 
-        self::$tempSpaceName = md5(time());
+        try {
+            $spaces->space('spaces-api-test')->destroy();
+        } catch (SpaceDoesntExistException $e) {
+        }
 
-        self::$space = $spaces->create(self::$tempSpaceName);
+        self::$space = $spaces->create('spaces-api-test');
         self::$file = self::$space->uploadText('Lorem ipsum', 'lorem-ipsum.txt');
     }
 
     public static function tearDownAfterClass(): void
     {
-        self::$space->destroy();
+        (new Spaces($_ENV['SPACES_KEY'], $_ENV['SPACES_SECRET']))->space('spaces-api-test')->destroy();
     }
 
     public function testCanUpdatePrivacy()
@@ -62,17 +64,6 @@ class FileTest extends TestCase
         self::$space->file('lorem-ipsum-2.txt');
     }
 
-    public function testCanMoveRenameFile()
-    {
-        $file = self::$file->copy('test.txt');
-        $file->move('renamed-file.txt');
-
-        $this->assertEquals("renamed-file.txt", $file->filename);
-
-        $this->expectException(FileDoesntExistException::class);
-        self::$space->file('test.txt');
-    }
-
     public function testCanGetURL()
     {
         $this->assertStringContainsString('lorem-ipsum.txt', self::$file->getURL());

tests/SpaceTest.php

@@ -9,7 +9,6 @@ use SpacesAPI\Spaces;
 
 class SpaceTest extends TestCase
 {
-    private static $tempSpaceName;
     private static $space;
 
     public static function setUpBeforeClass(): void
@@ -20,14 +19,17 @@ class SpaceTest extends TestCase
 
         $spaces = new Spaces($_ENV['SPACES_KEY'], $_ENV['SPACES_SECRET']);
 
-        self::$tempSpaceName = md5(time());
+        try {
+            $spaces->space('spaces-api-test')->destroy();
+        } catch (SpaceDoesntExistException $e) {
+        }
 
-        self::$space = $spaces->create(self::$tempSpaceName);
+        self::$space = $spaces->create('spaces-api-test');
     }
 
     public static function tearDownAfterClass(): void
     {
-        self::$space->destroy();
+//        (new Spaces($_ENV['SPACES_KEY'], $_ENV['SPACES_SECRET']))->space('spaces-api-test')->destroy();
     }
 
     public function testCanUpdateSpacePrivacy()
@@ -69,14 +71,6 @@ class SpaceTest extends TestCase
     {
         $file = self::$space->uploadText("Lorem ipsum", "lorem-ipsum.txt");
         $this->assertInstanceOf(File::class, $file);
-        $this->assertFalse($file->isPublic());
-    }
-
-    public function testCanPublicUploadText()
-    {
-        $file = self::$space->uploadText("Lorem ipsum", "lorem-ipsum.txt", [], false);
-        $this->assertInstanceOf(File::class, $file);
-        $this->assertTrue($file->isPublic());
     }
 
     public function testCanUploadFile()
@@ -86,14 +80,6 @@ class SpaceTest extends TestCase
         $this->assertInstanceOf(File::class, $file);
     }
 
-    public function testCanUploadFileWithMimeType()
-    {
-        $tmpFile = tempnam(sys_get_temp_dir(), 'spaces-test');
-        $file = self::$space->uploadFile($tmpFile, 'upload-test.txt', 'text/plain');
-        $this->assertInstanceOf(File::class, $file);
-        $this->assertEquals('text/plain', $file->content_type);
-    }
-
     /**
      * @depends testCanUploadText
      * @depends testCanUploadFile

tests/SpacesTest.php

@@ -10,21 +10,21 @@ use SpacesAPI\Spaces;
 
 class SpacesTest extends TestCase
 {
-    private static $tempSpaceName;
-
     public static function setUpBeforeClass(): void
     {
         $dotenv = Dotenv::createImmutable(__DIR__ . "/..");
         $dotenv->load();
         $dotenv->required(['SPACES_KEY', 'SPACES_SECRET']);
 
-        // This should hopefully always be unique amongst all DO spaces
-        self::$tempSpaceName = md5(time());
+        try {
+            (new Spaces($_ENV['SPACES_KEY'], $_ENV['SPACES_SECRET']))->space('spaces-api-test')->destroy();
+        } catch (SpaceDoesntExistException $e) {
+        }
     }
 
     public static function tearDownAfterClass(): void
     {
-        (new Spaces($_ENV['SPACES_KEY'], $_ENV['SPACES_SECRET']))->space(self::$tempSpaceName)->destroy();
+        (new Spaces($_ENV['SPACES_KEY'], $_ENV['SPACES_SECRET']))->space('spaces-api-test')->destroy();
     }
 
     public function testAuthenticationCanFail()
@@ -53,7 +53,7 @@ class SpacesTest extends TestCase
      */
     public function testCanCreateSpace(Spaces $spaces)
     {
-        $space = $spaces->create(self::$tempSpaceName);
+        $space = $spaces->create('spaces-api-test');
         $this->assertInstanceOf(Space::class, $space);
 
         return $space;
@@ -69,7 +69,7 @@ class SpacesTest extends TestCase
 
         $spaceFound = false;
         foreach ($list as $name => $space) {
-            if ($name == self::$tempSpaceName && $space->getName() == self::$tempSpaceName) {
+            if ($name == 'spaces-api-test' && $space->getName() == 'spaces-api-test') {
                 $spaceFound = true;
             }
         }