RubyGems - webmachine - Versions diffs - 0.1.0 - Mend

webmachine 0.1.0

Files changed (37) hide show

data/.gitignore +28 -0
data/Gemfile +16 -0
data/Guardfile +11 -0
data/README.md +89 -0
data/Rakefile +31 -0
data/examples/webrick.rb +19 -0
data/lib/webmachine/adapters/webrick.rb +74 -0
data/lib/webmachine/adapters.rb +15 -0
data/lib/webmachine/decision/conneg.rb +304 -0
data/lib/webmachine/decision/flow.rb +502 -0
data/lib/webmachine/decision/fsm.rb +79 -0
data/lib/webmachine/decision/helpers.rb +80 -0
data/lib/webmachine/decision.rb +12 -0
data/lib/webmachine/dispatcher/route.rb +85 -0
data/lib/webmachine/dispatcher.rb +40 -0
data/lib/webmachine/errors.rb +37 -0
data/lib/webmachine/headers.rb +16 -0
data/lib/webmachine/locale/en.yml +28 -0
data/lib/webmachine/request.rb +56 -0
data/lib/webmachine/resource/callbacks.rb +362 -0
data/lib/webmachine/resource/encodings.rb +36 -0
data/lib/webmachine/resource.rb +48 -0
data/lib/webmachine/response.rb +49 -0
data/lib/webmachine/streaming.rb +27 -0
data/lib/webmachine/translation.rb +11 -0
data/lib/webmachine/version.rb +4 -0
data/lib/webmachine.rb +19 -0
data/spec/spec_helper.rb +13 -0
data/spec/tests.org +57 -0
data/spec/webmachine/decision/conneg_spec.rb +152 -0
data/spec/webmachine/decision/flow_spec.rb +1030 -0
data/spec/webmachine/dispatcher/route_spec.rb +109 -0
data/spec/webmachine/dispatcher_spec.rb +34 -0
data/spec/webmachine/headers_spec.rb +19 -0
data/spec/webmachine/request_spec.rb +24 -0
data/webmachine.gemspec +44 -0
metadata +137 -0

data/lib/webmachine/resource.rb ADDED Viewed

@@ -0,0 +1,48 @@
+require 'webmachine/resource/callbacks'
+require 'webmachine/resource/encodings'
+module Webmachine
+  # Resource is the primary building block of Webmachine applications,
+  # and describes families of HTTP resources. It includes all of the
+  # methods you might want to override to customize the behavior of
+  # the resource.  The simplest resource family you can implement
+  # looks like this:
+  #
+  #    class HelloWorldResource < Webmachine::Resource
+  #      def to_html
+  #        "<html><body>Hello, world!</body></html>"
+  #      end
+  #    end
+  #
+  # For more information about how response decisions are made in
+  # Webmachine based on your resource class, refer to the diagram at
+  # {http://webmachine.basho.com/images/http-headers-status-v3.png}.
+  class Resource
+    include Callbacks
+    include Encodings
+    attr_reader :request, :response
+    # Creates a new {Resource}, initializing it with the request and
+    # response. Note that you may still override {#initialize} to
+    # initialize your resource. It will be called after the request
+    # and response ivars are set.
+    # @param [Request] request the request object
+    # @param [Response] response the response object
+    # @return [Resource] the new resource
+    def self.new(request, response)
+      instance = allocate
+      instance.instance_variable_set(:@request, request)
+      instance.instance_variable_set(:@response, response)
+      instance.send :initialize
+      instance
+    end
+    private
+    # When no specific charsets are provided, this acts as an identity
+    # on the response body. Probably deserves some refactoring.
+    def charset_nop(x)
+      x
+    end
+  end
+end

data/lib/webmachine/response.rb ADDED Viewed

