paul-resourceful 0.3.1 → 0.5.0

data/lib/resourceful/response.rb

@@ -5,13 +5,10 @@ require 'facets/kernel/ergo'
 require 'zlib'
 
 module Resourceful
-  # Exception indicating that the server used a content coding scheme
-  # that Resourceful is unable to handle.
-  class UnsupportedContentCoding < Exception
-  end
 
   class Response
     REDIRECT_RESPONSE_CODES = [301,302,303,307]
+    NORMALLY_CACHEABLE_RESPONSE_CODES = [200, 203, 300, 301, 410]
 
     attr_reader :uri, :code, :header, :body, :response_time
     alias headers header
@@ -24,98 +21,15 @@ module Resourceful
       @response_time = Time.now
     end
 
-    # Is the response code sucessful? True for only 2xx series
-    # response codes.
-    #
-    # @return true|false
-    def is_success?
-      @code.in? 200..299
-    end
-    alias was_successful? is_success?
-
-    # Is the response the result of a server error? True for
-    # 5xx series response codes
-    #
-    # @return true|false
-    def is_server_error?
-      @code.in? 500..599
-    end
-    alias was_server_error? is_server_error?
-
-    # Is the response the result of a client error? True for
-    # 4xx series response codes
-    #
-    # @return true|false
-    def is_client_error?
-      @code.in? 400..499
-    end
-    alias was_client_error? is_client_error?
-
-    # Is the response the result of any kind of error? True for
-    # 4xx and 5xx series response codes
-    #
-    # @return true|false
-    def is_error?
-      is_server_error? || is_client_error?
-    end
-    alias was_error? is_error?
-
-    # Is the response not a success? True for
-    # 3xx, 4xx and 5xx series response codes
-    #
-    # @return true|false
-    def is_unsuccesful?
-      is_error? || is_redirect?
-    end
-    alias was_unsuccessful? is_unsuccesful?
-
-    # Is the response a redirect response code? True for
-    # 3xx codes that are redirects (301, 302, 303, 307)
-    #
-    # @return true|false
-    def is_redirect?
-      @code.in? REDIRECT_RESPONSE_CODES
-    end
-    alias was_redirect? is_redirect?
-
-    # Is the response a Permanent Redirect (301) ?
-    #
-    # @return true|false
-    def is_permanent_redirect?
-      @code == 301
-    end
-
-    # Is the response a Temporary Redirect (anything but 301) ?
-    #
-    # @return true|false
-    def is_temporary_redirect?
-      is_redirect? and not is_permanent_redirect?
-    end
-
-    # Is the response a client error of Not Authorized (401) ?
-    #
-    # @return true|false
-    def is_not_authorized?
-      @code == 401
-    end
-
-    # Is the response not modified (304) ?
-    #
-    # @return true|false
-    def is_not_modified?
-      @code == 304
-    end
-  
     # Is this a cached response that has expired?
     #
     # @return true|false
     def expired?
-      if header['Expire']
-        return true if Time.httpdate(header['Expire'].first) < Time.now
-      end
       if header['Cache-Control'] and header['Cache-Control'].first.include?('max-age')
         max_age = header['Cache-Control'].first.split(',').grep(/max-age/).first.split('=').last.to_i
         return true if current_age > max_age
+      elsif header['Expire']
+        return true if Time.httpdate(header['Expire'].first) < Time.now
       end
 
       false
@@ -137,21 +51,37 @@ module Resourceful
     # Is this response cachable?
     #
     # @return true|false
-    def cachable?
-      return false if header['Vary'] and header['Vary'].include?('*')
-      return false if header['Cache-Control'] and header['Cache-Control'].include?('no-store')
+    def cacheable?
+      @cacheable ||= begin
+        @cacheable = true  if NORMALLY_CACHEABLE_RESPONSE_CODES.include?(code.to_i)
+        @cacheable = false if header.vary && header.vary.include?('*')
+        @cacheable = false if header.cache_control && header.cache_control.include?('no-cache')
+        @cacheable = true  if header.cache_control && header.cache_control.include?('public')
+        @cacheable = true  if header.cache_control && header.cache_control.include?('private')
+        @cacheable || false
+      end
+    end
 
