RubyGems - rest-client-next-dshelf - Versions diffs - 1.6.1 - Mend

rest-client-next-dshelf 1.6.1

Files changed (32) hide show

data/README.rdoc +277 -0
data/Rakefile +70 -0
data/VERSION +1 -0
data/bin/restclient +92 -0
data/history.md +104 -0
data/lib/rest-client.rb +2 -0
data/lib/rest_client.rb +2 -0
data/lib/restclient.rb +165 -0
data/lib/restclient/abstract_response.rb +106 -0
data/lib/restclient/exceptions.rb +193 -0
data/lib/restclient/net_http_ext.rb +21 -0
data/lib/restclient/payload.rb +220 -0
data/lib/restclient/raw_response.rb +34 -0
data/lib/restclient/request.rb +308 -0
data/lib/restclient/resource.rb +160 -0
data/lib/restclient/response.rb +24 -0
data/spec/abstract_response_spec.rb +85 -0
data/spec/base.rb +16 -0
data/spec/exceptions_spec.rb +98 -0
data/spec/integration/certs/equifax.crt +19 -0
data/spec/integration/certs/verisign.crt +14 -0
data/spec/integration/request_spec.rb +25 -0
data/spec/integration_spec.rb +38 -0
data/spec/master_shake.jpg +0 -0
data/spec/payload_spec.rb +219 -0
data/spec/raw_response_spec.rb +17 -0
data/spec/request2_spec.rb +27 -0
data/spec/request_spec.rb +529 -0
data/spec/resource_spec.rb +129 -0
data/spec/response_spec.rb +169 -0
data/spec/restclient_spec.rb +68 -0
metadata +154 -0

data/README.rdoc ADDED Viewed

