activeresource 2.3.18 → 3.0.0.beta

data/lib/active_resource/connection.rb

@@ -1,75 +1,10 @@
+require 'active_support/core_ext/benchmark'
 require 'net/https'
 require 'date'
 require 'time'
 require 'uri'
-require 'benchmark'
 
 module ActiveResource
-  class ConnectionError < StandardError # :nodoc:
-    attr_reader :response
-
-    def initialize(response, message = nil)
-      @response = response
-      @message  = message
-    end
-
-    def to_s
-      "Failed with #{response.code} #{response.message if response.respond_to?(:message)}"
-    end
-  end
-
-  # Raised when a Timeout::Error occurs.
-  class TimeoutError < ConnectionError
-    def initialize(message)
-      @message = message
-    end
-    def to_s; @message ;end
-  end
-
-  # Raised when a OpenSSL::SSL::SSLError occurs.
-  class SSLError < ConnectionError
-    def initialize(message)
-      @message = message
-    end
-    def to_s; @message ;end
-  end
-
-  # 3xx Redirection
-  class Redirection < ConnectionError # :nodoc:
-    def to_s; response['Location'] ? "#{super} => #{response['Location']}" : super; end
-  end
-
-  # 4xx Client Error
-  class ClientError < ConnectionError; end # :nodoc:
-
-  # 400 Bad Request
-  class BadRequest < ClientError; end # :nodoc
-
-  # 401 Unauthorized
-  class UnauthorizedAccess < ClientError; end # :nodoc
-
-  # 403 Forbidden
-  class ForbiddenAccess < ClientError; end # :nodoc
-
-  # 404 Not Found
-  class ResourceNotFound < ClientError; end # :nodoc:
-
-  # 409 Conflict
-  class ResourceConflict < ClientError; end # :nodoc:
-
-  # 410 Gone
-  class ResourceGone < ClientError; end # :nodoc:
-
-  # 5xx Server Error
-  class ServerError < ConnectionError; end # :nodoc:
-
-  # 405 Method Not Allowed
-  class MethodNotAllowed < ClientError # :nodoc:
-    def allowed_methods
-      @response['Allow'].split(',').map { |verb| verb.strip.downcase.to_sym }
-    end
-  end
-
   # Class to handle connections to remote web services.
   # This class is used by ActiveResource::Base to interface with REST
   # services.
@@ -82,7 +17,7 @@ module ActiveResource
       :head => 'Accept'
     }
 
-    attr_reader :site, :user, :password, :timeout, :proxy, :ssl_options
+    attr_reader :site, :user, :password, :auth_type, :timeout, :proxy, :ssl_options
     attr_accessor :format
 
     class << self
@@ -93,36 +28,42 @@ module ActiveResource
 
     # The +site+ parameter is required and will set the +site+
     # attribute to the URI for the remote resource service.
-    def initialize(site, format = ActiveResource::Formats[:xml])
+    def initialize(site, format = ActiveResource::Formats::XmlFormat)
       raise ArgumentError, 'Missing site URI' unless site
       @user = @password = nil
+      @uri_parser = URI.const_defined?(:Parser) ? URI::Parser.new : URI
       self.site = site
       self.format = format
     end
 
     # Set URI for remote service.
     def site=(site)
-      @site = site.is_a?(URI) ? site : URI.parse(site)
-      @user = URI.decode(@site.user) if @site.user
-      @password = URI.decode(@site.password) if @site.password
+      @site = site.is_a?(URI) ? site : @uri_parser.parse(site)
+      @user = @uri_parser.unescape(@site.user) if @site.user
+      @password = @uri_parser.unescape(@site.password) if @site.password
     end
 
     # Set the proxy for remote service.
     def proxy=(proxy)
-      @proxy = proxy.is_a?(URI) ? proxy : URI.parse(proxy)
+      @proxy = proxy.is_a?(URI) ? proxy : @uri_parser.parse(proxy)
     end
 
-    # Set the user for remote service.
+    # Sets the user for remote service.
     def user=(user)
       @user = user
     end
 
