Merge pull request #345 from cloudant/remove-virtual-hosts

Remove virtual hosts

Author: smithsz

CHANGES.md

@@ -2,6 +2,7 @@
 - [FIXED] Expose `BasePlugin` type in Cloudant client.
 - [REMOVED] Remove nodejs-cloudant TypeScript type definitions for
   `db.search`. These definitions are now imported directly from Nano.
+- [REMOVED] Removed support for the deprecated Cloudant virtual hosts feature.
 - [UPGRADED] Using nano==7.1.1 dependency.
 
 # 2.4.1 (2018-11-12)

README.md

@@ -18,7 +18,6 @@ This is the official Cloudant library for Node.js.
     * [Generate a Cloudant API key](#generate-a-cloudant-api-key)
     * [Use a Cloudant API Key](#use-a-cloudant-api-key)
   * [CORS](#cors)
-  * [Virtual Hosts](#virtual-hosts)
   * [Cloudant Query](#cloudant-query)
   * [Cloudant Search](#cloudant-search)
   * [Cloudant Geospatial](#cloudant-geospatial)
@@ -612,33 +611,6 @@ Cloudant account.
 
 See [CORS] for further details.
 
-## Virtual Hosts
-
-If you wish to access your Cloudant domain name (myaccount.cloudant.com) using a
-CNAME'd domain name (mysubdomain.mydomain.com) then you can instruct Cloudant to
-do so.
-
-- To add a virtual host:
-  ~~~ js
-  cloudant.add_virtual_host({ host: "mysubdomain.mydomain.com", path: "/mypath"}, function(err, data) {
-    console.log(err, data);
-  });
-  ~~~
-
-- To view virtual host configuration:
-  ~~~ js
-  cloudant.get_virtual_hosts(function(err, data) {
-    console.log(err, data);
-  });
-  ~~~
-
-- To delete a virtual host:
-  ~~~ js
-  cloudant.delete_virtual_host({ host: "mysubdomain.mydomain.com", path: "/mypath"}, function(err, data) {
-    console.log(err, data);
-  });
-  ~~~
-
 ## Cloudant Query
 
 This feature interfaces with Cloudant's query functionality. See the [Cloudant

cloudant.js

@@ -186,34 +186,11 @@ function Cloudant(options, callback) {
       body: configuration }, callback);
   };
 
-  // https://console.bluemix.net/docs/services/Cloudant/api/vhosts.html#listing-virtual-hosts
-  var get_virtual_hosts = function(callback) { // eslint-disable-line camelcase
-    return nano.request({path: '_api/v2/user/virtual_hosts',
-      method: 'get'}, callback);
-  };
-
-  // https://console.bluemix.net/docs/services/Cloudant/api/vhosts.html#creating-a-virtual-host
-  var add_virtual_host = function(opts, callback) { // eslint-disable-line camelcase
-    return nano.request({path: '_api/v2/user/virtual_hosts',
-      method: 'post',
-      body: opts }, callback);
-  };
-
-  // https://console.bluemix.net/docs/services/Cloudant/api/vhosts.html#deleting-a-virtual-host
-  var delete_virtual_host = function(opts, callback) { // eslint-disable-line camelcase
-    return nano.request({path: '_api/v2/user/virtual_hosts',
-      method: 'delete',
-      body: opts }, callback);
-  };
-
   // add top-level Cloudant-specific functions
   nano.ping = ping;
   nano.get_cors = get_cors; // eslint-disable-line camelcase
   nano.set_cors = set_cors; // eslint-disable-line camelcase
   nano.generate_api_key = generate_api_key; // eslint-disable-line camelcase
-  nano.get_virtual_hosts = get_virtual_hosts; // eslint-disable-line camelcase
-  nano.add_virtual_host = add_virtual_host; // eslint-disable-line camelcase
-  nano.delete_virtual_host = delete_virtual_host; // eslint-disable-line camelcase
 
   if (callback) {
     nano.cc._addPlugins('cookieauth');

test/legacy/api.js

@@ -962,57 +962,3 @@ function test_gzip() {
     });
   });
 }
-
-describe('Virtual Hosts', function() {
-  var myHost = `${uuid()}.myhost.com`;
-
-  it('supports virtual hosts API - GET /_api/v2/user/virtual_hosts', function(done) {
-    var mocks = nock(SERVER)
-      .get('/_api/v2/user/virtual_hosts').reply(200, {'virtual_hosts': []});
-
-    var c = Cloudant({ url: SERVER, username: ME, password: PASSWORD, plugins: 'retry' });
-    c.get_virtual_hosts(function(er, d) {
-      should(er).equal(null);
-      d.should.be.an.Object;
-      d.should.have.a.property('virtual_hosts');
-      d.virtual_hosts.should.be.an.Array;
-
-      mocks.done();
-      done();
-    });
-  });
-
-  it('supports virtual hosts API - POST /_api/v2/user/virtual_hosts', function(done) {
-    var mocks = nock(SERVER)
-      .post('/_api/v2/user/virtual_hosts').reply(200, {'ok': true});
-
-    var c = Cloudant({ url: SERVER, username: ME, password: PASSWORD, plugins: 'retry' });
-    c.add_virtual_host({ host: myHost, path: '/mypath'}, function(er, d) {
-      should(er).equal(null);
-      d.should.be.an.Object;
-      d.should.have.a.property('ok');
-      d.ok.should.be.a.Boolean;
-      d.ok.should.equal(true);
-
-      mocks.done();
-      done();
-    });
-  });
-
-  it('supports virtual hosts API - DELETE /_api/v2/user/config/virtual_hosts', function(done) {
-    var mocks = nock(SERVER)
-      .delete('/_api/v2/user/virtual_hosts').reply(200, { 'ok': true });
-
-    var c = Cloudant({ url: SERVER, username: ME, password: PASSWORD, plugins: 'retry' });
-    c.delete_virtual_host({ host: myHost, path: '/mypath'}, function(er, d) {
-      should(er).equal(null);
-      d.should.be.an.Object;
-      d.should.have.a.property('ok');
-      d.ok.should.be.a.Boolean;
-      d.ok.should.be.equal(true);
-
-      mocks.done();
-      done();
-    });
-  });
-});

test/legacy/readme-examples.js

@@ -314,59 +314,6 @@ describe('CORS #db', function() {
   });
 });
 
