chore: update presignRequest to presign (#1020)

Author: trivikr

features/s3/step_definitions/objects.js

@@ -20,7 +20,7 @@ module.exports = function() {
       .then(request => {
         const expiration = new Date(Date.now() + 1 * 60 * 60 * 1000);
         signer
-          .presignRequest(request, expiration)
+          .presign(request, expiration)
           .then(data => {
             callback(null, formatUrl(data));
           })

packages/middleware-sdk-ec2/src/index.ts

@@ -62,7 +62,7 @@ export function copySnapshotPresignedUrlMiddleware(
         sha256: options.sha256,
         uriEscapePath: options.signingEscapePath
       });
-      const presignedRequest = await signer.presignRequest(
+      const presignedRequest = await signer.presign(
         request,
         expirationTime(3600)
       );

packages/middleware-sdk-rds/src/index.ts

@@ -97,7 +97,7 @@ export function crossRegionPresignedUrlMiddleware(
         sha256: options.sha256,
         uriEscapePath: options.signingEscapePath
       });
-      const presignedRequest = await signer.presignRequest(
+      const presignedRequest = await signer.presign(
         request,
         expirationTime(3600)
       );

packages/s3-request-presigner/README.md

@@ -18,7 +18,7 @@ const signer = new S3Presigner({
 });
 const Day = 24 * 60 * 60 * 1000;
 const expiration = new Date(Date.now() + 1 * Day);
-const url = signer.presignRequest(request, expiration);
+const url = signer.presign(request, expiration);
 ```
 
 Typescript Example:
@@ -34,7 +34,7 @@ const signer = new S3RequestPresigner({
 });
 const Day = 24 * 60 * 60 * 1000;
 const expiration = new Date(Date.now() + 1 * Day);
-const url = signer.presignRequest(request, expiration);
+const url = signer.presign(request, expiration);
 ```
 
 To avoid redundant construction parameters when instantiate the s3 presigner,

packages/s3-request-presigner/src/index.spec.ts

@@ -41,7 +41,7 @@ describe("s3 presigner", () => {
 
   it("should not double uri encode the path", async () => {
     const signer = new S3RequestPresigner(s3ResolvedConfig);
-    const signed = await signer.presignRequest(
+    const signed = await signer.presign(
       minimalRequest,
       expiration,
       presigningOptions
@@ -51,7 +51,7 @@ describe("s3 presigner", () => {
 
   it("should set the body digest to 'UNSIGNED_PAYLOAD'", async () => {
     const signer = new S3RequestPresigner(s3ResolvedConfig);
-    const signed = await signer.presignRequest(
+    const signed = await signer.presign(
       minimalRequest,
       expiration,
       presigningOptions
@@ -62,7 +62,7 @@ describe("s3 presigner", () => {
   it("should not change original request", async () => {
     const signer = new S3RequestPresigner(s3ResolvedConfig);
     const originalRequest = { ...minimalRequest };
-    const signed = await signer.presignRequest(
+    const signed = await signer.presign(
       minimalRequest,
       expiration,
       presigningOptions
@@ -87,7 +87,7 @@ describe("s3 presigner", () => {
         "Content-Type": "application/octet-stream"
       }
     };
-    const signed = await signer.presignRequest(
+    const signed = await signer.presign(
       requestWithContentTypeHeader,
       expiration,
       presigningOptions

packages/s3-request-presigner/src/index.ts

@@ -36,14 +36,14 @@ export class S3RequestPresigner implements RequestPresigner {
     this.signer = new SignatureV4(resolvedOptions);
   }
 
-  public async presignRequest(
+  public async presign(
     requestToSign: IHttpRequest,
     expiration: DateInput,
     { unsignableHeaders = new Set(), ...options }: RequestSigningArguments = {}
   ): Promise<IHttpRequest> {
     unsignableHeaders.add("content-type");
     requestToSign.headers[SHA256_HEADER] = UNSIGNED_PAYLOAD;
-    return this.signer.presignRequest(requestToSign, expiration, {
+    return this.signer.presign(requestToSign, expiration, {
       unsignableHeaders,
       ...options
     });

packages/signature-v4/src/SignatureV4.spec.ts

@@ -54,7 +54,7 @@ describe("SignatureV4", () => {
     };
 
     it("should sign requests without bodies", async () => {
-      const { query } = await signer.presignRequest(
+      const { query } = await signer.presign(
         minimalRequest,
         expiration,
         presigningOptions
@@ -71,7 +71,7 @@ describe("SignatureV4", () => {
     });
 
     it("should sign requests with string bodies", async () => {
-      const { query } = await signer.presignRequest(
+      const { query } = await signer.presign(
         new HttpRequest({
           ...minimalRequest,
           body: "It was the best of times, it was the worst of times"
@@ -91,7 +91,7 @@ describe("SignatureV4", () => {
     });
 
     it("should sign requests with binary bodies", async () => {
-      const { query } = await signer.presignRequest(
+      const { query } = await signer.presign(
         new HttpRequest({
           ...minimalRequest,
           body: new Uint8Array([0xde, 0xad, 0xbe, 0xef])
@@ -116,7 +116,7 @@ describe("SignatureV4", () => {
        */
       class ExoticStream {}
 
-      const { query } = await signer.presignRequest(
+      const { query } = await signer.presign(
         new HttpRequest({
           ...minimalRequest,
           body: new ExoticStream() as any
@@ -145,7 +145,7 @@ describe("SignatureV4", () => {
           sessionToken: "baz"
         }
       });
-      const { query } = await signer.presignRequest(
+      const { query } = await signer.presign(
         minimalRequest,
         expiration,
         presigningOptions
@@ -171,7 +171,7 @@ describe("SignatureV4", () => {
         credentials
       });
 
-      const { query } = await signer.presignRequest(
+      const { query } = await signer.presign(
         new HttpRequest({
           ...minimalRequest,
           body: new Uint8Array([0xde, 0xad, 0xbe, 0xef]),
@@ -202,7 +202,7 @@ describe("SignatureV4", () => {
         foo: "bar",
         "user-agent": "baz"
       };
-      const { headers: headersAsSigned, query } = await signer.presignRequest(
+      const { headers: headersAsSigned, query } = await signer.presign(
         new HttpRequest({
           ...minimalRequest,
           headers
@@ -219,7 +219,7 @@ describe("SignatureV4", () => {
 
     it("should return a rejected promise if the expiration is more than one week in the future", async () => {
       await expect(
-        signer.presignRequest(minimalRequest, new Date(), presigningOptions)
+        signer.presign(minimalRequest, new Date(), presigningOptions)
       ).rejects.toMatch(/less than one week in the future/);
     });
 
@@ -237,7 +237,7 @@ describe("SignatureV4", () => {
         credentials: credsProvider
       });
 
-      const { query } = await signer.presignRequest(
+      const { query } = await signer.presign(
         minimalRequest,
         expiration,
         presigningOptions
@@ -261,7 +261,7 @@ describe("SignatureV4", () => {
         }
       });
 
-      const { query } = await signer.presignRequest(
+      const { query } = await signer.presign(
         minimalRequest,
         expiration,
         presigningOptions
@@ -284,7 +284,7 @@ describe("SignatureV4", () => {
       });
 
       it("should URI-encode the path by default", async () => {
-        const { query = {} } = await signer.presignRequest(
+        const { query = {} } = await signer.presign(
           minimalRequest,
           expiration,
           presigningOptions
@@ -311,7 +311,7 @@ describe("SignatureV4", () => {
           uriEscapePath: false
         });
 
-        const { query = {} } = await signer.presignRequest(
+        const { query = {} } = await signer.presign(
           new HttpRequest({
             ...minimalRequest,
             path: "/foo/bar/baz",
@@ -661,7 +661,7 @@ describe("SignatureV4", () => {
 
     it("should use the current date for presigning if no signing date was supplied", async () => {
       const date = new Date();
-      const { query } = await signer.presignRequest(
+      const { query } = await signer.presign(
         minimalRequest,
         Math.floor((date.valueOf() + 60 * 60 * 1000) / 1000)
       );

packages/signature-v4/src/SignatureV4.ts

@@ -127,7 +127,7 @@ export class SignatureV4
     }
   }
 
-  public async presignRequest(
+  public async presign(
     originalRequest: HttpRequest,
     expiration: DateInput,
     options: RequestSigningArguments = {}

packages/types/src/signature.ts

@@ -51,7 +51,7 @@ export interface RequestPresigner {
    *                      longer be honored.
    * @param options       Additional signing options.
    */
-  presignRequest(
+  presign(
     requestToSign: HttpRequest,
     expiration: DateInput,
     options?: RequestSigningArguments