@rip-lang/api 0.8.0 → 1.0.0

package/README.md

@@ -2,28 +2,30 @@
 
 # Rip API - @rip-lang/api
 
-> **Pure Rip API framework — elegant, fast, zero dependencies**
+> **A fast, elegant API framework with zero dependencies — written entirely in Rip**
 
-## Overview
+Rip API is a complete HTTP framework for building APIs with Bun. It provides
+Sinatra-style routing, Koa-style middleware composition, 37 built-in validators,
+and powerful session management — all in two files with no external dependencies.
+It powers [@rip-lang/db](https://github.com/shreeve/rip-lang/tree/main/packages/db)
+and is designed for APIs that are clear, concise, and correct.
 
-`@rip-lang/api` is a complete API framework written entirely in Rip. It provides Hono-compatible routing, middleware composition, and powerful validation — all with no external dependencies.
+## Features
 
-- **`api.rip`** (~595 lines) — Core framework: routing, validation, `read()`, `session`, server
-- **`middleware.rip`** (~390 lines) — Optional middleware: cors, logger, compress, sessions, etc.
+- **Zero dependencies** — Pure Rip implementation, no external frameworks
+- **Sinatra-style handlers** — Return data directly, no ceremony
+- **Magic `@` access** — `@req`, `@json()`, `@session` like Sinatra
+- **37 built-in validators** — Elegant `read()` function for parsing and validation
+- **Lifecycle filters** — `raw` → `before` → handler → `after` hooks
+- **AsyncLocalStorage context** — `read()` and `session` work anywhere, no prop drilling
+- **Hono-compatible API** — Easy migration from existing Hono apps
 
-**Core Philosophy**: API development should be intuitive, safe, and beautiful. Every function eliminates boilerplate, prevents common errors, and makes your intent crystal clear.
+| File | Lines | Role |
+|------|-------|------|
+| `api.rip` | ~590 | Core framework: routing, validation, `read()`, `session`, server |
+| `middleware.rip` | ~465 | Built-in middleware: cors, logger, sessions, compression, security |
 
-### Key Features
-
-- **Zero Dependencies** — Pure Rip implementation, no Hono or other frameworks
-- **Sinatra-Style Handlers** — Return data directly, no ceremony
-- **Magic `@` Access** — Use `@req`, `@json()`, `@session`, `@silent` like Sinatra
-- **Powerful Validation** — 37 built-in validators with elegant `read()` function
-- **Lifecycle Filters** — `raw` → `before` → handler → `after` hooks
-- **AsyncLocalStorage** — Safe, race-condition-free request context
-- **Hono-Compatible API** — Easy migration from existing Hono apps
-
-> **See Also**: For complete Rip language documentation, see the [main rip-lang repository](https://github.com/shreeve/rip-lang) and [docs/GUIDE.md](https://github.com/shreeve/rip-lang/blob/main/docs/GUIDE.md).
+> **See Also**: For Rip language documentation, see the [main rip-lang repository](https://github.com/shreeve/rip-lang) and [docs/GUIDE.md](https://github.com/shreeve/rip-lang/blob/main/docs/GUIDE.md).
 
 ## Try it Now
 
@@ -806,7 +808,7 @@ start port: 3000
 
 ## Performance
 
-- **Minimal footprint** — Core is ~595 lines, optional middleware ~390 lines
+- **Minimal footprint** — Core is ~590 lines, middleware ~465 lines
 - **Zero dependencies** — No external packages to load
 - **Compiled patterns** — Route regexes compiled once at startup
 - **Smart response wrapping** — Minimal overhead for return-value handlers

package/api.rip

@@ -508,91 +508,81 @@ export getValidator      = (name)     -> validators[name]
 # read() — Sinatra-style Parameter Reading
 # ==============================================================================
 
-export read = (keyOrTag = null, tagOrMiss = null, missOrNil = null) ->
-  store = requestContext.getStore()
-  unless store?
-    throw new Error 'read() called outside request context'
+export read = (name = null, type = null, miss = null) ->
+  store = requestContext.getStore() or throw new Error 'no context for read()'
 
-  data = store.data or {}
-  key  = null
-  tag  = null
-  miss = null
+  # missing value helper
+  done = (must = false) ->
+    return miss() if typeof miss is 'function'
+    throw new Error "Missing required field: #{name}" if must
+    return miss ?? null
 
-  [key, tag, miss] = typeof keyOrTag is 'string' \
-    ? [keyOrTag, tagOrMiss, missOrNil]           \
-    : [null    , keyOrTag , tagOrMiss]
+  # get value from store
+  v = store.data or {}
+  v = v[name] if name?
+  v = v.trim() if typeof v is 'string'
 
-  raw = if key? then data[key] else data
-  unless tag?
-    return raw if raw?
-    return miss() if typeof miss is 'function'
-    return if miss? and miss isnt '' then miss else null
+  # value only, no validator
+  if !type?
+    return v if v?
+    return done()
 
-  required = false
-  if typeof tag is 'string' and tag.endsWith('!')
-    required = true
-    tag = tag.slice(0, -1)
+  # String: apply validator function
+  else if typeof type is 'string'
 
-  v = raw
-  v = v.trim() if typeof v is 'string'
+    # detect required value (trailing '!')
+    if type.endsWith '!'
+      must = true
+      type = type.slice(0, -1)
+
+    # apply validator function
+    f = getValidator(type)
+    v = String(v ?? '') unless type in ['array', 'hash', 'json']
+    v = if f then f(v) else null
 
-  # Named validator
-  if typeof tag is 'string'
-    fn = getValidator(tag)
-    v = if fn then fn(String(v or '')) else null
+  # Regex: apply regex pattern
+  else if type instanceof RegExp
+    s = String(v ?? '')
+    v = s.match(type)?[0] or null
 
   # Array: [min, max] constraint or enumeration
-  else if Array.isArray(tag)
-    if typeof tag[0] is 'number'
-      minVal = tag[0]
-      maxVal = tag[1]
-      if typeof v is 'number' or (String(v) =~ /^[-+]?\d+$/)
-        n = if typeof v is 'number' then v else parseInt(String(v))
-        ok = not isNaN(n)
-        ok = false if minVal? and n < minVal
-        ok = false if maxVal? and n > maxVal
-        v = if ok then n else null
+  else if Array.isArray(type)
+    s = String(v ?? '')
+    y = true
+    if typeof type[0] is 'number'
+      [min, max] = type
+      if typeof v is 'number' or (s =~ /^[-+]?\d+$/)
+        n = if typeof v is 'number' then v else +s
+        y = false if min? and n < min
+        y = false if max? and n > max
+        v = if y then n else null
       else
-        s = String(v or '')
-        ok = true
-        ok = false if minVal? and s.length < minVal
-        ok = false if maxVal? and s.length > maxVal
-        v = if ok then s else null
+        y = false if min? and s.length < min
+        y = false if max? and s.length > max
+        v = if y then s else null
     else
-      v = if tag.includes(String(v)) then String(v) else null
-
-  # Regex
-  else if tag instanceof RegExp
-    v = String(v or '').match(tag)?[0] or null
-
-  # Object constraints
-  else if typeof tag is 'object'
-    if tag.start? or tag.end?
-      n = parseInt(v)
-      v = if not isNaN(n) and (not tag.start? or n >= tag.start) and (not tag.end? or n <= tag.end) then n else null
-    else if tag.min? or tag.max?
-      if typeof v is 'number' or (String(v or '') =~ /^[-+]?\d+$/)
-        n = if typeof v is 'number' then v else parseInt(String(v))
-        ok = not isNaN(n)
-        ok = false if tag.min? and n < tag.min
-        ok = false if tag.max? and n > tag.max
-        v = if ok then n else null
+      v = if type.includes(s) then s else null
+
+  # Object: start/end, min/max
+  else if type? and typeof type is 'object'
+    s = String(v ?? '')
+    if type.start? or type.end?
+      n = if s =~ /^[-+]?\d+$/ then +s else NaN
+      v = if not isNaN(n) and (not type.start? or n >= type.start) and (not type.end? or n <= type.end) then n else null
+    else if type.min? or type.max?
+      y = true
+      if typeof v is 'number' or (s =~ /^[-+]?\d+$/)
+        n = if typeof v is 'number' then v else +s
+        y = false if type.min? and n < type.min
+        y = false if type.max? and n > type.max
+        v = if y then n else null
       else
-        s = String(v or '')
-        ok = true
-        ok = false if tag.min? and s.length < tag.min
-        ok = false if tag.max? and s.length > tag.max
-        v = if ok then s else null
-
-  blank = v is null or v is undefined or (typeof v is 'string' and v.trim() is '')
-
-  if blank
-    if required
-      return miss?() if typeof miss is 'function'
-      throw new Error "Missing required field: #{key}"
-    else
-      return miss?() if typeof miss is 'function'
-      return null if miss is '' or not miss?  # Empty string or null/undefined → null
-      return miss  # Return 0, false, etc. as-is
+        y = false if type.min? and s.length < type.min
+        y = false if type.max? and s.length > type.max
+        v = if y then s else null
+
+  # blank / missing value handling
+  if not v? or (typeof v is 'string' and v.trim() is '')
+    return done(must)
 
   v

package/middleware.rip

@@ -415,7 +415,7 @@ export prettyJson = (c, next) ->
       return _renderHtmlJson(data, status)
     originalJson(data, status, headers)
 
-  next!()
+  next!
 
 _shouldRenderHtmlJson = (req) ->
   ua = req.headers.get('user-agent') or ''

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rip-lang/api",
-  "version": "0.8.0",
+  "version": "1.0.0",
   "description": "Pure Rip API framework — elegant, fast, zero dependencies",
   "type": "module",
   "main": "api.rip",
@@ -10,7 +10,7 @@
   },
   "scripts": {
     "build": "rip api.rip",
-    "test": "echo \"Tests coming soon\" && exit 0"
+    "test": "rip tests/read.test.rip"
   },
   "keywords": [
     "api",
@@ -32,6 +32,9 @@
   },
   "author": "Steve Shreeve <steve.shreeve@gmail.com>",
   "license": "MIT",
+  "dependencies": {
+    "rip-lang": "^2.9.0"
+  },
   "files": [
     "api.rip",
     "middleware.rip",