-    # Set password for remote service.
+    # Sets the password for remote service.
     def password=(password)
       @password = password
     end
 
-    # Set the number of seconds after which HTTP requests to the remote service should time out.
+    # Sets the auth type for remote service.
+    def auth_type=(auth_type)
+      @auth_type = legitimize_auth_type(auth_type)
+    end
+
+    # Sets the number of seconds after which HTTP requests to the remote service should time out.
     def timeout=(timeout)
       @timeout = timeout
     end
@@ -132,44 +73,44 @@ module ActiveResource
       @ssl_options = opts
     end
 
-    # Execute a GET request.
+    # Executes a GET request.
     # Used to get (find) resources.
     def get(path, headers = {})
-      format.decode(request(:get, path, build_request_headers(headers, :get)).body)
+      with_auth { format.decode(request(:get, path, build_request_headers(headers, :get, self.site.merge(path))).body) }
     end
 
-    # Execute a DELETE request (see HTTP protocol documentation if unfamiliar).
+    # Executes a DELETE request (see HTTP protocol documentation if unfamiliar).
     # Used to delete resources.
     def delete(path, headers = {})
-      request(:delete, path, build_request_headers(headers, :delete))
+      with_auth { request(:delete, path, build_request_headers(headers, :delete, self.site.merge(path))) }
     end
 
-    # Execute a PUT request (see HTTP protocol documentation if unfamiliar).
+    # Executes a PUT request (see HTTP protocol documentation if unfamiliar).
     # Used to update resources.
     def put(path, body = '', headers = {})
-      request(:put, path, body.to_s, build_request_headers(headers, :put))
+      with_auth { request(:put, path, body.to_s, build_request_headers(headers, :put, self.site.merge(path))) }
     end
 
-    # Execute a POST request.
+    # Executes a POST request.
     # Used to create new resources.
     def post(path, body = '', headers = {})
-      request(:post, path, body.to_s, build_request_headers(headers, :post))
+      with_auth { request(:post, path, body.to_s, build_request_headers(headers, :post, self.site.merge(path))) }
     end
 
-    # Execute a HEAD request.
+    # Executes a HEAD request.
     # Used to obtain meta-information about resources, such as whether they exist and their size (via response headers).
     def head(path, headers = {})
-      request(:head, path, build_request_headers(headers, :head))
+      with_auth { request(:head, path, build_request_headers(headers, :head, self.site.merge(path))) }
     end
 
-
     private
-      # Makes request to remote service.
+      # Makes a request to the remote service.
       def request(method, path, *arguments)
-        logger.info "#{method.to_s.upcase} #{site.scheme}://#{site.host}:#{site.port}#{path}" if logger
-        result = nil
-        ms = Benchmark.ms { result = http.send(method, path, *arguments) }
-        logger.info "--> %d %s (%d %.0fms)" % [result.code, result.message, result.body ? result.body.length : 0, ms] if logger
+        result = ActiveSupport::Notifications.instrument("active_resource.request") do |payload|
+          payload[:method]      = method
+          payload[:request_uri] = "#{site.scheme}://#{site.host}:#{site.port}#{path}"
+          payload[:result]      = http.send(method, path, *arguments)
+        end
         handle_response(result)
       rescue Timeout::Error => e
         raise TimeoutError.new(e.message)
@@ -177,7 +118,7 @@ module ActiveResource
         raise SSLError.new(e.message)
       end
 
-      # Handles response and error codes from remote service.
+      # Handles response and error codes from the remote service.
       def handle_response(response)
         case response.code.to_i
           when 301,302
@@ -209,7 +150,7 @@ module ActiveResource
         end
       end
 
-      # Creates new Net::HTTP instance for communication with
+      # Creates new Net::HTTP instance for communication with the
       # remote service and resources.
       def http
         configure_http(new_http)
@@ -263,21 +204,80 @@ module ActiveResource
       end
 
       # Builds headers for request to remote service.
-      def build_request_headers(headers, http_method=nil)
-        authorization_header.update(default_header).update(http_format_header(http_method)).update(headers)
+      def build_request_headers(headers, http_method, uri)
+        authorization_header(http_method, uri).update(default_header).update(http_format_header(http_method)).update(headers)
+      end
+
+      def response_auth_header
+        @response_auth_header ||= ""
+      end
+
+      def with_auth
+        retried ||= false
+        yield
+      rescue UnauthorizedAccess => e
+        raise if retried || auth_type != :digest
+        @response_auth_header = e.response['WWW-Authenticate']
+        retried = true
+        retry
+      end
+
+      def authorization_header(http_method, uri)
+        if @user || @password
+          if auth_type == :digest
+            { 'Authorization' => digest_auth_header(http_method, uri) }
+          else
+            { 'Authorization' => 'Basic ' + ["#{@user}:#{@password}"].pack('m').delete("\r\n") }
+          end
+        else
+          {}
+        end
+      end
+
+      def digest_auth_header(http_method, uri)
+        params = extract_params_from_response
+
+        ha1 = Digest::MD5.hexdigest("#{@user}:#{params['realm']}:#{@password}")
+        ha2 = Digest::MD5.hexdigest("#{http_method.to_s.upcase}:#{uri.path}")
+
+        params.merge!('cnonce' => client_nonce)
+        request_digest = Digest::MD5.hexdigest([ha1, params['nonce'], "0", params['cnonce'], params['qop'], ha2].join(":"))
+        "Digest #{auth_attributes_for(uri, request_digest, params)}"
+      end
+
+      def client_nonce
+        Digest::MD5.hexdigest("%x" % (Time.now.to_i + rand(65535)))
+      end
+
+      def extract_params_from_response
+        params = {}
+        if response_auth_header =~ /^(\w+) (.*)/
+          $2.gsub(/(\w+)="(.*?)"/) { params[$1] = $2 }
+        end
+        params
       end
 
-      # Sets authorization header
-      def authorization_header
-        (@user || @password ? { 'Authorization' => 'Basic ' + ["#{@user}:#{ @password}"].pack('m').delete("\r\n") } : {})
+      def auth_attributes_for(uri, request_digest, params)
+        [
+          %Q(username="#{@user}"),
+          %Q(realm="#{params['realm']}"),
+          %Q(qop="#{params['qop']}"),
+          %Q(uri="#{uri.path}"),
+          %Q(nonce="#{params['nonce']}"),
+          %Q(nc="0"),
+          %Q(cnonce="#{params['cnonce']}"),
+          %Q(opaque="#{params['opaque']}"),
+          %Q(response="#{request_digest}")].join(", ")
       end
 
       def http_format_header(http_method)
         {HTTP_FORMAT_HEADER_NAMES[http_method] => format.mime_type}
       end
 
-      def logger #:nodoc:
-        Base.logger
+      def legitimize_auth_type(auth_type)
+        return :basic if auth_type.nil?
+        auth_type = auth_type.to_sym
+        [:basic, :digest].include?(auth_type) ? auth_type : :basic
       end
   end
 end

data/lib/active_resource/custom_methods.rb

@@ -31,47 +31,44 @@ module ActiveResource
   #   # => [{:id => 1, :name => 'Ryan'}, {:id => 2, :name => 'Joe'}]
   #
   module CustomMethods
-    def self.included(base)
-      base.class_eval do
-        extend ActiveResource::CustomMethods::ClassMethods
-        include ActiveResource::CustomMethods::InstanceMethods
+    extend ActiveSupport::Concern
 
-        class << self
-          alias :orig_delete :delete
+    included do
+      class << self
+        alias :orig_delete :delete
 
