Implemented GET method to service and added badges to README. Close #2

Author: thebug404

README.md

@@ -1,6 +1,8 @@
 # filesrocket-amazons3
 
-[Filesrocket](https://github.com/filesrocket/filesrocket) service to manage your files with [Amazon S3](https://aws.amazon.com/s3) services.
+[![npm version](https://badge.fury.io/js/filesrocket-amazons3.svg)](https://badge.fury.io/js/filesrocket-amazons3) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+
+[**Filesrocket**](https://github.com/filesrocket/filesrocket) service to manage your files with [**Amazon S3**](https://aws.amazon.com/s3)
 
 ## Install
 
@@ -22,7 +24,7 @@ const filesrocket = new Filesrocket();
 // Setting service
 const amazons3 = new AmazonS3FileService({
   Pagination: { default: 15, max: 50 },
-  Bucket: "filesrocket",
+  Bucket: "<Your Bucket>",
   region: "<Your Region>",
   credentials: {
     accessKeyId: "<Your ACCESS_KEY>",

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "filesrocket-amazons3",
-  "version": "0.0.3",
-  "description": "Filerocket service to manage files from Amazon Storage S3 service",
+  "version": "0.0.4",
+  "description": "Filerocket service to manage files from Amazon Storage S3",
   "main": "lib/index.js",
   "types": "lib",
   "author": {
@@ -18,9 +18,9 @@
     "lib": "lib"
   },
   "files": [
-    "LICENCE",
+    "lib/**",
     "README.md",
-    "lib/**"
+    "LICENCE"
   ],
   "keywords": [
     "upload",
@@ -32,15 +32,15 @@
   ],
   "license": "MIT",
   "scripts": {
-    "build": "npm run test && npm run lint && tsc -p .",
+    "build": "npm run lint && npm run test && tsc -p .",
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint --fix . --ext .ts",
     "test": "jest",
     "test:w": "npm run test -- --watch"
   },
   "dependencies": {
     "aws-sdk": "2.1012.0",
-    "filesrocket": "^0.0.4"
+    "filesrocket": "^0.0.6"
   },
   "devDependencies": {
     "@types/jest": "^27.0.3",

package.json

@@ -65,25 +65,47 @@ export class FileService extends BaseAmazonRocket implements ServiceMethods {
       .promise()
 
     data.Contents = data.Contents?.map((item) => {
-      const Bucket = query.Bucket || this.options.Bucket
       const Key = item.Key
       return this.builder(item, { Bucket, Key }) as any
     })
 
     return this.paginate(data)
   }
 
-  async remove (id: string, query: Query = {}): Promise<OutputEntity> {
-    const data = await this.list({ path: id })
+  async get (id: string, query: Query = {}): Promise<OutputEntity> {
+    const partialQuery = omitProps(query, ['path'])
+
+    const Bucket = query.Bucket || this.options.Bucket
 
-    if (!data.items.length) {
-      throw new NotFound('File does not exist')
+    const payload = {
+      ...partialQuery,
+      Prefix: id,
+      Bucket
     }
 
+    const { Contents = [] } = await this.s3
+      .listObjectsV2(payload)
+      .promise()
+
+    const items = Contents.map(item => {
+      const Key = item.Key
+      return this.builder(item, { Bucket, Key })
+    })
+
+    const file = items.at(0)
+
+    if (!file) throw new NotFound('File does not exist')
+
+    return file
+  }
+
+  async remove (id: string, query: Query = {}): Promise<OutputEntity> {
+    const file = await this.get(id, query)
+
     const Bucket = query.Bucket || this.options.Bucket
-    const file = data.items[0]
+    const payload = { ...query, Bucket, Key: id }
 
-    await this.s3.deleteObject({ ...query, Bucket, Key: id }).promise()
+    await this.s3.deleteObject(payload).promise()
 
     return file
   }

src/services/file.service.ts

@@ -2,11 +2,11 @@ import { Paginated, OutputEntity } from 'filesrocket'
 import { resolve } from 'path'
 
 import {
-  uploadFile,
-  uploadManyFiles,
-  getFiles,
-  deleteOneFile,
-  deleteManyFiles
+  uploadOne,
+  uploadMany,
+  findOne,
+  find,
+  remove
 } from './helpers/file.helper'
 
 jest.mock('filesrocket')
@@ -34,59 +34,81 @@ describe('Uploading files', () => {
   const path: string = `test/fixtures/${name}`
 
   test('Upload many files', async () => {
-    const results = await uploadManyFiles(paths)
+    const results = await uploadMany(paths)
     expect(results).toHaveLength(paths.length)
   })
 
   test('Upload single file', async () => {
-    const entity = await uploadFile(path)
+    const entity = await uploadOne(path)
     expect(typeof entity).toBe('object')
     expect(entity.name).toBe(name)
   })
 
   test('Upload many files in a directory', async () => {
-    const items = await uploadManyFiles(paths, { path: DIRECTORY_NAME })
+    const items = await uploadMany(paths, { path: DIRECTORY_NAME })
     expect(items).toHaveLength(FILESNAMES.length)
   })
 })
 
 describe('Getting files', () => {
   test('Gets 3 files', async () => {
     const SIZE: number = 3
-    const data: Paginated<OutputEntity> = await getFiles({ size: SIZE })
+
+    const data: Paginated<OutputEntity> = await find({ size: SIZE })
+
     expect(data.items).toHaveLength(SIZE)
   })
 
   test('Get files from a directory', async () => {
-    const data = await getFiles({ path: DIRECTORY_NAME })
+    const data = await find({ path: DIRECTORY_NAME })
+
     expect(data.items).toHaveLength(FILESNAMES.length)
   })
+
+  test('Get one file', async () => {
+    const data = await find({ size: 1 })
+
+    const entity = data.items.at(0)
+
+    const file = await findOne(entity?.id || '')
+
+    expect(file).toBeTruthy()
+    expect(file.name).toBe(entity?.name)
+  })
+
+  test('Get file does not exist', async () => {
+    await expect(findOne('random.jpg'))
+      .rejects
+      .toThrowError('File does not exist')
+  })
 })
 
 describe('Deleting files', () => {
   test('Delete 1 file', async () => {
-    const data: Paginated<OutputEntity> = await getFiles({ size: 1 })
+    const data: Paginated<OutputEntity> = await find({ size: 1 })
     const file: OutputEntity = data.items[0]
 
-    const entity: OutputEntity = await deleteOneFile(file.id)
-    expect(file.name).toBe(entity.name)
-  })
+    const entities: OutputEntity[] = await remove([file.id])
+    const entity = entities.at(0)
 
-  test('Delete many files', async () => {
-    const data = await getFiles()
-
-    const keys: string[] = data.items.map(item => item.id)
-    const items = await deleteManyFiles(keys)
-
-    expect(items).toHaveLength(data.items.length)
+    expect(file.name).toBe(entity?.name)
   })
 
   test('Delete files from a directory', async () => {
-    const data = await getFiles({ path: DIRECTORY_NAME })
+    const data = await find({ path: DIRECTORY_NAME })
 
     const keys: string[] = data.items.map(item => item.Key)
-    const items = await deleteManyFiles(keys)
+    const items = await remove(keys)
 
     expect(items).toHaveLength(keys.length)
   })
+
+  test('Delete many files', async () => {
+    const data = await find()
+
+    const keys: string[] = data.items.map(item => item.id)
+    const items = await remove(keys)
+
+    expect(items).toHaveLength(data.items.length)
+  })
 })

test/file.service.spec.ts

@@ -4,7 +4,7 @@ import { parse } from 'path'
 
 import service from '../config/amazon'
 
-export async function uploadFile (
+export async function uploadOne (
   path: string,
   query: Query = {}
 ): Promise<Partial<OutputEntity>> {
@@ -21,27 +21,29 @@ export async function uploadFile (
   return service.create(data, query)
 }
 
-export async function uploadManyFiles (
+export async function uploadMany (
   paths: string[],
   query: Query = {}
 ): Promise<Partial<OutputEntity>[]> {
-  return Promise.all(paths.map(path => uploadFile(path, query)))
+  return Promise.all(
+    paths.map(path => uploadOne(path, query))
+  )
 }
 
-export async function getFiles (
+export function findOne (id: string): Promise<OutputEntity> {
+  return service.get(id)
+}
+
+export async function find (
   query: Query = {}
 ): Promise<Paginated<OutputEntity>> {
   return service.list(query)
 }
 
-export async function deleteOneFile (
-  key: string
-): Promise<OutputEntity> {
-  return service.remove(key)
-}
-
-export async function deleteManyFiles (
+export async function remove (
   keys: string[]
 ): Promise<OutputEntity[]> {
-  return Promise.all(keys.map(key => deleteOneFile(key)))
+  return Promise.all(
+    keys.map(key => service.remove(key))
+  )
 }

test/helpers/file.helper.ts

@@ -22,9 +22,6 @@
     "strictFunctionTypes": true,                            /* Ensure 'use strict' is always emitted. */
     "noUnusedLocals": true,                           /* Enable error reporting when a local variables aren't read. */
     "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
-    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */,
-
-    /* Experimental */
-    "experimentalDecorators": true
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
   }
 }