sevenwire-http_client 0.1.0

data/lib/http_client/raw_response.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/mixin/response'
+
+module HttpClient
+  # The response from HttpClient on a raw request looks like a string, but is 
+  # actually one of these.  99% of the time you're making a http call all you 
+  # care about is the body, but on the occassion you want to fetch the 
+  # headers you can:
+  #
+  #   HttpClient.get('http://example.com').headers[:content_type]
+  #
+  # In addition, if you do not use the response as a string, you can access
+  # a Tempfile object at res.file, which contains the path to the raw 
+  # downloaded request body.  
+  class RawResponse 
+    include HttpClient::Mixin::Response
+
+    attr_reader :file
+
+    def initialize(tempfile, net_http_res)
+      @net_http_res = net_http_res
+      @file = tempfile
+    end
+
+    def to_s
+      @file.open
+      @file.read
+    end
+
+  end
+end

data/lib/http_client/request.rb

@@ -0,0 +1,207 @@
+require 'tempfile'
+
+module HttpClient
+  # This class is used internally by HttpClient to send the request, but you can also
+  # access it internally if you'd like to use a method not directly supported by the
+  # main API.  For example:
+  #
+  #   HttpClient::Request.execute(:method => :head, :url => 'http://example.com')
+  #
+  class Request
+    attr_reader :method, :url, :payload, :headers,
+      :cookies, :user, :password, :timeout, :open_timeout,
+      :verify_ssl, :ssl_client_cert, :ssl_client_key, :ssl_ca_file,
+      :raw_response
+
+    def self.execute(args)
+      new(args).execute
+    end
+
+    def initialize(args)
+      @method = args[:method] or raise ArgumentError, "must pass :method"
+      @url = args[:url] or raise ArgumentError, "must pass :url"
+      @headers = args[:headers] || {}
+      @cookies = @headers.delete(:cookies) || args[:cookies] || {}
+      @payload = process_payload(args[:payload])
+      @user = args[:user]
+      @password = args[:password]
+      @timeout = args[:timeout]
+      @open_timeout = args[:open_timeout]
+      @raw_response = args[:raw_response] || false
+      @verify_ssl = args[:verify_ssl] || false
+      @ssl_client_cert = args[:ssl_client_cert] || nil
+      @ssl_client_key  = args[:ssl_client_key] || nil
+      @ssl_ca_file = args[:ssl_ca_file] || nil
+      @tf = nil # If you are a raw request, this is your tempfile
+    end
+
+    def execute
+      uri = parse_url_with_auth(url)
+      transmit uri, net_http_request_class(method).new(uri.request_uri, make_headers(headers)), payload
+    end
+
+    def make_headers(user_headers)
+      unless @cookies.empty?
+        user_headers[:cookie] = @cookies.map {|key, val| "#{key.to_s}=#{val}" }.join('; ')
+      end
+
+      default_headers.merge(user_headers).inject({}) do |final, (key, value)|
+        final[key.to_s.gsub(/_/, '-').capitalize] = value.to_s
+      final
+      end
+    end
+
+    def net_http_class
+      if HttpClient.proxy
+        proxy_uri = URI.parse(HttpClient.proxy)
+        Net::HTTP::Proxy(proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password)
+      else
+        Net::HTTP
+      end
+    end
+
+    def net_http_request_class(method)
+      Net::HTTP.const_get(method.to_s.capitalize)
+    end
+
+    def parse_url(url)
+      url = "http://#{url}" unless url.match(/^http/)
+      URI.parse(url)
+    end
+
+    def parse_url_with_auth(url)
+      uri = parse_url(url)
+      @user = uri.user if uri.user
+      @password = uri.password if uri.password
+      uri
+    end
+
+    def process_payload(p=nil, parent_key=nil)
+      unless p.is_a?(Hash)
+        p
+      else
+        @headers[:content_type] ||= 'application/x-www-form-urlencoded'
+        p.keys.map do |k|
+          key = parent_key ? "#{parent_key}[#{k}]" : k
+          if p[k].is_a? Hash
+            process_payload(p[k], key)
+          else
+            value = URI.escape(p[k].to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+            "#{key}=#{value}"
+          end
+        end.join("&")
+      end
+    end
+
+    def transmit(uri, req, payload)
+      setup_credentials(req)
+
+      net = net_http_class.new(uri.host, uri.port)
+      net.use_ssl = uri.is_a?(URI::HTTPS)
+      net.verify_mode = OpenSSL::SSL::VERIFY_NONE if @verify_ssl == false
+      net.cert = @ssl_client_cert if @ssl_client_cert
+      net.key = @ssl_client_key if @ssl_client_key
+      net.ca_file = @ssl_ca_file if @ssl_ca_file
+      net.read_timeout = @timeout if @timeout
+      net.open_timeout = @open_timeout if @open_timeout
+
+      display_log request_log
+
+      net.start do |http|
+        res = http.request(req, payload) { |http_response| fetch_body(http_response) }
+        result = process_result(res)
+        display_log response_log(res)
+
+        if result.kind_of?(String) or @method == :head
+          Response.new(result, res)
+        elsif @raw_response
+          RawResponse.new(@tf, res)
+        else
+          nil
+        end
+      end
+    rescue EOFError
+      raise HttpClient::ServerBrokeConnection
+    rescue Timeout::Error
+      raise HttpClient::RequestTimeout
+    rescue Errno::ECONNREFUSED
+      raise HttpClient::ConnectionRefused
+    end
+
+    def setup_credentials(req)
+      req.basic_auth(user, password) if user
+    end
+
+    def fetch_body(http_response)
+      if @raw_response
+        # Taken from Chef, which as in turn...
+        # Stolen from http://www.ruby-forum.com/topic/166423
+        # Kudos to _why!
+        @tf = Tempfile.new("http-client") 
+        size, total = 0, http_response.header['Content-Length'].to_i
+        http_response.read_body do |chunk|
+          @tf.write(chunk) 
+          size += chunk.size
+          if size == 0
+            display_log("#{@method} #{@url} done (0 length file)")
+          elsif total == 0
+            display_log("#{@method} #{@url} (zero content length)")
+          else
+            display_log("#{@method} #{@url} %d%% done (%d of %d)" % [(size * 100) / total, size, total])
+          end
+        end
+        @tf.close
+        @tf
+      else
+        http_response.read_body
+      end
+      http_response
+    end
+
+    def process_result(res)
+      # We don't decode raw requests
+      unless @raw_response
+        decode res['content-encoding'], res.body if res.body
+      end
+    end
+
+    def decode(content_encoding, body)
+      if content_encoding == 'gzip' and not body.empty?
+        Zlib::GzipReader.new(StringIO.new(body)).read
+      elsif content_encoding == 'deflate'
+        Zlib::Inflate.new.inflate(body)
+      else
+        body
+      end
+    end
+
+    def request_log
+      out = []
+      out << "HttpClient.#{method} #{url.inspect}"
+      out << (payload.size > 100 ? "(#{payload.size} byte payload)".inspect : payload.inspect) if payload
+      out << headers.inspect.gsub(/^\{/, '').gsub(/\}$/, '') unless headers.empty?
+      out.join(', ')
+    end
+
+    def response_log(res)
+      size = @raw_response ? File.size(@tf.path) : res.body.size
+      "# => #{res.code} #{res.class.to_s.gsub(/^Net::HTTP/, '')} | #{(res['Content-type'] || '').gsub(/;.*$/, '')} #{size} bytes"
+    end
+
+    def display_log(msg)
+      return unless log_to = HttpClient.log
+
+      if log_to == 'stdout'
+        STDOUT.puts msg
+      elsif log_to == 'stderr'
+        STDERR.puts msg
+      else
+        File.open(log_to, 'a') { |f| f.puts msg }
+      end
+    end
+
+    def default_headers
+      { :accept => 'application/xml', :accept_encoding => 'gzip, deflate' }
+    end
+  end
+end

data/lib/http_client/resource.rb

@@ -0,0 +1,146 @@
+module HttpClient
+  # A class that can be instantiated for access to a HTTPful resource,
+  # including authentication.
+  #
+  # Example:
+  #
+  #   resource = HttpClient::Resource.new('http://some/resource')
+  #   jpg = resource.get(:accept => 'image/jpg')
+  #
+  # With HTTP basic authentication:
+  #
+  #   resource = HttpClient::Resource.new('http://protected/resource', :user => 'user', :password => 'password')
+  #   resource.delete
+  #
+  # With a timeout (seconds):
+  #
+  #   HttpClient::Resource.new('http://slow', :timeout => 10)
+  #
+  # With an open timeout (seconds):
+  #
+  #   HttpClient::Resource.new('http://behindfirewall', :open_timeout => 10)
+  #
+  # You can also use resources to share common headers. For headers keys,
+  # symbols are converted to strings. Example:
+  #
+  #   resource = HttpClient::Resource.new('http://some/resource', :headers => { :client_version => 1 })
+  #
+  # This header will be transported as X-Client-Version (notice the X prefix,
+  # capitalization and hyphens)
+  #
+  # Use the [] syntax to allocate subresources:
+  #
+  #   site = HttpClient::Resource.new('http://example.com', :user => 'adam', :password => 'mypasswd')
+  #   site['posts/1/comments'].post 'Good article.', :content_type => 'text/plain'
+  #
+  class Resource
+    attr_reader :url, :options
+
+    def initialize(url, options={}, backwards_compatibility=nil)
+      @url = url
+      if options.class == Hash
+        @options = options
+      else # compatibility with previous versions
+        @options = { :user => options, :password => backwards_compatibility }
+      end
+    end
+
+    def get(additional_headers={})
+      Request.execute(options.merge(
+        :method => :get,
+        :url => url,
+        :headers => headers.merge(additional_headers)
+      ))
+    end
+
+    def post(payload, additional_headers={})
+      Request.execute(options.merge(
+        :method => :post,
+        :url => url,
+        :payload => payload,
+        :headers => headers.merge(additional_headers)
+      ))
+    end
+
+    def put(payload, additional_headers={})
+      Request.execute(options.merge(
+        :method => :put,
+        :url => url,
+        :payload => payload,
+        :headers => headers.merge(additional_headers)
+      ))
+    end
+
+    def delete(additional_headers={})
+      Request.execute(options.merge(
+        :method => :delete,
+        :url => url,
+        :headers => headers.merge(additional_headers)
+      ))
+    end
+
+    def to_s
+      url
+    end
+
+    def user
+      options[:user]
+    end
+
+    def password
+      options[:password]
+    end
+
+    def headers
+      options[:headers] || {}
+    end
+
+    def timeout
+      options[:timeout]
+    end
+    
+    def open_timeout
+      options[:open_timeout]
+    end
+
+    # Construct a subresource, preserving authentication.
+    #
+    # Example:
+    #
+    #   site = HttpClient::Resource.new('http://example.com', 'adam', 'mypasswd')
+    #   site['posts/1/comments'].post 'Good article.', :content_type => 'text/plain'
+    #
+    # This is especially useful if you wish to define your site in one place and
+    # call it in multiple locations:
+    #
+    #   def orders
+    #     HttpClient::Resource.new('http://example.com/orders', 'admin', 'mypasswd')
+    #   end
+    #
+    #   orders.get                     # GET http://example.com/orders
+    #   orders['1'].get                # GET http://example.com/orders/1
+    #   orders['1/items'].delete       # DELETE http://example.com/orders/1/items
+    #
+    # Nest resources as far as you want:
+    #
+    #   site = HttpClient::Resource.new('http://example.com')
+    #   posts = site['posts']
+    #   first_post = posts['1']
+    #   comments = first_post['comments']
+    #   comments.post 'Hello', :content_type => 'text/plain'
+    #
+    def [](suburl)
+      self.class.new(concat_urls(url, suburl), options)
+    end
+
+    def concat_urls(url, suburl)   # :nodoc:
+      url = url.to_s
+      suburl = suburl.to_s
+      if url.slice(-1, 1) == '/' or suburl.slice(0, 1) == '/'
+        url + suburl
+      else
+        "#{url}/#{suburl}"
+      end
+    end
+  end
+end

data/lib/http_client/response.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/mixin/response'
+
+module HttpClient
+  # The response from HttpClient looks like a string, but is actually one of
+  # these.  99% of the time you're making a http call all you care about is
+  # the body, but on the occassion you want to fetch the headers you can:
+  #
+  #   HttpClient.get('http://example.com').headers[:content_type]
+  #
+  class Response < String
+
+    include HttpClient::Mixin::Response
+
+    def initialize(string, net_http_res)
+      @net_http_res = net_http_res
+      super(string || "")
+    end
+
+  end
+end

data/spec/base.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'spec'
+
+require File.dirname(__FILE__) + '/../lib/http_client'

data/spec/exceptions_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/base'
+
+describe HttpClient::Exception do
+  it "sets the exception message to ErrorMessage" do
+    HttpClient::ServerBrokeConnection.new.message.should == 'Server broke connection'
+  end
+
+  it "contains exceptions in HttpClient" do
+    HttpClient::ServerBrokeConnection.new.should be_a_kind_of(HttpClient::Exception)
+    HttpClient::RequestTimeout.new.should be_a_kind_of(HttpClient::Exception)
+  end
+end

data/spec/http_client_spec.rb

@@ -0,0 +1,53 @@
+require File.dirname(__FILE__) + '/base'
+
+describe HttpClient do
+  describe "API" do
+    it "GET" do
+      HttpClient::Request.should_receive(:execute).with(:method => :get, :url => 'http://some/resource', :headers => {})
+      HttpClient.get('http://some/resource')
+    end
+
+    it "POST" do
+      HttpClient::Request.should_receive(:execute).with(:method => :post, :url => 'http://some/resource', :payload => 'payload', :headers => {})
+      HttpClient.post('http://some/resource', 'payload')
+    end
+
+    it "PUT" do
+      HttpClient::Request.should_receive(:execute).with(:method => :put, :url => 'http://some/resource', :payload => 'payload', :headers => {})
+      HttpClient.put('http://some/resource', 'payload')
+    end
+
+    it "DELETE" do
+      HttpClient::Request.should_receive(:execute).with(:method => :delete, :url => 'http://some/resource', :headers => {})
+      HttpClient.delete('http://some/resource')
+    end
+
+    it "HEAD" do
+      HttpClient::Request.should_receive(:execute).with(:method => :head, :url => 'http://some/resource', :headers => {})
+      HttpClient.head('http://some/resource')
+    end
+  end
+
+  describe "logging" do
+    after do
+      HttpClient.log = nil
+    end
+
+    it "gets the log source from the HTTPCLIENT_LOG environment variable" do
+      ENV.stub!(:[]).with('HTTPCLIENT_LOG').and_return('from env')
+      HttpClient.log = 'from class method'
+      HttpClient.log.should == 'from env'
+    end
+
+    it "sets a destination for log output, used if no environment variable is set" do
+      ENV.stub!(:[]).with('HTTPCLIENT_LOG').and_return(nil)
+      HttpClient.log = 'from class method'
+      HttpClient.log.should == 'from class method'
+    end
+
+    it "returns nil (no logging) if neither are set (default)" do
+      ENV.stub!(:[]).with('HTTPCLIENT_LOG').and_return(nil)
+      HttpClient.log.should == nil
+    end
+  end
+end