Document search rpc

Author: bubelov

docs/rpc/analytics/search.md

@@ -0,0 +1,75 @@
+# search
+
+## Description
+
+Performs a case-insensitive substring search across areas, places and events, returning matching records sorted by source (areas first, then places, then events). When the optional `type` filter is provided, only records of that source are returned.
+
+## Params
+
+```json
+{
+  "query": "berlin",
+  "type": "place"
+}
+```
+
+| Field  | Type   | Required | Description                                                                                       |
+| ------ | ------ | -------- | ------------------------------------------------------------------------------------------------- |
+| query  | string | yes      | The search string matched against area names, place names and event names (case-insensitive).    |
+| type   | string | no       | Restricts the result set to a single source. Accepts `area`, `place` or `event`. Defaults to all. |
+
+## Result Format
+
+```json
+[
+  {
+    "name": "Berlin",
+    "type": "area",
+    "id": 42
+  },
+  {
+    "name": "Berlin Bitcoin Meetup",
+    "type": "place",
+    "id": 1337
+  },
+  {
+    "name": "Bitcoin Berlin Conference",
+    "type": "event",
+    "id": 9
+  }
+]
+```
+
+| Field | Type    | Description                                                              |
+| ----- | ------- | ------------------------------------------------------------------------ |
+| name  | string  | Display name of the matched record.                                      |
+| type  | string  | Source of the record: `area`, `place` or `event`.                        |
+| id    | integer | Database id of the matched area, place or event.                        |
+
+## Allowed Roles
+
+- Root
+- Admin
+- Event Manager
+
+## Examples
+
+### curl
+
+```bash
+curl --header 'Content-Type: application/json' \
+  --header "Authorization: Bearer $ACCESS_TOKEN" \
+  --request POST \
+  --data '{"jsonrpc":"2.0","method":"search","params":{"query":"berlin"},"id":1}' \
+  https://api.btcmap.org/rpc
+```
+
+Search only places:
+
+```bash
+curl --header 'Content-Type: application/json' \
+  --header "Authorization: Bearer $ACCESS_TOKEN" \
+  --request POST \
+  --data '{"jsonrpc":"2.0","method":"search","params":{"query":"berlin","type":"place"},"id":1}' \
+  https://api.btcmap.org/rpc
+```

src/rpc/analytics/mod.rs

@@ -3,3 +3,4 @@ pub mod get_daily_infra_report;
 pub mod get_report;
 pub mod get_request_log;
 pub mod get_top_clients;
+pub mod search;

src/rpc/analytics/search.rs

@@ -0,0 +1,67 @@
+use crate::{db, Result};
+use deadpool_sqlite::Pool;
+use serde::{Deserialize, Serialize};
+
+#[derive(Deserialize)]
+pub struct Params {
+    pub query: String,
+    pub r#type: Option<String>,
+}
+
+#[derive(Serialize)]
+pub struct Res {
+    pub name: String,
+    pub r#type: String,
+    pub id: i64,
+}
+
+pub async fn run(params: Params, pool: &Pool) -> Result<Vec<Res>> {
+    let mut res = vec![];
+    let filter = params.r#type.as_deref();
+    if filter.is_none() || filter == Some("area") {
+        let areas = db::main::area::queries::select_by_search_query(&params.query, pool).await?;
+        let mut res_areas: Vec<Res> = areas
+            .into_iter()
+            .map(|it| Res {
+                name: it.name(),
+                r#type: "area".into(),
+                id: it.id,
+            })
+            .collect();
+        res.append(&mut res_areas);
+    }
+    if filter.is_none() || filter == Some("place") {
+        let elements =
+            db::main::element::queries::select_by_search_query(&params.query, true, pool).await?;
+        let mut res_elements: Vec<Res> = elements
+            .into_iter()
+            .map(|it| Res {
+                name: it.name(None),
+                r#type: "place".into(),
+                id: it.id,
+            })
+            .collect();
+        res.append(&mut res_elements);
+    }
+    if filter.is_none() || filter == Some("event") {
+        let events = db::main::event::queries::select_all(pool).await?;
+        let events: Vec<_> = events
+            .into_iter()
+            .filter(|it| {
+                it.name
+                    .to_uppercase()
+                    .contains(&params.query.to_uppercase())
+            })
+            .collect();
+        let mut res_events: Vec<Res> = events
+            .into_iter()
+            .map(|it| Res {
+                name: it.name,
+                r#type: "event".into(),
+                id: it.id,
+            })
+            .collect();
+        res.append(&mut res_events);
+    }
+    Ok(res)
+}

src/rpc/handler.rs

@@ -572,7 +572,7 @@ pub async fn handle(
         ),
         RpcMethod::Search => RpcResponse::from(
             req.id.clone(),
-            super::search::run(params(req.params)?, &main_pool).await?,
+            super::analytics::search::run(params(req.params)?, &main_pool).await?,
         ),
         RpcMethod::GetReport => RpcResponse::from(
             req.id.clone(),

src/rpc/mod.rs

@@ -29,7 +29,7 @@ pub mod remove_area;
 pub mod remove_area_tag;
 pub mod remove_element_tag;
 pub mod remove_user_tag;
-pub mod search;
+
 pub mod set_area_image;
 pub mod set_area_tag;
 pub mod set_element_tag;