esod-client 0.1.0

data/lib/rest-client-1.2.0/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={}, &b)
+      headers = (options[:headers] || {}).merge(additional_headers)
+      Request.execute(options.merge(
+              :method => :get,
+              :url => url,
+              :headers => headers), &b)
+    end
+
+    def post(payload, additional_headers={}, &b)
+      headers = (options[:headers] || {}).merge(additional_headers)
+      Request.execute(options.merge(
+              :method => :post,
+              :url => url,
+              :payload => payload,
+              :headers => headers), &b)
+    end
+
+    def put(payload, additional_headers={}, &b)
+      headers = (options[:headers] || {}).merge(additional_headers)
+      Request.execute(options.merge(
+              :method => :put,
+              :url => url,
+              :payload => payload,
+              :headers => headers), &b)
+    end
+
+    def delete(additional_headers={}, &b)
+      headers = (options[:headers] || {}).merge(additional_headers)
+      Request.execute(options.merge(
+              :method => :delete,
+              :url => url,
+              :headers => headers), &b)
+    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/rest-client-1.2.0/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/rest-client-1.2.0/spec/base.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'spec'
+
+begin
+  require "ruby-debug"
+rescue LoadError
+  # NOP, ignore
+end
+
+require File.dirname(__FILE__) + '/../lib/restclient'

data/lib/rest-client-1.2.0/spec/exceptions_spec.rb

@@ -0,0 +1,65 @@
+require File.dirname(__FILE__) + '/base'
+
+describe RestClient::Exception do
+  it "sets the exception message to ErrorMessage" do
+    RestClient::ResourceNotFound.new.message.should == 'Resource not found'
+  end
+
+  it "contains exceptions in RestClient" do
+    RestClient::Unauthorized.new.should be_a_kind_of(RestClient::Exception)
+    RestClient::ServerBrokeConnection.new.should be_a_kind_of(RestClient::Exception)
+  end
+end
+
+describe RestClient::RequestFailed do
+  before do
+    @response = mock('HTTP Response', :code => '502')
+  end
+
+  it "stores the http response on the exception" do
+    begin
+      raise RestClient::RequestFailed, :response
+    rescue RestClient::RequestFailed => e
+      e.response.should == :response
+    end
+  end
+
+  it "http_code convenience method for fetching the code as an integer" do
+    RestClient::RequestFailed.new(@response).http_code.should == 502
+  end
+
+  it "http_body convenience method for fetching the body (decoding when necessary)" do
+    @response.stub!(:[]).with('content-encoding').and_return('gzip')
+    @response.stub!(:body).and_return('compressed body')
+    RestClient::Request.should_receive(:decode).with('gzip', 'compressed body').and_return('plain body')
+    RestClient::RequestFailed.new(@response).http_body.should == 'plain body'
+  end
+
+  it "shows the status code in the message" do
+    RestClient::RequestFailed.new(@response).to_s.should match(/502/)
+  end
+end
+
+describe RestClient::ResourceNotFound do
+  it "also has the http response attached" do
+    begin
+      raise RestClient::ResourceNotFound, :response
+    rescue RestClient::ResourceNotFound => e
+      e.response.should == :response
+    end
+  end
+end
+
+describe "backwards compatibility" do
+  it "alias RestClient::Request::Redirect to RestClient::Redirect" do
+    RestClient::Request::Redirect.should == RestClient::Redirect
+  end
+
+  it "alias RestClient::Request::Unauthorized to RestClient::Unauthorized" do
+    RestClient::Request::Unauthorized.should == RestClient::Unauthorized
+  end
+
+  it "alias RestClient::Request::RequestFailed to RestClient::RequestFailed" do
+    RestClient::Request::RequestFailed.should == RestClient::RequestFailed
+  end
+end

data/lib/rest-client-1.2.0/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/lib/rest-client-1.2.0/spec/payload_spec.rb