-          # Invokes a GET to a given custom REST method. For example:
-          #
-          #   Person.get(:active)  # GET /people/active.xml
-          #   # => [{:id => 1, :name => 'Ryan'}, {:id => 2, :name => 'Joe'}]
-          #
-          #   Person.get(:active, :awesome => true)  # GET /people/active.xml?awesome=true
-          #   # => [{:id => 1, :name => 'Ryan'}]
-          #
-          # Note: the objects returned from this method are not automatically converted
-          # into ActiveResource::Base instances - they are ordinary Hashes. If you are expecting
-          # ActiveResource::Base instances, use the <tt>find</tt> class method with the
-          # <tt>:from</tt> option. For example:
-          #
-          #   Person.find(:all, :from => :active)
-          def get(custom_method_name, options = {})
-            connection.get(custom_method_collection_url(custom_method_name, options), headers)
-          end
+        # Invokes a GET to a given custom REST method. For example:
+        #
+        #   Person.get(:active)  # GET /people/active.xml
+        #   # => [{:id => 1, :name => 'Ryan'}, {:id => 2, :name => 'Joe'}]
+        #
+        #   Person.get(:active, :awesome => true)  # GET /people/active.xml?awesome=true
+        #   # => [{:id => 1, :name => 'Ryan'}]
+        #
+        # Note: the objects returned from this method are not automatically converted
+        # into ActiveResource::Base instances - they are ordinary Hashes. If you are expecting
+        # ActiveResource::Base instances, use the <tt>find</tt> class method with the
+        # <tt>:from</tt> option. For example:
+        #
+        #   Person.find(:all, :from => :active)
+        def get(custom_method_name, options = {})
+          connection.get(custom_method_collection_url(custom_method_name, options), headers)
+        end
 
-          def post(custom_method_name, options = {}, body = '')
-            connection.post(custom_method_collection_url(custom_method_name, options), body, headers)
-          end
+        def post(custom_method_name, options = {}, body = '')
+          connection.post(custom_method_collection_url(custom_method_name, options), body, headers)
+        end
 
-          def put(custom_method_name, options = {}, body = '')
-            connection.put(custom_method_collection_url(custom_method_name, options), body, headers)
-          end
+        def put(custom_method_name, options = {}, body = '')
+          connection.put(custom_method_collection_url(custom_method_name, options), body, headers)
+        end
 
-          def delete(custom_method_name, options = {})
-            # Need to jump through some hoops to retain the original class 'delete' method
-            if custom_method_name.is_a?(Symbol)
-              connection.delete(custom_method_collection_url(custom_method_name, options), headers)
-            else
-              orig_delete(custom_method_name, options)
-            end
+        def delete(custom_method_name, options = {})
+          # Need to jump through some hoops to retain the original class 'delete' method
+          if custom_method_name.is_a?(Symbol)
+            connection.delete(custom_method_collection_url(custom_method_name, options), headers)
+          else
+            orig_delete(custom_method_name, options)
           end
         end
       end

data/lib/active_resource/exceptions.rb

@@ -8,7 +8,10 @@ module ActiveResource
     end
 
     def to_s
-      "Failed with #{response.code} #{response.message if response.respond_to?(:message)}"
+      message = "Failed."
+      message << "  Response code = #{response.code}." if response.respond_to?(:code)
+      message << "  Response message = #{response.message}." if response.respond_to?(:message)
+      message
     end
   end
 

data/lib/active_resource/formats.rb

@@ -1,14 +1,14 @@
 module ActiveResource
   module Formats
+    autoload :XmlFormat, 'active_resource/formats/xml_format'
+    autoload :JsonFormat, 'active_resource/formats/json_format'
+
     # Lookup the format class from a mime type reference symbol. Example:
     #
     #   ActiveResource::Formats[:xml]  # => ActiveResource::Formats::XmlFormat
     #   ActiveResource::Formats[:json] # => ActiveResource::Formats::JsonFormat
     def self.[](mime_type_reference)
-      ActiveResource::Formats.const_get(mime_type_reference.to_s.camelize + "Format")
+      ActiveResource::Formats.const_get(ActiveSupport::Inflector.camelize(mime_type_reference.to_s) + "Format")
     end
   end
 end
-
-require 'active_resource/formats/xml_format'
-require 'active_resource/formats/json_format'

data/lib/active_resource/formats/json_format.rb

