resourceful 0.3.1 → 0.5.0

data/Manifest

@@ -1,34 +1,30 @@
-lib/resourceful.rb
-lib/resourceful/authentication_manager.rb
-lib/resourceful/util.rb
-lib/resourceful/resource.rb
-lib/resourceful/memcache_cache_manager.rb
+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/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/authentication_manager.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
+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
-README.markdown
 MIT-LICENSE

data/Rakefile

@@ -1,16 +1,22 @@
 require 'rubygems'
 require 'rake'
-require 'echoe'
+require 'lib/resourceful'
 
-Echoe.new('resourceful', '0.3.1') do |p|
-  p.description     = "An HTTP library for Ruby that takes advantage of everything HTTP has to offer."
-  p.url             = "http://github.com/paul/resourceful"
-  p.author          = "Paul Sadauskas"
-  p.email           = "psadauskas@gmail.com"
+begin
+  require 'echoe'
 
-  p.ignore_pattern  = ["pkg/*", "tmp/*"]
-  p.dependencies    = ['addressable', 'httpauth', 'rspec', 'facets', 'andand']
-  p.development_dependencies = ['thin', 'yard']
+  Echoe.new('resourceful', Resourceful::VERSION) do |p|
+    p.description     = "An HTTP library for Ruby that takes advantage of everything HTTP has to offer."
+    p.url             = "http://github.com/paul/resourceful"
+    p.author          = "Paul Sadauskas"
+    p.email           = "psadauskas@gmail.com"
+
+    p.ignore_pattern  = ["pkg/*", "tmp/*"]
+    p.dependencies    = ['addressable', 'httpauth', 'rspec', 'facets', 'andand']
+    p.development_dependencies = ['thin', 'yard', 'sinatra']
+  end
+rescue LoadError => e
+  puts "install 'echoe' gem to be able to build the gem"
 end
 
 require 'spec/rake/spectask'
@@ -19,7 +25,27 @@ desc 'Run all specs'
 Spec::Rake::SpecTask.new(:spec) do |t|
   t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
   t.libs << 'lib'
-  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_files = FileList['spec/acceptance/*_spec.rb'] 
+end
+
+desc 'Run the specs for the server'
+Spec::Rake::SpecTask.new('spec:server') do |t|
+  t.spec_opts << '--options' << 'spec/spec.opts' if File.exists?('spec/spec.opts')
+  t.libs << 'lib'
+  t.spec_files = FileList['spec/simple_sinatra_server_spec.rb'] 
+end
+
+begin 
+  require 'spec/simple_sinatra_server'
+  desc "Run the sinatra echo server, with loggin" 
+  task :server do
+    Sinatra::Default.set(
+      :run => true,
+      :logging => true
+    )
+  end
+rescue LoadError => e
+  puts "Install 'sinatra' gem to run the server"
 end
 
 desc 'Default: Run Specs'
@@ -28,11 +54,15 @@ task :default => :spec
 desc 'Run all tests'
 task :test => :spec
 
-require 'yard'
+begin
+  require 'yard'
 
-desc "Generate Yardoc"
-YARD::Rake::YardocTask.new do |t|
-  t.files = ['lib/**/*.rb', 'README.markdown']
+  desc "Generate Yardoc"
+  YARD::Rake::YardocTask.new do |t|
+    t.files = ['lib/**/*.rb', 'README.markdown']
+  end
+rescue LoadError => e
+  puts "Install 'yard' gem to generate docs"
 end
 
 desc "Update rubyforge documentation"

data/lib/resourceful.rb

@@ -1,28 +1,18 @@
-require 'resourceful/http_accessor'
 
-require 'resourceful/util'
+__DIR__ = File.dirname(__FILE__)
 
-# Resourceful is a library that provides a high level HTTP interface.
-module Resourceful
+$LOAD_PATH.unshift __DIR__ unless
+  $LOAD_PATH.include?(__DIR__) ||
+  $LOAD_PATH.include?(File.expand_path(__DIR__))
 
-  HOP_BY_HOP_HEADERS = %w{
-    Connection
-    Keep-Alive
-    Proxy-Authenticate
-    Proxy-Authorization
-    TE
-    Trailers
-    Transfer-Encoding
-    Upgrade
-  }
+require 'resourceful/util'
 