@@ -0,0 +1,131 @@
+require File.dirname(__FILE__) + "/base"
+
+describe RestClient::Payload do
+  context "A regular Payload" do
+    it "should use standard enctype as default content-type" do
+      RestClient::Payload::UrlEncoded.new({}).headers['Content-Type'].
+              should == 'application/x-www-form-urlencoded'
+    end
+
+    it "should form properly encoded params" do
+      RestClient::Payload::UrlEncoded.new({:foo => 'bar'}).to_s.
+              should == "foo=bar"
+    end
+
+    it "should properly handle hashes as parameter" do
+      RestClient::Payload::UrlEncoded.new({:foo => {:bar => 'baz' }}).to_s.
+              should == "foo[bar]=baz"
+      RestClient::Payload::UrlEncoded.new({:foo => {:bar => {:baz => 'qux' }}}).to_s.
+              should == "foo[bar][baz]=qux"
+    end
+
+    it "should form properly use symbols as parameters" do
+      RestClient::Payload::UrlEncoded.new({:foo => :bar}).to_s.
+              should == "foo=bar"
+      RestClient::Payload::UrlEncoded.new({:foo => {:bar => :baz }}).to_s.
+              should == "foo[bar]=baz"
+    end
+
+  end
+
+  context "A multipart Payload" do
+    it "should use standard enctype as default content-type" do
+      m = RestClient::Payload::Multipart.new({})
+      m.stub!(:boundary).and_return(123)
+      m.headers['Content-Type'].should == 'multipart/form-data; boundary="123"'
+    end
+
+    it "should form properly separated multipart data" do
+      m = RestClient::Payload::Multipart.new([[:bar, "baz"], [:foo, "bar"]])
+      m.to_s.should == <<-EOS
+--#{m.boundary}\r
+Content-Disposition: multipart/form-data; name="bar"\r
+\r
+baz\r
+--#{m.boundary}\r
+Content-Disposition: multipart/form-data; name="foo"\r
+\r
+bar\r
+--#{m.boundary}--\r
+      EOS
+    end
+
+    it "should form properly separated multipart data" do
+      f = File.new(File.dirname(__FILE__) + "/master_shake.jpg")
+      m = RestClient::Payload::Multipart.new({:foo => f})
+      m.to_s.should == <<-EOS
+--#{m.boundary}\r
+Content-Disposition: multipart/form-data; name="foo"; filename="master_shake.jpg"\r
+Content-Type: image/jpeg\r
+\r
+#{IO.read(f.path)}\r
+--#{m.boundary}--\r
+      EOS
+    end
+
+    it "should detect optional (original) content type and filename" do
+      f = File.new(File.dirname(__FILE__) + "/master_shake.jpg")
+      f.instance_eval "def content_type; 'text/plain'; end"
+      f.instance_eval "def original_filename; 'foo.txt'; end"
+      m = RestClient::Payload::Multipart.new({:foo => f})
+      m.to_s.should == <<-EOS
+--#{m.boundary}\r
+Content-Disposition: multipart/form-data; name="foo"; filename="foo.txt"\r
+Content-Type: text/plain\r
+\r
+#{IO.read(f.path)}\r
+--#{m.boundary}--\r
+      EOS
+    end
+
+    it "should handle hash in hash parameters" do
+      m = RestClient::Payload::Multipart.new({:bar => {:baz => "foo"}})
+      m.to_s.should == <<-EOS
+--#{m.boundary}\r
+Content-Disposition: multipart/form-data; name="bar[baz]"\r
+\r
+foo\r
+--#{m.boundary}--\r
+      EOS
+
+      f = File.new(File.dirname(__FILE__) + "/master_shake.jpg")
+      f.instance_eval "def content_type; 'text/plain'; end"
+      f.instance_eval "def original_filename; 'foo.txt'; end"
+      m = RestClient::Payload::Multipart.new({:foo => {:bar => f}})
+      m.to_s.should == <<-EOS
+--#{m.boundary}\r
+Content-Disposition: multipart/form-data; name="foo[bar]"; filename="foo.txt"\r
+Content-Type: text/plain\r
+\r
+#{IO.read(f.path)}\r
+--#{m.boundary}--\r
+      EOS
+    end
+
+  end
+
+  context "Payload generation" do
+    it "should recognize standard urlencoded params" do
+      RestClient::Payload.generate({"foo" => 'bar'}).should be_kind_of(RestClient::Payload::UrlEncoded)
+    end
+
+    it "should recognize multipart params" do
+      f = File.new(File.dirname(__FILE__) + "/master_shake.jpg")
+      RestClient::Payload.generate({"foo" => f}).should be_kind_of(RestClient::Payload::Multipart)
+    end
+
+    it "should be multipart if forced" do
+      RestClient::Payload.generate({"foo" => "bar", :multipart => true}).should be_kind_of(RestClient::Payload::Multipart)
+    end
+
+    it "should return data if no of the above" do
+      RestClient::Payload.generate("data").should be_kind_of(RestClient::Payload::Base)
+    end
+
+    it "should recognize nested multipart payloads" do
+      f = File.new(File.dirname(__FILE__) + "/master_shake.jpg")
+      RestClient::Payload.generate({"foo" => {"file" => f}}).should be_kind_of(RestClient::Payload::Multipart)
+    end
+
+  end
+end

data/lib/rest-client-1.2.0/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