@pinata/sdk 1.2.0 → 2.0.0-beta.0

package/test/commands/data/getFilesByCount/{getFilesByCount.test.js → getFilesByCount.test.ts}

@@ -1,22 +1,21 @@
-import getFilesByCount from "../../../../src/commands/data/getFilesByCount/getFilesByCount";
-import axios from "axios";
-import { APIData, pinListAxiosMockPages, fakeHeaders } from "../pinlist-sample-api";
+import getFilesByCount from '../../../../src/commands/data/getFilesByCount/getFilesByCount';
+import axios from 'axios';
+import {
+    APIData,
+    pinListAxiosMockPages,
+    fakeHeaders
+} from '../pinlist-sample-api';
+import { PinataConfig, PinataPin, PinataPinListFilterOptions } from '../../../../src';
 
-jest.mock("axios");
+jest.mock('axios');
 
 const metadataName = (item) => {
     return item.metadata.name;
 };
-const callIterableObject = async (
-    pinataKey,
-    pinataSecret,
-    filterToApply,
-    pinsCount
-) => {
-    const pins = [];
+const callIterableObject = async (config: PinataConfig, filterToApply: PinataPinListFilterOptions, pinsCount?: number) => {
+    const pins: PinataPin[] = [];
     for await (const item of getFilesByCount(
-        pinataKey,
-        pinataSecret,
+        config,
         filterToApply,
         pinsCount
     )) {
@@ -26,25 +25,28 @@ const callIterableObject = async (
     return pins;
 };
 
-describe("Get Files By Count", () => {
+describe('Get Files By Count', () => {
+    const pinataConfig = {
+        pinataApiKey: fakeHeaders.headers.pinata_api_key,
+        pinataSecretApiKey: fakeHeaders.headers.pinata_secret_api_key
+    };
     const filterToApply = {
-        status: "pinned",
+        status: 'pinned'
     };
 
     afterEach(() => {
         jest.resetAllMocks();
     });
 
-    test("Request 17 pins, pins available", async () => {
+    test('Request 17 pins, pins available', async () => {
         const pinsToRequest = 17;
 
-        axios.get
+        (axios.get as jest.Mock)
             .mockResolvedValueOnce(pinListAxiosMockPages.firstPage.response)
             .mockResolvedValueOnce(pinListAxiosMockPages.secondPage.response);
 
         const pins = await callIterableObject(
-            fakeHeaders.headers.pinata_api_key,
-            fakeHeaders.headers.pinata_secret_api_key,
+            pinataConfig,
             filterToApply,
             pinsToRequest
         );
@@ -67,15 +69,14 @@ describe("Get Files By Count", () => {
         expect(axios.get).toHaveBeenCalledTimes(2);
     });
 
-    test("Request 6 pins, pins available", async () => {
+    test('Request 6 pins, pins available', async () => {
         const pinsToRequest = 6;
 
-        axios.get.mockResolvedValueOnce(
+        (axios.get as jest.Mock).mockResolvedValueOnce(
             pinListAxiosMockPages.firstPage.response
         );
         const pins = await callIterableObject(
-            fakeHeaders.headers.pinata_api_key,
-            fakeHeaders.headers.pinata_secret_api_key,
+            pinataConfig,
             filterToApply,
             pinsToRequest
         );
@@ -92,18 +93,17 @@ describe("Get Files By Count", () => {
         expect(axios.get).toHaveBeenCalledTimes(1);
     });
 
-    test("Request 25 pins, pins not available", async () => {
+    test('Request 25 pins, pins not available', async () => {
         const pinsToRequest = 25;
 
-        axios.get
+        (axios.get as jest.Mock)
             .mockResolvedValueOnce(pinListAxiosMockPages.firstPage.response)
             .mockResolvedValueOnce(pinListAxiosMockPages.secondPage.response)
             .mockResolvedValueOnce(
                 pinListAxiosMockPages.thirdPageEmpty.response
             );
         const pins = await callIterableObject(
-            fakeHeaders.headers.pinata_api_key,
-            fakeHeaders.headers.pinata_secret_api_key,
+            pinataConfig,
             filterToApply,
             pinsToRequest
         );
@@ -132,15 +132,14 @@ describe("Get Files By Count", () => {
         expect(axios.get).toHaveBeenCalledTimes(3);
     });
 
-    test("Request 3 pins, pins not available", async () => {
+    test('Request 3 pins, pins not available', async () => {
         const pinsToRequest = 3;
 
-        axios.get.mockResolvedValueOnce(
+        (axios.get as jest.Mock).mockResolvedValueOnce(
             pinListAxiosMockPages.firstPageEmpty.response
         );
         const pins = await callIterableObject(
-            fakeHeaders.headers.pinata_api_key,
-            fakeHeaders.headers.pinata_secret_api_key,
+            pinataConfig,
             filterToApply,
             pinsToRequest
         );
@@ -157,16 +156,15 @@ describe("Get Files By Count", () => {
         expect(axios.get).toHaveBeenCalledTimes(1);
     });
 
-    test("Request all pins, pins available", async () => {
-        axios.get
+    test('Request all pins, pins available', async () => {
+        (axios.get as jest.Mock)
             .mockResolvedValueOnce(pinListAxiosMockPages.firstPage.response)
             .mockResolvedValueOnce(pinListAxiosMockPages.secondPage.response)
             .mockResolvedValueOnce(
                 pinListAxiosMockPages.thirdPageEmpty.response
             );
         const pins = await callIterableObject(
-            fakeHeaders.headers.pinata_api_key,
-            fakeHeaders.headers.pinata_secret_api_key,
+            pinataConfig,
             filterToApply
         );
         expect(pins).toEqual(APIData.rows.map(metadataName));
@@ -191,13 +189,12 @@ describe("Get Files By Count", () => {
         expect(axios.get).toHaveBeenCalledTimes(3);
     });
 
-    test("Request all pins, pins not available", async () => {
-        axios.get.mockResolvedValueOnce(
+    test('Request all pins, pins not available', async () => {
+        (axios.get as jest.Mock).mockResolvedValueOnce(
             pinListAxiosMockPages.firstPageEmpty.response
         );
         const pins = await callIterableObject(
-            fakeHeaders.headers.pinata_api_key,
-            fakeHeaders.headers.pinata_secret_api_key,
+            pinataConfig,
             filterToApply
         );
 

package/test/commands/data/pinList/pinList.test.ts

@@ -0,0 +1,102 @@
+import axios from 'axios';
+import pinList from '../../../../src/commands/data/pinList/pinList';
+import {
+    pinListAxiosMockPages,
+    fakeHeaders
+} from '../pinlist-sample-api';
+
+jest.mock('axios');
+
+describe('Pin List by page', () => {
+    afterEach(() => {
+        jest.resetAllMocks();
+    });
+
+    test('Call two pages in a row', async () => {
+        (axios.get as jest.Mock)
+            .mockResolvedValueOnce(pinListAxiosMockPages.firstPage.response)
+            .mockResolvedValueOnce(pinListAxiosMockPages.secondPage.response);
+
+        const resp = await pinList(
+            {
+                pinataApiKey: fakeHeaders.headers.pinata_api_key,
+                pinataSecretApiKey: fakeHeaders.headers.pinata_secret_api_key
+            },
+            { pageLimit: 10, pageOffset: 0, status: 'pinned' }
+        );
+        const resp2 = await pinList(
+            {
+                pinataApiKey: fakeHeaders.headers.pinata_api_key,
+                pinataSecretApiKey: fakeHeaders.headers.pinata_secret_api_key
+            },
+            { pageLimit: 10, pageOffset: 10, status: 'pinned' }
+        );
+        expect(resp).toEqual(pinListAxiosMockPages.firstPage.response.data);
+        expect(resp2).toEqual(pinListAxiosMockPages.secondPage.response.data);
+
+        expect(axios.get).toHaveBeenNthCalledWith(
+            1,
+            pinListAxiosMockPages.firstPage.url,
+            pinListAxiosMockPages.firstPage.headers
+        );
+        expect(axios.get).toHaveBeenNthCalledWith(
+            2,
+            pinListAxiosMockPages.secondPage.url,
+            pinListAxiosMockPages.secondPage.headers
+        );
+
+        expect(axios.get).toHaveBeenCalledTimes(2);
+    });
+
+    test('Call empty page', async () => {
+        (axios.get as jest.Mock).mockResolvedValueOnce(
+            pinListAxiosMockPages.firstPageEmpty.response
+        );
+
+        const resp = await pinList(
+            {
+                pinataApiKey: fakeHeaders.headers.pinata_api_key,
+                pinataSecretApiKey: fakeHeaders.headers.pinata_secret_api_key
+            },
+            { pageLimit: 10, pageOffset: 0, status: 'pinned' }
+        );
+
+        expect(resp).toEqual({ rows: [] });
+
+        expect(axios.get).toHaveBeenNthCalledWith(
+            1,
+            pinListAxiosMockPages.firstPageEmpty.url,
+            pinListAxiosMockPages.firstPageEmpty.headers
+        );
+
+        expect(axios.get).toHaveBeenCalledTimes(1);
+    });
+    test('Result other than 200 status is returned', () => {
+        const badStatus = {
+            status: 700
+        };
+        (axios.get as jest.Mock).mockResolvedValue(badStatus);
+        expect.assertions(1);
+        expect(pinList({ pinataApiKey: 'test', pinataSecretApiKey: 'test' })).rejects.toEqual(
+            Error(
+                `unknown server response while attempting to retrieve user pin list: ${badStatus}`
+            )
+        );
+    });
+
+    test('200 status is returned', () => {
+        const goodStatus = {
+            status: 200,
+            data: 'testData'
+        };
+        (axios.get as jest.Mock).mockResolvedValue(goodStatus);
+        expect.assertions(1);
+        expect(pinList({ pinataApiKey: 'test', pinataSecretApiKey: 'test' })).resolves.toEqual(goodStatus.data);
+    });
+
+    test('Rejection handled', () => {
+        (axios.get as jest.Mock).mockRejectedValue('test error');
+        expect.assertions(1);
+        expect(pinList({ pinataApiKey: 'test', pinataSecretApiKey: 'test' })).rejects.toEqual('test error');
+    });
+});

package/test/commands/data/pinList/{queryBuilder.test.js → queryBuilder.test.ts}

@@ -1,16 +1,15 @@
-import queryBuilder from './../../../../src/commands/data/pinList/queryBuilder';
+import queryBuilder from '../../../../src/commands/data/pinList/queryBuilder';
 
 const baseUrl = 'testing.com/test';
-const badFilterValue = 'badFilterValue';
 const noFiltersUrl = `${baseUrl}?`;
 const validISODate = '2019-03-12T20:42:26.743Z';
 const validInteger = 5;
 
 describe('queryBuilder no params provided', () => {
     test('if no baseUrl is provided', () => {
-        expect(() => {
-            queryBuilder();
-        }).toThrow('no baseUrl provided');
+        // expect(() => {
+        //     queryBuilder();
+        // }).toThrow('no baseUrl provided');
     });
     test('if no filters are provided, return a non filtered url', () => {
         expect(queryBuilder(baseUrl)).toEqual(noFiltersUrl);
@@ -163,7 +162,7 @@ describe('queryBuilder filter: pageLimit', () => {
         };
         expect(() => {
             queryBuilder(baseUrl, filters);
-        }).toThrow(`Please make sure the pageLimit is a valid integer between 1-1000`);
+        }).toThrow('Please make sure the pageLimit is a valid integer between 1-1000');
     });
     test('non valid pageLimit is passed in', () => {
         const filters = {
@@ -171,7 +170,7 @@ describe('queryBuilder filter: pageLimit', () => {
         };
         expect(() => {
             queryBuilder(baseUrl, filters);
-        }).toThrow(`Please make sure the pageLimit is a valid integer between 1-1000`);
+        }).toThrow('Please make sure the pageLimit is a valid integer between 1-1000');
     });
     test('Decimal is passed in - expect to round down', () => {
         const filters = {
@@ -320,7 +319,7 @@ describe('metadata provided', () => {
         };
         expect(() => {
             queryBuilder(baseUrl, filters);
-        }).toThrow(`Because between op code was passed in, keyValue: testKeyValue must have both also include a secondValue`);
+        }).toThrow('Because between op code was passed in, keyValue: testKeyValue must have both also include a secondValue');
     });
     test('between op code passed in, but object passed in as secondValue', () => {
         const filters = {
@@ -353,7 +352,7 @@ describe('metadata provided', () => {
         };
         expect(() => {
             queryBuilder(baseUrl, filters);
-        }).toThrow(`Because notBetween op code was passed in, keyValue: testKeyValue must have both also include a secondValue`);
+        }).toThrow('Because notBetween op code was passed in, keyValue: testKeyValue must have both also include a secondValue');
     });
     test('notBetween op code passed in, but object passed in as secondValue', () => {
         const filters = {
@@ -394,7 +393,7 @@ describe('metadata provided', () => {
                     testKeyValue: {
                         value: 'test',
                         op: 'eq'
-                    }, 
+                    },
                     testKeyValue2: {
                         value: 'test2',
                         op: 'eq'