-      true
+    # Does this response force revalidation?
+    def must_be_revalidated?
+      header.cache_control && header.cache_control.include?('must-revalidate')
+    end
+    
+    # Update our headers from a later 304 response
+    def revalidate!(not_modified_response)
+      header.merge!(not_modified_response.header)
+      request_time = not_modified_response.request_time
+      @authoritative = true
     end
 
     # Algorithm taken from RCF2616#13.2.3
     def current_age
-      age_value   = Time.httpdate(header['Age'].first) if header['Age']
+      age_value   = header['Age'] ? header['Age'].first.to_i : 0
       date_value  = Time.httpdate(header['Date'].first)
       now         = Time.now
 
       apparent_age = [0, response_time - date_value].max
-      corrected_received_age = [apparent_age, age_value || 0].max
+      corrected_received_age = [apparent_age, age_value].max
       current_age = corrected_received_age + (response_time - request_time) + (now - response_time)
     end
 
@@ -170,6 +100,123 @@ module Resourceful
         raise UnsupportedContentCoding, "Resourceful does not support #{header['Content-Encoding'].ergo.first} content coding" 
       end
     end
+
+    CODE_NAMES = {
+      100 => "Continue".freeze,
+      101 => "Switching Protocols".freeze,
+
+      200 => "OK".freeze,
+      201 => "Created".freeze,
+      202 => "Accepted".freeze,
+      203 => "Non-Authoritative Information".freeze,
+      204 => "No Content".freeze,
+      205 => "Reset Content".freeze,
+      206 => "Partial Content".freeze,
+
+      300 => "Multiple Choices".freeze,
+      301 => "Moved Permanently".freeze,
+      302 => "Found".freeze,
+      303 => "See Other".freeze,
+      304 => "Not Modified".freeze,
+      305 => "Use Proxy".freeze,
+      307 => "Temporary Redirect".freeze,
+
+      400 => "Bad Request".freeze,
+      401 => "Unauthorized".freeze,
+      402 => "Payment Required".freeze,
+      403 => "Forbidden".freeze,
+      404 => "Not Found".freeze,
+      405 => "Method Not Allowed".freeze,
+      406 => "Not Acceptable".freeze,
+      407 => "Proxy Authentication Required".freeze,
+      408 => "Request Timeout".freeze,
+      409 => "Conflict".freeze,
+      410 => "Gone".freeze,
+      411 => "Length Required".freeze,
+      412 => "Precondition Failed".freeze,
+      413 => "Request Entity Too Large".freeze,
+      414 => "Request-URI Too Long".freeze,
+      415 => "Unsupported Media Type".freeze,
+      416 => "Requested Range Not Satisfiable".freeze,
+      417 => "Expectation Failed".freeze,
+
+      500 => "Internal Server Error".freeze,
+      501 => "Not Implemented".freeze,
+      502 => "Bad Gateway".freeze,
+      503 => "Service Unavailable".freeze,
+      504 => "Gateway Timeout".freeze,
+      505 => "HTTP Version Not Supported".freeze,
+    }.freeze
+
+    CODES = CODE_NAMES.keys
+
+    CODE_NAMES.each do |code, msg|
+      method_name = msg.downcase.gsub(/[- ]/, "_")
+
+      class_eval <<-RUBY
+        def #{method_name}?                           # def ok?
+          @code == #{code}                            #   @code == 200
+        end                                           # end
+      RUBY
+    end
+
+    # Is the response informational? True for
+    # 1xx series response codes
+    #
+    # @return true|false
+    def informational?
+      @code.in? 100..199
+    end
+
+    # Is the response code sucessful? True for only 2xx series
+    # response codes.
+    #
+    # @return true|false
+    def successful?
+      @code.in? 200..299
+    end
+    alias success? successful?
+
+    # Is the response a redirect? True for
+    # 3xx series response codes
+    #
+    # @return true|false
+    def redirection?
+      @code.in? 300..399
+    end
+
+    # Is the response a actual redirect? True for
+    # 301, 302, 303, 307 response codes
+    #
+    # @return true|false
+    def redirect?
+      @code.in? REDIRECT_RESPONSE_CODES
+    end
+
+    # Is the response the result of a client error? True for
+    # 4xx series response codes
+    #
+    # @return true|false
+    def client_error?
+      @code.in? 400..499
+    end
+
+    # Is the response the result of a server error? True for
+    # 5xx series response codes
+    #
+    # @return true|false
+    def server_error?
+      @code.in? 500..599
+    end
+
+    # Is the response the result of any kind of error? True for
+    # 4xx and 5xx series response codes
+    #
+    # @return true|false
+    def error?
+      server_error? || client_error?
+    end
+
   end
   
 end

