stripe / stripe-node / #14

Build # #14

Build Type

push

Committed by

Commit Message

<a href="https://github.com/stripe/stripe-node/commit/<a class=hub.com/stripe/stripe-node/commit/d9057fbfacf9e97761b0ce9a154ba1794f791640">d9057fbfa<a href="https://github.com/stripe/stripe-node/commit/d9057fbfacf9e97761b0ce9a154ba1794f791640">">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/b276190da6c38fc6a0a31e4b0f0eb570758553dc">b276190da</a>">b276190da</a><a href="https://github.com/stripe/stripe-node/commit/d9057fbfacf9e97761b0ce9a154ba1794f791640"> into deb7bb54c">deb7bb54c</a>

Run Details

502 of 569 branches covered (88.22%)

Branch coverage included in aggregate %.

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

1238 of 1313 relevant lines covered (94.29%)

328.05 hits per line

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

87.55

/lib/stripe.js

'use strict';
const _Error = require('./Error');
const resources = require('./resources');
const DEFAULT_HOST = 'api.stripe.com';
const DEFAULT_PORT = '443';
const DEFAULT_BASE_PATH = '/v1/';
const DEFAULT_API_VERSION = null;
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
  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 = {
  /**
   * @deprecated will be removed in a future major version. Use the config object instead:
   *
   * const stripe = new Stripe(API_KEY, {
   *   host: 'example.com',
   *   port: '8080',
   *   protocol: 'http',
   * });
   *
   */
  setHost(host, port, protocol) {
    emitWarning(
      '`setHost` is deprecated. Use the `host` config option instead.'
    );
    this._setApiField('host', host);
    if (port) {
      this.setPort(port);
    }
    if (protocol) {
      this.setProtocol(protocol);
    }
  },
  /**
   * @deprecated will be removed in a future major version. Use the config object instead:
   *
   * const stripe = new Stripe(API_KEY, {
   *   protocol: 'http',
   * });
   *
   */
  setProtocol(protocol) {
    emitWarning(
      '`setProtocol` is deprecated. Use the `protocol` config option instead.'
    );
    this._setApiField('protocol', protocol.toLowerCase());
  },
  /**
   * @deprecated will be removed in a future major version. Use the config object instead:
   *
   * const stripe = new Stripe(API_KEY, {
   *   port: 3000,
   * });
   *
   */
  setPort(port) {
    emitWarning(
      '`setPort` is deprecated. Use the `port` config option instead.'
    );
    this._setApiField('port', port);
  },
  /**
   * @deprecated will be removed in a future major version. Use the config object instead:
   *
   * const stripe = new Stripe(API_KEY, {
   *   apiVersion: API_VERSION,
   * });
   *
   */
  setApiVersion(version) {
    emitWarning(
      '`setApiVersion` is deprecated. Use the `apiVersion` config or request option instead.'
    );
    if (version) {
      this._setApiField('version', version);
    }
  },
  /**
   * @deprecated will be removed in a future major version. Use the config object instead:
   *
   * const stripe = new Stripe(API_KEY);
   *
   * Or, for Stripe Connect, use `stripeAccount` instead:
   *
   * const stripe = new Stripe(API_KEY, {
   *   stripeAccount: 'acct_...',
   * });
   *
   * Or, to use a different apiKey on a given request:
   *
   * stripe.customers.create(params, {apiKey: 'sk_test_...'});
   */
  setApiKey(key) {
    emitWarning(
      '`setApiKey` is deprecated. Use the `apiKey` request option instead.'
    );
    this._setApiKey(key);
  },
  /**
   * @private
   */
  _setApiKey(key) {
    if (key) {
      this._setApiField('auth', `Bearer ${key}`);
    }
  },
  /**
   * @deprecated will be removed in a future major version. Use the config object instead:
   *
   * const stripe = new Stripe(API_KEY, {
   *   timeout: TIMEOUT_MS,
   * });
   */
  setTimeout(timeout) {
    emitWarning(
      '`setTimeout` is deprecated. Use the `timeout` config or request option instead.'
    );
    this._setApiField('timeout', timeout == null ? DEFAULT_TIMEOUT : timeout);
  },
  /**
   * @deprecated will be removed in a future major version. Use the config object instead:
   *
   * const stripe = new Stripe(API_KEY, {
   *   appInfo: {
   *     name: 'MyPlugin',
   *     version: '1.4.2',
   *     url: 'https://myplugin.com',
   *     partner_id: '1234',
   *   },
   * });
   */
  setAppInfo(info) {
    emitWarning(
      '`setAppInfo` is deprecated. Use the `appInfo` config option instead.'
    );
    this._setAppInfo(info);
  },
  /**
   * @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 || {};
    const appInfo = APP_INFO_PROPERTIES.reduce((accum, prop) => {
      if (typeof info[prop] == 'string') {
        accum = accum || {};
        accum[prop] = info[prop];
      }
      return accum;
    }, undefined);
    this._appInfo = appInfo;
  },
  /**
   * @deprecated will be removed in a future major version. Use the config object instead:
   *
   * const ProxyAgent = require('https-proxy-agent');
   * const stripe = new Stripe(API_KEY, {
   *   httpAgent: new ProxyAgent(process.env.http_proxy),
   * });
   *
   */
  setHttpAgent(agent) {
    emitWarning(
      '`setHttpAgent` is deprecated. Use the `httpAgent` config option instead.'
    );
    this._setApiField('agent', agent);
  },
  /**
   * @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');
  },
  /**
   * @deprecated will be removed in a future major version. Use the config object instead:
   *
   * const stripe = new Stripe(API_KEY, {
   *   maxNetworkRetries: 2,
   * });
   *
   */
  setMaxNetworkRetries(maxNetworkRetries) {
    this._setApiNumberField('maxNetworkRetries', 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;
  },
  /**
   * @deprecated will be removed in a future major version. Use the config object instead:
   *
   * const stripe = new Stripe(API_KEY, {
   *   telemetry: false,
   * });
   *
   */
  setTelemetryEnabled(enableTelemetry) {
    emitWarning(
      '`setTelemetryEnabled` is deprecated. Use the `telemetry` config option instead.'
    );
    this._enableTelemetry = enableTelemetry;
  },
  getTelemetryEnabled() {
    return this._enableTelemetry;
  },
  /**
   * @private
   * This may be removed in the future.
   */
  _prepResources() {
    for (const name in resources) {
      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');	3✔
3	const resources = require('./resources');	3✔
4	const DEFAULT_HOST = 'api.stripe.com';	3✔
5	const DEFAULT_PORT = '443';	3✔
6	const DEFAULT_BASE_PATH = '/v1/';	3✔
7	const DEFAULT_API_VERSION = null;	3✔
8	const DEFAULT_TIMEOUT = 80000;	3✔
9	Stripe.PACKAGE_VERSION = require('../package.json').version;	3✔
10	const utils = require('./utils');	3✔
11	const {determineProcessUserAgentProperties, emitWarning} = utils;	3✔
12	Stripe.USER_AGENT = Object.assign(	3✔
13	{
14	bindings_version: Stripe.PACKAGE_VERSION,
15	lang: 'node',
16	publisher: 'stripe',
17	uname: null,
18	typescript: false,
19	},
20	determineProcessUserAgentProperties()
21	);
22	/** @private */
23	Stripe._UNAME_CACHE = null;	3✔
24	const MAX_NETWORK_RETRY_DELAY_SEC = 2;	3✔
25	const INITIAL_NETWORK_RETRY_DELAY_SEC = 0.5;	3✔
26	const APP_INFO_PROPERTIES = ['name', 'version', 'url', 'partner_id'];	3✔
27	const ALLOWED_CONFIG_PROPERTIES = [	3✔
28	'apiVersion',
29	'typescript',
30	'maxNetworkRetries',
31	'httpAgent',
32	'httpClient',
33	'timeout',
34	'host',
35	'port',
36	'protocol',
37	'telemetry',
38	'appInfo',
39	'stripeAccount',
40	];
41	const EventEmitter = require('events').EventEmitter;	3✔
42	const StripeResource = require('./StripeResource');	3✔
43	Stripe.StripeResource = StripeResource;	3✔
44	Stripe.resources = resources;	3✔
45	const {HttpClient, HttpClientResponse} = require('./net/HttpClient');	3✔
46	Stripe.HttpClient = HttpClient;	3✔
47	Stripe.HttpClientResponse = HttpClientResponse;	3✔
48	const CryptoProvider = require('./crypto/CryptoProvider');	3✔
49	Stripe.CryptoProvider = CryptoProvider;	3✔
50	function Stripe(key, config = {}) {	80✔
51	if (!(this instanceof Stripe)) {	252✔
52	return new Stripe(key, config);	124✔
53	}
54	const props = this._getPropsFromConfig(config);	128✔
55	Object.defineProperty(this, '_emitter', {	125✔
56	value: new EventEmitter(),
57	enumerable: false,
58	configurable: false,
59	writable: false,
60	});
61	this.VERSION = Stripe.PACKAGE_VERSION;	125✔
62	this.on = this._emitter.on.bind(this._emitter);	125✔
63	this.once = this._emitter.once.bind(this._emitter);	125✔
64	this.off = this._emitter.removeListener.bind(this._emitter);	125✔
65	if (	125✔
66	props.protocol &&	185✔
67	props.protocol !== 'https' &&
68	(!props.host \|\| /\.stripe\.com$/.test(props.host))
69	) {
70	throw new Error(	3✔
71	'The `https` protocol must be used when sending requests to `*.stripe.com`'
72	);
73	}
74	const agent = props.httpAgent \|\| null;	122✔
75	this._api = {	122✔
76	auth: null,
77	host: props.host \|\| DEFAULT_HOST,	223✔
78	port: props.port \|\| DEFAULT_PORT,	227✔
79	protocol: props.protocol \|\| 'https',	226✔
80	basePath: DEFAULT_BASE_PATH,
81	version: props.apiVersion \|\| DEFAULT_API_VERSION,	237✔
82	timeout: utils.validateInteger('timeout', props.timeout, DEFAULT_TIMEOUT),
83	maxNetworkRetries: utils.validateInteger(
84	'maxNetworkRetries',
85	props.maxNetworkRetries,
86	0
87	),
88	agent: agent,
89	httpClient: props.httpClient \|\| Stripe.createNodeHttpClient(agent),	244✔
90	dev: false,
91	stripeAccount: props.stripeAccount \|\| null,	242✔
92	};
93	const typescript = props.typescript \|\| false;	122✔
94	if (typescript !== Stripe.USER_AGENT.typescript) {	122✔
95	// The mutation here is uncomfortable, but likely fastest;
96	// serializing the user agent involves shelling out to the system,
97	// and given some users may instantiate the library many times without switching between TS and non-TS,
98	// we only want to incur the performance hit when that actually happens.
99	Stripe.USER_AGENT.typescript = typescript;	2✔
100	}
101	if (props.appInfo) {	122!
102	this._setAppInfo(props.appInfo);	×
103	}
104	this._prepResources();	122✔
105	this._setApiKey(key);	122✔
106	this.errors = _Error;	122✔
107	this.webhooks = require('./Webhooks');	122✔
108	this._prevRequestMetrics = [];	122✔
109	this._enableTelemetry = props.telemetry !== false;	122✔
110	// Expose StripeResource on the instance too
111	this.StripeResource = Stripe.StripeResource;	122✔
112	}
113	Stripe.errors = _Error;	3✔
114	Stripe.webhooks = require('./Webhooks');	3✔
115	Stripe.createNodeHttpClient = (agent) => {	3✔
116	const {NodeHttpClient} = require('./net/NodeHttpClient');	134✔
117	return new NodeHttpClient(agent);	134✔
118	};
119	/**
120	* Creates an HTTP client for issuing Stripe API requests which uses the Web
121	* Fetch API.
122	*
123	* A fetch function can optionally be passed in as a parameter. If none is
124	* passed, will default to the default `fetch` function in the global scope.
125	*/
126	Stripe.createFetchHttpClient = (fetchFn) => {	3✔
127	const {FetchHttpClient} = require('./net/FetchHttpClient');	×
128	return new FetchHttpClient(fetchFn);	×
129	};
130	/**
131	* Create a CryptoProvider which uses the built-in Node crypto libraries for
132	* its crypto operations.
133	*/
134	Stripe.createNodeCryptoProvider = () => {	3✔
135	const NodeCryptoProvider = require('./crypto/NodeCryptoProvider');	×
136	return new NodeCryptoProvider();	×
137	};
138	/**
139	* Creates a CryptoProvider which uses the Subtle Crypto API from the Web
140	* Crypto API spec for its crypto operations.
141	*
142	* A SubtleCrypto interface can optionally be passed in as a parameter. If none
143	* is passed, will default to the default `crypto.subtle` object in the global
144	* scope.
145	*/
146	Stripe.createSubtleCryptoProvider = (subtleCrypto) => {	3✔
147	const SubtleCryptoProvider = require('./crypto/SubtleCryptoProvider');	×
148	return new SubtleCryptoProvider(subtleCrypto);	×
149	};
150	Stripe.prototype = {	3✔
151	/**
152	* @deprecated will be removed in a future major version. Use the config object instead:
153	*
154	* const stripe = new Stripe(API_KEY, {
155	* host: 'example.com',
156	* port: '8080',
157	* protocol: 'http',
158	* });
159	*
160	*/
161	setHost(host, port, protocol) {
162	emitWarning(	3✔
163	'`setHost` is deprecated. Use the `host` config option instead.'
164	);
165	this._setApiField('host', host);	3✔
166	if (port) {	3!
167	this.setPort(port);	3✔
168	}
169	if (protocol) {	3!
170	this.setProtocol(protocol);	3✔
171	}
172	},
173	/**
174	* @deprecated will be removed in a future major version. Use the config object instead:
175	*
176	* const stripe = new Stripe(API_KEY, {
177	* protocol: 'http',
178	* });
179	*
180	*/
181	setProtocol(protocol) {
182	emitWarning(	3✔
183	'`setProtocol` is deprecated. Use the `protocol` config option instead.'
184	);
185	this._setApiField('protocol', protocol.toLowerCase());	3✔
186	},
187	/**
188	* @deprecated will be removed in a future major version. Use the config object instead:
189	*
190	* const stripe = new Stripe(API_KEY, {
191	* port: 3000,
192	* });
193	*
194	*/
195	setPort(port) {
196	emitWarning(	3✔
197	'`setPort` is deprecated. Use the `port` config option instead.'
198	);
199	this._setApiField('port', port);	3✔
200	},
201	/**
202	* @deprecated will be removed in a future major version. Use the config object instead:
203	*
204	* const stripe = new Stripe(API_KEY, {
205	* apiVersion: API_VERSION,
206	* });
207	*
208	*/
209	setApiVersion(version) {
210	emitWarning(	8✔
211	'`setApiVersion` is deprecated. Use the `apiVersion` config or request option instead.'
212	);
213	if (version) {	8✔
214	this._setApiField('version', version);	5✔
215	}
216	},
217	/**
218	* @deprecated will be removed in a future major version. Use the config object instead:
219	*
220	* const stripe = new Stripe(API_KEY);
221	*
222	* Or, for Stripe Connect, use `stripeAccount` instead:
223	*
224	* const stripe = new Stripe(API_KEY, {
225	* stripeAccount: 'acct_...',
226	* });
227	*
228	* Or, to use a different apiKey on a given request:
229	*
230	* stripe.customers.create(params, {apiKey: 'sk_test_...'});
231	*/
232	setApiKey(key) {
233	emitWarning(	×
234	'`setApiKey` is deprecated. Use the `apiKey` request option instead.'
235	);
236	this._setApiKey(key);	×
237	},
238	/**
239	* @private
240	*/
241	_setApiKey(key) {
242	if (key) {	122!
243	this._setApiField('auth', `Bearer ${key}`);	122✔
244	}
245	},
246	/**
247	* @deprecated will be removed in a future major version. Use the config object instead:
248	*
249	* const stripe = new Stripe(API_KEY, {
250	* timeout: TIMEOUT_MS,
251	* });
252	*/
253	setTimeout(timeout) {
254	emitWarning(	3✔
255	'`setTimeout` is deprecated. Use the `timeout` config or request option instead.'
256	);
257	this._setApiField('timeout', timeout == null ? DEFAULT_TIMEOUT : timeout);	3✔
258	},
259	/**
260	* @deprecated will be removed in a future major version. Use the config object instead:
261	*
262	* const stripe = new Stripe(API_KEY, {
263	* appInfo: {
264	* name: 'MyPlugin',
265	* version: '1.4.2',
266	* url: 'https://myplugin.com',
267	* partner_id: '1234',
268	* },
269	* });
270	*/
271	setAppInfo(info) {
272	emitWarning(	11✔
273	'`setAppInfo` is deprecated. Use the `appInfo` config option instead.'
274	);
275	this._setAppInfo(info);	11✔
276	},
277	/**
278	* @private
279	* This may be removed in the future.
280	*/
281	_setAppInfo(info) {
282	if (info && typeof info !== 'object') {	11✔
283	throw new Error('AppInfo must be an object.');	1✔
284	}
285	if (info && !info.name) {	10✔
286	throw new Error('AppInfo.name is required');	3✔
287	}
288	info = info \|\| {};	7✔
289	const appInfo = APP_INFO_PROPERTIES.reduce((accum, prop) => {	7✔
290	if (typeof info[prop] == 'string') {	28✔
291	accum = accum \|\| {};	14✔
292	accum[prop] = info[prop];	14✔
293	}
294	return accum;	28✔
295	}, undefined);
296	this._appInfo = appInfo;	7✔
297	},
298	/**
299	* @deprecated will be removed in a future major version. Use the config object instead:
300	*
301	* const ProxyAgent = require('https-proxy-agent');
302	* const stripe = new Stripe(API_KEY, {
303	* httpAgent: new ProxyAgent(process.env.http_proxy),
304	* });
305	*
306	*/
307	setHttpAgent(agent) {
308	emitWarning(	×
309	'`setHttpAgent` is deprecated. Use the `httpAgent` config option instead.'
310	);
311	this._setApiField('agent', agent);	×
312	},
313	/**
314	* @private
315	* This may be removed in the future.
316	*/
317	_setApiField(key, value) {
318	this._api[key] = value;	217✔
319	},
320	/**
321	* @private
322	* Please open or upvote an issue at github.com/stripe/stripe-node
323	* if you use this, detailing your use-case.
324	*
325	* It may be deprecated and removed in the future.
326	*/
327	getApiField(key) {
328	return this._api[key];	16,741✔
329	},
330	setClientId(clientId) {
331	this._clientId = clientId;	7✔
332	},
333	getClientId() {
334	return this._clientId;	6✔
335	},
336	/**
337	* @private
338	* Please open or upvote an issue at github.com/stripe/stripe-node
339	* if you use this, detailing your use-case.
340	*
341	* It may be deprecated and removed in the future.
342	*/
343	getConstant: (c) => {
344	switch (c) {	530!
345	case 'DEFAULT_HOST':
346	return DEFAULT_HOST;	13✔
347	case 'DEFAULT_PORT':
348	return DEFAULT_PORT;	×
349	case 'DEFAULT_BASE_PATH':
350	return DEFAULT_BASE_PATH;	×
351	case 'DEFAULT_API_VERSION':
352	return DEFAULT_API_VERSION;	×
353	case 'DEFAULT_TIMEOUT':
354	return DEFAULT_TIMEOUT;	×
355	case 'MAX_NETWORK_RETRY_DELAY_SEC':
356	return MAX_NETWORK_RETRY_DELAY_SEC;	×
357	case 'INITIAL_NETWORK_RETRY_DELAY_SEC':
358	return INITIAL_NETWORK_RETRY_DELAY_SEC;	×
359	}
360	return Stripe[c];	517✔
361	},
362	getMaxNetworkRetries() {
363	return this.getApiField('maxNetworkRetries');	1,040✔
364	},
365	/**
366	* @deprecated will be removed in a future major version. Use the config object instead:
367	*
368	* const stripe = new Stripe(API_KEY, {
369	* maxNetworkRetries: 2,
370	* });
371	*
372	*/
373	setMaxNetworkRetries(maxNetworkRetries) {
374	this._setApiNumberField('maxNetworkRetries', maxNetworkRetries);	×
375	},
376	/**
377	* @private
378	* This may be removed in the future.
379	*/
380	_setApiNumberField(prop, n, defaultVal) {
381	const val = utils.validateInteger(prop, n, defaultVal);	80✔
382	this._setApiField(prop, val);	78✔
383	},
384	getMaxNetworkRetryDelay() {
385	return MAX_NETWORK_RETRY_DELAY_SEC;	20✔
386	},
387	getInitialNetworkRetryDelay() {
388	return INITIAL_NETWORK_RETRY_DELAY_SEC;	20✔
389	},
390	/**
391	* @private
392	*/
393	getUname(cb) {
394	if (!Stripe._UNAME_CACHE) {	523✔
395	Stripe._UNAME_CACHE = new Promise((resolve) => {	5✔
396	utils.safeExec('uname -a', (err, uname) => {	5✔
397	resolve(uname);	5✔
398	});
399	});
400	}
401	Stripe._UNAME_CACHE.then((uname) => cb(uname));	523✔
402	},
403	/**
404	* @private
405	* Please open or upvote an issue at github.com/stripe/stripe-node
406	* if you use this, detailing your use-case.
407	*
408	* It may be deprecated and removed in the future.
409	*
410	* Gets a JSON version of a User-Agent and uses a cached version for a slight
411	* speed advantage.
412	*/
413	getClientUserAgent(cb) {
414	return this.getClientUserAgentSeeded(Stripe.USER_AGENT, cb);	518✔
415	},
416	/**
417	* @private
418	* Please open or upvote an issue at github.com/stripe/stripe-node
419	* if you use this, detailing your use-case.
420	*
421	* It may be deprecated and removed in the future.
422	*
423	* Gets a JSON version of a User-Agent by encoding a seeded object and
424	* fetching a uname from the system.
425	*/
426	getClientUserAgentSeeded(seed, cb) {
427	this.getUname((uname) => {	523✔
428	const userAgent = {};	523✔
429	for (const field in seed) {	523✔
430	userAgent[field] = encodeURIComponent(seed[field]);	3,631✔
431	}
432	// URI-encode in case there are unusual characters in the system's uname.
433	userAgent.uname = encodeURIComponent(uname \|\| 'UNKNOWN');	523✔
434	const client = this.getApiField('httpClient');	523✔
435	if (client) {	523!
436	userAgent.httplib = encodeURIComponent(client.getClientName());	523✔
437	}
438	if (this._appInfo) {	523✔
439	userAgent.application = this._appInfo;	6✔
440	}
441	cb(JSON.stringify(userAgent));	523✔
442	});
443	},
444	/**
445	* @private
446	* Please open or upvote an issue at github.com/stripe/stripe-node
447	* if you use this, detailing your use-case.
448	*
449	* It may be deprecated and removed in the future.
450	*/
451	getAppInfoAsString() {
452	if (!this._appInfo) {	7✔
453	return '';	1✔
454	}
455	let formatted = this._appInfo.name;	6✔
456	if (this._appInfo.version) {	6!
457	formatted += `/${this._appInfo.version}`;	6✔
458	}
459	if (this._appInfo.url) {	6!
460	formatted += ` (${this._appInfo.url})`;	6✔
461	}
462	return formatted;	6✔
463	},
464	/**
465	* @deprecated will be removed in a future major version. Use the config object instead:
466	*
467	* const stripe = new Stripe(API_KEY, {
468	* telemetry: false,
469	* });
470	*
471	*/
472	setTelemetryEnabled(enableTelemetry) {
473	emitWarning(	3✔
474	'`setTelemetryEnabled` is deprecated. Use the `telemetry` config option instead.'
475	);
476	this._enableTelemetry = enableTelemetry;	3✔
477	},
478	getTelemetryEnabled() {
479	return this._enableTelemetry;	1,012✔
480	},
481	/**
482	* @private
483	* This may be removed in the future.
484	*/
485	_prepResources() {
486	for (const name in resources) {	122✔
487	this[utils.pascalToCamelCase(name)] = new resources[name](this);	7,320✔
488	}
489	},
490	/**
491	* @private
492	* This may be removed in the future.
493	*/
494	_getPropsFromConfig(config) {
495	// If config is null or undefined, just bail early with no props
496	if (!config) {	128✔
497	return {};	4✔
498	}
499	// config can be an object or a string
500	const isString = typeof config === 'string';	124✔
501	const isObject = config === Object(config) && !Array.isArray(config);	124✔
502	if (!isObject && !isString) {	124✔
503	throw new Error('Config must either be an object or a string');	2✔
504	}
505	// If config is a string, we assume the old behavior of passing in a string representation of the api version
506	if (isString) {	122✔
507	return {	5✔
508	apiVersion: config,
509	};
510	}
511	// If config is an object, we assume the new behavior and make sure it doesn't contain any unexpected values
512	const values = Object.keys(config).filter(	117✔
513	(value) => !ALLOWED_CONFIG_PROPERTIES.includes(value)	95✔
514	);
515	if (values.length > 0) {	117✔
516	throw new Error(	1✔
517	`Config object may only contain the following: ${ALLOWED_CONFIG_PROPERTIES.join(
518	', '
519	)}`
520	);
521	}
522	return config;	116✔
523	},
524	};
525	module.exports = Stripe;	3✔
526	// expose constructor as a named property to enable mocking with Sinon.JS
527	module.exports.Stripe = Stripe;	3✔
528	// Allow use with the TypeScript compiler without `esModuleInterop`.
529	// We may also want to add `Object.defineProperty(exports, "__esModule", {value: true});` in the future, so that Babel users will use the `default` version.
530	module.exports.default = Stripe;	3✔

stripe / stripe-node / #14

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