Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Rack middleware to help you, as a teapot, comply with HTCPCP/1.0: the Hyper Text Coffee Pot Control Protocol

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 lib
Octocat-spinner-32 test
Octocat-spinner-32 .gitignore
Octocat-spinner-32 Changelog.rdoc
Octocat-spinner-32 License
Octocat-spinner-32 Rakefile
Octocat-spinner-32 Readme.rdoc
Octocat-spinner-32 teapot.gemspec
Readme.rdoc

teapot

It's imperative to respond correctly to coffee machine BREW requests when you are, in fact, a teapot. This piece of Rack middleware will ensure you comply with HTCPCP/1.0: the Hyper Text Coffee Pot Control Protocol.

For more information see www.ietf.org/rfc/rfc2324.txt

INSTALL

sudo gem install toolmantim-teapot --source http://gems.github.com

USAGE

Simply require and use from your rackup file (e.g. config.ru):

require 'rubygems'
require 'teapot'

use Teapot

Your Rack application will now serve English Breakfast and respond with a 418 I'm a teapot if it receives any BREW or application/coffee-pot-command requests.

Tea connoisseurs may wish to refer to Teapot for a finer selection of tea.

BREWING

You can perform a BREW request using curl's request method flag -X:

curl -i -X BREW myrackapp.com
Something went wrong with that request. Please try again.