rest-client 1.6.1 → 1.6.2.a

data/README.rdoc

@@ -12,7 +12,7 @@ of specifying actions: get, put, post, delete.
   require 'rest_client'
 
   RestClient.get 'http://example.com/resource'
-  
+
   RestClient.get 'http://example.com/resource', {:params => {:id => 50, 'foo' => 'bar'}}
 
   RestClient.get 'https://user:password@example.com/private/resource', {:accept => :json}
@@ -137,7 +137,15 @@ If you want to use non-normalized URIs, you can normalize them with the addressa
 
 == Lower-level access
 
-For cases not covered by the general API, you can use the RestClient::Resource class which provide a lower-level API, see the class' rdoc for more information.
+For cases not covered by the general API, you can use the RestClient::Request class which provide a lower-level API.
+
+You can:
+
+* specify ssl parameters
+* override cookies
+* manually handle the response (so you can operate on the response stream than reading it fully in memory)
+
+see the class' rdoc for more information.
 
 == Shell
 

data/Rakefile

@@ -6,16 +6,17 @@ Jeweler::Tasks.new do |s|
   s.name = "rest-client"
   s.description = "A simple HTTP and REST client for Ruby, inspired by the Sinatra microframework style of specifying actions: get, put, post, delete."
   s.summary = "Simple HTTP and REST client for Ruby, inspired by microframework syntax for specifying actions."
-  s.author = "Adam Wiggins"
+  s.authors = ["Adam Wiggins", "Julien Kirch"]
   s.email = "rest.client@librelist.com"
   s.homepage = "http://github.com/archiloque/rest-client"
   s.rubyforge_project = "rest-client"
   s.has_rdoc = true
   s.files = FileList["[A-Z]*", "{bin,lib,spec}/**/*"]
   s.executables = %w(restclient)
-  s.add_dependency("mime-types", ">= 1.16")
+  s.add_runtime_dependency("mime-types", ">= 1.16")
   s.add_development_dependency("webmock", ">= 0.9.1")
   s.add_development_dependency("rspec")
+  s.extra_rdoc_files = [ 'README.rdoc', 'history.md']
 end
 
 Jeweler::RubyforgeTasks.new

data/VERSION

@@ -1 +1 @@
-1.6.1
+1.6.2.a

data/bin/restclient

@@ -6,17 +6,19 @@ 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)
+  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
+POSSIBLE_VERBS = ['get', 'put', 'post', 'delete']
+
+if POSSIBLE_VERBS.include? ARGV.first
+  @verb = ARGV.shift
 else
-	@verb = nil
+  @verb = nil
 end
 
 @url = ARGV.shift || 'http://localhost:4567'
@@ -24,61 +26,64 @@ end
 config = YAML.load(File.read(ENV['HOME'] + "/.restclient")) rescue {}
 
 @url, @username, @password = if c = config[@url]
-	[c['url'], c['username'], c['password']]
+  [c['url'], c['username'], c['password']]
 else
-	[@url, *ARGV]
+  [@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)
+  @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
+  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)
+POSSIBLE_VERBS.each do |m|
+  eval <<-end_eval
+def  #{m} (path, *args, &b)
+	r[path]. #{m} (*args, &b)
 end
- end_eval
+  end_eval
 end
 
-def method_missing(s, *args, &b)
-	super unless r.respond_to?(s)
-	begin
-		r.send(s, *args, &b)
-	rescue RestClient::RequestFailed => e
-		print STDERR, e.response.body
-		raise e
-	end
+def method_missing(s, * args, & b)
+  if POSSIBLE_VERBS.include? s
+    begin
+      r.send(s, *args, & b)
+    rescue RestClient::RequestFailed => e
+      print STDERR, e.response.body
+      raise e
+    end
+  else
+    super
+  end
 end
 
 require 'irb'
 require 'irb/completion'
 
 if File.exists? ".irbrc"
-	ENV['IRBRC'] = ".irbrc"
+  ENV['IRBRC'] = ".irbrc"
 end
 
-if File.exists?( File.expand_path(rcfile = "~/.restclientrc") )
-	load(rcfile)
+if File.exists?(File.expand_path(rcfile = "~/.restclientrc"))
+  load(rcfile)
 end
 
 ARGV.clear

data/history.md

@@ -1,3 +1,13 @@
+# 1.6.2
+
+- add support for HEAD in resources (patch provided by tpresa)
+- fix shell for 1.9.2
+- workaround when some gem monkeypatch net/http (patch provided by Ian Warshak)
+- DELETE requests should process parameters just like GET and HEAD
+- adding :block_response parameter for manual processing
+- limit number of redirections (patch provided by Chris Dinn)
+- close and unlink the temp file created by playload (patch provided by Chris Green)
+
 # 1.6.1
 
 - add response body in Exception#inspect