-  NON_MODIFIABLE_HEADERS = %w{
-    Content-Location
-    Content-MD5
-    ETag
-    Last-Modified
-    Expires
-  }
+require 'resourceful/header'
+require 'resourceful/http_accessor'
 
+# Resourceful is a library that provides a high level HTTP interface.
+module Resourceful
+  VERSION = "0.5.0"
+  RESOURCEFUL_USER_AGENT_TOKEN = "Resourceful/#{VERSION}(Ruby/#{RUBY_VERSION})"
 
 end

data/lib/resourceful/authentication_manager.rb

@@ -20,8 +20,9 @@ module Resourceful
     end
 
     def add_credentials(request)
-      authenticator = @authenticators.find { |authenticator| authenticator.can_handle?(request) }
-      authenticator.add_credentials_to(request) if authenticator
+      @authenticators.each do |authenticator|
+        authenticator.add_credentials_to(request) if authenticator.can_handle?(request)
+      end
     end
 
   end

data/lib/resourceful/cache_manager.rb

@@ -1,6 +1,7 @@
 require 'resourceful/header'
 require 'andand'
 require 'facets/kernel/returning'
+require 'digest/md5'
 
 module Resourceful
 
@@ -40,6 +41,13 @@ module Resourceful
     # @param uri<String>
     #   The uri of the resource to be invalidated
     def invalidate(uri); end
+
+    protected
+
+    # Returns an alphanumeric hash of a URI
+    def uri_hash(uri)
+      Digest::MD5.hexdigest(uri)
+    end
   end
 
   # This is the default cache, and does not do any caching. All lookups
@@ -70,7 +78,7 @@ module Resourceful
     end
 
     def store(request, response)
-      return unless response.cachable?
+      return unless response.cacheable?
 
       @collection[request.uri.to_s][request] = response
     end
@@ -80,6 +88,55 @@ module Resourceful
     end
   end  # class InMemoryCacheManager
 
+  # Stores cache entries in a directory on the filesystem. Similarly to the 
+  # InMemoryCacheManager there are no limits on storage, so this will eventually 
+  # eat up all your disk!
+  class FileCacheManager < AbstractCacheManager
+    # Create a new FileCacheManager
+    #
+    # @param [String] location
+    #   A directory on the filesystem to store cache entries. This directory
+    #   will be created if it doesn't exist
+    def initialize(location="/tmp/resourceful")
+      require 'fileutils'
+      require 'yaml'
+      @dir = FileUtils.mkdir_p(location)
+    end
+
+    def lookup(request)
+      returning(cache_entries_for(request)[request]) do |response|
+        response.authoritative = false if response
+      end
+    end
+
+    def store(request, response)
+      return unless response.cacheable?
+
+      entries = cache_entries_for(request)
+      entries[request] = response
+      File.open(cache_file(request.uri), "w") {|fh| fh.write( YAML.dump(entries) ) }
+    end
+
+    def invalidate(uri);
+      File.unlink(cache_file(uri));
+    end
+
+    private
+    
+    def cache_entries_for(request)
+      if File.readable?( cache_file(request.uri) )
+        YAML.load_file( cache_file(request.uri) )
+      else
+        Resourceful::CacheEntryCollection.new
+      end
+    end
+
+    def cache_file(uri)
+      "#{@dir}/#{uri_hash(uri)}"
+    end
+  end # class FileCacheManager
+
+  
   # The collection of cached entries.  Nominally all the entry in a
   # collection of this sort will be for the same resource but that is
   # not required to be true.

data/lib/resourceful/exceptions.rb

@@ -0,0 +1,34 @@
+
+module Resourceful
+
+  # This exception used to indicate that the request did not succeed.
+  # The HTTP response is included so that the appropriate actions can
+  # be taken based on the details of that response
+  class UnsuccessfulHttpRequestError < Exception
+    attr_reader :http_response, :http_request
+ 
+    # Initialize new error from the HTTP request and response attributes.
+    def initialize(http_request, http_response)
+      super("#{http_request.method} request to <#{http_request.uri}> failed with code #{http_response.code}")
+      @http_request = http_request
+      @http_response = http_response
+    end
+  end
+
+  class MalformedServerResponse < UnsuccessfulHttpRequestError
+  end
+      
+
+  # Exception indicating that the server used a content coding scheme
+  # that Resourceful is unable to handle.
+  class UnsupportedContentCoding < Exception
+  end
+
+  # Raised when a body is supplied, but not a content-type header
+  class MissingContentType < ArgumentError
+    def initialize
+      super("A Content-Type must be specified when an entity-body is supplied.")
+    end
+  end
+
+end

