resourceful 0.6.1 → 0.6.3

data/History.txt

@@ -1,3 +1,19 @@
+Version 0.7.0
+=============
+ * Multiple values in a single header field are treated the same as repeated header fields. (Peter Williams)
+
+Compatibility issues
+--------------------
+
+ * The semantics of the Resourceful::Header API have changed slightly.
+   Previously multiple values in a single header field 
+   (e.g. `Accept: application/xml, application/json`) where treated 
+   differently from multiple values occurring in multiple fields (e.g 
+   `Accept: application/xml\n\rAccept: application/json`).  This lead 
+   to some unfortunate complexity when interacting with multi-valued 
+   fields.
+
+
 Version 0.6.0
 =============
 

data/Manifest

@@ -1,39 +1,40 @@
-lib/resourceful.rb
-lib/resourceful/net_http_adapter.rb
-lib/resourceful/options_interpretation.rb
-lib/resourceful/stubbed_resource_proxy.rb
-lib/resourceful/urlencoded_form_data.rb
-lib/resourceful/header.rb
-lib/resourceful/memcache_cache_manager.rb
-lib/resourceful/response.rb
-lib/resourceful/util.rb
+History.txt
 lib/resourceful/abstract_form_data.rb
+lib/resourceful/authentication_manager.rb
 lib/resourceful/cache_manager.rb
-lib/resourceful/request.rb
-lib/resourceful/resource.rb
 lib/resourceful/exceptions.rb
-lib/resourceful/multipart_form_data.rb
+lib/resourceful/header.rb
 lib/resourceful/http_accessor.rb
-lib/resourceful/authentication_manager.rb
-History.txt
-resourceful.gemspec
-README.markdown
+lib/resourceful/memcache_cache_manager.rb
+lib/resourceful/multipart_form_data.rb
+lib/resourceful/net_http_adapter.rb
+lib/resourceful/request.rb
+lib/resourceful/resource.rb
+lib/resourceful/response.rb
+lib/resourceful/stubbed_resource_proxy.rb
+lib/resourceful/urlencoded_form_data.rb
+lib/resourceful/util.rb
+lib/resourceful.rb
+Manifest
 MIT-LICENSE
 Rakefile
-Manifest
-spec/simple_sinatra_server_spec.rb
-spec/old_acceptance_specs.rb
-spec/acceptance_shared_specs.rb
-spec/spec_helper.rb
-spec/simple_sinatra_server.rb
+README.markdown
+resourceful.gemspec
 spec/acceptance/authorization_spec.rb
-spec/acceptance/header_spec.rb
-spec/acceptance/resource_spec.rb
 spec/acceptance/caching_spec.rb
+spec/acceptance/header_spec.rb
 spec/acceptance/redirecting_spec.rb
-spec/resourceful/multipart_form_data_spec.rb
+spec/acceptance/resource_spec.rb
+spec/acceptance_shared_specs.rb
+spec/caching_spec.rb
+spec/old_acceptance_specs.rb
 spec/resourceful/header_spec.rb
+spec/resourceful/http_accessor_spec.rb
+spec/resourceful/multipart_form_data_spec.rb
 spec/resourceful/resource_spec.rb
+spec/resourceful/response_spec.rb
 spec/resourceful/urlencoded_form_data_spec.rb
-spec/caching_spec.rb
+spec/simple_sinatra_server.rb
+spec/simple_sinatra_server_spec.rb
 spec/spec.opts
+spec/spec_helper.rb

data/Rakefile

@@ -12,7 +12,7 @@ begin
     p.email           = "psadauskas@gmail.com"
 
     p.ignore_pattern  = ["pkg/*", "tmp/*"]
-    p.dependencies    = [['addressable', '>= 2.1.0'], 'httpauth']
+    p.dependencies    = [['addressable', '>= 2.1.0'], 'httpauth', ['options', '>= 2.2.0']]
     p.development_dependencies = ['thin', 'yard', 'sinatra', 'rspec']
     p.retain_gemspec  = true
   end

data/lib/resourceful.rb

@@ -13,10 +13,11 @@ require 'resourceful/http_accessor'
 module Resourceful
   autoload :MultipartFormData, 'resourceful/multipart_form_data'
   autoload :UrlencodedFormData, 'resourceful/urlencoded_form_data'
+  autoload :StubbedResourceProxy, 'resourceful/stubbed_resource_proxy'
 end
 
 # Resourceful is a library that provides a high level HTTP interface.
 module Resourceful
-  VERSION = "0.6.1"
+  VERSION = "0.6.3"
   RESOURCEFUL_USER_AGENT_TOKEN = "Resourceful/#{VERSION}(Ruby/#{RUBY_VERSION})"
 end

data/lib/resourceful/header.rb

@@ -1,5 +1,6 @@
-require 'resourceful/options_interpretation'
+require 'options'
 require 'set'
+require 'facets/memoize'
 
 # Represents the header fields of an HTTP message.  To access a field
 # you can use `#[]` and `#[]=`.  For example, to get the content type
@@ -53,11 +54,25 @@ module Resourceful
     def has_key?(k)
       field_def(k).exists_in?(@raw_fields)
     end