@@ -6,6 +16,7 @@
 - block passing in Resource#[] (patch provided by Niko Dittmann)
 - cookies set in a response should be kept in a redirect
 - HEAD requests should process parameters just like GET (patch provided by Rob Eanes)
+- exception message should never be nil (patch provided by Michael Klett)
 
 # 1.6.0
 

data/lib/restclient/abstract_response.rb

@@ -31,7 +31,7 @@ module RestClient
 
     # Return the default behavior corresponding to the response code:
     # the response itself for code in 200..206, redirection for 301, 302 and 307 in get and head cases, redirection for 303 and an exception in other cases
-    def return! request  = nil, result = nil, & block
+    def return! request = nil, result = nil, & block
       if (200..207).include? code
         self
       elsif [301, 302, 307].include? code
@@ -47,7 +47,7 @@ module RestClient
       elsif Exceptions::EXCEPTIONS_MAP[code]
         raise Exceptions::EXCEPTIONS_MAP[code].new(self, code)
       else
-        raise RequestFailed self
+        raise RequestFailed.new(self, code)
       end
     end
 
@@ -67,9 +67,13 @@ module RestClient
       end
       args[:url] = url
       if request
+        if request.max_redirects == 0
+          raise MaxRedirectsReached
+        end
         args[:password] = request.password
         args[:user] = request.user
         args[:headers] = request.headers
+        args[:max_redirects] = request.max_redirects - 1
         # pass any cookie set in the result
         if result && result['set-cookie']
           args[:headers][:cookies] = (args[:headers][:cookies] || {}).merge(parse_cookie(result['set-cookie']))

data/lib/restclient/exceptions.rb

@@ -80,7 +80,8 @@ module RestClient
   # For example, the entire result body (which is
   # probably an HTML error page) is e.response.
   class Exception < RuntimeError
-    attr_accessor :message, :response
+    attr_accessor :response
+    attr_writer   :message
 
     def initialize response = nil, initial_response_code = nil
       @response = response
@@ -110,6 +111,10 @@ module RestClient
     def to_s
       inspect
     end
+    
+    def message
+      @message || self.class.name
+    end
 
   end
 
@@ -158,11 +163,18 @@ module RestClient
     end
   end
 
+  class MaxRedirectsReached < Exception	
+    message = 'Maximum number of redirect reached'	
+  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
-    message = 'Server broke connection'
+    def initialize(message = 'Server broke connection')
+      super nil, nil
+      self.message = message
+    end
   end
 
   class SSLCertificateNotVerified < Exception

data/lib/restclient/payload.rb

@@ -213,7 +213,7 @@ module RestClient
       end
 
       def close
-        @stream.close
+        @stream.close!
       end
     end
   end

data/lib/restclient/request.rb

@@ -16,14 +16,16 @@ module RestClient
   # * :headers a hash containing the request headers
   # * :cookies will replace possible cookies in the :headers
   # * :user and :password for basic auth, will be replaced by a user/password available in the :url
+  # * :block_response call the provided block with the HTTPResponse as parameter
   # * :raw_response return a low-level RawResponse instead of a Response
+  # * :max_redirects maximum number of redirections (default to 10)
   # * :verify_ssl enable ssl verification, possible values are constants from OpenSSL::SSL
   # * :timeout and :open_timeout
   # * :ssl_client_cert, :ssl_client_key, :ssl_ca_file
   class Request
 
     attr_reader :method, :url, :headers, :cookies,
-                :payload, :user, :password, :timeout,
+                :payload, :user, :password, :timeout, :max_redirects,
                 :open_timeout, :raw_response, :verify_ssl, :ssl_client_cert,
                 :ssl_client_key, :ssl_ca_file, :processed_headers, :args
 
@@ -45,12 +47,14 @@ module RestClient
       @password = args[:password]
       @timeout = args[:timeout]
       @open_timeout = args[:open_timeout]
+      @block_response = args[:block_response]
       @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
+      @max_redirects = args[:max_redirects] || 10
       @processed_headers = make_headers headers
       @args = args
     end
@@ -62,7 +66,7 @@ module RestClient
 
     # Extract the query parameters for get request and append them to the url
     def process_get_params url, headers
-      if [:get, :head].include? method
+      if [:get, :head, :delete].include? method
         get_params = {}
         headers.delete_if do |key, value|
           if 'params' == key.to_s.downcase && value.is_a?(Hash)
@@ -164,9 +168,13 @@ module RestClient
       log_request
 
       net.start do |http|
-        res = http.request(req, payload) { |http_response| fetch_body(http_response) }
-        log_response res
-        process_result res, & block
+        if @block_response
+          http.request(req, payload ? payload.to_s : nil, & @block_response)
+        else
+          res = http.request(req, payload ? payload.to_s : nil) { |http_response| fetch_body(http_response) }
+          log_response res
+          process_result res, & block
+        end
       end
     rescue EOFError
       raise RestClient::ServerBrokeConnection

