Version 5 (#115)

* heavily refactored for zipstream 3.1

* docs

* create our own stream wrapper for caching output to secondary stream

* underlying package handles size estimation now, we don’t need these

* improvements for our wrapped caching output stream, with test

* comments

* more cache output options supported

* some cleanup

* Support for a callback to run after zip stream is finished

* Support for a `$zip->has($path)` check. Resolves #97

* Support adding files from Laravel Storage disks

* update docs

* update docs

* update docs

* Support saving output to disk

* update docs

* update docs

* remove this header from the streamed response

* flush output, minimize buffering and RAM usage

* add the nginx buffering header here

* getOption method in the File model

* don’t exclude any tests now

* run tests on php8.3

* s3 client requires a region

Author: jszobody

.chipperci.yml

@@ -1,12 +1,12 @@
 version: 1
 
 environment:
-  php: 8.1    # 7.1, 7.2, 7.3, 7.4, 8.0, 8.1
+  php: 8.3    # 7.1, 7.2, 7.3, 7.4, 8.0, 8.1
 
 pipeline:
   - name: Setup
     cmd: |
       composer install --no-interaction --prefer-dist --optimize-autoloader
 
   - name: Run Tests
-    cmd: phpunit --exclude big
+    cmd: phpunit

README.md

@@ -25,7 +25,7 @@ The service provider and facade will be automatically wired up.
 #### 2. In a controller method call the `create` method on the `Zip` facade
 
 ```php
-use Zip;
+use STS\ZipStream\Facades\Zip;
 
 class ZipController {
 
@@ -43,9 +43,9 @@ That's it! A `StreamedResponse` will be returned and the zip contents built and
 
 ## Customize the internal zip path for a file
 
-By default any files you add will be stored in the root of the zip, with their original filenames. 
+By default, any files you add will be stored in the root of the zip, with their original filenames. 
 
-You can customize the filename and even create subfolders within the zip by providing your files array with key/value pairs:
+You can customize the filename and even create sub-folders within the zip by providing your files array with key/value pairs:
 
 ```php
 Zip::create("package.zip", [
@@ -91,6 +91,16 @@ Zip::create("package.zip")
     ->addRaw("...file contents...", "hello.txt");
 ```
 
+## Add from storage disk
+
+You can add files from a storage disk. Use `addFromDisk` and provide the disk name or disk instance as the first argument:
+
+```php
+Zip::create("package.zip")
+    ->addFromDisk("local", "file.txt", "My File.txt")
+    ->addFromDisk(Storage::disk("tmp"), "important.txt")
+```
+
 ## Support for S3
 
 ### Install AWS sdk and configure S3
@@ -99,7 +109,7 @@ You can stream files from S3 into your zip.
 
 1. Install the `aws/aws-sdk-php` package
 
-2. Setup an AWS IAM user with `s3:GetObject` permission for the S3 bucket and objects you intend to zip up.
+2. Set up an AWS IAM user with `s3:GetObject` permission for the S3 bucket and objects you intend to zip up.
 
 3. Store your credentials as `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, and `AWS_DEFAULT_REGION` in your .env file.
 
@@ -125,13 +135,14 @@ Zip::create("package.zip")->add(
 );
 ```
 
-## Zip size prediction
-
-By default this package attempts to predict the final zip size and sends a `Content-Length` header up front. This means users will see accurate progress on their download, even though the zip is being streamed out as it is created!
+Instead of specifying an absolute `s3://` path, you can use `addFromDisk` and specify a disk that uses the `s3` driver:
 
-This only works if files are not compressed.
+```php
+Zip::create("package.zip")
+    ->addFromDisk("s3", "object.pdf", "Something.pdf");
+```
 
-If you have issues with the zip size prediction you can disable it with `ZIPSTREAM_PREDICT_SIZE=false` in your .env file.
+In this case the S3 client from the storage disk will be used. 
 
 ## Specify your own filesizes
 
@@ -154,14 +165,30 @@ foreach($files AS $file) {
 }
 ```
 
+Or if you are adding from an S3 disk:
+
+```php
+$zip->add(
+    File::makeFromDisk('s3', $file->key, $file->name)->setFilesize($file->size)
+);
+````
+
+## Zip size prediction
+
+By default, this package attempts to predict the final zip size and sends a `Content-Length` header up front. This means users will see accurate progress on their download, even though the zip is being streamed out as it is created!
+
+This only works if files are not compressed.
+
+If you have issues with the zip size prediction you can disable it with `ZIPSTREAM_PREDICT_SIZE=false` in your .env file.
+
 ## Configure compression
 
-By default this package uses _no_ compression. Why?
+By default, this package uses _no_ compression. Why?
 
 1) This makes building the zips super fast, and is light on your CPU
 2) This makes it possible to predict the final zip size as mentioned above.
 
-If you want to compress your zip files set `ZIPSTREAM_FILE_METHOD=deflate` in your .env file. Just realize this will disable the `Content-Length` header.
+If you want to compress your zip files set `ZIPSTREAM_COMPRESSION_METHOD=deflate` in your .env file. Just realize this will disable the `Content-Length` header.
 
 ## Save Zip to disk
 
@@ -183,6 +210,14 @@ Zip::create("package.zip")
     ->saveTo("s3://bucket-name/path/to/folder");
 ```
 
+Or you can save to a disk:
+
+```php
+Zip::create("package.zip")
+    // ... add files ...
+    ->saveToDisk("s3", "folder");
+```
+
 ## Caching zip while still streaming download
 
 What if you have a lot of users requesting the same zip payload? It might be nice to stream out the zip while _also_ caching it to disk for the future.
@@ -195,22 +230,29 @@ Zip::create("package.zip")
     ->cache("/path/to/folder/some-unique-cache-name.zip");
 ```
 
+Or you can cache to a disk:
+
+```php
+Zip::create("package.zip")
+    // ... add files ...
+    ->cacheToDisk("s3", "folder/some-unique-cache-name.zip");
+```
+
 You might use an internal DB id for your cache name, so that the next time a user requests a zip download you can determine if one is already built and just hand it back.
 
 ## Events
 
 - `STS\ZipStream\Events\ZipStreaming`: Dispatched when a new zip stream begins processing
-- `STS\ZipStream\Events\ZipStreamed`: Dispatched when a zip finishes streaming
-- `STS\ZipStream\Events\ZipSizePredictionFailed`: Fired if the predicted filesize doesn't match the final size. If you have filesize prediction enabled it's a good idea to listen for this event and log it, since that might mean the zip download failed or was corrupt for your user. 
+- `STS\ZipStream\Events\ZipStreamed`: Dispatched when a zip finishes streaming 
 
 ## Filename sanitization
 
-By default this package will try to translate any non-ascii character in filename or folder's name to ascii. For example, if your filename is `中文_にほんご_Ч_Ɯ_☺_someascii.txt`. It will become `__C___someascii.txt` using Laravel's `Str::ascii($path)`.
+By default, this package will try to translate any non-ascii character in filename or folder's name to ascii. For example, if your filename is `中文_にほんご_Ч_Ɯ_☺_someascii.txt`. It will become `__C___someascii.txt` using Laravel's `Str::ascii($path)`.
 
 If you need to preserve non-ascii characters, you can disable this feature with an `.env` setting:
 
 ```env
-ZIPSTREAM_FILE_SANITIZE=false
+ZIPSTREAM_ASCII_FILENAMES=false
 ```
 
 ## License

composer.json

@@ -15,14 +15,19 @@
         }
     ],
     "require": {
-        "php": "^7.1|^8.0",
-        "guzzlehttp/guzzle": "^6.0|^7.0",
-        "illuminate/support": "^5.6|^6.0|^7.0|^8.0|^9.0|^10.0|^11.0",
-        "maennchen/zipstream-php": "^v2.0"
+        "php": "^8.1",
+        "guzzlehttp/guzzle": "^7.0",
+        "guzzlehttp/psr7": "^2.6",
+        "illuminate/support": "^10.0|^11.0",
+        "league/flysystem-path-prefixing": "^3.28",
+        "maennchen/zipstream-php": "^v3.0",
+        "psr/http-message": "^2.0",
+        "spatie/laravel-package-tools": "^1.16"
     },
     "require-dev": {
-        "orchestra/testbench": "^5.0|^6.0|^7.0|^8.0|^9.0",
-        "phpunit/phpunit": "^9.0"
+        "league/flysystem-aws-s3-v3": "^3.28",
+        "orchestra/testbench": "^8.0|^9.0",
+        "phpunit/phpunit": "^9.0|^10.0"
     },
     "autoload": {
         "psr-4": {
@@ -47,7 +52,7 @@
                 "STS\\ZipStream\\ZipStreamServiceProvider"
             ],
             "aliases": {
-                "Zip": "STS\\ZipStream\\ZipStreamFacade"
+                "Zip": "STS\\ZipStream\\Facades\\Zip"
             }
         }
     }