data/resourceful.gemspec

@@ -2,26 +2,25 @@
 
 Gem::Specification.new do |s|
   s.name = %q{resourceful}
-  s.version = "0.3.1"
+  s.version = "0.5.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Paul Sadauskas"]
-  s.date = %q{2008-12-05}
+  s.date = %q{2009-05-18}
   s.description = %q{An HTTP library for Ruby that takes advantage of everything HTTP has to offer.}
   s.email = %q{psadauskas@gmail.com}
-  s.extra_rdoc_files = ["lib/resourceful.rb", "lib/resourceful/authentication_manager.rb", "lib/resourceful/util.rb", "lib/resourceful/resource.rb", "lib/resourceful/memcache_cache_manager.rb", "lib/resourceful/net_http_adapter.rb", "lib/resourceful/http_accessor.rb", "lib/resourceful/stubbed_resource_proxy.rb", "lib/resourceful/header.rb", "lib/resourceful/cache_manager.rb", "lib/resourceful/options_interpreter.rb", "lib/resourceful/response.rb", "lib/resourceful/request.rb", "README.markdown"]
-  s.files = ["lib/resourceful.rb", "lib/resourceful/authentication_manager.rb", "lib/resourceful/util.rb", "lib/resourceful/resource.rb", "lib/resourceful/memcache_cache_manager.rb", "lib/resourceful/net_http_adapter.rb", "lib/resourceful/http_accessor.rb", "lib/resourceful/stubbed_resource_proxy.rb", "lib/resourceful/header.rb", "lib/resourceful/cache_manager.rb", "lib/resourceful/options_interpreter.rb", "lib/resourceful/response.rb", "lib/resourceful/request.rb", "spec/acceptance_shared_specs.rb", "spec/spec.opts", "spec/acceptance_spec.rb", "spec/simple_http_server_shared_spec_spec.rb", "spec/spec_helper.rb", "spec/resourceful/header_spec.rb", "spec/resourceful/authentication_manager_spec.rb", "spec/resourceful/memcache_cache_manager_spec.rb", "spec/resourceful/response_spec.rb", "spec/resourceful/options_interpreter_spec.rb", "spec/resourceful/http_accessor_spec.rb", "spec/resourceful/stubbed_resource_proxy_spec.rb", "spec/resourceful/request_spec.rb", "spec/resourceful/resource_spec.rb", "spec/resourceful/cache_manager_spec.rb", "spec/resourceful/net_http_adapter_spec.rb", "spec/simple_http_server_shared_spec.rb", "Manifest", "Rakefile", "README.markdown", "MIT-LICENSE", "resourceful.gemspec"]
-  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.markdown", "lib/resourceful/cache_manager.rb", "lib/resourceful/exceptions.rb", "lib/resourceful/net_http_adapter.rb", "lib/resourceful/stubbed_resource_proxy.rb", "lib/resourceful/header.rb", "lib/resourceful/authentication_manager.rb", "lib/resourceful/request.rb", "lib/resourceful/resource.rb", "lib/resourceful/response.rb", "lib/resourceful/util.rb", "lib/resourceful/http_accessor.rb", "lib/resourceful/options_interpreter.rb", "lib/resourceful/memcache_cache_manager.rb", "lib/resourceful.rb"]
+  s.files = ["Manifest", "spec/spec.opts", "spec/simple_sinatra_server_spec.rb", "spec/simple_sinatra_server.rb", "spec/acceptance/header_spec.rb", "spec/acceptance/caching_spec.rb", "spec/acceptance/resource_spec.rb", "spec/acceptance/redirecting_spec.rb", "spec/acceptance/authorization_spec.rb", "spec/acceptance_shared_specs.rb", "spec/spec_helper.rb", "spec/old_acceptance_specs.rb", "README.markdown", "resourceful.gemspec", "lib/resourceful/cache_manager.rb", "lib/resourceful/exceptions.rb", "lib/resourceful/net_http_adapter.rb", "lib/resourceful/stubbed_resource_proxy.rb", "lib/resourceful/header.rb", "lib/resourceful/authentication_manager.rb", "lib/resourceful/request.rb", "lib/resourceful/resource.rb", "lib/resourceful/response.rb", "lib/resourceful/util.rb", "lib/resourceful/http_accessor.rb", "lib/resourceful/options_interpreter.rb", "lib/resourceful/memcache_cache_manager.rb", "lib/resourceful.rb", "Rakefile", "MIT-LICENSE"]
   s.homepage = %q{http://github.com/paul/resourceful}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Resourceful", "--main", "README.markdown"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{resourceful}
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.3}
   s.summary = %q{An HTTP library for Ruby that takes advantage of everything HTTP has to offer.}
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<addressable>, [">= 0"])
@@ -31,6 +30,7 @@ Gem::Specification.new do |s|
       s.add_runtime_dependency(%q<andand>, [">= 0"])
       s.add_development_dependency(%q<thin>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<sinatra>, [">= 0"])
     else
       s.add_dependency(%q<addressable>, [">= 0"])
       s.add_dependency(%q<httpauth>, [">= 0"])
