Media Manager class implementation

.env.sample

@@ -0,0 +1,12 @@
+# Integration test.
+#
+# Note that all files in the specified bucket with prefix will
+# be deleted on every integration test run.
+#
+
+# The whole JSON file content. Example:
+# CREDENTIALS_JSON={"type": "service_account", "project_id": "...", ...}
+CREDENTIALS_JSON=
+
+BUCKET_NAME=
+PREFIX=

.github/workflows/main.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        node: ['18.x']
+        node: ['16.x']
         os: [ubuntu-latest]
 
     steps:
@@ -27,6 +27,10 @@ jobs:
 
       - name: Test
         run: npm run test -- --ci --coverage --maxWorkers=2
+        env:
+          CREDENTIALS_JSON: ${{ secrets.CREDENTIALS_JSON }}
+          BUCKET_NAME: ${{ secrets.BUCKET_NAME }}
+          PREFIX: github/
 
       - name: Build
         run: npm run build

.gitignore

@@ -2,4 +2,5 @@
 .DS_Store
 node_modules
 dist
-coverage
+coverage
+.env

README.md

@@ -4,6 +4,44 @@
 
 Design: https://g0v.hackmd.io/@mrorz/cofacts-media-manager
 
+## Usage
+
+```js
+import MediaManager from '@cofacts/media-manager';
+
+// Setup
+const manager = new MediaManager({
+  credentialsJSON: process.env.GCS_CREDENTIALS,
+  bucketName: process.env.GCS_BUCKET_NAME,
+
+  // The prefix of where files are put.
+  // Trailing `/` is REQUIRED if you want files to be put in a "directory" on GCS web console. Otherwise, root directories will just have specified prefix in its front.
+  // If not given, files will be placed right insight the bucket.
+  prefix: 'some-dir/'
+});
+
+// Search
+const { hits } = await manager.query({url: 'https://......'});
+
+// Upload and index
+const { id, url } = await manager.insert({url: 'https://......'});
+```
+
+### Install
+
+Install cofacts/media-manager via npm:
+
+```
+npm i @cofacts/media-manager
+```
+
+### Service account permission
+The service account should have the following [permissions](https://cloud.google.com/storage/docs/access-control/iam-roles) to the bucket:
+- `storage.objects.list`
+- `storage.objects.create`
+- `storage.objects.get`
+- `storage.objects.delete`
+
 ## Development
 
 This project uses npm and Node.JS. Please use the Node.JS version specified in `engines` in `package.json`.
@@ -39,3 +77,16 @@ Use `npm run lint` to perform lint.
 ### Bundle Analysis
 
 [`size-limit`](https://github.com/ai/size-limit) is set up to calculate the real cost of media-manager with `npm run size` and visualize the bundle with `npm run analyze`.
+
+### Integration tests
+
+Real integration tests are enabled if correct environment variables are provided.
+Copy `.env.sample` to `.env` to get started.
+
+If the environment variables are provided in `.env`, running `npm t` will also trigger an integration test, which will:
+
+1. Cleanup files with `PREFIX` in `BUCKET` specified by `.env`
+2. Start a static file server that serves files under `test/fixtures`
+3. Instantiate `MediaManager` that connects to GCS using credentials provided in `.env`
+4. Perform query & insertion on live Google Cloud Storage
+