RubyGems - webmachine - Versions diffs - 0.4.1 → 0.4.2 - Mend

webmachine 0.4.1 → 0.4.2

Files changed (907) hide show

data/pkg/webmachine-0.4.0/README.md DELETED Viewed

@@ -1,169 +0,0 @@
-# webmachine for Ruby [![travis](https://secure.travis-ci.org/seancribbs/webmachine-ruby.png)](http://travis-ci.org/seancribbs/webmachine-ruby)
-webmachine-ruby is a port of
-[Webmachine](https://github.com/basho/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 handling requests directly and
-more with describing the behavior of 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.
-## A Note about Rack
-Webmachine has a Rack adapter -- thanks to Jamis Buck -- but when
-using it, we recommend you ensure that NO middleware is used.  The
-behaviors that are encapsulated in Webmachine could be broken by
-middlewares that sit above it, and there is no way to detect them at
-runtime. _Caveat implementor_. That said, Webmachine should behave properly
-when given a clear stack.
-## Getting Started
-Webmachine is very young, but it's still easy to construct an
-application for it!
-```ruby
-require 'webmachine'
-# Require any of the files that contain your resources here
-require 'my_resource'
-# Point all URIs at the MyResource class
-Webmachine::Dispatcher.add_route(['*'], MyResource)
-# Start the server, binds to port 8080 using WEBrick
-Webmachine.run
-```
-Your resource will look something like this:
-```ruby
-class MyResource < Webmachine::Resource
-  def to_html
-    "<html><body>Hello, world!</body></html>"
-  end
-end
-```
-Run the first file and your application is up. That's all there is to
-it! If you want to customize your resource more, look at the available
-callbacks in lib/webmachine/resource/callbacks.rb. For example, you
-might want to enable "gzip" compression on your resource, for which
-you can simply add an `encodings_provided` callback method:
-```ruby
-class MyResource < Webmachine::Resource
-  def encodings_provided
-    {"gzip" => :encode_gzip, "identity" => :encode_identity}
-  end
-  def to_html
-    "<html><body>Hello, world!</body></html>"
-  end
-end
-```
-There are many other HTTP features exposed to your resource through
-{Webmachine::Resource::Callbacks}. Give them a try!
-### Configurator
-There's a configurator that allows you to set the ip address and port
-bindings as well as a different webserver adapter.  You can also add
-your routes in a block. Both of these call return the `Webmachine`
-module, so you could chain them if you like.
-```ruby
-require 'webmachine'
-require 'my_resource'
-Webmachine.routes do
-  add ['*'], MyResource
-end
-Webmachine.configure do |config|
-  config.ip = '127.0.0.1'
-  config.port = 3000
-  config.adapter = :Mongrel
-end
-# Start the server.
-Webmachine.run
-```
-## Features
-* Handles the hard parts of content negotiation, conditional
-  requests, and response codes for you.
-* Most callbacks can interrupt the decision flow by returning an
-  integer response code. You generally only want to do this when new
-  information comes to light, requiring a modification of the response.
-* Supports WEBrick and Mongrel (1.2pre+), 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.
-## Problems/TODOs
-* Command-line tools, and general polish.
-* Tracing is exposed as an Array of decisions visited on the response
-  object. You should be able to turn this off and on, and visualize
-  the decisions on the sequence diagram.
-## Changelog
-### 0.3.0 November 9, 2011
-0.3.0 introduces some new features, refactorings, and now has 100%
-documentation coverage! Among the new features are minimal Rack
-compatibility, streaming responses via Fibers and a friendlier route
-definition syntax. Added Jamis Buck as a committer. Thank you for your
-contributions!
-* Chunked bodies are now wrapped in a way that works on webservers
-  that don't automatically produce them.
-* HTTP Basic Authentication is easy to add to resources, just include
-  `Webmachine::Resource::Authentication`.
-* Routes are a little less painful to add, you can now specify them
-  with `Webmachine.routes` which will be evaled into the `Dispatcher`.
-* The new default port is 8080.
-* Rack is minimally supported as a host server. _Don't put middleware
-  above Webmachine!_
-* Fibers can be used as streamed response bodies.
-* `Dispatcher#add_route` will now return the added `Route` instance.
-* The header-conversion code for CGI-style servers has been extracted
-  into `Webmachine::Headers`.
-* `Route#path_spec` is now public so that applications can inspect
-  existing routes, perhaps for URL generation.
-* `Request#query` now uses `CGI.unescape` so '+' characters are
-  correctly parsed.
-* YARD documentation has 100% coverage.
-### 0.2.0 September 11, 2011
-0.2.0 includes an adapter for Mongrel and a central place for
-configuration as well as numerous bugfixes. Added Ian Plosker and
-Bernd Ahlers as committers. Thank you for your contributions!
-* Acceptable media types are matched less strictly, which has
-  implications on both responses and PUT requests. See the
-  [discussion on the commit](https://github.com/seancribbs/webmachine-ruby/commit/3686d0d9ff77fc98aff59f89478e9c6c18844ca1).
-* Resources now receive a callback after the language has been
-  negotiated, so they can decide what to do with it.
-* Added `Webmachine::Configuration` so we can more easily support more
-  than one host server/adapter.
-* Added Mongrel adapter, supporting 1.2pre+.
-* Media type headers are more lax about whitespace following
-  semicolons.
-* Fix some problems with callable response bodies.
-* Make sure String response bodies get a Content-Length header added
-  and streaming responses get chunked encoding.
-* Numerous refactorings, including extracting `MediaType` into its own
-  top-level class.
-### 0.1.0 August 25, 2011
-This is the initial release. Most things work, but only WEBrick is supported.

data/pkg/webmachine-0.4.0/Rakefile DELETED Viewed

@@ -1,41 +0,0 @@
-require 'rubygems'
-require 'rubygems/package_task'
-begin
-  require 'yard'
-  require 'yard/rake/yardoc_task'
-  YARD::Rake::YardocTask.new do |doc|
-    doc.files = Dir["lib/**/*.rb"] + ['README.md']
-    doc.options = ["-m", "markdown"]
-  end
-rescue LoadError
-end
-def gemspec
-  $webmachine_gemspec ||= Gem::Specification.load("webmachine.gemspec")
-end
-Gem::PackageTask.new(gemspec) do |pkg|
-  pkg.need_zip = false
-  pkg.need_tar = false
-end
-task :gem => :gemspec
-desc %{Validate the gemspec file.}
-task :gemspec do
-  gemspec.validate
-end
-desc %{Release the gem to RubyGems.org}
-task :release => :gem do
-  system "gem push pkg/#{gemspec.name}-#{gemspec.version}.gem"
-end
-require 'rspec/core'
-require 'rspec/core/rake_task'
-desc "Run specs"
-RSpec::Core::RakeTask.new(:spec)
-task :default => :spec

data/pkg/webmachine-0.4.0/doc/Webmachine/Adapters/Mongrel/Handler.html DELETED Viewed

@@ -1,348 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
-  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
-  <head>
-    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>
-  Class: Webmachine::Adapters::Mongrel::Handler
-    &mdash; Documentation by YARD 0.7.3
-</title>
-  <link rel="stylesheet" href="../../../css/style.css" type="text/css" media="screen" charset="utf-8" />
-  <link rel="stylesheet" href="../../../css/common.css" type="text/css" media="screen" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  relpath = '../../..';
-  if (relpath != '') relpath += '/';
-</script>
-  <script type="text/javascript" charset="utf-8" src="../../../js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="../../../js/app.js"></script>
-  </head>
-  <body>
-    <script type="text/javascript" charset="utf-8">
-      if (window.top.frames.main) document.body.className = 'frames';
-    </script>
-    <div id="header">
-      <div id="menu">
-    <a href="../../../_index.html">Index (H)</a> &raquo;
-    <span class='title'><span class='object_link'><a href="../../../Webmachine.html" title="Webmachine (module)">Webmachine</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../../Adapters.html" title="Webmachine::Adapters (module)">Adapters</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Mongrel.html" title="Webmachine::Adapters::Mongrel (module)">Mongrel</a></span></span>
-     &raquo;
-    <span class="title">Handler</span>
-  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-      <div id="search">
-    <a id="class_list_link" href="#">Class List</a>
-    <a id="method_list_link" href="#">Method List</a>
-    <a id="file_list_link" href="#">File List</a>
-</div>
-      <div class="clear"></div>
-    </div>
-    <iframe id="search_frame"></iframe>
-    <div id="content"><h1>Class: Webmachine::Adapters::Mongrel::Handler
-</h1>
-<dl class="box">
-    <dt class="r1">Inherits:</dt>
-    <dd class="r1">
-      <span class="inheritName">Mongrel::HttpHandler</span>
-        <ul class="fullTree">
-          <li>Object</li>
-            <li class="next">Mongrel::HttpHandler</li>
-            <li class="next">Webmachine::Adapters::Mongrel::Handler</li>
-        </ul>
-        <a href="#" class="inheritanceTree">show all</a>
-      </dd>
-    <dt class="r2 last">Defined in:</dt>
-    <dd class="r2 last">lib/webmachine/adapters/mongrel.rb</dd>
-</dl>
-<div class="clear"></div>
-<h2>Overview</h2><div class="docstring">
-  <div class="discussion">
-    A Mongrel handler for Webmachine
-  </div>
-</div>
-<div class="tags">
-</div>
-    <h2>
-      Instance Method Summary
-      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
-    </h2>
-    <ul class="summary">
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#initialize-instance_method" title="#initialize (instance method)">- (Handler) <strong>initialize</strong>(dispatcher) </a>
-  </span>
-    <span class="note title constructor">constructor</span>
-    <span class="summary_desc"><div class='inline'>A new instance of Handler.</div></span>
-</li>
-        <li class="public ">
-  <span class="summary_signature">
-      <a href="#process-instance_method" title="#process (instance method)">- (Object) <strong>process</strong>(wreq, wres) </a>
-  </span>
-    <span class="summary_desc"><div class='inline'>Processes an individual request from Mongrel through Webmachine.</div></span>
-</li>
-    </ul>
-  <div id="constructor_details" class="method_details_list">
-  <h2>Constructor Details</h2>
-    <div class="method_details first">
-  <p class="signature first" id="initialize-instance_method">
-    - (<tt><span class='object_link'><a href="" title="Webmachine::Adapters::Mongrel::Handler (class)">Handler</a></span></tt>) <strong>initialize</strong>(dispatcher)
-</p><div class="docstring">
-  <div class="discussion">
-    A new instance of Handler
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-31
-32
-33
-34</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/adapters/mongrel.rb', line 31</span>
-<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id dispatcher'>dispatcher</span><span class='rparen'>)</span>
-  <span class='ivar'>@dispatcher</span> <span class='op'>=</span> <span class='id dispatcher'>dispatcher</span>
-  <span class='kw'>super</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-</div>
-  <div id="instance_method_details" class="method_details_list">
-    <h2>Instance Method Details</h2>
-      <div class="method_details first">
-  <p class="signature first" id="process-instance_method">
-    - (<tt>Object</tt>) <strong>process</strong>(wreq, wres)
-</p><div class="docstring">
-  <div class="discussion">
-    Processes an individual request from Mongrel through Webmachine.
-  </div>
-</div>
-<div class="tags">
-</div><table class="source_code">
-  <tr>
-    <td>
-      <pre class="lines">
-37
-38
-39
-40
-41
-42
-43
-44
-45
-46
-47
-48
-49
-50
-51
-52
-53
-54
-55
-56
-57
-58
-59
-60
-61
-62
-63
-64
-65
-66
-67
-68
-69
-70
-71
-72
-73
-74
-75
-76
-77
-78
-79
-80</pre>
-    </td>
-    <td>
-      <pre class="code"><span class="info file"># File 'lib/webmachine/adapters/mongrel.rb', line 37</span>
-<span class='kw'>def</span> <span class='id process'>process</span><span class='lparen'>(</span><span class='id wreq'>wreq</span><span class='comma'>,</span> <span class='id wres'>wres</span><span class='rparen'>)</span>
-  <span class='id header'>header</span> <span class='op'>=</span> <span class='const'>Webmachine</span><span class='op'>::</span><span class='const'>Headers</span><span class='period'>.</span><span class='id from_cgi'>from_cgi</span><span class='lparen'>(</span><span class='id wreq'>wreq</span><span class='period'>.</span><span class='id params'>params</span><span class='rparen'>)</span>
-  <span class='id request'>request</span> <span class='op'>=</span> <span class='const'>Webmachine</span><span class='op'>::</span><span class='const'>Request</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id wreq'>wreq</span><span class='period'>.</span><span class='id params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>REQUEST_METHOD</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='comma'>,</span>
-                                    <span class='const'>URI</span><span class='period'>.</span><span class='id parse'>parse</span><span class='lparen'>(</span><span class='id wreq'>wreq</span><span class='period'>.</span><span class='id params'>params</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>REQUEST_URI</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='rparen'>)</span><span class='comma'>,</span>
-                                    <span class='id header'>header</span><span class='comma'>,</span>
-                                    <span class='id wreq'>wreq</span><span class='period'>.</span><span class='id body'>body</span> <span class='op'>||</span> <span class='const'>StringIO</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span><span class='rparen'>)</span>
-  <span class='id response'>response</span> <span class='op'>=</span> <span class='const'>Webmachine</span><span class='op'>::</span><span class='const'>Response</span><span class='period'>.</span><span class='id new'>new</span>
-  <span class='ivar'>@dispatcher</span><span class='period'>.</span><span class='id dispatch'>dispatch</span><span class='lparen'>(</span><span class='id request'>request</span><span class='comma'>,</span> <span class='id response'>response</span><span class='rparen'>)</span>
-  <span class='kw'>begin</span>
-    <span class='id wres'>wres</span><span class='period'>.</span><span class='id status'>status</span> <span class='op'>=</span> <span class='id response'>response</span><span class='period'>.</span><span class='id code'>code</span><span class='period'>.</span><span class='id to_i'>to_i</span>
-    <span class='id wres'>wres</span><span class='period'>.</span><span class='id send_status'>send_status</span><span class='lparen'>(</span><span class='kw'>nil</span><span class='rparen'>)</span>
-    <span class='id response'>response</span><span class='period'>.</span><span class='id headers'>headers</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id k'>k</span><span class='comma'>,</span> <span class='id vs'>vs</span><span class='op'>|</span>
-      <span class='id vs'>vs</span><span class='period'>.</span><span class='id split'>split</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>\n</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id v'>v</span><span class='op'>|</span>
-        <span class='id wres'>wres</span><span class='period'>.</span><span class='id header'>header</span><span class='lbracket'>[</span><span class='id k'>k</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id v'>v</span>
-      <span class='rbrace'>}</span>
-    <span class='rbrace'>}</span>
-    <span class='id wres'>wres</span><span class='period'>.</span><span class='id header'>header</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>Server</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='const'>Webmachine</span><span class='op'>::</span><span class='const'>SERVER_STRING</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>Mongrel/</span><span class='embexpr_beg'>#{</span><span class='op'>::</span><span class='const'>Mongrel</span><span class='op'>::</span><span class='const'>Const</span><span class='op'>::</span><span class='const'>MONGREL_VERSION</span><span class='rbrace'>}</span><span class='tstring_end'>&quot;</span></span><span class='rbracket'>]</span><span class='period'>.</span><span class='id join'>join</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'> </span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
-    <span class='id wres'>wres</span><span class='period'>.</span><span class='id send_header'>send_header</span>
-    <span class='kw'>case</span> <span class='id response'>response</span><span class='period'>.</span><span class='id body'>body</span>
-    <span class='kw'>when</span> <span class='const'>String</span>
-      <span class='id wres'>wres</span><span class='period'>.</span><span class='id write'>write</span> <span class='id response'>response</span><span class='period'>.</span><span class='id body'>body</span>
-      <span class='id wres'>wres</span><span class='period'>.</span><span class='id socket'>socket</span><span class='period'>.</span><span class='id flush'>flush</span>
-    <span class='kw'>when</span> <span class='const'>Enumerable</span>
-      <span class='const'>Webmachine</span><span class='op'>::</span><span class='const'>ChunkedBody</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='id response'>response</span><span class='period'>.</span><span class='id body'>body</span><span class='rparen'>)</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id part'>part</span><span class='op'>|</span>
-        <span class='id wres'>wres</span><span class='period'>.</span><span class='id write'>write</span> <span class='id part'>part</span>
-        <span class='id wres'>wres</span><span class='period'>.</span><span class='id socket'>socket</span><span class='period'>.</span><span class='id flush'>flush</span>
-      <span class='rbrace'>}</span>
-    <span class='kw'>else</span>
-      <span class='kw'>if</span> <span class='id response'>response</span><span class='period'>.</span><span class='id body'>body</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span><span class='lparen'>(</span><span class='symbol'>:call</span><span class='rparen'>)</span>
-        <span class='const'>Webmachine</span><span class='op'>::</span><span class='const'>ChunkedBody</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='const'>Array</span><span class='lparen'>(</span><span class='id response'>response</span><span class='period'>.</span><span class='id body'>body</span><span class='period'>.</span><span class='id call'>call</span><span class='rparen'>)</span><span class='rparen'>)</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id part'>part</span><span class='op'>|</span>
-          <span class='id wres'>wres</span><span class='period'>.</span><span class='id write'>write</span> <span class='id part'>part</span>
-          <span class='id wres'>wres</span><span class='period'>.</span><span class='id socket'>socket</span><span class='period'>.</span><span class='id flush'>flush</span>
-        <span class='rbrace'>}</span>
-      <span class='kw'>end</span>
-    <span class='kw'>end</span>
-  <span class='kw'>ensure</span>
-    <span class='id response'>response</span><span class='period'>.</span><span class='id body'>body</span><span class='period'>.</span><span class='id close'>close</span> <span class='kw'>if</span> <span class='id response'>response</span><span class='period'>.</span><span class='id body'>body</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='symbol'>:close</span>
-  <span class='kw'>end</span>
-<span class='kw'>end</span></pre>
-    </td>
-  </tr>
-</table>
-</div>
-  </div>
-</div>
-    <div id="footer">
-  Generated on Wed Jan  4 08:47:41 2012 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.7.3 (ruby-1.9.3).
-</div>
-  </body>
-</html>