@@ -39,6 +39,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<andand>, [">= 0"])
       s.add_dependency(%q<thin>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<sinatra>, [">= 0"])
     end
   else
     s.add_dependency(%q<addressable>, [">= 0"])
@@ -48,5 +49,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<andand>, [">= 0"])
     s.add_dependency(%q<thin>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<sinatra>, [">= 0"])
   end
 end

data/spec/acceptance/authorization_spec.rb

@@ -0,0 +1,16 @@
+
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'resourceful'
+
+describe Resourceful do
+
+  describe "basic auth" do
+
+  end
+
+  describe "digest auth" do
+
+  end
+
+end
+

data/spec/acceptance/caching_spec.rb

@@ -0,0 +1,191 @@
+
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'resourceful'
+
+describe Resourceful do
+
+  describe "caching" do
+
+    before do
+      @http = Resourceful::HttpAccessor.new(:cache_manager => Resourceful::InMemoryCacheManager.new)
+      if ENV['SPEC_LOGGING']
+        @http.logger = Resourceful::StdOutLogger.new
+      end
+    end
+
+    def get_with_errors(resource)
+      begin
+        resp = resource.get
+      rescue Resourceful::UnsuccessfulHttpRequestError => e
+        resp = e.http_response
+      end
+      resp
+    end
+
+    def uri_plus_params(uri, params = {})
+      uri = uri.is_a?(Addressable::URI) ? uri : Addressable::URI.parse(uri)
+      uri.query_values = params
+      uri
+    end
+
+    def uri_for_code(code, params = {})
+      uri = Addressable::URI.expand_template("http://localhost:3000/code/{code}",
+                                             "code" => code.to_s)
+
+      uri_plus_params(uri, params)
+    end
+
+    describe "response cacheability" do
+      Resourceful::Response::NORMALLY_CACHEABLE_RESPONSE_CODES.each do |code|
+        describe "response code #{code}" do
+          it "should normally be cached" do
+            resource = @http.resource(uri_for_code(code))
+
+            resp = get_with_errors(resource)
+            resp.should be_cacheable
+          end
+
+          it "should not be cached if Vary: *" do
+            resource = @http.resource(uri_for_code(200, "Vary" => "*"))
+
+            resp = get_with_errors(resource)
+            resp.should_not be_cacheable
+          end
+
+          it "should not be cached if Cache-Control: no-cache'" do
+            resource = @http.resource(uri_for_code(200, "Cache-Control" => "no-cache"))
+
+            resp = get_with_errors(resource)
+            resp.should_not be_cacheable
+          end
+        end
+      end
+
+      # I would prefer to do all other codes, but some of them do some magic stuff (100),
+      # so I'll just spot check. 
+      [201, 206, 302, 307, 404, 500].each do |code|
+        describe "response code #{code}" do
+          it "should not normally be cached" do
+            resource = @http.resource(uri_for_code(code))
+
+            resp = get_with_errors(resource)
+            resp.should_not be_cacheable
+          end
+          
+          it "should be cached if Cache-Control: public" do
+            resource = @http.resource(uri_for_code(code, "Cache-Control" => "public"))
+
+            resp = get_with_errors(resource)
+            resp.should be_cacheable
+          end
+
+          it "should be cached if Cache-Control: private" do
+            resource = @http.resource(uri_for_code(code, "Cache-Control" => "private"))
+
+            resp = get_with_errors(resource)
+            resp.should be_cacheable
+          end
+        end
+      end
+
+    end
+
+    describe "expiration" do
+      it 'should use the cached response if Expire: is in the future' do
+        in_the_future = (Time.now + 60).httpdate
+        resource = @http.resource(uri_for_code(200, "Expire" => in_the_future))
+
+        resp = resource.get
+        resp.should_not be_expired
+
+        resp = resource.get
+        resp.should be_ok
+        resp.should_not be_authoritative
+      end
+
+      it 'should revalidate the cached response if the response is expired' do
+        in_the_past = (Time.now - 60).httpdate
+        resource = @http.resource(uri_for_code(200, "Expire" => in_the_past))
+
+        resp = resource.get
+        resp.should be_expired
+
+        resp = resource.get
+        resp.should be_ok
+        resp.should be_authoritative
+      end
+    end
+
+    describe 'authoritative' do
+
+      it "should be authoritative if the response is directly from the server" do
+        resource = @http.resource(
+          uri_plus_params('http://localhost:3000/', "Cache-Control" => 'max-age=10')
+        )
+
+        response  = resource.get
+        response.should be_authoritative
+      end
+
+      it "should be authoritative if a cached response was revalidated with the server" do
+        now = Time.now.httpdate
+        resource = @http.resource(
+          uri_plus_params('http://localhost:3000/cached', 
+                          "modified" => now, 
+                          "Cache-Control" => 'max-age=0')
+        )
+
+        resource.get
+        response = resource.get("Cache-Control" => "max-age=0")
+        response.should be_authoritative
+      end
+
+      it "should not be authoritative if the cached response was not revalidated" do
+        now = Time.now.httpdate
+        resource = @http.resource(
+          uri_plus_params('http://localhost:3000/cached', 
+                          "modified" => now, 
+                          "Cache-Control" => 'max-age=10')
+        )
+
+        resource.get
+        response = resource.get
+        response.should_not be_authoritative
+
+      end
+
+    end
+    
+    describe "Not Modified responses" do
+      before do
+        now = Time.now.httpdate
+
+        resource = @http.resource(
+          uri_plus_params('http://localhost:3000/cached', 
+                          "modified" => now, 
+                          "Cache-Control" => 'max-age=0')
+        )
+
+        @first_response  = resource.get
+        @second_response = resource.get("Cache-Control" => "max-age=0") # Force revalidation
+      end
+
+      it "should replace the 304 response with whats in the cache" do
+        @second_response.code.should == @first_response.code
+      end
+
+      it "should provide a body identical to the original response" do
+        @second_response.body.should == @first_response.body
+      end
+
+      it "should override any cached headers with new ones"
+    end
+
+    describe "cache invalidation" do
+
+    end
+
+  end
+
+end
+