Merge pull request #9 from brammittendorff/feature/added-ftp-to-flysystem-factory

Added FTP to flysystem factory

Author: mjrider

.travis.yml

@@ -4,6 +4,7 @@ sudo: required
 env:
   global:
     - TEST_S3_LOCATION='//TRAVISACCESSPHPUNIT:wJalrXUtnFEMI%2FSECRET%2FTRAVISPHPUNIT@us-east-1/?endpoint=http%3A%2F%2F127.0.0.1%3A9999&use_path_style_endpoint=1'
+    - TEST_FTP_LOCATION='ftp://test:test@localhost'
 
 services:
   - docker
@@ -40,6 +41,7 @@ install:
      -e 'MINIO_ACCESS_KEY=TRAVISACCESSPHPUNIT' \
      -e 'MINIO_SECRET_KEY=wJalrXUtnFEMI/K7MDENG/TRAVISKEYPHPUNIT' \
      --detach minio/minio server /data"
+  - "docker run -d -p 21:21 -p 30000-30009:30000-30009 -e 'PUBLICHOST=localhost' jack12816/ftpd_test"
 
 script:
   - composer validate

src/Adapter/Ftp.php

@@ -0,0 +1,58 @@
+<?php
+
+namespace MJRider\FlysystemFactory\Adapter;
+
+use League\Flysystem\Filesystem;
+use League\Flysystem\Adapter\Ftp as Adapter;
+
+/**
+ * Static factory class for creating an ftp connection
+ */
+class Ftp implements AdapterFactoryInterface
+{
+    /**
+     * Builds the arguments for the FTP adapter
+     *
+     * @param [string] $url
+     * @return void
+     */
+    protected static function buildArgs($url)
+    {
+        $args = [
+            'host' => $url->host,
+            'username' => urldecode($url->user),
+            'password' => urldecode($url->pass),
+            'port' => $url->port,
+            'root' => $url->path,
+        ];
+
+        if (isset($url->query->passive)) {
+            $args[ 'passive' ] = (bool)$url->query->passive;
+        }
+
+        if (isset($url->query->ssl)) {
+            $args[ 'ssl' ] = (bool)$url->query->ssl;
+        }
+        
+        if (isset($url->query->timeout)) {
+            $args[ 'timeout' ] = (int)$url->query->timeout;
+        }
+
+        return $args;
+    }
+
+    /**
+     * Creates the adapter for FTP
+     *
+     * @param [string] $url
+     * @return void
+     */
+    public static function create($url)
+    {
+        $args = static::buildArgs($url);
+
+        $adapter = new Adapter($args);
+
+        return $adapter;
+    }
+}

src/functions.php

@@ -30,6 +30,9 @@ function create($endpoint)
         case 'b2':
             $adapter = Adapter\B2::create($url);
             break;
+        case 'ftp':
+            $adapter = Adapter\Ftp::create($url);
+            break;
         case 'file':
         case 'local':
             $adapter = Adapter\Local::create($url);

tests/Adapter/FtpTest.php

@@ -0,0 +1,31 @@
+<?php
+
+namespace MJRider\FlysystemFactory\Adapter;
+
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @requires PHP 5.4
+ */
+class FtpTest extends TestCase
+{
+    protected $root = '';
+
+    public function setup()
+    {
+        $this->root = getenv('TEST_FTP_LOCATION');
+        if ($this->root === false) {
+            $this->markTestSkipped('no ftp endpoint available, test skipped');
+        }
+        if (defined('HHVM_VERSION')) {
+            $this->markTestSkipped('HHVM ftp not supported ');
+        }
+    }
+
+    public function testFtp()
+    {
+        $filesystem = \MJRider\FlysystemFactory\create($this->root);
+        $this->assertInstanceOf('\League\Flysystem\Filesystem', $filesystem);
+        $this->assertInstanceOf('\League\Flysystem\Adapter\Ftp', $filesystem->getAdapter());
+    }
+}