embulk-output-ftp 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b64ed089208e577c405d228e5c0f5229e667587
-  data.tar.gz: d1cc2104d30d5451df24596199ea9383b09d0da9
+  metadata.gz: 5dc75d041719981674d7fae9fa33063917cbb78b
+  data.tar.gz: 10b76c0ea6377bfbc4e7843102380ef939bc803e
 SHA512:
-  metadata.gz: 90f8c88a80c849c15584780a865c7bd9ca2cb9d538108265364f717eff007c570aa9bbd48b1e30baa66b1681eab314abdeae6098ed5cbdbc40889cc59ddf3fba
-  data.tar.gz: d9548123c3a9ddd42d165769fd24a8f9bb22e4eb3ad08922bd131ea4db009eebb4c0c79b7510880157b9a2106bcb8c0e5292a1d88204594407cda059bdbba7e1
+  metadata.gz: 54f5d91122ba11013591355303f7ff57930a7f952998ee3bdb7d4d189b5b94b3a8062cbe2f75cebdd93a14ce91e257e116a19e38a9ceef6e11b85618634274d9
+  data.tar.gz: 60ec552f6383b58521f8f1054d4045664a71a0aa6c6d97531449eb87a513ffb7558912c9129ec6f5f9a98280da96d24b46d2f5658738d95988139aefe88d7dc4

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.3 - 2016-07-21
+
+* [new feature] Support both of FTPS(explicit) and FTPS(implicit). [#4](https://github.com/sakama/embulk-output-ftp/pull/4)
+* [maintenance] Fix exception handling. [#5](https://github.com/sakama/embulk-output-ftp/pull/5)
+
 ## 0.1.2 - 2016-07-21
 
 * [maintenance] Force to create remote directory if remote directory doesn't exists. [#2](https://github.com/sakama/embulk-output-ftp/pull/2)

data/README.md

@@ -1,6 +1,10 @@
 # FTP file output plugin for Embulk
 [![Build Status](https://travis-ci.org/sakama/embulk-output-ftp.svg?branch=master)](https://travis-ci.org/sakama/embulk-output-ftp)
 
+This plugin support **FTP**, **FTPES(FTPS explicit)**, **FTPS(FTPS implicit)** and doesn't support **SFTP**.
+
+If you want to use SFTP, please use [embulk-output-sftp](https://github.com/civitaspo/embulk-output-sftp).
+
 ## Overview
 
 * **Plugin type**: file input
@@ -10,7 +14,7 @@
 ## Configuration
 
 - **host**: FTP server address (string, required)
-- **port**: FTP server port number (integer, default: `21`. `990` if `ssl` is true)
+- **port**: FTP server port number (integer, default: `21`.)
 - **user**: user name to login (string, optional)
 - **password**: password to login (string, default: `""`)
 - **path_prefix** prefix of target files (string, required)
@@ -19,11 +23,26 @@
 - **passive_mode**: use passive mode (boolean, default: true)
 - **ascii_mode**: use ASCII mode instead of binary mode (boolean, default: false)
 - **ssl**: use FTPS (SSL encryption). (boolean, default: false)
+- **ssl_explicit** use FTPS(explicit) instead of FTPS(implicit). (boolean, default:true)
 - **ssl_verify**: verify the certification provided by the server. By default, connection fails if the server certification is not signed by one the CAs in JVM's default trusted CA list. (boolean, default: true)
 - **ssl_verify_hostname**: verify server's hostname matches with provided certificate. (boolean, default: true)
 - **ssl_trusted_ca_cert_file**: if the server certification is not signed by a certificate authority, set path to the X.508 certification file (pem file) of a private CA (string, optional)
 - **ssl_trusted_ca_cert_data**: similar to `ssl_trusted_ca_cert_file` but embed the contents of the PEM file as a string value instead of path to a local file (string, optional)
 
+### FTP / FTPS default port number
+
+FTP and FTPS server listens following port number(TCP) as default.
+
+Please be sure to configure firewall rules.
+
+|                         | FTP | FTPS(explicit) = FTPES | FTPS(implicit) = FTPS |
+|:------------------------|----:|-----------------------:|----------------------:|
+| Control channel port    |  21 |                     21 |             990 (\*1) |
+| Data channel port (\*2) |  20 |                     20 |                   989 |
+
+1. If you're using both of FTPS(implicit) and FTP, server also use 21/TCP for FTP.
+2. If you're using passive mode, data channel port can be taken between 1024 and 65535.
+
 ## Example
 
 Simple FTP:
@@ -90,7 +109,6 @@ out:
   ext: csv
 ```
 
-
 ## Build
 
 ```

data/build.gradle

@@ -14,7 +14,7 @@ configurations {
     provided
 }
 
-version = "0.1.2"
+version = "0.1.3"
 
 sourceCompatibility = 1.7
 targetCompatibility = 1.7

data/src/main/java/org/embulk/output/ftp/FtpFileOutputPlugin.java

@@ -48,7 +48,7 @@ public class FtpFileOutputPlugin implements FileOutputPlugin
         String getHost();
 
         @Config("port")
-        @ConfigDefault("null")
+        @ConfigDefault("21")
         Optional<Integer> getPort();
         void setPort(Optional<Integer> port);
 
@@ -72,6 +72,10 @@ public class FtpFileOutputPlugin implements FileOutputPlugin
         @ConfigDefault("false")
         boolean getSsl();
 
+        @Config("ssl_explicit")
+        @ConfigDefault("true")
+        boolean getSslExplicit();
+
         SSLPluginConfig getSSLConfig();
         void setSSLConfig(SSLPluginConfig config);
 
@@ -256,7 +260,7 @@ public class FtpFileOutputPlugin implements FileOutputPlugin
                                 public void onRetry(Exception exception, int retryCount, int retryLimit, int retryWait)
                                         throws RetryGiveupException
                                 {
-                                    if (exception instanceof FileNotFoundException || exception instanceof URISyntaxException || exception instanceof ConfigException) {
+                                    if (exception instanceof ConfigException) {
                                         throw new RetryGiveupException(exception);
                                     }
                                     String message = String.format("FTP put request failed. Retrying %d/%d after %d seconds. Message: %s",
@@ -314,14 +318,13 @@ public class FtpFileOutputPlugin implements FileOutputPlugin
         try {
             if (task.getSsl()) {
                 client.setSSLSocketFactory(SSLPlugins.newSSLSocketFactory(task.getSSLConfig(), task.getHost()));
-                client.setSecurity(FTPClient.SECURITY_FTPS);
-                if (!task.getPort().isPresent()) {
-                    task.setPort(Optional.of(990));
+                if (task.getSslExplicit()) {
+                    client.setSecurity(FTPClient.SECURITY_FTPES);
+                    log.info("Using FTPES(FTPS/explicit) mode");
                 }
-            }
-            else {
-                if (!task.getPort().isPresent()) {
-                    task.setPort(Optional.of(21));
+                else {
+                    client.setSecurity(FTPClient.SECURITY_FTPS);
+                    log.info("Using FTPS(FTPS/implicit) mode");
                 }
             }
 

data/src/test/java/org/embulk/output/ftp/TestFtpFileOutputPlugin.java

@@ -110,6 +110,10 @@ public class TestFtpFileOutputPlugin
         assertEquals(FTP_TEST_HOST, task.getHost());
         assertEquals(FTP_TEST_USER, task.getUser().get());
         assertEquals(FTP_TEST_PASSWORD, task.getPassword().get());
+        assertEquals(true, task.getPassiveMode());
+        assertEquals(false, task.getAsciiMode());
+        assertEquals(false, task.getSsl());
+        assertEquals(true, task.getSslExplicit());
         assertEquals(10, task.getMaxConnectionRetry());
     }
 
@@ -152,29 +156,29 @@ public class TestFtpFileOutputPlugin
         runner.transaction(config, schema, 0, new Control());
     }
 
-//    @Test
-//    public void testTransactionWithSsl()
-//    {
-//        ConfigSource config = Exec.newConfigSource()
-//                .set("in", inputConfig())
-//                .set("parser", parserConfig(schemaConfig()))
-//                .set("type", "ftp")
-//                .set("host", FTP_TEST_HOST)
-//                .set("port", FTP_TEST_SSL_PORT)
-//                .set("user", FTP_TEST_USER)
-//                .set("password", FTP_TEST_PASSWORD)
-//                .set("ssl", true)
-//                .set("ssl_verify", false)
-//                .set("ssl_verify_hostname", false)
-//                .set("ssl_trusted_ca_cert_file", FTP_TEST_SSL_TRUSTED_CA_CERT_FILE)
-//                .set("path_prefix", "my-prefix")
-//                .set("file_ext", ".csv")
-//                .set("formatter", formatterConfig());
-//
-//        Schema schema = config.getNested("parser").loadConfig(CsvParserPlugin.PluginTask.class).getSchemaConfig().toSchema();
-//
-//        runner.transaction(config, schema, 0, new Control());
-//    }
+    @Test
+    public void testTransactionWithSsl()
+    {
+        ConfigSource config = Exec.newConfigSource()
+                .set("in", inputConfig())
+                .set("parser", parserConfig(schemaConfig()))
+                .set("type", "ftp")
+                .set("host", FTP_TEST_HOST)
+                .set("port", FTP_TEST_SSL_PORT)
+                .set("user", FTP_TEST_USER)
+                .set("password", FTP_TEST_PASSWORD)
+                .set("ssl", true)
+                .set("ssl_verify", false)
+                .set("ssl_verify_hostname", false)
+                .set("ssl_trusted_ca_cert_file", FTP_TEST_SSL_TRUSTED_CA_CERT_FILE)
+                .set("path_prefix", "my-prefix")
+                .set("file_ext", ".csv")
+                .set("formatter", formatterConfig());
+
+        Schema schema = config.getNested("parser").loadConfig(CsvParserPlugin.PluginTask.class).getSchemaConfig().toSchema();
+
+        runner.transaction(config, schema, 0, new Control());
+    }
 
     @Test
     public void testResume()

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: embulk-output-ftp
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Satoshi Akama
@@ -69,7 +69,7 @@ files:
 - src/test/resources/sample_02.csv
 - classpath/bcpkix-jdk15on-1.52.jar
 - classpath/bcprov-jdk15on-1.52.jar
-- classpath/embulk-output-ftp-0.1.2.jar
+- classpath/embulk-output-ftp-0.1.3.jar
 - classpath/ftp4j-1.7.2.jar
 homepage: https://github.com/sakama/embulk-output-ftp
 licenses: