Merge pull request #88 from deepgram/require-ssl

Adding SSL options

Author: briancbarrow

src/billing.ts

@@ -4,6 +4,7 @@ export class Billing {
   constructor(
     private _credentials: string,
     private _apiUrl: string,
+    private _requireSSL: boolean,
     private _request: RequestFunction
   ) {}
 
@@ -18,6 +19,7 @@ export class Billing {
       "GET",
       this._credentials,
       this._apiUrl,
+      this._requireSSL,
       `${this.apiPath}/${projectId}/balances`
     );
   }
@@ -33,6 +35,7 @@ export class Billing {
       "GET",
       this._credentials,
       this._apiUrl,
+      this._requireSSL,
       `${this.apiPath}/${projectId}/balances/${balanceId}`
     );
   }

src/browser/httpFetch.ts

@@ -4,10 +4,12 @@ export async function _request<T>(
   method: string,
   api_key: string,
   apiUrl: string,
+  requireSSL: boolean,
   path: string,
   payload?: string
 ): Promise<T> {
-  const url = `https://${apiUrl}${path}`;
+  const protocol = requireSSL ? "https" : "http";
+  const url = `${protocol}://${apiUrl}${path}`;
   try {
     const response = await fetch(url, {
       method: method,

src/browser/index.ts

@@ -14,6 +14,7 @@ import { _request } from "./httpFetch";
 export class Deepgram {
   private _apiUrl: string;
   private _apiKey: string;
+  private _requireSSL: boolean;
 
   transcription: Transcriber;
   projects: Projects;
@@ -24,22 +25,23 @@ export class Deepgram {
   billing: Billing;
   scopes: Scopes;
 
-  constructor(apiKey: string, apiUrl?: string) {
+  constructor(apiKey: string, apiUrl?: string, requireSSL?: boolean) {
     this._apiKey = apiKey;
     this._apiUrl = apiUrl || DefaultOptions.apiUrl;
+    this._requireSSL = requireSSL || DefaultOptions.requireSSL;
 
     /**
      * Ensures that the provided options were provided
      */
     validateOptions(this._apiKey, this._apiUrl);
 
-    this.transcription = new Transcriber(this._apiKey, this._apiUrl);
-    this.projects = new Projects(this._apiKey, this._apiUrl, _request);
-    this.keys = new Keys(this._apiKey, this._apiUrl, _request);
-    this.usage = new Usage(this._apiKey, this._apiUrl, _request);
-    this.members = new Members(this._apiKey, this._apiUrl, _request);
-    this.invitation = new Invitation(this._apiKey, this._apiUrl, _request);
-    this.billing = new Billing(this._apiKey, this._apiUrl, _request);
-    this.scopes = new Scopes(this._apiKey, this._apiUrl, _request);
+    this.transcription = new Transcriber(this._apiKey, this._apiUrl, this._requireSSL);
+    this.projects = new Projects(this._apiKey, this._apiUrl, this._requireSSL, _request);
+    this.keys = new Keys(this._apiKey, this._apiUrl, this._requireSSL, _request);
+    this.usage = new Usage(this._apiKey, this._apiUrl, this._requireSSL, _request);
+    this.members = new Members(this._apiKey, this._apiUrl, this._requireSSL, _request);
+    this.invitation = new Invitation(this._apiKey, this._apiUrl, this._requireSSL, _request);
+    this.billing = new Billing(this._apiKey, this._apiUrl, this._requireSSL, _request);
+    this.scopes = new Scopes(this._apiKey, this._apiUrl, this._requireSSL, _request);
   }
 }

src/browser/transcription/index.ts

@@ -8,7 +8,7 @@ import querystring from "querystring";
 import { preRecordedTranscription } from "./preRecordedTranscription";
 
 export class Transcriber {
-  constructor(private _credentials: string, private _apiUrl: string) {}
+  constructor(private _credentials: string, private _apiUrl: string, private _requireSSL: boolean) { }
 
   /**
    * Transcribes prerecorded audio from a file or buffer
@@ -22,6 +22,7 @@ export class Transcriber {
     return await preRecordedTranscription(
       this._credentials,
       this._apiUrl || "",
+      this._requireSSL || true,
       source,
       options
     );
@@ -32,8 +33,10 @@ export class Transcriber {
    * @param options Options to modify transcriptions
    */
   live(options?: LiveTranscriptionOptions): WebSocket {
+    const protocol = this._requireSSL ? "wss" : "ws";
+
     return new WebSocket(
-      `wss://${this._apiUrl}/v1/listen?${querystring.stringify(options)}`,
+      `${protocol}://${this._apiUrl}/v1/listen?${querystring.stringify(options)}`,
       ["token", this._credentials]
     );
   }

src/browser/transcription/preRecordedTranscription.ts

@@ -15,12 +15,14 @@ function isUrlSource(providedSource: UrlSource): providedSource is UrlSource {
  * Transcribes audio from a url
  * @param credentials Base64 encoded API key & secret
  * @param apiUrl url string of Deepgram's API
+ * @param requireSSL Whether the request should use HTTPS or HTTP
  * @param source Url or Buffer of file to transcribe
  * @param options Options to modify transcriptions
  */
 export const preRecordedTranscription = async (
   apiKey: string,
   apiUrl: string,
+  requireSSL: boolean,
   source: UrlSource,
   options?: PrerecordedTranscriptionOptions
 ): Promise<PrerecordedTranscriptionResponse> => {
@@ -35,6 +37,7 @@ export const preRecordedTranscription = async (
     "POST",
     apiKey,
     apiUrl,
+    requireSSL,
     `/v1/listen?${querystring.stringify(transcriptionOptions)}`,
     body
   );

src/constants/defaultOptions.ts

@@ -3,4 +3,5 @@
  */
 export const DefaultOptions = {
   apiUrl: "api.deepgram.com",
+  requireSSL: true,
 };

src/httpRequest.ts

@@ -1,10 +1,12 @@
 import { Readable } from "stream";
-import { request, RequestOptions } from "https";
+import https, { RequestOptions } from "https";
+import http from "http";
 import { userAgent } from "./userAgent";
 
 const _requestOptions = (
-  api_key: string,
+  apiKey: string,
   apiUrl: string,
+  requireSSL: boolean,
   path: string,
   method: string,
   payload?: string | Buffer | Readable,
@@ -18,12 +20,13 @@ const _requestOptions = (
 
   const options = {
     host: apiUrl,
+    protocol: requireSSL ? "https" : "http",
     path,
     method,
     headers: {
       "User-Agent": userAgent(),
       "Content-Type": "application/json",
-      Authorization: `token ${api_key}`,
+      Authorization: `token ${apiKey}`,
       ...additionalHeaders,
     },
   };
@@ -37,24 +40,28 @@ const _requestOptions = (
 
 export function _request<T>(
   method: string,
-  api_key: string,
-  apiUrl: string,
+  apiKey: string,
+  apiURL: string,
+  requireSSL: boolean,
   path: string,
   payload?: string | Buffer | Readable,
   // eslint-disable-next-line @typescript-eslint/ban-types
   options?: Object
 ): Promise<T> {
   const requestOptions = _requestOptions(
-    api_key,
-    apiUrl,
+    apiKey,
+    apiURL,
+    requireSSL,
     path,
     method,
     payload,
     options
   );
   return new Promise((resolve, reject) => {
     try {
-      const httpRequest = request(requestOptions, (dgRes) => {
+      const httpClient = requireSSL ? https : http;
+
+      const httpRequest = httpClient.request(requestOptions, (dgRes) => {
         let dgResContent = "";
 
         dgRes.on("data", (chunk) => {

src/index.ts

@@ -10,9 +10,11 @@ import { Scopes } from "./scopes";
 
 import { validateOptions } from "./helpers";
 import { _request } from "./httpRequest";
+
 export class Deepgram {
   private _apiUrl: string;
   private _apiKey: string;
+  private _requireSSL: boolean;
 
   keys: Keys;
   projects: Projects;
@@ -23,22 +25,62 @@ export class Deepgram {
   billing: Billing;
   scopes: Scopes;
 
-  constructor(apiKey: string, apiUrl?: string) {
+  constructor(apiKey: string, apiUrl?: string, requireSSL?: boolean) {
     this._apiKey = apiKey;
     this._apiUrl = apiUrl || DefaultOptions.apiUrl;
+    this._requireSSL = requireSSL || DefaultOptions.requireSSL;
 
     /**
      * Ensures that the provided options were provided
      */
     validateOptions(this._apiKey, this._apiUrl);
 
-    this.keys = new Keys(this._apiKey, this._apiUrl, _request);
-    this.projects = new Projects(this._apiKey, this._apiUrl, _request);
-    this.transcription = new Transcriber(this._apiKey, this._apiUrl);
-    this.usage = new Usage(this._apiKey, this._apiUrl, _request);
-    this.members = new Members(this._apiKey, this._apiUrl, _request);
-    this.invitation = new Invitation(this._apiKey, this._apiUrl, _request);
-    this.billing = new Billing(this._apiKey, this._apiUrl, _request);
-    this.scopes = new Scopes(this._apiKey, this._apiUrl, _request);
+    this.keys = new Keys(
+      this._apiKey,
+      this._apiUrl,
+      this._requireSSL,
+      _request
+    );
+    this.projects = new Projects(
+      this._apiKey,
+      this._apiUrl,
+      this._requireSSL,
+      _request
+    );
+    this.transcription = new Transcriber(
+      this._apiKey,
+      this._apiUrl,
+      this._requireSSL
+    );
+    this.usage = new Usage(
+      this._apiKey,
+      this._apiUrl,
+      this._requireSSL,
+      _request
+    );
+    this.members = new Members(
+      this._apiKey,
+      this._apiUrl,
+      this._requireSSL,
+      _request
+    );
+    this.invitation = new Invitation(
+      this._apiKey,
+      this._apiUrl,
+      this._requireSSL,
+      _request
+    );
+    this.billing = new Billing(
+      this._apiKey,
+      this._apiUrl,
+      this._requireSSL,
+      _request
+    );
+    this.scopes = new Scopes(
+      this._apiKey,
+      this._apiUrl,
+      this._requireSSL,
+      _request
+    );
   }
 }

src/invitation.ts

@@ -9,6 +9,7 @@ export class Invitation {
   constructor(
     private _credentials: string,
     private _apiUrl: string,
+    private _requireSSL: boolean,
     private _request: RequestFunction
   ) {}
 
@@ -23,6 +24,7 @@ export class Invitation {
       "GET",
       this._credentials,
       this._apiUrl,
+      this._requireSSL,
       `${this.apiPath}/${projectId}/invites`
     );
   }
@@ -36,6 +38,7 @@ export class Invitation {
       "POST",
       this._credentials,
       this._apiUrl,
+      this._requireSSL,
       `${this.apiPath}/${projectId}/invites`,
       JSON.stringify({
         email: options.email,
@@ -53,6 +56,7 @@ export class Invitation {
       "DELETE",
       this._credentials,
       this._apiUrl,
+      this._requireSSL,
       `${this.apiPath}/${projectId}/leave`
     );
   }
@@ -68,6 +72,7 @@ export class Invitation {
       "DELETE",
       this._credentials,
       this._apiUrl,
+      this._requireSSL,
       `${this.apiPath}/${projectId}/invites/${email}`
     );
   }

src/keys.ts

@@ -10,6 +10,7 @@ export class Keys {
   constructor(
     private _credentials: string,
     private _apiUrl: string,
+    private _requireSSL: boolean,
     private _request: RequestFunction
   ) {}
 
@@ -24,6 +25,7 @@ export class Keys {
       "GET",
       this._credentials,
       this._apiUrl,
+      this._requireSSL,
       `${this.apiPath}/${projectId}/keys`
     );
 
@@ -47,6 +49,7 @@ export class Keys {
       "GET",
       this._credentials,
       this._apiUrl,
+      this._requireSSL,
       `${this.apiPath}/${projectId}/keys/${keyId}`
     );
   }
@@ -79,6 +82,7 @@ export class Keys {
       "POST",
       this._credentials,
       this._apiUrl,
+      this._requireSSL,
       `${this.apiPath}/${projectId}/keys`,
       JSON.stringify({
         comment,
@@ -103,6 +107,7 @@ export class Keys {
       "DELETE",
       this._credentials,
       this._apiUrl,
+      this._requireSSL,
       `${this.apiPath}/${projectId}/keys/${keyId}`
     );
   }