alex-knaub / step

Tiny Scala web framework, based on Sinatra

About

Step is a tiny Scala web framework inspired by Sinatra and originally based on some code I found on an awesome blog post.

It could probably use a lot of work; it's my first Scala project. I welcome comments, pull requests, and issues.

Example

package com.thinkminimo.step

class StepExample extends Step {

  // send a text/html content type back each time
  before() {
    contentType = "text/html"
  }

  // parse matching requests, saving things prefixed with ':' as params
  get("/date/:year/:month/:day") {
    <ul>
      <li>Year: {params("year")}</li>
      <li>Month: {params("month")}</li>
      <li>Day: {params("day")}</li>
    </ul>
  }

  // produce a simple HTML form
  get("/form") {
    <form action='/post' method='POST'>
      Post something: <input name='submission' type='text'/>
      <input type='submit'/>
    </form>
  }

  // handle POSTs from the form generated above
  post("/post") {
    <h1>You posted: {params("submission")}</h1>
  }

  // respond to '/' with a greeting
  get("/") {
    <h1>Hello world!</h1>
  }
}

Quick Start

1. Install Java

You'll need Java installed; I have it running with 1.5

2. Install simple-build-tool

Step uses sbt, a fantastic tool for building Scala programs.  For instructions, see [the sbt site](http://code.google.com/p/simple-build-tool/wiki/Setup)

3. Run sbt

In the directory you downloaded step to, run `sbt`.
sbt will download core dependencies, and Scala itself if it needs to.

4. Download dependencies

At the sbt prompt, type `update`.  This will download the Servlet API and Jetty.

5. Try it out

At the sbt prompt, type `jetty-run`.  This will run step with the example on port 8080.

6. Navigate to http://localhost:8080

You should see "Hello world."  You can poke around the example code in src/main/scala/StepExample.scala
to see what's going on.

Supported Methods

• before

  Run some block before a request is returned.

• get

  Respond to a GET request.

  Specify the route to match, with parameters to store prefixed with : like Sinatra. "/match/this/path/and/save/:this" would match that GET request, and provide you with a params("this") in your block.

• post

  Respond to a POST request.

  Posted variables are available in the params hash.

• delete

  Respond to a DELETE request.

• put

  Respond to a PUT request.

Miscellaneous

While Step can be run standalone, you can also package it up in a .jar for use in other projects. At the sbt prompt, type package. For more information, see the sbt site

Props

I'd like to thank this awesome dude for the inspirational blog post, and Mark Harrah for help on the sbt mailing list and for creating sbt. Ant+Ivy by itself was a total bitch.

Todo

• tests
• docs
• more tests
• regex and 'splat' support ala Sinatra?