@@ -1,3 +1,5 @@
+require 'active_support/json'
+
 module ActiveResource
   module Formats
     module JsonFormat

data/lib/active_resource/formats/xml_format.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext/hash/conversions'
+
 module ActiveResource
   module Formats
     module XmlFormat

data/lib/active_resource/http_mock.rb

@@ -1,4 +1,4 @@
-require 'active_resource/connection'
+require 'active_support/core_ext/kernel/reporting'
 
 module ActiveResource
   class InvalidRequestError < StandardError; end #:nodoc:
@@ -29,8 +29,7 @@ module ActiveResource
   #
   # In order for a mock to deliver its content, the incoming request must match by the <tt>http_method</tt>,
   # +path+ and <tt>request_headers</tt>.  If no match is found an InvalidRequestError exception
-  # will be raised showing you what request it could not find a response for and also what requests and response
-  # pairs have been recorded so you can create a new mock for that request.
+  # will be raised letting you know you need to create a new mock for that request.
   #
   # ==== Example
   #   def setup
@@ -58,7 +57,7 @@ module ActiveResource
         # def post(path, request_headers = {}, body = nil, status = 200, response_headers = {})
         #   @responses[Request.new(:post, path, nil, request_headers)] = Response.new(body || "", status, response_headers)
         # end