@@ -0,0 +1,49 @@
+module Webmachine
+  # Represents an HTTP response from Webmachine.
+  class Response
+    # @return [Hash] Response headers that will be sent to the client
+    attr_reader :headers
+    # @return [Fixnum] The HTTP status code of the response
+    attr_accessor :code
+    # @return [String, #each] The response body
+    attr_accessor :body
+    # @return [true,false] Whether the response is a redirect
+    attr_accessor :redirect
+    # @return [Array] the list of states that were traversed
+    attr_reader :trace
+    # @return [Symbol] When an error has occurred, the last state the
+    #   FSM was in
+    attr_accessor :end_state
+    # @return [String] The error message when responding with an error
+    #   code
+    attr_accessor :error
+    # Creates a new Response object with the appropriate defaults.
+    def initialize
+      @headers = {}
+      @trace = []
+      self.code = 200
+      self.redirect = false
+    end
+    # Indicate that the response should be a redirect. This is only
+    # used when processing a POST request in {Callbacks#process_post}
+    # to indicate that the client should request another resource
+    # using GET. Either pass the URI of the target resource, or
+    # manually set the Location header using {#headers}.
+    # @param [String, URI] location the target of the redirection
+    def do_redirect(location=nil)
+      headers['Location'] = location.to_s if location
+      self.redirect = true
+    end
+    alias :is_redirect? :redirect
+    alias :redirect_to :do_redirect
+  end
+end

data/lib/webmachine/streaming.rb ADDED Viewed

@@ -0,0 +1,27 @@
+module Webmachine
+  class StreamingEncoder
+    def initialize(resource, encoder, charsetter, body)
+      @resource, @encoder, @charsetter, @body = resource, encoder, charsetter, body
+    end
+  end
+  class EnumerableEncoder < StreamingEncoder
+    include Enumerable
+    def each
+      body.each do |block|
+        yield @resource.send(@encoder, resource.send(@charsetter, block))
+      end
+    end
+  end
+  class CallableEncoder < StreamingEncoder
+    def call
+      @resource.send(@encoder, @resource.send(@charsetter, body.call))
+    end
+    def to_proc
+      method(:call).to_proc
+    end
+  end
+end

data/lib/webmachine/translation.rb ADDED Viewed

@@ -0,0 +1,11 @@
+require 'i18n'
+I18n.config.load_path << File.expand_path("../locale/en.yml", __FILE__)
+module Webmachine
+  module Translation
+    def t(key, options={})
+      ::I18n.t(key, options.merge(:scope => :webmachine))
+    end
+  end
+end

data/lib/webmachine/version.rb ADDED Viewed

@@ -0,0 +1,4 @@
+module Webmachine
+  VERSION = "0.1.0"
+  SERVER_STRING = "Webmachine-Ruby/#{VERSION}"
+end

data/lib/webmachine.rb ADDED Viewed

@@ -0,0 +1,19 @@
+require 'webmachine/headers'
+require 'webmachine/request'
+require 'webmachine/response'
+require 'webmachine/errors'
+require 'webmachine/decision'
+require 'webmachine/streaming'
+require 'webmachine/adapters'
+require 'webmachine/dispatcher'
+require 'webmachine/resource'
+require 'webmachine/version'
+# Webmachine is a toolkit for making well-behaved HTTP applications.
+# It is based on the Erlang library of the same name.
+module Webmachine
+  # Starts Webmachine serving requests
+  def self.run
+    Adapters.const_get(adapter).run
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,13 @@
+$LOAD_PATH << File.expand_path("..", __FILE__)
+$LOAD_PATH << File.expand_path("../../lib", __FILE__)
+require 'rubygems'
+require 'webmachine'
+require 'rspec'
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.filter_run :focus => true
+  config.run_all_when_everything_filtered = true
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+end

data/spec/tests.org ADDED Viewed

