Contents

module Sucker #:nodoc

  # A Nokogiri-driven wrapper around the cURL response
  class Response

    # The response body
    attr_accessor :body

    # The HTTP status code of the response
    attr_accessor :code

    # Transaction time in seconds for request
    attr_accessor :time

    def initialize(curl)
      self.body = curl.body_str
      self.code = curl.response_code
      self.time = curl.total_time
    end

    # Queries an xpath and returns an array of matching nodes
    #
    # Will yield each match if a block is given
    #
    #   response = worker.get
    #   response.find("Item") { |item| ... }
    #
    def find(path)
      node = xml.xpath("//xmlns:#{path}").map { |node| strip_content(node.to_hash[path]) }
      node.each { |e| yield e } if block_given?
      node
    end

    def node(path) # :nodoc:
      warn "[DEPRECATION] `node` is deprecated.  Use `find` instead."
      find(path)
    end

    # Parses the response into a simple hash
    #
    #   response = worker.get
    #   response.to_hash
    #
    def to_hash
      strip_content(xml.to_hash)
    end

    # Checks if the HTTP response is OK
    #
    #    response = worker.get
    #    p response.valid?
    #    => true
    #
    def valid?
      code == 200
    end

    # The XML document
    #
    #    response = worker.get
    #    response.xml
    def xml
      @xml ||= Nokogiri::XML(body)
    end

    private

    # Let's massage that hash
    def strip_content(node)
      case node
      when Array 
        node.map { |child| strip_content(child) }
      when Hash
        if node.keys.size == 1 && node["__content__"]
          node["__content__"]
        else
          node.inject({}) do |attributes, key_value|
            attributes.merge({ key_value.first => strip_content(key_value.last) })
          end
        end
      else
        node
      end
    end
  end

  class ResponseError < StandardError; end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
sucker-1.0.0.beta.4	lib/sucker/response.rb