-        module_eval <<-EOE, __FILE__, __LINE__ + 1
+        module_eval <<-EOE, __FILE__, __LINE__
           def #{method}(path, request_headers = {}, body = nil, status = 200, response_headers = {})
             @responses << [Request.new(:#{method}, path, nil, request_headers), Response.new(body || "", status, response_headers)]
           end
@@ -98,79 +97,10 @@ module ActiveResource
         @@responses ||= []
       end
 
-      # Accepts a block which declares a set of requests and responses for the HttpMock to respond to in
-      # the following format:
-      # 
-      #   mock.http_method(path, request_headers = {}, body = nil, status = 200, response_headers = {})
-      # 
-      # === Example
-      # 
-      #   @matz  = { :id => 1, :name => "Matz" }.to_xml(:root => "person")
-      #   ActiveResource::HttpMock.respond_to do |mock|
-      #     mock.post   "/people.xml",   {}, @matz, 201, "Location" => "/people/1.xml"
-      #     mock.get    "/people/1.xml", {}, @matz
-      #     mock.put    "/people/1.xml", {}, nil, 204
-      #     mock.delete "/people/1.xml", {}, nil, 200
-      #   end
-      # 
-      # Alternatively, accepts a hash of <tt>{Request => Response}</tt> pairs allowing you to generate
-      # these the following format:
-      # 
-      #   ActiveResource::Request.new(method, path, body, request_headers)
-      #   ActiveResource::Response.new(body, status, response_headers)
-      # 
-      # === Example
-      # 
-      # Request.new(:#{method}, path, nil, request_headers)
-      # 
-      #   @matz  = { :id => 1, :name => "Matz" }.to_xml(:root => "person")
-      #
-      #   create_matz      = ActiveResource::Request.new(:post, '/people.xml', @matz, {})
-      #   created_response = ActiveResource::Response.new("", 201, {"Location" => "/people/1.xml"})
-      #   get_matz         = ActiveResource::Request.new(:get, '/people/1.xml', nil)
-      #   ok_response      = ActiveResource::Response.new("", 200, {})
-      # 
-      #   pairs = {create_matz => created_response, get_matz => ok_response}
-      # 
-      #   ActiveResource::HttpMock.respond_to(pairs)
-      #
-      # Note, by default, every time you call +respond_to+, any previous request and response pairs stored
-      # in HttpMock will be deleted giving you a clean slate to work on.
-      # 
-      # If you want to override this behaviour, pass in +false+ as the last argument to +respond_to+
-      # 
-      # === Example
-      # 
-      #   ActiveResource::HttpMock.respond_to do |mock|
-      #     mock.send(:get, "/people/1", {}, "XML1")
-      #   end
-      #   ActiveResource::HttpMock.responses.length #=> 1
-      #   
-      #   ActiveResource::HttpMock.respond_to(false) do |mock|
-      #     mock.send(:get, "/people/2", {}, "XML2")
-      #   end
-      #   ActiveResource::HttpMock.responses.length #=> 2
-      # 
-      # This also works with passing in generated pairs of requests and responses, again, just pass in false
-      # as the last argument:
-      # 
-      # === Example
-      # 
-      #   ActiveResource::HttpMock.respond_to do |mock|
-      #     mock.send(:get, "/people/1", {}, "XML1")
-      #   end
-      #   ActiveResource::HttpMock.responses.length #=> 1
-      # 
-      #   get_matz         = ActiveResource::Request.new(:get, '/people/1.xml', nil)
-      #   ok_response      = ActiveResource::Response.new("", 200, {})
-      # 
-      #   pairs = {get_matz => ok_response}
-      #
-      #   ActiveResource::HttpMock.respond_to(pairs, false)
-      #   ActiveResource::HttpMock.responses.length #=> 2
-      def respond_to(*args) #:yields: mock
-        pairs = args.first || {}
-        reset! if args.last.class != FalseClass
+      # Accepts a block which declares a set of requests and responses for the HttpMock to respond to. See the main
+      # ActiveResource::HttpMock description for a more detailed explanation.
+      def respond_to(pairs = {}) #:yields: mock
+        reset!
         responses.concat pairs.to_a
         if block_given?
           yield Responder.new(responses)
@@ -193,20 +123,16 @@ module ActiveResource
         # def post(path, body, headers)
         #   request = ActiveResource::Request.new(:post, path, body, headers)
         #   self.class.requests << request
-        #   if response = self.class.responses.assoc(request)
-        #     response[1]
-        #   else
-        #     raise InvalidRequestError.new("Could not find a response recorded for #{request.to_s} - Responses recorded are: - #{inspect_responses}")
-        #   end
+        #   self.class.responses.assoc(request).try(:second) || raise(InvalidRequestError.new("No response recorded for #{request}"))
         # end
-        module_eval <<-EOE, __FILE__, __LINE__ + 1
+        module_eval <<-EOE, __FILE__, __LINE__
           def #{method}(path, #{'body, ' if has_body}headers)
             request = ActiveResource::Request.new(:#{method}, path, #{has_body ? 'body, ' : 'nil, '}headers)
             self.class.requests << request
             if response = self.class.responses.assoc(request)
               response[1]
             else
-              raise InvalidRequestError.new("Could not find a response recorded for \#{request.to_s} - Responses recorded are: \#{inspect_responses}")
+              raise InvalidRequestError.new("No response recorded for \#{request}")
             end
           end
         EOE
@@ -216,39 +142,22 @@ module ActiveResource
     def initialize(site) #:nodoc:
       @site = site
     end
-
-    def inspect_responses #:nodoc:
-      self.class.responses.map { |r| r[0].to_s }.inspect
-    end
   end
 
   class Request
     attr_accessor :path, :method, :body, :headers
 
     def initialize(method, path, body = nil, headers = {})
-      @method, @path, @body, @headers = method, path, body, headers
+      @method, @path, @body, @headers = method, path, body, headers.merge(ActiveResource::Connection::HTTP_FORMAT_HEADER_NAMES[method] => 'application/xml')
     end
 
     def ==(req)
-      path == req.path && method == req.method && headers_match?(req)
+      path == req.path && method == req.method && headers == req.headers
     end
 
     def to_s
       "<#{method.to_s.upcase}: #{path} [#{headers}] (#{body})>"
     end
-
-    private
-
-    def headers_match?(req)
-      # Ignore format header on equality if it's not defined
-      format_header = ActiveResource::Connection::HTTP_FORMAT_HEADER_NAMES[method]
-      if headers[format_header].present? || req.headers[format_header].blank?
-        headers == req.headers
-      else
-        headers.dup.merge(format_header => req.headers[format_header]) == req.headers
-      end
-    end
-
   end
 
   class Response