+    alias has_field? has_key?
 
     def each(&blk)
       @raw_fields.each(&blk)
     end
-    alias each_field each
+
+    # Iterates through the fields with values provided as message
+    # ready strings.
+    def each_field(&blk)
+      each do |k,v|
+        str_v = if field_def(k).multivalued?
+                  v.join(', ')
+                else
+                  v.to_s
+                end
+
+        yield k, str_v
+      end
+    end
 
     def merge!(another)
       another.each do |k,v|
@@ -82,43 +97,61 @@ module Resourceful
       self.class.new(@raw_fields.dup)
     end
 
-
     # Class to handle the details of each type of field.
-    class HeaderFieldDef
+    class FieldDesc
       include Comparable
-      include OptionsInterpretation
-
+      
       ##
       attr_reader :name
-
+      
+      # Create a new header field descriptor.
+      #
+      # @param [String] name  The canonical name of this field.
+      #
+      # @param [Hash] options hash containing extra information about
+      #   this header fields.  Valid keys are:
+      #   
+      #     `:multivalued`
+      #     `:multivalue`
+      #     `:repeatable`
+      #     :   Values of this field are comma separated list of values.  
+      #         (n#VALUE per HTTP spec.) Default: false
+      #
+      #     `:hop_by_hop`
+      #     :   True if the header is a hop-by-hop header. Default: false
+      #
+      #     `:modifiable`
+      #     :   False if the header should not be modified by intermediates or caches. Default: true
+      #
       def initialize(name, options = {})
         @name = name
-        extract_opts(options) do |opts|
-          @repeatable = opts.extract(:repeatable, :default => false)
-          @hop_by_hop = opts.extract(:hop_by_hop, :default => false)
-          @modifiable = opts.extract(:modifiable, :default => true)
-        end
+        options = Options.for(options).validate(:repeatable, :hop_by_hop, :modifiable)
+        
+        @repeatable = options.getopt([:repeatable, :multivalue, :multivalued]) || false
+        @hop_by_hop = options.getopt(:hop_by_hop) || false
+        @modifiable = options.getopt(:modifiable, true)
       end
-
+      
       def repeatable?
         @repeatable
       end
-
+      alias multivalued? repeatable?
+      
       def hop_by_hop?
         @hop_by_hop
       end
-
+      
       def modifiable?
         @modifiable
       end
-
+      
       def get_from(raw_fields_hash)
         raw_fields_hash[name]
       end
-
+      
       def set_to(value, raw_fields_hash)
-        raw_fields_hash[name] = if repeatable?
-                                  Array(value)
+        raw_fields_hash[name] = if multivalued?
+                                  Array(value).map{|v| v.split(/,\s*/)}.flatten
                                 elsif value.kind_of?(Array)
                                   raise ArgumentError, "#{name} field may only have one value" if value.size > 1
                                   value.first
@@ -126,86 +159,140 @@ module Resourceful
                                   value
                                 end
       end
-
+      
       def exists_in?(raw_fields_hash)
         raw_fields_hash.has_key?(name)
       end
-
+      
       def <=>(another)
         name <=> another.name
       end
-
+      
       def ==(another)
-        name_pattern === another.name
+        name_pattern === another.to_s
       end
       alias eql? ==
-
+        
       def ===(another)
-        if another.kind_of?(HeaderFieldDef)
+        if another.kind_of?(FieldDesc)
           self == another
         else
           name_pattern === another
         end
       end
-
+      
       def name_pattern
-        Regexp.new('^' + name.gsub('-', '[_-]') + '$', Regexp::IGNORECASE)
+        @name_pattern || @name_pattern = Regexp.new('^' + name.gsub('-', '[_-]') + '$', Regexp::IGNORECASE)
       end
-
+      
       def methodized_name
-        name.downcase.gsub('-', '_')
+        @methodized_name ||= name.downcase.gsub('-', '_')
       end
-
+        
+      def constantized_name
+        @constantized_name ||= name.upcase.gsub('-', '_')
+      end
+      
       alias to_s name
