Merge pull request #12 from cesargb/actions

Add actions

Author: cesargb

README.md

@@ -59,12 +59,13 @@ Each MagicLink is associated with an action, which is what will be performed
 once the link is visited.
 
 * [Login Action](#login-action)
+* [Download file Action](#download-file-action)
+* [View Action](#view-action)
 * [Http Reponse Action](#http-response-action)
 
 ### Login Action
 
-Through the `LoginAction` action, you can log in to the application using the generated link
-by `MagicLink`.
+Through the `LoginAction` action, you can log in to the application using the generated link by `MagicLink`.
 
 Your constructor supports the user who will login. Optionally we can specify
 the [HTTP response](https://laravel.com/docs/master/responses) using the
@@ -99,6 +100,40 @@ $urlShowView = MagicLink::create(
 )->url;
 ```
 
+### Download file Action
+
+This action, `DownloadFileAction`, permit create a link to download a private file.
+
+The constructor require the file path.
+
+Example:
+
+```php
+use MagicLink\Actions\DownloadFileAction;
+use MagicLink\MagicLink;
+
+// Url to download the file storage_app('private_document.pdf')
+$url = MagicLink::create(new DownloadFileAction('private_document.pdf'))->url;
+```
+
+### View Action
+
+With the action `ViewAction`, you can provide access to the view. You can use
+in his constructor the same arguments than method `view` of Laravel.
+
+Example:
+
+```php
+use MagicLink\Actions\ViewAction;
+use MagicLink\MagicLink;
+
+// Url to view a internal.blade.php
+$url = MagicLink::create(new ViewAction('internal', [
+    'data' => 'Your private custom content',
+]))->url;
+```
+
+
 ### Http Response Action
 
 Through the `ResponseAction` action we can access private content without need
@@ -112,18 +147,6 @@ Examples:
 use MagicLink\Actions\ResponseAction;
 use MagicLink\MagicLink;
 
-$urlToViewContenct = MagicLink::create(
-    new ResponseAction(
-        view('promotion.code', ['code' => 'YOUR_CODE'])
-    )
-)->url;
-
-$urlToDownLoadFile = MagicLink::create(
-    new ResponseAction(function () {
-        return Storage::download('private/docs.pdf');
-    })
-)->url;
-
 $urlToCustomFunction = MagicLink::create(
     new ResponseAction(function () {
         Auth::login(User::first());

src/Actions/DownloadFileAction.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace MagicLink\Actions;
+
+use Illuminate\Support\Facades\Storage;
+
+class DownloadFileAction implements ActionInterface
+{
+    protected $path;
+
+    protected $name;
+
+    protected $headers;
+
+    /**
+     * Constructor to action.
+     *
+     * @param  string  $path
+     * @param  string|null  $name
+     * @param  array  $headers
+     * @return void
+     */
+    public function __construct(string $path, ?string $name = null, array $headers = [])
+    {
+        $this->path = $path;
+        $this->name = $name;
+        $this->headers = $headers;
+    }
+
+    /**
+     * Execute Action.
+     */
+    public function run()
+    {
+        return Storage::download($this->path, $this->name, $this->headers);
+    }
+}

src/Actions/ViewAction.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace MagicLink\Actions;
+
+class ViewAction implements ActionInterface
+{
+    protected $view;
+
+    protected $data;
+
+    protected $mergeData;
+
+    /**
+     * Constructor action.
+     *
+     * @param string $view
+     * @param \Illuminate\Contracts\Support\Arrayable|array $data
+     * @param array $mergeData
+     */
+    public function __construct(string $view, $data = [], $mergeData = [])
+    {
+        $this->view = $view;
+
+        $this->data = $data;
+
+        $this->mergeData = $mergeData;
+    }
+
+    /**
+     * Execute Action.
+     */
+    public function run()
+    {
+        return view($this->view, $this->data, $this->mergeData);
+    }
+}

tests/Actions/DownloadFileTest.php

@@ -0,0 +1,36 @@
+<?php
+
+namespace MagicLink\Test\Actions;
+
+use MagicLink\Actions\DownloadFileAction;
+use MagicLink\MagicLink;
+use MagicLink\Test\TestCase;
+
+class DownloadFileTest extends TestCase
+{
+    public function test_download_file()
+    {
+        $magiclink = MagicLink::create(new DownloadFileAction('text.txt'));
+
+        $this->get($magiclink->url)
+                ->assertStatus(200)
+                ->assertHeader(
+                    'content-disposition',
+                    'attachment; filename=text.txt'
+                );
+    }
+
+    public function test_download_file_with_custom_name()
+    {
+        $magiclink = MagicLink::create(
+            new DownloadFileAction('text.txt', 'other.txt')
+        );
+
+        $this->get($magiclink->url)
+                ->assertStatus(200)
+                ->assertHeader(
+                    'content-disposition',
+                    'attachment; filename=other.txt'
+                );
+    }
+}

tests/Actions/ViewTest.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace MagicLink\Test\Actions;
+
+use MagicLink\Actions\ViewAction;
+use MagicLink\MagicLink;
+use MagicLink\Test\TestCase;
+
+class ViewTest extends TestCase
+{
+    public function test_view()
+    {
+        $magiclink = MagicLink::create(new ViewAction('view'));
+
+        $this->get($magiclink->url)
+                ->assertStatus(200)
+                ->assertSeeText('This is a tests view');
+    }
+
+    public function test_view_with_data()
+    {
+        $magiclink = MagicLink::create(
+            new ViewAction('data', ['data' => 'Lorem, ipsum dolor.'])
+        );
+
+        $this->get($magiclink->url)
+                ->assertStatus(200)
+                ->assertSeeText('Lorem, ipsum dolor.');
+    }
+}