data/lib/resourceful/header.rb

@@ -25,6 +25,101 @@ module Resourceful
     def capitalize(k)
       k.to_s.downcase.gsub(/^.|[-_\s]./) { |x| x.upcase }.gsub('_', '-')
     end
+
+    def each_field(&blk)
+      to_hash.each { |k,v|
+        blk.call capitalize(k), v
+      }
+    end
+
+    HEADERS = %w[
+      Accept
+      Accept-Charset
+      Accept-Encoding
+      Accept-Language
+      Accept-Ranges
+      Age
+      Allow
+      Authorization
+      Cache-Control
+      Connection
+      Content-Encoding
+      Content-Language
+      Content-Length
+      Content-Location
+      Content-MD5
+      Content-Range
+      Content-Type
+      Date
+      ETag
+      Expect
+      Expires
+      From
+      Host
+      If-Match
+      If-Modified-Since
+      If-None-Match
+      If-Range
+      If-Unmodified-Since
+      Keep-Alive
+      Last-Modified
+      Location
+      Max-Forwards
+      Pragma
+      Proxy-Authenticate
+      Proxy-Authorization
+      Range
+      Referer
+      Retry-After
+      Server
+      TE
+      Trailer
+      Transfer-Encoding
+      Upgrade
+      User-Agent
+      Vary
+      Via
+      Warning
+      WWW-Authenticate
+    ]
+
+    HEADERS.each do |header|
+      const = header.upcase.gsub('-', '_')
+      meth  = header.downcase.gsub('-', '_')
+
+      class_eval <<-RUBY, __FILE__, __LINE__
+        #{const} = "#{header}".freeze    # ACCEPT = "accept".freeze
+
+        def #{meth}                      # def accept
+          self[#{const}]                 #   self[ACCEPT]
+        end                              # end
+
+        def #{meth}=(str)                # def accept=(str)
+          self[#{const}] = str           #   self[ACCEPT] = str
+        end                              # end
+      RUBY
+
+    end
+
+    HOP_BY_HOP_HEADERS = [
+      CONNECTION,
+      KEEP_ALIVE,
+      PROXY_AUTHENTICATE,
+      PROXY_AUTHORIZATION,
+      TE,
+      TRAILER,
+      TRANSFER_ENCODING,
+      UPGRADE
+    ].freeze
+
+    NON_MODIFIABLE_HEADERS = [
+      CONTENT_LOCATION,
+      CONTENT_MD5,
+      ETAG,
+      LAST_MODIFIED,
+      EXPIRES
+    ].freeze
+
   end
 end
 

data/lib/resourceful/http_accessor.rb

@@ -28,8 +28,6 @@ module Resourceful
   # provided by the Resourceful library.  Conceptually this object
   # acts a collection of all the resources available via HTTP.
   class HttpAccessor
-    RESOURCEFUL_VERSION = "0.3.1"
-    RESOURCEFUL_USER_AGENT_TOKEN = "Resourceful/#{RESOURCEFUL_VERSION}(Ruby/#{RUBY_VERSION})"
     
     # A logger object to which messages about the activities of this
     # object will be written.  This should be an object that responds

data/lib/resourceful/memcache_cache_manager.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/cache_manager"
+require "resourceful/cache_manager"
 
 require 'memcache'
 require 'facets/kernel/returning'
@@ -58,7 +58,7 @@ module Resourceful
     # @param [String] uri
     #   The uri of the resource to be invalidated
     def invalidate(uri)
-      @memcache.delete(Digest::MD5.hexdigest(uri))
+      @memcache.delete(uri_hash(uri))
     end
 
 
@@ -69,17 +69,7 @@ module Resourceful
     attr_reader :memcache
 
     def cache_entries_for(a_request)
-      @memcache.get(a_request.to_mc_key) || Resourceful::CacheEntryCollection.new
+      @memcache.get(uri_hash(a_request.uri)) || Resourceful::CacheEntryCollection.new
     end
   end
-  
-  module MemCacheKey
-    def to_mc_key
-      Digest::MD5.hexdigest(uri)
-    end
-  end
-
-  class Request
-    include MemCacheKey
-  end
 end