resourceful 0.5.4 → 0.6.0

data/lib/resourceful/http_accessor.rb

@@ -1,6 +1,6 @@
 require 'net/http'
 
-require 'resourceful/options_interpreter'
+require 'resourceful/options_interpretation'
 require 'resourceful/authentication_manager'
 require 'resourceful/cache_manager'
 require 'resourceful/resource'
@@ -28,7 +28,8 @@ 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)+.  
@@ -40,40 +41,45 @@ module Resourceful
     attr_reader :auth_manager
     attr_reader :user_agent_tokens  
     
-    INIT_OPTIONS = OptionsInterpreter.new do 
-      option(:logger, :default => Resourceful::BitBucketLogger.new)
-      option(:user_agent, :default => []) {|ua| [ua].flatten}
-      option(:cache_manager, :default => NullCacheManager.new)
-      option(:authenticator)
-      option(:authenticators, :default => [])
-    end
+    ##
+    # The adapter this accessor will use to make the actual HTTP requests.
+    attr_reader :http_adapter
     
     # Initializes a new HttpAccessor.  Valid options:
     #
-    #  +:logger+:: A Logger object that the new HTTP accessor should
-    #    send log messages
+    #  `:logger`
+    #  :    A Logger object that the new HTTP accessor should send log messages
+    #
+    #  `:user_agent`
+    #  :    One or more additional user agent tokens to added to the user agent string.
     #
-    #  +:user_agent+:: One or more additional user agent tokens to
-    #    added to the user agent string.
+    #  `:cache_manager`
+    #  :    The cache manager this accessor should use.
     #
-    #  +:cache_manager+:: The cache manager this accessor should use.
+    #  `:authenticator`
+    #  :    Add a single authenticator for this accessor.
     #
-    #  +:authenticator+:: Add a single authenticator for this accessor.
+    #  `:authenticators`
+    #  :    Enumerable of the authenticators for this accessor.
     #
-    #  +:authenticators+:: Enumerable of the authenticators for this
-    #    accessor.
+    #  `http_adapter`
+    #  :    The HttpAdapter to be used by this accessor
+    #
+    # 
     def initialize(options = {})
       @user_agent_tokens = [RESOURCEFUL_USER_AGENT_TOKEN]
-      
-      INIT_OPTIONS.interpret(options) do |opts|
-        @user_agent_tokens.push(*opts[:user_agent].reverse)
-        self.logger = opts[:logger]
-        @auth_manager = AuthenticationManager.new()
-        @cache_manager = opts[:cache_manager]
+      @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})
         
-        add_authenticator(opts[:authenticator]) if opts[:authenticator]
-        opts[:authenticators].each { |a| add_authenticator(a) }
-      end     
+        opts.extract(:authenticator, :required => false).tap{|a| add_authenticator(a) if a}
+        opts.extract(:authenticators, :default => []).each { |a| add_authenticator(a) }
+      end
     end
     
     # Returns the string that identifies this HTTP accessor.  If you

data/lib/resourceful/multipart_form_data.rb

@@ -0,0 +1,46 @@
+require 'resourceful/abstract_form_data'
+
+module Resourceful
+  class MultipartFormData < AbstractFormData
+    FileParamValue = Struct.new(:content, :file_name, :content_type)
+
+    def add_file(name, file_name, content_type="application/octet-stream")
+      add(name, FileParamValue.new(File.new(file_name, 'r'), File.basename(file_name), content_type))
+    end
+
+    def content_type
+      "multipart/form-data; boundary=#{boundary}"
+    end
+
+    def read
+      StringIO.new.tap do |out|
+        first = true
+        form_data.each do |key, val|
+          out << "\r\n" unless first
+          out << "--" << boundary
+          out << "\r\nContent-Disposition: form-data; name=\"#{key}\""
+          if val.kind_of?(FileParamValue)
+            out << "; filename=\"#{val.file_name}\""
+            out << "\r\nContent-Type: #{val.content_type}"
+          end
+          out << "\r\n\r\n"
+          if val.kind_of?(FileParamValue)
+            out << val.content.read
+          else
+            out << val.to_s
+          end
+          first = false
+        end
+        out << "\r\n--#{boundary}--"
+      end.string
+    end
+
+    protected
+
+    def boundary
+      @boundary ||= (0..30).map{BOUNDARY_CHARS[rand(BOUNDARY_CHARS.length)]}.join
+    end
+
+    BOUNDARY_CHARS = [('a'..'z').to_a,('A'..'Z').to_a,(0..9).to_a].flatten
+  end
+end

data/lib/resourceful/net_http_adapter.rb