-
-      def gen_setter(klass)
-        klass.class_eval <<-RUBY
-          def #{methodized_name}=(val)  # def accept=(val)
-            self['#{name}'] = val       #   self['Accept'] = val
-          end                           # end
-        RUBY
+      
+      def accessor_module 
+        @accessor_module ||= begin
+                               Module.new.tap{|m| m.module_eval(<<-RUBY)}
+                                 #{constantized_name} = '#{name}'
+  
+                                 def #{methodized_name}        # def accept
+                                   self[#{constantized_name}]  #   self[ACCEPT]
+                                 end                           # end
+         
+                                 def #{methodized_name}=(val)        # def accept=(val)
+                                   self[#{constantized_name}] = val  #   self[ACCEPT] = val
+                                 end                                 # end
+                               RUBY
+                             end
       end
 
-      def gen_getter(klass)
-        klass.class_eval <<-RUBY
-          def #{methodized_name}  # def accept
-            self['#{name}']       #   self['Accept']
-          end                     # end
-        RUBY
+      def hash
+        @name.hash
       end
-
-      def gen_canonical_name_const(klass)
-        const_name = name.upcase.gsub('-', '_')
         
-        klass.const_set(const_name, name)
+      # Yields each commonly used lookup key for this header field.
+      def lookup_keys(&blk)
+        yield name
+        yield name.upcase
+        yield name.downcase
+        yield methodized_name
+        yield methodized_name.to_sym
+        yield constantized_name
+        yield constantized_name.to_sym
       end
-    end
- 
-    @@header_field_defs = Set.new
-
+    end # FieldDesc
+    
+    @@known_fields = Set.new
+    @@known_fields_lookup = Hash.new
+
+    # Declares a common header field.  Header fields do not have to be
+    # defined this way but accessing them is easier, safer and faster
+    # if you do.  Declaring a field does the following things:
+    #
+    #  * defines accessor methods (e.g. `#content_type` and
+    #    `#content_type=`) on `Header`
+    #  
+    #  * defines constant that can be used to reference there field
+    #    name (e.g. `some_header[Header::CONTENT_TYPE]`)
+    #  
+    #  * includes the field in the appropriate *_fields groups (e.g. `Header.non_modifiable_fields`)
+    #
+    #  * provides improved multiple value parsing
+    #
+    # Create a new header field descriptor.
+    #
+    # @param [String] name  The canonical name of this field.
+    #
+    # @param [Hash] options hash containing extra information about
+    #   this header fields.  Valid keys are:
+    #   
+    #     `:multivalued`
+    #     `:multivalue`
+    #     `:repeatable`
+    #     :   Values of this field are comma separated list of values.  
+    #         (n#VALUE per HTTP spec.) Default: false
+    #
+    #     `:hop_by_hop`
+    #     :   True if the header is a hop-by-hop header. Default: false
+    #
+    #     `:modifiable`
+    #     :   False if the header should not be modified by intermediates or caches. Default: true
+    #
     def self.header_field(name, options = {})
-      hfd = HeaderFieldDef.new(name, options)
-
-      @@header_field_defs << hfd
-
-      hfd.gen_getter(self)
-      hfd.gen_setter(self)
-      hfd.gen_canonical_name_const(self)
-    end
+      hfd = FieldDesc.new(name, options)
+      
+      @@known_fields << hfd      
+      hfd.lookup_keys do |a_key|
+        @@known_fields_lookup[a_key] = hfd
+      end
 
-    def self.hop_by_hop_headers
-      @@header_field_defs.select{|hfd| hfd.hop_by_hop?}
+      include(hfd.accessor_module)
     end
-
-    def self.non_modifiable_headers
-      @@header_field_defs.reject{|hfd| hfd.repeatable?}
+    
+    def self.hop_by_hop_fields
+      @@known_fields.select{|hfd| hfd.hop_by_hop?}
     end
     
-    def field_def(name)
-      @@header_field_defs.find{|hfd| hfd === name} || 
-        HeaderFieldDef.new(name.to_s.downcase.gsub(/^.|[-_\s]./) { |x| x.upcase }.gsub('_', '-'), :repeatable => true)
+    def self.non_modifiable_fields
+      @@known_fields.reject{|hfd| hfd.modifiable?}
     end
 
+    protected
+
+    # ---
+    #
+    # We have to fall back on a slow iteration to find the header
+    # field some times because field names are
+    def field_def(name)
+      @@known_fields_lookup[name] ||  # the fast way
+        @@known_fields.find{|hfd| hfd === name} ||  # the slow way
+        FieldDesc.new(name.to_s.downcase.gsub(/^.|[-_\s]./) { |x| x.upcase }.gsub('_', '-'), :repeatable => true)  # make up as we go
+    end
 
     header_field('Accept', :repeatable => true)
     header_field('Accept-Charset', :repeatable => true)

data/lib/resourceful/http_accessor.rb

@@ -1,10 +1,10 @@
 require 'net/http'
 
-require 'resourceful/options_interpretation'
 require 'resourceful/authentication_manager'
 require 'resourceful/cache_manager'
 require 'resourceful/resource'
-require 'resourceful/stubbed_resource_proxy'
+
+require 'options'
 
 module Resourceful
   # This is an imitation Logger used when no real logger is
@@ -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
-    include OptionsInterpretation
-
     # A logger object to which messages about the activities of this
     # object will be written.  This should be an object that responds
     # to +#info(message)+ and +#debug(message)+.  
@@ -67,18 +65,19 @@ module Resourceful
     #
     # 
     def initialize(options = {})
+      options = Options.for(options).validate(:logger, :user_agent, :cache_manager, :authenticator, :authenticators, :http_adapter)
+
       @user_agent_tokens = [RESOURCEFUL_USER_AGENT_TOKEN]
       @auth_manager = AuthenticationManager.new()
 
-      extract_opts(options) do |opts|
-        @user_agent_tokens.push(*opts.extract(:user_agent, :default => []) {|ua| [ua].flatten})
-        
-        self.logger    = opts.extract(:logger, :default => BitBucketLogger.new)
-        @cache_manager = opts.extract(:cache_manager, :default => NullCacheManager.new)
-        @http_adapter  = opts.extract(:http_adapter, :default => lambda{NetHttpAdapter.new})
-        
-        opts.extract(:authenticator, :required => false).tap{|a| add_authenticator(a) if a}
-        opts.extract(:authenticators, :default => []).each { |a| add_authenticator(a) }
+      
+      @user_agent_tokens.push(*Array(options.getopt(:user_agent)).flatten.reverse)
+      self.logger    = options.getopt(:logger) || BitBucketLogger.new
+      @cache_manager = options.getopt(:cache_manager) || NullCacheManager.new
+      @http_adapter  = options.getopt(:http_adapter) || NetHttpAdapter.new
+      
+      Array(options.getopt([:authenticator, :authenticators])).flatten.each do |an_authenticator|
+        add_authenticator(an_authenticator)
       end
     end
     

data/lib/resourceful/request.rb

@@ -123,6 +123,7 @@ module Resourceful
       logger.info("Authentication Required. Retrying with auth info")
       accessor.auth_manager.associate_auth_info(response)
       add_credentials!
+      @body.rewind if @body # Its a stringIO, and we already fed it to the adapter once, so rewind it when we try again
       response = fetch_response
     end
 

data/lib/resourceful/response.rb

@@ -23,11 +23,10 @@ module Resourceful
     #
     # @return true|false
     def expired?
-      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['Expires']
-        return true if Time.httpdate(header['Expires']) < Time.now
+      if header.cache_control and m_age_str = header.cache_control.find{|cc| /^max-age=/ === cc}
+        return current_age > m_age_str[/\d+/].to_i
+      elsif header.expires
+        return Time.httpdate(header.expires) < Time.now
       end
 
       false
@@ -38,10 +37,8 @@ module Resourceful
     # @return true|false
     def stale?
       return true if expired?
-      if header['Cache-Control']
-        return true if header['Cache-Control'].include?('must-revalidate')
-        return true if header['Cache-Control'].include?('no-cache')
-      end
+      return false unless header.has_field?(Header::CACHE_CONTROL)
+      return true if header.cache_control.any?{|cc| /must-revalidate|no-cache/ === cc}
 
       false
     end
@@ -75,8 +72,8 @@ module Resourceful
 
     # Algorithm taken from RCF2616#13.2.3
     def current_age
-      age_value   = header['Age'] || 0
-      date_value  = Time.httpdate(header['Date'])
+      age_value   = header.age.to_i
+      date_value  = Time.httpdate(header.date)
       now         = Time.now
 
       apparent_age = [0, response_time - date_value].max

data/resourceful.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{resourceful}
-  s.version = "0.6.1"
+  s.version = "0.6.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Paul Sadauskas"]
-  s.date = %q{2009-09-15}
+  s.date = %q{2009-09-29}
   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/net_http_adapter.rb", "lib/resourceful/options_interpretation.rb", "lib/resourceful/stubbed_resource_proxy.rb", "lib/resourceful/urlencoded_form_data.rb", "lib/resourceful/header.rb", "lib/resourceful/memcache_cache_manager.rb", "lib/resourceful/response.rb", "lib/resourceful/util.rb", "lib/resourceful/abstract_form_data.rb", "lib/resourceful/cache_manager.rb", "lib/resourceful/request.rb", "lib/resourceful/resource.rb", "lib/resourceful/exceptions.rb", "lib/resourceful/multipart_form_data.rb", "lib/resourceful/http_accessor.rb", "lib/resourceful/authentication_manager.rb", "README.markdown"]
-  s.files = ["lib/resourceful.rb", "lib/resourceful/net_http_adapter.rb", "lib/resourceful/options_interpretation.rb", "lib/resourceful/stubbed_resource_proxy.rb", "lib/resourceful/urlencoded_form_data.rb", "lib/resourceful/header.rb", "lib/resourceful/memcache_cache_manager.rb", "lib/resourceful/response.rb", "lib/resourceful/util.rb", "lib/resourceful/abstract_form_data.rb", "lib/resourceful/cache_manager.rb", "lib/resourceful/request.rb", "lib/resourceful/resource.rb", "lib/resourceful/exceptions.rb", "lib/resourceful/multipart_form_data.rb", "lib/resourceful/http_accessor.rb", "lib/resourceful/authentication_manager.rb", "History.txt", "resourceful.gemspec", "README.markdown", "MIT-LICENSE", "Rakefile", "Manifest", "spec/simple_sinatra_server_spec.rb", "spec/old_acceptance_specs.rb", "spec/acceptance_shared_specs.rb", "spec/spec_helper.rb", "spec/simple_sinatra_server.rb", "spec/acceptance/authorization_spec.rb", "spec/acceptance/header_spec.rb", "spec/acceptance/resource_spec.rb", "spec/acceptance/caching_spec.rb", "spec/acceptance/redirecting_spec.rb", "spec/resourceful/multipart_form_data_spec.rb", "spec/resourceful/header_spec.rb", "spec/resourceful/resource_spec.rb", "spec/resourceful/urlencoded_form_data_spec.rb", "spec/caching_spec.rb", "spec/spec.opts"]
+  s.extra_rdoc_files = ["lib/resourceful/abstract_form_data.rb", "lib/resourceful/authentication_manager.rb", "lib/resourceful/cache_manager.rb", "lib/resourceful/exceptions.rb", "lib/resourceful/header.rb", "lib/resourceful/http_accessor.rb", "lib/resourceful/memcache_cache_manager.rb", "lib/resourceful/multipart_form_data.rb", "lib/resourceful/net_http_adapter.rb", "lib/resourceful/request.rb", "lib/resourceful/resource.rb", "lib/resourceful/response.rb", "lib/resourceful/stubbed_resource_proxy.rb", "lib/resourceful/urlencoded_form_data.rb", "lib/resourceful/util.rb", "lib/resourceful.rb", "README.markdown"]
+  s.files = ["History.txt", "lib/resourceful/abstract_form_data.rb", "lib/resourceful/authentication_manager.rb", "lib/resourceful/cache_manager.rb", "lib/resourceful/exceptions.rb", "lib/resourceful/header.rb", "lib/resourceful/http_accessor.rb", "lib/resourceful/memcache_cache_manager.rb", "lib/resourceful/multipart_form_data.rb", "lib/resourceful/net_http_adapter.rb", "lib/resourceful/request.rb", "lib/resourceful/resource.rb", "lib/resourceful/response.rb", "lib/resourceful/stubbed_resource_proxy.rb", "lib/resourceful/urlencoded_form_data.rb", "lib/resourceful/util.rb", "lib/resourceful.rb", "Manifest", "MIT-LICENSE", "Rakefile", "README.markdown", "resourceful.gemspec", "spec/acceptance/authorization_spec.rb", "spec/acceptance/caching_spec.rb", "spec/acceptance/header_spec.rb", "spec/acceptance/redirecting_spec.rb", "spec/acceptance/resource_spec.rb", "spec/acceptance_shared_specs.rb", "spec/caching_spec.rb", "spec/old_acceptance_specs.rb", "spec/resourceful/header_spec.rb", "spec/resourceful/http_accessor_spec.rb", "spec/resourceful/multipart_form_data_spec.rb", "spec/resourceful/resource_spec.rb", "spec/resourceful/response_spec.rb", "spec/resourceful/urlencoded_form_data_spec.rb", "spec/simple_sinatra_server.rb", "spec/simple_sinatra_server_spec.rb", "spec/spec.opts", "spec/spec_helper.rb"]
   s.homepage = %q{http://github.com/paul/resourceful}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Resourceful", "--main", "README.markdown"]
   s.require_paths = ["lib"]
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<addressable>, [">= 2.1.0"])
       s.add_runtime_dependency(%q<httpauth>, [">= 0"])
+      s.add_runtime_dependency(%q<options>, [">= 2.2.0"])
       s.add_development_dependency(%q<thin>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<sinatra>, [">= 0"])
@@ -32,6 +33,7 @@ Gem::Specification.new do |s|
     else
       s.add_dependency(%q<addressable>, [">= 2.1.0"])
       s.add_dependency(%q<httpauth>, [">= 0"])
+      s.add_dependency(%q<options>, [">= 2.2.0"])
       s.add_dependency(%q<thin>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<sinatra>, [">= 0"])
@@ -40,6 +42,7 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<addressable>, [">= 2.1.0"])
     s.add_dependency(%q<httpauth>, [">= 0"])
