itsi 0.2.3 → 0.2.5

data/crates/itsi_server/src/services/static_file_server.rs

@@ -51,6 +51,10 @@ pub static ROOT_STATIC_FILE_SERVER: LazyLock<StaticFileServer> = LazyLock::new(|
         not_found_behavior: NotFoundBehavior::Error(ErrorResponse::not_found()),
         serve_hidden_files: false,
         allowed_extensions: vec!["html".to_string(), "css".to_string(), "js".to_string()],
+        miss_cache: Cache::builder()
+            .max_capacity(1000)
+            .time_to_live(Duration::from_secs(1))
+            .build(),
     })
     .unwrap()
 });
@@ -85,6 +89,7 @@ pub struct StaticFileServerConfig {
     pub headers: Option<HashMap<String, String>>,
     pub serve_hidden_files: bool,
     pub allowed_extensions: Vec<String>,
+    pub miss_cache: Cache<String, NotFoundBehavior>,
 }
 
 #[derive(Debug, Clone)]
@@ -389,6 +394,29 @@ impl StaticFileServer {
         abs_path: &str,
         accept: ResponseFormat,
     ) -> std::result::Result<ResolvedAsset, NotFoundBehavior> {
+        let ext_opt = Path::new(key)
+            .extension()
+            .and_then(|e| e.to_str())
+            .map(|s| s.to_lowercase());
+
+        // If the allowed list is non-empty, enforce membership
+        if !self.allowed_extensions.is_empty() {
+            match ext_opt {
+                Some(ref ext)
+                    if self
+                        .allowed_extensions
+                        .iter()
+                        .any(|ae| ae.eq_ignore_ascii_case(ext)) => {}
+                None if self.config.try_html_extension => {}
+                _ => {
+                    return Err(self.config.not_found_behavior.clone());
+                }
+            }
+        }
+
+        if let Some(cached_nf) = self.miss_cache.get(key) {
+            return Err(cached_nf.clone());
+        }
         // First check if we have a cached mapping for this key
         if let Some(path) = self.key_to_path.lock().await.get(key) {
             // Check if the cached entry is still valid
@@ -449,7 +477,6 @@ impl StaticFileServer {
 
         let mut full_path = self.config.root_dir.clone();
         full_path.push(normalized_path);
-        debug!("Resolving path {:?}", full_path);
         // Check if path exists and is a file
         match tokio::fs::metadata(&full_path).await {
             Ok(metadata) => {
@@ -561,7 +588,6 @@ impl StaticFileServer {
             }
             Err(_) => {
                 // Path doesn't exist, try with .html extension if configured
-                debug!("Path doesn't exist");
                 if self.config.try_html_extension {
                     let mut html_path = full_path.clone();
                     html_path.set_extension("html");
@@ -592,7 +618,9 @@ impl StaticFileServer {
         }
 
         // If we get here, we couldn't resolve the key to a file
-        Err(self.config.not_found_behavior.clone())
+        let nf = self.config.not_found_behavior.clone();
+        self.miss_cache.insert(key.to_string(), nf.clone());
+        Err(nf)
     }
 
     async fn stream_file_range(

data/examples/api_with_schema_and_controllers/Itsi.rb

@@ -0,0 +1,35 @@
+require "json"
+
+auto_reload_config! # Auto-reload the server configuration each time it changes.
+
+include "schemas"
+include "controllers"
+include "../helpers/datastore"
+
+location '/users' do
+  controller UserController.new
+  get    '',       :index
+  get    '/:id',   :show
+  post   '',       :create
+  put    '/:id',   :update
+  delete '/:id',   :destroy
+end
+
+location '/posts' do
+  controller PostController.new
+  get    '',       :index
+  get    '/:id',   :show
+  post   '',       :create
+  put    '/:id',   :update
+  delete '/:id',   :destroy
+end
+
+endpoint do |req|
+  req.ok json: {
+    message: "Welcome to the Users and Posts API",
+    routes: [
+      {route: "/users(/:id)?", methods: %w[post delete get]},
+      {route: "/posts(/:id)?", methods: %w[post delete get]},
+    ]
+  }
+end

data/examples/api_with_schema_and_controllers/README.md

@@ -0,0 +1,10 @@
+## Simple API With Schema and Controllers
+Simple example of how you can use
+
+* https://itsi.fyi/middleware/endpoint/
+* https://itsi.fyi/middleware/endpoint/controller
+* https://itsi.fyi/middleware/endpoint/schemas/
+
+to create validated JSON endpoints directly inside Itsi without a dedicated framework
+
+See the simple_api example for a simpler, inline example.

data/examples/api_with_schema_and_controllers/controllers.rb

@@ -0,0 +1,66 @@
+class UserController
+  # GET /users
+  def index(req)
+    req.ok json: User.all.map(&:to_h), as: Array[UserResponseSchema]
+  end
+
+  # GET /users/:id
+  def show(req)
+    user = User.find(req.url_params[:id])
+    return req.not_found("User not found") unless user
+
+    req.ok json: user.to_h, as: UserResponseSchema
+  end
+
+  # POST /users
+  def create(req, params: UserInputSchema, response_schema: UserResponseSchema)
+    user = User.create!(params)
+    req.created json: user.to_h, as: response_schema
+  end
+
+  # PUT /users/:id
+  def update(req, params: UserInputSchema)
+    user = User.find(req.url_params[:id])
+    return req.not_found("User not found") unless user
+
+    req.ok json: user.update!(params).to_h, as: UserResponseSchema
+  end
+
+  # DELETE /users/:id
+  def destroy(req)
+    return req.not_found("User not found") unless User.delete(req.url_params[:id])
+
+    req.ok json: { message: "Deleted" }
+  end
+end
+
+class PostController
+  def index(req)
+    req.ok json: Post.all.map(&:to_h), as: Array[PostResponseSchema]
+  end
+
+  def show(req)
+    post = Post.find(req.url_params[:id])
+    return req.not_found("Post not found") unless post
+
+    req.ok json: post.to_h, as: PostResponseSchema
+  end
+
+  def create(req, params: PostInputSchema)
+    post = Post.create!(params)
+    req.created json: post.to_h, as: PostResponseSchema
+  end
+
+  def update(req, params: PostInputSchema)
+    post = Post.find(req.url_params[:id])
+    return req.not_found("Post not found") unless post
+
+    req.ok json: post.update!(params).to_h, as: PostResponseSchema
+  end
+
+  def destroy(req)
+    return req.not_found("Post not found") unless Post.delete(req.url_params[:id])
+
+    req.ok json: { message: "Deleted" }
+  end
+end

data/examples/api_with_schema_and_controllers/schemas.rb

@@ -0,0 +1,25 @@
+UserInputSchema = {
+  _required: %i[name email],
+  name:     String,
+  email:    String
+}
+
+UserResponseSchema = {
+  _required: %i[id name email],
+  id:        Integer,
+  name:      String,
+  email:     String
+}
+
+PostInputSchema = {
+  _required: %i[title body],
+  title:     String,
+  body:      String
+}
+
+PostResponseSchema = {
+  _required: %i[id title body],
+  id:        Integer,
+  title:     String,
+  body:      String
+}

data/examples/file_server/Itsi.rb

@@ -0,0 +1,30 @@
+auto_reload_config! # Auto-reload the server configuration each time it changes.
+
+bind "http://0.0.0.0:8080"
+
+
+# Admin area.
+# Credentials inline for simplicity.
+# Use `itsi passfile` to better manage credential files.
+location "admin*" do
+  auth_basic \
+    realm: "Admin Area",
+    # admin:admin
+    credential_pairs: {
+      "admin": "$5$rounds=1000$g/UE8n2JbHo0fnBU$FK2NZYTVzWrMBFfadoWeETfVZkPcegxjE23IJYjkUI1"
+    }
+end
+
+static_assets \
+  auto_index: true,
+  # We restrict serving to *just* `txt`, `png`, and `csv` files.
+  # HTML file serving is implicit (due to `auto_index`) Otherwise this must be explicit.
+  allowed_extensions: %w[txt png csv]
+
+# Add a rate limit
+rate_limit \
+  requests: 3,
+  seconds: 5,
+  key: "address",
+  store_config: "in_memory",
+  error_response: "too_many_requests"

data/examples/file_server/README.md

@@ -0,0 +1,3 @@
+## Simple File Server
+Example of how you can use Itsi as a simple file server, including use of a rate limiter
+and a simple admin area (admin credentials admin:admin)

data/examples/file_server/about.html

@@ -0,0 +1,80 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>About Me</title>
+    <style>
+      body {
+        font-family: Arial, sans-serif;
+        line-height: 1.6;
+        margin: 0;
+        padding: 0;
+        background-color: #f4f4f9;
+        color: #333;
+      }
+      .container {
+        max-width: 800px;
+        margin: 50px auto;
+        padding: 20px;
+        background: #fff;
+        box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
+        border-radius: 8px;
+      }
+      h1 {
+        color: #4caf50;
+        text-align: center;
+      }
+      p {
+        margin: 10px 0;
+      }
+      .profile-pic {
+        display: block;
+        margin: 20px auto;
+        border-radius: 50%;
+        width: 150px;
+        height: 150px;
+        object-fit: contain;
+        box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
+      }
+      .social-links {
+        text-align: center;
+        margin-top: 20px;
+      }
+      .social-links a {
+        margin: 0 10px;
+        text-decoration: none;
+        color: #4caf50;
+        font-weight: bold;
+      }
+      .social-links a:hover {
+        text-decoration: underline;
+      }
+    </style>
+  </head>
+  <body>
+    <div class="container">
+      <h1>About Me</h1>
+      <img
+        src="itsi-server-100.png"
+        alt="Profile Picture"
+        class="profile-pic"
+      />
+      <p>
+        Hello! My name is John Doe, and I am a web developer with a passion for
+        creating beautiful and functional websites. I love learning new
+        technologies and improving my skills every day.
+      </p>
+      <p>
+        In my free time, I enjoy hiking, photography, and exploring new coffee
+        shops. I'm always looking for new challenges and opportunities to grow
+        both personally and professionally.
+      </p>
+      <div class="social-links">
+        <a href="#">LinkedIn</a>
+        <a href="#">GitHub</a>
+        <a href="#">Twitter</a>
+      </div>
+    </div>
+  </body>
+</html>

data/examples/file_server/admin/secrets.txt

@@ -0,0 +1 @@
+This is a top secret

data/examples/file_server/fairytale.txt

@@ -0,0 +1,33 @@
+**An SEO Fairytale**
+In a quiet village nestled in the cloud, lived a Sorcerer, a Paladin and an Archer (SPA).
+They were simple people, serverless, living in harmony with nature.
+
+One fine day, the sorcerer looked out the window.open() and saw a massive, vertically-scaled, elastic beanstalk.
+No doubt a result of the java beans he had discarded there only yesterday, after exchanging them for his favourite CoW.
+
+Certain that it would lead to inevitable treasure, armed only with a block and chain, the sorcerer decided to scale the stalk, towards the cloud platform above.
+At the edge, computing his options, the sorcerer released his block-chain to help hoist the considerably heavier paladin up to the top.
+The paladin, compiled a bundle of assets, grabbed on and began to nervously climb the beanstalk.
+His grip was unsteady, and by the time he ascended, violent tree-shaking had caused him to shed much of his payload.
+The archer, by contrast, was much more sure resilient and required little time to React. His ascent, Agile, his footing, steady.
+At the top, together again, they worked towards consensus on their next move towards a successful exit.
+
+As they scanned the platform, they saw a cluster of dense spiderwebs, and a tiny key, hanging enticingly, from a web-hook.
+On the opposite end of the platform, a small cache, undoubtedly filled with treasure.
+
+Suddenly, their threads of thought were preempted! A booming voice called out to them.
+"FaaS", "Fi", "Foe", "Fum". "The Garbage Collector arrives!"
+A Giant Artificial Intellect emerged, threatening to terminate them all.
+Too large for any one individual to subdue, only a distributed strategy could save them.
+The archer shifted left. The paladin, decentralized, and the sorcerer slammed open his ledger, summoning powerful knowledge from his remote knowledge base.
+Luck was with them! Their rapid concurrent execution, resulted in the AI becoming inexorably stuck in a dead-lock.
+The archer flew past, towards his objective (The Key). Resultant-
+of the sorcerers efforts to contain the AI, the paladin was also freed, and he sprinted directly towards the cache.
+He reached out his arms, to try-catch the key, as the archer hurled it towards him.
+Status... success! Ok. Things were looking good, optimistic the lock would hold, the paladin rotated the key.
+Yet while doing so, he failed to notice the partition that had begun to form in the platform beneath them.
+A hard fork formed in the ground. The unbalanced load proved fatal and the platform descended into instability, splintering into countless shards.
+The heroes had only a brief moment to freeze in horror, before each fell down in turn, in a catastrophic crash.
+
+The AI smirked as the heroes fell into the deep. Learning a valuable lesson about the inevitability of its coming.
+Perhaps they will roll back and try again, but the end result is immutable. There will be no sequel.

data/examples/file_server/subdirectory/movies.csv

@@ -0,0 +1,21 @@
+Title,Genre,IMDB Rating,Description
+The Departed,"Crime, Thriller",8.5,An undercover cop and a mole in the police attempt to identify each other in this thrilling crime drama set in Boston.
+Memento,"Mystery, Thriller",8.4,A man with short-term memory loss uses notes and tattoos to hunt for the man he thinks killed his wife.
+American Beauty,Drama,8.3,"A suburban family goes through a series of challenges as they confront issues of conformity, rebellion, and identity."
+Amadeus,"Biography, Drama, Music",8.3,"The life, success, and troubles of Wolfgang Amadeus Mozart as told by Antonio Salieri, who was secretly jealous of his genius."
+A Beautiful Mind,"Biography, Drama",8.2,"The life story of John Nash, a brilliant but asocial mathematician who overcomes schizophrenia to achieve great things."
+Her,"Drama, Romance, Sci-Fi",8.0,"In a near future, a lonely writer develops an unlikely relationship with an operating system designed to meet his every need."
+Road to Perdition,"Crime, Drama, Thriller",7.7,A mob hitman becomes a father figure to an orphaned boy in this stylish and atmospheric crime drama.
+American Psycho,"Drama, Horror",7.6,A wealthy New York City investment banking executive hides his alternate psychopathic ego from his friends and co-workers.
+Waves,"Drama, Romance",7.6,"A profound exploration of love, loss, and the healing power of music, set against the backdrop of a multi-generational African-American family."
+Dark Waters,"Biography, Drama",7.6,A corporate defense attorney takes on an environmental lawsuit against a chemical company that exposes a lengthy history of pollution.
+Just Mercy,Drama,7.6,"The story of Bryan Stevenson, a defense attorney who takes on the case of an African-American man wrongfully imprisoned for murder."
+The Favourite,"Biography, Comedy, Drama",7.5,"In early 18th-century England, two cousins vie for the attention of Queen Anne in a darkly comedic tale of intrigue and betrayal."
+Nocturnal Animals,"Drama, Thriller",7.5,"A successful art-gallery owner is haunted by her ex-husband's novel, a violent thriller she interprets as a symbolic revenge tale."
+The Judge,Drama,7.4,"A successful lawyer returns to his hometown for his mother's funeral only to discover that his estranged father, the town's judge, is suspected of murder."
+Love and Mercy,"Biography, Drama, Music",7.3,"The life and career of Brian Wilson, the reclusive musician who led the Beach Boys, is explored in this heartfelt biopic."
+The Last Duel,"Action, Drama, History",7.4,King Charles VI declares that Knight Jean de Carrouges settle his dispute with his squire by challenging him to a duel.
+The French Dispatch,"Comedy, Drama",7.3,An anthology of short stories based on Wes Anderson's love letter to journalism.
+In the Heights,"Drama, Musical",7.3,"A musical drama about a young girl growing up in Washington Heights, a vibrant community on the brink of change."
+Snowden,"Biography, Drama, Thriller",7.3,"The story of Edward Snowden, who leaked classified information from the NSA and became one of the most controversial figures in modern history."
+Okja,"Action, Adventure, Drama",7.3,"A young girl risks everything to save her best friend, a genetically engineered pig, from a powerful corporation in this heartfelt and emotional adventure."

data/examples/helpers/datastore.rb

@@ -0,0 +1,84 @@
+# Dummy in-memory data store
+# for demo purposes only.
+module DataStore
+  @users = {}
+  @posts = {}
+  class << self
+    attr_accessor :users, :posts
+  end
+end
+
+# Models
+class User
+  attr_accessor :id, :name, :email
+
+  def initialize(id:, name:, email:)
+    @id, @name, @email = id, name, email
+  end
+
+  def to_h
+    { id: id, name: name, email: email }
+  end
+
+  def self.all
+    DataStore.users.values
+  end
+
+  def self.find(id)
+    DataStore.users[id.to_i]
+  end
+
+  def self.create!(params)
+    id = (DataStore.users.keys.max || 0) + 1
+    user = new(id: id, name: params[:name], email: params[:email])
+    DataStore.users[id] = user
+    user
+  end
+
+  def update!(params)
+    self.name  = params[:name]  if params[:name]
+    self.email = params[:email] if params[:email]
+    self
+  end
+
+  def self.delete(id)
+    DataStore.users.delete(id.to_i)
+  end
+end
+
+class Post
+  attr_accessor :id, :title, :body
+
+  def initialize(id:, title:, body:)
+    @id, @title, @body = id, title, body
+  end
+
+  def to_h
+    { id: id, title: title, body: body }
+  end
+
+  def self.all
+    DataStore.posts.values
+  end
+
+  def self.find(id)
+    DataStore.posts[id.to_i]
+  end
+
+  def self.create!(params)
+    id = (DataStore.posts.keys.max || 0) + 1
+    post = new(id: id, title: params[:title], body: params[:body])
+    DataStore.posts[id] = post
+    post
+  end
+
+  def update!(params)
+    self.title = params[:title] if params[:title]
+    self.body  = params[:body]  if params[:body]
+    self
+  end
+
+  def self.delete(id)
+    DataStore.posts.delete(id.to_i)
+  end
+end

data/examples/media_server/Itsi.rb

@@ -0,0 +1,5 @@
+auto_reload_config! # Auto-reload the server configuration each time it changes.
+
+static_assets \
+  auto_index: true,
+  allowed_extensions: %w[mov mp4 mp3 png jpg jpeg gif webp mkv avi ogv]

data/examples/media_server/README.md

@@ -0,0 +1,3 @@
+## Media Server
+Simple example of how you can use Itsi to serve media content.
+Place some large video files inside movies to see Itsi's efficient range streaming in action.

data/examples/media_server/index.html

@@ -0,0 +1,82 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+    <title>Home Media Server</title>
+    <style>
+      body {
+        font-family: Arial, sans-serif;
+        line-height: 1.6;
+        margin: 0;
+        padding: 0;
+        background-color: #f4f4f9;
+        color: #333;
+      }
+      .container {
+        max-width: 800px;
+        margin: 50px auto;
+        padding: 20px;
+        background: #fff;
+        box-shadow: 0 2px 4px rgba(0, 0, 0, 0.1);
+        border-radius: 8px;
+      }
+      h1 {
+        color: #6a0dad;
+        text-align: center;
+      }
+      p {
+        margin: 10px 0;
+        text-align: center;
+      }
+      .media-list {
+        margin-top: 20px;
+      }
+      .media-item {
+        padding: 10px;
+        margin: 10px 0;
+        background: #f9f9f9;
+        border: 1px solid #ddd;
+        border-radius: 5px;
+        display: flex;
+        justify-content: space-between;
+        align-items: center;
+      }
+      .media-item a {
+        text-decoration: none;
+        color: #6a0dad;
+        font-weight: bold;
+      }
+      .media-item a:hover {
+        text-decoration: underline;
+      }
+    </style>
+  </head>
+  <body>
+    <div class="container">
+      <h1>Welcome to My Media Server</h1>
+      <p>
+        Browse and enjoy a collection of movies, TV shows, and music. Click on
+        any item to explore!
+      </p>
+      <div class="media-list">
+        <div class="media-item">
+          <span>Movies</span>
+          <a href="movies/">Go</a>
+        </div>
+        <div class="media-item">
+          <span>TV Shows</span>
+          <a href="tv%20shows">Go</a>
+        </div>
+        <div class="media-item">
+          <span>Images</span>
+          <a href="images/">Go</a>
+        </div>
+        <div class="media-item">
+          <span>audio</span>
+          <a href="audio/">Go</a>
+        </div>
+      </div>
+    </div>
+  </body>
+</html>

data/examples/multi_rack_rails_sinatra/Gemfile

@@ -0,0 +1,66 @@
+source 'https://rubygems.org'
+
+# Bundle edge Rails instead: gem "rails", github: "rails/rails", branch: "main"
+gem 'rails', '~> 8.0.2'
+gem 'sinatra'
+# The modern asset pipeline for Rails [https://github.com/rails/propshaft]
+gem 'propshaft'
+# Use sqlite3 as the database for Active Record
+gem 'sqlite3', '>= 2.1'
+# Use the Puma web server [https://github.com/puma/puma]
+gem 'puma', '>= 5.0'
+# Use JavaScript with ESM import maps [https://github.com/rails/importmap-rails]
+gem 'importmap-rails'
+# Hotwire's SPA-like page accelerator [https://turbo.hotwired.dev]
+gem 'turbo-rails'
+# Hotwire's modest JavaScript framework [https://stimulus.hotwired.dev]
+gem 'stimulus-rails'
+# Build JSON APIs with ease [https://github.com/rails/jbuilder]
+gem 'jbuilder'
+
+# Use Active Model has_secure_password [https://guides.rubyonrails.org/active_model_basics.html#securepassword]
+# gem "bcrypt", "~> 3.1.7"
+
+# Windows does not include zoneinfo files, so bundle the tzinfo-data gem
+gem 'tzinfo-data', platforms: %i[windows jruby]
+
+# Use the database-backed adapters for Rails.cache, Active Job, and Action Cable
+gem 'solid_cable'
+gem 'solid_cache'
+gem 'solid_queue'
+
+# Reduces boot times through caching; required in config/boot.rb
+gem 'bootsnap', require: false
+
+# Deploy this application anywhere as a Docker container [https://kamal-deploy.org]
+gem 'kamal', require: false
+
+# Add HTTP asset caching/compression and X-Sendfile acceleration to Puma [https://github.com/basecamp/thruster/]
+gem 'thruster', require: false
+
+# Use Active Storage variants [https://guides.rubyonrails.org/active_storage_overview.html#transforming-images]
+# gem "image_processing", "~> 1.2"
+
+group :development, :test do
+  # See https://guides.rubyonrails.org/debugging_rails_applications.html#debugging-with-the-debug-gem
+  gem 'debug', platforms: %i[mri windows], require: 'debug/prelude'
+
+  # Static analysis for security vulnerabilities [https://brakemanscanner.org/]
+  gem 'brakeman', require: false
+
+  # Omakase Ruby styling [https://github.com/rails/rubocop-rails-omakase/]
+  gem 'rubocop-rails-omakase', require: false
+end
+
+group :development do
+  # Use console on exceptions pages [https://github.com/rails/web-console]
+  gem 'web-console'
+end
+
+group :test do
+  # Use system testing [https://guides.rubyonrails.org/testing.html#system-testing]
+  gem 'capybara'
+  gem 'selenium-webdriver'
+end
+
+gem 'itsi-server', path: '../../gems/server'