@@ -0,0 +1,277 @@
+= REST Client -- simple DSL for accessing HTTP and REST resources
+A simple HTTP and REST client for Ruby, inspired by the Sinatra's microframework style
+of specifying actions: get, put, post, delete.
+* Main page: http://github.com/archiloque/rest-client
+* Mailing list: rest.client@librelist.com (send a mail to subscribe).
+* IRC: #rest-client at freenode
+== Usage: Raw URL
+  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}
+  RestClient.post 'http://example.com/resource', :param1 => 'one', :nested => { :param2 => 'two' }
+  RestClient.post "http://example.com/resource", { 'x' => 1 }.to_json, :content_type => :json, :accept => :json
+  RestClient.delete 'http://example.com/resource'
+  response = RestClient.get 'http://example.com/resource'
+  response.code
+  ➔ 200
+  response.cookies
+  ➔ {"Foo"=>"BAR", "QUUX"=>"QUUUUX"}
+  response.headers
+  ➔ {:content_type=>"text/html; charset=utf-8", :cache_control=>"private" ...
+  response.to_str
+  ➔ \n<!DOCTYPE html PUBLIC \"-//W3C//DTD HTML 4.01//EN\"\n   \"http://www.w3.org/TR/html4/strict.dtd\">\n\n<html ....
+  RestClient.post( url,
+    {
+      :transfer => {
+        :path => '/foo/bar',
+        :owner => 'that_guy',
+        :group => 'those_guys'
+      },
+       :upload => {
+        :file => File.new(path, 'rb')
+      }
+    })
+== Multipart
+Yeah, that's right!  This does multipart sends for you!
+  RestClient.post '/data', :myfile => File.new("/path/to/image.jpg", 'rb')
+This does two things for you:
+* Auto-detects that you have a File value sends it as multipart
+* Auto-detects the mime of the file and sets it in the HEAD of the payload for each entry
+If you are sending params that do not contain a File object but the payload needs to be multipart then:
+  RestClient.post '/data', :foo => 'bar', :multipart => true
+== Usage: ActiveResource-Style
+  resource = RestClient::Resource.new 'http://example.com/resource'
+  resource.get
+  private_resource = RestClient::Resource.new 'https://example.com/private/resource', 'user', 'pass'
+  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.
+== Exceptions (see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html)
+* for results code between 200 and 207 a RestClient::Response will be returned
+* for results code 301, 302 or 307 the redirection will be followed if the request is a get or a head
+* for result code 303 the redirection will be followed and the request transformed into a get
+* for other cases a RestClient::Exception holding the Response will be raised, a specific exception class will be thrown for know error codes
+   RestClient.get 'http://example.com/resource'
+   ➔ RestClient::ResourceNotFound: RestClient::ResourceNotFound
+   begin
+     RestClient.get 'http://example.com/resource'
+   rescue => e
+     e.response
+   end
+   ➔ 404 Resource Not Found | text/html 282 bytes
+== Result handling
+A block can be passed to the RestClient method, this block will then be called with the Response.
+Response.return! can be called to invoke the default response's behavior.
+  # Don't raise exceptions but return the response
+  RestClient.get('http://example.com/resource'){|response, request, result| response }
+  ➔ 404 Resource Not Found | text/html 282 bytes
+  # Manage a specific error code
+  RestClient.get('http://my-rest-service.com/resource'){ |response, request, result, &block|
+    case response.code
+    when 200
+      p "It worked !"
+      response
+    when 423
+      raise SomeCustomExceptionIfYouWant
+    else
+      response.return!(request, result, &block)
+    end
+  }
+  # Follow redirections for all request types and not only for get and head
+  # RFC : "If the 301, 302 or 307 status code is received in response to a request other than GET or HEAD,
+  #        the user agent MUST NOT automatically redirect the request unless it can be confirmed by the user,
+  #        since this might change the conditions under which the request was issued."
+  RestClient.get('http://my-rest-service.com/resource'){ |response, request, result, &block|
+    if [301, 302, 307].include? response.code
+      response.follow_redirection(request, result, &block)
+    else
+      response.return!(request, result, &block)
+    end
+  }
+== Non-normalized URIs.
+If you want to use non-normalized URIs, you can normalize them with the addressable gem (http://addressable.rubyforge.org/api/).
+  require 'addressable/uri'
+  RestClient.get(Addressable::URI.parse("http://www.詹姆斯.com/").normalize.to_str)
+== Lower-level access
+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
+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
+To enable logging you can
+* set RestClient.log with a ruby Logger
+* or set an environment variable to avoid modifying the code (in this case you can use a file name, "stdout" or "stderr"):
+   $ 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.
+== Hook
+RestClient.add_before_execution_proc add a Proc to be called before each execution, it's handy if you need a direct access to the http request.
+Example:
+  # Add oath support using the oauth gem
+  require 'oauth'
+  access_token = ...
+  RestClient.add_before_execution_proc do |req, params|
+    access_token.sign! req
+  end
+  RestClient.get 'http://example.com'
+== More
+Need caching, more advanced logging or any ability provided by a rack middleware ?
+Have a look at rest-client-components http://github.com/crohr/rest-client-components
+== Meta
+Written by Adam Wiggins, major modifications by Blake Mizerany, maintained by Julien Kirch
+Patches contributed by many, including Chris Anderson, Greg Borenstein, Ardekantur, Pedro Belo, Rafael Souza, Rick Olson, Aman Gupta, François Beausoleil and Nick Plante.
+Released under the MIT License: http://www.opensource.org/licenses/mit-license.php

data/Rakefile ADDED Viewed

@@ -0,0 +1,70 @@
+require 'rake'
+require 'jeweler'
+Jeweler::Tasks.new do |s|
+  s.name = "rest-client-next-dshelf"
+  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.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_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
+############################
+require 'spec/rake/spectask'
+desc "Run all specs"
+task :spec => ["spec:unit", "spec:integration"]
+desc "Run unit specs"
+Spec::Rake::SpecTask.new('spec:unit') do |t|
+  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+  t.spec_files = FileList['spec/*_spec.rb']
+end
+desc "Run integration specs"
+Spec::Rake::SpecTask.new('spec:integration') do |t|
+  t.spec_opts = ['--colour --format progress --loadby mtime --reverse']
+  t.spec_files = FileList['spec/integration/*_spec.rb']
+end
+desc "Print specdocs"
+Spec::Rake::SpecTask.new(:doc) do |t|
+  t.spec_opts = ["--format", "specdoc", "--dry-run"]
+  t.spec_files = FileList['spec/*_spec.rb']
+end
+desc "Run all examples with RCov"
+Spec::Rake::SpecTask.new('rcov') do |t|
+  t.spec_files = FileList['spec/*_spec.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'examples']
+end
+task :default => :spec
+############################
+require 'rake/rdoctask'
+Rake::RDocTask.new do |t|
+  t.rdoc_dir = 'rdoc'
+  t.title    = "rest-client, fetch RESTful resources effortlessly"
+  t.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+  t.options << '--charset' << 'utf-8'
+  t.rdoc_files.include('README.rdoc')
+  t.rdoc_files.include('lib/*.rb')
+end

data/VERSION ADDED Viewed

	@@ -0,0 +1 @@
1	+ 1.6.1

data/bin/restclient ADDED Viewed

@@ -0,0 +1,92 @@
+#!/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
+POSSIBLE_VERBS = ['get', 'put', 'post', 'delete']
+if POSSIBLE_VERBS.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
+POSSIBLE_VERBS.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)
+  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"
+end
+if File.exists?(File.expand_path(rcfile = "~/.restclientrc"))
+  load(rcfile)
+end
+ARGV.clear
+IRB.start
+exit!

data/history.md ADDED Viewed

@@ -0,0 +1,104 @@
+# 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)
+# 1.6.1
+- add response body in Exception#inspect
+- add support for RestClient.options
+- fix tests for 1.9.2 (patch provided by Niko Dittmann)
+- 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
+- forgot to include rest-client.rb in the gem
+- user, password and user-defined headers should survive a redirect
+- added all missing status codes
+- added parameter passing for get request using the :param key in header
+- the warning about the logger when using a string was a bad idea
+- multipart parameters names should not be escaped
+- remove the cookie escaping introduced by migrating to CGI cookie parsing in 1.5.1
+- add a streamed payload type (patch provided by Caleb Land)
+- Exception#http_body works even when no response
+# 1.5.1
+- only converts headers keys which are Symbols
+- use CGI for cookie parsing instead of custom code
+- unescape user and password before using them (patch provided by Lars Gierth)
+- expand ~ in ~/.restclientrc (patch provided by Mike Fletcher)
+- ssl verification raise an exception when the ca certificate is incorrect (patch provided by Braintree)
+# 1.5.0
+- the response is now a String with the Response module a.k.a. the change in 1.4.0 was a mistake (Response.body is returning self for compatability)
+- added AbstractResponse.to_i to improve semantic
+- multipart Payloads ignores the name attribute if it's not set (patch provided by Tekin Suleyman)
+- correctly takes into account user headers whose keys are strings (path provided by Cyril Rohr)
+- use binary mode for payload temp file
+- concatenate cookies with ';'
+- fixed deeper parameter handling
+- do not quote the boundary in the Content-Type header (patch provided by W. Andrew Loe III)
+# 1.4.2
+- fixed RestClient.add_before_execution_proc (patch provided by Nicholas Wieland)
+- fixed error when an exception is raised without a response (patch provided by Caleb Land)
+# 1.4.1
+- fixed parameters managment when using hash
+# 1.4.0
+- Response is no more a String, and the mixin is replaced by an abstract_response, existing calls are redirected to response body with a warning.
+- enable repeated parameters  RestClient.post 'http://example.com/resource', :param1 => ['one', 'two', 'three'], => :param2 => 'foo' (patch provided by Rodrigo Panachi)
+- fixed the redirect code concerning relative path and query string combination (patch provided by Kevin Read)
+- redirection code moved to Response so redirection can be customized using the block syntax
+- only get and head redirections are now followed by default, as stated in the specification
+- added RestClient.add_before_execution_proc to hack the http request, like for oauth
+The response change may be breaking in rare cases.
+# 1.3.1
+- added compatibility to enable responses in exception to act like Net::HTTPResponse
+# 1.3.0
+- a block can be used to process a request's result, this enable to handle custom error codes or paththrought (design by Cyril Rohr)
+- cleaner log API, add a warning for some cases but should be compatible
+- accept multiple "Set-Cookie" headers, see http://www.ietf.org/rfc/rfc2109.txt (patch provided by Cyril Rohr)
+- remove "Content-Length" and "Content-Type" headers when following a redirection (patch provided by haarts)
+- all http error codes have now a corresponding exception class and all of them contain the Reponse -> this means that the raised exception can be different
+- changed "Content-Disposition: multipart/form-data" to "Content-Disposition: form-data" per RFC 2388 (patch provided by Kyle Crawford)
+The only breaking change should be the exception classes, but as the new classes inherits from the existing ones, the breaking cases should be rare.
+# 1.2.0
+- formatting changed from tabs to spaces
+- logged requests now include generated headers
+- accept and content-type headers can now be specified using extentions: RestClient.post "http://example.com/resource", { 'x' => 1 }.to_json, :content_type => :json, :accept => :json
+- should be 1.1.1 but renamed to 1.2.0 because 1.1.X versions has already been packaged on Debian
+# 1.1.0
+- new maintainer: Archiloque, the working repo is now at http://github.com/archiloque/rest-client
+- a mailing list has been created at rest.client@librelist.com and an freenode irc channel #rest-client
+- François Beausoleil' multipart code from http://github.com/francois/rest-client has been merged
+- ability to use hash in hash as payload
+- the mime-type code now rely on the mime-types gem http://mime-types.rubyforge.org/ instead of an internal partial list
+- 204 response returns a Response instead of nil (patch provided by Elliott Draper)
+All changes exept the last one should be fully compatible with the previous version.
+NOTE: due to a dependency problem and to the last change, heroku users should update their heroku gem to >= 1.5.3 to be able to use this version.