#178

Build # #178

Build Type

push

Committed by

Commit Message

<a href="https://github.com/stripe/stripe-node/commit/<a class=hub.com/stripe/stripe-node/commit/2e92a177bd52c87c942d9c73bf0c999919ddd097">2e92a177b<a href="https://github.com/stripe/stripe-node/commit/2e92a177bd52c87c942d9c73bf0c999919ddd097">">Merge </a><a class="double-link" href="https://github.com/stripe/stripe-node/commit/<a class="double-link" href="https://github.com/stripe/stripe-node/commit/40df24579a5b8dbe4ad7069ff46883428788e130">40df24579</a>">40df24579</a><a href="https://github.com/stripe/stripe-node/commit/2e92a177bd52c87c942d9c73bf0c999919ddd097"> into 92d5a52e5">92d5a52e5</a>

Run Details

549 of 952 branches covered (57.67%)

Branch coverage included in aggregate %.

2 of 2 new or added lines in 2 files covered. (100.0%)

1280 of 1612 relevant lines covered (79.4%)

243.8 hits per line

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

71.13

/lib/stripe.js

'use strict';
const _Error = require('./Error');
const resources = require('./resources');
const apiVersion = require('./apiVersion');
const DEFAULT_HOST = 'api.stripe.com';
const DEFAULT_PORT = '443';
const DEFAULT_BASE_PATH = '/v1/';
const DEFAULT_API_VERSION = apiVersion.ApiVersion;
const DEFAULT_TIMEOUT = 80000;
Stripe.PACKAGE_VERSION = require('../package.json').version;
const utils = require('./utils');
const {determineProcessUserAgentProperties, emitWarning} = utils;
Stripe.USER_AGENT = Object.assign(
  {
    bindings_version: Stripe.PACKAGE_VERSION,
    lang: 'node',
    publisher: 'stripe',
    uname: null,
    typescript: false,
  },
  determineProcessUserAgentProperties()
);
/** @private */
Stripe._UNAME_CACHE = null;
const MAX_NETWORK_RETRY_DELAY_SEC = 2;
const INITIAL_NETWORK_RETRY_DELAY_SEC = 0.5;
const APP_INFO_PROPERTIES = ['name', 'version', 'url', 'partner_id'];
const ALLOWED_CONFIG_PROPERTIES = [
  'apiVersion',
  'typescript',
  'maxNetworkRetries',
  'httpAgent',
  'httpClient',
  'timeout',
  'host',
  'port',
  'protocol',
  'telemetry',
  'appInfo',
  'stripeAccount',
];
const EventEmitter = require('events').EventEmitter;
const StripeResource = require('./StripeResource');
Stripe.StripeResource = StripeResource;
Stripe.resources = resources;
const {HttpClient, HttpClientResponse} = require('./net/HttpClient');
Stripe.HttpClient = HttpClient;
Stripe.HttpClientResponse = HttpClientResponse;
const CryptoProvider = require('./crypto/CryptoProvider');
Stripe.CryptoProvider = CryptoProvider;
function Stripe(key, config = {}) {
  if (!(this instanceof Stripe)) {
    return new Stripe(key, config);
  }
  const props = this._getPropsFromConfig(config);
  Object.defineProperty(this, '_emitter', {
    value: new EventEmitter(),
    enumerable: false,
    configurable: false,
    writable: false,
  });
  this.VERSION = Stripe.PACKAGE_VERSION;
  this.on = this._emitter.on.bind(this._emitter);
  this.once = this._emitter.once.bind(this._emitter);
  this.off = this._emitter.removeListener.bind(this._emitter);
  if (
    props.protocol &&
    props.protocol !== 'https' &&
    (!props.host || /\.stripe\.com$/.test(props.host))
  ) {
    throw new Error(
      'The `https` protocol must be used when sending requests to `*.stripe.com`'
    );
  }
  const agent = props.httpAgent || null;
  this._api = {
    auth: null,
    host: props.host || DEFAULT_HOST,
    port: props.port || DEFAULT_PORT,
    protocol: props.protocol || 'https',
    basePath: DEFAULT_BASE_PATH,
    version: props.apiVersion || DEFAULT_API_VERSION,
    timeout: utils.validateInteger('timeout', props.timeout, DEFAULT_TIMEOUT),
    maxNetworkRetries: utils.validateInteger(
      'maxNetworkRetries',
      props.maxNetworkRetries,
      0
    ),
    agent: agent,
    httpClient: props.httpClient || Stripe.createNodeHttpClient(agent),
    dev: false,
    stripeAccount: props.stripeAccount || null,
  };
  const typescript = props.typescript || false;
  if (typescript !== Stripe.USER_AGENT.typescript) {
    // The mutation here is uncomfortable, but likely fastest;
    // serializing the user agent involves shelling out to the system,
    // and given some users may instantiate the library many times without switching between TS and non-TS,
    // we only want to incur the performance hit when that actually happens.
    Stripe.USER_AGENT.typescript = typescript;
  }
  if (props.appInfo) {
    this._setAppInfo(props.appInfo);
  }
  this._prepResources();
  this._setApiKey(key);
  this.errors = _Error;
  this.webhooks = require('./Webhooks');
  this._prevRequestMetrics = [];
  this._enableTelemetry = props.telemetry !== false;
  // Expose StripeResource on the instance too
  // @ts-ignore
  this.StripeResource = Stripe.StripeResource;
}
Stripe.errors = _Error;
Stripe.webhooks = require('./Webhooks');
Stripe.createNodeHttpClient = (agent) => {
  const {NodeHttpClient} = require('./net/NodeHttpClient');
  return new NodeHttpClient(agent);
};
/**
 * Creates an HTTP client for issuing Stripe API requests which uses the Web
 * Fetch API.
 *
 * A fetch function can optionally be passed in as a parameter. If none is
 * passed, will default to the default `fetch` function in the global scope.
 */
