IBM-Cloud / gp-js-client / 249

pending completion

Build # 249

Build Type

push

travis-ci

Committed by

srl295

Commit Message

<a href="https://github.com/IBM-Cloud/gp-js-client/commit/<a class=hub.com/IBM-Cloud/gp-js-client/commit/a9ef5e8e142f05653ae70fddf13379c31718e0ea">a9ef5e8e1<a href="https://github.com/IBM-Cloud/gp-js-client/commit/a9ef5e8e142f05653ae70fddf13379c31718e0ea">&quot;&gt;add connect(), deprecate getClient()

- update docs

Fixes: https://github.com/IBM-Cloud/gp-js-client/issues/101

- Cherry picks include </a><a class="double-link" href="https://github.com/IBM-Cloud/gp-js-client/commit/<a class="double-link" href="https://github.com/IBM-Cloud/gp-js-client/commit/c0f41bf1ac9f9de5b046b0de9cc6000da7473cd8">c0f41bf1a</a>">c0f41bf1a</a><a href="https://github.com/IBM-Cloud/gp-js-client/commit/a9ef5e8e142f05653ae70fddf13379c31718e0ea"> and 367336bb7">367336bb7</a>

Run Details

275 of 360 branches covered (76.39%)

12 of 12 new or added lines in 1 file covered. (100.0%)

606 of 685 relevant lines covered (88.47%)

25.82 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

59.09

/lib/main.js

/*
 * Copyright IBM Corp. 2015-2017
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

const Client = require('./client.js');
const Consts = require('./consts.js');
const utils = require('./utils.js');

/**
 * @private
 */

let didWarnGetClient = false;

/**
 * @author Steven R. Loomis
 */

/**
 * Construct a g11n-pipeline client.
 * params.credentials is required unless params.appEnv is supplied.
 * @param {Object} params - configuration params
 * @param {Object} params.appEnv - pass the result of cfEnv.getAppEnv(). Ignored if params.credentials is supplied.
 * @param {Object.<string,string>} params.credentials - Bound credentials as from the CF service broker (overrides appEnv)
 * @param {string} params.credentials.url - service URL. (should end in '/translate')
 * @param {string} params.credentials.userId - service API key.
 * @param {string} params.credentials.password - service API key.
 * @param {string} params.credentials.instanceId - instance ID
 * @returns {Client}
 * @function getClient
 * @deprecated use create() which returns a promise
 */
exports.getClient = function getClient(params) {
  const client = new Client(params);
  /* eslint no-console: "off" */
  client.swaggerClient.catch((error) => {
    console.error(`g11n-pipeline: Error connecting to ${params.credentials.url}: ${error.message}`);
    if(!didWarnGetClient) {
      didWarnGetClient = true;
      /* eslint no-irregular-whitespace: "off" */
      console.warn(`g11n-pipeline: Please use “await require('g11n-pipeline').connect(…)” instead of “.getClient()”`);
    }
  });
  return client;
};

/**
 * Create a GP client… returns a promise to the client.
 */
exports.connect = function connect(params) {
  return new Promise((resolve, reject) => {
    const client = new Client(params);
    client.swaggerClient.then(() => resolve(client), (error) => reject(error));
  });
};

// re export these…
exports.serviceRegex = Consts.serviceRegex;
exports.exampleCredentials = Consts.exampleCredentials;
exports.exampleCredentialsString = Consts.exampleCredentialsString;
exports._normalizeUrl = utils._normalizeUrl;

1	/*
2	* Copyright IBM Corp. 2015-2017
3	*
4	* Licensed under the Apache License, Version 2.0 (the "License");
5	* you may not use this file except in compliance with the License.
6	* You may obtain a copy of the License at
7	*
8	* http://www.apache.org/licenses/LICENSE-2.0
9	*
10	* Unless required by applicable law or agreed to in writing, software
11	* distributed under the License is distributed on an "AS IS" BASIS,
12	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13	* See the License for the specific language governing permissions and
14	* limitations under the License.
15	*/
16
17	const Client = require('./client.js');	1✔
18	const Consts = require('./consts.js');	1✔
19	const utils = require('./utils.js');	1✔
20
21	/**
22	* @private
23	*/
24
25	let didWarnGetClient = false;	1✔
26
27	/**
28	* @author Steven R. Loomis
29	*/
30
31	/**
32	* Construct a g11n-pipeline client.
33	* params.credentials is required unless params.appEnv is supplied.
34	* @param {Object} params - configuration params
35	* @param {Object} params.appEnv - pass the result of cfEnv.getAppEnv(). Ignored if params.credentials is supplied.
36	* @param {Object.<string,string>} params.credentials - Bound credentials as from the CF service broker (overrides appEnv)
37	* @param {string} params.credentials.url - service URL. (should end in '/translate')
38	* @param {string} params.credentials.userId - service API key.
39	* @param {string} params.credentials.password - service API key.
40	* @param {string} params.credentials.instanceId - instance ID
41	* @returns {Client}
42	* @function getClient
43	* @deprecated use create() which returns a promise
44	*/
45	exports.getClient = function getClient(params) {	1✔
46	const client = new Client(params);	8✔
47	/* eslint no-console: "off" */
48	client.swaggerClient.catch((error) => {	8✔
49	console.error(`g11n-pipeline: Error connecting to ${params.credentials.url}: ${error.message}`);	×
50	if(!didWarnGetClient) {	×
51	didWarnGetClient = true;	×
52	/* eslint no-irregular-whitespace: "off" */
53	console.warn(`g11n-pipeline: Please use “await require('g11n-pipeline').connect(…)” instead of “.getClient()”`);	×
54	}
55	});
56	return client;	8✔
57	};
58
59	/**
60	* Create a GP client… returns a promise to the client.
61	*/
62	exports.connect = function connect(params) {	1✔
63	return new Promise((resolve, reject) => {	×
64	const client = new Client(params);	×
65	client.swaggerClient.then(() => resolve(client), (error) => reject(error));	×
66	});
67	};
68
69	// re export these…
70	exports.serviceRegex = Consts.serviceRegex;	1✔
71	exports.exampleCredentials = Consts.exampleCredentials;	1✔
72	exports.exampleCredentialsString = Consts.exampleCredentialsString;	1✔
73	exports._normalizeUrl = utils._normalizeUrl;	1✔

IBM-Cloud / gp-js-client / 249

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous