Merge pull request #91 from lifeart/feat-endpoint-config-option

feat: endpoint support

Author: lukemelia

README.md

@@ -144,6 +144,16 @@ The client specified MUST implement functions called `getObject` and `putObject`
 
 *Default:* the default S3 library is `aws-sdk`
 
+### endpoint
+
+AWS (or AWS compatible endpoint) to use. E.g. with DigitalOcean Spaces, Microsoft Azure Blob Storage,
+or Openstack Swift
+
+If `endpoint` set the `region` option will be ignored.
+
+*Default:* `[region].s3.amazonaws.com` 
+
+
 ### serverSideEncryption
 
 The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms). Possible values include:

lib/s3.js

@@ -30,6 +30,7 @@ module.exports = CoreObject.extend({
     var plugin = options.plugin;
     var config = plugin.pluginConfig;
     var profile = plugin.readConfig('profile');
+    var endpoint = plugin.readConfig('endpoint');
 
     this._plugin = plugin;
 
@@ -38,6 +39,11 @@ module.exports = CoreObject.extend({
       AWS.config.credentials = new AWS.SharedIniFileCredentials({ profile: profile });
     }
 
+    if (endpoint) {
+      this._plugin.log('Using endpoint from config', { verbose: true });
+      AWS.config.endpoint = new AWS.Endpoint(endpoint);
+    }
+
     this._client = plugin.readConfig('s3Client') || new AWS.S3(config);
   },
 

tests/unit/lib/s3-test.js

@@ -195,6 +195,27 @@ describe('s3', function() {
         });
     });
 
+    it('allows `endpoint` option to be passed to customize storage', function() {
+      var endpoint = 'foo.bar.baz';
+      subject = new S3({
+        plugin: Object.assign(plugin, {
+          readConfig: function(propertyName) {
+            if (propertyName === 's3Client') {
+              return s3Client;
+            } else if (propertyName === 'endpoint') {
+              return endpoint;
+            }
+          }
+        })
+      });
+      var promise = subject.upload(options);
+      return assert.isFulfilled(promise)
+        .then(function() {
+          assert.equal(require('aws-sdk').config.endpoint.host, endpoint, 'Endpoint in SDK is correct');
+          assert.equal(mockUi.messages[0], '- Using endpoint from config', 'Prefix is included in log output');
+        });
+    });
+
     it('allows `cacheControl` option to be passed to customize the used cache-control', function() {
       var cacheControl = 'max-age=3600';