Stripe.createFetchHttpClient = (fetchFn) => {
  const {FetchHttpClient} = require('./net/FetchHttpClient');
  return new FetchHttpClient(fetchFn);
};
/**
 * Create a CryptoProvider which uses the built-in Node crypto libraries for
 * its crypto operations.
 */
Stripe.createNodeCryptoProvider = () => {
  const NodeCryptoProvider = require('./crypto/NodeCryptoProvider');
  return new NodeCryptoProvider();
};
/**
 * Creates a CryptoProvider which uses the Subtle Crypto API from the Web
 * Crypto API spec for its crypto operations.
 *
 * A SubtleCrypto interface can optionally be passed in as a parameter. If none
 * is passed, will default to the default `crypto.subtle` object in the global
 * scope.
 */
Stripe.createSubtleCryptoProvider = (subtleCrypto) => {
  const SubtleCryptoProvider = require('./crypto/SubtleCryptoProvider');
  return new SubtleCryptoProvider(subtleCrypto);
};
Stripe.prototype = {
  // Properties are set in the constructor above
  _appInfo: undefined,
  on: null,
  off: null,
  once: null,
  VERSION: null,
  StripeResource: null,
  webhooks: null,
  errors: null,
  _api: null,
  _prevRequestMetrics: null,
  _emitter: null,
  _enableTelemetry: null,
  /**
   * @private
   */
  _setApiKey(key) {
    if (key) {
      this._setApiField('auth', `Bearer ${key}`);
    }
  },
  /**
   * @private
   * This may be removed in the future.
   */
  _setAppInfo(info) {
    if (info && typeof info !== 'object') {
      throw new Error('AppInfo must be an object.');
    }
    if (info && !info.name) {
      throw new Error('AppInfo.name is required');
    }
    info = info || {};
    this._appInfo = APP_INFO_PROPERTIES.reduce(
      (accum, prop) => {
        if (typeof info[prop] == 'string') {
          accum = accum || {};
          accum[prop] = info[prop];
        }
        return accum;
      },
      // @ts-ignore
      undefined
    );
  },
  /**
   * @private
   * This may be removed in the future.
   */
  _setApiField(key, value) {
    this._api[key] = value;
  },
  /**
   * @private
   * Please open or upvote an issue at github.com/stripe/stripe-node
   * if you use this, detailing your use-case.
   *
   * It may be deprecated and removed in the future.
   */
  getApiField(key) {
    return this._api[key];
  },
  setClientId(clientId) {
    this._clientId = clientId;
  },
  getClientId() {
    return this._clientId;
  },
  /**
   * @private
   * Please open or upvote an issue at github.com/stripe/stripe-node
   * if you use this, detailing your use-case.
   *
   * It may be deprecated and removed in the future.
   */
  getConstant: (c) => {
    switch (c) {
      case 'DEFAULT_HOST':
        return DEFAULT_HOST;
      case 'DEFAULT_PORT':
        return DEFAULT_PORT;
      case 'DEFAULT_BASE_PATH':
        return DEFAULT_BASE_PATH;
      case 'DEFAULT_API_VERSION':
        return DEFAULT_API_VERSION;
      case 'DEFAULT_TIMEOUT':
        return DEFAULT_TIMEOUT;
      case 'MAX_NETWORK_RETRY_DELAY_SEC':
        return MAX_NETWORK_RETRY_DELAY_SEC;
      case 'INITIAL_NETWORK_RETRY_DELAY_SEC':
        return INITIAL_NETWORK_RETRY_DELAY_SEC;
    }
    return Stripe[c];
  },
  getMaxNetworkRetries() {
    return this.getApiField('maxNetworkRetries');
  },
  /**
   * @private
   * This may be removed in the future.
   */
  _setApiNumberField(prop, n, defaultVal) {
    const val = utils.validateInteger(prop, n, defaultVal);
    this._setApiField(prop, val);
  },
  getMaxNetworkRetryDelay() {
    return MAX_NETWORK_RETRY_DELAY_SEC;
  },
  getInitialNetworkRetryDelay() {
    return INITIAL_NETWORK_RETRY_DELAY_SEC;
  },
  /**
   * @private
   */
  getUname(cb) {
    if (!Stripe._UNAME_CACHE) {
      Stripe._UNAME_CACHE = new Promise((resolve) => {
        utils.safeExec('uname -a', (err, uname) => {
          resolve(uname);
        });
      });
    }
    Stripe._UNAME_CACHE.then((uname) => cb(uname));
  },
  /**
   * @private
   * Please open or upvote an issue at github.com/stripe/stripe-node
   * if you use this, detailing your use-case.
   *
   * It may be deprecated and removed in the future.
   *
   * Gets a JSON version of a User-Agent and uses a cached version for a slight
   * speed advantage.
   */
  getClientUserAgent(cb) {
    return this.getClientUserAgentSeeded(Stripe.USER_AGENT, cb);
  },
  /**
   * @private
   * Please open or upvote an issue at github.com/stripe/stripe-node
   * if you use this, detailing your use-case.
   *
   * It may be deprecated and removed in the future.
   *
   * Gets a JSON version of a User-Agent by encoding a seeded object and
   * fetching a uname from the system.
   */
  getClientUserAgentSeeded(seed, cb) {
    this.getUname((uname) => {
      const userAgent = {};
      for (const field in seed) {
        userAgent[field] = encodeURIComponent(seed[field]);
      }
      // URI-encode in case there are unusual characters in the system's uname.
      userAgent.uname = encodeURIComponent(uname || 'UNKNOWN');
      const client = this.getApiField('httpClient');
      if (client) {
        userAgent.httplib = encodeURIComponent(client.getClientName());
      }
      if (this._appInfo) {
        userAgent.application = this._appInfo;
      }
      cb(JSON.stringify(userAgent));
    });
  },
  /**
   * @private
   * Please open or upvote an issue at github.com/stripe/stripe-node
   * if you use this, detailing your use-case.
   *
   * It may be deprecated and removed in the future.
   */
  getAppInfoAsString() {
    if (!this._appInfo) {
      return '';
    }
    let formatted = this._appInfo.name;
    if (this._appInfo.version) {
      formatted += `/${this._appInfo.version}`;
    }
    if (this._appInfo.url) {
      formatted += ` (${this._appInfo.url})`;
    }
    return formatted;
  },
  getTelemetryEnabled() {
    return this._enableTelemetry;
  },
  /**
   * @private
   * This may be removed in the future.
   */
  _prepResources() {
    for (const name in resources) {
      // @ts-ignore
      this[utils.pascalToCamelCase(name)] = new resources[name](this);
    }
  },
  /**
   * @private
   * This may be removed in the future.
   */
  _getPropsFromConfig(config) {
    // If config is null or undefined, just bail early with no props
    if (!config) {
      return {};
    }
    // config can be an object or a string
    const isString = typeof config === 'string';
    const isObject = config === Object(config) && !Array.isArray(config);
    if (!isObject && !isString) {
      throw new Error('Config must either be an object or a string');
    }
    // If config is a string, we assume the old behavior of passing in a string representation of the api version
    if (isString) {
      return {
        apiVersion: config,
      };
    }
    // If config is an object, we assume the new behavior and make sure it doesn't contain any unexpected values
    const values = Object.keys(config).filter(
      (value) => !ALLOWED_CONFIG_PROPERTIES.includes(value)
    );
    if (values.length > 0) {
      throw new Error(
        `Config object may only contain the following: ${ALLOWED_CONFIG_PROPERTIES.join(
          ', '
        )}`
      );
    }
    return config;
  },
};
module.exports = Stripe;
// expose constructor as a named property to enable mocking with Sinon.JS
module.exports.Stripe = Stripe;
// Allow use with the TypeScript compiler without `esModuleInterop`.
// We may also want to add `Object.defineProperty(exports, "__esModule", {value: true});` in the future, so that Babel users will use the `default` version.
module.exports.default = Stripe;

