Ruby JavaScript Other
Latest commit 64c24a8 May 4, 2016 @seancribbs seancribbs Merge pull request #238 from rfestag/add_named_captures_support
Added support for named captures
Permalink
Failed to load latest commit information.
documentation Added documentation on regex route components May 1, 2016
examples
lib Added support for named captures May 1, 2016
spec
.gitignore Release 1.3.0 Jan 3, 2015
.rspec Two small changes to project config files Oct 24, 2013
.travis.yml
.yardopts Add textfiles and examples to YARD docs Jun 19, 2014
CHANGELOG.md Version 1.4.0 Mar 20, 2015
Gemfile Added test for Rack adapter using Rack::Test to ensure we do not depe… Jan 4, 2015
Guardfile
LICENSE webmachine-ruby is Apache licensed. Thanks for catching that, @strmpnk. Mar 22, 2012
README.md Fix Travis CI status button. Aug 15, 2015
Rakefile Use bundler gem tasks instead of custom tasks. Mar 20, 2015
memory_test.rb improve header lookup time Oct 17, 2014
webmachine.gemspec Reduced object allocation per request Oct 14, 2014

README.md

webmachine for Ruby Build Status

webmachine-ruby is a port of Webmachine, which is written in Erlang. The goal of both projects is to expose interesting parts of the HTTP protocol to your application in a declarative way. This means that you are less concerned with the procedures involved in handling requests directly and more with describing facts about the resources that make up your application. Webmachine is not a web framework per se, but more of a toolkit for building HTTP-friendly applications. For example, it does not provide a templating engine or a persistence layer; those choices are up to you.

Features

  • Handles the hard parts of content negotiation, conditional requests, and response codes for you.
  • Provides a base resource with points of extension to let you describe what is relevant about your particular resource.
  • Supports WEBrick, Reel, HTTPkit, and a Rack shim. Other host servers are being investigated.
  • Streaming/chunked response bodies are permitted as Enumerables, Procs, or Fibers!
  • Unlike the Erlang original, it does real Language negotiation.
  • Includes a visual debugger so you can look through the decision graph to determine how your resources are behaving.

Documentation & Finding Help

Getting Started

Below we go through some examples of how to do basic things with webmachine-ruby.

The first example defines a simple resource that doesn't demo the true power of Webmachine but perhaps gives a feel for how a Webmachine resource might look. Webmachine::Resource.run is available to provide for quick prototyping and development. In a real application you will want to configure what path a resource is served from. See the Router section in the README for more details on how to do that.

There are many other HTTP features exposed to a resource through {Webmachine::Resource::Callbacks}. A callback can alter the outcome of the decision tree Webmachine implements, and the decision tree is what makes Webmachine unique and powerful.

A simple static HTML resource

require 'webmachine'

class MyResource < Webmachine::Resource
  def to_html
    "<html><body>Hello, world!</body></html>"
  end
end

# Start a web server to serve requests via localhost
MyResource.run

A simple dynamic JSON Resource

require 'webmachine'
require 'widget'

class MyResource < Webmachine::Resource

  # GET and HEAD are allowed by default, but are shown here for clarity.
  def allowed_methods
    ['GET','HEAD']
  end

  def content_types_provided
    [['application/json', :to_json]]
  end

  # Return a Truthy or Falsey value
  def resource_exists?
    widget
  end

  def widget
    @widget ||= Widget.find(request.path_info[:id])
  end

  def to_json
    widget.to_json
  end
end

Router

The router is used to map a resource to a given path. To map the class MyResource to the path /myresource you would write something along the lines of:

Webmachine.application.routes do
  add ['myresource'], MyResource
end

# Start a web server to serve requests via localhost
Webmachine.application.run

When the resource needs to be mapped with variables that will be passed into the resource, use symbols to identify which path components are variables.

Webmachine.application.routes do
  add ['myresource', :id], MyResource
end

To add more components to the URL mapping, simply add them to the array.

Webmachine.application.routes do
  add ['myparentresource', :parent_id, 'myresource', :id], MyResource
end

Read more about routing here.

Application/Configurator

There is a configurator that allows you to set what IP address and port a web server should bind to as well as what web server should serve a webmachine resource. Learn how to configure your application here.

Adapters

Webmachine provides adapters for many popular webservers. Learn more here.

Visual debugger

It can be hard to understand all of the decisions that Webmachine makes when servicing a request to your resource, which is why we have the "visual debugger". Learn how to configure it here.

Related libraries

LICENSE

webmachine-ruby is licensed under the Apache v2.0 license. See LICENSE for details.