@@ -0,0 +1,57 @@
+* 2,2 Basic Rules
+  - HTTP/1.1 header field values can be folded onto multiple lines if
+    the continuation line begins with a space or horizontal tab. All
+    linear white space, including folding, has the same semantics as
+    SP. A recipient MAY replace any linear white space with a single
+    SP before interpreting the field value or forwarding the message
+    downstream.
+  - Many HTTP/1.1 header field values consist of words separated by
+    LWS or special characters. These special characters MUST be in a
+    quoted string to be used within a parameter value (as defined in
+    section 3.6).
+* 3.1 HTTP Version
+  - Note that the major and minor numbers MUST be treated as separate
+    integers and that each MAY be incremented higher than a single
+    digit.
+  - Leading zeros MUST be ignored by recipients and MUST NOT be sent.
+  - An application that sends a request or response message that
+    includes HTTP-Version of "HTTP/1.1" MUST be at least conditionally
+    compliant with this specification.
+  - Applications that are at least conditionally compliant with this
+    specification SHOULD use an HTTP-Version of "HTTP/1.1" in their
+    messages, and MUST do so for any message that is not compatible
+    with HTTP/1.0.
+  - Since the protocol version indicates the protocol capability of
+    the sender, a proxy/gateway MUST NOT send a message with a version
+    indicator which is greater than its actual version. If a higher
+    version request is received, the proxy/gateway MUST either
+    downgrade the request version, or respond with an error, or switch
+    to tunnel behavior.
+  - Due to interoperability problems with HTTP/1.0 proxies discovered
+    since the publication of RFC 2068 [33], caching proxies MUST,
+    gateways MAY, and tunnels MUST NOT upgrade the request to the
+    highest version they support. The proxy/gateway's response to that
+    request MUST be in the same major version as the request.
+* 3.2 URIs
+** General Syntax
+   - Servers MUST be able to handle the URI of any resource they serve.
+   - Servers SHOULD be able to handle URIs of unbounded length if they
+     provide GET-based forms that could generate such URIs.
+   - A server SHOULD return 414 (Request-URI Too Long) status if a URI
+     is longer than the server can handle
+** http URL
+   - If the abs_path is not present in the URL, it MUST be given as
+     "/" when used as a Request-URI for a resource.
+   - If a proxy receives a fully qualified domain name, the proxy MUST
+     NOT change the host name.
+** URI Comparison
+   - When comparing two URIs to decide if they match or not, a client
+     SHOULD use a case-sensitive octet-by-octet comparison of the
+     entire URIs, with these exceptions:
+     - A port that is empty or not given is equivalent to the default
+       port for that URI-reference
+     - Comparisons of host names MUST be case-insensitive
+     - Comparisons of scheme names MUST be case-insensitive
+     - An empty abs_path is equivalent to an abs_path of "/"
+* 3.3 Date/Time Formats

data/spec/webmachine/decision/conneg_spec.rb ADDED Viewed