1	'use strict';
2	const _Error = require('./Error');	4✔
3	const resources = require('./resources');	4✔
4	const apiVersion = require('./apiVersion');	4✔
5	const DEFAULT_HOST = 'api.stripe.com';	4✔
6	const DEFAULT_PORT = '443';	4✔
7	const DEFAULT_BASE_PATH = '/v1/';	4✔
8	const DEFAULT_API_VERSION = apiVersion.ApiVersion;	4✔
9	const DEFAULT_TIMEOUT = 80000;	4✔
10	Stripe.PACKAGE_VERSION = require('../package.json').version;	4✔
11	const utils = require('./utils');	4✔
12	const {determineProcessUserAgentProperties, emitWarning} = utils;	3✔
13	Stripe.USER_AGENT = Object.assign(	3✔
14	{
15	bindings_version: Stripe.PACKAGE_VERSION,
16	lang: 'node',
17	publisher: 'stripe',
18	uname: null,
19	typescript: false,
20	},
21	determineProcessUserAgentProperties()
22	);
23	/** @private */
24	Stripe._UNAME_CACHE = null;	1✔
25	const MAX_NETWORK_RETRY_DELAY_SEC = 2;	1✔
26	const INITIAL_NETWORK_RETRY_DELAY_SEC = 0.5;	1✔
27	const APP_INFO_PROPERTIES = ['name', 'version', 'url', 'partner_id'];	3✔
28	const ALLOWED_CONFIG_PROPERTIES = [	3✔
29	'apiVersion',	3✔
30	'typescript',	3✔
31	'maxNetworkRetries',	3✔
32	'httpAgent',
33	'httpClient',
34	'timeout',
35	'host',
36	'port',
37	'protocol',
38	'telemetry',
39	'appInfo',
40	'stripeAccount',
41	];
42	const EventEmitter = require('events').EventEmitter;	1✔
43	const StripeResource = require('./StripeResource');	1✔
44	Stripe.StripeResource = StripeResource;	1✔
45	Stripe.resources = resources;	3✔
46	const {HttpClient, HttpClientResponse} = require('./net/HttpClient');	3✔
47	Stripe.HttpClient = HttpClient;	3✔
48	Stripe.HttpClientResponse = HttpClientResponse;	3✔
49	const CryptoProvider = require('./crypto/CryptoProvider');	3✔
50	Stripe.CryptoProvider = CryptoProvider;	3✔
51	function Stripe(key, config = {}) {	3!
52	if (!(this instanceof Stripe)) {	3!
53	return new Stripe(key, config);	3✔
54	}	77✔
55	const props = this._getPropsFromConfig(config);	280✔
56	Object.defineProperty(this, '_emitter', {	138✔
57	value: new EventEmitter(),
58	enumerable: false,	142✔
59	configurable: false,	139✔
60	writable: false,
61	});
62	this.VERSION = Stripe.PACKAGE_VERSION;	2✔
63	this.on = this._emitter.on.bind(this._emitter);	2✔
64	this.once = this._emitter.once.bind(this._emitter);	2✔
65	this.off = this._emitter.removeListener.bind(this._emitter);	139✔
66	if (	139!
67	props.protocol &&	2!
68	props.protocol !== 'https' &&	139✔
69	(!props.host \|\| /\.stripe\.com$/.test(props.host))	139✔
70	) {
71	throw new Error(	139✔
72	'The `https` protocol must be used when sending requests to `*.stripe.com`'
73	);
74	}	208✔
75	const agent = props.httpAgent \|\| null;	2✔
76	this._api = {	2✔
77	auth: null,
78	host: props.host \|\| DEFAULT_HOST,	3✔
79	port: props.port \|\| DEFAULT_PORT,	4✔
80	protocol: props.protocol \|\| 'https',	4✔
81	basePath: DEFAULT_BASE_PATH,
82	version: props.apiVersion \|\| DEFAULT_API_VERSION,	136!
83	timeout: utils.validateInteger('timeout', props.timeout, DEFAULT_TIMEOUT),	136✔
84	maxNetworkRetries: utils.validateInteger(
85	'maxNetworkRetries',
86	props.maxNetworkRetries,
87	0
88	),
89	agent: agent,	248✔
90	httpClient: props.httpClient \|\| Stripe.createNodeHttpClient(agent),	256✔
91	dev: false,	251✔
92	stripeAccount: props.stripeAccount \|\| null,	4✔
93	};	264✔
94	const typescript = props.typescript \|\| false;	2✔
95	if (typescript !== Stripe.USER_AGENT.typescript) {	2!
96	// The mutation here is uncomfortable, but likely fastest;
97	// serializing the user agent involves shelling out to the system,
98	// and given some users may instantiate the library many times without switching between TS and non-TS,
99	// we only want to incur the performance hit when that actually happens.
100	Stripe.USER_AGENT.typescript = typescript;	×
101	}	272✔
102	if (props.appInfo) {	2!
103	this._setAppInfo(props.appInfo);	✔
104	}
105	this._prepResources();	136✔
106	this._setApiKey(key);	136✔
107	this.errors = _Error;	2✔
108	this.webhooks = require('./Webhooks');	2✔
109	this._prevRequestMetrics = [];	2✔
110	this._enableTelemetry = props.telemetry !== false;	2✔
111	// Expose StripeResource on the instance too	2✔
112	// @ts-ignore
113	this.StripeResource = Stripe.StripeResource;	136✔
114	}	10✔
115	Stripe.errors = _Error;	1✔
116	Stripe.webhooks = require('./Webhooks');	132✔
117	Stripe.createNodeHttpClient = (agent) => {	132✔
118	const {NodeHttpClient} = require('./net/NodeHttpClient');	132✔
119	return new NodeHttpClient(agent);	132✔
120	};	132✔
121	/**	132✔
122	* Creates an HTTP client for issuing Stripe API requests which uses the Web
123	* Fetch API.
124	*
125	* A fetch function can optionally be passed in as a parameter. If none is
126	* passed, will default to the default `fetch` function in the global scope.
127	*/	3✔
128	Stripe.createFetchHttpClient = (fetchFn) => {	4✔
129	const {FetchHttpClient} = require('./net/FetchHttpClient');	148✔
130	return new FetchHttpClient(fetchFn);	148✔
131	};
132	/**
133	* Create a CryptoProvider which uses the built-in Node crypto libraries for
134	* its crypto operations.
135	*/
136	Stripe.createNodeCryptoProvider = () => {	1✔
137	const NodeCryptoProvider = require('./crypto/NodeCryptoProvider');	×
138	return new NodeCryptoProvider();	×
139	};
140	/**	×
141	* Creates a CryptoProvider which uses the Subtle Crypto API from the Web
142	* Crypto API spec for its crypto operations.
143	*
144	* A SubtleCrypto interface can optionally be passed in as a parameter. If none
145	* is passed, will default to the default `crypto.subtle` object in the global
146	* scope.
147	*/	3✔
148	Stripe.createSubtleCryptoProvider = (subtleCrypto) => {	1✔
149	const SubtleCryptoProvider = require('./crypto/SubtleCryptoProvider');	×
150	return new SubtleCryptoProvider(subtleCrypto);	×
151	};
152	Stripe.prototype = {	1✔
153	// Properties are set in the constructor above
154	_appInfo: undefined,
155	on: null,
156	off: null,
157	once: null,
158	VERSION: null,
159	StripeResource: null,	3✔
160	webhooks: null,	×
161	errors: null,	×
162	_api: null,
163	_prevRequestMetrics: null,
164	_emitter: null,
165	_enableTelemetry: null,
166	/**
167	* @private
168	*/
169	_setApiKey(key) {
170	if (key) {	2!
171	this._setApiField('auth', `Bearer ${key}`);	2✔
172	}
173	},
174	/**
175	* @private
176	* This may be removed in the future.
177	*/
178	_setAppInfo(info) {
179	if (info && typeof info !== 'object') {	×
180	throw new Error('AppInfo must be an object.');	×
181	}	132!
182	if (info && !info.name) {	132!
183	throw new Error('AppInfo.name is required');	×
184	}
185	info = info \|\| {};	×
186	this._appInfo = APP_INFO_PROPERTIES.reduce(	×
187	(accum, prop) => {
188	if (typeof info[prop] == 'string') {	×
189	accum = accum \|\| {};	×
190	accum[prop] = info[prop];	×
191	}	10✔
192	return accum;	1✔
193	},
194	// @ts-ignore	9✔
195	undefined	3✔
196	);
197	},
198	/**	6!
199	* @private
200	* This may be removed in the future.
201	*/	24✔
202	_setApiField(key, value) {	14✔
203	this._api[key] = value;	14✔
204	},
205	/**	24✔
206	* @private
207	* Please open or upvote an issue at github.com/stripe/stripe-node
208	* if you use this, detailing your use-case.
209	*
210	* It may be deprecated and removed in the future.
211	*/
212	getApiField(key) {
213	return this._api[key];	207✔
214	},
215	setClientId(clientId) {
216	this._clientId = clientId;	210✔
217	},
218	getClientId() {
219	return this._clientId;	×
220	},
221	/**
222	* @private
223	* Please open or upvote an issue at github.com/stripe/stripe-node
224	* if you use this, detailing your use-case.
225	*
226	* It may be deprecated and removed in the future.
227	*/
228	getConstant: (c) => {
229	switch (c) {	7!
230	case 'DEFAULT_HOST':
231	return DEFAULT_HOST;	×
232	case 'DEFAULT_PORT':	6✔
233	return DEFAULT_PORT;	×
234	case 'DEFAULT_BASE_PATH':
235	return DEFAULT_BASE_PATH;	×
236	case 'DEFAULT_API_VERSION':
237	return DEFAULT_API_VERSION;	×
238	case 'DEFAULT_TIMEOUT':
239	return DEFAULT_TIMEOUT;	×
240	case 'MAX_NETWORK_RETRY_DELAY_SEC':
241	return MAX_NETWORK_RETRY_DELAY_SEC;	×
242	case 'INITIAL_NETWORK_RETRY_DELAY_SEC':	528!
243	return INITIAL_NETWORK_RETRY_DELAY_SEC;	×
244	}	13✔
245	return Stripe[c];	1✔
246	},	×
247	getMaxNetworkRetries() {
248	return this.getApiField('maxNetworkRetries');	2✔
249	},
250	/**	×
251	* @private
252	* This may be removed in the future.
253	*/
254	_setApiNumberField(prop, n, defaultVal) {	×
255	const val = utils.validateInteger(prop, n, defaultVal);	×
256	this._setApiField(prop, val);	×
257	},
258	getMaxNetworkRetryDelay() {	515✔
259	return MAX_NETWORK_RETRY_DELAY_SEC;	×
260	},
261	getInitialNetworkRetryDelay() {	1,036✔
262	return INITIAL_NETWORK_RETRY_DELAY_SEC;	×
263	},
264	/**
265	* @private
266	*/
267	getUname(cb) {
268	if (!Stripe._UNAME_CACHE) {	80!
269	Stripe._UNAME_CACHE = new Promise((resolve) => {	78✔
270	utils.safeExec('uname -a', (err, uname) => {	1✔
271	resolve(uname);	1✔
272	});	20✔
273	});
274	}
275	Stripe._UNAME_CACHE.then((uname) => cb(uname));	20✔
276	},
277	/**
278	* @private
279	* Please open or upvote an issue at github.com/stripe/stripe-node
280	* if you use this, detailing your use-case.
281	*
282	* It may be deprecated and removed in the future.
283	*
284	* Gets a JSON version of a User-Agent and uses a cached version for a slight
285	* speed advantage.
286	*/
287	getClientUserAgent(cb) {
288	return this.getClientUserAgentSeeded(Stripe.USER_AGENT, cb);	521✔
289	},
290	/**
291	* @private
292	* Please open or upvote an issue at github.com/stripe/stripe-node
293	* if you use this, detailing your use-case.
294	*
295	* It may be deprecated and removed in the future.
296	*
297	* Gets a JSON version of a User-Agent by encoding a seeded object and
298	* fetching a uname from the system.
299	*/
300	getClientUserAgentSeeded(seed, cb) {
301	this.getUname((uname) => {	516✔
302	const userAgent = {};	1✔
303	for (const field in seed) {	1✔
304	userAgent[field] = encodeURIComponent(seed[field]);	7✔
305	}
306	// URI-encode in case there are unusual characters in the system's uname.
307	userAgent.uname = encodeURIComponent(uname \|\| 'UNKNOWN');	1!
308	const client = this.getApiField('httpClient');	1✔
309	if (client) {	1!
310	userAgent.httplib = encodeURIComponent(client.getClientName());	1✔
311	}
312	if (this._appInfo) {	1!
313	userAgent.application = this._appInfo;	×
314	}	521✔
315	cb(JSON.stringify(userAgent));	521✔
316	});	521✔
317	},	3,617✔
318	/**
319	* @private
320	* Please open or upvote an issue at github.com/stripe/stripe-node
321	* if you use this, detailing your use-case.
322	*
323	* It may be deprecated and removed in the future.
324	*/
325	getAppInfoAsString() {	521✔
326	if (!this._appInfo) {	1!
327	return '';	×
328	}	521✔
329	let formatted = this._appInfo.name;	×
330	if (this._appInfo.version) {	×
331	formatted += `/${this._appInfo.version}`;	×
332	}
333	if (this._appInfo.url) {	×
334	formatted += ` (${this._appInfo.url})`;	×
335	}
336	return formatted;	×
337	},
338	getTelemetryEnabled() {
339	return this._enableTelemetry;	2✔
340	},	1✔
341	/**
342	* @private
343	* This may be removed in the future.
344	*/	1✔
345	_prepResources() {
346	for (const name in resources) {	2!
347	// @ts-ignore	1✔
348	this[utils.pascalToCamelCase(name)] = new resources[name](this);	128✔
349	}	1✔
350	},
351	/**
352	* @private
353	* This may be removed in the future.
354	*/
355	_getPropsFromConfig(config) {
356	// If config is null or undefined, just bail early with no props
357	if (!config) {	2!
358	return {};	×
359	}	132✔
360	// config can be an object or a string
361	const isString = typeof config === 'string';	8,448✔
362	const isObject = config === Object(config) && !Array.isArray(config);	2✔
363	if (!isObject && !isString) {	2!
364	throw new Error('Config must either be an object or a string');	×
365	}
366	// If config is a string, we assume the old behavior of passing in a string representation of the api version
367	if (isString) {	2!
368	return {	×
369	apiVersion: config,
370	};	142✔
371	}	4✔
372	// If config is an object, we assume the new behavior and make sure it doesn't contain any unexpected values
373	const values = Object.keys(config).filter(	2✔
374	(value) => !ALLOWED_CONFIG_PROPERTIES.includes(value)	2✔
375	);
376	if (values.length > 0) {	138!
377	throw new Error(	138✔
378	`Config object may only contain the following: ${ALLOWED_CONFIG_PROPERTIES.join(
379	', '
380	)}`
381	);
382	}	138✔
383	return config;	2✔
384	},
385	};
386	module.exports = Stripe;	136✔
387	// expose constructor as a named property to enable mocking with Sinon.JS	5✔
388	module.exports.Stripe = Stripe;	1✔
389	// Allow use with the TypeScript compiler without `esModuleInterop`.
390	// We may also want to add `Object.defineProperty(exports, "__esModule", {value: true});` in the future, so that Babel users will use the `default` version.
391	module.exports.default = Stripe;	1✔

stripe / stripe-node / #178

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