+    s.add_dependency(%q<options>, [">= 2.2.0"])
     s.add_dependency(%q<thin>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<sinatra>, [">= 0"])

data/spec/caching_spec.rb

@@ -54,7 +54,7 @@ describe "Caching" do
 
       resp = @resource.get
       resp.headers['X-Updateme'].should == ["bar"]
-      resp.headers['Cache-Control'].should == ["private,max-age=0"]
+      resp.headers['Cache-Control'].should == ["private", "max-age=0"]
     end
 
   end

data/spec/resourceful/header_spec.rb

@@ -1,8 +1,153 @@
 require File.dirname(__FILE__) + "/../spec_helper.rb"
 
+module Resourceful
+  describe Header do 
+    def self.should_support_header(name)
+      const_name = name.upcase.gsub('-', '_')
+      meth_name  = name.downcase.gsub('-', '_')
 
-describe Resourceful::Header do 
-  it "should have constants for header names" do 
-    Resourceful::Header::CONTENT_TYPE.should == 'Content-Type'
+      eval <<-RUBY
+      it "should have constant `#{const_name}` for header `#{name}`" do 
+        Resourceful::Header::#{const_name}.should == '#{name}'
+      end
+
+      it "should have accessor method `#{meth_name}` for header `#{name}`" do 
+        Resourceful::Header.new.should respond_to(:#{meth_name})
+      end
+
+    RUBY
+    end
+
+    should_support_header('Accept')
+    should_support_header('Accept-Charset')
+    should_support_header('Accept-Encoding')
+    should_support_header('Accept-Language')
+    should_support_header('Accept-Ranges')
+    should_support_header('Age')
+    should_support_header('Allow')
+    should_support_header('Authorization')
+    should_support_header('Cache-Control')
+    should_support_header('Connection')
+    should_support_header('Content-Encoding')
+    should_support_header('Content-Language')
+    should_support_header('Content-Length')
+    should_support_header('Content-Location')
+    should_support_header('Content-MD5')
+    should_support_header('Content-Range')
+    should_support_header('Content-Type')
+    should_support_header('Date')
+    should_support_header('ETag')
+    should_support_header('Expect')
+    should_support_header('Expires')
+    should_support_header('From')
+    should_support_header('Host')
+    should_support_header('If-Match')
+    should_support_header('If-Modified-Since')
+    should_support_header('If-None-Match')
+    should_support_header('If-Range')
+    should_support_header('If-Unmodified-Since')
+    should_support_header('Keep-Alive')
+    should_support_header('Last-Modified')
+    should_support_header('Location')
+    should_support_header('Max-Forwards')
+    should_support_header('Pragma')
+    should_support_header('Proxy-Authenticate')
+    should_support_header('Proxy-Authorization')
+    should_support_header('Range')
+    should_support_header('Referer')
+    should_support_header('Retry-After')
+    should_support_header('Server')
+    should_support_header('TE')
+    should_support_header('Trailer')
+    should_support_header('Transfer-Encoding')
+    should_support_header('Upgrade')
+    should_support_header('User-Agent')
+    should_support_header('Vary')
+    should_support_header('Via')
+    should_support_header('Warning')
+    should_support_header('WWW-Authenticate')
+
+
+    it "should be instantiatable w/ single valued header fields" do 
+      Header.new('Host' => 'foo.example').
+        host.should eql('foo.example')
+    end
+
+    it "should gracefully handle repeated values for single valued header fields" do 
+      lambda {
+        Header.new('Host' => ['foo.example', 'bar.example'])
+      }.should raise_error(ArgumentError, 'Host field may only have one value')
+    end
+
+    it "should provide #each_fields to iterate through all header fields and values as strings" do 
+      field_names = []
+      Header.new('Accept' => "this", :content_type => "that", 'pragma' => 'test').each_field do |fname, _|
+        field_names << fname
+      end
+
+      field_names.should include('Accept')
+      field_names.should include('Content-Type')
+      field_names.should include('Pragma')
+      field_names.should have(3).items
+    end
+
+    it "should provide #to_hash as a way to dump the header fields" do 
+      Header.new('Accept' => "this", :content_type => "that", 'date' => 'today').to_hash.tap do |h|
+        h.should have_pair('Accept', ['this'])
+        h.should have_pair('Content-Type', 'that')
+        h.should have_pair('Date', 'today')
+      end
+    end
+
+    it "should provide a list of hop-by-hop fields" do
+      Header.header_field('X-Hop-By-Hop-Header', :hop_by_hop => true)
+      Header.hop_by_hop_fields.should include('X-Hop-By-Hop-Header')
+    end
+
+    it "should provide a list of not modified fields" do
+      Header.header_field('X-Dont-Modify-Me', :modifiable => false)
+      Header.non_modifiable_fields.should include('X-Dont-Modify-Me')
+    end
+
+    describe "multi-valued fields" do
+      it "should be instantiatable w/ repeated multi-valued header fields" do
+        Header.new('Accept' => ['application/foo', 'application/bar']).
+          accept.should eql(['application/foo', 'application/bar'])
+      end
+
+      it "should be instantiatable w/ repeated multi-valued header fields w/ multiple values" do
+        Header.new('Accept' => ['application/foo, application/bar', 'text/plain']).
+          accept.should eql(['application/foo', 'application/bar', 'text/plain'])
+      end
+
+      it "should be instantiatable w/ multi-valued header fields w/ multiple values" do
+        Header.new('Accept' => 'application/foo, application/bar').
+          accept.should eql(['application/foo', 'application/bar'])
+      end
+
+      it "should be instantiatable w/ multi-valued header fields w/ one value" do 
+        Header.new('Accept' => 'application/foo').
+          accept.should eql(['application/foo'])
+      end
+
+      it "should provide values to #each_field as a comma separated string" do 
+        Header.new('Accept' => ['this', 'that']).each_field do |fname, fval|
+          fval.should == 'this, that'
+        end
+      end
+
+      it "should provide #each as a way to iterate through fields as w/ higher level values" do
+        Header.new('Accept' => ['this', 'that']).each do |fname, fval|
+          fval.should == ['this', 'that']
+        end
+      end
+    end
+
+    Spec::Matchers.define :have_pair do |name, value|
+      match do |header_hash|
+        header_hash.has_key?(name)
+        header_hash[name] == value
+      end
+    end    
   end
 end

data/spec/resourceful/http_accessor_spec.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+require "resourceful/http_accessor"
+
+module Resourceful
+  describe HttpAccessor do 
+    describe "instantiation" do 
+      it "should accept logger option" do 
+        test_logger = stub('logger', :debug => false)
+        ha = HttpAccessor.new(:logger => test_logger)
+        ha.logger.should equal(test_logger)
+      end
+
+      it "should accept array user_agent option" do 
+        ha = HttpAccessor.new(:user_agent => ['foo/3.2', 'bar/1.0'])
+        ha.user_agent_string.should match(/^foo\/3.2 bar\/1.0 Resourceful/)
+      end
+
+      it "should accept string user_agent option" do 
+        ha = HttpAccessor.new(:user_agent => 'foo')
+        ha.user_agent_string.should match(/^foo Resourceful/)
+      end
+
+      it "should accept cache_manager option" do 
+        test_cache_manager = stub('cache_manager', :debug => false)
+        ha = HttpAccessor.new(:cache_manager => test_cache_manager)
+        ha.cache_manager.should equal(test_cache_manager)
+      end
+
+      it "should accept http_adapter option" do 
+        test_http_adapter = stub('http_adapter', :debug => false)
+        ha = HttpAccessor.new(:http_adapter => test_http_adapter)
+        ha.http_adapter.should equal(test_http_adapter)
+      end
+
+      it "should accept authenticator option" do 
+        test_authenticator = stub('authenticator', :debug => false)
+        ha = HttpAccessor.new(:authenticator => test_authenticator)
+        # cannot really be tested safely so we just rely on the fact that the option was accepted
+      end
+
+      it "should accept authenticators option" do 
+        test_authenticator1 = stub('authenticator1', :debug => false)
+        test_authenticator2 = stub('authenticator2', :debug => false)
+        ha = HttpAccessor.new(:authenticator => [test_authenticator1, test_authenticator2])
+        # cannot really be tested safely so we just rely on the fact that the option was accepted
+      end
+
+      it "should reject unrecognized options" do 
+        lambda {
+          HttpAccessor.new(:not_a_valid_option => "this")
+        }.should raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/resourceful/response_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+require 'resourceful/response'
+require 'resourceful/header'
+
+module Resourceful
+  describe Response do 
+    
+    it "should know when it is expired" do 
+      resp = Response.new(nil, nil, Header.new('Cache-Control' => 'max-age=2', 'Date' => (Time.now - 2).httpdate), nil)
+      resp.request_time = Time.now
+
+      resp.expired?.should be_true
+    end
+
+    it "should know when it is not expired" do 
+      resp = Response.new(nil, nil, Header.new('Cache-Control' => 'max-age=1', 'Date' => Time.now.httpdate), nil)
+      resp.request_time = Time.now
+
+      resp.expired?.should be_false
+    end
+
+    it "know when it is stale due to expiration" do 
+      resp = Response.new(nil, nil, Header.new('Cache-Control' => 'max-age=1', 'Date' => (Time.now - 2).httpdate), nil)
+      resp.request_time = Time.now
+
+      resp.stale?.should be_true
+    end
+
+    it "know when it is stale due to no-cache" do 
+      resp = Response.new(nil, nil, Header.new('Cache-Control' => 'no-cache', 'Date' => Time.now.httpdate), nil)
+      resp.request_time = Time.now
+
+      resp.stale?.should be_true
+    end
+
+    it "know when it is stale due to must-revalidate" do 
+      resp = Response.new(nil, nil, Header.new('Cache-Control' => 'must-revalidate', 'Date' => Time.now.httpdate), nil)
+      resp.request_time = Time.now
+
+      resp.stale?.should be_true
+    end
+
+    it "know when it is not stale" do 
+      resp = Response.new(nil, nil, Header.new('Cache-Control' => 'max-age=1', 'Date' => Time.now.httpdate), nil)
+      resp.request_time = Time.now
+
+      resp.stale?.should be_false
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -2,10 +2,12 @@ require 'rubygems'
 require 'spec'
 require 'pp'
 
-$LOAD_PATH << File.join(File.dirname(__FILE__), "..", "lib")
+__DIR__ = File.dirname(__FILE__)
+
+$LOAD_PATH << File.join(__DIR__, "..", "lib")
 require 'resourceful'
 
-$LOAD_PATH << File.dirname(__FILE__) # ./spec
+$LOAD_PATH << __DIR__ # ./spec
 
 # Spawn the server in another process
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: resourceful
 version: !ruby/object:Gem::Version 
-  version: 0.6.1
+  version: 0.6.3
 platform: ruby
 authors: 
 - Paul Sadauskas
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-15 00:00:00 -06:00
+date: 2009-09-29 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,6 +32,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: options
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.2.0
+    version: 
 - !ruby/object:Gem::Dependency 
   name: thin
   type: :development
@@ -79,64 +89,64 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- lib/resourceful.rb
-- lib/resourceful/net_http_adapter.rb
-- lib/resourceful/options_interpretation.rb
-- lib/resourceful/stubbed_resource_proxy.rb
-- lib/resourceful/urlencoded_form_data.rb
-- lib/resourceful/header.rb
-- lib/resourceful/memcache_cache_manager.rb
-- lib/resourceful/response.rb
-- lib/resourceful/util.rb
 - lib/resourceful/abstract_form_data.rb
+- lib/resourceful/authentication_manager.rb
 - lib/resourceful/cache_manager.rb
-- lib/resourceful/request.rb
-- lib/resourceful/resource.rb
 - lib/resourceful/exceptions.rb
-- lib/resourceful/multipart_form_data.rb
+- lib/resourceful/header.rb
 - lib/resourceful/http_accessor.rb
-- lib/resourceful/authentication_manager.rb
-- README.markdown
-files: 
-- lib/resourceful.rb
+- lib/resourceful/memcache_cache_manager.rb
+- lib/resourceful/multipart_form_data.rb
 - lib/resourceful/net_http_adapter.rb
-- lib/resourceful/options_interpretation.rb
+- lib/resourceful/request.rb
+- lib/resourceful/resource.rb
+- lib/resourceful/response.rb
 - lib/resourceful/stubbed_resource_proxy.rb
 - lib/resourceful/urlencoded_form_data.rb
-- lib/resourceful/header.rb
-- lib/resourceful/memcache_cache_manager.rb
-- lib/resourceful/response.rb
 - lib/resourceful/util.rb
+- lib/resourceful.rb
+- README.markdown
+files: 
+- History.txt
 - lib/resourceful/abstract_form_data.rb
+- lib/resourceful/authentication_manager.rb
 - lib/resourceful/cache_manager.rb
-- lib/resourceful/request.rb
-- lib/resourceful/resource.rb
 - lib/resourceful/exceptions.rb
-- lib/resourceful/multipart_form_data.rb
+- lib/resourceful/header.rb
 - lib/resourceful/http_accessor.rb
-- lib/resourceful/authentication_manager.rb
-- History.txt
-- resourceful.gemspec
-- README.markdown
+- lib/resourceful/memcache_cache_manager.rb
+- lib/resourceful/multipart_form_data.rb
+- lib/resourceful/net_http_adapter.rb
+- lib/resourceful/request.rb
+- lib/resourceful/resource.rb
+- lib/resourceful/response.rb
+- lib/resourceful/stubbed_resource_proxy.rb
+- lib/resourceful/urlencoded_form_data.rb
+- lib/resourceful/util.rb
+- lib/resourceful.rb
+- Manifest
 - MIT-LICENSE
 - Rakefile
-- Manifest
-- spec/simple_sinatra_server_spec.rb
-- spec/old_acceptance_specs.rb
-- spec/acceptance_shared_specs.rb
-- spec/spec_helper.rb
-- spec/simple_sinatra_server.rb
+- README.markdown
+- resourceful.gemspec
 - spec/acceptance/authorization_spec.rb
-- spec/acceptance/header_spec.rb
-- spec/acceptance/resource_spec.rb
 - spec/acceptance/caching_spec.rb
+- spec/acceptance/header_spec.rb
 - spec/acceptance/redirecting_spec.rb
-- spec/resourceful/multipart_form_data_spec.rb
+- spec/acceptance/resource_spec.rb
+- spec/acceptance_shared_specs.rb
+- spec/caching_spec.rb
+- spec/old_acceptance_specs.rb
 - spec/resourceful/header_spec.rb
+- spec/resourceful/http_accessor_spec.rb
+- spec/resourceful/multipart_form_data_spec.rb
 - spec/resourceful/resource_spec.rb
+- spec/resourceful/response_spec.rb
 - spec/resourceful/urlencoded_form_data_spec.rb
-- spec/caching_spec.rb
+- spec/simple_sinatra_server.rb
+- spec/simple_sinatra_server_spec.rb
 - spec/spec.opts
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: http://github.com/paul/resourceful
 licenses: []

data/lib/resourceful/options_interpretation.rb

@@ -1,72 +0,0 @@
-module Resourceful
-  # Declarative way of interpreting options hashes
-  #
-  #    include OptionsInterpretion
-  #    def my_method(opts = {})
-  #      extract_opts(opts) do |opts|
-  #        host = opts.extract(:host)
-  #        port = opts.extract(:port, :default => 80) {|p| Integer(p)}
-  #      end
-  #    end
-  #
-  module OptionsInterpretation
-    # Interpret an options hash
-    #
-    # @param [Hash] opts
-    #   The options to interpret.
-    # 
-    # @yield block that used to interpreter options hash
-    #
-    # @yieldparam [Resourceful::OptionsInterpretion::OptionsInterpreter] interpeter
-    #   An interpreter that can be used to extract option information from the options hash.
-    def extract_opts(opts, &blk)
-      opts = opts.clone
-      yield OptionsInterpreter.new(opts)
-
-      unless opts.empty?
-        raise ArgumentError, "Unrecognized options: #{opts.keys.join(", ")}"
-      end
-
-    end
-
-    class OptionsInterpreter
-      def initialize(options_hash)
-        @options_hash = options_hash
-      end
-   
-      # Extract a particular option.
-      #
-      # @param [String] name
-      #   Name of option to extract
-      # @param [Hash] interpreter_opts
-      #   ':default'
-      #   :: The default value, or an object that responds to #call 
-      #      with the default value.
-      #   ':required'
-      #   :: Boolean indicating if this option is required.  Default: 
-      #      false if a default is provided; otherwise true.
-      def extract(name, interpreter_opts = {}, &blk)
-        option_required = !interpreter_opts.has_key?(:default)
-        option_required = interpreter_opts[:required] if interpreter_opts.has_key?(:required)
-        
-        raise ArgumentError, "Required option #{name} not provided" if option_required && !@options_hash.has_key?(name) 
-        # We have the option we need
-
-        orig_val = @options_hash.delete(name)
-        
-        if block_given?
-          yield orig_val
-
-        elsif orig_val
-          orig_val
-          
-        elsif interpreter_opts[:default] && interpreter_opts[:default].respond_to?(:call)
-          interpreter_opts[:default].call()
-
-        elsif interpreter_opts[:default]
-          interpreter_opts[:default]
-        end
-      end
-    end
-  end
-end