@@ -0,0 +1,152 @@
+require 'spec_helper'
+describe Webmachine::Decision::Conneg do
+  let(:request) { Webmachine::Request.new("GET", URI.parse("http://localhost:8080/"), Webmachine::Headers["accept" => "*/*"], "") }
+  let(:response) { Webmachine::Response.new }
+  let(:resource) do
+    Class.new(Webmachine::Resource) do
+      def to_html; "hello world!"; end
+    end
+  end
+  subject do
+    Webmachine::Decision::FSM.new(resource, request, response)
+  end
+  context "choosing a media type" do
+    it "should not choose a type when none are provided" do
+      subject.choose_media_type([], "*/*").should be_nil
+    end
+    it "should not choose a type when none are acceptable" do
+      subject.choose_media_type(["text/html"], "application/json").should be_nil
+    end
+    it "should choose the first acceptable type" do
+      subject.choose_media_type(["text/html", "application/xml"],
+                                "application/xml, text/html, */*").should == "application/xml"
+    end
+    it "should choose the type that matches closest when matching subparams" do
+      subject.choose_media_type(["text/html",
+                                 ["text/html", {"charset" => "iso8859-1"}]],
+                                "text/html;charset=iso8859-1, application/xml").
+        should == "text/html;charset=iso8859-1"
+    end
+    it "should choose the preferred type over less-preferred types" do
+      subject.choose_media_type(["text/html", "application/xml"],
+                                "application/xml;q=0.7, text/html, */*").should == "text/html"
+    end
+    it "should raise an exception when a media-type is improperly formatted" do
+      expect {
+        subject.choose_media_type(["text/html", "application/xml"],
+                                  "bah;")
+      }.to raise_error(Webmachine::MalformedRequest)
+    end
+  end
+  context "choosing an encoding" do
+    it "should not set the encoding when none are provided" do
+      subject.choose_encoding({}, "identity, gzip")
+      subject.metadata['Content-Encoding'].should be_nil
+      subject.response.headers['Content-Encoding'].should be_nil
+    end
+    it "should not set the Content-Encoding header when it is identity" do
+      subject.choose_encoding({"gzip"=> :encode_gzip, "identity" => :encode_identity}, "identity")
+      subject.metadata['Content-Encoding'].should == 'identity'
+      response.headers['Content-Encoding'].should be_nil
+    end
+    it "should choose the first acceptable encoding" do
+      subject.choose_encoding({"gzip" => :encode_gzip}, "identity, gzip")
+      subject.metadata['Content-Encoding'].should == 'gzip'
+      response.headers['Content-Encoding'].should == 'gzip'
+    end
+    it "should choose the preferred encoding over less-preferred encodings" do
+      subject.choose_encoding({"gzip" => :encode_gzip, "identity" => :encode_identity}, "gzip, identity;q=0.7")
+      subject.metadata['Content-Encoding'].should == 'gzip'
+      response.headers['Content-Encoding'].should == 'gzip'
+    end
+    it "should not set the encoding if none are acceptable" do
+      subject.choose_encoding({"gzip" => :encode_gzip}, "identity")
+      subject.metadata['Content-Encoding'].should be_nil
+      response.headers['Content-Encoding'].should be_nil
+    end
+  end
+  context "choosing a charset" do
+    it "should not set the charset when none are provided" do
+      subject.choose_charset([], "ISO-8859-1")
+      subject.metadata['Charset'].should be_nil
+    end
+    it "should choose the first acceptable charset" do
+      subject.choose_charset([["UTF-8", :to_utf8],["US-ASCII", :to_ascii]], "US-ASCII, UTF-8")
+      subject.metadata['Charset'].should == "US-ASCII"
+    end
+    it "should choose the preferred charset over less-preferred charsets" do
+      subject.choose_charset([["UTF-8", :to_utf8],["US-ASCII", :to_ascii]], "US-ASCII;q=0.7, UTF-8")
+      subject.metadata['Charset'].should == "UTF-8"
+    end
+    it "should not set the charset if none are acceptable" do
+      subject.choose_charset([["UTF-8", :to_utf8],["US-ASCII", :to_ascii]], "ISO-8859-1")
+      subject.metadata['Charset'].should be_nil
+    end
+    it "should choose a charset case-insensitively" do
+      subject.choose_charset([["UtF-8", :to_utf8],["US-ASCII", :to_ascii]], "iso-8859-1, utf-8")
+      subject.metadata['Charset'].should == "utf-8"
+    end
+  end
+  context "choosing a language" do
+    it "should not set the language when none are provided" do
+      subject.choose_language([], "en")
+      subject.metadata['Language'].should be_nil
+    end
+    it "should choose the first acceptable language" do
+      subject.choose_language(['en', 'en-US', 'es'], "en-US, es")
+      subject.metadata['Language'].should == "en-US"
+      response.headers['Content-Language'].should == "en-US"
+    end
+    it "should choose the preferred language over less-preferred languages" do
+      subject.choose_language(['en', 'en-US', 'es'], "en-US;q=0.6, es")
+      subject.metadata['Language'].should == "es"
+      response.headers['Content-Language'].should == "es"
+    end
+    it "should select the first language if all are acceptable" do
+      subject.choose_language(['en', 'fr', 'es'], "*")
+      subject.metadata['Language'].should == "en"
+      response.headers['Content-Language'].should == "en"
+    end
+    it "should select the closest acceptable language when an exact match is not available" do
+      subject.choose_language(['en-US', 'es'], "en, fr")
+      subject.metadata['Language'].should == 'en-US'
+      response.headers['Content-Language'].should == 'en-US'
+    end
+    it "should not set the language if none are acceptable" do
+      subject.choose_language(['en'], 'es')
+      subject.metadata['Language'].should be_nil
+      response.headers.should_not include('Content-Language')
+    end
+    it "should choose a language case-insensitively" do
+      subject.choose_language(['en-US', 'ZH'], 'zh-ch, EN')
+      subject.metadata['Language'].should == 'en-US'
+      response.headers['Content-Language'].should == 'en-US'
+    end
+  end
+end