sevenwire-rest-client 0.9.3

data/lib/restclient/resource.rb

@@ -0,0 +1,146 @@
+module RestClient
+  # A class that can be instantiated for access to a RESTful resource,
+  # including authentication.
+  #
+  # Example:
+  #
+  #   resource = RestClient::Resource.new('http://some/resource')
+  #   jpg = resource.get(:accept => 'image/jpg')
+  #
+  # With HTTP basic authentication:
+  #
+  #   resource = RestClient::Resource.new('http://protected/resource', :user => 'user', :password => 'password')
+  #   resource.delete
+  #
+  # With a timeout (seconds):
+  #
+  #   RestClient::Resource.new('http://slow', :timeout => 10)
+  #
+  # With an open timeout (seconds):
+  #
+  #   RestClient::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 = RestClient::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 = RestClient::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 = RestClient::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
+    #     RestClient::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 = RestClient::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/restclient/response.rb

@@ -0,0 +1,20 @@
+require File.dirname(__FILE__) + '/mixin/response'
+
+module RestClient
+  # The response from RestClient 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]
+  #
+  class Response < String
+
+    include RestClient::Mixin::Response
+
+    def initialize(string, net_http_res)
+      @net_http_res = net_http_res
+      super(string || "")
+    end
+
+  end
+end

data/lib/restclient.rb

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

data/spec/base.rb

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

data/spec/exceptions_spec.rb

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

data/spec/mixin/response_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/../base'
+
+class MockResponse
+  include RestClient::Mixin::Response
+
+  def initialize(body, res)
+    @net_http_res = res
+    @body = @body
+  end
+end
+
+describe RestClient::Mixin::Response do
+  before do
+    @net_http_res = mock('net http response')
+    @response = MockResponse.new('abc', @net_http_res)
+  end
+
+  it "fetches the numeric response code" do
+    @net_http_res.should_receive(:code).and_return('200')
+    @response.code.should == 200
+  end
+
+  it "beautifies the headers by turning the keys to symbols" do
+    h = RestClient::Response.beautify_headers('content-type' => [ 'x' ])
+    h.keys.first.should == :content_type
+  end
+
+  it "beautifies the headers by turning the values to strings instead of one-element arrays" do
+    h = RestClient::Response.beautify_headers('x' => [ 'text/html' ] )
+    h.values.first.should == 'text/html'
+  end
+
+  it "fetches the headers" do
+    @net_http_res.should_receive(:to_hash).and_return('content-type' => [ 'text/html' ])
+    @response.headers.should == { :content_type => 'text/html' }
+  end
+
+  it "extracts cookies from response headers" do
+    @net_http_res.should_receive(:to_hash).and_return('set-cookie' => ['session_id=1; path=/'])
+    @response.cookies.should == { 'session_id' => '1' }
+  end
+
+  it "can access the net http result directly" do
+    @response.net_http_res.should == @net_http_res
+  end
+end

data/spec/raw_response_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/base'
+
+describe RestClient::RawResponse do
+  before do
+    @tf = mock("Tempfile", :read => "the answer is 42", :open => true)
+    @net_http_res = mock('net http response')
+    @response = RestClient::RawResponse.new(@tf, @net_http_res)
+  end
+
+  it "behaves like string" do
+    @response.to_s.should == 'the answer is 42'
+  end
+
+  it "exposes a Tempfile" do
+    @response.file.should == @tf
+  end
+end