Add helper-github-api package

Stefan Buck · Stefan Buck · commit a8d911bc7fe3 · 2019-02-02T23:09:29.000+01:00
diff --git a/packages/helper-github-api/__tests__/fetch-tree.js b/packages/helper-github-api/__tests__/fetch-tree.js
@@ -0,0 +1,85 @@
+import rateLimitNotification from '@octolinker/ratelimit-notification';
+import { get } from '@octolinker/helper-settings';
+import fetchTree from '../fetch-tree';
+
+jest.mock('@octolinker/ratelimit-notification', () => jest.fn());
+jest.mock('@octolinker/helper-settings', () => ({
+  get: jest.fn(),
+}));
+
+const response = JSON.stringify({
+  tree: [
+    { type: 'blob', path: 'foo.js' },
+    { type: 'tree', path: 'src' },
+    { type: 'blob', path: 'src/bar.js' },
+  ],
+});
+
+const options = {
+  user: 'octo',
+  repo: 'cat',
+  branch: 'tentacle',
+};
+
+describe('helper-github-api tree', () => {
+  beforeEach(() => {
+    fetch.resetMocks();
+  });
+
+  it('calls the github tree api', async () => {
+    fetch.mockResponseOnce(response);
+    await fetchTree(options);
+
+    expect(global.fetch).toBeCalledWith(
+      'https://api.github.com/repos/octo/cat/git/trees/tentacle?recursive=1',
+      {
+        method: 'GET',
+        headers: {
+          Accept: 'application/vnd.github.v3+json',
+        },
+      },
+    );
+  });
+
+  it('calls the github tree api with an api token', async () => {
+    fetch.mockResponseOnce(response);
+    get.mockReturnValue('fake-token');
+    await fetchTree(options);
+
+    expect(global.fetch).toBeCalledWith(
+      'https://api.github.com/repos/octo/cat/git/trees/tentacle?recursive=1',
+      {
+        method: 'GET',
+        headers: {
+          Accept: 'application/vnd.github.v3+json',
+          Authorization: 'token fake-token',
+        },
+      },
+    );
+  });
+
+  it('returns an empty array on failure', async () => {
+    fetch.mockResponseOnce(() => new Promise((resolve, reject) => reject()));
+
+    expect(await fetchTree(options)).toEqual([]);
+  });
+
+  it('calls rateLimitNotification on success', async () => {
+    const headers = new Headers();
+    headers.append('foo', 'bar');
+
+    fetch.mockResponseOnce(response, {
+      status: 201,
+      headers,
+    });
+    await fetchTree(options);
+
+    expect(rateLimitNotification).toBeCalledWith(headers, 201);
+  });
+
+  it('returns an array of files', async () => {
+    fetch.mockResponseOnce(response);
+
+    expect(await fetchTree(options)).toEqual(['foo.js', 'src/bar.js']);
+  });
+});
diff --git a/packages/helper-github-api/fetch-tree.js b/packages/helper-github-api/fetch-tree.js
@@ -0,0 +1,41 @@
+import * as storage from '@octolinker/helper-settings';
+import rateLimitNotification from '@octolinker/ratelimit-notification';
+
+export default async function({ user, repo, branch }) {
+  const token = storage.get('githubToken');
+
+  const headers = {
+    Accept: 'application/vnd.github.v3+json',
+  };
+
+  if (token) {
+    headers.Authorization = `token ${token}`;
+  }
+
+  let response;
+  try {
+    response = await fetch(
+      `https://api.github.com/repos/${user}/${repo}/git/trees/${branch}?recursive=1`,
+      {
+        method: 'GET',
+        headers,
+      },
+    );
+  } catch (error) {
+    console.error(error);
+  }
+
+  if (!response) return [];
+
+  rateLimitNotification(response.headers, response.status);
+
+  const json = await response.json();
+
+  if (!json.tree) {
+    return [];
+  }
+
+  return json.tree
+    .filter(({ type }) => type === 'blob')
+    .map(({ path }) => path);
+}
diff --git a/packages/helper-github-api/index.js b/packages/helper-github-api/index.js
@@ -0,0 +1,3 @@
+import fetchTree from './fetch-tree';
+
+export { fetchTree };
diff --git a/packages/helper-github-api/package.json b/packages/helper-github-api/package.json
@@ -0,0 +1,12 @@
+{
+  "name": "@octolinker/helper-github-api",
+  "version": "1.0.0",
+  "description": "",
+  "repository": "https://github.com/octolinker/octolinker/tree/master/packages/helper-github-api",
+  "license": "MIT",
+  "main": "./index.js",
+  "dependencies": {
+    "@octolinker/helper-settings": "1.0.0",
+    "@octolinker/ratelimit-notification": "1.0.0"
+  }
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+import fetchTree from './fetch-tree';`
	`2`	`+`
	`3`	`+export { fetchTree };`