@@ -23,17 +23,31 @@ module Resourceful
     # Make an HTTP request using the standard library net/http.
     #
     # Will use a proxy defined in the http_proxy environment variable, if set.
-    def self.make_request(method, uri, body = nil, header = nil)
+    #
+    # @param [#read] body
+    #   An IO-ish thing containing the body of the request
+    #
+    def make_request(method, uri, body = nil, header = nil)
       uri = uri.is_a?(Addressable::URI) ? uri : Addressable::URI.parse(uri)
 
+      if [:put, :post].include? method
+        body = body ? body.read : ""
+        header[:content_length] = body.size 
+      end
+
       req = net_http_request_class(method).new(uri.absolute_path)
       header.each_field { |k,v| req[k] = v } if header
       https = ("https" == uri.scheme)
-      conn = Net::HTTP.Proxy(*proxy_details).new(uri.host, uri.port || (https ? 443 : 80))
+      conn_class = proxy_details ? Net::HTTP.Proxy(*proxy_details) : Net::HTTP
+      conn = conn_class.new(uri.host, uri.port || (https ? 443 : 80))
       conn.use_ssl = https
       begin 
         conn.start
-        res = conn.request(req, body)
+        res = if body
+                conn.request(req, body)
+              else
+                conn.request(req)
+              end
       ensure
         conn.finish if conn.started?
       end
@@ -49,12 +63,12 @@ module Resourceful
     private
 
     # Parse proxy details from http_proxy environment variable
-    def self.proxy_details
+    def proxy_details
       proxy = Addressable::URI.parse(ENV["http_proxy"])
       [proxy.host, proxy.port, proxy.user, proxy.password] if proxy
     end
 
-    def self.net_http_request_class(method)
+    def net_http_request_class(method)
       case method
       when :get     then Net::HTTP::Get
       when :head    then Net::HTTP::Head

data/lib/resourceful/options_interpretation.rb

@@ -0,0 +1,72 @@
+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

data/lib/resourceful/request.rb

@@ -163,7 +163,7 @@ module Resourceful
     def perform!
       @request_time = Time.now
 
-      http_resp = NetHttpAdapter.make_request(@method, @resource.uri, @body, @header)
+      http_resp = adapter.make_request(@method, @resource.uri, @body, @header)
       @response = Resourceful::Response.new(uri, *http_resp)
       @response.request_time = @request_time
       @response.authoritative = true
@@ -205,7 +205,7 @@ module Resourceful
 
     # Does this request force us to revalidate the cache?
     def forces_revalidation?
-      if max_age == 0 || header.cache_control && cc.include?('no-cache')
+      if max_age == 0 || skip_cache?
         logger.info("    Client forced revalidation")
         true
       else 
@@ -225,6 +225,10 @@ module Resourceful
     def logger
       resource.logger
     end
+
+    def adapter
+      accessor.http_adapter
+    end
   end
 
 end

data/lib/resourceful/resource.rb

@@ -5,7 +5,6 @@ module Resourceful
 
   class Resource
     attr_reader :accessor
-    attr_accessor :default_header
 
     # Build a new resource for a uri
     #
@@ -30,6 +29,10 @@ module Resourceful
     end
     alias uri effective_uri
 
+    def default_header(temp_defaults = {})
+      @default_header.merge(temp_defaults)
+    end
+
     # Returns the host for this Resource's current uri
     def host
       Addressable::URI.parse(uri).host
@@ -95,7 +98,6 @@ module Resourceful
     # @raise [UnsuccessfulHttpRequestError] unless the request is a
     #   success, ie the final request returned a 2xx response code
     def post(data = nil, header = {})
-      check_content_type_exists(data, header)
       request(:post, data, header)
     end
 
@@ -116,7 +118,6 @@ module Resourceful
     # @raise [UnsuccessfulHttpRequestError] unless the request is a
     #   success, ie the final request returned a 2xx response code
     def put(data, header = {})
-      check_content_type_exists(data, header)
       request(:put, data, header)
     end
 
@@ -137,17 +138,32 @@ module Resourceful
     private
 
     # Ensures that the request has a content type header
-    # TODO Move this to request
-    def check_content_type_exists(body, header)
-      if body
-        raise MissingContentType unless header.has_key?(:content_type) or default_header.has_key?(:content_type)
+    def ensure_content_type(body, header)
+      return if header.has_key?('Content-Type') 
+      
+      if body.respond_to?(:content_type)
+        header['Content-Type'] = body.content_type
+        return
       end
+      
+      return if default_header.has_key?('Content-Type') 
+
+      # could not figure it out
+      raise MissingContentType
     end
 
     # Actually make the request
     def request(method, data, header)