config/config.php renamed to config/zipstream.php

@@ -1,22 +1,15 @@
 <?php
+use ZipStream\CompressionMethod;
 
-/*
- * You can place your custom package configuration in here.
- */
 return [
-    // Default options for our archives
-    'archive' => [
-        'predict' => env('ZIPSTREAM_PREDICT_SIZE', true)
-    ],
-
-    // Default options for files added
-    'file'    => [
-        'method' => env('ZIPSTREAM_FILE_METHOD', 'store'),
+    // Try to predict the zip size up front and send a Content-Length header
+    'predict_size' => env('ZIPSTREAM_PREDICT_SIZE', true),
 
-        'deflate' => env('ZIPSTREAM_FILE_DEFLATE'),
+    // Compression method used only if we don't (or can't) predict the zip size
+    'compression_method' => env('ZIPSTREAM_COMPRESSION_METHOD', 'store'),
 
-        'sanitize' => env('ZIPSTREAM_FILE_SANITIZE', true)
-    ],
+    // Remove all non-ascii characters from filenames
+    'ascii_filenames' => env('ZIPSTREAM_ASCII_FILENAMES', true),
 
     // AWS configs for S3 files
     'aws'     => [

phpunit.xml.dist

@@ -1,24 +1,13 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         bootstrap="vendor/autoload.php"
-         backupGlobals="false"
-         backupStaticAttributes="false"
-         colors="true"
-         verbose="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd">
-    <coverage>
-        <include>
-            <directory suffix=".php">src/</directory>
-        </include>
-    </coverage>
-    <testsuites>
-        <testsuite name="Test Suite">
-            <directory>tests</directory>
-        </testsuite>
-    </testsuites>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" bootstrap="vendor/autoload.php" backupGlobals="false" colors="true" processIsolation="false" stopOnFailure="false" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.5/phpunit.xsd" cacheDirectory=".phpunit.cache" backupStaticProperties="false">
+  <testsuites>
+    <testsuite name="Test Suite">
+      <directory>tests</directory>
+    </testsuite>
+  </testsuites>
+  <source>
+    <include>
+      <directory suffix=".php">src/</directory>
+    </include>
+  </source>
 </phpunit>