data/lib/restclient/resource.rb

@@ -54,6 +54,14 @@ module RestClient
               :headers => headers), &(block || @block))
     end
 
+    def head(additional_headers={}, &block)
+      headers = (options[:headers] || {}).merge(additional_headers)
+      Request.execute(options.merge(
+              :method => :head,
+              :url => url,
+              :headers => headers), &(block || @block))
+    end
+
     def post(payload, additional_headers={}, &block)
       headers = (options[:headers] || {}).merge(additional_headers)
       Request.execute(options.merge(

data/spec/abstract_response_spec.rb

@@ -64,4 +64,22 @@ describe RestClient::AbstractResponse do
   it "can access the net http result directly" do
     @response.net_http_res.should == @net_http_res
   end
+  
+  describe "#return!" do
+    it "should return the response itself on 200-codes" do
+      @net_http_res.should_receive(:code).and_return('200')
+      @response.return!.should be_equal(@response)
+    end
+
+    it "should raise RequestFailed on unknown codes" do
+      @net_http_res.should_receive(:code).and_return('1000')
+      lambda { @response.return! }.should raise_error RestClient::RequestFailed
+    end
+    
+    it "should raise an error on a redirection after non-GET/HEAD requests" do
+      @net_http_res.should_receive(:code).and_return('301')
+      @response.args.merge(:method => :put)
+      lambda { @response.return! }.should raise_error RestClient::RequestFailed
+    end
+  end
 end

data/spec/exceptions_spec.rb

@@ -4,6 +4,18 @@ require 'webmock/rspec'
 include WebMock
 
 describe RestClient::Exception do
+  it "returns a 'message' equal to the class name if the message is not set, because 'message' should not be nil" do
+    e = RestClient::Exception.new
+    e.message.should == "RestClient::Exception"
+  end
+  
+  it "returns the 'message' that was set" do
+    e = RestClient::Exception.new
+    message = "An explicitly set message"
+    e.message = message
+    e.message.should == message
+  end
+  
   it "sets the exception message to ErrorMessage" do
     RestClient::ResourceNotFound.new.message.should == 'Resource Not Found'
   end
@@ -14,6 +26,13 @@ describe RestClient::Exception do
   end
 end
 
+describe RestClient::ServerBrokeConnection do
+  it "should have a default message of 'Server broke connection'" do
+    e = RestClient::ServerBrokeConnection.new
+    e.message.should == 'Server broke connection'
+  end
+end
+
 describe RestClient::RequestFailed do
   before do
     @response = mock('HTTP Response', :code => '502')

data/spec/request2_spec.rb

@@ -13,5 +13,15 @@ describe RestClient::Request do
     RestClient::Request.execute(:url => 'http://some/resource', :method => :get, :headers => {:foo => :bar, :params => :a}).body.should == 'foo'
   end
 
+  it "can use a block to process response" do
+    response_value = nil
+    block = Proc.new do |http_response|
+      response_value = http_response.body
+    end
+    stub_request(:get, 'http://some/resource?a=b&c=d').with(:headers => {'Accept'=>'*/*; q=0.5, application/xml', 'Accept-Encoding'=>'gzip, deflate', 'Foo'=>'bar'}).to_return(:body => 'foo', :status => 200)
+    RestClient::Request.execute(:url => 'http://some/resource', :method => :get, :headers => {:foo => :bar, :params => {:a => :b, 'c' => 'd'}}, :block_response => block)
+    response_value.should == "foo"
+  end
+
 end
 

data/spec/resource_spec.rb

@@ -14,6 +14,11 @@ describe RestClient::Resource do
       @resource.get
     end
 
+    it "HEAD" do
+      RestClient::Request.should_receive(:execute).with(:method => :head, :url => 'http://some/resource', :headers => {'X-Something' => '1'}, :user => 'jane', :password => 'mypass')
+      @resource.head
+    end
+
     it "POST" do
       RestClient::Request.should_receive(:execute).with(:method => :post, :url => 'http://some/resource', :payload => 'abc', :headers => {:content_type => 'image/jpg', 'X-Something' => '1'}, :user => 'jane', :password => 'mypass')
       @resource.post 'abc', :content_type => 'image/jpg'

data/spec/response_spec.rb

@@ -149,8 +149,20 @@ describe RestClient::Response do
       stub_request(:get, 'http://new/resource').to_return(:body => 'Foo')
       RestClient::Request.execute(:url => 'http://some/resource', :method => :get).body.should == 'Foo'
     end
-
     
+    it "follows no more than 10 redirections before raising error" do
+      stub_request(:get, 'http://some/redirect-1').to_return(:body => '', :status => 301, :headers => {'Location' => 'http://some/redirect-2'})
+      stub_request(:get, 'http://some/redirect-2').to_return(:body => '', :status => 301, :headers => {'Location' => 'http://some/redirect-2'})
+      lambda { RestClient::Request.execute(:url => 'http://some/redirect-1', :method => :get) }.should raise_error(RestClient::MaxRedirectsReached)
+      WebMock.should have_requested(:get, 'http://some/redirect-2').times(10)
+    end
+    
+    it "follows no more than max_redirects redirections, if specified" do
+      stub_request(:get, 'http://some/redirect-1').to_return(:body => '', :status => 301, :headers => {'Location' => 'http://some/redirect-2'})
+      stub_request(:get, 'http://some/redirect-2').to_return(:body => '', :status => 301, :headers => {'Location' => 'http://some/redirect-2'})
+      lambda { RestClient::Request.execute(:url => 'http://some/redirect-1', :method => :get, :max_redirects => 5) }.should raise_error(RestClient::MaxRedirectsReached)
+      WebMock.should have_requested(:get, 'http://some/redirect-2').times(5)
+    end
   end
 
 

metadata

@@ -1,13 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: rest-client
 version: !ruby/object:Gem::Version 
-  hash: 13
-  prerelease: false
+  hash: 2
+  prerelease: 6
   segments: 
   - 1
   - 6
-  - 1
-  version: 1.6.1
+  - 2
+  - a
+  version: 1.6.2.a
 platform: ruby
 authors: 
 - Adam Wiggins
@@ -16,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-24 00:00:00 +02:00
+date: 2011-02-13 00:00:00 +01:00
 default_executable: restclient
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,7 +35,37 @@ dependencies:
         version: "1.16"
   type: :runtime
   version_requirements: *id001
-description: "A simple Simple HTTP and REST client for Ruby, inspired by the Sinatra microframework style of specifying actions: get, put, post, delete."
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 57
+        segments: 
+        - 0
+        - 9
+        - 1
+        version: 0.9.1
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: "A simple HTTP and REST client for Ruby, inspired by the Sinatra microframework style of specifying actions: get, put, post, delete."
 email: rest.client@librelist.com
 executables: 
 - restclient
@@ -48,40 +79,40 @@ files:
 - Rakefile
 - VERSION
 - bin/restclient
-- lib/rest_client.rb
 - lib/rest-client.rb
+- lib/rest_client.rb
 - lib/restclient.rb
-- lib/restclient/exceptions.rb
 - lib/restclient/abstract_response.rb
+- lib/restclient/exceptions.rb
 - lib/restclient/net_http_ext.rb
 - lib/restclient/payload.rb
 - lib/restclient/raw_response.rb
 - lib/restclient/request.rb
 - lib/restclient/resource.rb
 - lib/restclient/response.rb
+- spec/abstract_response_spec.rb
 - spec/base.rb
 - spec/exceptions_spec.rb
+- spec/integration/certs/equifax.crt
+- spec/integration/certs/verisign.crt
+- spec/integration/request_spec.rb
 - spec/integration_spec.rb
 - spec/master_shake.jpg
-- spec/abstract_response_spec.rb
 - spec/payload_spec.rb
 - spec/raw_response_spec.rb
-- spec/request_spec.rb
 - spec/request2_spec.rb
+- spec/request_spec.rb
 - spec/resource_spec.rb
 - spec/response_spec.rb
 - spec/restclient_spec.rb
-- spec/integration/certs/equifax.crt
-- spec/integration/certs/verisign.crt
-- spec/integration/request_spec.rb
 - history.md
 has_rdoc: true
 homepage: http://github.com/archiloque/rest-client
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -96,29 +127,31 @@ required_ruby_version: !ruby/object:Gem::Requirement
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 25
       segments: 
-      - 0
-      version: "0"
+      - 1
+      - 3
+      - 1
+      version: 1.3.1
 requirements: []
 
 rubyforge_project: rest-client
-rubygems_version: 1.3.7
+rubygems_version: 1.5.2
 signing_key: 
 specification_version: 3
-summary: Simple REST client for Ruby, inspired by microframework syntax for specifying actions.
+summary: Simple HTTP and REST client for Ruby, inspired by microframework syntax for specifying actions.
 test_files: 
+- spec/abstract_response_spec.rb
 - spec/base.rb
 - spec/exceptions_spec.rb
+- spec/integration/request_spec.rb
 - spec/integration_spec.rb
-- spec/abstract_response_spec.rb
 - spec/payload_spec.rb
 - spec/raw_response_spec.rb
-- spec/request_spec.rb
 - spec/request2_spec.rb
+- spec/request_spec.rb
 - spec/resource_spec.rb
 - spec/response_spec.rb
 - spec/restclient_spec.rb
-- spec/integration/request_spec.rb