Merge pull request #1 from ralaruri/gleam-cli/rewriting-into-rs-lookup

ADHOC: Updating Gleam CLI to use Runescape API

Author: ralaruri

README.md

@@ -1,25 +1,48 @@
-# vars
+# ge
 
-[![Package Version](https://img.shields.io/hexpm/v/vars)](https://hex.pm/packages/vars)
-[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/vars/)
+A command-line tool for checking Old School RuneScape Grand Exchange prices in real time. It pulls live buy/sell prices from the OSRS Wiki API so you can look up any item by name or search for items matching a keyword. Built with Gleam and runs on the Erlang VM.
+
+## Installation
+
+Make sure you have [Gleam](https://gleam.run) (v1.0+) and Erlang/OTP installed, then clone this repo and build:
 
 ```sh
-gleam add vars
+git clone https://github.com/ralaruri/gleam-cli.git
+cd gleam-cli
+gleam build
 ```
-```gleam
-import vars
 
-pub fn main() {
-  // TODO: An example of the project in use
-}
+## Usage
+
+```sh
+# Look up an item's latest GE price
+gleam run -- price "abyssal whip"
+
+# Search for items matching a query
+gleam run -- search dragon
 ```
 
-Further documentation can be found at <https://hexdocs.pm/vars>.
+## Example Output
+
+```
+$ ge price "abyssal whip"
+Abyssal whip (ID: 4151)
+  Buy price:  1,350,000 gp
+  Sell price: 1,340,000 gp
+  GE limit:   70
+  Members:    Yes
+
+$ ge search dragon
+Found 191 items matching "dragon":
+  Dragon scimitar (ID: 4587)
+  Dragon longsword (ID: 1305)
+  ...
+```
 
 ## Development
 
 ```sh
-gleam run   # Run the project
-gleam test  # Run the tests
-gleam shell # Run an Erlang shell
+gleam build  # Build the project
+gleam run    # Run the project
+gleam test   # Run the tests
 ```

gleam.toml

@@ -1,21 +1,16 @@
-name = "vars"
+name = "ge"
 version = "1.0.0"
-
-# Fill out these fields if you intend to generate HTML documentation or publish
-# your project to the Hex package manager.
-#
-# description = ""
-# licences = ["Apache-2.0"]
-# repository = { type = "github", user = "username", repo = "project" }
-# links = [{ title = "Website", href = "https://gleam.run" }]
-#
-# For a full reference of all the available options, you can have a look at
-# https://gleam.run/writing-gleam/gleam-toml/. 
+description = "OSRS Grand Exchange Price Checker CLI"
 
 [dependencies]
 gleam_stdlib = "~> 0.34 or ~> 1.0"
-envoy = "~> 1.0"
+gleam_httpc = "~> 3.0"
+gleam_json = "~> 2.0"
 argv = "~> 1.0"
+gleam_http = "~> 3.7"
 
 [dev-dependencies]
 gleeunit = "~> 1.0"
+
+[erlang]
+extra_applications = ["inets", "ssl"]

manifest.toml

@@ -3,13 +3,18 @@
 
 packages = [
   { name = "argv", version = "1.0.1", build_tools = ["gleam"], requirements = [], otp_app = "argv", source = "hex", outer_checksum = "A6E9009E50BBE863EB37D963E4315398D41A3D87D0075480FC244125808F964A" },
-  { name = "envoy", version = "1.0.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "envoy", source = "hex", outer_checksum = "CFAACCCFC47654F7E8B75E614746ED924C65BD08B1DE21101548AC314A8B6A41" },
+  { name = "gleam_erlang", version = "0.33.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_erlang", source = "hex", outer_checksum = "A1D26B80F01901B59AABEE3475DD4C18D27D58FA5C897D922FCB9B099749C064" },
+  { name = "gleam_http", version = "3.7.1", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_http", source = "hex", outer_checksum = "A9EE0722106FCCAB8AD3BF9D0A3EFF92BFE8561D59B83BAE96EB0BE1938D4E0F" },
+  { name = "gleam_httpc", version = "3.0.0", build_tools = ["gleam"], requirements = ["gleam_erlang", "gleam_http", "gleam_stdlib"], otp_app = "gleam_httpc", source = "hex", outer_checksum = "091CDD2BEC8092E82707BEA03FB5205A2BBBDE4A2F551E3C069E13B8BC0C428E" },
+  { name = "gleam_json", version = "2.0.0", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleam_json", source = "hex", outer_checksum = "CB10B0E7BF44282FB25162F1A24C1A025F6B93E777CCF238C4017E4EEF2CDE97" },
   { name = "gleam_stdlib", version = "0.36.0", build_tools = ["gleam"], requirements = [], otp_app = "gleam_stdlib", source = "hex", outer_checksum = "C0D14D807FEC6F8A08A7C9EF8DFDE6AE5C10E40E21325B2B29365965D82EB3D4" },
   { name = "gleeunit", version = "1.0.2", build_tools = ["gleam"], requirements = ["gleam_stdlib"], otp_app = "gleeunit", source = "hex", outer_checksum = "D364C87AFEB26BDB4FB8A5ABDE67D635DC9FA52D6AB68416044C35B096C6882D" },
 ]
 
 [requirements]
-argv = { version = "~> 1.0"}
-envoy = { version = "~> 1.0"}
+argv = { version = "~> 1.0" }
+gleam_http = { version = "~> 3.7"}
+gleam_httpc = { version = "~> 3.0" }
+gleam_json = { version = "~> 2.0" }
 gleam_stdlib = { version = "~> 0.34 or ~> 1.0" }
 gleeunit = { version = "~> 1.0" }

src/ge.gleam

@@ -0,0 +1,60 @@
+import gleam/io
+import gleam/string
+import gleam/list
+import argv
+import ge/api
+import ge/display
+import ge/types
+
+pub fn main() {
+  case argv.load().arguments {
+    ["price", ..name_parts] -> {
+      let name = string.join(name_parts, " ")
+      price_command(name)
+    }
+    ["search", ..query_parts] -> {
+      let query = string.join(query_parts, " ")
+      search_command(query)
+    }
+    _ -> io.println("Usage:\n  ge price <item_name>\n  ge search <query>")
+  }
+}
+
+fn price_command(name: String) -> Nil {
+  case api.fetch_mapping() {
+    Ok(items) -> {
+      let lower_name = string.lowercase(name)
+      let matches =
+        list.filter(items, fn(item: types.Item) {
+          string.lowercase(item.name) == lower_name
+        })
+      case matches {
+        [item, ..] -> {
+          case api.fetch_latest(item.id) {
+            Ok(price) -> io.println(display.format_item_price(item, price))
+            Error(err) -> io.println("Error: " <> err)
+          }
+        }
+        [] -> io.println("No item found with name \"" <> name <> "\"")
+      }
+    }
+    Error(err) -> io.println("Error: " <> err)
+  }
+}
+
+fn search_command(query: String) -> Nil {
+  case api.fetch_mapping() {
+    Ok(items) -> {
+      let lower_query = string.lowercase(query)
+      let matches =
+        list.filter(items, fn(item: types.Item) {
+          string.contains(string.lowercase(item.name), lower_query)
+        })
+      case matches {
+        [] -> io.println("No items found matching \"" <> query <> "\"")
+        _ -> io.println(display.format_search_results(matches, query))
+      }
+    }
+    Error(err) -> io.println("Error: " <> err)
+  }
+}

src/ge/api.gleam

@@ -0,0 +1,70 @@
+import gleam/httpc
+import gleam/http/request
+import gleam/json
+import gleam/dynamic.{type Dynamic}
+import gleam/dict
+import gleam/int
+import ge/types.{type Item, type Price, Item, Price}
+
+const base_url = "https://prices.runescape.wiki/api/v1/osrs"
+
+const user_agent = "ge-gleam-cli"
+
+pub fn fetch_mapping() -> Result(List(Item), String) {
+  let assert Ok(req) = request.to(base_url <> "/mapping")
+  let req = request.set_header(req, "user-agent", user_agent)
+
+  case httpc.send(req) {
+    Ok(resp) -> {
+      case json.decode(from: resp.body, using: dynamic.list(item_decoder())) {
+        Ok(items) -> Ok(items)
+        Error(_) -> Error("Failed to decode mapping response")
+      }
+    }
+    Error(_) -> Error("Failed to fetch mapping")
+  }
+}
+
+pub fn fetch_latest(item_id: Int) -> Result(Price, String) {
+  let url = base_url <> "/latest?id=" <> int.to_string(item_id)
+  let assert Ok(req) = request.to(url)
+  let req = request.set_header(req, "user-agent", user_agent)
+
+  case httpc.send(req) {
+    Ok(resp) -> {
+      let decoder =
+        dynamic.field("data", dynamic.dict(dynamic.string, price_decoder()))
+      case json.decode(from: resp.body, using: decoder) {
+        Ok(data) -> {
+          case dict.get(data, int.to_string(item_id)) {
+            Ok(price) -> Ok(price)
+            Error(_) -> Error("Item not found in response")
+          }
+        }
+        Error(_) -> Error("Failed to decode price response")
+      }
+    }
+    Error(_) -> Error("Failed to fetch latest prices")
+  }
+}
+
+fn item_decoder() -> fn(Dynamic) -> Result(Item, List(dynamic.DecodeError)) {
+  dynamic.decode5(
+    Item,
+    dynamic.field("id", dynamic.int),
+    dynamic.field("name", dynamic.string),
+    dynamic.field("members", dynamic.bool),
+    dynamic.optional_field("highalch", dynamic.int),
+    dynamic.optional_field("limit", dynamic.int),
+  )
+}
+
+fn price_decoder() -> fn(Dynamic) -> Result(Price, List(dynamic.DecodeError)) {
+  dynamic.decode4(
+    Price,
+    dynamic.optional_field("high", dynamic.int),
+    dynamic.optional_field("highTime", dynamic.int),
+    dynamic.optional_field("low", dynamic.int),
+    dynamic.optional_field("lowTime", dynamic.int),
+  )
+}

src/ge/display.gleam

@@ -0,0 +1,92 @@
+import gleam/int
+import gleam/string
+import gleam/list
+import gleam/option.{None, Some}
+import ge/types.{type Item, type Price}
+
+pub fn format_item_price(item: Item, price: Price) -> String {
+  let members_str = case item.members {
+    True -> "Yes"
+    False -> "No"
+  }
+  let limit_str = case item.limit {
+    Some(l) -> format_number(l)
+    None -> "N/A"
+  }
+  let buy_str = case price.high {
+    Some(h) -> format_number(h) <> " gp"
+    None -> "N/A"
+  }
+  let sell_str = case price.low {
+    Some(l) -> format_number(l) <> " gp"
+    None -> "N/A"
+  }
+
+  item.name
+  <> " (ID: "
+  <> int.to_string(item.id)
+  <> ")\n"
+  <> "  Buy price:  "
+  <> buy_str
+  <> "\n"
+  <> "  Sell price: "
+  <> sell_str
+  <> "\n"
+  <> "  GE limit:   "
+  <> limit_str
+  <> "\n"
+  <> "  Members:    "
+  <> members_str
+}
+
+pub fn format_search_results(items: List(Item), query: String) -> String {
+  let count = list.length(items)
+  let header =
+    "Found " <> int.to_string(count) <> " items matching \"" <> query <> "\":\n"
+  let entries =
+    list.map(items, fn(item) {
+      "  " <> item.name <> " (ID: " <> int.to_string(item.id) <> ")"
+    })
+  header <> string.join(entries, "\n")
+}
+
+pub fn format_number(n: Int) -> String {
+  case n < 0 {
+    True -> "-" <> format_number(-n)
+    False -> {
+      let digits = int.to_string(n)
+      let len = string.length(digits)
+      case len <= 3 {
+        True -> digits
+        False -> insert_commas(digits, len)
+      }
+    }
+  }
+}
+
+fn insert_commas(digits: String, len: Int) -> String {
+  let first_group = len % 3
+  let chars = string.to_graphemes(digits)
+  case first_group {
+    0 -> group_digits(chars, [])
+    _ -> {
+      let #(first, rest) = list.split(chars, first_group)
+      let first_str = string.concat(first)
+      case rest {
+        [] -> first_str
+        _ -> first_str <> "," <> group_digits(rest, [])
+      }
+    }
+  }
+}
+
+fn group_digits(chars: List(String), acc: List(String)) -> String {
+  case chars {
+    [] -> string.join(list.reverse(acc), ",")
+    _ -> {
+      let #(group, rest) = list.split(chars, 3)
+      let group_str = string.concat(group)
+      group_digits(rest, [group_str, ..acc])
+    }
+  }
+}

src/ge/types.gleam

@@ -0,0 +1,20 @@
+import gleam/option.{type Option}
+
+pub type Item {
+  Item(
+    id: Int,
+    name: String,
+    members: Bool,
+    highalch: Option(Int),
+    limit: Option(Int),
+  )
+}
+
+pub type Price {
+  Price(
+    high: Option(Int),
+    high_time: Option(Int),
+    low: Option(Int),
+    low_time: Option(Int),
+  )
+}