sevenwire-rest-client 0.9.3

data/README.rdoc

@@ -0,0 +1,151 @@
+= REST Client -- simple DSL for accessing REST resources
+
+A simple REST client for Ruby, inspired by the Sinatra's microframework style
+of specifying actions: get, put, post, delete.
+
+== Usage: Raw URL
+
+  require 'rest_client'
+
+  RestClient.get 'http://example.com/resource'
+  RestClient.get 'https://user:password@example.com/private/resource'
+
+  RestClient.post 'http://example.com/resource', :param1 => 'one', :nested => { :param2 => 'two' }
+
+  RestClient.delete 'http://example.com/resource'
+
+See RestClient module docs for details.
+
+== Usage: ActiveResource-Style
+
+  resource = RestClient::Resource.new 'http://example.com/resource'
+  resource.get
+
+  private_resource = RestClient::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 RestClient::Resource module docs for details.
+
+== Usage: Resource Nesting
+
+  site = RestClient::Resource.new('http://example.com')
+  site['posts/1/comments'].post 'Good article.', :content_type => 'text/plain'
+
+See RestClient::Resource docs for details.
+
+== Shell
+
+The restclient shell command gives an IRB session with RestClient already loaded:
+
+  $ restclient
+  >> RestClient.get 'http://example.com'
+
+Specify a URL argument for get/post/put/delete on that resource:
+
+  $ restclient http://example.com
+  >> put '/resource', 'data'
+
+Add a user and password for authenticated resources:
+
+  $ restclient https://example.com user pass
+  >> delete '/private/resource'
+
+Create ~/.restclient 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:
+
+  $ restclient private_site
+  
+Use as a one-off, curl-style:
+
+  $ restclient get http://example.com/resource > output_body
+
+  $ restclient put http://example.com/resource < input_body
+
+== Logging
+
+Write calls to a log filename (can also be "stdout" or "stderr"):
+
+  RestClient.log = '/tmp/restclient.log'
+
+Or set an environment variable to avoid modifying the code:
+
+  $ RESTCLIENT_LOG=stdout path/to/my/program
+
+Either produces logs like this:
+
+  RestClient.get "http://some/resource"
+  # => 200 OK | text/html 250 bytes
+  RestClient.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 restclient
+shell or a script to replay your sequence of rest calls.
+
+== Proxy
+
+All calls to RestClient, including Resources, will use the proxy specified by
+RestClient.proxy:
+
+  RestClient.proxy = "http://proxy.example.com/"
+  RestClient.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:
+
+  RestClient.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 = RestClient.get 'http://example.com/action_which_sets_session_id'
+  response.cookies
+  # => {"_applicatioN_session_id" => "1234"}
+
+  response2 = RestClient.post(
+    'http://localhost:3000/',
+    {:param1 => "foo"},
+    {:cookies => {:session_id => "1234"}}
+  )
+  # ...response body
+
+== SSL Client Certificates
+
+  RestClient::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
+
+Written by Adam Wiggins (adam at heroku dot com)
+
+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
+
+http://rest-client.heroku.com
+
+http://github.com/adamwiggins/rest-client
+

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rest-client"
+    gem.summary = %Q{Simple REST client for Ruby, inspired by microframework syntax for specifying actions.}
+    gem.email = "adam@heroku.com"
+    gem.homepage = "http://rest-client.heroku.com/"
+    gem.authors = ["Adam Wiggins"]
+
+    # 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 = "rest-client #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

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

data/bin/restclient

@@ -0,0 +1,82 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.dirname(__FILE__) + "/../lib"
+require 'restclient'
+
+require "yaml"
+
+def usage(why = nil)
+  puts "failed for reason: #{why}" if why
+  puts "usage: restclient [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'] + "/.restclient")) 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 ||= RestClient::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 RestClient::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 = "~/.restclientrc")
+  load(rcfile)
+end
+
+ARGV.clear
+
+IRB.start
+exit!

data/lib/rest_client.rb

@@ -0,0 +1,2 @@
+# This file exists for backward compatbility with require 'rest_client'
+require File.dirname(__FILE__) + '/restclient'

data/lib/restclient/exceptions.rb

@@ -0,0 +1,34 @@
+module RestClient
+  # This is the base RestClient exception class. Rescue it if you want to
+  # catch any exception that your request might raise
+  class Exception < RuntimeError
+    def message(default=nil)
+      self.class::ErrorMessage
+    end
+  end
+
+  # Base RestClient 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
+end

data/lib/restclient/mixin/response.rb

@@ -0,0 +1,43 @@
+module RestClient
+  module Mixin
+    module Response
+      attr_reader :net_http_res
+
+      # HTTP status code, always 200 since RestClient 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(RestClient::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

data/lib/restclient/raw_response.rb

@@ -0,0 +1,30 @@
+require File.dirname(__FILE__) + '/mixin/response'
+
+module RestClient
+  # The response from RestClient on a raw request looks like a string, but is 
+  # actually one of these.  99% of the time you're making a rest call all you 
+  # care about is the body, but on the occassion you want to fetch the 
+  # headers you can:
+  #
+  #   RestClient.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 RestClient::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/restclient/request.rb

@@ -0,0 +1,232 @@
+require 'tempfile'
+
+module RestClient
+  # This class is used internally by RestClient 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:
+  #
+  #   RestClient::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
+      execute_inner
+    rescue Redirect => e
+      @url = e.url
+      execute
+    end
+
+    def execute_inner
+      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 RestClient.proxy
+        proxy_uri = URI.parse(RestClient.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 RestClient::ServerBrokeConnection
+    rescue Timeout::Error
+      raise RestClient::RequestTimeout
+    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("rest-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)
+      if res.code =~ /\A2\d{2}\z/ 
+        # We don't decode raw requests
+        unless @raw_response
+          decode res['content-encoding'], res.body if res.body
+        end
+      elsif %w(301 302 303).include? res.code
+        url = res.header['Location']
+
+        if url !~ /^http/
+          uri = URI.parse(@url)
+          uri.path = "/#{url}".squeeze('/')
+          url = uri.to_s
+        end
+
+        "Redirected to: #{url}"
+      elsif res.code == "304"
+        "Not Modified"
+      elsif res.code == "401"
+        "Unauthorized"
+      elsif res.code == "404"
+        "Not Found"
+      else
+        "Failed"
+      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 << "RestClient.#{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 = RestClient.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