Merge pull request #8 from dragonflydb/joezhou/ad-server-bun-paths

feat(example): ad server update routes and README

Author: Niennienzz

ad-server-cache-bun/README.md

@@ -1,5 +1,8 @@
 # Example: Ad Server using Bun, ElysiaJS, and Dragonfly
 
+In this example, we will build a real-time ad server API using Bun, ElysiaJS, and Dragonfly.
+In terms of data types, we use `Hash` to store ad metadata and `Set` to store ad categories and user preferences.
+
 ## Packages Used
 
 - [ElysiaJS](https://elysiajs.com/) is a TypeScript framework supercharged by the [Bun](https://bun.sh/) runtime with end-to-end type safety.
@@ -28,3 +31,39 @@ bun run dev # (or `bun dev`)
 ```
 
 - The ad server API would be running on `http://localhost:3000/`
+
+## Interact with the Ad Server API
+
+- Create ad metadata with the following request:
+
+```shell
+curl --request POST \
+  --url http://localhost:3888/ads \
+  --header 'Content-Type: application/json' \
+  --data '{
+	"id": "1",
+	"title": "Dragonfly - a data store built for modern workloads",
+	"category": "technology",
+	"clickURL": "https://www.dragonflydb.io/",
+	"imageURL": "https://www.dragonflydb.io/blog"
+}'
+```
+
+- Create or update user preferences with the following request:
+
+```shell
+curl --request POST \
+  --url http://localhost:3888/ads/user_preferences \
+  --header 'Content-Type: application/json' \
+  --data '{
+	"userId": "1",
+	"categories": ["technology", "sports"]
+}'
+```
+
+- Retrieve ads for a specific user with the following request:
+
+```shell
+curl --request GET \
+  --url http://localhost:3888/ads/user_preferences/1
+```

ad-server-cache-bun/src/ads.ts

@@ -15,15 +15,15 @@ export class AdMetadataStore {
         this.client = client;
     }
 
-    metadataKey(metadataId: string): string {
+    private metadataKey(metadataId: string): string {
         return `${AdMetadataStore.AD_METADATA_PREFIX}:${metadataId}`;
     }
 
-    categoryKey(metadataCategory: string): string {
+    private categoryKey(metadataCategory: string): string {
         return `${AdMetadataStore.AD_CATEGORY_PREFIX}:${metadataCategory}`;
     }
 
-    userPreferenceKey(userId: string): string {
+    private userPreferenceKey(userId: string): string {
         return `${AdMetadataStore.AD_USER_PREFERENCE_PREFIX}:${userId}`;
     }
 
@@ -72,7 +72,7 @@ export class AdMetadataStore {
         return await this.getAdMetadataList(adIds);
     }
 
-    async getAdMetadataList(ids: Array<string>): Promise<Array<AdMetadata>> {
+    private async getAdMetadataList(ids: Array<string>): Promise<Array<AdMetadata>> {
         const pipeline = this.client.pipeline();
         ids.forEach((id: string) => {
             pipeline.hgetall(this.metadataKey(id))

ad-server-cache-bun/src/index.ts

@@ -8,12 +8,6 @@ const client = new Dragonfly();
 
 const app = new Elysia()
     .decorate("adMetadataCache", new AdMetadataStore(client))
-    .get(
-        "/ads/:userId",
-        async (context) => {
-            return await context.adMetadataCache.getAdMetadataListByUserPreference(context.params.userId);
-        },
-    )
     .post(
         "/ads",
         async (context) => {
@@ -24,15 +18,21 @@ const app = new Elysia()
         {body: AdMetadata}
     )
     .post(
-        "/ads/preferences",
+        "/ads/user_preferences",
         async (context) => {
             await context.adMetadataCache.createUserPreference(context.body);
             context.set.status = 201;
             return;
         },
         {body: UserAdPreferences}
     )
-    .listen(3000);
+    .get(
+        "/ads/user_preferences/:userId",
+        async (context) => {
+            return await context.adMetadataCache.getAdMetadataListByUserPreference(context.params.userId);
+        },
+    )
+    .listen(3888);
 
 console.log(
     `Ad server API is running at ${app.server?.hostname}:${app.server?.port}`