sevenwire-http_client 0.1.0

data/README.rdoc

@@ -0,0 +1,159 @@
+= HTTP Client -- simple DSL for accessing HTTP resources
+
+A simple HTTP client for Ruby, inspired by the Sinatra's microframework style
+of specifying actions: get, put, post, delete.
+
+== Usage: Raw URL
+
+  require 'http_client'
+
+  HttpClient.get 'http://example.com/resource'
+  HttpClient.get 'https://user:password@example.com/private/resource'
+
+  HttpClient.post 'http://example.com/resource', :param1 => 'one', :nested => { :param2 => 'two' }
+
+  HttpClient.delete 'http://example.com/resource'
+
+See HttpClient module docs for details.
+
+== Usage: ActiveResource-Style
+
+  resource = HttpClient::Resource.new 'http://example.com/resource'
+  resource.get
+
+  private_resource = HttpClient::Resource.new 'https://example.com/private/resource', :user => 'adam', :password => 'secret', :timeout => 20, :open_timeout => 5
+  private_resource.put File.read('pic.jpg'), :content_type => 'image/jpg'
+
+See HttpClient::Resource module docs for details.
+
+== Usage: Resource Nesting
+
+  site = HttpClient::Resource.new('http://example.com')
+  site['posts/1/comments'].post 'Good article.', :content_type => 'text/plain'
+
+See HttpClient::Resource docs for details.
+
+== Shell
+
+The http_client shell command gives an IRB session with HttpClient already loaded:
+
+  $ http_client
+  >> HttpClient.get 'http://example.com'
+
+Specify a URL argument for get/post/put/delete on that resource:
+
+  $ http_client http://example.com
+  >> put '/resource', 'data'
+
+Add a user and password for authenticated resources:
+
+  $ http_client https://example.com user pass
+  >> delete '/private/resource'
+
+Create ~/.http_client for named sessions:
+
+  sinatra:
+    url: http://localhost:4567
+  rack:
+    url: http://localhost:9292
+  private_site:
+    url: http://example.com
+    username: user
+    password: pass
+
+Then invoke:
+
+  $ http_client private_site
+  
+Use as a one-off, curl-style:
+
+  $ http_client get http://example.com/resource > output_body
+
+  $ http_client put http://example.com/resource < input_body
+
+== Logging
+
+Write calls to a log filename (can also be "stdout" or "stderr"):
+
+  HttpClient.log = '/tmp/http_client.log'
+
+Or set an environment variable to avoid modifying the code:
+
+  $ HTTPCLIENT_LOG=stdout path/to/my/program
+
+Either produces logs like this:
+
+  HttpClient.get "http://some/resource"
+  # => 200 OK | text/html 250 bytes
+  HttpClient.put "http://some/resource", "payload"
+  # => 401 Unauthorized | application/xml 340 bytes
+
+Note that these logs are valid Ruby, so you can paste them into the http_client
+shell or a script to replay your sequence of http calls.
+
+== Proxy
+
+All calls to HttpClient, including Resources, will use the proxy specified by
+HttpClient.proxy:
+
+  HttpClient.proxy = "http://proxy.example.com/"
+  HttpClient.get "http://some/resource"
+  # => response from some/resource as proxied through proxy.example.com
+
+Often the proxy url is set in an environment variable, so you can do this to
+use whatever proxy the system is configured to use:
+
+  HttpClient.proxy = ENV['http_proxy']
+
+== Cookies
+
+Request and Response objects know about HTTP cookies, and will automatically
+extract and set headers for them as needed:
+
+  response = HttpClient.get 'http://example.com/action_which_sets_session_id'
+  response.cookies
+  # => {"_applicatioN_session_id" => "1234"}
+
+  response2 = HttpClient.post(
+    'http://localhost:3000/',
+    {:param1 => "foo"},
+    {:cookies => {:session_id => "1234"}}
+  )
+  # ...response body
+
+== SSL Client Certificates
+
+  HttpClient::Resource.new(
+    'https://example.com', 
+    :ssl_client_cert  =>  OpenSSL::X509::Certificate.new(File.read("cert.pem")), 
+    :ssl_client_key   =>  OpenSSL::PKey::RSA.new(File.read("key.pem"), "passphrase, if any"),
+    :ssl_ca_file      =>  "ca_certificate.pem", 
+    :verify_ssl       =>  OpenSSL::SSL::VERIFY_PEER 
+  ).get
+
+Self-signed certificates can be generated with the openssl command-line tool.
+
+== Meta
+
+This library began its life as RestClient. Due to some changes and the desire
+to not conflict with the original library, Sevenwire forked and renamed it.
+
+RestClient was written by Adam Wiggins (adam at heroku dot com)
+
+RestClient Patches contributed by: Chris Anderson, Greg Borenstein, Ardekantur, Pedro
+Belo, Rafael Souza, Rick Olson, Aman Gupta, Blake Mizerany, Brian Donovan, Ivan
+Makfinsky, Marc-André Cournoyer, Coda Hale, Tetsuo Watanabe, Dusty Doris,
+Lennon Day-Reynolds, James Edward Gray II, Cyril Rohr, Juan Alvarez, and Adam
+Jacob
+
+Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
+
+RestClient can be found at:
+
+http://rest-client.heroku.com
+
+http://github.com/adamwiggins/rest-client
+
+HttpClient can be found at:
+
+http://github.com/sevenwire/http-client

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "http_client"
+    gem.summary = %Q{Simple HTTP/REST client for Ruby, inspired by microframework syntax for specifying actions. Forked from RestClient http://rest-client.heroku.com see README for reasons}
+    gem.email = "nate@sevenwire.com"
+    gem.homepage = "http://github.com/sevenwire/http_client"
+    gem.authors = ["Adam Wiggins", "Nate Sutton"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "http-client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 0

data/bin/http_client

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.dirname(__FILE__) + "/../lib"
+require 'http_client'
+
+require "yaml"
+
+def usage(why = nil)
+  puts "failed for reason: #{why}" if why
+  puts "usage: http_client [get|put|post|delete] url|name [username] [password]"
+  puts "  The verb is optional, if you leave it off you'll get an interactive shell."
+  puts "  put and post both take the input body on stdin."
+  exit(1)
+end
+
+if %w(get put post delete).include? ARGV.first
+  @verb = ARGV.shift
+else
+  @verb = nil
+end
+
+@url = ARGV.shift || 'http://localhost:4567'
+
+config = YAML.load(File.read(ENV['HOME'] + "/.http_client")) rescue {}
+
+@url, @username, @password = if c = config[@url]
+  [c['url'], c['username'], c['password']]
+else
+  [@url, *ARGV]
+end
+
+usage("invalid url '#{@url}") unless @url =~ /^https?/
+usage("too few args") unless ARGV.size < 3
+
+def r
+  @r ||= HttpClient::Resource.new(@url, @username, @password)
+end
+
+r # force rc to load
+
+if @verb
+  begin
+    if %w(put post).include? @verb
+      puts r.send(@verb, STDIN.read)
+    else
+      puts r.send(@verb)
+    end
+    exit 0
+  rescue HttpClient::Exception => e
+    puts e.response.body if e.respond_to? :response
+    raise
+  end
+end
+
+%w(get post put delete).each do |m|
+ eval <<-end_eval
+def #{m}(path, *args, &b)
+  r[path].#{m}(*args, &b)
+end
+ end_eval
+end
+
+def method_missing(s, *args, &b)
+  super unless r.respond_to?(s)
+  r.send(s, *args, &b)
+end
+
+require 'irb'
+require 'irb/completion'
+
+if File.exists? ".irbrc"
+  ENV['IRBRC'] = ".irbrc"
+end
+
+if File.exists?(rcfile = "~/.http_clientrc")
+  load(rcfile)
+end
+
+ARGV.clear
+
+IRB.start
+exit!

data/lib/http_client.rb

@@ -0,0 +1,93 @@
+require 'uri'
+require 'net/https'
+require 'zlib'
+require 'stringio'
+
+require File.dirname(__FILE__) + '/http_client/request'
+require File.dirname(__FILE__) + '/http_client/mixin/response'
+require File.dirname(__FILE__) + '/http_client/response'
+require File.dirname(__FILE__) + '/http_client/raw_response'
+require File.dirname(__FILE__) + '/http_client/resource'
+require File.dirname(__FILE__) + '/http_client/exceptions'
+
+# This module's static methods are the entry point for using the HTTP client.
+#
+#   # GET
+#   xml = HttpClient.get 'http://example.com/resource'
+#   jpg = HttpClient.get 'http://example.com/resource', :accept => 'image/jpg'
+#
+#   # authentication and SSL
+#   HttpClient.get 'https://user:password@example.com/private/resource'
+#
+#   # POST or PUT with a hash sends parameters as a urlencoded form body
+#   HttpClient.post 'http://example.com/resource', :param1 => 'one'
+#
+#   # nest hash parameters
+#   HttpClient.post 'http://example.com/resource', :nested => { :param1 => 'one' }
+#
+#   # POST and PUT with raw payloads
+#   HttpClient.post 'http://example.com/resource', 'the post body', :content_type => 'text/plain'
+#   HttpClient.post 'http://example.com/resource.xml', xml_doc
+#   HttpClient.put 'http://example.com/resource.pdf', File.read('my.pdf'), :content_type => 'application/pdf'
+#
+#   # DELETE
+#   HttpClient.delete 'http://example.com/resource'
+#
+#   # retreive the response http code and headers
+#   res = HttpClient.get 'http://example.com/some.jpg'
+#   res.code                    # => 200
+#   res.headers[:content_type]  # => 'image/jpg'
+#
+#   # HEAD
+#   HttpClient.head('http://example.com').headers
+#
+# To use with a proxy, just set HttpClient.proxy to the proper http proxy:
+#
+#   HttpClient.proxy = "http://proxy.example.com/"
+#
+# Or inherit the proxy from the environment:
+#
+#   HttpClient.proxy = ENV['http_proxy']
+#
+# For live tests of HttpClient, try using http://http-test.heroku.com, which echoes back information about the http call:
+#
+#   >> HttpClient.put 'http://http-test.heroku.com/resource', :foo => 'baz'
+#   => "PUT http://http-test.heroku.com/resource with a 7 byte payload, content type application/x-www-form-urlencoded {\"foo\"=>\"baz\"}"
+#
+module HttpClient
+  def self.get(url, headers={})
+    Request.execute(:method => :get, :url => url, :headers => headers)
+  end
+
+  def self.post(url, payload, headers={})
+    Request.execute(:method => :post, :url => url, :payload => payload, :headers => headers)
+  end
+
+  def self.put(url, payload, headers={})
+    Request.execute(:method => :put, :url => url, :payload => payload, :headers => headers)
+  end
+
+  def self.delete(url, headers={})
+    Request.execute(:method => :delete, :url => url, :headers => headers)
+  end
+
+  def self.head(url, headers={})
+    Request.execute(:method => :head, :url => url, :headers => headers)
+  end
+
+  class << self
+    attr_accessor :proxy
+  end
+
+  # Print log of HttpClient calls.  Value can be stdout, stderr, or a filename.
+  # You can also configure logging by the environment variable HTTPCLIENT_LOG.
+  def self.log=(log)
+    @@log = log
+  end
+
+  def self.log    # :nodoc:
+    return ENV['HTTPCLIENT_LOG'] if ENV['HTTPCLIENT_LOG']
+    return @@log if defined? @@log
+    nil
+  end
+end

data/lib/http_client/exceptions.rb

@@ -0,0 +1,39 @@
+module HttpClient
+  # This is the base HttpClient exception class. Rescue it if you want to
+  # catch any exception that your request might raise
+  class Exception < StandardError
+    def message(default=nil)
+      self.class::ErrorMessage
+    end
+  end
+
+  # Base HttpClient exception when there's a response available
+  class ExceptionWithResponse < Exception
+    attr_accessor :response
+
+    def initialize(response=nil)
+      @response = response
+    end
+
+    def http_code
+      @response.code.to_i if @response
+    end
+  end
+
+  # The server broke the connection prior to the request completing.  Usually
+  # this means it crashed, or sometimes that your network connection was
+  # severed before it could complete.
+  class ServerBrokeConnection < Exception
+    ErrorMessage = 'Server broke connection'
+  end
+
+  # The server took too long to respond.
+  class RequestTimeout < Exception
+    ErrorMessage = 'Request timed out'
+  end
+
+  # The server refused the connection
+  class ConnectionRefused < Exception
+    ErrorMessage = 'Server refused connection'
+  end
+end

data/lib/http_client/mixin/response.rb

@@ -0,0 +1,43 @@
+module HttpClient
+  module Mixin
+    module Response
+      attr_reader :net_http_res
+
+      # HTTP status code, always 200 since HttpClient throws exceptions for
+      # other codes.
+      def code
+        @code ||= @net_http_res.code.to_i
+      end
+
+      # A hash of the headers, beautified with symbols and underscores.
+      # e.g. "Content-type" will become :content_type.
+      def headers
+        @headers ||= self.class.beautify_headers(@net_http_res.to_hash)
+      end
+
+      # Hash of cookies extracted from response headers
+      def cookies
+        @cookies ||= (self.headers[:set_cookie] || "").split('; ').inject({}) do |out, raw_c|
+          key, val = raw_c.split('=')
+          unless %w(expires domain path secure).member?(key)
+            out[key] = val
+          end
+          out
+        end
+      end
+
+      def self.included(receiver)
+        receiver.extend(HttpClient::Mixin::Response::ClassMethods)
+      end
+
+      module ClassMethods
+        def beautify_headers(headers)
+          headers.inject({}) do |out, (key, value)|
+            out[key.gsub(/-/, '_').to_sym] = value.first
+            out
+          end
+        end
+      end
+    end
+  end
+end