#3 Write docs

IlyaLisov · Feb 11, 2024 · 3316c33 · 3316c33
1 parent e04e875
commit 3316c33
Show file tree

Hide file tree

Showing 3 changed files with 154 additions and 57 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,148 @@
-# storage
-Storage library for Java applications.
+# Storage
+
+[![Lines-of-Code](https://tokei.rs/b1/github/ilyalisov/storage)](https://github.com/ilyalisov/storage)
+[![Hits-of-Code](https://hitsofcode.com/github/ilyalisov/storage?branch=master)](https://hitsofcode.com/github/ilyalisov/storage/view?branch=master)
+[![mvn](https://github.com/ilyalisov/storage/actions/workflows/maven-build.yml/badge.svg)](https://github.com/ilyalisov/storage/actions/workflows/maven-build.yml)
+
+[![codecov](https://codecov.io/gh/IlyaLisov/storage/graph/badge.svg?token=OJR6TFQ2qr)](https://codecov.io/gh/IlyaLisov/storage)
+
+This repository is an open-source Java library for fast and convenient storing
+and accessing data in your Java applications.
+
+Currently, we support MinIO and Firebase.
+
+## Content:
+
+* [How to use](#how-to-use)
+    * [Instantiate a service](#instantiate-a-service)
+    * [Save file](#save-file)
+    * [Delete file](#delete-file)
+    * [If file exists](#check-if-file-exists)
+    * [Get file](#get-file)
+* [How to contribute](#how-to-contribute)
+
+## How to use
+
+At first, you need to install this library.
+
+With Maven add dependency to your `pom.xml`.
+
+```xml
+<dependency>
+    <groupId>io.github.ilyalisov</groupId>
+    <artifactId>storage</artifactId>
+    <version>0.1.0</version>
+</dependency>
+```
+
+This library provides simple and convenient usage.
+
+### Instantiate a service
+
+You need to create `MinIOStorageService` object and pass login data for MinIO
+to the constructor.
+
+```java
+public class Main {
+    public static void main(String[] args) {
+        String host = "http://localhost:9000";
+        String rootUser = "rootUser";
+        String rootPassword = "rootPassword";
+        String bucket = "bucket";
+
+        StorageService storageService = new MinIOStorageServiceImpl(
+                host,
+                rootUser,
+                rootPassword,
+                bucket
+        );
+    }
+}
+```
+
+And for Firebase it is a bit different.
+
+```java
+public class Main {
+    public static void main(String[] args) {
+        InputStream inputStream = new ByteArrayInputStream(
+                System.getenv("FIREBASE_SECRET").getBytes()
+        );
+        String bucket = System.getenv("FIREBASE_BUCKET");
+
+        StorageService storageService = new FirebaseStorageServiceImpl(
+                inputStream,
+                bucket
+        );
+    }
+}
+```
+
+After, you can call available methods and use library.
+
+### Save file
+
+To save file just call method save. It will return path to saved file.
+
+```java
+public class Main {
+    public static void main(String[] args) {
+        StorageFile file = new StorageFile(
+                "fileName",
+                "text/plain",
+                new ByteArrayInputStream("...")
+        );
+
+        Path path = storageService.save(file);
+    }
+}
+```
+
+### Delete file
+
+You can delete file by its name, name and path, and you can delete entire folder
+by path.
+
+```java
+public class Main {
+    public static void main(String[] args) {
+        storageService.delete("file.txt");
+        storageService.delete("file.txt", Path.of("folder"));
+        storageService.delete(Path.of("folder"));
+    }
+}
+```
+
+### Check if file exists
+
+You can check whether file exists or not.
+
+```java
+public class Main {
+    public static void main(String[] args) {
+        boolean file1 = storageService.exists("file.txt");
+        boolean file2 = storageService.delete("file.txt", Path.of("folder"));
+    }
+}
+```
+
+### Get file
+
+You can get file from storage by calling corresponding methods.
+
+```java
+public class Main {
+    public static void main(String[] args) {
+        Optional<StorageFile> file = storageService.find("file.txt");
+        Optional<StorageFile> file2 = storageService.find("file.txt", Path.of("folder"));
+        List<StorageFile> files = storageService.findAll(
+                Path.of("folder"),
+                new Page(0, 10)
+        );
+    }
+}
+```
+
+## How to contribute
+
+See active issues at [issues page](https://github.com/ilyalisov/storage/issues)
diff --git a/src/main/java/io/github/ilyalisov/storage/service/FirebaseStorageServiceImpl.java b/src/main/java/io/github/ilyalisov/storage/service/FirebaseStorageServiceImpl.java
@@ -81,17 +81,7 @@ public Optional<StorageFile> find(
             final String fileName,
             final Path path
     ) {
-        Blob result = bucket.get(fileName(path, fileName));
-        if (result == null) {
-            return Optional.empty();
-        }
-        StorageFile file = new StorageFile(
-                fileName,
-                path,
-                result.getContentType(),
-                new ByteArrayInputStream(result.getContent())
-        );
-        return Optional.of(file);
+        return find(fileName(path, fileName));
     }
 
     @Override
@@ -132,7 +122,7 @@ public boolean exists(
             final String fileName,
             final Path path
     ) {
-        return bucket.get(fileName(path, fileName)) != null;
+        return exists(fileName(path, fileName));
     }
 
     @Override
@@ -166,10 +156,7 @@ public void delete(
             final String fileName,
             final Path path
     ) {
-        Blob file = bucket.get(fileName(path, fileName));
-        if (file != null) {
-            file.delete();
-        }
+        delete(fileName(path, fileName));
     }
 
     @Override

diff --git a/src/main/java/io/github/ilyalisov/storage/service/MinIOStorageServiceImpl.java b/src/main/java/io/github/ilyalisov/storage/service/MinIOStorageServiceImpl.java
@@ -115,28 +115,7 @@ public Optional<StorageFile> find(
             final String fileName,
             final Path path
     ) {
-        try (GetObjectResponse result = client.getObject(
-                GetObjectArgs.builder()
-                        .bucket(bucket)
-                        .object(fileName(path, fileName))
-                        .build()
-        )) {
-            StatObjectResponse stat = client.statObject(
-                    StatObjectArgs.builder()
-                            .bucket(bucket)
-                            .object(fileName(path, fileName))
-                            .build()
-            );
-            StorageFile file = new StorageFile(
-                    fileName,
-                    path,
-                    stat.contentType(),
-                    new ByteArrayInputStream(result.readAllBytes())
-            );
-            return Optional.of(file);
-        } catch (Exception e) {
-            return Optional.empty();
-        }
+        return find(fileName(path, fileName));
     }
 
     @Override
@@ -216,17 +195,7 @@ public boolean exists(
             final String fileName,
             final Path path
     ) {
-        try {
-            client.statObject(
-                    StatObjectArgs.builder()
-                            .bucket(bucket)
-                            .object(fileName(path, fileName))
-                            .build()
-            );
-            return true;
-        } catch (Exception e) {
-            return false;
-        }
+        return exists(fileName(path, fileName));
     }
 
     @Override
@@ -268,12 +237,7 @@ public void delete(
             final String fileName,
             final Path path
     ) {
-        client.removeObject(
-                RemoveObjectArgs.builder()
-                        .bucket(bucket)
-                        .object(fileName(path, fileName))
-                        .build()
-        );
+        delete(fileName(path, fileName));
     }
 
     @Override