-      log_request_with_time "#{method.to_s.upcase} [#{uri}]" do
-        request = Request.new(method, self, data, default_header.merge(header))
+      header = default_header.merge(header)
+      ensure_content_type(data, header) if data
+
+      data = StringIO.new(data) if data.kind_of?(String)
+
+      logger.debug { header.map {|k,v| "#{k}: #{v}"}.join("\n\t\t") }
+      logger.debug { data = StringIO.new(data.read); data.string } if data
+      
+      log_request_with_time "#{method.to_s.upcase} [#{uri}]" do        
+        request = Request.new(method, self, data, header)
         request.fetch_response
       end
     end

data/lib/resourceful/response.rb

@@ -26,8 +26,8 @@ module Resourceful
       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
+      elsif header['Expires']
+        return true if Time.httpdate(header['Expires']) < Time.now
       end
 
       false
@@ -75,8 +75,8 @@ module Resourceful
 
     # Algorithm taken from RCF2616#13.2.3
     def current_age
-      age_value   = header['Age'] ? header['Age'].first.to_i : 0
-      date_value  = Time.httpdate(header['Date'].first)
+      age_value   = header['Age'] || 0
+      date_value  = Time.httpdate(header['Date'])
       now         = Time.now
 
       apparent_age = [0, response_time - date_value].max
@@ -85,7 +85,7 @@ module Resourceful
     end
 
     def body
-      encoding = header['Content-Encoding'] && header['Content-Encoding'].first
+      encoding = header['Content-Encoding']
       case encoding
       when nil
         # body is identity encoded; just return it

data/lib/resourceful/urlencoded_form_data.rb

@@ -0,0 +1,17 @@
+require 'resourceful/abstract_form_data'
+require 'cgi'
+
+module Resourceful
+  class UrlencodedFormData < AbstractFormData
+
+    def content_type
+      "application/x-www-form-urlencoded"
+    end
+
+    def read
+      @form_data.map do |k,v|
+        CGI.escape(k) + '=' + CGI.escape(v)
+      end.join('&')
+    end
+  end
+end

data/resourceful.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{resourceful}
-  s.version = "0.5.4"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Paul Sadauskas"]
-  s.date = %q{2009-08-11}
+  s.date = %q{2009-08-14}
   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/stubbed_resource_proxy.rb", "lib/resourceful/header.rb", "lib/resourceful/memcache_cache_manager.rb", "lib/resourceful/response.rb", "lib/resourceful/util.rb", "lib/resourceful/options_interpreter.rb", "lib/resourceful/cache_manager.rb", "lib/resourceful/request.rb", "lib/resourceful/resource.rb", "lib/resourceful/exceptions.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/stubbed_resource_proxy.rb", "lib/resourceful/header.rb", "lib/resourceful/memcache_cache_manager.rb", "lib/resourceful/response.rb", "lib/resourceful/util.rb", "lib/resourceful/options_interpreter.rb", "lib/resourceful/cache_manager.rb", "lib/resourceful/request.rb", "lib/resourceful/resource.rb", "lib/resourceful/exceptions.rb", "lib/resourceful/http_accessor.rb", "lib/resourceful/authentication_manager.rb", "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/spec.opts", "resourceful.gemspec"]
+  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.homepage = %q{http://github.com/paul/resourceful}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Resourceful", "--main", "README.markdown"]
   s.require_paths = ["lib"]
@@ -23,14 +23,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<addressable>, [">= 0"])
+      s.add_runtime_dependency(%q<addressable>, [">= 2.1.0"])
       s.add_runtime_dependency(%q<httpauth>, [">= 0"])
       s.add_development_dependency(%q<thin>, [">= 0"])
       s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_development_dependency(%q<sinatra>, [">= 0"])
       s.add_development_dependency(%q<rspec>, [">= 0"])
     else
-      s.add_dependency(%q<addressable>, [">= 0"])
+      s.add_dependency(%q<addressable>, [">= 2.1.0"])
       s.add_dependency(%q<httpauth>, [">= 0"])
       s.add_dependency(%q<thin>, [">= 0"])
       s.add_dependency(%q<yard>, [">= 0"])
@@ -38,7 +38,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<rspec>, [">= 0"])
     end
   else
-    s.add_dependency(%q<addressable>, [">= 0"])
+    s.add_dependency(%q<addressable>, [">= 2.1.0"])
     s.add_dependency(%q<httpauth>, [">= 0"])
     s.add_dependency(%q<thin>, [">= 0"])
     s.add_dependency(%q<yard>, [">= 0"])