-describe('Virtual Hosts', function() {
-  var mocks;
-  after(function() { mocks.done(); });
-  before(function() {
-    mocks = nock(SERVER)
-      .post('/_api/v2/user/virtual_hosts')
-      .reply(200, {ok: true})
-      .get('/_api/v2/user/virtual_hosts')
-      .reply(200, { virtual_hosts: [ [ 'mysubdomain.mydomain.com', '/mypath' ] ] })
-      .delete('/_api/v2/user/virtual_hosts')
-      .reply(200, {ok: true});
-  });
-
-  var cloudant;
-  before(function() {
-    var Cloudant = require('@cloudant/cloudant');
-    cloudant = Cloudant({url: SERVER, username: ME, password: process.env.cloudant_password, plugins: 'retry'});
-  });
-
-  it('Example 1', function(done) {
-    cloudant.add_virtual_host({ host: 'mysubdomain.mydomain.com', path: '/mypath'}, function(err, data) {
-      console.log(err, data);
-      if (err) {
-        return done(err);
-      }
-      data.should.have.a.property('ok').which.is.equal(true);
-      done();
-    });
-  });
-
-  it('Example 2', function(done) {
-    cloudant.get_virtual_hosts(function(err, data) {
-      console.log(err, data);
-      if (err) {
-        return done(err);
-      }
-      data.should.have.a.property('virtual_hosts').which.is.an.Array;
-      done();
-    });
-  });
-
-  it('Example 3', function(done) {
-    cloudant.delete_virtual_host({ host: 'mysubdomain.mydomain.com', path: '/mypath'}, function(err, data) {
-      console.log(err, data);
-      if (err) {
-        return done(err);
-      }
-      data.should.have.a.property('ok').which.is.equal(true);
-      done();
-    });
-  });
-});
-
 describe('Cloudant Query #db', function() {
   var mocks;
   before(function() {

types/index.d.ts

@@ -100,11 +100,6 @@ declare namespace cloudant {
         [key: string]: any;
     }
 
-    interface VirtualHost {
-        host: string;
-        path: string;
-    }
-
     // Server Scope
     // ============
 
@@ -113,21 +108,12 @@ declare namespace cloudant {
         use(db: string): DocumentScope<any>;
         scope(db: string): DocumentScope<any>;
 
-        // https://console.bluemix.net/docs/services/Cloudant/api/vhosts.html#creating-a-virtual-host
-        add_virtual_host(virtualHost: VirtualHost, callback?: Callback<any>): Promise<any>;
-
-        // https://console.bluemix.net/docs/services/Cloudant/api/vhosts.html#deleting-a-virtual-host
-        delete_virtual_host(virtualHost: VirtualHost, callback?: Callback<any>): Promise<any>;
-
         // https://console.bluemix.net/docs/services/Cloudant/api/authorization.html#api-keys
         generate_api_key(callback?: Callback<ApiKey>): Promise<any>;
 
         // https://console.bluemix.net/docs/services/Cloudant/api/cors.html#reading-the-cors-configuration
         get_cors(callback?: Callback<any>): Promise<any>;
 
-        // https://console.bluemix.net/docs/services/Cloudant/api/vhosts.html#listing-virtual-hosts
-        get_virtual_hosts(callback?: Callback<any>): Promise<any>;
-
         // https://console.bluemix.net/docs/services/Cloudant/api/account.html#ping
         ping(callback?: Callback<any>): Promise<any>;
 

types/tests.ts

@@ -62,20 +62,6 @@ instance.set_cors(cors).then((data) => {});
 instance.get_cors((error, data) => {});
 instance.get_cors().then((data) => {});
 
-const virtualHost: cloudant.VirtualHost = {
-  host: 'www.example.com',
-  path: 'the-path'
-};
-
-instance.add_virtual_host(virtualHost, (error, resp) => {});
-instance.add_virtual_host(virtualHost).then((resp) => {});
-
-instance.get_virtual_hosts((error, hosts) => {});
-instance.get_virtual_hosts().then((hosts) => {});
-
-instance.delete_virtual_host(virtualHost, (error, resp) => {});
-instance.delete_virtual_host(virtualHost).then((resp) => {});
-
 /*
  * Document Scope
  */